1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR the authors of Guix (msgids)
3 # This file is distributed under the same license as the guix manual package.
4 # Marek Felšöci <marek@felsoci.sk>, 2021.
7 "Project-Id-Version: guix manual checkout\n"
8 "Report-Msgid-Bugs-To: bug-guix@gnu.org\n"
9 "POT-Creation-Date: 2021-04-13 01:18+0200\n"
10 "PO-Revision-Date: 2021-04-17 23:47+0000\n"
11 "Last-Translator: Marek Felšöci <marek@felsoci.sk>\n"
12 "Language-Team: Slovak <https://translate.fedoraproject.org/projects/guix/documentation-manual/sk/>\n"
15 "Content-Type: text/plain; charset=UTF-8\n"
16 "Content-Transfer-Encoding: 8bit\n"
17 "Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"
18 "X-Generator: Weblate 4.5.3\n"
20 #. #-#-#-#-# contributing.pot (guix manual checkout) #-#-#-#-#
22 #. #-#-#-#-# guix.pot (guix manual checkout) #-#-#-#-#
24 #: guix-git/doc/contributing.texi:1 guix-git/doc/contributing.texi:2
25 #: guix-git/doc/guix.texi:168
31 #: guix-git/doc/contributing.texi:9
32 msgid "This project is a cooperative effort, and we need your help to make it grow! Please get in touch with us on @email{guix-devel@@gnu.org} and @code{#guix} on the Freenode IRC network. We welcome ideas, bug reports, patches, and anything that may be helpful to the project. We particularly welcome help on packaging (@pxref{Packaging Guidelines})."
33 msgstr "Tento projekt je výsledkom spoločného úsilia a potrebujeme vašu pomoc pri jeho rozširovaní! Spojte sa s nami prostredníctvom @email{guix-devel@@gnu.org} alebo @code{#guix} na sieti IRC Freenode. Radi privítame vaše nápady, hlásenia chýb, záplaty a čokoľvek čo môže projektu pomôcť. Zvlášť radi privítame vašu pomoc s pridávaním balíkov (@pxref{Packaging Guidelines})."
36 #: guix-git/doc/contributing.texi:10
38 msgid "code of conduct, of contributors"
39 msgstr "pravidlá pre spoluprácu"
42 #: guix-git/doc/contributing.texi:11
44 msgid "contributor covenant"
45 msgstr "záväzok prispievateľa"
48 #: guix-git/doc/contributing.texi:17
49 msgid "We want to provide a warm, friendly, and harassment-free environment, so that anyone can contribute to the best of their abilities. To this end our project uses a ``Contributor Covenant'', which was adapted from @url{https://contributor-covenant.org/}. You can find a local version in the @file{CODE-OF-CONDUCT} file in the source tree."
50 msgstr "Chceme vám poskytnúť príjemné a priateľské prostredie bez obťažovania, aby sa každý mohol zapojiť najlepšie ako vie. Preto sa náš projekt riadi „záväzkom prispievateľa“ založeným na @url{https://contributor-covenant.org/}. Úplné znenie záväzku nájdete v súbore @file{CODE-OF-CONDUCT} v strome zdrojových súborov."
53 #: guix-git/doc/contributing.texi:21
54 msgid "Contributors are not required to use their legal name in patches and on-line communication; they can use any name or pseudonym of their choice."
55 msgstr "Prispievatelia nemusia používať ich ozajstné meno v záplatách a online dokumentácii; môžu používať ľubovoľné meno alebo prezývku."
58 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:34
59 #: guix-git/doc/contributing.texi:35
61 msgid "Building from Git"
62 msgstr "Zostavenie z Gitu"
65 #: guix-git/doc/contributing.texi:32
66 msgid "The latest and greatest."
67 msgstr "Vždy ten najnovší."
70 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:160
71 #: guix-git/doc/contributing.texi:161
73 msgid "Running Guix Before It Is Installed"
74 msgstr "Spúšťanie Guixu ešte pred inštaláciou"
77 #: guix-git/doc/contributing.texi:32
78 msgid "Hacker tricks."
79 msgstr "Finty pre hackerov."
82 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:234
83 #: guix-git/doc/contributing.texi:235
85 msgid "The Perfect Setup"
86 msgstr "Dokonalé nastavenie"
89 #: guix-git/doc/contributing.texi:32
90 msgid "The right tools."
91 msgstr "Správne nástroje."
94 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:325
95 #: guix-git/doc/contributing.texi:326
97 msgid "Packaging Guidelines"
101 #: guix-git/doc/contributing.texi:32
102 msgid "Growing the distribution."
106 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:873
107 #: guix-git/doc/contributing.texi:874
113 #: guix-git/doc/contributing.texi:32
114 msgid "Hygiene of the contributor."
118 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:972
119 #: guix-git/doc/contributing.texi:973
121 msgid "Submitting Patches"
125 #: guix-git/doc/contributing.texi:32
126 msgid "Share your work."
130 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1198
131 #: guix-git/doc/contributing.texi:1199
133 msgid "Tracking Bugs and Patches"
137 #: guix-git/doc/contributing.texi:32
138 msgid "Using Debbugs."
142 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1249
143 #: guix-git/doc/contributing.texi:1250
145 msgid "Commit Access"
149 #: guix-git/doc/contributing.texi:32
150 msgid "Pushing to the official repository."
154 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1396
155 #: guix-git/doc/contributing.texi:1397
157 msgid "Updating the Guix Package"
161 #: guix-git/doc/contributing.texi:32
162 msgid "Updating the Guix package definition."
166 #: guix-git/doc/contributing.texi:39
167 msgid "If you want to hack Guix itself, it is recommended to use the latest version from the Git repository:"
171 #: guix-git/doc/contributing.texi:42
173 msgid "git clone https://git.savannah.gnu.org/git/guix.git\n"
177 #: guix-git/doc/contributing.texi:44
179 msgid "authentication, of a Guix checkout"
183 #: guix-git/doc/contributing.texi:49
184 msgid "How do you ensure that you obtained a genuine copy of the repository? To do that, run @command{guix git authenticate}, passing it the commit and OpenPGP fingerprint of the @dfn{channel introduction} (@pxref{Invoking guix git authenticate}):"
188 #: guix-git/doc/contributing.texi:56
191 "git fetch origin keyring:keyring\n"
192 "guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \\\n"
193 " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\"\n"
197 #: guix-git/doc/contributing.texi:61
198 msgid "This command completes with exit code zero on success; it prints an error message and exits with a non-zero code otherwise."
202 #: guix-git/doc/contributing.texi:68
203 msgid "As you can see, there is a chicken-and-egg problem: you first need to have Guix installed. Typically you would install Guix System (@pxref{System Installation}) or Guix on top of another distro (@pxref{Binary Installation}); in either case, you would verify the OpenPGP signature on the installation medium. This ``bootstraps'' the trust chain."
207 #: guix-git/doc/contributing.texi:73
208 msgid "The easiest way to set up a development environment for Guix is, of course, by using Guix! The following command starts a new shell where all the dependencies and appropriate environment variables are set up to hack on Guix:"
212 #: guix-git/doc/contributing.texi:76
214 msgid "guix environment guix --pure\n"
218 #: guix-git/doc/contributing.texi:79
219 msgid "@xref{Invoking guix environment}, for more information on that command."
223 #: guix-git/doc/contributing.texi:83
224 msgid "If you are unable to use Guix when building Guix from a checkout, the following are the required packages in addition to those mentioned in the installation instructions (@pxref{Requirements})."
228 #: guix-git/doc/contributing.texi:85
230 msgid "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
234 #: guix-git/doc/contributing.texi:86
236 msgid "@url{https://gnu.org/software/automake/, GNU Automake};"
240 #: guix-git/doc/contributing.texi:87
242 msgid "@url{https://gnu.org/software/gettext/, GNU Gettext};"
246 #: guix-git/doc/contributing.texi:88
248 msgid "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
252 #: guix-git/doc/contributing.texi:89
254 msgid "@url{https://www.graphviz.org/, Graphviz};"
258 #: guix-git/doc/contributing.texi:90
260 msgid "@url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}."
264 #: guix-git/doc/contributing.texi:95
265 msgid "On Guix, extra dependencies can be added by instead running @command{guix environment} with @option{--ad-hoc}:"
269 #: guix-git/doc/contributing.texi:98
271 msgid "guix environment guix --pure --ad-hoc help2man git strace\n"
275 #: guix-git/doc/contributing.texi:102
276 msgid "Run @command{./bootstrap} to generate the build system infrastructure using Autoconf and Automake. If you get an error like this one:"
280 #: guix-git/doc/contributing.texi:105
282 msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
286 #: guix-git/doc/contributing.texi:114
287 msgid "it probably means that Autoconf couldn’t find @file{pkg.m4}, which is provided by pkg-config. Make sure that @file{pkg.m4} is available. The same holds for the @file{guile.m4} set of macros provided by Guile. For instance, if you installed Automake in @file{/usr/local}, it wouldn’t look for @file{.m4} files in @file{/usr/share}. In that case, you have to invoke the following command:"
291 #: guix-git/doc/contributing.texi:117
293 msgid "export ACLOCAL_PATH=/usr/share/aclocal\n"
297 #: guix-git/doc/contributing.texi:121
298 msgid "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more information."
302 #: guix-git/doc/contributing.texi:128
303 msgid "Then, run @command{./configure} as usual. Make sure to pass @code{--localstatedir=@var{directory}} where @var{directory} is the @code{localstatedir} value used by your current installation (@pxref{The Store}, for information about this), usually @file{/var}. Note that you will probably not run @command{make install} at the end (you don't have to) but it's still important to pass the right @code{localstatedir}."
307 #: guix-git/doc/contributing.texi:133
308 msgid "Finally, you have to invoke @code{make && make check} to build Guix and run the tests (@pxref{Running the Test Suite}). If anything fails, take a look at installation instructions (@pxref{Installation}) or send a message to the @email{guix-devel@@gnu.org, mailing list}."
312 #: guix-git/doc/contributing.texi:136
313 msgid "From there on, you can authenticate all the commits included in your checkout by running:"
317 #: guix-git/doc/contributing.texi:139
319 msgid "make authenticate\n"
323 #: guix-git/doc/contributing.texi:142
324 msgid "The first run takes a couple of minutes, but subsequent runs are faster."
328 #: guix-git/doc/contributing.texi:148
329 msgid "Or, when your configuration for your local Git repository doesn't match the default one, you can provide the reference for the @code{keyring} branch through the variable @code{GUIX_GIT_KEYRING}. The following example assumes that you have a Git remote called @samp{myremote} pointing to the official repository:"
333 #: guix-git/doc/contributing.texi:151
335 msgid "make authenticate GUIX_GIT_KEYRING=myremote/keyring\n"
339 #: guix-git/doc/contributing.texi:153 guix-git/doc/contributing.texi:1316
340 #: guix-git/doc/guix.texi:565 guix-git/doc/guix.texi:614
341 #: guix-git/doc/guix.texi:1763 guix-git/doc/guix.texi:2010
342 #: guix-git/doc/guix.texi:2218 guix-git/doc/guix.texi:2439
343 #: guix-git/doc/guix.texi:2640 guix-git/doc/guix.texi:3757
344 #: guix-git/doc/guix.texi:4493 guix-git/doc/guix.texi:4507
345 #: guix-git/doc/guix.texi:4589 guix-git/doc/guix.texi:4819
346 #: guix-git/doc/guix.texi:5669 guix-git/doc/guix.texi:5915
347 #: guix-git/doc/guix.texi:6036 guix-git/doc/guix.texi:6088
348 #: guix-git/doc/guix.texi:8775 guix-git/doc/guix.texi:8845
349 #: guix-git/doc/guix.texi:10510 guix-git/doc/guix.texi:10550
350 #: guix-git/doc/guix.texi:10823 guix-git/doc/guix.texi:10835
351 #: guix-git/doc/guix.texi:13080 guix-git/doc/guix.texi:13707
352 #: guix-git/doc/guix.texi:14490 guix-git/doc/guix.texi:15465
353 #: guix-git/doc/guix.texi:17781 guix-git/doc/guix.texi:17930
354 #: guix-git/doc/guix.texi:25526 guix-git/doc/guix.texi:29135
355 #: guix-git/doc/guix.texi:31092 guix-git/doc/guix.texi:32585
356 #: guix-git/doc/guix.texi:32819 guix-git/doc/guix.texi:32989
357 #: guix-git/doc/guix.texi:33142 guix-git/doc/guix.texi:33244
358 #: guix-git/doc/guix.texi:33345
364 #: guix-git/doc/contributing.texi:157
365 msgid "You are advised to run @command{make authenticate} after every @command{git pull} invocation. This ensures you keep receiving valid changes to the repository."
369 #: guix-git/doc/contributing.texi:167
370 msgid "In order to keep a sane working environment, you will find it useful to test the changes made in your local source tree checkout without actually installing them. So that you can distinguish between your ``end-user'' hat and your ``motley'' costume."
374 #: guix-git/doc/contributing.texi:178
375 msgid "To that end, all the command-line tools can be used even if you have not run @code{make install}. To do that, you first need to have an environment with all the dependencies available (@pxref{Building from Git}), and then simply prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the top build tree of Guix; it is generated by running @command{./bootstrap} followed by @command{./configure}). As an example, here is how you would build the @code{hello} package as defined in your working tree (this assumes @command{guix-daemon} is already running on your system; it's OK if it's a different version):"
379 #: guix-git/doc/contributing.texi:181
381 msgid "$ ./pre-inst-env guix build hello\n"
385 #: guix-git/doc/contributing.texi:185
386 msgid "Similarly, an example for a Guile session using the Guix modules:"
390 #: guix-git/doc/contributing.texi:188
393 "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
398 #: guix-git/doc/contributing.texi:190
400 msgid ";;; (\"x86_64-linux\")\n"
404 #: guix-git/doc/contributing.texi:193
410 #: guix-git/doc/contributing.texi:194
412 msgid "read-eval-print loop"
416 #: guix-git/doc/contributing.texi:197
417 msgid "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):"
421 #: guix-git/doc/contributing.texi:212
424 "$ ./pre-inst-env guile\n"
425 "scheme@@(guile-user)> ,use(guix)\n"
426 "scheme@@(guile-user)> ,use(gnu)\n"
427 "scheme@@(guile-user)> (define snakes\n"
429 " (lambda (package lst)\n"
430 " (if (string-prefix? \"python\"\n"
431 " (package-name package))\n"
432 " (cons package lst)\n"
435 "scheme@@(guile-user)> (length snakes)\n"
440 #: guix-git/doc/contributing.texi:220
441 msgid "If you are hacking on the daemon and its supporting code or if @command{guix-daemon} is not already running on your system, you can launch it straight from the build tree@footnote{The @option{-E} flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and the tools it uses can find the Guile modules they need.}:"
445 #: guix-git/doc/contributing.texi:223
447 msgid "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
451 #: guix-git/doc/contributing.texi:227
452 msgid "The @command{pre-inst-env} script sets up all the environment variables necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}."
456 #: guix-git/doc/contributing.texi:232
457 msgid "Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the local source tree; it simply updates the @file{~/.config/guix/current} symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if you want to upgrade your local source tree."
461 #: guix-git/doc/contributing.texi:242
462 msgid "The Perfect Setup to hack on Guix is basically the perfect setup used for Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference Manual}). First, you need more than an editor, you need @url{https://www.gnu.org/software/emacs, Emacs}, empowered by the wonderful @url{https://nongnu.org/geiser/, Geiser}. To set that up, run:"
466 #: guix-git/doc/contributing.texi:245
468 msgid "guix package -i emacs guile emacs-geiser\n"
472 #: guix-git/doc/contributing.texi:254
473 msgid "Geiser allows for interactive and incremental development from within Emacs: code compilation and evaluation from within buffers, access to on-line documentation (docstrings), context-sensitive completion, @kbd{M-.} to jump to an object definition, a REPL to try out your code, and more (@pxref{Introduction,,, geiser, Geiser User Manual}). For convenient Guix development, make sure to augment Guile’s load path so that it finds source files from your checkout:"
477 #: guix-git/doc/contributing.texi:259
480 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
481 "(with-eval-after-load 'geiser-guile\n"
482 " (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n"
486 #: guix-git/doc/contributing.texi:267
487 msgid "To actually edit the code, Emacs already has a neat Scheme mode. But in addition to that, you must not miss @url{https://www.emacswiki.org/emacs/ParEdit, Paredit}. It provides facilities to directly operate on the syntax tree, such as raising an s-expression or wrapping it, swallowing or rejecting the following s-expression, etc."
491 #: guix-git/doc/contributing.texi:268
493 msgid "code snippets"
497 #: guix-git/doc/contributing.texi:269
503 #: guix-git/doc/contributing.texi:270
505 msgid "reducing boilerplate"
509 #: guix-git/doc/contributing.texi:277
510 msgid "We also provide templates for common git commit messages and package definitions in the @file{etc/snippets} directory. These templates can be used with @url{https://joaotavora.github.io/yasnippet/, YASnippet} to expand short trigger strings to interactive text snippets. You may want to add the snippets directory to the @var{yas-snippet-dirs} variable in Emacs."
514 #: guix-git/doc/contributing.texi:282
517 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
518 "(with-eval-after-load 'yasnippet\n"
519 " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n"
523 #: guix-git/doc/contributing.texi:290
524 msgid "The commit message snippets depend on @url{https://magit.vc/, Magit} to display staged files. When editing a commit message type @code{add} followed by @kbd{TAB} to insert a commit message template for adding a package; type @code{update} followed by @kbd{TAB} to insert a template for updating a package; type @code{https} followed by @kbd{TAB} to insert a template for changing the home page URI of a package to HTTPS."
528 #: guix-git/doc/contributing.texi:296
529 msgid "The main snippet for @code{scheme-mode} is triggered by typing @code{package...} followed by @kbd{TAB}. This snippet also inserts the trigger string @code{origin...}, which can be expanded further. The @code{origin} snippet in turn may insert other trigger strings ending on @code{...}, which also can be expanded further."
533 #: guix-git/doc/contributing.texi:297
535 msgid "insert or update copyright"
539 #: guix-git/doc/contributing.texi:298
541 msgid "M-x guix-copyright"
545 #: guix-git/doc/contributing.texi:299
547 msgid "M-x copyright-update"
551 #: guix-git/doc/contributing.texi:303
552 msgid "We additionally provide insertion and automatic update of a copyright in @file{etc/copyright.el}. You may want to set your full name, mail, and load a file."
556 #: guix-git/doc/contributing.texi:309
559 "(setq user-full-name \"Alice Doe\")\n"
560 "(setq user-mail-address \"alice@@mail.org\")\n"
561 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
562 "(load-file \"~/src/guix/etc/copyright.el\")\n"
566 #: guix-git/doc/contributing.texi:312
567 msgid "To insert a copyright at the current line invoke @code{M-x guix-copyright}."
571 #: guix-git/doc/contributing.texi:314
572 msgid "To update a copyright you need to specify a @code{copyright-names-regexp}."
576 #: guix-git/doc/contributing.texi:318
579 "(setq copyright-names-regexp\n"
580 " (format \"%s <%s>\" user-full-name user-mail-address))\n"
584 #: guix-git/doc/contributing.texi:324
585 msgid "You can check if your copyright is up to date by evaluating @code{M-x copyright-update}. If you want to do it automatically after each buffer save then add @code{(add-hook 'after-save-hook 'copyright-update)} in Emacs."
589 #: guix-git/doc/contributing.texi:328
591 msgid "packages, creating"
595 #: guix-git/doc/contributing.texi:332
596 msgid "The GNU distribution is nascent and may well lack some of your favorite packages. This section describes how you can help make the distribution grow."
600 #: guix-git/doc/contributing.texi:340
601 msgid "Free software packages are usually distributed in the form of @dfn{source code tarballs}---typically @file{tar.gz} files that contain all the source files. Adding a package to the distribution means essentially two things: adding a @dfn{recipe} that describes how to build the package, including a list of other packages required to build it, and adding @dfn{package metadata} along with that recipe, such as a description and licensing information."
605 #: guix-git/doc/contributing.texi:349
606 msgid "In Guix all this information is embodied in @dfn{package definitions}. Package definitions provide a high-level view of the package. They are written using the syntax of the Scheme programming language; in fact, for each package we define a variable bound to the package definition, and export that variable from a module (@pxref{Package Modules}). However, in-depth Scheme knowledge is @emph{not} a prerequisite for creating packages. For more information on package definitions, @pxref{Defining Packages}."
610 #: guix-git/doc/contributing.texi:355
611 msgid "Once a package definition is in place, stored in a file in the Guix source tree, it can be tested using the @command{guix build} command (@pxref{Invoking guix build}). For example, assuming the new package is called @code{gnew}, you may run this command from the Guix build tree (@pxref{Running Guix Before It Is Installed}):"
615 #: guix-git/doc/contributing.texi:358
617 msgid "./pre-inst-env guix build gnew --keep-failed\n"
621 #: guix-git/doc/contributing.texi:364
622 msgid "Using @code{--keep-failed} makes it easier to debug build failures since it provides access to the failed build tree. Another useful command-line option when debugging is @code{--log-file}, to access the build log."
626 #: guix-git/doc/contributing.texi:369
627 msgid "If the package is unknown to the @command{guix} command, it may be that the source file contains a syntax error, or lacks a @code{define-public} clause to export the package variable. To figure it out, you may load the module from Guile to get more information about the actual error:"
631 #: guix-git/doc/contributing.texi:372
633 msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n"
637 #: guix-git/doc/contributing.texi:379
638 msgid "Once your package builds correctly, please send us a patch (@pxref{Submitting Patches}). Well, if you need help, we will be happy to help you too. Once the patch is committed in the Guix repository, the new package automatically gets built on the supported platforms by @url{@value{SUBSTITUTE-URL}, our continuous integration system}."
642 #: guix-git/doc/contributing.texi:380
648 #: guix-git/doc/contributing.texi:387
649 msgid "Users can obtain the new package definition simply by running @command{guix pull} (@pxref{Invoking guix pull}). When @code{@value{SUBSTITUTE-SERVER}} is done building the package, installing the package automatically downloads binaries from there (@pxref{Substitutes}). The only place where human intervention is needed is to review and apply the patch."
653 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:403
654 #: guix-git/doc/contributing.texi:404
656 msgid "Software Freedom"
660 #: guix-git/doc/contributing.texi:401
661 msgid "What may go into the distribution."
665 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:431
666 #: guix-git/doc/contributing.texi:432
668 msgid "Package Naming"
672 #: guix-git/doc/contributing.texi:401
673 msgid "What's in a name?"
677 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:464
678 #: guix-git/doc/contributing.texi:465
680 msgid "Version Numbers"
684 #: guix-git/doc/contributing.texi:401
685 msgid "When the name is not enough."
689 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:555
690 #: guix-git/doc/contributing.texi:556
692 msgid "Synopses and Descriptions"
696 #: guix-git/doc/contributing.texi:401
697 msgid "Helping users find the right package."
701 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:634
702 #: guix-git/doc/contributing.texi:635
704 msgid "Snippets versus Phases"
708 #: guix-git/doc/contributing.texi:401
709 msgid "Whether to use a snippet, or a build phase."
713 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:649
714 #: guix-git/doc/contributing.texi:650 guix-git/doc/guix.texi:1945
716 msgid "Emacs Packages"
720 #: guix-git/doc/contributing.texi:401
721 msgid "Your Elisp fix."
725 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:689
726 #: guix-git/doc/contributing.texi:690
728 msgid "Python Modules"
732 #: guix-git/doc/contributing.texi:401
733 msgid "A touch of British comedy."
737 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:765
738 #: guix-git/doc/contributing.texi:766
744 #: guix-git/doc/contributing.texi:401
745 msgid "Little pearls."
749 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:781
750 #: guix-git/doc/contributing.texi:782
752 msgid "Java Packages"
756 #: guix-git/doc/contributing.texi:401
757 msgid "Coffee break."
761 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:801
762 #: guix-git/doc/contributing.texi:802
768 #: guix-git/doc/contributing.texi:401
769 msgid "Beware of oxidation."
773 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:835
774 #: guix-git/doc/contributing.texi:836
780 #: guix-git/doc/contributing.texi:401
781 msgid "Fond of fonts."
785 #: guix-git/doc/contributing.texi:407
787 msgid "free software"
791 #: guix-git/doc/contributing.texi:415
792 msgid "The GNU operating system has been developed so that users can have freedom in their computing. GNU is @dfn{free software}, meaning that users have the @url{https://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: to run the program, to study and change the program in source code form, to redistribute exact copies, and to distribute modified versions. Packages found in the GNU distribution provide only software that conveys these four freedoms."
796 #: guix-git/doc/contributing.texi:421
797 msgid "In addition, the GNU distribution follow the @url{https://www.gnu.org/distros/free-system-distribution-guidelines.html,free software distribution guidelines}. Among other things, these guidelines reject non-free firmware, recommendations of non-free software, and discuss ways to deal with trademarks and patents."
801 #: guix-git/doc/contributing.texi:429
802 msgid "Some otherwise free upstream package sources contain a small and optional subset that violates the above guidelines, for instance because this subset is itself non-free code. When that happens, the offending items are removed with appropriate patches or code snippets in the @code{origin} form of the package (@pxref{Defining Packages}). This way, @code{guix build --source} returns the ``freed'' source rather than the unmodified upstream source."
806 #: guix-git/doc/contributing.texi:434
812 #: guix-git/doc/contributing.texi:442
813 msgid "A package actually has two names associated with it. First, there is the name of the @emph{Scheme variable}, the one following @code{define-public}. By this name, the package can be made known in the Scheme code, for instance as input to another package. Second, there is the string in the @code{name} field of a package definition. This name is used by package management commands such as @command{guix package} and @command{guix build}."
817 #: guix-git/doc/contributing.texi:447
818 msgid "Both are usually the same and correspond to the lowercase conversion of the project name chosen upstream, with underscores replaced with hyphens. For instance, GNUnet is available as @code{gnunet}, and SDL_net as @code{sdl-net}."
822 #: guix-git/doc/contributing.texi:455
823 msgid "A noteworthy exception to this rule is when the project name is only a single character, or if an older maintained project with the same name already exists---regardless of whether it has already been packaged for Guix. Use common sense to make such names unambiguous and meaningful. For example, Guix's package for the shell called ``s'' upstream is @code{s-shell} and @emph{not} @code{s}. Feel free to ask your fellow hackers for inspiration."
827 #: guix-git/doc/contributing.texi:460
828 msgid "We do not add @code{lib} prefixes for library packages, unless these are already part of the official project name. But @pxref{Python Modules} and @ref{Perl Modules} for special rules concerning modules for the Python and Perl languages."
832 #: guix-git/doc/contributing.texi:462
833 msgid "Font package names are handled differently, @pxref{Fonts}."
837 #: guix-git/doc/contributing.texi:467
839 msgid "package version"
843 #: guix-git/doc/contributing.texi:476
844 msgid "We usually package only the latest version of a given free software project. But sometimes, for instance for incompatible library versions, two (or more) versions of the same package are needed. These require different Scheme variable names. We use the name as defined in @ref{Package Naming} for the most recent version; previous versions use the same name, suffixed by @code{-} and the smallest prefix of the version number that may distinguish the two versions."
848 #: guix-git/doc/contributing.texi:479
849 msgid "The name inside the package definition is the same for all versions of a package and does not contain any version number."
853 #: guix-git/doc/contributing.texi:481
854 msgid "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows:"
858 #: guix-git/doc/contributing.texi:493
861 "(define-public gtk+\n"
864 " (version \"3.9.12\")\n"
866 "(define-public gtk+-2\n"
869 " (version \"2.24.20\")\n"
874 #: guix-git/doc/contributing.texi:495
875 msgid "If we also wanted GTK+ 3.8.2, this would be packaged as"
879 #: guix-git/doc/contributing.texi:501
882 "(define-public gtk+-3.8\n"
885 " (version \"3.8.2\")\n"
890 #: guix-git/doc/contributing.texi:505
892 msgid "version number, for VCS snapshots"
896 #: guix-git/doc/contributing.texi:511
897 msgid "Occasionally, we package snapshots of upstream's version control system (VCS) instead of formal releases. This should remain exceptional, because it is up to upstream developers to clarify what the stable release is. Yet, it is sometimes necessary. So, what should we put in the @code{version} field?"
901 #: guix-git/doc/contributing.texi:519
902 msgid "Clearly, we need to make the commit identifier of the VCS snapshot visible in the version string, but we also need to make sure that the version string is monotonically increasing so that @command{guix package --upgrade} can determine which version is newer. Since commit identifiers, notably with Git, are not monotonically increasing, we add a revision number that we increase each time we upgrade to a newer snapshot. The resulting version string looks like this:"
906 #: guix-git/doc/contributing.texi:528
911 " | | `-- upstream commit ID\n"
913 " | `--- Guix package revision\n"
915 "latest upstream version\n"
919 #: guix-git/doc/contributing.texi:537
920 msgid "It is a good idea to strip commit identifiers in the @code{version} field to, say, 7 digits. It avoids an aesthetic annoyance (assuming aesthetics have a role to play here) as well as problems related to OS limits such as the maximum shebang length (127 bytes for the Linux kernel). It is best to use the full commit identifiers in @code{origin}s, though, to avoid ambiguities. A typical package definition may look like this:"
924 #: guix-git/doc/contributing.texi:553
927 "(define my-package\n"
928 " (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n"
929 " (revision \"1\")) ;Guix package revision\n"
931 " (version (git-version \"0.9\" revision commit))\n"
933 " (method git-fetch)\n"
934 " (uri (git-reference\n"
935 " (url \"git://example.org/my-package.git\")\n"
936 " (commit commit)))\n"
937 " (sha256 (base32 \"1mbikn@dots{}\"))\n"
938 " (file-name (git-file-name name version))))\n"
944 #: guix-git/doc/contributing.texi:558
946 msgid "package description"
950 #: guix-git/doc/contributing.texi:559
952 msgid "package synopsis"
956 #: guix-git/doc/contributing.texi:566
957 msgid "As we have seen before, each package in GNU@tie{}Guix includes a synopsis and a description (@pxref{Defining Packages}). Synopses and descriptions are important: They are what @command{guix package --search} searches, and a crucial piece of information to help users determine whether a given package suits their needs. Consequently, packagers should pay attention to what goes into them."
961 #: guix-git/doc/contributing.texi:574
962 msgid "Synopses must start with a capital letter and must not end with a period. They must not start with ``a'' or ``the'', which usually does not bring anything; for instance, prefer ``File-frobbing tool'' over ``A tool that frobs files''. The synopsis should say what the package is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines matching a pattern''."
966 #: guix-git/doc/contributing.texi:584
967 msgid "Keep in mind that the synopsis must be meaningful for a very wide audience. For example, ``Manipulate alignments in the SAM format'' might make sense for a seasoned bioinformatics researcher, but might be fairly unhelpful or even misleading to a non-specialized audience. It is a good idea to come up with a synopsis that gives an idea of the application domain of the package. In this example, this might give something like ``Manipulate nucleotide sequence alignments'', which hopefully gives the user a better idea of whether this is what they are looking for."
971 #: guix-git/doc/contributing.texi:592
972 msgid "Descriptions should take between five and ten lines. Use full sentences, and avoid using acronyms without first introducing them. Please avoid marketing phrases such as ``world-leading'', ``industrial-strength'', and ``next-generation'', and avoid superlatives like ``the most advanced''---they are not helpful to users looking for a package and may even sound suspicious. Instead, try to be factual, mentioning use cases and features."
976 #: guix-git/doc/contributing.texi:593
978 msgid "Texinfo markup, in package descriptions"
982 #: guix-git/doc/contributing.texi:602
983 msgid "Descriptions can include Texinfo markup, which is useful to introduce ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you should be careful when using some characters for example @samp{@@} and curly braces which are the basic special characters in Texinfo (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces such as @command{guix package --show} take care of rendering it appropriately."
987 #: guix-git/doc/contributing.texi:608
988 msgid "Synopses and descriptions are translated by volunteers @uref{https://translate.fedoraproject.org/projects/guix/packages, at Weblate} so that as many users as possible can read them in their native language. User interfaces search them and display them in the language specified by the current locale."
992 #: guix-git/doc/contributing.texi:613
993 msgid "To allow @command{xgettext} to extract them as translatable strings, synopses and descriptions @emph{must be literal strings}. This means that you cannot use @code{string-append} or @code{format} to construct these strings:"
997 #: guix-git/doc/contributing.texi:619
1002 " (synopsis \"This is translatable\")\n"
1003 " (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n"
1007 #: guix-git/doc/contributing.texi:627
1008 msgid "Translation is a lot of work so, as a packager, please pay even more attention to your synopses and descriptions as every change may entail additional work for translators. In order to help them, it is possible to make recommendations or instructions visible to them by inserting special comments like this (@pxref{xgettext Invocation,,, gettext, GNU Gettext}):"
1012 #: guix-git/doc/contributing.texi:632
1015 ";; TRANSLATORS: \"X11 resize-and-rotate\" should not be translated.\n"
1016 "(description \"ARandR is designed to provide a simple visual front end\n"
1017 "for the X11 resize-and-rotate (RandR) extension. @dots{}\")\n"
1021 #: guix-git/doc/contributing.texi:637
1023 msgid "snippets, when to use"
1027 #: guix-git/doc/contributing.texi:648
1028 msgid "The boundary between using an origin snippet versus a build phase to modify the sources of a package can be elusive. Origin snippets are typically used to remove unwanted files such as bundled libraries, nonfree sources, or to apply simple substitutions. The source derived from an origin should produce a source that can be used to build the package on any system that the upstream package supports (i.e., act as the corresponding source). In particular, origin snippets must not embed store items in the sources; such patching should rather be done using build phases. Refer to the @code{origin} record documentation for more information (@pxref{origin Reference})."
1032 #: guix-git/doc/contributing.texi:652
1034 msgid "emacs, packaging"
1038 #: guix-git/doc/contributing.texi:653
1040 msgid "elisp, packaging"
1044 #: guix-git/doc/contributing.texi:665
1045 msgid "Emacs packages should preferably use the Emacs build system (@pxref{emacs-build-system}), for uniformity and the benefits provided by its build phases, such as the auto-generation of the autoloads file and the byte compilation of the sources. Because there is no standardized way to run a test suite for Emacs packages, tests are disabled by default. When a test suite is available, it should be enabled by setting the @code{#:tests?} argument to @code{#true}. By default, the command to run the test is @command{make check}, but any command can be specified via the @code{#:test-command} argument. The @code{#:test-command} argument expects a list containing a command and its arguments, to be invoked during the @code{check} phase."
1049 #: guix-git/doc/contributing.texi:670
1050 msgid "The Elisp dependencies of Emacs packages are typically provided as @code{propagated-inputs} when required at run time. As for other packages, build or test dependencies should be specified as @code{native-inputs}."
1054 #: guix-git/doc/contributing.texi:679
1055 msgid "Emacs packages sometimes depend on resources directories that should be installed along the Elisp files. The @code{#:include} argument can be used for that purpose, by specifying a list of regexps to match. The best practice when using the @code{#:include} argument is to extend rather than override its default value (accessible via the @code{%default-include} variable). As an example, a yasnippet extension package typically include a @file{snippets} directory, which could be copied to the installation directory using:"
1059 #: guix-git/doc/contributing.texi:682
1061 msgid "#:include (cons \"^snippets/\" %default-include))\n"
1065 #: guix-git/doc/contributing.texi:688
1066 msgid "When encountering problems, it is wise to check for the presence of the @code{Package-Requires} extension header in the package main source file, and whether any dependencies and their versions listed therein are satisfied."
1070 #: guix-git/doc/contributing.texi:692
1076 #: guix-git/doc/contributing.texi:698
1077 msgid "We currently package Python 2 and Python 3, under the Scheme variable names @code{python-2} and @code{python} as explained in @ref{Version Numbers}. To avoid confusion and naming clashes with other programming languages, it seems desirable that the name of a package for a Python module contains the word @code{python}."
1081 #: guix-git/doc/contributing.texi:705
1082 msgid "Some modules are compatible with only one version of Python, others with both. If the package Foo is compiled with Python 3, we name it @code{python-foo}. If it is compiled with Python 2, we name it @code{python2-foo}. Packages should be added when they are necessary; we don't add Python 2 variants of the package unless we are going to use them."
1086 #: guix-git/doc/contributing.texi:711
1087 msgid "If a project already contains the word @code{python}, we drop this; for instance, the module python-dateutil is packaged under the names @code{python-dateutil} and @code{python2-dateutil}. If the project name starts with @code{py} (e.g.@: @code{pytz}), we keep it and prefix it as described above."
1090 #. type: subsubsection
1091 #: guix-git/doc/contributing.texi:712
1093 msgid "Specifying Dependencies"
1097 #: guix-git/doc/contributing.texi:713
1099 msgid "inputs, for Python packages"
1103 #: guix-git/doc/contributing.texi:718
1104 msgid "Dependency information for Python packages is usually available in the package source tree, with varying degrees of accuracy: in the @file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}."
1108 #: guix-git/doc/contributing.texi:724
1109 msgid "Your mission, when writing a recipe for a Python package, is to map these dependencies to the appropriate type of ``input'' (@pxref{package Reference, inputs}). Although the @code{pypi} importer normally does a good job (@pxref{Invoking guix import}), you may want to check the following check list to determine which dependency goes where."
1113 #: guix-git/doc/contributing.texi:732
1114 msgid "We currently package Python 2 with @code{setuptools} and @code{pip} installed like Python 3.4 has per default. Thus you don't need to specify either of these as an input. @command{guix lint} will warn you if you do."
1118 #: guix-git/doc/contributing.texi:738
1119 msgid "Python dependencies required at run time go into @code{propagated-inputs}. They are typically defined with the @code{install_requires} keyword in @file{setup.py}, or in the @file{requirements.txt} file."
1123 #: guix-git/doc/contributing.texi:746
1124 msgid "Python packages required only at build time---e.g., those listed with the @code{setup_requires} keyword in @file{setup.py}---or only for testing---e.g., those in @code{tests_require}---go into @code{native-inputs}. The rationale is that (1) they do not need to be propagated because they are not needed at run time, and (2) in a cross-compilation context, it's the ``native'' input that we'd want."
1128 #: guix-git/doc/contributing.texi:750
1129 msgid "Examples are the @code{pytest}, @code{mock}, and @code{nose} test frameworks. Of course if any of these packages is also required at run-time, it needs to go to @code{propagated-inputs}."
1133 #: guix-git/doc/contributing.texi:755
1134 msgid "Anything that does not fall in the previous categories goes to @code{inputs}, for example programs or C libraries required for building Python packages containing C extensions."
1138 #: guix-git/doc/contributing.texi:761
1139 msgid "If a Python package has optional dependencies (@code{extras_require}), it is up to you to decide whether to add them or not, based on their usefulness/overhead ratio (@pxref{Submitting Patches, @command{guix size}})."
1143 #: guix-git/doc/contributing.texi:768
1149 #: guix-git/doc/contributing.texi:779
1150 msgid "Perl programs standing for themselves are named as any other package, using the lowercase upstream name. For Perl packages containing a single class, we use the lowercase class name, replace all occurrences of @code{::} by dashes and prepend the prefix @code{perl-}. So the class @code{XML::Parser} becomes @code{perl-xml-parser}. Modules containing several classes keep their lowercase upstream name and are also prepended by @code{perl-}. Such modules tend to have the word @code{perl} somewhere in their name, which gets dropped in favor of the prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}."
1154 #: guix-git/doc/contributing.texi:784
1160 #: guix-git/doc/contributing.texi:787
1161 msgid "Java programs standing for themselves are named as any other package, using the lowercase upstream name."
1165 #: guix-git/doc/contributing.texi:793
1166 msgid "To avoid confusion and naming clashes with other programming languages, it is desirable that the name of a package for a Java package is prefixed with @code{java-}. If a project already contains the word @code{java}, we drop this; for instance, the package @code{ngsjava} is packaged under the name @code{java-ngs}."
1170 #: guix-git/doc/contributing.texi:799
1171 msgid "For Java packages containing a single class or a small class hierarchy, we use the lowercase class name, replace all occurrences of @code{.} by dashes and prepend the prefix @code{java-}. So the class @code{apache.commons.cli} becomes package @code{java-apache-commons-cli}."
1175 #: guix-git/doc/contributing.texi:804
1181 #: guix-git/doc/contributing.texi:807
1182 msgid "Rust programs standing for themselves are named as any other package, using the lowercase upstream name."
1186 #: guix-git/doc/contributing.texi:811
1187 msgid "To prevent namespace collisions we prefix all other Rust packages with the @code{rust-} prefix. The name should be changed to lowercase as appropriate and dashes should remain in place."
1191 #: guix-git/doc/contributing.texi:817
1192 msgid "In the rust ecosystem it is common for multiple incompatible versions of a package to be used at any given time, so all package definitions should have a versioned suffix. The versioned suffix is the left-most non-zero digit (and any leading zeros, of course). This follows the ``caret'' version scheme intended by Cargo. Examples@: @code{rust-clap-2}, @code{rust-rand-0.6}."
1196 #: guix-git/doc/contributing.texi:827
1197 msgid "Because of the difficulty in reusing rust packages as pre-compiled inputs for other packages the Cargo build system (@pxref{Build Systems, @code{cargo-build-system}}) presents the @code{#:cargo-inputs} and @code{cargo-development-inputs} keywords as build system arguments. It would be helpful to think of these as similar to @code{propagated-inputs} and @code{native-inputs}. Rust @code{dependencies} and @code{build-dependencies} should go in @code{#:cargo-inputs}, and @code{dev-dependencies} should go in @code{#:cargo-development-inputs}. If a Rust package links to other libraries then the standard placement in @code{inputs} and the like should be used."
1201 #: guix-git/doc/contributing.texi:833
1202 msgid "Care should be taken to ensure the correct version of dependencies are used; to this end we try to refrain from skipping the tests or using @code{#:skip-build?} when possible. Of course this is not always possible, as the package may be developed for a different Operating System, depend on features from the Nightly Rust compiler, or the test suite may have atrophied since it was released."
1206 #: guix-git/doc/contributing.texi:838 guix-git/doc/guix.texi:1880
1212 #: guix-git/doc/contributing.texi:844
1213 msgid "For fonts that are in general not installed by a user for typesetting purposes, or that are distributed as part of a larger software package, we rely on the general packaging rules for software; for instance, this applies to the fonts delivered as part of the X.Org system or fonts that are part of TeX Live."
1217 #: guix-git/doc/contributing.texi:848
1218 msgid "To make it easier for a user to search for fonts, names for other packages containing only fonts are constructed as follows, independently of the upstream package name."
1222 #: guix-git/doc/contributing.texi:856
1223 msgid "The name of a package containing only one font family starts with @code{font-}; it is followed by the foundry name and a dash @code{-} if the foundry is known, and the font family name, in which spaces are replaced by dashes (and as usual, all upper case letters are transformed to lower case). For example, the Gentium font family by SIL is packaged under the name @code{font-sil-gentium}."
1227 #: guix-git/doc/contributing.texi:865
1228 msgid "For a package containing several font families, the name of the collection is used in the place of the font family name. For instance, the Liberation fonts consist of three families, Liberation Sans, Liberation Serif and Liberation Mono. These could be packaged separately under the names @code{font-liberation-sans} and so on; but as they are distributed together under a common name, we prefer to package them together as @code{font-liberation}."
1232 #: guix-git/doc/contributing.texi:871
1233 msgid "In the case where several formats of the same font family or font collection are packaged separately, a short form of the format, prepended by a dash, is added to the package name. We use @code{-ttf} for TrueType fonts, @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 fonts."
1237 #: guix-git/doc/contributing.texi:879
1238 msgid "In general our code follows the GNU Coding Standards (@pxref{Top,,, standards, GNU Coding Standards}). However, they do not say much about Scheme, so here are some additional rules."
1242 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:887
1243 #: guix-git/doc/contributing.texi:888
1245 msgid "Programming Paradigm"
1249 #: guix-git/doc/contributing.texi:885
1250 msgid "How to compose your elements."
1254 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:894
1255 #: guix-git/doc/contributing.texi:895
1261 #: guix-git/doc/contributing.texi:885
1262 msgid "Where to store your code?"
1266 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:905
1267 #: guix-git/doc/contributing.texi:906
1269 msgid "Data Types and Pattern Matching"
1273 #: guix-git/doc/contributing.texi:885
1274 msgid "Implementing data structures."
1278 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:920
1279 #: guix-git/doc/contributing.texi:921
1281 msgid "Formatting Code"
1285 #: guix-git/doc/contributing.texi:885
1286 msgid "Writing conventions."
1290 #: guix-git/doc/contributing.texi:893
1291 msgid "Scheme code in Guix is written in a purely functional style. One exception is code that involves input/output, and procedures that implement low-level concepts, such as the @code{memoize} procedure."
1295 #: guix-git/doc/contributing.texi:901
1296 msgid "Guile modules that are meant to be used on the builder side must live in the @code{(guix build @dots{})} name space. They must not refer to other Guix or GNU modules. However, it is OK for a ``host-side'' module to use a build-side module."
1300 #: guix-git/doc/contributing.texi:904
1301 msgid "Modules that deal with the broader GNU system should be in the @code{(gnu @dots{})} name space rather than @code{(guix @dots{})}."
1305 #: guix-git/doc/contributing.texi:913
1306 msgid "The tendency in classical Lisp is to use lists to represent everything, and then to browse them ``by hand'' using @code{car}, @code{cdr}, @code{cadr}, and co. There are several problems with that style, notably the fact that it is hard to read, error-prone, and a hindrance to proper type error reports."
1310 #: guix-git/doc/contributing.texi:919
1311 msgid "Guix code should define appropriate data types (for instance, using @code{define-record-type*}) rather than abuse lists. In addition, it should use pattern matching, via Guile’s @code{(ice-9 match)} module, especially when matching lists (@pxref{Pattern Matching,,, guile, GNU Guile Reference Manual})."
1315 #: guix-git/doc/contributing.texi:923
1317 msgid "formatting code"
1321 #: guix-git/doc/contributing.texi:924
1323 msgid "coding style"
1327 #: guix-git/doc/contributing.texi:931
1328 msgid "When writing Scheme code, we follow common wisdom among Scheme programmers. In general, we follow the @url{https://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp Style Rules}. This document happens to describe the conventions mostly used in Guile’s code too. It is very thoughtful and well written, so please do read it."
1332 #: guix-git/doc/contributing.texi:938
1333 msgid "Some special forms introduced in Guix, such as the @code{substitute*} macro, have special indentation rules. These are defined in the @file{.dir-locals.el} file, which Emacs automatically uses. Also note that Emacs-Guix provides @code{guix-devel-mode} mode that indents and highlights Guix code properly (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference Manual})."
1337 #: guix-git/doc/contributing.texi:939
1339 msgid "indentation, of code"
1343 #: guix-git/doc/contributing.texi:940
1345 msgid "formatting, of code"
1349 #: guix-git/doc/contributing.texi:943
1350 msgid "If you do not use Emacs, please make sure to let your editor knows these rules. To automatically indent a package definition, you can also run:"
1354 #: guix-git/doc/contributing.texi:946
1356 msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
1360 #: guix-git/doc/contributing.texi:952
1361 msgid "This automatically indents the definition of @var{package} in @file{gnu/packages/@var{file}.scm} by running Emacs in batch mode. To indent a whole file, omit the second argument:"
1365 #: guix-git/doc/contributing.texi:955
1367 msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n"
1371 #: guix-git/doc/contributing.texi:957
1373 msgid "Vim, Scheme code editing"
1377 #: guix-git/doc/contributing.texi:963
1378 msgid "If you are editing code with Vim, we recommend that you run @code{:set autoindent} so that your code is automatically indented as you type. Additionally, @uref{https://www.vim.org/scripts/script.php?script_id=3998, @code{paredit.vim}} may help you deal with all these parentheses."
1382 #: guix-git/doc/contributing.texi:967
1383 msgid "We require all top-level procedures to carry a docstring. This requirement can be relaxed for simple private procedures in the @code{(guix build @dots{})} name space, though."
1387 #: guix-git/doc/contributing.texi:970
1388 msgid "Procedures should not have more than four positional parameters. Use keyword parameters for procedures that take more than four parameters."
1392 #: guix-git/doc/contributing.texi:981
1393 msgid "Development is done using the Git distributed version control system. Thus, access to the repository is not strictly necessary. We welcome contributions in the form of patches as produced by @code{git format-patch} sent to the @email{guix-patches@@gnu.org} mailing list. Seasoned Guix developers may also want to look at the section on commit access (@pxref{Commit Access})."
1397 #: guix-git/doc/contributing.texi:988
1398 msgid "This mailing list is backed by a Debbugs instance, which allows us to keep track of submissions (@pxref{Tracking Bugs and Patches}). Each message sent to that mailing list gets a new tracking number assigned; people can then follow up on the submission by sending email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking number (@pxref{Sending a Patch Series})."
1402 #: guix-git/doc/contributing.texi:992
1403 msgid "Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, standards, GNU Coding Standards}); you can check the commit history for examples."
1407 #: guix-git/doc/contributing.texi:995
1408 msgid "Before submitting a patch that adds or modifies a package definition, please run through this check list:"
1412 #: guix-git/doc/contributing.texi:1002
1413 msgid "If the authors of the packaged software provide a cryptographic signature for the release tarball, make an effort to verify the authenticity of the archive. For a detached GPG signature file this would be done with the @code{gpg --verify} command."
1417 #: guix-git/doc/contributing.texi:1006
1418 msgid "Take some time to provide an adequate synopsis and description for the package. @xref{Synopses and Descriptions}, for some guidelines."
1422 #: guix-git/doc/contributing.texi:1011
1423 msgid "Run @code{guix lint @var{package}}, where @var{package} is the name of the new or modified package, and fix any errors it reports (@pxref{Invoking guix lint})."
1427 #: guix-git/doc/contributing.texi:1015
1428 msgid "Make sure the package builds on your platform, using @code{guix build @var{package}}."
1432 #: guix-git/doc/contributing.texi:1022
1433 msgid "We recommend you also try building the package on other supported platforms. As you may not have access to actual hardware platforms, we recommend using the @code{qemu-binfmt-service-type} to emulate them. In order to enable it, add the following service to the list of services in your @code{operating-system} configuration:"
1437 #: guix-git/doc/contributing.texi:1027
1440 "(service qemu-binfmt-service-type\n"
1441 " (qemu-binfmt-configuration\n"
1442 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))\n"
1446 #: guix-git/doc/contributing.texi:1030
1447 msgid "Then reconfigure your system."
1451 #: guix-git/doc/contributing.texi:1035
1452 msgid "You can then build packages for different platforms by specifying the @code{--system} option. For example, to build the \"hello\" package for the armhf, aarch64, or mips64 architectures, you would run the following commands, respectively:"
1456 #: guix-git/doc/contributing.texi:1038
1459 "guix build --system=armhf-linux --rounds=2 hello\n"
1460 "guix build --system=aarch64-linux --rounds=2 hello\n"
1464 #: guix-git/doc/contributing.texi:1041
1470 #: guix-git/doc/contributing.texi:1044
1471 msgid "Make sure the package does not use bundled copies of software already available as separate packages."
1475 #: guix-git/doc/contributing.texi:1053
1476 msgid "Sometimes, packages include copies of the source code of their dependencies as a convenience for users. However, as a distribution, we want to make sure that such packages end up using the copy we already have in the distribution, if there is one. This improves resource usage (the dependency is built and stored only once), and allows the distribution to make transverse changes such as applying security updates for a given software package in a single place and have them affect the whole system---something that bundled copies prevent."
1480 #: guix-git/doc/contributing.texi:1062
1481 msgid "Take a look at the profile reported by @command{guix size} (@pxref{Invoking guix size}). This will allow you to notice references to other packages unwillingly retained. It may also help determine whether to split the package (@pxref{Packages with Multiple Outputs}), and which optional dependencies should be used. In particular, avoid adding @code{texlive} as a dependency: because of its extreme size, use the @code{texlive-tiny} package or @code{texlive-union} procedure instead."
1485 #: guix-git/doc/contributing.texi:1067
1486 msgid "For important changes, check that dependent package (if applicable) are not affected by the change; @code{guix refresh --list-dependent @var{package}} will help you do that (@pxref{Invoking guix refresh})."
1490 #: guix-git/doc/contributing.texi:1069
1492 msgid "branching strategy"
1496 #: guix-git/doc/contributing.texi:1070
1498 msgid "rebuild scheduling strategy"
1502 #: guix-git/doc/contributing.texi:1073
1503 msgid "Depending on the number of dependent packages and thus the amount of rebuilding induced, commits go to different branches, along these lines:"
1507 #: guix-git/doc/contributing.texi:1075
1509 msgid "300 dependent packages or less"
1513 #: guix-git/doc/contributing.texi:1077
1514 msgid "@code{master} branch (non-disruptive changes)."
1518 #: guix-git/doc/contributing.texi:1078
1520 msgid "between 300 and 1,800 dependent packages"
1524 #: guix-git/doc/contributing.texi:1083
1525 msgid "@code{staging} branch (non-disruptive changes). This branch is intended to be merged in @code{master} every 6 weeks or so. Topical changes (e.g., an update of the GNOME stack) can instead go to a specific branch (say, @code{gnome-updates})."
1529 #: guix-git/doc/contributing.texi:1084
1531 msgid "more than 1,800 dependent packages"
1535 #: guix-git/doc/contributing.texi:1088
1536 msgid "@code{core-updates} branch (may include major and potentially disruptive changes). This branch is intended to be merged in @code{master} every 6 months or so."
1540 #: guix-git/doc/contributing.texi:1095
1541 msgid "All these branches are @uref{@value{SUBSTITUTE-URL}, tracked by our build farm} and merged into @code{master} once everything has been successfully built. This allows us to fix issues before they hit users, and to reduce the window during which pre-built binaries are not available."
1545 #: guix-git/doc/contributing.texi:1104
1546 msgid "When we decide to start building the @code{staging} or @code{core-updates} branches, they will be forked and renamed with the suffix @code{-frozen}, at which time only bug fixes may be pushed to the frozen branches. The @code{core-updates} and @code{staging} branches will remain open to accept patches for the next cycle. Please ask on the mailing list or IRC if unsure where to place a patch."
1550 #: guix-git/doc/contributing.texi:1106
1552 msgid "determinism, of build processes"
1556 #: guix-git/doc/contributing.texi:1107
1558 msgid "reproducible builds, checking"
1562 #: guix-git/doc/contributing.texi:1111
1563 msgid "Check whether the package's build process is deterministic. This typically means checking whether an independent build of the package yields the exact same result that you obtained, bit for bit."
1567 #: guix-git/doc/contributing.texi:1114
1568 msgid "A simple way to do that is by building the same package several times in a row on your machine (@pxref{Invoking guix build}):"
1572 #: guix-git/doc/contributing.texi:1117
1574 msgid "guix build --rounds=2 my-package\n"
1578 #: guix-git/doc/contributing.texi:1121
1579 msgid "This is enough to catch a class of common non-determinism issues, such as timestamps or randomly-generated output in the build result."
1583 #: guix-git/doc/contributing.texi:1131
1584 msgid "Another option is to use @command{guix challenge} (@pxref{Invoking guix challenge}). You may run it once the package has been committed and built by @code{@value{SUBSTITUTE-SERVER}} to check whether it obtains the same result as you did. Better yet: Find another machine that can build it and run @command{guix publish}. Since the remote build machine is likely different from yours, this can catch non-determinism issues related to the hardware---e.g., use of different instruction set extensions---or to the operating system kernel---e.g., reliance on @code{uname} or @file{/proc} files."
1588 #: guix-git/doc/contributing.texi:1137
1589 msgid "When writing documentation, please use gender-neutral wording when referring to people, such as @uref{https://en.wikipedia.org/wiki/Singular_they, singular ``they''@comma{} ``their''@comma{} ``them''}, and so forth."
1593 #: guix-git/doc/contributing.texi:1141
1594 msgid "Verify that your patch contains only one set of related changes. Bundling unrelated changes together makes reviewing harder and slower."
1598 #: guix-git/doc/contributing.texi:1144
1599 msgid "Examples of unrelated changes include the addition of several packages, or a package update along with fixes to that package."
1603 #: guix-git/doc/contributing.texi:1149
1604 msgid "Please follow our code formatting rules, possibly running the @command{etc/indent-code.el} script to do that automatically for you (@pxref{Formatting Code})."
1608 #: guix-git/doc/contributing.texi:1157
1609 msgid "When possible, use mirrors in the source URL (@pxref{Invoking guix download}). Use reliable URLs, not generated ones. For instance, GitHub archives are not necessarily identical from one generation to the next, so in this case it's often better to clone the repository. Don't use the @command{name} field in the URL: it is not very useful and if the name changes, the URL will probably be wrong."
1613 #: guix-git/doc/contributing.texi:1161
1614 msgid "Check if Guix builds (@pxref{Building from Git}) and address the warnings, especially those about use of undefined symbols."
1618 #: guix-git/doc/contributing.texi:1164
1619 msgid "Make sure your changes do not break Guix and simulate a @code{guix pull} with:"
1623 #: guix-git/doc/contributing.texi:1166
1625 msgid "guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master\n"
1629 #: guix-git/doc/contributing.texi:1179
1630 msgid "When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a subject, if your patch is to be applied on a branch other than @code{master}, say @code{core-updates}, specify it in the subject like @samp{[PATCH core-updates] @dots{}}. You may use your email client or the @command{git send-email} command (@pxref{Sending a Patch Series}). We prefer to get patches in plain text messages, either inline or as MIME attachments. You are advised to pay attention if your email client changes anything like line breaks or indentation which could potentially break the patches."
1634 #: guix-git/doc/contributing.texi:1182
1635 msgid "When a bug is resolved, please close the thread by sending an email to @email{@var{NNN}-done@@debbugs.gnu.org}."
1639 #: guix-git/doc/contributing.texi:1183 guix-git/doc/contributing.texi:1185
1641 msgid "Sending a Patch Series"
1645 #: guix-git/doc/contributing.texi:1185
1647 msgid "patch series"
1651 #: guix-git/doc/contributing.texi:1186
1653 msgid "git send-email"
1657 #: guix-git/doc/contributing.texi:1187
1659 msgid "git-send-email"
1663 #: guix-git/doc/contributing.texi:1197
1664 msgid "When sending a patch series (e.g., using @code{git send-email}), please first send one message to @email{guix-patches@@gnu.org}, and then send subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure they are kept together. See @uref{https://debbugs.gnu.org/Advanced.html, the Debbugs documentation} for more information. You can install @command{git send-email} with @command{guix install git:send-email}."
1668 #: guix-git/doc/contributing.texi:1201
1670 msgid "bug reports, tracking"
1674 #: guix-git/doc/contributing.texi:1202
1676 msgid "patch submissions, tracking"
1680 #: guix-git/doc/contributing.texi:1203
1682 msgid "issue tracking"
1686 #: guix-git/doc/contributing.texi:1204
1688 msgid "Debbugs, issue tracking system"
1692 #: guix-git/doc/contributing.texi:1211
1693 msgid "Bug reports and patch submissions are currently tracked using the Debbugs instance at @uref{https://bugs.gnu.org}. Bug reports are filed against the @code{guix} ``package'' (in Debbugs parlance), by sending email to @email{bug-guix@@gnu.org}, while patch submissions are filed against the @code{guix-patches} package by sending email to @email{guix-patches@@gnu.org} (@pxref{Submitting Patches})."
1697 #: guix-git/doc/contributing.texi:1214
1698 msgid "A web interface (actually @emph{two} web interfaces!) are available to browse issues:"
1702 #: guix-git/doc/contributing.texi:1223
1703 msgid "@url{https://issues.guix.gnu.org} provides a pleasant interface@footnote{The web interface at @url{https://issues.guix.gnu.org} is powered by Mumi, a nice piece of software written in Guile, and you can help! See @url{https://git.elephly.net/gitweb.cgi?p=software/mumi.git}.} to browse bug reports and patches, and to participate in discussions;"
1707 #: guix-git/doc/contributing.texi:1225
1708 msgid "@url{https://bugs.gnu.org/guix} lists bug reports;"
1712 #: guix-git/doc/contributing.texi:1227
1713 msgid "@url{https://bugs.gnu.org/guix-patches} lists patch submissions."
1717 #: guix-git/doc/contributing.texi:1232
1718 msgid "To view discussions related to issue number @var{n}, go to @indicateurl{https://issues.guix.gnu.org/@var{n}} or @indicateurl{https://bugs.gnu.org/@var{n}}."
1722 #: guix-git/doc/contributing.texi:1235
1723 msgid "If you use Emacs, you may find it more convenient to interact with issues using @file{debbugs.el}, which you can install with:"
1727 #: guix-git/doc/contributing.texi:1238
1729 msgid "guix install emacs-debbugs\n"
1733 #: guix-git/doc/contributing.texi:1241
1734 msgid "For example, to list all open issues on @code{guix-patches}, hit:"
1738 #: guix-git/doc/contributing.texi:1244
1740 msgid "@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y\n"
1744 #: guix-git/doc/contributing.texi:1248
1745 msgid "@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on this nifty tool!"
1749 #: guix-git/doc/contributing.texi:1252
1751 msgid "commit access, for developers"
1755 #: guix-git/doc/contributing.texi:1256
1756 msgid "For frequent contributors, having write access to the repository is convenient. When you deem it necessary, consider applying for commit access by following these steps:"
1760 #: guix-git/doc/contributing.texi:1265
1761 msgid "Find three committers who would vouch for you. You can view the list of committers at @url{https://savannah.gnu.org/project/memberlist.php?group=guix}. Each of them should email a statement to @email{guix-maintainers@@gnu.org} (a private alias for the collective of maintainers), signed with their OpenPGP key."
1765 #: guix-git/doc/contributing.texi:1271
1766 msgid "Committers are expected to have had some interactions with you as a contributor and to be able to judge whether you are sufficiently familiar with the project's practices. It is @emph{not} a judgment on the value of your work, so a refusal should rather be interpreted as ``let's try again later''."
1770 #: guix-git/doc/contributing.texi:1278
1771 msgid "Send @email{guix-maintainers@@gnu.org} a message stating your intent, listing the three committers who support your application, signed with the OpenPGP key you will use to sign commits, and giving its fingerprint (see below). See @uref{https://emailselfdefense.fsf.org/en/}, for an introduction to public-key cryptography with GnuPG."
1775 #: guix-git/doc/contributing.texi:1284
1776 msgid "Set up GnuPG such that it never uses the SHA1 hash algorithm for digital signatures, which is known to be unsafe since 2019, for instance by adding the following line to @file{~/.gnupg/gpg.conf} (@pxref{GPG Esoteric Options,,, gnupg, The GNU Privacy Guard Manual}):"
1780 #: guix-git/doc/contributing.texi:1287
1782 msgid "digest-algo sha512\n"
1786 #: guix-git/doc/contributing.texi:1292
1787 msgid "Maintainers ultimately decide whether to grant you commit access, usually following your referrals' recommendation."
1791 #: guix-git/doc/contributing.texi:1294
1793 msgid "OpenPGP, signed commits"
1797 #: guix-git/doc/contributing.texi:1299
1798 msgid "If and once you've been given access, please send a message to @email{guix-devel@@gnu.org} to say so, again signed with the OpenPGP key you will use to sign commits (do that before pushing your first commit). That way, everyone can notice and ensure you control that OpenPGP key."
1802 #: guix-git/doc/contributing.texi:1300
1808 #: guix-git/doc/contributing.texi:1302
1809 msgid "Before you can push for the first time, maintainers must:"
1813 #: guix-git/doc/contributing.texi:1306
1814 msgid "add your OpenPGP key to the @code{keyring} branch;"
1818 #: guix-git/doc/contributing.texi:1309
1819 msgid "add your OpenPGP fingerprint to the @file{.guix-authorizations} file of the branch(es) you will commit to."
1823 #: guix-git/doc/contributing.texi:1314
1824 msgid "Make sure to read the rest of this section and... profit!"
1828 #: guix-git/doc/contributing.texi:1320
1829 msgid "Maintainers are happy to give commit access to people who have been contributing for some time and have a track record---don't be shy and don't underestimate your work!"
1833 #: guix-git/doc/contributing.texi:1324
1834 msgid "However, note that the project is working towards a more automated patch review and merging system, which, as a consequence, may lead us to have fewer people with commit access to the main repository. Stay tuned!"
1838 #: guix-git/doc/contributing.texi:1329
1839 msgid "If you get commit access, please make sure to follow the policy below (discussions of the policy can take place on @email{guix-devel@@gnu.org})."
1843 #: guix-git/doc/contributing.texi:1334
1844 msgid "Non-trivial patches should always be posted to @email{guix-patches@@gnu.org} (trivial patches include fixing typos, etc.). This mailing list fills the patch-tracking database (@pxref{Tracking Bugs and Patches})."
1848 #: guix-git/doc/contributing.texi:1343
1849 msgid "For patches that just add a new package, and a simple one, it's OK to commit, if you're confident (which means you successfully built it in a chroot setup, and have done a reasonable copyright and license auditing). Likewise for package upgrades, except upgrades that trigger a lot of rebuilds (for example, upgrading GnuTLS or GLib). We have a mailing list for commit notifications (@email{guix-commits@@gnu.org}), so people can notice. Before pushing your changes, make sure to run @code{git pull --rebase}."
1853 #: guix-git/doc/contributing.texi:1349
1854 msgid "All commits that are pushed to the central repository on Savannah must be signed with an OpenPGP key, and the public key should be uploaded to your user account on Savannah and to public key servers, such as @code{keys.openpgp.org}. To configure Git to automatically sign commits, run:"
1858 #: guix-git/doc/contributing.texi:1353
1861 "git config commit.gpgsign true\n"
1862 "git config user.signingkey CABBA6EA1DC0FF33\n"
1866 #: guix-git/doc/contributing.texi:1358
1867 msgid "You can prevent yourself from accidentally pushing unsigned commits to Savannah by using the pre-push Git hook called located at @file{etc/git/pre-push}:"
1871 #: guix-git/doc/contributing.texi:1361
1873 msgid "cp etc/git/pre-push .git/hooks/pre-push\n"
1877 #: guix-git/doc/contributing.texi:1367
1878 msgid "When pushing a commit on behalf of somebody else, please add a @code{Signed-off-by} line at the end of the commit log message---e.g., with @command{git am --signoff}. This improves tracking of who did what."
1882 #: guix-git/doc/contributing.texi:1371
1883 msgid "When adding channel news entries (@pxref{Channels, Writing Channel News}), make sure they are well-formed by running the following command right before pushing:"
1887 #: guix-git/doc/contributing.texi:1374
1889 msgid "make check-channel-news\n"
1893 #: guix-git/doc/contributing.texi:1380
1894 msgid "For anything else, please post to @email{guix-patches@@gnu.org} and leave time for a review, without committing anything (@pxref{Submitting Patches}). If you didn’t receive any reply after two weeks, and if you're confident, it's OK to commit."
1898 #: guix-git/doc/contributing.texi:1383
1899 msgid "That last part is subject to being adjusted, allowing individuals to commit directly on non-controversial changes on parts they’re familiar with."
1903 #: guix-git/doc/contributing.texi:1389
1904 msgid "In order to reduce the possibility of mistakes, committers will have their Savannah account removed from the Guix Savannah project and their key removed from @file{.guix-authorizations} after 12 months of inactivity; they can ask to regain commit access by emailing the maintainers, without going through the vouching process."
1908 #: guix-git/doc/contributing.texi:1395
1909 msgid "One last thing: the project keeps moving forward because committers not only push their own awesome changes, but also offer some of their time @emph{reviewing} and pushing other people's changes. As a committer, you're welcome to use your expertise and commit rights to help other contributors, too!"
1913 #: guix-git/doc/contributing.texi:1399
1915 msgid "update-guix-package, updating the guix package"
1919 #: guix-git/doc/contributing.texi:1405
1920 msgid "It is sometimes desirable to update the @code{guix} package itself (the package defined in @code{(gnu packages package-management)}), for example to make new daemon features available for use by the @code{guix-service-type} service type. In order to simplify this task, the following command can be used:"
1924 #: guix-git/doc/contributing.texi:1408
1926 msgid "make update-guix-package\n"
1930 #: guix-git/doc/contributing.texi:1415
1931 msgid "The @code{update-guix-package} make target will use the last known @emph{commit} corresponding to @code{HEAD} in your Guix checkout, compute the hash of the Guix sources corresponding to that commit and update the @code{commit}, @code{revision} and hash of the @code{guix} package definition."
1935 #: guix-git/doc/contributing.texi:1419
1936 msgid "To validate that the updated @code{guix} package hashes are correct and that it can be built successfully, the following command can be run from the directory of your Guix checkout:"
1940 #: guix-git/doc/contributing.texi:1422
1942 msgid "./pre-inst-env guix build guix\n"
1946 #: guix-git/doc/contributing.texi:1427
1947 msgid "To guard against accidentally updating the @code{guix} package to a commit that others can't refer to, a check is made that the commit used has already been pushed to the Savannah-hosted Guix git repository."
1951 #: guix-git/doc/contributing.texi:1431
1952 msgid "This check can be disabled, @emph{at your own peril}, by setting the @code{GUIX_ALLOW_ME_TO_USE_PRIVATE_COMMIT} environment variable. When this variable is set, the updated package source is also added to the store. This is used as part of the release process of Guix."
1956 #: guix-git/doc/guix.texi:7
1957 msgid "@documentencoding UTF-8"
1961 #: guix-git/doc/guix.texi:7 guix-git/doc/guix.texi:118
1963 msgid "GNU Guix Reference Manual"
1967 #: guix-git/doc/guix.texi:10
1969 msgid "version.texi"
1970 msgstr "version-sk.texi"
1973 #: guix-git/doc/guix.texi:91
1974 msgid "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017, 2019, 2020, 2021 Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018, 2019, 2020 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita Gillmann@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Jan Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* Copyright @copyright{} 2017, 2018, 2019 Clément Lassieur@* Copyright @copyright{} 2017, 2018, 2020, 2021 Mathieu Othacehe@* Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, 2018 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017, 2021 Christopher Lemmer Webber@* Copyright @copyright{} 2017, 2018, 2019, 2020 Marius Bakke@* Copyright @copyright{} 2017, 2019, 2020 Hartmut Goebel@* Copyright @copyright{} 2017, 2019, 2020, 2021 Maxim Cournoyer@* Copyright @copyright{} 2017, 2018, 2019, 2020, 2021 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018, 2019, 2020 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018, 2021 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright @copyright{} 2018, 2019 Gábor Boskovits@* Copyright @copyright{} 2018, 2019, 2020 Florian Pelz@* Copyright @copyright{} 2018 Laura Lazzati@* Copyright @copyright{} 2018 Alex Vong@* Copyright @copyright{} 2019 Josh Holland@* Copyright @copyright{} 2019, 2020 Diego Nicola Barbato@* Copyright @copyright{} 2019 Ivan Petkov@* Copyright @copyright{} 2019 Jakob L. Kreuze@* Copyright @copyright{} 2019 Kyle Andrews@* Copyright @copyright{} 2019 Alex Griffin@* Copyright @copyright{} 2019, 2020 Guillaume Le Vaillant@* Copyright @copyright{} 2020 Leo Prikler@* Copyright @copyright{} 2019, 2020 Simon Tournier@* Copyright @copyright{} 2020 Wiktor Żelazny@* Copyright @copyright{} 2020 Damien Cassou@* Copyright @copyright{} 2020 Jakub Kądziołka@* Copyright @copyright{} 2020 Jack Hill@* Copyright @copyright{} 2020 Naga Malleswari@* Copyright @copyright{} 2020 Brice Waegeneire@* Copyright @copyright{} 2020 R Veera Kumar@* Copyright @copyright{} 2020 Pierre Langlois@* Copyright @copyright{} 2020 pinoaffe@* Copyright @copyright{} 2020 André Batista@* Copyright @copyright{} 2020, 2021 Alexandru-Sergiu Marton@* Copyright @copyright{} 2020 raingloom@* Copyright @copyright{} 2020 Daniel Brooks@* Copyright @copyright{} 2020 John Soo@* Copyright @copyright{} 2020 Jonathan Brielmaier@* Copyright @copyright{} 2020 Edgar Vincent@* Copyright @copyright{} 2021 Maxime Devos@*"
1978 #: guix-git/doc/guix.texi:98
1979 msgid "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''."
1982 #. type: dircategory
1983 #: guix-git/doc/guix.texi:100
1985 msgid "System administration"
1989 #: guix-git/doc/guix.texi:108
1990 msgid "Guix: (guix)"
1994 #: guix-git/doc/guix.texi:108
1995 msgid "Manage installed software and system configuration."
1999 #: guix-git/doc/guix.texi:108
2000 msgid "guix package: (guix)Invoking guix package"
2004 #: guix-git/doc/guix.texi:108
2005 msgid "Installing, removing, and upgrading packages."
2009 #: guix-git/doc/guix.texi:108
2010 msgid "guix gc: (guix)Invoking guix gc"
2014 #: guix-git/doc/guix.texi:108
2015 msgid "Reclaiming unused disk space."
2019 #: guix-git/doc/guix.texi:108
2020 msgid "guix pull: (guix)Invoking guix pull"
2024 #: guix-git/doc/guix.texi:108
2025 msgid "Update the list of available packages."
2029 #: guix-git/doc/guix.texi:108
2030 msgid "guix system: (guix)Invoking guix system"
2034 #: guix-git/doc/guix.texi:108
2035 msgid "Manage the operating system configuration."
2039 #: guix-git/doc/guix.texi:108
2040 msgid "guix deploy: (guix)Invoking guix deploy"
2044 #: guix-git/doc/guix.texi:108
2045 msgid "Manage operating system configurations for remote hosts."
2048 #. type: dircategory
2049 #: guix-git/doc/guix.texi:110
2051 msgid "Software development"
2055 #: guix-git/doc/guix.texi:115
2056 msgid "guix environment: (guix)Invoking guix environment"
2060 #: guix-git/doc/guix.texi:115
2061 msgid "Building development environments with Guix."
2065 #: guix-git/doc/guix.texi:115
2066 msgid "guix build: (guix)Invoking guix build"
2070 #: guix-git/doc/guix.texi:115
2071 msgid "Building packages."
2075 #: guix-git/doc/guix.texi:115
2076 msgid "guix pack: (guix)Invoking guix pack"
2080 #: guix-git/doc/guix.texi:115
2081 msgid "Creating binary bundles."
2085 #: guix-git/doc/guix.texi:119
2087 msgid "Using the GNU Guix Functional Package Manager"
2091 #: guix-git/doc/guix.texi:120
2093 msgid "The GNU Guix Developers"
2097 #: guix-git/doc/guix.texi:126
2098 msgid "Edition @value{EDITION} @* @value{UPDATED} @*"
2102 #: guix-git/doc/guix.texi:133
2108 #: guix-git/doc/guix.texi:134
2114 #: guix-git/doc/guix.texi:138
2115 msgid "This document describes GNU Guix version @value{VERSION}, a functional package management tool written for the GNU system."
2118 #. You can replace the following paragraph with information on
2120 #: guix-git/doc/guix.texi:150
2121 msgid "This manual is also available in Simplified Chinese (@pxref{Top,,, guix.zh_CN, GNU Guix参考手册}), French (@pxref{Top,,, guix.fr, Manuel de référence de GNU Guix}), German (@pxref{Top,,, guix.de, Referenzhandbuch zu GNU Guix}), Spanish (@pxref{Top,,, guix.es, Manual de referencia de GNU Guix}), and Russian (@pxref{Top,,, guix.ru, Руководство GNU Guix}). If you would like to translate it in your native language, consider joining @uref{https://translate.fedoraproject.org/projects/guix/documentation-manual, Weblate}."
2125 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:178
2126 #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:380
2128 msgid "Introduction"
2132 #: guix-git/doc/guix.texi:168
2133 msgid "What is Guix about?"
2137 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:183
2138 #: guix-git/doc/guix.texi:560 guix-git/doc/guix.texi:561
2140 msgid "Installation"
2144 #: guix-git/doc/guix.texi:168
2145 msgid "Installing Guix."
2149 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:199
2150 #: guix-git/doc/guix.texi:1999 guix-git/doc/guix.texi:2000
2152 msgid "System Installation"
2156 #: guix-git/doc/guix.texi:168
2157 msgid "Installing the whole operating system."
2161 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:2740
2162 #: guix-git/doc/guix.texi:2741
2164 msgid "Getting Started"
2168 #: guix-git/doc/guix.texi:168
2169 msgid "Your first steps."
2173 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:216
2174 #: guix-git/doc/guix.texi:2948 guix-git/doc/guix.texi:2949
2176 msgid "Package Management"
2180 #: guix-git/doc/guix.texi:168
2181 msgid "Package installation, upgrade, etc."
2185 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:239
2186 #: guix-git/doc/guix.texi:4998 guix-git/doc/guix.texi:4999
2192 #: guix-git/doc/guix.texi:168
2193 msgid "Customizing the package collection."
2197 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:253
2198 #: guix-git/doc/guix.texi:5526 guix-git/doc/guix.texi:5527
2204 #: guix-git/doc/guix.texi:168
2205 msgid "Guix-aided software development."
2209 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:260
2210 #: guix-git/doc/guix.texi:6352 guix-git/doc/guix.texi:6353
2212 msgid "Programming Interface"
2216 #: guix-git/doc/guix.texi:168
2217 msgid "Using Guix in Scheme."
2221 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:279
2222 #: guix-git/doc/guix.texi:10148 guix-git/doc/guix.texi:10149
2228 #: guix-git/doc/guix.texi:168
2229 msgid "Package management commands."
2233 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:304
2234 #: guix-git/doc/guix.texi:13358 guix-git/doc/guix.texi:13359
2236 msgid "System Configuration"
2240 #: guix-git/doc/guix.texi:168
2241 msgid "Configuring the operating system."
2245 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34389
2246 #: guix-git/doc/guix.texi:34390
2248 msgid "Documentation"
2252 #: guix-git/doc/guix.texi:168
2253 msgid "Browsing software user manuals."
2257 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:366
2258 #: guix-git/doc/guix.texi:34453 guix-git/doc/guix.texi:34454
2260 msgid "Installing Debugging Files"
2264 #: guix-git/doc/guix.texi:168
2265 msgid "Feeding the debugger."
2269 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34594
2270 #: guix-git/doc/guix.texi:34595
2272 msgid "Security Updates"
2276 #: guix-git/doc/guix.texi:168
2277 msgid "Deploying security fixes quickly."
2281 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:371
2282 #: guix-git/doc/guix.texi:34709 guix-git/doc/guix.texi:34710
2284 msgid "Bootstrapping"
2288 #: guix-git/doc/guix.texi:168
2289 msgid "GNU/Linux built from scratch."
2293 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:35001
2299 #: guix-git/doc/guix.texi:168
2300 msgid "Targeting another platform or kernel."
2304 #: guix-git/doc/guix.texi:168
2305 msgid "Your help needed!"
2309 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35049
2310 #: guix-git/doc/guix.texi:35050
2312 msgid "Acknowledgments"
2316 #: guix-git/doc/guix.texi:173
2321 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35071
2322 #: guix-git/doc/guix.texi:35072
2324 msgid "GNU Free Documentation License"
2328 #: guix-git/doc/guix.texi:173
2329 msgid "The license of this manual."
2333 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35077
2334 #: guix-git/doc/guix.texi:35078
2336 msgid "Concept Index"
2340 #: guix-git/doc/guix.texi:173
2345 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35081
2346 #: guix-git/doc/guix.texi:35082
2348 msgid "Programming Index"
2352 #: guix-git/doc/guix.texi:173
2353 msgid "Data types, functions, and variables."
2357 #: guix-git/doc/guix.texi:176
2358 msgid "--- The Detailed Node Listing ---"
2362 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2363 #: guix-git/doc/guix.texi:408 guix-git/doc/guix.texi:409
2365 msgid "Managing Software the Guix Way"
2369 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2370 msgid "What's special."
2374 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2375 #: guix-git/doc/guix.texi:463 guix-git/doc/guix.texi:464
2377 msgid "GNU Distribution"
2381 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2382 msgid "The packages and tools."
2386 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2387 #: guix-git/doc/guix.texi:602 guix-git/doc/guix.texi:603
2389 msgid "Binary Installation"
2393 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2394 msgid "Getting Guix running in no time!"
2398 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2399 #: guix-git/doc/guix.texi:820 guix-git/doc/guix.texi:821
2401 msgid "Requirements"
2405 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2406 msgid "Software needed to build and run Guix."
2410 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2411 #: guix-git/doc/guix.texi:908 guix-git/doc/guix.texi:909
2413 msgid "Running the Test Suite"
2417 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2418 msgid "Testing Guix."
2422 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:193
2423 #: guix-git/doc/guix.texi:600 guix-git/doc/guix.texi:1005
2424 #: guix-git/doc/guix.texi:1006
2426 msgid "Setting Up the Daemon"
2430 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2431 msgid "Preparing the build daemon's environment."
2435 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2436 #: guix-git/doc/guix.texi:1475
2438 msgid "Invoking guix-daemon"
2442 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2443 msgid "Running the build daemon."
2447 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2448 #: guix-git/doc/guix.texi:1777 guix-git/doc/guix.texi:1778
2450 msgid "Application Setup"
2454 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2455 msgid "Application-specific setup."
2459 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2460 #: guix-git/doc/guix.texi:1962 guix-git/doc/guix.texi:1963
2462 msgid "Upgrading Guix"
2466 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2467 msgid "Upgrading Guix and its build daemon."
2471 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2472 #: guix-git/doc/guix.texi:1027 guix-git/doc/guix.texi:1028
2474 msgid "Build Environment Setup"
2478 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2479 msgid "Preparing the isolated build environment."
2483 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2484 #: guix-git/doc/guix.texi:1146
2486 msgid "Daemon Offload Setup"
2490 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2491 msgid "Offloading builds to remote machines."
2495 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2496 #: guix-git/doc/guix.texi:1384 guix-git/doc/guix.texi:1385
2498 msgid "SELinux Support"
2502 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1025
2503 msgid "Using an SELinux policy for the daemon."
2507 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:1420
2508 #: guix-git/doc/guix.texi:2033 guix-git/doc/guix.texi:2035
2509 #: guix-git/doc/guix.texi:2036
2515 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2516 msgid "What you can expect."
2520 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2521 #: guix-git/doc/guix.texi:2061 guix-git/doc/guix.texi:2062
2523 msgid "Hardware Considerations"
2527 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2528 msgid "Supported hardware."
2532 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2533 #: guix-git/doc/guix.texi:2096 guix-git/doc/guix.texi:2097
2535 msgid "USB Stick and DVD Installation"
2539 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2540 msgid "Preparing the installation medium."
2544 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2545 #: guix-git/doc/guix.texi:2201 guix-git/doc/guix.texi:2202
2547 msgid "Preparing for Installation"
2551 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2552 msgid "Networking, partitioning, etc."
2556 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2557 #: guix-git/doc/guix.texi:2224 guix-git/doc/guix.texi:2225
2559 msgid "Guided Graphical Installation"
2563 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2564 msgid "Easy graphical installation."
2568 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:211
2569 #: guix-git/doc/guix.texi:2033 guix-git/doc/guix.texi:2255
2570 #: guix-git/doc/guix.texi:2256
2572 msgid "Manual Installation"
2576 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2577 msgid "Manual installation for wizards."
2581 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2582 #: guix-git/doc/guix.texi:2623 guix-git/doc/guix.texi:2624
2584 msgid "After System Installation"
2588 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2589 msgid "When installation succeeded."
2593 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2594 #: guix-git/doc/guix.texi:2657
2596 msgid "Installing Guix in a VM"
2600 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2601 msgid "Guix System playground."
2605 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2606 #: guix-git/doc/guix.texi:2708 guix-git/doc/guix.texi:2709
2608 msgid "Building the Installation Image"
2612 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2033
2613 msgid "How this comes to be."
2617 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2273
2618 #: guix-git/doc/guix.texi:2275
2620 msgid "Keyboard Layout and Networking and Partitioning"
2624 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2273
2625 msgid "Initial setup."
2629 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2273
2630 #: guix-git/doc/guix.texi:2535 guix-git/doc/guix.texi:2536
2632 msgid "Proceeding with the Installation"
2636 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2273
2641 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2642 #: guix-git/doc/guix.texi:2982 guix-git/doc/guix.texi:2983
2648 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2649 msgid "How Guix will make your life brighter."
2653 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2654 #: guix-git/doc/guix.texi:3072
2656 msgid "Invoking guix package"
2660 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2661 msgid "Package installation, removal, etc."
2665 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:229
2666 #: guix-git/doc/guix.texi:2980 guix-git/doc/guix.texi:3688
2667 #: guix-git/doc/guix.texi:3689
2673 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2674 msgid "Downloading pre-built binaries."
2678 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2679 #: guix-git/doc/guix.texi:4019 guix-git/doc/guix.texi:4020
2681 msgid "Packages with Multiple Outputs"
2685 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2686 msgid "Single source package, multiple outputs."
2690 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2691 #: guix-git/doc/guix.texi:4073
2693 msgid "Invoking guix gc"
2697 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2698 msgid "Running the garbage collector."
2702 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2703 #: guix-git/doc/guix.texi:4283
2705 msgid "Invoking guix pull"
2709 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2710 msgid "Fetching the latest Guix and distribution."
2714 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2715 #: guix-git/doc/guix.texi:4530
2717 msgid "Invoking guix time-machine"
2721 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2722 msgid "Running an older revision of Guix."
2726 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2727 #: guix-git/doc/guix.texi:4585 guix-git/doc/guix.texi:4586
2733 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2734 msgid "Interacting with another revision of Guix."
2738 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2739 #: guix-git/doc/guix.texi:4713
2741 msgid "Invoking guix describe"
2745 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2746 msgid "Display information about your Guix revision."
2750 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2751 #: guix-git/doc/guix.texi:4808
2753 msgid "Invoking guix archive"
2757 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2980
2758 msgid "Exporting and importing store files."
2762 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2763 #: guix-git/doc/guix.texi:3714 guix-git/doc/guix.texi:3715
2765 msgid "Official Substitute Server"
2769 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2770 msgid "One particular source of substitutes."
2774 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2775 #: guix-git/doc/guix.texi:3743 guix-git/doc/guix.texi:3744
2777 msgid "Substitute Server Authorization"
2781 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2782 msgid "How to enable or disable substitutes."
2786 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2787 #: guix-git/doc/guix.texi:3812 guix-git/doc/guix.texi:3813
2789 msgid "Getting Substitutes from Other Servers"
2793 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2794 msgid "Substitute diversity."
2798 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2799 #: guix-git/doc/guix.texi:3914 guix-git/doc/guix.texi:3915
2801 msgid "Substitute Authentication"
2805 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2806 msgid "How Guix verifies substitutes."
2810 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2811 #: guix-git/doc/guix.texi:3949 guix-git/doc/guix.texi:3950
2813 msgid "Proxy Settings"
2817 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2818 msgid "How to get substitutes via proxy."
2822 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2823 #: guix-git/doc/guix.texi:3961 guix-git/doc/guix.texi:3962
2825 msgid "Substitution Failure"
2829 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2830 msgid "What happens when substitution fails."
2834 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2835 #: guix-git/doc/guix.texi:3989 guix-git/doc/guix.texi:3990
2837 msgid "On Trusting Binaries"
2841 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3712
2842 msgid "How can you trust that binary blob?"
2846 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2847 #: guix-git/doc/guix.texi:5031 guix-git/doc/guix.texi:5032
2849 msgid "Specifying Additional Channels"
2853 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2854 msgid "Extending the package collection."
2858 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2859 #: guix-git/doc/guix.texi:5081 guix-git/doc/guix.texi:5082
2861 msgid "Using a Custom Guix Channel"
2865 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2866 msgid "Using a customized Guix."
2870 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2871 #: guix-git/doc/guix.texi:5103 guix-git/doc/guix.texi:5104
2873 msgid "Replicating Guix"
2877 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2878 msgid "Running the @emph{exact same} Guix."
2882 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2883 #: guix-git/doc/guix.texi:5144 guix-git/doc/guix.texi:5145
2885 msgid "Channel Authentication"
2889 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2890 msgid "How Guix verifies what it fetches."
2894 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2895 #: guix-git/doc/guix.texi:5184 guix-git/doc/guix.texi:5185
2897 msgid "Channels with Substitutes"
2901 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2902 msgid "Using channels with available substitutes."
2906 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2907 #: guix-git/doc/guix.texi:5209 guix-git/doc/guix.texi:5210
2909 msgid "Creating a Channel"
2913 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2914 msgid "How to write your custom channel."
2918 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2919 #: guix-git/doc/guix.texi:5276 guix-git/doc/guix.texi:5277
2921 msgid "Package Modules in a Sub-directory"
2925 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2926 msgid "Specifying the channel's package modules location."
2930 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2931 #: guix-git/doc/guix.texi:5290 guix-git/doc/guix.texi:5291
2933 msgid "Declaring Channel Dependencies"
2937 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2938 msgid "How to depend on other channels."
2942 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2943 #: guix-git/doc/guix.texi:5332 guix-git/doc/guix.texi:5333
2945 msgid "Specifying Channel Authorizations"
2949 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2950 msgid "Defining channel authors authorizations."
2954 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2955 #: guix-git/doc/guix.texi:5433 guix-git/doc/guix.texi:5434
2961 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2962 msgid "Distinguishing mirror to original."
2966 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2967 #: guix-git/doc/guix.texi:5456 guix-git/doc/guix.texi:5457
2969 msgid "Writing Channel News"
2973 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5029
2974 msgid "Communicating information to channel's users."
2978 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
2979 #: guix-git/doc/guix.texi:5547
2981 msgid "Invoking guix environment"
2985 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
2986 msgid "Setting up development environments."
2990 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
2991 #: guix-git/doc/guix.texi:5907
2993 msgid "Invoking guix pack"
2997 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
2998 msgid "Creating software bundles."
3002 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
3003 #: guix-git/doc/guix.texi:6264 guix-git/doc/guix.texi:6265
3005 msgid "The GCC toolchain"
3009 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
3010 msgid "Working with languages supported by GCC."
3014 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
3015 #: guix-git/doc/guix.texi:6290
3017 msgid "Invoking guix git authenticate"
3021 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5545
3022 msgid "Authenticating Git repositories."
3026 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3027 #: guix-git/doc/guix.texi:6394 guix-git/doc/guix.texi:6395
3029 msgid "Package Modules"
3033 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3034 msgid "Packages from the programmer's viewpoint."
3038 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:274
3039 #: guix-git/doc/guix.texi:6392 guix-git/doc/guix.texi:6456
3040 #: guix-git/doc/guix.texi:6457
3042 msgid "Defining Packages"
3046 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3047 msgid "Defining new packages."
3051 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3052 #: guix-git/doc/guix.texi:7024 guix-git/doc/guix.texi:7025
3054 msgid "Defining Package Variants"
3058 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3059 msgid "Customizing packages."
3063 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3064 #: guix-git/doc/guix.texi:7256 guix-git/doc/guix.texi:7257
3066 msgid "Build Systems"
3070 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3071 msgid "Specifying how packages are built."
3075 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3076 #: guix-git/doc/guix.texi:8272 guix-git/doc/guix.texi:8273
3077 #: guix-git/doc/guix.texi:8676
3079 msgid "Build Phases"
3083 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3084 msgid "Phases of the build process of a package."
3088 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3089 #: guix-git/doc/guix.texi:8466 guix-git/doc/guix.texi:8467
3091 msgid "Build Utilities"
3095 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3096 msgid "Helpers for your package definitions and more."
3100 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3101 #: guix-git/doc/guix.texi:8753 guix-git/doc/guix.texi:8754
3107 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3108 msgid "Manipulating the package store."
3112 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3113 #: guix-git/doc/guix.texi:8906 guix-git/doc/guix.texi:8907
3119 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3120 msgid "Low-level interface to package derivations."
3124 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3125 #: guix-git/doc/guix.texi:9100 guix-git/doc/guix.texi:9101
3127 msgid "The Store Monad"
3131 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3132 msgid "Purely functional interface to the store."
3136 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3137 #: guix-git/doc/guix.texi:9419 guix-git/doc/guix.texi:9420
3139 msgid "G-Expressions"
3143 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3144 msgid "Manipulating build expressions."
3148 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6392
3149 #: guix-git/doc/guix.texi:10048
3151 msgid "Invoking guix repl"
3155 #: guix-git/doc/guix.texi:272
3156 msgid "Programming Guix in Guile."
3160 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6659
3161 #: guix-git/doc/guix.texi:6662
3163 msgid "package Reference"
3167 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6659
3168 msgid "The package data type."
3172 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6659
3173 #: guix-git/doc/guix.texi:6833
3175 msgid "origin Reference"
3179 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6659
3180 msgid "The origin data type."
3184 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3185 #: guix-git/doc/guix.texi:10174
3187 msgid "Invoking guix build"
3191 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3192 msgid "Building packages from the command line."
3196 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3197 #: guix-git/doc/guix.texi:11010
3199 msgid "Invoking guix edit"
3203 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3204 msgid "Editing package definitions."
3208 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3209 #: guix-git/doc/guix.texi:11040
3211 msgid "Invoking guix download"
3215 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3216 msgid "Downloading a file and printing its hash."
3220 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3221 #: guix-git/doc/guix.texi:11098
3223 msgid "Invoking guix hash"
3227 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3228 msgid "Computing the cryptographic hash of a file."
3232 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3233 #: guix-git/doc/guix.texi:11170
3235 msgid "Invoking guix import"
3239 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3240 msgid "Importing package definitions."
3244 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3245 #: guix-git/doc/guix.texi:11655
3247 msgid "Invoking guix refresh"
3251 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3252 msgid "Updating package definitions."
3256 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3257 #: guix-git/doc/guix.texi:11991
3259 msgid "Invoking guix lint"
3263 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3264 msgid "Finding errors in package definitions."
3268 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3269 #: guix-git/doc/guix.texi:12160
3271 msgid "Invoking guix size"
3275 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3276 msgid "Profiling disk usage."
3280 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3281 #: guix-git/doc/guix.texi:12304
3283 msgid "Invoking guix graph"
3287 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3288 msgid "Visualizing the graph of packages."
3292 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3293 #: guix-git/doc/guix.texi:12571
3295 msgid "Invoking guix publish"
3299 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3300 msgid "Sharing substitutes."
3304 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3305 #: guix-git/doc/guix.texi:12830
3307 msgid "Invoking guix challenge"
3311 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3312 msgid "Challenging substitute servers."
3316 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3317 #: guix-git/doc/guix.texi:13013
3319 msgid "Invoking guix copy"
3323 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3324 msgid "Copying to and from a remote store."
3328 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3329 #: guix-git/doc/guix.texi:13076
3331 msgid "Invoking guix container"
3335 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3336 msgid "Process isolation."
3340 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3341 #: guix-git/doc/guix.texi:13130
3343 msgid "Invoking guix weather"
3347 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3348 msgid "Assessing substitute availability."
3352 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3353 #: guix-git/doc/guix.texi:13260
3355 msgid "Invoking guix processes"
3359 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10172
3360 msgid "Listing client processes."
3364 #: guix-git/doc/guix.texi:297 guix-git/doc/guix.texi:10175
3366 msgid "Invoking @command{guix build}"
3370 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3371 #: guix-git/doc/guix.texi:10228 guix-git/doc/guix.texi:10229
3373 msgid "Common Build Options"
3377 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3378 msgid "Build options for most commands."
3382 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3383 #: guix-git/doc/guix.texi:10383 guix-git/doc/guix.texi:10384
3385 msgid "Package Transformation Options"
3389 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3390 msgid "Creating variants of packages."
3394 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3395 #: guix-git/doc/guix.texi:10692 guix-git/doc/guix.texi:10693
3397 msgid "Additional Build Options"
3401 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3402 msgid "Options specific to 'guix build'."
3406 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3407 #: guix-git/doc/guix.texi:10930 guix-git/doc/guix.texi:10931
3409 msgid "Debugging Build Failures"
3413 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10226
3414 msgid "Real life packaging experience."
3418 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3419 #: guix-git/doc/guix.texi:13403 guix-git/doc/guix.texi:13404
3421 msgid "Using the Configuration System"
3425 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3426 msgid "Customizing your GNU system."
3430 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3431 #: guix-git/doc/guix.texi:13651
3433 msgid "operating-system Reference"
3437 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3438 msgid "Detail of operating-system declarations."
3442 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3443 #: guix-git/doc/guix.texi:13903 guix-git/doc/guix.texi:13904
3445 msgid "File Systems"
3449 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3450 msgid "Configuring file system mounts."
3454 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3455 #: guix-git/doc/guix.texi:14226 guix-git/doc/guix.texi:14227
3457 msgid "Mapped Devices"
3461 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3462 msgid "Block device extra processing."
3466 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3467 #: guix-git/doc/guix.texi:14374 guix-git/doc/guix.texi:14375
3469 msgid "User Accounts"
3473 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3474 msgid "Specifying user accounts."
3478 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:2282
3479 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:14550
3480 #: guix-git/doc/guix.texi:14551
3482 msgid "Keyboard Layout"
3486 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3487 msgid "How the system interprets key strokes."
3491 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1785
3492 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:14696
3493 #: guix-git/doc/guix.texi:14697
3499 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3500 msgid "Language and cultural convention settings."
3504 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:324
3505 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:14836
3506 #: guix-git/doc/guix.texi:14837
3512 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3513 msgid "Specifying system services."
3517 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3518 #: guix-git/doc/guix.texi:32033 guix-git/doc/guix.texi:32034
3520 msgid "Setuid Programs"
3524 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3525 msgid "Programs running with root privileges."
3529 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1934
3530 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:32079
3531 #: guix-git/doc/guix.texi:32080
3533 msgid "X.509 Certificates"
3537 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3538 msgid "Authenticating HTTPS servers."
3542 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1828
3543 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:32142
3544 #: guix-git/doc/guix.texi:32143
3546 msgid "Name Service Switch"
3550 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3551 msgid "Configuring libc's name service switch."
3555 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3556 #: guix-git/doc/guix.texi:32280 guix-git/doc/guix.texi:32281
3558 msgid "Initial RAM Disk"
3562 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3563 msgid "Linux-Libre bootstrapping."
3567 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3568 #: guix-git/doc/guix.texi:32456 guix-git/doc/guix.texi:32457
3570 msgid "Bootloader Configuration"
3574 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3575 msgid "Configuring the boot loader."
3579 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3580 #: guix-git/doc/guix.texi:32750
3582 msgid "Invoking guix system"
3586 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3587 msgid "Instantiating a system configuration."
3591 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3592 #: guix-git/doc/guix.texi:33335
3594 msgid "Invoking guix deploy"
3598 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3599 msgid "Deploying a system configuration to a remote host."
3603 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3604 #: guix-git/doc/guix.texi:33541
3606 msgid "Running Guix in a VM"
3610 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3611 msgid "How to run Guix System in a virtual machine."
3615 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:359
3616 #: guix-git/doc/guix.texi:13401 guix-git/doc/guix.texi:33671
3617 #: guix-git/doc/guix.texi:33672
3619 msgid "Defining Services"
3623 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13401
3624 msgid "Adding new service definitions."
3628 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3629 #: guix-git/doc/guix.texi:14921 guix-git/doc/guix.texi:14922
3631 msgid "Base Services"
3635 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3636 msgid "Essential system services."
3640 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3641 #: guix-git/doc/guix.texi:15837 guix-git/doc/guix.texi:15838
3643 msgid "Scheduled Job Execution"
3647 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3648 msgid "The mcron service."
3652 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3653 #: guix-git/doc/guix.texi:15978 guix-git/doc/guix.texi:15979
3655 msgid "Log Rotation"
3659 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3660 msgid "The rottlog service."
3664 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3665 #: guix-git/doc/guix.texi:16091 guix-git/doc/guix.texi:16092
3667 msgid "Networking Services"
3671 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3672 msgid "Network setup, SSH daemon, etc."
3676 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3677 #: guix-git/doc/guix.texi:17661 guix-git/doc/guix.texi:17662
3679 msgid "Unattended Upgrades"
3683 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3684 msgid "Automated system upgrades."
3688 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3689 #: guix-git/doc/guix.texi:17799 guix-git/doc/guix.texi:17800
3695 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3696 msgid "Graphical display."
3700 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3701 #: guix-git/doc/guix.texi:18176 guix-git/doc/guix.texi:18177
3703 msgid "Printing Services"
3707 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3708 msgid "Local and remote printer support."
3712 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3713 #: guix-git/doc/guix.texi:19029 guix-git/doc/guix.texi:19030
3715 msgid "Desktop Services"
3719 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3720 msgid "D-Bus and desktop services."
3724 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3725 #: guix-git/doc/guix.texi:19547 guix-git/doc/guix.texi:19548
3727 msgid "Sound Services"
3731 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3732 msgid "ALSA and Pulseaudio services."
3736 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3737 #: guix-git/doc/guix.texi:19687 guix-git/doc/guix.texi:19688
3739 msgid "Database Services"
3743 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3744 msgid "SQL databases, key-value stores, etc."
3748 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3749 #: guix-git/doc/guix.texi:20019 guix-git/doc/guix.texi:20020
3751 msgid "Mail Services"
3755 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3756 msgid "IMAP, POP3, SMTP, and all that."
3760 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3761 #: guix-git/doc/guix.texi:21835 guix-git/doc/guix.texi:21836
3763 msgid "Messaging Services"
3767 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3768 msgid "Messaging services."
3772 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3773 #: guix-git/doc/guix.texi:22338 guix-git/doc/guix.texi:22339
3775 msgid "Telephony Services"
3779 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3780 msgid "Telephony services."
3784 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3785 #: guix-git/doc/guix.texi:23341 guix-git/doc/guix.texi:23342
3787 msgid "Monitoring Services"
3791 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3792 msgid "Monitoring services."
3796 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3797 #: guix-git/doc/guix.texi:23852 guix-git/doc/guix.texi:23853
3799 msgid "Kerberos Services"
3803 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3804 msgid "Kerberos services."
3808 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3809 #: guix-git/doc/guix.texi:23978 guix-git/doc/guix.texi:23979
3811 msgid "LDAP Services"
3815 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3816 msgid "LDAP services."
3820 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3821 #: guix-git/doc/guix.texi:24457 guix-git/doc/guix.texi:24458
3823 msgid "Web Services"
3827 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3828 msgid "Web servers."
3832 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3833 #: guix-git/doc/guix.texi:25658 guix-git/doc/guix.texi:25659
3835 msgid "Certificate Services"
3839 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3840 msgid "TLS certificates via Let's Encrypt."
3844 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3845 #: guix-git/doc/guix.texi:25831 guix-git/doc/guix.texi:25832
3847 msgid "DNS Services"
3851 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3852 msgid "DNS daemons."
3856 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3857 #: guix-git/doc/guix.texi:26579 guix-git/doc/guix.texi:26580
3859 msgid "VPN Services"
3863 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3864 msgid "VPN daemons."
3868 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3869 #: guix-git/doc/guix.texi:27034 guix-git/doc/guix.texi:27035
3871 msgid "Network File System"
3875 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3876 msgid "NFS related services."
3880 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3881 #: guix-git/doc/guix.texi:27230 guix-git/doc/guix.texi:27231
3883 msgid "Continuous Integration"
3887 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3888 msgid "Cuirass and Laminar services."
3892 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3893 #: guix-git/doc/guix.texi:27508 guix-git/doc/guix.texi:27509
3895 msgid "Power Management Services"
3899 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3900 msgid "Extending battery life."
3904 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3905 #: guix-git/doc/guix.texi:28042 guix-git/doc/guix.texi:28043
3907 msgid "Audio Services"
3911 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3916 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3917 #: guix-git/doc/guix.texi:28161 guix-git/doc/guix.texi:28162
3919 msgid "Virtualization Services"
3923 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3924 msgid "Virtualization services."
3928 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3929 #: guix-git/doc/guix.texi:29775 guix-git/doc/guix.texi:29776
3931 msgid "Version Control Services"
3935 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3936 msgid "Providing remote access to Git repositories."
3940 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3941 #: guix-git/doc/guix.texi:30967 guix-git/doc/guix.texi:30968
3943 msgid "Game Services"
3947 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3948 msgid "Game servers."
3952 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3953 #: guix-git/doc/guix.texi:30999 guix-git/doc/guix.texi:31000
3955 msgid "PAM Mount Service"
3959 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3960 msgid "Service to mount volumes when logging in."
3964 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3965 #: guix-git/doc/guix.texi:31082 guix-git/doc/guix.texi:31083
3967 msgid "Guix Services"
3971 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3972 msgid "Services relating specifically to Guix."
3976 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3977 #: guix-git/doc/guix.texi:31357 guix-git/doc/guix.texi:31358
3979 msgid "Linux Services"
3983 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3984 msgid "Services tied to the Linux kernel."
3988 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3989 #: guix-git/doc/guix.texi:31504 guix-git/doc/guix.texi:31505
3991 msgid "Hurd Services"
3995 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
3996 msgid "Services specific for a Hurd System."
4000 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
4001 #: guix-git/doc/guix.texi:31546 guix-git/doc/guix.texi:31547
4003 msgid "Miscellaneous Services"
4007 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14919
4008 msgid "Other services."
4012 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4013 #: guix-git/doc/guix.texi:33685 guix-git/doc/guix.texi:33686
4015 msgid "Service Composition"
4019 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4020 msgid "The model for composing services."
4024 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4025 #: guix-git/doc/guix.texi:33741 guix-git/doc/guix.texi:33742
4027 msgid "Service Types and Services"
4031 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4032 msgid "Types and services."
4036 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4037 #: guix-git/doc/guix.texi:33878 guix-git/doc/guix.texi:33879
4039 msgid "Service Reference"
4043 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4044 msgid "API reference."
4048 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4049 #: guix-git/doc/guix.texi:34169 guix-git/doc/guix.texi:34170
4051 msgid "Shepherd Services"
4055 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33683
4056 msgid "A particular type of service."
4060 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34470
4061 #: guix-git/doc/guix.texi:34472 guix-git/doc/guix.texi:34473
4063 msgid "Separate Debug Info"
4067 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34470
4068 msgid "Installing 'debug' outputs."
4072 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34470
4073 #: guix-git/doc/guix.texi:34531 guix-git/doc/guix.texi:34532
4075 msgid "Rebuilding Debug Info"
4079 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34470
4080 msgid "Building missing debug info."
4084 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34748
4085 #: guix-git/doc/guix.texi:34750
4087 msgid "Reduced Binary Seed Bootstrap"
4091 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34748
4092 msgid "A Bootstrap worthy of GNU."
4096 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34748
4097 #: guix-git/doc/guix.texi:34825 guix-git/doc/guix.texi:34826
4099 msgid "Preparing to Use the Bootstrap Binaries"
4103 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34748
4104 msgid "Building that what matters most."
4108 #: guix-git/doc/guix.texi:382
4114 #: guix-git/doc/guix.texi:390
4115 msgid "GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using the international phonetic alphabet (IPA).} is a package management tool for and distribution of the GNU system. Guix makes it easy for unprivileged users to install, upgrade, or remove software packages, to roll back to a previous package set, to build packages from source, and generally assists with the creation and maintenance of software environments."
4119 #: guix-git/doc/guix.texi:391 guix-git/doc/guix.texi:466
4125 #: guix-git/doc/guix.texi:392
4127 msgid "GuixSD, now Guix System"
4131 #: guix-git/doc/guix.texi:393
4133 msgid "Guix System Distribution, now Guix System"
4137 #: guix-git/doc/guix.texi:402
4138 msgid "You can install GNU@tie{}Guix on top of an existing GNU/Linux system where it complements the available tools without interference (@pxref{Installation}), or you can use it as a standalone operating system distribution, @dfn{Guix@tie{}System}@footnote{We used to refer to Guix System as ``Guix System Distribution'' or ``GuixSD''. We now consider it makes more sense to group everything under the ``Guix'' banner since, after all, Guix System is readily available through the @command{guix system} command, even if you're using a different distro underneath!}. @xref{GNU Distribution}."
4142 #: guix-git/doc/guix.texi:411
4144 msgid "user interfaces"
4148 #: guix-git/doc/guix.texi:417
4149 msgid "Guix provides a command-line package management interface (@pxref{Package Management}), tools to help with software development (@pxref{Development}), command-line utilities for more advanced usage (@pxref{Utilities}), as well as Scheme programming interfaces (@pxref{Programming Interface})."
4153 #: guix-git/doc/guix.texi:417
4155 msgid "build daemon"
4159 #: guix-git/doc/guix.texi:421
4160 msgid "Its @dfn{build daemon} is responsible for building packages on behalf of users (@pxref{Setting Up the Daemon}) and for downloading pre-built binaries from authorized sources (@pxref{Substitutes})."
4164 #: guix-git/doc/guix.texi:422
4166 msgid "extensibility of the distribution"
4170 #: guix-git/doc/guix.texi:423 guix-git/doc/guix.texi:6416
4172 msgid "customization, of packages"
4176 #: guix-git/doc/guix.texi:432
4177 msgid "Guix includes package definitions for many GNU and non-GNU packages, all of which @uref{https://www.gnu.org/philosophy/free-sw.html, respect the user's computing freedom}. It is @emph{extensible}: users can write their own package definitions (@pxref{Defining Packages}) and make them available as independent package modules (@pxref{Package Modules}). It is also @emph{customizable}: users can @emph{derive} specialized package definitions from existing ones, including from the command line (@pxref{Package Transformation Options})."
4181 #: guix-git/doc/guix.texi:433
4183 msgid "functional package management"
4187 #: guix-git/doc/guix.texi:434
4193 #: guix-git/doc/guix.texi:449
4194 msgid "Under the hood, Guix implements the @dfn{functional package management} discipline pioneered by Nix (@pxref{Acknowledgments}). In Guix, the package build and installation process is seen as a @emph{function}, in the mathematical sense. That function takes inputs, such as build scripts, a compiler, and libraries, and returns an installed package. As a pure function, its result depends solely on its inputs---for instance, it cannot refer to software or scripts that were not explicitly passed as inputs. A build function always produces the same result when passed a given set of inputs. It cannot alter the environment of the running system in any way; for instance, it cannot create, modify, or delete files outside of its build and installation directories. This is achieved by running build processes in isolated environments (or @dfn{containers}), where only their explicit inputs are visible."
4198 #: guix-git/doc/guix.texi:450 guix-git/doc/guix.texi:8756
4204 #: guix-git/doc/guix.texi:457
4205 msgid "The result of package build functions is @dfn{cached} in the file system, in a special directory called @dfn{the store} (@pxref{The Store}). Each package is installed in a directory of its own in the store---by default under @file{/gnu/store}. The directory name contains a hash of all the inputs used to build that package; thus, changing an input yields a different directory name."
4209 #: guix-git/doc/guix.texi:461
4210 msgid "This approach is the foundation for the salient features of Guix: support for transactional package upgrade and rollback, per-user installation, and garbage collection of packages (@pxref{Features})."
4214 #: guix-git/doc/guix.texi:476
4215 msgid "Guix comes with a distribution of the GNU system consisting entirely of free software@footnote{The term ``free'' here refers to the @url{https://www.gnu.org/philosophy/free-sw.html,freedom provided to users of that software}.}. The distribution can be installed on its own (@pxref{System Installation}), but it is also possible to install Guix as a package manager on top of an installed GNU/Linux system (@pxref{Installation}). When we need to distinguish between the two, we refer to the standalone distribution as Guix@tie{}System."
4219 #: guix-git/doc/guix.texi:482
4220 msgid "The distribution provides core GNU packages such as GNU libc, GCC, and Binutils, as well as many GNU and non-GNU applications. The complete list of available packages can be browsed @url{https://www.gnu.org/software/guix/packages,on-line} or by running @command{guix package} (@pxref{Invoking guix package}):"
4224 #: guix-git/doc/guix.texi:485
4226 msgid "guix package --list-available\n"
4230 #: guix-git/doc/guix.texi:491
4231 msgid "Our goal is to provide a practical 100% free software distribution of Linux-based and other variants of GNU, with a focus on the promotion and tight integration of GNU components, and an emphasis on programs and tools that help users exert that freedom."
4235 #: guix-git/doc/guix.texi:493
4236 msgid "Packages are currently available on the following platforms:"
4240 #: guix-git/doc/guix.texi:496 guix-git/doc/guix.texi:2105
4242 msgid "x86_64-linux"
4246 #: guix-git/doc/guix.texi:498
4247 msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel."
4251 #: guix-git/doc/guix.texi:499 guix-git/doc/guix.texi:2108
4257 #: guix-git/doc/guix.texi:501
4258 msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel."
4262 #: guix-git/doc/guix.texi:502
4268 #: guix-git/doc/guix.texi:506
4269 msgid "ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-float application binary interface (ABI), and Linux-Libre kernel."
4273 #: guix-git/doc/guix.texi:507
4275 msgid "aarch64-linux"
4279 #: guix-git/doc/guix.texi:509
4280 msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel."
4284 #: guix-git/doc/guix.texi:510
4290 #: guix-git/doc/guix.texi:513
4291 msgid "@uref{https://hurd.gnu.org, GNU/Hurd} on the Intel 32-bit architecture (IA32)."
4295 #: guix-git/doc/guix.texi:519
4296 msgid "This configuration is experimental and under development. The easiest way for you to give it a try is by setting up an instance of @code{hurd-vm-service-type} on your GNU/Linux machine (@pxref{transparent-emulation-qemu, @code{hurd-vm-service-type}}). @xref{Contributing}, on how to help!"
4300 #: guix-git/doc/guix.texi:520
4302 msgid "mips64el-linux (deprecated)"
4306 #: guix-git/doc/guix.texi:526
4307 msgid "little-endian 64-bit MIPS processors, specifically the Loongson series, n32 ABI, and Linux-Libre kernel. This configuration is no longer fully supported; in particular, there is no ongoing work to ensure that this architecture still works. Should someone decide they wish to revive this architecture then the code is still available."
4311 #: guix-git/doc/guix.texi:527
4313 msgid "powerpc64le-linux"
4317 #: guix-git/doc/guix.texi:537
4318 msgid "little-endian 64-bit Power ISA processors, Linux-Libre kernel. This includes POWER9 systems such as the @uref{https://www.fsf.org/news/talos-ii-mainboard-and-talos-ii-lite-mainboard-now-fsf-certified-to-respect-your-freedom, RYF Talos II mainboard}. This platform is available as a \"technology preview\": although it is supported, substitutes are not yet available from the build farm (@pxref{Substitutes}), and some packages may fail to build (@pxref{Tracking Bugs and Patches}). That said, the Guix community is actively working on improving this support, and now is a great time to try it and get involved!"
4322 #: guix-git/doc/guix.texi:547
4323 msgid "With Guix@tie{}System, you @emph{declare} all aspects of the operating system configuration and Guix takes care of instantiating the configuration in a transactional, reproducible, and stateless fashion (@pxref{System Configuration}). Guix System uses the Linux-libre kernel, the Shepherd initialization system (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual}), the well-known GNU utilities and tool chain, as well as the graphical environment or system services of your choice."
4327 #: guix-git/doc/guix.texi:550
4328 msgid "Guix System is available on all the above platforms except @code{mips64el-linux} and @code{powerpc64le-linux}."
4332 #: guix-git/doc/guix.texi:554
4333 msgid "For information on porting to other architectures or kernels, @pxref{Porting}."
4337 #: guix-git/doc/guix.texi:557
4338 msgid "Building this distribution is a cooperative effort, and you are invited to join! @xref{Contributing}, for information about how you can help."
4342 #: guix-git/doc/guix.texi:563
4344 msgid "installing Guix"
4348 #: guix-git/doc/guix.texi:575
4349 msgid "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, shell installer script} to install Guix on top of a running GNU/Linux system, thereafter called a @dfn{foreign distro}.@footnote{This section is concerned with the installation of the package manager, which can be done on top of a running GNU/Linux system. If, instead, you want to install the complete GNU operating system, @pxref{System Installation}.} The script automates the download, installation, and initial configuration of Guix. It should be run as the root user."
4353 #: guix-git/doc/guix.texi:577 guix-git/doc/guix.texi:1780
4355 msgid "foreign distro"
4359 #: guix-git/doc/guix.texi:578
4361 msgid "directories related to foreign distro"
4365 #: guix-git/doc/guix.texi:583
4366 msgid "When installed on a foreign distro, GNU@tie{}Guix complements the available tools without interference. Its data lives exclusively in two directories, usually @file{/gnu/store} and @file{/var/guix}; other files on your system, such as @file{/etc}, are left untouched."
4370 #: guix-git/doc/guix.texi:586
4371 msgid "Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull})."
4375 #: guix-git/doc/guix.texi:591
4376 msgid "If you prefer to perform the installation steps manually or want to tweak them, you may find the following subsections useful. They describe the software requirements of Guix, as well as how to install it manually and get ready to use it."
4380 #: guix-git/doc/guix.texi:605
4382 msgid "installing Guix from binaries"
4386 #: guix-git/doc/guix.texi:606
4388 msgid "installer script"
4392 #: guix-git/doc/guix.texi:612
4393 msgid "This section describes how to install Guix on an arbitrary system from a self-contained tarball providing binaries for Guix and for all its dependencies. This is often quicker than installing from source, which is described in the next sections. The only requirement is to have GNU@tie{}tar and Xz."
4397 #: guix-git/doc/guix.texi:620
4398 msgid "We recommend the use of this @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, shell installer script}. The script automates the download, installation, and initial configuration steps described below. It should be run as the root user. As root, you can thus run this:"
4402 #: guix-git/doc/guix.texi:626
4406 "wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh\n"
4407 "chmod +x guix-install.sh\n"
4408 "./guix-install.sh\n"
4412 #: guix-git/doc/guix.texi:630
4413 msgid "When you're done, @pxref{Application Setup} for extra configuration you might need, and @ref{Getting Started} for your first steps!"
4417 #: guix-git/doc/guix.texi:633
4418 msgid "Installing goes along these lines:"
4422 #: guix-git/doc/guix.texi:636
4424 msgid "downloading Guix binary"
4428 #: guix-git/doc/guix.texi:642
4429 msgid "Download the binary tarball from @indicateurl{@value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz}, where @code{x86_64-linux} can be replaced with @code{i686-linux} for an @code{i686} (32-bits) machine already running the kernel Linux, and so on (@pxref{GNU Distribution})."
4433 #: guix-git/doc/guix.texi:646
4434 msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the tarball against it, along these lines:"
4438 #: guix-git/doc/guix.texi:650
4441 "$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
4442 "$ gpg --verify guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
4446 #: guix-git/doc/guix.texi:654 guix-git/doc/guix.texi:2123
4447 msgid "If that command fails because you do not have the required public key, then run this command to import it:"
4451 #: guix-git/doc/guix.texi:658
4454 "$ wget '@value{OPENPGP-SIGNING-KEY-URL}' \\\n"
4455 " -qO - | gpg --import -\n"
4459 #: guix-git/doc/guix.texi:662 guix-git/doc/guix.texi:2131
4460 msgid "and rerun the @code{gpg --verify} command."
4464 #: guix-git/doc/guix.texi:665 guix-git/doc/guix.texi:2134
4465 msgid "Take note that a warning like ``This key is not certified with a trusted signature!'' is normal."
4469 #: guix-git/doc/guix.texi:671
4470 msgid "Now, you need to become the @code{root} user. Depending on your distribution, you may have to run @code{su -} or @code{sudo -i}. As @code{root}, run:"
4474 #: guix-git/doc/guix.texi:677
4478 "# tar --warning=no-timestamp -xf \\\n"
4479 " /path/to/guix-binary-@value{VERSION}.x86_64-linux.tar.xz\n"
4480 "# mv var/guix /var/ && mv gnu /\n"
4484 #: guix-git/doc/guix.texi:682
4485 msgid "This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. The latter contains a ready-to-use profile for @code{root} (see next step)."
4489 #: guix-git/doc/guix.texi:685
4490 msgid "Do @emph{not} unpack the tarball on a working Guix system since that would overwrite its own essential files."
4494 #: guix-git/doc/guix.texi:695
4495 msgid "The @option{--warning=no-timestamp} option makes sure GNU@tie{}tar does not emit warnings about ``implausibly old time stamps'' (such warnings were triggered by GNU@tie{}tar 1.26 and older; recent versions are fine). They stem from the fact that all the files in the archive have their modification time set to 1 (which means January 1st, 1970). This is done on purpose to make sure the archive content is independent of its creation time, thus making it reproducible."
4499 #: guix-git/doc/guix.texi:699
4500 msgid "Make the profile available under @file{~root/.config/guix/current}, which is where @command{guix pull} will install updates (@pxref{Invoking guix pull}):"
4504 #: guix-git/doc/guix.texi:704
4507 "# mkdir -p ~root/.config/guix\n"
4508 "# ln -sf /var/guix/profiles/per-user/root/current-guix \\\n"
4509 " ~root/.config/guix/current\n"
4513 #: guix-git/doc/guix.texi:708
4514 msgid "Source @file{etc/profile} to augment @env{PATH} and other relevant environment variables:"
4518 #: guix-git/doc/guix.texi:712
4521 "# GUIX_PROFILE=\"`echo ~root`/.config/guix/current\" ; \\\n"
4522 " source $GUIX_PROFILE/etc/profile\n"
4526 #: guix-git/doc/guix.texi:717
4527 msgid "Create the group and user accounts for build users as explained below (@pxref{Build Environment Setup})."
4531 #: guix-git/doc/guix.texi:720
4532 msgid "Run the daemon, and set it to automatically start on boot."
4536 #: guix-git/doc/guix.texi:723
4537 msgid "If your host distro uses the systemd init system, this can be achieved with these commands:"
4541 #: guix-git/doc/guix.texi:736
4544 "# cp ~root/.config/guix/current/lib/systemd/system/gnu-store.mount \\\n"
4545 " ~root/.config/guix/current/lib/systemd/system/guix-daemon.service \\\n"
4546 " /etc/systemd/system/\n"
4547 "# systemctl enable --now gnu-store.mount guix-daemon\n"
4551 #: guix-git/doc/guix.texi:739 guix-git/doc/guix.texi:12820
4552 msgid "If your host distro uses the Upstart init system:"
4556 #: guix-git/doc/guix.texi:745
4559 "# initctl reload-configuration\n"
4560 "# cp ~root/.config/guix/current/lib/upstart/system/guix-daemon.conf \\\n"
4562 "# start guix-daemon\n"
4566 #: guix-git/doc/guix.texi:748
4567 msgid "Otherwise, you can still start the daemon manually with:"
4571 #: guix-git/doc/guix.texi:752
4574 "# ~root/.config/guix/current/bin/guix-daemon \\\n"
4575 " --build-users-group=guixbuild\n"
4579 #: guix-git/doc/guix.texi:757
4580 msgid "Make the @command{guix} command available to other users on the machine, for instance with:"
4584 #: guix-git/doc/guix.texi:762
4587 "# mkdir -p /usr/local/bin\n"
4588 "# cd /usr/local/bin\n"
4589 "# ln -s /var/guix/profiles/per-user/root/current-guix/bin/guix\n"
4593 #: guix-git/doc/guix.texi:766
4594 msgid "It is also a good idea to make the Info version of this manual available there:"
4598 #: guix-git/doc/guix.texi:772
4601 "# mkdir -p /usr/local/share/info\n"
4602 "# cd /usr/local/share/info\n"
4603 "# for i in /var/guix/profiles/per-user/root/current-guix/share/info/* ;\n"
4604 " do ln -s $i ; done\n"
4608 #: guix-git/doc/guix.texi:778
4609 msgid "That way, assuming @file{/usr/local/share/info} is in the search path, running @command{info guix} will open this manual (@pxref{Other Info Directories,,, texinfo, GNU Texinfo}, for more details on changing the Info search path)."
4613 #: guix-git/doc/guix.texi:780 guix-git/doc/guix.texi:3747
4614 #: guix-git/doc/guix.texi:15454
4616 msgid "substitutes, authorization thereof"
4620 #: guix-git/doc/guix.texi:783
4621 msgid "To use substitutes from @code{@value{SUBSTITUTE-SERVER}} or one of its mirrors (@pxref{Substitutes}), authorize them:"
4625 #: guix-git/doc/guix.texi:787
4628 "# guix archive --authorize < \\\n"
4629 " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
4633 #: guix-git/doc/guix.texi:792
4634 msgid "Each user may need to perform a few additional steps to make their Guix environment ready for use, @pxref{Application Setup}."
4638 #: guix-git/doc/guix.texi:795
4639 msgid "Voilà, the installation is complete!"
4643 #: guix-git/doc/guix.texi:798
4644 msgid "You can confirm that Guix is working by installing a sample package into the root profile:"
4648 #: guix-git/doc/guix.texi:801
4650 msgid "# guix install hello\n"
4654 #: guix-git/doc/guix.texi:805
4655 msgid "The binary installation tarball can be (re)produced and verified simply by running the following command in the Guix source tree:"
4659 #: guix-git/doc/guix.texi:808
4661 msgid "make guix-binary.@var{system}.tar.xz\n"
4665 #: guix-git/doc/guix.texi:812
4666 msgid "...@: which, in turn, runs:"
4670 #: guix-git/doc/guix.texi:816
4673 "guix pack -s @var{system} --localstatedir \\\n"
4674 " --profile-name=current-guix guix\n"
4678 #: guix-git/doc/guix.texi:819
4679 msgid "@xref{Invoking guix pack}, for more info on this handy tool."
4683 #: guix-git/doc/guix.texi:827
4684 msgid "This section lists requirements when building Guix from source. The build procedure for Guix is the same as for other GNU software, and is not covered here. Please see the files @file{README} and @file{INSTALL} in the Guix source tree for additional details."
4688 #: guix-git/doc/guix.texi:828
4690 msgid "official website"
4694 #: guix-git/doc/guix.texi:831
4695 msgid "GNU Guix is available for download from its website at @url{https://www.gnu.org/software/guix/}."
4699 #: guix-git/doc/guix.texi:833
4700 msgid "GNU Guix depends on the following packages:"
4704 #: guix-git/doc/guix.texi:835
4706 msgid "@url{https://gnu.org/software/guile/, GNU Guile}, version 3.0.x or"
4710 #: guix-git/doc/guix.texi:837
4715 #: guix-git/doc/guix.texi:837
4717 msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version"
4721 #: guix-git/doc/guix.texi:839
4722 msgid "0.1.0 or later;"
4726 #: guix-git/doc/guix.texi:843
4727 msgid "@uref{https://gnutls.org/, GnuTLS}, specifically its Guile bindings (@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile});"
4731 #: guix-git/doc/guix.texi:846
4732 msgid "@uref{https://notabug.org/guile-sqlite3/guile-sqlite3, Guile-SQLite3}, version 0.1.0 or later;"
4736 #: guix-git/doc/guix.texi:846
4738 msgid "@uref{https://notabug.org/guile-zlib/guile-zlib, Guile-zlib},"
4742 #: guix-git/doc/guix.texi:848
4743 msgid "version 0.1.0 or later;"
4747 #: guix-git/doc/guix.texi:848
4749 msgid "@uref{https://notabug.org/guile-lzlib/guile-lzlib, Guile-lzlib};"
4753 #: guix-git/doc/guix.texi:849
4755 msgid "@uref{https://www.nongnu.org/guile-avahi/, Guile-Avahi};"
4759 #: guix-git/doc/guix.texi:854
4760 msgid "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, version 0.3.0 or later;"
4764 #: guix-git/doc/guix.texi:854
4766 msgid "@uref{https://savannah.nongnu.org/projects/guile-json/, Guile-JSON}"
4770 #: guix-git/doc/guix.texi:856
4771 msgid "4.3.0 or later;"
4775 #: guix-git/doc/guix.texi:856
4777 msgid "@url{https://www.gnu.org/software/make/, GNU Make}."
4781 #: guix-git/doc/guix.texi:860
4782 msgid "The following dependencies are optional:"
4786 #: guix-git/doc/guix.texi:868
4787 msgid "Support for build offloading (@pxref{Daemon Offload Setup}) and @command{guix copy} (@pxref{Invoking guix copy}) depends on @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, version 0.13.0 or later."
4791 #: guix-git/doc/guix.texi:873
4792 msgid "@uref{https://notabug.org/guile-zstd/guile-zstd, Guile-zstd}, for zstd compression and decompression in @command{guix publish} and for substitutes (@pxref{Invoking guix publish})."
4796 #: guix-git/doc/guix.texi:877
4797 msgid "@uref{https://ngyro.com/software/guile-semver.html, Guile-Semver} for the @code{crate} importer (@pxref{Invoking guix import})."
4801 #: guix-git/doc/guix.texi:882
4802 msgid "@uref{https://www.nongnu.org/guile-lib/doc/ref/htmlprag/, Guile-Lib} for the @code{go} importer (@pxref{Invoking guix import}) and for some of the ``updaters'' (@pxref{Invoking guix refresh})."
4806 #: guix-git/doc/guix.texi:886
4807 msgid "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} can use it to compress build logs."
4811 #: guix-git/doc/guix.texi:890
4812 msgid "Unless @option{--disable-daemon} was passed to @command{configure}, the following packages are also needed:"
4816 #: guix-git/doc/guix.texi:892
4818 msgid "@url{https://gnupg.org/, GNU libgcrypt};"
4822 #: guix-git/doc/guix.texi:893
4824 msgid "@url{https://sqlite.org, SQLite 3};"
4828 #: guix-git/doc/guix.texi:894
4830 msgid "@url{https://gcc.gnu.org, GCC's g++}, with support for the"
4834 #: guix-git/doc/guix.texi:896
4835 msgid "C++11 standard."
4839 #: guix-git/doc/guix.texi:898
4841 msgid "state directory"
4845 #: guix-git/doc/guix.texi:907
4846 msgid "When configuring Guix on a system that already has a Guix installation, be sure to specify the same state directory as the existing installation using the @option{--localstatedir} option of the @command{configure} script (@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding Standards}). Usually, this @var{localstatedir} option is set to the value @file{/var}. The @command{configure} script protects against unintended misconfiguration of @var{localstatedir} so you do not inadvertently corrupt your store (@pxref{The Store})."
4850 #: guix-git/doc/guix.texi:911
4856 #: guix-git/doc/guix.texi:917
4857 msgid "After a successful @command{configure} and @code{make} run, it is a good idea to run the test suite. It can help catch issues with the setup or environment, or bugs in Guix itself---and really, reporting test failures is a good way to help improve the software. To run the test suite, type:"
4861 #: guix-git/doc/guix.texi:920
4863 msgid "make check\n"
4867 #: guix-git/doc/guix.texi:927
4868 msgid "Test cases can run in parallel: you can use the @code{-j} option of GNU@tie{}make to speed things up. The first run may take a few minutes on a recent machine; subsequent runs will be faster because the store that is created for test purposes will already have various things in cache."
4872 #: guix-git/doc/guix.texi:930
4873 msgid "It is also possible to run a subset of the tests by defining the @code{TESTS} makefile variable as in this example:"
4877 #: guix-git/doc/guix.texi:933
4879 msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n"
4883 #: guix-git/doc/guix.texi:938
4884 msgid "By default, tests results are displayed at a file level. In order to see the details of every individual test cases, it is possible to define the @code{SCM_LOG_DRIVER_FLAGS} makefile variable as in this example:"
4888 #: guix-git/doc/guix.texi:941
4890 msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n"
4894 #: guix-git/doc/guix.texi:949
4895 msgid "The underlying SRFI 64 custom Automake test driver used for the 'check' test suite (located at @file{build-aux/test-driver.scm}) also allows selecting which test cases to run at a finer level, via its @option{--select} and @option{--exclude} options. Here's an example, to run all the test cases from the @file{tests/packages.scm} test file whose names start with ``transaction-upgrade-entry'':"
4899 #: guix-git/doc/guix.texi:953
4902 "export SCM_LOG_DRIVER_FLAGS=\"--select=^transaction-upgrade-entry\"\n"
4903 "make check TESTS=\"tests/packages.scm\"\n"
4907 #: guix-git/doc/guix.texi:959
4908 msgid "Those wishing to inspect the results of failed tests directly from the command line can add the @option{--errors-only=yes} option to the @code{SCM_LOG_DRIVER_FLAGS} makefile variable and set the @code{VERBOSE} Automake makefile variable, as in:"
4912 #: guix-git/doc/guix.texi:962
4914 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --errors-only=yes\" VERBOSE=1\n"
4918 #: guix-git/doc/guix.texi:967
4919 msgid "The @option{--show-duration=yes} option can be used to print the duration of the individual test cases, when used in combination with @option{--brief=no}:"
4923 #: guix-git/doc/guix.texi:970
4925 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --show-duration=yes\"\n"
4929 #: guix-git/doc/guix.texi:974
4930 msgid "@xref{Parallel Test Harness,,,automake,GNU Automake} for more information about the Automake Parallel Test Harness."
4934 #: guix-git/doc/guix.texi:979
4935 msgid "Upon failure, please email @email{bug-guix@@gnu.org} and attach the @file{test-suite.log} file. Please specify the Guix version being used as well as version numbers of the dependencies (@pxref{Requirements}) in your message."
4939 #: guix-git/doc/guix.texi:983
4940 msgid "Guix also comes with a whole-system test suite that tests complete Guix System instances. It can only run on systems where Guix is already installed, using:"
4944 #: guix-git/doc/guix.texi:986
4946 msgid "make check-system\n"
4950 #: guix-git/doc/guix.texi:990
4951 msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:"
4955 #: guix-git/doc/guix.texi:993
4957 msgid "make check-system TESTS=\"basic mcron\"\n"
4961 #: guix-git/doc/guix.texi:1001
4962 msgid "These system tests are defined in the @code{(gnu tests @dots{})} modules. They work by running the operating systems under test with lightweight instrumentation in a virtual machine (VM). They can be computationally intensive or rather cheap, depending on whether substitutes are available for their dependencies (@pxref{Substitutes}). Some of them require a lot of storage space to hold VM images."
4966 #: guix-git/doc/guix.texi:1004
4967 msgid "Again in case of test failures, please send @email{bug-guix@@gnu.org} all the details."
4971 #: guix-git/doc/guix.texi:1008
4977 #: guix-git/doc/guix.texi:1016
4978 msgid "Operations such as building a package or running the garbage collector are all performed by a specialized process, the @dfn{build daemon}, on behalf of clients. Only the daemon may access the store and its associated database. Thus, any operation that manipulates the store goes through the daemon. For instance, command-line tools such as @command{guix package} and @command{guix build} communicate with the daemon (@i{via} remote procedure calls) to instruct it what to do."
4982 #: guix-git/doc/guix.texi:1020
4983 msgid "The following sections explain how to prepare the build daemon's environment. See also @ref{Substitutes}, for information on how to allow the daemon to download pre-built binaries."
4987 #: guix-git/doc/guix.texi:1030 guix-git/doc/guix.texi:1492
4989 msgid "build environment"
4993 #: guix-git/doc/guix.texi:1038
4994 msgid "In a standard multi-user setup, Guix and its daemon---the @command{guix-daemon} program---are installed by the system administrator; @file{/gnu/store} is owned by @code{root} and @command{guix-daemon} runs as @code{root}. Unprivileged users may use Guix tools to build packages or otherwise access the store, and the daemon will do it on their behalf, ensuring that the store is kept in a consistent state, and allowing built packages to be shared among users."
4998 #: guix-git/doc/guix.texi:1039
5004 #: guix-git/doc/guix.texi:1050
5005 msgid "When @command{guix-daemon} runs as @code{root}, you may not want package build processes themselves to run as @code{root} too, for obvious security reasons. To avoid that, a special pool of @dfn{build users} should be created for use by build processes started by the daemon. These build users need not have a shell and a home directory: they will just be used when the daemon drops @code{root} privileges in build processes. Having several such users allows the daemon to launch distinct build processes under separate UIDs, which guarantees that they do not interfere with each other---an essential feature since builds are regarded as pure functions (@pxref{Introduction})."
5009 #: guix-git/doc/guix.texi:1053
5010 msgid "On a GNU/Linux system, a build user pool may be created like this (using Bash syntax and the @code{shadow} commands):"
5014 #: guix-git/doc/guix.texi:1065
5017 "# groupadd --system guixbuild\n"
5018 "# for i in $(seq -w 1 10);\n"
5020 " useradd -g guixbuild -G guixbuild \\\n"
5021 " -d /var/empty -s $(which nologin) \\\n"
5022 " -c \"Guix build user $i\" --system \\\n"
5028 #: guix-git/doc/guix.texi:1075
5029 msgid "The number of build users determines how many build jobs may run in parallel, as specified by the @option{--max-jobs} option (@pxref{Invoking guix-daemon, @option{--max-jobs}}). To use @command{guix system vm} and related commands, you may need to add the build users to the @code{kvm} group so they can access @file{/dev/kvm}, using @code{-G guixbuild,kvm} instead of @code{-G guixbuild} (@pxref{Invoking guix system})."
5033 #: guix-git/doc/guix.texi:1084
5034 msgid "The @code{guix-daemon} program may then be run as @code{root} with the following command@footnote{If your machine uses the systemd init system, dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} file in @file{/etc/systemd/system} will ensure that @command{guix-daemon} is automatically started. Similarly, if your machine uses the Upstart init system, drop the @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} file in @file{/etc/init}.}:"
5038 #: guix-git/doc/guix.texi:1087 guix-git/doc/guix.texi:1485
5040 msgid "# guix-daemon --build-users-group=guixbuild\n"
5044 #: guix-git/doc/guix.texi:1089 guix-git/doc/guix.texi:1490
5050 #: guix-git/doc/guix.texi:1094
5051 msgid "This way, the daemon starts build processes in a chroot, under one of the @code{guixbuilder} users. On GNU/Linux, by default, the chroot environment contains nothing but:"
5055 #: guix-git/doc/guix.texi:1102
5056 msgid "a minimal @code{/dev} directory, created mostly independently from the host @code{/dev}@footnote{``Mostly'', because while the set of files that appear in the chroot's @code{/dev} is fixed, most of these files can only be created if the host has them.};"
5060 #: guix-git/doc/guix.texi:1106
5061 msgid "the @code{/proc} directory; it only shows the processes of the container since a separate PID name space is used;"
5065 #: guix-git/doc/guix.texi:1110
5066 msgid "@file{/etc/passwd} with an entry for the current user and an entry for user @file{nobody};"
5070 #: guix-git/doc/guix.texi:1113
5071 msgid "@file{/etc/group} with an entry for the user's group;"
5075 #: guix-git/doc/guix.texi:1117
5076 msgid "@file{/etc/hosts} with an entry that maps @code{localhost} to @code{127.0.0.1};"
5080 #: guix-git/doc/guix.texi:1120
5081 msgid "a writable @file{/tmp} directory."
5085 #: guix-git/doc/guix.texi:1129
5086 msgid "You can influence the directory where the daemon stores build trees @i{via} the @env{TMPDIR} environment variable. However, the build tree within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, where @var{name} is the derivation name---e.g., @code{coreutils-8.24}. This way, the value of @env{TMPDIR} does not leak inside build environments, which avoids discrepancies in cases where build processes capture the name of their build tree."
5090 #: guix-git/doc/guix.texi:1130 guix-git/doc/guix.texi:3952
5096 #: guix-git/doc/guix.texi:1131 guix-git/doc/guix.texi:3953
5102 #: guix-git/doc/guix.texi:1136
5103 msgid "The daemon also honors the @env{http_proxy} and @env{https_proxy} environment variables for HTTP and HTTPS downloads it performs, be it for fixed-output derivations (@pxref{Derivations}) or for substitutes (@pxref{Substitutes})."
5107 #: guix-git/doc/guix.texi:1144
5108 msgid "If you are installing Guix as an unprivileged user, it is still possible to run @command{guix-daemon} provided you pass @option{--disable-chroot}. However, build processes will not be isolated from one another, and not from the rest of the system. Thus, build processes may interfere with each other, and may access programs, libraries, and other files available on the system---making it much harder to view them as @emph{pure} functions."
5112 #: guix-git/doc/guix.texi:1147
5114 msgid "Using the Offload Facility"
5118 #: guix-git/doc/guix.texi:1149 guix-git/doc/guix.texi:1551
5124 #: guix-git/doc/guix.texi:1150
5130 #: guix-git/doc/guix.texi:1169
5131 msgid "When desired, the build daemon can @dfn{offload} derivation builds to other machines running Guix, using the @code{offload} @dfn{build hook}@footnote{This feature is available only when @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH} is present.}. When that feature is enabled, a list of user-specified build machines is read from @file{/etc/guix/machines.scm}; every time a build is requested, for instance via @code{guix build}, the daemon attempts to offload it to one of the machines that satisfy the constraints of the derivation, in particular its system types---e.g., @code{x86_64-linux}. A single machine can have multiple system types, either because its architecture natively supports it, via emulation (@pxref{transparent-emulation-qemu, Transparent Emulation with QEMU}), or both. Missing prerequisites for the build are copied over SSH to the target machine, which then proceeds with the build; upon success the output(s) of the build are copied back to the initial machine. The offload facility comes with a basic scheduler that attempts to select the best machine. The best machine is chosen among the available machines based on criteria such as:"
5135 #: guix-git/doc/guix.texi:1175
5136 msgid "The availability of a build slot. A build machine can have as many build slots (connections) as the value of the @code{parallel-builds} field of its @code{build-machine} object."
5140 #: guix-git/doc/guix.texi:1179
5141 msgid "Its relative speed, as defined via the @code{speed} field of its @code{build-machine} object."
5145 #: guix-git/doc/guix.texi:1184
5146 msgid "Its load. The normalized machine load must be lower than a threshold value, configurable via the @code{overload-threshold} field of its @code{build-machine} object."
5150 #: guix-git/doc/guix.texi:1187
5151 msgid "Disk space availability. More than a 100 MiB must be available."
5155 #: guix-git/doc/guix.texi:1190
5156 msgid "The @file{/etc/guix/machines.scm} file typically looks like this:"
5160 #: guix-git/doc/guix.texi:1198
5163 "(list (build-machine\n"
5164 " (name \"eightysix.example.org\")\n"
5165 " (systems (list \"x86_64-linux\" \"i686-linux\"))\n"
5166 " (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n"
5168 " (speed 2.)) ;incredibly fast!\n"
5173 #: guix-git/doc/guix.texi:1207
5177 " (name \"armeight.example.org\")\n"
5178 " (systems (list \"aarch64-linux\"))\n"
5179 " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n"
5180 " (user \"alice\")\n"
5182 " (string-append (getenv \"HOME\")\n"
5183 " \"/.ssh/identity-for-guix\"))))\n"
5187 #: guix-git/doc/guix.texi:1213
5188 msgid "In the example above we specify a list of two build machines, one for the @code{x86_64} and @code{i686} architectures and one for the @code{aarch64} architecture."
5192 #: guix-git/doc/guix.texi:1222
5193 msgid "In fact, this file is---not surprisingly!---a Scheme file that is evaluated when the @code{offload} hook is started. Its return value must be a list of @code{build-machine} objects. While this example shows a fixed list of build machines, one could imagine, say, using DNS-SD to return a list of potential build machines discovered in the local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme Programs}). The @code{build-machine} data type is detailed below."
5197 #: guix-git/doc/guix.texi:1223
5199 msgid "{Data Type} build-machine"
5203 #: guix-git/doc/guix.texi:1226
5204 msgid "This data type represents build machines to which the daemon may offload builds. The important fields are:"
5208 #: guix-git/doc/guix.texi:1229 guix-git/doc/guix.texi:6672
5209 #: guix-git/doc/guix.texi:14420 guix-git/doc/guix.texi:14514
5210 #: guix-git/doc/guix.texi:14755 guix-git/doc/guix.texi:16704
5211 #: guix-git/doc/guix.texi:19888 guix-git/doc/guix.texi:22524
5212 #: guix-git/doc/guix.texi:23913 guix-git/doc/guix.texi:24525
5213 #: guix-git/doc/guix.texi:24877 guix-git/doc/guix.texi:24918
5214 #: guix-git/doc/guix.texi:27017 guix-git/doc/guix.texi:29286
5215 #: guix-git/doc/guix.texi:29306 guix-git/doc/guix.texi:31753
5216 #: guix-git/doc/guix.texi:31770 guix-git/doc/guix.texi:32259
5217 #: guix-git/doc/guix.texi:33991 guix-git/doc/guix.texi:34299
5223 #: guix-git/doc/guix.texi:1231
5224 msgid "The host name of the remote machine."
5228 #: guix-git/doc/guix.texi:1232
5234 #: guix-git/doc/guix.texi:1235
5235 msgid "The system types the remote machine supports---e.g., @code{(list \"x86_64-linux\" \"i686-linux\")}."
5239 #: guix-git/doc/guix.texi:1236 guix-git/doc/guix.texi:16714
5245 #: guix-git/doc/guix.texi:1240
5246 msgid "The user account to use when connecting to the remote machine over SSH. Note that the SSH key pair must @emph{not} be passphrase-protected, to allow non-interactive logins."
5250 #: guix-git/doc/guix.texi:1241
5256 #: guix-git/doc/guix.texi:1245
5257 msgid "This must be the machine's SSH @dfn{public host key} in OpenSSH format. This is used to authenticate the machine when we connect to it. It is a long string that looks like this:"
5261 #: guix-git/doc/guix.texi:1248
5263 msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n"
5267 #: guix-git/doc/guix.texi:1253
5268 msgid "If the machine is running the OpenSSH daemon, @command{sshd}, the host key can be found in a file such as @file{/etc/ssh/ssh_host_ed25519_key.pub}."
5272 #: guix-git/doc/guix.texi:1258
5273 msgid "If the machine is running the SSH daemon of GNU@tie{}lsh, @command{lshd}, the host key is in @file{/etc/lsh/host-key.pub} or a similar file. It can be converted to the OpenSSH format using @command{lsh-export-key} (@pxref{Converting keys,,, lsh, LSH Manual}):"
5277 #: guix-git/doc/guix.texi:1262
5280 "$ lsh-export-key --openssh < /etc/lsh/host-key.pub\n"
5281 "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n"
5285 #: guix-git/doc/guix.texi:1267
5286 msgid "A number of optional fields may be specified:"
5290 #: guix-git/doc/guix.texi:1270 guix-git/doc/guix.texi:33491
5292 msgid "@code{port} (default: @code{22})"
5296 #: guix-git/doc/guix.texi:1272
5297 msgid "Port number of SSH server on the machine."
5301 #: guix-git/doc/guix.texi:1273
5303 msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})"
5307 #: guix-git/doc/guix.texi:1276
5308 msgid "The SSH private key file to use when connecting to the machine, in OpenSSH format. This key must not be protected with a passphrase."
5312 #: guix-git/doc/guix.texi:1279
5313 msgid "Note that the default value is the private key @emph{of the root account}. Make sure it exists if you use the default."
5317 #: guix-git/doc/guix.texi:1280
5319 msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})"
5323 #: guix-git/doc/guix.texi:1281
5325 msgid "@code{compression-level} (default: @code{3})"
5329 #: guix-git/doc/guix.texi:1283
5330 msgid "The SSH-level compression methods and compression level requested."
5334 #: guix-git/doc/guix.texi:1286
5335 msgid "Note that offloading relies on SSH compression to reduce bandwidth usage when transferring files to and from build machines."
5339 #: guix-git/doc/guix.texi:1287
5341 msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})"
5345 #: guix-git/doc/guix.texi:1290
5346 msgid "File name of the Unix-domain socket @command{guix-daemon} is listening to on that machine."
5350 #: guix-git/doc/guix.texi:1291
5352 msgid "@code{overload-threshold} (default: @code{0.6})"
5356 #: guix-git/doc/guix.texi:1297
5357 msgid "The load threshold above which a potential offload machine is disregarded by the offload scheduler. The value roughly translates to the total processor usage of the build machine, ranging from 0.0 (0%) to 1.0 (100%). It can also be disabled by setting @code{overload-threshold} to @code{#f}."
5361 #: guix-git/doc/guix.texi:1298
5363 msgid "@code{parallel-builds} (default: @code{1})"
5367 #: guix-git/doc/guix.texi:1300
5368 msgid "The number of builds that may run in parallel on the machine."
5372 #: guix-git/doc/guix.texi:1301
5374 msgid "@code{speed} (default: @code{1.0})"
5378 #: guix-git/doc/guix.texi:1304
5379 msgid "A ``relative speed factor''. The offload scheduler will tend to prefer machines with a higher speed factor."
5383 #: guix-git/doc/guix.texi:1305
5385 msgid "@code{features} (default: @code{'()})"
5389 #: guix-git/doc/guix.texi:1310
5390 msgid "A list of strings denoting specific features supported by the machine. An example is @code{\"kvm\"} for machines that have the KVM Linux modules and corresponding hardware support. Derivations can request features by name, and they will be scheduled on matching build machines."
5394 #: guix-git/doc/guix.texi:1316
5395 msgid "The @command{guix} command must be in the search path on the build machines. You can check whether this is the case by running:"
5399 #: guix-git/doc/guix.texi:1319
5401 msgid "ssh build-machine guix repl --version\n"
5405 #: guix-git/doc/guix.texi:1326
5406 msgid "There is one last thing to do once @file{machines.scm} is in place. As explained above, when offloading, files are transferred back and forth between the machine stores. For this to work, you first need to generate a key pair on each machine to allow the daemon to export signed archives of files from the store (@pxref{Invoking guix archive}):"
5410 #: guix-git/doc/guix.texi:1329 guix-git/doc/guix.texi:33419
5412 msgid "# guix archive --generate-key\n"
5416 #: guix-git/doc/guix.texi:1334
5417 msgid "Each build machine must authorize the key of the master machine so that it accepts store items it receives from the master:"
5421 #: guix-git/doc/guix.texi:1337
5423 msgid "# guix archive --authorize < master-public-key.txt\n"
5427 #: guix-git/doc/guix.texi:1341
5428 msgid "Likewise, the master machine must authorize the key of each build machine."
5432 #: guix-git/doc/guix.texi:1347
5433 msgid "All the fuss with keys is here to express pairwise mutual trust relations between the master and the build machines. Concretely, when the master receives files from a build machine (and @i{vice versa}), its build daemon can make sure they are genuine, have not been tampered with, and that they are signed by an authorized key."
5437 #: guix-git/doc/guix.texi:1348
5439 msgid "offload test"
5443 #: guix-git/doc/guix.texi:1351
5444 msgid "To test whether your setup is operational, run this command on the master node:"
5448 #: guix-git/doc/guix.texi:1354
5450 msgid "# guix offload test\n"
5454 #: guix-git/doc/guix.texi:1360
5455 msgid "This will attempt to connect to each of the build machines specified in @file{/etc/guix/machines.scm}, make sure Guix is available on each machine, attempt to export to the machine and import from it, and report any error in the process."
5459 #: guix-git/doc/guix.texi:1363
5460 msgid "If you want to test a different machine file, just specify it on the command line:"
5464 #: guix-git/doc/guix.texi:1366
5466 msgid "# guix offload test machines-qualif.scm\n"
5470 #: guix-git/doc/guix.texi:1370
5471 msgid "Last, you can test the subset of the machines whose name matches a regular expression like this:"
5475 #: guix-git/doc/guix.texi:1373
5477 msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n"
5481 #: guix-git/doc/guix.texi:1375
5483 msgid "offload status"
5487 #: guix-git/doc/guix.texi:1378
5488 msgid "To display the current load of all build hosts, run this command on the main node:"
5492 #: guix-git/doc/guix.texi:1381
5494 msgid "# guix offload status\n"
5498 #: guix-git/doc/guix.texi:1387
5500 msgid "SELinux, daemon policy"
5504 #: guix-git/doc/guix.texi:1388
5506 msgid "mandatory access control, SELinux"
5510 #: guix-git/doc/guix.texi:1389
5512 msgid "security, guix-daemon"
5516 #: guix-git/doc/guix.texi:1395
5517 msgid "Guix includes an SELinux policy file at @file{etc/guix-daemon.cil} that can be installed on a system where SELinux is enabled, in order to label Guix files and to specify the expected behavior of the daemon. Since Guix System does not provide an SELinux base policy, the daemon policy cannot be used on Guix System."
5520 #. type: subsubsection
5521 #: guix-git/doc/guix.texi:1396
5523 msgid "Installing the SELinux policy"
5527 #: guix-git/doc/guix.texi:1397
5529 msgid "SELinux, policy installation"
5533 #: guix-git/doc/guix.texi:1399
5534 msgid "To install the policy run this command as root:"
5538 #: guix-git/doc/guix.texi:1402
5540 msgid "semodule -i etc/guix-daemon.cil\n"
5544 #: guix-git/doc/guix.texi:1406
5545 msgid "Then relabel the file system with @code{restorecon} or by a different mechanism provided by your system."
5549 #: guix-git/doc/guix.texi:1411
5550 msgid "Once the policy is installed, the file system has been relabeled, and the daemon has been restarted, it should be running in the @code{guix_daemon_t} context. You can confirm this with the following command:"
5554 #: guix-git/doc/guix.texi:1414
5556 msgid "ps -Zax | grep guix-daemon\n"
5560 #: guix-git/doc/guix.texi:1419
5561 msgid "Monitor the SELinux log files as you run a command like @code{guix build hello} to convince yourself that SELinux permits all necessary operations."
5565 #: guix-git/doc/guix.texi:1421
5567 msgid "SELinux, limitations"
5571 #: guix-git/doc/guix.texi:1426
5572 msgid "This policy is not perfect. Here is a list of limitations or quirks that should be considered when deploying the provided SELinux policy for the Guix daemon."
5576 #: guix-git/doc/guix.texi:1433
5577 msgid "@code{guix_daemon_socket_t} isn’t actually used. None of the socket operations involve contexts that have anything to do with @code{guix_daemon_socket_t}. It doesn’t hurt to have this unused label, but it would be preferable to define socket rules for only this label."
5581 #: guix-git/doc/guix.texi:1444
5582 msgid "@code{guix gc} cannot access arbitrary links to profiles. By design, the file label of the destination of a symlink is independent of the file label of the link itself. Although all profiles under $localstatedir are labelled, the links to these profiles inherit the label of the directory they are in. For links in the user’s home directory this will be @code{user_home_t}. But for links from the root user’s home directory, or @file{/tmp}, or the HTTP server’s working directory, etc, this won’t work. @code{guix gc} would be prevented from reading and following these links."
5586 #: guix-git/doc/guix.texi:1449
5587 msgid "The daemon’s feature to listen for TCP connections might no longer work. This might require extra rules, because SELinux treats network sockets differently from files."
5591 #: guix-git/doc/guix.texi:1460
5592 msgid "Currently all files with a name matching the regular expression @code{/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon} are assigned the label @code{guix_daemon_exec_t}; this means that @emph{any} file with that name in any profile would be permitted to run in the @code{guix_daemon_t} domain. This is not ideal. An attacker could build a package that provides this executable and convince a user to install and run it, which lifts it into the @code{guix_daemon_t} domain. At that point SELinux could not prevent it from accessing files that are allowed for processes in that domain."
5596 #: guix-git/doc/guix.texi:1465
5597 msgid "You will need to relabel the store directory after all upgrades to @file{guix-daemon}, such as after running @code{guix pull}. Assuming the store is in @file{/gnu}, you can do this with @code{restorecon -vR /gnu}, or by other means provided by your operating system."
5601 #: guix-git/doc/guix.texi:1473
5602 msgid "We could generate a much more restrictive policy at installation time, so that only the @emph{exact} file name of the currently installed @code{guix-daemon} executable would be labelled with @code{guix_daemon_exec_t}, instead of using a broad regular expression. The downside is that root would have to install or upgrade the policy at installation time whenever the Guix package that provides the effectively running @code{guix-daemon} executable is upgraded."
5606 #: guix-git/doc/guix.texi:1476
5608 msgid "Invoking @command{guix-daemon}"
5612 #: guix-git/doc/guix.texi:1482
5613 msgid "The @command{guix-daemon} program implements all the functionality to access the store. This includes launching build processes, running the garbage collector, querying the availability of a build result, etc. It is normally run as @code{root} like this:"
5617 #: guix-git/doc/guix.texi:1489
5618 msgid "For details on how to set it up, @pxref{Setting Up the Daemon}."
5622 #: guix-git/doc/guix.texi:1491
5624 msgid "container, build environment"
5628 #: guix-git/doc/guix.texi:1493 guix-git/doc/guix.texi:3034
5629 #: guix-git/doc/guix.texi:3933 guix-git/doc/guix.texi:12833
5631 msgid "reproducible builds"
5635 #: guix-git/doc/guix.texi:1505
5636 msgid "By default, @command{guix-daemon} launches build processes under different UIDs, taken from the build group specified with @option{--build-users-group}. In addition, each build process is run in a chroot environment that only contains the subset of the store that the build process depends on, as specified by its derivation (@pxref{Programming Interface, derivation}), plus a set of specific system directories. By default, the latter contains @file{/dev} and @file{/dev/pts}. Furthermore, on GNU/Linux, the build environment is a @dfn{container}: in addition to having its own file system tree, it has a separate mount name space, its own PID name space, network name space, etc. This helps achieve reproducible builds (@pxref{Features})."
5640 #: guix-git/doc/guix.texi:1511
5641 msgid "When the daemon performs a build on behalf of the user, it creates a build directory under @file{/tmp} or under the directory specified by its @env{TMPDIR} environment variable. This directory is shared with the container for the duration of the build, though within the container, the build tree is always called @file{/tmp/guix-build-@var{name}.drv-0}."
5645 #: guix-git/doc/guix.texi:1515
5646 msgid "The build directory is automatically deleted upon completion, unless the build failed and the client specified @option{--keep-failed} (@pxref{Common Build Options, @option{--keep-failed}})."
5650 #: guix-git/doc/guix.texi:1521
5651 msgid "The daemon listens for connections and spawns one sub-process for each session started by a client (one of the @command{guix} sub-commands). The @command{guix processes} command allows you to get an overview of the activity on your system by viewing each of the active sessions and clients. @xref{Invoking guix processes}, for more information."
5655 #: guix-git/doc/guix.texi:1523
5656 msgid "The following command-line options are supported:"
5660 #: guix-git/doc/guix.texi:1525
5662 msgid "--build-users-group=@var{group}"
5666 #: guix-git/doc/guix.texi:1528
5667 msgid "Take users from @var{group} to run build processes (@pxref{Setting Up the Daemon, build users})."
5671 #: guix-git/doc/guix.texi:1529 guix-git/doc/guix.texi:10288
5673 msgid "--no-substitutes"
5677 #: guix-git/doc/guix.texi:1530 guix-git/doc/guix.texi:3046
5678 #: guix-git/doc/guix.texi:3691
5684 #: guix-git/doc/guix.texi:1534 guix-git/doc/guix.texi:10292
5685 msgid "Do not use substitutes for build products. That is, always build things locally instead of allowing downloads of pre-built binaries (@pxref{Substitutes})."
5689 #: guix-git/doc/guix.texi:1538
5690 msgid "When the daemon runs with @option{--no-substitutes}, clients can still explicitly enable substitution @i{via} the @code{set-build-options} remote procedure call (@pxref{The Store})."
5694 #: guix-git/doc/guix.texi:1540
5695 msgid "daemon-substitute-urls"
5699 #: guix-git/doc/guix.texi:1540 guix-git/doc/guix.texi:10275
5700 #: guix-git/doc/guix.texi:12264 guix-git/doc/guix.texi:12979
5701 #: guix-git/doc/guix.texi:13204
5703 msgid "--substitute-urls=@var{urls}"
5707 #: guix-git/doc/guix.texi:1544
5708 msgid "Consider @var{urls} the default whitespace-separated list of substitute source URLs. When this option is omitted, @indicateurl{https://@value{SUBSTITUTE-SERVER}} is used."
5712 #: guix-git/doc/guix.texi:1547
5713 msgid "This means that substitutes may be downloaded from @var{urls}, as long as they are signed by a trusted signature (@pxref{Substitutes})."
5717 #: guix-git/doc/guix.texi:1550
5718 msgid "@xref{Getting Substitutes from Other Servers}, for more information on how to configure the daemon to get substitutes from other servers."
5722 #: guix-git/doc/guix.texi:1552 guix-git/doc/guix.texi:10311
5724 msgid "--no-offload"
5728 #: guix-git/doc/guix.texi:1556 guix-git/doc/guix.texi:10315
5729 msgid "Do not use offload builds to other machines (@pxref{Daemon Offload Setup}). That is, always build things locally instead of offloading builds to remote machines."
5733 #: guix-git/doc/guix.texi:1557
5735 msgid "--cache-failures"
5739 #: guix-git/doc/guix.texi:1559
5740 msgid "Cache build failures. By default, only successful builds are cached."
5744 #: guix-git/doc/guix.texi:1564
5745 msgid "When this option is used, @command{guix gc --list-failures} can be used to query the set of store items marked as failed; @command{guix gc --clear-failures} removes store items from the set of cached failures. @xref{Invoking guix gc}."
5749 #: guix-git/doc/guix.texi:1565 guix-git/doc/guix.texi:10341
5751 msgid "--cores=@var{n}"
5755 #: guix-git/doc/guix.texi:1566 guix-git/doc/guix.texi:10342
5761 #: guix-git/doc/guix.texi:1569
5762 msgid "Use @var{n} CPU cores to build each derivation; @code{0} means as many as available."
5766 #: guix-git/doc/guix.texi:1573
5767 msgid "The default value is @code{0}, but it may be overridden by clients, such as the @option{--cores} option of @command{guix build} (@pxref{Invoking guix build})."
5771 #: guix-git/doc/guix.texi:1577
5772 msgid "The effect is to define the @env{NIX_BUILD_CORES} environment variable in the build process, which can then use it to exploit internal parallelism---for instance, by running @code{make -j$NIX_BUILD_CORES}."
5776 #: guix-git/doc/guix.texi:1578 guix-git/doc/guix.texi:10346
5778 msgid "--max-jobs=@var{n}"
5782 #: guix-git/doc/guix.texi:1579 guix-git/doc/guix.texi:10347
5788 #: guix-git/doc/guix.texi:1584
5789 msgid "Allow at most @var{n} build jobs in parallel. The default value is @code{1}. Setting it to @code{0} means that no builds will be performed locally; instead, the daemon will offload builds (@pxref{Daemon Offload Setup}), or simply fail."
5793 #: guix-git/doc/guix.texi:1585 guix-git/doc/guix.texi:10316
5795 msgid "--max-silent-time=@var{seconds}"
5799 #: guix-git/doc/guix.texi:1588 guix-git/doc/guix.texi:10319
5800 msgid "When the build or substitution process remains silent for more than @var{seconds}, terminate it and report a build failure."
5804 #: guix-git/doc/guix.texi:1590 guix-git/doc/guix.texi:1599
5805 msgid "The default value is @code{0}, which disables the timeout."
5809 #: guix-git/doc/guix.texi:1593
5810 msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--max-silent-time}})."
5814 #: guix-git/doc/guix.texi:1594 guix-git/doc/guix.texi:10323
5816 msgid "--timeout=@var{seconds}"
5820 #: guix-git/doc/guix.texi:1597 guix-git/doc/guix.texi:10326
5821 msgid "Likewise, when the build or substitution process lasts for more than @var{seconds}, terminate it and report a build failure."
5825 #: guix-git/doc/guix.texi:1602
5826 msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--timeout}})."
5830 #: guix-git/doc/guix.texi:1603
5832 msgid "--rounds=@var{N}"
5836 #: guix-git/doc/guix.texi:1608
5837 msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical. Note that this setting can be overridden by clients such as @command{guix build} (@pxref{Invoking guix build})."
5841 #: guix-git/doc/guix.texi:1612 guix-git/doc/guix.texi:10310
5842 #: guix-git/doc/guix.texi:10872
5843 msgid "When used in conjunction with @option{--keep-failed}, the differing output is kept in the store, under @file{/gnu/store/@dots{}-check}. This makes it easy to look for differences between the two results."
5847 #: guix-git/doc/guix.texi:1613
5853 #: guix-git/doc/guix.texi:1615
5854 msgid "Produce debugging output."
5858 #: guix-git/doc/guix.texi:1619
5859 msgid "This is useful to debug daemon start-up issues, but then it may be overridden by clients, for example the @option{--verbosity} option of @command{guix build} (@pxref{Invoking guix build})."
5863 #: guix-git/doc/guix.texi:1620
5865 msgid "--chroot-directory=@var{dir}"
5869 #: guix-git/doc/guix.texi:1622
5870 msgid "Add @var{dir} to the build chroot."
5874 #: guix-git/doc/guix.texi:1628
5875 msgid "Doing this may change the result of build processes---for instance if they use optional dependencies found in @var{dir} when it is available, and not otherwise. For that reason, it is not recommended to do so. Instead, make sure that each derivation declares all the inputs that it needs."
5879 #: guix-git/doc/guix.texi:1629
5881 msgid "--disable-chroot"
5885 #: guix-git/doc/guix.texi:1631
5886 msgid "Disable chroot builds."
5890 #: guix-git/doc/guix.texi:1636
5891 msgid "Using this option is not recommended since, again, it would allow build processes to gain access to undeclared dependencies. It is necessary, though, when @command{guix-daemon} is running under an unprivileged user account."
5895 #: guix-git/doc/guix.texi:1637
5897 msgid "--log-compression=@var{type}"
5901 #: guix-git/doc/guix.texi:1640
5902 msgid "Compress build logs according to @var{type}, one of @code{gzip}, @code{bzip2}, or @code{none}."
5906 #: guix-git/doc/guix.texi:1644
5907 msgid "Unless @option{--lose-logs} is used, all the build logs are kept in the @var{localstatedir}. To save space, the daemon automatically compresses them with Bzip2 by default."
5911 #: guix-git/doc/guix.texi:1645
5913 msgid "--discover[=yes|no]"
5917 #: guix-git/doc/guix.texi:1648 guix-git/doc/guix.texi:15520
5918 msgid "Whether to discover substitute servers on the local network using mDNS and DNS-SD."
5922 #: guix-git/doc/guix.texi:1651
5923 msgid "This feature is still experimental. However, here are a few considerations."
5927 #: guix-git/doc/guix.texi:1655
5928 msgid "It might be faster/less expensive than fetching from remote servers;"
5932 #: guix-git/doc/guix.texi:1658
5933 msgid "There are no security risks, only genuine substitutes will be used (@pxref{Substitute Authentication});"
5937 #: guix-git/doc/guix.texi:1662
5938 msgid "An attacker advertising @command{guix publish} on your LAN cannot serve you malicious binaries, but they can learn what software you’re installing;"
5942 #: guix-git/doc/guix.texi:1665
5943 msgid "Servers may serve substitute over HTTP, unencrypted, so anyone on the LAN can see what software you’re installing."
5947 #: guix-git/doc/guix.texi:1669
5948 msgid "It is also possible to enable or disable substitute server discovery at run-time by running:"
5952 #: guix-git/doc/guix.texi:1673
5955 "herd discover guix-daemon on\n"
5956 "herd discover guix-daemon off\n"
5960 #: guix-git/doc/guix.texi:1675
5962 msgid "--disable-deduplication"
5966 #: guix-git/doc/guix.texi:1676 guix-git/doc/guix.texi:4271
5968 msgid "deduplication"
5972 #: guix-git/doc/guix.texi:1678
5973 msgid "Disable automatic file ``deduplication'' in the store."
5977 #: guix-git/doc/guix.texi:1685
5978 msgid "By default, files added to the store are automatically ``deduplicated'': if a newly added file is identical to another one found in the store, the daemon makes the new file a hard link to the other file. This can noticeably reduce disk usage, at the expense of slightly increased input/output load at the end of a build process. This option disables this optimization."
5982 #: guix-git/doc/guix.texi:1686
5984 msgid "--gc-keep-outputs[=yes|no]"
5988 #: guix-git/doc/guix.texi:1689
5989 msgid "Tell whether the garbage collector (GC) must keep outputs of live derivations."
5993 #: guix-git/doc/guix.texi:1690 guix-git/doc/guix.texi:4084
5999 #: guix-git/doc/guix.texi:1691 guix-git/doc/guix.texi:4085
6001 msgid "garbage collector roots"
6005 #: guix-git/doc/guix.texi:1697
6006 msgid "When set to @code{yes}, the GC will keep the outputs of any live derivation available in the store---the @file{.drv} files. The default is @code{no}, meaning that derivation outputs are kept only if they are reachable from a GC root. @xref{Invoking guix gc}, for more on GC roots."
6010 #: guix-git/doc/guix.texi:1698
6012 msgid "--gc-keep-derivations[=yes|no]"
6016 #: guix-git/doc/guix.texi:1701
6017 msgid "Tell whether the garbage collector (GC) must keep derivations corresponding to live outputs."
6021 #: guix-git/doc/guix.texi:1707
6022 msgid "When set to @code{yes}, as is the case by default, the GC keeps derivations---i.e., @file{.drv} files---as long as at least one of their outputs is live. This allows users to keep track of the origins of items in their store. Setting it to @code{no} saves a bit of disk space."
6026 #: guix-git/doc/guix.texi:1716
6027 msgid "In this way, setting @option{--gc-keep-derivations} to @code{yes} causes liveness to flow from outputs to derivations, and setting @option{--gc-keep-outputs} to @code{yes} causes liveness to flow from derivations to outputs. When both are set to @code{yes}, the effect is to keep all the build prerequisites (the sources, compiler, libraries, and other build-time tools) of live objects in the store, regardless of whether these prerequisites are reachable from a GC root. This is convenient for developers since it saves rebuilds or downloads."
6031 #: guix-git/doc/guix.texi:1717
6033 msgid "--impersonate-linux-2.6"
6037 #: guix-git/doc/guix.texi:1720
6038 msgid "On Linux-based systems, impersonate Linux 2.6. This means that the kernel's @command{uname} system call will report 2.6 as the release number."
6042 #: guix-git/doc/guix.texi:1723
6043 msgid "This might be helpful to build programs that (usually wrongfully) depend on the kernel version number."
6047 #: guix-git/doc/guix.texi:1724
6053 #: guix-git/doc/guix.texi:1727
6054 msgid "Do not keep build logs. By default they are kept under @file{@var{localstatedir}/guix/log}."
6058 #: guix-git/doc/guix.texi:1728 guix-git/doc/guix.texi:4512
6059 #: guix-git/doc/guix.texi:5811 guix-git/doc/guix.texi:6182
6060 #: guix-git/doc/guix.texi:10816 guix-git/doc/guix.texi:12291
6061 #: guix-git/doc/guix.texi:12542 guix-git/doc/guix.texi:13209
6062 #: guix-git/doc/guix.texi:32362 guix-git/doc/guix.texi:33161
6064 msgid "--system=@var{system}"
6068 #: guix-git/doc/guix.texi:1732
6069 msgid "Assume @var{system} as the current system type. By default it is the architecture/kernel pair found at configure time, such as @code{x86_64-linux}."
6073 #: guix-git/doc/guix.texi:1733 guix-git/doc/guix.texi:10121
6075 msgid "--listen=@var{endpoint}"
6079 #: guix-git/doc/guix.texi:1738
6080 msgid "Listen for connections on @var{endpoint}. @var{endpoint} is interpreted as the file name of a Unix-domain socket if it starts with @code{/} (slash sign). Otherwise, @var{endpoint} is interpreted as a host name or host name and port to listen to. Here are a few examples:"
6084 #: guix-git/doc/guix.texi:1740
6086 msgid "--listen=/gnu/var/daemon"
6090 #: guix-git/doc/guix.texi:1743
6091 msgid "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, creating it if needed."
6095 #: guix-git/doc/guix.texi:1744
6097 msgid "--listen=localhost"
6101 #: guix-git/doc/guix.texi:1745 guix-git/doc/guix.texi:8805
6103 msgid "daemon, remote access"
6107 #: guix-git/doc/guix.texi:1746 guix-git/doc/guix.texi:8806
6109 msgid "remote access to the daemon"
6113 #: guix-git/doc/guix.texi:1747 guix-git/doc/guix.texi:8807
6115 msgid "daemon, cluster setup"
6119 #: guix-git/doc/guix.texi:1748 guix-git/doc/guix.texi:8808
6121 msgid "clusters, daemon setup"
6125 #: guix-git/doc/guix.texi:1751
6126 msgid "Listen for TCP connections on the network interface corresponding to @code{localhost}, on port 44146."
6130 #: guix-git/doc/guix.texi:1752
6132 msgid "--listen=128.0.0.42:1234"
6136 #: guix-git/doc/guix.texi:1755
6137 msgid "Listen for TCP connections on the network interface corresponding to @code{128.0.0.42}, on port 1234."
6141 #: guix-git/doc/guix.texi:1762
6142 msgid "This option can be repeated multiple times, in which case @command{guix-daemon} accepts connections on all the specified endpoints. Users can tell client commands what endpoint to connect to by setting the @env{GUIX_DAEMON_SOCKET} environment variable (@pxref{The Store, @env{GUIX_DAEMON_SOCKET}})."
6146 #: guix-git/doc/guix.texi:1769
6147 msgid "The daemon protocol is @emph{unauthenticated and unencrypted}. Using @option{--listen=@var{host}} is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon. In other cases where remote access to the daemon is needed, we recommend using Unix-domain sockets along with SSH."
6151 #: guix-git/doc/guix.texi:1774
6152 msgid "When @option{--listen} is omitted, @command{guix-daemon} listens for connections on the Unix-domain socket located at @file{@var{localstatedir}/guix/daemon-socket/socket}."
6156 #: guix-git/doc/guix.texi:1784
6157 msgid "When using Guix on top of GNU/Linux distribution other than Guix System---a so-called @dfn{foreign distro}---a few additional steps are needed to get everything in place. Here are some of them."
6161 #: guix-git/doc/guix.texi:1788
6162 msgid "locales-and-locpath"
6166 #: guix-git/doc/guix.texi:1788
6168 msgid "locales, when not on Guix System"
6172 #: guix-git/doc/guix.texi:1789 guix-git/doc/guix.texi:14739
6178 #: guix-git/doc/guix.texi:1790
6180 msgid "GUIX_LOCPATH"
6184 #: guix-git/doc/guix.texi:1795
6185 msgid "Packages installed @i{via} Guix will not use the locale data of the host system. Instead, you must first install one of the locale packages available with Guix and then define the @env{GUIX_LOCPATH} environment variable:"
6189 #: guix-git/doc/guix.texi:1799
6192 "$ guix install glibc-locales\n"
6193 "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n"
6197 #: guix-git/doc/guix.texi:1805
6198 msgid "Note that the @code{glibc-locales} package contains data for all the locales supported by the GNU@tie{}libc and weighs in at around 917@tie{}MiB@. Alternatively, the @code{glibc-utf8-locales} is smaller but limited to a few UTF-8 locales."
6202 #: guix-git/doc/guix.texi:1809
6203 msgid "The @env{GUIX_LOCPATH} variable plays a role similar to @env{LOCPATH} (@pxref{Locale Names, @env{LOCPATH},, libc, The GNU C Library Reference Manual}). There are two important differences though:"
6207 #: guix-git/doc/guix.texi:1816
6208 msgid "@env{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc provided by foreign distros. Thus, using @env{GUIX_LOCPATH} allows you to make sure the programs of the foreign distro will not end up loading incompatible locale data."
6212 #: guix-git/doc/guix.texi:1823
6213 msgid "libc suffixes each entry of @env{GUIX_LOCPATH} with @code{/X.Y}, where @code{X.Y} is the libc version---e.g., @code{2.22}. This means that, should your Guix profile contain a mixture of programs linked against different libc version, each libc version will only try to load locale data in the right format."
6217 #: guix-git/doc/guix.texi:1827
6218 msgid "This is important because the locale data format used by different libc versions may be incompatible."
6222 #: guix-git/doc/guix.texi:1830
6224 msgid "name service switch, glibc"
6228 #: guix-git/doc/guix.texi:1831
6230 msgid "NSS (name service switch), glibc"
6234 #: guix-git/doc/guix.texi:1832
6236 msgid "nscd (name service caching daemon)"
6240 #: guix-git/doc/guix.texi:1833
6242 msgid "name service caching daemon (nscd)"
6246 #: guix-git/doc/guix.texi:1840
6247 msgid "When using Guix on a foreign distro, we @emph{strongly recommend} that the system run the GNU C library's @dfn{name service cache daemon}, @command{nscd}, which should be listening on the @file{/var/run/nscd/socket} socket. Failing to do that, applications installed with Guix may fail to look up host names or user accounts, or may even crash. The next paragraphs explain why."
6251 #: guix-git/doc/guix.texi:1841
6253 msgid "nsswitch.conf"
6257 #: guix-git/doc/guix.texi:1846
6258 msgid "The GNU C library implements a @dfn{name service switch} (NSS), which is an extensible mechanism for ``name lookups'' in general: host name resolution, user accounts, and more (@pxref{Name Service Switch,,, libc, The GNU C Library Reference Manual})."
6262 #: guix-git/doc/guix.texi:1847
6264 msgid "Network information service (NIS)"
6268 #: guix-git/doc/guix.texi:1848
6270 msgid "NIS (Network information service)"
6274 #: guix-git/doc/guix.texi:1857
6275 msgid "Being extensible, the NSS supports @dfn{plugins}, which provide new name lookup implementations: for example, the @code{nss-mdns} plugin allow resolution of @code{.local} host names, the @code{nis} plugin allows user account lookup using the Network information service (NIS), and so on. These extra ``lookup services'' are configured system-wide in @file{/etc/nsswitch.conf}, and all the programs running on the system honor those settings (@pxref{NSS Configuration File,,, libc, The GNU C Reference Manual})."
6279 #: guix-git/doc/guix.texi:1867
6280 msgid "When they perform a name lookup---for instance by calling the @code{getaddrinfo} function in C---applications first try to connect to the nscd; on success, nscd performs name lookups on their behalf. If the nscd is not running, then they perform the name lookup by themselves, by loading the name lookup services into their own address space and running it. These name lookup services---the @file{libnss_*.so} files---are @code{dlopen}'d, but they may come from the host system's C library, rather than from the C library the application is linked against (the C library coming from Guix)."
6284 #: guix-git/doc/guix.texi:1872
6285 msgid "And this is where the problem is: if your application is linked against Guix's C library (say, glibc 2.24) and tries to load NSS plugins from another C library (say, @code{libnss_mdns.so} for glibc 2.22), it will likely crash or have its name lookups fail unexpectedly."
6289 #: guix-git/doc/guix.texi:1877
6290 msgid "Running @command{nscd} on the system, among other advantages, eliminates this binary incompatibility problem because those @code{libnss_*.so} files are loaded in the @command{nscd} process, not in applications themselves."
6294 #: guix-git/doc/guix.texi:1878
6300 #: guix-git/doc/guix.texi:1888
6301 msgid "The majority of graphical applications use Fontconfig to locate and load fonts and perform X11-client-side rendering. The @code{fontconfig} package in Guix looks for fonts in @file{$HOME/.guix-profile} by default. Thus, to allow graphical applications installed with Guix to display fonts, you have to install fonts with Guix as well. Essential font packages include @code{gs-fonts}, @code{font-dejavu}, and @code{font-gnu-freefont}."
6305 #: guix-git/doc/guix.texi:1889
6311 #: guix-git/doc/guix.texi:1890
6317 #: guix-git/doc/guix.texi:1894
6318 msgid "Once you have installed or removed fonts, or when you notice an application that does not find fonts, you may need to install Fontconfig and to force an update of its font cache by running:"
6322 #: guix-git/doc/guix.texi:1898
6325 "guix install fontconfig\n"
6330 #: guix-git/doc/guix.texi:1906
6331 msgid "To display text written in Chinese languages, Japanese, or Korean in graphical applications, consider installing @code{font-adobe-source-han-sans} or @code{font-wqy-zenhei}. The former has multiple outputs, one per language family (@pxref{Packages with Multiple Outputs}). For instance, the following command installs fonts for Chinese languages:"
6335 #: guix-git/doc/guix.texi:1909
6337 msgid "guix install font-adobe-source-han-sans:cn\n"
6341 #: guix-git/doc/guix.texi:1911
6347 #: guix-git/doc/guix.texi:1915
6348 msgid "Older programs such as @command{xterm} do not use Fontconfig and instead rely on server-side font rendering. Such programs require to specify a full name of a font using XLFD (X Logical Font Description), like this:"
6352 #: guix-git/doc/guix.texi:1918
6354 msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n"
6358 #: guix-git/doc/guix.texi:1922
6359 msgid "To be able to use such full names for the TrueType fonts installed in your Guix profile, you need to extend the font path of the X server:"
6363 #: guix-git/doc/guix.texi:1927
6365 msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n"
6369 #: guix-git/doc/guix.texi:1929
6375 #: guix-git/doc/guix.texi:1932
6376 msgid "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to make sure your TrueType fonts are listed there."
6380 #: guix-git/doc/guix.texi:1936 guix-git/doc/guix.texi:32100
6386 #: guix-git/doc/guix.texi:1939
6387 msgid "The @code{nss-certs} package provides X.509 certificates, which allow programs to authenticate Web servers accessed over HTTPS."
6391 #: guix-git/doc/guix.texi:1944
6392 msgid "When using Guix on a foreign distro, you can install this package and define the relevant environment variables so that packages know where to look for certificates. @xref{X.509 Certificates}, for detailed information."
6396 #: guix-git/doc/guix.texi:1947
6402 #: guix-git/doc/guix.texi:1953
6403 msgid "When you install Emacs packages with Guix, the Elisp files are placed under the @file{share/emacs/site-lisp/} directory of the profile in which they are installed. The Elisp libraries are made available to Emacs through the @env{EMACSLOADPATH} environment variable, which is set when installing Emacs itself."
6407 #: guix-git/doc/guix.texi:1960
6408 msgid "Additionally, autoload definitions are automatically evaluated at the initialization of Emacs, by the Guix-specific @code{guix-emacs-autoload-packages} procedure. If, for some reason, you want to avoid auto-loading the Emacs packages installed with Guix, you can do so by running Emacs with the @option{--no-site-file} option (@pxref{Init File,,, emacs, The GNU Emacs Manual})."
6412 #: guix-git/doc/guix.texi:1965
6414 msgid "Upgrading Guix, on a foreign distro"
6418 #: guix-git/doc/guix.texi:1968
6419 msgid "To upgrade Guix, run:"
6423 #: guix-git/doc/guix.texi:1971 guix-git/doc/guix.texi:2842
6429 #: guix-git/doc/guix.texi:1974
6430 msgid "@xref{Invoking guix pull}, for more information."
6434 #: guix-git/doc/guix.texi:1975
6436 msgid "upgrading Guix for the root user, on a foreign distro"
6440 #: guix-git/doc/guix.texi:1976
6442 msgid "upgrading the Guix daemon, on a foreign distro"
6446 #: guix-git/doc/guix.texi:1977
6448 msgid "@command{guix pull} for the root user, on a foreign distro"
6452 #: guix-git/doc/guix.texi:1980
6453 msgid "On a foreign distro, you can upgrade the build daemon by running:"
6457 #: guix-git/doc/guix.texi:1983
6459 msgid "sudo -i guix pull\n"
6463 #: guix-git/doc/guix.texi:1988
6464 msgid "followed by (assuming your distro uses the systemd service management tool):"
6468 #: guix-git/doc/guix.texi:1991
6470 msgid "systemctl restart guix-daemon.service\n"
6474 #: guix-git/doc/guix.texi:1995
6475 msgid "On Guix System, upgrading the daemon is achieved by reconfiguring the system (@pxref{Invoking guix system, @code{guix system reconfigure}})."
6479 #: guix-git/doc/guix.texi:2002
6481 msgid "installing Guix System"
6485 #: guix-git/doc/guix.texi:2003
6487 msgid "Guix System, installation"
6491 #: guix-git/doc/guix.texi:2008
6492 msgid "This section explains how to install Guix System on a machine. Guix, as a package manager, can also be installed on top of a running GNU/Linux system, @pxref{Installation}."
6496 #: guix-git/doc/guix.texi:2017
6497 msgid "You are reading this documentation with an Info reader. For details on how to use it, hit the @key{RET} key (``return'' or ``enter'') on the link that follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}. Hit @kbd{l} afterwards to come back here."
6501 #: guix-git/doc/guix.texi:2020
6502 msgid "Alternatively, run @command{info info} in another tty to keep the manual available."
6506 #: guix-git/doc/guix.texi:2041
6507 msgid "We consider Guix System to be ready for a wide range of ``desktop'' and server use cases. The reliability guarantees it provides---transactional upgrades and rollbacks, reproducibility---make it a solid foundation."
6511 #: guix-git/doc/guix.texi:2044
6512 msgid "Nevertheless, before you proceed with the installation, be aware of the following noteworthy limitations applicable to version @value{VERSION}:"
6516 #: guix-git/doc/guix.texi:2049
6517 msgid "More and more system services are provided (@pxref{Services}), but some may be missing."
6521 #: guix-git/doc/guix.texi:2054
6522 msgid "GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop Services}), as well as a number of X11 window managers. However, KDE is currently missing."
6526 #: guix-git/doc/guix.texi:2059
6527 msgid "More than a disclaimer, this is an invitation to report issues (and success stories!), and to join us in improving it. @xref{Contributing}, for more info."
6531 #: guix-git/doc/guix.texi:2064
6533 msgid "hardware support on Guix System"
6537 #: guix-git/doc/guix.texi:2073
6538 msgid "GNU@tie{}Guix focuses on respecting the user's computing freedom. It builds around the kernel Linux-libre, which means that only hardware for which free software drivers and firmware exist is supported. Nowadays, a wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to graphics cards to scanners and Ethernet controllers. Unfortunately, there are still areas where hardware vendors deny users control over their own computing, and such hardware is not supported on Guix System."
6542 #: guix-git/doc/guix.texi:2074
6544 msgid "WiFi, hardware support"
6548 #: guix-git/doc/guix.texi:2083
6549 msgid "One of the main areas where free drivers or firmware are lacking is WiFi devices. WiFi devices known to work include those using Atheros chips (AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. Free firmware exists for both and is available out-of-the-box on Guix System, as part of @code{%base-firmware} (@pxref{operating-system Reference, @code{firmware}})."
6553 #: guix-git/doc/guix.texi:2084
6555 msgid "RYF, Respects Your Freedom"
6559 #: guix-git/doc/guix.texi:2090
6560 msgid "The @uref{https://www.fsf.org/, Free Software Foundation} runs @uref{https://www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a certification program for hardware products that respect your freedom and your privacy and ensure that you have control over your device. We encourage you to check the list of RYF-certified devices."
6564 #: guix-git/doc/guix.texi:2094
6565 msgid "Another useful resource is the @uref{https://www.h-node.org/, H-Node} web site. It contains a catalog of hardware devices with information about their support in GNU/Linux."
6569 #: guix-git/doc/guix.texi:2103
6570 msgid "An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from @indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz}, where you can replace @code{x86_64-linux} with one of:"
6574 #: guix-git/doc/guix.texi:2107
6575 msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;"
6579 #: guix-git/doc/guix.texi:2110
6580 msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs."
6584 #: guix-git/doc/guix.texi:2115
6585 msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines:"
6589 #: guix-git/doc/guix.texi:2119
6592 "$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig\n"
6593 "$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig\n"
6597 #: guix-git/doc/guix.texi:2127
6600 "$ wget @value{OPENPGP-SIGNING-KEY-URL} \\\n"
6601 " -qO - | gpg --import -\n"
6605 #: guix-git/doc/guix.texi:2139
6606 msgid "This image contains the tools necessary for an installation. It is meant to be copied @emph{as is} to a large-enough USB stick or DVD."
6609 #. type: unnumberedsubsec
6610 #: guix-git/doc/guix.texi:2140
6612 msgid "Copying to a USB Stick"
6616 #: guix-git/doc/guix.texi:2143
6617 msgid "To copy the image to a USB stick, follow these steps:"
6621 #: guix-git/doc/guix.texi:2147 guix-git/doc/guix.texi:2172
6622 msgid "Decompress the image using the @command{xz} command:"
6626 #: guix-git/doc/guix.texi:2150 guix-git/doc/guix.texi:2175
6628 msgid "xz -d guix-system-install-@value{VERSION}.x86_64-linux.iso.xz\n"
6632 #: guix-git/doc/guix.texi:2156
6633 msgid "Insert a USB stick of 1@tie{}GiB or more into your machine, and determine its device name. Assuming that the USB stick is known as @file{/dev/sdX}, copy the image with:"
6637 #: guix-git/doc/guix.texi:2160
6640 "dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX status=progress\n"
6645 #: guix-git/doc/guix.texi:2163
6646 msgid "Access to @file{/dev/sdX} usually requires root privileges."
6649 #. type: unnumberedsubsec
6650 #: guix-git/doc/guix.texi:2165
6652 msgid "Burning on a DVD"
6656 #: guix-git/doc/guix.texi:2168
6657 msgid "To copy the image to a DVD, follow these steps:"
6661 #: guix-git/doc/guix.texi:2181
6662 msgid "Insert a blank DVD into your machine, and determine its device name. Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with:"
6666 #: guix-git/doc/guix.texi:2184
6668 msgid "growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso\n"
6672 #: guix-git/doc/guix.texi:2187
6673 msgid "Access to @file{/dev/srX} usually requires root privileges."
6676 #. type: unnumberedsubsec
6677 #: guix-git/doc/guix.texi:2189
6683 #: guix-git/doc/guix.texi:2196
6684 msgid "Once this is done, you should be able to reboot the system and boot from the USB stick or DVD@. The latter usually requires you to get in the BIOS or UEFI boot menu, where you can choose to boot from the USB stick. In order to boot from Libreboot, switch to the command mode by pressing the @kbd{c} key and type @command{search_grub usb}."
6688 #: guix-git/doc/guix.texi:2199
6689 msgid "@xref{Installing Guix in a VM}, if, instead, you would like to install Guix System in a virtual machine (VM)."
6693 #: guix-git/doc/guix.texi:2209
6694 msgid "Once you have booted, you can use the guided graphical installer, which makes it easy to get started (@pxref{Guided Graphical Installation}). Alternatively, if you are already familiar with GNU/Linux and if you want more control than what the graphical installer provides, you can choose the ``manual'' installation process (@pxref{Manual Installation})."
6698 #: guix-git/doc/guix.texi:2217
6699 msgid "The graphical installer is available on TTY1. You can obtain root shells on TTYs 3 to 6 by hitting @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, etc. TTY2 shows this documentation and you can reach it with @kbd{ctrl-alt-f2}. Documentation is browsable using the Info reader commands (@pxref{Top,,, info-stnd, Stand-alone GNU Info}). The installation system runs the GPM mouse daemon, which allows you to select text with the left mouse button and to paste it with the middle button."
6703 #: guix-git/doc/guix.texi:2222
6704 msgid "Installation requires access to the Internet so that any missing dependencies of your system configuration can be downloaded. See the ``Networking'' section below."
6708 #: guix-git/doc/guix.texi:2229
6709 msgid "The graphical installer is a text-based user interface. It will guide you, with dialog boxes, through the steps needed to install GNU@tie{}Guix System."
6713 #: guix-git/doc/guix.texi:2234
6714 msgid "The first dialog boxes allow you to set up the system as you use it during the installation: you can choose the language, keyboard layout, and set up networking, which will be used during the installation. The image below shows the networking dialog."
6718 #: guix-git/doc/guix.texi:2236
6719 msgid "@image{images/installer-network,5in,, networking setup with the graphical installer}"
6723 #: guix-git/doc/guix.texi:2241
6724 msgid "Later steps allow you to partition your hard disk, as shown in the image below, to choose whether or not to use encrypted file systems, to enter the host name and root password, and to create an additional account, among other things."
6728 #: guix-git/doc/guix.texi:2243
6729 msgid "@image{images/installer-partitions,5in,, partitioning with the graphical installer}"
6733 #: guix-git/doc/guix.texi:2246
6734 msgid "Note that, at any time, the installer allows you to exit the current installation step and resume at a previous step, as show in the image below."
6738 #: guix-git/doc/guix.texi:2248
6739 msgid "@image{images/installer-resume,5in,, resuming the installation process}"
6743 #: guix-git/doc/guix.texi:2253
6744 msgid "Once you're done, the installer produces an operating system configuration and displays it (@pxref{Using the Configuration System}). At that point you can hit ``OK'' and installation will proceed. On success, you can reboot into the new system and enjoy. @xref{After System Installation}, for what's next!"
6748 #: guix-git/doc/guix.texi:2263
6749 msgid "This section describes how you would ``manually'' install GNU@tie{}Guix System on your machine. This option requires familiarity with GNU/Linux, with the shell, and with common administration tools. If you think this is not for you, consider using the guided graphical installer (@pxref{Guided Graphical Installation})."
6753 #: guix-git/doc/guix.texi:2269
6754 msgid "The installation system provides root shells on TTYs 3 to 6; press @kbd{ctrl-alt-f3}, @kbd{ctrl-alt-f4}, and so on to reach them. It includes many common tools needed to install the system. But it is also a full-blown Guix System, which means that you can install additional packages, should you need it, using @command{guix package} (@pxref{Invoking guix package})."
6758 #: guix-git/doc/guix.texi:2276
6760 msgid "Keyboard Layout, Networking, and Partitioning"
6764 #: guix-git/doc/guix.texi:2281
6765 msgid "Before you can install the system, you may want to adjust the keyboard layout, set up networking, and partition your target hard disk. This section will guide you through this."
6769 #: guix-git/doc/guix.texi:2284 guix-git/doc/guix.texi:14553
6771 msgid "keyboard layout"
6775 #: guix-git/doc/guix.texi:2288
6776 msgid "The installation image uses the US qwerty keyboard layout. If you want to change it, you can use the @command{loadkeys} command. For example, the following command selects the Dvorak keyboard layout:"
6780 #: guix-git/doc/guix.texi:2291
6782 msgid "loadkeys dvorak\n"
6786 #: guix-git/doc/guix.texi:2296
6787 msgid "See the files under @file{/run/current-system/profile/share/keymaps} for a list of available keyboard layouts. Run @command{man loadkeys} for more information."
6790 #. type: subsubsection
6791 #: guix-git/doc/guix.texi:2297
6797 #: guix-git/doc/guix.texi:2300
6798 msgid "Run the following command to see what your network interfaces are called:"
6802 #: guix-git/doc/guix.texi:2303
6804 msgid "ifconfig -a\n"
6808 #: guix-git/doc/guix.texi:2307 guix-git/doc/guix.texi:2329
6809 msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:"
6813 #: guix-git/doc/guix.texi:2310
6815 msgid "ip address\n"
6819 #: guix-git/doc/guix.texi:2317
6820 msgid "Wired interfaces have a name starting with @samp{e}; for example, the interface corresponding to the first on-board Ethernet controller is called @samp{eno1}. Wireless interfaces have a name starting with @samp{w}, like @samp{w1p2s0}."
6824 #: guix-git/doc/guix.texi:2319
6826 msgid "Wired connection"
6830 #: guix-git/doc/guix.texi:2322
6831 msgid "To configure a wired network run the following command, substituting @var{interface} with the name of the wired interface you want to use."
6835 #: guix-git/doc/guix.texi:2325
6837 msgid "ifconfig @var{interface} up\n"
6841 #: guix-git/doc/guix.texi:2332
6843 msgid "ip link set @var{interface} up\n"
6847 #: guix-git/doc/guix.texi:2334
6849 msgid "Wireless connection"
6853 #: guix-git/doc/guix.texi:2335 guix-git/doc/guix.texi:16178
6859 #: guix-git/doc/guix.texi:2336 guix-git/doc/guix.texi:16179
6865 #: guix-git/doc/guix.texi:2341
6866 msgid "To configure wireless networking, you can create a configuration file for the @command{wpa_supplicant} configuration tool (its location is not important) using one of the available text editors such as @command{nano}:"
6870 #: guix-git/doc/guix.texi:2344
6872 msgid "nano wpa_supplicant.conf\n"
6876 #: guix-git/doc/guix.texi:2349
6877 msgid "As an example, the following stanza can go to this file and will work for many wireless networks, provided you give the actual SSID and passphrase for the network you are connecting to:"
6881 #: guix-git/doc/guix.texi:2356
6885 " ssid=\"@var{my-ssid}\"\n"
6886 " key_mgmt=WPA-PSK\n"
6887 " psk=\"the network's secret passphrase\"\n"
6892 #: guix-git/doc/guix.texi:2361
6893 msgid "Start the wireless service and run it in the background with the following command (substitute @var{interface} with the name of the network interface you want to use):"
6897 #: guix-git/doc/guix.texi:2364
6899 msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n"
6903 #: guix-git/doc/guix.texi:2367
6904 msgid "Run @command{man wpa_supplicant} for more information."
6908 #: guix-git/doc/guix.texi:2369
6914 #: guix-git/doc/guix.texi:2372
6915 msgid "At this point, you need to acquire an IP address. On a network where IP addresses are automatically assigned @i{via} DHCP, you can run:"
6919 #: guix-git/doc/guix.texi:2375
6921 msgid "dhclient -v @var{interface}\n"
6925 #: guix-git/doc/guix.texi:2378
6926 msgid "Try to ping a server to see if networking is up and running:"
6930 #: guix-git/doc/guix.texi:2381
6932 msgid "ping -c 3 gnu.org\n"
6936 #: guix-git/doc/guix.texi:2385
6937 msgid "Setting up network access is almost always a requirement because the image does not contain all the software and tools that may be needed."
6941 #: guix-git/doc/guix.texi:2386
6943 msgid "proxy, during system installation"
6947 #: guix-git/doc/guix.texi:2389
6948 msgid "If you need HTTP and HTTPS access to go through a proxy, run the following command:"
6952 #: guix-git/doc/guix.texi:2392
6954 msgid "herd set-http-proxy guix-daemon @var{URL}\n"
6958 #: guix-git/doc/guix.texi:2397
6959 msgid "where @var{URL} is the proxy URL, for example @code{http://example.org:8118}."
6963 #: guix-git/doc/guix.texi:2398
6965 msgid "installing over SSH"
6969 #: guix-git/doc/guix.texi:2401
6970 msgid "If you want to, you can continue the installation remotely by starting an SSH server:"
6974 #: guix-git/doc/guix.texi:2404
6976 msgid "herd start ssh-daemon\n"
6980 #: guix-git/doc/guix.texi:2408
6981 msgid "Make sure to either set a password with @command{passwd}, or configure OpenSSH public key authentication before logging in."
6984 #. type: subsubsection
6985 #: guix-git/doc/guix.texi:2409
6987 msgid "Disk Partitioning"
6991 #: guix-git/doc/guix.texi:2413
6992 msgid "Unless this has already been done, the next step is to partition, and then format the target partition(s)."
6996 #: guix-git/doc/guix.texi:2418
6997 msgid "The installation image includes several partitioning tools, including Parted (@pxref{Overview,,, parted, GNU Parted User Manual}), @command{fdisk}, and @command{cfdisk}. Run it and set up your disk with the partition layout you want:"
7001 #: guix-git/doc/guix.texi:2421
7007 #: guix-git/doc/guix.texi:2427
7008 msgid "If your disk uses the GUID Partition Table (GPT) format and you plan to install BIOS-based GRUB (which is the default), make sure a BIOS Boot Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB manual})."
7012 #: guix-git/doc/guix.texi:2428
7014 msgid "EFI, installation"
7018 #: guix-git/doc/guix.texi:2429
7020 msgid "UEFI, installation"
7024 #: guix-git/doc/guix.texi:2430
7026 msgid "ESP, EFI system partition"
7030 #: guix-git/doc/guix.texi:2434
7031 msgid "If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System Partition} (ESP) is required. This partition can be mounted at @file{/boot/efi} for instance and must have the @code{esp} flag set. E.g., for @command{parted}:"
7035 #: guix-git/doc/guix.texi:2437
7037 msgid "parted /dev/sda set 1 esp on\n"
7041 #: guix-git/doc/guix.texi:2440 guix-git/doc/guix.texi:32500
7043 msgid "grub-bootloader"
7047 #: guix-git/doc/guix.texi:2441 guix-git/doc/guix.texi:32494
7049 msgid "grub-efi-bootloader"
7053 #: guix-git/doc/guix.texi:2448
7054 msgid "Unsure whether to use EFI- or BIOS-based GRUB? If the directory @file{/sys/firmware/efi} exists in the installation image, then you should probably perform an EFI installation, using @code{grub-efi-bootloader}. Otherwise you should use the BIOS-based GRUB, known as @code{grub-bootloader}. @xref{Bootloader Configuration}, for more info on bootloaders."
7058 #: guix-git/doc/guix.texi:2456
7059 msgid "Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s)@footnote{Currently Guix System only supports ext4, btrfs, JFS, and F2FS file systems. In particular, code that reads file system UUIDs and labels only works for these file system types.}. For the ESP, if you have one and assuming it is @file{/dev/sda1}, run:"
7063 #: guix-git/doc/guix.texi:2459
7065 msgid "mkfs.fat -F32 /dev/sda1\n"
7069 #: guix-git/doc/guix.texi:2466
7070 msgid "For the root file system, ext4 is the most widely used format. Other file systems, such as Btrfs, support compression, which is reported to nicely complement file deduplication that the daemon performs independently of the file system (@pxref{Invoking guix-daemon, deduplication})."
7074 #: guix-git/doc/guix.texi:2473
7075 msgid "Preferably, assign file systems a label so that you can easily and reliably refer to them in @code{file-system} declarations (@pxref{File Systems}). This is typically done using the @code{-L} option of @command{mkfs.ext4} and related commands. So, assuming the target root partition lives at @file{/dev/sda2}, a file system with the label @code{my-root} can be created with:"
7079 #: guix-git/doc/guix.texi:2476
7081 msgid "mkfs.ext4 -L my-root /dev/sda2\n"
7085 #: guix-git/doc/guix.texi:2478 guix-git/doc/guix.texi:13551
7087 msgid "encrypted disk"
7091 #: guix-git/doc/guix.texi:2485
7092 msgid "If you are instead planning to encrypt the root partition, you can use the Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, @uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, @code{man cryptsetup}} for more information). Assuming you want to store the root partition on @file{/dev/sda2}, the command sequence would be along these lines:"
7096 #: guix-git/doc/guix.texi:2490
7099 "cryptsetup luksFormat /dev/sda2\n"
7100 "cryptsetup open --type luks /dev/sda2 my-partition\n"
7101 "mkfs.ext4 -L my-root /dev/mapper/my-partition\n"
7105 #: guix-git/doc/guix.texi:2495
7106 msgid "Once that is done, mount the target file system under @file{/mnt} with a command like (again, assuming @code{my-root} is the label of the root file system):"
7110 #: guix-git/doc/guix.texi:2498
7112 msgid "mount LABEL=my-root /mnt\n"
7116 #: guix-git/doc/guix.texi:2504
7117 msgid "Also mount any other file systems you would like to use on the target system relative to this path. If you have opted for @file{/boot/efi} as an EFI mount point for example, mount it at @file{/mnt/boot/efi} now so it is found by @code{guix system init} afterwards."
7121 #: guix-git/doc/guix.texi:2509
7122 msgid "Finally, if you plan to use one or more swap partitions (@pxref{Memory Concepts, swap space,, libc, The GNU C Library Reference Manual}), make sure to initialize them with @command{mkswap}. Assuming you have one swap partition on @file{/dev/sda3}, you would run:"
7126 #: guix-git/doc/guix.texi:2513
7129 "mkswap /dev/sda3\n"
7130 "swapon /dev/sda3\n"
7134 #: guix-git/doc/guix.texi:2521
7135 msgid "Alternatively, you may use a swap file. For example, assuming that in the new system you want to use the file @file{/swapfile} as a swap file, you would run@footnote{This example will work for many types of file systems (e.g., ext4). However, for copy-on-write file systems (e.g., btrfs), the required steps may be different. For details, see the manual pages for @command{mkswap} and @command{swapon}.}:"
7139 #: guix-git/doc/guix.texi:2529
7142 "# This is 10 GiB of swap space. Adjust \"count\" to change the size.\n"
7143 "dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240\n"
7144 "# For security, make the file readable and writable only by root.\n"
7145 "chmod 600 /mnt/swapfile\n"
7146 "mkswap /mnt/swapfile\n"
7147 "swapon /mnt/swapfile\n"
7151 #: guix-git/doc/guix.texi:2534
7152 msgid "Note that if you have encrypted the root partition and created a swap file in its file system as described above, then the encryption also protects the swap file, just like any other file in that file system."
7156 #: guix-git/doc/guix.texi:2540
7157 msgid "With the target partitions ready and the target root mounted on @file{/mnt}, we're ready to go. First, run:"
7161 #: guix-git/doc/guix.texi:2543
7163 msgid "herd start cow-store /mnt\n"
7167 #: guix-git/doc/guix.texi:2550
7168 msgid "This makes @file{/gnu/store} copy-on-write, such that packages added to it during the installation phase are written to the target disk on @file{/mnt} rather than kept in memory. This is necessary because the first phase of the @command{guix system init} command (see below) entails downloads or builds to @file{/gnu/store} which, initially, is an in-memory file system."
7172 #: guix-git/doc/guix.texi:2561
7173 msgid "Next, you have to edit a file and provide the declaration of the operating system to be installed. To that end, the installation system comes with three text editors. We recommend GNU nano (@pxref{Top,,, nano, GNU nano Manual}), which supports syntax highlighting and parentheses matching; other editors include GNU Zile (an Emacs clone), and nvi (a clone of the original BSD @command{vi} editor). We strongly recommend storing that file on the target root file system, say, as @file{/mnt/etc/config.scm}. Failing to do that, you will have lost your configuration file once you have rebooted into the newly-installed system."
7177 #: guix-git/doc/guix.texi:2568
7178 msgid "@xref{Using the Configuration System}, for an overview of the configuration file. The example configurations discussed in that section are available under @file{/etc/configuration} in the installation image. Thus, to get started with a system configuration providing a graphical display server (a ``desktop'' system), you can run something along these lines:"
7182 #: guix-git/doc/guix.texi:2573
7185 "# mkdir /mnt/etc\n"
7186 "# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n"
7187 "# nano /mnt/etc/config.scm\n"
7191 #: guix-git/doc/guix.texi:2577
7192 msgid "You should pay attention to what your configuration file contains, and in particular:"
7196 #: guix-git/doc/guix.texi:2588
7197 msgid "Make sure the @code{bootloader-configuration} form refers to the target you want to install GRUB on. It should mention @code{grub-bootloader} if you are installing GRUB in the legacy way, or @code{grub-efi-bootloader} for newer UEFI systems. For legacy systems, the @code{target} field names a device, like @code{/dev/sda}; for UEFI systems it names a path to a mounted EFI partition, like @code{/boot/efi}; do make sure the path is currently mounted and a @code{file-system} entry is specified in your configuration."
7201 #: guix-git/doc/guix.texi:2594
7202 msgid "Be sure that your file system labels match the value of their respective @code{device} fields in your @code{file-system} configuration, assuming your @code{file-system} configuration uses the @code{file-system-label} procedure in its @code{device} field."
7206 #: guix-git/doc/guix.texi:2598
7207 msgid "If there are encrypted or RAID partitions, make sure to add a @code{mapped-devices} field to describe them (@pxref{Mapped Devices})."
7211 #: guix-git/doc/guix.texi:2603
7212 msgid "Once you are done preparing the configuration file, the new system must be initialized (remember that the target root file system is mounted under @file{/mnt}):"
7216 #: guix-git/doc/guix.texi:2606
7218 msgid "guix system init /mnt/etc/config.scm /mnt\n"
7222 #: guix-git/doc/guix.texi:2613
7223 msgid "This copies all the necessary files and installs GRUB on @file{/dev/sdX}, unless you pass the @option{--no-bootloader} option. For more information, @pxref{Invoking guix system}. This command may trigger downloads or builds of missing packages, which can take some time."
7227 #: guix-git/doc/guix.texi:2621
7228 msgid "Once that command has completed---and hopefully succeeded!---you can run @command{reboot} and boot into the new system. The @code{root} password in the new system is initially empty; other users' passwords need to be initialized by running the @command{passwd} command as @code{root}, unless your configuration specifies otherwise (@pxref{user-account-password, user account passwords}). @xref{After System Installation}, for what's next!"
7232 #: guix-git/doc/guix.texi:2628
7233 msgid "Success, you've now booted into Guix System! From then on, you can update the system whenever you want by running, say:"
7237 #: guix-git/doc/guix.texi:2632
7241 "sudo guix system reconfigure /etc/config.scm\n"
7245 #: guix-git/doc/guix.texi:2638
7246 msgid "This builds a new system generation with the latest packages and services (@pxref{Invoking guix system}). We recommend doing that regularly so that your system includes the latest security updates (@pxref{Security Updates})."
7250 #: guix-git/doc/guix.texi:2641
7252 msgid "sudo vs. @command{guix pull}"
7256 #: guix-git/doc/guix.texi:2645
7257 msgid "Note that @command{sudo guix} runs your user's @command{guix} command and @emph{not} root's, because @command{sudo} leaves @env{PATH} unchanged. To explicitly run root's @command{guix}, type @command{sudo -i guix @dots{}}."
7261 #: guix-git/doc/guix.texi:2650
7262 msgid "The difference matters here, because @command{guix pull} updates the @command{guix} command and package definitions only for the user it is run as. This means that if you choose to use @command{guix system reconfigure} in root's login shell, you'll need to @command{guix pull} separately."
7266 #: guix-git/doc/guix.texi:2655
7267 msgid "Now, @pxref{Getting Started}, and join us on @code{#guix} on the Freenode IRC network or on @email{guix-devel@@gnu.org} to share your experience!"
7271 #: guix-git/doc/guix.texi:2658
7273 msgid "Installing Guix in a Virtual Machine"
7277 #: guix-git/doc/guix.texi:2660
7279 msgid "virtual machine, Guix System installation"
7283 #: guix-git/doc/guix.texi:2661
7285 msgid "virtual private server (VPS)"
7289 #: guix-git/doc/guix.texi:2662
7291 msgid "VPS (virtual private server)"
7295 #: guix-git/doc/guix.texi:2666
7296 msgid "If you'd like to install Guix System in a virtual machine (VM) or on a virtual private server (VPS) rather than on your beloved machine, this section is for you."
7300 #: guix-git/doc/guix.texi:2669
7301 msgid "To boot a @uref{https://qemu.org/,QEMU} VM for installing Guix System in a disk image, follow these steps:"
7305 #: guix-git/doc/guix.texi:2674
7306 msgid "First, retrieve and decompress the Guix system installation image as described previously (@pxref{USB Stick and DVD Installation})."
7310 #: guix-git/doc/guix.texi:2678
7311 msgid "Create a disk image that will hold the installed system. To make a qcow2-formatted disk image, use the @command{qemu-img} command:"
7315 #: guix-git/doc/guix.texi:2681
7317 msgid "qemu-img create -f qcow2 guix-system.img 50G\n"
7321 #: guix-git/doc/guix.texi:2685
7322 msgid "The resulting file will be much smaller than 50 GB (typically less than 1 MB), but it will grow as the virtualized storage device is filled up."
7326 #: guix-git/doc/guix.texi:2688
7327 msgid "Boot the USB installation image in an VM:"
7331 #: guix-git/doc/guix.texi:2694
7334 "qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \\\n"
7335 " -nic user,model=virtio-net-pci -boot menu=on,order=d \\\n"
7336 " -drive file=guix-system.img \\\n"
7337 " -drive media=cdrom,file=guix-system-install-@value{VERSION}.@var{system}.iso\n"
7341 #: guix-git/doc/guix.texi:2698
7342 msgid "@code{-enable-kvm} is optional, but significantly improves performance, @pxref{Running Guix in a VM}."
7346 #: guix-git/doc/guix.texi:2702
7347 msgid "You're now root in the VM, proceed with the installation process. @xref{Preparing for Installation}, and follow the instructions."
7351 #: guix-git/doc/guix.texi:2707
7352 msgid "Once installation is complete, you can boot the system that's on your @file{guix-system.img} image. @xref{Running Guix in a VM}, for how to do that."
7356 #: guix-git/doc/guix.texi:2711
7358 msgid "installation image"
7362 #: guix-git/doc/guix.texi:2714
7363 msgid "The installation image described above was built using the @command{guix system} command, specifically:"
7367 #: guix-git/doc/guix.texi:2717
7369 msgid "guix system image -t iso9660 gnu/system/install.scm\n"
7373 #: guix-git/doc/guix.texi:2722
7374 msgid "Have a look at @file{gnu/system/install.scm} in the source tree, and see also @ref{Invoking guix system} for more information about the installation image."
7378 #: guix-git/doc/guix.texi:2723
7380 msgid "Building the Installation Image for ARM Boards"
7384 #: guix-git/doc/guix.texi:2727
7385 msgid "Many ARM boards require a specific variant of the @uref{https://www.denx.de/wiki/U-Boot/, U-Boot} bootloader."
7389 #: guix-git/doc/guix.texi:2731
7390 msgid "If you build a disk image and the bootloader is not available otherwise (on another boot drive etc), it's advisable to build an image that includes the bootloader, specifically:"
7394 #: guix-git/doc/guix.texi:2734
7396 msgid "guix system image --system=armhf-linux -e '((@@ (gnu system install) os-with-u-boot) (@@ (gnu system install) installation-os) \"A20-OLinuXino-Lime2\")'\n"
7400 #: guix-git/doc/guix.texi:2738
7401 msgid "@code{A20-OLinuXino-Lime2} is the name of the board. If you specify an invalid board, a list of possible boards will be printed."
7405 #: guix-git/doc/guix.texi:2748
7406 msgid "Presumably, you've reached this section because either you have installed Guix on top of another distribution (@pxref{Installation}), or you've installed the standalone Guix System (@pxref{System Installation}). It's time for you to get started using Guix and this section aims to help you do that and give you a feel of what it's like."
7410 #: guix-git/doc/guix.texi:2752
7411 msgid "Guix is about installing software, so probably the first thing you'll want to do is to actually look for software. Let's say you're looking for a text editor, you can run:"
7415 #: guix-git/doc/guix.texi:2755
7417 msgid "guix search text editor\n"
7421 #: guix-git/doc/guix.texi:2762
7422 msgid "This command shows you a number of matching @dfn{packages}, each time showing the package's name, version, a description, and additional info. Once you've found out the one you want to use, let's say Emacs (ah ha!), you can go ahead and install it (run this command as a regular user, @emph{no need for root privileges}!):"
7426 #: guix-git/doc/guix.texi:2765
7428 msgid "guix install emacs\n"
7432 #: guix-git/doc/guix.texi:2767 guix-git/doc/guix.texi:3079
7433 #: guix-git/doc/guix.texi:3131
7439 #: guix-git/doc/guix.texi:2775
7440 msgid "You've installed your first package, congrats! The package is now visible in your default @dfn{profile}, @file{$HOME/.guix-profile}---a profile is a directory containing installed packages. In the process, you've probably noticed that Guix downloaded pre-built binaries; or, if you explicitly chose to @emph{not} use pre-built binaries, then probably Guix is still building software (@pxref{Substitutes}, for more info)."
7444 #: guix-git/doc/guix.texi:2778
7445 msgid "Unless you're using Guix System, the @command{guix install} command must have printed this hint:"
7449 #: guix-git/doc/guix.texi:2781
7452 "hint: Consider setting the necessary environment variables by running:\n"
7457 #: guix-git/doc/guix.texi:2784
7460 " GUIX_PROFILE=\"$HOME/.guix-profile\"\n"
7461 " . \"$GUIX_PROFILE/etc/profile\"\n"
7466 #: guix-git/doc/guix.texi:2786
7468 msgid "Alternately, see `guix package --search-paths -p \"$HOME/.guix-profile\"'.\n"
7472 #: guix-git/doc/guix.texi:2800
7473 msgid "Indeed, you must now tell your shell where @command{emacs} and other programs installed with Guix are to be found. Pasting the two lines above will do just that: it will add @code{$HOME/.guix-profile/bin}---which is where the installed package is---to the @code{PATH} environment variable. You can paste these two lines in your shell so they take effect right away, but more importantly you should add them to @file{~/.bash_profile} (or equivalent file if you do not use Bash) so that environment variables are set next time you spawn a shell. You only need to do this once and other search paths environment variables will be taken care of similarly---e.g., if you eventually install @code{python} and Python libraries, @code{PYTHONPATH} will be defined."
7477 #: guix-git/doc/guix.texi:2803
7478 msgid "You can go on installing packages at your will. To list installed packages, run:"
7482 #: guix-git/doc/guix.texi:2806
7484 msgid "guix package --list-installed\n"
7488 #: guix-git/doc/guix.texi:2811
7489 msgid "To remove a package, you would unsurprisingly run @command{guix remove}. A distinguishing feature is the ability to @dfn{roll back} any operation you made---installation, removal, upgrade---by simply typing:"
7493 #: guix-git/doc/guix.texi:2814
7495 msgid "guix package --roll-back\n"
7499 #: guix-git/doc/guix.texi:2819
7500 msgid "This is because each operation is in fact a @dfn{transaction} that creates a new @dfn{generation}. These generations and the difference between them can be displayed by running:"
7504 #: guix-git/doc/guix.texi:2822
7506 msgid "guix package --list-generations\n"
7510 #: guix-git/doc/guix.texi:2825
7511 msgid "Now you know the basics of package management!"
7515 #: guix-git/doc/guix.texi:2826 guix-git/doc/guix.texi:2885
7517 msgid "Going further"
7521 #: guix-git/doc/guix.texi:2834
7522 msgid "@xref{Package Management}, for more about package management. You may like @dfn{declarative} package management with @command{guix package --manifest}, managing separate @dfn{profiles} with @option{--profile}, deleting old generations, collecting garbage, and other nifty features that will come in handy as you become more familiar with Guix. If you are a developer, @pxref{Development} for additional tools. And if you're curious, @pxref{Features}, to peek under the hood."
7526 #: guix-git/doc/guix.texi:2839
7527 msgid "Once you've installed a set of packages, you will want to periodically @emph{upgrade} them to the latest and greatest version. To do that, you will first pull the latest revision of Guix and its package collection:"
7531 #: guix-git/doc/guix.texi:2849
7532 msgid "The end result is a new @command{guix} command, under @file{~/.config/guix/current/bin}. Unless you're on Guix System, the first time you run @command{guix pull}, be sure to follow the hint that the command prints and, similar to what we saw above, paste these two lines in your terminal and @file{.bash_profile}:"
7536 #: guix-git/doc/guix.texi:2853
7539 "GUIX_PROFILE=\"$HOME/.config/guix/current\"\n"
7540 ". \"$GUIX_PROFILE/etc/profile\"\n"
7544 #: guix-git/doc/guix.texi:2857
7545 msgid "You must also instruct your shell to point to this new @command{guix}:"
7549 #: guix-git/doc/guix.texi:2860
7555 #: guix-git/doc/guix.texi:2864
7556 msgid "At this point, you're running a brand new Guix. You can thus go ahead and actually upgrade all the packages you previously installed:"
7560 #: guix-git/doc/guix.texi:2867
7562 msgid "guix upgrade\n"
7566 #: guix-git/doc/guix.texi:2873
7567 msgid "As you run this command, you will see that binaries are downloaded (or perhaps some packages are built), and eventually you end up with the upgraded packages. Should one of these upgraded packages not be to your liking, remember you can always roll back!"
7571 #: guix-git/doc/guix.texi:2876
7572 msgid "You can display the exact revision of Guix you're currently using by running:"
7576 #: guix-git/doc/guix.texi:2879
7578 msgid "guix describe\n"
7582 #: guix-git/doc/guix.texi:2884
7583 msgid "The information it displays is @emph{all it takes to reproduce the exact same Guix}, be it at a different point in time or on a different machine."
7587 #: guix-git/doc/guix.texi:2890
7588 msgid "@xref{Invoking guix pull}, for more information. @xref{Channels}, on how to specify additional @dfn{channels} to pull packages from, how to replicate Guix, and more. You may also find @command{time-machine} handy (@pxref{Invoking guix time-machine})."
7592 #: guix-git/doc/guix.texi:2895
7593 msgid "If you installed Guix System, one of the first things you'll want to do is to upgrade your system. Once you've run @command{guix pull} to get the latest Guix, you can upgrade the system like this:"
7597 #: guix-git/doc/guix.texi:2898
7599 msgid "sudo guix system reconfigure /etc/config.scm\n"
7603 #: guix-git/doc/guix.texi:2907
7604 msgid "Upon completion, the system runs the latest versions of its software packages. When you eventually reboot, you'll notice a sub-menu in the bootloader that reads ``Old system generations'': it's what allows you to boot @emph{an older generation of your system}, should the latest generation be ``broken'' or otherwise unsatisfying. Just like for packages, you can always @emph{roll back} to a previous generation @emph{of the whole system}:"
7608 #: guix-git/doc/guix.texi:2910
7610 msgid "sudo guix system roll-back\n"
7614 #: guix-git/doc/guix.texi:2917
7615 msgid "There are many things you'll probably want to tweak on your system: adding new user accounts, adding new system services, fiddling with the configuration of those services, etc. The system configuration is @emph{entirely} described in the @file{/etc/config.scm} file. @xref{Using the Configuration System}, to learn how to change it."
7619 #: guix-git/doc/guix.texi:2919
7620 msgid "Now you know enough to get started!"
7624 #: guix-git/doc/guix.texi:2920
7630 #: guix-git/doc/guix.texi:2923
7631 msgid "The rest of this manual provides a reference for all things Guix. Here are some additional resources you may find useful:"
7635 #: guix-git/doc/guix.texi:2928
7636 msgid "@xref{Top,,, guix-cookbook, The GNU Guix Cookbook}, for a list of ``how-to'' style of recipes for a variety of applications."
7640 #: guix-git/doc/guix.texi:2933
7641 msgid "The @uref{https://guix.gnu.org/guix-refcard.pdf, GNU Guix Reference Card} lists in two pages most of the commands and options you'll ever need."
7645 #: guix-git/doc/guix.texi:2938
7646 msgid "The web site contains @uref{https://guix.gnu.org/en/videos/, instructional videos} covering topics such as everyday use of Guix, how to get help, and how to become a contributor."
7650 #: guix-git/doc/guix.texi:2942
7651 msgid "@xref{Documentation}, to learn how to access documentation on your computer."
7655 #: guix-git/doc/guix.texi:2945
7656 msgid "We hope you will enjoy Guix as much as the community enjoys building it!"
7660 #: guix-git/doc/guix.texi:2951
7666 #: guix-git/doc/guix.texi:2956
7667 msgid "The purpose of GNU Guix is to allow users to easily install, upgrade, and remove software packages, without having to know about their build procedures or dependencies. Guix also goes beyond this obvious set of features."
7671 #: guix-git/doc/guix.texi:2964
7672 msgid "This chapter describes the main features of Guix, as well as the package management tools it provides. Along with the command-line interface described below (@pxref{Invoking guix package, @code{guix package}}), you may also use the Emacs-Guix interface (@pxref{Top,,, emacs-guix, The Emacs-Guix Reference Manual}), after installing @code{emacs-guix} package (run @kbd{M-x guix-help} command to start with it):"
7676 #: guix-git/doc/guix.texi:2967
7678 msgid "guix install emacs-guix\n"
7682 #: guix-git/doc/guix.texi:2988
7683 msgid "Here we assume you've already made your first steps with Guix (@pxref{Getting Started}) and would like to get an overview about what's going on under the hood."
7687 #: guix-git/doc/guix.texi:2992
7688 msgid "When using Guix, each package ends up in the @dfn{package store}, in its own directory---something that resembles @file{/gnu/store/xxx-package-1.2}, where @code{xxx} is a base32 string."
7692 #: guix-git/doc/guix.texi:2997
7693 msgid "Instead of referring to these directories, users have their own @dfn{profile}, which points to the packages that they actually want to use. These profiles are stored within each user's home directory, at @code{$HOME/.guix-profile}."
7697 #: guix-git/doc/guix.texi:3005
7698 msgid "For example, @code{alice} installs GCC 4.7.2. As a result, @file{/home/alice/.guix-profile/bin/gcc} points to @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Now, on the same machine, @code{bob} had already installed GCC 4.8.0. The profile of @code{bob} simply continues to point to @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC coexist on the same system without any interference."
7702 #: guix-git/doc/guix.texi:3009
7703 msgid "The @command{guix package} command is the central tool to manage packages (@pxref{Invoking guix package}). It operates on the per-user profiles, and can be used @emph{with normal user privileges}."
7707 #: guix-git/doc/guix.texi:3010 guix-git/doc/guix.texi:3093
7709 msgid "transactions"
7713 #: guix-git/doc/guix.texi:3017
7714 msgid "The command provides the obvious install, remove, and upgrade operations. Each invocation is actually a @emph{transaction}: either the specified operation succeeds, or nothing happens. Thus, if the @command{guix package} process is terminated during the transaction, or if a power outage occurs during the transaction, then the user's profile remains in its previous state, and remains usable."
7718 #: guix-git/doc/guix.texi:3025
7719 msgid "In addition, any package transaction may be @emph{rolled back}. So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well. Similarly, the global system configuration on Guix is subject to transactional upgrades and roll-back (@pxref{Using the Configuration System})."
7723 #: guix-git/doc/guix.texi:3032
7724 msgid "All packages in the package store may be @emph{garbage-collected}. Guix can determine which packages are still referenced by user profiles, and remove those that are provably no longer referenced (@pxref{Invoking guix gc}). Users may also explicitly remove old generations of their profile so that the packages they refer to can be collected."
7728 #: guix-git/doc/guix.texi:3033 guix-git/doc/guix.texi:4716
7730 msgid "reproducibility"
7734 #: guix-git/doc/guix.texi:3045
7735 msgid "Guix takes a @dfn{purely functional} approach to package management, as described in the introduction (@pxref{Introduction}). Each @file{/gnu/store} package directory name contains a hash of all the inputs that were used to build that package---compiler, libraries, build scripts, etc. This direct correspondence allows users to make sure a given package installation matches the current state of their distribution. It also helps maximize @dfn{build reproducibility}: thanks to the isolated build environments that are used, a given build is likely to yield bit-identical files when performed on different machines (@pxref{Invoking guix-daemon, container})."
7739 #: guix-git/doc/guix.texi:3056
7740 msgid "This foundation allows Guix to support @dfn{transparent binary/source deployment}. When a pre-built binary for a @file{/gnu/store} item is available from an external source---a @dfn{substitute}, Guix just downloads it and unpacks it; otherwise, it builds the package from source, locally (@pxref{Substitutes}). Because build results are usually bit-for-bit reproducible, users do not have to trust servers that provide substitutes: they can force a local build and @emph{challenge} providers (@pxref{Invoking guix challenge})."
7744 #: guix-git/doc/guix.texi:3062
7745 msgid "Control over the build environment is a feature that is also useful for developers. The @command{guix environment} command allows developers of a package to quickly set up the right development environment for their package, without having to manually install the dependencies of the package into their profile (@pxref{Invoking guix environment})."
7749 #: guix-git/doc/guix.texi:3063
7751 msgid "replication, of software environments"
7755 #: guix-git/doc/guix.texi:3064
7757 msgid "provenance tracking, of software artifacts"
7761 #: guix-git/doc/guix.texi:3071
7762 msgid "All of Guix and its package definitions is version-controlled, and @command{guix pull} allows you to ``travel in time'' on the history of Guix itself (@pxref{Invoking guix pull}). This makes it possible to replicate a Guix instance on a different machine or at a later point in time, which in turn allows you to @emph{replicate complete software environments}, while retaining precise @dfn{provenance tracking} of the software."
7766 #: guix-git/doc/guix.texi:3073
7768 msgid "Invoking @command{guix package}"
7772 #: guix-git/doc/guix.texi:3075
7774 msgid "installing packages"
7778 #: guix-git/doc/guix.texi:3076
7780 msgid "removing packages"
7784 #: guix-git/doc/guix.texi:3077
7786 msgid "package installation"
7790 #: guix-git/doc/guix.texi:3078
7792 msgid "package removal"
7796 #: guix-git/doc/guix.texi:3088
7797 msgid "The @command{guix package} command is the tool that allows users to install, upgrade, and remove packages, as well as rolling back to previous configurations. These operations work on a user @dfn{profile}---a directory of installed packages. Each user has a default profile in @file{$HOME/.guix-profile}. The command operates only on the user's own profile, and works with normal user privileges (@pxref{Features}). Its syntax is:"
7801 #: guix-git/doc/guix.texi:3091
7803 msgid "guix package @var{options}\n"
7807 #: guix-git/doc/guix.texi:3098
7808 msgid "Primarily, @var{options} specifies the operations to be performed during the transaction. Upon completion, a new profile is created, but previous @dfn{generations} of the profile remain available, should the user want to roll back."
7812 #: guix-git/doc/guix.texi:3101
7813 msgid "For example, to remove @code{lua} and install @code{guile} and @code{guile-cairo} in a single transaction:"
7817 #: guix-git/doc/guix.texi:3104
7819 msgid "guix package -r lua -i guile guile-cairo\n"
7823 #: guix-git/doc/guix.texi:3106
7825 msgid "aliases, for @command{guix package}"
7829 #: guix-git/doc/guix.texi:3108
7830 msgid "For your convenience, we also provide the following aliases:"
7834 #: guix-git/doc/guix.texi:3112
7835 msgid "@command{guix search} is an alias for @command{guix package -s},"
7839 #: guix-git/doc/guix.texi:3114
7840 msgid "@command{guix install} is an alias for @command{guix package -i},"
7844 #: guix-git/doc/guix.texi:3116
7845 msgid "@command{guix remove} is an alias for @command{guix package -r},"
7849 #: guix-git/doc/guix.texi:3118
7850 msgid "@command{guix upgrade} is an alias for @command{guix package -u},"
7854 #: guix-git/doc/guix.texi:3120
7855 msgid "and @command{guix show} is an alias for @command{guix package --show=}."
7859 #: guix-git/doc/guix.texi:3125
7860 msgid "These aliases are less expressive than @command{guix package} and provide fewer options, so in some cases you'll probably want to use @command{guix package} directly."
7864 #: guix-git/doc/guix.texi:3130
7865 msgid "@command{guix package} also supports a @dfn{declarative approach} whereby the user specifies the exact set of packages to be available and passes it @i{via} the @option{--manifest} option (@pxref{profile-manifest, @option{--manifest}})."
7869 #: guix-git/doc/guix.texi:3137
7870 msgid "For each user, a symlink to the user's default profile is automatically created in @file{$HOME/.guix-profile}. This symlink always points to the current generation of the user's default profile. Thus, users can add @file{$HOME/.guix-profile/bin} to their @env{PATH} environment variable, and so on."
7874 #: guix-git/doc/guix.texi:3137 guix-git/doc/guix.texi:3370
7876 msgid "search paths"
7880 #: guix-git/doc/guix.texi:3142
7881 msgid "If you are not using Guix System, consider adding the following lines to your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}) so that newly-spawned shells get all the right environment variable definitions:"
7885 #: guix-git/doc/guix.texi:3146
7888 "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n"
7889 "source \"$GUIX_PROFILE/etc/profile\"\n"
7893 #: guix-git/doc/guix.texi:3157
7894 msgid "In a multi-user setup, user profiles are stored in a place registered as a @dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points to (@pxref{Invoking guix gc}). That directory is normally @code{@var{localstatedir}/guix/profiles/per-user/@var{user}}, where @var{localstatedir} is the value passed to @code{configure} as @option{--localstatedir}, and @var{user} is the user name. The @file{per-user} directory is created when @command{guix-daemon} is started, and the @var{user} sub-directory is created by @command{guix package}."
7898 #: guix-git/doc/guix.texi:3159
7899 msgid "The @var{options} can be among the following:"
7903 #: guix-git/doc/guix.texi:3162
7905 msgid "--install=@var{package} @dots{}"
7909 #: guix-git/doc/guix.texi:3163
7911 msgid "-i @var{package} @dots{}"
7915 #: guix-git/doc/guix.texi:3165
7916 msgid "Install the specified @var{package}s."
7920 #: guix-git/doc/guix.texi:3170
7921 msgid "Each @var{package} may specify either a simple package name, such as @code{guile}, or a package name followed by an at-sign and version number, such as @code{guile@@1.8.8} or simply @code{guile@@1.8} (in the latter case, the newest version prefixed by @code{1.8} is selected)."
7925 #: guix-git/doc/guix.texi:3178
7926 msgid "If no version number is specified, the newest available version will be selected. In addition, @var{package} may contain a colon, followed by the name of one of the outputs of the package, as in @code{gcc:doc} or @code{binutils@@2.22:lib} (@pxref{Packages with Multiple Outputs}). Packages with a corresponding name (and optionally version) are searched for among the GNU distribution modules (@pxref{Package Modules})."
7930 #: guix-git/doc/guix.texi:3179
7932 msgid "propagated inputs"
7936 #: guix-git/doc/guix.texi:3185
7937 msgid "Sometimes packages have @dfn{propagated inputs}: these are dependencies that automatically get installed along with the required package (@pxref{package-propagated-inputs, @code{propagated-inputs} in @code{package} objects}, for information about propagated inputs in package definitions)."
7941 #: guix-git/doc/guix.texi:3192
7942 msgid "package-cmd-propagated-inputs"
7946 #: guix-git/doc/guix.texi:3192
7947 msgid "An example is the GNU MPC library: its C header files refer to those of the GNU MPFR library, which in turn refer to those of the GMP library. Thus, when installing MPC, the MPFR and GMP libraries also get installed in the profile; removing MPC also removes MPFR and GMP---unless they had also been explicitly installed by the user."
7951 #: guix-git/doc/guix.texi:3197
7952 msgid "Besides, packages sometimes rely on the definition of environment variables for their search paths (see explanation of @option{--search-paths} below). Any missing or possibly incorrect environment variable definitions are reported here."
7956 #: guix-git/doc/guix.texi:3198
7958 msgid "--install-from-expression=@var{exp}"
7962 #: guix-git/doc/guix.texi:3199
7964 msgid "-e @var{exp}"
7968 #: guix-git/doc/guix.texi:3201
7969 msgid "Install the package @var{exp} evaluates to."
7973 #: guix-git/doc/guix.texi:3206
7974 msgid "@var{exp} must be a Scheme expression that evaluates to a @code{<package>} object. This option is notably useful to disambiguate between same-named variants of a package, with expressions such as @code{(@@ (gnu packages base) guile-final)}."
7978 #: guix-git/doc/guix.texi:3210
7979 msgid "Note that this option installs the first output of the specified package, which may be insufficient when needing a specific output of a multiple-output package."
7983 #: guix-git/doc/guix.texi:3211
7985 msgid "--install-from-file=@var{file}"
7989 #: guix-git/doc/guix.texi:3212 guix-git/doc/guix.texi:10707
7991 msgid "-f @var{file}"
7995 #: guix-git/doc/guix.texi:3214
7996 msgid "Install the package that the code within @var{file} evaluates to."
8000 #: guix-git/doc/guix.texi:3217 guix-git/doc/guix.texi:5744
8001 msgid "As an example, @var{file} might contain a definition like this (@pxref{Defining Packages}):"
8005 #: guix-git/doc/guix.texi:3219 guix-git/doc/guix.texi:10715
8007 msgid "package-hello.scm"
8011 #: guix-git/doc/guix.texi:3226
8012 msgid "Developers may find it useful to include such a @file{guix.scm} file in the root of their project source tree that can be used to test development snapshots and create reproducible development environments (@pxref{Invoking guix environment})."
8016 #: guix-git/doc/guix.texi:3231
8017 msgid "The @var{file} may also contain a JSON representation of one or more package definitions. Running @code{guix package -f} on @file{hello.json} with the following contents would result in installing the package @code{greeter} after building @code{myhello}:"
8021 #: guix-git/doc/guix.texi:3234 guix-git/doc/guix.texi:10725
8023 msgid "@verbatiminclude package-hello.json\n"
8027 #: guix-git/doc/guix.texi:3236
8029 msgid "--remove=@var{package} @dots{}"
8033 #: guix-git/doc/guix.texi:3237
8035 msgid "-r @var{package} @dots{}"
8039 #: guix-git/doc/guix.texi:3239
8040 msgid "Remove the specified @var{package}s."
8044 #: guix-git/doc/guix.texi:3244
8045 msgid "As for @option{--install}, each @var{package} may specify a version number and/or output name in addition to the package name. For instance, @samp{-r glibc:debug} would remove the @code{debug} output of @code{glibc}."
8049 #: guix-git/doc/guix.texi:3245
8051 msgid "--upgrade[=@var{regexp} @dots{}]"
8055 #: guix-git/doc/guix.texi:3246
8057 msgid "-u [@var{regexp} @dots{}]"
8061 #: guix-git/doc/guix.texi:3247
8063 msgid "upgrading packages"
8067 #: guix-git/doc/guix.texi:3251
8068 msgid "Upgrade all the installed packages. If one or more @var{regexp}s are specified, upgrade only installed packages whose name matches a @var{regexp}. Also see the @option{--do-not-upgrade} option below."
8072 #: guix-git/doc/guix.texi:3256
8073 msgid "Note that this upgrades package to the latest version of packages found in the distribution currently installed. To update your distribution, you should regularly run @command{guix pull} (@pxref{Invoking guix pull})."
8077 #: guix-git/doc/guix.texi:3257
8079 msgid "package transformations, upgrades"
8083 #: guix-git/doc/guix.texi:3262
8084 msgid "When upgrading, package transformations that were originally applied when creating the profile are automatically re-applied (@pxref{Package Transformation Options}). For example, assume you first installed Emacs from the tip of its development branch with:"
8088 #: guix-git/doc/guix.texi:3265
8090 msgid "guix install emacs-next --with-branch=emacs-next=master\n"
8094 #: guix-git/doc/guix.texi:3270
8095 msgid "Next time you run @command{guix upgrade}, Guix will again pull the tip of the Emacs development branch and build @code{emacs-next} from that checkout."
8099 #: guix-git/doc/guix.texi:3275
8100 msgid "Note that transformation options such as @option{--with-branch} and @option{--with-source} depend on external state; it is up to you to ensure that they work as expected. You can also discard a transformations that apply to a package by running:"
8104 #: guix-git/doc/guix.texi:3278
8106 msgid "guix install @var{package}\n"
8110 #: guix-git/doc/guix.texi:3280
8112 msgid "--do-not-upgrade[=@var{regexp} @dots{}]"
8116 #: guix-git/doc/guix.texi:3285
8117 msgid "When used together with the @option{--upgrade} option, do @emph{not} upgrade any packages whose name matches a @var{regexp}. For example, to upgrade all packages in the current profile except those containing the substring ``emacs'':"
8121 #: guix-git/doc/guix.texi:3288
8123 msgid "$ guix package --upgrade . --do-not-upgrade emacs\n"
8127 #: guix-git/doc/guix.texi:3290
8129 msgid "profile-manifest"
8133 #: guix-git/doc/guix.texi:3290 guix-git/doc/guix.texi:5749
8134 #: guix-git/doc/guix.texi:6168 guix-git/doc/guix.texi:11778
8135 #: guix-git/doc/guix.texi:13215
8137 msgid "--manifest=@var{file}"
8141 #: guix-git/doc/guix.texi:3291 guix-git/doc/guix.texi:5750
8142 #: guix-git/doc/guix.texi:6169 guix-git/doc/guix.texi:11779
8144 msgid "-m @var{file}"
8148 #: guix-git/doc/guix.texi:3292
8150 msgid "profile declaration"
8154 #: guix-git/doc/guix.texi:3293
8156 msgid "profile manifest"
8160 #: guix-git/doc/guix.texi:3297
8161 msgid "Create a new generation of the profile from the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
8165 #: guix-git/doc/guix.texi:3303
8166 msgid "This allows you to @emph{declare} the profile's contents rather than constructing it through a sequence of @option{--install} and similar commands. The advantage is that @var{file} can be put under version control, copied to different machines to reproduce the same profile, and so on."
8170 #: guix-git/doc/guix.texi:3307
8171 msgid "@var{file} must return a @dfn{manifest} object, which is roughly a list of packages:"
8175 #: guix-git/doc/guix.texi:3308
8177 msgid "packages->manifest"
8181 #: guix-git/doc/guix.texi:3311
8184 "(use-package-modules guile emacs)\n"
8189 #: guix-git/doc/guix.texi:3317
8192 "(packages->manifest\n"
8195 " ;; Use a specific package output.\n"
8196 " (list guile-2.0 \"debug\")))\n"
8200 #: guix-git/doc/guix.texi:3319
8202 msgid "specifications->manifest"
8206 #: guix-git/doc/guix.texi:3326
8207 msgid "In this example we have to know which modules define the @code{emacs} and @code{guile-2.0} variables to provide the right @code{use-package-modules} line, which can be cumbersome. We can instead provide regular package specifications and let @code{specifications->manifest} look up the corresponding package objects, like this:"
8211 #: guix-git/doc/guix.texi:3330
8214 "(specifications->manifest\n"
8215 " '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n"
8219 #: guix-git/doc/guix.texi:3334
8220 msgid "@xref{export-manifest, @option{--export-manifest}}, to learn how to obtain a manifest file from an existing profile."
8224 #: guix-git/doc/guix.texi:3335 guix-git/doc/guix.texi:4437
8230 #: guix-git/doc/guix.texi:3336 guix-git/doc/guix.texi:4438
8231 #: guix-git/doc/guix.texi:32922
8233 msgid "rolling back"
8237 #: guix-git/doc/guix.texi:3337 guix-git/doc/guix.texi:4439
8239 msgid "undoing transactions"
8243 #: guix-git/doc/guix.texi:3338 guix-git/doc/guix.texi:4440
8245 msgid "transactions, undoing"
8249 #: guix-git/doc/guix.texi:3341
8250 msgid "Roll back to the previous @dfn{generation} of the profile---i.e., undo the last transaction."
8254 #: guix-git/doc/guix.texi:3344
8255 msgid "When combined with options such as @option{--install}, roll back occurs before any other actions."
8259 #: guix-git/doc/guix.texi:3348
8260 msgid "When rolling back from the first generation that actually contains installed packages, the profile is made to point to the @dfn{zeroth generation}, which contains no files apart from its own metadata."
8264 #: guix-git/doc/guix.texi:3352
8265 msgid "After having rolled back, installing, removing, or upgrading packages overwrites previous future generations. Thus, the history of the generations in a profile is always linear."
8269 #: guix-git/doc/guix.texi:3353 guix-git/doc/guix.texi:4444
8271 msgid "--switch-generation=@var{pattern}"
8275 #: guix-git/doc/guix.texi:3354 guix-git/doc/guix.texi:4445
8277 msgid "-S @var{pattern}"
8281 #: guix-git/doc/guix.texi:3355 guix-git/doc/guix.texi:3585
8282 #: guix-git/doc/guix.texi:4446 guix-git/doc/guix.texi:32880
8288 #: guix-git/doc/guix.texi:3357 guix-git/doc/guix.texi:4448
8289 msgid "Switch to a particular generation defined by @var{pattern}."
8293 #: guix-git/doc/guix.texi:3363 guix-git/doc/guix.texi:4454
8294 msgid "@var{pattern} may be either a generation number or a number prefixed with ``+'' or ``-''. The latter means: move forward/backward by a specified number of generations. For example, if you want to return to the latest generation after @option{--roll-back}, use @option{--switch-generation=+1}."
8298 #: guix-git/doc/guix.texi:3368
8299 msgid "The difference between @option{--roll-back} and @option{--switch-generation=-1} is that @option{--switch-generation} will not make a zeroth generation, so if a specified generation does not exist, the current generation will not be changed."
8303 #: guix-git/doc/guix.texi:3369
8305 msgid "--search-paths[=@var{kind}]"
8309 #: guix-git/doc/guix.texi:3375
8310 msgid "Report environment variable definitions, in Bash syntax, that may be needed in order to use the set of installed packages. These environment variables are used to specify @dfn{search paths} for files used by some of the installed packages."
8314 #: guix-git/doc/guix.texi:3383
8315 msgid "For example, GCC needs the @env{CPATH} and @env{LIBRARY_PATH} environment variables to be defined so it can look for headers and libraries in the user's profile (@pxref{Environment Variables,,, gcc, Using the GNU Compiler Collection (GCC)}). If GCC and, say, the C library are installed in the profile, then @option{--search-paths} will suggest setting these variables to @file{@var{profile}/include} and @file{@var{profile}/lib}, respectively."
8319 #: guix-git/doc/guix.texi:3386
8320 msgid "The typical use case is to define these environment variables in the shell:"
8324 #: guix-git/doc/guix.texi:3389
8326 msgid "$ eval `guix package --search-paths`\n"
8330 #: guix-git/doc/guix.texi:3395
8331 msgid "@var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, meaning that the returned environment variable definitions will either be exact settings, or prefixes or suffixes of the current value of these variables. When omitted, @var{kind} defaults to @code{exact}."
8335 #: guix-git/doc/guix.texi:3398
8336 msgid "This option can also be used to compute the @emph{combined} search paths of several profiles. Consider this example:"
8340 #: guix-git/doc/guix.texi:3403
8343 "$ guix package -p foo -i guile\n"
8344 "$ guix package -p bar -i guile-json\n"
8345 "$ guix package -p foo -p bar --search-paths\n"
8349 #: guix-git/doc/guix.texi:3408
8350 msgid "The last command above reports about the @env{GUILE_LOAD_PATH} variable, even though, taken individually, neither @file{foo} nor @file{bar} would lead to that recommendation."
8354 #: guix-git/doc/guix.texi:3410
8356 msgid "profile, choosing"
8360 #: guix-git/doc/guix.texi:3411 guix-git/doc/guix.texi:4474
8361 #: guix-git/doc/guix.texi:4803
8363 msgid "--profile=@var{profile}"
8367 #: guix-git/doc/guix.texi:3412 guix-git/doc/guix.texi:4475
8368 #: guix-git/doc/guix.texi:4804
8370 msgid "-p @var{profile}"
8374 #: guix-git/doc/guix.texi:3414
8375 msgid "Use @var{profile} instead of the user's default profile."
8379 #: guix-git/doc/guix.texi:3419
8380 msgid "@var{profile} must be the name of a file that will be created upon completion. Concretely, @var{profile} will be a mere symbolic link (``symlink'') pointing to the actual profile where packages are installed:"
8384 #: guix-git/doc/guix.texi:3425
8387 "$ guix install hello -p ~/code/my-profile\n"
8389 "$ ~/code/my-profile/bin/hello\n"
8394 #: guix-git/doc/guix.texi:3429
8395 msgid "All it takes to get rid of the profile is to remove this symlink and its siblings that point to specific generations:"
8399 #: guix-git/doc/guix.texi:3432
8401 msgid "$ rm ~/code/my-profile ~/code/my-profile-*-link\n"
8405 #: guix-git/doc/guix.texi:3434
8407 msgid "--list-profiles"
8411 #: guix-git/doc/guix.texi:3436
8412 msgid "List all the user's profiles:"
8416 #: guix-git/doc/guix.texi:3443
8419 "$ guix package --list-profiles\n"
8420 "/home/charlie/.guix-profile\n"
8421 "/home/charlie/code/my-profile\n"
8422 "/home/charlie/code/devel-profile\n"
8423 "/home/charlie/tmp/test\n"
8427 #: guix-git/doc/guix.texi:3446
8428 msgid "When running as root, list all the profiles of all the users."
8432 #: guix-git/doc/guix.texi:3447
8434 msgid "collisions, in a profile"
8438 #: guix-git/doc/guix.texi:3448
8440 msgid "colliding packages in profiles"
8444 #: guix-git/doc/guix.texi:3449
8446 msgid "profile collisions"
8450 #: guix-git/doc/guix.texi:3450
8452 msgid "--allow-collisions"
8456 #: guix-git/doc/guix.texi:3452
8457 msgid "Allow colliding packages in the new profile. Use at your own risk!"
8461 #: guix-git/doc/guix.texi:3456
8462 msgid "By default, @command{guix package} reports as an error @dfn{collisions} in the profile. Collisions happen when two or more different versions or variants of a given package end up in the profile."
8466 #: guix-git/doc/guix.texi:3457 guix-git/doc/guix.texi:4517
8467 #: guix-git/doc/guix.texi:6254
8473 #: guix-git/doc/guix.texi:3460
8474 msgid "Use the bootstrap Guile to build the profile. This option is only useful to distribution developers."
8478 #: guix-git/doc/guix.texi:3466
8479 msgid "In addition to these actions, @command{guix package} supports the following options to query the current state of a profile, or the availability of packages:"
8483 #: guix-git/doc/guix.texi:3469
8485 msgid "--search=@var{regexp}"
8489 #: guix-git/doc/guix.texi:3470
8491 msgid "-s @var{regexp}"
8495 #: guix-git/doc/guix.texi:3472
8500 #: guix-git/doc/guix.texi:3472
8502 msgid "searching for packages"
8506 #: guix-git/doc/guix.texi:3478
8507 msgid "List the available packages whose name, synopsis, or description matches @var{regexp} (in a case-insensitive fashion), sorted by relevance. Print all the metadata of matching packages in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
8511 #: guix-git/doc/guix.texi:3481
8512 msgid "This allows specific fields to be extracted using the @command{recsel} command, for instance:"
8516 #: guix-git/doc/guix.texi:3487
8519 "$ guix package -s malloc | recsel -p name,version,relevance\n"
8527 #: guix-git/doc/guix.texi:3491
8537 #: guix-git/doc/guix.texi:3495
8546 #: guix-git/doc/guix.texi:3499
8547 msgid "Similarly, to show the name of all the packages available under the terms of the GNU@tie{}LGPL version 3:"
8551 #: guix-git/doc/guix.texi:3503
8554 "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n"
8560 #: guix-git/doc/guix.texi:3506
8568 #: guix-git/doc/guix.texi:3512
8569 msgid "It is also possible to refine search results using several @code{-s} flags to @command{guix package}, or several arguments to @command{guix search}. For example, the following command returns a list of board games (this time using the @command{guix search} alias):"
8573 #: guix-git/doc/guix.texi:3517
8576 "$ guix search '\\<board\\>' game | recsel -p name\n"
8582 #: guix-git/doc/guix.texi:3523
8583 msgid "If we were to omit @code{-s game}, we would also get software packages that deal with printed circuit boards; removing the angle brackets around @code{board} would further add packages that have to do with keyboards."
8587 #: guix-git/doc/guix.texi:3527
8588 msgid "And now for a more elaborate example. The following command searches for cryptographic libraries, filters out Haskell, Perl, Python, and Ruby libraries, and prints the name and synopsis of the matching packages:"
8592 #: guix-git/doc/guix.texi:3531
8595 "$ guix search crypto library | \\\n"
8596 " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n"
8600 #: guix-git/doc/guix.texi:3536
8601 msgid "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more information on @dfn{selection expressions} for @code{recsel -e}."
8605 #: guix-git/doc/guix.texi:3537
8607 msgid "--show=@var{package}"
8611 #: guix-git/doc/guix.texi:3541
8612 msgid "Show details about @var{package}, taken from the list of available packages, in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
8616 #: guix-git/doc/guix.texi:3546
8619 "$ guix package --show=python | recsel -p name,version\n"
8626 #: guix-git/doc/guix.texi:3549
8634 #: guix-git/doc/guix.texi:3553
8635 msgid "You may also specify the full name of a package to only get details about a specific version of it (this time using the @command{guix show} alias):"
8639 #: guix-git/doc/guix.texi:3557
8642 "$ guix show python@@3.4 | recsel -p name,version\n"
8648 #: guix-git/doc/guix.texi:3561
8650 msgid "--list-installed[=@var{regexp}]"
8654 #: guix-git/doc/guix.texi:3562
8656 msgid "-I [@var{regexp}]"
8660 #: guix-git/doc/guix.texi:3566
8661 msgid "List the currently installed packages in the specified profile, with the most recently installed packages shown last. When @var{regexp} is specified, list only installed packages whose name matches @var{regexp}."
8665 #: guix-git/doc/guix.texi:3572
8666 msgid "For each installed package, print the following items, separated by tabs: the package name, its version string, the part of the package that is installed (for instance, @code{out} for the default output, @code{include} for its headers, etc.), and the path of this package in the store."
8670 #: guix-git/doc/guix.texi:3573
8672 msgid "--list-available[=@var{regexp}]"
8676 #: guix-git/doc/guix.texi:3574
8678 msgid "-A [@var{regexp}]"
8682 #: guix-git/doc/guix.texi:3578
8683 msgid "List packages currently available in the distribution for this system (@pxref{GNU Distribution}). When @var{regexp} is specified, list only available packages whose name matches @var{regexp}."
8687 #: guix-git/doc/guix.texi:3582
8688 msgid "For each package, print the following items separated by tabs: its name, its version string, the parts of the package (@pxref{Packages with Multiple Outputs}), and the source location of its definition."
8692 #: guix-git/doc/guix.texi:3583 guix-git/doc/guix.texi:4430
8694 msgid "--list-generations[=@var{pattern}]"
8698 #: guix-git/doc/guix.texi:3584 guix-git/doc/guix.texi:4431
8700 msgid "-l [@var{pattern}]"
8704 #: guix-git/doc/guix.texi:3590
8705 msgid "Return a list of generations along with their creation dates; for each generation, show the installed packages, with the most recently installed packages shown last. Note that the zeroth generation is never shown."
8709 #: guix-git/doc/guix.texi:3595
8710 msgid "For each installed package, print the following items, separated by tabs: the name of a package, its version string, the part of the package that is installed (@pxref{Packages with Multiple Outputs}), and the location of this package in the store."
8714 #: guix-git/doc/guix.texi:3598
8715 msgid "When @var{pattern} is used, the command returns only matching generations. Valid patterns include:"
8719 #: guix-git/doc/guix.texi:3600
8721 msgid "@emph{Integers and comma-separated integers}. Both patterns denote"
8725 #: guix-git/doc/guix.texi:3603
8726 msgid "generation numbers. For instance, @option{--list-generations=1} returns the first one."
8730 #: guix-git/doc/guix.texi:3606
8731 msgid "And @option{--list-generations=1,8,2} outputs three generations in the specified order. Neither spaces nor trailing commas are allowed."
8735 #: guix-git/doc/guix.texi:3607
8737 msgid "@emph{Ranges}. @option{--list-generations=2..9} prints the"
8741 #: guix-git/doc/guix.texi:3610
8742 msgid "specified generations and everything in between. Note that the start of a range must be smaller than its end."
8746 #: guix-git/doc/guix.texi:3614
8747 msgid "It is also possible to omit the endpoint. For example, @option{--list-generations=2..}, returns all generations starting from the second one."
8751 #: guix-git/doc/guix.texi:3615
8753 msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks,"
8757 #: guix-git/doc/guix.texi:3619
8758 msgid "or months by passing an integer along with the first letter of the duration. For example, @option{--list-generations=20d} lists generations that are up to 20 days old."
8762 #: guix-git/doc/guix.texi:3621 guix-git/doc/guix.texi:4455
8764 msgid "--delete-generations[=@var{pattern}]"
8768 #: guix-git/doc/guix.texi:3622 guix-git/doc/guix.texi:4456
8770 msgid "-d [@var{pattern}]"
8774 #: guix-git/doc/guix.texi:3625 guix-git/doc/guix.texi:4459
8775 msgid "When @var{pattern} is omitted, delete all generations except the current one."
8779 #: guix-git/doc/guix.texi:3631 guix-git/doc/guix.texi:4465
8780 msgid "This command accepts the same patterns as @option{--list-generations}. When @var{pattern} is specified, delete the matching generations. When @var{pattern} specifies a duration, generations @emph{older} than the specified duration match. For instance, @option{--delete-generations=1m} deletes generations that are more than one month old."
8784 #: guix-git/doc/guix.texi:3634
8785 msgid "If the current generation matches, it is @emph{not} deleted. Also, the zeroth generation is never deleted."
8789 #: guix-git/doc/guix.texi:3637 guix-git/doc/guix.texi:4470
8790 msgid "Note that deleting generations prevents rolling back to them. Consequently, this command must be used with care."
8794 #: guix-git/doc/guix.texi:3638
8796 msgid "manifest, exporting"
8800 #: guix-git/doc/guix.texi:3640
8801 msgid "export-manifest"
8805 #: guix-git/doc/guix.texi:3640
8807 msgid "--export-manifest"
8811 #: guix-git/doc/guix.texi:3643
8812 msgid "Write to standard output a manifest suitable for @option{--manifest} corresponding to the chosen profile(s)."
8816 #: guix-git/doc/guix.texi:3647
8817 msgid "This option is meant to help you migrate from the ``imperative'' operating mode---running @command{guix install}, @command{guix upgrade}, etc.---to the declarative mode that @option{--manifest} offers."
8821 #: guix-git/doc/guix.texi:3652
8822 msgid "Be aware that the resulting manifest @emph{approximates} what your profile actually contains; for instance, depending on how your profile was created, it can refer to packages or package versions that are not exactly what you specified."
8826 #: guix-git/doc/guix.texi:3657
8827 msgid "Keep in mind that a manifest is purely symbolic: it only contains package names and possibly versions, and their meaning varies over time. If you wish to ``pin'' channels to the revisions that were used to build the profile(s), see @option{--export-channels} below."
8831 #: guix-git/doc/guix.texi:3658
8833 msgid "pinning, channel revisions of a profile"
8837 #: guix-git/doc/guix.texi:3659
8839 msgid "--export-channels"
8843 #: guix-git/doc/guix.texi:3663
8844 msgid "Write to standard output the list of channels used by the chosen profile(s), in a format suitable for @command{guix pull --channels} or @command{guix time-machine --channels} (@pxref{Channels})."
8848 #: guix-git/doc/guix.texi:3667
8849 msgid "Together with @option{--export-manifest}, this option provides information allowing you to replicate the current profile (@pxref{Replicating Guix})."
8853 #: guix-git/doc/guix.texi:3675
8854 msgid "However, note that the output of this command @emph{approximates} what was actually used to build this profile. In particular, a single profile might have been built from several different revisions of the same channel. In that case, @option{--export-manifest} chooses the last one and writes the list of other revisions in a comment. If you really need to pick packages from different channel revisions, you can use inferiors in your manifest to do so (@pxref{Inferiors})."
8858 #: guix-git/doc/guix.texi:3680
8859 msgid "Together with @option{--export-manifest}, this is a good starting point if you are willing to migrate from the ``imperative'' model to the fully declarative model consisting of a manifest file along with a channels file pinning the exact channel revision(s) you want."
8863 #: guix-git/doc/guix.texi:3687
8864 msgid "Finally, since @command{guix package} may actually start build processes, it supports all the common build options (@pxref{Common Build Options}). It also supports package transformation options, such as @option{--with-source}, and preserves them across upgrades (@pxref{Package Transformation Options})."
8868 #: guix-git/doc/guix.texi:3692
8870 msgid "pre-built binaries"
8874 #: guix-git/doc/guix.texi:3698
8875 msgid "Guix supports transparent source/binary deployment, which means that it can either build things locally, or download pre-built items from a server, or both. We call these pre-built items @dfn{substitutes}---they are substitutes for local build results. In many cases, downloading a substitute is much faster than building things locally."
8879 #: guix-git/doc/guix.texi:3703
8880 msgid "Substitutes can be anything resulting from a derivation build (@pxref{Derivations}). Of course, in the common case, they are pre-built package binaries, but source tarballs, for instance, which also result from derivation builds, can be available as substitutes."
8884 #: guix-git/doc/guix.texi:3717
8890 #: guix-git/doc/guix.texi:3727
8891 msgid "The @code{@value{SUBSTITUTE-SERVER}} server is a front-end to an official build farm that builds packages from Guix continuously for some architectures, and makes them available as substitutes. This is the default source of substitutes; it can be overridden by passing the @option{--substitute-urls} option either to @command{guix-daemon} (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) or to client tools such as @command{guix package} (@pxref{client-substitute-urls,, client @option{--substitute-urls} option})."
8895 #: guix-git/doc/guix.texi:3733
8896 msgid "Substitute URLs can be either HTTP or HTTPS. HTTPS is recommended because communications are encrypted; conversely, using HTTP makes all communications visible to an eavesdropper, who could use the information gathered to determine, for instance, whether your system has unpatched security vulnerabilities."
8900 #: guix-git/doc/guix.texi:3742
8901 msgid "Substitutes from the official build farm are enabled by default when using Guix System (@pxref{GNU Distribution}). However, they are disabled by default when using Guix on a foreign distribution, unless you have explicitly enabled them via one of the recommended installation steps (@pxref{Installation}). The following paragraphs describe how to enable or disable substitutes for the official build farm; the same procedure can also be used to enable substitutes for any other substitute server."
8905 #: guix-git/doc/guix.texi:3746
8911 #: guix-git/doc/guix.texi:3748
8913 msgid "access control list (ACL), for substitutes"
8917 #: guix-git/doc/guix.texi:3749
8919 msgid "ACL (access control list), for substitutes"
8923 #: guix-git/doc/guix.texi:3756
8924 msgid "To allow Guix to download substitutes from @code{@value{SUBSTITUTE-SERVER}} or a mirror thereof, you must add its public key to the access control list (ACL) of archive imports, using the @command{guix archive} command (@pxref{Invoking guix archive}). Doing so implies that you trust @code{@value{SUBSTITUTE-SERVER}} to not be compromised and to serve genuine substitutes."
8928 #: guix-git/doc/guix.texi:3760
8929 msgid "If you are using Guix System, you can skip this section: Guix System authorizes substitutes from @code{@value{SUBSTITUTE-SERVER}} by default."
8933 #: guix-git/doc/guix.texi:3768
8934 msgid "The public key for @code{@value{SUBSTITUTE-SERVER}} is installed along with Guix, in @code{@var{prefix}/share/guix/@value{SUBSTITUTE-SERVER}.pub}, where @var{prefix} is the installation prefix of Guix. If you installed Guix from source, make sure you checked the GPG signature of @file{guix-@value{VERSION}.tar.gz}, which contains this public key file. Then, you can run something like this:"
8938 #: guix-git/doc/guix.texi:3771
8940 msgid "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
8944 #: guix-git/doc/guix.texi:3775
8945 msgid "Once this is in place, the output of a command like @code{guix build} should change from something like:"
8949 #: guix-git/doc/guix.texi:3784
8952 "$ guix build emacs --dry-run\n"
8953 "The following derivations would be built:\n"
8954 " /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n"
8955 " /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n"
8956 " /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n"
8957 " /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n"
8962 #: guix-git/doc/guix.texi:3788
8963 msgid "to something like:"
8967 #: guix-git/doc/guix.texi:3797
8970 "$ guix build emacs --dry-run\n"
8971 "112.3 MB would be downloaded:\n"
8972 " /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n"
8973 " /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n"
8974 " /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n"
8975 " /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n"
8980 #: guix-git/doc/guix.texi:3804
8981 msgid "The text changed from ``The following derivations would be built'' to ``112.3 MB would be downloaded''. This indicates that substitutes from @code{@value{SUBSTITUTE-SERVER}} are usable and will be downloaded, when possible, for future builds."
8985 #: guix-git/doc/guix.texi:3805
8987 msgid "substitutes, how to disable"
8991 #: guix-git/doc/guix.texi:3811
8992 msgid "The substitute mechanism can be disabled globally by running @code{guix-daemon} with @option{--no-substitutes} (@pxref{Invoking guix-daemon}). It can also be disabled temporarily by passing the @option{--no-substitutes} option to @command{guix package}, @command{guix build}, and other command-line tools."
8996 #: guix-git/doc/guix.texi:3815
8998 msgid "substitute servers, adding more"
9002 #: guix-git/doc/guix.texi:3822
9003 msgid "Guix can look up and fetch substitutes from several servers. This is useful when you are using packages from additional channels for which the official server does not have substitutes but another server provides them. Another situation where this is useful is when you would prefer to download from your organization's substitute server, resorting to the official server only as a fallback or dismissing it altogether."
9007 #: guix-git/doc/guix.texi:3827
9008 msgid "You can give Guix a list of substitute server URLs and it will check them in the specified order. You also need to explicitly authorize the public keys of substitute servers to instruct Guix to accept the substitutes they sign."
9012 #: guix-git/doc/guix.texi:3834
9013 msgid "On Guix System, this is achieved by modifying the configuration of the @code{guix} service. Since the @code{guix} service is part of the default lists of services, @code{%base-services} and @code{%desktop-services}, you can use @code{modify-services} to change its configuration and add the URLs and substitute keys that you want (@pxref{Service Reference, @code{modify-services}})."
9017 #: guix-git/doc/guix.texi:3839
9018 msgid "As an example, suppose you want to fetch substitutes from @code{guix.example.org} and to authorize the signing key of that server, in addition to the default @code{@value{SUBSTITUTE-SERVER}}. The resulting operating system configuration will look something like:"
9022 #: guix-git/doc/guix.texi:3856
9025 "(operating-system\n"
9028 " ;; Assume we're starting from '%desktop-services'. Replace it\n"
9029 " ;; with the list of services you're actually using.\n"
9030 " (modify-services %desktop-services\n"
9031 " (guix-service-type config =>\n"
9032 " (guix-configuration\n"
9033 " (inherit config)\n"
9034 " (substitute-urls\n"
9035 " (append (list \"https://guix.example.org\")\n"
9036 " %default-substitute-urls))\n"
9037 " (authorized-keys\n"
9038 " (append (list (local-file \"./key.pub\"))\n"
9039 " %default-authorized-guix-keys)))))))\n"
9043 #: guix-git/doc/guix.texi:3863
9044 msgid "This assumes that the file @file{key.pub} contains the signing key of @code{guix.example.org}. With this change in place in your operating system configuration file (say @file{/etc/config.scm}), you can reconfigure and restart the @code{guix-daemon} service or reboot so the changes take effect:"
9048 #: guix-git/doc/guix.texi:3867
9051 "$ sudo guix system reconfigure /etc/config.scm\n"
9052 "$ sudo herd restart guix-daemon\n"
9056 #: guix-git/doc/guix.texi:3871
9057 msgid "If you're running Guix on a ``foreign distro'', you would instead take the following steps to get substitutes from additional servers:"
9061 #: guix-git/doc/guix.texi:3880
9062 msgid "Edit the service configuration file for @code{guix-daemon}; when using systemd, this is normally @file{/etc/systemd/system/guix-daemon.service}. Add the @option{--substitute-urls} option on the @command{guix-daemon} command line and list the URLs of interest (@pxref{daemon-substitute-urls, @code{guix-daemon --substitute-urls}}):"
9066 #: guix-git/doc/guix.texi:3883
9068 msgid "@dots{} --substitute-urls='https://guix.example.org https://@value{SUBSTITUTE-SERVER}'\n"
9072 #: guix-git/doc/guix.texi:3887
9073 msgid "Restart the daemon. For systemd, it goes like this:"
9077 #: guix-git/doc/guix.texi:3891
9080 "systemctl daemon-reload\n"
9081 "systemctl restart guix-daemon.service\n"
9085 #: guix-git/doc/guix.texi:3895
9086 msgid "Authorize the key of the new server (@pxref{Invoking guix archive}):"
9090 #: guix-git/doc/guix.texi:3898
9092 msgid "guix archive --authorize < key.pub\n"
9096 #: guix-git/doc/guix.texi:3902
9097 msgid "Again this assumes @file{key.pub} contains the public key that @code{guix.example.org} uses to sign substitutes."
9101 #: guix-git/doc/guix.texi:3909
9102 msgid "Now you're all set! Substitutes will be preferably taken from @code{https://guix.example.org}, using @code{@value{SUBSTITUTE-SERVER}} as a fallback. Of course you can list as many substitute servers as you like, with the caveat that substitute lookup can be slowed down if too many servers need to be contacted."
9106 #: guix-git/doc/guix.texi:3913
9107 msgid "Note that there are also situations where one may want to add the URL of a substitute server @emph{without} authorizing its key. @xref{Substitute Authentication}, to understand this fine point."
9111 #: guix-git/doc/guix.texi:3917
9113 msgid "digital signatures"
9117 #: guix-git/doc/guix.texi:3921
9118 msgid "Guix detects and raises an error when attempting to use a substitute that has been tampered with. Likewise, it ignores substitutes that are not signed, or that are not signed by one of the keys listed in the ACL."
9122 #: guix-git/doc/guix.texi:3927
9123 msgid "There is one exception though: if an unauthorized server provides substitutes that are @emph{bit-for-bit identical} to those provided by an authorized server, then the unauthorized server becomes eligible for downloads. For example, assume we have chosen two substitute servers with this option:"
9127 #: guix-git/doc/guix.texi:3930
9129 msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n"
9133 #: guix-git/doc/guix.texi:3941
9134 msgid "If the ACL contains only the key for @samp{b.example.org}, and if @samp{a.example.org} happens to serve the @emph{exact same} substitutes, then Guix will download substitutes from @samp{a.example.org} because it comes first in the list and can be considered a mirror of @samp{b.example.org}. In practice, independent build machines usually produce the same binaries, thanks to bit-reproducible builds (see below)."
9138 #: guix-git/doc/guix.texi:3948
9139 msgid "When using HTTPS, the server's X.509 certificate is @emph{not} validated (in other words, the server is not authenticated), contrary to what HTTPS clients such as Web browsers usually do. This is because Guix authenticates substitute information itself, as explained above, which is what we care about (whereas X.509 certificates are about authenticating bindings between domain names and public keys)."
9143 #: guix-git/doc/guix.texi:3960
9144 msgid "Substitutes are downloaded over HTTP or HTTPS@. The @env{http_proxy} and @env{https_proxy} environment variables can be set in the environment of @command{guix-daemon} and are honored for downloads of substitutes. Note that the value of those environment variables in the environment where @command{guix build}, @command{guix package}, and other client commands are run has @emph{absolutely no effect}."
9148 #: guix-git/doc/guix.texi:3969
9149 msgid "Even when a substitute for a derivation is available, sometimes the substitution attempt will fail. This can happen for a variety of reasons: the substitute server might be offline, the substitute may recently have been deleted, the connection might have been interrupted, etc."
9153 #: guix-git/doc/guix.texi:3983
9154 msgid "When substitutes are enabled and a substitute for a derivation is available, but the substitution attempt fails, Guix will attempt to build the derivation locally depending on whether or not @option{--fallback} was given (@pxref{fallback-option,, common build option @option{--fallback}}). Specifically, if @option{--fallback} was omitted, then no local build will be performed, and the derivation is considered to have failed. However, if @option{--fallback} was given, then Guix will attempt to build the derivation locally, and the success or failure of the derivation depends on the success or failure of the local build. Note that when substitutes are disabled or no substitute is available for the derivation in question, a local build will @emph{always} be performed, regardless of whether or not @option{--fallback} was given."
9158 #: guix-git/doc/guix.texi:3988
9159 msgid "To get an idea of how many substitutes are available right now, you can try running the @command{guix weather} command (@pxref{Invoking guix weather}). This command provides statistics on the substitutes provided by a server."
9163 #: guix-git/doc/guix.texi:3992
9165 msgid "trust, of pre-built binaries"
9169 #: guix-git/doc/guix.texi:4002
9170 msgid "Today, each individual's control over their own computing is at the mercy of institutions, corporations, and groups with enough power and determination to subvert the computing infrastructure and exploit its weaknesses. While using @code{@value{SUBSTITUTE-SERVER}} substitutes can be convenient, we encourage users to also build on their own, or even run their own build farm, such that @code{@value{SUBSTITUTE-SERVER}} is less of an interesting target. One way to help is by publishing the software you build using @command{guix publish} so that others have one more choice of server to download substitutes from (@pxref{Invoking guix publish})."
9174 #: guix-git/doc/guix.texi:4014
9175 msgid "Guix has the foundations to maximize build reproducibility (@pxref{Features}). In most cases, independent builds of a given package or derivation should yield bit-identical results. Thus, through a diverse set of independent package builds, we can strengthen the integrity of our systems. The @command{guix challenge} command aims to help users assess substitute servers, and to assist developers in finding out about non-deterministic package builds (@pxref{Invoking guix challenge}). Similarly, the @option{--check} option of @command{guix build} allows users to check whether previously-installed substitutes are genuine by rebuilding them locally (@pxref{build-check, @command{guix build --check}})."
9179 #: guix-git/doc/guix.texi:4018
9180 msgid "In the future, we want Guix to have support to publish and retrieve binaries to/from other users, in a peer-to-peer fashion. If you would like to discuss this project, join us on @email{guix-devel@@gnu.org}."
9184 #: guix-git/doc/guix.texi:4022
9186 msgid "multiple-output packages"
9190 #: guix-git/doc/guix.texi:4023
9192 msgid "package outputs"
9196 #: guix-git/doc/guix.texi:4024
9202 #: guix-git/doc/guix.texi:4034
9203 msgid "Often, packages defined in Guix have a single @dfn{output}---i.e., the source package leads to exactly one directory in the store. When running @command{guix install glibc}, one installs the default output of the GNU libc package; the default output is called @code{out}, but its name can be omitted as shown in this command. In this particular case, the default output of @code{glibc} contains all the C header files, shared libraries, static libraries, Info documentation, and other supporting files."
9207 #: guix-git/doc/guix.texi:4042
9208 msgid "Sometimes it is more appropriate to separate the various types of files produced from a single source package into separate outputs. For instance, the GLib C library (used by GTK+ and related packages) installs more than 20 MiB of reference documentation as HTML pages. To save space for users who do not need it, the documentation goes to a separate output, called @code{doc}. To install the main GLib output, which contains everything but the documentation, one would run:"
9212 #: guix-git/doc/guix.texi:4045
9214 msgid "guix install glib\n"
9218 #: guix-git/doc/guix.texi:4047 guix-git/doc/guix.texi:34245
9219 #: guix-git/doc/guix.texi:34302
9221 msgid "documentation"
9225 #: guix-git/doc/guix.texi:4049
9226 msgid "The command to install its documentation is:"
9230 #: guix-git/doc/guix.texi:4052
9232 msgid "guix install glib:doc\n"
9236 #: guix-git/doc/guix.texi:4063
9237 msgid "Some packages install programs with different ``dependency footprints''. For instance, the WordNet package installs both command-line tools and graphical user interfaces (GUIs). The former depend solely on the C library, whereas the latter depend on Tcl/Tk and the underlying X libraries. In this case, we leave the command-line tools in the default output, whereas the GUIs are in a separate output. This allows users who do not need the GUIs to save space. The @command{guix size} command can help find out about such situations (@pxref{Invoking guix size}). @command{guix graph} can also be helpful (@pxref{Invoking guix graph})."
9241 #: guix-git/doc/guix.texi:4071
9242 msgid "There are several such multiple-output packages in the GNU distribution. Other conventional output names include @code{lib} for libraries and possibly header files, @code{bin} for stand-alone programs, and @code{debug} for debugging information (@pxref{Installing Debugging Files}). The outputs of a packages are listed in the third column of the output of @command{guix package --list-available} (@pxref{Invoking guix package})."
9246 #: guix-git/doc/guix.texi:4074
9248 msgid "Invoking @command{guix gc}"
9252 #: guix-git/doc/guix.texi:4076
9254 msgid "garbage collector"
9258 #: guix-git/doc/guix.texi:4077
9264 #: guix-git/doc/guix.texi:4083
9265 msgid "Packages that are installed, but not used, may be @dfn{garbage-collected}. The @command{guix gc} command allows users to explicitly run the garbage collector to reclaim space from the @file{/gnu/store} directory. It is the @emph{only} way to remove files from @file{/gnu/store}---removing files or directories manually may break it beyond repair!"
9269 #: guix-git/doc/guix.texi:4094
9270 msgid "The garbage collector has a set of known @dfn{roots}: any file under @file{/gnu/store} reachable from a root is considered @dfn{live} and cannot be deleted; any other file is considered @dfn{dead} and may be deleted. The set of garbage collector roots (``GC roots'' for short) includes default user profiles; by default, the symlinks under @file{/var/guix/gcroots} represent these GC roots. New GC roots can be added with @command{guix build --root}, for example (@pxref{Invoking guix build}). The @command{guix gc --list-roots} command lists them."
9274 #: guix-git/doc/guix.texi:4100
9275 msgid "Prior to running @code{guix gc --collect-garbage} to make space, it is often useful to remove old generations from user profiles; that way, old package builds referenced by those generations can be reclaimed. This is achieved by running @code{guix package --delete-generations} (@pxref{Invoking guix package})."
9279 #: guix-git/doc/guix.texi:4104
9280 msgid "Our recommendation is to run a garbage collection periodically, or when you are short on disk space. For instance, to guarantee that at least 5@tie{}GB are available on your disk, simply run:"
9284 #: guix-git/doc/guix.texi:4107
9286 msgid "guix gc -F 5G\n"
9290 #: guix-git/doc/guix.texi:4116
9291 msgid "It is perfectly safe to run as a non-interactive periodic job (@pxref{Scheduled Job Execution}, for how to set up such a job). Running @command{guix gc} with no arguments will collect as much garbage as it can, but that is often inconvenient: you may find yourself having to rebuild or re-download software that is ``dead'' from the GC viewpoint but that is necessary to build other pieces of software---e.g., the compiler tool chain."
9295 #: guix-git/doc/guix.texi:4122
9296 msgid "The @command{guix gc} command has three modes of operation: it can be used to garbage-collect any dead files (the default), to delete specific files (the @option{--delete} option), to print garbage-collector information, or for more advanced queries. The garbage collection options are as follows:"
9300 #: guix-git/doc/guix.texi:4124
9302 msgid "--collect-garbage[=@var{min}]"
9306 #: guix-git/doc/guix.texi:4125
9308 msgid "-C [@var{min}]"
9312 #: guix-git/doc/guix.texi:4129
9313 msgid "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-directories. This is the default operation when no option is specified."
9317 #: guix-git/doc/guix.texi:4134
9318 msgid "When @var{min} is given, stop once @var{min} bytes have been collected. @var{min} may be a number of bytes, or it may include a unit as a suffix, such as @code{MiB} for mebibytes and @code{GB} for gigabytes (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})."
9322 #: guix-git/doc/guix.texi:4136
9323 msgid "When @var{min} is omitted, collect all the garbage."
9327 #: guix-git/doc/guix.texi:4137
9329 msgid "--free-space=@var{free}"
9333 #: guix-git/doc/guix.texi:4138
9335 msgid "-F @var{free}"
9339 #: guix-git/doc/guix.texi:4142
9340 msgid "Collect garbage until @var{free} space is available under @file{/gnu/store}, if possible; @var{free} denotes storage space, such as @code{500MiB}, as described above."
9344 #: guix-git/doc/guix.texi:4145
9345 msgid "When @var{free} or more is already available in @file{/gnu/store}, do nothing and exit immediately."
9349 #: guix-git/doc/guix.texi:4146
9351 msgid "--delete-generations[=@var{duration}]"
9355 #: guix-git/doc/guix.texi:4147
9357 msgid "-d [@var{duration}]"
9361 #: guix-git/doc/guix.texi:4151
9362 msgid "Before starting the garbage collection process, delete all the generations older than @var{duration}, for all the user profiles; when run as root, this applies to all the profiles @emph{of all the users}."
9366 #: guix-git/doc/guix.texi:4155
9367 msgid "For example, this command deletes all the generations of all your profiles that are older than 2 months (except generations that are current), and then proceeds to free space until at least 10 GiB are available:"
9371 #: guix-git/doc/guix.texi:4158
9373 msgid "guix gc -d 2m -F 10G\n"
9377 #: guix-git/doc/guix.texi:4160
9383 #: guix-git/doc/guix.texi:4161
9389 #: guix-git/doc/guix.texi:4165
9390 msgid "Attempt to delete all the store files and directories specified as arguments. This fails if some of the files are not in the store, or if they are still live."
9394 #: guix-git/doc/guix.texi:4166
9396 msgid "--list-failures"
9400 #: guix-git/doc/guix.texi:4168
9401 msgid "List store items corresponding to cached build failures."
9405 #: guix-git/doc/guix.texi:4172
9406 msgid "This prints nothing unless the daemon was started with @option{--cache-failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})."
9410 #: guix-git/doc/guix.texi:4173
9412 msgid "--list-roots"
9416 #: guix-git/doc/guix.texi:4176
9417 msgid "List the GC roots owned by the user; when run as root, list @emph{all} the GC roots."
9421 #: guix-git/doc/guix.texi:4177
9427 #: guix-git/doc/guix.texi:4180
9428 msgid "List store items in use by currently running processes. These store items are effectively considered GC roots: they cannot be deleted."
9432 #: guix-git/doc/guix.texi:4181
9434 msgid "--clear-failures"
9438 #: guix-git/doc/guix.texi:4183
9439 msgid "Remove the specified store items from the failed-build cache."
9443 #: guix-git/doc/guix.texi:4186
9444 msgid "Again, this option only makes sense when the daemon is started with @option{--cache-failures}. Otherwise, it does nothing."
9448 #: guix-git/doc/guix.texi:4187
9454 #: guix-git/doc/guix.texi:4190
9455 msgid "Show the list of dead files and directories still present in the store---i.e., files and directories no longer reachable from any root."
9459 #: guix-git/doc/guix.texi:4191
9465 #: guix-git/doc/guix.texi:4193
9466 msgid "Show the list of live store files and directories."
9470 #: guix-git/doc/guix.texi:4197
9471 msgid "In addition, the references among existing store files can be queried:"
9475 #: guix-git/doc/guix.texi:4200
9477 msgid "--references"
9481 #: guix-git/doc/guix.texi:4201
9487 #: guix-git/doc/guix.texi:4202 guix-git/doc/guix.texi:12309
9489 msgid "package dependencies"
9493 #: guix-git/doc/guix.texi:4205
9494 msgid "List the references (respectively, the referrers) of store files given as arguments."
9498 #: guix-git/doc/guix.texi:4206
9500 msgid "--requisites"
9504 #: guix-git/doc/guix.texi:4207 guix-git/doc/guix.texi:6054
9510 #: guix-git/doc/guix.texi:4208 guix-git/doc/guix.texi:12165
9511 #: guix-git/doc/guix.texi:12193 guix-git/doc/guix.texi:12274
9517 #: guix-git/doc/guix.texi:4213
9518 msgid "List the requisites of the store files passed as arguments. Requisites include the store files themselves, their references, and the references of these, recursively. In other words, the returned list is the @dfn{transitive closure} of the store files."
9522 #: guix-git/doc/guix.texi:4217
9523 msgid "@xref{Invoking guix size}, for a tool to profile the size of the closure of an element. @xref{Invoking guix graph}, for a tool to visualize the graph of references."
9527 #: guix-git/doc/guix.texi:4218
9533 #: guix-git/doc/guix.texi:4219 guix-git/doc/guix.texi:6368
9534 #: guix-git/doc/guix.texi:12028 guix-git/doc/guix.texi:12418
9540 #: guix-git/doc/guix.texi:4222
9541 msgid "Return the derivation(s) leading to the given store items (@pxref{Derivations})."
9545 #: guix-git/doc/guix.texi:4224
9546 msgid "For example, this command:"
9550 #: guix-git/doc/guix.texi:4227
9552 msgid "guix gc --derivers $(guix package -I ^emacs$ | cut -f4)\n"
9556 #: guix-git/doc/guix.texi:4232
9557 msgid "returns the @file{.drv} file(s) leading to the @code{emacs} package installed in your profile."
9561 #: guix-git/doc/guix.texi:4236
9562 msgid "Note that there may be zero matching @file{.drv} files, for instance because these files have been garbage-collected. There can also be more than one matching @file{.drv} due to fixed-output derivations."
9566 #: guix-git/doc/guix.texi:4240
9567 msgid "Lastly, the following options allow you to check the integrity of the store and to control disk usage."
9571 #: guix-git/doc/guix.texi:4243
9573 msgid "--verify[=@var{options}]"
9577 #: guix-git/doc/guix.texi:4244
9579 msgid "integrity, of the store"
9583 #: guix-git/doc/guix.texi:4245
9585 msgid "integrity checking"
9589 #: guix-git/doc/guix.texi:4247
9590 msgid "Verify the integrity of the store."
9594 #: guix-git/doc/guix.texi:4250
9595 msgid "By default, make sure that all the store items marked as valid in the database of the daemon actually exist in @file{/gnu/store}."
9599 #: guix-git/doc/guix.texi:4253
9600 msgid "When provided, @var{options} must be a comma-separated list containing one or more of @code{contents} and @code{repair}."
9604 #: guix-git/doc/guix.texi:4259
9605 msgid "When passing @option{--verify=contents}, the daemon computes the content hash of each store item and compares it against its hash in the database. Hash mismatches are reported as data corruptions. Because it traverses @emph{all the files in the store}, this command can take a long time, especially on systems with a slow disk drive."
9609 #: guix-git/doc/guix.texi:4260
9611 msgid "repairing the store"
9615 #: guix-git/doc/guix.texi:4261 guix-git/doc/guix.texi:10875
9617 msgid "corruption, recovering from"
9621 #: guix-git/doc/guix.texi:4269
9622 msgid "Using @option{--verify=repair} or @option{--verify=contents,repair} causes the daemon to try to repair corrupt store items by fetching substitutes for them (@pxref{Substitutes}). Because repairing is not atomic, and thus potentially dangerous, it is available only to the system administrator. A lightweight alternative, when you know exactly which items in the store are corrupt, is @command{guix build --repair} (@pxref{Invoking guix build})."
9626 #: guix-git/doc/guix.texi:4270
9632 #: guix-git/doc/guix.texi:4274
9633 msgid "Optimize the store by hard-linking identical files---this is @dfn{deduplication}."
9637 #: guix-git/doc/guix.texi:4280
9638 msgid "The daemon performs deduplication after each successful build or archive import, unless it was started with @option{--disable-deduplication} (@pxref{Invoking guix-daemon, @option{--disable-deduplication}}). Thus, this option is primarily useful when the daemon was running with @option{--disable-deduplication}."
9642 #: guix-git/doc/guix.texi:4284
9644 msgid "Invoking @command{guix pull}"
9648 #: guix-git/doc/guix.texi:4286
9650 msgid "upgrading Guix"
9654 #: guix-git/doc/guix.texi:4287
9656 msgid "updating Guix"
9659 #. type: command{#1}
9660 #: guix-git/doc/guix.texi:4288
9666 #: guix-git/doc/guix.texi:4289
9672 #: guix-git/doc/guix.texi:4290
9674 msgid "security, @command{guix pull}"
9678 #: guix-git/doc/guix.texi:4291
9680 msgid "authenticity, of code obtained with @command{guix pull}"
9684 #: guix-git/doc/guix.texi:4301
9685 msgid "Packages are installed or upgraded to the latest version available in the distribution currently available on your local machine. To update that distribution, along with the Guix tools, you must run @command{guix pull}: the command downloads the latest Guix source code and package descriptions, and deploys it. Source code is downloaded from a @uref{https://git-scm.com, Git} repository, by default the official GNU@tie{}Guix repository, though this can be customized. @command{guix pull} ensures that the code it downloads is @emph{authentic} by verifying that commits are signed by Guix developers."
9689 #: guix-git/doc/guix.texi:4304
9690 msgid "Specifically, @command{guix pull} downloads code from the @dfn{channels} (@pxref{Channels}) specified by one of the followings, in this order:"
9694 #: guix-git/doc/guix.texi:4308
9695 msgid "the @option{--channels} option;"
9699 #: guix-git/doc/guix.texi:4310
9700 msgid "the user's @file{~/.config/guix/channels.scm} file;"
9704 #: guix-git/doc/guix.texi:4312
9705 msgid "the system-wide @file{/etc/guix/channels.scm} file;"
9709 #: guix-git/doc/guix.texi:4315
9710 msgid "the built-in default channels specified in the @code{%default-channels} variable."
9714 #: guix-git/doc/guix.texi:4322
9715 msgid "On completion, @command{guix package} will use packages and package versions from this just-retrieved copy of Guix. Not only that, but all the Guix commands and Scheme modules will also be taken from that latest version. New @command{guix} sub-commands added by the update also become available."
9719 #: guix-git/doc/guix.texi:4328
9720 msgid "Any user can update their Guix copy using @command{guix pull}, and the effect is limited to the user who ran @command{guix pull}. For instance, when user @code{root} runs @command{guix pull}, this has no effect on the version of Guix that user @code{alice} sees, and vice versa."
9724 #: guix-git/doc/guix.texi:4334
9725 msgid "The result of running @command{guix pull} is a @dfn{profile} available under @file{~/.config/guix/current} containing the latest Guix. Thus, make sure to add it to the beginning of your search path so that you use the latest version, and similarly for the Info manual (@pxref{Documentation}):"
9729 #: guix-git/doc/guix.texi:4338
9732 "export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n"
9733 "export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n"
9737 #: guix-git/doc/guix.texi:4342
9738 msgid "The @option{--list-generations} or @option{-l} option lists past generations produced by @command{guix pull}, along with details about their provenance:"
9742 #: guix-git/doc/guix.texi:4350
9746 "Generation 1\tJun 10 2018 00:18:18\n"
9748 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9749 " branch: origin/master\n"
9750 " commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n"
9755 #: guix-git/doc/guix.texi:4360
9758 "Generation 2\tJun 11 2018 11:02:49\n"
9760 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9761 " branch: origin/master\n"
9762 " commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n"
9763 " 2 new packages: keepalived, libnfnetlink\n"
9764 " 6 packages upgraded: emacs-nix-mode@@2.0.4,\n"
9765 " guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac,\n"
9766 " heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4\n"
9771 #: guix-git/doc/guix.texi:4368
9774 "Generation 3\tJun 13 2018 23:31:07\t(current)\n"
9776 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9777 " branch: origin/master\n"
9778 " commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n"
9779 " 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{}\n"
9780 " 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{}\n"
9784 #: guix-git/doc/guix.texi:4372
9785 msgid "@xref{Invoking guix describe, @command{guix describe}}, for other ways to describe the current status of Guix."
9789 #: guix-git/doc/guix.texi:4377
9790 msgid "This @code{~/.config/guix/current} profile works exactly like the profiles created by @command{guix package} (@pxref{Invoking guix package}). That is, you can list generations, roll back to the previous generation---i.e., the previous Guix---and so on:"
9794 #: guix-git/doc/guix.texi:4383
9797 "$ guix pull --roll-back\n"
9798 "switched from generation 3 to 2\n"
9799 "$ guix pull --delete-generations=1\n"
9800 "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
9804 #: guix-git/doc/guix.texi:4387
9805 msgid "You can also use @command{guix package} (@pxref{Invoking guix package}) to manage the profile by naming it explicitly:"
9809 #: guix-git/doc/guix.texi:4392
9812 "$ guix package -p ~/.config/guix/current --roll-back\n"
9813 "switched from generation 3 to 2\n"
9814 "$ guix package -p ~/.config/guix/current --delete-generations=1\n"
9815 "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
9819 #: guix-git/doc/guix.texi:4396
9820 msgid "The @command{guix pull} command is usually invoked with no arguments, but it supports the following options:"
9824 #: guix-git/doc/guix.texi:4398 guix-git/doc/guix.texi:4556
9826 msgid "--url=@var{url}"
9830 #: guix-git/doc/guix.texi:4399 guix-git/doc/guix.texi:4557
9832 msgid "--commit=@var{commit}"
9836 #: guix-git/doc/guix.texi:4400 guix-git/doc/guix.texi:4558
9838 msgid "--branch=@var{branch}"
9842 #: guix-git/doc/guix.texi:4404
9843 msgid "Download code for the @code{guix} channel from the specified @var{url}, at the given @var{commit} (a valid Git commit ID represented as a hexadecimal string), or @var{branch}."
9847 #: guix-git/doc/guix.texi:4405 guix-git/doc/guix.texi:5002
9849 msgid "@file{channels.scm}, configuration file"
9853 #: guix-git/doc/guix.texi:4406 guix-git/doc/guix.texi:5003
9855 msgid "configuration file for channels"
9859 #: guix-git/doc/guix.texi:4410
9860 msgid "These options are provided for convenience, but you can also specify your configuration in the @file{~/.config/guix/channels.scm} file or using the @option{--channels} option (see below)."
9864 #: guix-git/doc/guix.texi:4411 guix-git/doc/guix.texi:4563
9866 msgid "--channels=@var{file}"
9870 #: guix-git/doc/guix.texi:4412 guix-git/doc/guix.texi:4564
9872 msgid "-C @var{file}"
9876 #: guix-git/doc/guix.texi:4418
9877 msgid "Read the list of channels from @var{file} instead of @file{~/.config/guix/channels.scm} or @file{/etc/guix/channels.scm}. @var{file} must contain Scheme code that evaluates to a list of channel objects. @xref{Channels}, for more information."
9881 #: guix-git/doc/guix.texi:4419
9883 msgid "channel news"
9887 #: guix-git/doc/guix.texi:4420
9893 #: guix-git/doc/guix.texi:4421 guix-git/doc/guix.texi:5829
9894 #: guix-git/doc/guix.texi:33214
9900 #: guix-git/doc/guix.texi:4425
9901 msgid "Display the list of packages added or upgraded since the previous generation, as well as, occasionally, news written by channel authors for their users (@pxref{Channels, Writing Channel News})."
9905 #: guix-git/doc/guix.texi:4429
9906 msgid "The package information is the same as displayed upon @command{guix pull} completion, but without ellipses; it is also similar to the output of @command{guix pull -l} for the last generation (see below)."
9910 #: guix-git/doc/guix.texi:4436
9911 msgid "List all the generations of @file{~/.config/guix/current} or, if @var{pattern} is provided, the subset of generations that match @var{pattern}. The syntax of @var{pattern} is the same as with @code{guix package --list-generations} (@pxref{Invoking guix package})."
9915 #: guix-git/doc/guix.texi:4443
9916 msgid "Roll back to the previous @dfn{generation} of @file{~/.config/guix/current}---i.e., undo the last transaction."
9920 #: guix-git/doc/guix.texi:4467
9921 msgid "If the current generation matches, it is @emph{not} deleted."
9925 #: guix-git/doc/guix.texi:4473
9926 msgid "@xref{Invoking guix describe}, for a way to display information about the current generation only."
9930 #: guix-git/doc/guix.texi:4477
9931 msgid "Use @var{profile} instead of @file{~/.config/guix/current}."
9935 #: guix-git/doc/guix.texi:4478 guix-git/doc/guix.texi:10266
9941 #: guix-git/doc/guix.texi:4479 guix-git/doc/guix.texi:10267
9942 #: guix-git/doc/guix.texi:12147
9948 #: guix-git/doc/guix.texi:4482
9949 msgid "Show which channel commit(s) would be used and what would be built or substituted but do not actually do it."
9953 #: guix-git/doc/guix.texi:4483 guix-git/doc/guix.texi:33233
9955 msgid "--allow-downgrades"
9959 #: guix-git/doc/guix.texi:4486
9960 msgid "Allow pulling older or unrelated revisions of channels than those currently in use."
9964 #: guix-git/doc/guix.texi:4487
9966 msgid "downgrade attacks, protection against"
9970 #: guix-git/doc/guix.texi:4492
9971 msgid "By default, @command{guix pull} protects against so-called ``downgrade attacks'' whereby the Git repository of a channel would be reset to an earlier or unrelated revision of itself, potentially leading you to install older, known-vulnerable versions of software packages."
9975 #: guix-git/doc/guix.texi:4496 guix-git/doc/guix.texi:33247
9976 msgid "Make sure you understand its security implications before using @option{--allow-downgrades}."
9980 #: guix-git/doc/guix.texi:4498
9982 msgid "--disable-authentication"
9986 #: guix-git/doc/guix.texi:4500
9987 msgid "Allow pulling channel code without authenticating it."
9991 #: guix-git/doc/guix.texi:4501 guix-git/doc/guix.texi:5148
9993 msgid "authentication, of channel code"
9997 #: guix-git/doc/guix.texi:4506
9998 msgid "By default, @command{guix pull} authenticates code downloaded from channels by verifying that its commits are signed by authorized developers, and raises an error if this is not the case. This option instructs it to not perform any such verification."
10002 #: guix-git/doc/guix.texi:4510
10003 msgid "Make sure you understand its security implications before using @option{--disable-authentication}."
10007 #: guix-git/doc/guix.texi:4513 guix-git/doc/guix.texi:5812
10008 #: guix-git/doc/guix.texi:6183 guix-git/doc/guix.texi:10817
10009 #: guix-git/doc/guix.texi:12292 guix-git/doc/guix.texi:12543
10010 #: guix-git/doc/guix.texi:13210 guix-git/doc/guix.texi:33162
10012 msgid "-s @var{system}"
10016 #: guix-git/doc/guix.texi:4516 guix-git/doc/guix.texi:6186
10017 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host."
10021 #: guix-git/doc/guix.texi:4520
10022 msgid "Use the bootstrap Guile to build the latest Guix. This option is only useful to Guix developers."
10025 #. type: Plain text
10026 #: guix-git/doc/guix.texi:4526
10027 msgid "The @dfn{channel} mechanism allows you to instruct @command{guix pull} which repository and branch to pull from, as well as @emph{additional} repositories containing package modules that should be deployed. @xref{Channels}, for more information."
10030 #. type: Plain text
10031 #: guix-git/doc/guix.texi:4529
10032 msgid "In addition, @command{guix pull} supports all the common build options (@pxref{Common Build Options})."
10036 #: guix-git/doc/guix.texi:4531
10038 msgid "Invoking @command{guix time-machine}"
10041 #. type: command{#1}
10042 #: guix-git/doc/guix.texi:4533
10044 msgid "guix time-machine"
10048 #: guix-git/doc/guix.texi:4534 guix-git/doc/guix.texi:5106
10050 msgid "pinning, channels"
10054 #: guix-git/doc/guix.texi:4535 guix-git/doc/guix.texi:4717
10055 #: guix-git/doc/guix.texi:5107
10057 msgid "replicating Guix"
10061 #: guix-git/doc/guix.texi:4536 guix-git/doc/guix.texi:5108
10063 msgid "reproducibility, of Guix"
10066 #. type: Plain text
10067 #: guix-git/doc/guix.texi:4544
10068 msgid "The @command{guix time-machine} command provides access to other revisions of Guix, for example to install older versions of packages, or to reproduce a computation in an identical environment. The revision of Guix to be used is defined by a commit or by a channel description file created by @command{guix describe} (@pxref{Invoking guix describe})."
10071 #. type: Plain text
10072 #: guix-git/doc/guix.texi:4546 guix-git/doc/guix.texi:5561
10073 #: guix-git/doc/guix.texi:6306 guix-git/doc/guix.texi:10063
10074 #: guix-git/doc/guix.texi:10186 guix-git/doc/guix.texi:11108
10075 #: guix-git/doc/guix.texi:11185 guix-git/doc/guix.texi:12122
10076 #: guix-git/doc/guix.texi:12601 guix-git/doc/guix.texi:12964
10077 #: guix-git/doc/guix.texi:13053 guix-git/doc/guix.texi:13092
10078 #: guix-git/doc/guix.texi:13189
10079 msgid "The general syntax is:"
10083 #: guix-git/doc/guix.texi:4549
10085 msgid "guix time-machine @var{options}@dots{} -- @var{command} @var {arg}@dots{}\n"
10088 #. type: Plain text
10089 #: guix-git/doc/guix.texi:4554
10090 msgid "where @var{command} and @var{arg}@dots{} are passed unmodified to the @command{guix} command of the specified revision. The @var{options} that define this revision are the same as for @command{guix pull} (@pxref{Invoking guix pull}):"
10094 #: guix-git/doc/guix.texi:4562
10095 msgid "Use the @code{guix} channel from the specified @var{url}, at the given @var{commit} (a valid Git commit ID represented as a hexadecimal string), or @var{branch}."
10099 #: guix-git/doc/guix.texi:4568
10100 msgid "Read the list of channels from @var{file}. @var{file} must contain Scheme code that evaluates to a list of channel objects. @xref{Channels} for more information."
10103 #. type: Plain text
10104 #: guix-git/doc/guix.texi:4572
10105 msgid "As for @command{guix pull}, the absence of any options means that the latest commit on the master branch will be used. The command"
10109 #: guix-git/doc/guix.texi:4575
10111 msgid "guix time-machine -- build hello\n"
10114 #. type: Plain text
10115 #: guix-git/doc/guix.texi:4580
10116 msgid "will thus build the package @code{hello} as defined in the master branch, which is in general a newer revision of Guix than you have installed. Time travel works in both directions!"
10119 #. type: Plain text
10120 #: guix-git/doc/guix.texi:4584
10121 msgid "Note that @command{guix time-machine} can trigger builds of channels and their dependencies, and these are controlled by the standard build options (@pxref{Common Build Options})."
10125 #: guix-git/doc/guix.texi:4592
10126 msgid "The functionality described here is a ``technology preview'' as of version @value{VERSION}. As such, the interface is subject to change."
10130 #: guix-git/doc/guix.texi:4594 guix-git/doc/guix.texi:10100
10136 #: guix-git/doc/guix.texi:4595
10138 msgid "composition of Guix revisions"
10141 #. type: Plain text
10142 #: guix-git/doc/guix.texi:4600
10143 msgid "Sometimes you might need to mix packages from the revision of Guix you're currently running with packages available in a different revision of Guix. Guix @dfn{inferiors} allow you to achieve that by composing different Guix revisions in arbitrary ways."
10147 #: guix-git/doc/guix.texi:4601 guix-git/doc/guix.texi:4666
10149 msgid "inferior packages"
10152 #. type: Plain text
10153 #: guix-git/doc/guix.texi:4607
10154 msgid "Technically, an ``inferior'' is essentially a separate Guix process connected to your main Guix process through a REPL (@pxref{Invoking guix repl}). The @code{(guix inferior)} module allows you to create inferiors and to communicate with them. It also provides a high-level interface to browse and manipulate the packages that an inferior provides---@dfn{inferior packages}."
10157 #. type: Plain text
10158 #: guix-git/doc/guix.texi:4617
10159 msgid "When combined with channels (@pxref{Channels}), inferiors provide a simple way to interact with a separate revision of Guix. For example, let's assume you want to install in your profile the current @code{guile} package, along with the @code{guile-json} as it existed in an older revision of Guix---perhaps because the newer @code{guile-json} has an incompatible API and you want to run your code against the old API@. To do that, you could write a manifest for use by @code{guix package --manifest} (@pxref{Invoking guix package}); in that manifest, you would create an inferior for that old Guix revision you care about, and you would look up the @code{guile-json} package in the inferior:"
10163 #: guix-git/doc/guix.texi:4621
10166 "(use-modules (guix inferior) (guix channels)\n"
10167 " (srfi srfi-1)) ;for 'first'\n"
10172 #: guix-git/doc/guix.texi:4630
10175 "(define channels\n"
10176 " ;; This is the old revision from which we want to\n"
10177 " ;; extract guile-json.\n"
10178 " (list (channel\n"
10180 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10182 " \"65956ad3526ba09e1f7a40722c96c6ef7c0936fe\"))))\n"
10187 #: guix-git/doc/guix.texi:4634
10190 "(define inferior\n"
10191 " ;; An inferior representing the above revision.\n"
10192 " (inferior-for-channels channels))\n"
10197 #: guix-git/doc/guix.texi:4640
10200 ";; Now create a manifest with the current \"guile\" package\n"
10201 ";; and the old \"guile-json\" package.\n"
10202 "(packages->manifest\n"
10203 " (list (first (lookup-inferior-packages inferior \"guile-json\"))\n"
10204 " (specification->package \"guile\")))\n"
10207 #. type: Plain text
10208 #: guix-git/doc/guix.texi:4645
10209 msgid "On its first run, @command{guix package --manifest} might have to build the channel you specified before it can create the inferior; subsequent runs will be much faster because the Guix revision will be cached."
10212 #. type: Plain text
10213 #: guix-git/doc/guix.texi:4648
10214 msgid "The @code{(guix inferior)} module provides the following procedures to open an inferior:"
10218 #: guix-git/doc/guix.texi:4649
10220 msgid "{Scheme Procedure} inferior-for-channels @var{channels} @"
10224 #: guix-git/doc/guix.texi:4654
10225 msgid "[#:cache-directory] [#:ttl] Return an inferior for @var{channels}, a list of channels. Use the cache at @var{cache-directory}, where entries can be reclaimed after @var{ttl} seconds. This procedure opens a new connection to the build daemon."
10229 #: guix-git/doc/guix.texi:4657
10230 msgid "As a side effect, this procedure may build or substitute binaries for @var{channels}, which can take time."
10234 #: guix-git/doc/guix.texi:4659
10236 msgid "{Scheme Procedure} open-inferior @var{directory} @"
10240 #: guix-git/doc/guix.texi:4664
10241 msgid "[#:command \"bin/guix\"] Open the inferior Guix in @var{directory}, running @code{@var{directory}/@var{command} repl} or equivalent. Return @code{#f} if the inferior could not be launched."
10244 #. type: Plain text
10245 #: guix-git/doc/guix.texi:4669
10246 msgid "The procedures listed below allow you to obtain and manipulate inferior packages."
10250 #: guix-git/doc/guix.texi:4670
10252 msgid "{Scheme Procedure} inferior-packages @var{inferior}"
10256 #: guix-git/doc/guix.texi:4672
10257 msgid "Return the list of packages known to @var{inferior}."
10261 #: guix-git/doc/guix.texi:4674
10263 msgid "{Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @"
10267 #: guix-git/doc/guix.texi:4679
10268 msgid "[@var{version}] Return the sorted list of inferior packages matching @var{name} in @var{inferior}, with highest version numbers first. If @var{version} is true, return only packages with a version number prefixed by @var{version}."
10272 #: guix-git/doc/guix.texi:4681
10274 msgid "{Scheme Procedure} inferior-package? @var{obj}"
10278 #: guix-git/doc/guix.texi:4683
10279 msgid "Return true if @var{obj} is an inferior package."
10283 #: guix-git/doc/guix.texi:4685
10285 msgid "{Scheme Procedure} inferior-package-name @var{package}"
10289 #: guix-git/doc/guix.texi:4686
10291 msgid "{Scheme Procedure} inferior-package-version @var{package}"
10295 #: guix-git/doc/guix.texi:4687
10297 msgid "{Scheme Procedure} inferior-package-synopsis @var{package}"
10301 #: guix-git/doc/guix.texi:4688
10303 msgid "{Scheme Procedure} inferior-package-description @var{package}"
10307 #: guix-git/doc/guix.texi:4689
10309 msgid "{Scheme Procedure} inferior-package-home-page @var{package}"
10313 #: guix-git/doc/guix.texi:4690
10315 msgid "{Scheme Procedure} inferior-package-location @var{package}"
10319 #: guix-git/doc/guix.texi:4691
10321 msgid "{Scheme Procedure} inferior-package-inputs @var{package}"
10325 #: guix-git/doc/guix.texi:4692
10327 msgid "{Scheme Procedure} inferior-package-native-inputs @var{package}"
10331 #: guix-git/doc/guix.texi:4693
10333 msgid "{Scheme Procedure} inferior-package-propagated-inputs @var{package}"
10337 #: guix-git/doc/guix.texi:4694
10339 msgid "{Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package}"
10343 #: guix-git/doc/guix.texi:4695
10345 msgid "{Scheme Procedure} inferior-package-native-search-paths @var{package}"
10349 #: guix-git/doc/guix.texi:4696
10351 msgid "{Scheme Procedure} inferior-package-transitive-native-search-paths @var{package}"
10355 #: guix-git/doc/guix.texi:4697
10357 msgid "{Scheme Procedure} inferior-package-search-paths @var{package}"
10361 #: guix-git/doc/guix.texi:4702
10362 msgid "These procedures are the counterpart of package record accessors (@pxref{package Reference}). Most of them work by querying the inferior @var{package} comes from, so the inferior must still be live when you call these procedures."
10365 #. type: Plain text
10366 #: guix-git/doc/guix.texi:4712
10367 msgid "Inferior packages can be used transparently like any other package or file-like object in G-expressions (@pxref{G-Expressions}). They are also transparently handled by the @code{packages->manifest} procedure, which is commonly used in manifests (@pxref{Invoking guix package, the @option{--manifest} option of @command{guix package}}). Thus you can insert an inferior package pretty much anywhere you would insert a regular package: in manifests, in the @code{packages} field of your @code{operating-system} declaration, and so on."
10371 #: guix-git/doc/guix.texi:4714
10373 msgid "Invoking @command{guix describe}"
10376 #. type: Plain text
10377 #: guix-git/doc/guix.texi:4725
10378 msgid "Often you may want to answer questions like: ``Which revision of Guix am I using?'' or ``Which channels am I using?'' This is useful information in many situations: if you want to @emph{replicate} an environment on a different machine or user account, if you want to report a bug or to determine what change in the channels you are using caused it, or if you want to record your system state for reproducibility purposes. The @command{guix describe} command answers these questions."
10381 #. type: Plain text
10382 #: guix-git/doc/guix.texi:4729
10383 msgid "When run from a @command{guix pull}ed @command{guix}, @command{guix describe} displays the channel(s) that it was built from, including their repository URL and commit IDs (@pxref{Channels}):"
10387 #: guix-git/doc/guix.texi:4737
10390 "$ guix describe\n"
10391 "Generation 10\tSep 03 2018 17:32:44\t(current)\n"
10393 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
10394 " branch: master\n"
10395 " commit: e0fa68c7718fffd33d81af415279d6ddb518f727\n"
10398 #. type: Plain text
10399 #: guix-git/doc/guix.texi:4746
10400 msgid "If you're familiar with the Git version control system, this is similar in spirit to @command{git describe}; the output is also similar to that of @command{guix pull --list-generations}, but limited to the current generation (@pxref{Invoking guix pull, the @option{--list-generations} option}). Because the Git commit ID shown above unambiguously refers to a snapshot of Guix, this information is all it takes to describe the revision of Guix you're using, and also to replicate it."
10403 #. type: Plain text
10404 #: guix-git/doc/guix.texi:4749
10405 msgid "To make it easier to replicate Guix, @command{guix describe} can also be asked to return a list of channels instead of the human-readable description above:"
10409 #: guix-git/doc/guix.texi:4762
10412 "$ guix describe -f channels\n"
10415 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10417 " \"e0fa68c7718fffd33d81af415279d6ddb518f727\")\n"
10419 " (make-channel-introduction\n"
10420 " \"9edb3f66fd807b096b48283debdcddccfea34bad\"\n"
10421 " (openpgp-fingerprint\n"
10422 " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\")))))\n"
10425 #. type: Plain text
10426 #: guix-git/doc/guix.texi:4771
10427 msgid "You can save this to a file and feed it to @command{guix pull -C} on some other machine or at a later point in time, which will instantiate @emph{this exact Guix revision} (@pxref{Invoking guix pull, the @option{-C} option}). From there on, since you're able to deploy the same revision of Guix, you can just as well @emph{replicate a complete software environment}. We humbly think that this is @emph{awesome}, and we hope you'll like it too!"
10430 #. type: Plain text
10431 #: guix-git/doc/guix.texi:4774
10432 msgid "The details of the options supported by @command{guix describe} are as follows:"
10436 #: guix-git/doc/guix.texi:4776 guix-git/doc/guix.texi:6013
10437 #: guix-git/doc/guix.texi:13322
10439 msgid "--format=@var{format}"
10443 #: guix-git/doc/guix.texi:4777 guix-git/doc/guix.texi:6014
10444 #: guix-git/doc/guix.texi:13323
10446 msgid "-f @var{format}"
10450 #: guix-git/doc/guix.texi:4779 guix-git/doc/guix.texi:13325
10451 msgid "Produce output in the specified @var{format}, one of:"
10455 #: guix-git/doc/guix.texi:4781
10461 #: guix-git/doc/guix.texi:4783
10462 msgid "produce human-readable output;"
10466 #: guix-git/doc/guix.texi:4783 guix-git/doc/guix.texi:5001
10472 #: guix-git/doc/guix.texi:4787
10473 msgid "produce a list of channel specifications that can be passed to @command{guix pull -C} or installed as @file{~/.config/guix/channels.scm} (@pxref{Invoking guix pull});"
10477 #: guix-git/doc/guix.texi:4787
10479 msgid "channels-sans-intro"
10483 #: guix-git/doc/guix.texi:4793
10484 msgid "like @code{channels}, but omit the @code{introduction} field; use it to produce a channel specification suitable for Guix version 1.1.0 or earlier---the @code{introduction} field has to do with channel authentication (@pxref{Channels, Channel Authentication}) and is not supported by these older versions;"
10488 #: guix-git/doc/guix.texi:4793 guix-git/doc/guix.texi:11371
10494 #: guix-git/doc/guix.texi:4794
10500 #: guix-git/doc/guix.texi:4796
10501 msgid "produce a list of channel specifications in JSON format;"
10505 #: guix-git/doc/guix.texi:4796 guix-git/doc/guix.texi:13327
10511 #: guix-git/doc/guix.texi:4798
10512 msgid "produce a list of channel specifications in Recutils format."
10516 #: guix-git/doc/guix.texi:4800
10518 msgid "--list-formats"
10522 #: guix-git/doc/guix.texi:4802
10523 msgid "Display available formats for @option{--format} option."
10527 #: guix-git/doc/guix.texi:4806
10528 msgid "Display information about @var{profile}."
10532 #: guix-git/doc/guix.texi:4809
10534 msgid "Invoking @command{guix archive}"
10537 #. type: command{#1}
10538 #: guix-git/doc/guix.texi:4811
10540 msgid "guix archive"
10544 #: guix-git/doc/guix.texi:4812
10549 #. type: Plain text
10550 #: guix-git/doc/guix.texi:4818
10551 msgid "The @command{guix archive} command allows users to @dfn{export} files from the store into a single archive, and to later @dfn{import} them on a machine that runs Guix. In particular, it allows store files to be transferred from one machine to the store on another machine."
10555 #: guix-git/doc/guix.texi:4822
10556 msgid "If you're looking for a way to produce archives in a format suitable for tools other than Guix, @pxref{Invoking guix pack}."
10560 #: guix-git/doc/guix.texi:4824
10562 msgid "exporting store items"
10565 #. type: Plain text
10566 #: guix-git/doc/guix.texi:4826
10567 msgid "To export store files as an archive to standard output, run:"
10571 #: guix-git/doc/guix.texi:4829
10573 msgid "guix archive --export @var{options} @var{specifications}...\n"
10576 #. type: Plain text
10577 #: guix-git/doc/guix.texi:4836
10578 msgid "@var{specifications} may be either store file names or package specifications, as for @command{guix package} (@pxref{Invoking guix package}). For instance, the following command creates an archive containing the @code{gui} output of the @code{git} package and the main output of @code{emacs}:"
10582 #: guix-git/doc/guix.texi:4839
10584 msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n"
10587 #. type: Plain text
10588 #: guix-git/doc/guix.texi:4844
10589 msgid "If the specified packages are not built yet, @command{guix archive} automatically builds them. The build process may be controlled with the common build options (@pxref{Common Build Options})."
10592 #. type: Plain text
10593 #: guix-git/doc/guix.texi:4847
10594 msgid "To transfer the @code{emacs} package to a machine connected over SSH, one would run:"
10598 #: guix-git/doc/guix.texi:4850
10600 msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n"
10603 #. type: Plain text
10604 #: guix-git/doc/guix.texi:4855
10605 msgid "Similarly, a complete user profile may be transferred from one machine to another like this:"
10609 #: guix-git/doc/guix.texi:4859
10612 "guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n"
10613 " ssh the-machine guix archive --import\n"
10616 #. type: Plain text
10617 #: guix-git/doc/guix.texi:4869
10618 msgid "However, note that, in both examples, all of @code{emacs} and the profile as well as all of their dependencies are transferred (due to @option{-r}), regardless of what is already available in the store on the target machine. The @option{--missing} option can help figure out which items are missing from the target store. The @command{guix copy} command simplifies and optimizes this whole process, so this is probably what you should use in this case (@pxref{Invoking guix copy})."
10622 #: guix-git/doc/guix.texi:4870
10624 msgid "nar, archive format"
10628 #: guix-git/doc/guix.texi:4871
10630 msgid "normalized archive (nar)"
10634 #: guix-git/doc/guix.texi:4872
10636 msgid "nar bundle, archive format"
10639 #. type: Plain text
10640 #: guix-git/doc/guix.texi:4877
10641 msgid "Each store item is written in the @dfn{normalized archive} or @dfn{nar} format (described below), and the output of @command{guix archive --export} (and input of @command{guix archive --import}) is a @dfn{nar bundle}."
10644 #. type: Plain text
10645 #: guix-git/doc/guix.texi:4887
10646 msgid "The nar format is comparable in spirit to `tar', but with differences that make it more appropriate for our purposes. First, rather than recording all Unix metadata for each file, the nar format only mentions the file type (regular, directory, or symbolic link); Unix permissions and owner/group are dismissed. Second, the order in which directory entries are stored always follows the order of file names according to the C locale collation order. This makes archive production fully deterministic."
10649 #. type: Plain text
10650 #: guix-git/doc/guix.texi:4891
10651 msgid "That nar bundle format is essentially the concatenation of zero or more nars along with metadata for each store item it contains: its file name, references, corresponding derivation, and a digital signature."
10654 #. type: Plain text
10655 #: guix-git/doc/guix.texi:4897
10656 msgid "When exporting, the daemon digitally signs the contents of the archive, and that digital signature is appended. When importing, the daemon verifies the signature and rejects the import in case of an invalid signature or if the signing key is not authorized."
10659 #. type: Plain text
10660 #: guix-git/doc/guix.texi:4899
10661 msgid "The main options are:"
10665 #: guix-git/doc/guix.texi:4901
10671 #: guix-git/doc/guix.texi:4904
10672 msgid "Export the specified store files or packages (see below). Write the resulting archive to the standard output."
10676 #: guix-git/doc/guix.texi:4907
10677 msgid "Dependencies are @emph{not} included in the output, unless @option{--recursive} is passed."
10681 #: guix-git/doc/guix.texi:4908 guix-git/doc/guix.texi:11141
10682 #: guix-git/doc/guix.texi:11243 guix-git/doc/guix.texi:11268
10683 #: guix-git/doc/guix.texi:11476 guix-git/doc/guix.texi:11517
10684 #: guix-git/doc/guix.texi:11564 guix-git/doc/guix.texi:11589
10685 #: guix-git/doc/guix.texi:11605 guix-git/doc/guix.texi:11636
10691 #: guix-git/doc/guix.texi:4909 guix-git/doc/guix.texi:11140
10692 #: guix-git/doc/guix.texi:11242 guix-git/doc/guix.texi:11267
10693 #: guix-git/doc/guix.texi:11475 guix-git/doc/guix.texi:11516
10694 #: guix-git/doc/guix.texi:11563 guix-git/doc/guix.texi:11588
10695 #: guix-git/doc/guix.texi:11604 guix-git/doc/guix.texi:11635
10696 #: guix-git/doc/guix.texi:11692
10698 msgid "--recursive"
10702 #: guix-git/doc/guix.texi:4914
10703 msgid "When combined with @option{--export}, this instructs @command{guix archive} to include dependencies of the given items in the archive. Thus, the resulting archive is self-contained: it contains the closure of the exported store items."
10707 #: guix-git/doc/guix.texi:4915
10713 #: guix-git/doc/guix.texi:4920
10714 msgid "Read an archive from the standard input, and import the files listed therein into the store. Abort if the archive has an invalid digital signature, or if it is signed by a public key not among the authorized keys (see @option{--authorize} below)."
10718 #: guix-git/doc/guix.texi:4921
10724 #: guix-git/doc/guix.texi:4925
10725 msgid "Read a list of store file names from the standard input, one per line, and write on the standard output the subset of these files missing from the store."
10729 #: guix-git/doc/guix.texi:4926
10731 msgid "--generate-key[=@var{parameters}]"
10735 #: guix-git/doc/guix.texi:4927
10737 msgid "signing, archives"
10741 #: guix-git/doc/guix.texi:4934
10742 msgid "Generate a new key pair for the daemon. This is a prerequisite before archives can be exported with @option{--export}. This operation is usually instantaneous but it can take time if the system's entropy pool needs to be refilled. On Guix System, @code{guix-service-type} takes care of generating this key pair the first boot."
10746 #: guix-git/doc/guix.texi:4944
10747 msgid "The generated key pair is typically stored under @file{/etc/guix}, in @file{signing-key.pub} (public key) and @file{signing-key.sec} (private key, which must be kept secret). When @var{parameters} is omitted, an ECDSA key using the Ed25519 curve is generated, or, for Libgcrypt versions before 1.6.0, it is a 4096-bit RSA key. Alternatively, @var{parameters} can specify @code{genkey} parameters suitable for Libgcrypt (@pxref{General public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The Libgcrypt Reference Manual})."
10751 #: guix-git/doc/guix.texi:4945
10753 msgid "--authorize"
10757 #: guix-git/doc/guix.texi:4946
10759 msgid "authorizing, archives"
10763 #: guix-git/doc/guix.texi:4950
10764 msgid "Authorize imports signed by the public key passed on standard input. The public key must be in ``s-expression advanced format''---i.e., the same format as the @file{signing-key.pub} file."
10768 #: guix-git/doc/guix.texi:4957
10769 msgid "The list of authorized keys is kept in the human-editable file @file{/etc/guix/acl}. The file contains @url{https://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format s-expressions''} and is structured as an access-control list in the @url{https://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure (SPKI)}."
10773 #: guix-git/doc/guix.texi:4958
10775 msgid "--extract=@var{directory}"
10779 #: guix-git/doc/guix.texi:4959
10781 msgid "-x @var{directory}"
10785 #: guix-git/doc/guix.texi:4963
10786 msgid "Read a single-item archive as served by substitute servers (@pxref{Substitutes}) and extract it to @var{directory}. This is a low-level operation needed in only very narrow use cases; see below."
10790 #: guix-git/doc/guix.texi:4966
10791 msgid "For example, the following command extracts the substitute for Emacs served by @code{@value{SUBSTITUTE-SERVER}} to @file{/tmp/emacs}:"
10795 #: guix-git/doc/guix.texi:4971
10799 " https://@value{SUBSTITUTE-SERVER}/nar/gzip/@dots{}-emacs-24.5 \\\n"
10800 " | gunzip | guix archive -x /tmp/emacs\n"
10804 #: guix-git/doc/guix.texi:4978
10805 msgid "Single-item archives are different from multiple-item archives produced by @command{guix archive --export}; they contain a single store item, and they do @emph{not} embed a signature. Thus this operation does @emph{no} signature verification and its output should be considered unsafe."
10809 #: guix-git/doc/guix.texi:4982
10810 msgid "The primary purpose of this operation is to facilitate inspection of archive contents coming from possibly untrusted substitute servers (@pxref{Invoking guix challenge})."
10814 #: guix-git/doc/guix.texi:4983
10820 #: guix-git/doc/guix.texi:4984 guix-git/doc/guix.texi:11463
10821 #: guix-git/doc/guix.texi:11510
10827 #: guix-git/doc/guix.texi:4988
10828 msgid "Read a single-item archive as served by substitute servers (@pxref{Substitutes}) and print the list of files it contains, as in this example:"
10832 #: guix-git/doc/guix.texi:4993
10836 " https://@value{SUBSTITUTE-SERVER}/nar/lzip/@dots{}-emacs-26.3 \\\n"
10837 " | lzip -d | guix archive -t\n"
10841 #: guix-git/doc/guix.texi:5004
10843 msgid "@command{guix pull}, configuration file"
10847 #: guix-git/doc/guix.texi:5005
10849 msgid "configuration of @command{guix pull}"
10852 #. type: Plain text
10853 #: guix-git/doc/guix.texi:5016
10854 msgid "Guix and its package collection are updated by running @command{guix pull} (@pxref{Invoking guix pull}). By default @command{guix pull} downloads and deploys Guix itself from the official GNU@tie{}Guix repository. This can be customized by defining @dfn{channels} in the @file{~/.config/guix/channels.scm} file. A channel specifies a URL and branch of a Git repository to be deployed, and @command{guix pull} can be instructed to pull from one or more channels. In other words, channels can be used to @emph{customize} and to @emph{extend} Guix, as we will see below. Guix is able to take into account security concerns and deal with authenticated updates."
10858 #: guix-git/doc/guix.texi:5034
10860 msgid "extending the package collection (channels)"
10864 #: guix-git/doc/guix.texi:5035
10866 msgid "variant packages (channels)"
10869 #. type: Plain text
10870 #: guix-git/doc/guix.texi:5039
10871 msgid "You can specify @emph{additional channels} to pull from. To use a channel, write @code{~/.config/guix/channels.scm} to instruct @command{guix pull} to pull from it @emph{in addition} to the default Guix channel(s):"
10875 #: guix-git/doc/guix.texi:5040
10877 msgid "%default-channels"
10881 #: guix-git/doc/guix.texi:5047
10884 ";; Add variant packages to those Guix provides.\n"
10886 " (name 'variant-packages)\n"
10887 " (url \"https://example.org/variant-packages.git\"))\n"
10888 " %default-channels)\n"
10891 #. type: Plain text
10892 #: guix-git/doc/guix.texi:5057
10893 msgid "Note that the snippet above is (as always!)@: Scheme code; we use @code{cons} to add a channel the list of channels that the variable @code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, guile, GNU Guile Reference Manual}). With this file in place, @command{guix pull} builds not only Guix but also the package modules from your own repository. The result in @file{~/.config/guix/current} is the union of Guix with your own package modules:"
10897 #: guix-git/doc/guix.texi:5072
10900 "$ guix pull --list-generations\n"
10902 "Generation 19\tAug 27 2018 16:20:48\n"
10904 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
10905 " branch: master\n"
10906 " commit: d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300\n"
10907 " variant-packages dd3df5e\n"
10908 " repository URL: https://example.org/variant-packages.git\n"
10909 " branch: master\n"
10910 " commit: dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\n"
10911 " 11 new packages: variant-gimp, variant-emacs-with-cool-features, @dots{}\n"
10912 " 4 packages upgraded: emacs-racket-mode@@0.0.2-2.1b78827, @dots{}\n"
10915 #. type: Plain text
10916 #: guix-git/doc/guix.texi:5080
10917 msgid "The output of @command{guix pull} above shows that Generation@tie{}19 includes both Guix and packages from the @code{variant-personal-packages} channel. Among the new and upgraded packages that are listed, some like @code{variant-gimp} and @code{variant-emacs-with-cool-features} might come from @code{variant-packages}, while others come from the Guix default channel."
10920 #. type: Plain text
10921 #: guix-git/doc/guix.texi:5089
10922 msgid "The channel called @code{guix} specifies where Guix itself---its command-line tools as well as its package collection---should be downloaded. For instance, suppose you want to update from another copy of the Guix repository at @code{example.org}, and specifically the @code{super-hacks} branch, you can write in @code{~/.config/guix/channels.scm} this specification:"
10926 #: guix-git/doc/guix.texi:5096
10929 ";; Tell 'guix pull' to use another repo.\n"
10932 " (url \"https://example.org/another-guix.git\")\n"
10933 " (branch \"super-hacks\")))\n"
10936 #. type: Plain text
10937 #: guix-git/doc/guix.texi:5102
10938 msgid "From there on, @command{guix pull} will fetch code from the @code{super-hacks} branch of the repository at @code{example.org}. The authentication concern is addressed below ((@pxref{Channel Authentication})."
10941 #. type: Plain text
10942 #: guix-git/doc/guix.texi:5113
10943 msgid "The @command{guix pull --list-generations} output above shows precisely which commits were used to build this instance of Guix. We can thus replicate it, say, on another machine, by providing a channel specification in @file{~/.config/guix/channels.scm} that is ``pinned'' to these commits:"
10947 #: guix-git/doc/guix.texi:5124
10950 ";; Deploy specific commits of my channels of interest.\n"
10953 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10954 " (commit \"6298c3ffd9654d3231a6f25390b056483e8f407c\"))\n"
10956 " (name 'variant-packages)\n"
10957 " (url \"https://example.org/variant-packages.git\")\n"
10958 " (commit \"dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\")))\n"
10961 #. type: Plain text
10962 #: guix-git/doc/guix.texi:5131
10963 msgid "The @command{guix describe --format=channels} command can even generate this list of channels directly (@pxref{Invoking guix describe}). The resulting file can be used with the -C options of @command{guix pull} (@pxref{Invoking guix pull}) or @command{guix time-machine} (@pxref{Invoking guix time-machine})."
10966 #. type: Plain text
10967 #: guix-git/doc/guix.texi:5138
10968 msgid "At this point the two machines run the @emph{exact same Guix}, with access to the @emph{exact same packages}. The output of @command{guix build gimp} on one machine will be exactly the same, bit for bit, as the output of the same command on the other machine. It also means both machines have access to all the source code of Guix and, transitively, to all the source code of every package it defines."
10971 #. type: Plain text
10972 #: guix-git/doc/guix.texi:5143
10973 msgid "This gives you super powers, allowing you to track the provenance of binary artifacts with very fine grain, and to reproduce software environments at will---some sort of ``meta reproducibility'' capabilities, if you will. @xref{Inferiors}, for another way to take advantage of these super powers."
10976 #. type: anchor{#1}
10977 #: guix-git/doc/guix.texi:5148
10978 msgid "channel-authentication"
10981 #. type: Plain text
10982 #: guix-git/doc/guix.texi:5154
10983 msgid "The @command{guix pull} and @command{guix time-machine} commands @dfn{authenticate} the code retrieved from channels: they make sure each commit that is fetched is signed by an authorized developer. The goal is to protect from unauthorized modifications to the channel that would lead users to run malicious code."
10986 #. type: Plain text
10987 #: guix-git/doc/guix.texi:5159
10988 msgid "As a user, you must provide a @dfn{channel introduction} in your channels file so that Guix knows how to authenticate its first commit. A channel specification, including its introduction, looks something along these lines:"
10992 #: guix-git/doc/guix.texi:5169
10996 " (name 'some-channel)\n"
10997 " (url \"https://example.org/some-channel.git\")\n"
10999 " (make-channel-introduction\n"
11000 " \"6f0d8cc0d88abb59c324b2990bfee2876016bb86\"\n"
11001 " (openpgp-fingerprint\n"
11002 " \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
11005 #. type: Plain text
11006 #: guix-git/doc/guix.texi:5175
11007 msgid "The specification above shows the name and URL of the channel. The call to @code{make-channel-introduction} above specifies that authentication of this channel starts at commit @code{6f0d8cc@dots{}}, which is signed by the OpenPGP key with fingerprint @code{CABB A931@dots{}}."
11010 #. type: Plain text
11011 #: guix-git/doc/guix.texi:5181
11012 msgid "For the main channel, called @code{guix}, you automatically get that information from your Guix installation. For other channels, include the channel introduction provided by the channel authors in your @file{channels.scm} file. Make sure you retrieve the channel introduction from a trusted source since that is the root of your trust."
11015 #. type: Plain text
11016 #: guix-git/doc/guix.texi:5183
11017 msgid "If you're curious about the authentication mechanics, read on!"
11020 #. type: Plain text
11021 #: guix-git/doc/guix.texi:5194
11022 msgid "When running @command{guix pull}, Guix will first compile the definitions of every available package. This is an expensive operation for which substitutes (@pxref{Substitutes}) may be available. The following snippet in @file{channels.scm} will ensure that @command{guix pull} uses the latest commit with available substitutes for the package definitions: this is done by querying the continuous integration server at @url{https://ci.guix.gnu.org}."
11026 #: guix-git/doc/guix.texi:5197
11029 "(use-modules (guix ci))\n"
11034 #: guix-git/doc/guix.texi:5201
11037 "(list (channel-with-substitutes-available\n"
11038 " %default-guix-channel\n"
11039 " \"https://ci.guix.gnu.org\"))\n"
11042 #. type: Plain text
11043 #: guix-git/doc/guix.texi:5208
11044 msgid "Note that this does not mean that all the packages that you will install after running @command{guix pull} will have available substitutes. It only ensures that @command{guix pull} will not try to compile package definitions. This is particularly useful when using machines with limited resources."
11048 #: guix-git/doc/guix.texi:5212
11050 msgid "personal packages (channels)"
11054 #: guix-git/doc/guix.texi:5213
11056 msgid "channels, for personal packages"
11059 #. type: Plain text
11060 #: guix-git/doc/guix.texi:5221
11061 msgid "Let's say you have a bunch of custom package variants or personal packages that you think would make little sense to contribute to the Guix project, but would like to have these packages transparently available to you at the command line. You would first write modules containing those package definitions (@pxref{Package Modules}), maintain them in a Git repository, and then you and anyone else can use it as an additional channel to get packages from. Neat, no?"
11065 #: guix-git/doc/guix.texi:5225 guix-git/doc/guix.texi:13677
11066 #: guix-git/doc/guix.texi:19632 guix-git/doc/guix.texi:19639
11072 #: guix-git/doc/guix.texi:5229
11073 msgid "Before you, dear user, shout---``woow this is @emph{soooo coool}!''---and publish your personal channel to the world, we would like to share a few words of caution:"
11077 #: guix-git/doc/guix.texi:5237
11078 msgid "Before publishing a channel, please consider contributing your package definitions to Guix proper (@pxref{Contributing}). Guix as a project is open to free software of all sorts, and packages in Guix proper are readily available to all Guix users and benefit from the project's quality assurance process."
11082 #: guix-git/doc/guix.texi:5246
11083 msgid "When you maintain package definitions outside Guix, we, Guix developers, consider that @emph{the compatibility burden is on you}. Remember that package modules and package definitions are just Scheme code that uses various programming interfaces (APIs). We want to remain free to change these APIs to keep improving Guix, possibly in ways that break your channel. We never change APIs gratuitously, but we will @emph{not} commit to freezing APIs either."
11087 #: guix-git/doc/guix.texi:5250
11088 msgid "Corollary: if you're using an external channel and that channel breaks, please @emph{report the issue to the channel authors}, not to the Guix project."
11092 #: guix-git/doc/guix.texi:5257
11093 msgid "You've been warned! Having said this, we believe external channels are a practical way to exert your freedom to augment Guix' package collection and to share your improvements, which are basic tenets of @uref{https://www.gnu.org/philosophy/free-sw.html, free software}. Please email us at @email{guix-devel@@gnu.org} if you'd like to discuss this."
11096 #. type: Plain text
11097 #: guix-git/doc/guix.texi:5269
11098 msgid "To create a channel, create a Git repository containing your own package modules and make it available. The repository can contain anything, but a useful channel will contain Guile modules that export packages. Once you start using a channel, Guix will behave as if the root directory of that channel's Git repository has been added to the Guile load path (@pxref{Load Paths,,, guile, GNU Guile Reference Manual}). For example, if your channel contains a file at @file{my-packages/my-tools.scm} that defines a Guile module, then the module will be available under the name @code{(my-packages my-tools)}, and you will be able to use it like any other module (@pxref{Modules,,, guile, GNU Guile Reference Manual})."
11101 #. type: Plain text
11102 #: guix-git/doc/guix.texi:5274
11103 msgid "As a channel author, consider bundling authentication material with your channel so that users can authenticate it. @xref{Channel Authentication}, and @ref{Specifying Channel Authorizations}, for info on how to do it."
11107 #: guix-git/doc/guix.texi:5279
11109 msgid "subdirectory, channels"
11112 #. type: Plain text
11113 #: guix-git/doc/guix.texi:5283
11114 msgid "As a channel author, you may want to keep your channel modules in a sub-directory. If your modules are in the sub-directory @file{guix}, you must add a meta-data file @file{.guix-channel} that contains:"
11118 #: guix-git/doc/guix.texi:5288
11123 " (directory \"guix\"))\n"
11127 #: guix-git/doc/guix.texi:5293
11129 msgid "dependencies, channels"
11133 #: guix-git/doc/guix.texi:5294
11135 msgid "meta-data, channels"
11138 #. type: Plain text
11139 #: guix-git/doc/guix.texi:5299
11140 msgid "Channel authors may decide to augment a package collection provided by other channels. They can declare their channel to be dependent on other channels in a meta-data file @file{.guix-channel}, which is to be placed in the root of the channel repository."
11143 #. type: Plain text
11144 #: guix-git/doc/guix.texi:5301
11145 msgid "The meta-data file should contain a simple S-expression like this:"
11149 #: guix-git/doc/guix.texi:5309
11156 " (name some-collection)\n"
11157 " (url \"https://example.org/first-collection.git\")\n"
11162 #: guix-git/doc/guix.texi:5321
11165 " ;; The 'introduction' bit below is optional: you would\n"
11166 " ;; provide it for dependencies that can be authenticated.\n"
11168 " (channel-introduction\n"
11170 " (commit \"a8883b58dc82e167c96506cf05095f37c2c2c6cd\")\n"
11171 " (signer \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
11173 " (name some-other-collection)\n"
11174 " (url \"https://example.org/second-collection.git\")\n"
11175 " (branch \"testing\"))))\n"
11178 #. type: Plain text
11179 #: guix-git/doc/guix.texi:5327
11180 msgid "In the above example this channel is declared to depend on two other channels, which will both be fetched automatically. The modules provided by the channel will be compiled in an environment where the modules of all these declared channels are available."
11183 #. type: Plain text
11184 #: guix-git/doc/guix.texi:5331
11185 msgid "For the sake of reliability and maintainability, you should avoid dependencies on channels that you don't control, and you should aim to keep the number of dependencies to a minimum."
11189 #: guix-git/doc/guix.texi:5335
11191 msgid "channel authorizations"
11194 #. type: anchor{#1}
11195 #: guix-git/doc/guix.texi:5349
11196 msgid "channel-authorizations"
11199 #. type: Plain text
11200 #: guix-git/doc/guix.texi:5349
11201 msgid "As we saw above, Guix ensures the source code it pulls from channels comes from authorized developers. As a channel author, you need to specify the list of authorized developers in the @file{.guix-authorizations} file in the channel's Git repository. The authentication rule is simple: each commit must be signed by a key listed in the @file{.guix-authorizations} file of its parent commit(s)@footnote{Git commits form a @dfn{directed acyclic graph} (DAG). Each commit can have zero or more parents; ``regular'' commits have one parent and merge commits have two parent commits. Read @uref{https://eagain.net/articles/git-for-computer-scientists/, @i{Git for Computer Scientists}} for a great overview.} The @file{.guix-authorizations} file looks like this:"
11205 #: guix-git/doc/guix.texi:5352
11208 ";; Example '.guix-authorizations' file.\n"
11213 #: guix-git/doc/guix.texi:5355
11216 "(authorizations\n"
11217 " (version 0) ;current file format version\n"
11222 #: guix-git/doc/guix.texi:5362
11225 " ((\"AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3\"\n"
11226 " (name \"alice\"))\n"
11227 " (\"2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5\"\n"
11228 " (name \"bob\"))\n"
11229 " (\"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"\n"
11230 " (name \"charlie\"))))\n"
11233 #. type: Plain text
11234 #: guix-git/doc/guix.texi:5366
11235 msgid "Each fingerprint is followed by optional key/value pairs, as in the example above. Currently these key/value pairs are ignored."
11238 #. type: Plain text
11239 #: guix-git/doc/guix.texi:5371
11240 msgid "This authentication rule creates a chicken-and-egg issue: how do we authenticate the first commit? Related to that: how do we deal with channels whose repository history contains unsigned commits and lack @file{.guix-authorizations}? And how do we fork existing channels?"
11244 #: guix-git/doc/guix.texi:5372
11246 msgid "channel introduction"
11249 #. type: Plain text
11250 #: guix-git/doc/guix.texi:5379
11251 msgid "Channel introductions answer these questions by describing the first commit of a channel that should be authenticated. The first time a channel is fetched with @command{guix pull} or @command{guix time-machine}, the command looks up the introductory commit and verifies that it is signed by the specified OpenPGP key. From then on, it authenticates commits according to the rule above."
11254 #. type: Plain text
11255 #: guix-git/doc/guix.texi:5386
11256 msgid "Additionally, your channel must provide all the OpenPGP keys that were ever mentioned in @file{.guix-authorizations}, stored as @file{.key} files, which can be either binary or ``ASCII-armored''. By default, those @file{.key} files are searched for in the branch named @code{keyring} but you can specify a different branch name in @code{.guix-channel} like so:"
11260 #: guix-git/doc/guix.texi:5391
11265 " (keyring-reference \"my-keyring-branch\"))\n"
11268 #. type: Plain text
11269 #: guix-git/doc/guix.texi:5395
11270 msgid "To summarize, as the author of a channel, there are three things you have to do to allow users to authenticate your code:"
11274 #: guix-git/doc/guix.texi:5401
11275 msgid "Export the OpenPGP keys of past and present committers with @command{gpg --export} and store them in @file{.key} files, by default in a branch named @code{keyring} (we recommend making it an @dfn{orphan branch})."
11279 #: guix-git/doc/guix.texi:5406
11280 msgid "Introduce an initial @file{.guix-authorizations} in the channel's repository. Do that in a signed commit (@pxref{Commit Access}, for information on how to sign Git commits.)"
11284 #: guix-git/doc/guix.texi:5412
11285 msgid "Advertise the channel introduction, for instance on your channel's web page. The channel introduction, as we saw above, is the commit/key pair---i.e., the commit that introduced @file{.guix-authorizations}, and the fingerprint of the OpenPGP used to sign it."
11288 #. type: Plain text
11289 #: guix-git/doc/guix.texi:5417
11290 msgid "Before pushing to your public Git repository, you can run @command{guix git-authenticate} to verify that you did sign all the commits you are about to push with an authorized key:"
11294 #: guix-git/doc/guix.texi:5420
11296 msgid "guix git authenticate @var{commit} @var{signer}\n"
11299 #. type: Plain text
11300 #: guix-git/doc/guix.texi:5425
11301 msgid "where @var{commit} and @var{signer} are your channel introduction. @xref{Invoking guix git authenticate}, for details."
11304 #. type: Plain text
11305 #: guix-git/doc/guix.texi:5432
11306 msgid "Publishing a signed channel requires discipline: any mistake, such as an unsigned commit or a commit signed by an unauthorized key, will prevent users from pulling from your channel---well, that's the whole point of authentication! Pay attention to merges in particular: merge commits are considered authentic if and only if they are signed by a key present in the @file{.guix-authorizations} file of @emph{both} branches."
11310 #: guix-git/doc/guix.texi:5436
11312 msgid "primary URL, channels"
11315 #. type: Plain text
11316 #: guix-git/doc/guix.texi:5439
11317 msgid "Channel authors can indicate the primary URL of their channel's Git repository in the @file{.guix-channel} file, like so:"
11321 #: guix-git/doc/guix.texi:5444
11326 " (url \"https://example.org/guix.git\"))\n"
11329 #. type: Plain text
11330 #: guix-git/doc/guix.texi:5451
11331 msgid "This allows @command{guix pull} to determine whether it is pulling code from a mirror of the channel; when that is the case, it warns the user that the mirror might be stale and displays the primary URL@. That way, users cannot be tricked into fetching code from a stale mirror that does not receive security updates."
11334 #. type: Plain text
11335 #: guix-git/doc/guix.texi:5455
11336 msgid "This feature only makes sense for authenticated repositories, such as the official @code{guix} channel, for which @command{guix pull} ensures the code it fetches is authentic."
11340 #: guix-git/doc/guix.texi:5459
11342 msgid "news, for channels"
11345 #. type: Plain text
11346 #: guix-git/doc/guix.texi:5463
11347 msgid "Channel authors may occasionally want to communicate to their users information about important changes in the channel. You'd send them all an email, but that's not convenient."
11350 #. type: Plain text
11351 #: guix-git/doc/guix.texi:5468
11352 msgid "Instead, channels can provide a @dfn{news file}; when the channel users run @command{guix pull}, that news file is automatically read and @command{guix pull --news} can display the announcements that correspond to the new commits that have been pulled, if any."
11355 #. type: Plain text
11356 #: guix-git/doc/guix.texi:5471
11357 msgid "To do that, channel authors must first declare the name of the news file in their @file{.guix-channel} file:"
11361 #: guix-git/doc/guix.texi:5476
11366 " (news-file \"etc/news.txt\"))\n"
11369 #. type: Plain text
11370 #: guix-git/doc/guix.texi:5480
11371 msgid "The news file itself, @file{etc/news.txt} in this example, must look something like this:"
11375 #: guix-git/doc/guix.texi:5493
11380 " (entry (tag \"the-bug-fix\")\n"
11381 " (title (en \"Fixed terrible bug\")\n"
11382 " (fr \"Oh la la\"))\n"
11383 " (body (en \"@@emph@{Good news@}! It's fixed!\")\n"
11384 " (eo \"Certe ĝi pli bone funkcias nun!\")))\n"
11385 " (entry (commit \"bdcabe815cd28144a2d2b4bc3c5057b051fa9906\")\n"
11386 " (title (en \"Added a great package\")\n"
11387 " (ca \"Què vol dir guix?\"))\n"
11388 " (body (en \"Don't miss the @@code@{hello@} package!\"))))\n"
11391 #. type: Plain text
11392 #: guix-git/doc/guix.texi:5500
11393 msgid "While the news file is using the Scheme syntax, avoid naming it with a @file{.scm} extension or else it will get picked up when building the channel and yield an error since it is not a valid module. Alternatively, you can move the channel module to a subdirectory and store the news file in another directory."
11396 #. type: Plain text
11397 #: guix-git/doc/guix.texi:5505
11398 msgid "The file consists of a list of @dfn{news entries}. Each entry is associated with a commit or tag: it describes changes made in this commit, possibly in preceding commits as well. Users see entries only the first time they obtain the commit the entry refers to."
11401 #. type: Plain text
11402 #: guix-git/doc/guix.texi:5511
11403 msgid "The @code{title} field should be a one-line summary while @code{body} can be arbitrarily long, and both can contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). Both the title and body are a list of language tag/message tuples, which allows @command{guix pull} to display news in the language that corresponds to the user's locale."
11406 #. type: Plain text
11407 #: guix-git/doc/guix.texi:5517
11408 msgid "If you want to translate news using a gettext-based workflow, you can extract translatable strings with @command{xgettext} (@pxref{xgettext Invocation,,, gettext, GNU Gettext Utilities}). For example, assuming you write news entries in English first, the command below creates a PO file containing the strings to translate:"
11412 #: guix-git/doc/guix.texi:5520
11414 msgid "xgettext -o news.po -l scheme -ken etc/news.txt\n"
11417 #. type: Plain text
11418 #: guix-git/doc/guix.texi:5524
11419 msgid "To sum up, yes, you could use your channel as a blog. But beware, this is @emph{not quite} what your users might expect."
11423 #: guix-git/doc/guix.texi:5529
11425 msgid "software development"
11428 #. type: Plain text
11429 #: guix-git/doc/guix.texi:5533
11430 msgid "If you are a software developer, Guix provides tools that you should find helpful---independently of the language you're developing in. This is what this chapter is about."
11433 #. type: Plain text
11434 #: guix-git/doc/guix.texi:5539
11435 msgid "The @command{guix environment} command provides a convenient way to set up @dfn{development environments} containing all the dependencies and tools necessary to work on the software package of your choice. The @command{guix pack} command allows you to create @dfn{application bundles} that can be easily distributed to users who do not run Guix."
11439 #: guix-git/doc/guix.texi:5548
11441 msgid "Invoking @command{guix environment}"
11445 #: guix-git/doc/guix.texi:5550
11447 msgid "reproducible build environments"
11451 #: guix-git/doc/guix.texi:5551
11453 msgid "development environments"
11456 #. type: command{#1}
11457 #: guix-git/doc/guix.texi:5552
11459 msgid "guix environment"
11463 #: guix-git/doc/guix.texi:5553
11465 msgid "environment, package build environment"
11468 #. type: Plain text
11469 #: guix-git/doc/guix.texi:5559
11470 msgid "The purpose of @command{guix environment} is to assist hackers in creating reproducible development environments without polluting their package profile. The @command{guix environment} tool takes one or more packages, builds all of their inputs, and creates a shell environment to use them."
11474 #: guix-git/doc/guix.texi:5564
11476 msgid "guix environment @var{options} @var{package}@dots{}\n"
11479 #. type: Plain text
11480 #: guix-git/doc/guix.texi:5568
11481 msgid "The following example spawns a new shell set up for the development of GNU@tie{}Guile:"
11485 #: guix-git/doc/guix.texi:5571
11487 msgid "guix environment guile\n"
11490 #. type: Plain text
11491 #: guix-git/doc/guix.texi:5588
11492 msgid "If the needed dependencies are not built yet, @command{guix environment} automatically builds them. The environment of the new shell is an augmented version of the environment that @command{guix environment} was run in. It contains the necessary search paths for building the given package added to the existing environment variables. To create a ``pure'' environment, in which the original environment variables have been unset, use the @option{--pure} option@footnote{Users sometimes wrongfully augment environment variables such as @env{PATH} in their @file{~/.bashrc} file. As a consequence, when @command{guix environment} launches it, Bash may read @file{~/.bashrc}, thereby introducing ``impurities'' in these environment variables. It is an error to define such environment variables in @file{.bashrc}; instead, they should be defined in @file{.bash_profile}, which is sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for details on Bash start-up files.}."
11495 #. type: Plain text
11496 #: guix-git/doc/guix.texi:5594
11497 msgid "Exiting from a Guix environment is the same as exiting from the shell, and will place the user back in the old environment before @command{guix environment} was invoked. The next garbage collection (@pxref{Invoking guix gc}) will clean up packages that were installed from within the environment and are no longer used outside of it."
11501 #: guix-git/doc/guix.texi:5595
11503 msgid "GUIX_ENVIRONMENT"
11506 #. type: Plain text
11507 #: guix-git/doc/guix.texi:5601
11508 msgid "@command{guix environment} defines the @env{GUIX_ENVIRONMENT} variable in the shell it spawns; its value is the file name of the profile of this environment. This allows users to, say, define a specific prompt for development environments in their @file{.bashrc} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}):"
11512 #: guix-git/doc/guix.texi:5607
11515 "if [ -n \"$GUIX_ENVIRONMENT\" ]\n"
11517 " export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n"
11521 #. type: Plain text
11522 #: guix-git/doc/guix.texi:5611
11523 msgid "...@: or to browse the profile:"
11527 #: guix-git/doc/guix.texi:5614
11529 msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n"
11532 #. type: Plain text
11533 #: guix-git/doc/guix.texi:5620
11534 msgid "Additionally, more than one package may be specified, in which case the union of the inputs for the given packages are used. For example, the command below spawns a shell where all of the dependencies of both Guile and Emacs are available:"
11538 #: guix-git/doc/guix.texi:5623
11540 msgid "guix environment guile emacs\n"
11543 #. type: Plain text
11544 #: guix-git/doc/guix.texi:5628
11545 msgid "Sometimes an interactive shell session is not desired. An arbitrary command may be invoked by placing the @code{--} token to separate the command from the rest of the arguments:"
11549 #: guix-git/doc/guix.texi:5631
11551 msgid "guix environment guile -- make -j4\n"
11554 #. type: Plain text
11555 #: guix-git/doc/guix.texi:5637
11556 msgid "In other situations, it is more convenient to specify the list of packages needed in the environment. For example, the following command runs @command{python} from an environment containing Python@tie{}2.7 and NumPy:"
11560 #: guix-git/doc/guix.texi:5640
11562 msgid "guix environment --ad-hoc python2-numpy python-2.7 -- python\n"
11565 #. type: Plain text
11566 #: guix-git/doc/guix.texi:5651
11567 msgid "Furthermore, one might want the dependencies of a package and also some additional packages that are not build-time or runtime dependencies, but are useful when developing nonetheless. Because of this, the @option{--ad-hoc} flag is positional. Packages appearing before @option{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment. Packages appearing after are interpreted as packages that will be added to the environment directly. For example, the following command creates a Guix development environment that additionally includes Git and strace:"
11571 #: guix-git/doc/guix.texi:5654
11573 msgid "guix environment --pure guix --ad-hoc git strace\n"
11577 #: guix-git/doc/guix.texi:5656 guix-git/doc/guix.texi:5817
11578 #: guix-git/doc/guix.texi:13078 guix-git/doc/guix.texi:33121
11583 #. type: Plain text
11584 #: guix-git/doc/guix.texi:5664
11585 msgid "Sometimes it is desirable to isolate the environment as much as possible, for maximal purity and reproducibility. In particular, when using Guix on a host distro that is not Guix System, it is desirable to prevent access to @file{/usr/bin} and other system-wide resources from the development environment. For example, the following command spawns a Guile REPL in a ``container'' where only the store and the current working directory are mounted:"
11589 #: guix-git/doc/guix.texi:5667
11591 msgid "guix environment --ad-hoc --container guile -- guile\n"
11595 #: guix-git/doc/guix.texi:5671
11596 msgid "The @option{--container} option requires Linux-libre 3.19 or newer."
11600 #: guix-git/doc/guix.texi:5673
11602 msgid "certificates"
11605 #. type: Plain text
11606 #: guix-git/doc/guix.texi:5680
11607 msgid "Another typical use case for containers is to run security-sensitive applications such as a web browser. To run Eolie, we must expose and share some files and directories; we include @code{nss-certs} and expose @file{/etc/ssl/certs/} for HTTPS authentication; finally we preserve the @env{DISPLAY} environment variable since containerized graphical applications won't display without it."
11611 #: guix-git/doc/guix.texi:5687
11614 "guix environment --preserve='^DISPLAY$' --container --network \\\n"
11615 " --expose=/etc/machine-id \\\n"
11616 " --expose=/etc/ssl/certs/ \\\n"
11617 " --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \\\n"
11618 " --ad-hoc eolie nss-certs dbus -- eolie\n"
11621 #. type: Plain text
11622 #: guix-git/doc/guix.texi:5690
11623 msgid "The available options are summarized below."
11627 #: guix-git/doc/guix.texi:5692 guix-git/doc/guix.texi:6228
11628 #: guix-git/doc/guix.texi:10886 guix-git/doc/guix.texi:33218
11630 msgid "--root=@var{file}"
11634 #: guix-git/doc/guix.texi:5693 guix-git/doc/guix.texi:6229
11635 #: guix-git/doc/guix.texi:10887 guix-git/doc/guix.texi:33219
11637 msgid "-r @var{file}"
11641 #: guix-git/doc/guix.texi:5694
11643 msgid "persistent environment"
11647 #: guix-git/doc/guix.texi:5695
11649 msgid "garbage collector root, for environments"
11653 #: guix-git/doc/guix.texi:5698
11654 msgid "Make @var{file} a symlink to the profile for this environment, and register it as a garbage collector root."
11658 #: guix-git/doc/guix.texi:5701
11659 msgid "This is useful if you want to protect your environment from garbage collection, to make it ``persistent''."
11663 #: guix-git/doc/guix.texi:5707
11664 msgid "When this option is omitted, the environment is protected from garbage collection only for the duration of the @command{guix environment} session. This means that next time you recreate the same environment, you could have to rebuild or re-download packages. @xref{Invoking guix gc}, for more on GC roots."
11668 #: guix-git/doc/guix.texi:5708 guix-git/doc/guix.texi:6160
11669 #: guix-git/doc/guix.texi:10732 guix-git/doc/guix.texi:11737
11670 #: guix-git/doc/guix.texi:12532 guix-git/doc/guix.texi:33153
11672 msgid "--expression=@var{expr}"
11676 #: guix-git/doc/guix.texi:5709 guix-git/doc/guix.texi:6161
11677 #: guix-git/doc/guix.texi:10733 guix-git/doc/guix.texi:11738
11678 #: guix-git/doc/guix.texi:12533 guix-git/doc/guix.texi:33154
11680 msgid "-e @var{expr}"
11684 #: guix-git/doc/guix.texi:5712
11685 msgid "Create an environment for the package or list of packages that @var{expr} evaluates to."
11689 #: guix-git/doc/guix.texi:5714
11690 msgid "For example, running:"
11694 #: guix-git/doc/guix.texi:5717
11696 msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
11700 #: guix-git/doc/guix.texi:5721
11701 msgid "starts a shell with the environment for this specific variant of the PETSc package."
11705 #: guix-git/doc/guix.texi:5723
11710 #: guix-git/doc/guix.texi:5726
11712 msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n"
11716 #: guix-git/doc/guix.texi:5729
11717 msgid "starts a shell with all the base system packages available."
11721 #: guix-git/doc/guix.texi:5732
11722 msgid "The above commands only use the default output of the given packages. To select other outputs, two element tuples can be specified:"
11726 #: guix-git/doc/guix.texi:5735
11728 msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
11732 #: guix-git/doc/guix.texi:5737
11734 msgid "--load=@var{file}"
11738 #: guix-git/doc/guix.texi:5738
11740 msgid "-l @var{file}"
11744 #: guix-git/doc/guix.texi:5741
11745 msgid "Create an environment for the package or list of packages that the code within @var{file} evaluates to."
11749 #: guix-git/doc/guix.texi:5747
11751 msgid "@verbatiminclude environment-gdb.scm\n"
11755 #: guix-git/doc/guix.texi:5754
11756 msgid "Create an environment for the packages contained in the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
11760 #: guix-git/doc/guix.texi:5758
11761 msgid "This is similar to the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files."
11765 #: guix-git/doc/guix.texi:5759
11771 #: guix-git/doc/guix.texi:5764
11772 msgid "Include all specified packages in the resulting environment, as if an @i{ad hoc} package were defined with them as inputs. This option is useful for quickly creating an environment without having to write a package expression to contain the desired inputs."
11776 #: guix-git/doc/guix.texi:5766
11777 msgid "For instance, the command:"
11781 #: guix-git/doc/guix.texi:5769
11783 msgid "guix environment --ad-hoc guile guile-sdl -- guile\n"
11787 #: guix-git/doc/guix.texi:5773
11788 msgid "runs @command{guile} in an environment where Guile and Guile-SDL are available."
11792 #: guix-git/doc/guix.texi:5778
11793 msgid "Note that this example implicitly asks for the default output of @code{guile} and @code{guile-sdl}, but it is possible to ask for a specific output---e.g., @code{glib:bin} asks for the @code{bin} output of @code{glib} (@pxref{Packages with Multiple Outputs})."
11797 #: guix-git/doc/guix.texi:5784
11798 msgid "This option may be composed with the default behavior of @command{guix environment}. Packages appearing before @option{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment, the default behavior. Packages appearing after are interpreted as packages that will be added to the environment directly."
11802 #: guix-git/doc/guix.texi:5785
11808 #: guix-git/doc/guix.texi:5789
11809 msgid "Unset existing environment variables when building the new environment, except those specified with @option{--preserve} (see below). This has the effect of creating an environment in which search paths only contain package inputs."
11813 #: guix-git/doc/guix.texi:5790
11815 msgid "--preserve=@var{regexp}"
11819 #: guix-git/doc/guix.texi:5791
11821 msgid "-E @var{regexp}"
11825 #: guix-git/doc/guix.texi:5796
11826 msgid "When used alongside @option{--pure}, preserve the environment variables matching @var{regexp}---in other words, put them on a ``white list'' of environment variables that must be preserved. This option can be repeated several times."
11830 #: guix-git/doc/guix.texi:5800
11833 "guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \\\n"
11834 " -- mpirun @dots{}\n"
11838 #: guix-git/doc/guix.texi:5806
11839 msgid "This example runs @command{mpirun} in a context where the only environment variables defined are @env{PATH}, environment variables whose name starts with @samp{SLURM}, as well as the usual ``precious'' variables (@env{HOME}, @env{USER}, etc.)."
11843 #: guix-git/doc/guix.texi:5807
11845 msgid "--search-paths"
11849 #: guix-git/doc/guix.texi:5810
11850 msgid "Display the environment variable definitions that make up the environment."
11854 #: guix-git/doc/guix.texi:5814
11855 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}."
11859 #: guix-git/doc/guix.texi:5815
11861 msgid "--container"
11865 #: guix-git/doc/guix.texi:5816
11871 #: guix-git/doc/guix.texi:5823
11872 msgid "Run @var{command} within an isolated container. The current working directory outside the container is mapped inside the container. Additionally, unless overridden with @option{--user}, a dummy home directory is created that matches the current user's home directory, and @file{/etc/passwd} is configured accordingly."
11876 #: guix-git/doc/guix.texi:5827
11877 msgid "The spawned process runs as the current user outside the container. Inside the container, it has the same UID and GID as the current user, unless @option{--user} is passed (see below)."
11881 #: guix-git/doc/guix.texi:5828 guix-git/doc/guix.texi:33213
11887 #: guix-git/doc/guix.texi:5833
11888 msgid "For containers, share the network namespace with the host system. Containers created without this flag only have access to the loopback device."
11892 #: guix-git/doc/guix.texi:5834
11894 msgid "--link-profile"
11898 #: guix-git/doc/guix.texi:5835
11904 #: guix-git/doc/guix.texi:5843
11905 msgid "For containers, link the environment profile to @file{~/.guix-profile} within the container and set @code{GUIX_ENVIRONMENT} to that. This is equivalent to making @file{~/.guix-profile} a symlink to the actual profile within the container. Linking will fail and abort the environment if the directory already exists, which will certainly be the case if @command{guix environment} was invoked in the user's home directory."
11909 #: guix-git/doc/guix.texi:5849
11910 msgid "Certain packages are configured to look in @file{~/.guix-profile} for configuration files and data;@footnote{For example, the @code{fontconfig} package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} @option{--link-profile} allows these programs to behave as expected within the environment."
11914 #: guix-git/doc/guix.texi:5850 guix-git/doc/guix.texi:12665
11916 msgid "--user=@var{user}"
11920 #: guix-git/doc/guix.texi:5851 guix-git/doc/guix.texi:12666
11922 msgid "-u @var{user}"
11926 #: guix-git/doc/guix.texi:5858
11927 msgid "For containers, use the username @var{user} in place of the current user. The generated @file{/etc/passwd} entry within the container will contain the name @var{user}, the home directory will be @file{/home/@var{user}}, and no user GECOS data will be copied. Furthermore, the UID and GID inside the container are 1000. @var{user} need not exist on the system."
11931 #: guix-git/doc/guix.texi:5863
11932 msgid "Additionally, any shared or exposed path (see @option{--share} and @option{--expose} respectively) whose target is within the current user's home directory will be remapped relative to @file{/home/USER}; this includes the automatic mapping of the current working directory."
11936 #: guix-git/doc/guix.texi:5870
11939 "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
11941 "guix environment --container --user=foo \\\n"
11942 " --expose=$HOME/test \\\n"
11943 " --expose=/tmp/target=$HOME/target\n"
11947 #: guix-git/doc/guix.texi:5875
11948 msgid "While this will limit the leaking of user identity through home paths and each of the user fields, this is only one useful component of a broader privacy/anonymity solution---not one in and of itself."
11952 #: guix-git/doc/guix.texi:5876
11958 #: guix-git/doc/guix.texi:5883
11959 msgid "For containers, the default behavior is to share the current working directory with the isolated container and immediately change to that directory within the container. If this is undesirable, @option{--no-cwd} will cause the current working directory to @emph{not} be automatically shared and will change to the user's home directory within the container instead. See also @option{--user}."
11963 #: guix-git/doc/guix.texi:5884
11965 msgid "--expose=@var{source}[=@var{target}]"
11969 #: guix-git/doc/guix.texi:5885
11971 msgid "--share=@var{source}[=@var{target}]"
11975 #: guix-git/doc/guix.texi:5891
11976 msgid "For containers, @option{--expose} (resp. @option{--share}) exposes the file system @var{source} from the host system as the read-only (resp. writable) file system @var{target} within the container. If @var{target} is not specified, @var{source} is used as the target mount point in the container."
11980 #: guix-git/doc/guix.texi:5895
11981 msgid "The example below spawns a Guile REPL in a container in which the user's home directory is accessible read-only via the @file{/exchange} directory:"
11985 #: guix-git/doc/guix.texi:5898
11987 msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n"
11990 #. type: Plain text
11991 #: guix-git/doc/guix.texi:5906
11992 msgid "@command{guix environment} also supports all of the common build options that @command{guix build} supports (@pxref{Common Build Options}) as well as package transformation options (@pxref{Package Transformation Options})."
11996 #: guix-git/doc/guix.texi:5908
11998 msgid "Invoking @command{guix pack}"
12001 #. type: Plain text
12002 #: guix-git/doc/guix.texi:5914
12003 msgid "Occasionally you want to pass software to people who are not (yet!) lucky enough to be using Guix. You'd tell them to run @command{guix package -i @var{something}}, but that's not possible in this case. This is where @command{guix pack} comes in."
12007 #: guix-git/doc/guix.texi:5919
12008 msgid "If you are looking for ways to exchange binaries among machines that already run Guix, @pxref{Invoking guix copy}, @ref{Invoking guix publish}, and @ref{Invoking guix archive}."
12012 #: guix-git/doc/guix.texi:5921
12018 #: guix-git/doc/guix.texi:5922
12024 #: guix-git/doc/guix.texi:5923
12026 msgid "application bundle"
12030 #: guix-git/doc/guix.texi:5924
12032 msgid "software bundle"
12035 #. type: Plain text
12036 #: guix-git/doc/guix.texi:5933
12037 msgid "The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or @dfn{software bundle}: it creates a tarball or some other archive containing the binaries of the software you're interested in, and all its dependencies. The resulting archive can be used on any machine that does not have Guix, and people can run the exact same binaries as those you have with Guix. The pack itself is created in a bit-reproducible fashion, so anyone can verify that it really contains the build results that you pretend to be shipping."
12040 #. type: Plain text
12041 #: guix-git/doc/guix.texi:5936
12042 msgid "For example, to create a bundle containing Guile, Emacs, Geiser, and all their dependencies, you can run:"
12046 #: guix-git/doc/guix.texi:5941
12049 "$ guix pack guile emacs geiser\n"
12051 "/gnu/store/@dots{}-pack.tar.gz\n"
12054 #. type: Plain text
12055 #: guix-git/doc/guix.texi:5949
12056 msgid "The result here is a tarball containing a @file{/gnu/store} directory with all the relevant packages. The resulting tarball contains a @dfn{profile} with the three packages of interest; the profile is the same as would be created by @command{guix package -i}. It is this mechanism that is used to create Guix's own standalone binary tarball (@pxref{Binary Installation})."
12059 #. type: Plain text
12060 #: guix-git/doc/guix.texi:5954
12061 msgid "Users of this pack would have to run @file{/gnu/store/@dots{}-profile/bin/guile} to run Guile, which you may find inconvenient. To work around it, you can create, say, a @file{/opt/gnu/bin} symlink to the profile:"
12065 #: guix-git/doc/guix.texi:5957
12067 msgid "guix pack -S /opt/gnu/bin=bin guile emacs geiser\n"
12070 #. type: Plain text
12071 #: guix-git/doc/guix.texi:5961
12072 msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy."
12076 #: guix-git/doc/guix.texi:5962
12078 msgid "relocatable binaries, with @command{guix pack}"
12081 #. type: Plain text
12082 #: guix-git/doc/guix.texi:5970
12083 msgid "What if the recipient of your pack does not have root privileges on their machine, and thus cannot unpack it in the root file system? In that case, you will want to use the @option{--relocatable} option (see below). This option produces @dfn{relocatable binaries}, meaning they they can be placed anywhere in the file system hierarchy: in the example above, users can unpack your tarball in their home directory and directly run @file{./opt/gnu/bin/guile}."
12087 #: guix-git/doc/guix.texi:5971
12089 msgid "Docker, build an image with guix pack"
12092 #. type: Plain text
12093 #: guix-git/doc/guix.texi:5974
12094 msgid "Alternatively, you can produce a pack in the Docker image format using the following command:"
12098 #: guix-git/doc/guix.texi:5977
12100 msgid "guix pack -f docker -S /bin=bin guile guile-readline\n"
12103 #. type: Plain text
12104 #: guix-git/doc/guix.texi:5982
12105 msgid "The result is a tarball that can be passed to the @command{docker load} command, followed by @code{docker run}:"
12109 #: guix-git/doc/guix.texi:5986
12112 "docker load < @var{file}\n"
12113 "docker run -ti guile-guile-readline /bin/guile\n"
12116 #. type: Plain text
12117 #: guix-git/doc/guix.texi:5993
12118 msgid "where @var{file} is the image returned by @var{guix pack}, and @code{guile-guile-readline} is its ``image tag''. See the @uref{https://docs.docker.com/engine/reference/commandline/load/, Docker documentation} for more information."
12122 #: guix-git/doc/guix.texi:5994
12124 msgid "Singularity, build an image with guix pack"
12128 #: guix-git/doc/guix.texi:5995
12130 msgid "SquashFS, build an image with guix pack"
12133 #. type: Plain text
12134 #: guix-git/doc/guix.texi:5998
12135 msgid "Yet another option is to produce a SquashFS image with the following command:"
12139 #: guix-git/doc/guix.texi:6001
12141 msgid "guix pack -f squashfs bash guile emacs geiser\n"
12144 #. type: Plain text
12145 #: guix-git/doc/guix.texi:6009
12146 msgid "The result is a SquashFS file system image that can either be mounted or directly be used as a file system container image with the @uref{https://www.sylabs.io/docs/, Singularity container execution environment}, using commands like @command{singularity shell} or @command{singularity exec}."
12149 #. type: Plain text
12150 #: guix-git/doc/guix.texi:6011
12151 msgid "Several command-line options allow you to customize your pack:"
12155 #: guix-git/doc/guix.texi:6016
12156 msgid "Produce a pack in the given @var{format}."
12160 #: guix-git/doc/guix.texi:6018
12161 msgid "The available formats are:"
12165 #: guix-git/doc/guix.texi:6020
12171 #: guix-git/doc/guix.texi:6023
12172 msgid "This is the default format. It produces a tarball containing all the specified binaries and symlinks."
12176 #: guix-git/doc/guix.texi:6024
12182 #: guix-git/doc/guix.texi:6030
12183 msgid "This produces a tarball that follows the @uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, Docker Image Specification}. The ``repository name'' as it appears in the output of the @command{docker images} command is computed from package names passed on the command line or in the manifest file."
12187 #: guix-git/doc/guix.texi:6031
12193 #: guix-git/doc/guix.texi:6035
12194 msgid "This produces a SquashFS image containing all the specified binaries and symlinks, as well as empty mount points for virtual file systems like procfs."
12198 #: guix-git/doc/guix.texi:6041
12199 msgid "Singularity @emph{requires} you to provide @file{/bin/sh} in the image. For that reason, @command{guix pack -f squashfs} always implies @code{-S /bin=bin}. Thus, your @command{guix pack} invocation must always start with something like:"
12203 #: guix-git/doc/guix.texi:6044
12205 msgid "guix pack -f squashfs bash @dots{}\n"
12209 #: guix-git/doc/guix.texi:6049
12210 msgid "If you forget the @code{bash} (or similar) package, @command{singularity run} and @command{singularity exec} will fail with an unhelpful ``no such file or directory'' message."
12214 #: guix-git/doc/guix.texi:6052
12216 msgid "relocatable binaries"
12220 #: guix-git/doc/guix.texi:6053
12222 msgid "--relocatable"
12226 #: guix-git/doc/guix.texi:6057
12227 msgid "Produce @dfn{relocatable binaries}---i.e., binaries that can be placed anywhere in the file system hierarchy and run from there."
12231 #: guix-git/doc/guix.texi:6065
12232 msgid "When this option is passed once, the resulting binaries require support for @dfn{user namespaces} in the kernel Linux; when passed @emph{twice}@footnote{Here's a trick to memorize it: @code{-RR}, which adds PRoot support, can be thought of as the abbreviation of ``Really Relocatable''. Neat, isn't it?}, relocatable binaries fall to back to other techniques if user namespaces are unavailable, and essentially work anywhere---see below for the implications."
12236 #: guix-git/doc/guix.texi:6067
12237 msgid "For example, if you create a pack containing Bash with:"
12241 #: guix-git/doc/guix.texi:6070
12243 msgid "guix pack -RR -S /mybin=bin bash\n"
12247 #: guix-git/doc/guix.texi:6075
12248 msgid "...@: you can copy that pack to a machine that lacks Guix, and from your home directory as a normal user, run:"
12252 #: guix-git/doc/guix.texi:6079
12255 "tar xf pack.tar.gz\n"
12260 #: guix-git/doc/guix.texi:6087
12261 msgid "In that shell, if you type @code{ls /gnu/store}, you'll notice that @file{/gnu/store} shows up and contains all the dependencies of @code{bash}, even though the machine actually lacks @file{/gnu/store} altogether! That is probably the simplest way to deploy Guix-built software on a non-Guix machine."
12265 #: guix-git/doc/guix.texi:6093
12266 msgid "By default, relocatable binaries rely on the @dfn{user namespace} feature of the kernel Linux, which allows unprivileged users to mount or change root. Old versions of Linux did not support it, and some GNU/Linux distributions turn it off."
12270 #: guix-git/doc/guix.texi:6099
12271 msgid "To produce relocatable binaries that work even in the absence of user namespaces, pass @option{--relocatable} or @option{-R} @emph{twice}. In that case, binaries will try user namespace support and fall back to another @dfn{execution engine} if user namespaces are not supported. The following execution engines are supported:"
12275 #: guix-git/doc/guix.texi:6101 guix-git/doc/guix.texi:16276
12281 #: guix-git/doc/guix.texi:6104
12282 msgid "Try user namespaces and fall back to PRoot if user namespaces are not supported (see below)."
12286 #: guix-git/doc/guix.texi:6105
12288 msgid "performance"
12292 #: guix-git/doc/guix.texi:6108
12293 msgid "Try user namespaces and fall back to Fakechroot if user namespaces are not supported (see below)."
12297 #: guix-git/doc/guix.texi:6109
12303 #: guix-git/doc/guix.texi:6112
12304 msgid "Run the program through user namespaces and abort if they are not supported."
12308 #: guix-git/doc/guix.texi:6113
12314 #: guix-git/doc/guix.texi:6120
12315 msgid "Run through PRoot. The @uref{https://proot-me.github.io/, PRoot} program provides the necessary support for file system virtualization. It achieves that by using the @code{ptrace} system call on the running program. This approach has the advantage to work without requiring special kernel support, but it incurs run-time overhead every time a system call is made."
12319 #: guix-git/doc/guix.texi:6121
12325 #: guix-git/doc/guix.texi:6129
12326 msgid "Run through Fakechroot. @uref{https://github.com/dex4er/fakechroot/, Fakechroot} virtualizes file system accesses by intercepting calls to C library functions such as @code{open}, @code{stat}, @code{exec}, and so on. Unlike PRoot, it incurs very little overhead. However, it does not always work: for example, some file system accesses made from within the C library are not intercepted, and file system accesses made @i{via} direct syscalls are not intercepted either, leading to erratic behavior."
12330 #: guix-git/doc/guix.texi:6131
12332 msgid "GUIX_EXECUTION_ENGINE"
12336 #: guix-git/doc/guix.texi:6135
12337 msgid "When running a wrapped program, you can explicitly request one of the execution engines listed above by setting the @env{GUIX_EXECUTION_ENGINE} environment variable accordingly."
12341 #: guix-git/doc/guix.texi:6137
12343 msgid "entry point, for Docker images"
12347 #: guix-git/doc/guix.texi:6138
12349 msgid "--entry-point=@var{command}"
12353 #: guix-git/doc/guix.texi:6143
12354 msgid "Use @var{command} as the @dfn{entry point} of the resulting pack, if the pack format supports it---currently @code{docker} and @code{squashfs} (Singularity) support it. @var{command} must be relative to the profile contained in the pack."
12358 #: guix-git/doc/guix.texi:6147
12359 msgid "The entry point specifies the command that tools like @code{docker run} or @code{singularity run} automatically start by default. For example, you can do:"
12363 #: guix-git/doc/guix.texi:6150
12365 msgid "guix pack -f docker --entry-point=bin/guile guile\n"
12369 #: guix-git/doc/guix.texi:6154
12370 msgid "The resulting pack can easily be loaded and @code{docker run} with no extra arguments will spawn @code{bin/guile}:"
12374 #: guix-git/doc/guix.texi:6158
12377 "docker load -i pack.tar.gz\n"
12378 "docker run @var{image-id}\n"
12382 #: guix-git/doc/guix.texi:6163 guix-git/doc/guix.texi:11740
12383 #: guix-git/doc/guix.texi:12535
12384 msgid "Consider the package @var{expr} evaluates to."
12388 #: guix-git/doc/guix.texi:6167
12389 msgid "This has the same purpose as the same-named option in @command{guix build} (@pxref{Additional Build Options, @option{--expression} in @command{guix build}})."
12393 #: guix-git/doc/guix.texi:6173
12394 msgid "Use the packages contained in the manifest object returned by the Scheme code in @var{file}. This option can be repeated several times, in which case the manifests are concatenated."
12398 #: guix-git/doc/guix.texi:6181
12399 msgid "This has a similar purpose as the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files. It allows you to define a collection of packages once and use it both for creating profiles and for creating archives for use on machines that do not have Guix installed. Note that you can specify @emph{either} a manifest file @emph{or} a list of packages, but not both."
12403 #: guix-git/doc/guix.texi:6187 guix-git/doc/guix.texi:10850
12405 msgid "--target=@var{triplet}"
12409 #: guix-git/doc/guix.texi:6188 guix-git/doc/guix.texi:6639
12410 #: guix-git/doc/guix.texi:10851
12412 msgid "cross-compilation"
12416 #: guix-git/doc/guix.texi:6192
12417 msgid "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying target triplets, GNU configuration triplets,, autoconf, Autoconf})."
12421 #: guix-git/doc/guix.texi:6193
12423 msgid "--compression=@var{tool}"
12427 #: guix-git/doc/guix.texi:6194
12429 msgid "-C @var{tool}"
12433 #: guix-git/doc/guix.texi:6198
12434 msgid "Compress the resulting tarball using @var{tool}---one of @code{gzip}, @code{zstd}, @code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression."
12438 #: guix-git/doc/guix.texi:6199
12440 msgid "--symlink=@var{spec}"
12444 #: guix-git/doc/guix.texi:6200
12446 msgid "-S @var{spec}"
12450 #: guix-git/doc/guix.texi:6203
12451 msgid "Add the symlinks specified by @var{spec} to the pack. This option can appear several times."
12455 #: guix-git/doc/guix.texi:6207
12456 msgid "@var{spec} has the form @code{@var{source}=@var{target}}, where @var{source} is the symlink that will be created and @var{target} is the symlink target."
12460 #: guix-git/doc/guix.texi:6210
12461 msgid "For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} symlink pointing to the @file{bin} sub-directory of the profile."
12465 #: guix-git/doc/guix.texi:6211 guix-git/doc/guix.texi:33172
12467 msgid "--save-provenance"
12471 #: guix-git/doc/guix.texi:6215
12472 msgid "Save provenance information for the packages passed on the command line. Provenance information includes the URL and commit of the channels in use (@pxref{Channels})."
12476 #: guix-git/doc/guix.texi:6221
12477 msgid "Provenance information is saved in the @file{/gnu/store/@dots{}-profile/manifest} file in the pack, along with the usual package metadata---the name and version of each package, their propagated inputs, and so on. It is useful information to the recipient of the pack, who then knows how the pack was (supposedly) obtained."
12481 #: guix-git/doc/guix.texi:6227
12482 msgid "This option is not enabled by default because, like timestamps, provenance information contributes nothing to the build process. In other words, there is an infinity of channel URLs and commit IDs that can lead to the same pack. Recording such ``silent'' metadata in the output thus potentially breaks the source-to-binary bitwise reproducibility property."
12486 #: guix-git/doc/guix.texi:6230
12488 msgid "garbage collector root, for packs"
12492 #: guix-git/doc/guix.texi:6233
12493 msgid "Make @var{file} a symlink to the resulting pack, and register it as a garbage collector root."
12497 #: guix-git/doc/guix.texi:6234
12499 msgid "--localstatedir"
12503 #: guix-git/doc/guix.texi:6235
12505 msgid "--profile-name=@var{name}"
12509 #: guix-git/doc/guix.texi:6240
12510 msgid "Include the ``local state directory'', @file{/var/guix}, in the resulting pack, and notably the @file{/var/guix/profiles/per-user/root/@var{name}} profile---by default @var{name} is @code{guix-profile}, which corresponds to @file{~root/.guix-profile}."
12514 #: guix-git/doc/guix.texi:6246
12515 msgid "@file{/var/guix} contains the store database (@pxref{The Store}) as well as garbage-collector roots (@pxref{Invoking guix gc}). Providing it in the pack means that the store is ``complete'' and manageable by Guix; not providing it pack means that the store is ``dead'': items cannot be added to it or removed from it after extraction of the pack."
12519 #: guix-git/doc/guix.texi:6249
12520 msgid "One use case for this is the Guix self-contained binary tarball (@pxref{Binary Installation})."
12524 #: guix-git/doc/guix.texi:6250 guix-git/doc/guix.texi:33166
12526 msgid "--derivation"
12530 #: guix-git/doc/guix.texi:6251 guix-git/doc/guix.texi:10882
12531 #: guix-git/doc/guix.texi:33167
12537 #: guix-git/doc/guix.texi:6253
12538 msgid "Print the name of the derivation that builds the pack."
12542 #: guix-git/doc/guix.texi:6257
12543 msgid "Use the bootstrap binaries to build the pack. This option is only useful to Guix developers."
12546 #. type: Plain text
12547 #: guix-git/doc/guix.texi:6262
12548 msgid "In addition, @command{guix pack} supports all the common build options (@pxref{Common Build Options}) and all the package transformation options (@pxref{Package Transformation Options})."
12552 #: guix-git/doc/guix.texi:6267
12558 #: guix-git/doc/guix.texi:6268
12564 #: guix-git/doc/guix.texi:6269
12566 msgid "linker wrapper"
12570 #: guix-git/doc/guix.texi:6270
12572 msgid "toolchain, for C development"
12576 #: guix-git/doc/guix.texi:6271
12578 msgid "toolchain, for Fortran development"
12581 #. type: Plain text
12582 #: guix-git/doc/guix.texi:6278
12583 msgid "If you need a complete toolchain for compiling and linking C or C++ source code, use the @code{gcc-toolchain} package. This package provides a complete GCC toolchain for C/C++ development, including GCC itself, the GNU C Library (headers and binaries, plus debugging symbols in the @code{debug} output), Binutils, and a linker wrapper."
12586 #. type: Plain text
12587 #: guix-git/doc/guix.texi:6284
12588 msgid "The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches passed to the linker, add corresponding @code{-rpath} arguments, and invoke the actual linker with this new set of arguments. You can instruct the wrapper to refuse to link against libraries not in the store by setting the @env{GUIX_LD_WRAPPER_ALLOW_IMPURITIES} environment variable to @code{no}."
12591 #. type: Plain text
12592 #: guix-git/doc/guix.texi:6288
12593 msgid "The package @code{gfortran-toolchain} provides a complete GCC toolchain for Fortran development. For other languages, please use @samp{guix search gcc toolchain} (@pxref{guix-search,, Invoking guix package})."
12597 #: guix-git/doc/guix.texi:6291
12599 msgid "Invoking @command{guix git authenticate}"
12602 #. type: Plain text
12603 #: guix-git/doc/guix.texi:6299
12604 msgid "The @command{guix git authenticate} command authenticates a Git checkout following the same rule as for channels (@pxref{channel-authentication, channel authentication}). That is, starting from a given commit, it ensures that all subsequent commits are signed by an OpenPGP key whose fingerprint appears in the @file{.guix-authorizations} file of its parent commit(s)."
12607 #. type: Plain text
12608 #: guix-git/doc/guix.texi:6304
12609 msgid "You will find this command useful if you maintain a channel. But in fact, this authentication mechanism is useful in a broader context, so you might want to use it for Git repositories that have nothing to do with Guix."
12613 #: guix-git/doc/guix.texi:6309
12615 msgid "guix git authenticate @var{commit} @var{signer} [@var{options}@dots{}]\n"
12618 #. type: Plain text
12619 #: guix-git/doc/guix.texi:6318
12620 msgid "By default, this command authenticates the Git checkout in the current directory; it outputs nothing and exits with exit code zero on success and non-zero on failure. @var{commit} above denotes the first commit where authentication takes place, and @var{signer} is the OpenPGP fingerprint of public key used to sign @var{commit}. Together, they form a ``channel introduction'' (@pxref{channel-authentication, channel introduction}). The options below allow you to fine-tune the process."
12624 #: guix-git/doc/guix.texi:6320
12626 msgid "--repository=@var{directory}"
12630 #: guix-git/doc/guix.texi:6321
12632 msgid "-r @var{directory}"
12636 #: guix-git/doc/guix.texi:6324
12637 msgid "Open the Git repository in @var{directory} instead of the current directory."
12641 #: guix-git/doc/guix.texi:6325
12643 msgid "--keyring=@var{reference}"
12647 #: guix-git/doc/guix.texi:6326
12649 msgid "-k @var{reference}"
12653 #: guix-git/doc/guix.texi:6332
12654 msgid "Load OpenPGP keyring from @var{reference}, the reference of a branch such as @code{origin/keyring} or @code{my-keyring}. The branch must contain OpenPGP public keys in @file{.key} files, either in binary form or ``ASCII-armored''. By default the keyring is loaded from the branch named @code{keyring}."
12658 #: guix-git/doc/guix.texi:6333
12664 #: guix-git/doc/guix.texi:6335
12665 msgid "Display commit signing statistics upon completion."
12669 #: guix-git/doc/guix.texi:6336
12671 msgid "--cache-key=@var{key}"
12675 #: guix-git/doc/guix.texi:6340
12676 msgid "Previously-authenticated commits are cached in a file under @file{~/.cache/guix/authentication}. This option forces the cache to be stored in file @var{key} in that directory."
12680 #: guix-git/doc/guix.texi:6341
12682 msgid "--historical-authorizations=@var{file}"
12686 #: guix-git/doc/guix.texi:6348
12687 msgid "By default, any commit whose parent commit(s) lack the @file{.guix-authorizations} file is considered inauthentic. In contrast, this option considers the authorizations in @var{file} for any commit that lacks @file{.guix-authorizations}. The format of @var{file} is the same as that of @file{.guix-authorizations} (@pxref{channel-authorizations, @file{.guix-authorizations} format})."
12690 #. type: Plain text
12691 #: guix-git/doc/guix.texi:6361
12692 msgid "GNU Guix provides several Scheme programming interfaces (APIs) to define, build, and query packages. The first interface allows users to write high-level package definitions. These definitions refer to familiar packaging concepts, such as the name and version of a package, its build system, and its dependencies. These definitions can then be turned into concrete build actions."
12695 #. type: Plain text
12696 #: guix-git/doc/guix.texi:6367
12697 msgid "Build actions are performed by the Guix daemon, on behalf of users. In a standard setup, the daemon has write access to the store---the @file{/gnu/store} directory---whereas users do not. The recommended setup also has the daemon perform builds in chroots, under specific build users, to minimize interference with the rest of the system."
12700 #. type: Plain text
12701 #: guix-git/doc/guix.texi:6376
12702 msgid "Lower-level APIs are available to interact with the daemon and the store. To instruct the daemon to perform a build action, users actually provide it with a @dfn{derivation}. A derivation is a low-level representation of the build actions to be taken, and the environment in which they should occur---derivations are to package definitions what assembly is to C programs. The term ``derivation'' comes from the fact that build results @emph{derive} from them."
12705 #. type: Plain text
12706 #: guix-git/doc/guix.texi:6379
12707 msgid "This chapter describes all these APIs in turn, starting from high-level package definitions."
12711 #: guix-git/doc/guix.texi:6392
12712 msgid "Programming Guix in Guile"
12715 #. type: Plain text
12716 #: guix-git/doc/guix.texi:6408
12717 msgid "From a programming viewpoint, the package definitions of the GNU distribution are provided by Guile modules in the @code{(gnu packages @dots{})} name space@footnote{Note that packages under the @code{(gnu packages @dots{})} module name space are not necessarily ``GNU packages''. This module naming scheme follows the usual Guile module naming convention: @code{gnu} means that these modules are distributed as part of the GNU system, and @code{packages} identifies modules that define packages.} (@pxref{Modules, Guile modules,, guile, GNU Guile Reference Manual}). For instance, the @code{(gnu packages emacs)} module exports a variable named @code{emacs}, which is bound to a @code{<package>} object (@pxref{Defining Packages})."
12720 #. type: Plain text
12721 #: guix-git/doc/guix.texi:6415
12722 msgid "The @code{(gnu packages @dots{})} module name space is automatically scanned for packages by the command-line tools. For instance, when running @code{guix install emacs}, all the @code{(gnu packages @dots{})} modules are scanned until one that exports a package object whose name is @code{emacs} is found. This package search facility is implemented in the @code{(gnu packages)} module."
12726 #: guix-git/doc/guix.texi:6417
12728 msgid "package module search path"
12731 #. type: Plain text
12732 #: guix-git/doc/guix.texi:6426
12733 msgid "Users can store package definitions in modules with different names---e.g., @code{(my-packages emacs)}@footnote{Note that the file name and module name must match. For instance, the @code{(my-packages emacs)} module must be stored in a @file{my-packages/emacs.scm} file relative to the load path specified with @option{--load-path} or @env{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for details.}. There are two ways to make these package definitions visible to the user interfaces:"
12737 #: guix-git/doc/guix.texi:6433
12738 msgid "By adding the directory containing your package modules to the search path with the @code{-L} flag of @command{guix package} and other commands (@pxref{Common Build Options}), or by setting the @env{GUIX_PACKAGE_PATH} environment variable described below."
12742 #: guix-git/doc/guix.texi:6439
12743 msgid "By defining a @dfn{channel} and configuring @command{guix pull} so that it pulls from it. A channel is essentially a Git repository containing package modules. @xref{Channels}, for more information on how to define and use channels."
12746 #. type: Plain text
12747 #: guix-git/doc/guix.texi:6442
12748 msgid "@env{GUIX_PACKAGE_PATH} works similarly to other search path variables:"
12752 #: guix-git/doc/guix.texi:6443
12754 msgid "{Environment Variable} GUIX_PACKAGE_PATH"
12758 #: guix-git/doc/guix.texi:6447
12759 msgid "This is a colon-separated list of directories to search for additional package modules. Directories listed in this variable take precedence over the own modules of the distribution."
12762 #. type: Plain text
12763 #: guix-git/doc/guix.texi:6455
12764 msgid "The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: each package is built based solely on other packages in the distribution. The root of this dependency graph is a small set of @dfn{bootstrap binaries}, provided by the @code{(gnu packages bootstrap)} module. For more information on bootstrapping, @pxref{Bootstrapping}."
12767 #. type: Plain text
12768 #: guix-git/doc/guix.texi:6463
12769 msgid "The high-level interface to package definitions is implemented in the @code{(guix packages)} and @code{(guix build-system)} modules. As an example, the package definition, or @dfn{recipe}, for the GNU Hello package looks like this:"
12773 #: guix-git/doc/guix.texi:6471
12776 "(define-module (gnu packages hello)\n"
12777 " #:use-module (guix packages)\n"
12778 " #:use-module (guix download)\n"
12779 " #:use-module (guix build-system gnu)\n"
12780 " #:use-module (guix licenses)\n"
12781 " #:use-module (gnu packages gawk))\n"
12786 #: guix-git/doc/guix.texi:6490
12789 "(define-public hello\n"
12791 " (name \"hello\")\n"
12792 " (version \"2.10\")\n"
12793 " (source (origin\n"
12794 " (method url-fetch)\n"
12795 " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
12799 " \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"))))\n"
12800 " (build-system gnu-build-system)\n"
12801 " (arguments '(#:configure-flags '(\"--enable-silent-rules\")))\n"
12802 " (inputs `((\"gawk\" ,gawk)))\n"
12803 " (synopsis \"Hello, GNU world: An example GNU package\")\n"
12804 " (description \"Guess what GNU Hello prints!\")\n"
12805 " (home-page \"https://www.gnu.org/software/hello/\")\n"
12806 " (license gpl3+)))\n"
12809 #. type: Plain text
12810 #: guix-git/doc/guix.texi:6500
12811 msgid "Without being a Scheme expert, the reader may have guessed the meaning of the various fields here. This expression binds the variable @code{hello} to a @code{<package>} object, which is essentially a record (@pxref{SRFI-9, Scheme records,, guile, GNU Guile Reference Manual}). This package object can be inspected using procedures found in the @code{(guix packages)} module; for instance, @code{(package-name hello)} returns---surprise!---@code{\"hello\"}."
12814 #. type: Plain text
12815 #: guix-git/doc/guix.texi:6504
12816 msgid "With luck, you may be able to import part or all of the definition of the package you are interested in from another repository, using the @code{guix import} command (@pxref{Invoking guix import})."
12819 #. type: Plain text
12820 #: guix-git/doc/guix.texi:6510
12821 msgid "In the example above, @code{hello} is defined in a module of its own, @code{(gnu packages hello)}. Technically, this is not strictly necessary, but it is convenient to do so: all the packages defined in modules under @code{(gnu packages @dots{})} are automatically known to the command-line tools (@pxref{Package Modules})."
12824 #. type: Plain text
12825 #: guix-git/doc/guix.texi:6512
12826 msgid "There are a few points worth noting in the above package definition:"
12830 #: guix-git/doc/guix.texi:6519
12831 msgid "The @code{source} field of the package is an @code{<origin>} object (@pxref{origin Reference}, for the complete reference). Here, the @code{url-fetch} method from @code{(guix download)} is used, meaning that the source is a file to be downloaded over FTP or HTTP."
12835 #: guix-git/doc/guix.texi:6522
12836 msgid "The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the GNU mirrors defined in @code{(guix download)}."
12840 #: guix-git/doc/guix.texi:6529
12841 msgid "The @code{sha256} field specifies the expected SHA256 hash of the file being downloaded. It is mandatory, and allows Guix to check the integrity of the file. The @code{(base32 @dots{})} form introduces the base32 representation of the hash. You can obtain this information with @code{guix download} (@pxref{Invoking guix download}) and @code{guix hash} (@pxref{Invoking guix hash})."
12845 #: guix-git/doc/guix.texi:6530
12851 #: guix-git/doc/guix.texi:6534
12852 msgid "When needed, the @code{origin} form can also have a @code{patches} field listing patches to be applied, and a @code{snippet} field giving a Scheme expression to modify the source code."
12856 #: guix-git/doc/guix.texi:6536
12858 msgid "GNU Build System"
12862 #: guix-git/doc/guix.texi:6542
12863 msgid "The @code{build-system} field specifies the procedure to build the package (@pxref{Build Systems}). Here, @code{gnu-build-system} represents the familiar GNU Build System, where packages may be configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence."
12867 #: guix-git/doc/guix.texi:6546
12868 msgid "When you start packaging non-trivial software, you may need tools to manipulate those build phases, manipulate files, and so on. @xref{Build Utilities}, for more on this."
12872 #: guix-git/doc/guix.texi:6552
12873 msgid "The @code{arguments} field specifies options for the build system (@pxref{Build Systems}). Here it is interpreted by @code{gnu-build-system} as a request run @file{configure} with the @option{--enable-silent-rules} flag."
12877 #: guix-git/doc/guix.texi:6553 guix-git/doc/guix.texi:6556
12883 #: guix-git/doc/guix.texi:6554
12889 #: guix-git/doc/guix.texi:6555
12895 #: guix-git/doc/guix.texi:6564
12896 msgid "What about these quote (@code{'}) characters? They are Scheme syntax to introduce a literal list; @code{'} is synonymous with @code{quote}. @xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, for details. Here the value of the @code{arguments} field is a list of arguments passed to the build system down the road, as with @code{apply} (@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference Manual})."
12900 #: guix-git/doc/guix.texi:6570
12901 msgid "The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} (@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and @code{#:configure-flags} is a keyword used to pass a keyword argument to the build system (@pxref{Coding With Keywords,,, guile, GNU Guile Reference Manual})."
12905 #: guix-git/doc/guix.texi:6576
12906 msgid "The @code{inputs} field specifies inputs to the build process---i.e., build-time or run-time dependencies of the package. Here, we define an input called @code{\"gawk\"} whose value is that of the @code{gawk} variable; @code{gawk} is itself bound to a @code{<package>} object."
12910 #: guix-git/doc/guix.texi:6577
12912 msgid "backquote (quasiquote)"
12916 #: guix-git/doc/guix.texi:6578
12922 #: guix-git/doc/guix.texi:6579
12928 #: guix-git/doc/guix.texi:6580
12930 msgid "comma (unquote)"
12934 #: guix-git/doc/guix.texi:6581
12940 #: guix-git/doc/guix.texi:6582
12946 #: guix-git/doc/guix.texi:6583
12952 #: guix-git/doc/guix.texi:6584
12954 msgid "unquote-splicing"
12958 #: guix-git/doc/guix.texi:6590
12959 msgid "Again, @code{`} (a backquote, synonymous with @code{quasiquote}) allows us to introduce a literal list in the @code{inputs} field, while @code{,} (a comma, synonymous with @code{unquote}) allows us to insert a value in that list (@pxref{Expression Syntax, unquote,, guile, GNU Guile Reference Manual})."
12963 #: guix-git/doc/guix.texi:6594
12964 msgid "Note that GCC, Coreutils, Bash, and other essential tools do not need to be specified as inputs here. Instead, @code{gnu-build-system} takes care of ensuring that they are present (@pxref{Build Systems})."
12968 #: guix-git/doc/guix.texi:6598
12969 msgid "However, any other dependencies need to be specified in the @code{inputs} field. Any dependency not specified here will simply be unavailable to the build process, possibly leading to a build failure."
12972 #. type: Plain text
12973 #: guix-git/doc/guix.texi:6601
12974 msgid "@xref{package Reference}, for a full description of possible fields."
12977 #. type: Plain text
12978 #: guix-git/doc/guix.texi:6612
12979 msgid "Once a package definition is in place, the package may actually be built using the @code{guix build} command-line tool (@pxref{Invoking guix build}), troubleshooting any build failures you encounter (@pxref{Debugging Build Failures}). You can easily jump back to the package definition using the @command{guix edit} command (@pxref{Invoking guix edit}). @xref{Packaging Guidelines}, for more information on how to test package definitions, and @ref{Invoking guix lint}, for information on how to check a definition for style conformance."
12983 #: guix-git/doc/guix.texi:6612
12985 msgid "GUIX_PACKAGE_PATH"
12988 #. type: Plain text
12989 #: guix-git/doc/guix.texi:6616
12990 msgid "Lastly, @pxref{Channels}, for information on how to extend the distribution by adding your own package definitions in a ``channel''."
12993 #. type: Plain text
12994 #: guix-git/doc/guix.texi:6620
12995 msgid "Finally, updating the package definition to a new upstream version can be partly automated by the @command{guix refresh} command (@pxref{Invoking guix refresh})."
12998 #. type: Plain text
12999 #: guix-git/doc/guix.texi:6626
13000 msgid "Behind the scenes, a derivation corresponding to the @code{<package>} object is first computed by the @code{package-derivation} procedure. That derivation is stored in a @file{.drv} file under @file{/gnu/store}. The build actions it prescribes may then be realized by using the @code{build-derivations} procedure (@pxref{The Store})."
13004 #: guix-git/doc/guix.texi:6627
13006 msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]"
13010 #: guix-git/doc/guix.texi:6630
13011 msgid "Return the @code{<derivation>} object of @var{package} for @var{system} (@pxref{Derivations})."
13015 #: guix-git/doc/guix.texi:6636
13016 msgid "@var{package} must be a valid @code{<package>} object, and @var{system} must be a string denoting the target system type---e.g., @code{\"x86_64-linux\"} for an x86_64 Linux-based GNU system. @var{store} must be a connection to the daemon, which operates on the store (@pxref{The Store})."
13019 #. type: Plain text
13020 #: guix-git/doc/guix.texi:6642
13021 msgid "Similarly, it is possible to compute a derivation that cross-builds a package for some other system:"
13025 #: guix-git/doc/guix.texi:6643
13027 msgid "{Scheme Procedure} package-cross-derivation @var{store} @"
13031 #: guix-git/doc/guix.texi:6647
13032 msgid "@var{package} @var{target} [@var{system}] Return the @code{<derivation>} object of @var{package} cross-built from @var{system} to @var{target}."
13036 #: guix-git/doc/guix.texi:6651
13037 msgid "@var{target} must be a valid GNU triplet denoting the target hardware and operating system, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying Target Triplets,,, autoconf, Autoconf})."
13040 #. type: Plain text
13041 #: guix-git/doc/guix.texi:6655
13042 msgid "Once you have package definitions, you can easily define @emph{variants} of those packages. @xref{Defining Package Variants}, for more on that."
13045 #. type: subsection
13046 #: guix-git/doc/guix.texi:6663
13048 msgid "@code{package} Reference"
13051 #. type: Plain text
13052 #: guix-git/doc/guix.texi:6667
13053 msgid "This section summarizes all the options available in @code{package} declarations (@pxref{Defining Packages})."
13057 #: guix-git/doc/guix.texi:6668
13059 msgid "{Data Type} package"
13063 #: guix-git/doc/guix.texi:6670
13064 msgid "This is the data type representing a package recipe."
13068 #: guix-git/doc/guix.texi:6674
13069 msgid "The name of the package, as a string."
13073 #: guix-git/doc/guix.texi:6675
13079 #: guix-git/doc/guix.texi:6677
13080 msgid "The version of the package, as a string."
13084 #: guix-git/doc/guix.texi:6678 guix-git/doc/guix.texi:12011
13085 #: guix-git/doc/guix.texi:14256 guix-git/doc/guix.texi:14759
13091 #: guix-git/doc/guix.texi:6685
13092 msgid "An object telling how the source code for the package should be acquired. Most of the time, this is an @code{origin} object, which denotes a file fetched from the Internet (@pxref{origin Reference}). It can also be any other ``file-like'' object such as a @code{local-file}, which denotes a file from the local file system (@pxref{G-Expressions, @code{local-file}})."
13096 #: guix-git/doc/guix.texi:6686
13098 msgid "build-system"
13102 #: guix-git/doc/guix.texi:6689
13103 msgid "The build system that should be used to build the package (@pxref{Build Systems})."
13107 #: guix-git/doc/guix.texi:6690 guix-git/doc/guix.texi:16722
13109 msgid "@code{arguments} (default: @code{'()})"
13113 #: guix-git/doc/guix.texi:6693
13114 msgid "The arguments that should be passed to the build system. This is a list, typically containing sequential keyword-value pairs."
13118 #: guix-git/doc/guix.texi:6694
13120 msgid "@code{inputs} (default: @code{'()})"
13124 #: guix-git/doc/guix.texi:6695
13126 msgid "@code{native-inputs} (default: @code{'()})"
13130 #: guix-git/doc/guix.texi:6696
13132 msgid "@code{propagated-inputs} (default: @code{'()})"
13136 #: guix-git/doc/guix.texi:6697
13138 msgid "inputs, of packages"
13142 #: guix-git/doc/guix.texi:6705
13143 msgid "These fields list dependencies of the package. Each one is a list of tuples, where each tuple has a label for the input (a string) as its first element, a package, origin, or derivation as its second element, and optionally the name of the output thereof that should be used, which defaults to @code{\"out\"} (@pxref{Packages with Multiple Outputs}, for more on package outputs). For example, the list below specifies three inputs:"
13147 #: guix-git/doc/guix.texi:6710
13150 "`((\"libffi\" ,libffi)\n"
13151 " (\"libunistring\" ,libunistring)\n"
13152 " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of Glib\n"
13156 #: guix-git/doc/guix.texi:6712
13158 msgid "cross compilation, package dependencies"
13162 #: guix-git/doc/guix.texi:6718
13163 msgid "The distinction between @code{native-inputs} and @code{inputs} is necessary when considering cross-compilation. When cross-compiling, dependencies listed in @code{inputs} are built for the @emph{target} architecture; conversely, dependencies listed in @code{native-inputs} are built for the architecture of the @emph{build} machine."
13167 #: guix-git/doc/guix.texi:6723
13168 msgid "@code{native-inputs} is typically used to list tools needed at build time, but not at run time, such as Autoconf, Automake, pkg-config, Gettext, or Bison. @command{guix lint} can report likely mistakes in this area (@pxref{Invoking guix lint})."
13171 #. type: anchor{#1}
13172 #: guix-git/doc/guix.texi:6731
13173 msgid "package-propagated-inputs"
13177 #: guix-git/doc/guix.texi:6731
13178 msgid "Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the specified packages will be automatically installed to profiles (@pxref{Features, the role of profiles in Guix}) alongside the package they belong to (@pxref{package-cmd-propagated-inputs, @command{guix package}}, for information on how @command{guix package} deals with propagated inputs)."
13182 #: guix-git/doc/guix.texi:6735
13183 msgid "For example this is necessary when packaging a C/C++ library that needs headers of another library to compile, or when a pkg-config file refers to another one @i{via} its @code{Requires} field."
13187 #: guix-git/doc/guix.texi:6742
13188 msgid "Another example where @code{propagated-inputs} is useful is for languages that lack a facility to record the run-time search path akin to the @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. When packaging libraries written in those languages, ensure they can find library code they depend on at run time by listing run-time dependencies in @code{propagated-inputs} rather than @code{inputs}."
13192 #: guix-git/doc/guix.texi:6743
13194 msgid "@code{outputs} (default: @code{'(\"out\")})"
13198 #: guix-git/doc/guix.texi:6746
13199 msgid "The list of output names of the package. @xref{Packages with Multiple Outputs}, for typical uses of additional outputs."
13203 #: guix-git/doc/guix.texi:6747
13205 msgid "@code{native-search-paths} (default: @code{'()})"
13209 #: guix-git/doc/guix.texi:6748
13211 msgid "@code{search-paths} (default: @code{'()})"
13215 #: guix-git/doc/guix.texi:6751
13216 msgid "A list of @code{search-path-specification} objects describing search-path environment variables honored by the package."
13220 #: guix-git/doc/guix.texi:6752
13222 msgid "@code{replacement} (default: @code{#f})"
13226 #: guix-git/doc/guix.texi:6756
13227 msgid "This must be either @code{#f} or a package object that will be used as a @dfn{replacement} for this package. @xref{Security Updates, grafts}, for details."
13231 #: guix-git/doc/guix.texi:6757 guix-git/doc/guix.texi:12003
13237 #: guix-git/doc/guix.texi:6759
13238 msgid "A one-line description of the package."
13242 #: guix-git/doc/guix.texi:6760 guix-git/doc/guix.texi:12004
13243 #: guix-git/doc/guix.texi:33864 guix-git/doc/guix.texi:34015
13245 msgid "description"
13249 #: guix-git/doc/guix.texi:6762
13250 msgid "A more elaborate description of the package."
13254 #: guix-git/doc/guix.texi:6763
13260 #: guix-git/doc/guix.texi:6764
13262 msgid "license, of packages"
13266 #: guix-git/doc/guix.texi:6767
13267 msgid "The license of the package; a value from @code{(guix licenses)}, or a list of such values."
13271 #: guix-git/doc/guix.texi:6768 guix-git/doc/guix.texi:12012
13277 #: guix-git/doc/guix.texi:6770
13278 msgid "The URL to the home-page of the package, as a string."
13282 #: guix-git/doc/guix.texi:6771
13284 msgid "@code{supported-systems} (default: @code{%supported-systems})"
13288 #: guix-git/doc/guix.texi:6774
13289 msgid "The list of systems supported by the package, as strings of the form @code{architecture-kernel}, for example @code{\"x86_64-linux\"}."
13293 #: guix-git/doc/guix.texi:6775
13295 msgid "@code{location} (default: source location of the @code{package} form)"
13299 #: guix-git/doc/guix.texi:6779
13300 msgid "The source location of the package. It is useful to override this when inheriting from another package, in which case this field is not automatically corrected."
13304 #: guix-git/doc/guix.texi:6782
13306 msgid "{Scheme Syntax} this-package"
13310 #: guix-git/doc/guix.texi:6785
13311 msgid "When used in the @emph{lexical scope} of a package field definition, this identifier resolves to the package being defined."
13315 #: guix-git/doc/guix.texi:6788
13316 msgid "The example below shows how to add a package as a native input of itself when cross-compiling:"
13320 #: guix-git/doc/guix.texi:6793
13324 " (name \"guile\")\n"
13330 #: guix-git/doc/guix.texi:6799
13333 " ;; When cross-compiled, Guile, for example, depends on\n"
13334 " ;; a native version of itself. Add it here.\n"
13335 " (native-inputs (if (%current-target-system)\n"
13336 " `((\"self\" ,this-package))\n"
13341 #: guix-git/doc/guix.texi:6802
13342 msgid "It is an error to refer to @code{this-package} outside a package definition."
13345 #. type: Plain text
13346 #: guix-git/doc/guix.texi:6808
13347 msgid "Because packages are regular Scheme objects that capture a complete dependency graph and associated build procedures, it is often useful to write procedures that take a package and return a modified version thereof according to some parameters. Below are a few examples."
13351 #: guix-git/doc/guix.texi:6809
13353 msgid "tool chain, choosing a package's tool chain"
13357 #: guix-git/doc/guix.texi:6810
13359 msgid "{Scheme Procedure} package-with-c-toolchain @var{package} @var{toolchain}"
13363 #: guix-git/doc/guix.texi:6815
13364 msgid "Return a variant of @var{package} that uses @var{toolchain} instead of the default GNU C/C++ toolchain. @var{toolchain} must be a list of inputs (label/package tuples) providing equivalent functionality, such as the @code{gcc-toolchain} package."
13368 #: guix-git/doc/guix.texi:6819
13369 msgid "The example below returns a variant of the @code{hello} package built with GCC@tie{}10.x and the rest of the GNU tool chain (Binutils and the GNU C Library) instead of the default tool chain:"
13373 #: guix-git/doc/guix.texi:6823
13376 "(let ((toolchain (specification->package \"gcc-toolchain@@10\")))\n"
13377 " (package-with-c-toolchain hello `((\"toolchain\" ,toolchain))))\n"
13381 #: guix-git/doc/guix.texi:6831
13382 msgid "The build tool chain is part of the @dfn{implicit inputs} of packages---it's usually not listed as part of the various ``inputs'' fields and is instead pulled in by the build system. Consequently, this procedure works by changing the build system of @var{package} so that it pulls in @var{toolchain} instead of the defaults. @ref{Build Systems}, for more on build systems."
13385 #. type: subsection
13386 #: guix-git/doc/guix.texi:6834
13388 msgid "@code{origin} Reference"
13391 #. type: Plain text
13392 #: guix-git/doc/guix.texi:6842
13393 msgid "This section documents @dfn{origins}. An @code{origin} declaration specifies data that must be ``produced''---downloaded, usually---and whose content hash is known in advance. Origins are primarily used to represent the source code of packages (@pxref{Defining Packages}). For that reason, the @code{origin} form allows you to declare patches to apply to the original source code as well as code snippets to modify it."
13397 #: guix-git/doc/guix.texi:6843
13399 msgid "{Data Type} origin"
13403 #: guix-git/doc/guix.texi:6845
13404 msgid "This is the data type representing a source code origin."
13408 #: guix-git/doc/guix.texi:6847 guix-git/doc/guix.texi:24896
13414 #: guix-git/doc/guix.texi:6852
13415 msgid "An object containing the URI of the source. The object type depends on the @code{method} (see below). For example, when using the @var{url-fetch} method of @code{(guix download)}, the valid @code{uri} values are: a URL represented as a string, or a list thereof."
13419 #: guix-git/doc/guix.texi:6853
13421 msgid "fixed-output derivations, for download"
13425 #: guix-git/doc/guix.texi:6854
13431 #: guix-git/doc/guix.texi:6861
13432 msgid "A monadic procedure that handles the given URI@. The procedure must accept at least three arguments: the value of the @code{uri} field and the hash algorithm and hash value specified by the @code{hash} field. It must return a store item or a derivation in the store monad (@pxref{The Store Monad}); most methods return a fixed-output derivation (@pxref{Derivations})."
13436 #: guix-git/doc/guix.texi:6865
13437 msgid "Commonly used methods include @code{url-fetch}, which fetches data from a URL, and @code{git-fetch}, which fetches data from a Git repository (see below)."
13441 #: guix-git/doc/guix.texi:6866
13447 #: guix-git/doc/guix.texi:6870
13448 msgid "A bytevector containing the SHA-256 hash of the source. This is equivalent to providing a @code{content-hash} SHA256 object in the @code{hash} field described below."
13452 #: guix-git/doc/guix.texi:6871
13458 #: guix-git/doc/guix.texi:6874
13459 msgid "The @code{content-hash} object of the source---see below for how to use @code{content-hash}."
13463 #: guix-git/doc/guix.texi:6878
13464 msgid "You can obtain this information using @code{guix download} (@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking guix hash})."
13468 #: guix-git/doc/guix.texi:6879
13470 msgid "@code{file-name} (default: @code{#f})"
13474 #: guix-git/doc/guix.texi:6885
13475 msgid "The file name under which the source code should be saved. When this is @code{#f}, a sensible default value will be used in most cases. In case the source is fetched from a URL, the file name from the URL will be used. For version control checkouts, it is recommended to provide the file name explicitly because the default is not very descriptive."
13479 #: guix-git/doc/guix.texi:6886
13481 msgid "@code{patches} (default: @code{'()})"
13485 #: guix-git/doc/guix.texi:6889
13486 msgid "A list of file names, origins, or file-like objects (@pxref{G-Expressions, file-like objects}) pointing to patches to be applied to the source."
13490 #: guix-git/doc/guix.texi:6893
13491 msgid "This list of patches must be unconditional. In particular, it cannot depend on the value of @code{%current-system} or @code{%current-target-system}."
13495 #: guix-git/doc/guix.texi:6894
13497 msgid "@code{snippet} (default: @code{#f})"
13501 #: guix-git/doc/guix.texi:6898
13502 msgid "A G-expression (@pxref{G-Expressions}) or S-expression that will be run in the source directory. This is a convenient way to modify the source, sometimes more convenient than a patch."
13506 #: guix-git/doc/guix.texi:6899
13508 msgid "@code{patch-flags} (default: @code{'(\"-p1\")})"
13512 #: guix-git/doc/guix.texi:6902
13513 msgid "A list of command-line flags that should be passed to the @code{patch} command."
13517 #: guix-git/doc/guix.texi:6903
13519 msgid "@code{patch-inputs} (default: @code{#f})"
13523 #: guix-git/doc/guix.texi:6907
13524 msgid "Input packages or derivations to the patching process. When this is @code{#f}, the usual set of inputs necessary for patching are provided, such as GNU@tie{}Patch."
13528 #: guix-git/doc/guix.texi:6908 guix-git/doc/guix.texi:24769
13530 msgid "@code{modules} (default: @code{'()})"
13534 #: guix-git/doc/guix.texi:6911
13535 msgid "A list of Guile modules that should be loaded during the patching process and while running the code in the @code{snippet} field."
13539 #: guix-git/doc/guix.texi:6912
13541 msgid "@code{patch-guile} (default: @code{#f})"
13545 #: guix-git/doc/guix.texi:6915
13546 msgid "The Guile package that should be used in the patching process. When this is @code{#f}, a sensible default is used."
13550 #: guix-git/doc/guix.texi:6918
13552 msgid "{Data Type} content-hash @var{value} [@var{algorithm}]"
13556 #: guix-git/doc/guix.texi:6922
13557 msgid "Construct a content hash object for the given @var{algorithm}, and with @var{value} as its hash value. When @var{algorithm} is omitted, assume it is @code{sha256}."
13561 #: guix-git/doc/guix.texi:6925
13562 msgid "@var{value} can be a literal string, in which case it is base32-decoded, or it can be a bytevector."
13566 #: guix-git/doc/guix.texi:6927
13567 msgid "The following forms are all equivalent:"
13571 #: guix-git/doc/guix.texi:6936
13574 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\")\n"
13575 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"\n"
13577 "(content-hash (base32\n"
13578 " \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"))\n"
13579 "(content-hash (base64 \"kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=\")\n"
13584 #: guix-git/doc/guix.texi:6941
13585 msgid "Technically, @code{content-hash} is currently implemented as a macro. It performs sanity checks at macro-expansion time, when possible, such as ensuring that @var{value} has the right size for @var{algorithm}."
13588 #. type: Plain text
13589 #: guix-git/doc/guix.texi:6947
13590 msgid "As we have seen above, how exactly the data an origin refers to is retrieved is determined by its @code{method} field. The @code{(guix download)} module provides the most common method, @code{url-fetch}, described below."
13594 #: guix-git/doc/guix.texi:6948
13596 msgid "{Scheme Procedure} url-fetch @var{url} @var{hash-algo} @var{hash} @"
13600 #: guix-git/doc/guix.texi:6956
13601 msgid "[name] [#:executable? #f] Return a fixed-output derivation that fetches data from @var{url} (a string, or a list of strings denoting alternate URLs), which is expected to have hash @var{hash} of type @var{hash-algo} (a symbol). By default, the file name is the base name of URL; optionally, @var{name} can specify a different file name. When @var{executable?} is true, make the downloaded file executable."
13605 #: guix-git/doc/guix.texi:6959
13606 msgid "When one of the URL starts with @code{mirror://}, then its host part is interpreted as the name of a mirror scheme, taken from @file{%mirror-file}."
13610 #: guix-git/doc/guix.texi:6962
13611 msgid "Alternatively, when URL starts with @code{file://}, return the corresponding file name in the store."
13614 #. type: Plain text
13615 #: guix-git/doc/guix.texi:6968
13616 msgid "Likewise, the @code{(guix git-download)} module defines the @code{git-fetch} origin method, which fetches data from a Git version control repository, and the @code{git-reference} data type to describe the repository and revision to fetch."
13620 #: guix-git/doc/guix.texi:6969
13622 msgid "{Scheme Procedure} git-fetch @var{ref} @var{hash-algo} @var{hash}"
13626 #: guix-git/doc/guix.texi:6974
13627 msgid "Return a fixed-output derivation that fetches @var{ref}, a @code{<git-reference>} object. The output is expected to have recursive hash @var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file name, or a generic name if @code{#f}."
13631 #: guix-git/doc/guix.texi:6976
13633 msgid "{Data Type} git-reference"
13637 #: guix-git/doc/guix.texi:6979
13638 msgid "This data type represents a Git reference for @code{git-fetch} to retrieve."
13642 #: guix-git/doc/guix.texi:6981 guix-git/doc/guix.texi:22531
13648 #: guix-git/doc/guix.texi:6983
13649 msgid "The URL of the Git repository to clone."
13653 #: guix-git/doc/guix.texi:6984
13659 #: guix-git/doc/guix.texi:6988
13660 msgid "This string denotes either the commit to fetch (a hexadecimal string, either the full SHA1 commit or a ``short'' commit string; the latter is not recommended) or the tag to fetch."
13664 #: guix-git/doc/guix.texi:6989
13666 msgid "@code{recursive?} (default: @code{#f})"
13670 #: guix-git/doc/guix.texi:6991
13671 msgid "This Boolean indicates whether to recursively fetch Git sub-modules."
13675 #: guix-git/doc/guix.texi:6995
13676 msgid "The example below denotes the @code{v2.10} tag of the GNU@tie{}Hello repository:"
13680 #: guix-git/doc/guix.texi:7000
13684 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13685 " (commit \"v2.10\"))\n"
13689 #: guix-git/doc/guix.texi:7004
13690 msgid "This is equivalent to the reference below, which explicitly names the commit:"
13694 #: guix-git/doc/guix.texi:7009
13698 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13699 " (commit \"dc7dc56a00e48fe6f231a58f6537139fe2908fb9\"))\n"
13702 #. type: Plain text
13703 #: guix-git/doc/guix.texi:7015
13704 msgid "For Mercurial repositories, the module @code{(guix hg-download)} defines the @code{hg-fetch} origin method and @code{hg-reference} data type for support of the Mercurial version control system."
13708 #: guix-git/doc/guix.texi:7016
13710 msgid "{Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @"
13714 #: guix-git/doc/guix.texi:7022
13715 msgid "[name] Return a fixed-output derivation that fetches @var{ref}, a @code{<hg-reference>} object. The output is expected to have recursive hash @var{hash} of type @var{hash-algo} (a symbol). Use @var{name} as the file name, or a generic name if @code{#false}."
13719 #: guix-git/doc/guix.texi:7027
13721 msgid "customizing packages"
13725 #: guix-git/doc/guix.texi:7028
13727 msgid "variants, of packages"
13730 #. type: Plain text
13731 #: guix-git/doc/guix.texi:7038
13732 msgid "One of the nice things with Guix is that, given a package definition, you can easily @emph{derive} variants of that package---for a different upstream version, with different dependencies, different compilation options, and so on. Some of these custom packages can be defined straight from the command line (@pxref{Package Transformation Options}). This section describes how to define package variants in code. This can be useful in ``manifests'' (@pxref{profile-manifest, @option{--manifest}}) and in your own package collection (@pxref{Creating a Channel}), among others!"
13736 #: guix-git/doc/guix.texi:7039
13738 msgid "inherit, for package definitions"
13741 #. type: Plain text
13742 #: guix-git/doc/guix.texi:7046
13743 msgid "As discussed earlier, packages are first-class objects in the Scheme language. The @code{(guix packages)} module provides the @code{package} construct to define new package objects (@pxref{package Reference}). The easiest way to define a package variant is using the @code{inherit} keyword together with @code{package}. This allows you to inherit from a package definition while overriding the fields you want."
13746 #. type: Plain text
13747 #: guix-git/doc/guix.texi:7051
13748 msgid "For example, given the @code{hello} variable, which contains a definition for the current version of GNU@tie{}Hello, here's how you would define a variant for version 2.2 (released in 2006, it's vintage!):"
13752 #: guix-git/doc/guix.texi:7054
13755 "(use-modules (gnu packages base)) ;for 'hello'\n"
13760 #: guix-git/doc/guix.texi:7066
13763 "(define hello-2.2\n"
13765 " (inherit hello)\n"
13766 " (version \"2.2\")\n"
13767 " (source (origin\n"
13768 " (method url-fetch)\n"
13769 " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
13773 " \"0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9\"))))))\n"
13776 #. type: Plain text
13777 #: guix-git/doc/guix.texi:7075
13778 msgid "The example above corresponds to what the @option{--with-source} package transformation option does. Essentially @code{hello-2.2} preserves all the fields of @code{hello}, except @code{version} and @code{source}, which it overrides. Note that the original @code{hello} variable is still there, in the @code{(gnu packages base)} module, unchanged. When you define a custom package like this, you are really @emph{adding} a new package definition; the original one remains available."
13781 #. type: Plain text
13782 #: guix-git/doc/guix.texi:7081
13783 msgid "You can just as well define variants with a different set of dependencies than the original package. For example, the default @code{gdb} package depends on @code{guile}, but since that is an optional dependency, you can define a variant that removes that dependency like so:"
13787 #: guix-git/doc/guix.texi:7085
13790 "(use-modules (gnu packages gdb) ;for 'gdb'\n"
13791 " (srfi srfi-1)) ;for 'alist-delete'\n"
13796 #: guix-git/doc/guix.texi:7091
13799 "(define gdb-sans-guile\n"
13802 " (inputs (alist-delete \"guile\"\n"
13803 " (package-inputs gdb)))))\n"
13806 #. type: Plain text
13807 #: guix-git/doc/guix.texi:7097
13808 msgid "The @code{alist-delete} call above removes the tuple from the @code{inputs} field that has @code{\"guile\"} as its first element (@pxref{SRFI-1 Association Lists,,, guile, GNU Guile Reference Manual})."
13811 #. type: Plain text
13812 #: guix-git/doc/guix.texi:7105
13813 msgid "In some cases, you may find it useful to write functions (``procedures'', in Scheme parlance) that return a package based on some parameters. For example, consider the @code{luasocket} library for the Lua programming language. We want to create @code{luasocket} packages for major versions of Lua. One way to do that is to define a procedure that takes a Lua package and returns a @code{luasocket} package that depends on it:"
13817 #: guix-git/doc/guix.texi:7116
13820 "(define (make-lua-socket name lua)\n"
13821 " ;; Return a luasocket package built with LUA.\n"
13824 " (version \"3.0\")\n"
13825 " ;; several fields omitted\n"
13827 " `((\"lua\" ,lua)))\n"
13828 " (synopsis \"Socket library for Lua\")))\n"
13833 #: guix-git/doc/guix.texi:7119
13836 "(define-public lua5.1-socket\n"
13837 " (make-lua-socket \"lua5.1-socket\" lua-5.1))\n"
13842 #: guix-git/doc/guix.texi:7122
13845 "(define-public lua5.2-socket\n"
13846 " (make-lua-socket \"lua5.2-socket\" lua-5.2))\n"
13849 #. type: Plain text
13850 #: guix-git/doc/guix.texi:7130
13851 msgid "Here we have defined packages @code{lua5.1-socket} and @code{lua5.2-socket} by calling @code{make-lua-socket} with different arguments. @xref{Procedures,,, guile, GNU Guile Reference Manual}, for more info on procedures. Having top-level public definitions for these two packages means that they can be referred to from the command line (@pxref{Package Modules})."
13855 #: guix-git/doc/guix.texi:7131
13857 msgid "package transformations"
13860 #. type: Plain text
13861 #: guix-git/doc/guix.texi:7136
13862 msgid "These are pretty simple package variants. As a convenience, the @code{(guix transformations)} module provides a high-level interface that directly maps to the more sophisticated package transformation options (@pxref{Package Transformation Options}):"
13866 #: guix-git/doc/guix.texi:7137
13868 msgid "{Scheme Procedure} options->transformation @var{opts}"
13872 #: guix-git/doc/guix.texi:7141
13873 msgid "Return a procedure that, when passed an object to build (package, derivation, etc.), applies the transformations specified by @var{opts} and returns the resulting objects. @var{opts} must be a list of symbol/string pairs such as:"
13877 #: guix-git/doc/guix.texi:7145
13880 "((with-branch . \"guile-gcrypt=master\")\n"
13881 " (without-tests . \"libgcrypt\"))\n"
13885 #: guix-git/doc/guix.texi:7149
13886 msgid "Each symbol names a transformation and the corresponding string is an argument to that transformation."
13889 #. type: Plain text
13890 #: guix-git/doc/guix.texi:7152
13891 msgid "For instance, a manifest equivalent to this command:"
13895 #: guix-git/doc/guix.texi:7157
13898 "guix build guix \\\n"
13899 " --with-branch=guile-gcrypt=master \\\n"
13900 " --with-debug-info=zlib\n"
13903 #. type: Plain text
13904 #: guix-git/doc/guix.texi:7161
13905 msgid "... would look like this:"
13909 #: guix-git/doc/guix.texi:7164
13912 "(use-modules (guix transformations))\n"
13917 #: guix-git/doc/guix.texi:7170
13920 "(define transform\n"
13921 " ;; The package transformation procedure.\n"
13922 " (options->transformation\n"
13923 " '((with-branch . \"guile-gcrypt=master\")\n"
13924 " (with-debug-info . \"zlib\"))))\n"
13929 #: guix-git/doc/guix.texi:7173
13932 "(packages->manifest\n"
13933 " (list (transform (specification->package \"guix\"))))\n"
13937 #: guix-git/doc/guix.texi:7175
13939 msgid "input rewriting"
13943 #: guix-git/doc/guix.texi:7176
13945 msgid "dependency graph rewriting"
13948 #. type: Plain text
13949 #: guix-git/doc/guix.texi:7183
13950 msgid "The @code{options->transformation} procedure is convenient, but it's perhaps also not as flexible as you may like. How is it implemented? The astute reader probably noticed that most package transformation options go beyond the superficial changes shown in the first examples of this section: they involve @dfn{input rewriting}, whereby the dependency graph of a package is rewritten by replacing specific inputs by others."
13953 #. type: Plain text
13954 #: guix-git/doc/guix.texi:7187
13955 msgid "Dependency graph rewriting, for the purposes of swapping packages in the graph, is what the @code{package-input-rewriting} procedure in @code{(guix packages)} implements."
13959 #: guix-git/doc/guix.texi:7188
13961 msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @"
13965 #: guix-git/doc/guix.texi:7195
13966 msgid "[@var{rewrite-name}] [#:deep? #t] Return a procedure that, when passed a package, replaces its direct and indirect dependencies, including implicit inputs when @var{deep?} is true, according to @var{replacements}. @var{replacements} is a list of package pairs; the first element of each pair is the package to replace, and the second one is the replacement."
13970 #: guix-git/doc/guix.texi:7198
13971 msgid "Optionally, @var{rewrite-name} is a one-argument procedure that takes the name of a package and returns its new name after rewrite."
13975 #: guix-git/doc/guix.texi:7202 guix-git/doc/guix.texi:10528
13976 msgid "Consider this example:"
13980 #: guix-git/doc/guix.texi:7208
13983 "(define libressl-instead-of-openssl\n"
13984 " ;; This is a procedure to replace OPENSSL by LIBRESSL,\n"
13985 " ;; recursively.\n"
13986 " (package-input-rewriting `((,openssl . ,libressl))))\n"
13991 #: guix-git/doc/guix.texi:7211
13994 "(define git-with-libressl\n"
13995 " (libressl-instead-of-openssl git))\n"
13998 #. type: Plain text
13999 #: guix-git/doc/guix.texi:7219
14000 msgid "Here we first define a rewriting procedure that replaces @var{openssl} with @var{libressl}. Then we use it to define a @dfn{variant} of the @var{git} package that uses @var{libressl} instead of @var{openssl}. This is exactly what the @option{--with-input} command-line option does (@pxref{Package Transformation Options, @option{--with-input}})."
14003 #. type: Plain text
14004 #: guix-git/doc/guix.texi:7222
14005 msgid "The following variant of @code{package-input-rewriting} can match packages to be replaced by name rather than by identity."
14009 #: guix-git/doc/guix.texi:7223
14011 msgid "{Scheme Procedure} package-input-rewriting/spec @var{replacements} [#:deep? #t]"
14015 #: guix-git/doc/guix.texi:7230
14016 msgid "Return a procedure that, given a package, applies the given @var{replacements} to all the package graph, including implicit inputs unless @var{deep?} is false. @var{replacements} is a list of spec/procedures pair; each spec is a package specification such as @code{\"gcc\"} or @code{\"guile@@2\"}, and each procedure takes a matching package and returns a replacement for that package."
14019 #. type: Plain text
14020 #: guix-git/doc/guix.texi:7233
14021 msgid "The example above could be rewritten this way:"
14025 #: guix-git/doc/guix.texi:7238
14028 "(define libressl-instead-of-openssl\n"
14029 " ;; Replace all the packages called \"openssl\" with LibreSSL.\n"
14030 " (package-input-rewriting/spec `((\"openssl\" . ,(const libressl)))))\n"
14033 #. type: Plain text
14034 #: guix-git/doc/guix.texi:7243
14035 msgid "The key difference here is that, this time, packages are matched by spec and not by identity. In other words, any package in the graph that is called @code{openssl} will be replaced."
14038 #. type: Plain text
14039 #: guix-git/doc/guix.texi:7247
14040 msgid "A more generic procedure to rewrite a package dependency graph is @code{package-mapping}: it supports arbitrary changes to nodes in the graph."
14044 #: guix-git/doc/guix.texi:7248
14046 msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}] [#:deep? #f]"
14050 #: guix-git/doc/guix.texi:7253
14051 msgid "Return a procedure that, given a package, applies @var{proc} to all the packages depended on and returns the resulting package. The procedure stops recursion when @var{cut?} returns true for a given package. When @var{deep?} is true, @var{proc} is applied to implicit inputs as well."
14055 #: guix-git/doc/guix.texi:7259
14057 msgid "build system"
14060 #. type: Plain text
14061 #: guix-git/doc/guix.texi:7264
14062 msgid "Each package definition specifies a @dfn{build system} and arguments for that build system (@pxref{Defining Packages}). This @code{build-system} field represents the build procedure of the package, as well as implicit dependencies of that build procedure."
14065 #. type: Plain text
14066 #: guix-git/doc/guix.texi:7268
14067 msgid "Build systems are @code{<build-system>} objects. The interface to create and manipulate them is provided by the @code{(guix build-system)} module, and actual build systems are exported by specific modules."
14071 #: guix-git/doc/guix.texi:7269
14073 msgid "bag (low-level package representation)"
14076 #. type: Plain text
14077 #: guix-git/doc/guix.texi:7279
14078 msgid "Under the hood, build systems first compile package objects to @dfn{bags}. A @dfn{bag} is like a package, but with less ornamentation---in other words, a bag is a lower-level representation of a package, which includes all the inputs of that package, including some that were implicitly added by the build system. This intermediate representation is then compiled to a derivation (@pxref{Derivations}). The @code{package-with-c-toolchain} is an example of a way to change the implicit inputs that a package's build system pulls in (@pxref{package Reference, @code{package-with-c-toolchain}})."
14081 #. type: Plain text
14082 #: guix-git/doc/guix.texi:7287
14083 msgid "Build systems accept an optional list of @dfn{arguments}. In package definitions, these are passed @i{via} the @code{arguments} field (@pxref{Defining Packages}). They are typically keyword arguments (@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU Guile Reference Manual}). The value of these arguments is usually evaluated in the @dfn{build stratum}---i.e., by a Guile process launched by the daemon (@pxref{Derivations})."
14086 #. type: Plain text
14087 #: guix-git/doc/guix.texi:7291
14088 msgid "The main build system is @code{gnu-build-system}, which implements the standard build procedure for GNU and many other packages. It is provided by the @code{(guix build-system gnu)} module."
14092 #: guix-git/doc/guix.texi:7292
14094 msgid "{Scheme Variable} gnu-build-system"
14098 #: guix-git/doc/guix.texi:7296
14099 msgid "@code{gnu-build-system} represents the GNU Build System, and variants thereof (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards})."
14103 #: guix-git/doc/guix.texi:7297 guix-git/doc/guix.texi:8223
14104 #: guix-git/doc/guix.texi:8678
14106 msgid "build phases"
14110 #: guix-git/doc/guix.texi:7304
14111 msgid "In a nutshell, packages using it are configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence. In practice, a few additional steps are often needed. All these steps are split up in separate @dfn{phases}. @xref{Build Phases}, for more info on build phases and ways to customize them."
14115 #: guix-git/doc/guix.texi:7311
14116 msgid "In addition, this build system ensures that the ``standard'' environment for GNU packages is available. This includes tools such as GCC, libc, Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix build-system gnu)} module for a complete list). We call these the @dfn{implicit inputs} of a package, because package definitions do not have to mention them."
14120 #: guix-git/doc/guix.texi:7315
14121 msgid "This build system supports a number of keyword arguments, which can be passed @i{via} the @code{arguments} field of a package. Here are some of the main parameters:"
14125 #: guix-git/doc/guix.texi:7317
14131 #: guix-git/doc/guix.texi:7320
14132 msgid "This argument specifies build-side code that evaluates to an alist of build phases. @xref{Build Phases}, for more information."
14136 #: guix-git/doc/guix.texi:7321
14138 msgid "#:configure-flags"
14142 #: guix-git/doc/guix.texi:7324
14143 msgid "This is a list of flags (strings) passed to the @command{configure} script. @xref{Defining Packages}, for an example."
14147 #: guix-git/doc/guix.texi:7325
14149 msgid "#:make-flags"
14153 #: guix-git/doc/guix.texi:7329
14154 msgid "This list of strings contains flags passed as arguments to @command{make} invocations in the @code{build}, @code{check}, and @code{install} phases."
14158 #: guix-git/doc/guix.texi:7330
14160 msgid "#:out-of-source?"
14164 #: guix-git/doc/guix.texi:7333
14165 msgid "This Boolean, @code{#f} by default, indicates whether to run builds in a build directory separate from the source tree."
14169 #: guix-git/doc/guix.texi:7338
14170 msgid "When it is true, the @code{configure} phase creates a separate build directory, changes to that directory, and runs the @code{configure} script from there. This is useful for packages that require it, such as @code{glibc}."
14174 #: guix-git/doc/guix.texi:7339
14180 #: guix-git/doc/guix.texi:7342
14181 msgid "This Boolean, @code{#t} by default, indicates whether the @code{check} phase should run the package's test suite."
14185 #: guix-git/doc/guix.texi:7343
14187 msgid "#:test-target"
14191 #: guix-git/doc/guix.texi:7346
14192 msgid "This string, @code{\"check\"} by default, gives the name of the makefile target used by the @code{check} phase."
14196 #: guix-git/doc/guix.texi:7347
14198 msgid "#:parallel-build?"
14202 #: guix-git/doc/guix.texi:7348
14204 msgid "#:parallel-tests?"
14208 #: guix-git/doc/guix.texi:7355
14209 msgid "These Boolean values specify whether to build, respectively run the test suite, in parallel, with the @code{-j} flag of @command{make}. When they are true, @code{make} is passed @code{-j@var{n}}, where @var{n} is the number specified as the @option{--cores} option of @command{guix-daemon} or that of the @command{guix} client command (@pxref{Common Build Options, @option{--cores}})."
14213 #: guix-git/doc/guix.texi:7356
14215 msgid "RUNPATH, validation"
14219 #: guix-git/doc/guix.texi:7357
14221 msgid "#:validate-runpath?"
14225 #: guix-git/doc/guix.texi:7361
14226 msgid "This Boolean, @code{#t} by default, determines whether to ``validate'' the @code{RUNPATH} of ELF binaries (@code{.so} shared libraries as well as executables) previously installed by the @code{install} phase."
14230 #: guix-git/doc/guix.texi:7369
14231 msgid "This validation step consists in making sure that all the shared libraries needed by an ELF binaries, which are listed as @code{DT_NEEDED} entries in its @code{PT_DYNAMIC} segment, appear in the @code{DT_RUNPATH} entry of that binary. In other words, it ensures that running or using those binaries will not result in a ``file not found'' error at run time. @xref{Options, @option{-rpath},, ld, The GNU Linker}, for more information on @code{RUNPATH}."
14235 #: guix-git/doc/guix.texi:7370
14237 msgid "#:substitutable?"
14241 #: guix-git/doc/guix.texi:7374
14242 msgid "This Boolean, @code{#t} by default, tells whether the package outputs should be substitutable---i.e., whether users should be able to obtain substitutes for them instead of building locally (@pxref{Substitutes})."
14246 #: guix-git/doc/guix.texi:7375
14248 msgid "#:allowed-references"
14252 #: guix-git/doc/guix.texi:7376
14254 msgid "#:disallowed-references"
14258 #: guix-git/doc/guix.texi:7381
14259 msgid "When true, these arguments must be a list of dependencies that must not appear among the references of the build results. If, upon build completion, some of these references are retained, the build process fails."
14263 #: guix-git/doc/guix.texi:7386
14264 msgid "This is useful to ensure that a package does not erroneously keep a reference to some of it build-time inputs, in cases where doing so would, for example, unnecessarily increase its size (@pxref{Invoking guix size})."
14268 #: guix-git/doc/guix.texi:7389
14269 msgid "Most other build systems support these keyword arguments."
14272 #. type: Plain text
14273 #: guix-git/doc/guix.texi:7396
14274 msgid "Other @code{<build-system>} objects are defined to support other conventions and tools used by free software packages. They inherit most of @code{gnu-build-system}, and differ mainly in the set of inputs implicitly added to the build process, and in the list of phases executed. Some of these build systems are listed below."
14278 #: guix-git/doc/guix.texi:7397
14280 msgid "{Scheme Variable} ant-build-system"
14284 #: guix-git/doc/guix.texi:7401
14285 msgid "This variable is exported by @code{(guix build-system ant)}. It implements the build procedure for Java packages that can be built with @url{https://ant.apache.org/, Ant build tool}."
14289 #: guix-git/doc/guix.texi:7406
14290 msgid "It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as provided by the @code{icedtea} package to the set of inputs. Different packages can be specified with the @code{#:ant} and @code{#:jdk} parameters, respectively."
14294 #: guix-git/doc/guix.texi:7412
14295 msgid "When the original package does not provide a suitable Ant build file, the parameter @code{#:jar-name} can be used to generate a minimal Ant build file @file{build.xml} with tasks to build the specified jar archive. In this case the parameter @code{#:source-dir} can be used to specify the source sub-directory, defaulting to ``src''."
14299 #: guix-git/doc/guix.texi:7420
14300 msgid "The @code{#:main-class} parameter can be used with the minimal ant buildfile to specify the main class of the resulting jar. This makes the jar file executable. The @code{#:test-include} parameter can be used to specify the list of junit tests to run. It defaults to @code{(list \"**/*Test.java\")}. The @code{#:test-exclude} can be used to disable some tests. It defaults to @code{(list \"**/Abstract*.java\")}, because abstract classes cannot be run as tests."
14304 #: guix-git/doc/guix.texi:7424
14305 msgid "The parameter @code{#:build-target} can be used to specify the Ant task that should be run during the @code{build} phase. By default the ``jar'' task will be run."
14309 #: guix-git/doc/guix.texi:7427
14311 msgid "{Scheme Variable} android-ndk-build-system"
14315 #: guix-git/doc/guix.texi:7428
14317 msgid "Android distribution"
14321 #: guix-git/doc/guix.texi:7429
14323 msgid "Android NDK build system"
14327 #: guix-git/doc/guix.texi:7433
14328 msgid "This variable is exported by @code{(guix build-system android-ndk)}. It implements a build procedure for Android NDK (native development kit) packages using a Guix-specific build process."
14332 #: guix-git/doc/guix.texi:7437
14333 msgid "The build system assumes that packages install their public interface (header) files to the subdirectory @file{include} of the @code{out} output and their libraries to the subdirectory @file{lib} the @code{out} output."
14337 #: guix-git/doc/guix.texi:7440
14338 msgid "It's also assumed that the union of all the dependencies of a package has no conflicting files."
14342 #: guix-git/doc/guix.texi:7443
14343 msgid "For the time being, cross-compilation is not supported - so right now the libraries and header files are assumed to be host tools."
14347 #: guix-git/doc/guix.texi:7446
14349 msgid "{Scheme Variable} asdf-build-system/source"
14353 #: guix-git/doc/guix.texi:7447
14355 msgid "{Scheme Variable} asdf-build-system/sbcl"
14359 #: guix-git/doc/guix.texi:7448
14361 msgid "{Scheme Variable} asdf-build-system/ecl"
14365 #: guix-git/doc/guix.texi:7454
14366 msgid "These variables, exported by @code{(guix build-system asdf)}, implement build procedures for Common Lisp packages using @url{https://common-lisp.net/project/asdf/, ``ASDF''}. ASDF is a system definition facility for Common Lisp programs and libraries."
14370 #: guix-git/doc/guix.texi:7461
14371 msgid "The @code{asdf-build-system/source} system installs the packages in source form, and can be loaded using any common lisp implementation, via ASDF@. The others, such as @code{asdf-build-system/sbcl}, install binary systems in the format which a particular implementation understands. These build systems can also be used to produce executable programs, or lisp images which contain a set of packages pre-loaded."
14375 #: guix-git/doc/guix.texi:7465
14376 msgid "The build system uses naming conventions. For binary packages, the package name should be prefixed with the lisp implementation, such as @code{sbcl-} for @code{asdf-build-system/sbcl}."
14380 #: guix-git/doc/guix.texi:7469
14381 msgid "Additionally, the corresponding source package should be labeled using the same convention as python packages (see @ref{Python Modules}), using the @code{cl-} prefix."
14385 #: guix-git/doc/guix.texi:7477
14386 msgid "In order to create executable programs and images, the build-side procedures @code{build-program} and @code{build-image} can be used. They should be called in a build phase after the @code{create-asdf-configuration} phase, so that the system which was just built can be used within the resulting image. @code{build-program} requires a list of Common Lisp expressions to be passed as the @code{#:entry-program} argument."
14390 #: guix-git/doc/guix.texi:7486
14391 msgid "By default, all the @file{.asd} files present in the sources are read to find system definitions. The @code{#:asd-files} parameter can be used to specify the list of @file{.asd} files to read. Furthermore, if the package defines a system for its tests in a separate file, it will be loaded before the tests are run if it is specified by the @code{#:test-asd-file} parameter. If it is not set, the files @code{<system>-tests.asd}, @code{<system>-test.asd}, @code{tests.asd}, and @code{test.asd} will be tried if they exist."
14395 #: guix-git/doc/guix.texi:7491
14396 msgid "If for some reason the package must be named in a different way than the naming conventions suggest, or if several systems must be compiled, the @code{#:asd-systems} parameter can be used to specify the list of system names."
14400 #: guix-git/doc/guix.texi:7494
14402 msgid "{Scheme Variable} cargo-build-system"
14406 #: guix-git/doc/guix.texi:7495
14408 msgid "Rust programming language"
14412 #: guix-git/doc/guix.texi:7496
14414 msgid "Cargo (Rust build system)"
14418 #: guix-git/doc/guix.texi:7500
14419 msgid "This variable is exported by @code{(guix build-system cargo)}. It supports builds of packages using Cargo, the build tool of the @uref{https://www.rust-lang.org, Rust programming language}."
14423 #: guix-git/doc/guix.texi:7503
14424 msgid "It adds @code{rustc} and @code{cargo} to the set of inputs. A different Rust package can be specified with the @code{#:rust} parameter."
14428 #: guix-git/doc/guix.texi:7513
14429 msgid "Regular cargo dependencies should be added to the package definition similarly to other packages; those needed only at build time to native-inputs, others to inputs. If you need to add source-only crates then you should add them to via the @code{#:cargo-inputs} parameter as a list of name and spec pairs, where the spec can be a package or a source definition. Note that the spec must evaluate to a path to a gzipped tarball which includes a @code{Cargo.toml} file at its root, or it will be ignored. Similarly, cargo dev-dependencies should be added to the package definition via the @code{#:cargo-development-inputs} parameter."
14433 #: guix-git/doc/guix.texi:7523
14434 msgid "In its @code{configure} phase, this build system will make any source inputs specified in the @code{#:cargo-inputs} and @code{#:cargo-development-inputs} parameters available to cargo. It will also remove an included @code{Cargo.lock} file to be recreated by @code{cargo} during the @code{build} phase. The @code{package} phase will run @code{cargo package} to create a source crate for future use. The @code{install} phase installs the binaries defined by the crate. Unless @code{install-source? #f} is defined it will also install a source crate repository of itself and unpacked sources, to ease in future hacking on rust packages."
14438 #: guix-git/doc/guix.texi:7525
14440 msgid "{Scheme Variable} chicken-build-system"
14444 #: guix-git/doc/guix.texi:7530
14445 msgid "This variable is exported by @code{(guix build-system chicken)}. It builds @uref{https://call-cc.org/, CHICKEN Scheme} modules, also called ``eggs'' or ``extensions''. CHICKEN generates C source code, which then gets compiled by a C compiler, in this case GCC."
14449 #: guix-git/doc/guix.texi:7533
14450 msgid "This build system adds @code{chicken} to the package inputs, as well as the packages of @code{gnu-build-system}."
14454 #: guix-git/doc/guix.texi:7537
14455 msgid "The build system can't (yet) deduce the egg's name automatically, so just like with @code{go-build-system} and its @code{#:import-path}, you should define @code{#:egg-name} in the package's @code{arguments} field."
14459 #: guix-git/doc/guix.texi:7539
14460 msgid "For example, if you are packaging the @code{srfi-1} egg:"
14464 #: guix-git/doc/guix.texi:7542
14466 msgid "(arguments '(#:egg-name \"srfi-1\"))\n"
14470 #: guix-git/doc/guix.texi:7547
14471 msgid "Egg dependencies must be defined in @code{propagated-inputs}, not @code{inputs} because CHICKEN doesn't embed absolute references in compiled eggs. Test dependencies should go to @code{native-inputs}, as usual."
14475 #: guix-git/doc/guix.texi:7549
14477 msgid "{Scheme Variable} copy-build-system"
14481 #: guix-git/doc/guix.texi:7553
14482 msgid "This variable is exported by @code{(guix build-system copy)}. It supports builds of simple packages that don't require much compiling, mostly just moving files around."
14486 #: guix-git/doc/guix.texi:7558
14487 msgid "It adds much of the @code{gnu-build-system} packages to the set of inputs. Because of this, the @code{copy-build-system} does not require all the boilerplate code often needed for the @code{trivial-build-system}."
14491 #: guix-git/doc/guix.texi:7563
14492 msgid "To further simplify the file installation process, an @code{#:install-plan} argument is exposed to let the packager specify which files go where. The install plan is a list of @code{(@var{source} @var{target} [@var{filters}])}. @var{filters} are optional."
14496 #: guix-git/doc/guix.texi:7565
14498 msgid "When @var{source} matches a file or directory without trailing slash, install it to @var{target}."
14502 #: guix-git/doc/guix.texi:7567
14504 msgid "If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}."
14508 #: guix-git/doc/guix.texi:7568
14510 msgid "Otherwise install @var{source} as @var{target}."
14514 #: guix-git/doc/guix.texi:7571
14516 msgid "When @var{source} is a directory with a trailing slash, or when @var{filters} are used,"
14520 #: guix-git/doc/guix.texi:7574
14521 msgid "the trailing slash of @var{target} is implied with the same meaning as above."
14525 #: guix-git/doc/guix.texi:7575
14527 msgid "Without @var{filters}, install the full @var{source} @emph{content} to @var{target}."
14531 #: guix-git/doc/guix.texi:7576
14533 msgid "With @var{filters} among @code{#:include}, @code{#:include-regexp}, @code{#:exclude},"
14537 #: guix-git/doc/guix.texi:7579
14538 msgid "@code{#:exclude-regexp}, only select files are installed depending on the filters. Each filters is specified by a list of strings."
14542 #: guix-git/doc/guix.texi:7580
14544 msgid "With @code{#:include}, install all the files which the path suffix matches"
14548 #: guix-git/doc/guix.texi:7582
14549 msgid "at least one of the elements in the given list."
14553 #: guix-git/doc/guix.texi:7582
14555 msgid "With @code{#:include-regexp}, install all the files which the"
14559 #: guix-git/doc/guix.texi:7585
14560 msgid "subpaths match at least one of the regular expressions in the given list."
14564 #: guix-git/doc/guix.texi:7585
14566 msgid "The @code{#:exclude} and @code{#:exclude-regexp} filters"
14570 #: guix-git/doc/guix.texi:7590
14571 msgid "are the complement of their inclusion counterpart. Without @code{#:include} flags, install all files but those matching the exclusion filters. If both inclusions and exclusions are specified, the exclusions are done on top of the inclusions."
14575 #: guix-git/doc/guix.texi:7594
14576 msgid "In all cases, the paths relative to @var{source} are preserved within @var{target}."
14580 #: guix-git/doc/guix.texi:7597
14585 #: guix-git/doc/guix.texi:7599
14587 msgid "@code{(\"foo/bar\" \"share/my-app/\")}: Install @file{bar} to @file{share/my-app/bar}."
14591 #: guix-git/doc/guix.texi:7600
14593 msgid "@code{(\"foo/bar\" \"share/my-app/baz\")}: Install @file{bar} to @file{share/my-app/baz}."
14597 #: guix-git/doc/guix.texi:7601
14599 msgid "@code{(\"foo/\" \"share/my-app\")}: Install the content of @file{foo} inside @file{share/my-app},"
14603 #: guix-git/doc/guix.texi:7603
14604 msgid "e.g., install @file{foo/sub/file} to @file{share/my-app/sub/file}."
14608 #: guix-git/doc/guix.texi:7603
14610 msgid "@code{(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))}: Install only @file{foo/sub/file} to"
14614 #: guix-git/doc/guix.texi:7605
14615 msgid "@file{share/my-app/sub/file}."
14619 #: guix-git/doc/guix.texi:7605
14621 msgid "@code{(\"foo/sub\" \"share/my-app\" #:include (\"file\"))}: Install @file{foo/sub/file} to"
14625 #: guix-git/doc/guix.texi:7607
14626 msgid "@file{share/my-app/file}."
14630 #: guix-git/doc/guix.texi:7611
14632 msgid "Clojure (programming language)"
14636 #: guix-git/doc/guix.texi:7612
14638 msgid "simple Clojure build system"
14642 #: guix-git/doc/guix.texi:7613
14644 msgid "{Scheme Variable} clojure-build-system"
14648 #: guix-git/doc/guix.texi:7618
14649 msgid "This variable is exported by @code{(guix build-system clojure)}. It implements a simple build procedure for @uref{https://clojure.org/, Clojure} packages using plain old @code{compile} in Clojure. Cross-compilation is not supported yet."
14653 #: guix-git/doc/guix.texi:7622
14654 msgid "It adds @code{clojure}, @code{icedtea} and @code{zip} to the set of inputs. Different packages can be specified with the @code{#:clojure}, @code{#:jdk} and @code{#:zip} parameters, respectively."
14658 #: guix-git/doc/guix.texi:7628
14659 msgid "A list of source directories, test directories and jar names can be specified with the @code{#:source-dirs}, @code{#:test-dirs} and @code{#:jar-names} parameters, respectively. Compile directory and main class can be specified with the @code{#:compile-dir} and @code{#:main-class} parameters, respectively. Other parameters are documented below."
14663 #: guix-git/doc/guix.texi:7631
14664 msgid "This build system is an extension of @code{ant-build-system}, but with the following phases changed:"
14668 #: guix-git/doc/guix.texi:7634 guix-git/doc/guix.texi:8186
14669 #: guix-git/doc/guix.texi:8233 guix-git/doc/guix.texi:8302
14670 #: guix-git/doc/guix.texi:32958
14676 #: guix-git/doc/guix.texi:7643
14677 msgid "This phase calls @code{compile} in Clojure to compile source files and runs @command{jar} to create jars from both source files and compiled files according to the include list and exclude list specified in @code{#:aot-include} and @code{#:aot-exclude}, respectively. The exclude list has priority over the include list. These lists consist of symbols representing Clojure libraries or the special keyword @code{#:all} representing all Clojure libraries found under the source directories. The parameter @code{#:omit-source?} decides if source should be included into the jars."
14681 #: guix-git/doc/guix.texi:7644 guix-git/doc/guix.texi:8190
14682 #: guix-git/doc/guix.texi:8307
14688 #: guix-git/doc/guix.texi:7651
14689 msgid "This phase runs tests according to the include list and exclude list specified in @code{#:test-include} and @code{#:test-exclude}, respectively. Their meanings are analogous to that of @code{#:aot-include} and @code{#:aot-exclude}, except that the special keyword @code{#:all} now stands for all Clojure libraries found under the test directories. The parameter @code{#:tests?} decides if tests should be run."
14693 #: guix-git/doc/guix.texi:7652 guix-git/doc/guix.texi:8194
14694 #: guix-git/doc/guix.texi:8237 guix-git/doc/guix.texi:8313
14700 #: guix-git/doc/guix.texi:7654
14701 msgid "This phase installs all jars built previously."
14705 #: guix-git/doc/guix.texi:7657
14706 msgid "Apart from the above, this build system also contains an additional phase:"
14710 #: guix-git/doc/guix.texi:7660
14712 msgid "install-doc"
14716 #: guix-git/doc/guix.texi:7665
14717 msgid "This phase installs all top-level files with base name matching @code{%doc-regex}. A different regex can be specified with the @code{#:doc-regex} parameter. All files (recursively) inside the documentation directories specified in @code{#:doc-dirs} are installed as well."
14721 #: guix-git/doc/guix.texi:7668
14723 msgid "{Scheme Variable} cmake-build-system"
14727 #: guix-git/doc/guix.texi:7672
14728 msgid "This variable is exported by @code{(guix build-system cmake)}. It implements the build procedure for packages using the @url{https://www.cmake.org, CMake build tool}."
14732 #: guix-git/doc/guix.texi:7676
14733 msgid "It automatically adds the @code{cmake} package to the set of inputs. Which package is used can be specified with the @code{#:cmake} parameter."
14737 #: guix-git/doc/guix.texi:7683
14738 msgid "The @code{#:configure-flags} parameter is taken as a list of flags passed to the @command{cmake} command. The @code{#:build-type} parameter specifies in abstract terms the flags passed to the compiler; it defaults to @code{\"RelWithDebInfo\"} (short for ``release mode with debugging information''), which roughly means that code is compiled with @code{-O2 -g}, as is the case for Autoconf-based packages by default."
14742 #: guix-git/doc/guix.texi:7685
14744 msgid "{Scheme Variable} dune-build-system"
14748 #: guix-git/doc/guix.texi:7692
14749 msgid "This variable is exported by @code{(guix build-system dune)}. It supports builds of packages using @uref{https://dune.build/, Dune}, a build tool for the OCaml programming language. It is implemented as an extension of the @code{ocaml-build-system} which is described below. As such, the @code{#:ocaml} and @code{#:findlib} parameters can be passed to this build system."
14753 #: guix-git/doc/guix.texi:7696
14754 msgid "It automatically adds the @code{dune} package to the set of inputs. Which package is used can be specified with the @code{#:dune} parameter."
14758 #: guix-git/doc/guix.texi:7700
14759 msgid "There is no @code{configure} phase because dune packages typically don't need to be configured. The @code{#:build-flags} parameter is taken as a list of flags passed to the @code{dune} command during the build."
14763 #: guix-git/doc/guix.texi:7704
14764 msgid "The @code{#:jbuild?} parameter can be passed to use the @code{jbuild} command instead of the more recent @code{dune} command while building a package. Its default value is @code{#f}."
14768 #: guix-git/doc/guix.texi:7709
14769 msgid "The @code{#:package} parameter can be passed to specify a package name, which is useful when a package contains multiple packages and you want to build only one of them. This is equivalent to passing the @code{-p} argument to @code{dune}."
14773 #: guix-git/doc/guix.texi:7711
14775 msgid "{Scheme Variable} go-build-system"
14779 #: guix-git/doc/guix.texi:7716
14780 msgid "This variable is exported by @code{(guix build-system go)}. It implements a build procedure for Go packages using the standard @url{https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies, Go build mechanisms}."
14784 #: guix-git/doc/guix.texi:7727
14785 msgid "The user is expected to provide a value for the key @code{#:import-path} and, in some cases, @code{#:unpack-path}. The @url{https://golang.org/doc/code.html#ImportPaths, import path} corresponds to the file system path expected by the package's build scripts and any referring packages, and provides a unique way to refer to a Go package. It is typically based on a combination of the package source code's remote URI and file system hierarchy structure. In some cases, you will need to unpack the package's source code to a different directory structure than the one indicated by the import path, and @code{#:unpack-path} should be used in such cases."
14789 #: guix-git/doc/guix.texi:7732
14790 msgid "Packages that provide Go libraries should install their source code into the built output. The key @code{#:install-source?}, which defaults to @code{#t}, controls whether or not the source code is installed. It can be set to @code{#f} for packages that only provide executable files."
14794 #: guix-git/doc/guix.texi:7734
14796 msgid "{Scheme Variable} glib-or-gtk-build-system"
14800 #: guix-git/doc/guix.texi:7737
14801 msgid "This variable is exported by @code{(guix build-system glib-or-gtk)}. It is intended for use with packages making use of GLib or GTK+."
14805 #: guix-git/doc/guix.texi:7740
14806 msgid "This build system adds the following two phases to the ones defined by @code{gnu-build-system}:"
14810 #: guix-git/doc/guix.texi:7742 guix-git/doc/guix.texi:8210
14812 msgid "glib-or-gtk-wrap"
14816 #: guix-git/doc/guix.texi:7749
14817 msgid "The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are able to find GLib ``schemas'' and @uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ modules}. This is achieved by wrapping the programs in launch scripts that appropriately set the @env{XDG_DATA_DIRS} and @env{GTK_PATH} environment variables."
14821 #: guix-git/doc/guix.texi:7756
14822 msgid "It is possible to exclude specific package outputs from that wrapping process by listing their names in the @code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful when an output is known not to contain any GLib or GTK+ binaries, and where wrapping would gratuitously add a dependency of that output on GLib and GTK+."
14826 #: guix-git/doc/guix.texi:7757 guix-git/doc/guix.texi:8214
14828 msgid "glib-or-gtk-compile-schemas"
14832 #: guix-git/doc/guix.texi:7765
14833 msgid "The phase @code{glib-or-gtk-compile-schemas} makes sure that all @uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, GSettings schemas} of GLib are compiled. Compilation is performed by the @command{glib-compile-schemas} program. It is provided by the package @code{glib:bin} which is automatically imported by the build system. The @code{glib} package providing @command{glib-compile-schemas} can be specified with the @code{#:glib} parameter."
14837 #: guix-git/doc/guix.texi:7768
14838 msgid "Both phases are executed after the @code{install} phase."
14842 #: guix-git/doc/guix.texi:7770
14844 msgid "{Scheme Variable} guile-build-system"
14848 #: guix-git/doc/guix.texi:7777
14849 msgid "This build system is for Guile packages that consist exclusively of Scheme code and that are so lean that they don't even have a makefile, let alone a @file{configure} script. It compiles Scheme code using @command{guild compile} (@pxref{Compilation,,, guile, GNU Guile Reference Manual}) and installs the @file{.scm} and @file{.go} files in the right place. It also installs documentation."
14853 #: guix-git/doc/guix.texi:7780
14854 msgid "This build system supports cross-compilation by using the @option{--target} option of @samp{guild compile}."
14858 #: guix-git/doc/guix.texi:7783
14859 msgid "Packages built with @code{guile-build-system} must provide a Guile package in their @code{native-inputs} field."
14863 #: guix-git/doc/guix.texi:7785
14865 msgid "{Scheme Variable} julia-build-system"
14869 #: guix-git/doc/guix.texi:7792
14870 msgid "This variable is exported by @code{(guix build-system julia)}. It implements the build procedure used by @uref{https://julialang.org/, julia} packages, which essentially is similar to running @samp{julia -e 'using Pkg; Pkg.add(package)'} in an environment where @env{JULIA_LOAD_PATH} contains the paths to all Julia package inputs. Tests are run by calling @code{/test/runtests.jl}."
14874 #: guix-git/doc/guix.texi:7796
14875 msgid "The Julia package name is read from the file @file{Project.toml}. This value can be overridden by passing the argument @code{#:julia-package-name} (which must be correctly capitalized)."
14879 #: guix-git/doc/guix.texi:7800
14880 msgid "Julia packages usually manage their binary dependencies via @code{JLLWrappers.jl}, a Julia package that creates a module (named after the wrapped library followed by @code{_jll.jl}."
14884 #: guix-git/doc/guix.texi:7805
14885 msgid "To add the binary path @code{_jll.jl} packages, you need to patch the files under @file{src/wrappers/}, replacing the call to the macro @code{JLLWrappers.@@generate_wrapper_header}, adding as a second argument containing the store path the binary."
14889 #: guix-git/doc/guix.texi:7809
14890 msgid "As an example, in the MbedTLS Julia package, we add a build phase (@pxref{Build Phases}) to insert the absolute file name of the wrapped MbedTLS package:"
14894 #: guix-git/doc/guix.texi:7821
14897 "(add-after 'unpack 'override-binary-path\n"
14898 " (lambda* (#:key inputs #:allow-other-keys)\n"
14899 " (for-each (lambda (wrapper)\n"
14900 " (substitute* wrapper\n"
14901 " ((\"generate_wrapper_header.*\")\n"
14902 " (string-append\n"
14903 " \"generate_wrapper_header(\\\"MbedTLS\\\", \\\"\"\n"
14904 " (assoc-ref inputs \"mbedtls-apache\") \"\\\")\\n\"))))\n"
14905 " ;; There's a Julia file for each platform, override them all.\n"
14906 " (find-files \"src/wrappers/\" \"\\\\.jl$\"))))\n"
14910 #: guix-git/doc/guix.texi:7829
14911 msgid "Some older packages that aren't using @file{Package.toml} yet, will require this file to be created, too. The function @code{julia-create-package-toml} helps creating the file. You need to pass the outputs and the source of the package, it's name (the same as the @code{file-name} parameter), the package uuid, the package version, and a list of dependencies specified by their name and their uuid."
14915 #: guix-git/doc/guix.texi:7831
14917 msgid "{Scheme Variable} maven-build-system"
14921 #: guix-git/doc/guix.texi:7838
14922 msgid "This variable is exported by @code{(guix build-system maven)}. It implements a build procedure for @uref{https://maven.apache.org, Maven} packages. Maven is a dependency and lifecycle management tool for Java. A user of Maven specifies dependencies and plugins in a @file{pom.xml} file that Maven reads. When Maven does not have one of the dependencies or plugins in its repository, it will download them and use them to build the package."
14926 #: guix-git/doc/guix.texi:7848
14927 msgid "The maven build system ensures that maven will not try to download any dependency by running in offline mode. Maven will fail if a dependency is missing. Before running Maven, the @file{pom.xml} (and subprojects) are modified to specify the version of dependencies and plugins that match the versions available in the guix build environment. Dependencies and plugins must be installed in the fake maven repository at @file{lib/m2}, and are symlinked into a proper repository before maven is run. Maven is instructed to use that repository for the build and installs built artifacts there. Changed files are copied to the @file{lib/m2} directory of the package output."
14931 #: guix-git/doc/guix.texi:7851
14932 msgid "You can specify a @file{pom.xml} file with the @code{#:pom-file} argument, or let the build system use the default @file{pom.xml} file in the sources."
14936 #: guix-git/doc/guix.texi:7857
14937 msgid "In case you need to specify a dependency's version manually, you can use the @code{#:local-packages} argument. It takes an association list where the key is the groupId of the package and its value is an association list where the key is the artifactId of the package and its value is the version you want to override in the @file{pom.xml}."
14941 #: guix-git/doc/guix.texi:7863
14942 msgid "Some packages use dependencies or plugins that are not useful at runtime nor at build time in Guix. You can alter the @file{pom.xml} file to remove them using the @code{#:exclude} argument. Its value is an association list where the key is the groupId of the plugin or dependency you want to remove, and the value is a list of artifactId you want to remove."
14946 #: guix-git/doc/guix.texi:7866
14947 msgid "You can override the default @code{jdk} and @code{maven} packages with the corresponding argument, @code{#:jdk} and @code{#:maven}."
14951 #: guix-git/doc/guix.texi:7871
14952 msgid "The @code{#:maven-plugins} argument is a list of maven plugins used during the build, with the same format as the @code{inputs} fields of the package declaration. Its default value is @code{(default-maven-plugins)} which is also exported."
14956 #: guix-git/doc/guix.texi:7873
14958 msgid "{Scheme Variable} minify-build-system"
14962 #: guix-git/doc/guix.texi:7876
14963 msgid "This variable is exported by @code{(guix build-system minify)}. It implements a minification procedure for simple JavaScript packages."
14967 #: guix-git/doc/guix.texi:7882
14968 msgid "It adds @code{uglify-js} to the set of inputs and uses it to compress all JavaScript files in the @file{src} directory. A different minifier package can be specified with the @code{#:uglify-js} parameter, but it is expected that the package writes the minified code to the standard output."
14972 #: guix-git/doc/guix.texi:7886
14973 msgid "When the input JavaScript files are not all located in the @file{src} directory, the parameter @code{#:javascript-files} can be used to specify a list of file names to feed to the minifier."
14977 #: guix-git/doc/guix.texi:7888
14979 msgid "{Scheme Variable} ocaml-build-system"
14983 #: guix-git/doc/guix.texi:7894
14984 msgid "This variable is exported by @code{(guix build-system ocaml)}. It implements a build procedure for @uref{https://ocaml.org, OCaml} packages, which consists of choosing the correct set of commands to run for each package. OCaml packages can expect many different commands to be run. This build system will try some of them."
14988 #: guix-git/doc/guix.texi:7904
14989 msgid "When the package has a @file{setup.ml} file present at the top-level, it will run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and @code{ocaml setup.ml -install}. The build system will assume that this file was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will take care of setting the prefix and enabling tests if they are not disabled. You can pass configure and build flags with the @code{#:configure-flags} and @code{#:build-flags}. The @code{#:test-flags} key can be passed to change the set of flags used to enable tests. The @code{#:use-make?} key can be used to bypass this system in the build and install phases."
14993 #: guix-git/doc/guix.texi:7909
14994 msgid "When the package has a @file{configure} file, it is assumed that it is a hand-made configure script that requires a different argument format than in the @code{gnu-build-system}. You can add more flags with the @code{#:configure-flags} key."
14998 #: guix-git/doc/guix.texi:7913
14999 msgid "When the package has a @file{Makefile} file (or @code{#:use-make?} is @code{#t}), it will be used and more flags can be passed to the build and install phases with the @code{#:make-flags} key."
15003 #: guix-git/doc/guix.texi:7921
15004 msgid "Finally, some packages do not have these files and use a somewhat standard location for its build system. In that case, the build system will run @code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of providing the path to the required findlib module. Additional flags can be passed via the @code{#:build-flags} key. Install is taken care of by @command{opam-installer}. In this case, the @code{opam} package must be added to the @code{native-inputs} field of the package definition."
15008 #: guix-git/doc/guix.texi:7929
15009 msgid "Note that most OCaml packages assume they will be installed in the same directory as OCaml, which is not what we want in guix. In particular, they will install @file{.so} files in their module's directory, which is usually fine because it is in the OCaml compiler directory. In guix though, these libraries cannot be found and we use @env{CAML_LD_LIBRARY_PATH}. This variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where @file{.so} libraries should be installed."
15013 #: guix-git/doc/guix.texi:7931
15015 msgid "{Scheme Variable} python-build-system"
15019 #: guix-git/doc/guix.texi:7936
15020 msgid "This variable is exported by @code{(guix build-system python)}. It implements the more or less standard build procedure used by Python packages, which consists in running @code{python setup.py build} and then @code{python setup.py install --prefix=/gnu/store/@dots{}}."
15024 #: guix-git/doc/guix.texi:7940
15025 msgid "For packages that install stand-alone Python programs under @code{bin/}, it takes care of wrapping these programs so that their @env{PYTHONPATH} environment variable points to all the Python libraries they depend on."
15029 #: guix-git/doc/guix.texi:7946
15030 msgid "Which Python package is used to perform the build can be specified with the @code{#:python} parameter. This is a useful way to force a package to be built for a specific version of the Python interpreter, which might be necessary if the package is only compatible with a single interpreter version."
15034 #: guix-git/doc/guix.texi:7951
15035 msgid "By default guix calls @code{setup.py} under control of @code{setuptools}, much like @command{pip} does. Some packages are not compatible with setuptools (and pip), thus you can disable this by setting the @code{#:use-setuptools?} parameter to @code{#f}."
15039 #: guix-git/doc/guix.texi:7953
15041 msgid "{Scheme Variable} perl-build-system"
15045 #: guix-git/doc/guix.texi:7965
15046 msgid "This variable is exported by @code{(guix build-system perl)}. It implements the standard build procedure for Perl packages, which either consists in running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, followed by @code{Build} and @code{Build install}; or in running @code{perl Makefile.PL PREFIX=/gnu/store/@dots{}}, followed by @code{make} and @code{make install}, depending on which of @code{Build.PL} or @code{Makefile.PL} is present in the package distribution. Preference is given to the former if both @code{Build.PL} and @code{Makefile.PL} exist in the package distribution. This preference can be reversed by specifying @code{#t} for the @code{#:make-maker?} parameter."
15050 #: guix-git/doc/guix.texi:7969
15051 msgid "The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation passes flags specified by the @code{#:make-maker-flags} or @code{#:module-build-flags} parameter, respectively."
15055 #: guix-git/doc/guix.texi:7971
15056 msgid "Which Perl package is used can be specified with @code{#:perl}."
15060 #: guix-git/doc/guix.texi:7973
15062 msgid "{Scheme Variable} renpy-build-system"
15066 #: guix-git/doc/guix.texi:7977
15067 msgid "This variable is exported by @code{(guix build-system renpy)}. It implements the more or less standard build procedure used by Ren'py games, which consists of loading @code{#:game} once, thereby creating bytecode for it."
15071 #: guix-git/doc/guix.texi:7980
15072 msgid "It further creates a wrapper script in @code{bin/} and a desktop entry in @code{share/applications}, both of which can be used to launch the game."
15076 #: guix-git/doc/guix.texi:7984
15077 msgid "Which Ren'py package is used can be specified with @code{#:renpy}. Games can also be installed in outputs other than ``out'' by using @code{#:output}."
15081 #: guix-git/doc/guix.texi:7986
15083 msgid "{Scheme Variable} qt-build-system"
15087 #: guix-git/doc/guix.texi:7989
15088 msgid "This variable is exported by @code{(guix build-system qt)}. It is intended for use with applications using Qt or KDE."
15092 #: guix-git/doc/guix.texi:7992
15093 msgid "This build system adds the following two phases to the ones defined by @code{cmake-build-system}:"
15097 #: guix-git/doc/guix.texi:7994
15099 msgid "check-setup"
15103 #: guix-git/doc/guix.texi:8001
15104 msgid "The phase @code{check-setup} prepares the environment for running the checks as commonly used by Qt test programs. For now this only sets some environment variables: @code{QT_QPA_PLATFORM=offscreen}, @code{DBUS_FATAL_WARNINGS=0} and @code{CTEST_OUTPUT_ON_FAILURE=1}."
15108 #: guix-git/doc/guix.texi:8004
15109 msgid "This phase is added before the @code{check} phase. It's a separate phase to ease adjusting if necessary."
15113 #: guix-git/doc/guix.texi:8005
15119 #: guix-git/doc/guix.texi:8011
15120 msgid "The phase @code{qt-wrap} searches for Qt5 plugin paths, QML paths and some XDG in the inputs and output. In case some path is found, all programs in the output's @file{bin/}, @file{sbin/}, @file{libexec/} and @file{lib/libexec/} directories are wrapped in scripts defining the necessary environment variables."
15124 #: guix-git/doc/guix.texi:8017
15125 msgid "It is possible to exclude specific package outputs from that wrapping process by listing their names in the @code{#:qt-wrap-excluded-outputs} parameter. This is useful when an output is known not to contain any Qt binaries, and where wrapping would gratuitously add a dependency of that output on Qt, KDE, or such."
15129 #: guix-git/doc/guix.texi:8019
15130 msgid "This phase is added after the @code{install} phase."
15134 #: guix-git/doc/guix.texi:8022
15136 msgid "{Scheme Variable} r-build-system"
15140 #: guix-git/doc/guix.texi:8030
15141 msgid "This variable is exported by @code{(guix build-system r)}. It implements the build procedure used by @uref{https://r-project.org, R} packages, which essentially is little more than running @samp{R CMD INSTALL --library=/gnu/store/@dots{}} in an environment where @env{R_LIBS_SITE} contains the paths to all R package inputs. Tests are run after installation using the R function @code{tools::testInstalledPackage}."
15145 #: guix-git/doc/guix.texi:8032
15147 msgid "{Scheme Variable} rakudo-build-system"
15151 #: guix-git/doc/guix.texi:8040
15152 msgid "This variable is exported by @code{(guix build-system rakudo)}. It implements the build procedure used by @uref{https://rakudo.org/, Rakudo} for @uref{https://perl6.org/, Perl6} packages. It installs the package to @code{/gnu/store/@dots{}/NAME-VERSION/share/perl6} and installs the binaries, library files and the resources, as well as wrap the files under the @code{bin/} directory. Tests can be skipped by passing @code{#f} to the @code{tests?} parameter."
15156 #: guix-git/doc/guix.texi:8048
15157 msgid "Which rakudo package is used can be specified with @code{rakudo}. Which perl6-tap-harness package used for the tests can be specified with @code{#:prove6} or removed by passing @code{#f} to the @code{with-prove6?} parameter. Which perl6-zef package used for tests and installing can be specified with @code{#:zef} or removed by passing @code{#f} to the @code{with-zef?} parameter."
15161 #: guix-git/doc/guix.texi:8050
15163 msgid "{Scheme Variable} texlive-build-system"
15167 #: guix-git/doc/guix.texi:8055
15168 msgid "This variable is exported by @code{(guix build-system texlive)}. It is used to build TeX packages in batch mode with a specified engine. The build system sets the @env{TEXINPUTS} variable to find all TeX source files in the inputs."
15172 #: guix-git/doc/guix.texi:8064
15173 msgid "By default it runs @code{luatex} on all files ending on @code{ins}. A different engine and format can be specified with the @code{#:tex-format} argument. Different build targets can be specified with the @code{#:build-targets} argument, which expects a list of file names. The build system adds only @code{texlive-bin} and @code{texlive-latex-base} (both from @code{(gnu packages tex}) to the inputs. Both can be overridden with the arguments @code{#:texlive-bin} and @code{#:texlive-latex-base}, respectively."
15177 #: guix-git/doc/guix.texi:8067
15178 msgid "The @code{#:tex-directory} parameter tells the build system where to install the built files under the texmf tree."
15182 #: guix-git/doc/guix.texi:8069
15184 msgid "{Scheme Variable} ruby-build-system"
15188 #: guix-git/doc/guix.texi:8073
15189 msgid "This variable is exported by @code{(guix build-system ruby)}. It implements the RubyGems build procedure used by Ruby packages, which involves running @code{gem build} followed by @code{gem install}."
15193 #: guix-git/doc/guix.texi:8081
15194 msgid "The @code{source} field of a package that uses this build system typically references a gem archive, since this is the format that Ruby developers use when releasing their software. The build system unpacks the gem archive, potentially patches the source, runs the test suite, repackages the gem, and installs it. Additionally, directories and tarballs may be referenced to allow building unreleased gems from Git or a traditional source release tarball."
15198 #: guix-git/doc/guix.texi:8085
15199 msgid "Which Ruby package is used can be specified with the @code{#:ruby} parameter. A list of additional flags to be passed to the @command{gem} command can be specified with the @code{#:gem-flags} parameter."
15203 #: guix-git/doc/guix.texi:8087
15205 msgid "{Scheme Variable} waf-build-system"
15209 #: guix-git/doc/guix.texi:8093
15210 msgid "This variable is exported by @code{(guix build-system waf)}. It implements a build procedure around the @code{waf} script. The common phases---@code{configure}, @code{build}, and @code{install}---are implemented by passing their names as arguments to the @code{waf} script."
15214 #: guix-git/doc/guix.texi:8097
15215 msgid "The @code{waf} script is executed by the Python interpreter. Which Python package is used to run the script can be specified with the @code{#:python} parameter."
15219 #: guix-git/doc/guix.texi:8099
15221 msgid "{Scheme Variable} scons-build-system"
15225 #: guix-git/doc/guix.texi:8105
15226 msgid "This variable is exported by @code{(guix build-system scons)}. It implements the build procedure used by the SCons software construction tool. This build system runs @code{scons} to build the package, @code{scons test} to run tests, and then @code{scons install} to install the package."
15230 #: guix-git/doc/guix.texi:8112
15231 msgid "Additional flags to be passed to @code{scons} can be specified with the @code{#:scons-flags} parameter. The default build and install targets can be overridden with @code{#:build-targets} and @code{#:install-targets} respectively. The version of Python used to run SCons can be specified by selecting the appropriate SCons package with the @code{#:scons} parameter."
15235 #: guix-git/doc/guix.texi:8114
15237 msgid "{Scheme Variable} haskell-build-system"
15241 #: guix-git/doc/guix.texi:8128
15242 msgid "This variable is exported by @code{(guix build-system haskell)}. It implements the Cabal build procedure used by Haskell packages, which involves running @code{runhaskell Setup.hs configure --prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. Instead of installing the package by running @code{runhaskell Setup.hs install}, to avoid trying to register libraries in the read-only compiler store directory, the build system uses @code{runhaskell Setup.hs copy}, followed by @code{runhaskell Setup.hs register}. In addition, the build system generates the package documentation by running @code{runhaskell Setup.hs haddock}, unless @code{#:haddock? #f} is passed. Optional Haddock parameters can be passed with the help of the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} is not found, the build system looks for @code{Setup.lhs} instead."
15246 #: guix-git/doc/guix.texi:8131
15247 msgid "Which Haskell compiler is used can be specified with the @code{#:haskell} parameter which defaults to @code{ghc}."
15251 #: guix-git/doc/guix.texi:8133
15253 msgid "{Scheme Variable} dub-build-system"
15257 #: guix-git/doc/guix.texi:8138
15258 msgid "This variable is exported by @code{(guix build-system dub)}. It implements the Dub build procedure used by D packages, which involves running @code{dub build} and @code{dub run}. Installation is done by copying the files manually."
15262 #: guix-git/doc/guix.texi:8141
15263 msgid "Which D compiler is used can be specified with the @code{#:ldc} parameter which defaults to @code{ldc}."
15266 #. type: anchor{#1}
15267 #: guix-git/doc/guix.texi:8144
15268 msgid "emacs-build-system"
15272 #: guix-git/doc/guix.texi:8144
15274 msgid "{Scheme Variable} emacs-build-system"
15278 #: guix-git/doc/guix.texi:8148
15279 msgid "This variable is exported by @code{(guix build-system emacs)}. It implements an installation procedure similar to the packaging system of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
15283 #: guix-git/doc/guix.texi:8154
15284 msgid "It first creates the @code{@code{package}-autoloads.el} file, then it byte compiles all Emacs Lisp files. Differently from the Emacs packaging system, the Info documentation files are moved to the standard documentation directory and the @file{dir} file is deleted. The Elisp package files are installed directly under @file{share/emacs/site-lisp}."
15288 #: guix-git/doc/guix.texi:8156
15290 msgid "{Scheme Variable} font-build-system"
15294 #: guix-git/doc/guix.texi:8162
15295 msgid "This variable is exported by @code{(guix build-system font)}. It implements an installation procedure for font packages where upstream provides pre-compiled TrueType, OpenType, etc.@: font files that merely need to be copied into place. It copies font files to standard locations in the output directory."
15299 #: guix-git/doc/guix.texi:8164
15301 msgid "{Scheme Variable} meson-build-system"
15305 #: guix-git/doc/guix.texi:8168
15306 msgid "This variable is exported by @code{(guix build-system meson)}. It implements the build procedure for packages that use @url{https://mesonbuild.com, Meson} as their build system."
15310 #: guix-git/doc/guix.texi:8174
15311 msgid "It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set of inputs, and they can be changed with the parameters @code{#:meson} and @code{#:ninja} if needed. The default Meson is @code{meson-for-build}, which is special because it doesn't clear the @code{RUNPATH} of binaries and libraries when they are installed."
15315 #: guix-git/doc/guix.texi:8177
15316 msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed to some specific for Meson:"
15320 #: guix-git/doc/guix.texi:8180 guix-git/doc/guix.texi:8229
15321 #: guix-git/doc/guix.texi:8297
15327 #: guix-git/doc/guix.texi:8185
15328 msgid "The phase runs @code{meson} with the flags specified in @code{#:configure-flags}. The flag @option{--buildtype} is always set to @code{debugoptimized} unless something else is specified in @code{#:build-type}."
15332 #: guix-git/doc/guix.texi:8189
15333 msgid "The phase runs @code{ninja} to build the package in parallel by default, but this can be changed with @code{#:parallel-build?}."
15337 #: guix-git/doc/guix.texi:8193
15338 msgid "The phase runs @code{ninja} with the target specified in @code{#:test-target}, which is @code{\"test\"} by default."
15342 #: guix-git/doc/guix.texi:8196
15343 msgid "The phase runs @code{ninja install} and can not be changed."
15347 #: guix-git/doc/guix.texi:8199
15348 msgid "Apart from that, the build system also adds the following phases:"
15352 #: guix-git/doc/guix.texi:8202
15354 msgid "fix-runpath"
15358 #: guix-git/doc/guix.texi:8209
15359 msgid "This phase ensures that all binaries can find the libraries they need. It searches for required libraries in subdirectories of the package being built, and adds those to @code{RUNPATH} where needed. It also removes references to libraries left over from the build phase by @code{meson-for-build}, such as test dependencies, that aren't actually required for the program to run."
15363 #: guix-git/doc/guix.texi:8213 guix-git/doc/guix.texi:8217
15364 msgid "This phase is the phase provided by @code{glib-or-gtk-build-system}, and it is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}."
15368 #: guix-git/doc/guix.texi:8220
15370 msgid "{Scheme Variable} linux-module-build-system"
15374 #: guix-git/doc/guix.texi:8222
15375 msgid "@code{linux-module-build-system} allows building Linux kernel modules."
15379 #: guix-git/doc/guix.texi:8226
15380 msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed:"
15384 #: guix-git/doc/guix.texi:8232
15385 msgid "This phase configures the environment so that the Linux kernel's Makefile can be used to build the external kernel module."
15389 #: guix-git/doc/guix.texi:8236
15390 msgid "This phase uses the Linux kernel's Makefile in order to build the external kernel module."
15394 #: guix-git/doc/guix.texi:8240
15395 msgid "This phase uses the Linux kernel's Makefile in order to install the external kernel module."
15399 #: guix-git/doc/guix.texi:8245
15400 msgid "It is possible and useful to specify the Linux kernel to use for building the module (in the @code{arguments} form of a package using the @code{linux-module-build-system}, use the key @code{#:linux} to specify it)."
15404 #: guix-git/doc/guix.texi:8247
15406 msgid "{Scheme Variable} node-build-system"
15410 #: guix-git/doc/guix.texi:8252
15411 msgid "This variable is exported by @code{(guix build-system node)}. It implements the build procedure used by @uref{https://nodejs.org, Node.js}, which implements an approximation of the @code{npm install} command, followed by an @code{npm test} command."
15415 #: guix-git/doc/guix.texi:8256
15416 msgid "Which Node.js package is used to interpret the @code{npm} commands can be specified with the @code{#:node} parameter which defaults to @code{node}."
15419 #. type: Plain text
15420 #: guix-git/doc/guix.texi:8262
15421 msgid "Lastly, for packages that do not need anything as sophisticated, a ``trivial'' build system is provided. It is trivial in the sense that it provides basically no support: it does not pull any implicit inputs, and does not have a notion of build phases."
15425 #: guix-git/doc/guix.texi:8263
15427 msgid "{Scheme Variable} trivial-build-system"
15431 #: guix-git/doc/guix.texi:8265
15432 msgid "This variable is exported by @code{(guix build-system trivial)}."
15436 #: guix-git/doc/guix.texi:8270
15437 msgid "This build system requires a @code{#:builder} argument. This argument must be a Scheme expression that builds the package output(s)---as with @code{build-expression->derivation} (@pxref{Derivations, @code{build-expression->derivation}})."
15441 #: guix-git/doc/guix.texi:8275
15443 msgid "build phases, for packages"
15446 #. type: Plain text
15447 #: guix-git/doc/guix.texi:8281
15448 msgid "Almost all package build systems implement a notion @dfn{build phases}: a sequence of actions that the build system executes, when you build the package, leading to the installed byproducts in the store. A notable exception is the ``bare-bones'' @code{trivial-build-system} (@pxref{Build Systems})."
15451 #. type: Plain text
15452 #: guix-git/doc/guix.texi:8285
15453 msgid "As discussed in the previous section, those build systems provide a standard list of phases. For @code{gnu-build-system}, the main build phases are the following:"
15457 #: guix-git/doc/guix.texi:8287
15463 #: guix-git/doc/guix.texi:8291
15464 msgid "Unpack the source tarball, and change the current directory to the extracted source tree. If the source is actually a directory, copy it to the build tree, and enter that directory."
15468 #: guix-git/doc/guix.texi:8292
15470 msgid "patch-source-shebangs"
15474 #: guix-git/doc/guix.texi:8296
15475 msgid "Patch shebangs encountered in source files so they refer to the right store file names. For instance, this changes @code{#!/bin/sh} to @code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}."
15479 #: guix-git/doc/guix.texi:8301
15480 msgid "Run the @file{configure} script with a number of default options, such as @option{--prefix=/gnu/store/@dots{}}, as well as the options specified by the @code{#:configure-flags} argument."
15484 #: guix-git/doc/guix.texi:8306
15485 msgid "Run @code{make} with the list of flags specified with @code{#:make-flags}. If the @code{#:parallel-build?} argument is true (the default), build with @code{make -j}."
15489 #: guix-git/doc/guix.texi:8312
15490 msgid "Run @code{make check}, or some other target specified with @code{#:test-target}, unless @code{#:tests? #f} is passed. If the @code{#:parallel-tests?} argument is true (the default), run @code{make check -j}."
15494 #: guix-git/doc/guix.texi:8315
15495 msgid "Run @code{make install} with the flags listed in @code{#:make-flags}."
15499 #: guix-git/doc/guix.texi:8316
15501 msgid "patch-shebangs"
15505 #: guix-git/doc/guix.texi:8318
15506 msgid "Patch shebangs on the installed executable files."
15510 #: guix-git/doc/guix.texi:8319
15516 #: guix-git/doc/guix.texi:8323
15517 msgid "Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} is false), copying them to the @code{debug} output when available (@pxref{Installing Debugging Files})."
15520 #. type: Plain text
15521 #: guix-git/doc/guix.texi:8332
15522 msgid "Other build systems have similar phases, with some variations. For example, @code{cmake-build-system} has same-named phases but its @code{configure} phases runs @code{cmake} instead of @code{./configure}. Others, such as @code{python-build-system}, have a wholly different list of standard phases. All this code runs on the @dfn{build side}: it is evaluated when you actually build the package, in a dedicated build process spawned by the build daemon (@pxref{Invoking guix-daemon})."
15525 #. type: Plain text
15526 #: guix-git/doc/guix.texi:8339
15527 msgid "Build phases are represented as association lists or ``alists'' (@pxref{Association Lists,,, guile, GNU Guile Reference Manual}) where each key is a symbol for the name of the phase and the associated value is a procedure that accepts an arbitrary number of arguments. By convention, those procedures receive information about the build in the form of @dfn{keyword parameters}, which they can use or ignore."
15531 #: guix-git/doc/guix.texi:8340
15533 msgid "%standard-phases"
15536 #. type: Plain text
15537 #: guix-git/doc/guix.texi:8346
15538 msgid "For example, here is how @code{(guix build gnu-build-system)} defines @code{%standard-phases}, the variable holding its alist of build phases@footnote{We present a simplified view of those build phases, but do take a look at @code{(guix build gnu-build-system)} to see all the details!}:"
15542 #: guix-git/doc/guix.texi:8349
15545 ";; The build phases of 'gnu-build-system'.\n"
15550 #: guix-git/doc/guix.texi:8353
15553 "(define* (unpack #:key source #:allow-other-keys)\n"
15554 " ;; Extract the source tarball.\n"
15555 " (invoke \"tar\" \"xvf\" source))\n"
15560 #: guix-git/doc/guix.texi:8359
15563 "(define* (configure #:key outputs #:allow-other-keys)\n"
15564 " ;; Run the 'configure' script. Install to output \"out\".\n"
15565 " (let ((out (assoc-ref outputs \"out\")))\n"
15566 " (invoke \"./configure\"\n"
15567 " (string-append \"--prefix=\" out))))\n"
15572 #: guix-git/doc/guix.texi:8363
15575 "(define* (build #:allow-other-keys)\n"
15577 " (invoke \"make\"))\n"
15582 #: guix-git/doc/guix.texi:8370
15585 "(define* (check #:key (test-target \"check\") (tests? #true)\n"
15586 " #:allow-other-keys)\n"
15587 " ;; Run the test suite.\n"
15589 " (invoke \"make\" test-target)\n"
15590 " (display \"test suite not run\\n\")))\n"
15595 #: guix-git/doc/guix.texi:8374
15598 "(define* (install #:allow-other-keys)\n"
15599 " ;; Install files to the prefix 'configure' specified.\n"
15600 " (invoke \"make\" \"install\"))\n"
15605 #: guix-git/doc/guix.texi:8383
15608 "(define %standard-phases\n"
15609 " ;; The list of standard phases (quite a few are omitted\n"
15610 " ;; for brevity). Each element is a symbol/procedure pair.\n"
15611 " (list (cons 'unpack unpack)\n"
15612 " (cons 'configure configure)\n"
15613 " (cons 'build build)\n"
15614 " (cons 'check check)\n"
15615 " (cons 'install install)))\n"
15618 #. type: Plain text
15619 #: guix-git/doc/guix.texi:8393
15620 msgid "This shows how @code{%standard-phases} is defined as a list of symbol/procedure pairs (@pxref{Pairs,,, guile, GNU Guile Reference Manual}). The first pair associates the @code{unpack} procedure with the @code{unpack} symbol---a name; the second pair defines the @code{configure} phase similarly, and so on. When building a package that uses @code{gnu-build-system} with its default list of phases, those phases are executed sequentially. You can see the name of each phase started and completed in the build log of packages that you build."
15623 #. type: Plain text
15624 #: guix-git/doc/guix.texi:8399
15625 msgid "Let's now look at the procedures themselves. Each one is defined with @code{define*}: @code{#:key} lists keyword parameters the procedure accepts, possibly with a default value, and @code{#:allow-other-keys} specifies that other keyword parameters are ignored (@pxref{Optional Arguments,,, guile, GNU Guile Reference Manual})."
15628 #. type: Plain text
15629 #: guix-git/doc/guix.texi:8415
15630 msgid "The @code{unpack} procedure honors the @code{source} parameter, which the build system uses to pass the file name of the source tarball (or version control checkout), and it ignores other parameters. The @code{configure} phase only cares about the @code{outputs} parameter, an alist mapping package output names to their store file name (@pxref{Packages with Multiple Outputs}). It extracts the file name of for @code{out}, the default output, and passes it to @command{./configure} as the installation prefix, meaning that @command{make install} will eventually copy all the files in that directory (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards}). @code{build} and @code{install} ignore all their arguments. @code{check} honors the @code{test-target} argument, which specifies the name of the Makefile target to run tests; it prints a message and skips tests when @code{tests?} is false."
15634 #: guix-git/doc/guix.texi:8416
15636 msgid "build phases, customizing"
15639 #. type: Plain text
15640 #: guix-git/doc/guix.texi:8425
15641 msgid "The list of phases used for a particular package can be changed with the @code{#:phases} parameter of the build system. Changing the set of build phases boils down to building a new alist of phases based on the @code{%standard-phases} alist described above. This can be done with standard alist procedures such as @code{alist-delete} (@pxref{SRFI-1 Association Lists,,, guile, GNU Guile Reference Manual}); however, it is more convenient to do so with @code{modify-phases} (@pxref{Build Utilities, @code{modify-phases}})."
15644 #. type: Plain text
15645 #: guix-git/doc/guix.texi:8430
15646 msgid "Here is an example of a package definition that removes the @code{configure} phase of @code{%standard-phases} and inserts a new phase before the @code{build} phase, called @code{set-prefix-in-makefile}:"
15650 #: guix-git/doc/guix.texi:8450
15653 "(define-public example\n"
15655 " (name \"example\")\n"
15656 " ;; other fields omitted\n"
15657 " (build-system gnu-build-system)\n"
15659 " '(#:phases (modify-phases %standard-phases\n"
15660 " (delete 'configure)\n"
15661 " (add-before 'build 'set-prefix-in-makefile\n"
15662 " (lambda* (#:key outputs #:allow-other-keys)\n"
15663 " ;; Modify the makefile so that its\n"
15664 " ;; 'PREFIX' variable points to \"out\".\n"
15665 " (let ((out (assoc-ref outputs \"out\")))\n"
15666 " (substitute* \"Makefile\"\n"
15667 " ((\"PREFIX =.*\")\n"
15668 " (string-append \"PREFIX = \"\n"
15669 " out \"\\n\")))\n"
15673 #. type: Plain text
15674 #: guix-git/doc/guix.texi:8456
15675 msgid "The new phase that is inserted is written as an anonymous procedure, introduced with @code{lambda*}; it honors the @code{outputs} parameter we have seen before. @xref{Build Utilities}, for more about the helpers used by this phase, and for more examples of @code{modify-phases}."
15679 #: guix-git/doc/guix.texi:8457 guix-git/doc/guix.texi:9430
15681 msgid "code staging"
15685 #: guix-git/doc/guix.texi:8458 guix-git/doc/guix.texi:9431
15687 msgid "staging, of code"
15690 #. type: Plain text
15691 #: guix-git/doc/guix.texi:8465
15692 msgid "Keep in mind that build phases are code evaluated at the time the package is actually built. This explains why the whole @code{modify-phases} expression above is quoted (it comes after the @code{'} or apostrophe): it is @dfn{staged} for later execution. @xref{G-Expressions}, for an explanation of code staging and the @dfn{code strata} involved."
15695 #. type: Plain text
15696 #: guix-git/doc/guix.texi:8475
15697 msgid "As soon as you start writing non-trivial package definitions (@pxref{Defining Packages}) or other build actions (@pxref{G-Expressions}), you will likely start looking for helpers for ``shell-like'' actions---creating directories, copying and deleting files recursively, manipulating build phases, and so on. The @code{(guix build utils)} module provides such utility procedures."
15700 #. type: Plain text
15701 #: guix-git/doc/guix.texi:8479
15702 msgid "Most build systems load @code{(guix build utils)} (@pxref{Build Systems}). Thus, when writing custom build phases for your package definitions, you can usually assume those procedures are in scope."
15705 #. type: Plain text
15706 #: guix-git/doc/guix.texi:8484
15707 msgid "When writing G-expressions, you can import @code{(guix build utils)} on the ``build side'' using @code{with-imported-modules} and then put it in scope with the @code{use-modules} form (@pxref{Using Guile Modules,,, guile, GNU Guile Reference Manual}):"
15711 #: guix-git/doc/guix.texi:8491
15714 "(with-imported-modules '((guix build utils)) ;import it\n"
15715 " (computed-file \"empty-tree\"\n"
15717 " ;; Put it in scope.\n"
15718 " (use-modules (guix build utils))\n"
15723 #: guix-git/doc/guix.texi:8494
15726 " ;; Happily use its 'mkdir-p' procedure.\n"
15727 " (mkdir-p (string-append #$output \"/a/b/c\")))))\n"
15730 #. type: Plain text
15731 #: guix-git/doc/guix.texi:8498
15732 msgid "The remainder of this section is the reference for most of the utility procedures provided by @code{(guix build utils)}."
15735 #. type: subsection
15736 #: guix-git/doc/guix.texi:8501
15738 msgid "Dealing with Store File Names"
15741 #. type: Plain text
15742 #: guix-git/doc/guix.texi:8504
15743 msgid "This section documents procedures that deal with store file names."
15747 #: guix-git/doc/guix.texi:8505
15749 msgid "{Scheme Procedure} %store-directory"
15753 #: guix-git/doc/guix.texi:8507
15754 msgid "Return the directory name of the store."
15758 #: guix-git/doc/guix.texi:8509
15760 msgid "{Scheme Procedure} store-file-name? @var{file}"
15764 #: guix-git/doc/guix.texi:8511
15765 msgid "Return true if @var{file} is in the store."
15769 #: guix-git/doc/guix.texi:8513
15771 msgid "{Scheme Procedure} strip-store-file-name @var{file}"
15775 #: guix-git/doc/guix.texi:8516
15776 msgid "Strip the @file{/gnu/store} and hash from @var{file}, a store file name. The result is typically a @code{\"@var{package}-@var{version}\"} string."
15780 #: guix-git/doc/guix.texi:8518
15782 msgid "{Scheme Procedure} package-name->name+version @var{name}"
15786 #: guix-git/doc/guix.texi:8523
15787 msgid "Given @var{name}, a package name like @code{\"foo-0.9.1b\"}, return two values: @code{\"foo\"} and @code{\"0.9.1b\"}. When the version part is unavailable, @var{name} and @code{#f} are returned. The first hyphen followed by a digit is considered to introduce the version part."
15790 #. type: subsection
15791 #: guix-git/doc/guix.texi:8525
15796 #. type: Plain text
15797 #: guix-git/doc/guix.texi:8528
15798 msgid "The procedures below deal with files and file types."
15802 #: guix-git/doc/guix.texi:8529
15804 msgid "{Scheme Procedure} directory-exists? @var{dir}"
15808 #: guix-git/doc/guix.texi:8531
15809 msgid "Return @code{#t} if @var{dir} exists and is a directory."
15813 #: guix-git/doc/guix.texi:8533
15815 msgid "{Scheme Procedure} executable-file? @var{file}"
15819 #: guix-git/doc/guix.texi:8535
15820 msgid "Return @code{#t} if @var{file} exists and is executable."
15824 #: guix-git/doc/guix.texi:8537
15826 msgid "{Scheme Procedure} symbolic-link? @var{file}"
15830 #: guix-git/doc/guix.texi:8539
15831 msgid "Return @code{#t} if @var{file} is a symbolic link (aka. a ``symlink'')."
15835 #: guix-git/doc/guix.texi:8541
15837 msgid "{Scheme Procedure} elf-file? @var{file}"
15841 #: guix-git/doc/guix.texi:8542
15843 msgid "{Scheme Procedure} ar-file? @var{file}"
15847 #: guix-git/doc/guix.texi:8543
15849 msgid "{Scheme Procedure} gzip-file? @var{file}"
15853 #: guix-git/doc/guix.texi:8546
15854 msgid "Return @code{#t} if @var{file} is, respectively, an ELF file, an @code{ar} archive (such as a @file{.a} static library), or a gzip file."
15858 #: guix-git/doc/guix.texi:8548
15860 msgid "{Scheme Procedure} reset-gzip-timestamp @var{file} [#:keep-mtime? #t]"
15864 #: guix-git/doc/guix.texi:8552
15865 msgid "If @var{file} is a gzip file, reset its embedded timestamp (as with @command{gzip --no-name}) and return true. Otherwise return @code{#f}. When @var{keep-mtime?} is true, preserve @var{file}'s modification time."
15868 #. type: subsection
15869 #: guix-git/doc/guix.texi:8554
15871 msgid "File Manipulation"
15874 #. type: Plain text
15875 #: guix-git/doc/guix.texi:8561
15876 msgid "The following procedures and macros help create, modify, and delete files. They provide functionality comparable to common shell utilities such as @command{mkdir -p}, @command{cp -r}, @command{rm -r}, and @command{sed}. They complement Guile's extensive, but low-level, file system interface (@pxref{POSIX,,, guile, GNU Guile Reference Manual})."
15880 #: guix-git/doc/guix.texi:8562
15882 msgid "{Scheme Syntax} with-directory-excursion @var{directory} @var{body}@dots{}"
15886 #: guix-git/doc/guix.texi:8564
15887 msgid "Run @var{body} with @var{directory} as the process's current directory."
15891 #: guix-git/doc/guix.texi:8571
15892 msgid "Essentially, this macro changes the current directory to @var{directory} before evaluating @var{body}, using @code{chdir} (@pxref{Processes,,, guile, GNU Guile Reference Manual}). It changes back to the initial directory when the dynamic extent of @var{body} is left, be it @i{via} normal procedure return or @i{via} a non-local exit such as an exception."
15896 #: guix-git/doc/guix.texi:8573
15898 msgid "{Scheme Procedure} mkdir-p @var{dir}"
15902 #: guix-git/doc/guix.texi:8575
15903 msgid "Create directory @var{dir} and all its ancestors."
15907 #: guix-git/doc/guix.texi:8577
15909 msgid "{Scheme Procedure} install-file @var{file} @var{directory}"
15913 #: guix-git/doc/guix.texi:8580
15914 msgid "Create @var{directory} if it does not exist and copy @var{file} in there under the same name."
15918 #: guix-git/doc/guix.texi:8582
15920 msgid "{Scheme Procedure} make-file-writable @var{file}"
15924 #: guix-git/doc/guix.texi:8584
15925 msgid "Make @var{file} writable for its owner."
15929 #: guix-git/doc/guix.texi:8586
15931 msgid "{Scheme Procedure} copy-recursively @var{source} @var{destination} @"
15935 #: guix-git/doc/guix.texi:8593
15936 msgid "[#:log (current-output-port)] [#:follow-symlinks? #f] [#:keep-mtime? #f] Copy @var{source} directory to @var{destination}. Follow symlinks if @var{follow-symlinks?} is true; otherwise, just preserve them. When @var{keep-mtime?} is true, keep the modification time of the files in @var{source} on those of @var{destination}. Write verbose output to the @var{log} port."
15940 #: guix-git/doc/guix.texi:8595
15942 msgid "{Scheme Procedure} delete-file-recursively @var{dir} @"
15946 #: guix-git/doc/guix.texi:8600
15947 msgid "[#:follow-mounts? #f] Delete @var{dir} recursively, like @command{rm -rf}, without following symlinks. Don't follow mount points either, unless @var{follow-mounts?} is true. Report but ignore errors."
15951 #: guix-git/doc/guix.texi:8602
15953 msgid "{Scheme Syntax} substitute* @var{file} @"
15957 #: guix-git/doc/guix.texi:8607
15958 msgid "((@var{regexp} @var{match-var}@dots{}) @var{body}@dots{}) @dots{} Substitute @var{regexp} in @var{file} by the string returned by @var{body}. @var{body} is evaluated with each @var{match-var} bound to the corresponding positional regexp sub-expression. For example:"
15962 #: guix-git/doc/guix.texi:8614
15965 "(substitute* file\n"
15967 " \"good morning\\n\")\n"
15968 " ((\"foo([a-z]+)bar(.*)$\" all letters end)\n"
15969 " (string-append \"baz\" letter end)))\n"
15973 #: guix-git/doc/guix.texi:8620
15974 msgid "Here, anytime a line of @var{file} contains @code{hello}, it is replaced by @code{good morning}. Anytime a line of @var{file} matches the second regexp, @code{all} is bound to the complete match, @code{letters} is bound to the first sub-expression, and @code{end} is bound to the last one."
15978 #: guix-git/doc/guix.texi:8623
15979 msgid "When one of the @var{match-var} is @code{_}, no variable is bound to the corresponding match substring."
15983 #: guix-git/doc/guix.texi:8626
15984 msgid "Alternatively, @var{file} may be a list of file names, in which case they are all subject to the substitutions."
15988 #: guix-git/doc/guix.texi:8629
15989 msgid "Be careful about using @code{$} to match the end of a line; by itself it won't match the terminating newline of a line."
15992 #. type: subsection
15993 #: guix-git/doc/guix.texi:8631
15995 msgid "File Search"
15999 #: guix-git/doc/guix.texi:8633
16001 msgid "file, searching"
16004 #. type: Plain text
16005 #: guix-git/doc/guix.texi:8635
16006 msgid "This section documents procedures to search and filter files."
16010 #: guix-git/doc/guix.texi:8636
16012 msgid "{Scheme Procedure} file-name-predicate @var{regexp}"
16016 #: guix-git/doc/guix.texi:8639
16017 msgid "Return a predicate that returns true when passed a file name whose base name matches @var{regexp}."
16021 #: guix-git/doc/guix.texi:8641
16023 msgid "{Scheme Procedure} find-files @var{dir} [@var{pred}] @"
16027 #: guix-git/doc/guix.texi:8652
16028 msgid "[#:stat lstat] [#:directories? #f] [#:fail-on-error? #f] Return the lexicographically sorted list of files under @var{dir} for which @var{pred} returns true. @var{pred} is passed two arguments: the absolute file name, and its stat buffer; the default predicate always returns true. @var{pred} can also be a regular expression, in which case it is equivalent to @code{(file-name-predicate @var{pred})}. @var{stat} is used to obtain file information; using @code{lstat} means that symlinks are not followed. If @var{directories?} is true, then directories will also be included. If @var{fail-on-error?} is true, raise an exception upon error."
16031 #. type: Plain text
16032 #: guix-git/doc/guix.texi:8656
16033 msgid "Here are a few examples where we assume that the current directory is the root of the Guix source tree:"
16037 #: guix-git/doc/guix.texi:8661
16040 ";; List all the regular files in the current directory.\n"
16041 "(find-files \".\")\n"
16042 "@result{} (\"./.dir-locals.el\" \"./.gitignore\" @dots{})\n"
16047 #: guix-git/doc/guix.texi:8665
16050 ";; List all the .scm files under gnu/services.\n"
16051 "(find-files \"gnu/services\" \"\\\\.scm$\")\n"
16052 "@result{} (\"gnu/services/admin.scm\" \"gnu/services/audio.scm\" @dots{})\n"
16057 #: guix-git/doc/guix.texi:8669
16060 ";; List ar files in the current directory.\n"
16061 "(find-files \".\" (lambda (file stat) (ar-file? file)))\n"
16062 "@result{} (\"./libformat.a\" \"./libstore.a\" @dots{})\n"
16066 #: guix-git/doc/guix.texi:8671
16068 msgid "{Scheme Procedure} which @var{program}"
16072 #: guix-git/doc/guix.texi:8674
16073 msgid "Return the complete file name for @var{program} as found in @code{$PATH}, or @code{#f} if @var{program} could not be found."
16076 #. type: Plain text
16077 #: guix-git/doc/guix.texi:8685
16078 msgid "The @code{(guix build utils)} also contains tools to manipulate build phases as used by build systems (@pxref{Build Systems}). Build phases are represented as association lists or ``alists'' (@pxref{Association Lists,,, guile, GNU Guile Reference Manual}) where each key is a symbol naming the phase and the associated value is a procedure (@pxref{Build Phases})."
16081 #. type: Plain text
16082 #: guix-git/doc/guix.texi:8689
16083 msgid "Guile core and the @code{(srfi srfi-1)} module both provide tools to manipulate alists. The @code{(guix build utils)} module complements those with tools written with build phases in mind."
16087 #: guix-git/doc/guix.texi:8690
16089 msgid "build phases, modifying"
16093 #: guix-git/doc/guix.texi:8691
16095 msgid "{Scheme Syntax} modify-phases @var{phases} @var{clause}@dots{}"
16099 #: guix-git/doc/guix.texi:8694
16100 msgid "Modify @var{phases} sequentially as per each @var{clause}, which may have one of the following forms:"
16104 #: guix-git/doc/guix.texi:8700
16107 "(delete @var{old-phase-name})\n"
16108 "(replace @var{old-phase-name} @var{new-phase})\n"
16109 "(add-before @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
16110 "(add-after @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
16114 #: guix-git/doc/guix.texi:8704
16115 msgid "Where every @var{phase-name} above is an expression evaluating to a symbol, and @var{new-phase} an expression evaluating to a procedure."
16118 #. type: Plain text
16119 #: guix-git/doc/guix.texi:8715
16120 msgid "The example below is taken from the definition of the @code{grep} package. It adds a phase to run after the @code{install} phase, called @code{fix-egrep-and-fgrep}. That phase is a procedure (@code{lambda*} is for anonymous procedures) that takes a @code{#:outputs} keyword argument and ignores extra keyword arguments (@pxref{Optional Arguments,,, guile, GNU Guile Reference Manual}, for more on @code{lambda*} and optional and keyword arguments.) The phase uses @code{substitute*} to modify the installed @file{egrep} and @file{fgrep} scripts so that they refer to @code{grep} by its absolute file name:"
16124 #: guix-git/doc/guix.texi:8729
16127 "(modify-phases %standard-phases\n"
16128 " (add-after 'install 'fix-egrep-and-fgrep\n"
16129 " ;; Patch 'egrep' and 'fgrep' to execute 'grep' via its\n"
16130 " ;; absolute file name instead of searching for it in $PATH.\n"
16131 " (lambda* (#:key outputs #:allow-other-keys)\n"
16132 " (let* ((out (assoc-ref outputs \"out\"))\n"
16133 " (bin (string-append out \"/bin\")))\n"
16134 " (substitute* (list (string-append bin \"/egrep\")\n"
16135 " (string-append bin \"/fgrep\"))\n"
16136 " ((\"^exec grep\")\n"
16137 " (string-append \"exec \" bin \"/grep\")))\n"
16141 #. type: Plain text
16142 #: guix-git/doc/guix.texi:8736
16143 msgid "In the example below, phases are modified in two ways: the standard @code{configure} phase is deleted, presumably because the package does not have a @file{configure} script or anything similar, and the default @code{install} phase is replaced by one that manually copies the executable files to be installed:"
16147 #: guix-git/doc/guix.texi:8749
16150 "(modify-phases %standard-phases\n"
16151 " (delete 'configure) ;no 'configure' script\n"
16152 " (replace 'install\n"
16153 " (lambda* (#:key outputs #:allow-other-keys)\n"
16154 " ;; The package's Makefile doesn't provide an \"install\"\n"
16155 " ;; rule so do it by ourselves.\n"
16156 " (let ((bin (string-append (assoc-ref outputs \"out\")\n"
16158 " (install-file \"footswitch\" bin)\n"
16159 " (install-file \"scythe\" bin)\n"
16164 #: guix-git/doc/guix.texi:8757
16166 msgid "store items"
16170 #: guix-git/doc/guix.texi:8758
16172 msgid "store paths"
16175 #. type: Plain text
16176 #: guix-git/doc/guix.texi:8769
16177 msgid "Conceptually, the @dfn{store} is the place where derivations that have been built successfully are stored---by default, @file{/gnu/store}. Sub-directories in the store are referred to as @dfn{store items} or sometimes @dfn{store paths}. The store has an associated database that contains information such as the store paths referred to by each store path, and the list of @emph{valid} store items---results of successful builds. This database resides in @file{@var{localstatedir}/guix/db}, where @var{localstatedir} is the state directory specified @i{via} @option{--localstatedir} at configure time, usually @file{/var}."
16180 #. type: Plain text
16181 #: guix-git/doc/guix.texi:8774
16182 msgid "The store is @emph{always} accessed by the daemon on behalf of its clients (@pxref{Invoking guix-daemon}). To manipulate the store, clients connect to the daemon over a Unix-domain socket, send requests to it, and read the result---these are remote procedure calls, or RPCs."
16186 #: guix-git/doc/guix.texi:8779
16187 msgid "Users must @emph{never} modify files under @file{/gnu/store} directly. This would lead to inconsistencies and break the immutability assumptions of Guix's functional model (@pxref{Introduction})."
16191 #: guix-git/doc/guix.texi:8783
16192 msgid "@xref{Invoking guix gc, @command{guix gc --verify}}, for information on how to check the integrity of the store and attempt recovery from accidental modifications."
16195 #. type: Plain text
16196 #: guix-git/doc/guix.texi:8790
16197 msgid "The @code{(guix store)} module provides procedures to connect to the daemon, and to perform RPCs. These are described below. By default, @code{open-connection}, and thus all the @command{guix} commands, connect to the local daemon or to the URI specified by the @env{GUIX_DAEMON_SOCKET} environment variable."
16201 #: guix-git/doc/guix.texi:8791
16203 msgid "{Environment Variable} GUIX_DAEMON_SOCKET"
16207 #: guix-git/doc/guix.texi:8796
16208 msgid "When set, the value of this variable should be a file name or a URI designating the daemon endpoint. When it is a file name, it denotes a Unix-domain socket to connect to. In addition to file names, the supported URI schemes are:"
16212 #: guix-git/doc/guix.texi:8798 guix-git/doc/guix.texi:24528
16218 #: guix-git/doc/guix.texi:8799
16224 #: guix-git/doc/guix.texi:8803
16225 msgid "These are for Unix-domain sockets. @code{file:///var/guix/daemon-socket/socket} is equivalent to @file{/var/guix/daemon-socket/socket}."
16229 #: guix-git/doc/guix.texi:8804
16235 #: guix-git/doc/guix.texi:8812
16236 msgid "These URIs denote connections over TCP/IP, without encryption nor authentication of the remote host. The URI must specify the host name and optionally a port number (by default port 44146 is used):"
16240 #: guix-git/doc/guix.texi:8815
16242 msgid "guix://master.guix.example.org:1234\n"
16246 #: guix-git/doc/guix.texi:8820
16247 msgid "This setup is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon at @code{master.guix.example.org}."
16251 #: guix-git/doc/guix.texi:8824
16252 msgid "The @option{--listen} option of @command{guix-daemon} can be used to instruct it to listen for TCP connections (@pxref{Invoking guix-daemon, @option{--listen}})."
16256 #: guix-git/doc/guix.texi:8825
16262 #: guix-git/doc/guix.texi:8826
16264 msgid "SSH access to build daemons"
16268 #: guix-git/doc/guix.texi:8832
16269 msgid "These URIs allow you to connect to a remote daemon over SSH@. This feature requires Guile-SSH (@pxref{Requirements}) and a working @command{guile} binary in @env{PATH} on the destination machine. It supports public key and GSSAPI authentication. A typical URL might look like this:"
16273 #: guix-git/doc/guix.texi:8835
16275 msgid "ssh://charlie@@guix.example.org:22\n"
16279 #: guix-git/doc/guix.texi:8839
16280 msgid "As for @command{guix copy}, the usual OpenSSH client configuration files are honored (@pxref{Invoking guix copy})."
16284 #: guix-git/doc/guix.texi:8842
16285 msgid "Additional URI schemes may be supported in the future."
16289 #: guix-git/doc/guix.texi:8849
16290 msgid "The ability to connect to remote build daemons is considered experimental as of @value{VERSION}. Please get in touch with us to share any problems or suggestions you may have (@pxref{Contributing})."
16294 #: guix-git/doc/guix.texi:8852
16296 msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]"
16300 #: guix-git/doc/guix.texi:8857
16301 msgid "Connect to the daemon over the Unix-domain socket at @var{uri} (a string). When @var{reserve-space?} is true, instruct it to reserve a little bit of extra space on the file system so that the garbage collector can still operate should the disk become full. Return a server object."
16305 #: guix-git/doc/guix.texi:8860
16306 msgid "@var{file} defaults to @code{%default-socket-path}, which is the normal location given the options that were passed to @command{configure}."
16310 #: guix-git/doc/guix.texi:8862
16312 msgid "{Scheme Procedure} close-connection @var{server}"
16316 #: guix-git/doc/guix.texi:8864
16317 msgid "Close the connection to @var{server}."
16321 #: guix-git/doc/guix.texi:8866
16323 msgid "{Scheme Variable} current-build-output-port"
16327 #: guix-git/doc/guix.texi:8869
16328 msgid "This variable is bound to a SRFI-39 parameter, which refers to the port where build and error logs sent by the daemon should be written."
16331 #. type: Plain text
16332 #: guix-git/doc/guix.texi:8873
16333 msgid "Procedures that make RPCs all take a server object as their first argument."
16337 #: guix-git/doc/guix.texi:8874
16339 msgid "{Scheme Procedure} valid-path? @var{server} @var{path}"
16343 #: guix-git/doc/guix.texi:8875
16345 msgid "invalid store items"
16349 #: guix-git/doc/guix.texi:8880
16350 msgid "Return @code{#t} when @var{path} designates a valid store item and @code{#f} otherwise (an invalid item may exist on disk but still be invalid, for instance because it is the result of an aborted or failed build)."
16354 #: guix-git/doc/guix.texi:8883
16355 msgid "A @code{&store-protocol-error} condition is raised if @var{path} is not prefixed by the store directory (@file{/gnu/store})."
16359 #: guix-git/doc/guix.texi:8885
16361 msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]"
16365 #: guix-git/doc/guix.texi:8889
16366 msgid "Add @var{text} under file @var{name} in the store, and return its store path. @var{references} is the list of store paths referred to by the resulting store path."
16370 #: guix-git/doc/guix.texi:8891
16372 msgid "{Scheme Procedure} build-derivations @var{store} @var{derivations} @"
16376 #: guix-git/doc/guix.texi:8896
16377 msgid "[@var{mode}] Build @var{derivations}, a list of @code{<derivation>} objects, @file{.drv} file names, or derivation/output pairs, using the specified @var{mode}---@code{(build-mode normal)} by default."
16380 #. type: Plain text
16381 #: guix-git/doc/guix.texi:8902
16382 msgid "Note that the @code{(guix monads)} module provides a monad as well as monadic versions of the above procedures, with the goal of making it more convenient to work with code that accesses the store (@pxref{The Store Monad})."
16386 #: guix-git/doc/guix.texi:8905
16387 msgid "This section is currently incomplete."
16391 #: guix-git/doc/guix.texi:8909
16393 msgid "derivations"
16396 #. type: Plain text
16397 #: guix-git/doc/guix.texi:8913
16398 msgid "Low-level build actions and the environment in which they are performed are represented by @dfn{derivations}. A derivation contains the following pieces of information:"
16402 #: guix-git/doc/guix.texi:8918
16403 msgid "The outputs of the derivation---derivations produce at least one file or directory in the store, but may produce more."
16407 #: guix-git/doc/guix.texi:8920
16409 msgid "build-time dependencies"
16413 #: guix-git/doc/guix.texi:8921
16415 msgid "dependencies, build-time"
16419 #: guix-git/doc/guix.texi:8925
16420 msgid "The inputs of the derivations---i.e., its build-time dependencies---which may be other derivations or plain files in the store (patches, build scripts, etc.)."
16424 #: guix-git/doc/guix.texi:8928
16425 msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}."
16429 #: guix-git/doc/guix.texi:8932
16430 msgid "The file name of a build script in the store, along with the arguments to be passed."
16434 #: guix-git/doc/guix.texi:8935
16435 msgid "A list of environment variables to be defined."
16439 #: guix-git/doc/guix.texi:8938
16441 msgid "derivation path"
16444 #. type: Plain text
16445 #: guix-git/doc/guix.texi:8946
16446 msgid "Derivations allow clients of the daemon to communicate build actions to the store. They exist in two forms: as an in-memory representation, both on the client- and daemon-side, and as files in the store whose name end in @file{.drv}---these files are referred to as @dfn{derivation paths}. Derivations paths can be passed to the @code{build-derivations} procedure to perform the build actions they prescribe (@pxref{The Store})."
16450 #: guix-git/doc/guix.texi:8947
16452 msgid "fixed-output derivations"
16455 #. type: Plain text
16456 #: guix-git/doc/guix.texi:8954
16457 msgid "Operations such as file downloads and version-control checkouts for which the expected content hash is known in advance are modeled as @dfn{fixed-output derivations}. Unlike regular derivations, the outputs of a fixed-output derivation are independent of its inputs---e.g., a source code download produces the same result regardless of the download method and tools being used."
16461 #: guix-git/doc/guix.texi:8955 guix-git/doc/guix.texi:12445
16467 #: guix-git/doc/guix.texi:8956
16469 msgid "run-time dependencies"
16473 #: guix-git/doc/guix.texi:8957
16475 msgid "dependencies, run-time"
16478 #. type: Plain text
16479 #: guix-git/doc/guix.texi:8964
16480 msgid "The outputs of derivations---i.e., the build results---have a set of @dfn{references}, as reported by the @code{references} RPC or the @command{guix gc --references} command (@pxref{Invoking guix gc}). References are the set of run-time dependencies of the build results. References are a subset of the inputs of the derivation; this subset is automatically computed by the build daemon by scanning all the files in the outputs."
16483 #. type: Plain text
16484 #: guix-git/doc/guix.texi:8969
16485 msgid "The @code{(guix derivations)} module provides a representation of derivations as Scheme objects, along with procedures to create and otherwise manipulate derivations. The lowest-level primitive to create a derivation is the @code{derivation} procedure:"
16489 #: guix-git/doc/guix.texi:8970
16491 msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
16495 #: guix-git/doc/guix.texi:8979
16496 msgid "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:substitutable? #t] [#:properties '()] Build a derivation with the given arguments, and return the resulting @code{<derivation>} object."
16500 #: guix-git/doc/guix.texi:8986
16501 msgid "When @var{hash} and @var{hash-algo} are given, a @dfn{fixed-output derivation} is created---i.e., one whose result is known in advance, such as a file download. If, in addition, @var{recursive?} is true, then that fixed output may be an executable file or a directory and @var{hash} must be the hash of an archive containing this output."
16505 #: guix-git/doc/guix.texi:8991
16506 msgid "When @var{references-graphs} is true, it must be a list of file name/store path pairs. In that case, the reference graph of each store path is exported in the build environment in the corresponding file, in a simple text format."
16510 #: guix-git/doc/guix.texi:8996
16511 msgid "When @var{allowed-references} is true, it must be a list of store items or outputs that the derivation's output may refer to. Likewise, @var{disallowed-references}, if true, must be a list of things the outputs may @emph{not} refer to."
16515 #: guix-git/doc/guix.texi:9003
16516 msgid "When @var{leaked-env-vars} is true, it must be a list of strings denoting environment variables that are allowed to ``leak'' from the daemon's environment to the build environment. This is only applicable to fixed-output derivations---i.e., when @var{hash} is true. The main use is to allow variables such as @code{http_proxy} to be passed to derivations that download files."
16520 #: guix-git/doc/guix.texi:9008
16521 msgid "When @var{local-build?} is true, declare that the derivation is not a good candidate for offloading and should rather be built locally (@pxref{Daemon Offload Setup}). This is the case for small derivations where the costs of data transfers would outweigh the benefits."
16525 #: guix-git/doc/guix.texi:9013
16526 msgid "When @var{substitutable?} is false, declare that substitutes of the derivation's output should not be used (@pxref{Substitutes}). This is useful, for instance, when building packages that capture details of the host CPU instruction set."
16530 #: guix-git/doc/guix.texi:9016
16531 msgid "@var{properties} must be an association list describing ``properties'' of the derivation. It is kept as-is, uninterpreted, in the derivation."
16534 #. type: Plain text
16535 #: guix-git/doc/guix.texi:9022
16536 msgid "Here's an example with a shell script as its builder, assuming @var{store} is an open connection to the daemon, and @var{bash} points to a Bash executable in the store:"
16540 #: guix-git/doc/guix.texi:9027
16543 "(use-modules (guix utils)\n"
16545 " (guix derivations))\n"
16550 #: guix-git/doc/guix.texi:9036
16553 "(let ((builder ; add the Bash script to the store\n"
16554 " (add-text-to-store store \"my-builder.sh\"\n"
16555 " \"echo hello world > $out\\n\" '())))\n"
16556 " (derivation store \"foo\"\n"
16557 " bash `(\"-e\" ,builder)\n"
16558 " #:inputs `((,bash) (,builder))\n"
16559 " #:env-vars '((\"HOME\" . \"/homeless\"))))\n"
16560 "@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo>\n"
16563 #. type: Plain text
16564 #: guix-git/doc/guix.texi:9043
16565 msgid "As can be guessed, this primitive is cumbersome to use directly. A better approach is to write build scripts in Scheme, of course! The best course of action for that is to write the build code as a ``G-expression'', and to pass it to @code{gexp->derivation}. For more information, @pxref{G-Expressions}."
16568 #. type: Plain text
16569 #: guix-git/doc/guix.texi:9048
16570 msgid "Once upon a time, @code{gexp->derivation} did not exist and constructing derivations with build code written in Scheme was achieved with @code{build-expression->derivation}, documented below. This procedure is now deprecated in favor of the much nicer @code{gexp->derivation}."
16574 #: guix-git/doc/guix.texi:9049
16576 msgid "{Scheme Procedure} build-expression->derivation @var{store} @"
16580 #: guix-git/doc/guix.texi:9065
16581 msgid "@var{name} @var{exp} @ [#:system (%current-system)] [#:inputs '()] @ [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] Return a derivation that executes Scheme expression @var{exp} as a builder for derivation @var{name}. @var{inputs} must be a list of @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, @code{\"out\"} is assumed. @var{modules} is a list of names of Guile modules from the current search path to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}."
16585 #: guix-git/doc/guix.texi:9073
16586 msgid "@var{exp} is evaluated in an environment where @code{%outputs} is bound to a list of output/path pairs, and where @code{%build-inputs} is bound to a list of string/output-path pairs made from @var{inputs}. Optionally, @var{env-vars} is a list of string pairs specifying the name and value of environment variables visible to the builder. The builder terminates by passing the result of @var{exp} to @code{exit}; thus, when @var{exp} returns @code{#f}, the build is considered to have failed."
16590 #: guix-git/doc/guix.texi:9077
16591 msgid "@var{exp} is built using @var{guile-for-build} (a derivation). When @var{guile-for-build} is omitted or is @code{#f}, the value of the @code{%guile-for-build} fluid is used instead."
16595 #: guix-git/doc/guix.texi:9082
16596 msgid "See the @code{derivation} procedure for the meaning of @var{references-graphs}, @var{allowed-references}, @var{disallowed-references}, @var{local-build?}, and @var{substitutable?}."
16599 #. type: Plain text
16600 #: guix-git/doc/guix.texi:9087
16601 msgid "Here's an example of a single-output derivation that creates a directory containing one file:"
16605 #: guix-git/doc/guix.texi:9095
16608 "(let ((builder '(let ((out (assoc-ref %outputs \"out\")))\n"
16609 " (mkdir out) ; create /gnu/store/@dots{}-goo\n"
16610 " (call-with-output-file (string-append out \"/test\")\n"
16612 " (display '(hello guix) p))))))\n"
16613 " (build-expression->derivation store \"goo\" builder))\n"
16618 #: guix-git/doc/guix.texi:9097
16620 msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n"
16624 #: guix-git/doc/guix.texi:9103
16629 #. type: Plain text
16630 #: guix-git/doc/guix.texi:9109
16631 msgid "The procedures that operate on the store described in the previous sections all take an open connection to the build daemon as their first argument. Although the underlying model is functional, they either have side effects or depend on the current state of the store."
16634 #. type: Plain text
16635 #: guix-git/doc/guix.texi:9115
16636 msgid "The former is inconvenient: the connection to the build daemon has to be carried around in all those functions, making it impossible to compose functions that do not take that parameter with functions that do. The latter can be problematic: since store operations have side effects and/or depend on external state, they have to be properly sequenced."
16640 #: guix-git/doc/guix.texi:9116
16642 msgid "monadic values"
16646 #: guix-git/doc/guix.texi:9117
16648 msgid "monadic functions"
16651 #. type: Plain text
16652 #: guix-git/doc/guix.texi:9127
16653 msgid "This is where the @code{(guix monads)} module comes in. This module provides a framework for working with @dfn{monads}, and a particularly useful monad for our uses, the @dfn{store monad}. Monads are a construct that allows two things: associating ``context'' with values (in our case, the context is the store), and building sequences of computations (here computations include accesses to the store). Values in a monad---values that carry this additional context---are called @dfn{monadic values}; procedures that return such values are called @dfn{monadic procedures}."
16656 #. type: Plain text
16657 #: guix-git/doc/guix.texi:9129
16658 msgid "Consider this ``normal'' procedure:"
16662 #: guix-git/doc/guix.texi:9138
16665 "(define (sh-symlink store)\n"
16666 " ;; Return a derivation that symlinks the 'bash' executable.\n"
16667 " (let* ((drv (package-derivation store bash))\n"
16668 " (out (derivation->output-path drv))\n"
16669 " (sh (string-append out \"/bin/bash\")))\n"
16670 " (build-expression->derivation store \"sh\"\n"
16671 " `(symlink ,sh %output))))\n"
16674 #. type: Plain text
16675 #: guix-git/doc/guix.texi:9142
16676 msgid "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a monadic function:"
16680 #: guix-git/doc/guix.texi:9150
16683 "(define (sh-symlink)\n"
16684 " ;; Same, but return a monadic value.\n"
16685 " (mlet %store-monad ((drv (package->derivation bash)))\n"
16686 " (gexp->derivation \"sh\"\n"
16687 " #~(symlink (string-append #$drv \"/bin/bash\")\n"
16691 #. type: Plain text
16692 #: guix-git/doc/guix.texi:9157
16693 msgid "There are several things to note in the second version: the @code{store} parameter is now implicit and is ``threaded'' in the calls to the @code{package->derivation} and @code{gexp->derivation} monadic procedures, and the monadic value returned by @code{package->derivation} is @dfn{bound} using @code{mlet} instead of plain @code{let}."
16696 #. type: Plain text
16697 #: guix-git/doc/guix.texi:9161
16698 msgid "As it turns out, the call to @code{package->derivation} can even be omitted since it will take place implicitly, as we will see later (@pxref{G-Expressions}):"
16702 #: guix-git/doc/guix.texi:9167
16705 "(define (sh-symlink)\n"
16706 " (gexp->derivation \"sh\"\n"
16707 " #~(symlink (string-append #$bash \"/bin/bash\")\n"
16711 #. type: Plain text
16712 #: guix-git/doc/guix.texi:9176
16713 msgid "Calling the monadic @code{sh-symlink} has no effect. As someone once said, ``you exit a monad like you exit a building on fire: by running''. So, to exit the monad and get the desired effect, one must use @code{run-with-store}:"
16717 #: guix-git/doc/guix.texi:9180
16720 "(run-with-store (open-connection) (sh-symlink))\n"
16721 "@result{} /gnu/store/...-sh-symlink\n"
16724 #. type: Plain text
16725 #: guix-git/doc/guix.texi:9186
16726 msgid "Note that the @code{(guix monad-repl)} module extends the Guile REPL with new ``meta-commands'' to make it easier to deal with monadic procedures: @code{run-in-store}, and @code{enter-store-monad}. The former is used to ``run'' a single monadic value through the store:"
16730 #: guix-git/doc/guix.texi:9190
16733 "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n"
16734 "$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
16737 #. type: Plain text
16738 #: guix-git/doc/guix.texi:9194
16739 msgid "The latter enters a recursive REPL, where all the return values are automatically run through the store:"
16743 #: guix-git/doc/guix.texi:9203
16746 "scheme@@(guile-user)> ,enter-store-monad\n"
16747 "store-monad@@(guile-user) [1]> (package->derivation hello)\n"
16748 "$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
16749 "store-monad@@(guile-user) [1]> (text-file \"foo\" \"Hello!\")\n"
16750 "$3 = \"/gnu/store/@dots{}-foo\"\n"
16751 "store-monad@@(guile-user) [1]> ,q\n"
16752 "scheme@@(guile-user)>\n"
16755 #. type: Plain text
16756 #: guix-git/doc/guix.texi:9208
16757 msgid "Note that non-monadic values cannot be returned in the @code{store-monad} REPL."
16760 #. type: Plain text
16761 #: guix-git/doc/guix.texi:9211
16762 msgid "The main syntactic forms to deal with monads in general are provided by the @code{(guix monads)} module and are described below."
16766 #: guix-git/doc/guix.texi:9212
16768 msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..."
16772 #: guix-git/doc/guix.texi:9215
16773 msgid "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in @var{monad}."
16777 #: guix-git/doc/guix.texi:9217
16779 msgid "{Scheme Syntax} return @var{val}"
16783 #: guix-git/doc/guix.texi:9219
16784 msgid "Return a monadic value that encapsulates @var{val}."
16788 #: guix-git/doc/guix.texi:9221
16790 msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..."
16794 #: guix-git/doc/guix.texi:9228
16795 msgid "@dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic procedures @var{mproc}@dots{}@footnote{This operation is commonly referred to as ``bind'', but that name denotes an unrelated procedure in Guile. Thus we use this somewhat cryptic symbol inherited from the Haskell language.}. There can be one @var{mproc} or several of them, as in this example:"
16799 #: guix-git/doc/guix.texi:9236
16802 "(run-with-state\n"
16803 " (with-monad %state-monad\n"
16804 " (>>= (return 1)\n"
16805 " (lambda (x) (return (+ 1 x)))\n"
16806 " (lambda (x) (return (* 2 x)))))\n"
16812 #: guix-git/doc/guix.texi:9239
16816 "@result{} some-state\n"
16820 #: guix-git/doc/guix.texi:9242
16822 msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @"
16826 #: guix-git/doc/guix.texi:9244
16827 msgid "@var{body} ..."
16831 #: guix-git/doc/guix.texi:9244
16833 msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @"
16837 #: guix-git/doc/guix.texi:9256
16838 msgid "@var{body} ... Bind the variables @var{var} to the monadic values @var{mval} in @var{body}, which is a sequence of expressions. As with the bind operator, this can be thought of as ``unpacking'' the raw, non-monadic value ``contained'' in @var{mval} and making @var{var} refer to that raw, non-monadic value within the scope of the @var{body}. The form (@var{var} -> @var{val}) binds @var{var} to the ``normal'' value @var{val}, as per @code{let}. The binding operations occur in sequence from left to right. The last expression of @var{body} must be a monadic expression, and its result will become the result of the @code{mlet} or @code{mlet*} when run in the @var{monad}."
16842 #: guix-git/doc/guix.texi:9259
16843 msgid "@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual})."
16847 #: guix-git/doc/guix.texi:9261
16849 msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..."
16853 #: guix-git/doc/guix.texi:9265
16854 msgid "Bind @var{mexp} and the following monadic expressions in sequence, returning the result of the last expression. Every expression in the sequence must be a monadic expression."
16858 #: guix-git/doc/guix.texi:9269
16859 msgid "This is akin to @code{mlet}, except that the return values of the monadic expressions are ignored. In that sense, it is analogous to @code{begin}, but applied to monadic expressions."
16863 #: guix-git/doc/guix.texi:9271
16865 msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..."
16869 #: guix-git/doc/guix.texi:9276
16870 msgid "When @var{condition} is true, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is false, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression."
16874 #: guix-git/doc/guix.texi:9278
16876 msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..."
16880 #: guix-git/doc/guix.texi:9283
16881 msgid "When @var{condition} is false, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is true, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression."
16885 #: guix-git/doc/guix.texi:9285
16887 msgid "state monad"
16890 #. type: Plain text
16891 #: guix-git/doc/guix.texi:9289
16892 msgid "The @code{(guix monads)} module provides the @dfn{state monad}, which allows an additional value---the state---to be @emph{threaded} through monadic procedure calls."
16896 #: guix-git/doc/guix.texi:9290
16898 msgid "{Scheme Variable} %state-monad"
16902 #: guix-git/doc/guix.texi:9293
16903 msgid "The state monad. Procedures in the state monad can access and change the state that is threaded."
16907 #: guix-git/doc/guix.texi:9297
16908 msgid "Consider the example below. The @code{square} procedure returns a value in the state monad. It returns the square of its argument, but also increments the current state value:"
16912 #: guix-git/doc/guix.texi:9304
16915 "(define (square x)\n"
16916 " (mlet %state-monad ((count (current-state)))\n"
16917 " (mbegin %state-monad\n"
16918 " (set-current-state (+ 1 count))\n"
16919 " (return (* x x)))))\n"
16924 #: guix-git/doc/guix.texi:9308
16927 "(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n"
16928 "@result{} (0 1 4)\n"
16933 #: guix-git/doc/guix.texi:9312
16934 msgid "When ``run'' through @code{%state-monad}, we obtain that additional state value, which is the number of @code{square} calls."
16938 #: guix-git/doc/guix.texi:9314
16940 msgid "{Monadic Procedure} current-state"
16944 #: guix-git/doc/guix.texi:9316
16945 msgid "Return the current state as a monadic value."
16949 #: guix-git/doc/guix.texi:9318
16951 msgid "{Monadic Procedure} set-current-state @var{value}"
16955 #: guix-git/doc/guix.texi:9321
16956 msgid "Set the current state to @var{value} and return the previous state as a monadic value."
16960 #: guix-git/doc/guix.texi:9323
16962 msgid "{Monadic Procedure} state-push @var{value}"
16966 #: guix-git/doc/guix.texi:9326
16967 msgid "Push @var{value} to the current state, which is assumed to be a list, and return the previous state as a monadic value."
16971 #: guix-git/doc/guix.texi:9328
16973 msgid "{Monadic Procedure} state-pop"
16977 #: guix-git/doc/guix.texi:9331
16978 msgid "Pop a value from the current state and return it as a monadic value. The state is assumed to be a list."
16982 #: guix-git/doc/guix.texi:9333
16984 msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]"
16988 #: guix-git/doc/guix.texi:9336
16989 msgid "Run monadic value @var{mval} starting with @var{state} as the initial state. Return two values: the resulting value, and the resulting state."
16992 #. type: Plain text
16993 #: guix-git/doc/guix.texi:9340
16994 msgid "The main interface to the store monad, provided by the @code{(guix store)} module, is as follows."
16998 #: guix-git/doc/guix.texi:9341
17000 msgid "{Scheme Variable} %store-monad"
17004 #: guix-git/doc/guix.texi:9343
17005 msgid "The store monad---an alias for @code{%state-monad}."
17009 #: guix-git/doc/guix.texi:9347
17010 msgid "Values in the store monad encapsulate accesses to the store. When its effect is needed, a value of the store monad must be ``evaluated'' by passing it to the @code{run-with-store} procedure (see below)."
17014 #: guix-git/doc/guix.texi:9349
17016 msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]"
17020 #: guix-git/doc/guix.texi:9352
17021 msgid "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open store connection."
17025 #: guix-git/doc/guix.texi:9354
17027 msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]"
17031 #: guix-git/doc/guix.texi:9358
17032 msgid "Return as a monadic value the absolute file name in the store of the file containing @var{text}, a string. @var{references} is a list of store items that the resulting text file refers to; it defaults to the empty list."
17036 #: guix-git/doc/guix.texi:9360
17038 msgid "{Monadic Procedure} binary-file @var{name} @var{data} [@var{references}]"
17042 #: guix-git/doc/guix.texi:9364
17043 msgid "Return as a monadic value the absolute file name in the store of the file containing @var{data}, a bytevector. @var{references} is a list of store items that the resulting binary file refers to; it defaults to the empty list."
17047 #: guix-git/doc/guix.texi:9366
17049 msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @"
17053 #: guix-git/doc/guix.texi:9371
17054 msgid "[#:recursive? #t] [#:select? (const #t)] Return the name of @var{file} once interned in the store. Use @var{name} as its store name, or the basename of @var{file} if @var{name} is omitted."
17058 #: guix-git/doc/guix.texi:9375 guix-git/doc/guix.texi:9798
17059 msgid "When @var{recursive?} is true, the contents of @var{file} are added recursively; if @var{file} designates a flat file and @var{recursive?} is true, its contents are added, and its permission bits are kept."
17063 #: guix-git/doc/guix.texi:9380 guix-git/doc/guix.texi:9803
17064 msgid "When @var{recursive?} is true, call @code{(@var{select?} @var{file} @var{stat})} for each directory entry, where @var{file} is the entry's absolute file name and @var{stat} is the result of @code{lstat}; exclude entries for which @var{select?} does not return true."
17068 #: guix-git/doc/guix.texi:9382
17069 msgid "The example below adds a file to the store, under two different names:"
17073 #: guix-git/doc/guix.texi:9388
17076 "(run-with-store (open-connection)\n"
17077 " (mlet %store-monad ((a (interned-file \"README\"))\n"
17078 " (b (interned-file \"README\" \"LEGU-MIN\")))\n"
17079 " (return (list a b))))\n"
17084 #: guix-git/doc/guix.texi:9390
17086 msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n"
17089 #. type: Plain text
17090 #: guix-git/doc/guix.texi:9396
17091 msgid "The @code{(guix packages)} module exports the following package-related monadic procedures:"
17095 #: guix-git/doc/guix.texi:9397
17097 msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @"
17101 #: guix-git/doc/guix.texi:9405
17102 msgid "[#:system (%current-system)] [#:target #f] @ [#:output \"out\"] Return as a monadic value in the absolute file name of @var{file} within the @var{output} directory of @var{package}. When @var{file} is omitted, return the name of the @var{output} directory of @var{package}. When @var{target} is true, use it as a cross-compilation target triplet."
17106 #: guix-git/doc/guix.texi:9409
17107 msgid "Note that this procedure does @emph{not} build @var{package}. Thus, the result might or might not designate an existing file. We recommend not using this procedure unless you know what you are doing."
17111 #: guix-git/doc/guix.texi:9411
17113 msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]"
17117 #: guix-git/doc/guix.texi:9412
17119 msgid "{Monadic Procedure} package->cross-derivation @var{package} @"
17123 #: guix-git/doc/guix.texi:9416
17124 msgid "@var{target} [@var{system}] Monadic version of @code{package-derivation} and @code{package-cross-derivation} (@pxref{Defining Packages})."
17128 #: guix-git/doc/guix.texi:9422
17130 msgid "G-expression"
17134 #: guix-git/doc/guix.texi:9423
17136 msgid "build code quoting"
17139 #. type: Plain text
17140 #: guix-git/doc/guix.texi:9429
17141 msgid "So we have ``derivations'', which represent a sequence of build actions to be performed to produce an item in the store (@pxref{Derivations}). These build actions are performed when asking the daemon to actually build the derivations; they are run by the daemon in a container (@pxref{Invoking guix-daemon})."
17145 #: guix-git/doc/guix.texi:9432
17147 msgid "strata of code"
17150 #. type: Plain text
17151 #: guix-git/doc/guix.texi:9444
17152 msgid "It should come as no surprise that we like to write these build actions in Scheme. When we do that, we end up with two @dfn{strata} of Scheme code@footnote{The term @dfn{stratum} in this context was coined by Manuel Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who has written insightful @url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code on this topic}, refers to this kind of code generation as @dfn{staging}.}: the ``host code''---code that defines packages, talks to the daemon, etc.---and the ``build code''---code that actually performs build actions, such as making directories, invoking @command{make}, and so on (@pxref{Build Phases})."
17155 #. type: Plain text
17156 #: guix-git/doc/guix.texi:9451
17157 msgid "To describe a derivation and its build actions, one typically needs to embed build code inside host code. It boils down to manipulating build code as data, and the homoiconicity of Scheme---code has a direct representation as data---comes in handy for that. But we need more than the normal @code{quasiquote} mechanism in Scheme to construct build expressions."
17160 #. type: Plain text
17161 #: guix-git/doc/guix.texi:9460
17162 msgid "The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of S-expressions adapted to build expressions. G-expressions, or @dfn{gexps}, consist essentially of three syntactic forms: @code{gexp}, @code{ungexp}, and @code{ungexp-splicing} (or simply: @code{#~}, @code{#$}, and @code{#$@@}), which are comparable to @code{quasiquote}, @code{unquote}, and @code{unquote-splicing}, respectively (@pxref{Expression Syntax, @code{quasiquote},, guile, GNU Guile Reference Manual}). However, there are major differences:"
17166 #: guix-git/doc/guix.texi:9465
17167 msgid "Gexps are meant to be written to a file and run or manipulated by other processes."
17171 #: guix-git/doc/guix.texi:9470
17172 msgid "When a high-level object such as a package or derivation is unquoted inside a gexp, the result is as if its output file name had been introduced."
17176 #: guix-git/doc/guix.texi:9475
17177 msgid "Gexps carry information about the packages or derivations they refer to, and these dependencies are automatically added as inputs to the build processes that use them."
17181 #: guix-git/doc/guix.texi:9477 guix-git/doc/guix.texi:10034
17183 msgid "lowering, of high-level objects in gexps"
17186 #. type: Plain text
17187 #: guix-git/doc/guix.texi:9487
17188 msgid "This mechanism is not limited to package and derivation objects: @dfn{compilers} able to ``lower'' other high-level objects to derivations or files in the store can be defined, such that these objects can also be inserted into gexps. For example, a useful type of high-level objects that can be inserted in a gexp is ``file-like objects'', which make it easy to add files to the store and to refer to them in derivations and such (see @code{local-file} and @code{plain-file} below)."
17191 #. type: Plain text
17192 #: guix-git/doc/guix.texi:9489
17193 msgid "To illustrate the idea, here is an example of a gexp:"
17197 #: guix-git/doc/guix.texi:9497
17200 "(define build-exp\n"
17202 " (mkdir #$output)\n"
17203 " (chdir #$output)\n"
17204 " (symlink (string-append #$coreutils \"/bin/ls\")\n"
17205 " \"list-files\")))\n"
17208 #. type: Plain text
17209 #: guix-git/doc/guix.texi:9502
17210 msgid "This gexp can be passed to @code{gexp->derivation}; we obtain a derivation that builds a directory containing exactly one symlink to @file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}:"
17214 #: guix-git/doc/guix.texi:9505
17216 msgid "(gexp->derivation \"the-thing\" build-exp)\n"
17219 #. type: Plain text
17220 #: guix-git/doc/guix.texi:9513
17221 msgid "As one would expect, the @code{\"/gnu/store/@dots{}-coreutils-8.22\"} string is substituted to the reference to the @var{coreutils} package in the actual build code, and @var{coreutils} is automatically made an input to the derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp output)}) is replaced by a string containing the directory name of the output of the derivation."
17225 #: guix-git/doc/guix.texi:9514
17227 msgid "cross compilation"
17230 #. type: Plain text
17231 #: guix-git/doc/guix.texi:9520
17232 msgid "In a cross-compilation context, it is useful to distinguish between references to the @emph{native} build of a package---that can run on the host---versus references to cross builds of a package. To that end, the @code{#+} plays the same role as @code{#$}, but is a reference to a native package build:"
17236 #: guix-git/doc/guix.texi:9531
17239 "(gexp->derivation \"vi\"\n"
17241 " (mkdir #$output)\n"
17242 " (mkdir (string-append #$output \"/bin\"))\n"
17243 " (system* (string-append #+coreutils \"/bin/ln\")\n"
17245 " (string-append #$emacs \"/bin/emacs\")\n"
17246 " (string-append #$output \"/bin/vi\")))\n"
17247 " #:target \"aarch64-linux-gnu\")\n"
17250 #. type: Plain text
17251 #: guix-git/doc/guix.texi:9537
17252 msgid "In the example above, the native build of @var{coreutils} is used, so that @command{ln} can actually run on the host; but then the cross-compiled build of @var{emacs} is referenced."
17256 #: guix-git/doc/guix.texi:9538
17258 msgid "imported modules, for gexps"
17262 #: guix-git/doc/guix.texi:9539
17264 msgid "with-imported-modules"
17267 #. type: Plain text
17268 #: guix-git/doc/guix.texi:9544
17269 msgid "Another gexp feature is @dfn{imported modules}: sometimes you want to be able to use certain Guile modules from the ``host environment'' in the gexp, so those modules should be imported in the ``build environment''. The @code{with-imported-modules} form allows you to express that:"
17273 #: guix-git/doc/guix.texi:9555
17276 "(let ((build (with-imported-modules '((guix build utils))\n"
17278 " (use-modules (guix build utils))\n"
17279 " (mkdir-p (string-append #$output \"/bin\"))))))\n"
17280 " (gexp->derivation \"empty-dir\"\n"
17283 " (display \"success!\\n\")\n"
17287 #. type: Plain text
17288 #: guix-git/doc/guix.texi:9561
17289 msgid "In this example, the @code{(guix build utils)} module is automatically pulled into the isolated build environment of our gexp, such that @code{(use-modules (guix build utils))} works as expected."
17293 #: guix-git/doc/guix.texi:9562
17295 msgid "module closure"
17299 #: guix-git/doc/guix.texi:9563
17301 msgid "source-module-closure"
17304 #. type: Plain text
17305 #: guix-git/doc/guix.texi:9570
17306 msgid "Usually you want the @emph{closure} of the module to be imported---i.e., the module itself and all the modules it depends on---rather than just the module; failing to do that, attempts to use the module will fail because of missing dependent modules. The @code{source-module-closure} procedure computes the closure of a module by looking at its source file headers, which comes in handy in this case:"
17310 #: guix-git/doc/guix.texi:9573
17313 "(use-modules (guix modules)) ;for 'source-module-closure'\n"
17318 #: guix-git/doc/guix.texi:9582
17321 "(with-imported-modules (source-module-closure\n"
17322 " '((guix build utils)\n"
17323 " (gnu build vm)))\n"
17324 " (gexp->derivation \"something-with-vms\"\n"
17326 " (use-modules (guix build utils)\n"
17327 " (gnu build vm))\n"
17332 #: guix-git/doc/guix.texi:9584
17334 msgid "extensions, for gexps"
17338 #: guix-git/doc/guix.texi:9585
17340 msgid "with-extensions"
17343 #. type: Plain text
17344 #: guix-git/doc/guix.texi:9590
17345 msgid "In the same vein, sometimes you want to import not just pure-Scheme modules, but also ``extensions'' such as Guile bindings to C libraries or other ``full-blown'' packages. Say you need the @code{guile-json} package available on the build side, here's how you would do it:"
17349 #: guix-git/doc/guix.texi:9593
17352 "(use-modules (gnu packages guile)) ;for 'guile-json'\n"
17357 #: guix-git/doc/guix.texi:9599
17360 "(with-extensions (list guile-json)\n"
17361 " (gexp->derivation \"something-with-json\"\n"
17363 " (use-modules (json))\n"
17367 #. type: Plain text
17368 #: guix-git/doc/guix.texi:9602
17369 msgid "The syntactic form to construct gexps is summarized below."
17373 #: guix-git/doc/guix.texi:9603
17375 msgid "{Scheme Syntax} #~@var{exp}"
17379 #: guix-git/doc/guix.texi:9604
17381 msgid "{Scheme Syntax} (gexp @var{exp})"
17385 #: guix-git/doc/guix.texi:9607
17386 msgid "Return a G-expression containing @var{exp}. @var{exp} may contain one or more of the following forms:"
17390 #: guix-git/doc/guix.texi:9609
17392 msgid "#$@var{obj}"
17396 #: guix-git/doc/guix.texi:9610
17398 msgid "(ungexp @var{obj})"
17402 #: guix-git/doc/guix.texi:9615
17403 msgid "Introduce a reference to @var{obj}. @var{obj} may have one of the supported types, for example a package or a derivation, in which case the @code{ungexp} form is replaced by its output file name---e.g., @code{\"/gnu/store/@dots{}-coreutils-8.22}."
17407 #: guix-git/doc/guix.texi:9618
17408 msgid "If @var{obj} is a list, it is traversed and references to supported objects are substituted similarly."
17412 #: guix-git/doc/guix.texi:9621
17413 msgid "If @var{obj} is another gexp, its contents are inserted and its dependencies are added to those of the containing gexp."
17417 #: guix-git/doc/guix.texi:9623
17418 msgid "If @var{obj} is another kind of object, it is inserted as is."
17422 #: guix-git/doc/guix.texi:9624
17424 msgid "#$@var{obj}:@var{output}"
17428 #: guix-git/doc/guix.texi:9625
17430 msgid "(ungexp @var{obj} @var{output})"
17434 #: guix-git/doc/guix.texi:9629
17435 msgid "This is like the form above, but referring explicitly to the @var{output} of @var{obj}---this is useful when @var{obj} produces multiple outputs (@pxref{Packages with Multiple Outputs})."
17439 #: guix-git/doc/guix.texi:9630
17441 msgid "#+@var{obj}"
17445 #: guix-git/doc/guix.texi:9631
17447 msgid "#+@var{obj}:output"
17451 #: guix-git/doc/guix.texi:9632
17453 msgid "(ungexp-native @var{obj})"
17457 #: guix-git/doc/guix.texi:9633
17459 msgid "(ungexp-native @var{obj} @var{output})"
17463 #: guix-git/doc/guix.texi:9636
17464 msgid "Same as @code{ungexp}, but produces a reference to the @emph{native} build of @var{obj} when used in a cross compilation context."
17468 #: guix-git/doc/guix.texi:9637
17470 msgid "#$output[:@var{output}]"
17474 #: guix-git/doc/guix.texi:9638
17476 msgid "(ungexp output [@var{output}])"
17480 #: guix-git/doc/guix.texi:9641
17481 msgid "Insert a reference to derivation output @var{output}, or to the main output when @var{output} is omitted."
17485 #: guix-git/doc/guix.texi:9643
17486 msgid "This only makes sense for gexps passed to @code{gexp->derivation}."
17490 #: guix-git/doc/guix.texi:9644
17492 msgid "#$@@@var{lst}"
17496 #: guix-git/doc/guix.texi:9645
17498 msgid "(ungexp-splicing @var{lst})"
17502 #: guix-git/doc/guix.texi:9648
17503 msgid "Like the above, but splices the contents of @var{lst} inside the containing list."
17507 #: guix-git/doc/guix.texi:9649
17509 msgid "#+@@@var{lst}"
17513 #: guix-git/doc/guix.texi:9650
17515 msgid "(ungexp-native-splicing @var{lst})"
17519 #: guix-git/doc/guix.texi:9653
17520 msgid "Like the above, but refers to native builds of the objects listed in @var{lst}."
17524 #: guix-git/doc/guix.texi:9658
17525 msgid "G-expressions created by @code{gexp} or @code{#~} are run-time objects of the @code{gexp?} type (see below)."
17529 #: guix-git/doc/guix.texi:9660
17531 msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}"
17535 #: guix-git/doc/guix.texi:9663
17536 msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in their execution environment."
17540 #: guix-git/doc/guix.texi:9667
17541 msgid "Each item in @var{modules} can be the name of a module, such as @code{(guix build utils)}, or it can be a module name, followed by an arrow, followed by a file-like object:"
17545 #: guix-git/doc/guix.texi:9673
17548 "`((guix build utils)\n"
17550 " ((guix config) => ,(scheme-file \"config.scm\"\n"
17551 " #~(define-module @dots{}))))\n"
17555 #: guix-git/doc/guix.texi:9678
17556 msgid "In the example above, the first two modules are taken from the search path, and the last one is created from the given file-like object."
17560 #: guix-git/doc/guix.texi:9682
17561 msgid "This form has @emph{lexical} scope: it has an effect on the gexps directly defined in @var{body}@dots{}, but not on those defined, say, in procedures called from @var{body}@dots{}."
17565 #: guix-git/doc/guix.texi:9684
17567 msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}"
17571 #: guix-git/doc/guix.texi:9689
17572 msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{extensions} in their build and execution environment. @var{extensions} is typically a list of package objects such as those defined in the @code{(gnu packages guile)} module."
17576 #: guix-git/doc/guix.texi:9694
17577 msgid "Concretely, the packages listed in @var{extensions} are added to the load path while compiling imported modules in @var{body}@dots{}; they are also added to the load path of the gexp returned by @var{body}@dots{}."
17581 #: guix-git/doc/guix.texi:9696
17583 msgid "{Scheme Procedure} gexp? @var{obj}"
17587 #: guix-git/doc/guix.texi:9698
17588 msgid "Return @code{#t} if @var{obj} is a G-expression."
17591 #. type: Plain text
17592 #: guix-git/doc/guix.texi:9704
17593 msgid "G-expressions are meant to be written to disk, either as code building some derivation, or as plain files in the store. The monadic procedures below allow you to do that (@pxref{The Store Monad}, for more information about monads)."
17597 #: guix-git/doc/guix.texi:9705
17599 msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @"
17603 #: guix-git/doc/guix.texi:9723
17604 msgid "[#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:module-path @code{%load-path}] @ [#:effective-version \"2.2\"] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:leaked-env-vars #f] @ [#:script-name (string-append @var{name} \"-builder\")] @ [#:deprecation-warnings #f] @ [#:local-build? #f] [#:substitutable? #t] @ [#:properties '()] [#:guile-for-build #f] Return a derivation @var{name} that runs @var{exp} (a gexp) with @var{guile-for-build} (a derivation) on @var{system}; @var{exp} is stored in a file called @var{script-name}. When @var{target} is true, it is used as the cross-compilation target triplet for packages referred to by @var{exp}."
17608 #: guix-git/doc/guix.texi:9731
17609 msgid "@var{modules} is deprecated in favor of @code{with-imported-modules}. Its meaning is to make @var{modules} available in the evaluation context of @var{exp}; @var{modules} is a list of names of Guile modules searched in @var{module-path} to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}."
17613 #: guix-git/doc/guix.texi:9734
17614 msgid "@var{effective-version} determines the string to use when adding extensions of @var{exp} (see @code{with-extensions}) to the search path---e.g., @code{\"2.2\"}."
17618 #: guix-git/doc/guix.texi:9737
17619 msgid "@var{graft?} determines whether packages referred to by @var{exp} should be grafted when applicable."
17623 #: guix-git/doc/guix.texi:9740
17624 msgid "When @var{references-graphs} is true, it must be a list of tuples of one of the following forms:"
17628 #: guix-git/doc/guix.texi:9747
17631 "(@var{file-name} @var{package})\n"
17632 "(@var{file-name} @var{package} @var{output})\n"
17633 "(@var{file-name} @var{derivation})\n"
17634 "(@var{file-name} @var{derivation} @var{output})\n"
17635 "(@var{file-name} @var{store-item})\n"
17639 #: guix-git/doc/guix.texi:9753
17640 msgid "The right-hand-side of each element of @var{references-graphs} is automatically made an input of the build process of @var{exp}. In the build environment, each @var{file-name} contains the reference graph of the corresponding item, in a simple text format."
17644 #: guix-git/doc/guix.texi:9759
17645 msgid "@var{allowed-references} must be either @code{#f} or a list of output names and packages. In the latter case, the list denotes store items that the result is allowed to refer to. Any reference to another store item will lead to a build error. Similarly for @var{disallowed-references}, which can list items that must not be referenced by the outputs."
17649 #: guix-git/doc/guix.texi:9762
17650 msgid "@var{deprecation-warnings} determines whether to show deprecation warnings while compiling modules. It can be @code{#f}, @code{#t}, or @code{'detailed}."
17654 #: guix-git/doc/guix.texi:9764
17655 msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})."
17659 #: guix-git/doc/guix.texi:9766
17661 msgid "file-like objects"
17664 #. type: Plain text
17665 #: guix-git/doc/guix.texi:9771
17666 msgid "The @code{local-file}, @code{plain-file}, @code{computed-file}, @code{program-file}, and @code{scheme-file} procedures below return @dfn{file-like objects}. That is, when unquoted in a G-expression, these objects lead to a file in the store. Consider this G-expression:"
17670 #: guix-git/doc/guix.texi:9775
17673 "#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n"
17674 " #$(local-file \"/tmp/my-nscd.conf\"))\n"
17677 #. type: Plain text
17678 #: guix-git/doc/guix.texi:9784
17679 msgid "The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it to the store. Once expanded, for instance @i{via} @code{gexp->derivation}, the G-expression refers to that copy under @file{/gnu/store}; thus, modifying or removing the file in @file{/tmp} does not have any effect on what the G-expression does. @code{plain-file} can be used similarly; it differs in that the file content is directly passed as a string."
17683 #: guix-git/doc/guix.texi:9785
17685 msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @"
17689 #: guix-git/doc/guix.texi:9794
17690 msgid "[#:recursive? #f] [#:select? (const #t)] Return an object representing local file @var{file} to add to the store; this object can be used in a gexp. If @var{file} is a literal string denoting a relative file name, it is looked up relative to the source file where it appears; if @var{file} is not a literal string, it is looked up relative to the current working directory at run time. @var{file} will be added to the store under @var{name}--by default the base name of @var{file}."
17694 #: guix-git/doc/guix.texi:9806
17695 msgid "This is the declarative counterpart of the @code{interned-file} monadic procedure (@pxref{The Store Monad, @code{interned-file}})."
17699 #: guix-git/doc/guix.texi:9808
17701 msgid "{Scheme Procedure} plain-file @var{name} @var{content}"
17705 #: guix-git/doc/guix.texi:9811
17706 msgid "Return an object representing a text file called @var{name} with the given @var{content} (a string or a bytevector) to be added to the store."
17710 #: guix-git/doc/guix.texi:9813
17711 msgid "This is the declarative counterpart of @code{text-file}."
17715 #: guix-git/doc/guix.texi:9815
17717 msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @"
17721 #: guix-git/doc/guix.texi:9822
17722 msgid "[#:local-build? #t] [#:options '()] Return an object representing the store item @var{name}, a file or directory computed by @var{gexp}. When @var{local-build?} is true (the default), the derivation is built locally. @var{options} is a list of additional arguments to pass to @code{gexp->derivation}."
17726 #: guix-git/doc/guix.texi:9824
17727 msgid "This is the declarative counterpart of @code{gexp->derivation}."
17731 #: guix-git/doc/guix.texi:9826
17733 msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @"
17737 #: guix-git/doc/guix.texi:9832
17738 msgid "[#:guile (default-guile)] [#:module-path %load-path] @ [#:system (%current-system)] [#:target #f] Return an executable script @var{name} that runs @var{exp} using @var{guile}, with @var{exp}'s imported modules in its search path. Look up @var{exp}'s modules in @var{module-path}."
17742 #: guix-git/doc/guix.texi:9835
17743 msgid "The example below builds a script that simply invokes the @command{ls} command:"
17747 #: guix-git/doc/guix.texi:9838
17750 "(use-modules (guix gexp) (gnu packages base))\n"
17755 #: guix-git/doc/guix.texi:9842
17758 "(gexp->script \"list-files\"\n"
17759 " #~(execl #$(file-append coreutils \"/bin/ls\")\n"
17764 #: guix-git/doc/guix.texi:9847
17765 msgid "When ``running'' it through the store (@pxref{The Store Monad, @code{run-with-store}}), we obtain a derivation that produces an executable file @file{/gnu/store/@dots{}-list-files} along these lines:"
17769 #: guix-git/doc/guix.texi:9852
17772 "#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n"
17774 "(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n"
17778 #: guix-git/doc/guix.texi:9855
17780 msgid "{Scheme Procedure} program-file @var{name} @var{exp} @"
17784 #: guix-git/doc/guix.texi:9860
17785 msgid "[#:guile #f] [#:module-path %load-path] Return an object representing the executable store item @var{name} that runs @var{gexp}. @var{guile} is the Guile package used to execute that script. Imported modules of @var{gexp} are looked up in @var{module-path}."
17789 #: guix-git/doc/guix.texi:9862
17790 msgid "This is the declarative counterpart of @code{gexp->script}."
17794 #: guix-git/doc/guix.texi:9864
17796 msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @"
17800 #: guix-git/doc/guix.texi:9871
17801 msgid "[#:set-load-path? #t] [#:module-path %load-path] @ [#:splice? #f] @ [#:guile (default-guile)] Return a derivation that builds a file @var{name} containing @var{exp}. When @var{splice?} is true, @var{exp} is considered to be a list of expressions that will be spliced in the resulting file."
17805 #: guix-git/doc/guix.texi:9876
17806 msgid "When @var{set-load-path?} is true, emit code in the resulting file to set @code{%load-path} and @code{%load-compiled-path} to honor @var{exp}'s imported modules. Look up @var{exp}'s modules in @var{module-path}."
17810 #: guix-git/doc/guix.texi:9879
17811 msgid "The resulting file holds references to all the dependencies of @var{exp} or a subset thereof."
17815 #: guix-git/doc/guix.texi:9881
17817 msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} @"
17821 #: guix-git/doc/guix.texi:9885
17822 msgid "[#:splice? #f] [#:set-load-path? #t] Return an object representing the Scheme file @var{name} that contains @var{exp}."
17826 #: guix-git/doc/guix.texi:9887
17827 msgid "This is the declarative counterpart of @code{gexp->file}."
17831 #: guix-git/doc/guix.texi:9889
17833 msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}"
17837 #: guix-git/doc/guix.texi:9895
17838 msgid "Return as a monadic value a derivation that builds a text file containing all of @var{text}. @var{text} may list, in addition to strings, objects of any type that can be used in a gexp: packages, derivations, local file objects, etc. The resulting store file holds references to all these."
17842 #: guix-git/doc/guix.texi:9900
17843 msgid "This variant should be preferred over @code{text-file} anytime the file to create will reference items from the store. This is typically the case when building a configuration file that embeds store file names, like this:"
17847 #: guix-git/doc/guix.texi:9908
17850 "(define (profile.sh)\n"
17851 " ;; Return the name of a shell script in the store that\n"
17852 " ;; initializes the 'PATH' environment variable.\n"
17853 " (text-file* \"profile.sh\"\n"
17854 " \"export PATH=\" coreutils \"/bin:\"\n"
17855 " grep \"/bin:\" sed \"/bin\\n\"))\n"
17859 #: guix-git/doc/guix.texi:9913
17860 msgid "In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby preventing them from being garbage-collected during its lifetime."
17864 #: guix-git/doc/guix.texi:9915
17866 msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}"
17870 #: guix-git/doc/guix.texi:9919
17871 msgid "Return an object representing store file @var{name} containing @var{text}. @var{text} is a sequence of strings and file-like objects, as in:"
17875 #: guix-git/doc/guix.texi:9923
17878 "(mixed-text-file \"profile\"\n"
17879 " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n"
17883 #: guix-git/doc/guix.texi:9926
17884 msgid "This is the declarative counterpart of @code{text-file*}."
17888 #: guix-git/doc/guix.texi:9928
17890 msgid "{Scheme Procedure} file-union @var{name} @var{files}"
17894 #: guix-git/doc/guix.texi:9933
17895 msgid "Return a @code{<computed-file>} that builds a directory containing all of @var{files}. Each item in @var{files} must be a two-element list where the first element is the file name to use in the new directory, and the second element is a gexp denoting the target file. Here's an example:"
17899 #: guix-git/doc/guix.texi:9940
17902 "(file-union \"etc\"\n"
17903 " `((\"hosts\" ,(plain-file \"hosts\"\n"
17904 " \"127.0.0.1 localhost\"))\n"
17905 " (\"bashrc\" ,(plain-file \"bashrc\"\n"
17906 " \"alias ls='ls --color=auto'\"))))\n"
17910 #: guix-git/doc/guix.texi:9943
17911 msgid "This yields an @code{etc} directory containing these two files."
17915 #: guix-git/doc/guix.texi:9945
17917 msgid "{Scheme Procedure} directory-union @var{name} @var{things}"
17921 #: guix-git/doc/guix.texi:9948
17922 msgid "Return a directory that is the union of @var{things}, where @var{things} is a list of file-like objects denoting directories. For example:"
17926 #: guix-git/doc/guix.texi:9951
17928 msgid "(directory-union \"guile+emacs\" (list guile emacs))\n"
17932 #: guix-git/doc/guix.texi:9954
17933 msgid "yields a directory that is the union of the @code{guile} and @code{emacs} packages."
17937 #: guix-git/doc/guix.texi:9956
17939 msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}"
17943 #: guix-git/doc/guix.texi:9960
17944 msgid "Return a file-like object that expands to the concatenation of @var{obj} and @var{suffix}, where @var{obj} is a lowerable object and each @var{suffix} is a string."
17948 #: guix-git/doc/guix.texi:9962
17949 msgid "As an example, consider this gexp:"
17953 #: guix-git/doc/guix.texi:9967
17956 "(gexp->script \"run-uname\"\n"
17957 " #~(system* #$(file-append coreutils\n"
17958 " \"/bin/uname\")))\n"
17962 #: guix-git/doc/guix.texi:9970
17963 msgid "The same effect could be achieved with:"
17967 #: guix-git/doc/guix.texi:9975
17970 "(gexp->script \"run-uname\"\n"
17971 " #~(system* (string-append #$coreutils\n"
17972 " \"/bin/uname\")))\n"
17976 #: guix-git/doc/guix.texi:9981
17977 msgid "There is one difference though: in the @code{file-append} case, the resulting script contains the absolute file name as a string, whereas in the second case, the resulting script contains a @code{(string-append @dots{})} expression to construct the file name @emph{at run time}."
17981 #: guix-git/doc/guix.texi:9983
17983 msgid "{Scheme Syntax} let-system @var{system} @var{body}@dots{}"
17987 #: guix-git/doc/guix.texi:9984
17989 msgid "{Scheme Syntax} let-system (@var{system} @var{target}) @var{body}@dots{}"
17993 #: guix-git/doc/guix.texi:9987
17994 msgid "Bind @var{system} to the currently targeted system---e.g., @code{\"x86_64-linux\"}---within @var{body}."
17998 #: guix-git/doc/guix.texi:9992
17999 msgid "In the second case, additionally bind @var{target} to the current cross-compilation target---a GNU triplet such as @code{\"arm-linux-gnueabihf\"}---or @code{#f} if we are not cross-compiling."
18003 #: guix-git/doc/guix.texi:9995
18004 msgid "@code{let-system} is useful in the occasional case where the object spliced into the gexp depends on the target system, as in this example:"
18008 #: guix-git/doc/guix.texi:10006
18012 " #+(let-system system\n"
18013 " (cond ((string-prefix? \"armhf-\" system)\n"
18014 " (file-append qemu \"/bin/qemu-system-arm\"))\n"
18015 " ((string-prefix? \"x86_64-\" system)\n"
18016 " (file-append qemu \"/bin/qemu-system-x86_64\"))\n"
18018 " (error \"dunno!\"))))\n"
18019 " \"-net\" \"user\" #$image)\n"
18023 #: guix-git/doc/guix.texi:10009
18025 msgid "{Scheme Syntax} with-parameters ((@var{parameter} @var{value}) @dots{}) @var{exp}"
18029 #: guix-git/doc/guix.texi:10015
18030 msgid "This macro is similar to the @code{parameterize} form for dynamically-bound @dfn{parameters} (@pxref{Parameters,,, guile, GNU Guile Reference Manual}). The key difference is that it takes effect when the file-like object returned by @var{exp} is lowered to a derivation or store item."
18034 #: guix-git/doc/guix.texi:10018
18035 msgid "A typical use of @code{with-parameters} is to force the system in effect for a given object:"
18039 #: guix-git/doc/guix.texi:10022
18042 "(with-parameters ((%current-system \"i686-linux\"))\n"
18047 #: guix-git/doc/guix.texi:10026
18048 msgid "The example above returns an object that corresponds to the i686 build of Coreutils, regardless of the current value of @code{%current-system}."
18051 #. type: Plain text
18052 #: guix-git/doc/guix.texi:10033
18053 msgid "Of course, in addition to gexps embedded in ``host'' code, there are also modules containing build tools. To make it clear that they are meant to be used in the build stratum, these modules are kept in the @code{(guix build @dots{})} name space."
18056 #. type: Plain text
18057 #: guix-git/doc/guix.texi:10039
18058 msgid "Internally, high-level objects are @dfn{lowered}, using their compiler, to either derivations or store items. For instance, lowering a package yields a derivation, and lowering a @code{plain-file} yields a store item. This is achieved using the @code{lower-object} monadic procedure."
18062 #: guix-git/doc/guix.texi:10040
18064 msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @"
18068 #: guix-git/doc/guix.texi:10046
18069 msgid "[#:target #f] Return as a value in @code{%store-monad} the derivation or store item corresponding to @var{obj} for @var{system}, cross-compiling for @var{target} if @var{target} is true. @var{obj} must be an object that has an associated gexp compiler, such as a @code{<package>}."
18073 #: guix-git/doc/guix.texi:10049
18075 msgid "Invoking @command{guix repl}"
18079 #: guix-git/doc/guix.texi:10051
18081 msgid "REPL, read-eval-print loop, script"
18084 #. type: Plain text
18085 #: guix-git/doc/guix.texi:10061
18086 msgid "The @command{guix repl} command makes it easier to program Guix in Guile by launching a Guile @dfn{read-eval-print loop} (REPL) for interactive programming (@pxref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}), or by running Guile scripts (@pxref{Running Guile Scripts,,, guile, GNU Guile Reference Manual}). Compared to just launching the @command{guile} command, @command{guix repl} guarantees that all the Guix modules and all its dependencies are available in the search path."
18090 #: guix-git/doc/guix.texi:10066
18092 msgid "guix repl @var{options} [@var{file} @var{args}]\n"
18095 #. type: Plain text
18096 #: guix-git/doc/guix.texi:10070
18097 msgid "When a @var{file} argument is provided, @var{file} is executed as a Guile scripts:"
18101 #: guix-git/doc/guix.texi:10073
18103 msgid "guix repl my-script.scm\n"
18106 #. type: Plain text
18107 #: guix-git/doc/guix.texi:10077
18108 msgid "To pass arguments to the script, use @code{--} to prevent them from being interpreted as arguments to @command{guix repl} itself:"
18112 #: guix-git/doc/guix.texi:10080
18114 msgid "guix repl -- my-script.scm --input=foo.txt\n"
18117 #. type: Plain text
18118 #: guix-git/doc/guix.texi:10085
18119 msgid "To make a script executable directly from the shell, using the guix executable that is on the user's search path, add the following two lines at the top of the script:"
18123 #: guix-git/doc/guix.texi:10089
18126 "@code{#!/usr/bin/env -S guix repl --}\n"
18130 #. type: Plain text
18131 #: guix-git/doc/guix.texi:10092
18132 msgid "Without a file name argument, a Guile REPL is started:"
18136 #: guix-git/doc/guix.texi:10098
18140 "scheme@@(guile-user)> ,use (gnu packages base)\n"
18141 "scheme@@(guile-user)> coreutils\n"
18142 "$1 = #<package coreutils@@8.29 gnu/packages/base.scm:327 3e28300>\n"
18145 #. type: Plain text
18146 #: guix-git/doc/guix.texi:10105
18147 msgid "In addition, @command{guix repl} implements a simple machine-readable REPL protocol for use by @code{(guix inferior)}, a facility to interact with @dfn{inferiors}, separate processes running a potentially different revision of Guix."
18150 #. type: Plain text
18151 #: guix-git/doc/guix.texi:10107
18152 msgid "The available options are as follows:"
18156 #: guix-git/doc/guix.texi:10109 guix-git/doc/guix.texi:12501
18158 msgid "--type=@var{type}"
18162 #: guix-git/doc/guix.texi:10110 guix-git/doc/guix.texi:12502
18163 #: guix-git/doc/guix.texi:33191
18165 msgid "-t @var{type}"
18169 #: guix-git/doc/guix.texi:10112
18170 msgid "Start a REPL of the given @var{TYPE}, which can be one of the following:"
18174 #: guix-git/doc/guix.texi:10114
18180 #: guix-git/doc/guix.texi:10116
18181 msgid "This is default, and it spawns a standard full-featured Guile REPL."
18185 #: guix-git/doc/guix.texi:10116
18191 #: guix-git/doc/guix.texi:10119
18192 msgid "Spawn a REPL that uses the machine-readable protocol. This is the protocol that the @code{(guix inferior)} module speaks."
18196 #: guix-git/doc/guix.texi:10125
18197 msgid "By default, @command{guix repl} reads from standard input and writes to standard output. When this option is passed, it will instead listen for connections on @var{endpoint}. Here are examples of valid options:"
18201 #: guix-git/doc/guix.texi:10127
18203 msgid "--listen=tcp:37146"
18207 #: guix-git/doc/guix.texi:10129
18208 msgid "Accept connections on localhost on port 37146."
18212 #: guix-git/doc/guix.texi:10130
18214 msgid "--listen=unix:/tmp/socket"
18218 #: guix-git/doc/guix.texi:10132
18219 msgid "Accept connections on the Unix-domain socket @file{/tmp/socket}."
18223 #: guix-git/doc/guix.texi:10134 guix-git/doc/guix.texi:10238
18224 #: guix-git/doc/guix.texi:11970 guix-git/doc/guix.texi:12150
18225 #: guix-git/doc/guix.texi:12295 guix-git/doc/guix.texi:12549
18227 msgid "--load-path=@var{directory}"
18231 #: guix-git/doc/guix.texi:10135 guix-git/doc/guix.texi:10239
18232 #: guix-git/doc/guix.texi:12151 guix-git/doc/guix.texi:12296
18233 #: guix-git/doc/guix.texi:12550
18235 msgid "-L @var{directory}"
18239 #: guix-git/doc/guix.texi:10138 guix-git/doc/guix.texi:10242
18240 #: guix-git/doc/guix.texi:11973 guix-git/doc/guix.texi:12154
18241 #: guix-git/doc/guix.texi:12299 guix-git/doc/guix.texi:12553
18242 msgid "Add @var{directory} to the front of the package module search path (@pxref{Package Modules})."
18246 #: guix-git/doc/guix.texi:10141
18247 msgid "This allows users to define their own packages and make them visible to the script or REPL."
18251 #: guix-git/doc/guix.texi:10142 guix-git/doc/guix.texi:10701
18257 #: guix-git/doc/guix.texi:10145
18258 msgid "Inhibit loading of the @file{~/.guile} file. By default, that configuration file is loaded when spawning a @code{guile} REPL."
18261 #. type: Plain text
18262 #: guix-git/doc/guix.texi:10155
18263 msgid "This section describes Guix command-line utilities. Some of them are primarily targeted at developers and users who write new package definitions, while others are more generally useful. They complement the Scheme programming interface of Guix in a convenient way."
18267 #: guix-git/doc/guix.texi:10177
18269 msgid "package building"
18272 #. type: command{#1}
18273 #: guix-git/doc/guix.texi:10178
18278 #. type: Plain text
18279 #: guix-git/doc/guix.texi:10184
18280 msgid "The @command{guix build} command builds packages or derivations and their dependencies, and prints the resulting store paths. Note that it does not modify the user's profile---this is the job of the @command{guix package} command (@pxref{Invoking guix package}). Thus, it is mainly useful for distribution developers."
18284 #: guix-git/doc/guix.texi:10189
18286 msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n"
18289 #. type: Plain text
18290 #: guix-git/doc/guix.texi:10194
18291 msgid "As an example, the following command builds the latest versions of Emacs and of Guile, displays their build logs, and finally displays the resulting directories:"
18295 #: guix-git/doc/guix.texi:10197
18297 msgid "guix build emacs guile\n"
18300 #. type: Plain text
18301 #: guix-git/doc/guix.texi:10200
18302 msgid "Similarly, the following command builds all the available packages:"
18306 #: guix-git/doc/guix.texi:10204
18309 "guix build --quiet --keep-going \\\n"
18310 " $(guix package -A | cut -f1,2 --output-delimiter=@@)\n"
18313 #. type: Plain text
18314 #: guix-git/doc/guix.texi:10212
18315 msgid "@var{package-or-derivation} may be either the name of a package found in the software distribution such as @code{coreutils} or @code{coreutils@@8.20}, or a derivation such as @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the former case, a package with the corresponding name (and optionally version) is searched for among the GNU distribution modules (@pxref{Package Modules})."
18318 #. type: Plain text
18319 #: guix-git/doc/guix.texi:10217
18320 msgid "Alternatively, the @option{--expression} option may be used to specify a Scheme expression that evaluates to a package; this is useful when disambiguating among several same-named packages or package variants is needed."
18323 #. type: Plain text
18324 #: guix-git/doc/guix.texi:10220
18325 msgid "There may be zero or more @var{options}. The available options are described in the subsections below."
18328 #. type: Plain text
18329 #: guix-git/doc/guix.texi:10235
18330 msgid "A number of options that control the build process are common to @command{guix build} and other commands that can spawn builds, such as @command{guix package} or @command{guix archive}. These are the following:"
18334 #: guix-git/doc/guix.texi:10245 guix-git/doc/guix.texi:11976
18335 #: guix-git/doc/guix.texi:12157 guix-git/doc/guix.texi:12302
18336 #: guix-git/doc/guix.texi:12556
18337 msgid "This allows users to define their own packages and make them visible to the command-line tools."
18341 #: guix-git/doc/guix.texi:10246
18343 msgid "--keep-failed"
18347 #: guix-git/doc/guix.texi:10247
18353 #: guix-git/doc/guix.texi:10253
18354 msgid "Keep the build tree of failed builds. Thus, if a build fails, its build tree is kept under @file{/tmp}, in a directory whose name is shown at the end of the build log. This is useful when debugging build issues. @xref{Debugging Build Failures}, for tips and tricks on how to debug build issues."
18358 #: guix-git/doc/guix.texi:10257
18359 msgid "This option implies @option{--no-offload}, and it has no effect when connecting to a remote daemon with a @code{guix://} URI (@pxref{The Store, the @env{GUIX_DAEMON_SOCKET} variable})."
18363 #: guix-git/doc/guix.texi:10258
18365 msgid "--keep-going"
18369 #: guix-git/doc/guix.texi:10259
18375 #: guix-git/doc/guix.texi:10262
18376 msgid "Keep going when some of the derivations fail to build; return only once all the builds have either completed or failed."
18380 #: guix-git/doc/guix.texi:10265
18381 msgid "The default behavior is to stop as soon as one of the specified derivations has failed."
18385 #: guix-git/doc/guix.texi:10269
18386 msgid "Do not build the derivations."
18389 #. type: anchor{#1}
18390 #: guix-git/doc/guix.texi:10271
18391 msgid "fallback-option"
18395 #: guix-git/doc/guix.texi:10271
18401 #: guix-git/doc/guix.texi:10274
18402 msgid "When substituting a pre-built binary fails, fall back to building packages locally (@pxref{Substitution Failure})."
18405 #. type: anchor{#1}
18406 #: guix-git/doc/guix.texi:10280
18407 msgid "client-substitute-urls"
18411 #: guix-git/doc/guix.texi:10280
18412 msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs, overriding the default list of URLs of @command{guix-daemon} (@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs})."
18416 #: guix-git/doc/guix.texi:10284
18417 msgid "This means that substitutes may be downloaded from @var{urls}, provided they are signed by a key authorized by the system administrator (@pxref{Substitutes})."
18421 #: guix-git/doc/guix.texi:10287
18422 msgid "When @var{urls} is the empty string, substitutes are effectively disabled."
18426 #: guix-git/doc/guix.texi:10293
18428 msgid "--no-grafts"
18432 #: guix-git/doc/guix.texi:10297
18433 msgid "Do not ``graft'' packages. In practice, this means that package updates available as grafts are not applied. @xref{Security Updates}, for more information on grafts."
18437 #: guix-git/doc/guix.texi:10298
18439 msgid "--rounds=@var{n}"
18443 #: guix-git/doc/guix.texi:10301
18444 msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical."
18448 #: guix-git/doc/guix.texi:10306
18449 msgid "This is a useful way to detect non-deterministic builds processes. Non-deterministic build processes are a problem because they make it practically impossible for users to @emph{verify} whether third-party binaries are genuine. @xref{Invoking guix challenge}, for more."
18453 #: guix-git/doc/guix.texi:10322
18454 msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--max-silent-time}})."
18458 #: guix-git/doc/guix.texi:10329
18459 msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--timeout}})."
18463 #: guix-git/doc/guix.texi:10332
18465 msgid "verbosity, of the command-line tools"
18469 #: guix-git/doc/guix.texi:10333
18471 msgid "build logs, verbosity"
18475 #: guix-git/doc/guix.texi:10334
18477 msgid "-v @var{level}"
18481 #: guix-git/doc/guix.texi:10335
18483 msgid "--verbosity=@var{level}"
18487 #: guix-git/doc/guix.texi:10340
18488 msgid "Use the given verbosity @var{level}, an integer. Choosing 0 means that no output is produced, 1 is for quiet output; 2 is similar to 1 but it additionally displays download URLs; 3 shows all the build log output on standard error."
18492 #: guix-git/doc/guix.texi:10345
18493 msgid "Allow the use of up to @var{n} CPU cores for the build. The special value @code{0} means to use as many CPU cores as available."
18497 #: guix-git/doc/guix.texi:10351
18498 msgid "Allow at most @var{n} build jobs in parallel. @xref{Invoking guix-daemon, @option{--max-jobs}}, for details about this option and the equivalent @command{guix-daemon} option."
18502 #: guix-git/doc/guix.texi:10352
18504 msgid "--debug=@var{level}"
18508 #: guix-git/doc/guix.texi:10356
18509 msgid "Produce debugging output coming from the build daemon. @var{level} must be an integer between 0 and 5; higher means more verbose output. Setting a level of 4 or more may be helpful when debugging setup issues with the build daemon."
18512 #. type: Plain text
18513 #: guix-git/doc/guix.texi:10363
18514 msgid "Behind the scenes, @command{guix build} is essentially an interface to the @code{package-derivation} procedure of the @code{(guix packages)} module, and to the @code{build-derivations} procedure of the @code{(guix derivations)} module."
18517 #. type: Plain text
18518 #: guix-git/doc/guix.texi:10367
18519 msgid "In addition to options explicitly passed on the command line, @command{guix build} and other @command{guix} commands that support building honor the @env{GUIX_BUILD_OPTIONS} environment variable."
18523 #: guix-git/doc/guix.texi:10368
18525 msgid "{Environment Variable} GUIX_BUILD_OPTIONS"
18529 #: guix-git/doc/guix.texi:10373
18530 msgid "Users can define this variable to a list of command line options that will automatically be used by @command{guix build} and other @command{guix} commands that can perform builds, as in the example below:"
18534 #: guix-git/doc/guix.texi:10376
18536 msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n"
18540 #: guix-git/doc/guix.texi:10380
18541 msgid "These options are parsed independently, and the result is appended to the parsed command-line options."
18545 #: guix-git/doc/guix.texi:10386
18547 msgid "package variants"
18550 #. type: Plain text
18551 #: guix-git/doc/guix.texi:10394
18552 msgid "Another set of command-line options supported by @command{guix build} and also @command{guix package} are @dfn{package transformation options}. These are options that make it possible to define @dfn{package variants}---for instance, packages built from different source code. This is a convenient way to create customized packages on the fly without having to type in the definitions of package variants (@pxref{Defining Packages})."
18555 #. type: Plain text
18556 #: guix-git/doc/guix.texi:10398
18557 msgid "Package transformation options are preserved across upgrades: @command{guix upgrade} attempts to apply transformation options initially used when creating the profile to the upgraded packages."
18560 #. type: Plain text
18561 #: guix-git/doc/guix.texi:10403
18562 msgid "The available options are listed below. Most commands support them and also support a @option{--help-transform} option that lists all the available options and a synopsis (these options are not shown in the @option{--help} output for brevity)."
18566 #: guix-git/doc/guix.texi:10406
18568 msgid "--with-source=@var{source}"
18572 #: guix-git/doc/guix.texi:10407
18574 msgid "--with-source=@var{package}=@var{source}"
18578 #: guix-git/doc/guix.texi:10408
18580 msgid "--with-source=@var{package}@@@var{version}=@var{source}"
18584 #: guix-git/doc/guix.texi:10413
18585 msgid "Use @var{source} as the source of @var{package}, and @var{version} as its version number. @var{source} must be a file name or a URL, as for @command{guix download} (@pxref{Invoking guix download})."
18589 #: guix-git/doc/guix.texi:10419
18590 msgid "When @var{package} is omitted, it is taken to be the package name specified on the command line that matches the base of @var{source}---e.g., if @var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding package is @code{guile}."
18594 #: guix-git/doc/guix.texi:10422
18595 msgid "Likewise, when @var{version} is omitted, the version string is inferred from @var{source}; in the previous example, it is @code{2.0.10}."
18599 #: guix-git/doc/guix.texi:10427
18600 msgid "This option allows users to try out versions of packages other than the one provided by the distribution. The example below downloads @file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for the @code{ed} package:"
18604 #: guix-git/doc/guix.texi:10430
18606 msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n"
18610 #: guix-git/doc/guix.texi:10434
18611 msgid "As a developer, @option{--with-source} makes it easy to test release candidates:"
18615 #: guix-git/doc/guix.texi:10437
18617 msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n"
18621 #: guix-git/doc/guix.texi:10440
18622 msgid "@dots{} or to build from a checkout in a pristine environment:"
18626 #: guix-git/doc/guix.texi:10444
18629 "$ git clone git://git.sv.gnu.org/guix.git\n"
18630 "$ guix build guix --with-source=guix@@1.0=./guix\n"
18634 #: guix-git/doc/guix.texi:10446
18636 msgid "--with-input=@var{package}=@var{replacement}"
18640 #: guix-git/doc/guix.texi:10451
18641 msgid "Replace dependency on @var{package} by a dependency on @var{replacement}. @var{package} must be a package name, and @var{replacement} must be a package specification such as @code{guile} or @code{guile@@1.8}."
18645 #: guix-git/doc/guix.texi:10455
18646 msgid "For instance, the following command builds Guix, but replaces its dependency on the current stable version of Guile with a dependency on the legacy version of Guile, @code{guile@@2.0}:"
18650 #: guix-git/doc/guix.texi:10458
18652 msgid "guix build --with-input=guile=guile@@2.0 guix\n"
18656 #: guix-git/doc/guix.texi:10463
18657 msgid "This is a recursive, deep replacement. So in this example, both @code{guix} and its dependency @code{guile-json} (which also depends on @code{guile}) get rebuilt against @code{guile@@2.0}."
18661 #: guix-git/doc/guix.texi:10466
18662 msgid "This is implemented using the @code{package-input-rewriting} Scheme procedure (@pxref{Defining Packages, @code{package-input-rewriting}})."
18666 #: guix-git/doc/guix.texi:10467
18668 msgid "--with-graft=@var{package}=@var{replacement}"
18672 #: guix-git/doc/guix.texi:10473
18673 msgid "This is similar to @option{--with-input} but with an important difference: instead of rebuilding the whole dependency chain, @var{replacement} is built and then @dfn{grafted} onto the binaries that were initially referring to @var{package}. @xref{Security Updates}, for more information on grafts."
18677 #: guix-git/doc/guix.texi:10477
18678 msgid "For example, the command below grafts version 3.5.4 of GnuTLS onto Wget and all its dependencies, replacing references to the version of GnuTLS they currently refer to:"
18682 #: guix-git/doc/guix.texi:10480
18684 msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n"
18688 #: guix-git/doc/guix.texi:10489
18689 msgid "This has the advantage of being much faster than rebuilding everything. But there is a caveat: it works if and only if @var{package} and @var{replacement} are strictly compatible---for example, if they provide a library, the application binary interface (ABI) of those libraries must be compatible. If @var{replacement} is somehow incompatible with @var{package}, then the resulting package may be unusable. Use with care!"
18693 #: guix-git/doc/guix.texi:10490 guix-git/doc/guix.texi:34534
18695 msgid "debugging info, rebuilding"
18699 #: guix-git/doc/guix.texi:10491
18701 msgid "--with-debug-info=@var{package}"
18705 #: guix-git/doc/guix.texi:10496
18706 msgid "Build @var{package} in a way that preserves its debugging info and graft it onto packages that depend on it. This is useful if @var{package} does not already provide debugging info as a @code{debug} output (@pxref{Installing Debugging Files})."
18710 #: guix-git/doc/guix.texi:10502
18711 msgid "For example, suppose you're experiencing a crash in Inkscape and would like to see what's up in GLib, a library deep down in Inkscape's dependency graph. GLib lacks a @code{debug} output, so debugging is tough. Fortunately, you rebuild GLib with debugging info and tack it on Inkscape:"
18715 #: guix-git/doc/guix.texi:10505 guix-git/doc/guix.texi:34565
18717 msgid "guix install inkscape --with-debug-info=glib\n"
18721 #: guix-git/doc/guix.texi:10509
18722 msgid "Only GLib needs to be recompiled so this takes a reasonable amount of time. @xref{Installing Debugging Files}, for more info."
18726 #: guix-git/doc/guix.texi:10515
18727 msgid "Under the hood, this option works by passing the @samp{#:strip-binaries? #f} to the build system of the package of interest (@pxref{Build Systems}). Most build systems support that option but some do not. In that case, an error is raised."
18731 #: guix-git/doc/guix.texi:10519
18732 msgid "Likewise, if a C/C++ package is built without @code{-g} (which is rarely the case), debugging info will remain unavailable even when @code{#:strip-binaries?} is false."
18736 #: guix-git/doc/guix.texi:10521
18738 msgid "tool chain, changing the build tool chain of a package"
18742 #: guix-git/doc/guix.texi:10522
18744 msgid "--with-c-toolchain=@var{package}=@var{toolchain}"
18748 #: guix-git/doc/guix.texi:10526
18749 msgid "This option changes the compilation of @var{package} and everything that depends on it so that they get built with @var{toolchain} instead of the default GNU tool chain for C/C++."
18753 #: guix-git/doc/guix.texi:10533
18756 "guix build octave-cli \\\n"
18757 " --with-c-toolchain=fftw=gcc-toolchain@@10 \\\n"
18758 " --with-c-toolchain=fftwf=gcc-toolchain@@10\n"
18762 #: guix-git/doc/guix.texi:10540
18763 msgid "The command above builds a variant of the @code{fftw} and @code{fftwf} packages using version 10 of @code{gcc-toolchain} instead of the default tool chain, and then builds a variant of the GNU@tie{}Octave command-line interface using them. GNU@tie{}Octave itself is also built with @code{gcc-toolchain@@10}."
18767 #: guix-git/doc/guix.texi:10544
18768 msgid "This other example builds the Hardware Locality (@code{hwloc}) library and its dependents up to @code{intel-mpi-benchmarks} with the Clang C compiler:"
18772 #: guix-git/doc/guix.texi:10548
18775 "guix build --with-c-toolchain=hwloc=clang-toolchain \\\n"
18776 " intel-mpi-benchmarks\n"
18780 #: guix-git/doc/guix.texi:10557
18781 msgid "There can be application binary interface (ABI) incompatibilities among tool chains. This is particularly true of the C++ standard library and run-time support libraries such as that of OpenMP@. By rebuilding all dependents with the same tool chain, @option{--with-c-toolchain} minimizes the risks of incompatibility but cannot entirely eliminate them. Choose @var{package} wisely."
18785 #: guix-git/doc/guix.texi:10559
18787 msgid "--with-git-url=@var{package}=@var{url}"
18791 #: guix-git/doc/guix.texi:10560
18793 msgid "Git, using the latest commit"
18797 #: guix-git/doc/guix.texi:10561
18799 msgid "latest commit, building"
18803 #: guix-git/doc/guix.texi:10565
18804 msgid "Build @var{package} from the latest commit of the @code{master} branch of the Git repository at @var{url}. Git sub-modules of the repository are fetched, recursively."
18808 #: guix-git/doc/guix.texi:10568
18809 msgid "For example, the following command builds the NumPy Python library against the latest commit of the master branch of Python itself:"
18813 #: guix-git/doc/guix.texi:10572
18816 "guix build python-numpy \\\n"
18817 " --with-git-url=python=https://github.com/python/cpython\n"
18821 #: guix-git/doc/guix.texi:10576
18822 msgid "This option can also be combined with @option{--with-branch} or @option{--with-commit} (see below)."
18826 #: guix-git/doc/guix.texi:10577 guix-git/doc/guix.texi:27233
18828 msgid "continuous integration"
18832 #: guix-git/doc/guix.texi:10583
18833 msgid "Obviously, since it uses the latest commit of the given branch, the result of such a command varies over time. Nevertheless it is a convenient way to rebuild entire software stacks against the latest commit of one or more packages. This is particularly useful in the context of continuous integration (CI)."
18837 #: guix-git/doc/guix.texi:10587
18838 msgid "Checkouts are kept in a cache under @file{~/.cache/guix/checkouts} to speed up consecutive accesses to the same repository. You may want to clean it up once in a while to save disk space."
18842 #: guix-git/doc/guix.texi:10588
18844 msgid "--with-branch=@var{package}=@var{branch}"
18848 #: guix-git/doc/guix.texi:10594
18849 msgid "Build @var{package} from the latest commit of @var{branch}. If the @code{source} field of @var{package} is an origin with the @code{git-fetch} method (@pxref{origin Reference}) or a @code{git-checkout} object, the repository URL is taken from that @code{source}. Otherwise you have to use @option{--with-git-url} to specify the URL of the Git repository."
18853 #: guix-git/doc/guix.texi:10599
18854 msgid "For instance, the following command builds @code{guile-sqlite3} from the latest commit of its @code{master} branch, and then builds @code{guix} (which depends on it) and @code{cuirass} (which depends on @code{guix}) against this specific @code{guile-sqlite3} build:"
18858 #: guix-git/doc/guix.texi:10602
18860 msgid "guix build --with-branch=guile-sqlite3=master cuirass\n"
18864 #: guix-git/doc/guix.texi:10604
18866 msgid "--with-commit=@var{package}=@var{commit}"
18870 #: guix-git/doc/guix.texi:10608
18871 msgid "This is similar to @option{--with-branch}, except that it builds from @var{commit} rather than the tip of a branch. @var{commit} must be a valid Git commit SHA1 identifier or a tag."
18875 #: guix-git/doc/guix.texi:10609
18877 msgid "--with-patch=@var{package}=@var{file}"
18881 #: guix-git/doc/guix.texi:10616
18882 msgid "Add @var{file} to the list of patches applied to @var{package}, where @var{package} is a spec such as @code{python@@3.8} or @code{glibc}. @var{file} must contain a patch; it is applied with the flags specified in the @code{origin} of @var{package} (@pxref{origin Reference}), which by default includes @code{-p1} (@pxref{patch Directories,,, diffutils, Comparing and Merging Files})."
18886 #: guix-git/doc/guix.texi:10619
18887 msgid "As an example, the command below rebuilds Coreutils with the GNU C Library (glibc) patched with the given patch:"
18891 #: guix-git/doc/guix.texi:10622
18893 msgid "guix build coreutils --with-patch=glibc=./glibc-frob.patch\n"
18897 #: guix-git/doc/guix.texi:10626
18898 msgid "In this example, glibc itself as well as everything that leads to Coreutils in the dependency graph is rebuilt."
18902 #: guix-git/doc/guix.texi:10627
18904 msgid "upstream, latest version"
18908 #: guix-git/doc/guix.texi:10628
18910 msgid "--with-latest=@var{package}"
18914 #: guix-git/doc/guix.texi:10633
18915 msgid "So you like living on the bleeding edge? This option is for you! It replaces occurrences of @var{package} in the dependency graph with its latest upstream version, as reported by @command{guix refresh} (@pxref{Invoking guix refresh})."
18919 #: guix-git/doc/guix.texi:10637
18920 msgid "It does so by determining the latest upstream release of @var{package} (if possible), downloading it, and authenticating it @emph{if} it comes with an OpenPGP signature."
18924 #: guix-git/doc/guix.texi:10640
18925 msgid "As an example, the command below builds Guix against the latest version of Guile-JSON:"
18929 #: guix-git/doc/guix.texi:10643
18931 msgid "guix build guix --with-latest=guile-json\n"
18935 #: guix-git/doc/guix.texi:10652
18936 msgid "There are limitations. First, in cases where the tool cannot or does not know how to authenticate source code, you are at risk of running malicious code; a warning is emitted in this case. Second, this option simply changes the source used in the existing package definitions, which is not always sufficient: there might be additional dependencies that need to be added, patches to apply, and more generally the quality assurance work that Guix developers normally do will be missing."
18940 #: guix-git/doc/guix.texi:10657
18941 msgid "You've been warned! In all the other cases, it's a snappy way to stay on top. We encourage you to submit patches updating the actual package definitions once you have successfully tested an upgrade (@pxref{Contributing})."
18945 #: guix-git/doc/guix.texi:10658
18947 msgid "test suite, skipping"
18951 #: guix-git/doc/guix.texi:10659
18953 msgid "--without-tests=@var{package}"
18957 #: guix-git/doc/guix.texi:10665
18958 msgid "Build @var{package} without running its tests. This can be useful in situations where you want to skip the lengthy test suite of a intermediate package, or if a package's test suite fails in a non-deterministic fashion. It should be used with care because running the test suite is a good way to ensure a package is working as intended."
18962 #: guix-git/doc/guix.texi:10669
18963 msgid "Turning off tests leads to a different store item. Consequently, when using this option, anything that depends on @var{package} must be rebuilt, as in this example:"
18967 #: guix-git/doc/guix.texi:10672
18969 msgid "guix install --without-tests=python python-notebook\n"
18973 #: guix-git/doc/guix.texi:10678
18974 msgid "The command above installs @code{python-notebook} on top of @code{python} built without running its test suite. To do so, it also rebuilds everything that depends on @code{python}, including @code{python-notebook} itself."
18978 #: guix-git/doc/guix.texi:10684
18979 msgid "Internally, @option{--without-tests} relies on changing the @code{#:tests?} option of a package's @code{check} phase (@pxref{Build Systems}). Note that some packages use a customized @code{check} phase that does not respect a @code{#:tests? #f} setting. Therefore, @option{--without-tests} has no effect on these packages."
18982 #. type: Plain text
18983 #: guix-git/doc/guix.texi:10691
18984 msgid "Wondering how to achieve the same effect using Scheme code, for example in your manifest, or how to write your own package transformation? @xref{Defining Package Variants}, for an overview of the programming interfaces available."
18987 #. type: Plain text
18988 #: guix-git/doc/guix.texi:10697
18989 msgid "The command-line options presented below are specific to @command{guix build}."
18993 #: guix-git/doc/guix.texi:10700
18999 #: guix-git/doc/guix.texi:10705
19000 msgid "Build quietly, without displaying the build log; this is equivalent to @option{--verbosity=0}. Upon completion, the build log is kept in @file{/var} (or similar) and can always be retrieved using the @option{--log-file} option."
19004 #: guix-git/doc/guix.texi:10706
19006 msgid "--file=@var{file}"
19010 #: guix-git/doc/guix.texi:10710
19011 msgid "Build the package, derivation, or other file-like object that the code within @var{file} evaluates to (@pxref{G-Expressions, file-like objects})."
19015 #: guix-git/doc/guix.texi:10713
19016 msgid "As an example, @var{file} might contain a package definition like this (@pxref{Defining Packages}):"
19020 #: guix-git/doc/guix.texi:10722
19021 msgid "The @var{file} may also contain a JSON representation of one or more package definitions. Running @code{guix build -f} on @file{hello.json} with the following contents would result in building the packages @code{myhello} and @code{greeter}:"
19025 #: guix-git/doc/guix.texi:10727
19027 msgid "--manifest=@var{manifest}"
19031 #: guix-git/doc/guix.texi:10728
19033 msgid "-m @var{manifest}"
19037 #: guix-git/doc/guix.texi:10731
19038 msgid "Build all packages listed in the given @var{manifest} (@pxref{profile-manifest, @option{--manifest}})."
19042 #: guix-git/doc/guix.texi:10735
19043 msgid "Build the package or derivation @var{expr} evaluates to."
19047 #: guix-git/doc/guix.texi:10739
19048 msgid "For example, @var{expr} may be @code{(@@ (gnu packages guile) guile-1.8)}, which unambiguously designates this specific variant of version 1.8 of Guile."
19052 #: guix-git/doc/guix.texi:10743
19053 msgid "Alternatively, @var{expr} may be a G-expression, in which case it is used as a build program passed to @code{gexp->derivation} (@pxref{G-Expressions})."
19057 #: guix-git/doc/guix.texi:10747
19058 msgid "Lastly, @var{expr} may refer to a zero-argument monadic procedure (@pxref{The Store Monad}). The procedure must return a derivation as a monadic value, which is then passed through @code{run-with-store}."
19062 #: guix-git/doc/guix.texi:10748
19068 #: guix-git/doc/guix.texi:10749
19074 #: guix-git/doc/guix.texi:10752
19075 msgid "Build the source derivations of the packages, rather than the packages themselves."
19079 #: guix-git/doc/guix.texi:10756
19080 msgid "For instance, @code{guix build -S gcc} returns something like @file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC source tarball."
19084 #: guix-git/doc/guix.texi:10760
19085 msgid "The returned source tarball is the result of applying any patches and code snippets specified in the package @code{origin} (@pxref{Defining Packages})."
19089 #: guix-git/doc/guix.texi:10761
19091 msgid "source, verification"
19095 #: guix-git/doc/guix.texi:10767
19096 msgid "As with other derivations, the result of building a source derivation can be verified using the @option{--check} option (@pxref{build-check}). This is useful to validate that a (potentially already built or substituted, thus cached) package source matches against its declared hash."
19100 #: guix-git/doc/guix.texi:10772
19101 msgid "Note that @command{guix build -S} compiles the sources only of the specified packages. They do not include the sources of statically linked dependencies and by themselves are insufficient for reproducing the packages."
19105 #: guix-git/doc/guix.texi:10773
19111 #: guix-git/doc/guix.texi:10780
19112 msgid "Fetch and return the source of @var{package-or-derivation} and all their dependencies, recursively. This is a handy way to obtain a local copy of all the source code needed to build @var{packages}, allowing you to eventually build them even without network access. It is an extension of the @option{--source} option and can accept one of the following optional argument values:"
19116 #: guix-git/doc/guix.texi:10782 guix-git/doc/guix.texi:12356
19122 #: guix-git/doc/guix.texi:10785
19123 msgid "This value causes the @option{--sources} option to behave in the same way as the @option{--source} option."
19127 #: guix-git/doc/guix.texi:10786 guix-git/doc/guix.texi:18302
19133 #: guix-git/doc/guix.texi:10789
19134 msgid "Build the source derivations of all packages, including any source that might be listed as @code{inputs}. This is the default value."
19138 #: guix-git/doc/guix.texi:10795
19141 "$ guix build --sources tzdata\n"
19142 "The following derivations will be built:\n"
19143 " /gnu/store/@dots{}-tzdata2015b.tar.gz.drv\n"
19144 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
19148 #: guix-git/doc/guix.texi:10797
19154 #: guix-git/doc/guix.texi:10801
19155 msgid "Build the source derivations of all packages, as well of all transitive inputs to the packages. This can be used e.g.@: to prefetch package source for later offline building."
19159 #: guix-git/doc/guix.texi:10812
19162 "$ guix build --sources=transitive tzdata\n"
19163 "The following derivations will be built:\n"
19164 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
19165 " /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv\n"
19166 " /gnu/store/@dots{}-grep-2.21.tar.xz.drv\n"
19167 " /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv\n"
19168 " /gnu/store/@dots{}-make-4.1.tar.xz.drv\n"
19169 " /gnu/store/@dots{}-bash-4.3.tar.xz.drv\n"
19174 #: guix-git/doc/guix.texi:10822
19175 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host. The @command{guix build} command allows you to repeat this option several times, in which case it builds for all the specified systems; other commands ignore extraneous @option{-s} options."
19179 #: guix-git/doc/guix.texi:10827
19180 msgid "The @option{--system} flag is for @emph{native} compilation and must not be confused with cross-compilation. See @option{--target} below for information on cross-compilation."
19184 #: guix-git/doc/guix.texi:10834
19185 msgid "An example use of this is on Linux-based systems, which can emulate different personalities. For instance, passing @option{--system=i686-linux} on an @code{x86_64-linux} system or @option{--system=armhf-linux} on an @code{aarch64-linux} system allows you to build packages in a complete 32-bit environment."
19189 #: guix-git/doc/guix.texi:10839
19190 msgid "Building for an @code{armhf-linux} system is unconditionally enabled on @code{aarch64-linux} machines, although certain aarch64 chipsets do not allow for this functionality, notably the ThunderX."
19194 #: guix-git/doc/guix.texi:10845
19195 msgid "Similarly, when transparent emulation with QEMU and @code{binfmt_misc} is enabled (@pxref{Virtualization Services, @code{qemu-binfmt-service-type}}), you can build for any system for which a QEMU @code{binfmt_misc} handler is installed."
19199 #: guix-git/doc/guix.texi:10849
19200 msgid "Builds for a system other than that of the machine you are using can also be offloaded to a remote machine of the right architecture. @xref{Daemon Offload Setup}, for more information on offloading."
19204 #: guix-git/doc/guix.texi:10855
19205 msgid "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{\"aarch64-linux-gnu\"} (@pxref{Specifying Target Triplets, GNU configuration triplets,, autoconf, Autoconf})."
19208 #. type: anchor{#1}
19209 #: guix-git/doc/guix.texi:10857
19210 msgid "build-check"
19214 #: guix-git/doc/guix.texi:10857
19220 #: guix-git/doc/guix.texi:10858
19222 msgid "determinism, checking"
19226 #: guix-git/doc/guix.texi:10859
19228 msgid "reproducibility, checking"
19232 #: guix-git/doc/guix.texi:10863
19233 msgid "Rebuild @var{package-or-derivation}, which are already available in the store, and raise an error if the build results are not bit-for-bit identical."
19237 #: guix-git/doc/guix.texi:10868
19238 msgid "This mechanism allows you to check whether previously installed substitutes are genuine (@pxref{Substitutes}), or whether the build result of a package is deterministic. @xref{Invoking guix challenge}, for more background information and tools."
19242 #: guix-git/doc/guix.texi:10873
19248 #: guix-git/doc/guix.texi:10874
19250 msgid "repairing store items"
19254 #: guix-git/doc/guix.texi:10878
19255 msgid "Attempt to repair the specified store items, if they are corrupt, by re-downloading or rebuilding them."
19259 #: guix-git/doc/guix.texi:10880
19260 msgid "This operation is not atomic and thus restricted to @code{root}."
19264 #: guix-git/doc/guix.texi:10881
19266 msgid "--derivations"
19270 #: guix-git/doc/guix.texi:10885
19271 msgid "Return the derivation paths, not the output paths, of the given packages."
19275 #: guix-git/doc/guix.texi:10888
19277 msgid "GC roots, adding"
19281 #: guix-git/doc/guix.texi:10889
19283 msgid "garbage collector roots, adding"
19287 #: guix-git/doc/guix.texi:10892 guix-git/doc/guix.texi:33222
19288 msgid "Make @var{file} a symlink to the result, and register it as a garbage collector root."
19292 #: guix-git/doc/guix.texi:10898
19293 msgid "Consequently, the results of this @command{guix build} invocation are protected from garbage collection until @var{file} is removed. When that option is omitted, build results are eligible for garbage collection as soon as the build completes. @xref{Invoking guix gc}, for more on GC roots."
19297 #: guix-git/doc/guix.texi:10899
19303 #: guix-git/doc/guix.texi:10900
19305 msgid "build logs, access"
19309 #: guix-git/doc/guix.texi:10904
19310 msgid "Return the build log file names or URLs for the given @var{package-or-derivation}, or raise an error if build logs are missing."
19314 #: guix-git/doc/guix.texi:10907
19315 msgid "This works regardless of how packages or derivations are specified. For instance, the following invocations are equivalent:"
19319 #: guix-git/doc/guix.texi:10913
19322 "guix build --log-file $(guix build -d guile)\n"
19323 "guix build --log-file $(guix build guile)\n"
19324 "guix build --log-file guile\n"
19325 "guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)'\n"
19329 #: guix-git/doc/guix.texi:10918
19330 msgid "If a log is unavailable locally, and unless @option{--no-substitutes} is passed, the command looks for a corresponding log on one of the substitute servers (as specified with @option{--substitute-urls})."
19334 #: guix-git/doc/guix.texi:10921
19335 msgid "So for instance, imagine you want to see the build log of GDB on MIPS, but you are actually on an @code{x86_64} machine:"
19339 #: guix-git/doc/guix.texi:10925
19342 "$ guix build --log-file gdb -s aarch64-linux\n"
19343 "https://@value{SUBSTITUTE-SERVER}/log/@dots{}-gdb-7.10\n"
19347 #: guix-git/doc/guix.texi:10928
19348 msgid "You can freely access a huge library of build logs!"
19352 #: guix-git/doc/guix.texi:10933
19354 msgid "build failures, debugging"
19357 #. type: Plain text
19358 #: guix-git/doc/guix.texi:10939
19359 msgid "When defining a new package (@pxref{Defining Packages}), you will probably find yourself spending some time debugging and tweaking the build until it succeeds. To do that, you need to operate the build commands yourself in an environment as close as possible to the one the build daemon uses."
19362 #. type: Plain text
19363 #: guix-git/doc/guix.texi:10944
19364 msgid "To that end, the first thing to do is to use the @option{--keep-failed} or @option{-K} option of @command{guix build}, which will keep the failed build tree in @file{/tmp} or whatever directory you specified as @env{TMPDIR} (@pxref{Common Build Options, @option{--keep-failed}})."
19367 #. type: Plain text
19368 #: guix-git/doc/guix.texi:10950
19369 msgid "From there on, you can @command{cd} to the failed build tree and source the @file{environment-variables} file, which contains all the environment variable definitions that were in place when the build failed. So let's say you're debugging a build failure in package @code{foo}; a typical session would look like this:"
19373 #: guix-git/doc/guix.texi:10957
19376 "$ guix build foo -K\n"
19377 "@dots{} @i{build fails}\n"
19378 "$ cd /tmp/guix-build-foo.drv-0\n"
19379 "$ source ./environment-variables\n"
19383 #. type: Plain text
19384 #: guix-git/doc/guix.texi:10961
19385 msgid "Now, you can invoke commands as if you were the daemon (almost) and troubleshoot your build process."
19388 #. type: Plain text
19389 #: guix-git/doc/guix.texi:10967
19390 msgid "Sometimes it happens that, for example, a package's tests pass when you run them manually but they fail when the daemon runs them. This can happen because the daemon runs builds in containers where, unlike in our environment above, network access is missing, @file{/bin/sh} does not exist, etc. (@pxref{Build Environment Setup})."
19393 #. type: Plain text
19394 #: guix-git/doc/guix.texi:10970
19395 msgid "In such cases, you may need to run inspect the build process from within a container similar to the one the build daemon creates:"
19399 #: guix-git/doc/guix.texi:10978
19402 "$ guix build -K foo\n"
19404 "$ cd /tmp/guix-build-foo.drv-0\n"
19405 "$ guix environment --no-grafts -C foo --ad-hoc strace gdb\n"
19406 "[env]# source ./environment-variables\n"
19407 "[env]# cd foo-1.2\n"
19410 #. type: Plain text
19411 #: guix-git/doc/guix.texi:10987
19412 msgid "Here, @command{guix environment -C} creates a container and spawns a new shell in it (@pxref{Invoking guix environment}). The @command{--ad-hoc strace gdb} part adds the @command{strace} and @command{gdb} commands to the container, which you may find handy while debugging. The @option{--no-grafts} option makes sure we get the exact same environment, with ungrafted packages (@pxref{Security Updates}, for more info on grafts)."
19415 #. type: Plain text
19416 #: guix-git/doc/guix.texi:10990
19417 msgid "To get closer to a container like that used by the build daemon, we can remove @file{/bin/sh}:"
19421 #: guix-git/doc/guix.texi:10993
19423 msgid "[env]# rm /bin/sh\n"
19426 #. type: Plain text
19427 #: guix-git/doc/guix.texi:10997
19428 msgid "(Don't worry, this is harmless: this is all happening in the throw-away container created by @command{guix environment}.)"
19431 #. type: Plain text
19432 #: guix-git/doc/guix.texi:11000
19433 msgid "The @command{strace} command is probably not in the search path, but we can run:"
19437 #: guix-git/doc/guix.texi:11003
19439 msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n"
19442 #. type: Plain text
19443 #: guix-git/doc/guix.texi:11008
19444 msgid "In this way, not only you will have reproduced the environment variables the daemon uses, you will also be running the build process in a container similar to the one the daemon uses."
19448 #: guix-git/doc/guix.texi:11011
19450 msgid "Invoking @command{guix edit}"
19453 #. type: command{#1}
19454 #: guix-git/doc/guix.texi:11013
19460 #: guix-git/doc/guix.texi:11014
19462 msgid "package definition, editing"
19465 #. type: Plain text
19466 #: guix-git/doc/guix.texi:11019
19467 msgid "So many packages, so many source files! The @command{guix edit} command facilitates the life of users and packagers by pointing their editor at the source file containing the definition of the specified packages. For instance:"
19471 #: guix-git/doc/guix.texi:11022
19473 msgid "guix edit gcc@@4.9 vim\n"
19476 #. type: Plain text
19477 #: guix-git/doc/guix.texi:11028
19478 msgid "launches the program specified in the @env{VISUAL} or in the @env{EDITOR} environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim."
19481 #. type: Plain text
19482 #: guix-git/doc/guix.texi:11034
19483 msgid "If you are using a Guix Git checkout (@pxref{Building from Git}), or have created your own packages on @env{GUIX_PACKAGE_PATH} (@pxref{Package Modules}), you will be able to edit the package recipes. In other cases, you will be able to examine the read-only recipes for packages currently in the store."
19486 #. type: Plain text
19487 #: guix-git/doc/guix.texi:11039
19488 msgid "Instead of @env{GUIX_PACKAGE_PATH}, the command-line option @option{--load-path=@var{directory}} (or in short @option{-L @var{directory}}) allows you to add @var{directory} to the front of the package module search path and so make your own packages visible."
19492 #: guix-git/doc/guix.texi:11041
19494 msgid "Invoking @command{guix download}"
19497 #. type: command{#1}
19498 #: guix-git/doc/guix.texi:11043
19500 msgid "guix download"
19504 #: guix-git/doc/guix.texi:11044
19506 msgid "downloading package sources"
19509 #. type: Plain text
19510 #: guix-git/doc/guix.texi:11051
19511 msgid "When writing a package definition, developers typically need to download a source tarball, compute its SHA256 hash, and write that hash in the package definition (@pxref{Defining Packages}). The @command{guix download} tool helps with this task: it downloads a file from the given URI, adds it to the store, and prints both its file name in the store and its SHA256 hash."
19514 #. type: Plain text
19515 #: guix-git/doc/guix.texi:11058
19516 msgid "The fact that the downloaded file is added to the store saves bandwidth: when the developer eventually tries to build the newly defined package with @command{guix build}, the source tarball will not have to be downloaded again because it is already in the store. It is also a convenient way to temporarily stash files, which may be deleted eventually (@pxref{Invoking guix gc})."
19519 #. type: Plain text
19520 #: guix-git/doc/guix.texi:11066
19521 msgid "The @command{guix download} command supports the same URIs as used in package definitions. In particular, it supports @code{mirror://} URIs. @code{https} URIs (HTTP over TLS) are supported @emph{provided} the Guile bindings for GnuTLS are available in the user's environment; when they are not available, an error is raised. @xref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}, for more information."
19524 #. type: Plain text
19525 #: guix-git/doc/guix.texi:11071
19526 msgid "@command{guix download} verifies HTTPS server certificates by loading the certificates of X.509 authorities from the directory pointed to by the @env{SSL_CERT_DIR} environment variable (@pxref{X.509 Certificates}), unless @option{--no-check-certificate} is used."
19529 #. type: Plain text
19530 #: guix-git/doc/guix.texi:11073 guix-git/doc/guix.texi:12655
19531 msgid "The following options are available:"
19535 #: guix-git/doc/guix.texi:11075 guix-git/doc/guix.texi:11119
19537 msgid "--hash=@var{algorithm}"
19541 #: guix-git/doc/guix.texi:11076 guix-git/doc/guix.texi:11120
19543 msgid "-H @var{algorithm}"
19547 #: guix-git/doc/guix.texi:11079
19548 msgid "Compute a hash using the specified @var{algorithm}. @xref{Invoking guix hash}, for more information."
19552 #: guix-git/doc/guix.texi:11080 guix-git/doc/guix.texi:11129
19554 msgid "--format=@var{fmt}"
19558 #: guix-git/doc/guix.texi:11081 guix-git/doc/guix.texi:11130
19560 msgid "-f @var{fmt}"
19564 #: guix-git/doc/guix.texi:11084
19565 msgid "Write the hash in the format specified by @var{fmt}. For more information on the valid values for @var{fmt}, @pxref{Invoking guix hash}."
19569 #: guix-git/doc/guix.texi:11085
19571 msgid "--no-check-certificate"
19575 #: guix-git/doc/guix.texi:11087
19576 msgid "Do not validate the X.509 certificates of HTTPS servers."
19580 #: guix-git/doc/guix.texi:11091
19581 msgid "When using this option, you have @emph{absolutely no guarantee} that you are communicating with the authentic server responsible for the given URL, which makes you vulnerable to ``man-in-the-middle'' attacks."
19585 #: guix-git/doc/guix.texi:11092
19587 msgid "--output=@var{file}"
19591 #: guix-git/doc/guix.texi:11093
19593 msgid "-o @var{file}"
19597 #: guix-git/doc/guix.texi:11096
19598 msgid "Save the downloaded file to @var{file} instead of adding it to the store."
19602 #: guix-git/doc/guix.texi:11099
19604 msgid "Invoking @command{guix hash}"
19607 #. type: command{#1}
19608 #: guix-git/doc/guix.texi:11101
19613 #. type: Plain text
19614 #: guix-git/doc/guix.texi:11106
19615 msgid "The @command{guix hash} command computes the hash of a file. It is primarily a convenience tool for anyone contributing to the distribution: it computes the cryptographic hash of a file, which can be used in the definition of a package (@pxref{Defining Packages})."
19619 #: guix-git/doc/guix.texi:11111
19621 msgid "guix hash @var{option} @var{file}\n"
19624 #. type: Plain text
19625 #: guix-git/doc/guix.texi:11116
19626 msgid "When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the hash of data read from standard input. @command{guix hash} has the following options:"
19630 #: guix-git/doc/guix.texi:11123
19631 msgid "Compute a hash using the specified @var{algorithm}, @code{sha256} by default."
19635 #: guix-git/doc/guix.texi:11128
19636 msgid "@var{algorithm} must the name of a cryptographic hash algorithm supported by Libgcrypt @i{via} Guile-Gcrypt---e.g., @code{sha512} or @code{sha3-256} (@pxref{Hash Functions,,, guile-gcrypt, Guile-Gcrypt Reference Manual})."
19640 #: guix-git/doc/guix.texi:11132
19641 msgid "Write the hash in the format specified by @var{fmt}."
19645 #: guix-git/doc/guix.texi:11135
19646 msgid "Supported formats: @code{base64}, @code{nix-base32}, @code{base32}, @code{base16} (@code{hex} and @code{hexadecimal} can be used as well)."
19650 #: guix-git/doc/guix.texi:11139
19651 msgid "If the @option{--format} option is not specified, @command{guix hash} will output the hash in @code{nix-base32}. This representation is used in the definitions of packages."
19655 #: guix-git/doc/guix.texi:11143
19656 msgid "Compute the hash on @var{file} recursively."
19660 #: guix-git/doc/guix.texi:11152
19661 msgid "In this case, the hash is computed on an archive containing @var{file}, including its children if it is a directory. Some of the metadata of @var{file} is part of the archive; for instance, when @var{file} is a regular file, the hash is different depending on whether @var{file} is executable or not. Metadata such as time stamps has no impact on the hash (@pxref{Invoking guix archive})."
19665 #: guix-git/doc/guix.texi:11153
19667 msgid "--exclude-vcs"
19671 #: guix-git/doc/guix.texi:11154 guix-git/doc/guix.texi:12142
19677 #: guix-git/doc/guix.texi:11157
19678 msgid "When combined with @option{--recursive}, exclude version control system directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)."
19682 #: guix-git/doc/guix.texi:11158
19688 #: guix-git/doc/guix.texi:11162
19689 msgid "As an example, here is how you would compute the hash of a Git checkout, which is useful when using the @code{git-fetch} method (@pxref{origin Reference}):"
19693 #: guix-git/doc/guix.texi:11167
19696 "$ git clone http://example.org/foo.git\n"
19698 "$ guix hash -rx .\n"
19702 #: guix-git/doc/guix.texi:11171 guix-git/doc/guix.texi:11176
19704 msgid "Invoking @command{guix import}"
19708 #: guix-git/doc/guix.texi:11173
19710 msgid "importing packages"
19714 #: guix-git/doc/guix.texi:11174
19716 msgid "package import"
19720 #: guix-git/doc/guix.texi:11175
19722 msgid "package conversion"
19725 #. type: Plain text
19726 #: guix-git/doc/guix.texi:11183
19727 msgid "The @command{guix import} command is useful for people who would like to add a package to the distribution with as little work as possible---a legitimate demand. The command knows of a few repositories from which it can ``import'' package metadata. The result is a package definition, or a template thereof, in the format we know (@pxref{Defining Packages})."
19731 #: guix-git/doc/guix.texi:11188
19733 msgid "guix import @var{importer} @var{options}@dots{}\n"
19736 #. type: Plain text
19737 #: guix-git/doc/guix.texi:11193
19738 msgid "@var{importer} specifies the source from which to import package metadata, and @var{options} specifies a package identifier and other options specific to @var{importer}."
19741 #. type: Plain text
19742 #: guix-git/doc/guix.texi:11197
19743 msgid "Some of the importers rely on the ability to run the @command{gpgv} command. For these, GnuPG must be installed and in @code{$PATH}; run @code{guix install gnupg} if needed."
19746 #. type: Plain text
19747 #: guix-git/doc/guix.texi:11199
19748 msgid "Currently, the available ``importers'' are:"
19752 #: guix-git/doc/guix.texi:11201 guix-git/doc/guix.texi:11789
19758 #: guix-git/doc/guix.texi:11205
19759 msgid "Import metadata for the given GNU package. This provides a template for the latest version of that GNU package, including the hash of its source tarball, and its canonical synopsis and description."
19763 #: guix-git/doc/guix.texi:11208
19764 msgid "Additional information such as the package dependencies and its license needs to be figured out manually."
19768 #: guix-git/doc/guix.texi:11211
19769 msgid "For example, the following command returns a package definition for GNU@tie{}Hello:"
19773 #: guix-git/doc/guix.texi:11214
19775 msgid "guix import gnu hello\n"
19779 #: guix-git/doc/guix.texi:11217 guix-git/doc/guix.texi:11457
19780 #: guix-git/doc/guix.texi:11507 guix-git/doc/guix.texi:11536
19781 msgid "Specific command-line options are:"
19785 #: guix-git/doc/guix.texi:11219 guix-git/doc/guix.texi:11950
19787 msgid "--key-download=@var{policy}"
19791 #: guix-git/doc/guix.texi:11223
19792 msgid "As for @command{guix refresh}, specify the policy to handle missing OpenPGP keys when verifying the package signature. @xref{Invoking guix refresh, @option{--key-download}}."
19796 #: guix-git/doc/guix.texi:11225 guix-git/doc/guix.texi:11226
19797 #: guix-git/doc/guix.texi:11811
19803 #: guix-git/doc/guix.texi:11233
19804 msgid "Import metadata from the @uref{https://pypi.python.org/, Python Package Index}. Information is taken from the JSON-formatted description available at @code{pypi.python.org} and usually includes all the relevant information, including package dependencies. For maximum efficiency, it is recommended to install the @command{unzip} utility, so that the importer can unzip Python wheels and gather data from them."
19808 #: guix-git/doc/guix.texi:11236
19809 msgid "The command below imports metadata for the @code{itsdangerous} Python package:"
19813 #: guix-git/doc/guix.texi:11239
19815 msgid "guix import pypi itsdangerous\n"
19819 #: guix-git/doc/guix.texi:11247 guix-git/doc/guix.texi:11272
19820 #: guix-git/doc/guix.texi:11480 guix-git/doc/guix.texi:11521
19821 #: guix-git/doc/guix.texi:11568 guix-git/doc/guix.texi:11593
19822 #: guix-git/doc/guix.texi:11609 guix-git/doc/guix.texi:11640
19823 msgid "Traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix."
19827 #: guix-git/doc/guix.texi:11249 guix-git/doc/guix.texi:11250
19828 #: guix-git/doc/guix.texi:11813
19834 #: guix-git/doc/guix.texi:11259
19835 msgid "Import metadata from @uref{https://rubygems.org/, RubyGems}. Information is taken from the JSON-formatted description available at @code{rubygems.org} and includes most relevant information, including runtime dependencies. There are some caveats, however. The metadata doesn't distinguish between synopses and descriptions, so the same string is used for both fields. Additionally, the details of non-Ruby dependencies required to build native extensions is unavailable and left as an exercise to the packager."
19839 #: guix-git/doc/guix.texi:11261
19840 msgid "The command below imports metadata for the @code{rails} Ruby package:"
19844 #: guix-git/doc/guix.texi:11264
19846 msgid "guix import gem rails\n"
19850 #: guix-git/doc/guix.texi:11274 guix-git/doc/guix.texi:11809
19856 #: guix-git/doc/guix.texi:11275
19862 #: guix-git/doc/guix.texi:11283
19863 msgid "Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}. Information is taken from the JSON-formatted metadata provided through @uref{https://fastapi.metacpan.org/, MetaCPAN's API} and includes most relevant information, such as module dependencies. License information should be checked closely. If Perl is available in the store, then the @code{corelist} utility will be used to filter core modules out of the list of dependencies."
19867 #: guix-git/doc/guix.texi:11286
19868 msgid "The command command below imports metadata for the Acme::Boolean Perl module:"
19872 #: guix-git/doc/guix.texi:11289
19874 msgid "guix import cpan Acme::Boolean\n"
19878 #: guix-git/doc/guix.texi:11291 guix-git/doc/guix.texi:11805
19884 #: guix-git/doc/guix.texi:11292
19890 #: guix-git/doc/guix.texi:11293
19892 msgid "Bioconductor"
19896 #: guix-git/doc/guix.texi:11297
19897 msgid "Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central repository for the @uref{https://r-project.org, GNU@tie{}R statistical and graphical environment}."
19901 #: guix-git/doc/guix.texi:11299
19902 msgid "Information is extracted from the @file{DESCRIPTION} file of the package."
19906 #: guix-git/doc/guix.texi:11301
19907 msgid "The command command below imports metadata for the Cairo R package:"
19911 #: guix-git/doc/guix.texi:11304
19913 msgid "guix import cran Cairo\n"
19917 #: guix-git/doc/guix.texi:11309
19918 msgid "When @option{--recursive} is added, the importer will traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix."
19922 #: guix-git/doc/guix.texi:11316
19923 msgid "When @option{--style=specification} is added, the importer will generate package definitions whose inputs are package specifications instead of references to package variables. This is useful when generated package definitions are to be appended to existing user modules, as the list of used package modules need not be changed. The default is @option{--style=variable}."
19927 #: guix-git/doc/guix.texi:11321
19928 msgid "When @option{--archive=bioconductor} is added, metadata is imported from @uref{https://www.bioconductor.org/, Bioconductor}, a repository of R packages for the analysis and comprehension of high-throughput genomic data in bioinformatics."
19932 #: guix-git/doc/guix.texi:11324
19933 msgid "Information is extracted from the @file{DESCRIPTION} file contained in the package archive."
19937 #: guix-git/doc/guix.texi:11326
19938 msgid "The command below imports metadata for the GenomicRanges R package:"
19942 #: guix-git/doc/guix.texi:11329
19944 msgid "guix import cran --archive=bioconductor GenomicRanges\n"
19948 #: guix-git/doc/guix.texi:11334
19949 msgid "Finally, you can also import R packages that have not yet been published on CRAN or Bioconductor as long as they are in a git repository. Use @option{--archive=git} followed by the URL of the git repository:"
19953 #: guix-git/doc/guix.texi:11337
19955 msgid "guix import cran --archive=git https://github.com/immunogenomics/harmony\n"
19959 #: guix-git/doc/guix.texi:11339
19965 #: guix-git/doc/guix.texi:11340
19971 #: guix-git/doc/guix.texi:11341
19977 #: guix-git/doc/guix.texi:11345
19978 msgid "Import metadata from @uref{https://www.ctan.org/, CTAN}, the comprehensive TeX archive network for TeX packages that are part of the @uref{https://www.tug.org/texlive/, TeX Live distribution}."
19982 #: guix-git/doc/guix.texi:11350
19983 msgid "Information about the package is obtained through the XML API provided by CTAN, while the source code is downloaded from the SVN repository of the Tex Live project. This is done because the CTAN does not keep versioned archives."
19987 #: guix-git/doc/guix.texi:11353
19988 msgid "The command command below imports metadata for the @code{fontspec} TeX package:"
19992 #: guix-git/doc/guix.texi:11356
19994 msgid "guix import texlive fontspec\n"
19998 #: guix-git/doc/guix.texi:11362
19999 msgid "When @option{--archive=@var{directory}} is added, the source code is downloaded not from the @file{latex} sub-directory of the @file{texmf-dist/source} tree in the TeX Live SVN repository, but from the specified sibling @var{directory} under the same root."
20003 #: guix-git/doc/guix.texi:11366
20004 msgid "The command below imports metadata for the @code{ifxetex} package from CTAN while fetching the sources from the directory @file{texmf/source/generic}:"
20008 #: guix-git/doc/guix.texi:11369
20010 msgid "guix import texlive --archive=generic ifxetex\n"
20014 #: guix-git/doc/guix.texi:11372
20016 msgid "JSON, import"
20020 #: guix-git/doc/guix.texi:11375
20021 msgid "Import package metadata from a local JSON file. Consider the following example package definition in JSON format:"
20025 #: guix-git/doc/guix.texi:11388
20029 " \"name\": \"hello\",\n"
20030 " \"version\": \"2.10\",\n"
20031 " \"source\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
20032 " \"build-system\": \"gnu\",\n"
20033 " \"home-page\": \"https://www.gnu.org/software/hello/\",\n"
20034 " \"synopsis\": \"Hello, GNU world: An example GNU package\",\n"
20035 " \"description\": \"GNU Hello prints a greeting.\",\n"
20036 " \"license\": \"GPL-3.0+\",\n"
20037 " \"native-inputs\": [\"gettext\"]\n"
20042 #: guix-git/doc/guix.texi:11394
20043 msgid "The field names are the same as for the @code{<package>} record (@xref{Defining Packages}). References to other packages are provided as JSON lists of quoted package specification strings such as @code{guile} or @code{guile@@2.0}."
20047 #: guix-git/doc/guix.texi:11397
20048 msgid "The importer also supports a more explicit source definition using the common fields for @code{<origin>} records:"
20052 #: guix-git/doc/guix.texi:11410
20057 " \"source\": @{\n"
20058 " \"method\": \"url-fetch\",\n"
20059 " \"uri\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
20060 " \"sha256\": @{\n"
20061 " \"base32\": \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"\n"
20069 #: guix-git/doc/guix.texi:11414
20070 msgid "The command below reads metadata from the JSON file @code{hello.json} and outputs a package expression:"
20074 #: guix-git/doc/guix.texi:11417
20076 msgid "guix import json hello.json\n"
20080 #: guix-git/doc/guix.texi:11419
20086 #: guix-git/doc/guix.texi:11428
20087 msgid "Import metadata from a local copy of the source of the @uref{https://nixos.org/nixpkgs/, Nixpkgs distribution}@footnote{This relies on the @command{nix-instantiate} command of @uref{https://nixos.org/nix/, Nix}.}. Package definitions in Nixpkgs are typically written in a mixture of Nix-language and Bash code. This command only imports the high-level package structure that is written in the Nix language. It normally includes all the basic fields of a package definition."
20091 #: guix-git/doc/guix.texi:11431
20092 msgid "When importing a GNU package, the synopsis and descriptions are replaced by their canonical upstream variant."
20096 #: guix-git/doc/guix.texi:11433
20097 msgid "Usually, you will first need to do:"
20101 #: guix-git/doc/guix.texi:11436
20103 msgid "export NIX_REMOTE=daemon\n"
20107 #: guix-git/doc/guix.texi:11440
20108 msgid "so that @command{nix-instantiate} does not try to open the Nix database."
20112 #: guix-git/doc/guix.texi:11444
20113 msgid "As an example, the command below imports the package definition of LibreOffice (more precisely, it imports the definition of the package bound to the @code{libreoffice} top-level attribute):"
20117 #: guix-git/doc/guix.texi:11447
20119 msgid "guix import nix ~/path/to/nixpkgs libreoffice\n"
20123 #: guix-git/doc/guix.texi:11449 guix-git/doc/guix.texi:11450
20124 #: guix-git/doc/guix.texi:11817
20130 #: guix-git/doc/guix.texi:11455
20131 msgid "Import metadata from the Haskell community's central package archive @uref{https://hackage.haskell.org/, Hackage}. Information is taken from Cabal files and includes all the relevant information, including package dependencies."
20135 #: guix-git/doc/guix.texi:11459
20141 #: guix-git/doc/guix.texi:11460
20147 #: guix-git/doc/guix.texi:11462
20148 msgid "Read a Cabal file from standard input."
20152 #: guix-git/doc/guix.texi:11462 guix-git/doc/guix.texi:11509
20154 msgid "--no-test-dependencies"
20158 #: guix-git/doc/guix.texi:11465 guix-git/doc/guix.texi:11512
20159 msgid "Do not include dependencies required only by the test suites."
20163 #: guix-git/doc/guix.texi:11465
20165 msgid "--cabal-environment=@var{alist}"
20169 #: guix-git/doc/guix.texi:11466
20171 msgid "-e @var{alist}"
20175 #: guix-git/doc/guix.texi:11475
20176 msgid "@var{alist} is a Scheme alist defining the environment in which the Cabal conditionals are evaluated. The accepted keys are: @code{os}, @code{arch}, @code{impl} and a string representing the name of a flag. The value associated with a flag has to be either the symbol @code{true} or @code{false}. The value associated with other keys has to conform to the Cabal file format definition. The default value associated with the keys @code{os}, @code{arch} and @code{impl} is @samp{linux}, @samp{x86_64} and @samp{ghc}, respectively."
20180 #: guix-git/doc/guix.texi:11485
20181 msgid "The command below imports metadata for the latest version of the HTTP Haskell package without including test dependencies and specifying the value of the flag @samp{network-uri} as @code{false}:"
20185 #: guix-git/doc/guix.texi:11488
20187 msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n"
20191 #: guix-git/doc/guix.texi:11492
20192 msgid "A specific package version may optionally be specified by following the package name by an at-sign and a version number as in the following example:"
20196 #: guix-git/doc/guix.texi:11495
20198 msgid "guix import hackage mtl@@2.1.3.1\n"
20202 #: guix-git/doc/guix.texi:11497 guix-git/doc/guix.texi:11498
20203 #: guix-git/doc/guix.texi:11819
20209 #: guix-git/doc/guix.texi:11505
20210 msgid "The @code{stackage} importer is a wrapper around the @code{hackage} one. It takes a package name, looks up the package version included in a long-term support (LTS) @uref{https://www.stackage.org, Stackage} release and uses the @code{hackage} importer to retrieve its metadata. Note that it is up to you to select an LTS release compatible with the GHC compiler used by Guix."
20214 #: guix-git/doc/guix.texi:11512
20216 msgid "--lts-version=@var{version}"
20220 #: guix-git/doc/guix.texi:11513
20222 msgid "-l @var{version}"
20226 #: guix-git/doc/guix.texi:11516
20227 msgid "@var{version} is the desired LTS release version. If omitted the latest release is used."
20231 #: guix-git/doc/guix.texi:11525
20232 msgid "The command below imports metadata for the HTTP Haskell package included in the LTS Stackage release version 7.18:"
20236 #: guix-git/doc/guix.texi:11528
20238 msgid "guix import stackage --lts-version=7.18 HTTP\n"
20242 #: guix-git/doc/guix.texi:11530 guix-git/doc/guix.texi:11531
20243 #: guix-git/doc/guix.texi:11803
20249 #: guix-git/doc/guix.texi:11534
20250 msgid "Import metadata from an Emacs Lisp Package Archive (ELPA) package repository (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
20254 #: guix-git/doc/guix.texi:11538
20256 msgid "--archive=@var{repo}"
20260 #: guix-git/doc/guix.texi:11539
20262 msgid "-a @var{repo}"
20266 #: guix-git/doc/guix.texi:11543
20267 msgid "@var{repo} identifies the archive repository from which to retrieve the information. Currently the supported repositories and their identifiers are:"
20271 #: guix-git/doc/guix.texi:11547
20272 msgid "@uref{https://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} identifier. This is the default."
20276 #: guix-git/doc/guix.texi:11553
20277 msgid "Packages from @code{elpa.gnu.org} are signed with one of the keys contained in the GnuPG keyring at @file{share/emacs/25.1/etc/package-keyring.gpg} (or similar) in the @code{emacs} package (@pxref{Package Installation, ELPA package signatures,, emacs, The GNU Emacs Manual})."
20281 #: guix-git/doc/guix.texi:11557
20282 msgid "@uref{https://stable.melpa.org/packages, MELPA-Stable}, selected by the @code{melpa-stable} identifier."
20286 #: guix-git/doc/guix.texi:11561
20287 msgid "@uref{https://melpa.org/packages, MELPA}, selected by the @code{melpa} identifier."
20291 #: guix-git/doc/guix.texi:11570 guix-git/doc/guix.texi:11571
20292 #: guix-git/doc/guix.texi:11821
20298 #: guix-git/doc/guix.texi:11574
20299 msgid "Import metadata from the crates.io Rust package repository @uref{https://crates.io, crates.io}, as in this example:"
20303 #: guix-git/doc/guix.texi:11577
20305 msgid "guix import crate blake2-rfc\n"
20309 #: guix-git/doc/guix.texi:11580
20310 msgid "The crate importer also allows you to specify a version string:"
20314 #: guix-git/doc/guix.texi:11583
20316 msgid "guix import crate constant-time-eq@@0.1.0\n"
20320 #: guix-git/doc/guix.texi:11586 guix-git/doc/guix.texi:11602
20321 #: guix-git/doc/guix.texi:11633
20322 msgid "Additional options include:"
20326 #: guix-git/doc/guix.texi:11595
20332 #: guix-git/doc/guix.texi:11596
20338 #: guix-git/doc/guix.texi:11597
20344 #: guix-git/doc/guix.texi:11600
20345 msgid "Import metadata from the @uref{https://opam.ocaml.org/, OPAM} package repository used by the OCaml community."
20349 #: guix-git/doc/guix.texi:11609
20355 #: guix-git/doc/guix.texi:11611
20356 msgid "Select the given repository (a repository name). Possible values include:"
20360 #: guix-git/doc/guix.texi:11612
20362 msgid "@code{opam}, the default opam repository,"
20366 #: guix-git/doc/guix.texi:11613
20368 msgid "@code{coq} or @code{coq-released}, the stable repository for coq packages,"
20372 #: guix-git/doc/guix.texi:11614
20374 msgid "@code{coq-core-dev}, the repository that contains development versions of coq,"
20378 #: guix-git/doc/guix.texi:11615
20380 msgid "@code{coq-extra-dev}, the repository that contains development versions"
20384 #: guix-git/doc/guix.texi:11617
20385 msgid "of coq packages."
20389 #: guix-git/doc/guix.texi:11620 guix-git/doc/guix.texi:11621
20395 #: guix-git/doc/guix.texi:11624
20396 msgid "Import metadata for a Go module using @uref{https://proxy.golang.org, proxy.golang.org}."
20400 #: guix-git/doc/guix.texi:11627
20402 msgid "guix import go gopkg.in/yaml.v2\n"
20406 #: guix-git/doc/guix.texi:11631
20407 msgid "It is possible to use a package specification with a @code{@@VERSION} suffix to import a specific version."
20411 #: guix-git/doc/guix.texi:11640
20413 msgid "--pin-versions"
20417 #: guix-git/doc/guix.texi:11648
20418 msgid "When using this option, the importer preserves the exact versions of the Go modules dependencies instead of using their latest available versions. This can be useful when attempting to import packages that recursively depend on former versions of themselves to build. When using this mode, the symbol of the package is made by appending the version to its name, so that multiple versions of the same package can coexist."
20421 #. type: Plain text
20422 #: guix-git/doc/guix.texi:11654
20423 msgid "The structure of the @command{guix import} code is modular. It would be useful to have more importers for other package formats, and your help is welcome here (@pxref{Contributing})."
20427 #: guix-git/doc/guix.texi:11656
20429 msgid "Invoking @command{guix refresh}"
20432 #. type: command{#1}
20433 #: guix-git/doc/guix.texi:11658
20435 msgid "guix refresh"
20438 #. type: Plain text
20439 #: guix-git/doc/guix.texi:11666
20440 msgid "The primary audience of the @command{guix refresh} command is packagers. As a user, you may be interested in the @option{--with-latest} option, which can bring you package update superpowers built upon @command{guix refresh} (@pxref{Package Transformation Options, @option{--with-latest}}). By default, @command{guix refresh} reports any packages provided by the distribution that are outdated compared to the latest upstream version, like this:"
20444 #: guix-git/doc/guix.texi:11671
20448 "gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1\n"
20449 "gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0\n"
20452 #. type: Plain text
20453 #: guix-git/doc/guix.texi:11675
20454 msgid "Alternatively, one can specify packages to consider, in which case a warning is emitted for packages that lack an updater:"
20458 #: guix-git/doc/guix.texi:11680
20461 "$ guix refresh coreutils guile guile-ssh\n"
20462 "gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh\n"
20463 "gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13\n"
20466 #. type: Plain text
20467 #: guix-git/doc/guix.texi:11689
20468 msgid "@command{guix refresh} browses the upstream repository of each package and determines the highest version number of the releases therein. The command knows how to update specific types of packages: GNU packages, ELPA packages, etc.---see the documentation for @option{--type} below. There are many packages, though, for which it lacks a method to determine whether a new upstream release is available. However, the mechanism is extensible, so feel free to get in touch with us to add a new method!"
20472 #: guix-git/doc/guix.texi:11694
20473 msgid "Consider the packages specified, and all the packages upon which they depend."
20477 #: guix-git/doc/guix.texi:11702
20480 "$ guix refresh --recursive coreutils\n"
20481 "gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1\n"
20482 "gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4\n"
20483 "gnu/packages/xml.scm:68:2: warning: no updater for expat\n"
20484 "gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp\n"
20488 #. type: Plain text
20489 #: guix-git/doc/guix.texi:11710
20490 msgid "Sometimes the upstream name differs from the package name used in Guix, and @command{guix refresh} needs a little help. Most updaters honor the @code{upstream-name} property in package definitions, which can be used to that effect:"
20494 #: guix-git/doc/guix.texi:11717
20497 "(define-public network-manager\n"
20499 " (name \"network-manager\")\n"
20501 " (properties '((upstream-name . \"NetworkManager\")))))\n"
20504 #. type: Plain text
20505 #: guix-git/doc/guix.texi:11726
20506 msgid "When passed @option{--update}, it modifies distribution source files to update the version numbers and source tarball hashes of those package recipes (@pxref{Defining Packages}). This is achieved by downloading each package's latest source tarball and its associated OpenPGP signature, authenticating the downloaded tarball against its signature using @command{gpgv}, and finally computing its hash---note that GnuPG must be installed and in @code{$PATH}; run @code{guix install gnupg} if needed."
20509 #. type: Plain text
20510 #: guix-git/doc/guix.texi:11732
20511 msgid "When the public key used to sign the tarball is missing from the user's keyring, an attempt is made to automatically retrieve it from a public key server; when this is successful, the key is added to the user's keyring; otherwise, @command{guix refresh} reports an error."
20514 #. type: Plain text
20515 #: guix-git/doc/guix.texi:11734
20516 msgid "The following options are supported:"
20520 #: guix-git/doc/guix.texi:11742 guix-git/doc/guix.texi:12537
20521 msgid "This is useful to precisely refer to a package, as in this example:"
20525 #: guix-git/doc/guix.texi:11745
20527 msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n"
20531 #: guix-git/doc/guix.texi:11749
20532 msgid "This command lists the dependents of the ``final'' libc (essentially all the packages)."
20536 #: guix-git/doc/guix.texi:11750
20542 #: guix-git/doc/guix.texi:11751
20548 #: guix-git/doc/guix.texi:11755
20549 msgid "Update distribution source files (package recipes) in place. This is usually run from a checkout of the Guix source tree (@pxref{Running Guix Before It Is Installed}):"
20553 #: guix-git/doc/guix.texi:11758
20555 msgid "$ ./pre-inst-env guix refresh -s non-core -u\n"
20559 #: guix-git/doc/guix.texi:11761
20560 msgid "@xref{Defining Packages}, for more information on package definitions."
20564 #: guix-git/doc/guix.texi:11762
20566 msgid "--select=[@var{subset}]"
20570 #: guix-git/doc/guix.texi:11763
20572 msgid "-s @var{subset}"
20576 #: guix-git/doc/guix.texi:11766
20577 msgid "Select all the packages in @var{subset}, one of @code{core} or @code{non-core}."
20581 #: guix-git/doc/guix.texi:11773
20582 msgid "The @code{core} subset refers to all the packages at the core of the distribution---i.e., packages that are used to build ``everything else''. This includes GCC, libc, Binutils, Bash, etc. Usually, changing one of these packages in the distribution entails a rebuild of all the others. Thus, such updates are an inconvenience to users in terms of build time or bandwidth used to achieve the upgrade."
20586 #: guix-git/doc/guix.texi:11777
20587 msgid "The @code{non-core} subset refers to the remaining packages. It is typically useful in cases where an update of the core packages would be inconvenient."
20591 #: guix-git/doc/guix.texi:11782
20592 msgid "Select all the packages from the manifest in @var{file}. This is useful to check if any packages of the user manifest can be updated."
20596 #: guix-git/doc/guix.texi:11783
20598 msgid "--type=@var{updater}"
20602 #: guix-git/doc/guix.texi:11784
20604 msgid "-t @var{updater}"
20608 #: guix-git/doc/guix.texi:11787
20609 msgid "Select only packages handled by @var{updater} (may be a comma-separated list of updaters). Currently, @var{updater} may be one of:"
20613 #: guix-git/doc/guix.texi:11791
20614 msgid "the updater for GNU packages;"
20618 #: guix-git/doc/guix.texi:11791
20624 #: guix-git/doc/guix.texi:11793
20625 msgid "the updater for packages hosted at @uref{https://savannah.gnu.org, Savannah};"
20629 #: guix-git/doc/guix.texi:11793
20631 msgid "sourceforge"
20635 #: guix-git/doc/guix.texi:11795
20636 msgid "the updater for packages hosted at @uref{https://sourceforge.net, SourceForge};"
20640 #: guix-git/doc/guix.texi:11795
20646 #: guix-git/doc/guix.texi:11797
20647 msgid "the updater for GNOME packages;"
20651 #: guix-git/doc/guix.texi:11797
20657 #: guix-git/doc/guix.texi:11799
20658 msgid "the updater for KDE packages;"
20662 #: guix-git/doc/guix.texi:11799
20668 #: guix-git/doc/guix.texi:11801
20669 msgid "the updater for X.org packages;"
20673 #: guix-git/doc/guix.texi:11801
20679 #: guix-git/doc/guix.texi:11803
20680 msgid "the updater for packages hosted on kernel.org;"
20684 #: guix-git/doc/guix.texi:11805
20685 msgid "the updater for @uref{https://elpa.gnu.org/, ELPA} packages;"
20689 #: guix-git/doc/guix.texi:11807
20690 msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;"
20694 #: guix-git/doc/guix.texi:11807
20696 msgid "bioconductor"
20700 #: guix-git/doc/guix.texi:11809
20701 msgid "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R packages;"
20705 #: guix-git/doc/guix.texi:11811
20706 msgid "the updater for @uref{https://www.cpan.org/, CPAN} packages;"
20710 #: guix-git/doc/guix.texi:11813
20711 msgid "the updater for @uref{https://pypi.python.org, PyPI} packages."
20715 #: guix-git/doc/guix.texi:11815
20716 msgid "the updater for @uref{https://rubygems.org, RubyGems} packages."
20720 #: guix-git/doc/guix.texi:11815
20726 #: guix-git/doc/guix.texi:11817
20727 msgid "the updater for @uref{https://github.com, GitHub} packages."
20731 #: guix-git/doc/guix.texi:11819
20732 msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages."
20736 #: guix-git/doc/guix.texi:11821
20737 msgid "the updater for @uref{https://www.stackage.org, Stackage} packages."
20741 #: guix-git/doc/guix.texi:11823
20742 msgid "the updater for @uref{https://crates.io, Crates} packages."
20746 #: guix-git/doc/guix.texi:11823
20752 #: guix-git/doc/guix.texi:11825
20753 msgid "the updater for @uref{https://launchpad.net, Launchpad} packages."
20757 #: guix-git/doc/guix.texi:11825
20759 msgid "generic-html"
20763 #: guix-git/doc/guix.texi:11828
20764 msgid "a generic updater that crawls the HTML page where the source tarball of the package is hosted, when applicable."
20768 #: guix-git/doc/guix.texi:11832
20769 msgid "For instance, the following command only checks for updates of Emacs packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages:"
20773 #: guix-git/doc/guix.texi:11837
20776 "$ guix refresh --type=elpa,cran\n"
20777 "gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0\n"
20778 "gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9\n"
20782 #: guix-git/doc/guix.texi:11839
20784 msgid "--list-updaters"
20788 #: guix-git/doc/guix.texi:11840
20794 #: guix-git/doc/guix.texi:11842
20795 msgid "List available updaters and exit (see @option{--type} above)."
20799 #: guix-git/doc/guix.texi:11845
20800 msgid "For each updater, display the fraction of packages it covers; at the end, display the fraction of packages covered by all these updaters."
20803 #. type: Plain text
20804 #: guix-git/doc/guix.texi:11849
20805 msgid "In addition, @command{guix refresh} can be passed one or more package names, as in this example:"
20809 #: guix-git/doc/guix.texi:11852
20811 msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n"
20814 #. type: Plain text
20815 #: guix-git/doc/guix.texi:11859
20816 msgid "The command above specifically updates the @code{emacs} and @code{idutils} packages. The @option{--select} option would have no effect in this case. You might also want to update definitions that correspond to the packages installed in your profile:"
20820 #: guix-git/doc/guix.texi:11863
20823 "$ ./pre-inst-env guix refresh -u \\\n"
20824 " $(guix package --list-installed | cut -f1)\n"
20827 #. type: Plain text
20828 #: guix-git/doc/guix.texi:11869
20829 msgid "When considering whether to upgrade a package, it is sometimes convenient to know which packages would be affected by the upgrade and should be checked for compatibility. For this the following option may be used when passing @command{guix refresh} one or more package names:"
20833 #: guix-git/doc/guix.texi:11872
20835 msgid "--list-dependent"
20839 #: guix-git/doc/guix.texi:11873 guix-git/doc/guix.texi:12132
20845 #: guix-git/doc/guix.texi:11876
20846 msgid "List top-level dependent packages that would need to be rebuilt as a result of upgrading one or more packages."
20850 #: guix-git/doc/guix.texi:11880
20851 msgid "@xref{Invoking guix graph, the @code{reverse-package} type of @command{guix graph}}, for information on how to visualize the list of dependents of a package."
20854 #. type: Plain text
20855 #: guix-git/doc/guix.texi:11886
20856 msgid "Be aware that the @option{--list-dependent} option only @emph{approximates} the rebuilds that would be required as a result of an upgrade. More rebuilds might be required under some circumstances."
20860 #: guix-git/doc/guix.texi:11891
20863 "$ guix refresh --list-dependent flex\n"
20864 "Building the following 120 packages would ensure 213 dependent packages are rebuilt:\n"
20865 "hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n"
20868 #. type: Plain text
20869 #: guix-git/doc/guix.texi:11895
20870 msgid "The command above lists a set of packages that could be built to check for compatibility with an upgraded @code{flex} package."
20874 #: guix-git/doc/guix.texi:11898
20876 msgid "--list-transitive"
20880 #: guix-git/doc/guix.texi:11900
20881 msgid "List all the packages which one or more packages depend upon."
20885 #: guix-git/doc/guix.texi:11905
20888 "$ guix refresh --list-transitive flex\n"
20889 "flex@@2.6.4 depends on the following 25 packages: perl@@5.28.0 help2man@@1.47.6\n"
20890 "bison@@3.0.5 indent@@2.2.10 tar@@1.30 gzip@@1.9 bzip2@@1.0.6 xz@@5.2.4 file@@5.33 @dots{}\n"
20893 #. type: Plain text
20894 #: guix-git/doc/guix.texi:11911
20895 msgid "The command above lists a set of packages which, when changed, would cause @code{flex} to be rebuilt."
20898 #. type: Plain text
20899 #: guix-git/doc/guix.texi:11913
20900 msgid "The following options can be used to customize GnuPG operation:"
20904 #: guix-git/doc/guix.texi:11916
20906 msgid "--gpg=@var{command}"
20910 #: guix-git/doc/guix.texi:11919
20911 msgid "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for in @code{$PATH}."
20915 #: guix-git/doc/guix.texi:11920
20917 msgid "--keyring=@var{file}"
20921 #: guix-git/doc/guix.texi:11926
20922 msgid "Use @var{file} as the keyring for upstream keys. @var{file} must be in the @dfn{keybox format}. Keybox files usually have a name ending in @file{.kbx} and the GNU@tie{}Privacy Guard (GPG) can manipulate these files (@pxref{kbxutil, @command{kbxutil},, gnupg, Using the GNU Privacy Guard}, for information on a tool to manipulate keybox files)."
20926 #: guix-git/doc/guix.texi:11932
20927 msgid "When this option is omitted, @command{guix refresh} uses @file{~/.config/guix/upstream/trustedkeys.kbx} as the keyring for upstream signing keys. OpenPGP signatures are checked against keys from this keyring; missing keys are downloaded to this keyring as well (see @option{--key-download} below)."
20931 #: guix-git/doc/guix.texi:11935
20932 msgid "You can export keys from your default GPG keyring into a keybox file using commands like this one:"
20936 #: guix-git/doc/guix.texi:11938
20938 msgid "gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx\n"
20942 #: guix-git/doc/guix.texi:11941
20943 msgid "Likewise, you can fetch keys to a specific keybox file like this:"
20947 #: guix-git/doc/guix.texi:11945
20950 "gpg --no-default-keyring --keyring mykeyring.kbx \\\n"
20951 " --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n"
20955 #: guix-git/doc/guix.texi:11949
20956 msgid "@xref{GPG Configuration Options, @option{--keyring},, gnupg, Using the GNU Privacy Guard}, for more information on GPG's @option{--keyring} option."
20960 #: guix-git/doc/guix.texi:11953
20961 msgid "Handle missing OpenPGP keys according to @var{policy}, which may be one of:"
20965 #: guix-git/doc/guix.texi:11955 guix-git/doc/guix.texi:20822
20971 #: guix-git/doc/guix.texi:11958
20972 msgid "Always download missing OpenPGP keys from the key server, and add them to the user's GnuPG keyring."
20976 #: guix-git/doc/guix.texi:11959 guix-git/doc/guix.texi:20824
20982 #: guix-git/doc/guix.texi:11961
20983 msgid "Never try to download missing OpenPGP keys. Instead just bail out."
20987 #: guix-git/doc/guix.texi:11962
20989 msgid "interactive"
20993 #: guix-git/doc/guix.texi:11965
20994 msgid "When a package signed with an unknown OpenPGP key is encountered, ask the user whether to download it or not. This is the default behavior."
20998 #: guix-git/doc/guix.texi:11967
21000 msgid "--key-server=@var{host}"
21004 #: guix-git/doc/guix.texi:11969
21005 msgid "Use @var{host} as the OpenPGP key server when importing a public key."
21008 #. type: Plain text
21009 #: guix-git/doc/guix.texi:11989
21010 msgid "The @code{github} updater uses the @uref{https://developer.github.com/v3/, GitHub API} to query for new releases. When used repeatedly e.g.@: when refreshing all packages, GitHub will eventually refuse to answer any further API requests. By default 60 API requests per hour are allowed, and a full refresh on all GitHub packages in Guix requires more than this. Authentication with GitHub through the use of an API token alleviates these limits. To use an API token, set the environment variable @env{GUIX_GITHUB_TOKEN} to a token procured from @uref{https://github.com/settings/tokens} or otherwise."
21014 #: guix-git/doc/guix.texi:11992
21016 msgid "Invoking @command{guix lint}"
21019 #. type: command{#1}
21020 #: guix-git/doc/guix.texi:11994
21026 #: guix-git/doc/guix.texi:11995
21028 msgid "package, checking for errors"
21031 #. type: Plain text
21032 #: guix-git/doc/guix.texi:12001
21033 msgid "The @command{guix lint} command is meant to help package developers avoid common errors and use a consistent style. It runs a number of checks on a given set of packages in order to find common mistakes in their definitions. Available @dfn{checkers} include (see @option{--list-checkers} for a complete list):"
21037 #: guix-git/doc/guix.texi:12007
21038 msgid "Validate certain typographical and stylistic rules about package descriptions and synopses."
21042 #: guix-git/doc/guix.texi:12008
21044 msgid "inputs-should-be-native"
21048 #: guix-git/doc/guix.texi:12010
21049 msgid "Identify inputs that should most likely be native inputs."
21053 #: guix-git/doc/guix.texi:12013
21059 #: guix-git/doc/guix.texi:12014
21065 #: guix-git/doc/guix.texi:12015
21067 msgid "source-file-name"
21071 #: guix-git/doc/guix.texi:12022
21072 msgid "Probe @code{home-page} and @code{source} URLs and report those that are invalid. Suggest a @code{mirror://} URL when applicable. If the @code{source} URL redirects to a GitHub URL, recommend usage of the GitHub URL@. Check that the source file name is meaningful, e.g.@: is not just a version number or ``git-checkout'', without a declared @code{file-name} (@pxref{origin Reference})."
21076 #: guix-git/doc/guix.texi:12023
21078 msgid "source-unstable-tarball"
21082 #: guix-git/doc/guix.texi:12027
21083 msgid "Parse the @code{source} URL to determine if a tarball from GitHub is autogenerated or if it is a release tarball. Unfortunately GitHub's autogenerated tarballs are sometimes regenerated."
21087 #: guix-git/doc/guix.texi:12031
21088 msgid "Check that the derivation of the given packages can be successfully computed for all the supported systems (@pxref{Derivations})."
21092 #: guix-git/doc/guix.texi:12032
21094 msgid "profile-collisions"
21098 #: guix-git/doc/guix.texi:12038
21099 msgid "Check whether installing the given packages in a profile would lead to collisions. Collisions occur when several packages with the same name but a different version or a different store file name are propagated. @xref{package Reference, @code{propagated-inputs}}, for more information on propagated inputs."
21103 #: guix-git/doc/guix.texi:12039
21109 #: guix-git/doc/guix.texi:12040
21111 msgid "Software Heritage, source code archive"
21115 #: guix-git/doc/guix.texi:12041
21117 msgid "archival of source code, Software Heritage"
21121 #: guix-git/doc/guix.texi:12044
21122 msgid "Checks whether the package's source code is archived at @uref{https://www.softwareheritage.org, Software Heritage}."
21126 #: guix-git/doc/guix.texi:12052
21127 msgid "When the source code that is not archived comes from a version-control system (VCS)---e.g., it's obtained with @code{git-fetch}, send Software Heritage a ``save'' request so that it eventually archives it. This ensures that the source will remain available in the long term, and that Guix can fall back to Software Heritage should the source code disappear from its original host. The status of recent ``save'' requests can be @uref{https://archive.softwareheritage.org/save/#requests, viewed on-line}."
21131 #: guix-git/doc/guix.texi:12057
21132 msgid "When source code is a tarball obtained with @code{url-fetch}, simply print a message when it is not archived. As of this writing, Software Heritage does not allow requests to save arbitrary tarballs; we are working on ways to ensure that non-VCS source code is also archived."
21136 #: guix-git/doc/guix.texi:12063
21137 msgid "Software Heritage @uref{https://archive.softwareheritage.org/api/#rate-limiting, limits the request rate per IP address}. When the limit is reached, @command{guix lint} prints a message and the @code{archival} checker stops doing anything until that limit has been reset."
21141 #: guix-git/doc/guix.texi:12064
21147 #: guix-git/doc/guix.texi:12065 guix-git/doc/guix.texi:34598
21149 msgid "security vulnerabilities"
21153 #: guix-git/doc/guix.texi:12066
21155 msgid "CVE, Common Vulnerabilities and Exposures"
21159 #: guix-git/doc/guix.texi:12071
21160 msgid "Report known vulnerabilities found in the Common Vulnerabilities and Exposures (CVE) databases of the current and past year @uref{https://nvd.nist.gov/vuln/data-feeds, published by the US NIST}."
21164 #: guix-git/doc/guix.texi:12073
21165 msgid "To view information about a particular vulnerability, visit pages such as:"
21168 #. type: indicateurl{#1}
21169 #: guix-git/doc/guix.texi:12077
21170 msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD"
21173 #. type: indicateurl{#1}
21174 #: guix-git/doc/guix.texi:12079
21175 msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD"
21179 #: guix-git/doc/guix.texi:12084
21180 msgid "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., @code{CVE-2015-7554}."
21184 #: guix-git/doc/guix.texi:12089
21185 msgid "Package developers can specify in package recipes the @uref{https://nvd.nist.gov/products/cpe,Common Platform Enumeration (CPE)} name and version of the package when they differ from the name or version that Guix uses, as in this example:"
21189 #: guix-git/doc/guix.texi:12097
21193 " (name \"grub\")\n"
21195 " ;; CPE calls this package \"grub2\".\n"
21196 " (properties '((cpe-name . \"grub2\")\n"
21197 " (cpe-version . \"2.3\"))))\n"
21201 #: guix-git/doc/guix.texi:12104
21202 msgid "Some entries in the CVE database do not specify which version of a package they apply to, and would thus ``stick around'' forever. Package developers who found CVE alerts and verified they can be ignored can declare them as in this example:"
21206 #: guix-git/doc/guix.texi:12114
21210 " (name \"t1lib\")\n"
21212 " ;; These CVEs no longer apply and can be safely ignored.\n"
21213 " (properties `((lint-hidden-cve . (\"CVE-2011-0433\"\n"
21214 " \"CVE-2011-1553\"\n"
21215 " \"CVE-2011-1554\"\n"
21216 " \"CVE-2011-5244\")))))\n"
21220 #: guix-git/doc/guix.texi:12116
21226 #: guix-git/doc/guix.texi:12119
21227 msgid "Warn about obvious source code formatting issues: trailing white space, use of tabulations, etc."
21231 #: guix-git/doc/guix.texi:12125
21233 msgid "guix lint @var{options} @var{package}@dots{}\n"
21236 #. type: Plain text
21237 #: guix-git/doc/guix.texi:12129
21238 msgid "If no package is given on the command line, then all packages are checked. The @var{options} may be zero or more of the following:"
21242 #: guix-git/doc/guix.texi:12131
21244 msgid "--list-checkers"
21248 #: guix-git/doc/guix.texi:12135
21249 msgid "List and describe all the available checkers that will be run on packages and exit."
21253 #: guix-git/doc/guix.texi:12136
21259 #: guix-git/doc/guix.texi:12137
21265 #: guix-git/doc/guix.texi:12140
21266 msgid "Only enable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
21270 #: guix-git/doc/guix.texi:12141
21276 #: guix-git/doc/guix.texi:12145
21277 msgid "Only disable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
21281 #: guix-git/doc/guix.texi:12146
21283 msgid "--no-network"
21287 #: guix-git/doc/guix.texi:12149
21288 msgid "Only enable the checkers that do not depend on Internet access."
21292 #: guix-git/doc/guix.texi:12161
21294 msgid "Invoking @command{guix size}"
21298 #: guix-git/doc/guix.texi:12163 guix-git/doc/guix.texi:33534
21304 #: guix-git/doc/guix.texi:12164
21306 msgid "package size"
21309 #. type: command{#1}
21310 #: guix-git/doc/guix.texi:12166
21315 #. type: Plain text
21316 #: guix-git/doc/guix.texi:12173
21317 msgid "The @command{guix size} command helps package developers profile the disk usage of packages. It is easy to overlook the impact of an additional dependency added to a package, or the impact of using a single output for a package that could easily be split (@pxref{Packages with Multiple Outputs}). Such are the typical issues that @command{guix size} can highlight."
21320 #. type: Plain text
21321 #: guix-git/doc/guix.texi:12178
21322 msgid "The command can be passed one or more package specifications such as @code{gcc@@4.8} or @code{guile:debug}, or a file name in the store. Consider this example:"
21326 #: guix-git/doc/guix.texi:12191
21329 "$ guix size coreutils\n"
21330 "store item total self\n"
21331 "/gnu/store/@dots{}-gcc-5.5.0-lib 60.4 30.1 38.1%\n"
21332 "/gnu/store/@dots{}-glibc-2.27 30.3 28.8 36.6%\n"
21333 "/gnu/store/@dots{}-coreutils-8.28 78.9 15.0 19.0%\n"
21334 "/gnu/store/@dots{}-gmp-6.1.2 63.1 2.7 3.4%\n"
21335 "/gnu/store/@dots{}-bash-static-4.4.12 1.5 1.5 1.9%\n"
21336 "/gnu/store/@dots{}-acl-2.2.52 61.1 0.4 0.5%\n"
21337 "/gnu/store/@dots{}-attr-2.4.47 60.6 0.2 0.3%\n"
21338 "/gnu/store/@dots{}-libcap-2.25 60.5 0.2 0.2%\n"
21339 "total: 78.9 MiB\n"
21342 #. type: Plain text
21343 #: guix-git/doc/guix.texi:12197
21344 msgid "The store items listed here constitute the @dfn{transitive closure} of Coreutils---i.e., Coreutils and all its dependencies, recursively---as would be returned by:"
21348 #: guix-git/doc/guix.texi:12200
21350 msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n"
21353 #. type: Plain text
21354 #: guix-git/doc/guix.texi:12208
21355 msgid "Here the output shows three columns next to store items. The first column, labeled ``total'', shows the size in mebibytes (MiB) of the closure of the store item---that is, its own size plus the size of all its dependencies. The next column, labeled ``self'', shows the size of the item itself. The last column shows the ratio of the size of the item itself to the space occupied by all the items listed here."
21358 #. type: Plain text
21359 #: guix-git/doc/guix.texi:12214
21360 msgid "In this example, we see that the closure of Coreutils weighs in at 79@tie{}MiB, most of which is taken by libc and GCC's run-time support libraries. (That libc and GCC's libraries represent a large fraction of the closure is not a problem @i{per se} because they are always available on the system anyway.)"
21363 #. type: Plain text
21364 #: guix-git/doc/guix.texi:12217
21365 msgid "Since the command also accepts store file names, assessing the size of a build result is straightforward:"
21369 #: guix-git/doc/guix.texi:12220
21371 msgid "guix size $(guix system build config.scm)\n"
21374 #. type: Plain text
21375 #: guix-git/doc/guix.texi:12230
21376 msgid "When the package(s) passed to @command{guix size} are available in the store@footnote{More precisely, @command{guix size} looks for the @emph{ungrafted} variant of the given package(s), as returned by @code{guix build @var{package} --no-grafts}. @xref{Security Updates}, for information on grafts.}, @command{guix size} queries the daemon to determine its dependencies, and measures its size in the store, similar to @command{du -ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU Coreutils})."
21379 #. type: Plain text
21380 #: guix-git/doc/guix.texi:12235
21381 msgid "When the given packages are @emph{not} in the store, @command{guix size} reports information based on the available substitutes (@pxref{Substitutes}). This makes it possible it to profile disk usage of store items that are not even on disk, only available remotely."
21384 #. type: Plain text
21385 #: guix-git/doc/guix.texi:12237
21386 msgid "You can also specify several package names:"
21390 #: guix-git/doc/guix.texi:12247
21393 "$ guix size coreutils grep sed bash\n"
21394 "store item total self\n"
21395 "/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4%\n"
21396 "/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8%\n"
21397 "/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6%\n"
21398 "/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2%\n"
21400 "total: 102.3 MiB\n"
21403 #. type: Plain text
21404 #: guix-git/doc/guix.texi:12253
21405 msgid "In this example we see that the combination of the four packages takes 102.3@tie{}MiB in total, which is much less than the sum of each closure since they have a lot of dependencies in common."
21408 #. type: Plain text
21409 #: guix-git/doc/guix.texi:12259
21410 msgid "When looking at the profile returned by @command{guix size}, you may find yourself wondering why a given package shows up in the profile at all. To understand it, you can use @command{guix graph --path -t references} to display the shortest path between the two packages (@pxref{Invoking guix graph})."
21413 #. type: Plain text
21414 #: guix-git/doc/guix.texi:12261
21415 msgid "The available options are:"
21419 #: guix-git/doc/guix.texi:12267
21420 msgid "Use substitute information from @var{urls}. @xref{client-substitute-urls, the same option for @code{guix build}}."
21424 #: guix-git/doc/guix.texi:12268
21426 msgid "--sort=@var{key}"
21430 #: guix-git/doc/guix.texi:12270
21431 msgid "Sort lines according to @var{key}, one of the following options:"
21435 #: guix-git/doc/guix.texi:12272
21441 #: guix-git/doc/guix.texi:12274
21442 msgid "the size of each item (the default);"
21446 #: guix-git/doc/guix.texi:12276
21447 msgid "the total size of the item's closure."
21451 #: guix-git/doc/guix.texi:12278
21453 msgid "--map-file=@var{file}"
21457 #: guix-git/doc/guix.texi:12280
21458 msgid "Write a graphical map of disk usage in PNG format to @var{file}."
21462 #: guix-git/doc/guix.texi:12282
21463 msgid "For the example above, the map looks like this:"
21467 #: guix-git/doc/guix.texi:12285
21468 msgid "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced by @command{guix size}}"
21472 #: guix-git/doc/guix.texi:12290
21473 msgid "This option requires that @uref{https://wingolog.org/software/guile-charting/, Guile-Charting} be installed and visible in Guile's module search path. When that is not the case, @command{guix size} fails as it tries to load it."
21477 #: guix-git/doc/guix.texi:12294
21478 msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}."
21482 #: guix-git/doc/guix.texi:12305
21484 msgid "Invoking @command{guix graph}"
21488 #: guix-git/doc/guix.texi:12307
21493 #. type: command{#1}
21494 #: guix-git/doc/guix.texi:12308
21499 #. type: Plain text
21500 #: guix-git/doc/guix.texi:12323
21501 msgid "Packages and their dependencies form a @dfn{graph}, specifically a directed acyclic graph (DAG). It can quickly become difficult to have a mental model of the package DAG, so the @command{guix graph} command provides a visual representation of the DAG@. By default, @command{guix graph} emits a DAG representation in the input format of @uref{https://www.graphviz.org/, Graphviz}, so its output can be passed directly to the @command{dot} command of Graphviz. It can also emit an HTML page with embedded JavaScript code to display a ``chord diagram'' in a Web browser, using the @uref{https://d3js.org/, d3.js} library, or emit Cypher queries to construct a graph in a graph database supporting the @uref{https://www.opencypher.org/, openCypher} query language. With @option{--path}, it simply displays the shortest path between two packages. The general syntax is:"
21505 #: guix-git/doc/guix.texi:12326
21507 msgid "guix graph @var{options} @var{package}@dots{}\n"
21510 #. type: Plain text
21511 #: guix-git/doc/guix.texi:12331
21512 msgid "For example, the following command generates a PDF file representing the package DAG for the GNU@tie{}Core Utilities, showing its build-time dependencies:"
21516 #: guix-git/doc/guix.texi:12334
21518 msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n"
21521 #. type: Plain text
21522 #: guix-git/doc/guix.texi:12337
21523 msgid "The output looks like this:"
21526 #. type: Plain text
21527 #: guix-git/doc/guix.texi:12339
21528 msgid "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}"
21531 #. type: Plain text
21532 #: guix-git/doc/guix.texi:12341
21533 msgid "Nice little graph, no?"
21536 #. type: Plain text
21537 #: guix-git/doc/guix.texi:12344
21538 msgid "You may find it more pleasant to navigate the graph interactively with @command{xdot} (from the @code{xdot} package):"
21542 #: guix-git/doc/guix.texi:12347
21544 msgid "guix graph coreutils | xdot -\n"
21547 #. type: Plain text
21548 #: guix-git/doc/guix.texi:12354
21549 msgid "But there is more than one graph! The one above is concise: it is the graph of package objects, omitting implicit inputs such as GCC, libc, grep, etc. It is often useful to have such a concise graph, but sometimes one may want to see more details. @command{guix graph} supports several types of graphs, allowing you to choose the level of detail:"
21553 #: guix-git/doc/guix.texi:12360
21554 msgid "This is the default type used in the example above. It shows the DAG of package objects, excluding implicit dependencies. It is concise, but filters out many details."
21558 #: guix-git/doc/guix.texi:12361
21560 msgid "reverse-package"
21564 #: guix-git/doc/guix.texi:12363
21565 msgid "This shows the @emph{reverse} DAG of packages. For example:"
21569 #: guix-git/doc/guix.texi:12366
21571 msgid "guix graph --type=reverse-package ocaml\n"
21575 #: guix-git/doc/guix.texi:12371
21576 msgid "...@: yields the graph of packages that @emph{explicitly} depend on OCaml (if you are also interested in cases where OCaml is an implicit dependency, see @code{reverse-bag} below)."
21580 #: guix-git/doc/guix.texi:12376
21581 msgid "Note that for core packages this can yield huge graphs. If all you want is to know the number of packages that depend on a given package, use @command{guix refresh --list-dependent} (@pxref{Invoking guix refresh, @option{--list-dependent}})."
21585 #: guix-git/doc/guix.texi:12377
21587 msgid "bag-emerged"
21591 #: guix-git/doc/guix.texi:12379
21592 msgid "This is the package DAG, @emph{including} implicit inputs."
21596 #: guix-git/doc/guix.texi:12381
21597 msgid "For instance, the following command:"
21601 #: guix-git/doc/guix.texi:12384
21603 msgid "guix graph --type=bag-emerged coreutils\n"
21607 #: guix-git/doc/guix.texi:12387
21608 msgid "...@: yields this bigger graph:"
21612 #: guix-git/doc/guix.texi:12389
21613 msgid "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils}"
21617 #: guix-git/doc/guix.texi:12392
21618 msgid "At the bottom of the graph, we see all the implicit inputs of @var{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})."
21622 #: guix-git/doc/guix.texi:12396
21623 msgid "Now, note that the dependencies of these implicit inputs---that is, the @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, for conciseness."
21627 #: guix-git/doc/guix.texi:12397
21633 #: guix-git/doc/guix.texi:12400
21634 msgid "Similar to @code{bag-emerged}, but this time including all the bootstrap dependencies."
21638 #: guix-git/doc/guix.texi:12401
21640 msgid "bag-with-origins"
21644 #: guix-git/doc/guix.texi:12403
21645 msgid "Similar to @code{bag}, but also showing origins and their dependencies."
21649 #: guix-git/doc/guix.texi:12404
21651 msgid "reverse-bag"
21655 #: guix-git/doc/guix.texi:12407
21656 msgid "This shows the @emph{reverse} DAG of packages. Unlike @code{reverse-package}, it also takes implicit dependencies into account. For example:"
21660 #: guix-git/doc/guix.texi:12410
21662 msgid "guix graph -t reverse-bag dune\n"
21666 #: guix-git/doc/guix.texi:12417
21667 msgid "...@: yields the graph of all packages that depend on Dune, directly or indirectly. Since Dune is an @emph{implicit} dependency of many packages @i{via} @code{dune-build-system}, this shows a large number of packages, whereas @code{reverse-package} would show very few if any."
21671 #: guix-git/doc/guix.texi:12423
21672 msgid "This is the most detailed representation: It shows the DAG of derivations (@pxref{Derivations}) and plain store items. Compared to the above representation, many additional nodes are visible, including build scripts, patches, Guile modules, etc."
21676 #: guix-git/doc/guix.texi:12426
21677 msgid "For this type of graph, it is also possible to pass a @file{.drv} file name instead of a package name, as in:"
21681 #: guix-git/doc/guix.texi:12429
21683 msgid "guix graph -t derivation $(guix system build -d my-config.scm)\n"
21687 #: guix-git/doc/guix.texi:12431
21693 #: guix-git/doc/guix.texi:12435
21694 msgid "This is the graph of @dfn{package modules} (@pxref{Package Modules}). For example, the following command shows the graph for the package module that defines the @code{guile} package:"
21698 #: guix-git/doc/guix.texi:12438
21700 msgid "guix graph -t module guile | xdot -\n"
21703 #. type: Plain text
21704 #: guix-git/doc/guix.texi:12443
21705 msgid "All the types above correspond to @emph{build-time dependencies}. The following graph type represents the @emph{run-time dependencies}:"
21709 #: guix-git/doc/guix.texi:12448
21710 msgid "This is the graph of @dfn{references} of a package output, as returned by @command{guix gc --references} (@pxref{Invoking guix gc})."
21714 #: guix-git/doc/guix.texi:12451
21715 msgid "If the given package output is not available in the store, @command{guix graph} attempts to obtain dependency information from substitutes."
21719 #: guix-git/doc/guix.texi:12455
21720 msgid "Here you can also pass a store file name instead of a package name. For example, the command below produces the reference graph of your profile (which can be big!):"
21724 #: guix-git/doc/guix.texi:12458
21726 msgid "guix graph -t references $(readlink -f ~/.guix-profile)\n"
21730 #: guix-git/doc/guix.texi:12460
21736 #: guix-git/doc/guix.texi:12463
21737 msgid "This is the graph of the @dfn{referrers} of a store item, as returned by @command{guix gc --referrers} (@pxref{Invoking guix gc})."
21741 #: guix-git/doc/guix.texi:12469
21742 msgid "This relies exclusively on local information from your store. For instance, let us suppose that the current Inkscape is available in 10 profiles on your machine; @command{guix graph -t referrers inkscape} will show a graph rooted at Inkscape and with those 10 profiles linked to it."
21746 #: guix-git/doc/guix.texi:12472
21747 msgid "It can help determine what is preventing a store item from being garbage collected."
21751 #: guix-git/doc/guix.texi:12475
21753 msgid "shortest path, between packages"
21756 #. type: Plain text
21757 #: guix-git/doc/guix.texi:12482
21758 msgid "Often, the graph of the package you are interested in does not fit on your screen, and anyway all you want to know is @emph{why} that package actually depends on some seemingly unrelated package. The @option{--path} option instructs @command{guix graph} to display the shortest path between two packages (or derivations, or store items, etc.):"
21762 #: guix-git/doc/guix.texi:12496
21765 "$ guix graph --path emacs libunistring\n"
21768 "libunistring@@0.9.10\n"
21769 "$ guix graph --path -t derivation emacs libunistring\n"
21770 "/gnu/store/@dots{}-emacs-26.3.drv\n"
21771 "/gnu/store/@dots{}-mailutils-3.9.drv\n"
21772 "/gnu/store/@dots{}-libunistring-0.9.10.drv\n"
21773 "$ guix graph --path -t references emacs libunistring\n"
21774 "/gnu/store/@dots{}-emacs-26.3\n"
21775 "/gnu/store/@dots{}-libidn2-2.2.0\n"
21776 "/gnu/store/@dots{}-libunistring-0.9.10\n"
21779 #. type: Plain text
21780 #: guix-git/doc/guix.texi:12499
21781 msgid "The available options are the following:"
21785 #: guix-git/doc/guix.texi:12505
21786 msgid "Produce a graph output of @var{type}, where @var{type} must be one of the values listed above."
21790 #: guix-git/doc/guix.texi:12506
21792 msgid "--list-types"
21796 #: guix-git/doc/guix.texi:12508
21797 msgid "List the supported graph types."
21801 #: guix-git/doc/guix.texi:12509
21803 msgid "--backend=@var{backend}"
21807 #: guix-git/doc/guix.texi:12510
21809 msgid "-b @var{backend}"
21813 #: guix-git/doc/guix.texi:12512
21814 msgid "Produce a graph using the selected @var{backend}."
21818 #: guix-git/doc/guix.texi:12513
21820 msgid "--list-backends"
21824 #: guix-git/doc/guix.texi:12515
21825 msgid "List the supported graph backends."
21829 #: guix-git/doc/guix.texi:12517
21830 msgid "Currently, the available backends are Graphviz and d3.js."
21834 #: guix-git/doc/guix.texi:12518
21840 #: guix-git/doc/guix.texi:12523
21841 msgid "Display the shortest path between two nodes of the type specified by @option{--type}. The example below shows the shortest path between @code{libreoffice} and @code{llvm} according to the references of @code{libreoffice}:"
21845 #: guix-git/doc/guix.texi:12530
21848 "$ guix graph --path -t references libreoffice llvm\n"
21849 "/gnu/store/@dots{}-libreoffice-6.4.2.2\n"
21850 "/gnu/store/@dots{}-libepoxy-1.5.4\n"
21851 "/gnu/store/@dots{}-mesa-19.3.4\n"
21852 "/gnu/store/@dots{}-llvm-9.0.1\n"
21856 #: guix-git/doc/guix.texi:12540
21858 msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n"
21862 #: guix-git/doc/guix.texi:12545
21863 msgid "Display the graph for @var{system}---e.g., @code{i686-linux}."
21867 #: guix-git/doc/guix.texi:12548
21868 msgid "The package dependency graph is largely architecture-independent, but there are some architecture-dependent bits that this option allows you to visualize."
21871 #. type: Plain text
21872 #: guix-git/doc/guix.texi:12564
21873 msgid "On top of that, @command{guix graph} supports all the usual package transformation options (@pxref{Package Transformation Options}). This makes it easy to view the effect of a graph-rewriting transformation such as @option{--with-input}. For example, the command below outputs the graph of @code{git} once @code{openssl} has been replaced by @code{libressl} everywhere in the graph:"
21877 #: guix-git/doc/guix.texi:12567
21879 msgid "guix graph git --with-input=openssl=libressl\n"
21882 #. type: Plain text
21883 #: guix-git/doc/guix.texi:12570
21884 msgid "So many possibilities, so much fun!"
21888 #: guix-git/doc/guix.texi:12572
21890 msgid "Invoking @command{guix publish}"
21893 #. type: command{#1}
21894 #: guix-git/doc/guix.texi:12574
21896 msgid "guix publish"
21899 #. type: Plain text
21900 #: guix-git/doc/guix.texi:12578
21901 msgid "The purpose of @command{guix publish} is to enable users to easily share their store with others, who can then use it as a substitute server (@pxref{Substitutes})."
21904 #. type: Plain text
21905 #: guix-git/doc/guix.texi:12584
21906 msgid "When @command{guix publish} runs, it spawns an HTTP server which allows anyone with network access to obtain substitutes from it. This means that any machine running Guix can also act as if it were a build farm, since the HTTP interface is compatible with Cuirass, the software behind the @code{@value{SUBSTITUTE-SERVER}} build farm."
21909 #. type: Plain text
21910 #: guix-git/doc/guix.texi:12590
21911 msgid "For security, each substitute is signed, allowing recipients to check their authenticity and integrity (@pxref{Substitutes}). Because @command{guix publish} uses the signing key of the system, which is only readable by the system administrator, it must be started as root; the @option{--user} option makes it drop root privileges early on."
21914 #. type: Plain text
21915 #: guix-git/doc/guix.texi:12594
21916 msgid "The signing key pair must be generated before @command{guix publish} is launched, using @command{guix archive --generate-key} (@pxref{Invoking guix archive})."
21919 #. type: Plain text
21920 #: guix-git/doc/guix.texi:12599
21921 msgid "When the @option{--advertise} option is passed, the server advertises its availability on the local network using multicast DNS (mDNS) and DNS service discovery (DNS-SD), currently @i{via} Guile-Avahi (@pxref{Top,,, guile-avahi, Using Avahi in Guile Scheme Programs})."
21925 #: guix-git/doc/guix.texi:12604
21927 msgid "guix publish @var{options}@dots{}\n"
21930 #. type: Plain text
21931 #: guix-git/doc/guix.texi:12608
21932 msgid "Running @command{guix publish} without any additional arguments will spawn an HTTP server on port 8080:"
21936 #: guix-git/doc/guix.texi:12611
21938 msgid "guix publish\n"
21941 #. type: Plain text
21942 #: guix-git/doc/guix.texi:12615
21943 msgid "Once a publishing server has been authorized, the daemon may download substitutes from it. @xref{Getting Substitutes from Other Servers}."
21946 #. type: Plain text
21947 #: guix-git/doc/guix.texi:12623
21948 msgid "By default, @command{guix publish} compresses archives on the fly as it serves them. This ``on-the-fly'' mode is convenient in that it requires no setup and is immediately available. However, when serving lots of clients, we recommend using the @option{--cache} option, which enables caching of the archives before they are sent to clients---see below for details. The @command{guix weather} command provides a handy way to check what a server provides (@pxref{Invoking guix weather})."
21951 #. type: Plain text
21952 #: guix-git/doc/guix.texi:12630
21953 msgid "As a bonus, @command{guix publish} also serves as a content-addressed mirror for source files referenced in @code{origin} records (@pxref{origin Reference}). For instance, assuming @command{guix publish} is running on @code{example.org}, the following URL returns the raw @file{hello-2.10.tar.gz} file with the given SHA256 hash (represented in @code{nix-base32} format, @pxref{Invoking guix hash}):"
21957 #: guix-git/doc/guix.texi:12633
21959 msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n"
21962 #. type: Plain text
21963 #: guix-git/doc/guix.texi:12637
21964 msgid "Obviously, these URLs only work for files that are in the store; in other cases, they return 404 (``Not Found'')."
21968 #: guix-git/doc/guix.texi:12638
21970 msgid "build logs, publication"
21973 #. type: Plain text
21974 #: guix-git/doc/guix.texi:12640
21975 msgid "Build logs are available from @code{/log} URLs like:"
21979 #: guix-git/doc/guix.texi:12643
21981 msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n"
21984 #. type: Plain text
21985 #: guix-git/doc/guix.texi:12653
21986 msgid "When @command{guix-daemon} is configured to save compressed build logs, as is the case by default (@pxref{Invoking guix-daemon}), @code{/log} URLs return the compressed log as-is, with an appropriate @code{Content-Type} and/or @code{Content-Encoding} header. We recommend running @command{guix-daemon} with @option{--log-compression=gzip} since Web browsers can automatically decompress it, which is not the case with Bzip2 compression."
21990 #: guix-git/doc/guix.texi:12657
21992 msgid "--port=@var{port}"
21996 #: guix-git/doc/guix.texi:12658
21998 msgid "-p @var{port}"
22002 #: guix-git/doc/guix.texi:12660
22003 msgid "Listen for HTTP requests on @var{port}."
22007 #: guix-git/doc/guix.texi:12661
22009 msgid "--listen=@var{host}"
22013 #: guix-git/doc/guix.texi:12664
22014 msgid "Listen on the network interface for @var{host}. The default is to accept connections from any interface."
22018 #: guix-git/doc/guix.texi:12669
22019 msgid "Change privileges to @var{user} as soon as possible---i.e., once the server socket is open and the signing key has been read."
22023 #: guix-git/doc/guix.texi:12670
22025 msgid "--compression[=@var{method}[:@var{level}]]"
22029 #: guix-git/doc/guix.texi:12671
22031 msgid "-C [@var{method}[:@var{level}]]"
22035 #: guix-git/doc/guix.texi:12675
22036 msgid "Compress data using the given @var{method} and @var{level}. @var{method} is one of @code{lzip}, @code{zstd}, and @code{gzip}; when @var{method} is omitted, @code{gzip} is used."
22040 #: guix-git/doc/guix.texi:12679
22041 msgid "When @var{level} is zero, disable compression. The range 1 to 9 corresponds to different compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). The default is 3."
22045 #: guix-git/doc/guix.texi:12686
22046 msgid "Usually, @code{lzip} compresses noticeably better than @code{gzip} for a small increase in CPU usage; see @uref{https://nongnu.org/lzip/lzip_benchmark.html,benchmarks on the lzip Web page}. However, @code{lzip} achieves low decompression throughput (on the order of 50@tie{}MiB/s on modern hardware), which can be a bottleneck for someone who downloads over a fast network connection."
22050 #: guix-git/doc/guix.texi:12690
22051 msgid "The compression ratio of @code{zstd} is between that of @code{lzip} and that of @code{gzip}; its main advantage is a @uref{https://facebook.github.io/zstd/,high decompression speed}."
22055 #: guix-git/doc/guix.texi:12699
22056 msgid "Unless @option{--cache} is used, compression occurs on the fly and the compressed streams are not cached. Thus, to reduce load on the machine that runs @command{guix publish}, it may be a good idea to choose a low compression level, to run @command{guix publish} behind a caching proxy, or to use @option{--cache}. Using @option{--cache} has the advantage that it allows @command{guix publish} to add @code{Content-Length} HTTP header to its responses."
22060 #: guix-git/doc/guix.texi:12704
22061 msgid "This option can be repeated, in which case every substitute gets compressed using all the selected methods, and all of them are advertised. This is useful when users may not support all the compression methods: they can select the one they support."
22065 #: guix-git/doc/guix.texi:12705
22067 msgid "--cache=@var{directory}"
22071 #: guix-git/doc/guix.texi:12706
22073 msgid "-c @var{directory}"
22077 #: guix-git/doc/guix.texi:12709
22078 msgid "Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and only serve archives that are in cache."
22082 #: guix-git/doc/guix.texi:12717
22083 msgid "When this option is omitted, archives and meta-data are created on-the-fly. This can reduce the available bandwidth, especially when compression is enabled, since this may become CPU-bound. Another drawback of the default mode is that the length of archives is not known in advance, so @command{guix publish} does not add a @code{Content-Length} HTTP header to its responses, which in turn prevents clients from knowing the amount of data being downloaded."
22087 #: guix-git/doc/guix.texi:12725
22088 msgid "Conversely, when @option{--cache} is used, the first request for a store item (@i{via} a @code{.narinfo} URL) triggers a background process to @dfn{bake} the archive---computing its @code{.narinfo} and compressing the archive, if needed. Once the archive is cached in @var{directory}, subsequent requests succeed and are served directly from the cache, which guarantees that clients get the best possible bandwidth."
22092 #: guix-git/doc/guix.texi:12732
22093 msgid "That first @code{.narinfo} request nonetheless returns 200, provided the requested store item is ``small enough'', below the cache bypass threshold---see @option{--cache-bypass-threshold} below. That way, clients do not have to wait until the archive is baked. For larger store items, the first @code{.narinfo} request returns 404, meaning that clients have to wait until the archive is baked."
22097 #: guix-git/doc/guix.texi:12736
22098 msgid "The ``baking'' process is performed by worker threads. By default, one thread per CPU core is created, but this can be customized. See @option{--workers} below."
22102 #: guix-git/doc/guix.texi:12739
22103 msgid "When @option{--ttl} is used, cached entries are automatically deleted when they have expired."
22107 #: guix-git/doc/guix.texi:12740
22109 msgid "--workers=@var{N}"
22113 #: guix-git/doc/guix.texi:12743
22114 msgid "When @option{--cache} is used, request the allocation of @var{N} worker threads to ``bake'' archives."
22118 #: guix-git/doc/guix.texi:12744
22120 msgid "--ttl=@var{ttl}"
22124 #: guix-git/doc/guix.texi:12748
22125 msgid "Produce @code{Cache-Control} HTTP headers that advertise a time-to-live (TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 days, @code{1m} means 1 month, and so on."
22129 #: guix-git/doc/guix.texi:12753
22130 msgid "This allows the user's Guix to keep substitute information in cache for @var{ttl}. However, note that @code{guix publish} does not itself guarantee that the store items it provides will indeed remain available for as long as @var{ttl}."
22134 #: guix-git/doc/guix.texi:12757
22135 msgid "Additionally, when @option{--cache} is used, cached entries that have not been accessed for @var{ttl} and that no longer have a corresponding item in the store, may be deleted."
22139 #: guix-git/doc/guix.texi:12758
22141 msgid "--cache-bypass-threshold=@var{size}"
22145 #: guix-git/doc/guix.texi:12763
22146 msgid "When used in conjunction with @option{--cache}, store items smaller than @var{size} are immediately available, even when they are not yet in cache. @var{size} is a size in bytes, or it can be suffixed by @code{M} for megabytes and so on. The default is @code{10M}."
22150 #: guix-git/doc/guix.texi:12768
22151 msgid "``Cache bypass'' allows you to reduce the publication delay for clients at the expense of possibly additional I/O and CPU use on the server side: depending on the client access patterns, those store items can end up being baked several times until a copy is available in cache."
22155 #: guix-git/doc/guix.texi:12772
22156 msgid "Increasing the threshold may be useful for sites that have few users, or to guarantee that users get substitutes even for store items that are not popular."
22160 #: guix-git/doc/guix.texi:12773
22162 msgid "--nar-path=@var{path}"
22166 #: guix-git/doc/guix.texi:12776
22167 msgid "Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Invoking guix archive, normalized archives})."
22171 #: guix-git/doc/guix.texi:12780
22172 msgid "By default, nars are served at a URL such as @code{/nar/gzip/@dots{}-coreutils-8.25}. This option allows you to change the @code{/nar} part to @var{path}."
22176 #: guix-git/doc/guix.texi:12781
22178 msgid "--public-key=@var{file}"
22182 #: guix-git/doc/guix.texi:12782
22184 msgid "--private-key=@var{file}"
22188 #: guix-git/doc/guix.texi:12785 guix-git/doc/guix.texi:27412
22189 #: guix-git/doc/guix.texi:27446
22190 msgid "Use the specific @var{file}s as the public/private key pair used to sign the store items being published."
22194 #: guix-git/doc/guix.texi:12792
22195 msgid "The files must correspond to the same key pair (the private key is used for signing and the public key is merely advertised in the signature metadata). They must contain keys in the canonical s-expression format as produced by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). By default, @file{/etc/guix/signing-key.pub} and @file{/etc/guix/signing-key.sec} are used."
22199 #: guix-git/doc/guix.texi:12793
22201 msgid "--repl[=@var{port}]"
22205 #: guix-git/doc/guix.texi:12794
22207 msgid "-r [@var{port}]"
22211 #: guix-git/doc/guix.texi:12798
22212 msgid "Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile Reference Manual}) on @var{port} (37146 by default). This is used primarily for debugging a running @command{guix publish} server."
22215 #. type: Plain text
22216 #: guix-git/doc/guix.texi:12804
22217 msgid "Enabling @command{guix publish} on Guix System is a one-liner: just instantiate a @code{guix-publish-service-type} service in the @code{services} field of the @code{operating-system} declaration (@pxref{guix-publish-service-type, @code{guix-publish-service-type}})."
22220 #. type: Plain text
22221 #: guix-git/doc/guix.texi:12807
22222 msgid "If you are instead running Guix on a ``foreign distro'', follow these instructions:"
22226 #: guix-git/doc/guix.texi:12811
22227 msgid "If your host distro uses the systemd init system:"
22231 #: guix-git/doc/guix.texi:12816
22234 "# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \\\n"
22235 " /etc/systemd/system/\n"
22236 "# systemctl start guix-publish && systemctl enable guix-publish\n"
22240 #: guix-git/doc/guix.texi:12824
22243 "# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n"
22244 "# start guix-publish\n"
22248 #: guix-git/doc/guix.texi:12828
22249 msgid "Otherwise, proceed similarly with your distro's init system."
22253 #: guix-git/doc/guix.texi:12831
22255 msgid "Invoking @command{guix challenge}"
22259 #: guix-git/doc/guix.texi:12834
22261 msgid "verifiable builds"
22264 #. type: command{#1}
22265 #: guix-git/doc/guix.texi:12835
22267 msgid "guix challenge"
22271 #: guix-git/doc/guix.texi:12836
22276 #. type: Plain text
22277 #: guix-git/doc/guix.texi:12841
22278 msgid "Do the binaries provided by this server really correspond to the source code it claims to build? Is a package build process deterministic? These are the questions the @command{guix challenge} command attempts to answer."
22281 #. type: Plain text
22282 #: guix-git/doc/guix.texi:12849
22283 msgid "The former is obviously an important question: Before using a substitute server (@pxref{Substitutes}), one had better @emph{verify} that it provides the right binaries, and thus @emph{challenge} it. The latter is what enables the former: If package builds are deterministic, then independent builds of the package should yield the exact same result, bit for bit; if a server provides a binary different from the one obtained locally, it may be either corrupt or malicious."
22286 #. type: Plain text
22287 #: guix-git/doc/guix.texi:12858
22288 msgid "We know that the hash that shows up in @file{/gnu/store} file names is the hash of all the inputs of the process that built the file or directory---compilers, libraries, build scripts, etc. (@pxref{Introduction}). Assuming deterministic build processes, one store file name should map to exactly one build output. @command{guix challenge} checks whether there is, indeed, a single mapping by comparing the build outputs of several independent builds of any given store item."
22291 #. type: Plain text
22292 #: guix-git/doc/guix.texi:12860
22293 msgid "The command output looks like this:"
22296 #. type: smallexample
22297 #: guix-git/doc/guix.texi:12872
22300 "$ guix challenge --substitute-urls=\"https://@value{SUBSTITUTE-SERVER} https://guix.example.org\"\n"
22301 "updating list of substitutes from 'https://@value{SUBSTITUTE-SERVER}'... 100.0%\n"
22302 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
22303 "/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n"
22304 " local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
22305 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
22306 " https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n"
22307 " differing files:\n"
22308 " /lib/libcrypto.so.1.1\n"
22309 " /lib/libssl.so.1.1\n"
22313 #. type: smallexample
22314 #: guix-git/doc/guix.texi:12879
22317 "/gnu/store/@dots{}-git-2.5.0 contents differ:\n"
22318 " local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n"
22319 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n"
22320 " https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n"
22321 " differing file:\n"
22322 " /libexec/git-core/git-fsck\n"
22326 #. type: smallexample
22327 #: guix-git/doc/guix.texi:12886
22330 "/gnu/store/@dots{}-pius-2.1.1 contents differ:\n"
22331 " local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
22332 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
22333 " https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n"
22334 " differing file:\n"
22335 " /share/man/man1/pius.1.gz\n"
22339 #. type: smallexample
22340 #: guix-git/doc/guix.texi:12888
22347 #. type: smallexample
22348 #: guix-git/doc/guix.texi:12893
22351 "6,406 store items were analyzed:\n"
22352 " - 4,749 (74.1%) were identical\n"
22353 " - 525 (8.2%) differed\n"
22354 " - 1,132 (17.7%) were inconclusive\n"
22357 #. type: Plain text
22358 #: guix-git/doc/guix.texi:12901
22359 msgid "In this example, @command{guix challenge} first scans the store to determine the set of locally-built derivations---as opposed to store items that were downloaded from a substitute server---and then queries all the substitute servers. It then reports those store items for which the servers obtained a result different from the local build."
22363 #: guix-git/doc/guix.texi:12902
22365 msgid "non-determinism, in package builds"
22368 #. type: Plain text
22369 #: guix-git/doc/guix.texi:12913
22370 msgid "As an example, @code{guix.example.org} always gets a different answer. Conversely, @code{@value{SUBSTITUTE-SERVER}} agrees with local builds, except in the case of Git. This might indicate that the build process of Git is non-deterministic, meaning that its output varies as a function of various things that Guix does not fully control, in spite of building packages in isolated environments (@pxref{Features}). Most common sources of non-determinism include the addition of timestamps in build results, the inclusion of random numbers, and directory listings sorted by inode number. See @uref{https://reproducible-builds.org/docs/}, for more information."
22373 #. type: Plain text
22374 #: guix-git/doc/guix.texi:12916
22375 msgid "To find out what is wrong with this Git binary, the easiest approach is to run:"
22379 #: guix-git/doc/guix.texi:12921
22382 "guix challenge git \\\n"
22383 " --diff=diffoscope \\\n"
22384 " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER} https://guix.example.org\"\n"
22387 #. type: Plain text
22388 #: guix-git/doc/guix.texi:12925
22389 msgid "This automatically invokes @command{diffoscope}, which displays detailed information about files that differ."
22392 #. type: Plain text
22393 #: guix-git/doc/guix.texi:12928
22394 msgid "Alternatively, we can do something along these lines (@pxref{Invoking guix archive}):"
22398 #: guix-git/doc/guix.texi:12933
22401 "$ wget -q -O - https://@value{SUBSTITUTE-SERVER}/nar/lzip/@dots{}-git-2.5.0 \\\n"
22402 " | lzip -d | guix archive -x /tmp/git\n"
22403 "$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git\n"
22406 #. type: Plain text
22407 #: guix-git/doc/guix.texi:12942
22408 msgid "This command shows the difference between the files resulting from the local build, and the files resulting from the build on @code{@value{SUBSTITUTE-SERVER}} (@pxref{Overview, Comparing and Merging Files,, diffutils, Comparing and Merging Files}). The @command{diff} command works great for text files. When binary files differ, a better option is @uref{https://diffoscope.org/, Diffoscope}, a tool that helps visualize differences for all kinds of files."
22411 #. type: Plain text
22412 #: guix-git/doc/guix.texi:12950
22413 msgid "Once you have done that work, you can tell whether the differences are due to a non-deterministic build process or to a malicious server. We try hard to remove sources of non-determinism in packages to make it easier to verify substitutes, but of course, this is a process that involves not just Guix, but a large part of the free software community. In the meantime, @command{guix challenge} is one tool to help address the problem."
22416 #. type: Plain text
22417 #: guix-git/doc/guix.texi:12954
22418 msgid "If you are writing packages for Guix, you are encouraged to check whether @code{@value{SUBSTITUTE-SERVER}} and other substitute servers obtain the same build result as you did with:"
22422 #: guix-git/doc/guix.texi:12957
22424 msgid "$ guix challenge @var{package}\n"
22427 #. type: Plain text
22428 #: guix-git/doc/guix.texi:12962
22429 msgid "where @var{package} is a package specification such as @code{guile@@2.0} or @code{glibc:debug}."
22433 #: guix-git/doc/guix.texi:12967
22435 msgid "guix challenge @var{options} [@var{packages}@dots{}]\n"
22438 #. type: Plain text
22439 #: guix-git/doc/guix.texi:12974
22440 msgid "When a difference is found between the hash of a locally-built item and that of a server-provided substitute, or among substitutes provided by different servers, the command displays it as in the example above and its exit code is 2 (other non-zero exit codes denote other kinds of errors)."
22443 #. type: Plain text
22444 #: guix-git/doc/guix.texi:12976
22445 msgid "The one option that matters is:"
22449 #: guix-git/doc/guix.texi:12982
22450 msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs to compare to."
22454 #: guix-git/doc/guix.texi:12983
22456 msgid "--diff=@var{mode}"
22460 #: guix-git/doc/guix.texi:12985
22461 msgid "Upon mismatches, show differences according to @var{mode}, one of:"
22465 #: guix-git/doc/guix.texi:12987
22467 msgid "@code{simple} (the default)"
22471 #: guix-git/doc/guix.texi:12989
22472 msgid "Show the list of files that differ."
22476 #: guix-git/doc/guix.texi:12990
22482 #: guix-git/doc/guix.texi:12991
22488 #: guix-git/doc/guix.texi:12994
22489 msgid "Invoke @uref{https://diffoscope.org/, Diffoscope}, passing it two directories whose contents do not match."
22493 #: guix-git/doc/guix.texi:12997
22494 msgid "When @var{command} is an absolute file name, run @var{command} instead of Diffoscope."
22498 #: guix-git/doc/guix.texi:12998 guix-git/doc/guix.texi:16310
22499 #: guix-git/doc/guix.texi:18299
22505 #: guix-git/doc/guix.texi:13000
22506 msgid "Do not show further details about the differences."
22510 #: guix-git/doc/guix.texi:13005
22511 msgid "Thus, unless @option{--diff=none} is passed, @command{guix challenge} downloads the store items from the given substitute servers so that it can compare them."
22515 #: guix-git/doc/guix.texi:13006
22521 #: guix-git/doc/guix.texi:13007
22527 #: guix-git/doc/guix.texi:13010
22528 msgid "Show details about matches (identical contents) in addition to information about mismatches."
22532 #: guix-git/doc/guix.texi:13014
22534 msgid "Invoking @command{guix copy}"
22538 #: guix-git/doc/guix.texi:13016
22540 msgid "copy, of store items, over SSH"
22544 #: guix-git/doc/guix.texi:13017
22546 msgid "SSH, copy of store items"
22550 #: guix-git/doc/guix.texi:13018
22552 msgid "sharing store items across machines"
22556 #: guix-git/doc/guix.texi:13019
22558 msgid "transferring store items across machines"
22561 #. type: Plain text
22562 #: guix-git/doc/guix.texi:13026
22563 msgid "The @command{guix copy} command copies items from the store of one machine to that of another machine over a secure shell (SSH) connection@footnote{This command is available only when Guile-SSH was found. @xref{Requirements}, for details.}. For example, the following command copies the @code{coreutils} package, the user's profile, and all their dependencies over to @var{host}, logged in as @var{user}:"
22567 #: guix-git/doc/guix.texi:13030
22570 "guix copy --to=@var{user}@@@var{host} \\\n"
22571 " coreutils $(readlink -f ~/.guix-profile)\n"
22574 #. type: Plain text
22575 #: guix-git/doc/guix.texi:13034
22576 msgid "If some of the items to be copied are already present on @var{host}, they are not actually sent."
22579 #. type: Plain text
22580 #: guix-git/doc/guix.texi:13037
22581 msgid "The command below retrieves @code{libreoffice} and @code{gimp} from @var{host}, assuming they are available there:"
22585 #: guix-git/doc/guix.texi:13040
22587 msgid "guix copy --from=@var{host} libreoffice gimp\n"
22590 #. type: Plain text
22591 #: guix-git/doc/guix.texi:13045
22592 msgid "The SSH connection is established using the Guile-SSH client, which is compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and @file{~/.ssh/config}, and uses the SSH agent for authentication."
22595 #. type: Plain text
22596 #: guix-git/doc/guix.texi:13051
22597 msgid "The key used to sign items that are sent must be accepted by the remote machine. Likewise, the key used by the remote machine to sign items you are retrieving must be in @file{/etc/guix/acl} so it is accepted by your own daemon. @xref{Invoking guix archive}, for more information about store item authentication."
22601 #: guix-git/doc/guix.texi:13056
22603 msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n"
22606 #. type: Plain text
22607 #: guix-git/doc/guix.texi:13059
22608 msgid "You must always specify one of the following options:"
22612 #: guix-git/doc/guix.texi:13061
22614 msgid "--to=@var{spec}"
22618 #: guix-git/doc/guix.texi:13062
22620 msgid "--from=@var{spec}"
22624 #: guix-git/doc/guix.texi:13066
22625 msgid "Specify the host to send to or receive from. @var{spec} must be an SSH spec such as @code{example.org}, @code{charlie@@example.org}, or @code{charlie@@example.org:2222}."
22628 #. type: Plain text
22629 #: guix-git/doc/guix.texi:13070
22630 msgid "The @var{items} can be either package names, such as @code{gimp}, or store items, such as @file{/gnu/store/@dots{}-idutils-4.6}."
22633 #. type: Plain text
22634 #: guix-git/doc/guix.texi:13074
22635 msgid "When specifying the name of a package to send, it is first built if needed, unless @option{--dry-run} was specified. Common build options are supported (@pxref{Common Build Options})."
22639 #: guix-git/doc/guix.texi:13077
22641 msgid "Invoking @command{guix container}"
22644 #. type: command{#1}
22645 #: guix-git/doc/guix.texi:13079
22647 msgid "guix container"
22651 #: guix-git/doc/guix.texi:13083
22652 msgid "As of version @value{VERSION}, this tool is experimental. The interface is subject to radical change in the future."
22655 #. type: Plain text
22656 #: guix-git/doc/guix.texi:13090
22657 msgid "The purpose of @command{guix container} is to manipulate processes running within an isolated environment, commonly known as a ``container'', typically created by the @command{guix environment} (@pxref{Invoking guix environment}) and @command{guix system container} (@pxref{Invoking guix system}) commands."
22661 #: guix-git/doc/guix.texi:13095
22663 msgid "guix container @var{action} @var{options}@dots{}\n"
22666 #. type: Plain text
22667 #: guix-git/doc/guix.texi:13099
22668 msgid "@var{action} specifies the operation to perform with a container, and @var{options} specifies the context-specific arguments for the action."
22671 #. type: Plain text
22672 #: guix-git/doc/guix.texi:13101
22673 msgid "The following actions are available:"
22677 #: guix-git/doc/guix.texi:13103
22683 #: guix-git/doc/guix.texi:13105
22684 msgid "Execute a command within the context of a running container."
22688 #: guix-git/doc/guix.texi:13107
22689 msgid "The syntax is:"
22693 #: guix-git/doc/guix.texi:13110
22695 msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n"
22699 #: guix-git/doc/guix.texi:13116
22700 msgid "@var{pid} specifies the process ID of the running container. @var{program} specifies an executable file name within the root file system of the container. @var{arguments} are the additional options that will be passed to @var{program}."
22704 #: guix-git/doc/guix.texi:13120
22705 msgid "The following command launches an interactive login shell inside a Guix system container, started by @command{guix system container}, and whose process ID is 9001:"
22709 #: guix-git/doc/guix.texi:13123
22711 msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n"
22715 #: guix-git/doc/guix.texi:13127
22716 msgid "Note that the @var{pid} cannot be the parent process of a container. It must be PID 1 of the container or one of its child processes."
22720 #: guix-git/doc/guix.texi:13131
22722 msgid "Invoking @command{guix weather}"
22725 #. type: Plain text
22726 #: guix-git/doc/guix.texi:13140
22727 msgid "Occasionally you're grumpy because substitutes are lacking and you end up building packages by yourself (@pxref{Substitutes}). The @command{guix weather} command reports on substitute availability on the specified servers so you can have an idea of whether you'll be grumpy today. It can sometimes be useful info as a user, but it is primarily useful to people running @command{guix publish} (@pxref{Invoking guix publish})."
22731 #: guix-git/doc/guix.texi:13141
22733 msgid "statistics, for substitutes"
22737 #: guix-git/doc/guix.texi:13142
22739 msgid "availability of substitutes"
22743 #: guix-git/doc/guix.texi:13143
22745 msgid "substitute availability"
22749 #: guix-git/doc/guix.texi:13144
22751 msgid "weather, substitute availability"
22754 #. type: Plain text
22755 #: guix-git/doc/guix.texi:13146
22756 msgid "Here's a sample run:"
22760 #: guix-git/doc/guix.texi:13158
22763 "$ guix weather --substitute-urls=https://guix.example.org\n"
22764 "computing 5,872 package derivations for x86_64-linux...\n"
22765 "looking for 6,128 store items on https://guix.example.org..\n"
22766 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
22767 "https://guix.example.org\n"
22768 " 43.4% substitutes available (2,658 out of 6,128)\n"
22769 " 7,032.5 MiB of nars (compressed)\n"
22770 " 19,824.2 MiB on disk (uncompressed)\n"
22771 " 0.030 seconds per request (182.9 seconds in total)\n"
22772 " 33.5 requests per second\n"
22777 #: guix-git/doc/guix.texi:13168
22780 " 9.8% (342 out of 3,470) of the missing items are queued\n"
22781 " 867 queued builds\n"
22782 " x86_64-linux: 518 (59.7%)\n"
22783 " i686-linux: 221 (25.5%)\n"
22784 " aarch64-linux: 128 (14.8%)\n"
22785 " build rate: 23.41 builds per hour\n"
22786 " x86_64-linux: 11.16 builds per hour\n"
22787 " i686-linux: 6.03 builds per hour\n"
22788 " aarch64-linux: 6.41 builds per hour\n"
22792 #: guix-git/doc/guix.texi:13170
22794 msgid "continuous integration, statistics"
22797 #. type: Plain text
22798 #: guix-git/doc/guix.texi:13181
22799 msgid "As you can see, it reports the fraction of all the packages for which substitutes are available on the server---regardless of whether substitutes are enabled, and regardless of whether this server's signing key is authorized. It also reports the size of the compressed archives (``nars'') provided by the server, the size the corresponding store items occupy in the store (assuming deduplication is turned off), and the server's throughput. The second part gives continuous integration (CI) statistics, if the server supports it. In addition, using the @option{--coverage} option, @command{guix weather} can list ``important'' package substitutes missing on the server (see below)."
22802 #. type: Plain text
22803 #: guix-git/doc/guix.texi:13187
22804 msgid "To achieve that, @command{guix weather} queries over HTTP(S) meta-data (@dfn{narinfos}) for all the relevant store items. Like @command{guix challenge}, it ignores signatures on those substitutes, which is innocuous since the command only gathers statistics and cannot install those substitutes."
22808 #: guix-git/doc/guix.texi:13192
22810 msgid "guix weather @var{options}@dots{} [@var{packages}@dots{}]\n"
22813 #. type: Plain text
22814 #: guix-git/doc/guix.texi:13200
22815 msgid "When @var{packages} is omitted, @command{guix weather} checks the availability of substitutes for @emph{all} the packages, or for those specified with @option{--manifest}; otherwise it only considers the specified packages. It is also possible to query specific system types with @option{--system}. @command{guix weather} exits with a non-zero code when the fraction of available substitutes is below 100%."
22818 #. type: Plain text
22819 #: guix-git/doc/guix.texi:13202
22820 msgid "The available options are listed below."
22824 #: guix-git/doc/guix.texi:13208
22825 msgid "@var{urls} is the space-separated list of substitute server URLs to query. When this option is omitted, the default set of substitute servers is queried."
22829 #: guix-git/doc/guix.texi:13214
22830 msgid "Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This option can be repeated, in which case @command{guix weather} will query substitutes for several system types."
22834 #: guix-git/doc/guix.texi:13220
22835 msgid "Instead of querying substitutes for all the packages, only ask for those specified in @var{file}. @var{file} must contain a @dfn{manifest}, as with the @code{-m} option of @command{guix package} (@pxref{Invoking guix package})."
22839 #: guix-git/doc/guix.texi:13223
22840 msgid "This option can be repeated several times, in which case the manifests are concatenated."
22844 #: guix-git/doc/guix.texi:13224
22846 msgid "--coverage[=@var{count}]"
22850 #: guix-git/doc/guix.texi:13225
22852 msgid "-c [@var{count}]"
22856 #: guix-git/doc/guix.texi:13231
22857 msgid "Report on substitute coverage for packages: list packages with at least @var{count} dependents (zero by default) for which substitutes are unavailable. Dependent packages themselves are not listed: if @var{b} depends on @var{a} and @var{a} has no substitutes, only @var{a} is listed, even though @var{b} usually lacks substitutes as well. The result looks like this:"
22861 #: guix-git/doc/guix.texi:13245
22864 "$ guix weather --substitute-urls=@value{SUBSTITUTE-URL} -c 10\n"
22865 "computing 8,983 package derivations for x86_64-linux...\n"
22866 "looking for 9,343 store items on @value{SUBSTITUTE-URL}...\n"
22867 "updating substitutes from '@value{SUBSTITUTE-URL}'... 100.0%\n"
22868 "@value{SUBSTITUTE-URL}\n"
22869 " 64.7% substitutes available (6,047 out of 9,343)\n"
22871 "2502 packages are missing from '@value{SUBSTITUTE-URL}' for 'x86_64-linux', among which:\n"
22872 " 58 kcoreaddons@@5.49.0 /gnu/store/@dots{}-kcoreaddons-5.49.0\n"
22873 " 46 qgpgme@@1.11.1 /gnu/store/@dots{}-qgpgme-1.11.1\n"
22874 " 37 perl-http-cookiejar@@0.008 /gnu/store/@dots{}-perl-http-cookiejar-0.008\n"
22879 #: guix-git/doc/guix.texi:13251
22880 msgid "What this example shows is that @code{kcoreaddons} and presumably the 58 packages that depend on it have no substitutes at @code{@value{SUBSTITUTE-SERVER}}; likewise for @code{qgpgme} and the 46 packages that depend on it."
22884 #: guix-git/doc/guix.texi:13255
22885 msgid "If you are a Guix developer, or if you are taking care of this build farm, you'll probably want to have a closer look at these packages: they may simply fail to build."
22889 #: guix-git/doc/guix.texi:13256
22891 msgid "--display-missing"
22895 #: guix-git/doc/guix.texi:13258
22896 msgid "Display the list of store items for which substitutes are missing."
22900 #: guix-git/doc/guix.texi:13261
22902 msgid "Invoking @command{guix processes}"
22905 #. type: Plain text
22906 #: guix-git/doc/guix.texi:13269
22907 msgid "The @command{guix processes} command can be useful to developers and system administrators, especially on multi-user machines and on build farms: it lists the current sessions (connections to the daemon), as well as information about the processes involved@footnote{Remote sessions, when @command{guix-daemon} is started with @option{--listen} specifying a TCP endpoint, are @emph{not} listed.}. Here's an example of the information it returns:"
22911 #: guix-git/doc/guix.texi:13275
22914 "$ sudo guix processes\n"
22915 "SessionPID: 19002\n"
22916 "ClientPID: 19090\n"
22917 "ClientCommand: guix environment --ad-hoc python\n"
22922 #: guix-git/doc/guix.texi:13279
22925 "SessionPID: 19402\n"
22926 "ClientPID: 19367\n"
22927 "ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{}\n"
22932 #: guix-git/doc/guix.texi:13292
22935 "SessionPID: 19444\n"
22936 "ClientPID: 19419\n"
22937 "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
22938 "LockHeld: /gnu/store/@dots{}-perl-ipc-cmd-0.96.lock\n"
22939 "LockHeld: /gnu/store/@dots{}-python-six-bootstrap-1.11.0.lock\n"
22940 "LockHeld: /gnu/store/@dots{}-libjpeg-turbo-2.0.0.lock\n"
22941 "ChildPID: 20495\n"
22942 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22943 "ChildPID: 27733\n"
22944 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22945 "ChildPID: 27793\n"
22946 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22949 #. type: Plain text
22950 #: guix-git/doc/guix.texi:13299
22951 msgid "In this example we see that @command{guix-daemon} has three clients: @command{guix environment}, @command{guix publish}, and the Cuirass continuous integration tool; their process identifier (PID) is given by the @code{ClientPID} field. The @code{SessionPID} field gives the PID of the @command{guix-daemon} sub-process of this particular session."
22954 #. type: Plain text
22955 #: guix-git/doc/guix.texi:13306
22956 msgid "The @code{LockHeld} fields show which store items are currently locked by this session, which corresponds to store items being built or substituted (the @code{LockHeld} field is not displayed when @command{guix processes} is not running as root). Last, by looking at the @code{ChildPID} and @code{ChildCommand} fields, we understand that these three builds are being offloaded (@pxref{Daemon Offload Setup})."
22959 #. type: Plain text
22960 #: guix-git/doc/guix.texi:13311
22961 msgid "The output is in Recutils format so we can use the handy @command{recsel} command to select sessions of interest (@pxref{Selection Expressions,,, recutils, GNU recutils manual}). As an example, the command shows the command line and PID of the client that triggered the build of a Perl package:"
22965 #: guix-git/doc/guix.texi:13317
22968 "$ sudo guix processes | \\\n"
22969 " recsel -p ClientPID,ClientCommand -e 'LockHeld ~ \"perl\"'\n"
22970 "ClientPID: 19419\n"
22971 "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
22974 #. type: Plain text
22975 #: guix-git/doc/guix.texi:13320
22976 msgid "Additional options are listed below."
22980 #: guix-git/doc/guix.texi:13330
22981 msgid "The default option. It outputs a set of Session recutils records that include each @code{ChildProcess} as a field."
22985 #: guix-git/doc/guix.texi:13331
22991 #: guix-git/doc/guix.texi:13338
22992 msgid "Normalize the output records into record sets (@pxref{Record Sets,,, recutils, GNU recutils manual}). Normalizing into record sets allows joins across record types. The example below lists the PID of each @code{ChildProcess} and the associated PID for @code{Session} that spawned the @code{ChildProcess} where the @code{Session} was started using @command{guix build}."
22996 #: guix-git/doc/guix.texi:13348
22999 "$ guix processes --format=normalized | \\\n"
23002 " -t ChildProcess \\\n"
23003 " -p Session.PID,PID \\\n"
23004 " -e 'Session.ClientCommand ~ \"guix build\"'\n"
23006 "Session_PID: 4278\n"
23011 #: guix-git/doc/guix.texi:13351
23015 "Session_PID: 4278\n"
23020 #: guix-git/doc/guix.texi:13354
23024 "Session_PID: 4278\n"
23028 #: guix-git/doc/guix.texi:13361
23030 msgid "system configuration"
23033 #. type: Plain text
23034 #: guix-git/doc/guix.texi:13367
23035 msgid "Guix System supports a consistent whole-system configuration mechanism. By that we mean that all aspects of the global system configuration---such as the available system services, timezone and locale settings, user accounts---are declared in a single place. Such a @dfn{system configuration} can be @dfn{instantiated}---i.e., effected."
23038 #. type: Plain text
23039 #: guix-git/doc/guix.texi:13377
23040 msgid "One of the advantages of putting all the system configuration under the control of Guix is that it supports transactional system upgrades, and makes it possible to roll back to a previous system instantiation, should something go wrong with the new one (@pxref{Features}). Another advantage is that it makes it easy to replicate the exact same configuration across different machines, or at different points in time, without having to resort to additional administration tools layered on top of the own tools of the system."
23043 #. type: Plain text
23044 #: guix-git/doc/guix.texi:13382
23045 msgid "This section describes this mechanism. First we focus on the system administrator's viewpoint---explaining how the system is configured and instantiated. Then we show how this mechanism can be extended, for instance to support new system services."
23048 #. type: Plain text
23049 #: guix-git/doc/guix.texi:13411
23050 msgid "The operating system is configured by providing an @code{operating-system} declaration in a file that can then be passed to the @command{guix system} command (@pxref{Invoking guix system}). A simple setup, with the default system services, the default Linux-Libre kernel, initial RAM disk, and boot loader looks like this:"
23054 #: guix-git/doc/guix.texi:13412 guix-git/doc/guix.texi:33463
23056 msgid "operating-system"
23060 #: guix-git/doc/guix.texi:13414
23062 msgid "os-config-bare-bones.texi"
23065 #. type: Plain text
23066 #: guix-git/doc/guix.texi:13421
23067 msgid "This example should be self-describing. Some of the fields defined above, such as @code{host-name} and @code{bootloader}, are mandatory. Others, such as @code{packages} and @code{services}, can be omitted, in which case they get a default value."
23070 #. type: Plain text
23071 #: guix-git/doc/guix.texi:13426
23072 msgid "Below we discuss the effect of some of the most important fields (@pxref{operating-system Reference}, for details about all the available fields), and how to @dfn{instantiate} the operating system using @command{guix system}."
23075 #. type: unnumberedsubsec
23076 #: guix-git/doc/guix.texi:13427
23082 #: guix-git/doc/guix.texi:13429
23084 msgid "legacy boot, on Intel machines"
23088 #: guix-git/doc/guix.texi:13430
23090 msgid "BIOS boot, on Intel machines"
23094 #: guix-git/doc/guix.texi:13431
23100 #: guix-git/doc/guix.texi:13432
23105 #. type: Plain text
23106 #: guix-git/doc/guix.texi:13438
23107 msgid "The @code{bootloader} field describes the method that will be used to boot your system. Machines based on Intel processors can boot in ``legacy'' BIOS mode, as in the example above. However, more recent machines rely instead on the @dfn{Unified Extensible Firmware Interface} (UEFI) to boot. In that case, the @code{bootloader} field should contain something along these lines:"
23111 #: guix-git/doc/guix.texi:13443
23114 "(bootloader-configuration\n"
23115 " (bootloader grub-efi-bootloader)\n"
23116 " (target \"/boot/efi\"))\n"
23119 #. type: Plain text
23120 #: guix-git/doc/guix.texi:13447
23121 msgid "@xref{Bootloader Configuration}, for more information on the available configuration options."
23124 #. type: unnumberedsubsec
23125 #: guix-git/doc/guix.texi:13448
23127 msgid "Globally-Visible Packages"
23131 #: guix-git/doc/guix.texi:13450
23133 msgid "%base-packages"
23136 #. type: Plain text
23137 #: guix-git/doc/guix.texi:13463
23138 msgid "The @code{packages} field lists packages that will be globally visible on the system, for all user accounts---i.e., in every user's @env{PATH} environment variable---in addition to the per-user profiles (@pxref{Invoking guix package}). The @code{%base-packages} variable provides all the tools one would expect for basic user and administrator tasks---including the GNU Core Utilities, the GNU Networking Utilities, the GNU Zile lightweight text editor, @command{find}, @command{grep}, etc. The example above adds GNU@tie{}Screen to those, taken from the @code{(gnu packages screen)} module (@pxref{Package Modules}). The @code{(list package output)} syntax can be used to add a specific output of a package:"
23142 #: guix-git/doc/guix.texi:13467
23145 "(use-modules (gnu packages))\n"
23146 "(use-modules (gnu packages dns))\n"
23151 #: guix-git/doc/guix.texi:13472
23154 "(operating-system\n"
23156 " (packages (cons (list bind \"utils\")\n"
23157 " %base-packages)))\n"
23161 #: guix-git/doc/guix.texi:13474
23163 msgid "specification->package"
23166 #. type: Plain text
23167 #: guix-git/doc/guix.texi:13483
23168 msgid "Referring to packages by variable name, like @code{bind} above, has the advantage of being unambiguous; it also allows typos and such to be diagnosed right away as ``unbound variables''. The downside is that one needs to know which module defines which package, and to augment the @code{use-package-modules} line accordingly. To avoid that, one can use the @code{specification->package} procedure of the @code{(gnu packages)} module, which returns the best package for a given name or name and version:"
23172 #: guix-git/doc/guix.texi:13486
23175 "(use-modules (gnu packages))\n"
23180 #: guix-git/doc/guix.texi:13492
23183 "(operating-system\n"
23185 " (packages (append (map specification->package\n"
23186 " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n"
23187 " %base-packages)))\n"
23190 #. type: unnumberedsubsec
23191 #: guix-git/doc/guix.texi:13494
23193 msgid "System Services"
23197 #: guix-git/doc/guix.texi:13496 guix-git/doc/guix.texi:32246
23198 #: guix-git/doc/guix.texi:33688
23204 #: guix-git/doc/guix.texi:13497
23206 msgid "%base-services"
23209 #. type: Plain text
23210 #: guix-git/doc/guix.texi:13507
23211 msgid "The @code{services} field lists @dfn{system services} to be made available when the system starts (@pxref{Services}). The @code{operating-system} declaration above specifies that, in addition to the basic services, we want the OpenSSH secure shell daemon listening on port 2222 (@pxref{Networking Services, @code{openssh-service-type}}). Under the hood, @code{openssh-service-type} arranges so that @command{sshd} is started with the right command-line options, possibly with supporting configuration files generated as needed (@pxref{Defining Services})."
23215 #: guix-git/doc/guix.texi:13508
23217 msgid "customization, of services"
23221 #: guix-git/doc/guix.texi:13509
23223 msgid "modify-services"
23226 #. type: Plain text
23227 #: guix-git/doc/guix.texi:13513
23228 msgid "Occasionally, instead of using the base services as is, you will want to customize them. To do this, use @code{modify-services} (@pxref{Service Reference, @code{modify-services}}) to modify the list."
23231 #. type: Plain text
23232 #: guix-git/doc/guix.texi:13518
23233 msgid "For example, suppose you want to modify @code{guix-daemon} and Mingetty (the console log-in) in the @code{%base-services} list (@pxref{Base Services, @code{%base-services}}). To do that, you can write the following in your operating system declaration:"
23237 #: guix-git/doc/guix.texi:13535
23240 "(define %my-services\n"
23241 " ;; My very own list of services.\n"
23242 " (modify-services %base-services\n"
23243 " (guix-service-type config =>\n"
23244 " (guix-configuration\n"
23245 " (inherit config)\n"
23246 " ;; Fetch substitutes from example.org.\n"
23247 " (substitute-urls\n"
23248 " (list \"https://example.org/guix\"\n"
23249 " \"https://ci.guix.gnu.org\"))))\n"
23250 " (mingetty-service-type config =>\n"
23251 " (mingetty-configuration\n"
23252 " (inherit config)\n"
23253 " ;; Automatially log in as \"guest\".\n"
23254 " (auto-login \"guest\")))))\n"
23259 #: guix-git/doc/guix.texi:13539
23262 "(operating-system\n"
23264 " (services %my-services))\n"
23267 #. type: Plain text
23268 #: guix-git/doc/guix.texi:13550
23269 msgid "This changes the configuration---i.e., the service parameters---of the @code{guix-service-type} instance, and that of all the @code{mingetty-service-type} instances in the @code{%base-services} list. Observe how this is accomplished: first, we arrange for the original configuration to be bound to the identifier @code{config} in the @var{body}, and then we write the @var{body} so that it evaluates to the desired configuration. In particular, notice how we use @code{inherit} to create a new configuration which has the same values as the old configuration, but with a few modifications."
23272 #. type: Plain text
23273 #: guix-git/doc/guix.texi:13557
23274 msgid "The configuration for a typical ``desktop'' usage, with an encrypted root partition, the X11 display server, GNOME and Xfce (users can choose which of these desktop environments to use at the log-in screen by pressing @kbd{F1}), network management, power management, and more, would look like this:"
23278 #: guix-git/doc/guix.texi:13559
23280 msgid "os-config-desktop.texi"
23283 #. type: Plain text
23284 #: guix-git/doc/guix.texi:13564
23285 msgid "A graphical system with a choice of lightweight window managers instead of full-blown desktop environments would look like this:"
23289 #: guix-git/doc/guix.texi:13566
23291 msgid "os-config-lightweight-desktop.texi"
23294 #. type: Plain text
23295 #: guix-git/doc/guix.texi:13572
23296 msgid "This example refers to the @file{/boot/efi} file system by its UUID, @code{1234-ABCD}. Replace this UUID with the right UUID on your system, as returned by the @command{blkid} command."
23299 #. type: Plain text
23300 #: guix-git/doc/guix.texi:13576
23301 msgid "@xref{Desktop Services}, for the exact list of services provided by @code{%desktop-services}. @xref{X.509 Certificates}, for background information about the @code{nss-certs} package that is used here."
23304 #. type: Plain text
23305 #: guix-git/doc/guix.texi:13583
23306 msgid "Again, @code{%desktop-services} is just a list of service objects. If you want to remove services from there, you can do so using the procedures for list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile Reference Manual}). For instance, the following expression returns a list that contains all the services in @code{%desktop-services} minus the Avahi service:"
23310 #: guix-git/doc/guix.texi:13588
23313 "(remove (lambda (service)\n"
23314 " (eq? (service-kind service) avahi-service-type))\n"
23315 " %desktop-services)\n"
23318 #. type: Plain text
23319 #: guix-git/doc/guix.texi:13591
23320 msgid "Alternatively, the @code{modify-services} macro can be used:"
23324 #: guix-git/doc/guix.texi:13595
23327 "(modify-services %desktop-services\n"
23328 " (delete avahi-service-type))\n"
23331 #. type: unnumberedsubsec
23332 #: guix-git/doc/guix.texi:13598
23334 msgid "Instantiating the System"
23337 #. type: Plain text
23338 #: guix-git/doc/guix.texi:13605
23339 msgid "Assuming the @code{operating-system} declaration is stored in the @file{my-system-config.scm} file, the @command{guix system reconfigure my-system-config.scm} command instantiates that configuration, and makes it the default GRUB boot entry (@pxref{Invoking guix system})."
23342 #. type: Plain text
23343 #: guix-git/doc/guix.texi:13613
23344 msgid "The normal way to change the system configuration is by updating this file and re-running @command{guix system reconfigure}. One should never have to touch files in @file{/etc} or to run commands that modify the system state such as @command{useradd} or @command{grub-install}. In fact, you must avoid that since that would not only void your warranty but also prevent you from rolling back to previous versions of your system, should you ever need to."
23348 #: guix-git/doc/guix.texi:13614
23350 msgid "roll-back, of the operating system"
23353 #. type: Plain text
23354 #: guix-git/doc/guix.texi:13624
23355 msgid "Speaking of roll-back, each time you run @command{guix system reconfigure}, a new @dfn{generation} of the system is created---without modifying or deleting previous generations. Old system generations get an entry in the bootloader boot menu, allowing you to boot them in case something went wrong with the latest generation. Reassuring, no? The @command{guix system list-generations} command lists the system generations available on disk. It is also possible to roll back the system via the commands @command{guix system roll-back} and @command{guix system switch-generation}."
23358 #. type: Plain text
23359 #: guix-git/doc/guix.texi:13630
23360 msgid "Although the @command{guix system reconfigure} command will not modify previous generations, you must take care when the current generation is not the latest (e.g., after invoking @command{guix system roll-back}), since the operation might overwrite a later generation (@pxref{Invoking guix system})."
23363 #. type: unnumberedsubsec
23364 #: guix-git/doc/guix.texi:13631
23366 msgid "The Programming Interface"
23369 #. type: Plain text
23370 #: guix-git/doc/guix.texi:13636
23371 msgid "At the Scheme level, the bulk of an @code{operating-system} declaration is instantiated with the following monadic procedure (@pxref{The Store Monad}):"
23375 #: guix-git/doc/guix.texi:13637
23377 msgid "{Monadic Procedure} operating-system-derivation os"
23381 #: guix-git/doc/guix.texi:13640
23382 msgid "Return a derivation that builds @var{os}, an @code{operating-system} object (@pxref{Derivations})."
23386 #: guix-git/doc/guix.texi:13644
23387 msgid "The output of the derivation is a single directory that refers to all the packages, configuration files, and other supporting files needed to instantiate @var{os}."
23390 #. type: Plain text
23391 #: guix-git/doc/guix.texi:13649
23392 msgid "This procedure is provided by the @code{(gnu system)} module. Along with @code{(gnu services)} (@pxref{Services}), this module contains the guts of Guix System. Make sure to visit it!"
23396 #: guix-git/doc/guix.texi:13652
23398 msgid "@code{operating-system} Reference"
23401 #. type: Plain text
23402 #: guix-git/doc/guix.texi:13657
23403 msgid "This section summarizes all the options available in @code{operating-system} declarations (@pxref{Using the Configuration System})."
23407 #: guix-git/doc/guix.texi:13658
23409 msgid "{Data Type} operating-system"
23413 #: guix-git/doc/guix.texi:13662
23414 msgid "This is the data type representing an operating system configuration. By that, we mean all the global system configuration, not per-user configuration (@pxref{Using the Configuration System})."
23418 #: guix-git/doc/guix.texi:13664
23420 msgid "@code{kernel} (default: @code{linux-libre})"
23424 #: guix-git/doc/guix.texi:13669
23425 msgid "The package object of the operating system kernel to use@footnote{Currently only the Linux-libre kernel is fully supported. Using GNU@tie{}mach with the GNU@tie{}Hurd is experimental and only available when building a virtual machine disk image.}."
23429 #: guix-git/doc/guix.texi:13670 guix-git/doc/guix.texi:28954
23435 #: guix-git/doc/guix.texi:13671
23437 msgid "@code{hurd} (default: @code{#f})"
23441 #: guix-git/doc/guix.texi:13676
23442 msgid "The package object of the Hurd to be started by the kernel. When this field is set, produce a GNU/Hurd operating system. In that case, @code{kernel} must also be set to the @code{gnumach} package---the microkernel the Hurd runs on."
23446 #: guix-git/doc/guix.texi:13679
23447 msgid "This feature is experimental and only supported for disk images."
23451 #: guix-git/doc/guix.texi:13681
23453 msgid "@code{kernel-loadable-modules} (default: '())"
23457 #: guix-git/doc/guix.texi:13684
23458 msgid "A list of objects (usually packages) to collect loadable kernel modules from--e.g. @code{(list ddcci-driver-linux)}."
23462 #: guix-git/doc/guix.texi:13685
23464 msgid "@code{kernel-arguments} (default: @code{%default-kernel-arguments})"
23468 #: guix-git/doc/guix.texi:13688
23469 msgid "List of strings or gexps representing additional arguments to pass on the command-line of the kernel---e.g., @code{(\"console=ttyS0\")}."
23473 #: guix-git/doc/guix.texi:13689 guix-git/doc/guix.texi:32459
23474 #: guix-git/doc/guix.texi:32478
23480 #: guix-git/doc/guix.texi:13691
23481 msgid "The system bootloader configuration object. @xref{Bootloader Configuration}."
23485 #: guix-git/doc/guix.texi:13692 guix-git/doc/guix.texi:32648
23491 #: guix-git/doc/guix.texi:13695
23492 msgid "This is the label (a string) as it appears in the bootloader's menu entry. The default label includes the kernel name and version."
23496 #: guix-git/doc/guix.texi:13696 guix-git/doc/guix.texi:18123
23497 #: guix-git/doc/guix.texi:32578
23499 msgid "@code{keyboard-layout} (default: @code{#f})"
23503 #: guix-git/doc/guix.texi:13701
23504 msgid "This field specifies the keyboard layout to use in the console. It can be either @code{#f}, in which case the default keyboard layout is used (usually US English), or a @code{<keyboard-layout>} record. @xref{Keyboard Layout}, for more information."
23508 #: guix-git/doc/guix.texi:13706
23509 msgid "This keyboard layout is in effect as soon as the kernel has booted. For instance, it is the keyboard layout in effect when you type a passphrase if your root file system is on a @code{luks-device-mapping} mapped device (@pxref{Mapped Devices})."
23513 #: guix-git/doc/guix.texi:13713
23514 msgid "This does @emph{not} specify the keyboard layout used by the bootloader, nor that used by the graphical display server. @xref{Bootloader Configuration}, for information on how to specify the bootloader's keyboard layout. @xref{X Window}, for information on how to specify the keyboard layout used by the X Window System."
23518 #: guix-git/doc/guix.texi:13715
23520 msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})"
23524 #: guix-git/doc/guix.texi:13716 guix-git/doc/guix.texi:32283
23525 #: guix-git/doc/guix.texi:32387
23531 #: guix-git/doc/guix.texi:13717 guix-git/doc/guix.texi:32284
23532 #: guix-git/doc/guix.texi:32388
23534 msgid "initial RAM disk"
23538 #: guix-git/doc/guix.texi:13720
23539 msgid "The list of Linux kernel modules that need to be available in the initial RAM disk. @xref{Initial RAM Disk}."
23543 #: guix-git/doc/guix.texi:13721
23545 msgid "@code{initrd} (default: @code{base-initrd})"
23549 #: guix-git/doc/guix.texi:13725
23550 msgid "A procedure that returns an initial RAM disk for the Linux kernel. This field is provided to support low-level customization and should rarely be needed for casual use. @xref{Initial RAM Disk}."
23554 #: guix-git/doc/guix.texi:13726
23556 msgid "@code{firmware} (default: @code{%base-firmware})"
23560 #: guix-git/doc/guix.texi:13727
23566 #: guix-git/doc/guix.texi:13729
23567 msgid "List of firmware packages loadable by the operating system kernel."
23571 #: guix-git/doc/guix.texi:13734
23572 msgid "The default includes firmware needed for Atheros- and Broadcom-based WiFi devices (Linux-libre modules @code{ath9k} and @code{b43-open}, respectively). @xref{Hardware Considerations}, for more info on supported hardware."
23576 #: guix-git/doc/guix.texi:13735 guix-git/doc/guix.texi:33482
23582 #: guix-git/doc/guix.texi:13737
23583 msgid "The host name."
23587 #: guix-git/doc/guix.texi:13738
23593 #: guix-git/doc/guix.texi:13739
23599 #: guix-git/doc/guix.texi:13744
23600 msgid "A file-like object (@pxref{G-Expressions, file-like objects}) for use as @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). The default is a file with entries for @code{localhost} and @var{host-name}."
23604 #: guix-git/doc/guix.texi:13745
23606 msgid "@code{mapped-devices} (default: @code{'()})"
23610 #: guix-git/doc/guix.texi:13747
23611 msgid "A list of mapped devices. @xref{Mapped Devices}."
23615 #: guix-git/doc/guix.texi:13748
23617 msgid "file-systems"
23621 #: guix-git/doc/guix.texi:13750
23622 msgid "A list of file systems. @xref{File Systems}."
23626 #: guix-git/doc/guix.texi:13751
23628 msgid "swap devices"
23632 #: guix-git/doc/guix.texi:13752
23638 #: guix-git/doc/guix.texi:13753
23640 msgid "@code{swap-devices} (default: @code{'()})"
23644 #: guix-git/doc/guix.texi:13758
23645 msgid "A list of UUIDs, file system labels, or strings identifying devices or files to be used for ``swap space'' (@pxref{Memory Concepts,,, libc, The GNU C Library Reference Manual}). Here are some examples:"
23649 #: guix-git/doc/guix.texi:13760
23651 msgid "(list (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\"))"
23655 #: guix-git/doc/guix.texi:13764
23656 msgid "Use the swap partition with the given UUID@. You can learn the UUID of a Linux swap partition by running @command{swaplabel @var{device}}, where @var{device} is the @file{/dev} file name of that partition."
23660 #: guix-git/doc/guix.texi:13765
23662 msgid "(list (file-system-label \"swap\"))"
23666 #: guix-git/doc/guix.texi:13769
23667 msgid "Use the partition with label @code{swap}. Again, the @command{swaplabel} command allows you to view and change the label of a Linux swap partition."
23671 #: guix-git/doc/guix.texi:13770
23673 msgid "(list \"/swapfile\")"
23677 #: guix-git/doc/guix.texi:13772
23678 msgid "Use the file @file{/swapfile} as swap space."
23682 #: guix-git/doc/guix.texi:13773
23684 msgid "(list \"/dev/sda3\" \"/dev/sdb2\")"
23688 #: guix-git/doc/guix.texi:13777
23689 msgid "Use the @file{/dev/sda3} and @file{/dev/sdb2} partitions as swap space. We recommend referring to swap devices by UUIDs or labels as shown above instead."
23693 #: guix-git/doc/guix.texi:13783
23694 msgid "It is possible to specify a swap file in a file system on a mapped device (under @file{/dev/mapper}), provided that the necessary device mapping and file system are also specified. @xref{Mapped Devices} and @ref{File Systems}."
23698 #: guix-git/doc/guix.texi:13784
23700 msgid "@code{users} (default: @code{%base-user-accounts})"
23704 #: guix-git/doc/guix.texi:13785
23706 msgid "@code{groups} (default: @code{%base-groups})"
23710 #: guix-git/doc/guix.texi:13787
23711 msgid "List of user accounts and groups. @xref{User Accounts}."
23715 #: guix-git/doc/guix.texi:13790
23716 msgid "If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' account with UID@tie{}0 is automatically added."
23720 #: guix-git/doc/guix.texi:13791
23722 msgid "@code{skeletons} (default: @code{(default-skeletons)})"
23726 #: guix-git/doc/guix.texi:13795
23727 msgid "A list of target file name/file-like object tuples (@pxref{G-Expressions, file-like objects}). These are the skeleton files that will be added to the home directory of newly-created user accounts."
23731 #: guix-git/doc/guix.texi:13797
23732 msgid "For instance, a valid value may look like this:"
23736 #: guix-git/doc/guix.texi:13803
23739 "`((\".bashrc\" ,(plain-file \"bashrc\" \"echo Hello\\n\"))\n"
23740 " (\".guile\" ,(plain-file \"guile\"\n"
23741 " \"(use-modules (ice-9 readline))\n"
23742 " (activate-readline)\")))\n"
23746 #: guix-git/doc/guix.texi:13805
23748 msgid "@code{issue} (default: @code{%default-issue})"
23752 #: guix-git/doc/guix.texi:13808
23753 msgid "A string denoting the contents of the @file{/etc/issue} file, which is displayed when users log in on a text console."
23757 #: guix-git/doc/guix.texi:13809
23759 msgid "@code{packages} (default: @code{%base-packages})"
23763 #: guix-git/doc/guix.texi:13813
23764 msgid "A list of packages to be installed in the global profile, which is accessible at @file{/run/current-system/profile}. Each element is either a package variable or a package/output tuple. Here's a simple example of both:"
23768 #: guix-git/doc/guix.texi:13818
23771 "(cons* git ; the default \"out\" output\n"
23772 " (list git \"send-email\") ; another output of git\n"
23773 " %base-packages) ; the default set\n"
23777 #: guix-git/doc/guix.texi:13823
23778 msgid "The default set includes core utilities and it is good practice to install non-core utilities in user profiles (@pxref{Invoking guix package})."
23782 #: guix-git/doc/guix.texi:13824
23788 #: guix-git/doc/guix.texi:13826
23789 msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}."
23793 #: guix-git/doc/guix.texi:13830
23794 msgid "You can run the @command{tzselect} command to find out which timezone string corresponds to your region. Choosing an invalid timezone name causes @command{guix system} to fail."
23798 #: guix-git/doc/guix.texi:13831 guix-git/doc/guix.texi:19734
23800 msgid "@code{locale} (default: @code{\"en_US.utf8\"})"
23804 #: guix-git/doc/guix.texi:13834
23805 msgid "The name of the default locale (@pxref{Locale Names,,, libc, The GNU C Library Reference Manual}). @xref{Locales}, for more information."
23809 #: guix-git/doc/guix.texi:13835
23811 msgid "@code{locale-definitions} (default: @code{%default-locale-definitions})"
23815 #: guix-git/doc/guix.texi:13838
23816 msgid "The list of locale definitions to be compiled and that may be used at run time. @xref{Locales}."
23820 #: guix-git/doc/guix.texi:13839
23822 msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})"
23826 #: guix-git/doc/guix.texi:13843
23827 msgid "The list of GNU@tie{}libc packages whose locale data and tools are used to build the locale definitions. @xref{Locales}, for compatibility considerations that justify this option."
23831 #: guix-git/doc/guix.texi:13844
23833 msgid "@code{name-service-switch} (default: @code{%default-nss})"
23837 #: guix-git/doc/guix.texi:13848
23838 msgid "Configuration of the libc name service switch (NSS)---a @code{<name-service-switch>} object. @xref{Name Service Switch}, for details."
23842 #: guix-git/doc/guix.texi:13849
23844 msgid "@code{services} (default: @code{%base-services})"
23848 #: guix-git/doc/guix.texi:13851
23849 msgid "A list of service objects denoting system services. @xref{Services}."
23853 #: guix-git/doc/guix.texi:13852
23855 msgid "essential services"
23859 #: guix-git/doc/guix.texi:13853
23861 msgid "@code{essential-services} (default: ...)"
23865 #: guix-git/doc/guix.texi:13858
23866 msgid "The list of ``essential services''---i.e., things like instances of @code{system-service-type} and @code{host-name-service-type} (@pxref{Service Reference}), which are derived from the operating system definition itself. As a user you should @emph{never} need to touch this field."
23870 #: guix-git/doc/guix.texi:13859
23872 msgid "@code{pam-services} (default: @code{(base-pam-services)})"
23876 #: guix-git/doc/guix.texi:13860
23882 #: guix-git/doc/guix.texi:13861
23884 msgid "pluggable authentication modules"
23888 #: guix-git/doc/guix.texi:13864
23889 msgid "Linux @dfn{pluggable authentication module} (PAM) services."
23893 #: guix-git/doc/guix.texi:13865
23895 msgid "@code{setuid-programs} (default: @code{%setuid-programs})"
23899 #: guix-git/doc/guix.texi:13868
23900 msgid "List of string-valued G-expressions denoting setuid programs. @xref{Setuid Programs}."
23904 #: guix-git/doc/guix.texi:13869
23906 msgid "@code{sudoers-file} (default: @code{%sudoers-specification})"
23910 #: guix-git/doc/guix.texi:13870
23912 msgid "sudoers file"
23916 #: guix-git/doc/guix.texi:13873
23917 msgid "The contents of the @file{/etc/sudoers} file as a file-like object (@pxref{G-Expressions, @code{local-file} and @code{plain-file}})."
23921 #: guix-git/doc/guix.texi:13878
23922 msgid "This file specifies which users can use the @command{sudo} command, what they are allowed to do, and what privileges they may gain. The default is that only @code{root} and members of the @code{wheel} group may use @code{sudo}."
23926 #: guix-git/doc/guix.texi:13881
23928 msgid "{Scheme Syntax} this-operating-system"
23932 #: guix-git/doc/guix.texi:13884
23933 msgid "When used in the @emph{lexical scope} of an operating system field definition, this identifier resolves to the operating system being defined."
23937 #: guix-git/doc/guix.texi:13887
23938 msgid "The example below shows how to refer to the operating system being defined in the definition of the @code{label} field:"
23942 #: guix-git/doc/guix.texi:13890 guix-git/doc/guix.texi:17352
23945 "(use-modules (gnu) (guix))\n"
23950 #: guix-git/doc/guix.texi:13895
23953 "(operating-system\n"
23955 " (label (package-full-name\n"
23956 " (operating-system-kernel this-operating-system))))\n"
23960 #: guix-git/doc/guix.texi:13899
23961 msgid "It is an error to refer to @code{this-operating-system} outside an operating system definition."
23964 #. type: Plain text
23965 #: guix-git/doc/guix.texi:13910
23966 msgid "The list of file systems to be mounted is specified in the @code{file-systems} field of the operating system declaration (@pxref{Using the Configuration System}). Each file system is declared using the @code{file-system} form, like this:"
23970 #: guix-git/doc/guix.texi:13916
23974 " (mount-point \"/home\")\n"
23975 " (device \"/dev/sda3\")\n"
23976 " (type \"ext4\"))\n"
23979 #. type: Plain text
23980 #: guix-git/doc/guix.texi:13920
23981 msgid "As usual, some of the fields are mandatory---those shown in the example above---while others can be omitted. These are described below."
23985 #: guix-git/doc/guix.texi:13921
23987 msgid "{Data Type} file-system"
23991 #: guix-git/doc/guix.texi:13924
23992 msgid "Objects of this type represent file systems to be mounted. They contain the following members:"
23996 #: guix-git/doc/guix.texi:13926 guix-git/doc/guix.texi:14276
24002 #: guix-git/doc/guix.texi:13929
24003 msgid "This is a string specifying the type of the file system---e.g., @code{\"ext4\"}."
24007 #: guix-git/doc/guix.texi:13930
24009 msgid "mount-point"
24013 #: guix-git/doc/guix.texi:13932
24014 msgid "This designates the place where the file system is to be mounted."
24018 #: guix-git/doc/guix.texi:13933
24024 #: guix-git/doc/guix.texi:13943
24025 msgid "This names the ``source'' of the file system. It can be one of three things: a file system label, a file system UUID, or the name of a @file{/dev} node. Labels and UUIDs offer a way to refer to file systems without having to hard-code their actual device name@footnote{Note that, while it is tempting to use @file{/dev/disk/by-uuid} and similar device names to achieve the same result, this is not recommended: These special device nodes are created by the udev daemon and may be unavailable at the time the device is mounted.}."
24029 #: guix-git/doc/guix.texi:13944
24031 msgid "file-system-label"
24035 #: guix-git/doc/guix.texi:13949
24036 msgid "File system labels are created using the @code{file-system-label} procedure, UUIDs are created using @code{uuid}, and @file{/dev} node are plain strings. Here's an example of a file system referred to by its label, as shown by the @command{e2label} command:"
24040 #: guix-git/doc/guix.texi:13955
24044 " (mount-point \"/home\")\n"
24045 " (type \"ext4\")\n"
24046 " (device (file-system-label \"my-home\")))\n"
24050 #: guix-git/doc/guix.texi:13957 guix-git/doc/guix.texi:31197
24051 #: guix-git/doc/guix.texi:31213
24057 #: guix-git/doc/guix.texi:13965
24058 msgid "UUIDs are converted from their string representation (as shown by the @command{tune2fs -l} command) using the @code{uuid} form@footnote{The @code{uuid} form expects 16-byte UUIDs as defined in @uref{https://tools.ietf.org/html/rfc4122, RFC@tie{}4122}. This is the form of UUID used by the ext2 family of file systems and others, but it is different from ``UUIDs'' found in FAT file systems, for instance.}, like this:"
24062 #: guix-git/doc/guix.texi:13971
24066 " (mount-point \"/home\")\n"
24067 " (type \"ext4\")\n"
24068 " (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
24072 #: guix-git/doc/guix.texi:13979
24073 msgid "When the source of a file system is a mapped device (@pxref{Mapped Devices}), its @code{device} field @emph{must} refer to the mapped device name---e.g., @file{\"/dev/mapper/root-partition\"}. This is required so that the system knows that mounting the file system depends on having the corresponding device mapping established."
24077 #: guix-git/doc/guix.texi:13980
24079 msgid "@code{flags} (default: @code{'()})"
24083 #: guix-git/doc/guix.texi:13990
24084 msgid "This is a list of symbols denoting mount flags. Recognized flags include @code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to special files), @code{no-suid} (ignore setuid and setgid bits), @code{no-atime} (do not update file access times), @code{strict-atime} (update file access time), @code{lazy-time} (only update time on the in-memory version of the file inode), and @code{no-exec} (disallow program execution). @xref{Mount-Unmount-Remount,,, libc, The GNU C Library Reference Manual}, for more information on these flags."
24088 #: guix-git/doc/guix.texi:13991
24090 msgid "@code{options} (default: @code{#f})"
24094 #: guix-git/doc/guix.texi:14000
24095 msgid "This is either @code{#f}, or a string denoting mount options passed to the file system driver. @xref{Mount-Unmount-Remount,,, libc, The GNU C Library Reference Manual}, for details and run @command{man 8 mount} for options for various file systems. Note that the @code{file-system-options->alist} and @code{alist->file-system-options} procedures from @code{(gnu system file-systems)} can be used to convert file system options given as an association list to the string representation, and vice-versa."
24099 #: guix-git/doc/guix.texi:14001
24101 msgid "@code{mount?} (default: @code{#t})"
24105 #: guix-git/doc/guix.texi:14006
24106 msgid "This value indicates whether to automatically mount the file system when the system is brought up. When set to @code{#f}, the file system gets an entry in @file{/etc/fstab} (read by the @command{mount} command) but is not automatically mounted."
24110 #: guix-git/doc/guix.texi:14007
24112 msgid "@code{needed-for-boot?} (default: @code{#f})"
24116 #: guix-git/doc/guix.texi:14012
24117 msgid "This Boolean value indicates whether the file system is needed when booting. If that is true, then the file system is mounted when the initial RAM disk (initrd) is loaded. This is always the case, for instance, for the root file system."
24121 #: guix-git/doc/guix.texi:14013
24123 msgid "@code{check?} (default: @code{#t})"
24127 #: guix-git/doc/guix.texi:14016
24128 msgid "This Boolean indicates whether the file system needs to be checked for errors before being mounted."
24132 #: guix-git/doc/guix.texi:14017
24134 msgid "@code{create-mount-point?} (default: @code{#f})"
24138 #: guix-git/doc/guix.texi:14019
24139 msgid "When true, the mount point is created if it does not exist yet."
24143 #: guix-git/doc/guix.texi:14020
24145 msgid "@code{mount-may-fail?} (default: @code{#f})"
24149 #: guix-git/doc/guix.texi:14025
24150 msgid "When true, this indicates that mounting this file system can fail but that should not be considered an error. This is useful in unusual cases; an example of this is @code{efivarfs}, a file system that can only be mounted on EFI/UEFI systems."
24154 #: guix-git/doc/guix.texi:14026
24156 msgid "@code{dependencies} (default: @code{'()})"
24160 #: guix-git/doc/guix.texi:14030
24161 msgid "This is a list of @code{<file-system>} or @code{<mapped-device>} objects representing file systems that must be mounted or mapped devices that must be opened before (and unmounted or closed after) this one."
24165 #: guix-git/doc/guix.texi:14034
24166 msgid "As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is a dependency of @file{/sys/fs/cgroup/cpu} and @file{/sys/fs/cgroup/memory}."
24170 #: guix-git/doc/guix.texi:14037
24171 msgid "Another example is a file system that depends on a mapped device, for example for an encrypted partition (@pxref{Mapped Devices})."
24175 #: guix-git/doc/guix.texi:14040
24177 msgid "{Scheme Procedure} file-system-label @var{str}"
24181 #: guix-git/doc/guix.texi:14043
24182 msgid "This procedure returns an opaque file system label from @var{str}, a string:"
24186 #: guix-git/doc/guix.texi:14047
24189 "(file-system-label \"home\")\n"
24190 "@result{} #<file-system-label \"home\">\n"
24194 #: guix-git/doc/guix.texi:14051
24195 msgid "File system labels are used to refer to file systems by label rather than by device name. See above for examples."
24198 #. type: Plain text
24199 #: guix-git/doc/guix.texi:14055
24200 msgid "The @code{(gnu system file-systems)} exports the following useful variables."
24204 #: guix-git/doc/guix.texi:14056
24206 msgid "{Scheme Variable} %base-file-systems"
24210 #: guix-git/doc/guix.texi:14061
24211 msgid "These are essential file systems that are required on normal systems, such as @code{%pseudo-terminal-file-system} and @code{%immutable-store} (see below). Operating system declarations should always contain at least these."
24215 #: guix-git/doc/guix.texi:14063
24217 msgid "{Scheme Variable} %pseudo-terminal-file-system"
24221 #: guix-git/doc/guix.texi:14069
24222 msgid "This is the file system to be mounted as @file{/dev/pts}. It supports @dfn{pseudo-terminals} created @i{via} @code{openpty} and similar functions (@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference Manual}). Pseudo-terminals are used by terminal emulators such as @command{xterm}."
24226 #: guix-git/doc/guix.texi:14071
24228 msgid "{Scheme Variable} %shared-memory-file-system"
24232 #: guix-git/doc/guix.texi:14075
24233 msgid "This file system is mounted as @file{/dev/shm} and is used to support memory sharing across processes (@pxref{Memory-mapped I/O, @code{shm_open},, libc, The GNU C Library Reference Manual})."
24237 #: guix-git/doc/guix.texi:14077
24239 msgid "{Scheme Variable} %immutable-store"
24243 #: guix-git/doc/guix.texi:14082
24244 msgid "This file system performs a read-only ``bind mount'' of @file{/gnu/store}, making it read-only for all the users including @code{root}. This prevents against accidental modification by software running as @code{root} or by system administrators."
24248 #: guix-git/doc/guix.texi:14085
24249 msgid "The daemon itself is still able to write to the store: it remounts it read-write in its own ``name space.''"
24253 #: guix-git/doc/guix.texi:14087
24255 msgid "{Scheme Variable} %binary-format-file-system"
24259 #: guix-git/doc/guix.texi:14091
24260 msgid "The @code{binfmt_misc} file system, which allows handling of arbitrary executable file types to be delegated to user space. This requires the @code{binfmt.ko} kernel module to be loaded."
24264 #: guix-git/doc/guix.texi:14093
24266 msgid "{Scheme Variable} %fuse-control-file-system"
24270 #: guix-git/doc/guix.texi:14097
24271 msgid "The @code{fusectl} file system, which allows unprivileged users to mount and unmount user-space FUSE file systems. This requires the @code{fuse.ko} kernel module to be loaded."
24274 #. type: Plain text
24275 #: guix-git/doc/guix.texi:14101
24276 msgid "The @code{(gnu system uuid)} module provides tools to deal with file system ``unique identifiers'' (UUIDs)."
24280 #: guix-git/doc/guix.texi:14102
24282 msgid "{Scheme Procedure} uuid @var{str} [@var{type}]"
24286 #: guix-git/doc/guix.texi:14105
24287 msgid "Return an opaque UUID (unique identifier) object of the given @var{type} (a symbol) by parsing @var{str} (a string):"
24291 #: guix-git/doc/guix.texi:14109
24294 "(uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")\n"
24295 "@result{} #<<uuid> type: dce bv: @dots{}>\n"
24300 #: guix-git/doc/guix.texi:14112
24303 "(uuid \"1234-ABCD\" 'fat)\n"
24304 "@result{} #<<uuid> type: fat bv: @dots{}>\n"
24308 #: guix-git/doc/guix.texi:14116
24309 msgid "@var{type} may be one of @code{dce}, @code{iso9660}, @code{fat}, @code{ntfs}, or one of the commonly found synonyms for these."
24313 #: guix-git/doc/guix.texi:14119
24314 msgid "UUIDs are another way to unambiguously refer to file systems in operating system configuration. See the examples above."
24317 #. type: subsection
24318 #: guix-git/doc/guix.texi:14122 guix-git/doc/guix.texi:14123
24320 msgid "Btrfs file system"
24323 #. type: Plain text
24324 #: guix-git/doc/guix.texi:14129
24325 msgid "The Btrfs has special features, such as subvolumes, that merit being explained in more details. The following section attempts to cover basic as well as complex uses of a Btrfs file system with the Guix System."
24328 #. type: Plain text
24329 #: guix-git/doc/guix.texi:14132
24330 msgid "In its simplest usage, a Btrfs file system can be described, for example, by:"
24334 #: guix-git/doc/guix.texi:14138
24338 " (mount-point \"/home\")\n"
24339 " (type \"btrfs\")\n"
24340 " (device (file-system-label \"my-home\")))\n"
24343 #. type: Plain text
24344 #: guix-git/doc/guix.texi:14144
24345 msgid "The example below is more complex, as it makes use of a Btrfs subvolume, named @code{rootfs}. The parent Btrfs file system is labeled @code{my-btrfs-pool}, and is located on an encrypted device (hence the dependency on @code{mapped-devices}):"
24349 #: guix-git/doc/guix.texi:14152
24353 " (device (file-system-label \"my-btrfs-pool\"))\n"
24354 " (mount-point \"/\")\n"
24355 " (type \"btrfs\")\n"
24356 " (options \"subvol=rootfs\")\n"
24357 " (dependencies mapped-devices))\n"
24360 #. type: Plain text
24361 #: guix-git/doc/guix.texi:14163
24362 msgid "Some bootloaders, for example GRUB, only mount a Btrfs partition at its top level during the early boot, and rely on their configuration to refer to the correct subvolume path within that top level. The bootloaders operating in this way typically produce their configuration on a running system where the Btrfs partitions are already mounted and where the subvolume information is readily available. As an example, @command{grub-mkconfig}, the configuration generator command shipped with GRUB, reads @file{/proc/self/mountinfo} to determine the top-level path of a subvolume."
24365 #. type: Plain text
24366 #: guix-git/doc/guix.texi:14171
24367 msgid "The Guix System produces a bootloader configuration using the operating system configuration as its sole input; it is therefore necessary to extract the subvolume name on which @file{/gnu/store} lives (if any) from that operating system configuration. To better illustrate, consider a subvolume named 'rootfs' which contains the root file system data. In such situation, the GRUB bootloader would only see the top level of the root Btrfs partition, e.g.:"
24371 #: guix-git/doc/guix.texi:14178
24375 "├── rootfs (subvolume directory)\n"
24376 " ├── gnu (normal directory)\n"
24377 " ├── store (normal directory)\n"
24381 #. type: Plain text
24382 #: guix-git/doc/guix.texi:14183
24383 msgid "Thus, the subvolume name must be prepended to the @file{/gnu/store} path of the kernel, initrd binaries and any other files referred to in the GRUB configuration that must be found during the early boot."
24386 #. type: Plain text
24387 #: guix-git/doc/guix.texi:14186
24388 msgid "The next example shows a nested hierarchy of subvolumes and directories:"
24392 #: guix-git/doc/guix.texi:14193
24396 "├── rootfs (subvolume)\n"
24397 " ├── gnu (normal directory)\n"
24398 " ├── store (subvolume)\n"
24402 #. type: Plain text
24403 #: guix-git/doc/guix.texi:14200
24404 msgid "This scenario would work without mounting the 'store' subvolume. Mounting 'rootfs' is sufficient, since the subvolume name matches its intended mount point in the file system hierarchy. Alternatively, the 'store' subvolume could be referred to by setting the @code{subvol} option to either @code{/rootfs/gnu/store} or @code{rootfs/gnu/store}."
24407 #. type: Plain text
24408 #: guix-git/doc/guix.texi:14202
24409 msgid "Finally, a more contrived example of nested subvolumes:"
24413 #: guix-git/doc/guix.texi:14209
24417 "├── root-snapshots (subvolume)\n"
24418 " ├── root-current (subvolume)\n"
24419 " ├── guix-store (subvolume)\n"
24423 #. type: Plain text
24424 #: guix-git/doc/guix.texi:14216
24425 msgid "Here, the 'guix-store' subvolume doesn't match its intended mount point, so it is necessary to mount it. The subvolume must be fully specified, by passing its file name to the @code{subvol} option. To illustrate, the 'guix-store' subvolume could be mounted on @file{/gnu/store} by using a file system declaration such as:"
24429 #: guix-git/doc/guix.texi:14224
24433 " (device (file-system-label \"btrfs-pool-1\"))\n"
24434 " (mount-point \"/gnu/store\")\n"
24435 " (type \"btrfs\")\n"
24436 " (options \"subvol=root-snapshots/root-current/guix-store,\\\n"
24437 "compress-force=zstd,space_cache=v2\"))\n"
24441 #: guix-git/doc/guix.texi:14229
24443 msgid "device mapping"
24447 #: guix-git/doc/guix.texi:14230
24449 msgid "mapped devices"
24452 #. type: Plain text
24453 #: guix-git/doc/guix.texi:14247
24454 msgid "The Linux kernel has a notion of @dfn{device mapping}: a block device, such as a hard disk partition, can be @dfn{mapped} into another device, usually in @code{/dev/mapper/}, with additional processing over the data that flows through it@footnote{Note that the GNU@tie{}Hurd makes no difference between the concept of a ``mapped device'' and that of a file system: both boil down to @emph{translating} input/output operations made on a file to operations on its backing store. Thus, the Hurd implements mapped devices, like file systems, using the generic @dfn{translator} mechanism (@pxref{Translators,,, hurd, The GNU Hurd Reference Manual}).}. A typical example is encryption device mapping: all writes to the mapped device are encrypted, and all reads are deciphered, transparently. Guix extends this notion by considering any device or set of devices that are @dfn{transformed} in some way to create a new device; for instance, RAID devices are obtained by @dfn{assembling} several other devices, such as hard disks or partitions, into a new one that behaves as one partition."
24457 #. type: Plain text
24458 #: guix-git/doc/guix.texi:14250
24459 msgid "Mapped devices are declared using the @code{mapped-device} form, defined as follows; for examples, see below."
24463 #: guix-git/doc/guix.texi:14251
24465 msgid "{Data Type} mapped-device"
24469 #: guix-git/doc/guix.texi:14254
24470 msgid "Objects of this type represent device mappings that will be made when the system boots up."
24474 #: guix-git/doc/guix.texi:14261
24475 msgid "This is either a string specifying the name of the block device to be mapped, such as @code{\"/dev/sda3\"}, or a list of such strings when several devices need to be assembled for creating a new one. In case of LVM this is a string specifying name of the volume group to be mapped."
24479 #: guix-git/doc/guix.texi:14262 guix-git/doc/guix.texi:32551
24485 #: guix-git/doc/guix.texi:14271
24486 msgid "This string specifies the name of the resulting mapped device. For kernel mappers such as encrypted devices of type @code{luks-device-mapping}, specifying @code{\"my-partition\"} leads to the creation of the @code{\"/dev/mapper/my-partition\"} device. For RAID devices of type @code{raid-device-mapping}, the full device name such as @code{\"/dev/md0\"} needs to be given. LVM logical volumes of type @code{lvm-device-mapping} need to be specified as @code{\"VGNAME-LVNAME\"}."
24490 #: guix-git/doc/guix.texi:14272
24496 #: guix-git/doc/guix.texi:14275
24497 msgid "This list of strings specifies names of the resulting mapped devices in case there are several. The format is identical to @var{target}."
24501 #: guix-git/doc/guix.texi:14279
24502 msgid "This must be a @code{mapped-device-kind} object, which specifies how @var{source} is mapped to @var{target}."
24506 #: guix-git/doc/guix.texi:14282
24508 msgid "{Scheme Variable} luks-device-mapping"
24512 #: guix-git/doc/guix.texi:14286
24513 msgid "This defines LUKS block device encryption using the @command{cryptsetup} command from the package with the same name. It relies on the @code{dm-crypt} Linux kernel module."
24517 #: guix-git/doc/guix.texi:14288
24519 msgid "{Scheme Variable} raid-device-mapping"
24523 #: guix-git/doc/guix.texi:14293
24524 msgid "This defines a RAID device, which is assembled using the @code{mdadm} command from the package with the same name. It requires a Linux kernel module for the appropriate RAID level to be loaded, such as @code{raid456} for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10."
24528 #: guix-git/doc/guix.texi:14295
24530 msgid "LVM, logical volume manager"
24534 #: guix-git/doc/guix.texi:14296
24536 msgid "{Scheme Variable} lvm-device-mapping"
24540 #: guix-git/doc/guix.texi:14301
24541 msgid "This defines one or more logical volumes for the Linux @uref{https://www.sourceware.org/lvm2/, Logical Volume Manager (LVM)}. The volume group is activated by the @command{vgchange} command from the @code{lvm2} package."
24545 #: guix-git/doc/guix.texi:14303
24547 msgid "disk encryption"
24551 #: guix-git/doc/guix.texi:14304
24556 #. type: Plain text
24557 #: guix-git/doc/guix.texi:14312
24558 msgid "The following example specifies a mapping from @file{/dev/sda3} to @file{/dev/mapper/home} using LUKS---the @url{https://gitlab.com/cryptsetup/cryptsetup,Linux Unified Key Setup}, a standard mechanism for disk encryption. The @file{/dev/mapper/home} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems})."
24562 #: guix-git/doc/guix.texi:14318
24566 " (source \"/dev/sda3\")\n"
24567 " (target \"home\")\n"
24568 " (type luks-device-mapping))\n"
24571 #. type: Plain text
24572 #: guix-git/doc/guix.texi:14323
24573 msgid "Alternatively, to become independent of device numbering, one may obtain the LUKS UUID (@dfn{unique identifier}) of the source device by a command like:"
24577 #: guix-git/doc/guix.texi:14326
24579 msgid "cryptsetup luksUUID /dev/sda3\n"
24582 #. type: Plain text
24583 #: guix-git/doc/guix.texi:14329
24584 msgid "and use it as follows:"
24588 #: guix-git/doc/guix.texi:14335
24592 " (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n"
24593 " (target \"home\")\n"
24594 " (type luks-device-mapping))\n"
24598 #: guix-git/doc/guix.texi:14337
24600 msgid "swap encryption"
24603 #. type: Plain text
24604 #: guix-git/doc/guix.texi:14343
24605 msgid "It is also desirable to encrypt swap space, since swap space may contain sensitive data. One way to accomplish that is to use a swap file in a file system on a device mapped via LUKS encryption. In this way, the swap file is encrypted because the entire device is encrypted. @xref{Preparing for Installation,,Disk Partitioning}, for an example."
24608 #. type: Plain text
24609 #: guix-git/doc/guix.texi:14346
24610 msgid "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} may be declared as follows:"
24614 #: guix-git/doc/guix.texi:14352
24618 " (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n"
24619 " (target \"/dev/md0\")\n"
24620 " (type raid-device-mapping))\n"
24623 #. type: Plain text
24624 #: guix-git/doc/guix.texi:14359
24625 msgid "The @file{/dev/md0} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems}). Note that the RAID level need not be given; it is chosen during the initial creation and formatting of the RAID device and is determined automatically later."
24628 #. type: Plain text
24629 #: guix-git/doc/guix.texi:14362
24630 msgid "LVM logical volumes ``alpha'' and ``beta'' from volume group ``vg0'' can be declared as follows:"
24634 #: guix-git/doc/guix.texi:14368
24638 " (source \"vg0\")\n"
24639 " (targets (list \"vg0-alpha\" \"vg0-beta\"))\n"
24640 " (type lvm-device-mapping))\n"
24643 #. type: Plain text
24644 #: guix-git/doc/guix.texi:14373
24645 msgid "Devices @file{/dev/mapper/vg0-alpha} and @file{/dev/mapper/vg0-beta} can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems})."
24649 #: guix-git/doc/guix.texi:14377
24655 #: guix-git/doc/guix.texi:14378
24661 #: guix-git/doc/guix.texi:14379
24663 msgid "user accounts"
24666 #. type: Plain text
24667 #: guix-git/doc/guix.texi:14383
24668 msgid "User accounts and groups are entirely managed through the @code{operating-system} declaration. They are specified with the @code{user-account} and @code{user-group} forms:"
24672 #: guix-git/doc/guix.texi:14393
24676 " (name \"alice\")\n"
24677 " (group \"users\")\n"
24678 " (supplementary-groups '(\"wheel\" ;allow use of sudo, etc.\n"
24679 " \"audio\" ;sound card\n"
24680 " \"video\" ;video devices such as webcams\n"
24681 " \"cdrom\")) ;the good ol' CD-ROM\n"
24682 " (comment \"Bob's sister\"))\n"
24685 #. type: Plain text
24686 #: guix-git/doc/guix.texi:14397
24687 msgid "Here's a user account that uses a different shell and a custom home directory (the default would be @file{\"/home/bob\"}):"
24691 #: guix-git/doc/guix.texi:14405
24695 " (name \"bob\")\n"
24696 " (group \"users\")\n"
24697 " (comment \"Alice's bro\")\n"
24698 " (shell (file-append zsh \"/bin/zsh\"))\n"
24699 " (home-directory \"/home/robert\"))\n"
24702 #. type: Plain text
24703 #: guix-git/doc/guix.texi:14414
24704 msgid "When booting or upon completion of @command{guix system reconfigure}, the system ensures that only the user accounts and groups specified in the @code{operating-system} declaration exist, and with the specified properties. Thus, account or group creations or modifications made by directly invoking commands such as @command{useradd} are lost upon reconfiguration or reboot. This ensures that the system remains exactly as declared."
24708 #: guix-git/doc/guix.texi:14415
24710 msgid "{Data Type} user-account"
24714 #: guix-git/doc/guix.texi:14418
24715 msgid "Objects of this type represent user accounts. The following members may be specified:"
24719 #: guix-git/doc/guix.texi:14422
24720 msgid "The name of the user account."
24724 #: guix-git/doc/guix.texi:14423 guix-git/doc/guix.texi:32237
24730 #: guix-git/doc/guix.texi:14424 guix-git/doc/guix.texi:14503
24736 #: guix-git/doc/guix.texi:14427
24737 msgid "This is the name (a string) or identifier (a number) of the user group this account belongs to."
24741 #: guix-git/doc/guix.texi:14428
24743 msgid "@code{supplementary-groups} (default: @code{'()})"
24747 #: guix-git/doc/guix.texi:14431
24748 msgid "Optionally, this can be defined as a list of group names that this account belongs to."
24752 #: guix-git/doc/guix.texi:14432
24754 msgid "@code{uid} (default: @code{#f})"
24758 #: guix-git/doc/guix.texi:14436
24759 msgid "This is the user ID for this account (a number), or @code{#f}. In the latter case, a number is automatically chosen by the system when the account is created."
24763 #: guix-git/doc/guix.texi:14437
24765 msgid "@code{comment} (default: @code{\"\"})"
24769 #: guix-git/doc/guix.texi:14439
24770 msgid "A comment about the account, such as the account owner's full name."
24774 #: guix-git/doc/guix.texi:14440
24776 msgid "home-directory"
24780 #: guix-git/doc/guix.texi:14442
24781 msgid "This is the name of the home directory for the account."
24785 #: guix-git/doc/guix.texi:14443
24787 msgid "@code{create-home-directory?} (default: @code{#t})"
24791 #: guix-git/doc/guix.texi:14446
24792 msgid "Indicates whether the home directory of this account should be created if it does not exist yet."
24796 #: guix-git/doc/guix.texi:14447
24798 msgid "@code{shell} (default: Bash)"
24802 #: guix-git/doc/guix.texi:14451
24803 msgid "This is a G-expression denoting the file name of a program to be used as the shell (@pxref{G-Expressions}). For example, you would refer to the Bash executable like this:"
24807 #: guix-git/doc/guix.texi:14454
24809 msgid "(file-append bash \"/bin/bash\")\n"
24813 #: guix-git/doc/guix.texi:14458
24814 msgid "... and to the Zsh executable like that:"
24818 #: guix-git/doc/guix.texi:14461
24820 msgid "(file-append zsh \"/bin/zsh\")\n"
24824 #: guix-git/doc/guix.texi:14463 guix-git/doc/guix.texi:14521
24826 msgid "@code{system?} (default: @code{#f})"
24830 #: guix-git/doc/guix.texi:14467
24831 msgid "This Boolean value indicates whether the account is a ``system'' account. System accounts are sometimes treated specially; for instance, graphical login managers do not list them."
24834 #. type: anchor{#1}
24835 #: guix-git/doc/guix.texi:14469
24836 msgid "user-account-password"
24840 #: guix-git/doc/guix.texi:14469
24842 msgid "password, for user accounts"
24846 #: guix-git/doc/guix.texi:14470 guix-git/doc/guix.texi:14525
24848 msgid "@code{password} (default: @code{#f})"
24852 #: guix-git/doc/guix.texi:14476
24853 msgid "You would normally leave this field to @code{#f}, initialize user passwords as @code{root} with the @command{passwd} command, and then let users change it with @command{passwd}. Passwords set with @command{passwd} are of course preserved across reboot and reconfiguration."
24857 #: guix-git/doc/guix.texi:14480
24858 msgid "If you @emph{do} want to set an initial password for an account, then this field must contain the encrypted password, as a string. You can use the @code{crypt} procedure for this purpose:"
24862 #: guix-git/doc/guix.texi:14485
24866 " (name \"charlie\")\n"
24867 " (group \"users\")\n"
24872 #: guix-git/doc/guix.texi:14488
24875 " ;; Specify a SHA-512-hashed initial password.\n"
24876 " (password (crypt \"InitialPassword!\" \"$6$abc\")))\n"
24880 #: guix-git/doc/guix.texi:14494
24881 msgid "The hash of this initial password will be available in a file in @file{/gnu/store}, readable by all the users, so this method must be used with care."
24885 #: guix-git/doc/guix.texi:14499
24886 msgid "@xref{Passphrase Storage,,, libc, The GNU C Library Reference Manual}, for more information on password encryption, and @ref{Encryption,,, guile, GNU Guile Reference Manual}, for information on Guile's @code{crypt} procedure."
24889 #. type: Plain text
24890 #: guix-git/doc/guix.texi:14505
24891 msgid "User group declarations are even simpler:"
24895 #: guix-git/doc/guix.texi:14508
24897 msgid "(user-group (name \"students\"))\n"
24901 #: guix-git/doc/guix.texi:14510
24903 msgid "{Data Type} user-group"
24907 #: guix-git/doc/guix.texi:14512
24908 msgid "This type is for, well, user groups. There are just a few fields:"
24912 #: guix-git/doc/guix.texi:14516
24913 msgid "The name of the group."
24917 #: guix-git/doc/guix.texi:14517 guix-git/doc/guix.texi:29041
24919 msgid "@code{id} (default: @code{#f})"
24923 #: guix-git/doc/guix.texi:14520
24924 msgid "The group identifier (a number). If @code{#f}, a new number is automatically allocated when the group is created."
24928 #: guix-git/doc/guix.texi:14524
24929 msgid "This Boolean value indicates whether the group is a ``system'' group. System groups have low numerical IDs."
24933 #: guix-git/doc/guix.texi:14528
24934 msgid "What, user groups can have a password? Well, apparently yes. Unless @code{#f}, this field specifies the password of the group."
24937 #. type: Plain text
24938 #: guix-git/doc/guix.texi:14534
24939 msgid "For convenience, a variable lists all the basic user groups one may expect:"
24943 #: guix-git/doc/guix.texi:14535
24945 msgid "{Scheme Variable} %base-groups"
24949 #: guix-git/doc/guix.texi:14540
24950 msgid "This is the list of basic user groups that users and/or packages expect to be present on the system. This includes groups such as ``root'', ``wheel'', and ``users'', as well as groups used to control access to specific devices such as ``audio'', ``disk'', and ``cdrom''."
24954 #: guix-git/doc/guix.texi:14542
24956 msgid "{Scheme Variable} %base-user-accounts"
24960 #: guix-git/doc/guix.texi:14545
24961 msgid "This is the list of basic system accounts that programs may expect to find on a GNU/Linux system, such as the ``nobody'' account."
24965 #: guix-git/doc/guix.texi:14548
24966 msgid "Note that the ``root'' account is not included here. It is a special-case and is automatically added whether or not it is specified."
24970 #: guix-git/doc/guix.texi:14554
24975 #. type: Plain text
24976 #: guix-git/doc/guix.texi:14562
24977 msgid "To specify what each key of your keyboard does, you need to tell the operating system what @dfn{keyboard layout} you want to use. The default, when nothing is specified, is the US English QWERTY layout for 105-key PC keyboards. However, German speakers will usually prefer the German QWERTZ layout, French speakers will want the AZERTY layout, and so on; hackers might prefer Dvorak or bépo, and they might even want to further customize the effect of some of the keys. This section explains how to get that done."
24981 #: guix-git/doc/guix.texi:14563
24983 msgid "keyboard layout, definition"
24986 #. type: Plain text
24987 #: guix-git/doc/guix.texi:14565
24988 msgid "There are three components that will want to know about your keyboard layout:"
24992 #: guix-git/doc/guix.texi:14572
24993 msgid "The @emph{bootloader} may want to know what keyboard layout you want to use (@pxref{Bootloader Configuration, @code{keyboard-layout}}). This is useful if you want, for instance, to make sure that you can type the passphrase of your encrypted root partition using the right layout."
24997 #: guix-git/doc/guix.texi:14577
24998 msgid "The @emph{operating system kernel}, Linux, will need that so that the console is properly configured (@pxref{operating-system Reference, @code{keyboard-layout}})."
25002 #: guix-git/doc/guix.texi:14581
25003 msgid "The @emph{graphical display server}, usually Xorg, also has its own idea of the keyboard layout (@pxref{X Window, @code{keyboard-layout}})."
25006 #. type: Plain text
25007 #: guix-git/doc/guix.texi:14585
25008 msgid "Guix allows you to configure all three separately but, fortunately, it allows you to share the same keyboard layout for all three components."
25012 #: guix-git/doc/guix.texi:14586
25014 msgid "XKB, keyboard layouts"
25017 #. type: Plain text
25018 #: guix-git/doc/guix.texi:14594
25019 msgid "Keyboard layouts are represented by records created by the @code{keyboard-layout} procedure of @code{(gnu system keyboard)}. Following the X Keyboard extension (XKB), each layout has four attributes: a name (often a language code such as ``fi'' for Finnish or ``jp'' for Japanese), an optional variant name, an optional keyboard model name, and a possibly empty list of additional options. In most cases the layout name is all you care about."
25023 #: guix-git/doc/guix.texi:14595
25025 msgid "{Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @"
25029 #: guix-git/doc/guix.texi:14598
25030 msgid "[#:model] [#:options '()] Return a new keyboard layout with the given @var{name} and @var{variant}."
25034 #: guix-git/doc/guix.texi:14602
25035 msgid "@var{name} must be a string such as @code{\"fr\"}; @var{variant} must be a string such as @code{\"bepo\"} or @code{\"nodeadkeys\"}. See the @code{xkeyboard-config} package for valid options."
25038 #. type: Plain text
25039 #: guix-git/doc/guix.texi:14605
25040 msgid "Here are a few examples:"
25044 #: guix-git/doc/guix.texi:14610
25047 ";; The German QWERTZ layout. Here we assume a standard\n"
25048 ";; \"pc105\" keyboard model.\n"
25049 "(keyboard-layout \"de\")\n"
25054 #: guix-git/doc/guix.texi:14613
25057 ";; The bépo variant of the French layout.\n"
25058 "(keyboard-layout \"fr\" \"bepo\")\n"
25063 #: guix-git/doc/guix.texi:14616
25066 ";; The Catalan layout.\n"
25067 "(keyboard-layout \"es\" \"cat\")\n"
25072 #: guix-git/doc/guix.texi:14619
25075 ";; Arabic layout with \"Alt-Shift\" to switch to US layout.\n"
25076 "(keyboard-layout \"ar,us\" #:options '(\"grp:alt_shift_toggle\"))\n"
25081 #: guix-git/doc/guix.texi:14626
25084 ";; The Latin American Spanish layout. In addition, the\n"
25085 ";; \"Caps Lock\" key is used as an additional \"Ctrl\" key,\n"
25086 ";; and the \"Menu\" key is used as a \"Compose\" key to enter\n"
25087 ";; accented letters.\n"
25088 "(keyboard-layout \"latam\"\n"
25089 " #:options '(\"ctrl:nocaps\" \"compose:menu\"))\n"
25094 #: guix-git/doc/guix.texi:14629
25097 ";; The Russian layout for a ThinkPad keyboard.\n"
25098 "(keyboard-layout \"ru\" #:model \"thinkpad\")\n"
25103 #: guix-git/doc/guix.texi:14634
25106 ";; The \"US international\" layout, which is the US layout plus\n"
25107 ";; dead keys to enter accented characters. This is for an\n"
25108 ";; Apple MacBook keyboard.\n"
25109 "(keyboard-layout \"us\" \"intl\" #:model \"macbook78\")\n"
25112 #. type: Plain text
25113 #: guix-git/doc/guix.texi:14638
25114 msgid "See the @file{share/X11/xkb} directory of the @code{xkeyboard-config} package for a complete list of supported layouts, variants, and models."
25118 #: guix-git/doc/guix.texi:14639
25120 msgid "keyboard layout, configuration"
25123 #. type: Plain text
25124 #: guix-git/doc/guix.texi:14643
25125 msgid "Let's say you want your system to use the Turkish keyboard layout throughout your system---bootloader, console, and Xorg. Here's what your system configuration would look like:"
25129 #: guix-git/doc/guix.texi:14644
25131 msgid "set-xorg-configuration"
25135 #: guix-git/doc/guix.texi:14648
25138 ";; Using the Turkish layout for the bootloader, the console,\n"
25139 ";; and for Xorg.\n"
25144 #: guix-git/doc/guix.texi:14660
25147 "(operating-system\n"
25149 " (keyboard-layout (keyboard-layout \"tr\")) ;for the console\n"
25150 " (bootloader (bootloader-configuration\n"
25151 " (bootloader grub-efi-bootloader)\n"
25152 " (target \"/boot/efi\")\n"
25153 " (keyboard-layout keyboard-layout))) ;for GRUB\n"
25154 " (services (cons (set-xorg-configuration\n"
25155 " (xorg-configuration ;for Xorg\n"
25156 " (keyboard-layout keyboard-layout)))\n"
25157 " %desktop-services)))\n"
25160 #. type: Plain text
25161 #: guix-git/doc/guix.texi:14667
25162 msgid "In the example above, for GRUB and for Xorg, we just refer to the @code{keyboard-layout} field defined above, but we could just as well refer to a different layout. The @code{set-xorg-configuration} procedure communicates the desired Xorg configuration to the graphical log-in manager, by default GDM."
25165 #. type: Plain text
25166 #: guix-git/doc/guix.texi:14670
25167 msgid "We've discussed how to specify the @emph{default} keyboard layout of your system when it starts, but you can also adjust it at run time:"
25171 #: guix-git/doc/guix.texi:14675
25172 msgid "If you're using GNOME, its settings panel has a ``Region & Language'' entry where you can select one or more keyboard layouts."
25176 #: guix-git/doc/guix.texi:14680
25177 msgid "Under Xorg, the @command{setxkbmap} command (from the same-named package) allows you to change the current layout. For example, this is how you would change the layout to US Dvorak:"
25181 #: guix-git/doc/guix.texi:14683
25183 msgid "setxkbmap us dvorak\n"
25187 #: guix-git/doc/guix.texi:14690
25188 msgid "The @code{loadkeys} command changes the keyboard layout in effect in the Linux console. However, note that @code{loadkeys} does @emph{not} use the XKB keyboard layout categorization described above. The command below loads the French bépo layout:"
25192 #: guix-git/doc/guix.texi:14693
25194 msgid "loadkeys fr-bepo\n"
25198 #: guix-git/doc/guix.texi:14699
25203 #. type: Plain text
25204 #: guix-git/doc/guix.texi:14706
25205 msgid "A @dfn{locale} defines cultural conventions for a particular language and region of the world (@pxref{Locales,,, libc, The GNU C Library Reference Manual}). Each locale has a name that typically has the form @code{@var{language}_@var{territory}.@var{codeset}}---e.g., @code{fr_LU.utf8} designates the locale for the French language, with cultural conventions from Luxembourg, and using the UTF-8 encoding."
25209 #: guix-git/doc/guix.texi:14707
25211 msgid "locale definition"
25214 #. type: Plain text
25215 #: guix-git/doc/guix.texi:14711
25216 msgid "Usually, you will want to specify the default locale for the machine using the @code{locale} field of the @code{operating-system} declaration (@pxref{operating-system Reference, @code{locale}})."
25219 #. type: Plain text
25220 #: guix-git/doc/guix.texi:14720
25221 msgid "The selected locale is automatically added to the @dfn{locale definitions} known to the system if needed, with its codeset inferred from its name---e.g., @code{bo_CN.utf8} will be assumed to use the @code{UTF-8} codeset. Additional locale definitions can be specified in the @code{locale-definitions} slot of @code{operating-system}---this is useful, for instance, if the codeset could not be inferred from the locale name. The default set of locale definitions includes some widely used locales, but not all the available locales, in order to save space."
25224 #. type: Plain text
25225 #: guix-git/doc/guix.texi:14723
25226 msgid "For instance, to add the North Frisian locale for Germany, the value of that field may be:"
25230 #: guix-git/doc/guix.texi:14728
25233 "(cons (locale-definition\n"
25234 " (name \"fy_DE.utf8\") (source \"fy_DE\"))\n"
25235 " %default-locale-definitions)\n"
25238 #. type: Plain text
25239 #: guix-git/doc/guix.texi:14732
25240 msgid "Likewise, to save space, one might want @code{locale-definitions} to list only the locales that are actually used, as in:"
25244 #: guix-git/doc/guix.texi:14737
25247 "(list (locale-definition\n"
25248 " (name \"ja_JP.eucjp\") (source \"ja_JP\")\n"
25249 " (charset \"EUC-JP\")))\n"
25252 #. type: Plain text
25253 #: guix-git/doc/guix.texi:14746
25254 msgid "The compiled locale definitions are available at @file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc version, which is the default location where the GNU@tie{}libc provided by Guix looks for locale data. This can be overridden using the @env{LOCPATH} environment variable (@pxref{locales-and-locpath, @env{LOCPATH} and locale packages})."
25257 #. type: Plain text
25258 #: guix-git/doc/guix.texi:14749
25259 msgid "The @code{locale-definition} form is provided by the @code{(gnu system locale)} module. Details are given below."
25263 #: guix-git/doc/guix.texi:14750
25265 msgid "{Data Type} locale-definition"
25269 #: guix-git/doc/guix.texi:14752
25270 msgid "This is the data type of a locale definition."
25274 #: guix-git/doc/guix.texi:14758
25275 msgid "The name of the locale. @xref{Locale Names,,, libc, The GNU C Library Reference Manual}, for more information on locale names."
25279 #: guix-git/doc/guix.texi:14762
25280 msgid "The name of the source for that locale. This is typically the @code{@var{language}_@var{territory}} part of the locale name."
25284 #: guix-git/doc/guix.texi:14763
25286 msgid "@code{charset} (default: @code{\"UTF-8\"})"
25290 #: guix-git/doc/guix.texi:14767
25291 msgid "The ``character set'' or ``code set'' for that locale, @uref{https://www.iana.org/assignments/character-sets, as defined by IANA}."
25295 #: guix-git/doc/guix.texi:14771
25297 msgid "{Scheme Variable} %default-locale-definitions"
25301 #: guix-git/doc/guix.texi:14775
25302 msgid "A list of commonly used UTF-8 locales, used as the default value of the @code{locale-definitions} field of @code{operating-system} declarations."
25306 #: guix-git/doc/guix.texi:14776
25308 msgid "locale name"
25312 #: guix-git/doc/guix.texi:14777
25314 msgid "normalized codeset in locale names"
25318 #: guix-git/doc/guix.texi:14783
25319 msgid "These locale definitions use the @dfn{normalized codeset} for the part that follows the dot in the name (@pxref{Using gettextized software, normalized codeset,, libc, The GNU C Library Reference Manual}). So for instance it has @code{uk_UA.utf8} but @emph{not}, say, @code{uk_UA.UTF-8}."
25322 #. type: subsection
25323 #: guix-git/doc/guix.texi:14785
25325 msgid "Locale Data Compatibility Considerations"
25329 #: guix-git/doc/guix.texi:14787
25331 msgid "incompatibility, of locale data"
25334 #. type: Plain text
25335 #: guix-git/doc/guix.texi:14794
25336 msgid "@code{operating-system} declarations provide a @code{locale-libcs} field to specify the GNU@tie{}libc packages that are used to compile locale declarations (@pxref{operating-system Reference}). ``Why would I care?'', you may ask. Well, it turns out that the binary format of locale data is occasionally incompatible from one libc version to another."
25339 #. type: Plain text
25340 #: guix-git/doc/guix.texi:14806
25341 msgid "For instance, a program linked against libc version 2.21 is unable to read locale data produced with libc 2.22; worse, that program @emph{aborts} instead of simply ignoring the incompatible locale data@footnote{Versions 2.23 and later of GNU@tie{}libc will simply skip the incompatible locale data, which is already an improvement.}. Similarly, a program linked against libc 2.22 can read most, but not all, of the locale data from libc 2.21 (specifically, @env{LC_COLLATE} data is incompatible); thus calls to @code{setlocale} may fail, but programs will not abort."
25344 #. type: Plain text
25345 #: guix-git/doc/guix.texi:14811
25346 msgid "The ``problem'' with Guix is that users have a lot of freedom: They can choose whether and when to upgrade software in their profiles, and might be using a libc version different from the one the system administrator used to build the system-wide locale data."
25349 #. type: Plain text
25350 #: guix-git/doc/guix.texi:14815
25351 msgid "Fortunately, unprivileged users can also install their own locale data and define @env{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, @env{GUIX_LOCPATH} and locale packages})."
25354 #. type: Plain text
25355 #: guix-git/doc/guix.texi:14822
25356 msgid "Still, it is best if the system-wide locale data at @file{/run/current-system/locale} is built for all the libc versions actually in use on the system, so that all the programs can access it---this is especially crucial on a multi-user system. To do that, the administrator can specify several libc packages in the @code{locale-libcs} field of @code{operating-system}:"
25360 #: guix-git/doc/guix.texi:14825
25363 "(use-package-modules base)\n"
25368 #: guix-git/doc/guix.texi:14829
25371 "(operating-system\n"
25373 " (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n"
25376 #. type: Plain text
25377 #: guix-git/doc/guix.texi:14834
25378 msgid "This example would lead to a system containing locale definitions for both libc 2.21 and the current version of libc in @file{/run/current-system/locale}."
25382 #: guix-git/doc/guix.texi:14839
25384 msgid "system services"
25387 #. type: Plain text
25388 #: guix-git/doc/guix.texi:14845
25389 msgid "An important part of preparing an @code{operating-system} declaration is listing @dfn{system services} and their configuration (@pxref{Using the Configuration System}). System services are typically daemons launched when the system boots, or other actions needed at that time---e.g., configuring network access."
25392 #. type: Plain text
25393 #: guix-git/doc/guix.texi:14852
25394 msgid "Guix has a broad definition of ``service'' (@pxref{Service Composition}), but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd Services}). On a running system, the @command{herd} command allows you to list the available services, show their status, start and stop them, or do other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd Manual}). For example:"
25398 #: guix-git/doc/guix.texi:14855
25400 msgid "# herd status\n"
25403 #. type: Plain text
25404 #: guix-git/doc/guix.texi:14860
25405 msgid "The above command, run as @code{root}, lists the currently defined services. The @command{herd doc} command shows a synopsis of the given service and its associated actions:"
25409 #: guix-git/doc/guix.texi:14864
25412 "# herd doc nscd\n"
25413 "Run libc's name service cache daemon (nscd).\n"
25418 #: guix-git/doc/guix.texi:14867
25421 "# herd doc nscd action invalidate\n"
25422 "invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.\n"
25425 #. type: Plain text
25426 #: guix-git/doc/guix.texi:14872
25427 msgid "The @command{start}, @command{stop}, and @command{restart} sub-commands have the effect you would expect. For instance, the commands below stop the nscd service and restart the Xorg display server:"
25431 #: guix-git/doc/guix.texi:14879
25434 "# herd stop nscd\n"
25435 "Service nscd has been stopped.\n"
25436 "# herd restart xorg-server\n"
25437 "Service xorg-server has been stopped.\n"
25438 "Service xorg-server has been started.\n"
25441 #. type: Plain text
25442 #: guix-git/doc/guix.texi:14884
25443 msgid "The following sections document the available services, starting with the core services, that may be used in an @code{operating-system} declaration."
25446 #. type: subsection
25447 #: guix-git/doc/guix.texi:14919 guix-git/doc/guix.texi:22543
25448 #: guix-git/doc/guix.texi:22544
25450 msgid "File-Sharing Services"
25454 #: guix-git/doc/guix.texi:14919
25455 msgid "File-sharing services."
25458 #. type: Plain text
25459 #: guix-git/doc/guix.texi:14927
25460 msgid "The @code{(gnu services base)} module provides definitions for the basic services that one expects from the system. The services exported by this module are listed below."
25464 #: guix-git/doc/guix.texi:14928
25466 msgid "{Scheme Variable} %base-services"
25470 #: guix-git/doc/guix.texi:14934
25471 msgid "This variable contains a list of basic services (@pxref{Service Types and Services}, for more information on service objects) one would expect from the system: a login service (mingetty) on each tty, syslogd, the libc name service cache daemon (nscd), the udev device manager, and more."
25475 #: guix-git/doc/guix.texi:14939
25476 msgid "This is the default value of the @code{services} field of @code{operating-system} declarations. Usually, when customizing a system, you will want to append services to @code{%base-services}, like this:"
25480 #: guix-git/doc/guix.texi:14944
25483 "(append (list (service avahi-service-type)\n"
25484 " (service openssh-service-type))\n"
25485 " %base-services)\n"
25489 #: guix-git/doc/guix.texi:14947
25491 msgid "{Scheme Variable} special-files-service-type"
25495 #: guix-git/doc/guix.texi:14950
25496 msgid "This is the service that sets up ``special files'' such as @file{/bin/sh}; an instance of it is part of @code{%base-services}."
25500 #: guix-git/doc/guix.texi:14954
25501 msgid "The value associated with @code{special-files-service-type} services must be a list of tuples where the first element is the ``special file'' and the second element is its target. By default it is:"
25505 #: guix-git/doc/guix.texi:14955
25511 #: guix-git/doc/guix.texi:14956
25513 msgid "@file{sh}, in @file{/bin}"
25517 #: guix-git/doc/guix.texi:14959
25519 msgid "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\")))\n"
25523 #: guix-git/doc/guix.texi:14961
25525 msgid "/usr/bin/env"
25529 #: guix-git/doc/guix.texi:14962
25531 msgid "@file{env}, in @file{/usr/bin}"
25535 #: guix-git/doc/guix.texi:14965
25536 msgid "If you want to add, say, @code{/usr/bin/env} to your system, you can change it to:"
25540 #: guix-git/doc/guix.texi:14969
25543 "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n"
25544 " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\")))\n"
25548 #: guix-git/doc/guix.texi:14976
25549 msgid "Since this is part of @code{%base-services}, you can use @code{modify-services} to customize the set of special files (@pxref{Service Reference, @code{modify-services}}). But the simple way to add a special file is @i{via} the @code{extra-special-file} procedure (see below)."
25553 #: guix-git/doc/guix.texi:14978
25555 msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}"
25559 #: guix-git/doc/guix.texi:14980
25560 msgid "Use @var{target} as the ``special file'' @var{file}."
25564 #: guix-git/doc/guix.texi:14984
25565 msgid "For example, adding the following lines to the @code{services} field of your operating system declaration leads to a @file{/usr/bin/env} symlink:"
25569 #: guix-git/doc/guix.texi:14988
25572 "(extra-special-file \"/usr/bin/env\"\n"
25573 " (file-append coreutils \"/bin/env\"))\n"
25577 #: guix-git/doc/guix.texi:14991
25579 msgid "{Scheme Procedure} host-name-service @var{name}"
25583 #: guix-git/doc/guix.texi:14993
25584 msgid "Return a service that sets the host name to @var{name}."
25588 #: guix-git/doc/guix.texi:14995
25590 msgid "{Scheme Variable} console-font-service-type"
25594 #: guix-git/doc/guix.texi:15000
25595 msgid "Install the given fonts on the specified ttys (fonts are per virtual console on the kernel Linux). The value of this service is a list of tty/font pairs. The font can be the name of a font provided by the @code{kbd} package or any valid argument to @command{setfont}, as in this example:"
25599 #: guix-git/doc/guix.texi:15009
25602 "`((\"tty1\" . \"LatGrkCyr-8x16\")\n"
25603 " (\"tty2\" . ,(file-append\n"
25605 " \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
25606 " (\"tty3\" . ,(file-append\n"
25608 " \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
25612 #: guix-git/doc/guix.texi:15012
25614 msgid "{Scheme Procedure} login-service @var{config}"
25618 #: guix-git/doc/guix.texi:15016
25619 msgid "Return a service to run login according to @var{config}, a @code{<login-configuration>} object, which specifies the message of the day, among other things."
25623 #: guix-git/doc/guix.texi:15018
25625 msgid "{Data Type} login-configuration"
25629 #: guix-git/doc/guix.texi:15020
25630 msgid "This is the data type representing the configuration of login."
25634 #: guix-git/doc/guix.texi:15023
25640 #: guix-git/doc/guix.texi:15024
25642 msgid "message of the day"
25646 #: guix-git/doc/guix.texi:15026
25647 msgid "A file-like object containing the ``message of the day''."
25651 #: guix-git/doc/guix.texi:15027 guix-git/doc/guix.texi:17908
25653 msgid "@code{allow-empty-passwords?} (default: @code{#t})"
25657 #: guix-git/doc/guix.texi:15030
25658 msgid "Allow empty passwords by default so that first-time users can log in when the 'root' account has just been created."
25662 #: guix-git/doc/guix.texi:15034
25664 msgid "{Scheme Procedure} mingetty-service @var{config}"
25668 #: guix-git/doc/guix.texi:15038
25669 msgid "Return a service to run mingetty according to @var{config}, a @code{<mingetty-configuration>} object, which specifies the tty to run, among other things."
25673 #: guix-git/doc/guix.texi:15040
25675 msgid "{Data Type} mingetty-configuration"
25679 #: guix-git/doc/guix.texi:15043
25680 msgid "This is the data type representing the configuration of Mingetty, which provides the default implementation of virtual console log-in."
25684 #: guix-git/doc/guix.texi:15046 guix-git/doc/guix.texi:15085
25685 #: guix-git/doc/guix.texi:31537
25691 #: guix-git/doc/guix.texi:15048
25692 msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}."
25696 #: guix-git/doc/guix.texi:15049 guix-git/doc/guix.texi:15114
25697 #: guix-git/doc/guix.texi:15273
25699 msgid "@code{auto-login} (default: @code{#f})"
25703 #: guix-git/doc/guix.texi:15053
25704 msgid "When true, this field must be a string denoting the user name under which the system automatically logs in. When it is @code{#f}, a user name and password must be entered to log in."
25708 #: guix-git/doc/guix.texi:15054
25710 msgid "@code{login-program} (default: @code{#f})"
25714 #: guix-git/doc/guix.texi:15058
25715 msgid "This must be either @code{#f}, in which case the default log-in program is used (@command{login} from the Shadow tool suite), or a gexp denoting the name of the log-in program."
25719 #: guix-git/doc/guix.texi:15059
25721 msgid "@code{login-pause?} (default: @code{#f})"
25725 #: guix-git/doc/guix.texi:15062
25726 msgid "When set to @code{#t} in conjunction with @var{auto-login}, the user will have to press a key before the log-in shell is launched."
25730 #: guix-git/doc/guix.texi:15063
25732 msgid "@code{clear-on-logout?} (default: @code{#t})"
25736 #: guix-git/doc/guix.texi:15065
25737 msgid "When set to @code{#t}, the screen will be cleared after logout."
25741 #: guix-git/doc/guix.texi:15066
25743 msgid "@code{mingetty} (default: @var{mingetty})"
25747 #: guix-git/doc/guix.texi:15068
25748 msgid "The Mingetty package to use."
25752 #: guix-git/doc/guix.texi:15072
25754 msgid "{Scheme Procedure} agetty-service @var{config}"
25758 #: guix-git/doc/guix.texi:15076
25759 msgid "Return a service to run agetty according to @var{config}, an @code{<agetty-configuration>} object, which specifies the tty to run, among other things."
25763 #: guix-git/doc/guix.texi:15078
25765 msgid "{Data Type} agetty-configuration"
25769 #: guix-git/doc/guix.texi:15082
25770 msgid "This is the data type representing the configuration of agetty, which implements virtual and serial console log-in. See the @code{agetty(8)} man page for more information."
25774 #: guix-git/doc/guix.texi:15089
25775 msgid "The name of the console this agetty runs on, as a string---e.g., @code{\"ttyS0\"}. This argument is optional, it will default to a reasonable default serial port used by the kernel Linux."
25779 #: guix-git/doc/guix.texi:15093
25780 msgid "For this, if there is a value for an option @code{agetty.tty} in the kernel command line, agetty will extract the device name of the serial port from it and use that."
25784 #: guix-git/doc/guix.texi:15097
25785 msgid "If not and if there is a value for an option @code{console} with a tty in the Linux command line, agetty will extract the device name of the serial port from it and use that."
25789 #: guix-git/doc/guix.texi:15101
25790 msgid "In both cases, agetty will leave the other serial device settings (baud rate etc.)@: alone---in the hope that Linux pinned them to the correct values."
25794 #: guix-git/doc/guix.texi:15102 guix-git/doc/guix.texi:31698
25796 msgid "@code{baud-rate} (default: @code{#f})"
25800 #: guix-git/doc/guix.texi:15105
25801 msgid "A string containing a comma-separated list of one or more baud rates, in descending order."
25805 #: guix-git/doc/guix.texi:15106
25807 msgid "@code{term} (default: @code{#f})"
25811 #: guix-git/doc/guix.texi:15109
25812 msgid "A string containing the value used for the @env{TERM} environment variable."
25816 #: guix-git/doc/guix.texi:15110
25818 msgid "@code{eight-bits?} (default: @code{#f})"
25822 #: guix-git/doc/guix.texi:15113
25823 msgid "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection is disabled."
25827 #: guix-git/doc/guix.texi:15117 guix-git/doc/guix.texi:15276
25828 msgid "When passed a login name, as a string, the specified user will be logged in automatically without prompting for their login name or password."
25832 #: guix-git/doc/guix.texi:15118
25834 msgid "@code{no-reset?} (default: @code{#f})"
25838 #: guix-git/doc/guix.texi:15120
25839 msgid "When @code{#t}, don't reset terminal cflags (control modes)."
25843 #: guix-git/doc/guix.texi:15121
25845 msgid "@code{host} (default: @code{#f})"
25849 #: guix-git/doc/guix.texi:15124
25850 msgid "This accepts a string containing the ``login_host'', which will be written into the @file{/var/run/utmpx} file."
25854 #: guix-git/doc/guix.texi:15125
25856 msgid "@code{remote?} (default: @code{#f})"
25860 #: guix-git/doc/guix.texi:15129
25861 msgid "When set to @code{#t} in conjunction with @var{host}, this will add an @code{-r} fakehost option to the command line of the login program specified in @var{login-program}."
25865 #: guix-git/doc/guix.texi:15130
25867 msgid "@code{flow-control?} (default: @code{#f})"
25871 #: guix-git/doc/guix.texi:15132
25872 msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control."
25876 #: guix-git/doc/guix.texi:15133
25878 msgid "@code{no-issue?} (default: @code{#f})"
25882 #: guix-git/doc/guix.texi:15136
25883 msgid "When set to @code{#t}, the contents of the @file{/etc/issue} file will not be displayed before presenting the login prompt."
25887 #: guix-git/doc/guix.texi:15137
25889 msgid "@code{init-string} (default: @code{#f})"
25893 #: guix-git/doc/guix.texi:15140
25894 msgid "This accepts a string that will be sent to the tty or modem before sending anything else. It can be used to initialize a modem."
25898 #: guix-git/doc/guix.texi:15141
25900 msgid "@code{no-clear?} (default: @code{#f})"
25904 #: guix-git/doc/guix.texi:15144
25905 msgid "When set to @code{#t}, agetty will not clear the screen before showing the login prompt."
25909 #: guix-git/doc/guix.texi:15145
25911 msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))"
25915 #: guix-git/doc/guix.texi:15149
25916 msgid "This must be either a gexp denoting the name of a log-in program, or unset, in which case the default value is the @command{login} from the Shadow tool suite."
25920 #: guix-git/doc/guix.texi:15150
25922 msgid "@code{local-line} (default: @code{#f})"
25926 #: guix-git/doc/guix.texi:15154
25927 msgid "Control the CLOCAL line flag. This accepts one of three symbols as arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, the default value chosen by agetty is @code{'auto}."
25931 #: guix-git/doc/guix.texi:15155
25933 msgid "@code{extract-baud?} (default: @code{#f})"
25937 #: guix-git/doc/guix.texi:15158
25938 msgid "When set to @code{#t}, instruct agetty to try to extract the baud rate from the status messages produced by certain types of modems."
25942 #: guix-git/doc/guix.texi:15159
25944 msgid "@code{skip-login?} (default: @code{#f})"
25948 #: guix-git/doc/guix.texi:15163
25949 msgid "When set to @code{#t}, do not prompt the user for a login name. This can be used with @var{login-program} field to use non-standard login systems."
25953 #: guix-git/doc/guix.texi:15164
25955 msgid "@code{no-newline?} (default: @code{#f})"
25959 #: guix-git/doc/guix.texi:15167
25960 msgid "When set to @code{#t}, do not print a newline before printing the @file{/etc/issue} file."
25964 #: guix-git/doc/guix.texi:15169
25966 msgid "@code{login-options} (default: @code{#f})"
25970 #: guix-git/doc/guix.texi:15174
25971 msgid "This option accepts a string containing options that are passed to the login program. When used with the @var{login-program}, be aware that a malicious user could try to enter a login name containing embedded options that could be parsed by the login program."
25975 #: guix-git/doc/guix.texi:15175
25977 msgid "@code{login-pause} (default: @code{#f})"
25981 #: guix-git/doc/guix.texi:15179
25982 msgid "When set to @code{#t}, wait for any key before showing the login prompt. This can be used in conjunction with @var{auto-login} to save memory by lazily spawning shells."
25986 #: guix-git/doc/guix.texi:15180
25988 msgid "@code{chroot} (default: @code{#f})"
25992 #: guix-git/doc/guix.texi:15183
25993 msgid "Change root to the specified directory. This option accepts a directory path as a string."
25997 #: guix-git/doc/guix.texi:15184
25999 msgid "@code{hangup?} (default: @code{#f})"
26003 #: guix-git/doc/guix.texi:15187
26004 msgid "Use the Linux system call @code{vhangup} to do a virtual hangup of the specified terminal."
26008 #: guix-git/doc/guix.texi:15188
26010 msgid "@code{keep-baud?} (default: @code{#f})"
26014 #: guix-git/doc/guix.texi:15192
26015 msgid "When set to @code{#t}, try to keep the existing baud rate. The baud rates from @var{baud-rate} are used when agetty receives a @key{BREAK} character."
26019 #: guix-git/doc/guix.texi:15193
26021 msgid "@code{timeout} (default: @code{#f})"
26025 #: guix-git/doc/guix.texi:15196
26026 msgid "When set to an integer value, terminate if no user name could be read within @var{timeout} seconds."
26030 #: guix-git/doc/guix.texi:15197
26032 msgid "@code{detect-case?} (default: @code{#f})"
26036 #: guix-git/doc/guix.texi:15203
26037 msgid "When set to @code{#t}, turn on support for detecting an uppercase-only terminal. This setting will detect a login name containing only uppercase letters as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions. Note that this will not support Unicode characters."
26041 #: guix-git/doc/guix.texi:15204
26043 msgid "@code{wait-cr?} (default: @code{#f})"
26047 #: guix-git/doc/guix.texi:15209
26048 msgid "When set to @code{#t}, wait for the user or modem to send a carriage-return or linefeed character before displaying @file{/etc/issue} or login prompt. This is typically used with the @var{init-string} option."
26052 #: guix-git/doc/guix.texi:15210
26054 msgid "@code{no-hints?} (default: @code{#f})"
26058 #: guix-git/doc/guix.texi:15213
26059 msgid "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks."
26063 #: guix-git/doc/guix.texi:15214
26065 msgid "@code{no-hostname?} (default: @code{#f})"
26069 #: guix-git/doc/guix.texi:15217
26070 msgid "By default, the hostname is printed. When this option is set to @code{#t}, no hostname will be shown at all."
26074 #: guix-git/doc/guix.texi:15218
26076 msgid "@code{long-hostname?} (default: @code{#f})"
26080 #: guix-git/doc/guix.texi:15222
26081 msgid "By default, the hostname is only printed until the first dot. When this option is set to @code{#t}, the fully qualified hostname by @code{gethostname} or @code{getaddrinfo} is shown."
26085 #: guix-git/doc/guix.texi:15223
26087 msgid "@code{erase-characters} (default: @code{#f})"
26091 #: guix-git/doc/guix.texi:15226
26092 msgid "This option accepts a string of additional characters that should be interpreted as backspace when the user types their login name."
26096 #: guix-git/doc/guix.texi:15227
26098 msgid "@code{kill-characters} (default: @code{#f})"
26102 #: guix-git/doc/guix.texi:15231
26103 msgid "This option accepts a string that should be interpreted to mean ``ignore all previous characters'' (also called a ``kill'' character) when the user types their login name."
26107 #: guix-git/doc/guix.texi:15232
26109 msgid "@code{chdir} (default: @code{#f})"
26113 #: guix-git/doc/guix.texi:15235
26114 msgid "This option accepts, as a string, a directory path that will be changed to before login."
26118 #: guix-git/doc/guix.texi:15236
26120 msgid "@code{delay} (default: @code{#f})"
26124 #: guix-git/doc/guix.texi:15239
26125 msgid "This options accepts, as an integer, the number of seconds to sleep before opening the tty and displaying the login prompt."
26129 #: guix-git/doc/guix.texi:15240
26131 msgid "@code{nice} (default: @code{#f})"
26135 #: guix-git/doc/guix.texi:15243
26136 msgid "This option accepts, as an integer, the nice value with which to run the @command{login} program."
26140 #: guix-git/doc/guix.texi:15244 guix-git/doc/guix.texi:15521
26141 #: guix-git/doc/guix.texi:16383 guix-git/doc/guix.texi:23526
26142 #: guix-git/doc/guix.texi:25002 guix-git/doc/guix.texi:27350
26143 #: guix-git/doc/guix.texi:28137 guix-git/doc/guix.texi:29836
26144 #: guix-git/doc/guix.texi:32028
26146 msgid "@code{extra-options} (default: @code{'()})"
26150 #: guix-git/doc/guix.texi:15247
26151 msgid "This option provides an ``escape hatch'' for the user to provide arbitrary command-line arguments to @command{agetty} as a list of strings."
26155 #: guix-git/doc/guix.texi:15251
26157 msgid "{Scheme Procedure} kmscon-service-type @var{config}"
26161 #: guix-git/doc/guix.texi:15255
26162 msgid "Return a service to run @uref{https://www.freedesktop.org/wiki/Software/kmscon,kmscon} according to @var{config}, a @code{<kmscon-configuration>} object, which specifies the tty to run, among other things."
26166 #: guix-git/doc/guix.texi:15257
26168 msgid "{Data Type} kmscon-configuration"
26172 #: guix-git/doc/guix.texi:15260
26173 msgid "This is the data type representing the configuration of Kmscon, which implements virtual console log-in."
26177 #: guix-git/doc/guix.texi:15263
26179 msgid "virtual-terminal"
26183 #: guix-git/doc/guix.texi:15265
26184 msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}."
26188 #: guix-git/doc/guix.texi:15266
26190 msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})"
26194 #: guix-git/doc/guix.texi:15269
26195 msgid "A gexp denoting the name of the log-in program. The default log-in program is @command{login} from the Shadow tool suite."
26199 #: guix-git/doc/guix.texi:15270
26201 msgid "@code{login-arguments} (default: @code{'(\"-p\")})"
26205 #: guix-git/doc/guix.texi:15272
26206 msgid "A list of arguments to pass to @command{login}."
26210 #: guix-git/doc/guix.texi:15277
26212 msgid "@code{hardware-acceleration?} (default: #f)"
26216 #: guix-git/doc/guix.texi:15279
26217 msgid "Whether to use hardware acceleration."
26221 #: guix-git/doc/guix.texi:15280
26223 msgid "@code{font-engine} (default: @code{\"pango\"})"
26227 #: guix-git/doc/guix.texi:15282
26228 msgid "Font engine used in Kmscon."
26232 #: guix-git/doc/guix.texi:15283
26234 msgid "@code{font-size} (default: @code{12})"
26238 #: guix-git/doc/guix.texi:15285
26239 msgid "Font size used in Kmscon."
26243 #: guix-git/doc/guix.texi:15286
26245 msgid "@code{kmscon} (default: @var{kmscon})"
26249 #: guix-git/doc/guix.texi:15288
26250 msgid "The Kmscon package to use."
26254 #: guix-git/doc/guix.texi:15292
26256 msgid "name service cache daemon"
26260 #: guix-git/doc/guix.texi:15293
26266 #: guix-git/doc/guix.texi:15294
26268 msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @"
26272 #: guix-git/doc/guix.texi:15299
26273 msgid "[#:name-services '()] Return a service that runs the libc name service cache daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} object. @xref{Name Service Switch}, for an example."
26277 #: guix-git/doc/guix.texi:15301
26278 msgid "For convenience, the Shepherd service for nscd provides the following actions:"
26282 #: guix-git/doc/guix.texi:15303
26288 #: guix-git/doc/guix.texi:15304
26290 msgid "cache invalidation, nscd"
26294 #: guix-git/doc/guix.texi:15305
26296 msgid "nscd, cache invalidation"
26300 #: guix-git/doc/guix.texi:15307
26301 msgid "This invalidate the given cache. For instance, running:"
26305 #: guix-git/doc/guix.texi:15310
26307 msgid "herd invalidate nscd hosts\n"
26311 #: guix-git/doc/guix.texi:15314
26312 msgid "invalidates the host name lookup cache of nscd."
26316 #: guix-git/doc/guix.texi:15315
26322 #: guix-git/doc/guix.texi:15318
26323 msgid "Running @command{herd statistics nscd} displays information about nscd usage and caches."
26327 #: guix-git/doc/guix.texi:15322
26329 msgid "{Scheme Variable} %nscd-default-configuration"
26333 #: guix-git/doc/guix.texi:15326
26334 msgid "This is the default @code{<nscd-configuration>} value (see below) used by @code{nscd-service}. It uses the caches defined by @code{%nscd-default-caches}; see below."
26338 #: guix-git/doc/guix.texi:15328
26340 msgid "{Data Type} nscd-configuration"
26344 #: guix-git/doc/guix.texi:15331
26345 msgid "This is the data type representing the name service cache daemon (nscd) configuration."
26349 #: guix-git/doc/guix.texi:15334
26351 msgid "@code{name-services} (default: @code{'()})"
26355 #: guix-git/doc/guix.texi:15337
26356 msgid "List of packages denoting @dfn{name services} that must be visible to the nscd---e.g., @code{(list @var{nss-mdns})}."
26360 #: guix-git/doc/guix.texi:15338
26362 msgid "@code{glibc} (default: @var{glibc})"
26366 #: guix-git/doc/guix.texi:15341
26367 msgid "Package object denoting the GNU C Library providing the @command{nscd} command."
26371 #: guix-git/doc/guix.texi:15342
26373 msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})"
26377 #: guix-git/doc/guix.texi:15345
26378 msgid "Name of the nscd log file. This is where debugging output goes when @code{debug-level} is strictly positive."
26382 #: guix-git/doc/guix.texi:15346
26384 msgid "@code{debug-level} (default: @code{0})"
26388 #: guix-git/doc/guix.texi:15349
26389 msgid "Integer denoting the debugging levels. Higher numbers mean that more debugging output is logged."
26393 #: guix-git/doc/guix.texi:15350
26395 msgid "@code{caches} (default: @code{%nscd-default-caches})"
26399 #: guix-git/doc/guix.texi:15353
26400 msgid "List of @code{<nscd-cache>} objects denoting things to be cached; see below."
26404 #: guix-git/doc/guix.texi:15357
26406 msgid "{Data Type} nscd-cache"
26410 #: guix-git/doc/guix.texi:15359
26411 msgid "Data type representing a cache database of nscd and its parameters."
26415 #: guix-git/doc/guix.texi:15362 guix-git/doc/guix.texi:19690
26421 #: guix-git/doc/guix.texi:15367
26422 msgid "This is a symbol representing the name of the database to be cached. Valid values are @code{passwd}, @code{group}, @code{hosts}, and @code{services}, which designate the corresponding NSS database (@pxref{NSS Basics,,, libc, The GNU C Library Reference Manual})."
26426 #: guix-git/doc/guix.texi:15368
26428 msgid "positive-time-to-live"
26432 #: guix-git/doc/guix.texi:15369
26434 msgid "@code{negative-time-to-live} (default: @code{20})"
26438 #: guix-git/doc/guix.texi:15372
26439 msgid "A number representing the number of seconds during which a positive or negative lookup result remains in cache."
26443 #: guix-git/doc/guix.texi:15373
26445 msgid "@code{check-files?} (default: @code{#t})"
26449 #: guix-git/doc/guix.texi:15376
26450 msgid "Whether to check for updates of the files corresponding to @var{database}."
26454 #: guix-git/doc/guix.texi:15380
26455 msgid "For instance, when @var{database} is @code{hosts}, setting this flag instructs nscd to check for updates in @file{/etc/hosts} and to take them into account."
26459 #: guix-git/doc/guix.texi:15381
26461 msgid "@code{persistent?} (default: @code{#t})"
26465 #: guix-git/doc/guix.texi:15383
26466 msgid "Whether the cache should be stored persistently on disk."
26470 #: guix-git/doc/guix.texi:15384
26472 msgid "@code{shared?} (default: @code{#t})"
26476 #: guix-git/doc/guix.texi:15386
26477 msgid "Whether the cache should be shared among users."
26481 #: guix-git/doc/guix.texi:15387
26483 msgid "@code{max-database-size} (default: 32@tie{}MiB)"
26487 #: guix-git/doc/guix.texi:15389
26488 msgid "Maximum size in bytes of the database cache."
26492 #: guix-git/doc/guix.texi:15396
26494 msgid "{Scheme Variable} %nscd-default-caches"
26498 #: guix-git/doc/guix.texi:15399
26499 msgid "List of @code{<nscd-cache>} objects used by default by @code{nscd-configuration} (see above)."
26503 #: guix-git/doc/guix.texi:15405
26504 msgid "It enables persistent and aggressive caching of service and host name lookups. The latter provides better host name lookup performance, resilience in the face of unreliable name servers, and also better privacy---often the result of host name lookups is in local cache, so external name servers do not even need to be queried."
26507 #. type: anchor{#1}
26508 #: guix-git/doc/guix.texi:15408
26509 msgid "syslog-configuration-type"
26513 #: guix-git/doc/guix.texi:15408 guix-git/doc/guix.texi:15424
26519 #: guix-git/doc/guix.texi:15409 guix-git/doc/guix.texi:15983
26525 #: guix-git/doc/guix.texi:15410
26527 msgid "{Data Type} syslog-configuration"
26531 #: guix-git/doc/guix.texi:15412
26532 msgid "This data type represents the configuration of the syslog daemon."
26536 #: guix-git/doc/guix.texi:15414
26538 msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})"
26542 #: guix-git/doc/guix.texi:15416
26543 msgid "The syslog daemon to use."
26547 #: guix-git/doc/guix.texi:15417
26549 msgid "@code{config-file} (default: @code{%default-syslog.conf})"
26553 #: guix-git/doc/guix.texi:15419
26554 msgid "The syslog configuration file to use."
26557 #. type: anchor{#1}
26558 #: guix-git/doc/guix.texi:15424
26559 msgid "syslog-service"
26563 #: guix-git/doc/guix.texi:15425
26565 msgid "{Scheme Procedure} syslog-service @var{config}"
26569 #: guix-git/doc/guix.texi:15427
26570 msgid "Return a service that runs a syslog daemon according to @var{config}."
26574 #: guix-git/doc/guix.texi:15430
26575 msgid "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax."
26579 #: guix-git/doc/guix.texi:15432
26581 msgid "{Scheme Variable} guix-service-type"
26585 #: guix-git/doc/guix.texi:15436
26586 msgid "This is the type of the service that runs the build daemon, @command{guix-daemon} (@pxref{Invoking guix-daemon}). Its value must be a @code{guix-configuration} record as described below."
26589 #. type: anchor{#1}
26590 #: guix-git/doc/guix.texi:15439
26591 msgid "guix-configuration-type"
26595 #: guix-git/doc/guix.texi:15439
26597 msgid "{Data Type} guix-configuration"
26601 #: guix-git/doc/guix.texi:15442
26602 msgid "This data type represents the configuration of the Guix build daemon. @xref{Invoking guix-daemon}, for more information."
26606 #: guix-git/doc/guix.texi:15444
26608 msgid "@code{guix} (default: @var{guix})"
26612 #: guix-git/doc/guix.texi:15446 guix-git/doc/guix.texi:15720
26613 msgid "The Guix package to use."
26617 #: guix-git/doc/guix.texi:15447
26619 msgid "@code{build-group} (default: @code{\"guixbuild\"})"
26623 #: guix-git/doc/guix.texi:15449
26624 msgid "Name of the group for build user accounts."
26628 #: guix-git/doc/guix.texi:15450
26630 msgid "@code{build-accounts} (default: @code{10})"
26634 #: guix-git/doc/guix.texi:15452
26635 msgid "Number of build user accounts to create."
26639 #: guix-git/doc/guix.texi:15453
26641 msgid "@code{authorize-key?} (default: @code{#t})"
26645 #: guix-git/doc/guix.texi:15458
26646 msgid "Whether to authorize the substitute keys listed in @code{authorized-keys}---by default that of @code{@value{SUBSTITUTE-SERVER}} (@pxref{Substitutes})."
26650 #: guix-git/doc/guix.texi:15464
26651 msgid "When @code{authorize-key?} is true, @file{/etc/guix/acl} cannot be changed by invoking @command{guix archive --authorize}. You must instead adjust @code{guix-configuration} as you wish and reconfigure the system. This ensures that your operating system configuration file is self-contained."
26655 #: guix-git/doc/guix.texi:15471
26656 msgid "When booting or reconfiguring to a system where @code{authorize-key?} is true, the existing @file{/etc/guix/acl} file is backed up as @file{/etc/guix/acl.bak} if it was determined to be a manually modified file. This is to facilitate migration from earlier versions, which allowed for in-place modifications to @file{/etc/guix/acl}."
26660 #: guix-git/doc/guix.texi:15473
26662 msgid "%default-authorized-guix-keys"
26666 #: guix-git/doc/guix.texi:15474
26668 msgid "@code{authorized-keys} (default: @code{%default-authorized-guix-keys})"
26672 #: guix-git/doc/guix.texi:15479
26673 msgid "The list of authorized key files for archive imports, as a list of string-valued gexps (@pxref{Invoking guix archive}). By default, it contains that of @code{@value{SUBSTITUTE-SERVER}} (@pxref{Substitutes}). See @code{substitute-urls} below for an example on how to change it."
26677 #: guix-git/doc/guix.texi:15480
26679 msgid "@code{use-substitutes?} (default: @code{#t})"
26683 #: guix-git/doc/guix.texi:15482
26684 msgid "Whether to use substitutes."
26688 #: guix-git/doc/guix.texi:15483
26690 msgid "@code{substitute-urls} (default: @code{%default-substitute-urls})"
26694 #: guix-git/doc/guix.texi:15485
26695 msgid "The list of URLs where to look for substitutes by default."
26699 #: guix-git/doc/guix.texi:15492
26700 msgid "Suppose you would like to fetch substitutes from @code{guix.example.org} in addition to @code{@value{SUBSTITUTE-SERVER}}. You will need to do two things: (1) add @code{guix.example.org} to @code{substitute-urls}, and (2) authorize its signing key, having done appropriate checks (@pxref{Substitute Server Authorization}). The configuration below does exactly that:"
26704 #: guix-git/doc/guix.texi:15501
26707 "(guix-configuration\n"
26708 " (substitute-urls\n"
26709 " (append (list \"https://guix.example.org\")\n"
26710 " %default-substitute-urls))\n"
26711 " (authorized-keys\n"
26712 " (append (list (local-file \"./guix.example.org-key.pub\"))\n"
26713 " %default-authorized-guix-keys)))\n"
26717 #: guix-git/doc/guix.texi:15506
26718 msgid "This example assumes that the file @file{./guix.example.org-key.pub} contains the public key that @code{guix.example.org} uses to sign substitutes."
26722 #: guix-git/doc/guix.texi:15507
26724 msgid "@code{max-silent-time} (default: @code{0})"
26728 #: guix-git/doc/guix.texi:15508
26730 msgid "@code{timeout} (default: @code{0})"
26734 #: guix-git/doc/guix.texi:15512
26735 msgid "The number of seconds of silence and the number of seconds of activity, respectively, after which a build process times out. A value of zero disables the timeout."
26739 #: guix-git/doc/guix.texi:15513
26741 msgid "@code{log-compression} (default: @code{'bzip2})"
26745 #: guix-git/doc/guix.texi:15516
26746 msgid "The type of compression used for build logs---one of @code{gzip}, @code{bzip2}, or @code{none}."
26750 #: guix-git/doc/guix.texi:15517
26752 msgid "@code{discover?} (default: @code{#f})"
26756 #: guix-git/doc/guix.texi:15523
26757 msgid "List of extra command-line options for @command{guix-daemon}."
26761 #: guix-git/doc/guix.texi:15524
26763 msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})"
26767 #: guix-git/doc/guix.texi:15527
26768 msgid "File where @command{guix-daemon}'s standard output and standard error are written."
26772 #: guix-git/doc/guix.texi:15528
26774 msgid "HTTP proxy, for @code{guix-daemon}"
26778 #: guix-git/doc/guix.texi:15529
26780 msgid "proxy, for @code{guix-daemon} HTTP access"
26784 #: guix-git/doc/guix.texi:15530
26786 msgid "@code{http-proxy} (default: @code{#f})"
26790 #: guix-git/doc/guix.texi:15533
26791 msgid "The URL of the HTTP and HTTPS proxy used for downloading fixed-output derivations and substitutes."
26795 #: guix-git/doc/guix.texi:15536
26796 msgid "It is also possible to change the daemon's proxy at run time through the @code{set-http-proxy} action, which restarts it:"
26800 #: guix-git/doc/guix.texi:15539
26802 msgid "herd set-http-proxy guix-daemon http://localhost:8118\n"
26806 #: guix-git/doc/guix.texi:15542
26807 msgid "To clear the proxy settings, run:"
26811 #: guix-git/doc/guix.texi:15545
26813 msgid "herd set-http-proxy guix-daemon\n"
26817 #: guix-git/doc/guix.texi:15547
26819 msgid "@code{tmpdir} (default: @code{#f})"
26823 #: guix-git/doc/guix.texi:15549
26824 msgid "A directory path where the @command{guix-daemon} will perform builds."
26828 #: guix-git/doc/guix.texi:15553
26830 msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]"
26834 #: guix-git/doc/guix.texi:15559
26835 msgid "Run @var{udev}, which populates the @file{/dev} directory dynamically. udev rules can be provided as a list of files through the @var{rules} variable. The procedures @code{udev-rule}, @code{udev-rules-service} and @code{file->udev-rule} from @code{(gnu services base)} simplify the creation of such rule files."
26839 #: guix-git/doc/guix.texi:15562
26840 msgid "The @command{herd rules udev} command, as root, returns the name of the directory containing all the active udev rules."
26844 #: guix-git/doc/guix.texi:15564
26846 msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]"
26850 #: guix-git/doc/guix.texi:15567
26851 msgid "Return a udev-rule file named @var{file-name} containing the rules defined by the @var{contents} literal."
26855 #: guix-git/doc/guix.texi:15571
26856 msgid "In the following example, a rule for a USB device is defined to be stored in the file @file{90-usb-thing.rules}. The rule runs a script upon detecting a USB device with a given product identifier."
26860 #: guix-git/doc/guix.texi:15579
26863 "(define %example-udev-rule\n"
26865 " \"90-usb-thing.rules\"\n"
26866 " (string-append \"ACTION==\\\"add\\\", SUBSYSTEM==\\\"usb\\\", \"\n"
26867 " \"ATTR@{product@}==\\\"Example\\\", \"\n"
26868 " \"RUN+=\\\"/path/to/script\\\"\")))\n"
26872 #: guix-git/doc/guix.texi:15582
26874 msgid "{Scheme Procedure} udev-rules-service [@var{name} @var{rules}] @"
26878 #: guix-git/doc/guix.texi:15589
26879 msgid "[#:groups @var{groups}] Return a service that extends @code{udev-service-type } with @var{rules} and @code{account-service-type} with @var{groups} as system groups. This works by creating a singleton service type @code{@var{name}-udev-rules}, of which the returned service is an instance."
26883 #: guix-git/doc/guix.texi:15592
26884 msgid "Here we show how it can be used to extend @code{udev-service-type} with the previously defined rule @code{%example-udev-rule}."
26888 #: guix-git/doc/guix.texi:15599
26891 "(operating-system\n"
26894 " (cons (udev-rules-service 'usb-thing %example-udev-rule)\n"
26895 " %desktop-services)))\n"
26899 #: guix-git/doc/guix.texi:15602
26901 msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]"
26905 #: guix-git/doc/guix.texi:15605
26906 msgid "Return a udev file named @var{file-name} containing the rules defined within @var{file}, a file-like object."
26910 #: guix-git/doc/guix.texi:15607
26911 msgid "The following example showcases how we can use an existing rule file."
26915 #: guix-git/doc/guix.texi:15612
26918 "(use-modules (guix download) ;for url-fetch\n"
26919 " (guix packages) ;for origin\n"
26925 #: guix-git/doc/guix.texi:15623
26928 "(define %android-udev-rules\n"
26929 " (file->udev-rule\n"
26930 " \"51-android-udev.rules\"\n"
26931 " (let ((version \"20170910\"))\n"
26933 " (method url-fetch)\n"
26934 " (uri (string-append \"https://raw.githubusercontent.com/M0Rf30/\"\n"
26935 " \"android-udev-rules/\" version \"/51-android.rules\"))\n"
26937 " (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n"
26940 #. type: Plain text
26941 #: guix-git/doc/guix.texi:15632
26942 msgid "Additionally, Guix package definitions can be included in @var{rules} in order to extend the udev rules with the definitions found under their @file{lib/udev/rules.d} sub-directory. In lieu of the previous @var{file->udev-rule} example, we could have used the @var{android-udev-rules} package which exists in Guix in the @code{(gnu packages android)} module."
26945 #. type: Plain text
26946 #: guix-git/doc/guix.texi:15641
26947 msgid "The following example shows how to use the @var{android-udev-rules} package so that the Android tool @command{adb} can detect devices without root privileges. It also details how to create the @code{adbusers} group, which is required for the proper functioning of the rules defined within the @code{android-udev-rules} package. To create such a group, we must define it both as part of the @code{supplementary-groups} of our @code{user-account} declaration, as well as in the @var{groups} of the @code{udev-rules-service} procedure."
26951 #: guix-git/doc/guix.texi:15646
26954 "(use-modules (gnu packages android) ;for android-udev-rules\n"
26955 " (gnu system shadow) ;for user-group\n"
26961 #: guix-git/doc/guix.texi:15659
26964 "(operating-system\n"
26966 " (users (cons (user-account\n"
26968 " (supplementary-groups\n"
26969 " '(\"adbusers\" ;for adb\n"
26970 " \"wheel\" \"netdev\" \"audio\" \"video\")))))\n"
26973 " (cons (udev-rules-service 'android android-udev-rules\n"
26974 " #:groups '(\"adbusers\"))\n"
26975 " %desktop-services)))\n"
26979 #: guix-git/doc/guix.texi:15661
26981 msgid "{Scheme Variable} urandom-seed-service-type"
26985 #: guix-git/doc/guix.texi:15666
26986 msgid "Save some entropy in @code{%random-seed-file} to seed @file{/dev/urandom} when rebooting. It also tries to seed @file{/dev/urandom} from @file{/dev/hwrng} while booting, if @file{/dev/hwrng} exists and is readable."
26990 #: guix-git/doc/guix.texi:15668
26992 msgid "{Scheme Variable} %random-seed-file"
26996 #: guix-git/doc/guix.texi:15672
26997 msgid "This is the name of the file where some random bytes are saved by @var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. It defaults to @file{/var/lib/random-seed}."
27001 #: guix-git/doc/guix.texi:15674
27007 #: guix-git/doc/guix.texi:15675
27013 #: guix-git/doc/guix.texi:15676
27015 msgid "{Scheme Variable} gpm-service-type"
27019 #: guix-git/doc/guix.texi:15681
27020 msgid "This is the type of the service that runs GPM, the @dfn{general-purpose mouse daemon}, which provides mouse support to the Linux console. GPM allows users to use the mouse in the console, notably to select, copy, and paste text."
27024 #: guix-git/doc/guix.texi:15684
27025 msgid "The value for services of this type must be a @code{gpm-configuration} (see below). This service is not part of @code{%base-services}."
27029 #: guix-git/doc/guix.texi:15686
27031 msgid "{Data Type} gpm-configuration"
27035 #: guix-git/doc/guix.texi:15688
27036 msgid "Data type representing the configuration of GPM."
27040 #: guix-git/doc/guix.texi:15690
27042 msgid "@code{options} (default: @code{%default-gpm-options})"
27046 #: guix-git/doc/guix.texi:15695
27047 msgid "Command-line options passed to @command{gpm}. The default set of options instruct @command{gpm} to listen to mouse events on @file{/dev/input/mice}. @xref{Command Line,,, gpm, gpm manual}, for more information."
27051 #: guix-git/doc/guix.texi:15696
27053 msgid "@code{gpm} (default: @code{gpm})"
27057 #: guix-git/doc/guix.texi:15698
27058 msgid "The GPM package to use."
27061 #. type: anchor{#1}
27062 #: guix-git/doc/guix.texi:15703
27063 msgid "guix-publish-service-type"
27067 #: guix-git/doc/guix.texi:15703
27069 msgid "{Scheme Variable} guix-publish-service-type"
27073 #: guix-git/doc/guix.texi:15707
27074 msgid "This is the service type for @command{guix publish} (@pxref{Invoking guix publish}). Its value must be a @code{guix-publish-configuration} object, as described below."
27078 #: guix-git/doc/guix.texi:15711
27079 msgid "This assumes that @file{/etc/guix} already contains a signing key pair as created by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). If that is not the case, the service will fail to start."
27083 #: guix-git/doc/guix.texi:15713
27085 msgid "{Data Type} guix-publish-configuration"
27089 #: guix-git/doc/guix.texi:15716
27090 msgid "Data type representing the configuration of the @code{guix publish} service."
27094 #: guix-git/doc/guix.texi:15718
27096 msgid "@code{guix} (default: @code{guix})"
27100 #: guix-git/doc/guix.texi:15721 guix-git/doc/guix.texi:29691
27102 msgid "@code{port} (default: @code{80})"
27106 #: guix-git/doc/guix.texi:15723
27107 msgid "The TCP port to listen for connections."
27111 #: guix-git/doc/guix.texi:15724 guix-git/doc/guix.texi:27330
27113 msgid "@code{host} (default: @code{\"localhost\"})"
27117 #: guix-git/doc/guix.texi:15727
27118 msgid "The host (and thus, network interface) to listen to. Use @code{\"0.0.0.0\"} to listen on all the network interfaces."
27122 #: guix-git/doc/guix.texi:15728
27124 msgid "@code{advertise?} (default: @code{#f})"
27128 #: guix-git/doc/guix.texi:15731
27129 msgid "When true, advertise the service on the local network @i{via} the DNS-SD protocol, using Avahi."
27133 #: guix-git/doc/guix.texi:15735
27134 msgid "This allows neighboring Guix devices with discovery on (see @code{guix-configuration} above) to discover this @command{guix publish} instance and to automatically download substitutes from it."
27138 #: guix-git/doc/guix.texi:15736
27140 msgid "@code{compression} (default: @code{'((\"gzip\" 3) (\"zstd\" 3))})"
27144 #: guix-git/doc/guix.texi:15740
27145 msgid "This is a list of compression method/level tuple used when compressing substitutes. For example, to compress all substitutes with @emph{both} lzip at level 7 and gzip at level 9, write:"
27149 #: guix-git/doc/guix.texi:15743
27151 msgid "'((\"lzip\" 7) (\"gzip\" 9))\n"
27155 #: guix-git/doc/guix.texi:15749
27156 msgid "Level 9 achieves the best compression ratio at the expense of increased CPU usage, whereas level 1 achieves fast compression. @xref{Invoking guix publish}, for more information on the available compression methods and the tradeoffs involved."
27160 #: guix-git/doc/guix.texi:15751
27161 msgid "An empty list disables compression altogether."
27165 #: guix-git/doc/guix.texi:15752
27167 msgid "@code{nar-path} (default: @code{\"nar\"})"
27171 #: guix-git/doc/guix.texi:15755
27172 msgid "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, @option{--nar-path}}, for details."
27176 #: guix-git/doc/guix.texi:15756
27178 msgid "@code{cache} (default: @code{#f})"
27182 #: guix-git/doc/guix.texi:15762
27183 msgid "When it is @code{#f}, disable caching and instead generate archives on demand. Otherwise, this should be the name of a directory---e.g., @code{\"/var/cache/guix/publish\"}---where @command{guix publish} caches archives and meta-data ready to be sent. @xref{Invoking guix publish, @option{--cache}}, for more information on the tradeoffs involved."
27187 #: guix-git/doc/guix.texi:15763
27189 msgid "@code{workers} (default: @code{#f})"
27193 #: guix-git/doc/guix.texi:15767
27194 msgid "When it is an integer, this is the number of worker threads used for caching; when @code{#f}, the number of processors is used. @xref{Invoking guix publish, @option{--workers}}, for more information."
27198 #: guix-git/doc/guix.texi:15768
27200 msgid "@code{cache-bypass-threshold} (default: 10 MiB)"
27204 #: guix-git/doc/guix.texi:15773
27205 msgid "When @code{cache} is true, this is the maximum size in bytes of a store item for which @command{guix publish} may bypass its cache in case of a cache miss. @xref{Invoking guix publish, @option{--cache-bypass-threshold}}, for more information."
27209 #: guix-git/doc/guix.texi:15774
27211 msgid "@code{ttl} (default: @code{#f})"
27215 #: guix-git/doc/guix.texi:15778
27216 msgid "When it is an integer, this denotes the @dfn{time-to-live} in seconds of the published archives. @xref{Invoking guix publish, @option{--ttl}}, for more information."
27219 #. type: anchor{#1}
27220 #: guix-git/doc/guix.texi:15782
27221 msgid "rngd-service"
27225 #: guix-git/doc/guix.texi:15782
27227 msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @"
27231 #: guix-git/doc/guix.texi:15787
27232 msgid "[#:device \"/dev/hwrng\"] Return a service that runs the @command{rngd} program from @var{rng-tools} to add @var{device} to the kernel's entropy pool. The service will fail if @var{device} does not exist."
27235 #. type: anchor{#1}
27236 #: guix-git/doc/guix.texi:15790
27237 msgid "pam-limits-service"
27241 #: guix-git/doc/guix.texi:15790
27243 msgid "session limits"
27247 #: guix-git/doc/guix.texi:15791
27253 #: guix-git/doc/guix.texi:15792
27259 #: guix-git/doc/guix.texi:15793
27265 #: guix-git/doc/guix.texi:15794
27271 #: guix-git/doc/guix.texi:15795
27277 #: guix-git/doc/guix.texi:15796
27279 msgid "open file descriptors"
27283 #: guix-git/doc/guix.texi:15797
27285 msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]"
27289 #: guix-git/doc/guix.texi:15804
27290 msgid "Return a service that installs a configuration file for the @uref{http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html, @code{pam_limits} module}. The procedure optionally takes a list of @code{pam-limits-entry} values, which can be used to specify @code{ulimit} limits and @code{nice} priority limits to user sessions."
27294 #: guix-git/doc/guix.texi:15807
27295 msgid "The following limits definition sets two hard and soft limits for all login sessions of users in the @code{realtime} group:"
27299 #: guix-git/doc/guix.texi:15813
27302 "(pam-limits-service\n"
27304 " (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n"
27305 " (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n"
27309 #: guix-git/doc/guix.texi:15819
27310 msgid "The first entry increases the maximum realtime priority for non-privileged processes; the second entry lifts any restriction of the maximum address space that can be locked in memory. These settings are commonly used for real-time audio systems."
27314 #: guix-git/doc/guix.texi:15822
27315 msgid "Another useful example is raising the maximum number of open file descriptors that can be used:"
27319 #: guix-git/doc/guix.texi:15827
27322 "(pam-limits-service\n"
27324 " (pam-limits-entry \"*\" 'both 'nofile 100000)))\n"
27328 #: guix-git/doc/guix.texi:15835
27329 msgid "In the above example, the asterisk means the limit should apply to any user. It is important to ensure the chosen value doesn't exceed the maximum system value visible in the @file{/proc/sys/fs/file-max} file, else the users would be prevented from login in. For more information about the Pluggable Authentication Module (PAM) limits, refer to the @samp{pam_limits} man page from the @code{linux-pam} package."
27333 #: guix-git/doc/guix.texi:15840
27339 #: guix-git/doc/guix.texi:15841
27345 #: guix-git/doc/guix.texi:15842
27347 msgid "scheduling jobs"
27350 #. type: Plain text
27351 #: guix-git/doc/guix.texi:15849
27352 msgid "The @code{(gnu services mcron)} module provides an interface to GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, mcron, GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional Unix @command{cron} daemon; the main difference is that it is implemented in Guile Scheme, which provides a lot of flexibility when specifying the scheduling of jobs and their actions."
27355 #. type: Plain text
27356 #: guix-git/doc/guix.texi:15857
27357 msgid "The example below defines an operating system that runs the @command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) and the @command{guix gc} commands (@pxref{Invoking guix gc}) daily, as well as the @command{mkid} command on behalf of an unprivileged user (@pxref{mkid invocation,,, idutils, ID Database Utilities}). It uses gexps to introduce job definitions that are passed to mcron (@pxref{G-Expressions})."
27361 #: guix-git/doc/guix.texi:15861
27364 "(use-modules (guix) (gnu) (gnu services mcron))\n"
27365 "(use-package-modules base idutils)\n"
27370 #: guix-git/doc/guix.texi:15870
27373 "(define updatedb-job\n"
27374 " ;; Run 'updatedb' at 3AM every day. Here we write the\n"
27375 " ;; job's action as a Scheme procedure.\n"
27376 " #~(job '(next-hour '(3))\n"
27378 " (execl (string-append #$findutils \"/bin/updatedb\")\n"
27380 " \"--prunepaths=/tmp /var/tmp /gnu/store\"))))\n"
27385 #: guix-git/doc/guix.texi:15876
27388 "(define garbage-collector-job\n"
27389 " ;; Collect garbage 5 minutes after midnight every day.\n"
27390 " ;; The job's action is a shell command.\n"
27391 " #~(job \"5 0 * * *\" ;Vixie cron syntax\n"
27392 " \"guix gc -F 1G\"))\n"
27397 #: guix-git/doc/guix.texi:15883
27400 "(define idutils-job\n"
27401 " ;; Update the index database as user \"charlie\" at 12:15PM\n"
27402 " ;; and 19:15PM. This runs from the user's home directory.\n"
27403 " #~(job '(next-minute-from (next-hour '(12 19)) '(15))\n"
27404 " (string-append #$idutils \"/bin/mkid src\")\n"
27405 " #:user \"charlie\"))\n"
27410 #: guix-git/doc/guix.texi:15886
27413 "(operating-system\n"
27419 #: guix-git/doc/guix.texi:15896
27422 " ;; %BASE-SERVICES already includes an instance of\n"
27423 " ;; 'mcron-service-type', which we extend with additional\n"
27424 " ;; jobs using 'simple-service'.\n"
27425 " (services (cons (simple-service 'my-cron-jobs\n"
27426 " mcron-service-type\n"
27427 " (list garbage-collector-job\n"
27430 " %base-services)))\n"
27433 #. type: Plain text
27434 #: guix-git/doc/guix.texi:15903
27435 msgid "For more complex jobs defined in Scheme where you need control over the top level, for instance to introduce a @code{use-modules} form, you can move your code to a separate program using the @code{program-file} procedure of the @code{(guix gexp)} module (@pxref{G-Expressions}). The example below illustrates that."
27439 #: guix-git/doc/guix.texi:15919
27442 "(define %battery-alert-job\n"
27443 " ;; Beep when the battery percentage falls below %MIN-LEVEL.\n"
27445 " '(next-minute (range 0 60 1))\n"
27446 " #$(program-file\n"
27447 " \"battery-alert.scm\"\n"
27448 " (with-imported-modules (source-module-closure\n"
27449 " '((guix build utils)))\n"
27451 " (use-modules (guix build utils)\n"
27454 " (ice-9 textual-ports)\n"
27455 " (srfi srfi-2))\n"
27460 #: guix-git/doc/guix.texi:15921
27463 " (define %min-level 20)\n"
27468 #: guix-git/doc/guix.texi:15932
27471 " (setenv \"LC_ALL\" \"C\") ;ensure English output\n"
27472 " (and-let* ((input-pipe (open-pipe*\n"
27474 " #$(file-append acpi \"/bin/acpi\")))\n"
27475 " (output (get-string-all input-pipe))\n"
27476 " (m (string-match \"Discharging, ([0-9]+)%\" output))\n"
27477 " (level (string->number (match:substring m 1)))\n"
27478 " ((< level %min-level)))\n"
27479 " (format #t \"warning: Battery level is low (~a%)~%\" level)\n"
27480 " (invoke #$(file-append beep \"/bin/beep\") \"-r5\")))))))\n"
27483 #. type: Plain text
27484 #: guix-git/doc/guix.texi:15937
27485 msgid "@xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, for more information on mcron job specifications. Below is the reference of the mcron service."
27488 #. type: Plain text
27489 #: guix-git/doc/guix.texi:15940
27490 msgid "On a running system, you can use the @code{schedule} action of the service to visualize the mcron jobs that will be executed next:"
27494 #: guix-git/doc/guix.texi:15943
27496 msgid "# herd schedule mcron\n"
27499 #. type: Plain text
27500 #: guix-git/doc/guix.texi:15948
27501 msgid "The example above lists the next five tasks that will be executed, but you can also specify the number of tasks to display:"
27505 #: guix-git/doc/guix.texi:15951
27507 msgid "# herd schedule mcron 10\n"
27511 #: guix-git/doc/guix.texi:15953
27513 msgid "{Scheme Variable} mcron-service-type"
27517 #: guix-git/doc/guix.texi:15956
27518 msgid "This is the type of the @code{mcron} service, whose value is an @code{mcron-configuration} object."
27522 #: guix-git/doc/guix.texi:15961
27523 msgid "This service type can be the target of a service extension that provides it additional job specifications (@pxref{Service Composition}). In other words, it is possible to define services that provide additional mcron jobs to run."
27527 #: guix-git/doc/guix.texi:15963
27529 msgid "{Data Type} mcron-configuration"
27533 #: guix-git/doc/guix.texi:15965
27534 msgid "Data type representing the configuration of mcron."
27538 #: guix-git/doc/guix.texi:15967
27540 msgid "@code{mcron} (default: @var{mcron})"
27544 #: guix-git/doc/guix.texi:15969
27545 msgid "The mcron package to use."
27549 #: guix-git/doc/guix.texi:15970 guix-git/doc/guix.texi:16039
27555 #: guix-git/doc/guix.texi:15974
27556 msgid "This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds to an mcron job specification (@pxref{Syntax, mcron job specifications,, mcron, GNU@tie{}mcron})."
27560 #: guix-git/doc/guix.texi:15981
27566 #: guix-git/doc/guix.texi:15982
27568 msgid "log rotation"
27571 #. type: Plain text
27572 #: guix-git/doc/guix.texi:15989
27573 msgid "Log files such as those found in @file{/var/log} tend to grow endlessly, so it's a good idea to @dfn{rotate} them once in a while---i.e., archive their contents in separate files, possibly compressed. The @code{(gnu services admin)} module provides an interface to GNU@tie{}Rot[t]log, a log rotation tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual})."
27576 #. type: Plain text
27577 #: guix-git/doc/guix.texi:15995
27578 msgid "This service is part of @code{%base-services}, and thus enabled by default, with the default settings, for commonly encountered log files. The example below shows how to extend it with an additional @dfn{rotation}, should you need to do that (usually, services that produce log files already take care of that):"
27582 #: guix-git/doc/guix.texi:15999
27585 "(use-modules (guix) (gnu))\n"
27586 "(use-service-modules admin)\n"
27591 #: guix-git/doc/guix.texi:16003
27594 "(define my-log-files\n"
27595 " ;; Log files that I want to rotate.\n"
27596 " '(\"/var/log/something.log\" \"/var/log/another.log\"))\n"
27601 #: guix-git/doc/guix.texi:16012
27604 "(operating-system\n"
27606 " (services (cons (simple-service 'rotate-my-stuff\n"
27607 " rottlog-service-type\n"
27608 " (list (log-rotation\n"
27609 " (frequency 'daily)\n"
27610 " (files my-log-files))))\n"
27611 " %base-services)))\n"
27615 #: guix-git/doc/guix.texi:16014
27617 msgid "{Scheme Variable} rottlog-service-type"
27621 #: guix-git/doc/guix.texi:16017
27622 msgid "This is the type of the Rottlog service, whose value is a @code{rottlog-configuration} object."
27626 #: guix-git/doc/guix.texi:16020
27627 msgid "Other services can extend this one with new @code{log-rotation} objects (see below), thereby augmenting the set of files to be rotated."
27631 #: guix-git/doc/guix.texi:16023
27632 msgid "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to run the rottlog service."
27636 #: guix-git/doc/guix.texi:16025
27638 msgid "{Data Type} rottlog-configuration"
27642 #: guix-git/doc/guix.texi:16027
27643 msgid "Data type representing the configuration of rottlog."
27647 #: guix-git/doc/guix.texi:16029
27649 msgid "@code{rottlog} (default: @code{rottlog})"
27653 #: guix-git/doc/guix.texi:16031
27654 msgid "The Rottlog package to use."
27658 #: guix-git/doc/guix.texi:16032
27660 msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})"
27664 #: guix-git/doc/guix.texi:16035
27665 msgid "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, rottlog, GNU Rot[t]log Manual})."
27669 #: guix-git/doc/guix.texi:16036
27671 msgid "@code{rotations} (default: @code{%default-rotations})"
27675 #: guix-git/doc/guix.texi:16038
27676 msgid "A list of @code{log-rotation} objects as defined below."
27680 #: guix-git/doc/guix.texi:16042
27681 msgid "This is a list of gexps where each gexp corresponds to an mcron job specification (@pxref{Scheduled Job Execution})."
27685 #: guix-git/doc/guix.texi:16045
27687 msgid "{Data Type} log-rotation"
27691 #: guix-git/doc/guix.texi:16047
27692 msgid "Data type representing the rotation of a group of log files."
27696 #: guix-git/doc/guix.texi:16051
27697 msgid "Taking an example from the Rottlog manual (@pxref{Period Related File Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be defined like this:"
27701 #: guix-git/doc/guix.texi:16060
27705 " (frequency 'daily)\n"
27706 " (files '(\"/var/log/apache/*\"))\n"
27707 " (options '(\"storedir apache-archives\"\n"
27709 " \"notifempty\"\n"
27710 " \"nocompress\")))\n"
27714 #: guix-git/doc/guix.texi:16063
27715 msgid "The list of fields is as follows:"
27719 #: guix-git/doc/guix.texi:16065
27721 msgid "@code{frequency} (default: @code{'weekly})"
27725 #: guix-git/doc/guix.texi:16067
27726 msgid "The log rotation frequency, a symbol."
27730 #: guix-git/doc/guix.texi:16068
27736 #: guix-git/doc/guix.texi:16070
27737 msgid "The list of files or file glob patterns to rotate."
27741 #: guix-git/doc/guix.texi:16071
27743 msgid "@code{options} (default: @code{'()})"
27747 #: guix-git/doc/guix.texi:16074
27748 msgid "The list of rottlog options for this rotation (@pxref{Configuration parameters,,, rottlog, GNU Rot[t]lg Manual})."
27752 #: guix-git/doc/guix.texi:16075
27754 msgid "@code{post-rotate} (default: @code{#f})"
27758 #: guix-git/doc/guix.texi:16077
27759 msgid "Either @code{#f} or a gexp to execute once the rotation has completed."
27763 #: guix-git/doc/guix.texi:16080
27765 msgid "{Scheme Variable} %default-rotations"
27769 #: guix-git/doc/guix.texi:16083
27770 msgid "Specifies weekly rotation of @code{%rotated-files} and of @file{/var/log/guix-daemon.log}."
27774 #: guix-git/doc/guix.texi:16085
27776 msgid "{Scheme Variable} %rotated-files"
27780 #: guix-git/doc/guix.texi:16089
27781 msgid "The list of syslog-controlled files to be rotated. By default it is: @code{'(\"/var/log/messages\" \"/var/log/secure\" \"/var/log/debug\" \\ \"/var/log/maillog\")}."
27784 #. type: Plain text
27785 #: guix-git/doc/guix.texi:16096
27786 msgid "The @code{(gnu services networking)} module provides services to configure the network interface."
27790 #: guix-git/doc/guix.texi:16097
27792 msgid "DHCP, networking service"
27796 #: guix-git/doc/guix.texi:16098
27798 msgid "{Scheme Variable} dhcp-client-service-type"
27802 #: guix-git/doc/guix.texi:16102
27803 msgid "This is the type of services that run @var{dhcp}, a Dynamic Host Configuration Protocol (DHCP) client, on all the non-loopback network interfaces. Its value is the DHCP client package to use, @code{isc-dhcp} by default."
27807 #: guix-git/doc/guix.texi:16104
27809 msgid "{Scheme Procedure} dhcpd-service-type"
27813 #: guix-git/doc/guix.texi:16108
27814 msgid "This type defines a service that runs a DHCP daemon. To create a service of this type, you must supply a @code{<dhcpd-configuration>}. For example:"
27818 #: guix-git/doc/guix.texi:16114
27821 "(service dhcpd-service-type\n"
27822 " (dhcpd-configuration\n"
27823 " (config-file (local-file \"my-dhcpd.conf\"))\n"
27824 " (interfaces '(\"enp0s25\"))))\n"
27828 #: guix-git/doc/guix.texi:16117
27830 msgid "{Data Type} dhcpd-configuration"
27834 #: guix-git/doc/guix.texi:16119
27836 msgid "@code{package} (default: @code{isc-dhcp})"
27840 #: guix-git/doc/guix.texi:16124
27841 msgid "The package that provides the DHCP daemon. This package is expected to provide the daemon at @file{sbin/dhcpd} relative to its output directory. The default package is the @uref{https://www.isc.org/products/DHCP, ISC's DHCP server}."
27845 #: guix-git/doc/guix.texi:16124 guix-git/doc/guix.texi:16380
27846 #: guix-git/doc/guix.texi:21452
27848 msgid "@code{config-file} (default: @code{#f})"
27852 #: guix-git/doc/guix.texi:16129
27853 msgid "The configuration file to use. This is required. It will be passed to @code{dhcpd} via its @code{-cf} option. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). See @code{man dhcpd.conf} for details on the configuration file syntax."
27857 #: guix-git/doc/guix.texi:16129
27859 msgid "@code{version} (default: @code{\"4\"})"
27863 #: guix-git/doc/guix.texi:16134
27864 msgid "The DHCP version to use. The ISC DHCP server supports the values ``4'', ``6'', and ``4o6''. These correspond to the @code{dhcpd} program options @code{-4}, @code{-6}, and @code{-4o6}. See @code{man dhcpd} for details."
27868 #: guix-git/doc/guix.texi:16134
27870 msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})"
27874 #: guix-git/doc/guix.texi:16137
27875 msgid "The run directory to use. At service activation time, this directory will be created if it does not exist."
27879 #: guix-git/doc/guix.texi:16137
27881 msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})"
27885 #: guix-git/doc/guix.texi:16140
27886 msgid "The PID file to use. This corresponds to the @code{-pf} option of @code{dhcpd}. See @code{man dhcpd} for details."
27890 #: guix-git/doc/guix.texi:16140
27892 msgid "@code{interfaces} (default: @code{'()})"
27896 #: guix-git/doc/guix.texi:16146
27897 msgid "The names of the network interfaces on which dhcpd should listen for broadcasts. If this list is not empty, then its elements (which must be strings) will be appended to the @code{dhcpd} invocation when starting the daemon. It may not be necessary to explicitly specify any interfaces here; see @code{man dhcpd} for details."
27901 #: guix-git/doc/guix.texi:16149
27903 msgid "{Scheme Variable} static-networking-service-type"
27907 #: guix-git/doc/guix.texi:16152
27908 msgid "This is the type for statically-configured network interfaces."
27912 #: guix-git/doc/guix.texi:16154
27914 msgid "{Scheme Procedure} static-networking-service @var{interface} @var{ip} @"
27918 #: guix-git/doc/guix.texi:16162
27919 msgid "[#:netmask #f] [#:gateway #f] [#:name-servers @code{'()}] @ [#:requirement @code{'(udev)}] Return a service that starts @var{interface} with address @var{ip}. If @var{netmask} is true, use it as the network mask. If @var{gateway} is true, it must be a string specifying the default network gateway. @var{requirement} can be used to declare a dependency on another service before configuring the interface."
27923 #: guix-git/doc/guix.texi:16167
27924 msgid "This procedure can be called several times, one for each network interface of interest. Behind the scenes what it does is extend @code{static-networking-service-type} with additional network interfaces to handle."
27928 #: guix-git/doc/guix.texi:16169 guix-git/doc/guix.texi:29003
27929 msgid "For example:"
27933 #: guix-git/doc/guix.texi:16174
27936 "(static-networking-service \"eno1\" \"192.168.1.82\"\n"
27937 " #:gateway \"192.168.1.2\"\n"
27938 " #:name-servers '(\"192.168.1.2\"))\n"
27942 #: guix-git/doc/guix.texi:16177
27948 #: guix-git/doc/guix.texi:16180
27950 msgid "network management"
27954 #: guix-git/doc/guix.texi:16181
27956 msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]"
27960 #: guix-git/doc/guix.texi:16184
27961 msgid "Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network management daemon that aims to simplify wired and wireless networking."
27965 #: guix-git/doc/guix.texi:16189
27966 msgid "This service adds the @var{wicd} package to the global profile, providing several commands to interact with the daemon and configure networking: @command{wicd-client}, a graphical user interface, and the @command{wicd-cli} and @command{wicd-curses} user interfaces."
27970 #: guix-git/doc/guix.texi:16191
27972 msgid "ModemManager"
27976 #: guix-git/doc/guix.texi:16193
27978 msgid "{Scheme Variable} modem-manager-service-type"
27982 #: guix-git/doc/guix.texi:16198
27983 msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/ModemManager, ModemManager} service. The value for this service type is a @code{modem-manager-configuration} record."
27987 #: guix-git/doc/guix.texi:16201 guix-git/doc/guix.texi:16230
27988 #: guix-git/doc/guix.texi:16262
27989 msgid "This service is part of @code{%desktop-services} (@pxref{Desktop Services})."
27993 #: guix-git/doc/guix.texi:16203
27995 msgid "{Data Type} modem-manager-configuration"
27999 #: guix-git/doc/guix.texi:16205
28000 msgid "Data type representing the configuration of ModemManager."
28004 #: guix-git/doc/guix.texi:16207
28006 msgid "@code{modem-manager} (default: @code{modem-manager})"
28010 #: guix-git/doc/guix.texi:16209
28011 msgid "The ModemManager package to use."
28015 #: guix-git/doc/guix.texi:16213
28017 msgid "USB_ModeSwitch"
28021 #: guix-git/doc/guix.texi:16214
28023 msgid "Modeswitching"
28027 #: guix-git/doc/guix.texi:16216
28029 msgid "{Scheme Variable} usb-modeswitch-service-type"
28033 #: guix-git/doc/guix.texi:16221
28034 msgid "This is the service type for the @uref{https://www.draisberghof.de/usb_modeswitch/, USB_ModeSwitch} service. The value for this service type is a @code{usb-modeswitch-configuration} record."
28038 #: guix-git/doc/guix.texi:16227
28039 msgid "When plugged in, some USB modems (and other USB devices) initially present themselves as a read-only storage medium and not as a modem. They need to be @dfn{modeswitched} before they are usable. The USB_ModeSwitch service type installs udev rules to automatically modeswitch these devices when they are plugged in."
28043 #: guix-git/doc/guix.texi:16232
28045 msgid "{Data Type} usb-modeswitch-configuration"
28049 #: guix-git/doc/guix.texi:16234
28050 msgid "Data type representing the configuration of USB_ModeSwitch."
28054 #: guix-git/doc/guix.texi:16236
28056 msgid "@code{usb-modeswitch} (default: @code{usb-modeswitch})"
28060 #: guix-git/doc/guix.texi:16238
28061 msgid "The USB_ModeSwitch package providing the binaries for modeswitching."
28065 #: guix-git/doc/guix.texi:16239
28067 msgid "@code{usb-modeswitch-data} (default: @code{usb-modeswitch-data})"
28071 #: guix-git/doc/guix.texi:16242
28072 msgid "The package providing the device data and udev rules file used by USB_ModeSwitch."
28076 #: guix-git/doc/guix.texi:16243
28078 msgid "@code{config-file} (default: @code{#~(string-append #$usb-modeswitch:dispatcher \"/etc/usb_modeswitch.conf\")})"
28082 #: guix-git/doc/guix.texi:16248
28083 msgid "Which config file to use for the USB_ModeSwitch dispatcher. By default the config file shipped with USB_ModeSwitch is used which disables logging to @file{/var/log} among other default settings. If set to @code{#f}, no config file is used."
28087 #: guix-git/doc/guix.texi:16252
28089 msgid "NetworkManager"
28093 #: guix-git/doc/guix.texi:16254
28095 msgid "{Scheme Variable} network-manager-service-type"
28099 #: guix-git/doc/guix.texi:16259
28100 msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/NetworkManager, NetworkManager} service. The value for this service type is a @code{network-manager-configuration} record."
28104 #: guix-git/doc/guix.texi:16264
28106 msgid "{Data Type} network-manager-configuration"
28110 #: guix-git/doc/guix.texi:16266
28111 msgid "Data type representing the configuration of NetworkManager."
28115 #: guix-git/doc/guix.texi:16268
28117 msgid "@code{network-manager} (default: @code{network-manager})"
28121 #: guix-git/doc/guix.texi:16270
28122 msgid "The NetworkManager package to use."
28126 #: guix-git/doc/guix.texi:16271
28128 msgid "@code{dns} (default: @code{\"default\"})"
28132 #: guix-git/doc/guix.texi:16274
28133 msgid "Processing mode for DNS, which affects how NetworkManager uses the @code{resolv.conf} configuration file."
28137 #: guix-git/doc/guix.texi:16279
28138 msgid "NetworkManager will update @code{resolv.conf} to reflect the nameservers provided by currently active connections."
28142 #: guix-git/doc/guix.texi:16280
28148 #: guix-git/doc/guix.texi:16284
28149 msgid "NetworkManager will run @code{dnsmasq} as a local caching nameserver, using a @dfn{conditional forwarding} configuration if you are connected to a VPN, and then update @code{resolv.conf} to point to the local nameserver."
28153 #: guix-git/doc/guix.texi:16290
28154 msgid "With this setting, you can share your network connection. For example when you want to share your network connection to another laptop @i{via} an Ethernet cable, you can open @command{nm-connection-editor} and configure the Wired connection's method for IPv4 and IPv6 to be ``Shared to other computers'' and reestablish the connection (or reboot)."
28158 #: guix-git/doc/guix.texi:16297
28159 msgid "You can also set up a @dfn{host-to-guest connection} to QEMU VMs (@pxref{Installing Guix in a VM}). With a host-to-guest connection, you can e.g.@: access a Web server running on the VM (@pxref{Web Services}) from a Web browser on your host system, or connect to the VM @i{via} SSH (@pxref{Networking Services, @code{openssh-service-type}}). To set up a host-to-guest connection, run this command once:"
28163 #: guix-git/doc/guix.texi:16304
28166 "nmcli connection add type tun \\\n"
28167 " connection.interface-name tap0 \\\n"
28168 " tun.mode tap tun.owner $(id -u) \\\n"
28169 " ipv4.method shared \\\n"
28170 " ipv4.addresses 172.28.112.1/24\n"
28174 #: guix-git/doc/guix.texi:16309
28175 msgid "Then each time you launch your QEMU VM (@pxref{Running Guix in a VM}), pass @option{-nic tap,ifname=tap0,script=no,downscript=no} to @command{qemu-system-...}."
28179 #: guix-git/doc/guix.texi:16312
28180 msgid "NetworkManager will not modify @code{resolv.conf}."
28184 #: guix-git/doc/guix.texi:16314
28186 msgid "@code{vpn-plugins} (default: @code{'()})"
28190 #: guix-git/doc/guix.texi:16318
28191 msgid "This is the list of available plugins for virtual private networks (VPNs). An example of this is the @code{network-manager-openvpn} package, which allows NetworkManager to manage VPNs @i{via} OpenVPN."
28195 #: guix-git/doc/guix.texi:16322
28201 #: guix-git/doc/guix.texi:16323
28203 msgid "{Scheme Variable} connman-service-type"
28207 #: guix-git/doc/guix.texi:16326
28208 msgid "This is the service type to run @url{https://01.org/connman,Connman}, a network connection manager."
28212 #: guix-git/doc/guix.texi:16329
28213 msgid "Its value must be an @code{connman-configuration} record as in this example:"
28217 #: guix-git/doc/guix.texi:16334
28220 "(service connman-service-type\n"
28221 " (connman-configuration\n"
28222 " (disable-vpn? #t)))\n"
28226 #: guix-git/doc/guix.texi:16337
28227 msgid "See below for details about @code{connman-configuration}."
28231 #: guix-git/doc/guix.texi:16339
28233 msgid "{Data Type} connman-configuration"
28237 #: guix-git/doc/guix.texi:16341
28238 msgid "Data Type representing the configuration of connman."
28242 #: guix-git/doc/guix.texi:16343
28244 msgid "@code{connman} (default: @var{connman})"
28248 #: guix-git/doc/guix.texi:16345
28249 msgid "The connman package to use."
28253 #: guix-git/doc/guix.texi:16346
28255 msgid "@code{disable-vpn?} (default: @code{#f})"
28259 #: guix-git/doc/guix.texi:16348
28260 msgid "When true, disable connman's vpn plugin."
28264 #: guix-git/doc/guix.texi:16351
28266 msgid "WPA Supplicant"
28270 #: guix-git/doc/guix.texi:16352
28272 msgid "{Scheme Variable} wpa-supplicant-service-type"
28276 #: guix-git/doc/guix.texi:16356
28277 msgid "This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA supplicant}, an authentication daemon required to authenticate against encrypted WiFi or ethernet networks."
28281 #: guix-git/doc/guix.texi:16358
28283 msgid "{Data Type} wpa-supplicant-configuration"
28287 #: guix-git/doc/guix.texi:16360
28288 msgid "Data type representing the configuration of WPA Supplicant."
28292 #: guix-git/doc/guix.texi:16362 guix-git/doc/guix.texi:31015
28293 msgid "It takes the following parameters:"
28297 #: guix-git/doc/guix.texi:16364
28299 msgid "@code{wpa-supplicant} (default: @code{wpa-supplicant})"
28303 #: guix-git/doc/guix.texi:16366
28304 msgid "The WPA Supplicant package to use."
28308 #: guix-git/doc/guix.texi:16367
28310 msgid "@code{requirement} (default: @code{'(user-processes loopback syslogd)}"
28314 #: guix-git/doc/guix.texi:16369
28315 msgid "List of services that should be started before WPA Supplicant starts."
28319 #: guix-git/doc/guix.texi:16370
28321 msgid "@code{dbus?} (default: @code{#t})"
28325 #: guix-git/doc/guix.texi:16372
28326 msgid "Whether to listen for requests on D-Bus."
28330 #: guix-git/doc/guix.texi:16373
28332 msgid "@code{pid-file} (default: @code{\"/var/run/wpa_supplicant.pid\"})"
28336 #: guix-git/doc/guix.texi:16375
28337 msgid "Where to store the PID file."
28341 #: guix-git/doc/guix.texi:16376 guix-git/doc/guix.texi:29460
28342 #: guix-git/doc/guix.texi:29602
28344 msgid "@code{interface} (default: @code{#f})"
28348 #: guix-git/doc/guix.texi:16379
28349 msgid "If this is set, it must specify the name of a network interface that WPA supplicant will control."
28353 #: guix-git/doc/guix.texi:16382
28354 msgid "Optional configuration file to use."
28358 #: guix-git/doc/guix.texi:16385
28359 msgid "List of additional command-line arguments to pass to the daemon."
28363 #: guix-git/doc/guix.texi:16388
28365 msgid "hostapd service, for Wi-Fi access points"
28369 #: guix-git/doc/guix.texi:16389
28371 msgid "Wi-Fi access points, hostapd service"
28375 #: guix-git/doc/guix.texi:16390
28377 msgid "{Scheme Variable} hostapd-service-type"
28381 #: guix-git/doc/guix.texi:16395
28382 msgid "This is the service type to run the @uref{https://w1.fi/hostapd/, hostapd} daemon to set up WiFi (IEEE 802.11) access points and authentication servers. Its associated value must be a @code{hostapd-configuration} as shown below:"
28386 #: guix-git/doc/guix.texi:16403
28389 ";; Use wlan1 to run the access point for \"My Network\".\n"
28390 "(service hostapd-service-type\n"
28391 " (hostapd-configuration\n"
28392 " (interface \"wlan1\")\n"
28393 " (ssid \"My Network\")\n"
28394 " (channel 12)))\n"
28398 #: guix-git/doc/guix.texi:16406
28400 msgid "{Data Type} hostapd-configuration"
28404 #: guix-git/doc/guix.texi:16409
28405 msgid "This data type represents the configuration of the hostapd service, with the following fields:"
28409 #: guix-git/doc/guix.texi:16411
28411 msgid "@code{package} (default: @code{hostapd})"
28415 #: guix-git/doc/guix.texi:16413
28416 msgid "The hostapd package to use."
28420 #: guix-git/doc/guix.texi:16414
28422 msgid "@code{interface} (default: @code{\"wlan0\"})"
28426 #: guix-git/doc/guix.texi:16416
28427 msgid "The network interface to run the WiFi access point."
28431 #: guix-git/doc/guix.texi:16417
28437 #: guix-git/doc/guix.texi:16420
28438 msgid "The SSID (@dfn{service set identifier}), a string that identifies this network."
28442 #: guix-git/doc/guix.texi:16421
28444 msgid "@code{broadcast-ssid?} (default: @code{#t})"
28448 #: guix-git/doc/guix.texi:16423
28449 msgid "Whether to broadcast this SSID."
28453 #: guix-git/doc/guix.texi:16424
28455 msgid "@code{channel} (default: @code{1})"
28459 #: guix-git/doc/guix.texi:16426
28460 msgid "The WiFi channel to use."
28464 #: guix-git/doc/guix.texi:16427
28466 msgid "@code{driver} (default: @code{\"nl80211\"})"
28470 #: guix-git/doc/guix.texi:16431
28471 msgid "The driver interface type. @code{\"nl80211\"} is used with all Linux mac80211 drivers. Use @code{\"none\"} if building hostapd as a standalone RADIUS server that does # not control any wireless/wired driver."
28475 #: guix-git/doc/guix.texi:16432 guix-git/doc/guix.texi:22301
28476 #: guix-git/doc/guix.texi:25151
28478 msgid "@code{extra-settings} (default: @code{\"\"})"
28482 #: guix-git/doc/guix.texi:16436
28483 msgid "Extra settings to append as-is to the hostapd configuration file. See @uref{https://w1.fi/cgit/hostap/plain/hostapd/hostapd.conf} for the configuration file reference."
28487 #: guix-git/doc/guix.texi:16439
28489 msgid "{Scheme Variable} simulated-wifi-service-type"
28493 #: guix-git/doc/guix.texi:16446
28494 msgid "This is the type of a service to simulate WiFi networking, which can be useful in virtual machines for testing purposes. The service loads the Linux kernel @uref{https://www.kernel.org/doc/html/latest/networking/mac80211_hwsim/mac80211_hwsim.html, @code{mac80211_hwsim} module} and starts hostapd to create a pseudo WiFi network that can be seen on @code{wlan0}, by default."
28498 #: guix-git/doc/guix.texi:16448
28499 msgid "The service's value is a @code{hostapd-configuration} record."
28503 #: guix-git/doc/guix.texi:16450
28509 #: guix-git/doc/guix.texi:16451
28511 msgid "{Scheme Variable} iptables-service-type"
28515 #: guix-git/doc/guix.texi:16457
28516 msgid "This is the service type to set up an iptables configuration. iptables is a packet filtering framework supported by the Linux kernel. This service supports configuring iptables for both IPv4 and IPv6. A simple example configuration rejecting all incoming connections except those to the ssh port 22 is shown below."
28520 #: guix-git/doc/guix.texi:16477
28523 "(service iptables-service-type\n"
28524 " (iptables-configuration\n"
28525 " (ipv4-rules (plain-file \"iptables.rules\" \"*filter\n"
28527 ":FORWARD ACCEPT\n"
28529 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28530 "-A INPUT -j REJECT --reject-with icmp-port-unreachable\n"
28533 " (ipv6-rules (plain-file \"ip6tables.rules\" \"*filter\n"
28535 ":FORWARD ACCEPT\n"
28537 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28538 "-A INPUT -j REJECT --reject-with icmp6-port-unreachable\n"
28544 #: guix-git/doc/guix.texi:16480
28546 msgid "{Data Type} iptables-configuration"
28550 #: guix-git/doc/guix.texi:16482
28551 msgid "The data type representing the configuration of iptables."
28555 #: guix-git/doc/guix.texi:16484
28557 msgid "@code{iptables} (default: @code{iptables})"
28561 #: guix-git/doc/guix.texi:16487
28562 msgid "The iptables package that provides @code{iptables-restore} and @code{ip6tables-restore}."
28566 #: guix-git/doc/guix.texi:16487
28568 msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})"
28572 #: guix-git/doc/guix.texi:16491
28573 msgid "The iptables rules to use. It will be passed to @code{iptables-restore}. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
28577 #: guix-git/doc/guix.texi:16491
28579 msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})"
28583 #: guix-git/doc/guix.texi:16495
28584 msgid "The ip6tables rules to use. It will be passed to @code{ip6tables-restore}. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
28588 #: guix-git/doc/guix.texi:16498
28594 #: guix-git/doc/guix.texi:16499
28596 msgid "{Scheme Variable} nftables-service-type"
28600 #: guix-git/doc/guix.texi:16507
28601 msgid "This is the service type to set up a nftables configuration. nftables is a netfilter project that aims to replace the existing iptables, ip6tables, arptables and ebtables framework. It provides a new packet filtering framework, a new user-space utility @command{nft}, and a compatibility layer for iptables. This service comes with a default ruleset @code{%default-nftables-ruleset} that rejecting all incoming connections except those to the ssh port 22. To use it, simply write:"
28605 #: guix-git/doc/guix.texi:16510
28607 msgid "(service nftables-service-type)\n"
28611 #: guix-git/doc/guix.texi:16513
28613 msgid "{Data Type} nftables-configuration"
28617 #: guix-git/doc/guix.texi:16515
28618 msgid "The data type representing the configuration of nftables."
28622 #: guix-git/doc/guix.texi:16517
28624 msgid "@code{package} (default: @code{nftables})"
28628 #: guix-git/doc/guix.texi:16519
28629 msgid "The nftables package that provides @command{nft}."
28633 #: guix-git/doc/guix.texi:16519
28635 msgid "@code{ruleset} (default: @code{%default-nftables-ruleset})"
28639 #: guix-git/doc/guix.texi:16522
28640 msgid "The nftables ruleset to use. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
28644 #: guix-git/doc/guix.texi:16525
28646 msgid "NTP (Network Time Protocol), service"
28650 #: guix-git/doc/guix.texi:16526
28652 msgid "ntpd, service for the Network Time Protocol daemon"
28656 #: guix-git/doc/guix.texi:16527
28658 msgid "real time clock"
28662 #: guix-git/doc/guix.texi:16528
28664 msgid "{Scheme Variable} ntp-service-type"
28668 #: guix-git/doc/guix.texi:16532
28669 msgid "This is the type of the service running the @uref{https://www.ntp.org, Network Time Protocol (NTP)} daemon, @command{ntpd}. The daemon will keep the system clock synchronized with that of the specified NTP servers."
28673 #: guix-git/doc/guix.texi:16535
28674 msgid "The value of this service is an @code{ntpd-configuration} object, as described below."
28678 #: guix-git/doc/guix.texi:16537
28680 msgid "{Data Type} ntp-configuration"
28684 #: guix-git/doc/guix.texi:16539
28685 msgid "This is the data type for the NTP service configuration."
28689 #: guix-git/doc/guix.texi:16541
28691 msgid "@code{servers} (default: @code{%ntp-servers})"
28695 #: guix-git/doc/guix.texi:16545
28696 msgid "This is the list of servers (@code{<ntp-server>} records) with which @command{ntpd} will be synchronized. See the @code{ntp-server} data type definition below."
28700 #: guix-git/doc/guix.texi:16546
28702 msgid "@code{allow-large-adjustment?} (default: @code{#t})"
28706 #: guix-git/doc/guix.texi:16549
28707 msgid "This determines whether @command{ntpd} is allowed to make an initial adjustment of more than 1,000 seconds."
28711 #: guix-git/doc/guix.texi:16550
28713 msgid "@code{ntp} (default: @code{ntp})"
28717 #: guix-git/doc/guix.texi:16552
28718 msgid "The NTP package to use."
28722 #: guix-git/doc/guix.texi:16555
28724 msgid "{Scheme Variable} %ntp-servers"
28728 #: guix-git/doc/guix.texi:16558
28729 msgid "List of host names used as the default NTP servers. These are servers of the @uref{https://www.ntppool.org/en/, NTP Pool Project}."
28733 #: guix-git/doc/guix.texi:16560
28735 msgid "{Data Type} ntp-server"
28739 #: guix-git/doc/guix.texi:16562
28740 msgid "The data type representing the configuration of a NTP server."
28744 #: guix-git/doc/guix.texi:16564
28746 msgid "@code{type} (default: @code{'server})"
28750 #: guix-git/doc/guix.texi:16567
28751 msgid "The type of the NTP server, given as a symbol. One of @code{'pool}, @code{'server}, @code{'peer}, @code{'broadcast} or @code{'manycastclient}."
28755 #: guix-git/doc/guix.texi:16568
28761 #: guix-git/doc/guix.texi:16570
28762 msgid "The address of the server, as a string."
28766 #: guix-git/doc/guix.texi:16571 guix-git/doc/guix.texi:31761
28767 #: guix-git/doc/guix.texi:31781
28773 #: guix-git/doc/guix.texi:16576
28774 msgid "NTPD options to use with that specific server, given as a list of option names and/or of option names and values tuples. The following example define a server to use with the options @option{iburst} and @option{prefer}, as well as @option{version} 3 and a @option{maxpoll} time of 16 seconds."
28778 #: guix-git/doc/guix.texi:16582
28782 " (type 'server)\n"
28783 " (address \"some.ntp.server.org\")\n"
28784 " (options `(iburst (version 3) (maxpoll 16) prefer))))\n"
28788 #: guix-git/doc/guix.texi:16586
28794 #: guix-git/doc/guix.texi:16587
28796 msgid "{Scheme Procedure} openntpd-service-type"
28800 #: guix-git/doc/guix.texi:16591
28801 msgid "Run the @command{ntpd}, the Network Time Protocol (NTP) daemon, as implemented by @uref{http://www.openntpd.org, OpenNTPD}. The daemon will keep the system clock synchronized with that of the given servers."
28805 #: guix-git/doc/guix.texi:16600
28809 " openntpd-service-type\n"
28810 " (openntpd-configuration\n"
28811 " (listen-on '(\"127.0.0.1\" \"::1\"))\n"
28812 " (sensor '(\"udcf0 correction 70000\"))\n"
28813 " (constraint-from '(\"www.gnu.org\"))\n"
28814 " (constraints-from '(\"https://www.google.com/\"))))\n"
28819 #: guix-git/doc/guix.texi:16604
28821 msgid "{Scheme Variable} %openntpd-servers"
28825 #: guix-git/doc/guix.texi:16607
28826 msgid "This variable is a list of the server addresses defined in @code{%ntp-servers}."
28830 #: guix-git/doc/guix.texi:16609
28832 msgid "{Data Type} openntpd-configuration"
28836 #: guix-git/doc/guix.texi:16611
28838 msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})"
28842 #: guix-git/doc/guix.texi:16613
28843 msgid "The openntpd executable to use."
28847 #: guix-git/doc/guix.texi:16613
28849 msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})"
28853 #: guix-git/doc/guix.texi:16615
28854 msgid "A list of local IP addresses or hostnames the ntpd daemon should listen on."
28858 #: guix-git/doc/guix.texi:16615
28860 msgid "@code{query-from} (default: @code{'()})"
28864 #: guix-git/doc/guix.texi:16617
28865 msgid "A list of local IP address the ntpd daemon should use for outgoing queries."
28869 #: guix-git/doc/guix.texi:16617
28871 msgid "@code{sensor} (default: @code{'()})"
28875 #: guix-git/doc/guix.texi:16622
28876 msgid "Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} will listen to each sensor that actually exists and ignore non-existent ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} for more information."
28880 #: guix-git/doc/guix.texi:16622
28882 msgid "@code{server} (default: @code{'()})"
28886 #: guix-git/doc/guix.texi:16624
28887 msgid "Specify a list of IP addresses or hostnames of NTP servers to synchronize to."
28891 #: guix-git/doc/guix.texi:16624
28893 msgid "@code{servers} (default: @code{%openntp-servers})"
28897 #: guix-git/doc/guix.texi:16626
28898 msgid "Specify a list of IP addresses or hostnames of NTP pools to synchronize to."
28902 #: guix-git/doc/guix.texi:16626
28904 msgid "@code{constraint-from} (default: @code{'()})"
28908 #: guix-git/doc/guix.texi:16633
28909 msgid "@code{ntpd} can be configured to query the ‘Date’ from trusted HTTPS servers via TLS. This time information is not used for precision but acts as an authenticated constraint, thereby reducing the impact of unauthenticated NTP man-in-the-middle attacks. Specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint."
28913 #: guix-git/doc/guix.texi:16633
28915 msgid "@code{constraints-from} (default: @code{'()})"
28919 #: guix-git/doc/guix.texi:16637
28920 msgid "As with constraint from, specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint. Should the hostname resolve to multiple IP addresses, @code{ntpd} will calculate a median constraint from all of them."
28924 #: guix-git/doc/guix.texi:16640
28930 #: guix-git/doc/guix.texi:16641
28932 msgid "{Scheme variable} inetd-service-type"
28936 #: guix-git/doc/guix.texi:16646
28937 msgid "This service runs the @command{inetd} (@pxref{inetd invocation,,, inetutils, GNU Inetutils}) daemon. @command{inetd} listens for connections on internet sockets, and lazily starts the specified server program when a connection is made on one of these sockets."
28941 #: guix-git/doc/guix.texi:16652
28942 msgid "The value of this service is an @code{inetd-configuration} object. The following example configures the @command{inetd} daemon to provide the built-in @command{echo} service, as well as an smtp service which forwards smtp traffic over ssh to a server @code{smtp-server} behind a gateway @code{hostname}:"
28946 #: guix-git/doc/guix.texi:16675
28950 " inetd-service-type\n"
28951 " (inetd-configuration\n"
28952 " (entries (list\n"
28954 " (name \"echo\")\n"
28955 " (socket-type 'stream)\n"
28956 " (protocol \"tcp\")\n"
28958 " (user \"root\"))\n"
28960 " (node \"127.0.0.1\")\n"
28961 " (name \"smtp\")\n"
28962 " (socket-type 'stream)\n"
28963 " (protocol \"tcp\")\n"
28965 " (user \"root\")\n"
28966 " (program (file-append openssh \"/bin/ssh\"))\n"
28968 " '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n"
28969 " \"-W\" \"smtp-server:25\" \"user@@hostname\")))))))\n"
28973 #: guix-git/doc/guix.texi:16678
28974 msgid "See below for more details about @code{inetd-configuration}."
28978 #: guix-git/doc/guix.texi:16680
28980 msgid "{Data Type} inetd-configuration"
28984 #: guix-git/doc/guix.texi:16682
28985 msgid "Data type representing the configuration of @command{inetd}."
28989 #: guix-git/doc/guix.texi:16684
28991 msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})"
28995 #: guix-git/doc/guix.texi:16686
28996 msgid "The @command{inetd} executable to use."
29000 #: guix-git/doc/guix.texi:16687 guix-git/doc/guix.texi:25985
29002 msgid "@code{entries} (default: @code{'()})"
29006 #: guix-git/doc/guix.texi:16690
29007 msgid "A list of @command{inetd} service entries. Each entry should be created by the @code{inetd-entry} constructor."
29011 #: guix-git/doc/guix.texi:16693
29013 msgid "{Data Type} inetd-entry"
29017 #: guix-git/doc/guix.texi:16697
29018 msgid "Data type representing an entry in the @command{inetd} configuration. Each entry corresponds to a socket where @command{inetd} will listen for requests."
29022 #: guix-git/doc/guix.texi:16699
29024 msgid "@code{node} (default: @code{#f})"
29028 #: guix-git/doc/guix.texi:16704
29029 msgid "Optional string, a comma-separated list of local addresses @command{inetd} should use when listening for this service. @xref{Configuration file,,, inetutils, GNU Inetutils} for a complete description of all options."
29033 #: guix-git/doc/guix.texi:16706
29034 msgid "A string, the name must correspond to an entry in @code{/etc/services}."
29038 #: guix-git/doc/guix.texi:16706
29040 msgid "socket-type"
29044 #: guix-git/doc/guix.texi:16709
29045 msgid "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or @code{'seqpacket}."
29049 #: guix-git/doc/guix.texi:16709
29055 #: guix-git/doc/guix.texi:16711
29056 msgid "A string, must correspond to an entry in @code{/etc/protocols}."
29060 #: guix-git/doc/guix.texi:16711
29062 msgid "@code{wait?} (default: @code{#t})"
29066 #: guix-git/doc/guix.texi:16714
29067 msgid "Whether @command{inetd} should wait for the server to exit before listening to new service requests."
29071 #: guix-git/doc/guix.texi:16719
29072 msgid "A string containing the user (and, optionally, group) name of the user as whom the server should run. The group name can be specified in a suffix, separated by a colon or period, i.e.@: @code{\"user\"}, @code{\"user:group\"} or @code{\"user.group\"}."
29076 #: guix-git/doc/guix.texi:16719
29078 msgid "@code{program} (default: @code{\"internal\"})"
29082 #: guix-git/doc/guix.texi:16722
29083 msgid "The server program which will serve the requests, or @code{\"internal\"} if @command{inetd} should use a built-in service."
29087 #: guix-git/doc/guix.texi:16727
29088 msgid "A list strings or file-like objects, which are the server program's arguments, starting with the zeroth argument, i.e.@: the name of the program itself. For @command{inetd}'s internal services, this entry must be @code{'()} or @code{'(\"internal\")}."
29092 #: guix-git/doc/guix.texi:16731
29093 msgid "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed discussion of each configuration field."
29097 #: guix-git/doc/guix.texi:16733
29103 #: guix-git/doc/guix.texi:16734
29105 msgid "{Scheme Variable} tor-service-type"
29109 #: guix-git/doc/guix.texi:16739
29110 msgid "This is the type for a service that runs the @uref{https://torproject.org, Tor} anonymous networking daemon. The service is configured using a @code{<tor-configuration>} record. By default, the Tor daemon runs as the @code{tor} unprivileged user, which is a member of the @code{tor} group."
29114 #: guix-git/doc/guix.texi:16742
29116 msgid "{Data Type} tor-configuration"
29120 #: guix-git/doc/guix.texi:16744
29122 msgid "@code{tor} (default: @code{tor})"
29126 #: guix-git/doc/guix.texi:16749
29127 msgid "The package that provides the Tor daemon. This package is expected to provide the daemon at @file{bin/tor} relative to its output directory. The default package is the @uref{https://www.torproject.org, Tor Project's} implementation."
29131 #: guix-git/doc/guix.texi:16750
29133 msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})"
29137 #: guix-git/doc/guix.texi:16756
29138 msgid "The configuration file to use. It will be appended to a default configuration file, and the final configuration file will be passed to @code{tor} via its @code{-f} option. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). See @code{man tor} for details on the configuration file syntax."
29142 #: guix-git/doc/guix.texi:16757
29144 msgid "@code{hidden-services} (default: @code{'()})"
29148 #: guix-git/doc/guix.texi:16763
29149 msgid "The list of @code{<hidden-service>} records to use. For any hidden service you include in this list, appropriate configuration to enable the hidden service will be automatically added to the default configuration file. You may conveniently create @code{<hidden-service>} records using the @code{tor-hidden-service} procedure described below."
29153 #: guix-git/doc/guix.texi:16764
29155 msgid "@code{socks-socket-type} (default: @code{'tcp})"
29159 #: guix-git/doc/guix.texi:16771
29160 msgid "The default socket type that Tor should use for its SOCKS socket. This must be either @code{'tcp} or @code{'unix}. If it is @code{'tcp}, then by default Tor will listen on TCP port 9050 on the loopback interface (i.e., localhost). If it is @code{'unix}, then Tor will listen on the UNIX domain socket @file{/var/run/tor/socks-sock}, which will be made writable by members of the @code{tor} group."
29164 #: guix-git/doc/guix.texi:16776
29165 msgid "If you want to customize the SOCKS socket in more detail, leave @code{socks-socket-type} at its default value of @code{'tcp} and use @code{config-file} to override the default by providing your own @code{SocksPort} option."
29169 #: guix-git/doc/guix.texi:16777
29171 msgid "@code{control-socket?} (default: @code{#f})"
29175 #: guix-git/doc/guix.texi:16783
29176 msgid "Whether or not to provide a ``control socket'' by which Tor can be controlled to, for instance, dynamically instantiate tor onion services. If @code{#t}, Tor will listen for control commands on the UNIX domain socket @file{/var/run/tor/control-sock}, which will be made writable by members of the @code{tor} group."
29180 #: guix-git/doc/guix.texi:16787
29182 msgid "hidden service"
29186 #: guix-git/doc/guix.texi:16788
29188 msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}"
29192 #: guix-git/doc/guix.texi:16791
29193 msgid "Define a new Tor @dfn{hidden service} called @var{name} and implementing @var{mapping}. @var{mapping} is a list of port/host tuples, such as:"
29197 #: guix-git/doc/guix.texi:16795
29200 " '((22 \"127.0.0.1:22\")\n"
29201 " (80 \"127.0.0.1:8080\"))\n"
29205 #: guix-git/doc/guix.texi:16799
29206 msgid "In this example, port 22 of the hidden service is mapped to local port 22, and port 80 is mapped to local port 8080."
29210 #: guix-git/doc/guix.texi:16803
29211 msgid "This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where the @file{hostname} file contains the @code{.onion} host name for the hidden service."
29215 #: guix-git/doc/guix.texi:16806
29216 msgid "See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information."
29219 #. type: Plain text
29220 #: guix-git/doc/guix.texi:16809
29221 msgid "The @code{(gnu services rsync)} module provides the following services:"
29224 #. type: Plain text
29225 #: guix-git/doc/guix.texi:16813
29226 msgid "You might want an rsync daemon if you have files that you want available so anyone (or just yourself) can download existing files or upload new files."
29230 #: guix-git/doc/guix.texi:16814
29232 msgid "{Scheme Variable} rsync-service-type"
29236 #: guix-git/doc/guix.texi:16818
29237 msgid "This is the service type for the @uref{https://rsync.samba.org, rsync} daemon, The value for this service type is a @command{rsync-configuration} record as in this example:"
29241 #: guix-git/doc/guix.texi:16821
29243 msgid "(service rsync-service-type)\n"
29247 #: guix-git/doc/guix.texi:16824
29248 msgid "See below for details about @code{rsync-configuration}."
29252 #: guix-git/doc/guix.texi:16826
29254 msgid "{Data Type} rsync-configuration"
29258 #: guix-git/doc/guix.texi:16828
29259 msgid "Data type representing the configuration for @code{rsync-service}."
29263 #: guix-git/doc/guix.texi:16830
29265 msgid "@code{package} (default: @var{rsync})"
29269 #: guix-git/doc/guix.texi:16832
29270 msgid "@code{rsync} package to use."
29274 #: guix-git/doc/guix.texi:16833
29276 msgid "@code{port-number} (default: @code{873})"
29280 #: guix-git/doc/guix.texi:16837
29281 msgid "TCP port on which @command{rsync} listens for incoming connections. If port is less than @code{1024} @command{rsync} needs to be started as the @code{root} user and group."
29285 #: guix-git/doc/guix.texi:16838
29287 msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})"
29291 #: guix-git/doc/guix.texi:16840
29292 msgid "Name of the file where @command{rsync} writes its PID."
29296 #: guix-git/doc/guix.texi:16841
29298 msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})"
29302 #: guix-git/doc/guix.texi:16843
29303 msgid "Name of the file where @command{rsync} writes its lock file."
29307 #: guix-git/doc/guix.texi:16844
29309 msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})"
29313 #: guix-git/doc/guix.texi:16846
29314 msgid "Name of the file where @command{rsync} writes its log file."
29318 #: guix-git/doc/guix.texi:16847
29320 msgid "@code{use-chroot?} (default: @var{#t})"
29324 #: guix-git/doc/guix.texi:16849
29325 msgid "Whether to use chroot for @command{rsync} shared directory."
29329 #: guix-git/doc/guix.texi:16850
29331 msgid "@code{share-path} (default: @file{/srv/rsync})"
29335 #: guix-git/doc/guix.texi:16852
29336 msgid "Location of the @command{rsync} shared directory."
29340 #: guix-git/doc/guix.texi:16853
29342 msgid "@code{share-comment} (default: @code{\"Rsync share\"})"
29346 #: guix-git/doc/guix.texi:16855
29347 msgid "Comment of the @command{rsync} shared directory."
29351 #: guix-git/doc/guix.texi:16856
29353 msgid "@code{read-only?} (default: @var{#f})"
29357 #: guix-git/doc/guix.texi:16858
29358 msgid "Read-write permissions to shared directory."
29362 #: guix-git/doc/guix.texi:16859
29364 msgid "@code{timeout} (default: @code{300})"
29368 #: guix-git/doc/guix.texi:16861
29369 msgid "I/O timeout in seconds."
29373 #: guix-git/doc/guix.texi:16862
29375 msgid "@code{user} (default: @var{\"root\"})"
29379 #: guix-git/doc/guix.texi:16864
29380 msgid "Owner of the @code{rsync} process."
29384 #: guix-git/doc/guix.texi:16865
29386 msgid "@code{group} (default: @var{\"root\"})"
29390 #: guix-git/doc/guix.texi:16867
29391 msgid "Group of the @code{rsync} process."
29395 #: guix-git/doc/guix.texi:16868
29397 msgid "@code{uid} (default: @var{\"rsyncd\"})"
29401 #: guix-git/doc/guix.texi:16871
29402 msgid "User name or user ID that file transfers to and from that module should take place as when the daemon was run as @code{root}."
29406 #: guix-git/doc/guix.texi:16872
29408 msgid "@code{gid} (default: @var{\"rsyncd\"})"
29412 #: guix-git/doc/guix.texi:16874 guix-git/doc/guix.texi:17317
29413 msgid "Group name or group ID that will be used when accessing the module."
29416 #. type: Plain text
29417 #: guix-git/doc/guix.texi:16879
29418 msgid "The @code{(gnu services syncthing)} module provides the following services:"
29422 #: guix-git/doc/guix.texi:16879
29427 #. type: Plain text
29428 #: guix-git/doc/guix.texi:16884
29429 msgid "You might want a syncthing daemon if you have files between two or more computers and want to sync them in real time, safely protected from prying eyes."
29433 #: guix-git/doc/guix.texi:16885
29435 msgid "{Scheme Variable} syncthing-service-type"
29439 #: guix-git/doc/guix.texi:16889
29440 msgid "This is the service type for the @uref{https://syncthing.net/, syncthing} daemon, The value for this service type is a @command{syncthing-configuration} record as in this example:"
29444 #: guix-git/doc/guix.texi:16893
29447 "(service syncthing-service-type\n"
29448 " (syncthing-configuration (user \"alice\")))\n"
29452 #: guix-git/doc/guix.texi:16896
29453 msgid "See below for details about @code{syncthing-configuration}."
29457 #: guix-git/doc/guix.texi:16897
29459 msgid "{Data Type} syncthing-configuration"
29463 #: guix-git/doc/guix.texi:16899
29464 msgid "Data type representing the configuration for @code{syncthing-service-type}."
29468 #: guix-git/doc/guix.texi:16901
29470 msgid "@code{syncthing} (default: @var{syncthing})"
29474 #: guix-git/doc/guix.texi:16903
29475 msgid "@code{syncthing} package to use."
29479 #: guix-git/doc/guix.texi:16904
29481 msgid "@code{arguments} (default: @var{'()})"
29485 #: guix-git/doc/guix.texi:16906
29486 msgid "List of command-line arguments passing to @code{syncthing} binary."
29490 #: guix-git/doc/guix.texi:16907
29492 msgid "@code{logflags} (default: @var{0})"
29496 #: guix-git/doc/guix.texi:16910
29497 msgid "Sum of logging flags, see @uref{https://docs.syncthing.net/users/syncthing.html#cmdoption-logflags, Syncthing documentation logflags}."
29501 #: guix-git/doc/guix.texi:16911
29503 msgid "@code{user} (default: @var{#f})"
29507 #: guix-git/doc/guix.texi:16914
29508 msgid "The user as which the Syncthing service is to be run. This assumes that the specified user exists."
29512 #: guix-git/doc/guix.texi:16915
29514 msgid "@code{group} (default: @var{\"users\"})"
29518 #: guix-git/doc/guix.texi:16918
29519 msgid "The group as which the Syncthing service is to be run. This assumes that the specified group exists."
29523 #: guix-git/doc/guix.texi:16919
29525 msgid "@code{home} (default: @var{#f})"
29529 #: guix-git/doc/guix.texi:16922
29530 msgid "Common configuration and data directory. The default configuration directory is @file{$HOME} of the specified Syncthing @code{user}."
29533 #. type: Plain text
29534 #: guix-git/doc/guix.texi:16928
29535 msgid "Furthermore, @code{(gnu services ssh)} provides the following services."
29539 #: guix-git/doc/guix.texi:16928 guix-git/doc/guix.texi:16967
29540 #: guix-git/doc/guix.texi:33628
29546 #: guix-git/doc/guix.texi:16929 guix-git/doc/guix.texi:16968
29547 #: guix-git/doc/guix.texi:33629
29553 #: guix-git/doc/guix.texi:16931
29555 msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @"
29559 #: guix-git/doc/guix.texi:16940
29560 msgid "[#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ [#:allow-empty-passwords? #f] [#:root-login? #f] @ [#:syslog-output? #t] [#:x11-forwarding? #t] @ [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ [#:public-key-authentication? #t] [#:initialize? #t] Run the @command{lshd} program from @var{lsh} to listen on port @var{port-number}. @var{host-key} must designate a file containing the host key, and readable only by root."
29564 #: guix-git/doc/guix.texi:16946
29565 msgid "When @var{daemonic?} is true, @command{lshd} will detach from the controlling terminal and log its output to syslogd, unless one sets @var{syslog-output?} to false. Obviously, it also makes lsh-service depend on existence of syslogd service. When @var{pid-file?} is true, @command{lshd} writes its PID to the file called @var{pid-file}."
29569 #: guix-git/doc/guix.texi:16950
29570 msgid "When @var{initialize?} is true, automatically create the seed and host key upon service activation if they do not exist yet. This may take long and require interaction."
29574 #: guix-git/doc/guix.texi:16955
29575 msgid "When @var{initialize?} is false, it is up to the user to initialize the randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create a key pair with the private key stored in file @var{host-key} (@pxref{lshd basics,,, lsh, LSH Manual})."
29579 #: guix-git/doc/guix.texi:16959
29580 msgid "When @var{interfaces} is empty, lshd listens for connections on all the network interfaces; otherwise, @var{interfaces} must be a list of host names or addresses."
29584 #: guix-git/doc/guix.texi:16963
29585 msgid "@var{allow-empty-passwords?} specifies whether to accept log-ins with empty passwords, and @var{root-login?} specifies whether to accept log-ins as root."
29589 #: guix-git/doc/guix.texi:16965
29590 msgid "The other options should be self-descriptive."
29594 #: guix-git/doc/guix.texi:16969
29596 msgid "{Scheme Variable} openssh-service-type"
29600 #: guix-git/doc/guix.texi:16973
29601 msgid "This is the type for the @uref{http://www.openssh.org, OpenSSH} secure shell daemon, @command{sshd}. Its value must be an @code{openssh-configuration} record as in this example:"
29605 #: guix-git/doc/guix.texi:16982
29608 "(service openssh-service-type\n"
29609 " (openssh-configuration\n"
29610 " (x11-forwarding? #t)\n"
29611 " (permit-root-login 'without-password)\n"
29612 " (authorized-keys\n"
29613 " `((\"alice\" ,(local-file \"alice.pub\"))\n"
29614 " (\"bob\" ,(local-file \"bob.pub\"))))))\n"
29618 #: guix-git/doc/guix.texi:16985
29619 msgid "See below for details about @code{openssh-configuration}."
29623 #: guix-git/doc/guix.texi:16988
29624 msgid "This service can be extended with extra authorized keys, as in this example:"
29628 #: guix-git/doc/guix.texi:16993
29631 "(service-extension openssh-service-type\n"
29632 " (const `((\"charlie\"\n"
29633 " ,(local-file \"charlie.pub\")))))\n"
29637 #: guix-git/doc/guix.texi:16996
29639 msgid "{Data Type} openssh-configuration"
29643 #: guix-git/doc/guix.texi:16998
29644 msgid "This is the configuration record for OpenSSH's @command{sshd}."
29648 #: guix-git/doc/guix.texi:17000
29650 msgid "@code{openssh} (default @var{openssh})"
29654 #: guix-git/doc/guix.texi:17002
29655 msgid "The Openssh package to use."
29659 #: guix-git/doc/guix.texi:17003
29661 msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})"
29665 #: guix-git/doc/guix.texi:17005
29666 msgid "Name of the file where @command{sshd} writes its PID."
29670 #: guix-git/doc/guix.texi:17006
29672 msgid "@code{port-number} (default: @code{22})"
29676 #: guix-git/doc/guix.texi:17008
29677 msgid "TCP port on which @command{sshd} listens for incoming connections."
29681 #: guix-git/doc/guix.texi:17009
29683 msgid "@code{permit-root-login} (default: @code{#f})"
29687 #: guix-git/doc/guix.texi:17014
29688 msgid "This field determines whether and when to allow logins as root. If @code{#f}, root logins are disallowed; if @code{#t}, they are allowed. If it's the symbol @code{'without-password}, then root logins are permitted but not with password-based authentication."
29692 #: guix-git/doc/guix.texi:17015 guix-git/doc/guix.texi:17176
29694 msgid "@code{allow-empty-passwords?} (default: @code{#f})"
29698 #: guix-git/doc/guix.texi:17018
29699 msgid "When true, users with empty passwords may log in. When false, they may not."
29703 #: guix-git/doc/guix.texi:17019 guix-git/doc/guix.texi:17179
29705 msgid "@code{password-authentication?} (default: @code{#t})"
29709 #: guix-git/doc/guix.texi:17022
29710 msgid "When true, users may log in with their password. When false, they have other authentication methods."
29714 #: guix-git/doc/guix.texi:17023
29716 msgid "@code{public-key-authentication?} (default: @code{#t})"
29720 #: guix-git/doc/guix.texi:17026
29721 msgid "When true, users may log in using public key authentication. When false, users have to use other authentication method."
29725 #: guix-git/doc/guix.texi:17029
29726 msgid "Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is used only by protocol version 2."
29730 #: guix-git/doc/guix.texi:17030
29732 msgid "@code{x11-forwarding?} (default: @code{#f})"
29736 #: guix-git/doc/guix.texi:17034
29737 msgid "When true, forwarding of X11 graphical client connections is enabled---in other words, @command{ssh} options @option{-X} and @option{-Y} will work."
29741 #: guix-git/doc/guix.texi:17035
29743 msgid "@code{allow-agent-forwarding?} (default: @code{#t})"
29747 #: guix-git/doc/guix.texi:17037
29748 msgid "Whether to allow agent forwarding."
29752 #: guix-git/doc/guix.texi:17038
29754 msgid "@code{allow-tcp-forwarding?} (default: @code{#t})"
29758 #: guix-git/doc/guix.texi:17040
29759 msgid "Whether to allow TCP forwarding."
29763 #: guix-git/doc/guix.texi:17041
29765 msgid "@code{gateway-ports?} (default: @code{#f})"
29769 #: guix-git/doc/guix.texi:17043
29770 msgid "Whether to allow gateway ports."
29774 #: guix-git/doc/guix.texi:17044
29776 msgid "@code{challenge-response-authentication?} (default: @code{#f})"
29780 #: guix-git/doc/guix.texi:17047
29781 msgid "Specifies whether challenge response authentication is allowed (e.g.@: via PAM)."
29785 #: guix-git/doc/guix.texi:17048
29787 msgid "@code{use-pam?} (default: @code{#t})"
29791 #: guix-git/doc/guix.texi:17054
29792 msgid "Enables the Pluggable Authentication Module interface. If set to @code{#t}, this will enable PAM authentication using @code{challenge-response-authentication?} and @code{password-authentication?}, in addition to PAM account and session module processing for all authentication types."
29796 #: guix-git/doc/guix.texi:17059
29797 msgid "Because PAM challenge response authentication usually serves an equivalent role to password authentication, you should disable either @code{challenge-response-authentication?} or @code{password-authentication?}."
29801 #: guix-git/doc/guix.texi:17060
29803 msgid "@code{print-last-log?} (default: @code{#t})"
29807 #: guix-git/doc/guix.texi:17063
29808 msgid "Specifies whether @command{sshd} should print the date and time of the last user login when a user logs in interactively."
29812 #: guix-git/doc/guix.texi:17064
29814 msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})"
29818 #: guix-git/doc/guix.texi:17066
29819 msgid "Configures external subsystems (e.g.@: file transfer daemon)."
29823 #: guix-git/doc/guix.texi:17070
29824 msgid "This is a list of two-element lists, each of which containing the subsystem name and a command (with optional arguments) to execute upon subsystem request."
29828 #: guix-git/doc/guix.texi:17073
29829 msgid "The command @command{internal-sftp} implements an in-process SFTP server. Alternatively, one can specify the @command{sftp-server} command:"
29833 #: guix-git/doc/guix.texi:17078
29836 "(service openssh-service-type\n"
29837 " (openssh-configuration\n"
29839 " `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n"
29843 #: guix-git/doc/guix.texi:17080
29845 msgid "@code{accepted-environment} (default: @code{'()})"
29849 #: guix-git/doc/guix.texi:17082
29850 msgid "List of strings describing which environment variables may be exported."
29854 #: guix-git/doc/guix.texi:17085
29855 msgid "Each string gets on its own line. See the @code{AcceptEnv} option in @code{man sshd_config}."
29859 #: guix-git/doc/guix.texi:17090
29860 msgid "This example allows ssh-clients to export the @env{COLORTERM} variable. It is set by terminal emulators, which support colors. You can use it in your shell's resource file to enable colors for the prompt and commands if this variable is set."
29864 #: guix-git/doc/guix.texi:17095
29867 "(service openssh-service-type\n"
29868 " (openssh-configuration\n"
29869 " (accepted-environment '(\"COLORTERM\"))))\n"
29873 #: guix-git/doc/guix.texi:17097
29875 msgid "@code{authorized-keys} (default: @code{'()})"
29879 #: guix-git/doc/guix.texi:17098
29881 msgid "authorized keys, SSH"
29885 #: guix-git/doc/guix.texi:17099
29887 msgid "SSH authorized keys"
29891 #: guix-git/doc/guix.texi:17103
29892 msgid "This is the list of authorized keys. Each element of the list is a user name followed by one or more file-like objects that represent SSH public keys. For example:"
29896 #: guix-git/doc/guix.texi:17110
29899 "(openssh-configuration\n"
29900 " (authorized-keys\n"
29901 " `((\"rekado\" ,(local-file \"rekado.pub\"))\n"
29902 " (\"chris\" ,(local-file \"chris.pub\"))\n"
29903 " (\"root\" ,(local-file \"rekado.pub\") ,(local-file \"chris.pub\")))))\n"
29907 #: guix-git/doc/guix.texi:17115
29908 msgid "registers the specified public keys for user accounts @code{rekado}, @code{chris}, and @code{root}."
29912 #: guix-git/doc/guix.texi:17118
29913 msgid "Additional authorized keys can be specified @i{via} @code{service-extension}."
29917 #: guix-git/doc/guix.texi:17121
29918 msgid "Note that this does @emph{not} interfere with the use of @file{~/.ssh/authorized_keys}."
29922 #: guix-git/doc/guix.texi:17122 guix-git/doc/guix.texi:17553
29924 msgid "@code{log-level} (default: @code{'info})"
29928 #: guix-git/doc/guix.texi:17126
29929 msgid "This is a symbol specifying the logging level: @code{quiet}, @code{fatal}, @code{error}, @code{info}, @code{verbose}, @code{debug}, etc. See the man page for @file{sshd_config} for the full list of level names."
29933 #: guix-git/doc/guix.texi:17127 guix-git/doc/guix.texi:19947
29934 #: guix-git/doc/guix.texi:24813
29936 msgid "@code{extra-content} (default: @code{\"\"})"
29940 #: guix-git/doc/guix.texi:17132
29941 msgid "This field can be used to append arbitrary text to the configuration file. It is especially useful for elaborate configurations that cannot be expressed otherwise. This configuration, for example, would generally disable root logins, but permit them from one specific IP address:"
29945 #: guix-git/doc/guix.texi:17138
29948 "(openssh-configuration\n"
29949 " (extra-content \"\\\n"
29950 "Match Address 192.168.0.1\n"
29951 " PermitRootLogin yes\"))\n"
29955 #: guix-git/doc/guix.texi:17143
29957 msgid "{Scheme Procedure} dropbear-service [@var{config}]"
29961 #: guix-git/doc/guix.texi:17147
29962 msgid "Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH daemon} with the given @var{config}, a @code{<dropbear-configuration>} object."
29966 #: guix-git/doc/guix.texi:17150
29967 msgid "For example, to specify a Dropbear service listening on port 1234, add this call to the operating system's @code{services} field:"
29971 #: guix-git/doc/guix.texi:17154
29974 "(dropbear-service (dropbear-configuration\n"
29975 " (port-number 1234)))\n"
29979 #: guix-git/doc/guix.texi:17157
29981 msgid "{Data Type} dropbear-configuration"
29985 #: guix-git/doc/guix.texi:17159
29986 msgid "This data type represents the configuration of a Dropbear SSH daemon."
29990 #: guix-git/doc/guix.texi:17161
29992 msgid "@code{dropbear} (default: @var{dropbear})"
29996 #: guix-git/doc/guix.texi:17163
29997 msgid "The Dropbear package to use."
30001 #: guix-git/doc/guix.texi:17164
30003 msgid "@code{port-number} (default: 22)"
30007 #: guix-git/doc/guix.texi:17166
30008 msgid "The TCP port where the daemon waits for incoming connections."
30012 #: guix-git/doc/guix.texi:17167
30014 msgid "@code{syslog-output?} (default: @code{#t})"
30018 #: guix-git/doc/guix.texi:17169
30019 msgid "Whether to enable syslog output."
30023 #: guix-git/doc/guix.texi:17170
30025 msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})"
30029 #: guix-git/doc/guix.texi:17172
30030 msgid "File name of the daemon's PID file."
30034 #: guix-git/doc/guix.texi:17173
30036 msgid "@code{root-login?} (default: @code{#f})"
30040 #: guix-git/doc/guix.texi:17175
30041 msgid "Whether to allow @code{root} logins."
30045 #: guix-git/doc/guix.texi:17178
30046 msgid "Whether to allow empty passwords."
30050 #: guix-git/doc/guix.texi:17181
30051 msgid "Whether to enable password-based authentication."
30055 #: guix-git/doc/guix.texi:17184
30061 #: guix-git/doc/guix.texi:17185
30063 msgid "{Scheme Variable} autossh-service-type"
30067 #: guix-git/doc/guix.texi:17193
30068 msgid "This is the type for the @uref{https://www.harding.motd.ca/autossh, AutoSSH} program that runs a copy of @command{ssh} and monitors it, restarting it as necessary should it die or stop passing traffic. AutoSSH can be run manually from the command-line by passing arguments to the binary @command{autossh} from the package @code{autossh}, but it can also be run as a Guix service. This latter use case is documented here."
30072 #: guix-git/doc/guix.texi:17197
30073 msgid "AutoSSH can be used to forward local traffic to a remote machine using an SSH tunnel, and it respects the @file{~/.ssh/config} of the user it is run as."
30077 #: guix-git/doc/guix.texi:17202
30078 msgid "For example, to specify a service running autossh as the user @code{pino} and forwarding all local connections to port @code{8081} to @code{remote:8081} using an SSH tunnel, add this call to the operating system's @code{services} field:"
30082 #: guix-git/doc/guix.texi:17208
30085 "(service autossh-service-type\n"
30086 " (autossh-configuration\n"
30087 " (user \"pino\")\n"
30088 " (ssh-options (list \"-T\" \"-N\" \"-L\" \"8081:localhost:8081\" \"remote.net\"))))\n"
30092 #: guix-git/doc/guix.texi:17211
30094 msgid "{Data Type} autossh-configuration"
30098 #: guix-git/doc/guix.texi:17213
30099 msgid "This data type represents the configuration of an AutoSSH service."
30103 #: guix-git/doc/guix.texi:17216
30105 msgid "@code{user} (default @code{\"autossh\"})"
30109 #: guix-git/doc/guix.texi:17219
30110 msgid "The user as which the AutoSSH service is to be run. This assumes that the specified user exists."
30114 #: guix-git/doc/guix.texi:17220
30116 msgid "@code{poll} (default @code{600})"
30120 #: guix-git/doc/guix.texi:17222
30121 msgid "Specifies the connection poll time in seconds."
30125 #: guix-git/doc/guix.texi:17223
30127 msgid "@code{first-poll} (default @code{#f})"
30131 #: guix-git/doc/guix.texi:17229
30132 msgid "Specifies how many seconds AutoSSH waits before the first connection test. After this first test, polling is resumed at the pace defined in @code{poll}. When set to @code{#f}, the first poll is not treated specially and will also use the connection poll specified in @code{poll}."
30136 #: guix-git/doc/guix.texi:17230
30138 msgid "@code{gate-time} (default @code{30})"
30142 #: guix-git/doc/guix.texi:17233
30143 msgid "Specifies how many seconds an SSH connection must be active before it is considered successful."
30147 #: guix-git/doc/guix.texi:17234
30149 msgid "@code{log-level} (default @code{1})"
30153 #: guix-git/doc/guix.texi:17237
30154 msgid "The log level, corresponding to the levels used by syslog---so @code{0} is the most silent while @code{7} is the chattiest."
30158 #: guix-git/doc/guix.texi:17238
30160 msgid "@code{max-start} (default @code{#f})"
30164 #: guix-git/doc/guix.texi:17241
30165 msgid "The maximum number of times SSH may be (re)started before AutoSSH exits. When set to @code{#f}, no maximum is configured and AutoSSH may restart indefinitely."
30169 #: guix-git/doc/guix.texi:17242
30171 msgid "@code{message} (default @code{\"\"})"
30175 #: guix-git/doc/guix.texi:17244
30176 msgid "The message to append to the echo message sent when testing connections."
30180 #: guix-git/doc/guix.texi:17245
30182 msgid "@code{port} (default @code{\"0\"})"
30186 #: guix-git/doc/guix.texi:17255
30187 msgid "The ports used for monitoring the connection. When set to @code{\"0\"}, monitoring is disabled. When set to @code{\"@var{n}\"} where @var{n} is a positive integer, ports @var{n} and @var{n}+1 are used for monitoring the connection, such that port @var{n} is the base monitoring port and @code{n+1} is the echo port. When set to @code{\"@var{n}:@var{m}\"} where @var{n} and @var{m} are positive integers, the ports @var{n} and @var{m} are used for monitoring the connection, such that port @var{n} is the base monitoring port and @var{m} is the echo port."
30191 #: guix-git/doc/guix.texi:17256
30193 msgid "@code{ssh-options} (default @code{'()})"
30197 #: guix-git/doc/guix.texi:17260
30198 msgid "The list of command-line arguments to pass to @command{ssh} when it is run. Options @option{-f} and @option{-M} are reserved for AutoSSH and may cause undefined behaviour."
30202 #: guix-git/doc/guix.texi:17264
30208 #: guix-git/doc/guix.texi:17265
30210 msgid "{Scheme Variable} webssh-service-type"
30214 #: guix-git/doc/guix.texi:17271
30215 msgid "This is the type for the @uref{https://webssh.huashengdun.org/, WebSSH} program that runs a web SSH client. WebSSH can be run manually from the command-line by passing arguments to the binary @command{wssh} from the package @code{webssh}, but it can also be run as a Guix service. This latter use case is documented here."
30219 #: guix-git/doc/guix.texi:17277
30220 msgid "For example, to specify a service running WebSSH on loopback interface on port @code{8888} with reject policy with a list of allowed to connection hosts, and NGINX as a reverse-proxy to this service listening for HTTPS connection, add this call to the operating system's @code{services} field:"
30224 #: guix-git/doc/guix.texi:17285
30227 "(service webssh-service-type\n"
30228 " (webssh-configuration (address \"127.0.0.1\")\n"
30230 " (policy 'reject)\n"
30231 " (known-hosts '(\"localhost ecdsa-sha2-nistp256 AAAA…\"\n"
30232 " \"127.0.0.1 ecdsa-sha2-nistp256 AAAA…\"))))\n"
30237 #: guix-git/doc/guix.texi:17301
30240 "(service nginx-service-type\n"
30241 " (nginx-configuration\n"
30242 " (server-blocks\n"
30244 " (nginx-server-configuration\n"
30245 " (inherit %webssh-configuration-nginx)\n"
30246 " (server-name '(\"webssh.example.com\"))\n"
30247 " (listen '(\"443 ssl\"))\n"
30248 " (ssl-certificate (letsencrypt-certificate \"webssh.example.com\"))\n"
30249 " (ssl-certificate-key (letsencrypt-key \"webssh.example.com\"))\n"
30251 " (cons (nginx-location-configuration\n"
30252 " (uri \"/.well-known\")\n"
30253 " (body '(\"root /var/www;\")))\n"
30254 " (nginx-server-configuration-locations %webssh-configuration-nginx))))))))\n"
30258 #: guix-git/doc/guix.texi:17304
30260 msgid "{Data Type} webssh-configuration"
30264 #: guix-git/doc/guix.texi:17306
30265 msgid "Data type representing the configuration for @code{webssh-service}."
30269 #: guix-git/doc/guix.texi:17308
30271 msgid "@code{package} (default: @var{webssh})"
30275 #: guix-git/doc/guix.texi:17310
30276 msgid "@code{webssh} package to use."
30280 #: guix-git/doc/guix.texi:17311
30282 msgid "@code{user-name} (default: @var{\"webssh\"})"
30286 #: guix-git/doc/guix.texi:17314
30287 msgid "User name or user ID that file transfers to and from that module should take place."
30291 #: guix-git/doc/guix.texi:17315
30293 msgid "@code{group-name} (default: @var{\"webssh\"})"
30297 #: guix-git/doc/guix.texi:17318
30299 msgid "@code{address} (default: @var{#f})"
30303 #: guix-git/doc/guix.texi:17320
30304 msgid "IP address on which @command{webssh} listens for incoming connections."
30308 #: guix-git/doc/guix.texi:17321
30310 msgid "@code{port} (default: @var{8888})"
30314 #: guix-git/doc/guix.texi:17323
30315 msgid "TCP port on which @command{webssh} listens for incoming connections."
30319 #: guix-git/doc/guix.texi:17324
30321 msgid "@code{policy} (default: @var{#f})"
30325 #: guix-git/doc/guix.texi:17326
30326 msgid "Connection policy. @var{reject} policy requires to specify @var{known-hosts}."
30330 #: guix-git/doc/guix.texi:17327
30332 msgid "@code{known-hosts} (default: @var{'()})"
30336 #: guix-git/doc/guix.texi:17329
30337 msgid "List of hosts which allowed for SSH connection from @command{webssh}."
30341 #: guix-git/doc/guix.texi:17330
30343 msgid "@code{log-file} (default: @file{\"/var/log/webssh.log\"})"
30347 #: guix-git/doc/guix.texi:17332
30348 msgid "Name of the file where @command{webssh} writes its log file."
30352 #: guix-git/doc/guix.texi:17333
30354 msgid "@code{log-level} (default: @var{#f})"
30358 #: guix-git/doc/guix.texi:17335
30359 msgid "Logging level."
30363 #: guix-git/doc/guix.texi:17339
30365 msgid "{Scheme Variable} %facebook-host-aliases"
30369 #: guix-git/doc/guix.texi:17345
30370 msgid "This variable contains a string for use in @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). Each line contains a entry that maps a known server name of the Facebook on-line service---e.g., @code{www.facebook.com}---to the local host---@code{127.0.0.1} or its IPv6 equivalent, @code{::1}."
30374 #: guix-git/doc/guix.texi:17349
30375 msgid "This variable is typically used in the @code{hosts-file} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @file{/etc/hosts}}):"
30379 #: guix-git/doc/guix.texi:17362
30382 "(operating-system\n"
30383 " (host-name \"mymachine\")\n"
30386 " ;; Create a /etc/hosts file with aliases for \"localhost\"\n"
30387 " ;; and \"mymachine\", as well as for Facebook servers.\n"
30388 " (plain-file \"hosts\"\n"
30389 " (string-append (local-host-aliases host-name)\n"
30390 " %facebook-host-aliases))))\n"
30394 #: guix-git/doc/guix.texi:17366
30395 msgid "This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook."
30398 #. type: Plain text
30399 #: guix-git/doc/guix.texi:17369
30400 msgid "The @code{(gnu services avahi)} provides the following definition."
30404 #: guix-git/doc/guix.texi:17370
30406 msgid "{Scheme Variable} avahi-service-type"
30410 #: guix-git/doc/guix.texi:17375
30411 msgid "This is the service that runs @command{avahi-daemon}, a system-wide mDNS/DNS-SD responder that allows for service discovery and ``zero-configuration'' host name lookups (see @uref{https://avahi.org/}). Its value must be an @code{avahi-configuration} record---see below."
30415 #: guix-git/doc/guix.texi:17380
30416 msgid "This service extends the name service cache daemon (nscd) so that it can resolve @code{.local} host names using @uref{https://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. @xref{Name Service Switch}, for information on host name resolution."
30420 #: guix-git/doc/guix.texi:17383
30421 msgid "Additionally, add the @var{avahi} package to the system profile so that commands such as @command{avahi-browse} are directly usable."
30425 #: guix-git/doc/guix.texi:17385
30427 msgid "{Data Type} avahi-configuration"
30431 #: guix-git/doc/guix.texi:17387
30432 msgid "Data type representation the configuration for Avahi."
30436 #: guix-git/doc/guix.texi:17390
30438 msgid "@code{host-name} (default: @code{#f})"
30442 #: guix-git/doc/guix.texi:17393
30443 msgid "If different from @code{#f}, use that as the host name to publish for this machine; otherwise, use the machine's actual host name."
30447 #: guix-git/doc/guix.texi:17394
30449 msgid "@code{publish?} (default: @code{#t})"
30453 #: guix-git/doc/guix.texi:17397
30454 msgid "When true, allow host names and services to be published (broadcast) over the network."
30458 #: guix-git/doc/guix.texi:17398
30460 msgid "@code{publish-workstation?} (default: @code{#t})"
30464 #: guix-git/doc/guix.texi:17402
30465 msgid "When true, @command{avahi-daemon} publishes the machine's host name and IP address via mDNS on the local network. To view the host names published on your local network, you can run:"
30469 #: guix-git/doc/guix.texi:17405
30471 msgid "avahi-browse _workstation._tcp\n"
30475 #: guix-git/doc/guix.texi:17407
30477 msgid "@code{wide-area?} (default: @code{#f})"
30481 #: guix-git/doc/guix.texi:17409
30482 msgid "When true, DNS-SD over unicast DNS is enabled."
30486 #: guix-git/doc/guix.texi:17410
30488 msgid "@code{ipv4?} (default: @code{#t})"
30492 #: guix-git/doc/guix.texi:17411
30494 msgid "@code{ipv6?} (default: @code{#t})"
30498 #: guix-git/doc/guix.texi:17413
30499 msgid "These fields determine whether to use IPv4/IPv6 sockets."
30503 #: guix-git/doc/guix.texi:17414
30505 msgid "@code{domains-to-browse} (default: @code{'()})"
30509 #: guix-git/doc/guix.texi:17416
30510 msgid "This is a list of domains to browse."
30514 #: guix-git/doc/guix.texi:17419
30516 msgid "{Scheme Variable} openvswitch-service-type"
30520 #: guix-git/doc/guix.texi:17423
30521 msgid "This is the type of the @uref{https://www.openvswitch.org, Open vSwitch} service, whose value should be an @code{openvswitch-configuration} object."
30525 #: guix-git/doc/guix.texi:17425
30527 msgid "{Data Type} openvswitch-configuration"
30531 #: guix-git/doc/guix.texi:17429
30532 msgid "Data type representing the configuration of Open vSwitch, a multilayer virtual switch which is designed to enable massive network automation through programmatic extension."
30536 #: guix-git/doc/guix.texi:17431
30538 msgid "@code{package} (default: @var{openvswitch})"
30542 #: guix-git/doc/guix.texi:17433
30543 msgid "Package object of the Open vSwitch."
30547 #: guix-git/doc/guix.texi:17437
30549 msgid "{Scheme Variable} pagekite-service-type"
30553 #: guix-git/doc/guix.texi:17442
30554 msgid "This is the service type for the @uref{https://pagekite.net, PageKite} service, a tunneling solution for making localhost servers publicly visible, even from behind restrictive firewalls or NAT without forwarded ports. The value for this service type is a @code{pagekite-configuration} record."
30558 #: guix-git/doc/guix.texi:17444
30559 msgid "Here's an example exposing the local HTTP and SSH daemons:"
30563 #: guix-git/doc/guix.texi:17451
30566 "(service pagekite-service-type\n"
30567 " (pagekite-configuration\n"
30568 " (kites '(\"http:@@kitename:localhost:80:@@kitesecret\"\n"
30569 " \"raw/22:@@kitename:localhost:22:@@kitesecret\"))\n"
30570 " (extra-file \"/etc/pagekite.rc\")))\n"
30574 #: guix-git/doc/guix.texi:17454
30576 msgid "{Data Type} pagekite-configuration"
30580 #: guix-git/doc/guix.texi:17456
30581 msgid "Data type representing the configuration of PageKite."
30585 #: guix-git/doc/guix.texi:17458
30587 msgid "@code{package} (default: @var{pagekite})"
30591 #: guix-git/doc/guix.texi:17460
30592 msgid "Package object of PageKite."
30596 #: guix-git/doc/guix.texi:17461
30598 msgid "@code{kitename} (default: @code{#f})"
30602 #: guix-git/doc/guix.texi:17463
30603 msgid "PageKite name for authenticating to the frontend server."
30607 #: guix-git/doc/guix.texi:17464
30609 msgid "@code{kitesecret} (default: @code{#f})"
30613 #: guix-git/doc/guix.texi:17467
30614 msgid "Shared secret for authenticating to the frontend server. You should probably put this inside @code{extra-file} instead."
30618 #: guix-git/doc/guix.texi:17468
30620 msgid "@code{frontend} (default: @code{#f})"
30624 #: guix-git/doc/guix.texi:17471
30625 msgid "Connect to the named PageKite frontend server instead of the @uref{https://pagekite.net,,pagekite.net} service."
30629 #: guix-git/doc/guix.texi:17472
30631 msgid "@code{kites} (default: @code{'(\"http:@@kitename:localhost:80:@@kitesecret\")})"
30635 #: guix-git/doc/guix.texi:17475
30636 msgid "List of service kites to use. Exposes HTTP on port 80 by default. The format is @code{proto:kitename:host:port:secret}."
30640 #: guix-git/doc/guix.texi:17476
30642 msgid "@code{extra-file} (default: @code{#f})"
30646 #: guix-git/doc/guix.texi:17479
30647 msgid "Extra configuration file to read, which you are expected to create manually. Use this to add additional options and manage shared secrets out-of-band."
30651 #: guix-git/doc/guix.texi:17483
30653 msgid "{Scheme Variable} yggdrasil-service-type"
30657 #: guix-git/doc/guix.texi:17487
30658 msgid "The service type for connecting to the @uref{https://yggdrasil-network.github.io/, Yggdrasil network}, an early-stage implementation of a fully end-to-end encrypted IPv6 network."
30662 #: guix-git/doc/guix.texi:17494
30663 msgid "Yggdrasil provides name-independent routing with cryptographically generated addresses. Static addressing means you can keep the same address as long as you want, even if you move to a new location, or generate a new address (by generating new keys) whenever you want. @uref{https://yggdrasil-network.github.io/2018/07/28/addressing.html}"
30667 #: guix-git/doc/guix.texi:17498
30668 msgid "Pass it a value of @code{yggdrasil-configuration} to connect it to public peers and/or local peers."
30672 #: guix-git/doc/guix.texi:17502
30673 msgid "Here is an example using public peers and a static address. The static signing and encryption keys are defined in @file{/etc/yggdrasil-private.conf} (the default value for @code{config-file})."
30677 #: guix-git/doc/guix.texi:17514
30680 ";; part of the operating-system declaration\n"
30681 "(service yggdrasil-service-type\n"
30682 " (yggdrasil-configuration\n"
30683 " (autoconf? #f) ;; use only the public peers\n"
30685 " ;; choose one from\n"
30686 " ;; https://github.com/yggdrasil-network/public-peers\n"
30687 " '((peers . #(\"tcp://1.2.3.4:1337\"))))\n"
30688 " ;; /etc/yggdrasil-private.conf is the default value for config-file\n"
30693 #: guix-git/doc/guix.texi:17521
30696 "# sample content for /etc/yggdrasil-private.conf\n"
30698 " # Your public encryption key. Your peers may ask you for this to put\n"
30699 " # into their AllowedEncryptionPublicKeys configuration.\n"
30700 " EncryptionPublicKey: 378dc5...\n"
30705 #: guix-git/doc/guix.texi:17524
30708 " # Your private encryption key. DO NOT share this with anyone!\n"
30709 " EncryptionPrivateKey: 0777...\n"
30714 #: guix-git/doc/guix.texi:17528
30717 " # Your public signing key. You should not ordinarily need to share\n"
30718 " # this with anyone.\n"
30719 " SigningPublicKey: e1664...\n"
30724 #: guix-git/doc/guix.texi:17532
30727 " # Your private signing key. DO NOT share this with anyone!\n"
30728 " SigningPrivateKey: 0589d...\n"
30733 #: guix-git/doc/guix.texi:17535
30735 msgid "{Data Type} yggdrasil-configuration"
30739 #: guix-git/doc/guix.texi:17537
30740 msgid "Data type representing the configuration of Yggdrasil."
30744 #: guix-git/doc/guix.texi:17539
30746 msgid "@code{package} (default: @code{yggdrasil})"
30750 #: guix-git/doc/guix.texi:17541
30751 msgid "Package object of Yggdrasil."
30755 #: guix-git/doc/guix.texi:17542
30757 msgid "@code{json-config} (default: @code{'()})"
30761 #: guix-git/doc/guix.texi:17548
30762 msgid "Contents of @file{/etc/yggdrasil.conf}. Will be merged with @file{/etc/yggdrasil-private.conf}. Note that these settings are stored in the Guix store, which is readable to all users. @strong{Do not store your private keys in it}. See the output of @code{yggdrasil -genconf} for a quick overview of valid keys and their default values."
30766 #: guix-git/doc/guix.texi:17549
30768 msgid "@code{autoconf?} (default: @code{#f})"
30772 #: guix-git/doc/guix.texi:17552
30773 msgid "Whether to use automatic mode. Enabling it makes Yggdrasil use adynamic IP and peer with IPv6 neighbors."
30777 #: guix-git/doc/guix.texi:17555
30778 msgid "How much detail to include in logs. Use @code{'debug} for more detail."
30782 #: guix-git/doc/guix.texi:17556
30784 msgid "@code{log-to} (default: @code{'stdout})"
30788 #: guix-git/doc/guix.texi:17560
30789 msgid "Where to send logs. By default, the service logs standard output to @file{/var/log/yggdrasil.log}. The alternative is @code{'syslog}, which sends output to the running syslog service."
30793 #: guix-git/doc/guix.texi:17561
30795 msgid "@code{config-file} (default: @code{\"/etc/yggdrasil-private.conf\"})"
30799 #: guix-git/doc/guix.texi:17568
30800 msgid "What HJSON file to load sensitive data from. This is where private keys should be stored, which are necessary to specify if you don't want a randomized address after each restart. Use @code{#f} to disable. Options defined in this file take precedence over @code{json-config}. Use the output of @code{yggdrasil -genconf} as a starting point. To configure a static address, delete everything except these options:"
30804 #: guix-git/doc/guix.texi:17570
30806 msgid "EncryptionPublicKey"
30810 #: guix-git/doc/guix.texi:17571
30812 msgid "EncryptionPrivateKey"
30816 #: guix-git/doc/guix.texi:17572
30818 msgid "SigningPublicKey"
30822 #: guix-git/doc/guix.texi:17573
30824 msgid "SigningPrivateKey"
30828 #: guix-git/doc/guix.texi:17578
30834 #: guix-git/doc/guix.texi:17579
30836 msgid "{Scheme Variable} ipfs-service-type"
30840 #: guix-git/doc/guix.texi:17583
30841 msgid "The service type for connecting to the @uref{https://ipfs.io,IPFS network}, a global, versioned, peer-to-peer file system. Pass it a @code{ipfs-configuration} to change the ports used for the gateway and API."
30845 #: guix-git/doc/guix.texi:17585
30846 msgid "Here's an example configuration, using some non-standard ports:"
30850 #: guix-git/doc/guix.texi:17591
30853 "(service ipfs-service-type\n"
30854 " (ipfs-configuration\n"
30855 " (gateway \"/ip4/127.0.0.1/tcp/8880\")\n"
30856 " (api \"/ip4/127.0.0.1/tcp/8881\")))\n"
30860 #: guix-git/doc/guix.texi:17594
30862 msgid "{Data Type} ipfs-configuration"
30866 #: guix-git/doc/guix.texi:17596
30867 msgid "Data type representing the configuration of IPFS."
30871 #: guix-git/doc/guix.texi:17598
30873 msgid "@code{package} (default: @code{go-ipfs})"
30877 #: guix-git/doc/guix.texi:17600
30878 msgid "Package object of IPFS."
30882 #: guix-git/doc/guix.texi:17601
30884 msgid "@code{gateway} (default: @code{\"/ip4/127.0.0.1/tcp/8082\"})"
30888 #: guix-git/doc/guix.texi:17603
30889 msgid "Address of the gateway, in ‘multiaddress’ format."
30893 #: guix-git/doc/guix.texi:17604
30895 msgid "@code{api} (default: @code{\"/ip4/127.0.0.1/tcp/5001\"})"
30899 #: guix-git/doc/guix.texi:17606
30900 msgid "Address of the API endpoint, in ‘multiaddress’ format."
30904 #: guix-git/doc/guix.texi:17609
30910 #: guix-git/doc/guix.texi:17610
30912 msgid "{Scheme Variable} keepalived-service-type"
30916 #: guix-git/doc/guix.texi:17615
30917 msgid "This is the type for the @uref{https://www.keepalived.org/, Keepalived} routing software, @command{keepalived}. Its value must be an @code{keepalived-configuration} record as in this example for master machine:"
30921 #: guix-git/doc/guix.texi:17620
30924 "(service keepalived-service-type\n"
30925 " (keepalived-configuration\n"
30926 " (config-file (local-file \"keepalived-master.conf\"))))\n"
30930 #: guix-git/doc/guix.texi:17623
30931 msgid "where @file{keepalived-master.conf}:"
30935 #: guix-git/doc/guix.texi:17635
30938 "vrrp_instance my-group @{\n"
30940 " interface enp9s0\n"
30941 " virtual_router_id 100\n"
30943 " unicast_peer @{ 10.0.0.2 @}\n"
30944 " virtual_ipaddress @{\n"
30951 #: guix-git/doc/guix.texi:17638
30952 msgid "and for backup machine:"
30956 #: guix-git/doc/guix.texi:17643
30959 "(service keepalived-service-type\n"
30960 " (keepalived-configuration\n"
30961 " (config-file (local-file \"keepalived-backup.conf\"))))\n"
30965 #: guix-git/doc/guix.texi:17646
30966 msgid "where @file{keepalived-backup.conf}:"
30970 #: guix-git/doc/guix.texi:17658
30973 "vrrp_instance my-group @{\n"
30975 " interface enp9s0\n"
30976 " virtual_router_id 100\n"
30978 " unicast_peer @{ 10.0.0.3 @}\n"
30979 " virtual_ipaddress @{\n"
30986 #: guix-git/doc/guix.texi:17664
30988 msgid "unattended upgrades"
30992 #: guix-git/doc/guix.texi:17665
30994 msgid "upgrades, unattended"
30997 #. type: Plain text
30998 #: guix-git/doc/guix.texi:17670
30999 msgid "Guix provides a service to perform @emph{unattended upgrades}: periodically, the system automatically reconfigures itself from the latest Guix. Guix System has several properties that make unattended upgrades safe:"
31003 #: guix-git/doc/guix.texi:17675
31004 msgid "upgrades are transactional (either the upgrade succeeds or it fails, but you cannot end up with an ``in-between'' system state);"
31008 #: guix-git/doc/guix.texi:17679
31009 msgid "the upgrade log is kept---you can view it with @command{guix system list-generations}---and you can roll back to any previous generation, should the upgraded system fail to behave as intended;"
31013 #: guix-git/doc/guix.texi:17682
31014 msgid "channel code is authenticated so you know you can only run genuine code (@pxref{Channels});"
31018 #: guix-git/doc/guix.texi:17685
31019 msgid "@command{guix system reconfigure} prevents downgrades, which makes it immune to @dfn{downgrade attacks}."
31022 #. type: Plain text
31023 #: guix-git/doc/guix.texi:17690
31024 msgid "To set up unattended upgrades, add an instance of @code{unattended-upgrade-service-type} like the one below to the list of your operating system services:"
31028 #: guix-git/doc/guix.texi:17693
31030 msgid "(service unattended-upgrade-service-type)\n"
31033 #. type: Plain text
31034 #: guix-git/doc/guix.texi:17700
31035 msgid "The defaults above set up weekly upgrades: every Sunday at midnight. You do not need to provide the operating system configuration file: it uses @file{/run/current-system/configuration.scm}, which ensures it always uses your latest configuration---@pxref{provenance-service-type}, for more information about this file."
31038 #. type: Plain text
31039 #: guix-git/doc/guix.texi:17706
31040 msgid "There are several things that can be configured, in particular the periodicity and services (daemons) to be restarted upon completion. When the upgrade is successful, the service takes care of deleting system generations older that some threshold, as per @command{guix system delete-generations}. See the reference below for details."
31043 #. type: Plain text
31044 #: guix-git/doc/guix.texi:17710
31045 msgid "To ensure that upgrades are actually happening, you can run @command{guix system describe}. To investigate upgrade failures, visit the unattended upgrade log file (see below)."
31049 #: guix-git/doc/guix.texi:17711
31051 msgid "{Scheme Variable} unattended-upgrade-service-type"
31055 #: guix-git/doc/guix.texi:17715
31056 msgid "This is the service type for unattended upgrades. It sets up an mcron job (@pxref{Scheduled Job Execution}) that runs @command{guix system reconfigure} from the latest version of the specified channels."
31060 #: guix-git/doc/guix.texi:17718
31061 msgid "Its value must be a @code{unattended-upgrade-configuration} record (see below)."
31065 #: guix-git/doc/guix.texi:17720
31067 msgid "{Data Type} unattended-upgrade-configuration"
31071 #: guix-git/doc/guix.texi:17723
31072 msgid "This data type represents the configuration of the unattended upgrade service. The following fields are available:"
31076 #: guix-git/doc/guix.texi:17725
31078 msgid "@code{schedule} (default: @code{\"30 01 * * 0\"})"
31082 #: guix-git/doc/guix.texi:17729
31083 msgid "This is the schedule of upgrades, expressed as a gexp containing an mcron job schedule (@pxref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron})."
31087 #: guix-git/doc/guix.texi:17730
31089 msgid "@code{channels} (default: @code{#~%default-channels})"
31093 #: guix-git/doc/guix.texi:17734
31094 msgid "This gexp specifies the channels to use for the upgrade (@pxref{Channels}). By default, the tip of the official @code{guix} channel is used."
31098 #: guix-git/doc/guix.texi:17735
31100 msgid "@code{operating-system-file} (default: @code{\"/run/current-system/configuration.scm\"})"
31104 #: guix-git/doc/guix.texi:17738
31105 msgid "This field specifies the operating system configuration file to use. The default is to reuse the config file of the current configuration."
31109 #: guix-git/doc/guix.texi:17744
31110 msgid "There are cases, though, where referring to @file{/run/current-system/configuration.scm} is not enough, for instance because that file refers to extra files (SSH public keys, extra configuration files, etc.) @i{via} @code{local-file} and similar constructs. For those cases, we recommend something along these lines:"
31114 #: guix-git/doc/guix.texi:17750
31117 "(unattended-upgrade-configuration\n"
31118 " (operating-system-file\n"
31119 " (file-append (local-file \".\" \"config-dir\" #:recursive? #t)\n"
31120 " \"/config.scm\")))\n"
31124 #: guix-git/doc/guix.texi:17757
31125 msgid "The effect here is to import all of the current directory into the store, and to refer to @file{config.scm} within that directory. Therefore, uses of @code{local-file} within @file{config.scm} will work as expected. @xref{G-Expressions}, for information about @code{local-file} and @code{file-append}."
31129 #: guix-git/doc/guix.texi:17758
31131 msgid "@code{services-to-restart} (default: @code{'(mcron)})"
31135 #: guix-git/doc/guix.texi:17761
31136 msgid "This field specifies the Shepherd services to restart when the upgrade completes."
31140 #: guix-git/doc/guix.texi:17768
31141 msgid "Those services are restarted right away upon completion, as with @command{herd restart}, which ensures that the latest version is running---remember that by default @command{guix system reconfigure} only restarts services that are not currently running, which is conservative: it minimizes disruption but leaves outdated services running."
31145 #: guix-git/doc/guix.texi:17772
31146 msgid "Use @command{herd status} to find out candidates for restarting. @xref{Services}, for general information about services. Common services to restart would include @code{ntpd} and @code{ssh-daemon}."
31150 #: guix-git/doc/guix.texi:17775
31151 msgid "By default, the @code{mcron} service is restarted. This ensures that the latest version of the unattended upgrade job will be used next time."
31155 #: guix-git/doc/guix.texi:17776
31157 msgid "@code{system-expiration} (default: @code{(* 3 30 24 3600)})"
31161 #: guix-git/doc/guix.texi:17780
31162 msgid "This is the expiration time in seconds for system generations. System generations older that this amount of time are deleted with @command{guix system delete-generations} when an upgrade completes."
31166 #: guix-git/doc/guix.texi:17785
31167 msgid "The unattended upgrade service does not run the garbage collector. You will probably want to set up your own mcron job to run @command{guix gc} periodically."
31171 #: guix-git/doc/guix.texi:17787
31173 msgid "@code{maximum-duration} (default: @code{3600})"
31177 #: guix-git/doc/guix.texi:17790
31178 msgid "Maximum duration in seconds for the upgrade; past that time, the upgrade aborts."
31182 #: guix-git/doc/guix.texi:17793
31183 msgid "This is primarily useful to ensure the upgrade does not end up rebuilding or re-downloading ``the world''."
31187 #: guix-git/doc/guix.texi:17794
31189 msgid "@code{log-file} (default: @code{\"/var/log/unattended-upgrade.log\"})"
31193 #: guix-git/doc/guix.texi:17796
31194 msgid "File where unattended upgrades are logged."
31198 #: guix-git/doc/guix.texi:17802
31204 #: guix-git/doc/guix.texi:17803
31206 msgid "X Window System"
31210 #: guix-git/doc/guix.texi:17804 guix-git/doc/guix.texi:18056
31212 msgid "login manager"
31215 #. type: Plain text
31216 #: guix-git/doc/guix.texi:17809
31217 msgid "Support for the X Window graphical display system---specifically Xorg---is provided by the @code{(gnu services xorg)} module. Note that there is no @code{xorg-service} procedure. Instead, the X server is started by the @dfn{login manager}, by default the GNOME Display Manager (GDM)."
31221 #: guix-git/doc/guix.texi:17810
31227 #: guix-git/doc/guix.texi:17811
31229 msgid "GNOME, login manager"
31232 #. type: Plain text
31233 #: guix-git/doc/guix.texi:17815
31234 msgid "GDM of course allows users to log in into window managers and desktop environments other than GNOME; for those using GNOME, GDM is required for features such as automatic screen locking."
31238 #: guix-git/doc/guix.texi:17816
31240 msgid "window manager"
31243 #. type: Plain text
31244 #: guix-git/doc/guix.texi:17821
31245 msgid "To use X11, you must install at least one @dfn{window manager}---for example the @code{windowmaker} or @code{openbox} packages---preferably by adding it to the @code{packages} field of your operating system definition (@pxref{operating-system Reference, system-wide packages})."
31249 #: guix-git/doc/guix.texi:17822
31251 msgid "{Scheme Variable} gdm-service-type"
31255 #: guix-git/doc/guix.texi:17827
31256 msgid "This is the type for the @uref{https://wiki.gnome.org/Projects/GDM/, GNOME Desktop Manager} (GDM), a program that manages graphical display servers and handles graphical user logins. Its value must be a @code{gdm-configuration} (see below)."
31260 #: guix-git/doc/guix.texi:17828
31262 msgid "session types (X11)"
31266 #: guix-git/doc/guix.texi:17829
31268 msgid "X11 session types"
31272 #: guix-git/doc/guix.texi:17835
31273 msgid "GDM looks for @dfn{session types} described by the @file{.desktop} files in @file{/run/current-system/profile/share/xsessions} and allows users to choose a session from the log-in screen. Packages such as @code{gnome}, @code{xfce}, and @code{i3} provide @file{.desktop} files; adding them to the system-wide set of packages automatically makes them available at the log-in screen."
31277 #: guix-git/doc/guix.texi:17839
31278 msgid "In addition, @file{~/.xsession} files are honored. When available, @file{~/.xsession} must be an executable that starts a window manager and/or other X clients."
31282 #: guix-git/doc/guix.texi:17841
31284 msgid "{Data Type} gdm-configuration"
31288 #: guix-git/doc/guix.texi:17843 guix-git/doc/guix.texi:17911
31290 msgid "@code{auto-login?} (default: @code{#f})"
31294 #: guix-git/doc/guix.texi:17844
31296 msgid "@code{default-user} (default: @code{#f})"
31300 #: guix-git/doc/guix.texi:17846
31301 msgid "When @code{auto-login?} is false, GDM presents a log-in screen."
31305 #: guix-git/doc/guix.texi:17849
31306 msgid "When @code{auto-login?} is true, GDM logs in directly as @code{default-user}."
31310 #: guix-git/doc/guix.texi:17850 guix-git/doc/guix.texi:23422
31311 #: guix-git/doc/guix.texi:25130 guix-git/doc/guix.texi:29480
31312 #: guix-git/doc/guix.texi:29509 guix-git/doc/guix.texi:29538
31313 #: guix-git/doc/guix.texi:29565 guix-git/doc/guix.texi:29620
31314 #: guix-git/doc/guix.texi:29645 guix-git/doc/guix.texi:29672
31315 #: guix-git/doc/guix.texi:29698 guix-git/doc/guix.texi:29740
31317 msgid "@code{debug?} (default: @code{#f})"
31321 #: guix-git/doc/guix.texi:17852
31322 msgid "When true, GDM writes debug messages to its log."
31326 #: guix-git/doc/guix.texi:17853
31328 msgid "@code{gnome-shell-assets} (default: ...)"
31332 #: guix-git/doc/guix.texi:17855
31333 msgid "List of GNOME Shell assets needed by GDM: icon theme, fonts, etc."
31337 #: guix-git/doc/guix.texi:17856
31339 msgid "@code{xorg-configuration} (default: @code{(xorg-configuration)})"
31343 #: guix-git/doc/guix.texi:17858 guix-git/doc/guix.texi:17938
31344 #: guix-git/doc/guix.texi:18022
31345 msgid "Configuration of the Xorg graphical server."
31349 #: guix-git/doc/guix.texi:17859
31351 msgid "@code{xsession} (default: @code{(xinitrc)})"
31355 #: guix-git/doc/guix.texi:17861 guix-git/doc/guix.texi:18037
31356 msgid "Script to run before starting a X session."
31360 #: guix-git/doc/guix.texi:17862
31362 msgid "@code{dbus-daemon} (default: @code{dbus-daemon-wrapper})"
31366 #: guix-git/doc/guix.texi:17864
31367 msgid "File name of the @code{dbus-daemon} executable."
31371 #: guix-git/doc/guix.texi:17865
31373 msgid "@code{gdm} (default: @code{gdm})"
31377 #: guix-git/doc/guix.texi:17867
31378 msgid "The GDM package to use."
31382 #: guix-git/doc/guix.texi:17870
31384 msgid "{Scheme Variable} slim-service-type"
31388 #: guix-git/doc/guix.texi:17872
31389 msgid "This is the type for the SLiM graphical login manager for X11."
31393 #: guix-git/doc/guix.texi:17876
31394 msgid "Like GDM, SLiM looks for session types described by @file{.desktop} files and allows users to choose a session from the log-in screen using @kbd{F1}. It also honors @file{~/.xsession} files."
31398 #: guix-git/doc/guix.texi:17883
31399 msgid "Unlike GDM, SLiM does not spawn the user session on a different VT after logging in, which means that you can only start one graphical session. If you want to be able to run multiple graphical sessions at the same time you have to add multiple SLiM services to your system services. The following example shows how to replace the default GDM service with two SLiM services on tty7 and tty8."
31403 #: guix-git/doc/guix.texi:17889
31406 "(use-modules (gnu services)\n"
31407 " (gnu services desktop)\n"
31408 " (gnu services xorg)\n"
31409 " (srfi srfi-1)) ;for 'remove'\n"
31414 #: guix-git/doc/guix.texi:17900
31417 "(operating-system\n"
31419 " (services (cons* (service slim-service-type (slim-configuration\n"
31420 " (display \":0\")\n"
31421 " (vt \"vt7\")))\n"
31422 " (service slim-service-type (slim-configuration\n"
31423 " (display \":1\")\n"
31424 " (vt \"vt8\")))\n"
31425 " (modify-services %desktop-services\n"
31426 " (delete gdm-service-type)))))\n"
31430 #: guix-git/doc/guix.texi:17904
31432 msgid "{Data Type} slim-configuration"
31436 #: guix-git/doc/guix.texi:17906
31437 msgid "Data type representing the configuration of @code{slim-service-type}."
31441 #: guix-git/doc/guix.texi:17910
31442 msgid "Whether to allow logins with empty passwords."
31446 #: guix-git/doc/guix.texi:17912
31448 msgid "@code{default-user} (default: @code{\"\"})"
31452 #: guix-git/doc/guix.texi:17914
31453 msgid "When @code{auto-login?} is false, SLiM presents a log-in screen."
31457 #: guix-git/doc/guix.texi:17917
31458 msgid "When @code{auto-login?} is true, SLiM logs in directly as @code{default-user}."
31462 #: guix-git/doc/guix.texi:17918
31464 msgid "@code{theme} (default: @code{%default-slim-theme})"
31468 #: guix-git/doc/guix.texi:17919
31470 msgid "@code{theme-name} (default: @code{%default-slim-theme-name})"
31474 #: guix-git/doc/guix.texi:17921
31475 msgid "The graphical theme to use and its name."
31479 #: guix-git/doc/guix.texi:17922
31481 msgid "@code{auto-login-session} (default: @code{#f})"
31485 #: guix-git/doc/guix.texi:17925
31486 msgid "If true, this must be the name of the executable to start as the default session---e.g., @code{(file-append windowmaker \"/bin/windowmaker\")}."
31490 #: guix-git/doc/guix.texi:17929
31491 msgid "If false, a session described by one of the available @file{.desktop} files in @code{/run/current-system/profile} and @code{~/.guix-profile} will be used."
31495 #: guix-git/doc/guix.texi:17934
31496 msgid "You must install at least one window manager in the system profile or in your user profile. Failing to do that, if @code{auto-login-session} is false, you will be unable to log in."
31500 #: guix-git/doc/guix.texi:17936 guix-git/doc/guix.texi:18020
31502 msgid "@code{xorg-configuration} (default @code{(xorg-configuration)})"
31506 #: guix-git/doc/guix.texi:17939
31508 msgid "@code{display} (default @code{\":0\"})"
31512 #: guix-git/doc/guix.texi:17941
31513 msgid "The display on which to start the Xorg graphical server."
31517 #: guix-git/doc/guix.texi:17942
31519 msgid "@code{vt} (default @code{\"vt7\"})"
31523 #: guix-git/doc/guix.texi:17944
31524 msgid "The VT on which to start the Xorg graphical server."
31528 #: guix-git/doc/guix.texi:17945
31530 msgid "@code{xauth} (default: @code{xauth})"
31534 #: guix-git/doc/guix.texi:17947
31535 msgid "The XAuth package to use."
31539 #: guix-git/doc/guix.texi:17948
31541 msgid "@code{shepherd} (default: @code{shepherd})"
31545 #: guix-git/doc/guix.texi:17951
31546 msgid "The Shepherd package used when invoking @command{halt} and @command{reboot}."
31550 #: guix-git/doc/guix.texi:17952
31552 msgid "@code{sessreg} (default: @code{sessreg})"
31556 #: guix-git/doc/guix.texi:17954
31557 msgid "The sessreg package used in order to register the session."
31561 #: guix-git/doc/guix.texi:17955
31563 msgid "@code{slim} (default: @code{slim})"
31567 #: guix-git/doc/guix.texi:17957
31568 msgid "The SLiM package to use."
31572 #: guix-git/doc/guix.texi:17960
31574 msgid "{Scheme Variable} %default-theme"
31578 #: guix-git/doc/guix.texi:17961
31580 msgid "{Scheme Variable} %default-theme-name"
31584 #: guix-git/doc/guix.texi:17963
31585 msgid "The default SLiM theme and its name."
31589 #: guix-git/doc/guix.texi:17966 guix-git/doc/guix.texi:18073
31591 msgid "{Data Type} sddm-configuration"
31595 #: guix-git/doc/guix.texi:17968
31596 msgid "This is the data type representing the SDDM service configuration."
31600 #: guix-git/doc/guix.texi:17970
31602 msgid "@code{display-server} (default: \"x11\")"
31606 #: guix-git/doc/guix.texi:17973
31607 msgid "Select display server to use for the greeter. Valid values are @samp{\"x11\"} or @samp{\"wayland\"}."
31611 #: guix-git/doc/guix.texi:17974
31613 msgid "@code{numlock} (default: \"on\")"
31617 #: guix-git/doc/guix.texi:17976
31618 msgid "Valid values are @samp{\"on\"}, @samp{\"off\"} or @samp{\"none\"}."
31622 #: guix-git/doc/guix.texi:17977
31624 msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})"
31628 #: guix-git/doc/guix.texi:17979
31629 msgid "Command to run when halting."
31633 #: guix-git/doc/guix.texi:17980
31635 msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})"
31639 #: guix-git/doc/guix.texi:17982
31640 msgid "Command to run when rebooting."
31644 #: guix-git/doc/guix.texi:17983
31646 msgid "@code{theme} (default \"maldives\")"
31650 #: guix-git/doc/guix.texi:17986
31651 msgid "Theme to use. Default themes provided by SDDM are @samp{\"elarun\"}, @samp{\"maldives\"} or @samp{\"maya\"}."
31655 #: guix-git/doc/guix.texi:17987
31657 msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")"
31661 #: guix-git/doc/guix.texi:17989
31662 msgid "Directory to look for themes."
31666 #: guix-git/doc/guix.texi:17990
31668 msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")"
31672 #: guix-git/doc/guix.texi:17992
31673 msgid "Directory to look for faces."
31677 #: guix-git/doc/guix.texi:17993
31679 msgid "@code{default-path} (default \"/run/current-system/profile/bin\")"
31683 #: guix-git/doc/guix.texi:17995
31684 msgid "Default PATH to use."
31688 #: guix-git/doc/guix.texi:17996
31690 msgid "@code{minimum-uid} (default: 1000)"
31694 #: guix-git/doc/guix.texi:17998
31695 msgid "Minimum UID displayed in SDDM and allowed for log-in."
31699 #: guix-git/doc/guix.texi:17999
31701 msgid "@code{maximum-uid} (default: 2000)"
31705 #: guix-git/doc/guix.texi:18001
31706 msgid "Maximum UID to display in SDDM."
31710 #: guix-git/doc/guix.texi:18002
31712 msgid "@code{remember-last-user?} (default #t)"
31716 #: guix-git/doc/guix.texi:18004
31717 msgid "Remember last user."
31721 #: guix-git/doc/guix.texi:18005
31723 msgid "@code{remember-last-session?} (default #t)"
31727 #: guix-git/doc/guix.texi:18007
31728 msgid "Remember last session."
31732 #: guix-git/doc/guix.texi:18008
31734 msgid "@code{hide-users} (default \"\")"
31738 #: guix-git/doc/guix.texi:18010
31739 msgid "Usernames to hide from SDDM greeter."
31743 #: guix-git/doc/guix.texi:18011
31745 msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})"
31749 #: guix-git/doc/guix.texi:18013
31750 msgid "Users with shells listed will be hidden from the SDDM greeter."
31754 #: guix-git/doc/guix.texi:18014
31756 msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})"
31760 #: guix-git/doc/guix.texi:18016
31761 msgid "Script to run before starting a wayland session."
31765 #: guix-git/doc/guix.texi:18017
31767 msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")"
31771 #: guix-git/doc/guix.texi:18019
31772 msgid "Directory to look for desktop files starting wayland sessions."
31776 #: guix-git/doc/guix.texi:18023
31778 msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})"
31782 #: guix-git/doc/guix.texi:18025
31783 msgid "Path to xauth."
31787 #: guix-git/doc/guix.texi:18026
31789 msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})"
31793 #: guix-git/doc/guix.texi:18028
31794 msgid "Path to Xephyr."
31798 #: guix-git/doc/guix.texi:18029
31800 msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})"
31804 #: guix-git/doc/guix.texi:18031
31805 msgid "Script to run after starting xorg-server."
31809 #: guix-git/doc/guix.texi:18032
31811 msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})"
31815 #: guix-git/doc/guix.texi:18034
31816 msgid "Script to run before stopping xorg-server."
31820 #: guix-git/doc/guix.texi:18035
31822 msgid "@code{xsession-command} (default: @code{xinitrc})"
31826 #: guix-git/doc/guix.texi:18038
31828 msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")"
31832 #: guix-git/doc/guix.texi:18040
31833 msgid "Directory to look for desktop files starting X sessions."
31837 #: guix-git/doc/guix.texi:18041
31839 msgid "@code{minimum-vt} (default: 7)"
31843 #: guix-git/doc/guix.texi:18043
31844 msgid "Minimum VT to use."
31848 #: guix-git/doc/guix.texi:18044
31850 msgid "@code{auto-login-user} (default \"\")"
31854 #: guix-git/doc/guix.texi:18046
31855 msgid "User to use for auto-login."
31859 #: guix-git/doc/guix.texi:18047
31861 msgid "@code{auto-login-session} (default \"\")"
31865 #: guix-git/doc/guix.texi:18049
31866 msgid "Desktop file to use for auto-login."
31870 #: guix-git/doc/guix.texi:18050
31872 msgid "@code{relogin?} (default #f)"
31876 #: guix-git/doc/guix.texi:18052
31877 msgid "Relogin after logout."
31881 #: guix-git/doc/guix.texi:18057
31887 #: guix-git/doc/guix.texi:18058
31889 msgid "{Scheme Variable} sddm-service-type"
31893 #: guix-git/doc/guix.texi:18062
31894 msgid "This is the type of the service to run the @uref{https://github.com/sddm/sddm,SDDM display manager}. Its value must be a @code{sddm-configuration} record (see below)."
31898 #: guix-git/doc/guix.texi:18064
31899 msgid "Here's an example use:"
31903 #: guix-git/doc/guix.texi:18070
31906 "(service sddm-service-type\n"
31907 " (sddm-configuration\n"
31908 " (auto-login-user \"alice\")\n"
31909 " (auto-login-session \"xfce.desktop\")))\n"
31913 #: guix-git/doc/guix.texi:18076
31914 msgid "This data type represents the configuration of the SDDM login manager. The available fields are:"
31918 #: guix-git/doc/guix.texi:18078
31920 msgid "@code{sddm} (default: @code{sddm})"
31924 #: guix-git/doc/guix.texi:18080
31925 msgid "The SDDM package to use."
31929 #: guix-git/doc/guix.texi:18081
31931 msgid "@code{display-server} (default: @code{\"x11\"})"
31935 #: guix-git/doc/guix.texi:18083
31936 msgid "This must be either @code{\"x11\"} or @code{\"wayland\"}."
31940 #: guix-git/doc/guix.texi:18086
31942 msgid "@code{auto-login-user} (default: @code{\"\"})"
31946 #: guix-git/doc/guix.texi:18089
31947 msgid "If non-empty, this is the user account under which to log in automatically."
31951 #: guix-git/doc/guix.texi:18090
31953 msgid "@code{auto-login-session} (default: @code{\"\"})"
31957 #: guix-git/doc/guix.texi:18093
31958 msgid "If non-empty, this is the @file{.desktop} file name to use as the auto-login session."
31962 #: guix-git/doc/guix.texi:18096
31964 msgid "Xorg, configuration"
31968 #: guix-git/doc/guix.texi:18097
31970 msgid "{Data Type} xorg-configuration"
31974 #: guix-git/doc/guix.texi:18102
31975 msgid "This data type represents the configuration of the Xorg graphical display server. Note that there is no Xorg service; instead, the X server is started by a ``display manager'' such as GDM, SDDM, and SLiM@. Thus, the configuration of these display managers aggregates an @code{xorg-configuration} record."
31979 #: guix-git/doc/guix.texi:18104
31981 msgid "@code{modules} (default: @code{%default-xorg-modules})"
31985 #: guix-git/doc/guix.texi:18107
31986 msgid "This is a list of @dfn{module packages} loaded by the Xorg server---e.g., @code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so on."
31990 #: guix-git/doc/guix.texi:18108
31992 msgid "@code{fonts} (default: @code{%default-xorg-fonts})"
31996 #: guix-git/doc/guix.texi:18110
31997 msgid "This is a list of font directories to add to the server's @dfn{font path}."
32001 #: guix-git/doc/guix.texi:18111
32003 msgid "@code{drivers} (default: @code{'()})"
32007 #: guix-git/doc/guix.texi:18115
32008 msgid "This must be either the empty list, in which case Xorg chooses a graphics driver automatically, or a list of driver names that will be tried in this order---e.g., @code{(\"modesetting\" \"vesa\")}."
32012 #: guix-git/doc/guix.texi:18116
32014 msgid "@code{resolutions} (default: @code{'()})"
32018 #: guix-git/doc/guix.texi:18120
32019 msgid "When @code{resolutions} is the empty list, Xorg chooses an appropriate screen resolution. Otherwise, it must be a list of resolutions---e.g., @code{((1024 768) (640 480))}."
32023 #: guix-git/doc/guix.texi:18121
32025 msgid "keyboard layout, for Xorg"
32029 #: guix-git/doc/guix.texi:18122
32031 msgid "keymap, for Xorg"
32035 #: guix-git/doc/guix.texi:18126
32036 msgid "If this is @code{#f}, Xorg uses the default keyboard layout---usually US English (``qwerty'') for a 105-key PC keyboard."
32040 #: guix-git/doc/guix.texi:18130
32041 msgid "Otherwise this must be a @code{keyboard-layout} object specifying the keyboard layout in use when Xorg is running. @xref{Keyboard Layout}, for more information on how to specify the keyboard layout."
32045 #: guix-git/doc/guix.texi:18131 guix-git/doc/guix.texi:19842
32046 #: guix-git/doc/guix.texi:32023
32048 msgid "@code{extra-config} (default: @code{'()})"
32052 #: guix-git/doc/guix.texi:18134 guix-git/doc/guix.texi:32027
32053 msgid "This is a list of strings or objects appended to the configuration file. It is used to pass extra text to be added verbatim to the configuration file."
32057 #: guix-git/doc/guix.texi:18135
32059 msgid "@code{server} (default: @code{xorg-server})"
32063 #: guix-git/doc/guix.texi:18137
32064 msgid "This is the package providing the Xorg server."
32068 #: guix-git/doc/guix.texi:18138
32070 msgid "@code{server-arguments} (default: @code{%default-xorg-server-arguments})"
32074 #: guix-git/doc/guix.texi:18141
32075 msgid "This is the list of command-line arguments to pass to the X server. The default is @code{-nolisten tcp}."
32079 #: guix-git/doc/guix.texi:18144
32081 msgid "{Scheme Procedure} set-xorg-configuration @var{config} @"
32085 #: guix-git/doc/guix.texi:18148
32086 msgid "[@var{login-manager-service-type}] Tell the log-in manager (of type @var{login-manager-service-type}) to use @var{config}, an @code{<xorg-configuration>} record."
32090 #: guix-git/doc/guix.texi:18152
32091 msgid "Since the Xorg configuration is embedded in the log-in manager's configuration---e.g., @code{gdm-configuration}---this procedure provides a shorthand to set the Xorg configuration."
32095 #: guix-git/doc/guix.texi:18154
32097 msgid "{Scheme Procedure} xorg-start-command [@var{config}]"
32101 #: guix-git/doc/guix.texi:18158
32102 msgid "Return a @code{startx} script in which the modules, fonts, etc. specified in @var{config}, are available. The result should be used in place of @code{startx}."
32106 #: guix-git/doc/guix.texi:18160
32107 msgid "Usually the X server is started by a login manager."
32111 #: guix-git/doc/guix.texi:18163
32113 msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]"
32117 #: guix-git/doc/guix.texi:18167
32118 msgid "Add @var{package}, a package for a screen locker or screen saver whose command is @var{program}, to the set of setuid programs and add a PAM entry for it. For example:"
32122 #: guix-git/doc/guix.texi:18170
32124 msgid "(screen-locker-service xlockmore \"xlock\")\n"
32128 #: guix-git/doc/guix.texi:18173
32129 msgid "makes the good ol' XlockMore usable."
32133 #: guix-git/doc/guix.texi:18179
32135 msgid "printer support with CUPS"
32138 #. type: Plain text
32139 #: guix-git/doc/guix.texi:18183
32140 msgid "The @code{(gnu services cups)} module provides a Guix service definition for the CUPS printing service. To add printer support to a Guix system, add a @code{cups-service} to the operating system definition:"
32144 #: guix-git/doc/guix.texi:18184
32146 msgid "{Scheme Variable} cups-service-type"
32150 #: guix-git/doc/guix.texi:18188
32151 msgid "The service type for the CUPS print server. Its value should be a valid CUPS configuration (see below). To use the default settings, simply write:"
32155 #: guix-git/doc/guix.texi:18190
32157 msgid "(service cups-service-type)\n"
32160 #. type: Plain text
32161 #: guix-git/doc/guix.texi:18200
32162 msgid "The CUPS configuration controls the basic things about your CUPS installation: what interfaces it listens on, what to do if a print job fails, how much logging to do, and so on. To actually add a printer, you have to visit the @url{http://localhost:631} URL, or use a tool such as GNOME's printer configuration services. By default, configuring a CUPS service will generate a self-signed certificate if needed, for secure connections to the print server."
32165 #. type: Plain text
32166 #: guix-git/doc/guix.texi:18206
32167 msgid "Suppose you want to enable the Web interface of CUPS and also add support for Epson printers @i{via} the @code{epson-inkjet-printer-escpr} package and for HP printers @i{via} the @code{hplip-minimal} package. You can do that directly, like this (you need to use the @code{(gnu packages cups)} module):"
32171 #: guix-git/doc/guix.texi:18213
32174 "(service cups-service-type\n"
32175 " (cups-configuration\n"
32176 " (web-interface? #t)\n"
32178 " (list cups-filters epson-inkjet-printer-escpr hplip-minimal))))\n"
32181 #. type: Plain text
32182 #: guix-git/doc/guix.texi:18218
32183 msgid "Note: If you wish to use the Qt5 based GUI which comes with the hplip package then it is suggested that you install the @code{hplip} package, either in your OS configuration file or as your user."
32186 #. type: Plain text
32187 #: guix-git/doc/guix.texi:18225
32188 msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{cupsd.conf} file that you want to port over from some other system; see the end for more details."
32191 #. type: Plain text
32192 #: guix-git/doc/guix.texi:18236
32193 msgid "Available @code{cups-configuration} fields are:"
32197 #: guix-git/doc/guix.texi:18237
32199 msgid "{@code{cups-configuration} parameter} package cups"
32203 #: guix-git/doc/guix.texi:18239 guix-git/doc/guix.texi:19007
32204 msgid "The CUPS package."
32208 #: guix-git/doc/guix.texi:18241
32210 msgid "{@code{cups-configuration} parameter} package-list extensions (default: @code{(list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)})"
32214 #: guix-git/doc/guix.texi:18243
32215 msgid "Drivers and other extensions to the CUPS package."
32219 #: guix-git/doc/guix.texi:18245
32221 msgid "{@code{cups-configuration} parameter} files-configuration files-configuration"
32225 #: guix-git/doc/guix.texi:18248
32226 msgid "Configuration of where to write logs, what directories to use for print spools, and related privileged configuration parameters."
32230 #: guix-git/doc/guix.texi:18250
32231 msgid "Available @code{files-configuration} fields are:"
32235 #: guix-git/doc/guix.texi:18251
32237 msgid "{@code{files-configuration} parameter} log-location access-log"
32241 #: guix-git/doc/guix.texi:18259
32242 msgid "Defines the access log filename. Specifying a blank filename disables access log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-access_log}."
32246 #: guix-git/doc/guix.texi:18261
32247 msgid "Defaults to @samp{\"/var/log/cups/access_log\"}."
32251 #: guix-git/doc/guix.texi:18263
32253 msgid "{@code{files-configuration} parameter} file-name cache-dir"
32257 #: guix-git/doc/guix.texi:18265
32258 msgid "Where CUPS should cache data."
32262 #: guix-git/doc/guix.texi:18267
32263 msgid "Defaults to @samp{\"/var/cache/cups\"}."
32267 #: guix-git/doc/guix.texi:18269
32269 msgid "{@code{files-configuration} parameter} string config-file-perm"
32273 #: guix-git/doc/guix.texi:18272
32274 msgid "Specifies the permissions for all configuration files that the scheduler writes."
32278 #: guix-git/doc/guix.texi:18278
32279 msgid "Note that the permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature."
32283 #: guix-git/doc/guix.texi:18280
32284 msgid "Defaults to @samp{\"0640\"}."
32288 #: guix-git/doc/guix.texi:18282
32290 msgid "{@code{files-configuration} parameter} log-location error-log"
32294 #: guix-git/doc/guix.texi:18290
32295 msgid "Defines the error log filename. Specifying a blank filename disables error log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-error_log}."
32299 #: guix-git/doc/guix.texi:18292
32300 msgid "Defaults to @samp{\"/var/log/cups/error_log\"}."
32304 #: guix-git/doc/guix.texi:18294
32306 msgid "{@code{files-configuration} parameter} string fatal-errors"
32310 #: guix-git/doc/guix.texi:18297
32311 msgid "Specifies which errors are fatal, causing the scheduler to exit. The kind strings are:"
32315 #: guix-git/doc/guix.texi:18301
32316 msgid "No errors are fatal."
32320 #: guix-git/doc/guix.texi:18304
32321 msgid "All of the errors below are fatal."
32325 #: guix-git/doc/guix.texi:18305
32331 #: guix-git/doc/guix.texi:18308
32332 msgid "Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon."
32336 #: guix-git/doc/guix.texi:18309
32342 #: guix-git/doc/guix.texi:18311
32343 msgid "Configuration file syntax errors are fatal."
32347 #: guix-git/doc/guix.texi:18312
32353 #: guix-git/doc/guix.texi:18315
32354 msgid "Listen or Port errors are fatal, except for IPv6 failures on the loopback or @code{any} addresses."
32358 #: guix-git/doc/guix.texi:18316
32364 #: guix-git/doc/guix.texi:18318
32365 msgid "Log file creation or write errors are fatal."
32369 #: guix-git/doc/guix.texi:18319
32371 msgid "permissions"
32375 #: guix-git/doc/guix.texi:18322
32376 msgid "Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions."
32380 #: guix-git/doc/guix.texi:18325
32381 msgid "Defaults to @samp{\"all -browse\"}."
32385 #: guix-git/doc/guix.texi:18327
32387 msgid "{@code{files-configuration} parameter} boolean file-device?"
32391 #: guix-git/doc/guix.texi:18330
32392 msgid "Specifies whether the file pseudo-device can be used for new printer queues. The URI @uref{file:///dev/null} is always allowed."
32396 #: guix-git/doc/guix.texi:18332 guix-git/doc/guix.texi:18402
32397 #: guix-git/doc/guix.texi:18444 guix-git/doc/guix.texi:18464
32398 #: guix-git/doc/guix.texi:18470 guix-git/doc/guix.texi:18486
32399 #: guix-git/doc/guix.texi:18574 guix-git/doc/guix.texi:18668
32400 #: guix-git/doc/guix.texi:18981 guix-git/doc/guix.texi:18994
32401 #: guix-git/doc/guix.texi:21543 guix-git/doc/guix.texi:21649
32402 #: guix-git/doc/guix.texi:21714 guix-git/doc/guix.texi:21723
32403 #: guix-git/doc/guix.texi:22728 guix-git/doc/guix.texi:22772
32404 #: guix-git/doc/guix.texi:22789 guix-git/doc/guix.texi:22797
32405 #: guix-git/doc/guix.texi:22812 guix-git/doc/guix.texi:22830
32406 #: guix-git/doc/guix.texi:22854 guix-git/doc/guix.texi:22907
32407 #: guix-git/doc/guix.texi:23040 guix-git/doc/guix.texi:23074
32408 #: guix-git/doc/guix.texi:23110 guix-git/doc/guix.texi:23126
32409 #: guix-git/doc/guix.texi:23154 guix-git/doc/guix.texi:23215
32410 #: guix-git/doc/guix.texi:23298 guix-git/doc/guix.texi:26691
32411 #: guix-git/doc/guix.texi:26705 guix-git/doc/guix.texi:26727
32412 #: guix-git/doc/guix.texi:26846 guix-git/doc/guix.texi:26860
32413 #: guix-git/doc/guix.texi:26881 guix-git/doc/guix.texi:26902
32414 #: guix-git/doc/guix.texi:26909 guix-git/doc/guix.texi:26954
32415 #: guix-git/doc/guix.texi:26961 guix-git/doc/guix.texi:27694
32416 #: guix-git/doc/guix.texi:27708 guix-git/doc/guix.texi:27880
32417 #: guix-git/doc/guix.texi:27925 guix-git/doc/guix.texi:28012
32418 #: guix-git/doc/guix.texi:28214 guix-git/doc/guix.texi:28247
32419 #: guix-git/doc/guix.texi:28387 guix-git/doc/guix.texi:28398
32420 #: guix-git/doc/guix.texi:28649 guix-git/doc/guix.texi:30114
32421 #: guix-git/doc/guix.texi:30123 guix-git/doc/guix.texi:30131
32422 #: guix-git/doc/guix.texi:30139 guix-git/doc/guix.texi:30155
32423 #: guix-git/doc/guix.texi:30171 guix-git/doc/guix.texi:30179
32424 #: guix-git/doc/guix.texi:30187 guix-git/doc/guix.texi:30196
32425 #: guix-git/doc/guix.texi:30205 guix-git/doc/guix.texi:30221
32426 #: guix-git/doc/guix.texi:30285 guix-git/doc/guix.texi:30391
32427 #: guix-git/doc/guix.texi:30399 guix-git/doc/guix.texi:30407
32428 #: guix-git/doc/guix.texi:30432 guix-git/doc/guix.texi:30486
32429 #: guix-git/doc/guix.texi:30534 guix-git/doc/guix.texi:30735
32430 #: guix-git/doc/guix.texi:30742
32431 msgid "Defaults to @samp{#f}."
32435 #: guix-git/doc/guix.texi:18334
32437 msgid "{@code{files-configuration} parameter} string group"
32441 #: guix-git/doc/guix.texi:18337
32442 msgid "Specifies the group name or ID that will be used when executing external programs."
32446 #: guix-git/doc/guix.texi:18339 guix-git/doc/guix.texi:18419
32447 msgid "Defaults to @samp{\"lp\"}."
32451 #: guix-git/doc/guix.texi:18341
32453 msgid "{@code{files-configuration} parameter} string log-file-perm"
32457 #: guix-git/doc/guix.texi:18343
32458 msgid "Specifies the permissions for all log files that the scheduler writes."
32462 #: guix-git/doc/guix.texi:18345
32463 msgid "Defaults to @samp{\"0644\"}."
32467 #: guix-git/doc/guix.texi:18347
32469 msgid "{@code{files-configuration} parameter} log-location page-log"
32473 #: guix-git/doc/guix.texi:18355
32474 msgid "Defines the page log filename. Specifying a blank filename disables page log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-page_log}."
32478 #: guix-git/doc/guix.texi:18357
32479 msgid "Defaults to @samp{\"/var/log/cups/page_log\"}."
32483 #: guix-git/doc/guix.texi:18359
32485 msgid "{@code{files-configuration} parameter} string remote-root"
32489 #: guix-git/doc/guix.texi:18362
32490 msgid "Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. The default is @code{remroot}."
32494 #: guix-git/doc/guix.texi:18364
32495 msgid "Defaults to @samp{\"remroot\"}."
32499 #: guix-git/doc/guix.texi:18366
32501 msgid "{@code{files-configuration} parameter} file-name request-root"
32505 #: guix-git/doc/guix.texi:18369
32506 msgid "Specifies the directory that contains print jobs and other HTTP request data."
32510 #: guix-git/doc/guix.texi:18371
32511 msgid "Defaults to @samp{\"/var/spool/cups\"}."
32515 #: guix-git/doc/guix.texi:18373
32517 msgid "{@code{files-configuration} parameter} sandboxing sandboxing"
32521 #: guix-git/doc/guix.texi:18378
32522 msgid "Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler; either @code{relaxed} or @code{strict}. This directive is currently only used/supported on macOS."
32526 #: guix-git/doc/guix.texi:18380
32527 msgid "Defaults to @samp{strict}."
32531 #: guix-git/doc/guix.texi:18382
32533 msgid "{@code{files-configuration} parameter} file-name server-keychain"
32537 #: guix-git/doc/guix.texi:18387
32538 msgid "Specifies the location of TLS certificates and private keys. CUPS will look for public and private keys in this directory: @file{.crt} files for PEM-encoded certificates and corresponding @file{.key} files for PEM-encoded private keys."
32542 #: guix-git/doc/guix.texi:18389
32543 msgid "Defaults to @samp{\"/etc/cups/ssl\"}."
32547 #: guix-git/doc/guix.texi:18391
32549 msgid "{@code{files-configuration} parameter} file-name server-root"
32553 #: guix-git/doc/guix.texi:18393
32554 msgid "Specifies the directory containing the server configuration files."
32558 #: guix-git/doc/guix.texi:18395
32559 msgid "Defaults to @samp{\"/etc/cups\"}."
32563 #: guix-git/doc/guix.texi:18397
32565 msgid "{@code{files-configuration} parameter} boolean sync-on-close?"
32569 #: guix-git/doc/guix.texi:18400
32570 msgid "Specifies whether the scheduler calls fsync(2) after writing configuration or state files."
32574 #: guix-git/doc/guix.texi:18404
32576 msgid "{@code{files-configuration} parameter} space-separated-string-list system-group"
32580 #: guix-git/doc/guix.texi:18406
32581 msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication."
32585 #: guix-git/doc/guix.texi:18408
32587 msgid "{@code{files-configuration} parameter} file-name temp-dir"
32591 #: guix-git/doc/guix.texi:18410
32592 msgid "Specifies the directory where temporary files are stored."
32596 #: guix-git/doc/guix.texi:18412
32597 msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}."
32601 #: guix-git/doc/guix.texi:18414
32603 msgid "{@code{files-configuration} parameter} string user"
32607 #: guix-git/doc/guix.texi:18417
32608 msgid "Specifies the user name or ID that is used when running external programs."
32612 #: guix-git/doc/guix.texi:18421
32614 msgid "{@code{files-configuration} parameter} string set-env"
32618 #: guix-git/doc/guix.texi:18423
32619 msgid "Set the specified environment variable to be passed to child processes."
32623 #: guix-git/doc/guix.texi:18425
32624 msgid "Defaults to @samp{\"variable value\"}."
32628 #: guix-git/doc/guix.texi:18428
32630 msgid "{@code{cups-configuration} parameter} access-log-level access-log-level"
32634 #: guix-git/doc/guix.texi:18435
32635 msgid "Specifies the logging level for the AccessLog file. The @code{config} level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. The @code{actions} level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for @code{config}. The @code{all} level logs all requests."
32639 #: guix-git/doc/guix.texi:18437
32640 msgid "Defaults to @samp{actions}."
32644 #: guix-git/doc/guix.texi:18439
32646 msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?"
32650 #: guix-git/doc/guix.texi:18442
32651 msgid "Specifies whether to purge job history data automatically when it is no longer required for quotas."
32655 #: guix-git/doc/guix.texi:18446
32657 msgid "{@code{cups-configuration} parameter} comma-separated-string-list browse-dns-sd-sub-types"
32661 #: guix-git/doc/guix.texi:18450
32662 msgid "Specifies a list of DNS-SD sub-types to advertise for each shared printer. For example, @samp{\"_cups\" \"_print\"} will tell network clients that both CUPS sharing and IPP Everywhere are supported."
32666 #: guix-git/doc/guix.texi:18452
32667 msgid "Defaults to @samp{\"_cups\"}."
32671 #: guix-git/doc/guix.texi:18454
32673 msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols"
32677 #: guix-git/doc/guix.texi:18456
32678 msgid "Specifies which protocols to use for local printer sharing."
32682 #: guix-git/doc/guix.texi:18458
32683 msgid "Defaults to @samp{dnssd}."
32687 #: guix-git/doc/guix.texi:18460
32689 msgid "{@code{cups-configuration} parameter} boolean browse-web-if?"
32693 #: guix-git/doc/guix.texi:18462
32694 msgid "Specifies whether the CUPS web interface is advertised."
32698 #: guix-git/doc/guix.texi:18466
32700 msgid "{@code{cups-configuration} parameter} boolean browsing?"
32704 #: guix-git/doc/guix.texi:18468
32705 msgid "Specifies whether shared printers are advertised."
32709 #: guix-git/doc/guix.texi:18472
32711 msgid "{@code{cups-configuration} parameter} string classification"
32715 #: guix-git/doc/guix.texi:18477
32716 msgid "Specifies the security classification of the server. Any valid banner name can be used, including @samp{\"classified\"}, @samp{\"confidential\"}, @samp{\"secret\"}, @samp{\"topsecret\"}, and @samp{\"unclassified\"}, or the banner can be omitted to disable secure printing functions."
32720 #: guix-git/doc/guix.texi:18479 guix-git/doc/guix.texi:18816
32721 #: guix-git/doc/guix.texi:20764 guix-git/doc/guix.texi:20776
32722 #: guix-git/doc/guix.texi:21550 guix-git/doc/guix.texi:21564
32723 #: guix-git/doc/guix.texi:21571 guix-git/doc/guix.texi:21578
32724 #: guix-git/doc/guix.texi:21608 guix-git/doc/guix.texi:21706
32725 #: guix-git/doc/guix.texi:23597 guix-git/doc/guix.texi:23623
32726 #: guix-git/doc/guix.texi:23659 guix-git/doc/guix.texi:23705
32727 #: guix-git/doc/guix.texi:23724 guix-git/doc/guix.texi:23763
32728 #: guix-git/doc/guix.texi:23822 guix-git/doc/guix.texi:23832
32729 #: guix-git/doc/guix.texi:28353 guix-git/doc/guix.texi:28361
32730 #: guix-git/doc/guix.texi:28369 guix-git/doc/guix.texi:28377
32731 #: guix-git/doc/guix.texi:28656 guix-git/doc/guix.texi:29957
32732 #: guix-git/doc/guix.texi:29965 guix-git/doc/guix.texi:29973
32733 #: guix-git/doc/guix.texi:30081 guix-git/doc/guix.texi:30106
32734 #: guix-git/doc/guix.texi:30237 guix-git/doc/guix.texi:30245
32735 #: guix-git/doc/guix.texi:30253 guix-git/doc/guix.texi:30261
32736 #: guix-git/doc/guix.texi:30269 guix-git/doc/guix.texi:30277
32737 #: guix-git/doc/guix.texi:30300 guix-git/doc/guix.texi:30308
32738 #: guix-git/doc/guix.texi:30360 guix-git/doc/guix.texi:30376
32739 #: guix-git/doc/guix.texi:30384 guix-git/doc/guix.texi:30423
32740 #: guix-git/doc/guix.texi:30446 guix-git/doc/guix.texi:30468
32741 #: guix-git/doc/guix.texi:30475 guix-git/doc/guix.texi:30510
32742 #: guix-git/doc/guix.texi:30518 guix-git/doc/guix.texi:30542
32743 #: guix-git/doc/guix.texi:30574 guix-git/doc/guix.texi:30603
32744 #: guix-git/doc/guix.texi:30610 guix-git/doc/guix.texi:30617
32745 #: guix-git/doc/guix.texi:30625 guix-git/doc/guix.texi:30639
32746 #: guix-git/doc/guix.texi:30648 guix-git/doc/guix.texi:30658
32747 #: guix-git/doc/guix.texi:30665 guix-git/doc/guix.texi:30672
32748 #: guix-git/doc/guix.texi:30679 guix-git/doc/guix.texi:30750
32749 #: guix-git/doc/guix.texi:30757 guix-git/doc/guix.texi:30764
32750 #: guix-git/doc/guix.texi:30773 guix-git/doc/guix.texi:30789
32751 #: guix-git/doc/guix.texi:30796 guix-git/doc/guix.texi:30803
32752 #: guix-git/doc/guix.texi:30810 guix-git/doc/guix.texi:30818
32753 #: guix-git/doc/guix.texi:30826
32754 msgid "Defaults to @samp{\"\"}."
32758 #: guix-git/doc/guix.texi:18481
32760 msgid "{@code{cups-configuration} parameter} boolean classify-override?"
32764 #: guix-git/doc/guix.texi:18484
32765 msgid "Specifies whether users may override the classification (cover page) of individual print jobs using the @code{job-sheets} option."
32769 #: guix-git/doc/guix.texi:18488
32771 msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type"
32775 #: guix-git/doc/guix.texi:18490
32776 msgid "Specifies the default type of authentication to use."
32780 #: guix-git/doc/guix.texi:18492
32781 msgid "Defaults to @samp{Basic}."
32785 #: guix-git/doc/guix.texi:18494
32787 msgid "{@code{cups-configuration} parameter} default-encryption default-encryption"
32791 #: guix-git/doc/guix.texi:18496
32792 msgid "Specifies whether encryption will be used for authenticated requests."
32796 #: guix-git/doc/guix.texi:18498
32797 msgid "Defaults to @samp{Required}."
32801 #: guix-git/doc/guix.texi:18500
32803 msgid "{@code{cups-configuration} parameter} string default-language"
32807 #: guix-git/doc/guix.texi:18502
32808 msgid "Specifies the default language to use for text and web content."
32812 #: guix-git/doc/guix.texi:18504
32813 msgid "Defaults to @samp{\"en\"}."
32817 #: guix-git/doc/guix.texi:18506
32819 msgid "{@code{cups-configuration} parameter} string default-paper-size"
32823 #: guix-git/doc/guix.texi:18511
32824 msgid "Specifies the default paper size for new print queues. @samp{\"Auto\"} uses a locale-specific default, while @samp{\"None\"} specifies there is no default paper size. Specific size names are typically @samp{\"Letter\"} or @samp{\"A4\"}."
32828 #: guix-git/doc/guix.texi:18513
32829 msgid "Defaults to @samp{\"Auto\"}."
32833 #: guix-git/doc/guix.texi:18515
32835 msgid "{@code{cups-configuration} parameter} string default-policy"
32839 #: guix-git/doc/guix.texi:18517
32840 msgid "Specifies the default access policy to use."
32844 #: guix-git/doc/guix.texi:18519
32845 msgid "Defaults to @samp{\"default\"}."
32849 #: guix-git/doc/guix.texi:18521
32851 msgid "{@code{cups-configuration} parameter} boolean default-shared?"
32855 #: guix-git/doc/guix.texi:18523
32856 msgid "Specifies whether local printers are shared by default."
32860 #: guix-git/doc/guix.texi:18525 guix-git/doc/guix.texi:18605
32861 #: guix-git/doc/guix.texi:18901 guix-git/doc/guix.texi:21640
32862 #: guix-git/doc/guix.texi:21691 guix-git/doc/guix.texi:21698
32863 #: guix-git/doc/guix.texi:22752 guix-git/doc/guix.texi:22940
32864 #: guix-git/doc/guix.texi:23057 guix-git/doc/guix.texi:23093
32865 #: guix-git/doc/guix.texi:23144 guix-git/doc/guix.texi:23163
32866 #: guix-git/doc/guix.texi:23173 guix-git/doc/guix.texi:23183
32867 #: guix-git/doc/guix.texi:23242 guix-git/doc/guix.texi:23264
32868 #: guix-git/doc/guix.texi:23289 guix-git/doc/guix.texi:23315
32869 #: guix-git/doc/guix.texi:23333 guix-git/doc/guix.texi:26513
32870 #: guix-git/doc/guix.texi:26541 guix-git/doc/guix.texi:26668
32871 #: guix-git/doc/guix.texi:26675 guix-git/doc/guix.texi:26683
32872 #: guix-git/doc/guix.texi:26720 guix-git/doc/guix.texi:26734
32873 #: guix-git/doc/guix.texi:26823 guix-git/doc/guix.texi:26830
32874 #: guix-git/doc/guix.texi:26838 guix-git/doc/guix.texi:27561
32875 #: guix-git/doc/guix.texi:27701 guix-git/doc/guix.texi:27887
32876 #: guix-git/doc/guix.texi:27894 guix-git/doc/guix.texi:27916
32877 #: guix-git/doc/guix.texi:27955 guix-git/doc/guix.texi:27975
32878 #: guix-git/doc/guix.texi:27989 guix-git/doc/guix.texi:28202
32879 #: guix-git/doc/guix.texi:30059 guix-git/doc/guix.texi:30147
32880 #: guix-git/doc/guix.texi:30163 guix-git/doc/guix.texi:30213
32881 msgid "Defaults to @samp{#t}."
32885 #: guix-git/doc/guix.texi:18527
32887 msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval"
32891 #: guix-git/doc/guix.texi:18531
32892 msgid "Specifies the delay for updating of configuration and state files, in seconds. A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds."
32896 #: guix-git/doc/guix.texi:18533 guix-git/doc/guix.texi:18581
32897 #: guix-git/doc/guix.texi:18590 guix-git/doc/guix.texi:18611
32898 #: guix-git/doc/guix.texi:18908 guix-git/doc/guix.texi:23102
32899 #: guix-git/doc/guix.texi:23135
32900 msgid "Defaults to @samp{30}."
32904 #: guix-git/doc/guix.texi:18535
32906 msgid "{@code{cups-configuration} parameter} error-policy error-policy"
32910 #: guix-git/doc/guix.texi:18541
32911 msgid "Specifies what to do when an error occurs. Possible values are @code{abort-job}, which will discard the failed print job; @code{retry-job}, which will retry the job at a later time; @code{retry-current-job}, which retries the failed job immediately; and @code{stop-printer}, which stops the printer."
32915 #: guix-git/doc/guix.texi:18543
32916 msgid "Defaults to @samp{stop-printer}."
32920 #: guix-git/doc/guix.texi:18545
32922 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit"
32926 #: guix-git/doc/guix.texi:18553
32927 msgid "Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. A limit of 0 disables filter limiting. An average print to a non-PostScript printer needs a filter limit of about 200. A PostScript printer needs about half that (100). Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time."
32931 #: guix-git/doc/guix.texi:18555 guix-git/doc/guix.texi:18563
32932 #: guix-git/doc/guix.texi:18618 guix-git/doc/guix.texi:18734
32933 #: guix-git/doc/guix.texi:18748 guix-git/doc/guix.texi:18755
32934 #: guix-git/doc/guix.texi:20206 guix-git/doc/guix.texi:20222
32935 #: guix-git/doc/guix.texi:20868 guix-git/doc/guix.texi:20880
32936 #: guix-git/doc/guix.texi:21659 guix-git/doc/guix.texi:21668
32937 #: guix-git/doc/guix.texi:21676 guix-git/doc/guix.texi:21684
32938 #: guix-git/doc/guix.texi:27577 guix-git/doc/guix.texi:27902
32939 #: guix-git/doc/guix.texi:30052 guix-git/doc/guix.texi:30352
32940 #: guix-git/doc/guix.texi:30526
32941 msgid "Defaults to @samp{0}."
32945 #: guix-git/doc/guix.texi:18557
32947 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice"
32951 #: guix-git/doc/guix.texi:18561
32952 msgid "Specifies the scheduling priority of filters that are run to print a job. The nice value ranges from 0, the highest priority, to 19, the lowest priority."
32956 #: guix-git/doc/guix.texi:18565
32958 msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups"
32962 #: guix-git/doc/guix.texi:18572
32963 msgid "Specifies whether to do reverse lookups on connecting clients. The @code{double} setting causes @code{cupsd} to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. Double lookups also prevent clients with unregistered addresses from connecting to your server. Only set this option to @code{#t} or @code{double} if absolutely required."
32967 #: guix-git/doc/guix.texi:18576
32969 msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay"
32973 #: guix-git/doc/guix.texi:18579
32974 msgid "Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job."
32978 #: guix-git/doc/guix.texi:18583
32980 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval"
32984 #: guix-git/doc/guix.texi:18588
32985 msgid "Specifies the interval between retries of jobs in seconds. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}."
32989 #: guix-git/doc/guix.texi:18592
32991 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit"
32995 #: guix-git/doc/guix.texi:18597
32996 msgid "Specifies the number of retries that are done for jobs. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}."
33000 #: guix-git/doc/guix.texi:18599 guix-git/doc/guix.texi:23066
33001 #: guix-git/doc/guix.texi:28454 guix-git/doc/guix.texi:28474
33002 #: guix-git/doc/guix.texi:28490 guix-git/doc/guix.texi:28504
33003 #: guix-git/doc/guix.texi:28511 guix-git/doc/guix.texi:28518
33004 #: guix-git/doc/guix.texi:28525 guix-git/doc/guix.texi:28685
33005 #: guix-git/doc/guix.texi:28701 guix-git/doc/guix.texi:28708
33006 #: guix-git/doc/guix.texi:28715 guix-git/doc/guix.texi:28726
33007 #: guix-git/doc/guix.texi:30004 guix-git/doc/guix.texi:30012
33008 #: guix-git/doc/guix.texi:30020 guix-git/doc/guix.texi:30044
33009 msgid "Defaults to @samp{5}."
33013 #: guix-git/doc/guix.texi:18601
33015 msgid "{@code{cups-configuration} parameter} boolean keep-alive?"
33019 #: guix-git/doc/guix.texi:18603
33020 msgid "Specifies whether to support HTTP keep-alive connections."
33024 #: guix-git/doc/guix.texi:18607
33026 msgid "{@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout"
33030 #: guix-git/doc/guix.texi:18609
33031 msgid "Specifies how long an idle client connection remains open, in seconds."
33035 #: guix-git/doc/guix.texi:18613
33037 msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body"
33041 #: guix-git/doc/guix.texi:18616
33042 msgid "Specifies the maximum size of print files, IPP requests, and HTML form data. A limit of 0 disables the limit check."
33046 #: guix-git/doc/guix.texi:18620
33048 msgid "{@code{cups-configuration} parameter} multiline-string-list listen"
33052 #: guix-git/doc/guix.texi:18627
33053 msgid "Listens on the specified interfaces for connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses. Values can also be file names of local UNIX domain sockets. The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks."
33057 #: guix-git/doc/guix.texi:18629
33059 msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log"
33063 #: guix-git/doc/guix.texi:18636
33064 msgid "Specifies the number of pending connections that will be allowed. This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones."
33068 #: guix-git/doc/guix.texi:18638
33069 msgid "Defaults to @samp{128}."
33073 #: guix-git/doc/guix.texi:18640
33075 msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls"
33079 #: guix-git/doc/guix.texi:18642
33080 msgid "Specifies a set of additional access controls."
33084 #: guix-git/doc/guix.texi:18644
33085 msgid "Available @code{location-access-controls} fields are:"
33089 #: guix-git/doc/guix.texi:18645
33091 msgid "{@code{location-access-controls} parameter} file-name path"
33095 #: guix-git/doc/guix.texi:18647
33096 msgid "Specifies the URI path to which the access control applies."
33100 #: guix-git/doc/guix.texi:18649
33102 msgid "{@code{location-access-controls} parameter} access-control-list access-controls"
33106 #: guix-git/doc/guix.texi:18652
33107 msgid "Access controls for all access to this path, in the same format as the @code{access-controls} of @code{operation-access-control}."
33111 #: guix-git/doc/guix.texi:18654 guix-git/doc/guix.texi:18660
33112 #: guix-git/doc/guix.texi:18674 guix-git/doc/guix.texi:18681
33113 #: guix-git/doc/guix.texi:18823 guix-git/doc/guix.texi:18882
33114 #: guix-git/doc/guix.texi:18960 guix-git/doc/guix.texi:18974
33115 #: guix-git/doc/guix.texi:21354 guix-git/doc/guix.texi:21557
33116 #: guix-git/doc/guix.texi:21585 guix-git/doc/guix.texi:21615
33117 #: guix-git/doc/guix.texi:21730 guix-git/doc/guix.texi:21743
33118 #: guix-git/doc/guix.texi:21750 guix-git/doc/guix.texi:23272
33119 #: guix-git/doc/guix.texi:23667 guix-git/doc/guix.texi:23771
33120 #: guix-git/doc/guix.texi:24198 guix-git/doc/guix.texi:24206
33121 #: guix-git/doc/guix.texi:24451 guix-git/doc/guix.texi:26572
33122 #: guix-git/doc/guix.texi:26741 guix-git/doc/guix.texi:26940
33123 #: guix-git/doc/guix.texi:28345 guix-git/doc/guix.texi:28405
33124 #: guix-git/doc/guix.texi:28413 guix-git/doc/guix.texi:30067
33125 #: guix-git/doc/guix.texi:30074 guix-git/doc/guix.texi:30416
33126 #: guix-git/doc/guix.texi:30494 guix-git/doc/guix.texi:30588
33127 #: guix-git/doc/guix.texi:30596 guix-git/doc/guix.texi:30632
33128 #: guix-git/doc/guix.texi:30782 guix-git/doc/guix.texi:30833
33129 #: guix-git/doc/guix.texi:30842
33130 msgid "Defaults to @samp{()}."
33134 #: guix-git/doc/guix.texi:18656
33136 msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls"
33140 #: guix-git/doc/guix.texi:18658
33141 msgid "Access controls for method-specific access to this path."
33145 #: guix-git/doc/guix.texi:18662
33146 msgid "Available @code{method-access-controls} fields are:"
33150 #: guix-git/doc/guix.texi:18663
33152 msgid "{@code{method-access-controls} parameter} boolean reverse?"
33156 #: guix-git/doc/guix.texi:18666
33157 msgid "If @code{#t}, apply access controls to all methods except the listed methods. Otherwise apply to only the listed methods."
33161 #: guix-git/doc/guix.texi:18670
33163 msgid "{@code{method-access-controls} parameter} method-list methods"
33167 #: guix-git/doc/guix.texi:18672
33168 msgid "Methods to which this access control applies."
33172 #: guix-git/doc/guix.texi:18676
33174 msgid "{@code{method-access-controls} parameter} access-control-list access-controls"
33178 #: guix-git/doc/guix.texi:18679
33179 msgid "Access control directives, as a list of strings. Each string should be one directive, such as @samp{\"Order allow,deny\"}."
33183 #: guix-git/doc/guix.texi:18685
33185 msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history"
33189 #: guix-git/doc/guix.texi:18689
33190 msgid "Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting."
33194 #: guix-git/doc/guix.texi:18691 guix-git/doc/guix.texi:18712
33195 #: guix-git/doc/guix.texi:18719 guix-git/doc/guix.texi:21114
33196 #: guix-git/doc/guix.texi:22804 guix-git/doc/guix.texi:22819
33197 #: guix-git/doc/guix.texi:26925
33198 msgid "Defaults to @samp{100}."
33202 #: guix-git/doc/guix.texi:18693
33204 msgid "{@code{cups-configuration} parameter} log-level log-level"
33208 #: guix-git/doc/guix.texi:18696
33209 msgid "Specifies the level of logging for the ErrorLog file. The value @code{none} stops all logging while @code{debug2} logs everything."
33213 #: guix-git/doc/guix.texi:18698 guix-git/doc/guix.texi:23281
33214 msgid "Defaults to @samp{info}."
33218 #: guix-git/doc/guix.texi:18700
33220 msgid "{@code{cups-configuration} parameter} log-time-format log-time-format"
33224 #: guix-git/doc/guix.texi:18703
33225 msgid "Specifies the format of the date and time in the log files. The value @code{standard} logs whole seconds while @code{usecs} logs microseconds."
33229 #: guix-git/doc/guix.texi:18705
33230 msgid "Defaults to @samp{standard}."
33234 #: guix-git/doc/guix.texi:18707
33236 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients"
33240 #: guix-git/doc/guix.texi:18710
33241 msgid "Specifies the maximum number of simultaneous clients that are allowed by the scheduler."
33245 #: guix-git/doc/guix.texi:18714
33247 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host"
33251 #: guix-git/doc/guix.texi:18717
33252 msgid "Specifies the maximum number of simultaneous clients that are allowed from a single address."
33256 #: guix-git/doc/guix.texi:18721
33258 msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies"
33262 #: guix-git/doc/guix.texi:18724
33263 msgid "Specifies the maximum number of copies that a user can print of each job."
33267 #: guix-git/doc/guix.texi:18726
33268 msgid "Defaults to @samp{9999}."
33272 #: guix-git/doc/guix.texi:18728
33274 msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time"
33278 #: guix-git/doc/guix.texi:18732
33279 msgid "Specifies the maximum time a job may remain in the @code{indefinite} hold state before it is canceled. A value of 0 disables cancellation of held jobs."
33283 #: guix-git/doc/guix.texi:18736
33285 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs"
33289 #: guix-git/doc/guix.texi:18739
33290 msgid "Specifies the maximum number of simultaneous jobs that are allowed. Set to 0 to allow an unlimited number of jobs."
33294 #: guix-git/doc/guix.texi:18741
33295 msgid "Defaults to @samp{500}."
33299 #: guix-git/doc/guix.texi:18743
33301 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer"
33305 #: guix-git/doc/guix.texi:18746
33306 msgid "Specifies the maximum number of simultaneous jobs that are allowed per printer. A value of 0 allows up to MaxJobs jobs per printer."
33310 #: guix-git/doc/guix.texi:18750
33312 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user"
33316 #: guix-git/doc/guix.texi:18753
33317 msgid "Specifies the maximum number of simultaneous jobs that are allowed per user. A value of 0 allows up to MaxJobs jobs per user."
33321 #: guix-git/doc/guix.texi:18757
33323 msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time"
33327 #: guix-git/doc/guix.texi:18760
33328 msgid "Specifies the maximum time a job may take to print before it is canceled, in seconds. Set to 0 to disable cancellation of ``stuck'' jobs."
33332 #: guix-git/doc/guix.texi:18762
33333 msgid "Defaults to @samp{10800}."
33337 #: guix-git/doc/guix.texi:18764
33339 msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size"
33343 #: guix-git/doc/guix.texi:18767
33344 msgid "Specifies the maximum size of the log files before they are rotated, in bytes. The value 0 disables log rotation."
33348 #: guix-git/doc/guix.texi:18769
33349 msgid "Defaults to @samp{1048576}."
33353 #: guix-git/doc/guix.texi:18771
33355 msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout"
33359 #: guix-git/doc/guix.texi:18774
33360 msgid "Specifies the maximum amount of time to allow between files in a multiple file print job, in seconds."
33364 #: guix-git/doc/guix.texi:18776 guix-git/doc/guix.texi:18987
33365 #: guix-git/doc/guix.texi:26506
33366 msgid "Defaults to @samp{300}."
33370 #: guix-git/doc/guix.texi:18778
33372 msgid "{@code{cups-configuration} parameter} string page-log-format"
33376 #: guix-git/doc/guix.texi:18783
33377 msgid "Specifies the format of PageLog lines. Sequences beginning with percent (@samp{%}) characters are replaced with the corresponding information, while all other characters are copied literally. The following percent sequences are recognized:"
33381 #: guix-git/doc/guix.texi:18785
33387 #: guix-git/doc/guix.texi:18787
33388 msgid "insert a single percent character"
33392 #: guix-git/doc/guix.texi:18788
33398 #: guix-git/doc/guix.texi:18790
33399 msgid "insert the value of the specified IPP attribute"
33403 #: guix-git/doc/guix.texi:18791
33409 #: guix-git/doc/guix.texi:18793
33410 msgid "insert the number of copies for the current page"
33414 #: guix-git/doc/guix.texi:18794
33420 #: guix-git/doc/guix.texi:18796
33421 msgid "insert the current page number"
33425 #: guix-git/doc/guix.texi:18797
33431 #: guix-git/doc/guix.texi:18799
33432 msgid "insert the current date and time in common log format"
33436 #: guix-git/doc/guix.texi:18800
33442 #: guix-git/doc/guix.texi:18802
33443 msgid "insert the job ID"
33447 #: guix-git/doc/guix.texi:18803 guix-git/doc/guix.texi:20724
33453 #: guix-git/doc/guix.texi:18805
33454 msgid "insert the printer name"
33458 #: guix-git/doc/guix.texi:18806 guix-git/doc/guix.texi:20747
33464 #: guix-git/doc/guix.texi:18808
33465 msgid "insert the username"
33469 #: guix-git/doc/guix.texi:18814
33470 msgid "A value of the empty string disables page logging. The string @code{%p %u %j %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@} %@{media@} %@{sides@}} creates a page log with the standard items."
33474 #: guix-git/doc/guix.texi:18818
33476 msgid "{@code{cups-configuration} parameter} environment-variables environment-variables"
33480 #: guix-git/doc/guix.texi:18821
33481 msgid "Passes the specified environment variable(s) to child processes; a list of strings."
33485 #: guix-git/doc/guix.texi:18825
33487 msgid "{@code{cups-configuration} parameter} policy-configuration-list policies"
33491 #: guix-git/doc/guix.texi:18827
33492 msgid "Specifies named access control policies."
33496 #: guix-git/doc/guix.texi:18829
33497 msgid "Available @code{policy-configuration} fields are:"
33501 #: guix-git/doc/guix.texi:18830
33503 msgid "{@code{policy-configuration} parameter} string name"
33507 #: guix-git/doc/guix.texi:18832
33508 msgid "Name of the policy."
33512 #: guix-git/doc/guix.texi:18834
33514 msgid "{@code{policy-configuration} parameter} string job-private-access"
33518 #: guix-git/doc/guix.texi:18844
33519 msgid "Specifies an access list for a job's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-config} configuration, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}."
33523 #: guix-git/doc/guix.texi:18846 guix-git/doc/guix.texi:18868
33524 msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}."
33528 #: guix-git/doc/guix.texi:18848
33530 msgid "{@code{policy-configuration} parameter} string job-private-values"
33534 #: guix-git/doc/guix.texi:18851 guix-git/doc/guix.texi:18873
33535 msgid "Specifies the list of job values to make private, or @code{all}, @code{default}, or @code{none}."
33539 #: guix-git/doc/guix.texi:18854
33540 msgid "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-name phone\"}."
33544 #: guix-git/doc/guix.texi:18856
33546 msgid "{@code{policy-configuration} parameter} string subscription-private-access"
33550 #: guix-git/doc/guix.texi:18866
33551 msgid "Specifies an access list for a subscription's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-config} configuration, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}."
33555 #: guix-git/doc/guix.texi:18870
33557 msgid "{@code{policy-configuration} parameter} string subscription-private-values"
33561 #: guix-git/doc/guix.texi:18876
33562 msgid "Defaults to @samp{\"notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data\"}."
33566 #: guix-git/doc/guix.texi:18878
33568 msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls"
33572 #: guix-git/doc/guix.texi:18880
33573 msgid "Access control by IPP operation."
33577 #: guix-git/doc/guix.texi:18885
33579 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files"
33583 #: guix-git/doc/guix.texi:18890
33584 msgid "Specifies whether job files (documents) are preserved after a job is printed. If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. Otherwise a boolean value applies indefinitely."
33588 #: guix-git/doc/guix.texi:18892
33589 msgid "Defaults to @samp{86400}."
33593 #: guix-git/doc/guix.texi:18894
33595 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history"
33599 #: guix-git/doc/guix.texi:18899
33600 msgid "Specifies whether the job history is preserved after a job is printed. If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. If @code{#t}, the job history is preserved until the MaxJobs limit is reached."
33604 #: guix-git/doc/guix.texi:18903
33606 msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout"
33610 #: guix-git/doc/guix.texi:18906
33611 msgid "Specifies the amount of time to wait for job completion before restarting the scheduler."
33615 #: guix-git/doc/guix.texi:18910
33617 msgid "{@code{cups-configuration} parameter} string rip-cache"
33621 #: guix-git/doc/guix.texi:18913
33622 msgid "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer."
33626 #: guix-git/doc/guix.texi:18915
33627 msgid "Defaults to @samp{\"128m\"}."
33631 #: guix-git/doc/guix.texi:18917
33633 msgid "{@code{cups-configuration} parameter} string server-admin"
33637 #: guix-git/doc/guix.texi:18919
33638 msgid "Specifies the email address of the server administrator."
33642 #: guix-git/doc/guix.texi:18921
33643 msgid "Defaults to @samp{\"root@@localhost.localdomain\"}."
33647 #: guix-git/doc/guix.texi:18923
33649 msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias"
33653 #: guix-git/doc/guix.texi:18931
33654 msgid "The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. Using the special name @code{*} can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using @code{*}."
33658 #: guix-git/doc/guix.texi:18933
33659 msgid "Defaults to @samp{*}."
33663 #: guix-git/doc/guix.texi:18935
33665 msgid "{@code{cups-configuration} parameter} string server-name"
33669 #: guix-git/doc/guix.texi:18937
33670 msgid "Specifies the fully-qualified host name of the server."
33674 #: guix-git/doc/guix.texi:18939 guix-git/doc/guix.texi:23794
33675 #: guix-git/doc/guix.texi:23839
33676 msgid "Defaults to @samp{\"localhost\"}."
33680 #: guix-git/doc/guix.texi:18941
33682 msgid "{@code{cups-configuration} parameter} server-tokens server-tokens"
33686 #: guix-git/doc/guix.texi:18949
33687 msgid "Specifies what information is included in the Server header of HTTP responses. @code{None} disables the Server header. @code{ProductOnly} reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname}) IPP/2.0}."
33691 #: guix-git/doc/guix.texi:18951
33692 msgid "Defaults to @samp{Minimal}."
33696 #: guix-git/doc/guix.texi:18953
33698 msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen"
33702 #: guix-git/doc/guix.texi:18958
33703 msgid "Listens on the specified interfaces for encrypted connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses."
33707 #: guix-git/doc/guix.texi:18962
33709 msgid "{@code{cups-configuration} parameter} ssl-options ssl-options"
33713 #: guix-git/doc/guix.texi:18972
33714 msgid "Sets encryption options. By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. Security is reduced when @code{Allow} options are used, and enhanced when @code{Deny} options are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher suites, which are required for some older clients. The @code{AllowSSL3} option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The @code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum protocol version to TLS v1.1."
33718 #: guix-git/doc/guix.texi:18976
33720 msgid "{@code{cups-configuration} parameter} boolean strict-conformance?"
33724 #: guix-git/doc/guix.texi:18979
33725 msgid "Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications."
33729 #: guix-git/doc/guix.texi:18983
33731 msgid "{@code{cups-configuration} parameter} non-negative-integer timeout"
33735 #: guix-git/doc/guix.texi:18985
33736 msgid "Specifies the HTTP request timeout, in seconds."
33740 #: guix-git/doc/guix.texi:18990
33742 msgid "{@code{cups-configuration} parameter} boolean web-interface?"
33746 #: guix-git/doc/guix.texi:18992
33747 msgid "Specifies whether the web interface is enabled."
33750 #. type: Plain text
33751 #: guix-git/doc/guix.texi:19002
33752 msgid "At this point you're probably thinking ``oh dear, Guix manual, I like you but you can stop already with the configuration options''. Indeed. However, one more point: it could be that you have an existing @code{cupsd.conf} that you want to use. In that case, you can pass an @code{opaque-cups-configuration} as the configuration of a @code{cups-service-type}."
33755 #. type: Plain text
33756 #: guix-git/doc/guix.texi:19004
33757 msgid "Available @code{opaque-cups-configuration} fields are:"
33761 #: guix-git/doc/guix.texi:19005
33763 msgid "{@code{opaque-cups-configuration} parameter} package cups"
33767 #: guix-git/doc/guix.texi:19009
33769 msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf"
33773 #: guix-git/doc/guix.texi:19011
33774 msgid "The contents of the @code{cupsd.conf}, as a string."
33778 #: guix-git/doc/guix.texi:19013
33780 msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf"
33784 #: guix-git/doc/guix.texi:19015
33785 msgid "The contents of the @code{cups-files.conf} file, as a string."
33788 #. type: Plain text
33789 #: guix-git/doc/guix.texi:19020
33790 msgid "For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in strings of the same name, you could instantiate a CUPS service like this:"
33794 #: guix-git/doc/guix.texi:19026
33797 "(service cups-service-type\n"
33798 " (opaque-cups-configuration\n"
33799 " (cupsd.conf cupsd.conf)\n"
33800 " (cups-files.conf cups-files.conf)))\n"
33803 #. type: Plain text
33804 #: guix-git/doc/guix.texi:19037
33805 msgid "The @code{(gnu services desktop)} module provides services that are usually useful in the context of a ``desktop'' setup---that is, on a machine running a graphical display server, possibly with graphical user interfaces, etc. It also defines services that provide specific desktop environments like GNOME, Xfce or MATE."
33808 #. type: Plain text
33809 #: guix-git/doc/guix.texi:19041
33810 msgid "To simplify things, the module defines a variable containing the set of services that users typically expect on a machine with a graphical environment and networking:"
33814 #: guix-git/doc/guix.texi:19042
33816 msgid "{Scheme Variable} %desktop-services"
33820 #: guix-git/doc/guix.texi:19045
33821 msgid "This is a list of services that builds upon @code{%base-services} and adds or adjusts services for a typical ``desktop'' setup."
33825 #: guix-git/doc/guix.texi:19056
33826 msgid "In particular, it adds a graphical login manager (@pxref{X Window, @code{gdm-service-type}}), screen lockers, a network management tool (@pxref{Networking Services, @code{network-manager-service-type}}) with modem support (@pxref{Networking Services, @code{modem-manager-service-type}}), energy and color management services, the @code{elogind} login and seat manager, the Polkit privilege service, the GeoClue location service, the AccountsService daemon that allows authorized users change system passwords, an NTP client (@pxref{Networking Services}), the Avahi daemon, and has the name service switch service configured to be able to use @code{nss-mdns} (@pxref{Name Service Switch, mDNS})."
33829 #. type: Plain text
33830 #: guix-git/doc/guix.texi:19061
33831 msgid "The @code{%desktop-services} variable can be used as the @code{services} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @code{services}})."
33834 #. type: Plain text
33835 #: guix-git/doc/guix.texi:19084
33836 msgid "Additionally, the @code{gnome-desktop-service-type}, @code{xfce-desktop-service}, @code{mate-desktop-service-type}, @code{lxqt-desktop-service-type} and @code{enlightenment-desktop-service-type} procedures can add GNOME, Xfce, MATE and/or Enlightenment to a system. To ``add GNOME'' means that system-level services like the backlight adjustment helpers and the power management utilities are added to the system, extending @code{polkit} and @code{dbus} appropriately, allowing GNOME to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service made by @code{gnome-desktop-service-type} adds the GNOME metapackage to the system profile. Likewise, adding the Xfce service not only adds the @code{xfce} metapackage to the system profile, but it also gives the Thunar file manager the ability to open a ``root-mode'' file management window, if the user authenticates using the administrator's password via the standard polkit graphical interface. To ``add MATE'' means that @code{polkit} and @code{dbus} are extended appropriately, allowing MATE to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service of type @code{mate-desktop-service-type} adds the MATE metapackage to the system profile. ``Adding Enlightenment'' means that @code{dbus} is extended appropriately, and several of Enlightenment's binaries are set as setuid, allowing Enlightenment's screen locker and other functionality to work as expected."
33839 #. type: Plain text
33840 #: guix-git/doc/guix.texi:19093
33841 msgid "The desktop environments in Guix use the Xorg display server by default. If you'd like to use the newer display server protocol called Wayland, you need to use the @code{sddm-service} instead of GDM as the graphical login manager. You should then select the ``GNOME (Wayland)'' session in SDDM@. Alternatively you can also try starting GNOME on Wayland manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session``. Currently only GNOME has support for Wayland."
33845 #: guix-git/doc/guix.texi:19094
33847 msgid "{Scheme Variable} gnome-desktop-service-type"
33851 #: guix-git/doc/guix.texi:19098
33852 msgid "This is the type of the service that adds the @uref{https://www.gnome.org, GNOME} desktop environment. Its value is a @code{gnome-desktop-configuration} object (see below)."
33856 #: guix-git/doc/guix.texi:19101
33857 msgid "This service adds the @code{gnome} package to the system profile, and extends polkit with the actions from @code{gnome-settings-daemon}."
33861 #: guix-git/doc/guix.texi:19103
33863 msgid "{Data Type} gnome-desktop-configuration"
33867 #: guix-git/doc/guix.texi:19105
33868 msgid "Configuration record for the GNOME desktop environment."
33872 #: guix-git/doc/guix.texi:19107
33874 msgid "@code{gnome} (default: @code{gnome})"
33878 #: guix-git/doc/guix.texi:19109
33879 msgid "The GNOME package to use."
33883 #: guix-git/doc/guix.texi:19112
33885 msgid "{Scheme Variable} xfce-desktop-service-type"
33889 #: guix-git/doc/guix.texi:19116
33890 msgid "This is the type of a service to run the @uref{Xfce, https://xfce.org/} desktop environment. Its value is an @code{xfce-desktop-configuration} object (see below)."
33894 #: guix-git/doc/guix.texi:19121
33895 msgid "This service adds the @code{xfce} package to the system profile, and extends polkit with the ability for @code{thunar} to manipulate the file system as root from within a user session, after the user has authenticated with the administrator's password."
33899 #: guix-git/doc/guix.texi:19127
33900 msgid "Note that @code{xfce4-panel} and its plugin packages should be installed in the same profile to ensure compatibility. When using this service, you should add extra plugins (@code{xfce4-whiskermenu-plugin}, @code{xfce4-weather-plugin}, etc.) to the @code{packages} field of your @code{operating-system}."
33904 #: guix-git/doc/guix.texi:19129
33906 msgid "{Data Type} xfce-desktop-configuration"
33910 #: guix-git/doc/guix.texi:19131
33911 msgid "Configuration record for the Xfce desktop environment."
33915 #: guix-git/doc/guix.texi:19133
33917 msgid "@code{xfce} (default: @code{xfce})"
33921 #: guix-git/doc/guix.texi:19135
33922 msgid "The Xfce package to use."
33926 #: guix-git/doc/guix.texi:19138
33928 msgid "{Scheme Variable} mate-desktop-service-type"
33932 #: guix-git/doc/guix.texi:19142
33933 msgid "This is the type of the service that runs the @uref{https://mate-desktop.org/, MATE desktop environment}. Its value is a @code{mate-desktop-configuration} object (see below)."
33937 #: guix-git/doc/guix.texi:19146
33938 msgid "This service adds the @code{mate} package to the system profile, and extends polkit with the actions from @code{mate-settings-daemon}."
33942 #: guix-git/doc/guix.texi:19148
33944 msgid "{Data Type} mate-desktop-configuration"
33948 #: guix-git/doc/guix.texi:19150
33949 msgid "Configuration record for the MATE desktop environment."
33953 #: guix-git/doc/guix.texi:19152
33955 msgid "@code{mate} (default: @code{mate})"
33959 #: guix-git/doc/guix.texi:19154
33960 msgid "The MATE package to use."
33964 #: guix-git/doc/guix.texi:19157
33966 msgid "{Scheme Variable} lxqt-desktop-service-type"
33970 #: guix-git/doc/guix.texi:19161
33971 msgid "This is the type of the service that runs the @uref{https://lxqt.github.io, LXQt desktop environment}. Its value is a @code{lxqt-desktop-configuration} object (see below)."
33975 #: guix-git/doc/guix.texi:19164
33976 msgid "This service adds the @code{lxqt} package to the system profile."
33980 #: guix-git/doc/guix.texi:19166
33982 msgid "{Data Type} lxqt-desktop-configuration"
33986 #: guix-git/doc/guix.texi:19168
33987 msgid "Configuration record for the LXQt desktop environment."
33991 #: guix-git/doc/guix.texi:19170
33993 msgid "@code{lxqt} (default: @code{lxqt})"
33997 #: guix-git/doc/guix.texi:19172
33998 msgid "The LXQT package to use."
34002 #: guix-git/doc/guix.texi:19175
34004 msgid "{Scheme Variable} enlightenment-desktop-service-type"
34008 #: guix-git/doc/guix.texi:19178
34009 msgid "Return a service that adds the @code{enlightenment} package to the system profile, and extends dbus with actions from @code{efl}."
34013 #: guix-git/doc/guix.texi:19180
34015 msgid "{Data Type} enlightenment-desktop-service-configuration"
34019 #: guix-git/doc/guix.texi:19182
34021 msgid "@code{enlightenment} (default: @code{enlightenment})"
34025 #: guix-git/doc/guix.texi:19184
34026 msgid "The enlightenment package to use."
34029 #. type: Plain text
34030 #: guix-git/doc/guix.texi:19192
34031 msgid "Because the GNOME, Xfce and MATE desktop services pull in so many packages, the default @code{%desktop-services} variable doesn't include any of them by default. To add GNOME, Xfce or MATE, just @code{cons} them onto @code{%desktop-services} in the @code{services} field of your @code{operating-system}:"
34035 #: guix-git/doc/guix.texi:19203
34038 "(use-modules (gnu))\n"
34039 "(use-service-modules desktop)\n"
34040 "(operating-system\n"
34042 " ;; cons* adds items to the list given as its last argument.\n"
34043 " (services (cons* (service gnome-desktop-service-type)\n"
34044 " (service xfce-desktop-service)\n"
34045 " %desktop-services))\n"
34049 #. type: Plain text
34050 #: guix-git/doc/guix.texi:19207
34051 msgid "These desktop environments will then be available as options in the graphical login window."
34054 #. type: Plain text
34055 #: guix-git/doc/guix.texi:19211
34056 msgid "The actual service definitions included in @code{%desktop-services} and provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} are described below."
34060 #: guix-git/doc/guix.texi:19212
34062 msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]"
34066 #: guix-git/doc/guix.texi:19215
34067 msgid "Return a service that runs the ``system bus'', using @var{dbus}, with support for @var{services}."
34071 #: guix-git/doc/guix.texi:19219
34072 msgid "@uref{https://dbus.freedesktop.org/, D-Bus} is an inter-process communication facility. Its system bus is used to allow system services to communicate and to be notified of system-wide events."
34076 #: guix-git/doc/guix.texi:19224
34077 msgid "@var{services} must be a list of packages that provide an @file{etc/dbus-1/system.d} directory containing additional D-Bus configuration and policy files. For example, to allow avahi-daemon to use the system bus, @var{services} must be equal to @code{(list avahi)}."
34081 #: guix-git/doc/guix.texi:19226
34083 msgid "{Scheme Procedure} elogind-service [#:config @var{config}]"
34087 #: guix-git/doc/guix.texi:19232
34088 msgid "Return a service that runs the @code{elogind} login and seat management daemon. @uref{https://github.com/elogind/elogind, Elogind} exposes a D-Bus interface that can be used to know which users are logged in, know what kind of sessions they have open, suspend the system, inhibit system suspend, reboot the system, and other tasks."
34092 #: guix-git/doc/guix.texi:19236
34093 msgid "Elogind handles most system-level power events for a computer, for example suspending the system when a lid is closed, or shutting it down when the power button is pressed."
34097 #: guix-git/doc/guix.texi:19241
34098 msgid "The @var{config} keyword argument specifies the configuration for elogind, and should be the result of an @code{(elogind-configuration (@var{parameter} @var{value})...)} invocation. Available parameters and their default values are:"
34102 #: guix-git/doc/guix.texi:19243
34104 msgid "kill-user-processes?"
34108 #: guix-git/doc/guix.texi:19245 guix-git/doc/guix.texi:19265
34109 #: guix-git/doc/guix.texi:19267 guix-git/doc/guix.texi:19269
34110 #: guix-git/doc/guix.texi:19281
34115 #: guix-git/doc/guix.texi:19245
34117 msgid "kill-only-users"
34121 #: guix-git/doc/guix.texi:19247 guix-git/doc/guix.texi:19287
34126 #: guix-git/doc/guix.texi:19247
34128 msgid "kill-exclude-users"
34132 #: guix-git/doc/guix.texi:19249
34137 #: guix-git/doc/guix.texi:19249
34139 msgid "inhibit-delay-max-seconds"
34143 #: guix-git/doc/guix.texi:19251
34148 #: guix-git/doc/guix.texi:19251
34150 msgid "handle-power-key"
34154 #: guix-git/doc/guix.texi:19253
34159 #: guix-git/doc/guix.texi:19253
34161 msgid "handle-suspend-key"
34165 #: guix-git/doc/guix.texi:19255 guix-git/doc/guix.texi:19259
34170 #: guix-git/doc/guix.texi:19255
34172 msgid "handle-hibernate-key"
34176 #: guix-git/doc/guix.texi:19257
34181 #: guix-git/doc/guix.texi:19257
34183 msgid "handle-lid-switch"
34187 #: guix-git/doc/guix.texi:19259
34189 msgid "handle-lid-switch-docked"
34193 #: guix-git/doc/guix.texi:19261 guix-git/doc/guix.texi:19263
34194 #: guix-git/doc/guix.texi:19275
34199 #: guix-git/doc/guix.texi:19261
34201 msgid "handle-lid-switch-external-power"
34205 #: guix-git/doc/guix.texi:19263
34207 msgid "power-key-ignore-inhibited?"
34211 #: guix-git/doc/guix.texi:19265
34213 msgid "suspend-key-ignore-inhibited?"
34217 #: guix-git/doc/guix.texi:19267
34219 msgid "hibernate-key-ignore-inhibited?"
34223 #: guix-git/doc/guix.texi:19269
34225 msgid "lid-switch-ignore-inhibited?"
34229 #: guix-git/doc/guix.texi:19271 guix-git/doc/guix.texi:19283
34234 #: guix-git/doc/guix.texi:19271
34236 msgid "holdoff-timeout-seconds"
34240 #: guix-git/doc/guix.texi:19273
34245 #: guix-git/doc/guix.texi:19273
34247 msgid "idle-action"
34251 #: guix-git/doc/guix.texi:19275
34253 msgid "idle-action-seconds"
34257 #: guix-git/doc/guix.texi:19277
34262 #: guix-git/doc/guix.texi:19277
34264 msgid "runtime-directory-size-percent"
34268 #: guix-git/doc/guix.texi:19279
34273 #: guix-git/doc/guix.texi:19279
34275 msgid "runtime-directory-size"
34279 #: guix-git/doc/guix.texi:19281
34281 msgid "remove-ipc?"
34285 #: guix-git/doc/guix.texi:19283
34287 msgid "suspend-state"
34291 #: guix-git/doc/guix.texi:19285
34292 msgid "(\"mem\" \"standby\" \"freeze\")"
34296 #: guix-git/doc/guix.texi:19285
34298 msgid "suspend-mode"
34302 #: guix-git/doc/guix.texi:19287
34304 msgid "hibernate-state"
34308 #: guix-git/doc/guix.texi:19289 guix-git/doc/guix.texi:19293
34313 #: guix-git/doc/guix.texi:19289
34315 msgid "hibernate-mode"
34319 #: guix-git/doc/guix.texi:19291
34320 msgid "(\"platform\" \"shutdown\")"
34324 #: guix-git/doc/guix.texi:19291
34326 msgid "hybrid-sleep-state"
34330 #: guix-git/doc/guix.texi:19293
34332 msgid "hybrid-sleep-mode"
34336 #: guix-git/doc/guix.texi:19295
34337 msgid "(\"suspend\" \"platform\" \"shutdown\")"
34341 #: guix-git/doc/guix.texi:19298
34343 msgid "{Scheme Procedure} accountsservice-service @"
34347 #: guix-git/doc/guix.texi:19306
34348 msgid "[#:accountsservice @var{accountsservice}] Return a service that runs AccountsService, a system service that can list available accounts, change their passwords, and so on. AccountsService integrates with PolicyKit to enable unprivileged users to acquire the capability to modify their system configuration. @uref{https://www.freedesktop.org/wiki/Software/AccountsService/, the accountsservice web site} for more information."
34352 #: guix-git/doc/guix.texi:19309
34353 msgid "The @var{accountsservice} keyword argument is the @code{accountsservice} package to expose as a service."
34357 #: guix-git/doc/guix.texi:19311
34359 msgid "{Scheme Procedure} polkit-service @"
34363 #: guix-git/doc/guix.texi:19320
34364 msgid "[#:polkit @var{polkit}] Return a service that runs the @uref{https://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege management service}, which allows system administrators to grant access to privileged operations in a structured way. By querying the Polkit service, a privileged system component can know when it should grant additional capabilities to ordinary users. For example, an ordinary user can be granted the capability to suspend the system if the user is logged in locally."
34368 #: guix-git/doc/guix.texi:19322
34370 msgid "{Scheme Variable} polkit-wheel-service"
34374 #: guix-git/doc/guix.texi:19327
34375 msgid "Service that adds the @code{wheel} group as admins to the Polkit service. This makes it so that users in the @code{wheel} group are queried for their own passwords when performing administrative actions instead of @code{root}'s, similar to the behaviour used by @code{sudo}."
34379 #: guix-git/doc/guix.texi:19329
34381 msgid "{Scheme Variable} upower-service-type"
34385 #: guix-git/doc/guix.texi:19333
34386 msgid "Service that runs @uref{https://upower.freedesktop.org/, @command{upowerd}}, a system-wide monitor for power consumption and battery levels, with the given configuration settings."
34390 #: guix-git/doc/guix.texi:19336
34391 msgid "It implements the @code{org.freedesktop.UPower} D-Bus interface, and is notably used by GNOME."
34395 #: guix-git/doc/guix.texi:19338
34397 msgid "{Data Type} upower-configuration"
34401 #: guix-git/doc/guix.texi:19340
34402 msgid "Data type representation the configuration for UPower."
34406 #: guix-git/doc/guix.texi:19343
34408 msgid "@code{upower} (default: @var{upower})"
34412 #: guix-git/doc/guix.texi:19345
34413 msgid "Package to use for @code{upower}."
34417 #: guix-git/doc/guix.texi:19346
34419 msgid "@code{watts-up-pro?} (default: @code{#f})"
34423 #: guix-git/doc/guix.texi:19348
34424 msgid "Enable the Watts Up Pro device."
34428 #: guix-git/doc/guix.texi:19349
34430 msgid "@code{poll-batteries?} (default: @code{#t})"
34434 #: guix-git/doc/guix.texi:19351
34435 msgid "Enable polling the kernel for battery level changes."
34439 #: guix-git/doc/guix.texi:19352
34441 msgid "@code{ignore-lid?} (default: @code{#f})"
34445 #: guix-git/doc/guix.texi:19354
34446 msgid "Ignore the lid state, this can be useful if it's incorrect on a device."
34450 #: guix-git/doc/guix.texi:19355
34452 msgid "@code{use-percentage-for-policy?} (default: @code{#f})"
34456 #: guix-git/doc/guix.texi:19358
34457 msgid "Whether battery percentage based policy should be used. The default is to use the time left, change to @code{#t} to use the percentage."
34461 #: guix-git/doc/guix.texi:19359
34463 msgid "@code{percentage-low} (default: @code{10})"
34467 #: guix-git/doc/guix.texi:19362
34468 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered low."
34472 #: guix-git/doc/guix.texi:19363
34474 msgid "@code{percentage-critical} (default: @code{3})"
34478 #: guix-git/doc/guix.texi:19366
34479 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered critical."
34483 #: guix-git/doc/guix.texi:19367
34485 msgid "@code{percentage-action} (default: @code{2})"
34489 #: guix-git/doc/guix.texi:19370
34490 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which action will be taken."
34494 #: guix-git/doc/guix.texi:19371
34496 msgid "@code{time-low} (default: @code{1200})"
34500 #: guix-git/doc/guix.texi:19374
34501 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered low."
34505 #: guix-git/doc/guix.texi:19375
34507 msgid "@code{time-critical} (default: @code{300})"
34511 #: guix-git/doc/guix.texi:19378
34512 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered critical."
34516 #: guix-git/doc/guix.texi:19379
34518 msgid "@code{time-action} (default: @code{120})"
34522 #: guix-git/doc/guix.texi:19382
34523 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which action will be taken."
34527 #: guix-git/doc/guix.texi:19383
34529 msgid "@code{critical-power-action} (default: @code{'hybrid-sleep})"
34533 #: guix-git/doc/guix.texi:19386
34534 msgid "The action taken when @code{percentage-action} or @code{time-action} is reached (depending on the configuration of @code{use-percentage-for-policy?})."
34538 #: guix-git/doc/guix.texi:19388
34539 msgid "Possible values are:"
34543 #: guix-git/doc/guix.texi:19392
34548 #: guix-git/doc/guix.texi:19395
34553 #: guix-git/doc/guix.texi:19398
34554 msgid "@code{'hybrid-sleep}."
34558 #: guix-git/doc/guix.texi:19403
34560 msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]"
34564 #: guix-git/doc/guix.texi:19413
34565 msgid "Return a service for @uref{https://udisks.freedesktop.org/docs/latest/, UDisks}, a @dfn{disk management} daemon that provides user interfaces with notifications and ways to mount/unmount disks. Programs that talk to UDisks include the @command{udisksctl} command, part of UDisks, and GNOME Disks. Note that Udisks relies on the @command{mount} command, so it will only be able to use the file-system utilities installed in the system profile. For example if you want to be able to mount NTFS file-systems in read and write fashion, you'll need to have @code{ntfs-3g} installed system-wide."
34569 #: guix-git/doc/guix.texi:19415
34571 msgid "{Scheme Variable} colord-service-type"
34575 #: guix-git/doc/guix.texi:19422
34576 msgid "This is the type of the service that runs @command{colord}, a system service with a D-Bus interface to manage the color profiles of input and output devices such as screens and scanners. It is notably used by the GNOME Color Manager graphical tool. See @uref{https://www.freedesktop.org/software/colord/, the colord web site} for more information."
34580 #: guix-git/doc/guix.texi:19424
34582 msgid "scanner access"
34586 #: guix-git/doc/guix.texi:19425
34588 msgid "{Scheme Variable} sane-service-type"
34592 #: guix-git/doc/guix.texi:19431
34593 msgid "This service provides access to scanners @i{via} @uref{http://www.sane-project.org, SANE} by installing the necessary udev rules. It is included in @code{%desktop-services} (@pxref{Desktop Services}) and relies by default on @code{sane-backends-minimal} package (see below) for hardware support."
34597 #: guix-git/doc/guix.texi:19433
34599 msgid "{Scheme Variable} sane-backends-minimal"
34603 #: guix-git/doc/guix.texi:19436
34604 msgid "The default package which the @code{sane-service-type} installs. It supports many recent scanners."
34608 #: guix-git/doc/guix.texi:19438
34610 msgid "{Scheme Variable} sane-backends"
34614 #: guix-git/doc/guix.texi:19445
34615 msgid "This package includes support for all scanners that @code{sane-backends-minimal} supports, plus older Hewlett-Packard scanners supported by @code{hplip} package. In order to use this on a system which relies on @code{%desktop-services}, you may use @code{modify-services} (@pxref{Service Reference, @code{modify-services}}) as illustrated below:"
34619 #: guix-git/doc/guix.texi:19454
34622 "(use-modules (gnu))\n"
34623 "(use-service-modules\n"
34626 "(use-package-modules\n"
34633 #: guix-git/doc/guix.texi:19459
34636 "(define %my-desktop-services\n"
34637 " ;; List of desktop services that supports a broader range of scanners.\n"
34638 " (modify-services %desktop-services\n"
34639 " (sane-service-type _ => sane-backends)))\n"
34644 #: guix-git/doc/guix.texi:19463
34647 "(operating-system\n"
34649 " (services %my-desktop-services)\n"
34653 #: guix-git/doc/guix.texi:19466
34655 msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]"
34659 #: guix-git/doc/guix.texi:19475
34660 msgid "Return a configuration allowing an application to access GeoClue location data. @var{name} is the Desktop ID of the application, without the @code{.desktop} part. If @var{allowed?} is true, the application will have access to location information by default. The boolean @var{system?} value indicates whether an application is a system component or not. Finally @var{users} is a list of UIDs of all users for which this application is allowed location info access. An empty users list means that all users are allowed."
34664 #: guix-git/doc/guix.texi:19477
34666 msgid "{Scheme Variable} %standard-geoclue-applications"
34670 #: guix-git/doc/guix.texi:19484
34671 msgid "The standard list of well-known GeoClue application configurations, granting authority to the GNOME date-and-time utility to ask for the current location in order to set the time zone, and allowing the IceCat and Epiphany web browsers to request location information. IceCat and Epiphany both query the user before allowing a web page to know the user's location."
34675 #: guix-git/doc/guix.texi:19486
34677 msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @"
34681 #: guix-git/doc/guix.texi:19499
34682 msgid "[#:whitelist '()] @ [#:wifi-geolocation-url \"https://location.services.mozilla.com/v1/geolocate?key=geoclue\"] @ [#:submit-data? #f] [#:wifi-submission-url \"https://location.services.mozilla.com/v1/submit?key=geoclue\"] @ [#:submission-nick \"geoclue\"] @ [#:applications %standard-geoclue-applications] Return a service that runs the GeoClue location service. This service provides a D-Bus interface to allow applications to request access to a user's physical location, and optionally to add information to online location databases. See @uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue web site} for more information."
34686 #: guix-git/doc/guix.texi:19501
34688 msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @"
34692 #: guix-git/doc/guix.texi:19508
34693 msgid "[@w{#:auto-enable? #f}] Return a service that runs the @command{bluetoothd} daemon, which manages all the Bluetooth devices and provides a number of D-Bus interfaces. When AUTO-ENABLE? is true, the bluetooth controller is powered automatically at boot, which can be useful when using a bluetooth keyboard or mouse."
34697 #: guix-git/doc/guix.texi:19510
34698 msgid "Users need to be in the @code{lp} group to access the D-Bus service."
34702 #: guix-git/doc/guix.texi:19512
34704 msgid "{Scheme Variable} gnome-keyring-service-type"
34708 #: guix-git/doc/guix.texi:19516
34709 msgid "This is the type of the service that adds the @uref{https://wiki.gnome.org/Projects/GnomeKeyring, GNOME Keyring}. Its value is a @code{gnome-keyring-configuration} object (see below)."
34713 #: guix-git/doc/guix.texi:19520
34714 msgid "This service adds the @code{gnome-keyring} package to the system profile and extends PAM with entries using @code{pam_gnome_keyring.so}, unlocking a user's login keyring when they log in or setting its password with passwd."
34718 #: guix-git/doc/guix.texi:19522
34720 msgid "{Data Type} gnome-keyring-configuration"
34724 #: guix-git/doc/guix.texi:19524
34725 msgid "Configuration record for the GNOME Keyring service."
34729 #: guix-git/doc/guix.texi:19526
34731 msgid "@code{keyring} (default: @code{gnome-keyring})"
34735 #: guix-git/doc/guix.texi:19528
34736 msgid "The GNOME keyring package to use."
34740 #: guix-git/doc/guix.texi:19529
34742 msgid "pam-services"
34746 #: guix-git/doc/guix.texi:19534
34747 msgid "A list of @code{(@var{service} . @var{kind})} pairs denoting PAM services to extend, where @var{service} is the name of an existing service to extend and @var{kind} is one of @code{login} or @code{passwd}."
34751 #: guix-git/doc/guix.texi:19540
34752 msgid "If @code{login} is given, it adds an optional @code{pam_gnome_keyring.so} to the auth block without arguments and to the session block with @code{auto_start}. If @code{passwd} is given, it adds an optional @code{pam_gnome_keyring.so} to the password block without arguments."
34756 #: guix-git/doc/guix.texi:19543
34757 msgid "By default, this field contains ``gdm-password'' with the value @code{login} and ``passwd'' is with the value @code{passwd}."
34761 #: guix-git/doc/guix.texi:19550
34763 msgid "sound support"
34767 #: guix-git/doc/guix.texi:19551
34773 #: guix-git/doc/guix.texi:19552
34775 msgid "PulseAudio, sound support"
34778 #. type: Plain text
34779 #: guix-git/doc/guix.texi:19557
34780 msgid "The @code{(gnu services sound)} module provides a service to configure the Advanced Linux Sound Architecture (ALSA) system, which makes PulseAudio the preferred ALSA output driver."
34784 #: guix-git/doc/guix.texi:19558
34786 msgid "{Scheme Variable} alsa-service-type"
34790 #: guix-git/doc/guix.texi:19563
34791 msgid "This is the type for the @uref{https://alsa-project.org/, Advanced Linux Sound Architecture} (ALSA) system, which generates the @file{/etc/asound.conf} configuration file. The value for this type is a @command{alsa-configuration} record as in this example:"
34795 #: guix-git/doc/guix.texi:19566
34797 msgid "(service alsa-service-type)\n"
34801 #: guix-git/doc/guix.texi:19569
34802 msgid "See below for details about @code{alsa-configuration}."
34806 #: guix-git/doc/guix.texi:19571
34808 msgid "{Data Type} alsa-configuration"
34812 #: guix-git/doc/guix.texi:19573
34813 msgid "Data type representing the configuration for @code{alsa-service}."
34817 #: guix-git/doc/guix.texi:19575
34819 msgid "@code{alsa-plugins} (default: @var{alsa-plugins})"
34823 #: guix-git/doc/guix.texi:19577
34824 msgid "@code{alsa-plugins} package to use."
34828 #: guix-git/doc/guix.texi:19578
34830 msgid "@code{pulseaudio?} (default: @var{#t})"
34834 #: guix-git/doc/guix.texi:19581
34835 msgid "Whether ALSA applications should transparently be made to use the @uref{https://www.pulseaudio.org/, PulseAudio} sound server."
34839 #: guix-git/doc/guix.texi:19585
34840 msgid "Using PulseAudio allows you to run several sound-producing applications at the same time and to individual control them @i{via} @command{pavucontrol}, among other things."
34844 #: guix-git/doc/guix.texi:19586
34846 msgid "@code{extra-options} (default: @var{\"\"})"
34850 #: guix-git/doc/guix.texi:19588
34851 msgid "String to append to the @file{/etc/asound.conf} file."
34854 #. type: Plain text
34855 #: guix-git/doc/guix.texi:19594
34856 msgid "Individual users who want to override the system configuration of ALSA can do it with the @file{~/.asoundrc} file:"
34860 #: guix-git/doc/guix.texi:19600
34863 "# In guix, we have to specify the absolute path for plugins.\n"
34864 "pcm_type.jack @{\n"
34865 " lib \"/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so\"\n"
34871 #: guix-git/doc/guix.texi:19609
34874 "# Routing ALSA to jack:\n"
34875 "# <http://jackaudio.org/faq/routing_alsa.html>.\n"
34878 " playback_ports @{\n"
34879 " 0 system:playback_1\n"
34880 " 1 system:playback_2\n"
34886 #: guix-git/doc/guix.texi:19615
34889 " capture_ports @{\n"
34890 " 0 system:capture_1\n"
34891 " 1 system:capture_2\n"
34898 #: guix-git/doc/guix.texi:19622
34901 "pcm.!default @{\n"
34904 " pcm \"rawjack\"\n"
34909 #. type: Plain text
34910 #: guix-git/doc/guix.texi:19626
34911 msgid "See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the details."
34915 #: guix-git/doc/guix.texi:19627
34917 msgid "{Scheme Variable} pulseaudio-service-type"
34921 #: guix-git/doc/guix.texi:19631
34922 msgid "This is the type for the @uref{https://www.pulseaudio.org/, PulseAudio} sound server. It exists to allow system overrides of the default settings via @code{pulseaudio-configuration}, see below."
34926 #: guix-git/doc/guix.texi:19637
34927 msgid "This service overrides per-user configuration files. If you want PulseAudio to honor configuration files in @file{~/.config/pulse} you have to unset the environment variables @env{PULSE_CONFIG} and @env{PULSE_CLIENTCONFIG} in your @file{~/.bash_profile}."
34931 #: guix-git/doc/guix.texi:19645
34932 msgid "This service on its own does not ensure, that the @code{pulseaudio} package exists on your machine. It merely adds configuration files for it, as detailed below. In the (admittedly unlikely) case, that you find yourself without a @code{pulseaudio} package, consider enabling it through the @code{alsa-service-type} above."
34936 #: guix-git/doc/guix.texi:19648
34938 msgid "{Data Type} pulseaudio-configuration"
34942 #: guix-git/doc/guix.texi:19650
34943 msgid "Data type representing the configuration for @code{pulseaudio-service}."
34947 #: guix-git/doc/guix.texi:19652
34949 msgid "@code{client-conf} (default: @code{'()})"
34953 #: guix-git/doc/guix.texi:19657
34954 msgid "List of settings to set in @file{client.conf}. Accepts a list of strings or a symbol-value pairs. A string will be inserted as-is with a newline added. A pair will be formatted as ``key = value'', again with a newline added."
34958 #: guix-git/doc/guix.texi:19658
34960 msgid "@code{daemon-conf} (default: @code{'((flat-volumes . no))})"
34964 #: guix-git/doc/guix.texi:19661
34965 msgid "List of settings to set in @file{daemon.conf}, formatted just like @var{client-conf}."
34969 #: guix-git/doc/guix.texi:19662
34971 msgid "@code{script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/default.pa\")})"
34975 #: guix-git/doc/guix.texi:19664
34976 msgid "Script file to use as @file{default.pa}."
34980 #: guix-git/doc/guix.texi:19665
34982 msgid "@code{system-script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/system.pa\")})"
34986 #: guix-git/doc/guix.texi:19667
34987 msgid "Script file to use as @file{system.pa}."
34991 #: guix-git/doc/guix.texi:19670
34993 msgid "{Scheme Variable} ladspa-service-type"
34997 #: guix-git/doc/guix.texi:19673
34998 msgid "This service sets the @var{LADSPA_PATH} variable, so that programs, which respect it, e.g. PulseAudio, can load LADSPA plugins."
35002 #: guix-git/doc/guix.texi:19676
35003 msgid "The following example will setup the service to enable modules from the @code{swh-plugins} package:"
35007 #: guix-git/doc/guix.texi:19680
35010 "(service ladspa-service-type\n"
35011 " (ladspa-configuration (plugins (list swh-plugins))))\n"
35015 #: guix-git/doc/guix.texi:19684
35016 msgid "See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the details."
35020 #: guix-git/doc/guix.texi:19691
35025 #. type: Plain text
35026 #: guix-git/doc/guix.texi:19693
35027 msgid "The @code{(gnu services databases)} module provides the following services."
35030 #. type: subsubheading
35031 #: guix-git/doc/guix.texi:19694
35036 #. type: Plain text
35037 #: guix-git/doc/guix.texi:19698
35038 msgid "The following example describes a PostgreSQL service with the default configuration."
35042 #: guix-git/doc/guix.texi:19703
35045 "(service postgresql-service-type\n"
35046 " (postgresql-configuration\n"
35047 " (postgresql postgresql-10)))\n"
35050 #. type: Plain text
35051 #: guix-git/doc/guix.texi:19709
35052 msgid "If the services fails to start, it may be due to an incompatible cluster already present in @var{data-directory}. Adjust it (or, if you don't need the cluster anymore, delete @var{data-directory}), then restart the service."
35055 #. type: Plain text
35056 #: guix-git/doc/guix.texi:19716
35057 msgid "Peer authentication is used by default and the @code{postgres} user account has no shell, which prevents the direct execution of @code{psql} commands as this user. To use @code{psql}, you can temporarily log in as @code{postgres} using a shell, create a PostgreSQL superuser with the same name as one of the system users and then create the associated database."
35061 #: guix-git/doc/guix.texi:19721
35064 "sudo -u postgres -s /bin/sh\n"
35065 "createuser --interactive\n"
35066 "createdb $MY_USER_LOGIN # Replace appropriately.\n"
35070 #: guix-git/doc/guix.texi:19723
35072 msgid "{Data Type} postgresql-configuration"
35076 #: guix-git/doc/guix.texi:19726
35077 msgid "Data type representing the configuration for the @code{postgresql-service-type}."
35081 #: guix-git/doc/guix.texi:19728
35087 #: guix-git/doc/guix.texi:19730
35088 msgid "PostgreSQL package to use for the service."
35092 #: guix-git/doc/guix.texi:19731
35094 msgid "@code{port} (default: @code{5432})"
35098 #: guix-git/doc/guix.texi:19733
35099 msgid "Port on which PostgreSQL should listen."
35103 #: guix-git/doc/guix.texi:19736
35104 msgid "Locale to use as the default when creating the database cluster."
35108 #: guix-git/doc/guix.texi:19737
35110 msgid "@code{config-file} (default: @code{(postgresql-config-file)})"
35114 #: guix-git/doc/guix.texi:19741
35115 msgid "The configuration file to use when running PostgreSQL@. The default behaviour uses the postgresql-config-file record with the default values for the fields."
35119 #: guix-git/doc/guix.texi:19742
35121 msgid "@code{log-directory} (default: @code{\"/var/log/postgresql\"})"
35125 #: guix-git/doc/guix.texi:19746
35126 msgid "The directory where @command{pg_ctl} output will be written in a file named @code{\"pg_ctl.log\"}. This file can be useful to debug PostgreSQL configuration errors for instance."
35130 #: guix-git/doc/guix.texi:19747
35132 msgid "@code{data-directory} (default: @code{\"/var/lib/postgresql/data\"})"
35136 #: guix-git/doc/guix.texi:19749
35137 msgid "Directory in which to store the data."
35141 #: guix-git/doc/guix.texi:19750
35143 msgid "@code{extension-packages} (default: @code{'()})"
35147 #: guix-git/doc/guix.texi:19751
35149 msgid "postgresql extension-packages"
35153 #: guix-git/doc/guix.texi:19756
35154 msgid "Additional extensions are loaded from packages listed in @var{extension-packages}. Extensions are available at runtime. For instance, to create a geographic database using the @code{postgis} extension, a user can configure the postgresql-service as in this example:"
35158 #: guix-git/doc/guix.texi:19757
35164 #: guix-git/doc/guix.texi:19760
35167 "(use-package-modules databases geo)\n"
35172 #: guix-git/doc/guix.texi:19773
35175 "(operating-system\n"
35177 " ;; postgresql is required to run `psql' but postgis is not required for\n"
35178 " ;; proper operation.\n"
35179 " (packages (cons* postgresql %base-packages))\n"
35182 " (service postgresql-service-type\n"
35183 " (postgresql-configuration\n"
35184 " (postgresql postgresql-10)\n"
35185 " (extension-packages (list postgis))))\n"
35186 " %base-services)))\n"
35190 #: guix-git/doc/guix.texi:19777
35191 msgid "Then the extension becomes visible and you can initialise an empty geographic database in this way:"
35195 #: guix-git/doc/guix.texi:19784
35198 "psql -U postgres\n"
35199 "> create database postgistest;\n"
35200 "> \\connect postgistest;\n"
35201 "> create extension postgis;\n"
35202 "> create extension postgis_topology;\n"
35206 #: guix-git/doc/guix.texi:19789
35207 msgid "There is no need to add this field for contrib extensions such as hstore or dblink as they are already loadable by postgresql. This field is only required to add extensions provided by other packages."
35211 #: guix-git/doc/guix.texi:19793
35213 msgid "{Data Type} postgresql-config-file"
35217 #: guix-git/doc/guix.texi:19799
35218 msgid "Data type representing the PostgreSQL configuration file. As shown in the following example, this can be used to customize the configuration of PostgreSQL@. Note that you can use any G-expression or filename in place of this record, if you already have a configuration file you'd like to use for example."
35222 #: guix-git/doc/guix.texi:19819
35225 "(service postgresql-service-type\n"
35226 " (postgresql-configuration\n"
35228 " (postgresql-config-file\n"
35229 " (log-destination \"stderr\")\n"
35231 " (plain-file \"pg_hba.conf\"\n"
35233 "local\tall\tall\t\t\ttrust\n"
35234 "host\tall\tall\t127.0.0.1/32 \tmd5\n"
35235 "host\tall\tall\t::1/128 \tmd5\"))\n"
35237 " '((\"session_preload_libraries\" \"auto_explain\")\n"
35238 " (\"random_page_cost\" 2)\n"
35239 " (\"auto_explain.log_min_duration\" \"100 ms\")\n"
35240 " (\"work_mem\" \"500 MB\")\n"
35241 " (\"logging_collector\" #t)\n"
35242 " (\"log_directory\" \"/var/log/postgresql\")))))))\n"
35246 #: guix-git/doc/guix.texi:19822
35248 msgid "@code{log-destination} (default: @code{\"syslog\"})"
35252 #: guix-git/doc/guix.texi:19825
35253 msgid "The logging method to use for PostgreSQL@. Multiple values are accepted, separated by commas."
35257 #: guix-git/doc/guix.texi:19826
35259 msgid "@code{hba-file} (default: @code{%default-postgres-hba})"
35263 #: guix-git/doc/guix.texi:19829
35264 msgid "Filename or G-expression for the host-based authentication configuration."
35268 #: guix-git/doc/guix.texi:19830
35270 msgid "@code{ident-file} (default: @code{%default-postgres-ident})"
35274 #: guix-git/doc/guix.texi:19832
35275 msgid "Filename or G-expression for the user name mapping configuration."
35279 #: guix-git/doc/guix.texi:19833
35281 msgid "@code{socket-directory} (default: @code{#false})"
35285 #: guix-git/doc/guix.texi:19838
35286 msgid "Specifies the directory of the Unix-domain socket(s) on which PostgreSQL is to listen for connections from client applications. If set to @code{\"\"} PostgreSQL does not listen on any Unix-domain sockets, in which case only TCP/IP sockets can be used to connect to the server."
35290 #: guix-git/doc/guix.texi:19841
35291 msgid "By default, the @code{#false} value means the PostgreSQL default value will be used, which is currently @samp{/tmp}."
35295 #: guix-git/doc/guix.texi:19846
35296 msgid "List of additional keys and values to include in the PostgreSQL config file. Each entry in the list should be a list where the first element is the key, and the remaining elements are the values."
35300 #: guix-git/doc/guix.texi:19852
35301 msgid "The values can be numbers, booleans or strings and will be mapped to PostgreSQL parameters types @code{Boolean}, @code{String}, @code{Numeric}, @code{Numeric with Unit} and @code{Enumerated} described @uref{https://www.postgresql.org/docs/current/config-setting.html, here}."
35305 #: guix-git/doc/guix.texi:19856
35307 msgid "{Scheme Variable} postgresql-role-service-type"
35311 #: guix-git/doc/guix.texi:19859
35312 msgid "This service allows to create PostgreSQL roles and databases after PostgreSQL service start. Here is an example of its use."
35316 #: guix-git/doc/guix.texi:19867
35319 "(service postgresql-role-service-type\n"
35320 " (postgresql-role-configuration\n"
35322 " (list (postgresql-role\n"
35323 " (name \"test\")\n"
35324 " (create-database? #t))))))\n"
35328 #: guix-git/doc/guix.texi:19871
35329 msgid "This service can be extended with extra roles, as in this example:"
35333 #: guix-git/doc/guix.texi:19877
35336 "(service-extension postgresql-role-service-type\n"
35337 " (const (postgresql-role\n"
35338 " (name \"alice\")\n"
35339 " (create-database? #t))))\n"
35343 #: guix-git/doc/guix.texi:19880
35345 msgid "{Data Type} postgresql-role"
35349 #: guix-git/doc/guix.texi:19886
35350 msgid "PostgreSQL manages database access permissions using the concept of roles. A role can be thought of as either a database user, or a group of database users, depending on how the role is set up. Roles can own database objects (for example, tables) and can assign privileges on those objects to other roles to control who has access to which objects."
35354 #: guix-git/doc/guix.texi:19890
35355 msgid "The role name."
35359 #: guix-git/doc/guix.texi:19891
35361 msgid "@code{permissions} (default: @code{'(createdb login)})"
35365 #: guix-git/doc/guix.texi:19895
35366 msgid "The role permissions list. Supported permissions are @code{bypassrls}, @code{createdb}, @code{createrole}, @code{login}, @code{replication} and @code{superuser}."
35370 #: guix-git/doc/guix.texi:19896
35372 msgid "@code{create-database?} (default: @code{#f})"
35376 #: guix-git/doc/guix.texi:19898
35377 msgid "Whether to create a database with the same name as the role."
35381 #: guix-git/doc/guix.texi:19902
35383 msgid "{Data Type} postgresql-role-configuration"
35387 #: guix-git/doc/guix.texi:19905
35388 msgid "Data type representing the configuration of @var{postgresql-role-service-type}."
35392 #: guix-git/doc/guix.texi:19907
35394 msgid "@code{host} (default: @code{\"/var/run/postgresql\"})"
35398 #: guix-git/doc/guix.texi:19909
35399 msgid "The PostgreSQL host to connect to."
35403 #: guix-git/doc/guix.texi:19910
35405 msgid "@code{log} (default: @code{\"/var/log/postgresql_roles.log\"})"
35409 #: guix-git/doc/guix.texi:19912
35410 msgid "File name of the log file."
35414 #: guix-git/doc/guix.texi:19913
35416 msgid "@code{roles} (default: @code{'()})"
35420 #: guix-git/doc/guix.texi:19915
35421 msgid "The initial PostgreSQL roles to create."
35424 #. type: subsubheading
35425 #: guix-git/doc/guix.texi:19918
35427 msgid "MariaDB/MySQL"
35431 #: guix-git/doc/guix.texi:19920
35433 msgid "{Scheme Variable} mysql-service-type"
35437 #: guix-git/doc/guix.texi:19924
35438 msgid "This is the service type for a MySQL or MariaDB database server. Its value is a @code{mysql-configuration} object that specifies which package to use, as well as various settings for the @command{mysqld} daemon."
35442 #: guix-git/doc/guix.texi:19926
35444 msgid "{Data Type} mysql-configuration"
35448 #: guix-git/doc/guix.texi:19928
35449 msgid "Data type representing the configuration of @var{mysql-service-type}."
35453 #: guix-git/doc/guix.texi:19930
35455 msgid "@code{mysql} (default: @var{mariadb})"
35459 #: guix-git/doc/guix.texi:19933
35460 msgid "Package object of the MySQL database server, can be either @var{mariadb} or @var{mysql}."
35464 #: guix-git/doc/guix.texi:19936
35465 msgid "For MySQL, a temporary root password will be displayed at activation time. For MariaDB, the root password is empty."
35469 #: guix-git/doc/guix.texi:19937 guix-git/doc/guix.texi:23483
35471 msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})"
35475 #: guix-git/doc/guix.texi:19940
35476 msgid "The IP on which to listen for network connections. Use @code{\"0.0.0.0\"} to bind to all available network interfaces."
35480 #: guix-git/doc/guix.texi:19941
35482 msgid "@code{port} (default: @code{3306})"
35486 #: guix-git/doc/guix.texi:19943
35487 msgid "TCP port on which the database server listens for incoming connections."
35491 #: guix-git/doc/guix.texi:19944
35493 msgid "@code{socket} (default: @code{\"/run/mysqld/mysqld.sock\"})"
35497 #: guix-git/doc/guix.texi:19946
35498 msgid "Socket file to use for local (non-network) connections."
35502 #: guix-git/doc/guix.texi:19949
35503 msgid "Additional settings for the @file{my.cnf} configuration file."
35507 #: guix-git/doc/guix.texi:19950
35509 msgid "@code{auto-upgrade?} (default: @code{#t})"
35513 #: guix-git/doc/guix.texi:19955
35514 msgid "Whether to automatically run @command{mysql_upgrade} after starting the service. This is necessary to upgrade the @dfn{system schema} after ``major'' updates (such as switching from MariaDB 10.4 to 10.5), but can be disabled if you would rather do that manually."
35517 #. type: subsubheading
35518 #: guix-git/doc/guix.texi:19959
35524 #: guix-git/doc/guix.texi:19961
35526 msgid "{Scheme Variable} memcached-service-type"
35530 #: guix-git/doc/guix.texi:19965
35531 msgid "This is the service type for the @uref{https://memcached.org/, Memcached} service, which provides a distributed in memory cache. The value for the service type is a @code{memcached-configuration} object."
35535 #: guix-git/doc/guix.texi:19969
35537 msgid "(service memcached-service-type)\n"
35541 #: guix-git/doc/guix.texi:19971
35543 msgid "{Data Type} memcached-configuration"
35547 #: guix-git/doc/guix.texi:19973
35548 msgid "Data type representing the configuration of memcached."
35552 #: guix-git/doc/guix.texi:19975
35554 msgid "@code{memcached} (default: @code{memcached})"
35558 #: guix-git/doc/guix.texi:19977
35559 msgid "The Memcached package to use."
35563 #: guix-git/doc/guix.texi:19978
35565 msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})"
35569 #: guix-git/doc/guix.texi:19980
35570 msgid "Network interfaces on which to listen."
35574 #: guix-git/doc/guix.texi:19981
35576 msgid "@code{tcp-port} (default: @code{11211})"
35580 #: guix-git/doc/guix.texi:19983
35581 msgid "Port on which to accept connections."
35585 #: guix-git/doc/guix.texi:19984
35587 msgid "@code{udp-port} (default: @code{11211})"
35591 #: guix-git/doc/guix.texi:19987
35592 msgid "Port on which to accept UDP connections on, a value of 0 will disable listening on a UDP socket."
35596 #: guix-git/doc/guix.texi:19988
35598 msgid "@code{additional-options} (default: @code{'()})"
35602 #: guix-git/doc/guix.texi:19990
35603 msgid "Additional command line options to pass to @code{memcached}."
35606 #. type: subsubheading
35607 #: guix-git/doc/guix.texi:19993
35613 #: guix-git/doc/guix.texi:19995
35615 msgid "{Scheme Variable} redis-service-type"
35619 #: guix-git/doc/guix.texi:19998
35620 msgid "This is the service type for the @uref{https://redis.io/, Redis} key/value store, whose value is a @code{redis-configuration} object."
35624 #: guix-git/doc/guix.texi:20000
35626 msgid "{Data Type} redis-configuration"
35630 #: guix-git/doc/guix.texi:20002
35631 msgid "Data type representing the configuration of redis."
35635 #: guix-git/doc/guix.texi:20004
35637 msgid "@code{redis} (default: @code{redis})"
35641 #: guix-git/doc/guix.texi:20006
35642 msgid "The Redis package to use."
35646 #: guix-git/doc/guix.texi:20007
35648 msgid "@code{bind} (default: @code{\"127.0.0.1\"})"
35652 #: guix-git/doc/guix.texi:20009
35653 msgid "Network interface on which to listen."
35657 #: guix-git/doc/guix.texi:20010
35659 msgid "@code{port} (default: @code{6379})"
35663 #: guix-git/doc/guix.texi:20013
35664 msgid "Port on which to accept connections on, a value of 0 will disable listening on a TCP socket."
35668 #: guix-git/doc/guix.texi:20014
35670 msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})"
35674 #: guix-git/doc/guix.texi:20016
35675 msgid "Directory in which to store the database and related files."
35679 #: guix-git/doc/guix.texi:20022
35685 #: guix-git/doc/guix.texi:20023
35690 #. type: Plain text
35691 #: guix-git/doc/guix.texi:20028
35692 msgid "The @code{(gnu services mail)} module provides Guix service definitions for email services: IMAP, POP3, and LMTP servers, as well as mail transport agents (MTAs). Lots of acronyms! These services are detailed in the subsections below."
35695 #. type: subsubheading
35696 #: guix-git/doc/guix.texi:20029
35698 msgid "Dovecot Service"
35702 #: guix-git/doc/guix.texi:20031
35704 msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]"
35708 #: guix-git/doc/guix.texi:20033
35709 msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server."
35712 #. type: Plain text
35713 #: guix-git/doc/guix.texi:20043
35714 msgid "By default, Dovecot does not need much configuration; the default configuration object created by @code{(dovecot-configuration)} will suffice if your mail is delivered to @code{~/Maildir}. A self-signed certificate will be generated for TLS-protected connections, though Dovecot will also listen on cleartext ports by default. There are a number of options, though, which mail administrators might need to change, and as is the case with other services, Guix allows the system administrator to specify these parameters via a uniform Scheme interface."
35717 #. type: Plain text
35718 #: guix-git/doc/guix.texi:20046
35719 msgid "For example, to specify that mail is located at @code{maildir~/.mail}, one would instantiate the Dovecot service like this:"
35723 #: guix-git/doc/guix.texi:20051
35726 "(dovecot-service #:config\n"
35727 " (dovecot-configuration\n"
35728 " (mail-location \"maildir:~/.mail\")))\n"
35731 #. type: Plain text
35732 #: guix-git/doc/guix.texi:20059
35733 msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{dovecot.conf} file that you want to port over from some other system; see the end for more details."
35736 #. type: Plain text
35737 #: guix-git/doc/guix.texi:20069
35738 msgid "Available @code{dovecot-configuration} fields are:"
35742 #: guix-git/doc/guix.texi:20070
35744 msgid "{@code{dovecot-configuration} parameter} package dovecot"
35748 #: guix-git/doc/guix.texi:20072 guix-git/doc/guix.texi:21378
35749 msgid "The dovecot package."
35753 #: guix-git/doc/guix.texi:20074
35755 msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen"
35759 #: guix-git/doc/guix.texi:20080
35760 msgid "A list of IPs or hosts where to listen for connections. @samp{*} listens on all IPv4 interfaces, @samp{::} listens on all IPv6 interfaces. If you want to specify non-default ports or anything more complex, customize the address and port fields of the @samp{inet-listener} of the specific services you are interested in."
35764 #: guix-git/doc/guix.texi:20082
35766 msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols"
35770 #: guix-git/doc/guix.texi:20085
35771 msgid "List of protocols we want to serve. Available protocols include @samp{imap}, @samp{pop3}, and @samp{lmtp}."
35775 #: guix-git/doc/guix.texi:20087
35776 msgid "Available @code{protocol-configuration} fields are:"
35780 #: guix-git/doc/guix.texi:20088
35782 msgid "{@code{protocol-configuration} parameter} string name"
35786 #: guix-git/doc/guix.texi:20090
35787 msgid "The name of the protocol."
35791 #: guix-git/doc/guix.texi:20092
35793 msgid "{@code{protocol-configuration} parameter} string auth-socket-path"
35797 #: guix-git/doc/guix.texi:20096
35798 msgid "UNIX socket path to the master authentication server to find users. This is used by imap (for shared users) and lda. It defaults to @samp{\"/var/run/dovecot/auth-userdb\"}."
35802 #: guix-git/doc/guix.texi:20098
35804 msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins"
35808 #: guix-git/doc/guix.texi:20100
35809 msgid "Space separated list of plugins to load."
35813 #: guix-git/doc/guix.texi:20102
35815 msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections"
35819 #: guix-git/doc/guix.texi:20106
35820 msgid "Maximum number of IMAP connections allowed for a user from each IP address. NOTE: The username is compared case-sensitively. Defaults to @samp{10}."
35824 #: guix-git/doc/guix.texi:20110
35826 msgid "{@code{dovecot-configuration} parameter} service-configuration-list services"
35830 #: guix-git/doc/guix.texi:20114
35831 msgid "List of services to enable. Available services include @samp{imap}, @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and @samp{lmtp}."
35835 #: guix-git/doc/guix.texi:20116
35836 msgid "Available @code{service-configuration} fields are:"
35840 #: guix-git/doc/guix.texi:20117
35842 msgid "{@code{service-configuration} parameter} string kind"
35846 #: guix-git/doc/guix.texi:20122
35847 msgid "The service kind. Valid values include @code{director}, @code{imap-login}, @code{pop3-login}, @code{lmtp}, @code{imap}, @code{pop3}, @code{auth}, @code{auth-worker}, @code{dict}, @code{tcpwrap}, @code{quota-warning}, or anything else."
35851 #: guix-git/doc/guix.texi:20124
35853 msgid "{@code{service-configuration} parameter} listener-configuration-list listeners"
35857 #: guix-git/doc/guix.texi:20129
35858 msgid "Listeners for the service. A listener is either a @code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or an @code{inet-listener-configuration}. Defaults to @samp{()}."
35862 #: guix-git/doc/guix.texi:20131
35863 msgid "Available @code{unix-listener-configuration} fields are:"
35867 #: guix-git/doc/guix.texi:20132
35869 msgid "{@code{unix-listener-configuration} parameter} string path"
35873 #: guix-git/doc/guix.texi:20135 guix-git/doc/guix.texi:20158
35874 msgid "Path to the file, relative to @code{base-dir} field. This is also used as the section name."
35878 #: guix-git/doc/guix.texi:20137
35880 msgid "{@code{unix-listener-configuration} parameter} string mode"
35884 #: guix-git/doc/guix.texi:20140 guix-git/doc/guix.texi:20163
35885 msgid "The access mode for the socket. Defaults to @samp{\"0600\"}."
35889 #: guix-git/doc/guix.texi:20142
35891 msgid "{@code{unix-listener-configuration} parameter} string user"
35895 #: guix-git/doc/guix.texi:20145 guix-git/doc/guix.texi:20168
35896 msgid "The user to own the socket. Defaults to @samp{\"\"}."
35900 #: guix-git/doc/guix.texi:20147
35902 msgid "{@code{unix-listener-configuration} parameter} string group"
35906 #: guix-git/doc/guix.texi:20150 guix-git/doc/guix.texi:20173
35907 msgid "The group to own the socket. Defaults to @samp{\"\"}."
35911 #: guix-git/doc/guix.texi:20154
35912 msgid "Available @code{fifo-listener-configuration} fields are:"
35916 #: guix-git/doc/guix.texi:20155
35918 msgid "{@code{fifo-listener-configuration} parameter} string path"
35922 #: guix-git/doc/guix.texi:20160
35924 msgid "{@code{fifo-listener-configuration} parameter} string mode"
35928 #: guix-git/doc/guix.texi:20165
35930 msgid "{@code{fifo-listener-configuration} parameter} string user"
35934 #: guix-git/doc/guix.texi:20170
35936 msgid "{@code{fifo-listener-configuration} parameter} string group"
35940 #: guix-git/doc/guix.texi:20177
35941 msgid "Available @code{inet-listener-configuration} fields are:"
35945 #: guix-git/doc/guix.texi:20178
35947 msgid "{@code{inet-listener-configuration} parameter} string protocol"
35951 #: guix-git/doc/guix.texi:20180
35952 msgid "The protocol to listen for."
35956 #: guix-git/doc/guix.texi:20182
35958 msgid "{@code{inet-listener-configuration} parameter} string address"
35962 #: guix-git/doc/guix.texi:20185
35963 msgid "The address on which to listen, or empty for all addresses. Defaults to @samp{\"\"}."
35967 #: guix-git/doc/guix.texi:20187
35969 msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port"
35973 #: guix-git/doc/guix.texi:20189
35974 msgid "The port on which to listen."
35978 #: guix-git/doc/guix.texi:20191
35980 msgid "{@code{inet-listener-configuration} parameter} boolean ssl?"
35984 #: guix-git/doc/guix.texi:20195
35985 msgid "Whether to use SSL for this service; @samp{yes}, @samp{no}, or @samp{required}. Defaults to @samp{#t}."
35989 #: guix-git/doc/guix.texi:20199
35991 msgid "{@code{service-configuration} parameter} non-negative-integer client-limit"
35995 #: guix-git/doc/guix.texi:20204
35996 msgid "Maximum number of simultaneous client connections per process. Once this number of connections is received, the next incoming connection will prompt Dovecot to spawn another process. If set to 0, @code{default-client-limit} is used instead."
36000 #: guix-git/doc/guix.texi:20209
36002 msgid "{@code{service-configuration} parameter} non-negative-integer service-count"
36006 #: guix-git/doc/guix.texi:20214
36007 msgid "Number of connections to handle before starting a new process. Typically the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 is faster. <doc/wiki/LoginProcess.txt>. Defaults to @samp{1}."
36011 #: guix-git/doc/guix.texi:20217
36013 msgid "{@code{service-configuration} parameter} non-negative-integer process-limit"
36017 #: guix-git/doc/guix.texi:20220
36018 msgid "Maximum number of processes that can exist for this service. If set to 0, @code{default-process-limit} is used instead."
36022 #: guix-git/doc/guix.texi:20225
36024 msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail"
36028 #: guix-git/doc/guix.texi:20228
36029 msgid "Number of processes to always keep waiting for more connections. Defaults to @samp{0}."
36033 #: guix-git/doc/guix.texi:20230
36035 msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit"
36039 #: guix-git/doc/guix.texi:20234
36040 msgid "If you set @samp{service-count 0}, you probably need to grow this. Defaults to @samp{256000000}."
36044 #: guix-git/doc/guix.texi:20238
36046 msgid "{@code{dovecot-configuration} parameter} dict-configuration dict"
36050 #: guix-git/doc/guix.texi:20241
36051 msgid "Dict configuration, as created by the @code{dict-configuration} constructor."
36055 #: guix-git/doc/guix.texi:20243
36056 msgid "Available @code{dict-configuration} fields are:"
36060 #: guix-git/doc/guix.texi:20244
36062 msgid "{@code{dict-configuration} parameter} free-form-fields entries"
36066 #: guix-git/doc/guix.texi:20247
36067 msgid "A list of key-value pairs that this dict should hold. Defaults to @samp{()}."
36071 #: guix-git/doc/guix.texi:20251
36073 msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs"
36077 #: guix-git/doc/guix.texi:20254
36078 msgid "A list of passdb configurations, each one created by the @code{passdb-configuration} constructor."
36082 #: guix-git/doc/guix.texi:20256
36083 msgid "Available @code{passdb-configuration} fields are:"
36087 #: guix-git/doc/guix.texi:20257
36089 msgid "{@code{passdb-configuration} parameter} string driver"
36093 #: guix-git/doc/guix.texi:20262
36094 msgid "The driver that the passdb should use. Valid values include @samp{pam}, @samp{passwd}, @samp{shadow}, @samp{bsdauth}, and @samp{static}. Defaults to @samp{\"pam\"}."
36098 #: guix-git/doc/guix.texi:20264
36100 msgid "{@code{passdb-configuration} parameter} space-separated-string-list args"
36104 #: guix-git/doc/guix.texi:20267
36105 msgid "Space separated list of arguments to the passdb driver. Defaults to @samp{\"\"}."
36109 #: guix-git/doc/guix.texi:20271
36111 msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs"
36115 #: guix-git/doc/guix.texi:20274
36116 msgid "List of userdb configurations, each one created by the @code{userdb-configuration} constructor."
36120 #: guix-git/doc/guix.texi:20276
36121 msgid "Available @code{userdb-configuration} fields are:"
36125 #: guix-git/doc/guix.texi:20277
36127 msgid "{@code{userdb-configuration} parameter} string driver"
36131 #: guix-git/doc/guix.texi:20281
36132 msgid "The driver that the userdb should use. Valid values include @samp{passwd} and @samp{static}. Defaults to @samp{\"passwd\"}."
36136 #: guix-git/doc/guix.texi:20283
36138 msgid "{@code{userdb-configuration} parameter} space-separated-string-list args"
36142 #: guix-git/doc/guix.texi:20286
36143 msgid "Space separated list of arguments to the userdb driver. Defaults to @samp{\"\"}."
36147 #: guix-git/doc/guix.texi:20288
36149 msgid "{@code{userdb-configuration} parameter} free-form-args override-fields"
36153 #: guix-git/doc/guix.texi:20291
36154 msgid "Override fields from passwd. Defaults to @samp{()}."
36158 #: guix-git/doc/guix.texi:20295
36160 msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration"
36164 #: guix-git/doc/guix.texi:20298
36165 msgid "Plug-in configuration, created by the @code{plugin-configuration} constructor."
36169 #: guix-git/doc/guix.texi:20300
36171 msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces"
36175 #: guix-git/doc/guix.texi:20303
36176 msgid "List of namespaces. Each item in the list is created by the @code{namespace-configuration} constructor."
36180 #: guix-git/doc/guix.texi:20305
36181 msgid "Available @code{namespace-configuration} fields are:"
36185 #: guix-git/doc/guix.texi:20306
36187 msgid "{@code{namespace-configuration} parameter} string name"
36191 #: guix-git/doc/guix.texi:20308
36192 msgid "Name for this namespace."
36196 #: guix-git/doc/guix.texi:20310
36198 msgid "{@code{namespace-configuration} parameter} string type"
36202 #: guix-git/doc/guix.texi:20313
36203 msgid "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to @samp{\"private\"}."
36207 #: guix-git/doc/guix.texi:20315
36209 msgid "{@code{namespace-configuration} parameter} string separator"
36213 #: guix-git/doc/guix.texi:20321
36214 msgid "Hierarchy separator to use. You should use the same separator for all namespaces or some clients get confused. @samp{/} is usually a good one. The default however depends on the underlying mail storage format. Defaults to @samp{\"\"}."
36218 #: guix-git/doc/guix.texi:20323
36220 msgid "{@code{namespace-configuration} parameter} string prefix"
36224 #: guix-git/doc/guix.texi:20327
36225 msgid "Prefix required to access this namespace. This needs to be different for all namespaces. For example @samp{Public/}. Defaults to @samp{\"\"}."
36229 #: guix-git/doc/guix.texi:20329
36231 msgid "{@code{namespace-configuration} parameter} string location"
36235 #: guix-git/doc/guix.texi:20333
36236 msgid "Physical location of the mailbox. This is in the same format as mail_location, which is also the default for it. Defaults to @samp{\"\"}."
36240 #: guix-git/doc/guix.texi:20335
36242 msgid "{@code{namespace-configuration} parameter} boolean inbox?"
36246 #: guix-git/doc/guix.texi:20339
36247 msgid "There can be only one INBOX, and this setting defines which namespace has it. Defaults to @samp{#f}."
36251 #: guix-git/doc/guix.texi:20341
36253 msgid "{@code{namespace-configuration} parameter} boolean hidden?"
36257 #: guix-git/doc/guix.texi:20349
36258 msgid "If namespace is hidden, it's not advertised to clients via NAMESPACE extension. You'll most likely also want to set @samp{list? #f}. This is mostly useful when converting from another server with different namespaces which you want to deprecate but still keep working. For example you can create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} and @samp{mail/}. Defaults to @samp{#f}."
36262 #: guix-git/doc/guix.texi:20351
36264 msgid "{@code{namespace-configuration} parameter} boolean list?"
36268 #: guix-git/doc/guix.texi:20357
36269 msgid "Show the mailboxes under this namespace with the LIST command. This makes the namespace visible for clients that do not support the NAMESPACE extension. The special @code{children} value lists child mailboxes, but hides the namespace prefix. Defaults to @samp{#t}."
36273 #: guix-git/doc/guix.texi:20359
36275 msgid "{@code{namespace-configuration} parameter} boolean subscriptions?"
36279 #: guix-git/doc/guix.texi:20364
36280 msgid "Namespace handles its own subscriptions. If set to @code{#f}, the parent namespace handles them. The empty prefix should always have this as @code{#t}). Defaults to @samp{#t}."
36284 #: guix-git/doc/guix.texi:20366
36286 msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes"
36290 #: guix-git/doc/guix.texi:20369
36291 msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}."
36295 #: guix-git/doc/guix.texi:20371
36296 msgid "Available @code{mailbox-configuration} fields are:"
36300 #: guix-git/doc/guix.texi:20372
36302 msgid "{@code{mailbox-configuration} parameter} string name"
36306 #: guix-git/doc/guix.texi:20374
36307 msgid "Name for this mailbox."
36311 #: guix-git/doc/guix.texi:20376
36313 msgid "{@code{mailbox-configuration} parameter} string auto"
36317 #: guix-git/doc/guix.texi:20380
36318 msgid "@samp{create} will automatically create this mailbox. @samp{subscribe} will both create and subscribe to the mailbox. Defaults to @samp{\"no\"}."
36322 #: guix-git/doc/guix.texi:20382
36324 msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use"
36328 #: guix-git/doc/guix.texi:20387
36329 msgid "List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. Valid values are @code{\\All}, @code{\\Archive}, @code{\\Drafts}, @code{\\Flagged}, @code{\\Junk}, @code{\\Sent}, and @code{\\Trash}. Defaults to @samp{()}."
36333 #: guix-git/doc/guix.texi:20393
36335 msgid "{@code{dovecot-configuration} parameter} file-name base-dir"
36339 #: guix-git/doc/guix.texi:20396
36340 msgid "Base directory where to store runtime data. Defaults to @samp{\"/var/run/dovecot/\"}."
36344 #: guix-git/doc/guix.texi:20398
36346 msgid "{@code{dovecot-configuration} parameter} string login-greeting"
36350 #: guix-git/doc/guix.texi:20401
36351 msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}."
36355 #: guix-git/doc/guix.texi:20403
36357 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks"
36361 #: guix-git/doc/guix.texi:20410
36362 msgid "List of trusted network ranges. Connections from these IPs are allowed to override their IP addresses and ports (for logging and for authentication checks). @samp{disable-plaintext-auth} is also ignored for these networks. Typically you would specify your IMAP proxy servers here. Defaults to @samp{()}."
36366 #: guix-git/doc/guix.texi:20412
36368 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets"
36372 #: guix-git/doc/guix.texi:20415
36373 msgid "List of login access check sockets (e.g.@: tcpwrap). Defaults to @samp{()}."
36377 #: guix-git/doc/guix.texi:20417
36379 msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?"
36383 #: guix-git/doc/guix.texi:20423
36384 msgid "Show more verbose process titles (in ps). Currently shows user name and IP address. Useful for seeing who is actually using the IMAP processes (e.g.@: shared mailboxes or if the same uid is used for multiple accounts). Defaults to @samp{#f}."
36388 #: guix-git/doc/guix.texi:20425
36390 msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?"
36394 #: guix-git/doc/guix.texi:20431
36395 msgid "Should all processes be killed when Dovecot master process shuts down. Setting this to @code{#f} means that Dovecot can be upgraded without forcing existing client connections to close (although that could also be a problem if the upgrade is e.g.@: due to a security fix). Defaults to @samp{#t}."
36399 #: guix-git/doc/guix.texi:20433
36401 msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count"
36405 #: guix-git/doc/guix.texi:20437
36406 msgid "If non-zero, run mail commands via this many connections to doveadm server, instead of running them directly in the same process. Defaults to @samp{0}."
36410 #: guix-git/doc/guix.texi:20439
36412 msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path"
36416 #: guix-git/doc/guix.texi:20442
36417 msgid "UNIX socket or host:port used for connecting to doveadm server. Defaults to @samp{\"doveadm-server\"}."
36421 #: guix-git/doc/guix.texi:20444
36423 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment"
36427 #: guix-git/doc/guix.texi:20448
36428 msgid "List of environment variables that are preserved on Dovecot startup and passed down to all of its child processes. You can also give key=value pairs to always set specific settings."
36432 #: guix-git/doc/guix.texi:20450
36434 msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?"
36438 #: guix-git/doc/guix.texi:20457
36439 msgid "Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP matches the local IP (i.e.@: you're connecting from the same computer), the connection is considered secure and plaintext authentication is allowed. See also ssl=required setting. Defaults to @samp{#t}."
36443 #: guix-git/doc/guix.texi:20459
36445 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size"
36449 #: guix-git/doc/guix.texi:20464
36450 msgid "Authentication cache size (e.g.@: @samp{#e10e6}). 0 means it's disabled. Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set for caching to be used. Defaults to @samp{0}."
36454 #: guix-git/doc/guix.texi:20466
36456 msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl"
36460 #: guix-git/doc/guix.texi:20474
36461 msgid "Time to live for cached data. After TTL expires the cached record is no longer used, *except* if the main database lookup returns internal failure. We also try to handle password changes automatically: If user's previous authentication was successful, but this one wasn't, the cache isn't used. For now this works only with plaintext authentication. Defaults to @samp{\"1 hour\"}."
36465 #: guix-git/doc/guix.texi:20476
36467 msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl"
36471 #: guix-git/doc/guix.texi:20480
36472 msgid "TTL for negative hits (user not found, password mismatch). 0 disables caching them completely. Defaults to @samp{\"1 hour\"}."
36476 #: guix-git/doc/guix.texi:20482
36478 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms"
36482 #: guix-git/doc/guix.texi:20488
36483 msgid "List of realms for SASL authentication mechanisms that need them. You can leave it empty if you don't want to support multiple realms. Many clients simply use the first one listed here, so keep the default realm first. Defaults to @samp{()}."
36487 #: guix-git/doc/guix.texi:20490
36489 msgid "{@code{dovecot-configuration} parameter} string auth-default-realm"
36493 #: guix-git/doc/guix.texi:20495
36494 msgid "Default realm/domain to use if none was specified. This is used for both SASL realms and appending @@domain to username in plaintext logins. Defaults to @samp{\"\"}."
36498 #: guix-git/doc/guix.texi:20497
36500 msgid "{@code{dovecot-configuration} parameter} string auth-username-chars"
36504 #: guix-git/doc/guix.texi:20504
36505 msgid "List of allowed characters in username. If the user-given username contains a character not listed in here, the login automatically fails. This is just an extra check to make sure user can't exploit any potential quote escaping vulnerabilities with SQL/LDAP databases. If you want to allow all characters, set this value to empty. Defaults to @samp{\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@\"}."
36509 #: guix-git/doc/guix.texi:20506
36511 msgid "{@code{dovecot-configuration} parameter} string auth-username-translation"
36515 #: guix-git/doc/guix.texi:20512
36516 msgid "Username character translations before it's looked up from databases. The value contains series of from -> to characters. For example @samp{#@@/@@} means that @samp{#} and @samp{/} characters are translated to @samp{@@}. Defaults to @samp{\"\"}."
36520 #: guix-git/doc/guix.texi:20514
36522 msgid "{@code{dovecot-configuration} parameter} string auth-username-format"
36526 #: guix-git/doc/guix.texi:20521
36527 msgid "Username formatting before it's looked up from databases. You can use the standard variables here, e.g.@: %Lu would lowercase the username, %n would drop away the domain if it was given, or @samp{%n-AT-%d} would change the @samp{@@} into @samp{-AT-}. This translation is done after @samp{auth-username-translation} changes. Defaults to @samp{\"%Lu\"}."
36531 #: guix-git/doc/guix.texi:20523
36533 msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator"
36537 #: guix-git/doc/guix.texi:20531
36538 msgid "If you want to allow master users to log in by specifying the master username within the normal username string (i.e.@: not using SASL mechanism's support for it), you can specify the separator character here. The format is then <username><separator><master username>. UW-IMAP uses @samp{*} as the separator, so that could be a good choice. Defaults to @samp{\"\"}."
36542 #: guix-git/doc/guix.texi:20533
36544 msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username"
36548 #: guix-git/doc/guix.texi:20537
36549 msgid "Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to @samp{\"anonymous\"}."
36553 #: guix-git/doc/guix.texi:20539
36555 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count"
36559 #: guix-git/doc/guix.texi:20544
36560 msgid "Maximum number of dovecot-auth worker processes. They're used to execute blocking passdb and userdb queries (e.g.@: MySQL and PAM). They're automatically created and destroyed as needed. Defaults to @samp{30}."
36564 #: guix-git/doc/guix.texi:20546
36566 msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname"
36570 #: guix-git/doc/guix.texi:20551
36571 msgid "Host name to use in GSSAPI principal names. The default is to use the name returned by gethostname(). Use @samp{$ALL} (with quotes) to allow all keytab entries. Defaults to @samp{\"\"}."
36575 #: guix-git/doc/guix.texi:20553
36577 msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab"
36581 #: guix-git/doc/guix.texi:20559
36582 msgid "Kerberos keytab to use for the GSSAPI mechanism. Will use the system default (usually @file{/etc/krb5.keytab}) if not specified. You may need to change the auth service to run as root to be able to read this file. Defaults to @samp{\"\"}."
36586 #: guix-git/doc/guix.texi:20561
36588 msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?"
36592 #: guix-git/doc/guix.texi:20566
36593 msgid "Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and @samp{ntlm-auth} helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. Defaults to @samp{#f}."
36597 #: guix-git/doc/guix.texi:20568
36599 msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path"
36603 #: guix-git/doc/guix.texi:20571
36604 msgid "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/bin/ntlm_auth\"}."
36608 #: guix-git/doc/guix.texi:20573
36610 msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay"
36614 #: guix-git/doc/guix.texi:20576
36615 msgid "Time to delay before replying to failed authentications. Defaults to @samp{\"2 secs\"}."
36619 #: guix-git/doc/guix.texi:20578
36621 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?"
36625 #: guix-git/doc/guix.texi:20582
36626 msgid "Require a valid SSL client certificate or the authentication fails. Defaults to @samp{#f}."
36630 #: guix-git/doc/guix.texi:20584
36632 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?"
36636 #: guix-git/doc/guix.texi:20589
36637 msgid "Take the username from client's SSL certificate, using @code{X509_NAME_get_text_by_NID()} which returns the subject's DN's CommonName. Defaults to @samp{#f}."
36641 #: guix-git/doc/guix.texi:20591
36643 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms"
36647 #: guix-git/doc/guix.texi:20597
36648 msgid "List of wanted authentication mechanisms. Supported mechanisms are: @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, @samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also @samp{disable-plaintext-auth} setting."
36652 #: guix-git/doc/guix.texi:20599
36654 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers"
36658 #: guix-git/doc/guix.texi:20604
36659 msgid "List of IPs or hostnames to all director servers, including ourself. Ports can be specified as ip:port. The default port is the same as what director service's @samp{inet-listener} is using. Defaults to @samp{()}."
36663 #: guix-git/doc/guix.texi:20606
36665 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers"
36669 #: guix-git/doc/guix.texi:20610
36670 msgid "List of IPs or hostnames to all backend mail servers. Ranges are allowed too, like 10.0.0.10-10.0.0.30. Defaults to @samp{()}."
36674 #: guix-git/doc/guix.texi:20612
36676 msgid "{@code{dovecot-configuration} parameter} string director-user-expire"
36680 #: guix-git/doc/guix.texi:20616
36681 msgid "How long to redirect users to a specific server after it no longer has any connections. Defaults to @samp{\"15 min\"}."
36685 #: guix-git/doc/guix.texi:20618
36687 msgid "{@code{dovecot-configuration} parameter} string director-username-hash"
36691 #: guix-git/doc/guix.texi:20623
36692 msgid "How the username is translated before being hashed. Useful values include %Ln if user can log in with or without @@domain, %Ld if mailboxes are shared within domain. Defaults to @samp{\"%Lu\"}."
36696 #: guix-git/doc/guix.texi:20625
36698 msgid "{@code{dovecot-configuration} parameter} string log-path"
36702 #: guix-git/doc/guix.texi:20629
36703 msgid "Log file to use for error messages. @samp{syslog} logs to syslog, @samp{/dev/stderr} logs to stderr. Defaults to @samp{\"syslog\"}."
36707 #: guix-git/doc/guix.texi:20631
36709 msgid "{@code{dovecot-configuration} parameter} string info-log-path"
36713 #: guix-git/doc/guix.texi:20635
36714 msgid "Log file to use for informational messages. Defaults to @samp{log-path}. Defaults to @samp{\"\"}."
36718 #: guix-git/doc/guix.texi:20637
36720 msgid "{@code{dovecot-configuration} parameter} string debug-log-path"
36724 #: guix-git/doc/guix.texi:20641
36725 msgid "Log file to use for debug messages. Defaults to @samp{info-log-path}. Defaults to @samp{\"\"}."
36729 #: guix-git/doc/guix.texi:20643
36731 msgid "{@code{dovecot-configuration} parameter} string syslog-facility"
36735 #: guix-git/doc/guix.texi:20648
36736 msgid "Syslog facility to use if you're logging to syslog. Usually if you don't want to use @samp{mail}, you'll use local0..local7. Also other standard facilities are supported. Defaults to @samp{\"mail\"}."
36740 #: guix-git/doc/guix.texi:20650
36742 msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?"
36746 #: guix-git/doc/guix.texi:20654
36747 msgid "Log unsuccessful authentication attempts and the reasons why they failed. Defaults to @samp{#f}."
36751 #: guix-git/doc/guix.texi:20656
36753 msgid "{@code{dovecot-configuration} parameter} string auth-verbose-passwords"
36757 #: guix-git/doc/guix.texi:20663
36758 msgid "In case of password mismatches, log the attempted password. Valid values are no, plain and sha1. sha1 can be useful for detecting brute force password attempts vs. user simply trying the same password over and over again. You can also truncate the value to n chars by appending \":n\" (e.g.@: sha1:6). Defaults to @samp{\"no\"}."
36762 #: guix-git/doc/guix.texi:20665
36764 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?"
36768 #: guix-git/doc/guix.texi:20669
36769 msgid "Even more verbose logging for debugging purposes. Shows for example SQL queries. Defaults to @samp{#f}."
36773 #: guix-git/doc/guix.texi:20671
36775 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?"
36779 #: guix-git/doc/guix.texi:20676
36780 msgid "In case of password mismatches, log the passwords and used scheme so the problem can be debugged. Enabling this also enables @samp{auth-debug}. Defaults to @samp{#f}."
36784 #: guix-git/doc/guix.texi:20678
36786 msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?"
36790 #: guix-git/doc/guix.texi:20682
36791 msgid "Enable mail process debugging. This can help you figure out why Dovecot isn't finding your mails. Defaults to @samp{#f}."
36795 #: guix-git/doc/guix.texi:20684
36797 msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?"
36801 #: guix-git/doc/guix.texi:20687
36802 msgid "Show protocol level SSL errors. Defaults to @samp{#f}."
36806 #: guix-git/doc/guix.texi:20689
36808 msgid "{@code{dovecot-configuration} parameter} string log-timestamp"
36812 #: guix-git/doc/guix.texi:20693
36813 msgid "Prefix for each line written to log file. % codes are in strftime(3) format. Defaults to @samp{\"\\\"%b %d %H:%M:%S \\\"\"}."
36817 #: guix-git/doc/guix.texi:20695
36819 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements"
36823 #: guix-git/doc/guix.texi:20699
36824 msgid "List of elements we want to log. The elements which have a non-empty variable value are joined together to form a comma-separated string."
36828 #: guix-git/doc/guix.texi:20701
36830 msgid "{@code{dovecot-configuration} parameter} string login-log-format"
36834 #: guix-git/doc/guix.texi:20705
36835 msgid "Login log format. %s contains @samp{login-log-format-elements} string, %$ contains the data we want to log. Defaults to @samp{\"%$: %s\"}."
36839 #: guix-git/doc/guix.texi:20707
36841 msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix"
36845 #: guix-git/doc/guix.texi:20711
36846 msgid "Log prefix for mail processes. See doc/wiki/Variables.txt for list of possible variables you can use. Defaults to @samp{\"\\\"%s(%u)<%@{pid@}><%@{session@}>: \\\"\"}."
36850 #: guix-git/doc/guix.texi:20713
36852 msgid "{@code{dovecot-configuration} parameter} string deliver-log-format"
36856 #: guix-git/doc/guix.texi:20715
36857 msgid "Format to use for logging mail deliveries. You can use variables:"
36861 #: guix-git/doc/guix.texi:20716
36867 #: guix-git/doc/guix.texi:20718
36868 msgid "Delivery status message (e.g.@: @samp{saved to INBOX})"
36872 #: guix-git/doc/guix.texi:20718
36878 #: guix-git/doc/guix.texi:20720
36883 #: guix-git/doc/guix.texi:20720 guix-git/doc/guix.texi:21252
36889 #: guix-git/doc/guix.texi:20722
36894 #: guix-git/doc/guix.texi:20722
36900 #: guix-git/doc/guix.texi:20724
36901 msgid "From address"
36905 #: guix-git/doc/guix.texi:20726
36906 msgid "Physical size"
36910 #: guix-git/doc/guix.texi:20726
36916 #: guix-git/doc/guix.texi:20728
36917 msgid "Virtual size."
36921 #: guix-git/doc/guix.texi:20730
36922 msgid "Defaults to @samp{\"msgid=%m: %$\"}."
36926 #: guix-git/doc/guix.texi:20732
36928 msgid "{@code{dovecot-configuration} parameter} string mail-location"
36932 #: guix-git/doc/guix.texi:20737
36933 msgid "Location for users' mailboxes. The default is empty, which means that Dovecot tries to find the mailboxes automatically. This won't work if the user doesn't yet have any mail, so you should explicitly tell Dovecot the full location."
36937 #: guix-git/doc/guix.texi:20743
36938 msgid "If you're using mbox, giving a path to the INBOX file (e.g.@: @file{/var/mail/%u}) isn't enough. You'll also need to tell Dovecot where the other mailboxes are kept. This is called the @emph{root mail directory}, and it must be the first path given in the @samp{mail-location} setting."
36942 #: guix-git/doc/guix.texi:20745
36943 msgid "There are a few special variables you can use, e.g.:"
36947 #: guix-git/doc/guix.texi:20749
36952 #: guix-git/doc/guix.texi:20749 guix-git/doc/guix.texi:21248
36958 #: guix-git/doc/guix.texi:20751
36959 msgid "user part in user@@domain, same as %u if there's no domain"
36963 #: guix-git/doc/guix.texi:20751
36969 #: guix-git/doc/guix.texi:20753
36970 msgid "domain part in user@@domain, empty if there's no domain"
36974 #: guix-git/doc/guix.texi:20753
36980 #: guix-git/doc/guix.texi:20755
36981 msgid "home director"
36985 #: guix-git/doc/guix.texi:20758
36986 msgid "See doc/wiki/Variables.txt for full list. Some examples:"
36990 #: guix-git/doc/guix.texi:20759
36992 msgid "maildir:~/Maildir"
36996 #: guix-git/doc/guix.texi:20760
36998 msgid "mbox:~/mail:INBOX=/var/mail/%u"
37002 #: guix-git/doc/guix.texi:20761
37004 msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%"
37008 #: guix-git/doc/guix.texi:20766
37010 msgid "{@code{dovecot-configuration} parameter} string mail-uid"
37014 #: guix-git/doc/guix.texi:20771
37015 msgid "System user and group used to access mails. If you use multiple, userdb can override these by returning uid or gid fields. You can use either numbers or names. <doc/wiki/UserIds.txt>. Defaults to @samp{\"\"}."
37019 #: guix-git/doc/guix.texi:20773
37021 msgid "{@code{dovecot-configuration} parameter} string mail-gid"
37025 #: guix-git/doc/guix.texi:20778
37027 msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group"
37031 #: guix-git/doc/guix.texi:20784
37032 msgid "Group to enable temporarily for privileged operations. Currently this is used only with INBOX when either its initial creation or dotlocking fails. Typically this is set to @samp{\"mail\"} to give access to @file{/var/mail}. Defaults to @samp{\"\"}."
37036 #: guix-git/doc/guix.texi:20786
37038 msgid "{@code{dovecot-configuration} parameter} string mail-access-groups"
37042 #: guix-git/doc/guix.texi:20794
37043 msgid "Grant access to these supplementary groups for mail processes. Typically these are used to set up access to shared mailboxes. Note that it may be dangerous to set these if users can create symlinks (e.g.@: if @samp{mail} group is set here, @code{ln -s /var/mail ~/mail/var} could allow a user to delete others' mailboxes, or @code{ln -s /secret/shared/box ~/mail/mybox} would allow reading it). Defaults to @samp{\"\"}."
37047 #: guix-git/doc/guix.texi:20796
37049 msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?"
37053 #: guix-git/doc/guix.texi:20802
37054 msgid "Allow full file system access to clients. There's no access checks other than what the operating system does for the active UID/GID@. It works with both maildir and mboxes, allowing you to prefix mailboxes names with e.g.@: @file{/path/} or @file{~user/}. Defaults to @samp{#f}."
37058 #: guix-git/doc/guix.texi:20804
37060 msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?"
37064 #: guix-git/doc/guix.texi:20808
37065 msgid "Don't use @code{mmap()} at all. This is required if you store indexes to shared file systems (NFS or clustered file system). Defaults to @samp{#f}."
37069 #: guix-git/doc/guix.texi:20810
37071 msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?"
37075 #: guix-git/doc/guix.texi:20815
37076 msgid "Rely on @samp{O_EXCL} to work when creating dotlock files. NFS supports @samp{O_EXCL} since version 3, so this should be safe to use nowadays by default. Defaults to @samp{#t}."
37080 #: guix-git/doc/guix.texi:20817
37082 msgid "{@code{dovecot-configuration} parameter} string mail-fsync"
37086 #: guix-git/doc/guix.texi:20819
37087 msgid "When to use fsync() or fdatasync() calls:"
37091 #: guix-git/doc/guix.texi:20820
37097 #: guix-git/doc/guix.texi:20822
37098 msgid "Whenever necessary to avoid losing important data"
37102 #: guix-git/doc/guix.texi:20824
37103 msgid "Useful with e.g.@: NFS when @code{write()}s are delayed"
37107 #: guix-git/doc/guix.texi:20826
37108 msgid "Never use it (best performance, but crashes can lose data)."
37112 #: guix-git/doc/guix.texi:20828
37113 msgid "Defaults to @samp{\"optimized\"}."
37117 #: guix-git/doc/guix.texi:20830
37119 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?"
37123 #: guix-git/doc/guix.texi:20835
37124 msgid "Mail storage exists in NFS@. Set this to yes to make Dovecot flush NFS caches whenever needed. If you're using only a single mail server this isn't needed. Defaults to @samp{#f}."
37128 #: guix-git/doc/guix.texi:20837
37130 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?"
37134 #: guix-git/doc/guix.texi:20841
37135 msgid "Mail index files also exist in NFS@. Setting this to yes requires @samp{mmap-disable? #t} and @samp{fsync-disable? #f}. Defaults to @samp{#f}."
37139 #: guix-git/doc/guix.texi:20843
37141 msgid "{@code{dovecot-configuration} parameter} string lock-method"
37145 #: guix-git/doc/guix.texi:20849
37146 msgid "Locking method for index files. Alternatives are fcntl, flock and dotlock. Dotlocking uses some tricks which may create more disk I/O than other locking methods. NFS users: flock doesn't work, remember to change @samp{mmap-disable}. Defaults to @samp{\"fcntl\"}."
37150 #: guix-git/doc/guix.texi:20851
37152 msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir"
37156 #: guix-git/doc/guix.texi:20855
37157 msgid "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to @samp{\"/tmp\"}."
37161 #: guix-git/doc/guix.texi:20857
37163 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid"
37167 #: guix-git/doc/guix.texi:20863
37168 msgid "Valid UID range for users. This is mostly to make sure that users can't log in as daemons or other system users. Note that denying root logins is hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} is set to 0. Defaults to @samp{500}."
37172 #: guix-git/doc/guix.texi:20865
37174 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid"
37178 #: guix-git/doc/guix.texi:20870
37180 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid"
37184 #: guix-git/doc/guix.texi:20875
37185 msgid "Valid GID range for users. Users having non-valid GID as primary group ID aren't allowed to log in. If user belongs to supplementary groups with non-valid GIDs, those groups are not set. Defaults to @samp{1}."
37189 #: guix-git/doc/guix.texi:20877
37191 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid"
37195 #: guix-git/doc/guix.texi:20882
37197 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length"
37201 #: guix-git/doc/guix.texi:20886
37202 msgid "Maximum allowed length for mail keyword name. It's only forced when trying to create new keywords. Defaults to @samp{50}."
37206 #: guix-git/doc/guix.texi:20888
37208 msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs"
37212 #: guix-git/doc/guix.texi:20898
37213 msgid "List of directories under which chrooting is allowed for mail processes (i.e.@: @file{/var/mail} will allow chrooting to @file{/var/mail/foo/bar} too). This setting doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth chroot settings. If this setting is empty, @samp{/./} in home dirs are ignored. WARNING: Never add directories here which local users can modify, that may lead to root exploit. Usually this should be done only if you don't allow shell access for users. <doc/wiki/Chrooting.txt>. Defaults to @samp{()}."
37217 #: guix-git/doc/guix.texi:20900
37219 msgid "{@code{dovecot-configuration} parameter} string mail-chroot"
37223 #: guix-git/doc/guix.texi:20909
37224 msgid "Default chroot directory for mail processes. This can be overridden for specific users in user database by giving @samp{/./} in user's home directory (e.g.@: @samp{/home/./user} chroots into @file{/home}). Note that usually there is no real need to do chrooting, Dovecot doesn't allow users to access files outside their mail directory anyway. If your home directories are prefixed with the chroot directory, append @samp{/.} to @samp{mail-chroot}. <doc/wiki/Chrooting.txt>. Defaults to @samp{\"\"}."
37228 #: guix-git/doc/guix.texi:20911
37230 msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path"
37234 #: guix-git/doc/guix.texi:20915
37235 msgid "UNIX socket path to master authentication server to find users. This is used by imap (for shared users) and lda. Defaults to @samp{\"/var/run/dovecot/auth-userdb\"}."
37239 #: guix-git/doc/guix.texi:20917
37241 msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir"
37245 #: guix-git/doc/guix.texi:20920
37246 msgid "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/dovecot\"}."
37250 #: guix-git/doc/guix.texi:20922
37252 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins"
37256 #: guix-git/doc/guix.texi:20926
37257 msgid "List of plugins to load for all services. Plugins specific to IMAP, LDA, etc.@: are added to this list in their own .conf files. Defaults to @samp{()}."
37261 #: guix-git/doc/guix.texi:20928
37263 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count"
37267 #: guix-git/doc/guix.texi:20933
37268 msgid "The minimum number of mails in a mailbox before updates are done to cache file. This allows optimizing Dovecot's behavior to do less disk writes at the cost of more disk reads. Defaults to @samp{0}."
37272 #: guix-git/doc/guix.texi:20935
37274 msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval"
37278 #: guix-git/doc/guix.texi:20942
37279 msgid "When IDLE command is running, mailbox is checked once in a while to see if there are any new mails or other changes. This setting defines the minimum time to wait between those checks. Dovecot can also use dnotify, inotify and kqueue to find out immediately when changes occur. Defaults to @samp{\"30 secs\"}."
37283 #: guix-git/doc/guix.texi:20944
37285 msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?"
37289 #: guix-git/doc/guix.texi:20951
37290 msgid "Save mails with CR+LF instead of plain LF@. This makes sending those mails take less CPU, especially with sendfile() syscall with Linux and FreeBSD@. But it also creates a bit more disk I/O which may just make it slower. Also note that if other software reads the mboxes/maildirs, they may handle the extra CRs wrong and cause problems. Defaults to @samp{#f}."
37294 #: guix-git/doc/guix.texi:20953
37296 msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?"
37300 #: guix-git/doc/guix.texi:20961
37301 msgid "By default LIST command returns all entries in maildir beginning with a dot. Enabling this option makes Dovecot return only entries which are directories. This is done by stat()ing each entry, so it causes more disk I/O. (For systems setting struct @samp{dirent->d_type} this check is free and it's done always regardless of this setting). Defaults to @samp{#f}."
37305 #: guix-git/doc/guix.texi:20963
37307 msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?"
37311 #: guix-git/doc/guix.texi:20968
37312 msgid "When copying a message, do it with hard links whenever possible. This makes the performance much better, and it's unlikely to have any side effects. Defaults to @samp{#t}."
37316 #: guix-git/doc/guix.texi:20970
37318 msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?"
37322 #: guix-git/doc/guix.texi:20975
37323 msgid "Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only when its mtime changes unexpectedly or when we can't find the mail otherwise. Defaults to @samp{#f}."
37327 #: guix-git/doc/guix.texi:20977
37329 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks"
37333 #: guix-git/doc/guix.texi:20980
37334 msgid "Which locking methods to use for locking mbox. There are four available:"
37338 #: guix-git/doc/guix.texi:20982
37344 #: guix-git/doc/guix.texi:20986
37345 msgid "Create <mailbox>.lock file. This is the oldest and most NFS-safe solution. If you want to use /var/mail/ like directory, the users will need write access to that directory."
37349 #: guix-git/doc/guix.texi:20986
37351 msgid "dotlock-try"
37355 #: guix-git/doc/guix.texi:20989
37356 msgid "Same as dotlock, but if it fails because of permissions or because there isn't enough disk space, just skip it."
37360 #: guix-git/doc/guix.texi:20989
37366 #: guix-git/doc/guix.texi:20991
37367 msgid "Use this if possible. Works with NFS too if lockd is used."
37371 #: guix-git/doc/guix.texi:20991
37377 #: guix-git/doc/guix.texi:20993 guix-git/doc/guix.texi:20995
37378 msgid "May not exist in all systems. Doesn't work with NFS."
37382 #: guix-git/doc/guix.texi:20993
37388 #: guix-git/doc/guix.texi:21001
37389 msgid "You can use multiple locking methods; if you do the order they're declared in is important to avoid deadlocks if other MTAs/MUAs are using multiple locking methods as well. Some operating systems don't allow using some of them simultaneously."
37393 #: guix-git/doc/guix.texi:21003
37395 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks"
37399 #: guix-git/doc/guix.texi:21007
37401 msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout"
37405 #: guix-git/doc/guix.texi:21010
37406 msgid "Maximum time to wait for lock (all of them) before aborting. Defaults to @samp{\"5 mins\"}."
37410 #: guix-git/doc/guix.texi:21012
37412 msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout"
37416 #: guix-git/doc/guix.texi:21016
37417 msgid "If dotlock exists but the mailbox isn't modified in any way, override the lock file after this much time. Defaults to @samp{\"2 mins\"}."
37421 #: guix-git/doc/guix.texi:21018
37423 msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?"
37427 #: guix-git/doc/guix.texi:21029
37428 msgid "When mbox changes unexpectedly we have to fully read it to find out what changed. If the mbox is large this can take a long time. Since the change is usually just a newly appended mail, it'd be faster to simply read the new mails. If this setting is enabled, Dovecot does this but still safely fallbacks to re-reading the whole mbox file whenever something in mbox isn't how it's expected to be. The only real downside to this setting is that if some other MUA changes message flags, Dovecot doesn't notice it immediately. Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK commands. Defaults to @samp{#t}."
37432 #: guix-git/doc/guix.texi:21031
37434 msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?"
37438 #: guix-git/doc/guix.texi:21036
37439 msgid "Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, EXAMINE, EXPUNGE or CHECK commands. If this is set, @samp{mbox-dirty-syncs} is ignored. Defaults to @samp{#f}."
37443 #: guix-git/doc/guix.texi:21038
37445 msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?"
37449 #: guix-git/doc/guix.texi:21044
37450 msgid "Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK commands and when closing the mailbox). This is especially useful for POP3 where clients often delete all mails. The downside is that our changes aren't immediately visible to other MUAs. Defaults to @samp{#t}."
37454 #: guix-git/doc/guix.texi:21046
37456 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size"
37460 #: guix-git/doc/guix.texi:21051
37461 msgid "If mbox size is smaller than this (e.g.@: 100k), don't write index files. If an index file already exists it's still read, just not updated. Defaults to @samp{0}."
37465 #: guix-git/doc/guix.texi:21053
37467 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size"
37471 #: guix-git/doc/guix.texi:21056
37472 msgid "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}."
37476 #: guix-git/doc/guix.texi:21058
37478 msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval"
37482 #: guix-git/doc/guix.texi:21063
37483 msgid "Maximum dbox file age until it's rotated. Typically in days. Day begins from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. Defaults to @samp{\"1d\"}."
37487 #: guix-git/doc/guix.texi:21065
37489 msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?"
37493 #: guix-git/doc/guix.texi:21070
37494 msgid "When creating new mdbox files, immediately preallocate their size to @samp{mdbox-rotate-size}. This setting currently works only in Linux with some file systems (ext4, xfs). Defaults to @samp{#f}."
37498 #: guix-git/doc/guix.texi:21072
37500 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir"
37504 #: guix-git/doc/guix.texi:21076
37505 msgid "sdbox and mdbox support saving mail attachments to external files, which also allows single instance storage for them. Other backends don't support this for now."
37509 #: guix-git/doc/guix.texi:21078
37510 msgid "WARNING: This feature hasn't been tested much yet. Use at your own risk."
37514 #: guix-git/doc/guix.texi:21081
37515 msgid "Directory root where to store mail attachments. Disabled, if empty. Defaults to @samp{\"\"}."
37519 #: guix-git/doc/guix.texi:21083
37521 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size"
37525 #: guix-git/doc/guix.texi:21088
37526 msgid "Attachments smaller than this aren't saved externally. It's also possible to write a plugin to disable saving specific attachments externally. Defaults to @samp{128000}."
37530 #: guix-git/doc/guix.texi:21090
37532 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs"
37536 #: guix-git/doc/guix.texi:21092
37537 msgid "File system backend to use for saving attachments:"
37541 #: guix-git/doc/guix.texi:21093
37547 #: guix-git/doc/guix.texi:21095
37548 msgid "No SiS done by Dovecot (but this might help FS's own deduplication)"
37552 #: guix-git/doc/guix.texi:21095
37558 #: guix-git/doc/guix.texi:21097
37559 msgid "SiS with immediate byte-by-byte comparison during saving"
37563 #: guix-git/doc/guix.texi:21097
37565 msgid "sis-queue posix"
37569 #: guix-git/doc/guix.texi:21099
37570 msgid "SiS with delayed comparison and deduplication."
37574 #: guix-git/doc/guix.texi:21101
37575 msgid "Defaults to @samp{\"sis posix\"}."
37579 #: guix-git/doc/guix.texi:21103
37581 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash"
37585 #: guix-git/doc/guix.texi:21109
37586 msgid "Hash format to use in attachment filenames. You can add any text and variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, @code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be truncated, e.g.@: @code{%@{sha256:80@}} returns only first 80 bits. Defaults to @samp{\"%@{sha1@}\"}."
37590 #: guix-git/doc/guix.texi:21111
37592 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit"
37596 #: guix-git/doc/guix.texi:21116
37598 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit"
37602 #: guix-git/doc/guix.texi:21119 guix-git/doc/guix.texi:28439
37603 msgid "Defaults to @samp{1000}."
37607 #: guix-git/doc/guix.texi:21121
37609 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit"
37613 #: guix-git/doc/guix.texi:21126
37614 msgid "Default VSZ (virtual memory size) limit for service processes. This is mainly intended to catch and kill processes that leak memory before they eat up everything. Defaults to @samp{256000000}."
37618 #: guix-git/doc/guix.texi:21128
37620 msgid "{@code{dovecot-configuration} parameter} string default-login-user"
37624 #: guix-git/doc/guix.texi:21133
37625 msgid "Login user is internally used by login processes. This is the most untrusted user in Dovecot system. It shouldn't have access to anything at all. Defaults to @samp{\"dovenull\"}."
37629 #: guix-git/doc/guix.texi:21135
37631 msgid "{@code{dovecot-configuration} parameter} string default-internal-user"
37635 #: guix-git/doc/guix.texi:21140
37636 msgid "Internal user is used by unprivileged processes. It should be separate from login user, so that login processes can't disturb other processes. Defaults to @samp{\"dovecot\"}."
37640 #: guix-git/doc/guix.texi:21142
37642 msgid "{@code{dovecot-configuration} parameter} string ssl?"
37646 #: guix-git/doc/guix.texi:21145
37647 msgid "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to @samp{\"required\"}."
37651 #: guix-git/doc/guix.texi:21147
37653 msgid "{@code{dovecot-configuration} parameter} string ssl-cert"
37657 #: guix-git/doc/guix.texi:21150
37658 msgid "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\"</etc/dovecot/default.pem\"}."
37662 #: guix-git/doc/guix.texi:21152
37664 msgid "{@code{dovecot-configuration} parameter} string ssl-key"
37668 #: guix-git/doc/guix.texi:21157
37669 msgid "PEM encoded SSL/TLS private key. The key is opened before dropping root privileges, so keep the key file unreadable by anyone but root. Defaults to @samp{\"</etc/dovecot/private/default.pem\"}."
37673 #: guix-git/doc/guix.texi:21159
37675 msgid "{@code{dovecot-configuration} parameter} string ssl-key-password"
37679 #: guix-git/doc/guix.texi:21165
37680 msgid "If key file is password protected, give the password here. Alternatively give it when starting dovecot with -p parameter. Since this file is often world-readable, you may want to place this setting instead to a different. Defaults to @samp{\"\"}."
37684 #: guix-git/doc/guix.texi:21167
37686 msgid "{@code{dovecot-configuration} parameter} string ssl-ca"
37690 #: guix-git/doc/guix.texi:21173
37691 msgid "PEM encoded trusted certificate authority. Set this only if you intend to use @samp{ssl-verify-client-cert? #t}. The file should contain the CA certificate(s) followed by the matching CRL(s). (e.g.@: @samp{ssl-ca </etc/ssl/certs/ca.pem}). Defaults to @samp{\"\"}."
37695 #: guix-git/doc/guix.texi:21175
37697 msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?"
37701 #: guix-git/doc/guix.texi:21178
37702 msgid "Require that CRL check succeeds for client certificates. Defaults to @samp{#t}."
37706 #: guix-git/doc/guix.texi:21180
37708 msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?"
37712 #: guix-git/doc/guix.texi:21184
37713 msgid "Request client to send a certificate. If you also want to require it, set @samp{auth-ssl-require-client-cert? #t} in auth section. Defaults to @samp{#f}."
37717 #: guix-git/doc/guix.texi:21186
37719 msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field"
37723 #: guix-git/doc/guix.texi:21191
37724 msgid "Which field from certificate to use for username. commonName and x500UniqueIdentifier are the usual choices. You'll also need to set @samp{auth-ssl-username-from-cert? #t}. Defaults to @samp{\"commonName\"}."
37728 #: guix-git/doc/guix.texi:21193
37730 msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol"
37734 #: guix-git/doc/guix.texi:21196
37735 msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}."
37739 #: guix-git/doc/guix.texi:21198
37741 msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list"
37745 #: guix-git/doc/guix.texi:21201
37746 msgid "SSL ciphers to use. Defaults to @samp{\"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH\"}."
37750 #: guix-git/doc/guix.texi:21203
37752 msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device"
37756 #: guix-git/doc/guix.texi:21206
37757 msgid "SSL crypto device to use, for valid values run \"openssl engine\". Defaults to @samp{\"\"}."
37761 #: guix-git/doc/guix.texi:21208
37763 msgid "{@code{dovecot-configuration} parameter} string postmaster-address"
37767 #: guix-git/doc/guix.texi:21212
37768 msgid "Address to use when sending rejection mails. %d expands to recipient domain. Defaults to @samp{\"postmaster@@%d\"}."
37772 #: guix-git/doc/guix.texi:21214
37774 msgid "{@code{dovecot-configuration} parameter} string hostname"
37778 #: guix-git/doc/guix.texi:21218
37779 msgid "Hostname to use in various parts of sent mails (e.g.@: in Message-Id) and in LMTP replies. Default is the system's real hostname@@domain. Defaults to @samp{\"\"}."
37783 #: guix-git/doc/guix.texi:21220
37785 msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?"
37789 #: guix-git/doc/guix.texi:21224
37790 msgid "If user is over quota, return with temporary failure instead of bouncing the mail. Defaults to @samp{#f}."
37794 #: guix-git/doc/guix.texi:21226
37796 msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path"
37800 #: guix-git/doc/guix.texi:21229
37801 msgid "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}."
37805 #: guix-git/doc/guix.texi:21231
37807 msgid "{@code{dovecot-configuration} parameter} string submission-host"
37811 #: guix-git/doc/guix.texi:21235
37812 msgid "If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to @samp{\"\"}."
37816 #: guix-git/doc/guix.texi:21237
37818 msgid "{@code{dovecot-configuration} parameter} string rejection-subject"
37822 #: guix-git/doc/guix.texi:21241
37823 msgid "Subject: header to use for rejection mails. You can use the same variables as for @samp{rejection-reason} below. Defaults to @samp{\"Rejected: %s\"}."
37827 #: guix-git/doc/guix.texi:21243
37829 msgid "{@code{dovecot-configuration} parameter} string rejection-reason"
37833 #: guix-git/doc/guix.texi:21246
37834 msgid "Human readable error message for rejection mails. You can use variables:"
37838 #: guix-git/doc/guix.texi:21250
37843 #: guix-git/doc/guix.texi:21250
37849 #: guix-git/doc/guix.texi:21252
37854 #: guix-git/doc/guix.texi:21254
37855 msgid "original subject"
37859 #: guix-git/doc/guix.texi:21254
37865 #: guix-git/doc/guix.texi:21256
37870 #: guix-git/doc/guix.texi:21258
37871 msgid "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}."
37875 #: guix-git/doc/guix.texi:21260
37877 msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter"
37881 #: guix-git/doc/guix.texi:21264
37882 msgid "Delimiter character between local-part and detail in email address. Defaults to @samp{\"+\"}."
37886 #: guix-git/doc/guix.texi:21266
37888 msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header"
37892 #: guix-git/doc/guix.texi:21272
37893 msgid "Header where the original recipient address (SMTP's RCPT TO: address) is taken from if not available elsewhere. With dovecot-lda -a parameter overrides this. A commonly used header for this is X-Original-To. Defaults to @samp{\"\"}."
37897 #: guix-git/doc/guix.texi:21274
37899 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?"
37903 #: guix-git/doc/guix.texi:21278
37904 msgid "Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to @samp{#f}."
37908 #: guix-git/doc/guix.texi:21280
37910 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?"
37914 #: guix-git/doc/guix.texi:21284
37915 msgid "Should automatically created mailboxes be also automatically subscribed?. Defaults to @samp{#f}."
37919 #: guix-git/doc/guix.texi:21286
37921 msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length"
37925 #: guix-git/doc/guix.texi:21292
37926 msgid "Maximum IMAP command line length. Some clients generate very long command lines with huge mailboxes, so you may need to raise this if you get \"Too long argument\" or \"IMAP command line too large\" errors often. Defaults to @samp{64000}."
37930 #: guix-git/doc/guix.texi:21294
37932 msgid "{@code{dovecot-configuration} parameter} string imap-logout-format"
37936 #: guix-git/doc/guix.texi:21296
37937 msgid "IMAP logout format string:"
37941 #: guix-git/doc/guix.texi:21297
37947 #: guix-git/doc/guix.texi:21299
37948 msgid "total number of bytes read from client"
37952 #: guix-git/doc/guix.texi:21299
37958 #: guix-git/doc/guix.texi:21301
37959 msgid "total number of bytes sent to client."
37963 #: guix-git/doc/guix.texi:21304
37964 msgid "See @file{doc/wiki/Variables.txt} for a list of all the variables you can use. Defaults to @samp{\"in=%i out=%o deleted=%@{deleted@} expunged=%@{expunged@} trashed=%@{trashed@} hdr_count=%@{fetch_hdr_count@} hdr_bytes=%@{fetch_hdr_bytes@} body_count=%@{fetch_body_count@} body_bytes=%@{fetch_body_bytes@}\"}."
37968 #: guix-git/doc/guix.texi:21306
37970 msgid "{@code{dovecot-configuration} parameter} string imap-capability"
37974 #: guix-git/doc/guix.texi:21310
37975 msgid "Override the IMAP CAPABILITY response. If the value begins with '+', add the given capabilities on top of the defaults (e.g.@: +XFOO XBAR). Defaults to @samp{\"\"}."
37979 #: guix-git/doc/guix.texi:21312
37981 msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval"
37985 #: guix-git/doc/guix.texi:21316
37986 msgid "How long to wait between \"OK Still here\" notifications when client is IDLEing. Defaults to @samp{\"2 mins\"}."
37990 #: guix-git/doc/guix.texi:21318
37992 msgid "{@code{dovecot-configuration} parameter} string imap-id-send"
37996 #: guix-git/doc/guix.texi:21324
37997 msgid "ID field names and values to send to clients. Using * as the value makes Dovecot use the default value. The following fields have default values currently: name, version, os, os-version, support-url, support-email. Defaults to @samp{\"\"}."
38001 #: guix-git/doc/guix.texi:21326
38003 msgid "{@code{dovecot-configuration} parameter} string imap-id-log"
38007 #: guix-git/doc/guix.texi:21329
38008 msgid "ID fields sent by client to log. * means everything. Defaults to @samp{\"\"}."
38012 #: guix-git/doc/guix.texi:21331
38014 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds"
38018 #: guix-git/doc/guix.texi:21333
38019 msgid "Workarounds for various client bugs:"
38023 #: guix-git/doc/guix.texi:21335
38025 msgid "delay-newmail"
38029 #: guix-git/doc/guix.texi:21342
38030 msgid "Send EXISTS/RECENT new mail notifications only when replying to NOOP and CHECK commands. Some clients ignore them otherwise, for example OSX Mail (<v2.1). Outlook Express breaks more badly though, without this it may show user \"Message no longer in server\" errors. Note that OE6 still breaks even with this workaround if synchronization is set to \"Headers Only\"."
38034 #: guix-git/doc/guix.texi:21343
38036 msgid "tb-extra-mailbox-sep"
38040 #: guix-git/doc/guix.texi:21347
38041 msgid "Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds extra @samp{/} suffixes to mailbox names. This option causes Dovecot to ignore the extra @samp{/} instead of treating it as invalid mailbox name."
38045 #: guix-git/doc/guix.texi:21348
38047 msgid "tb-lsub-flags"
38051 #: guix-git/doc/guix.texi:21352
38052 msgid "Show \\Noselect flags for LSUB replies with LAYOUT=fs (e.g.@: mbox). This makes Thunderbird realize they aren't selectable and show them greyed out, instead of only later giving \"not selectable\" popup error."
38056 #: guix-git/doc/guix.texi:21356
38058 msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host"
38062 #: guix-git/doc/guix.texi:21359
38063 msgid "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to @samp{\"\"}."
38066 #. type: Plain text
38067 #: guix-git/doc/guix.texi:21367
38068 msgid "Whew! Lots of configuration options. The nice thing about it though is that Guix has a complete interface to Dovecot's configuration language. This allows not only a nice way to declare configurations, but also offers reflective capabilities as well: users can write code to inspect and transform configurations from within Scheme."
38071 #. type: Plain text
38072 #: guix-git/doc/guix.texi:21373
38073 msgid "However, it could be that you just want to get a @code{dovecot.conf} up and running. In that case, you can pass an @code{opaque-dovecot-configuration} as the @code{#:config} parameter to @code{dovecot-service}. As its name indicates, an opaque configuration does not have easy reflective capabilities."
38076 #. type: Plain text
38077 #: guix-git/doc/guix.texi:21375
38078 msgid "Available @code{opaque-dovecot-configuration} fields are:"
38082 #: guix-git/doc/guix.texi:21376
38084 msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot"
38088 #: guix-git/doc/guix.texi:21380
38090 msgid "{@code{opaque-dovecot-configuration} parameter} string string"
38094 #: guix-git/doc/guix.texi:21382
38095 msgid "The contents of the @code{dovecot.conf}, as a string."
38098 #. type: Plain text
38099 #: guix-git/doc/guix.texi:21386
38100 msgid "For example, if your @code{dovecot.conf} is just the empty string, you could instantiate a dovecot service like this:"
38104 #: guix-git/doc/guix.texi:21391
38107 "(dovecot-service #:config\n"
38108 " (opaque-dovecot-configuration\n"
38109 " (string \"\")))\n"
38112 #. type: subsubheading
38113 #: guix-git/doc/guix.texi:21393
38115 msgid "OpenSMTPD Service"
38119 #: guix-git/doc/guix.texi:21395
38121 msgid "{Scheme Variable} opensmtpd-service-type"
38125 #: guix-git/doc/guix.texi:21399
38126 msgid "This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} service, whose value should be an @code{opensmtpd-configuration} object as in this example:"
38130 #: guix-git/doc/guix.texi:21404
38133 "(service opensmtpd-service-type\n"
38134 " (opensmtpd-configuration\n"
38135 " (config-file (local-file \"./my-smtpd.conf\"))))\n"
38139 #: guix-git/doc/guix.texi:21407
38141 msgid "{Data Type} opensmtpd-configuration"
38145 #: guix-git/doc/guix.texi:21409
38146 msgid "Data type representing the configuration of opensmtpd."
38150 #: guix-git/doc/guix.texi:21411
38152 msgid "@code{package} (default: @var{opensmtpd})"
38156 #: guix-git/doc/guix.texi:21413
38157 msgid "Package object of the OpenSMTPD SMTP server."
38161 #: guix-git/doc/guix.texi:21414
38163 msgid "@code{config-file} (default: @code{%default-opensmtpd-file})"
38167 #: guix-git/doc/guix.texi:21419
38168 msgid "File-like object of the OpenSMTPD configuration file to use. By default it listens on the loopback network interface, and allows for mail from users and daemons on the local machine, as well as permitting email to remote servers. Run @command{man smtpd.conf} for more information."
38171 #. type: subsubheading
38172 #: guix-git/doc/guix.texi:21423
38174 msgid "Exim Service"
38178 #: guix-git/doc/guix.texi:21425
38180 msgid "mail transfer agent (MTA)"
38184 #: guix-git/doc/guix.texi:21426
38186 msgid "MTA (mail transfer agent)"
38190 #: guix-git/doc/guix.texi:21427
38196 #: guix-git/doc/guix.texi:21429
38198 msgid "{Scheme Variable} exim-service-type"
38202 #: guix-git/doc/guix.texi:21433
38203 msgid "This is the type of the @uref{https://exim.org, Exim} mail transfer agent (MTA), whose value should be an @code{exim-configuration} object as in this example:"
38207 #: guix-git/doc/guix.texi:21438
38210 "(service exim-service-type\n"
38211 " (exim-configuration\n"
38212 " (config-file (local-file \"./my-exim.conf\"))))\n"
38215 #. type: Plain text
38216 #: guix-git/doc/guix.texi:21444
38217 msgid "In order to use an @code{exim-service-type} service you must also have a @code{mail-aliases-service-type} service present in your @code{operating-system} (even if it has no aliases)."
38221 #: guix-git/doc/guix.texi:21445
38223 msgid "{Data Type} exim-configuration"
38227 #: guix-git/doc/guix.texi:21447
38228 msgid "Data type representing the configuration of exim."
38232 #: guix-git/doc/guix.texi:21449
38234 msgid "@code{package} (default: @var{exim})"
38238 #: guix-git/doc/guix.texi:21451
38239 msgid "Package object of the Exim server."
38243 #: guix-git/doc/guix.texi:21458
38244 msgid "File-like object of the Exim configuration file to use. If its value is @code{#f} then use the default configuration file from the package provided in @code{package}. The resulting configuration file is loaded after setting the @code{exim_user} and @code{exim_group} configuration variables."
38247 #. type: subsubheading
38248 #: guix-git/doc/guix.texi:21462
38250 msgid "Getmail service"
38254 #: guix-git/doc/guix.texi:21464
38260 #: guix-git/doc/guix.texi:21465
38266 #: guix-git/doc/guix.texi:21467
38268 msgid "{Scheme Variable} getmail-service-type"
38272 #: guix-git/doc/guix.texi:21470
38273 msgid "This is the type of the @uref{http://pyropus.ca/software/getmail/, Getmail} mail retriever, whose value should be an @code{getmail-configuration}."
38276 #. type: Plain text
38277 #: guix-git/doc/guix.texi:21473
38278 msgid "Available @code{getmail-configuration} fields are:"
38282 #: guix-git/doc/guix.texi:21474
38284 msgid "{@code{getmail-configuration} parameter} symbol name"
38288 #: guix-git/doc/guix.texi:21476
38289 msgid "A symbol to identify the getmail service."
38293 #: guix-git/doc/guix.texi:21478
38294 msgid "Defaults to @samp{\"unset\"}."
38298 #: guix-git/doc/guix.texi:21481
38300 msgid "{@code{getmail-configuration} parameter} package package"
38304 #: guix-git/doc/guix.texi:21483
38305 msgid "The getmail package to use."
38309 #: guix-git/doc/guix.texi:21486
38311 msgid "{@code{getmail-configuration} parameter} string user"
38315 #: guix-git/doc/guix.texi:21488
38316 msgid "The user to run getmail as."
38320 #: guix-git/doc/guix.texi:21490 guix-git/doc/guix.texi:21497
38321 msgid "Defaults to @samp{\"getmail\"}."
38325 #: guix-git/doc/guix.texi:21493
38327 msgid "{@code{getmail-configuration} parameter} string group"
38331 #: guix-git/doc/guix.texi:21495
38332 msgid "The group to run getmail as."
38336 #: guix-git/doc/guix.texi:21500
38338 msgid "{@code{getmail-configuration} parameter} string directory"
38342 #: guix-git/doc/guix.texi:21502
38343 msgid "The getmail directory to use."
38347 #: guix-git/doc/guix.texi:21504
38348 msgid "Defaults to @samp{\"/var/lib/getmail/default\"}."
38352 #: guix-git/doc/guix.texi:21507
38354 msgid "{@code{getmail-configuration} parameter} getmail-configuration-file rcfile"
38358 #: guix-git/doc/guix.texi:21509
38359 msgid "The getmail configuration file to use."
38363 #: guix-git/doc/guix.texi:21511
38364 msgid "Available @code{getmail-configuration-file} fields are:"
38368 #: guix-git/doc/guix.texi:21512
38370 msgid "{@code{getmail-configuration-file} parameter} getmail-retriever-configuration retriever"
38374 #: guix-git/doc/guix.texi:21514
38375 msgid "What mail account to retrieve mail from, and how to access that account."
38379 #: guix-git/doc/guix.texi:21516
38380 msgid "Available @code{getmail-retriever-configuration} fields are:"
38384 #: guix-git/doc/guix.texi:21517
38386 msgid "{@code{getmail-retriever-configuration} parameter} string type"
38390 #: guix-git/doc/guix.texi:21520
38391 msgid "The type of mail retriever to use. Valid values include @samp{passwd} and @samp{static}."
38395 #: guix-git/doc/guix.texi:21522
38396 msgid "Defaults to @samp{\"SimpleIMAPSSLRetriever\"}."
38400 #: guix-git/doc/guix.texi:21525
38402 msgid "{@code{getmail-retriever-configuration} parameter} string server"
38406 #: guix-git/doc/guix.texi:21527 guix-git/doc/guix.texi:21534
38407 msgid "Username to login to the mail server with."
38411 #: guix-git/doc/guix.texi:21529 guix-git/doc/guix.texi:21536
38412 #: guix-git/doc/guix.texi:21600
38413 msgid "Defaults to @samp{unset}."
38417 #: guix-git/doc/guix.texi:21532
38419 msgid "{@code{getmail-retriever-configuration} parameter} string username"
38423 #: guix-git/doc/guix.texi:21539
38425 msgid "{@code{getmail-retriever-configuration} parameter} non-negative-integer port"
38429 #: guix-git/doc/guix.texi:21541
38430 msgid "Port number to connect to."
38434 #: guix-git/doc/guix.texi:21546
38436 msgid "{@code{getmail-retriever-configuration} parameter} string password"
38440 #: guix-git/doc/guix.texi:21548 guix-git/doc/guix.texi:21555
38441 msgid "Override fields from passwd."
38445 #: guix-git/doc/guix.texi:21553
38447 msgid "{@code{getmail-retriever-configuration} parameter} list password-command"
38451 #: guix-git/doc/guix.texi:21560
38453 msgid "{@code{getmail-retriever-configuration} parameter} string keyfile"
38457 #: guix-git/doc/guix.texi:21562
38458 msgid "PEM-formatted key file to use for the TLS negotiation."
38462 #: guix-git/doc/guix.texi:21567
38464 msgid "{@code{getmail-retriever-configuration} parameter} string certfile"
38468 #: guix-git/doc/guix.texi:21569
38469 msgid "PEM-formatted certificate file to use for the TLS negotiation."
38473 #: guix-git/doc/guix.texi:21574
38475 msgid "{@code{getmail-retriever-configuration} parameter} string ca-certs"
38479 #: guix-git/doc/guix.texi:21576
38480 msgid "CA certificates to use."
38484 #: guix-git/doc/guix.texi:21581
38486 msgid "{@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters"
38490 #: guix-git/doc/guix.texi:21583
38491 msgid "Extra retriever parameters."
38495 #: guix-git/doc/guix.texi:21590
38497 msgid "{@code{getmail-configuration-file} parameter} getmail-destination-configuration destination"
38501 #: guix-git/doc/guix.texi:21592
38502 msgid "What to do with retrieved messages."
38506 #: guix-git/doc/guix.texi:21594
38507 msgid "Available @code{getmail-destination-configuration} fields are:"
38511 #: guix-git/doc/guix.texi:21595
38513 msgid "{@code{getmail-destination-configuration} parameter} string type"
38517 #: guix-git/doc/guix.texi:21598
38518 msgid "The type of mail destination. Valid values include @samp{Maildir}, @samp{Mboxrd} and @samp{MDA_external}."
38522 #: guix-git/doc/guix.texi:21603
38524 msgid "{@code{getmail-destination-configuration} parameter} string-or-filelike path"
38528 #: guix-git/doc/guix.texi:21606
38529 msgid "The path option for the mail destination. The behaviour depends on the chosen type."
38533 #: guix-git/doc/guix.texi:21611
38535 msgid "{@code{getmail-destination-configuration} parameter} parameter-alist extra-parameters"
38539 #: guix-git/doc/guix.texi:21613
38540 msgid "Extra destination parameters"
38544 #: guix-git/doc/guix.texi:21620
38546 msgid "{@code{getmail-configuration-file} parameter} getmail-options-configuration options"
38550 #: guix-git/doc/guix.texi:21622
38551 msgid "Configure getmail."
38555 #: guix-git/doc/guix.texi:21624
38556 msgid "Available @code{getmail-options-configuration} fields are:"
38560 #: guix-git/doc/guix.texi:21625
38562 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer verbose"
38566 #: guix-git/doc/guix.texi:21630
38567 msgid "If set to @samp{0}, getmail will only print warnings and errors. A value of @samp{1} means that messages will be printed about retrieving and deleting messages. If set to @samp{2}, getmail will print messages about each of it's actions."
38571 #: guix-git/doc/guix.texi:21632 guix-git/doc/guix.texi:27909
38572 #: guix-git/doc/guix.texi:28497 guix-git/doc/guix.texi:28642
38573 msgid "Defaults to @samp{1}."
38577 #: guix-git/doc/guix.texi:21635
38579 msgid "{@code{getmail-options-configuration} parameter} boolean read-all"
38583 #: guix-git/doc/guix.texi:21638
38584 msgid "If true, getmail will retrieve all available messages. Otherwise it will only retrieve messages it hasn't seen previously."
38588 #: guix-git/doc/guix.texi:21643
38590 msgid "{@code{getmail-options-configuration} parameter} boolean delete"
38594 #: guix-git/doc/guix.texi:21647
38595 msgid "If set to true, messages will be deleted from the server after retrieving and successfully delivering them. Otherwise, messages will be left on the server."
38599 #: guix-git/doc/guix.texi:21652
38601 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-after"
38605 #: guix-git/doc/guix.texi:21657
38606 msgid "Getmail will delete messages this number of days after seeing them, if they have been delivered. This means messages will be left on the server this number of days after delivering them. A value of @samp{0} disabled this feature."
38610 #: guix-git/doc/guix.texi:21662
38612 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-bigger-than"
38616 #: guix-git/doc/guix.texi:21666
38617 msgid "Delete messages larger than this of bytes after retrieving them, even if the delete and delete-after options are disabled. A value of @samp{0} disables this feature."
38621 #: guix-git/doc/guix.texi:21671
38623 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-bytes-per-session"
38627 #: guix-git/doc/guix.texi:21674
38628 msgid "Retrieve messages totalling up to this number of bytes before closing the session with the server. A value of @samp{0} disables this feature."
38632 #: guix-git/doc/guix.texi:21679
38634 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-message-size"
38638 #: guix-git/doc/guix.texi:21682
38639 msgid "Don't retrieve messages larger than this number of bytes. A value of @samp{0} disables this feature."
38643 #: guix-git/doc/guix.texi:21687
38645 msgid "{@code{getmail-options-configuration} parameter} boolean delivered-to"
38649 #: guix-git/doc/guix.texi:21689
38650 msgid "If true, getmail will add a Delivered-To header to messages."
38654 #: guix-git/doc/guix.texi:21694
38656 msgid "{@code{getmail-options-configuration} parameter} boolean received"
38660 #: guix-git/doc/guix.texi:21696
38661 msgid "If set, getmail adds a Received header to the messages."
38665 #: guix-git/doc/guix.texi:21701
38667 msgid "{@code{getmail-options-configuration} parameter} string message-log"
38671 #: guix-git/doc/guix.texi:21704
38672 msgid "Getmail will record a log of its actions to the named file. A value of @samp{\"\"} disables this feature."
38676 #: guix-git/doc/guix.texi:21709
38678 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-syslog"
38682 #: guix-git/doc/guix.texi:21712
38683 msgid "If true, getmail will record a log of its actions using the system logger."
38687 #: guix-git/doc/guix.texi:21717
38689 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-verbose"
38693 #: guix-git/doc/guix.texi:21721
38694 msgid "If true, getmail will log information about messages not retrieved and the reason for not retrieving them, as well as starting and ending information lines."
38698 #: guix-git/doc/guix.texi:21726
38700 msgid "{@code{getmail-options-configuration} parameter} parameter-alist extra-parameters"
38704 #: guix-git/doc/guix.texi:21728
38705 msgid "Extra options to include."
38709 #: guix-git/doc/guix.texi:21737
38711 msgid "{@code{getmail-configuration} parameter} list idle"
38715 #: guix-git/doc/guix.texi:21741
38716 msgid "A list of mailboxes that getmail should wait on the server for new mail notifications. This depends on the server supporting the IDLE extension."
38720 #: guix-git/doc/guix.texi:21746
38722 msgid "{@code{getmail-configuration} parameter} list environment-variables"
38726 #: guix-git/doc/guix.texi:21748
38727 msgid "Environment variables to set for getmail."
38730 #. type: subsubheading
38731 #: guix-git/doc/guix.texi:21753
38733 msgid "Mail Aliases Service"
38737 #: guix-git/doc/guix.texi:21755
38739 msgid "email aliases"
38743 #: guix-git/doc/guix.texi:21756
38745 msgid "aliases, for email addresses"
38749 #: guix-git/doc/guix.texi:21758
38751 msgid "{Scheme Variable} mail-aliases-service-type"
38755 #: guix-git/doc/guix.texi:21761
38756 msgid "This is the type of the service which provides @code{/etc/aliases}, specifying how to deliver mail to users on this system."
38760 #: guix-git/doc/guix.texi:21766
38763 "(service mail-aliases-service-type\n"
38764 " '((\"postmaster\" \"bob\")\n"
38765 " (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n"
38768 #. type: Plain text
38769 #: guix-git/doc/guix.texi:21774
38770 msgid "The configuration for a @code{mail-aliases-service-type} service is an association list denoting how to deliver mail that comes to this system. Each entry is of the form @code{(alias addresses ...)}, with @code{alias} specifying the local alias and @code{addresses} specifying where to deliver this user's mail."
38773 #. type: Plain text
38774 #: guix-git/doc/guix.texi:21780
38775 msgid "The aliases aren't required to exist as users on the local system. In the above example, there doesn't need to be a @code{postmaster} entry in the @code{operating-system}'s @code{user-accounts} in order to deliver the @code{postmaster} mail to @code{bob} (which subsequently would deliver mail to @code{bob@@example.com} and @code{bob@@example2.com})."
38779 #: guix-git/doc/guix.texi:21781 guix-git/doc/guix.texi:21782
38781 msgid "GNU Mailutils IMAP4 Daemon"
38785 #: guix-git/doc/guix.texi:21784
38787 msgid "{Scheme Variable} imap4d-service-type"
38791 #: guix-git/doc/guix.texi:21788
38792 msgid "This is the type of the GNU Mailutils IMAP4 Daemon (@pxref{imap4d,,, mailutils, GNU Mailutils Manual}), whose value should be an @code{imap4d-configuration} object as in this example:"
38796 #: guix-git/doc/guix.texi:21793
38799 "(service imap4d-service-type\n"
38800 " (imap4d-configuration\n"
38801 " (config-file (local-file \"imap4d.conf\"))))\n"
38805 #: guix-git/doc/guix.texi:21796
38807 msgid "{Data Type} imap4d-configuration"
38811 #: guix-git/doc/guix.texi:21798
38812 msgid "Data type representing the configuration of @command{imap4d}."
38816 #: guix-git/doc/guix.texi:21800
38818 msgid "@code{package} (default: @code{mailutils})"
38822 #: guix-git/doc/guix.texi:21802
38823 msgid "The package that provides @command{imap4d}."
38827 #: guix-git/doc/guix.texi:21803
38829 msgid "@code{config-file} (default: @code{%default-imap4d-config-file})"
38833 #: guix-git/doc/guix.texi:21807
38834 msgid "File-like object of the configuration file to use, by default it will listen on TCP port 143 of @code{localhost}. @xref{Conf-imap4d,,, mailutils, GNU Mailutils Manual}, for details."
38837 #. type: subsubheading
38838 #: guix-git/doc/guix.texi:21811
38840 msgid "Radicale Service"
38844 #: guix-git/doc/guix.texi:21812
38850 #: guix-git/doc/guix.texi:21813
38856 #: guix-git/doc/guix.texi:21815
38858 msgid "{Scheme Variable} radicale-service-type"
38862 #: guix-git/doc/guix.texi:21818
38863 msgid "This is the type of the @uref{https://radicale.org, Radicale} CalDAV/CardDAV server whose value should be a @code{radicale-configuration}."
38867 #: guix-git/doc/guix.texi:21820
38869 msgid "{Data Type} radicale-configuration"
38873 #: guix-git/doc/guix.texi:21822
38874 msgid "Data type representing the configuration of @command{radicale}."
38878 #: guix-git/doc/guix.texi:21824
38880 msgid "@code{package} (default: @code{radicale})"
38884 #: guix-git/doc/guix.texi:21826
38885 msgid "The package that provides @command{radicale}."
38889 #: guix-git/doc/guix.texi:21827
38891 msgid "@code{config-file} (default: @code{%default-radicale-config-file})"
38895 #: guix-git/doc/guix.texi:21831
38896 msgid "File-like object of the configuration file to use, by default it will listen on TCP port 5232 of @code{localhost} and use the @code{htpasswd} file at @file{/var/lib/radicale/users} with no (@code{plain}) encryption."
38900 #: guix-git/doc/guix.texi:21838
38906 #: guix-git/doc/guix.texi:21839
38912 #: guix-git/doc/guix.texi:21840
38917 #. type: Plain text
38918 #: guix-git/doc/guix.texi:21844
38919 msgid "The @code{(gnu services messaging)} module provides Guix service definitions for messaging services. Currently it provides the following services:"
38922 #. type: subsubheading
38923 #: guix-git/doc/guix.texi:21845
38925 msgid "Prosody Service"
38929 #: guix-git/doc/guix.texi:21847
38931 msgid "{Scheme Variable} prosody-service-type"
38935 #: guix-git/doc/guix.texi:21851
38936 msgid "This is the type for the @uref{https://prosody.im, Prosody XMPP communication server}. Its value must be a @code{prosody-configuration} record as in this example:"
38940 #: guix-git/doc/guix.texi:21866
38943 "(service prosody-service-type\n"
38944 " (prosody-configuration\n"
38945 " (modules-enabled (cons* \"groups\" \"mam\" %default-modules-enabled))\n"
38946 " (int-components\n"
38948 " (int-component-configuration\n"
38949 " (hostname \"conference.example.net\")\n"
38950 " (plugin \"muc\")\n"
38951 " (mod-muc (mod-muc-configuration)))))\n"
38954 " (virtualhost-configuration\n"
38955 " (domain \"example.net\"))))))\n"
38959 #: guix-git/doc/guix.texi:21869
38960 msgid "See below for details about @code{prosody-configuration}."
38963 #. type: Plain text
38964 #: guix-git/doc/guix.texi:21875
38965 msgid "By default, Prosody does not need much configuration. Only one @code{virtualhosts} field is needed: it specifies the domain you wish Prosody to serve."
38968 #. type: Plain text
38969 #: guix-git/doc/guix.texi:21878
38970 msgid "You can perform various sanity checks on the generated configuration with the @code{prosodyctl check} command."
38973 #. type: Plain text
38974 #: guix-git/doc/guix.texi:21882
38975 msgid "Prosodyctl will also help you to import certificates from the @code{letsencrypt} directory so that the @code{prosody} user can access them. See @url{https://prosody.im/doc/letsencrypt}."
38979 #: guix-git/doc/guix.texi:21885
38981 msgid "prosodyctl --root cert import /etc/letsencrypt/live\n"
38984 #. type: Plain text
38985 #: guix-git/doc/guix.texi:21892
38986 msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. Types starting with @code{maybe-} denote parameters that won't show up in @code{prosody.cfg.lua} when their value is @code{'disabled}."
38989 #. type: Plain text
38990 #: guix-git/doc/guix.texi:21896
38991 msgid "There is also a way to specify the configuration as a string, if you have an old @code{prosody.cfg.lua} file that you want to port over from some other system; see the end for more details."
38994 #. type: Plain text
38995 #: guix-git/doc/guix.texi:21899
38996 msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a file name."
38999 #. type: Plain text
39000 #: guix-git/doc/guix.texi:21909
39001 msgid "Available @code{prosody-configuration} fields are:"
39005 #: guix-git/doc/guix.texi:21910
39007 msgid "{@code{prosody-configuration} parameter} package prosody"
39011 #: guix-git/doc/guix.texi:21912
39012 msgid "The Prosody package."
39016 #: guix-git/doc/guix.texi:21914
39018 msgid "{@code{prosody-configuration} parameter} file-name data-path"
39022 #: guix-git/doc/guix.texi:21918
39023 msgid "Location of the Prosody data storage directory. See @url{https://prosody.im/doc/configure}. Defaults to @samp{\"/var/lib/prosody\"}."
39027 #: guix-git/doc/guix.texi:21920
39029 msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths"
39033 #: guix-git/doc/guix.texi:21924
39034 msgid "Additional plugin directories. They are searched in all the specified paths in order. See @url{https://prosody.im/doc/plugins_directory}. Defaults to @samp{()}."
39038 #: guix-git/doc/guix.texi:21926
39040 msgid "{@code{prosody-configuration} parameter} file-name certificates"
39044 #: guix-git/doc/guix.texi:21931
39045 msgid "Every virtual host and component needs a certificate so that clients and servers can securely verify its identity. Prosody will automatically load certificates/keys from the directory specified here. Defaults to @samp{\"/etc/prosody/certs\"}."
39049 #: guix-git/doc/guix.texi:21933
39051 msgid "{@code{prosody-configuration} parameter} string-list admins"
39055 #: guix-git/doc/guix.texi:21939
39056 msgid "This is a list of accounts that are admins for the server. Note that you must create the accounts separately. See @url{https://prosody.im/doc/admins} and @url{https://prosody.im/doc/creating_accounts}. Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))} Defaults to @samp{()}."
39060 #: guix-git/doc/guix.texi:21941
39062 msgid "{@code{prosody-configuration} parameter} boolean use-libevent?"
39066 #: guix-git/doc/guix.texi:21945
39067 msgid "Enable use of libevent for better performance under high load. See @url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}."
39071 #: guix-git/doc/guix.texi:21947
39073 msgid "{@code{prosody-configuration} parameter} module-list modules-enabled"
39077 #: guix-git/doc/guix.texi:21953
39078 msgid "This is the list of modules Prosody will load on startup. It looks for @code{mod_modulename.lua} in the plugins folder, so make sure that exists too. Documentation on modules can be found at: @url{https://prosody.im/doc/modules}. Defaults to @samp{(\"roster\" \"saslauth\" \"tls\" \"dialback\" \"disco\" \"carbons\" \"private\" \"blocklist\" \"vcard\" \"version\" \"uptime\" \"time\" \"ping\" \"pep\" \"register\" \"admin_adhoc\")}."
39082 #: guix-git/doc/guix.texi:21955
39084 msgid "{@code{prosody-configuration} parameter} string-list modules-disabled"
39088 #: guix-git/doc/guix.texi:21959
39089 msgid "@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but should you want to disable them then add them to this list. Defaults to @samp{()}."
39093 #: guix-git/doc/guix.texi:21961
39095 msgid "{@code{prosody-configuration} parameter} file-object groups-file"
39099 #: guix-git/doc/guix.texi:21966
39100 msgid "Path to a text file where the shared groups are defined. If this path is empty then @samp{mod_groups} does nothing. See @url{https://prosody.im/doc/modules/mod_groups}. Defaults to @samp{\"/var/lib/prosody/sharedgroups.txt\"}."
39104 #: guix-git/doc/guix.texi:21968
39106 msgid "{@code{prosody-configuration} parameter} boolean allow-registration?"
39110 #: guix-git/doc/guix.texi:21972
39111 msgid "Disable account creation by default, for security. See @url{https://prosody.im/doc/creating_accounts}. Defaults to @samp{#f}."
39115 #: guix-git/doc/guix.texi:21974
39117 msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl"
39121 #: guix-git/doc/guix.texi:21979
39122 msgid "These are the SSL/TLS-related settings. Most of them are disabled so to use Prosody's defaults. If you do not completely understand these options, do not add them to your config, it is easy to lower the security of your server using them. See @url{https://prosody.im/doc/advanced_ssl_config}."
39126 #: guix-git/doc/guix.texi:21981
39127 msgid "Available @code{ssl-configuration} fields are:"
39131 #: guix-git/doc/guix.texi:21982
39133 msgid "{@code{ssl-configuration} parameter} maybe-string protocol"
39137 #: guix-git/doc/guix.texi:21984
39138 msgid "This determines what handshake to use."
39142 #: guix-git/doc/guix.texi:21986
39144 msgid "{@code{ssl-configuration} parameter} maybe-file-name key"
39148 #: guix-git/doc/guix.texi:21988
39149 msgid "Path to your private key file."
39153 #: guix-git/doc/guix.texi:21990
39155 msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate"
39159 #: guix-git/doc/guix.texi:21992
39160 msgid "Path to your certificate file."
39164 #: guix-git/doc/guix.texi:21994
39166 msgid "{@code{ssl-configuration} parameter} file-object capath"
39170 #: guix-git/doc/guix.texi:21998
39171 msgid "Path to directory containing root certificates that you wish Prosody to trust when verifying the certificates of remote servers. Defaults to @samp{\"/etc/ssl/certs\"}."
39175 #: guix-git/doc/guix.texi:22000
39177 msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile"
39181 #: guix-git/doc/guix.texi:22003
39182 msgid "Path to a file containing root certificates that you wish Prosody to trust. Similar to @code{capath} but with all certificates concatenated together."
39186 #: guix-git/doc/guix.texi:22005
39188 msgid "{@code{ssl-configuration} parameter} maybe-string-list verify"
39192 #: guix-git/doc/guix.texi:22008
39193 msgid "A list of verification options (these mostly map to OpenSSL's @code{set_verify()} flags)."
39197 #: guix-git/doc/guix.texi:22010
39199 msgid "{@code{ssl-configuration} parameter} maybe-string-list options"
39203 #: guix-git/doc/guix.texi:22014
39204 msgid "A list of general options relating to SSL/TLS@. These map to OpenSSL's @code{set_options()}. For a full list of options available in LuaSec, see the LuaSec source."
39208 #: guix-git/doc/guix.texi:22016
39210 msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth"
39214 #: guix-git/doc/guix.texi:22019
39215 msgid "How long a chain of certificate authorities to check when looking for a trusted root certificate."
39219 #: guix-git/doc/guix.texi:22021
39221 msgid "{@code{ssl-configuration} parameter} maybe-string ciphers"
39225 #: guix-git/doc/guix.texi:22024
39226 msgid "An OpenSSL cipher string. This selects what ciphers Prosody will offer to clients, and in what order."
39230 #: guix-git/doc/guix.texi:22026
39232 msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam"
39236 #: guix-git/doc/guix.texi:22030
39237 msgid "A path to a file containing parameters for Diffie-Hellman key exchange. You can create such a file with: @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}"
39241 #: guix-git/doc/guix.texi:22032
39243 msgid "{@code{ssl-configuration} parameter} maybe-string curve"
39247 #: guix-git/doc/guix.texi:22035
39248 msgid "Curve for Elliptic curve Diffie-Hellman. Prosody's default is @samp{\"secp384r1\"}."
39252 #: guix-git/doc/guix.texi:22037
39254 msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext"
39258 #: guix-git/doc/guix.texi:22039
39259 msgid "A list of ``extra'' verification options."
39263 #: guix-git/doc/guix.texi:22041
39265 msgid "{@code{ssl-configuration} parameter} maybe-string password"
39269 #: guix-git/doc/guix.texi:22043
39270 msgid "Password for encrypted private keys."
39274 #: guix-git/doc/guix.texi:22047
39276 msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?"
39280 #: guix-git/doc/guix.texi:22051
39281 msgid "Whether to force all client-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
39285 #: guix-git/doc/guix.texi:22053
39287 msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms"
39291 #: guix-git/doc/guix.texi:22057
39292 msgid "Set of mechanisms that will never be offered. See @url{https://prosody.im/doc/modules/mod_saslauth}. Defaults to @samp{(\"DIGEST-MD5\")}."
39296 #: guix-git/doc/guix.texi:22059
39298 msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?"
39302 #: guix-git/doc/guix.texi:22063
39303 msgid "Whether to force all server-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}."
39307 #: guix-git/doc/guix.texi:22065
39309 msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?"
39313 #: guix-git/doc/guix.texi:22071
39314 msgid "Whether to require encryption and certificate authentication. This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{#f}."
39318 #: guix-git/doc/guix.texi:22073
39320 msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains"
39324 #: guix-git/doc/guix.texi:22079
39325 msgid "Many servers don't support encryption or have invalid or self-signed certificates. You can list domains here that will not be required to authenticate using certificates. They will be authenticated using DNS@. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
39329 #: guix-git/doc/guix.texi:22081
39331 msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains"
39335 #: guix-git/doc/guix.texi:22086
39336 msgid "Even if you leave @code{s2s-secure-auth?} disabled, you can still require valid certificates for some domains by specifying a list here. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}."
39340 #: guix-git/doc/guix.texi:22088
39342 msgid "{@code{prosody-configuration} parameter} string authentication"
39346 #: guix-git/doc/guix.texi:22096
39347 msgid "Select the authentication backend to use. The default provider stores passwords in plaintext and uses Prosody's configured data storage to store the authentication data. If you do not trust your server please see @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information about using the hashed backend. See also @url{https://prosody.im/doc/authentication} Defaults to @samp{\"internal_plain\"}."
39351 #: guix-git/doc/guix.texi:22098
39353 msgid "{@code{prosody-configuration} parameter} maybe-string log"
39357 #: guix-git/doc/guix.texi:22102
39358 msgid "Set logging options. Advanced logging configuration is not yet supported by the Prosody service. See @url{https://prosody.im/doc/logging}. Defaults to @samp{\"*syslog\"}."
39362 #: guix-git/doc/guix.texi:22104
39364 msgid "{@code{prosody-configuration} parameter} file-name pidfile"
39368 #: guix-git/doc/guix.texi:22107
39369 msgid "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. Defaults to @samp{\"/var/run/prosody/prosody.pid\"}."
39373 #: guix-git/doc/guix.texi:22109
39375 msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size"
39379 #: guix-git/doc/guix.texi:22111
39380 msgid "Maximum allowed size of the HTTP body (in bytes)."
39384 #: guix-git/doc/guix.texi:22113
39386 msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url"
39390 #: guix-git/doc/guix.texi:22118
39391 msgid "Some modules expose their own URL in various ways. This URL is built from the protocol, host and port used. If Prosody sits behind a proxy, the public URL will be @code{http-external-url} instead. See @url{https://prosody.im/doc/http#external_url}."
39395 #: guix-git/doc/guix.texi:22120
39397 msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts"
39401 #: guix-git/doc/guix.texi:22125
39402 msgid "A host in Prosody is a domain on which user accounts can be created. For example if you want your users to have addresses like @samp{\"john.smith@@example.com\"} then you need to add a host @samp{\"example.com\"}. All options in this list will apply only to this host."
39406 #: guix-git/doc/guix.texi:22131
39407 msgid "Note: the name @emph{virtual} host is used in configuration to avoid confusion with the actual physical host that Prosody is installed on. A single Prosody instance can serve many domains, each one defined as a VirtualHost entry in Prosody's configuration. Conversely a server that hosts a single domain would have just one VirtualHost entry."
39411 #: guix-git/doc/guix.texi:22133
39412 msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}."
39416 #: guix-git/doc/guix.texi:22135
39417 msgid "Available @code{virtualhost-configuration} fields are:"
39421 #: guix-git/doc/guix.texi:22137 guix-git/doc/guix.texi:22159
39422 #: guix-git/doc/guix.texi:22212
39423 msgid "all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, @code{http-max-content-size}, @code{http-external-url}, @code{raw-content}, plus:"
39427 #: guix-git/doc/guix.texi:22137
39429 msgid "{@code{virtualhost-configuration} parameter} string domain"
39433 #: guix-git/doc/guix.texi:22139
39434 msgid "Domain you wish Prosody to serve."
39438 #: guix-git/doc/guix.texi:22143
39440 msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components"
39444 #: guix-git/doc/guix.texi:22148
39445 msgid "Components are extra services on a server which are available to clients, usually on a subdomain of the main server (such as @samp{\"mycomponent.example.com\"}). Example components might be chatroom servers, user directories, or gateways to other protocols."
39449 #: guix-git/doc/guix.texi:22152
39450 msgid "Internal components are implemented with Prosody-specific plugins. To add an internal component, you simply fill the hostname field, and the plugin you wish to use for the component."
39454 #: guix-git/doc/guix.texi:22155
39455 msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
39459 #: guix-git/doc/guix.texi:22157
39460 msgid "Available @code{int-component-configuration} fields are:"
39464 #: guix-git/doc/guix.texi:22159
39466 msgid "{@code{int-component-configuration} parameter} string hostname"
39470 #: guix-git/doc/guix.texi:22161 guix-git/doc/guix.texi:22218
39471 msgid "Hostname of the component."
39475 #: guix-git/doc/guix.texi:22163
39477 msgid "{@code{int-component-configuration} parameter} string plugin"
39481 #: guix-git/doc/guix.texi:22165
39482 msgid "Plugin you wish to use for the component."
39486 #: guix-git/doc/guix.texi:22167
39488 msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc"
39492 #: guix-git/doc/guix.texi:22170
39493 msgid "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users."
39497 #: guix-git/doc/guix.texi:22174
39498 msgid "General information on setting up and using multi-user chatrooms can be found in the ``Chatrooms'' documentation (@url{https://prosody.im/doc/chatrooms}), which you should read if you are new to XMPP chatrooms."
39502 #: guix-git/doc/guix.texi:22176
39503 msgid "See also @url{https://prosody.im/doc/modules/mod_muc}."
39507 #: guix-git/doc/guix.texi:22178
39508 msgid "Available @code{mod-muc-configuration} fields are:"
39512 #: guix-git/doc/guix.texi:22179
39514 msgid "{@code{mod-muc-configuration} parameter} string name"
39518 #: guix-git/doc/guix.texi:22182
39519 msgid "The name to return in service discovery responses. Defaults to @samp{\"Prosody Chatrooms\"}."
39523 #: guix-git/doc/guix.texi:22184
39525 msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation"
39529 #: guix-git/doc/guix.texi:22191
39530 msgid "If @samp{#t}, this will only allow admins to create new chatrooms. Otherwise anyone can create a room. The value @samp{\"local\"} restricts room creation to users on the service's parent domain. E.g.@: @samp{user@@example.com} can create rooms on @samp{rooms.example.com}. The value @samp{\"admin\"} restricts to service administrators only. Defaults to @samp{#f}."
39534 #: guix-git/doc/guix.texi:22193
39536 msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages"
39540 #: guix-git/doc/guix.texi:22197
39541 msgid "Maximum number of history messages that will be sent to the member that has just joined the room. Defaults to @samp{20}."
39545 #: guix-git/doc/guix.texi:22203
39547 msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components"
39551 #: guix-git/doc/guix.texi:22208
39552 msgid "External components use XEP-0114, which most standalone components support. To add an external component, you simply fill the hostname field. See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
39556 #: guix-git/doc/guix.texi:22210
39557 msgid "Available @code{ext-component-configuration} fields are:"
39561 #: guix-git/doc/guix.texi:22212
39563 msgid "{@code{ext-component-configuration} parameter} string component-secret"
39567 #: guix-git/doc/guix.texi:22214
39568 msgid "Password which the component will use to log in."
39572 #: guix-git/doc/guix.texi:22216
39574 msgid "{@code{ext-component-configuration} parameter} string hostname"
39578 #: guix-git/doc/guix.texi:22222
39580 msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports"
39584 #: guix-git/doc/guix.texi:22225
39585 msgid "Port(s) Prosody listens on for component connections. Defaults to @samp{(5347)}."
39589 #: guix-git/doc/guix.texi:22227
39591 msgid "{@code{prosody-configuration} parameter} string component-interface"
39595 #: guix-git/doc/guix.texi:22230
39596 msgid "Interface Prosody listens on for component connections. Defaults to @samp{\"127.0.0.1\"}."
39600 #: guix-git/doc/guix.texi:22232
39602 msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content"
39606 #: guix-git/doc/guix.texi:22234
39607 msgid "Raw content that will be added to the configuration file."
39610 #. type: Plain text
39611 #: guix-git/doc/guix.texi:22242
39612 msgid "It could be that you just want to get a @code{prosody.cfg.lua} up and running. In that case, you can pass an @code{opaque-prosody-configuration} record as the value of @code{prosody-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities. Available @code{opaque-prosody-configuration} fields are:"
39616 #: guix-git/doc/guix.texi:22243
39618 msgid "{@code{opaque-prosody-configuration} parameter} package prosody"
39622 #: guix-git/doc/guix.texi:22245
39623 msgid "The prosody package."
39627 #: guix-git/doc/guix.texi:22247
39629 msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua"
39633 #: guix-git/doc/guix.texi:22249
39634 msgid "The contents of the @code{prosody.cfg.lua} to use."
39637 #. type: Plain text
39638 #: guix-git/doc/guix.texi:22253
39639 msgid "For example, if your @code{prosody.cfg.lua} is just the empty string, you could instantiate a prosody service like this:"
39643 #: guix-git/doc/guix.texi:22258
39646 "(service prosody-service-type\n"
39647 " (opaque-prosody-configuration\n"
39648 " (prosody.cfg.lua \"\")))\n"
39651 #. type: subsubheading
39652 #: guix-git/doc/guix.texi:22262
39654 msgid "BitlBee Service"
39658 #: guix-git/doc/guix.texi:22264 guix-git/doc/guix.texi:22308
39660 msgid "IRC (Internet Relay Chat)"
39664 #: guix-git/doc/guix.texi:22265
39666 msgid "IRC gateway"
39669 #. type: Plain text
39670 #: guix-git/doc/guix.texi:22268
39671 msgid "@url{https://bitlbee.org,BitlBee} is a gateway that provides an IRC interface to a variety of messaging protocols such as XMPP."
39675 #: guix-git/doc/guix.texi:22269
39677 msgid "{Scheme Variable} bitlbee-service-type"
39681 #: guix-git/doc/guix.texi:22273
39682 msgid "This is the service type for the @url{https://bitlbee.org,BitlBee} IRC gateway daemon. Its value is a @code{bitlbee-configuration} (see below)."
39686 #: guix-git/doc/guix.texi:22276
39687 msgid "To have BitlBee listen on port 6667 on localhost, add this line to your services:"
39691 #: guix-git/doc/guix.texi:22279
39693 msgid "(service bitlbee-service-type)\n"
39697 #: guix-git/doc/guix.texi:22282
39699 msgid "{Data Type} bitlbee-configuration"
39703 #: guix-git/doc/guix.texi:22284
39704 msgid "This is the configuration for BitlBee, with the following fields:"
39708 #: guix-git/doc/guix.texi:22286
39710 msgid "@code{interface} (default: @code{\"127.0.0.1\"})"
39714 #: guix-git/doc/guix.texi:22287
39716 msgid "@code{port} (default: @code{6667})"
39720 #: guix-git/doc/guix.texi:22290
39721 msgid "Listen on the network interface corresponding to the IP address specified in @var{interface}, on @var{port}."
39725 #: guix-git/doc/guix.texi:22294
39726 msgid "When @var{interface} is @code{127.0.0.1}, only local clients can connect; when it is @code{0.0.0.0}, connections can come from any networking interface."
39730 #: guix-git/doc/guix.texi:22295
39732 msgid "@code{bitlbee} (default: @code{bitlbee})"
39736 #: guix-git/doc/guix.texi:22297
39737 msgid "The BitlBee package to use."
39741 #: guix-git/doc/guix.texi:22298
39743 msgid "@code{plugins} (default: @code{'()})"
39747 #: guix-git/doc/guix.texi:22300
39748 msgid "List of plugin packages to use---e.g., @code{bitlbee-discord}."
39752 #: guix-git/doc/guix.texi:22303
39753 msgid "Configuration snippet added as-is to the BitlBee configuration file."
39756 #. type: subsubheading
39757 #: guix-git/doc/guix.texi:22306
39759 msgid "Quassel Service"
39762 #. type: Plain text
39763 #: guix-git/doc/guix.texi:22312
39764 msgid "@url{https://quassel-irc.org/,Quassel} is a distributed IRC client, meaning that one or more clients can attach to and detach from the central core."
39768 #: guix-git/doc/guix.texi:22313
39770 msgid "{Scheme Variable} quassel-service-type"
39774 #: guix-git/doc/guix.texi:22317
39775 msgid "This is the service type for the @url{https://quassel-irc.org/,Quassel} IRC backend daemon. Its value is a @code{quassel-configuration} (see below)."
39779 #: guix-git/doc/guix.texi:22319
39781 msgid "{Data Type} quassel-configuration"
39785 #: guix-git/doc/guix.texi:22321
39786 msgid "This is the configuration for Quassel, with the following fields:"
39790 #: guix-git/doc/guix.texi:22323
39792 msgid "@code{quassel} (default: @code{quassel})"
39796 #: guix-git/doc/guix.texi:22325
39797 msgid "The Quassel package to use."
39801 #: guix-git/doc/guix.texi:22326
39803 msgid "@code{interface} (default: @code{\"::,0.0.0.0\"})"
39807 #: guix-git/doc/guix.texi:22327
39809 msgid "@code{port} (default: @code{4242})"
39813 #: guix-git/doc/guix.texi:22331
39814 msgid "Listen on the network interface(s) corresponding to the IPv4 or IPv6 interfaces specified in the comma delimited @var{interface}, on @var{port}."
39818 #: guix-git/doc/guix.texi:22332
39820 msgid "@code{loglevel} (default: @code{\"Info\"})"
39824 #: guix-git/doc/guix.texi:22335
39825 msgid "The level of logging desired. Accepted values are Debug, Info, Warning and Error."
39829 #: guix-git/doc/guix.texi:22341
39831 msgid "Murmur (VoIP server)"
39835 #: guix-git/doc/guix.texi:22342
39837 msgid "VoIP server"
39840 #. type: Plain text
39841 #: guix-git/doc/guix.texi:22346
39842 msgid "This section describes how to set up and run a Murmur server. Murmur is the server of the @uref{https://mumble.info, Mumble} voice-over-IP (VoIP) suite."
39846 #: guix-git/doc/guix.texi:22347
39848 msgid "{Data Type} murmur-configuration"
39852 #: guix-git/doc/guix.texi:22350
39853 msgid "The service type for the Murmur server. An example configuration can look like this:"
39857 #: guix-git/doc/guix.texi:22359
39860 "(service murmur-service-type\n"
39861 " (murmur-configuration\n"
39863 " \"Welcome to this Mumble server running on Guix!\")\n"
39864 " (cert-required? #t) ;disallow text password logins\n"
39865 " (ssl-cert \"/etc/letsencrypt/live/mumble.example.com/fullchain.pem\")\n"
39866 " (ssl-key \"/etc/letsencrypt/live/mumble.example.com/privkey.pem\")))\n"
39870 #: guix-git/doc/guix.texi:22363
39871 msgid "After reconfiguring your system, you can manually set the murmur @code{SuperUser} password with the command that is printed during the activation phase."
39875 #: guix-git/doc/guix.texi:22372
39876 msgid "It is recommended to register a normal Mumble user account and grant it admin or moderator rights. You can use the @code{mumble} client to login as new normal user, register yourself, and log out. For the next step login with the name @code{SuperUser} use the @code{SuperUser} password that you set previously, and grant your newly registered mumble user administrator or moderator rights and create some channels."
39880 #: guix-git/doc/guix.texi:22374
39881 msgid "Available @code{murmur-configuration} fields are:"
39885 #: guix-git/doc/guix.texi:22376
39887 msgid "@code{package} (default: @code{mumble})"
39891 #: guix-git/doc/guix.texi:22378
39892 msgid "Package that contains @code{bin/murmurd}."
39896 #: guix-git/doc/guix.texi:22379
39898 msgid "@code{user} (default: @code{\"murmur\"})"
39902 #: guix-git/doc/guix.texi:22381
39903 msgid "User who will run the Murmur server."
39907 #: guix-git/doc/guix.texi:22382
39909 msgid "@code{group} (default: @code{\"murmur\"})"
39913 #: guix-git/doc/guix.texi:22384
39914 msgid "Group of the user who will run the murmur server."
39918 #: guix-git/doc/guix.texi:22385
39920 msgid "@code{port} (default: @code{64738})"
39924 #: guix-git/doc/guix.texi:22387
39925 msgid "Port on which the server will listen."
39929 #: guix-git/doc/guix.texi:22388
39931 msgid "@code{welcome-text} (default: @code{\"\"})"
39935 #: guix-git/doc/guix.texi:22390
39936 msgid "Welcome text sent to clients when they connect."
39940 #: guix-git/doc/guix.texi:22391
39942 msgid "@code{server-password} (default: @code{\"\"})"
39946 #: guix-git/doc/guix.texi:22393
39947 msgid "Password the clients have to enter in order to connect."
39951 #: guix-git/doc/guix.texi:22394
39953 msgid "@code{max-users} (default: @code{100})"
39957 #: guix-git/doc/guix.texi:22396
39958 msgid "Maximum of users that can be connected to the server at once."
39962 #: guix-git/doc/guix.texi:22397
39964 msgid "@code{max-user-bandwidth} (default: @code{#f})"
39968 #: guix-git/doc/guix.texi:22399
39969 msgid "Maximum voice traffic a user can send per second."
39973 #: guix-git/doc/guix.texi:22400
39975 msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})"
39979 #: guix-git/doc/guix.texi:22403
39980 msgid "File name of the sqlite database. The service's user will become the owner of the directory."
39984 #: guix-git/doc/guix.texi:22404
39986 msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})"
39990 #: guix-git/doc/guix.texi:22407
39991 msgid "File name of the log file. The service's user will become the owner of the directory."
39995 #: guix-git/doc/guix.texi:22408
39997 msgid "@code{autoban-attempts} (default: @code{10})"
40001 #: guix-git/doc/guix.texi:22411
40002 msgid "Maximum number of logins a user can make in @code{autoban-timeframe} without getting auto banned for @code{autoban-time}."
40006 #: guix-git/doc/guix.texi:22412
40008 msgid "@code{autoban-timeframe} (default: @code{120})"
40012 #: guix-git/doc/guix.texi:22414
40013 msgid "Timeframe for autoban in seconds."
40017 #: guix-git/doc/guix.texi:22415
40019 msgid "@code{autoban-time} (default: @code{300})"
40023 #: guix-git/doc/guix.texi:22418
40024 msgid "Amount of time in seconds for which a client gets banned when violating the autoban limits."
40028 #: guix-git/doc/guix.texi:22419
40030 msgid "@code{opus-threshold} (default: @code{100})"
40034 #: guix-git/doc/guix.texi:22422
40035 msgid "Percentage of clients that need to support opus before switching over to opus audio codec."
40039 #: guix-git/doc/guix.texi:22423
40041 msgid "@code{channel-nesting-limit} (default: @code{10})"
40045 #: guix-git/doc/guix.texi:22425
40046 msgid "How deep channels can be nested at maximum."
40050 #: guix-git/doc/guix.texi:22426
40052 msgid "@code{channelname-regex} (default: @code{#f})"
40056 #: guix-git/doc/guix.texi:22428
40057 msgid "A string in form of a Qt regular expression that channel names must conform to."
40061 #: guix-git/doc/guix.texi:22429
40063 msgid "@code{username-regex} (default: @code{#f})"
40067 #: guix-git/doc/guix.texi:22431
40068 msgid "A string in form of a Qt regular expression that user names must conform to."
40072 #: guix-git/doc/guix.texi:22432
40074 msgid "@code{text-message-length} (default: @code{5000})"
40078 #: guix-git/doc/guix.texi:22434
40079 msgid "Maximum size in bytes that a user can send in one text chat message."
40083 #: guix-git/doc/guix.texi:22435
40085 msgid "@code{image-message-length} (default: @code{(* 128 1024)})"
40089 #: guix-git/doc/guix.texi:22437
40090 msgid "Maximum size in bytes that a user can send in one image message."
40094 #: guix-git/doc/guix.texi:22438
40096 msgid "@code{cert-required?} (default: @code{#f})"
40100 #: guix-git/doc/guix.texi:22441
40101 msgid "If it is set to @code{#t} clients that use weak password authentication will not be accepted. Users must have completed the certificate wizard to join."
40105 #: guix-git/doc/guix.texi:22442
40107 msgid "@code{remember-channel?} (default: @code{#f})"
40111 #: guix-git/doc/guix.texi:22445
40112 msgid "Should murmur remember the last channel each user was in when they disconnected and put them into the remembered channel when they rejoin."
40116 #: guix-git/doc/guix.texi:22446
40118 msgid "@code{allow-html?} (default: @code{#f})"
40122 #: guix-git/doc/guix.texi:22448
40123 msgid "Should html be allowed in text messages, user comments, and channel descriptions."
40127 #: guix-git/doc/guix.texi:22449
40129 msgid "@code{allow-ping?} (default: @code{#f})"
40133 #: guix-git/doc/guix.texi:22453
40134 msgid "Setting to true exposes the current user count, the maximum user count, and the server's maximum bandwidth per client to unauthenticated users. In the Mumble client, this information is shown in the Connect dialog."
40138 #: guix-git/doc/guix.texi:22455
40139 msgid "Disabling this setting will prevent public listing of the server."
40143 #: guix-git/doc/guix.texi:22456
40145 msgid "@code{bonjour?} (default: @code{#f})"
40149 #: guix-git/doc/guix.texi:22458
40150 msgid "Should the server advertise itself in the local network through the bonjour protocol."
40154 #: guix-git/doc/guix.texi:22459
40156 msgid "@code{send-version?} (default: @code{#f})"
40160 #: guix-git/doc/guix.texi:22461
40161 msgid "Should the murmur server version be exposed in ping requests."
40165 #: guix-git/doc/guix.texi:22462
40167 msgid "@code{log-days} (default: @code{31})"
40171 #: guix-git/doc/guix.texi:22466
40172 msgid "Murmur also stores logs in the database, which are accessible via RPC. The default is 31 days of months, but you can set this setting to 0 to keep logs forever, or -1 to disable logging to the database."
40176 #: guix-git/doc/guix.texi:22467
40178 msgid "@code{obfuscate-ips?} (default: @code{#t})"
40182 #: guix-git/doc/guix.texi:22469
40183 msgid "Should logged ips be obfuscated to protect the privacy of users."
40187 #: guix-git/doc/guix.texi:22470
40189 msgid "@code{ssl-cert} (default: @code{#f})"
40193 #: guix-git/doc/guix.texi:22472
40194 msgid "File name of the SSL/TLS certificate used for encrypted connections."
40198 #: guix-git/doc/guix.texi:22475
40200 msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n"
40204 #: guix-git/doc/guix.texi:22476
40206 msgid "@code{ssl-key} (default: @code{#f})"
40210 #: guix-git/doc/guix.texi:22478
40211 msgid "Filepath to the ssl private key used for encrypted connections."
40215 #: guix-git/doc/guix.texi:22480
40217 msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n"
40221 #: guix-git/doc/guix.texi:22482
40223 msgid "@code{ssl-dh-params} (default: @code{#f})"
40227 #: guix-git/doc/guix.texi:22487
40228 msgid "File name of a PEM-encoded file with Diffie-Hellman parameters for the SSL/TLS encryption. Alternatively you set it to @code{\"@@ffdhe2048\"}, @code{\"@@ffdhe3072\"}, @code{\"@@ffdhe4096\"}, @code{\"@@ffdhe6144\"} or @code{\"@@ffdhe8192\"} to use bundled parameters from RFC 7919."
40232 #: guix-git/doc/guix.texi:22488
40234 msgid "@code{ssl-ciphers} (default: @code{#f})"
40238 #: guix-git/doc/guix.texi:22491
40239 msgid "The @code{ssl-ciphers} option chooses the cipher suites to make available for use in SSL/TLS."
40243 #: guix-git/doc/guix.texi:22495
40244 msgid "This option is specified using @uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}."
40248 #: guix-git/doc/guix.texi:22500
40249 msgid "It is recommended that you try your cipher string using 'openssl ciphers <string>' before setting it here, to get a feel for which cipher suites you will get. After setting this option, it is recommend that you inspect your Murmur log to ensure that Murmur is using the cipher suites that you expected it to."
40253 #: guix-git/doc/guix.texi:22504
40254 msgid "Note: Changing this option may impact the backwards compatibility of your Murmur server, and can remove the ability for older Mumble clients to be able to connect to it."
40258 #: guix-git/doc/guix.texi:22505
40260 msgid "@code{public-registration} (default: @code{#f})"
40264 #: guix-git/doc/guix.texi:22507
40265 msgid "Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}."
40269 #: guix-git/doc/guix.texi:22512
40270 msgid "You can optionally register your server in the public server list that the @code{mumble} client shows on startup. You cannot register your server if you have set a @code{server-password}, or set @code{allow-ping} to @code{#f}."
40274 #: guix-git/doc/guix.texi:22514
40275 msgid "It might take a few hours until it shows up in the public list."
40279 #: guix-git/doc/guix.texi:22515 guix-git/doc/guix.texi:24751
40281 msgid "@code{file} (default: @code{#f})"
40285 #: guix-git/doc/guix.texi:22517
40286 msgid "Optional alternative override for this configuration."
40290 #: guix-git/doc/guix.texi:22520
40292 msgid "{Data Type} murmur-public-registration-configuration"
40296 #: guix-git/doc/guix.texi:22522
40297 msgid "Configuration for public registration of a murmur service."
40301 #: guix-git/doc/guix.texi:22526
40302 msgid "This is a display name for your server. Not to be confused with the hostname."
40306 #: guix-git/doc/guix.texi:22527 guix-git/doc/guix.texi:31202
40307 #: guix-git/doc/guix.texi:32243
40313 #: guix-git/doc/guix.texi:22530
40314 msgid "A password to identify your registration. Subsequent updates will need the same password. Don't lose your password."
40318 #: guix-git/doc/guix.texi:22534
40319 msgid "This should be a @code{http://} or @code{https://} link to your web site."
40323 #: guix-git/doc/guix.texi:22535 guix-git/doc/guix.texi:25630
40325 msgid "@code{hostname} (default: @code{#f})"
40329 #: guix-git/doc/guix.texi:22538
40330 msgid "By default your server will be listed by its IP address. If it is set your server will be linked by this host name instead."
40333 #. type: Plain text
40334 #: guix-git/doc/guix.texi:22548
40335 msgid "The @code{(gnu services file-sharing)} module provides services that assist with transferring files over peer-to-peer file-sharing networks."
40338 #. type: subsubheading
40339 #: guix-git/doc/guix.texi:22549
40341 msgid "Transmission Daemon Service"
40344 #. type: Plain text
40345 #: guix-git/doc/guix.texi:22557
40346 msgid "@uref{https://transmissionbt.com/, Transmission} is a flexible BitTorrent client that offers a variety of graphical and command-line interfaces. A @code{transmission-daemon-service-type} service provides Transmission's headless variant, @command{transmission-daemon}, as a system service, allowing users to share files via BitTorrent even when they are not logged in."
40350 #: guix-git/doc/guix.texi:22558
40352 msgid "{Scheme Variable} transmission-daemon-service-type"
40356 #: guix-git/doc/guix.texi:22562
40357 msgid "The service type for the Transmission Daemon BitTorrent client. Its value must be a @code{transmission-daemon-configuration} object as in this example:"
40361 #: guix-git/doc/guix.texi:22573
40364 "(service transmission-daemon-service-type\n"
40365 " (transmission-daemon-configuration\n"
40366 " ;; Restrict access to the RPC (\"control\") interface\n"
40367 " (rpc-authentication-required? #t)\n"
40368 " (rpc-username \"transmission\")\n"
40370 " (transmission-password-hash\n"
40371 " \"transmission\" ; desired password\n"
40372 " \"uKd1uMs9\")) ; arbitrary salt value\n"
40377 #: guix-git/doc/guix.texi:22578
40380 " ;; Accept requests from this and other hosts on the\n"
40381 " ;; local network\n"
40382 " (rpc-whitelist-enabled? #t)\n"
40383 " (rpc-whitelist '(\"::1\" \"127.0.0.1\" \"192.168.0.*\"))\n"
40388 #: guix-git/doc/guix.texi:22582
40391 " ;; Limit bandwidth use during work hours\n"
40392 " (alt-speed-down (* 1024 2)) ; 2 MB/s\n"
40393 " (alt-speed-up 512) ; 512 kB/s\n"
40398 #: guix-git/doc/guix.texi:22589
40401 " (alt-speed-time-enabled? #t)\n"
40402 " (alt-speed-time-day 'weekdays)\n"
40403 " (alt-speed-time-begin\n"
40404 " (+ (* 60 8) 30)) ; 8:30 am\n"
40405 " (alt-speed-time-end\n"
40406 " (+ (* 60 (+ 12 5)) 30)))) ; 5:30 pm\n"
40409 #. type: Plain text
40410 #: guix-git/doc/guix.texi:22602
40411 msgid "Once the service is started, users can interact with the daemon through its Web interface (at @code{http://localhost:9091/}) or by using the @command{transmission-remote} command-line tool, available in the @code{transmission} package. (Emacs users may want to also consider the @code{emacs-transmission} package.) Both communicate with the daemon through its remote procedure call (RPC) interface, which by default is available to all users on the system; you may wish to change this by assigning values to the @code{rpc-authentication-required?}, @code{rpc-username} and @code{rpc-password} settings, as shown in the example above and documented further below."
40414 #. type: Plain text
40415 #: guix-git/doc/guix.texi:22610
40416 msgid "The value for @code{rpc-password} must be a password hash of the type generated and used by Transmission clients. This can be copied verbatim from an existing @file{settings.json} file, if another Transmission client is already being used. Otherwise, the @code{transmission-password-hash} and @code{transmission-random-salt} procedures provided by this module can be used to obtain a suitable hash value."
40420 #: guix-git/doc/guix.texi:22611
40422 msgid "{Scheme Procedure} transmission-password-hash @var{password} @var{salt}"
40426 #: guix-git/doc/guix.texi:22615
40427 msgid "Returns a string containing the result of hashing @var{password} together with @var{salt}, in the format recognized by Transmission clients for their @code{rpc-password} configuration setting."
40431 #: guix-git/doc/guix.texi:22619
40432 msgid "@var{salt} must be an eight-character string. The @code{transmission-random-salt} procedure can be used to generate a suitable salt value at random."
40436 #: guix-git/doc/guix.texi:22621
40438 msgid "{Scheme Procedure} transmission-random-salt"
40442 #: guix-git/doc/guix.texi:22625
40443 msgid "Returns a string containing a random, eight-character salt value of the type generated and used by Transmission clients, suitable for passing to the @code{transmission-password-hash} procedure."
40446 #. type: Plain text
40447 #: guix-git/doc/guix.texi:22631
40448 msgid "These procedures are accessible from within a Guile REPL started with the @command{guix repl} command (@pxref{Invoking guix repl}). This is useful for obtaining a random salt value to provide as the second parameter to `transmission-password-hash`, as in this example session:"
40452 #: guix-git/doc/guix.texi:22637
40456 "scheme@@(guix-user)> ,use (gnu services file-sharing)\n"
40457 "scheme@@(guix-user)> (transmission-random-salt)\n"
40458 "$1 = \"uKd1uMs9\"\n"
40461 #. type: Plain text
40462 #: guix-git/doc/guix.texi:22640
40463 msgid "Alternatively, a complete password hash can generated in a single step:"
40467 #: guix-git/doc/guix.texi:22645
40470 "scheme@@(guix-user)> (transmission-password-hash \"transmission\"\n"
40471 "(transmission-random-salt))\n"
40472 "$2 = \"@{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX\"\n"
40475 #. type: Plain text
40476 #: guix-git/doc/guix.texi:22650
40477 msgid "The resulting string can be used as-is for the value of @code{rpc-password}, allowing the password to be kept hidden even in the operating-system configuration."
40480 #. type: Plain text
40481 #: guix-git/doc/guix.texi:22659
40482 msgid "Torrent files downloaded by the daemon are directly accessible only to users in the ``transmission'' user group, who receive read-only access to the directory specified by the @code{download-dir} configuration setting (and also the directory specified by @code{incomplete-dir}, if @code{incomplete-dir-enabled?} is @code{#t}). Downloaded files can be moved to another directory or deleted altogether using @command{transmission-remote} with its @code{--move} and @code{--remove-and-delete} options."
40485 #. type: Plain text
40486 #: guix-git/doc/guix.texi:22666
40487 msgid "If the @code{watch-dir-enabled?} setting is set to @code{#t}, users in the ``transmission'' group are able also to place @file{.torrent} files in the directory specified by @code{watch-dir} to have the corresponding torrents added by the daemon. (The @code{trash-original-torrent-files?} setting controls whether the daemon deletes these files after processing them.)"
40490 #. type: Plain text
40491 #: guix-git/doc/guix.texi:22671
40492 msgid "Some of the daemon's configuration settings can be changed temporarily by @command{transmission-remote} and similar tools. To undo these changes, use the service's @code{reload} action to have the daemon reload its settings from disk:"
40496 #: guix-git/doc/guix.texi:22674
40498 msgid "# herd reload transmission-daemon\n"
40501 #. type: Plain text
40502 #: guix-git/doc/guix.texi:22678
40503 msgid "The full set of available configuration settings is defined by the @code{transmission-daemon-configuration} data type."
40507 #: guix-git/doc/guix.texi:22679
40509 msgid "{Data Type} transmission-daemon-configuration"
40513 #: guix-git/doc/guix.texi:22683
40514 msgid "The data type representing configuration settings for Transmission Daemon. These correspond directly to the settings recognized by Transmission clients in their @file{settings.json} file."
40517 #. type: Plain text
40518 #: guix-git/doc/guix.texi:22697
40519 msgid "Available @code{transmission-daemon-configuration} fields are:"
40523 #: guix-git/doc/guix.texi:22698
40525 msgid "{@code{transmission-daemon-configuration} parameter} package transmission"
40529 #: guix-git/doc/guix.texi:22700
40530 msgid "The Transmission package to use."
40534 #: guix-git/doc/guix.texi:22703
40536 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer stop-wait-period"
40540 #: guix-git/doc/guix.texi:22709
40541 msgid "The period, in seconds, to wait when stopping the service for @command{transmission-daemon} to exit before killing its process. This allows the daemon time to complete its housekeeping and send a final update to trackers as it shuts down. On slow hosts, or hosts with a slow network connection, this value may need to be increased."
40545 #: guix-git/doc/guix.texi:22711 guix-git/doc/guix.texi:23083
40546 #: guix-git/doc/guix.texi:30315 guix-git/doc/guix.texi:30550
40547 #: guix-git/doc/guix.texi:30558 guix-git/doc/guix.texi:30566
40548 msgid "Defaults to @samp{10}."
40552 #: guix-git/doc/guix.texi:22714
40554 msgid "{@code{transmission-daemon-configuration} parameter} string download-dir"
40558 #: guix-git/doc/guix.texi:22716
40559 msgid "The directory to which torrent files are downloaded."
40563 #: guix-git/doc/guix.texi:22718
40564 msgid "Defaults to @samp{\"/var/lib/transmission-daemon/downloads\"}."
40568 #: guix-git/doc/guix.texi:22721
40570 msgid "{@code{transmission-daemon-configuration} parameter} boolean incomplete-dir-enabled?"
40574 #: guix-git/doc/guix.texi:22726
40575 msgid "If @code{#t}, files will be held in @code{incomplete-dir} while their torrent is being downloaded, then moved to @code{download-dir} once the torrent is complete. Otherwise, files for all torrents (including those still being downloaded) will be placed in @code{download-dir}."
40579 #: guix-git/doc/guix.texi:22731
40581 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string incomplete-dir"
40585 #: guix-git/doc/guix.texi:22734
40586 msgid "The directory in which files from incompletely downloaded torrents will be held when @code{incomplete-dir-enabled?} is @code{#t}."
40590 #: guix-git/doc/guix.texi:22736 guix-git/doc/guix.texi:22780
40591 #: guix-git/doc/guix.texi:22993 guix-git/doc/guix.texi:23049
40592 #: guix-git/doc/guix.texi:23223 guix-git/doc/guix.texi:23234
40593 #: guix-git/doc/guix.texi:23307 guix-git/doc/guix.texi:24032
40594 #: guix-git/doc/guix.texi:24075 guix-git/doc/guix.texi:24083
40595 #: guix-git/doc/guix.texi:24091 guix-git/doc/guix.texi:24099
40596 #: guix-git/doc/guix.texi:24108 guix-git/doc/guix.texi:24116
40597 #: guix-git/doc/guix.texi:24123 guix-git/doc/guix.texi:24131
40598 #: guix-git/doc/guix.texi:24139 guix-git/doc/guix.texi:24149
40599 #: guix-git/doc/guix.texi:24156 guix-git/doc/guix.texi:24180
40600 #: guix-git/doc/guix.texi:24188 guix-git/doc/guix.texi:24214
40601 #: guix-git/doc/guix.texi:24223 guix-git/doc/guix.texi:24232
40602 #: guix-git/doc/guix.texi:24241 guix-git/doc/guix.texi:24250
40603 #: guix-git/doc/guix.texi:24259 guix-git/doc/guix.texi:24267
40604 #: guix-git/doc/guix.texi:24275 guix-git/doc/guix.texi:24282
40605 #: guix-git/doc/guix.texi:24290 guix-git/doc/guix.texi:24297
40606 #: guix-git/doc/guix.texi:24305 guix-git/doc/guix.texi:24313
40607 #: guix-git/doc/guix.texi:24322 guix-git/doc/guix.texi:24331
40608 #: guix-git/doc/guix.texi:24339 guix-git/doc/guix.texi:24347
40609 #: guix-git/doc/guix.texi:24355 guix-git/doc/guix.texi:24366
40610 #: guix-git/doc/guix.texi:24376 guix-git/doc/guix.texi:24387
40611 #: guix-git/doc/guix.texi:24396 guix-git/doc/guix.texi:24406
40612 #: guix-git/doc/guix.texi:24414 guix-git/doc/guix.texi:24425
40613 #: guix-git/doc/guix.texi:24434 guix-git/doc/guix.texi:24444
40614 #: guix-git/doc/guix.texi:27607 guix-git/doc/guix.texi:27614
40615 #: guix-git/doc/guix.texi:27621 guix-git/doc/guix.texi:27628
40616 #: guix-git/doc/guix.texi:27635 guix-git/doc/guix.texi:27642
40617 #: guix-git/doc/guix.texi:27650 guix-git/doc/guix.texi:27658
40618 #: guix-git/doc/guix.texi:27665 guix-git/doc/guix.texi:27672
40619 #: guix-git/doc/guix.texi:27679 guix-git/doc/guix.texi:27686
40620 #: guix-git/doc/guix.texi:27716 guix-git/doc/guix.texi:27754
40621 #: guix-git/doc/guix.texi:27761 guix-git/doc/guix.texi:27770
40622 #: guix-git/doc/guix.texi:27792 guix-git/doc/guix.texi:27800
40623 #: guix-git/doc/guix.texi:27807 guix-git/doc/guix.texi:27962
40624 #: guix-git/doc/guix.texi:27982 guix-git/doc/guix.texi:27997
40625 #: guix-git/doc/guix.texi:28004 guix-git/doc/guix.texi:30687
40626 #: guix-git/doc/guix.texi:30695 guix-git/doc/guix.texi:30703
40627 #: guix-git/doc/guix.texi:30711 guix-git/doc/guix.texi:30719
40628 #: guix-git/doc/guix.texi:30727
40629 msgid "Defaults to @samp{disabled}."
40633 #: guix-git/doc/guix.texi:22739
40635 msgid "{@code{transmission-daemon-configuration} parameter} umask umask"
40639 #: guix-git/doc/guix.texi:22742
40640 msgid "The file mode creation mask used for downloaded files. (See the @command{umask} man page for more information.)"
40644 #: guix-git/doc/guix.texi:22744
40645 msgid "Defaults to @samp{18}."
40649 #: guix-git/doc/guix.texi:22747
40651 msgid "{@code{transmission-daemon-configuration} parameter} boolean rename-partial-files?"
40655 #: guix-git/doc/guix.texi:22750
40656 msgid "When @code{#t}, ``.part'' is appended to the name of partially downloaded files."
40660 #: guix-git/doc/guix.texi:22755
40662 msgid "{@code{transmission-daemon-configuration} parameter} preallocation-mode preallocation"
40666 #: guix-git/doc/guix.texi:22760
40667 msgid "The mode by which space should be preallocated for downloaded files, one of @code{none}, @code{fast} (or @code{sparse}) and @code{full}. Specifying @code{full} will minimize disk fragmentation at a cost to file-creation speed."
40671 #: guix-git/doc/guix.texi:22762
40672 msgid "Defaults to @samp{fast}."
40676 #: guix-git/doc/guix.texi:22765
40678 msgid "{@code{transmission-daemon-configuration} parameter} boolean watch-dir-enabled?"
40682 #: guix-git/doc/guix.texi:22770
40683 msgid "If @code{#t}, the directory specified by @code{watch-dir} will be watched for new @file{.torrent} files and the torrents they describe added automatically (and the original files removed, if @code{trash-original-torrent-files?} is @code{#t})."
40687 #: guix-git/doc/guix.texi:22775
40689 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string watch-dir"
40693 #: guix-git/doc/guix.texi:22778
40694 msgid "The directory to be watched for @file{.torrent} files indicating new torrents to be added, when @code{watch-dir-enabled} is @code{#t}."
40698 #: guix-git/doc/guix.texi:22783
40700 msgid "{@code{transmission-daemon-configuration} parameter} boolean trash-original-torrent-files?"
40704 #: guix-git/doc/guix.texi:22787
40705 msgid "When @code{#t}, @file{.torrent} files will be deleted from the watch directory once their torrent has been added (see @code{watch-directory-enabled?})."
40709 #: guix-git/doc/guix.texi:22792
40711 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-down-enabled?"
40715 #: guix-git/doc/guix.texi:22795
40716 msgid "When @code{#t}, the daemon's download speed will be limited to the rate specified by @code{speed-limit-down}."
40720 #: guix-git/doc/guix.texi:22800
40722 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-down"
40726 #: guix-git/doc/guix.texi:22802
40727 msgid "The default global-maximum download speed, in kilobytes per second."
40731 #: guix-git/doc/guix.texi:22807
40733 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-up-enabled?"
40737 #: guix-git/doc/guix.texi:22810
40738 msgid "When @code{#t}, the daemon's upload speed will be limited to the rate specified by @code{speed-limit-up}."
40742 #: guix-git/doc/guix.texi:22815
40744 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-up"
40748 #: guix-git/doc/guix.texi:22817
40749 msgid "The default global-maximum upload speed, in kilobytes per second."
40753 #: guix-git/doc/guix.texi:22822
40755 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-enabled?"
40759 #: guix-git/doc/guix.texi:22828
40760 msgid "When @code{#t}, the alternate speed limits @code{alt-speed-down} and @code{alt-speed-up} are used (in place of @code{speed-limit-down} and @code{speed-limit-up}, if they are enabled) to constrain the daemon's bandwidth usage. This can be scheduled to occur automatically at certain times during the week; see @code{alt-speed-time-enabled?}."
40764 #: guix-git/doc/guix.texi:22833
40766 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-down"
40770 #: guix-git/doc/guix.texi:22835
40771 msgid "The alternate global-maximum download speed, in kilobytes per second."
40775 #: guix-git/doc/guix.texi:22837 guix-git/doc/guix.texi:22844
40776 #: guix-git/doc/guix.texi:23016 guix-git/doc/guix.texi:30322
40777 #: guix-git/doc/guix.texi:30337
40778 msgid "Defaults to @samp{50}."
40782 #: guix-git/doc/guix.texi:22840
40784 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-up"
40788 #: guix-git/doc/guix.texi:22842
40789 msgid "The alternate global-maximum upload speed, in kilobytes per second."
40793 #: guix-git/doc/guix.texi:22847
40795 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-time-enabled?"
40799 #: guix-git/doc/guix.texi:22852
40800 msgid "When @code{#t}, the alternate speed limits @code{alt-speed-down} and @code{alt-speed-up} will be enabled automatically during the periods specified by @code{alt-speed-time-day}, @code{alt-speed-time-begin} and @code{alt-time-speed-end}."
40804 #: guix-git/doc/guix.texi:22857
40806 msgid "{@code{transmission-daemon-configuration} parameter} day-list alt-speed-time-day"
40810 #: guix-git/doc/guix.texi:22862
40811 msgid "The days of the week on which the alternate-speed schedule should be used, specified either as a list of days (@code{sunday}, @code{monday}, and so on) or using one of the symbols @code{weekdays}, @code{weekends} or @code{all}."
40815 #: guix-git/doc/guix.texi:22864
40816 msgid "Defaults to @samp{all}."
40820 #: guix-git/doc/guix.texi:22867
40822 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-begin"
40826 #: guix-git/doc/guix.texi:22870
40827 msgid "The time of day at which to enable the alternate speed limits, expressed as a number of minutes since midnight."
40831 #: guix-git/doc/guix.texi:22872
40832 msgid "Defaults to @samp{540}."
40836 #: guix-git/doc/guix.texi:22875
40838 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-end"
40842 #: guix-git/doc/guix.texi:22878
40843 msgid "The time of day at which to disable the alternate speed limits, expressed as a number of minutes since midnight."
40847 #: guix-git/doc/guix.texi:22880
40848 msgid "Defaults to @samp{1020}."
40852 #: guix-git/doc/guix.texi:22883
40854 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv4"
40858 #: guix-git/doc/guix.texi:22886
40859 msgid "The IP address at which to listen for peer connections, or ``0.0.0.0'' to listen at all available IP addresses."
40863 #: guix-git/doc/guix.texi:22888 guix-git/doc/guix.texi:23191
40864 #: guix-git/doc/guix.texi:28237
40865 msgid "Defaults to @samp{\"0.0.0.0\"}."
40869 #: guix-git/doc/guix.texi:22891
40871 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv6"
40875 #: guix-git/doc/guix.texi:22894
40876 msgid "The IPv6 address at which to listen for peer connections, or ``::'' to listen at all available IPv6 addresses."
40880 #: guix-git/doc/guix.texi:22896
40881 msgid "Defaults to @samp{\"::\"}."
40885 #: guix-git/doc/guix.texi:22899
40887 msgid "{@code{transmission-daemon-configuration} parameter} boolean peer-port-random-on-start?"
40891 #: guix-git/doc/guix.texi:22905
40892 msgid "If @code{#t}, when the daemon starts it will select a port at random on which to listen for peer connections, from the range specified (inclusively) by @code{peer-port-random-low} and @code{peer-port-random-high}. Otherwise, it listens on the port specified by @code{peer-port}."
40896 #: guix-git/doc/guix.texi:22910
40898 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-low"
40902 #: guix-git/doc/guix.texi:22913
40903 msgid "The lowest selectable port number when @code{peer-port-random-on-start?} is @code{#t}."
40907 #: guix-git/doc/guix.texi:22915
40908 msgid "Defaults to @samp{49152}."
40912 #: guix-git/doc/guix.texi:22918
40914 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-high"
40918 #: guix-git/doc/guix.texi:22921
40919 msgid "The highest selectable port number when @code{peer-port-random-on-start} is @code{#t}."
40923 #: guix-git/doc/guix.texi:22923
40924 msgid "Defaults to @samp{65535}."
40928 #: guix-git/doc/guix.texi:22926
40930 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port"
40934 #: guix-git/doc/guix.texi:22929
40935 msgid "The port on which to listen for peer connections when @code{peer-port-random-on-start?} is @code{#f}."
40939 #: guix-git/doc/guix.texi:22931
40940 msgid "Defaults to @samp{51413}."
40944 #: guix-git/doc/guix.texi:22934
40946 msgid "{@code{transmission-daemon-configuration} parameter} boolean port-forwarding-enabled?"
40950 #: guix-git/doc/guix.texi:22938
40951 msgid "If @code{#t}, the daemon will attempt to configure port-forwarding on an upstream gateway automatically using @acronym{UPnP} and @acronym{NAT-PMP}."
40955 #: guix-git/doc/guix.texi:22943
40957 msgid "{@code{transmission-daemon-configuration} parameter} encryption-mode encryption"
40961 #: guix-git/doc/guix.texi:22948
40962 msgid "The encryption preference for peer connections, one of @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or @code{require-encrypted-connections}."
40966 #: guix-git/doc/guix.texi:22950
40967 msgid "Defaults to @samp{prefer-encrypted-connections}."
40971 #: guix-git/doc/guix.texi:22953
40973 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm"
40977 #: guix-git/doc/guix.texi:22958
40978 msgid "The TCP congestion-control algorithm to use for peer connections, specified using a string recognized by the operating system in calls to @code{setsockopt} (or set to @code{disabled}, in which case the operating-system default is used)."
40982 #: guix-git/doc/guix.texi:22967
40983 msgid "Note that on GNU/Linux systems, the kernel must be configured to allow processes to use a congestion-control algorithm not in the default set; otherwise, it will deny these requests with ``Operation not permitted''. To see which algorithms are available on your system and which are currently permitted for use, look at the contents of the files @file{tcp_available_congestion_control} and @file{tcp_allowed_congestion_control} in the @file{/proc/sys/net/ipv4} directory."
40987 #: guix-git/doc/guix.texi:22975
40988 msgid "As an example, to have Transmission Daemon use @uref{http://www-ece.rice.edu/networks/TCP-LP/,the TCP Low Priority congestion-control algorithm}, you'll need to modify your kernel configuration to build in support for the algorithm, then update your operating-system configuration to allow its use by adding a @code{sysctl-service-type} service (or updating the existing one's configuration) with lines like the following:"
40992 #: guix-git/doc/guix.texi:22982
40995 "(service sysctl-service-type\n"
40996 " (sysctl-configuration\n"
40998 " (\"net.ipv4.tcp_allowed_congestion_control\" .\n"
40999 " \"reno cubic lp\"))))\n"
41003 #: guix-git/doc/guix.texi:22985
41004 msgid "The Transmission Daemon configuration can then be updated with"
41008 #: guix-git/doc/guix.texi:22988
41010 msgid "(peer-congestion-algorithm \"lp\")\n"
41014 #: guix-git/doc/guix.texi:22991
41015 msgid "and the system reconfigured to have the changes take effect."
41019 #: guix-git/doc/guix.texi:22996
41021 msgid "{@code{transmission-daemon-configuration} parameter} tcp-type-of-service peer-socket-tos"
41025 #: guix-git/doc/guix.texi:23000
41026 msgid "The type of service to request in outgoing @acronym{TCP} packets, one of @code{default}, @code{low-cost}, @code{throughput}, @code{low-delay} and @code{reliability}."
41030 #: guix-git/doc/guix.texi:23002
41031 msgid "Defaults to @samp{default}."
41035 #: guix-git/doc/guix.texi:23005
41037 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-global"
41041 #: guix-git/doc/guix.texi:23007
41042 msgid "The global limit on the number of connected peers."
41046 #: guix-git/doc/guix.texi:23009
41047 msgid "Defaults to @samp{200}."
41051 #: guix-git/doc/guix.texi:23012
41053 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-per-torrent"
41057 #: guix-git/doc/guix.texi:23014
41058 msgid "The per-torrent limit on the number of connected peers."
41062 #: guix-git/doc/guix.texi:23019
41064 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer upload-slots-per-torrent"
41068 #: guix-git/doc/guix.texi:23022
41069 msgid "The maximum number of peers to which the daemon will upload data simultaneously for each torrent."
41073 #: guix-git/doc/guix.texi:23024
41074 msgid "Defaults to @samp{14}."
41078 #: guix-git/doc/guix.texi:23027
41080 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-id-ttl-hours"
41084 #: guix-git/doc/guix.texi:23030
41085 msgid "The maximum lifespan, in hours, of the peer ID associated with each public torrent before it is regenerated."
41089 #: guix-git/doc/guix.texi:23032
41090 msgid "Defaults to @samp{6}."
41094 #: guix-git/doc/guix.texi:23035
41096 msgid "{@code{transmission-daemon-configuration} parameter} boolean blocklist-enabled?"
41100 #: guix-git/doc/guix.texi:23038
41101 msgid "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it has most recently downloaded from @code{blocklist-url}."
41105 #: guix-git/doc/guix.texi:23043
41107 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string blocklist-url"
41111 #: guix-git/doc/guix.texi:23047
41112 msgid "The URL of a peer blocklist (in @acronym{P2P}-plaintext or eMule @file{.dat} format) to be periodically downloaded and applied when @code{blocklist-enabled?} is @code{#t}."
41116 #: guix-git/doc/guix.texi:23052
41118 msgid "{@code{transmission-daemon-configuration} parameter} boolean download-queue-enabled?"
41122 #: guix-git/doc/guix.texi:23055
41123 msgid "If @code{#t}, the daemon will be limited to downloading at most @code{download-queue-size} non-stalled torrents simultaneously."
41127 #: guix-git/doc/guix.texi:23060
41129 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer download-queue-size"
41133 #: guix-git/doc/guix.texi:23064
41134 msgid "The size of the daemon's download queue, which limits the number of non-stalled torrents it will download at any one time when @code{download-queue-enabled?} is @code{#t}."
41138 #: guix-git/doc/guix.texi:23069
41140 msgid "{@code{transmission-daemon-configuration} parameter} boolean seed-queue-enabled?"
41144 #: guix-git/doc/guix.texi:23072
41145 msgid "If @code{#t}, the daemon will be limited to seeding at most @code{seed-queue-size} non-stalled torrents simultaneously."
41149 #: guix-git/doc/guix.texi:23077
41151 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer seed-queue-size"
41155 #: guix-git/doc/guix.texi:23081
41156 msgid "The size of the daemon's seed queue, which limits the number of non-stalled torrents it will seed at any one time when @code{seed-queue-enabled?} is @code{#t}."
41160 #: guix-git/doc/guix.texi:23086
41162 msgid "{@code{transmission-daemon-configuration} parameter} boolean queue-stalled-enabled?"
41166 #: guix-git/doc/guix.texi:23091
41167 msgid "When @code{#t}, the daemon will consider torrents for which it has not shared data in the past @code{queue-stalled-minutes} minutes to be stalled and not count them against its @code{download-queue-size} and @code{seed-queue-size} limits."
41171 #: guix-git/doc/guix.texi:23096
41173 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer queue-stalled-minutes"
41177 #: guix-git/doc/guix.texi:23100
41178 msgid "The maximum period, in minutes, a torrent may be idle before it is considered to be stalled, when @code{queue-stalled-enabled?} is @code{#t}."
41182 #: guix-git/doc/guix.texi:23105
41184 msgid "{@code{transmission-daemon-configuration} parameter} boolean ratio-limit-enabled?"
41188 #: guix-git/doc/guix.texi:23108
41189 msgid "When @code{#t}, a torrent being seeded will automatically be paused once it reaches the ratio specified by @code{ratio-limit}."
41193 #: guix-git/doc/guix.texi:23113
41195 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-rational ratio-limit"
41199 #: guix-git/doc/guix.texi:23116
41200 msgid "The ratio at which a torrent being seeded will be paused, when @code{ratio-limit-enabled?} is @code{#t}."
41204 #: guix-git/doc/guix.texi:23118
41205 msgid "Defaults to @samp{2.0}."
41209 #: guix-git/doc/guix.texi:23121
41211 msgid "{@code{transmission-daemon-configuration} parameter} boolean idle-seeding-limit-enabled?"
41215 #: guix-git/doc/guix.texi:23124
41216 msgid "When @code{#t}, a torrent being seeded will automatically be paused once it has been idle for @code{idle-seeding-limit} minutes."
41220 #: guix-git/doc/guix.texi:23129
41222 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer idle-seeding-limit"
41226 #: guix-git/doc/guix.texi:23133
41227 msgid "The maximum period, in minutes, a torrent being seeded may be idle before it is paused, when @code{idle-seeding-limit-enabled?} is @code{#t}."
41231 #: guix-git/doc/guix.texi:23138
41233 msgid "{@code{transmission-daemon-configuration} parameter} boolean dht-enabled?"
41237 #: guix-git/doc/guix.texi:23142
41238 msgid "Enable @uref{http://bittorrent.org/beps/bep_0005.html,the distributed hash table (@acronym{DHT}) protocol}, which supports the use of trackerless torrents."
41242 #: guix-git/doc/guix.texi:23147
41244 msgid "{@code{transmission-daemon-configuration} parameter} boolean lpd-enabled?"
41248 #: guix-git/doc/guix.texi:23152
41249 msgid "Enable @uref{https://en.wikipedia.org/wiki/Local_Peer_Discovery,local peer discovery} (@acronym{LPD}), which allows the discovery of peers on the local network and may reduce the amount of data sent over the public Internet."
41253 #: guix-git/doc/guix.texi:23157
41255 msgid "{@code{transmission-daemon-configuration} parameter} boolean pex-enabled?"
41259 #: guix-git/doc/guix.texi:23161
41260 msgid "Enable @uref{https://en.wikipedia.org/wiki/Peer_exchange,peer exchange} (@acronym{PEX}), which reduces the daemon's reliance on external trackers and may improve its performance."
41264 #: guix-git/doc/guix.texi:23166
41266 msgid "{@code{transmission-daemon-configuration} parameter} boolean utp-enabled?"
41270 #: guix-git/doc/guix.texi:23171
41271 msgid "Enable @uref{http://bittorrent.org/beps/bep_0029.html,the micro transport protocol} (@acronym{uTP}), which aims to reduce the impact of BitTorrent traffic on other users of the local network while maintaining full utilization of the available bandwidth."
41275 #: guix-git/doc/guix.texi:23176
41277 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-enabled?"
41281 #: guix-git/doc/guix.texi:23181
41282 msgid "If @code{#t}, enable the remote procedure call (@acronym{RPC}) interface, which allows remote control of the daemon via its Web interface, the @command{transmission-remote} command-line client, and similar tools."
41286 #: guix-git/doc/guix.texi:23186
41288 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-bind-address"
41292 #: guix-git/doc/guix.texi:23189
41293 msgid "The IP address at which to listen for @acronym{RPC} connections, or ``0.0.0.0'' to listen at all available IP addresses."
41297 #: guix-git/doc/guix.texi:23194
41299 msgid "{@code{transmission-daemon-configuration} parameter} port-number rpc-port"
41303 #: guix-git/doc/guix.texi:23196
41304 msgid "The port on which to listen for @acronym{RPC} connections."
41308 #: guix-git/doc/guix.texi:23198
41309 msgid "Defaults to @samp{9091}."
41313 #: guix-git/doc/guix.texi:23201
41315 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-url"
41319 #: guix-git/doc/guix.texi:23203
41320 msgid "The path prefix to use in the @acronym{RPC}-endpoint @acronym{URL}."
41324 #: guix-git/doc/guix.texi:23205
41325 msgid "Defaults to @samp{\"/transmission/\"}."
41329 #: guix-git/doc/guix.texi:23208
41331 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-authentication-required?"
41335 #: guix-git/doc/guix.texi:23213
41336 msgid "When @code{#t}, clients must authenticate (see @code{rpc-username} and @code{rpc-password}) when using the @acronym{RPC} interface. Note this has the side effect of disabling host-name whitelisting (see @code{rpc-host-whitelist-enabled?}."
41340 #: guix-git/doc/guix.texi:23218
41342 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string rpc-username"
41346 #: guix-git/doc/guix.texi:23221
41347 msgid "The username required by clients to access the @acronym{RPC} interface when @code{rpc-authentication-required?} is @code{#t}."
41351 #: guix-git/doc/guix.texi:23226
41353 msgid "{@code{transmission-daemon-configuration} parameter} maybe-transmission-password-hash rpc-password"
41357 #: guix-git/doc/guix.texi:23232
41358 msgid "The password required by clients to access the @acronym{RPC} interface when @code{rpc-authentication-required?} is @code{#t}. This must be specified using a password hash in the format recognized by Transmission clients, either copied from an existing @file{settings.json} file or generated using the @code{transmission-password-hash} procedure."
41362 #: guix-git/doc/guix.texi:23237
41364 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-whitelist-enabled?"
41368 #: guix-git/doc/guix.texi:23240
41369 msgid "When @code{#t}, @acronym{RPC} requests will be accepted only when they originate from an address specified in @code{rpc-whitelist}."
41373 #: guix-git/doc/guix.texi:23245
41375 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-whitelist"
41379 #: guix-git/doc/guix.texi:23249
41380 msgid "The list of IP and IPv6 addresses from which @acronym{RPC} requests will be accepted when @code{rpc-whitelist-enabled?} is @code{#t}. Wildcards may be specified using @samp{*}."
41384 #: guix-git/doc/guix.texi:23251
41385 msgid "Defaults to @samp{(\"127.0.0.1\" \"::1\")}."
41389 #: guix-git/doc/guix.texi:23254
41391 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-host-whitelist-enabled?"
41395 #: guix-git/doc/guix.texi:23259
41396 msgid "When @code{#t}, @acronym{RPC} requests will be accepted only when they are addressed to a host named in @code{rpc-host-whitelist}. Note that requests to ``localhost'' or ``localhost.'', or to a numeric address, are always accepted regardless of these settings."
41400 #: guix-git/doc/guix.texi:23262
41401 msgid "Note also this functionality is disabled when @code{rpc-authentication-required?} is @code{#t}."
41405 #: guix-git/doc/guix.texi:23267
41407 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-host-whitelist"
41411 #: guix-git/doc/guix.texi:23270
41412 msgid "The list of host names recognized by the @acronym{RPC} server when @code{rpc-host-whitelist-enabled?} is @code{#t}."
41416 #: guix-git/doc/guix.texi:23275
41418 msgid "{@code{transmission-daemon-configuration} parameter} message-level message-level"
41422 #: guix-git/doc/guix.texi:23279
41423 msgid "The minimum severity level of messages to be logged (to @file{/var/log/transmission.log}) by the daemon, one of @code{none} (no logging), @code{error}, @code{info} and @code{debug}."
41427 #: guix-git/doc/guix.texi:23284
41429 msgid "{@code{transmission-daemon-configuration} parameter} boolean start-added-torrents?"
41433 #: guix-git/doc/guix.texi:23287
41434 msgid "When @code{#t}, torrents are started as soon as they are added; otherwise, they are added in ``paused'' state."
41438 #: guix-git/doc/guix.texi:23292
41440 msgid "{@code{transmission-daemon-configuration} parameter} boolean script-torrent-done-enabled?"
41444 #: guix-git/doc/guix.texi:23296
41445 msgid "When @code{#t}, the script specified by @code{script-torrent-done-filename} will be invoked each time a torrent completes."
41449 #: guix-git/doc/guix.texi:23301
41451 msgid "{@code{transmission-daemon-configuration} parameter} maybe-file-object script-torrent-done-filename"
41455 #: guix-git/doc/guix.texi:23305
41456 msgid "A file name or file-like object specifying a script to run each time a torrent completes, when @code{script-torrent-done-enabled?} is @code{#t}."
41460 #: guix-git/doc/guix.texi:23310
41462 msgid "{@code{transmission-daemon-configuration} parameter} boolean scrape-paused-torrents-enabled?"
41466 #: guix-git/doc/guix.texi:23313
41467 msgid "When @code{#t}, the daemon will scrape trackers for a torrent even when the torrent is paused."
41471 #: guix-git/doc/guix.texi:23318
41473 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer cache-size-mb"
41477 #: guix-git/doc/guix.texi:23322
41478 msgid "The amount of memory, in megabytes, to allocate for the daemon's in-memory cache. A larger value may increase performance by reducing the frequency of disk I/O."
41482 #: guix-git/doc/guix.texi:23324
41483 msgid "Defaults to @samp{4}."
41487 #: guix-git/doc/guix.texi:23327
41489 msgid "{@code{transmission-daemon-configuration} parameter} boolean prefetch-enabled?"
41493 #: guix-git/doc/guix.texi:23331
41494 msgid "When @code{#t}, the daemon will try to improve I/O performance by hinting to the operating system which data is likely to be read next from disk to satisfy requests from peers."
41497 #. type: subsubheading
41498 #: guix-git/doc/guix.texi:23344
41500 msgid "Tailon Service"
41503 #. type: Plain text
41504 #: guix-git/doc/guix.texi:23348
41505 msgid "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for viewing and searching log files."
41508 #. type: Plain text
41509 #: guix-git/doc/guix.texi:23351
41510 msgid "The following example will configure the service with default values. By default, Tailon can be accessed on port 8080 (@code{http://localhost:8080})."
41514 #: guix-git/doc/guix.texi:23354
41516 msgid "(service tailon-service-type)\n"
41519 #. type: Plain text
41520 #: guix-git/doc/guix.texi:23358
41521 msgid "The following example customises more of the Tailon configuration, adding @command{sed} to the list of allowed commands."
41525 #: guix-git/doc/guix.texi:23365
41528 "(service tailon-service-type\n"
41529 " (tailon-configuration\n"
41531 " (tailon-configuration-file\n"
41532 " (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n"
41536 #: guix-git/doc/guix.texi:23368
41538 msgid "{Data Type} tailon-configuration"
41542 #: guix-git/doc/guix.texi:23371
41543 msgid "Data type representing the configuration of Tailon. This type has the following parameters:"
41547 #: guix-git/doc/guix.texi:23373
41549 msgid "@code{config-file} (default: @code{(tailon-configuration-file)})"
41553 #: guix-git/doc/guix.texi:23377
41554 msgid "The configuration file to use for Tailon. This can be set to a @dfn{tailon-configuration-file} record value, or any gexp (@pxref{G-Expressions})."
41558 #: guix-git/doc/guix.texi:23380
41559 msgid "For example, to instead use a local file, the @code{local-file} function can be used:"
41563 #: guix-git/doc/guix.texi:23385
41566 "(service tailon-service-type\n"
41567 " (tailon-configuration\n"
41568 " (config-file (local-file \"./my-tailon.conf\"))))\n"
41572 #: guix-git/doc/guix.texi:23387
41574 msgid "@code{package} (default: @code{tailon})"
41578 #: guix-git/doc/guix.texi:23389
41579 msgid "The tailon package to use."
41583 #: guix-git/doc/guix.texi:23393
41585 msgid "{Data Type} tailon-configuration-file"
41589 #: guix-git/doc/guix.texi:23396
41590 msgid "Data type representing the configuration options for Tailon. This type has the following parameters:"
41594 #: guix-git/doc/guix.texi:23398
41596 msgid "@code{files} (default: @code{(list \"/var/log\")})"
41600 #: guix-git/doc/guix.texi:23403
41601 msgid "List of files to display. The list can include strings for a single file or directory, or a list, where the first item is the name of a subsection, and the remaining items are the files or directories in that subsection."
41605 #: guix-git/doc/guix.texi:23404
41607 msgid "@code{bind} (default: @code{\"localhost:8080\"})"
41611 #: guix-git/doc/guix.texi:23406
41612 msgid "Address and port to which Tailon should bind on."
41616 #: guix-git/doc/guix.texi:23407
41618 msgid "@code{relative-root} (default: @code{#f})"
41622 #: guix-git/doc/guix.texi:23409
41623 msgid "URL path to use for Tailon, set to @code{#f} to not use a path."
41627 #: guix-git/doc/guix.texi:23410
41629 msgid "@code{allow-transfers?} (default: @code{#t})"
41633 #: guix-git/doc/guix.texi:23412
41634 msgid "Allow downloading the log files in the web interface."
41638 #: guix-git/doc/guix.texi:23413
41640 msgid "@code{follow-names?} (default: @code{#t})"
41644 #: guix-git/doc/guix.texi:23415
41645 msgid "Allow tailing of not-yet existent files."
41649 #: guix-git/doc/guix.texi:23416
41651 msgid "@code{tail-lines} (default: @code{200})"
41655 #: guix-git/doc/guix.texi:23418
41656 msgid "Number of lines to read initially from each file."
41660 #: guix-git/doc/guix.texi:23419
41662 msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})"
41666 #: guix-git/doc/guix.texi:23421
41667 msgid "Commands to allow running. By default, @code{sed} is disabled."
41671 #: guix-git/doc/guix.texi:23424
41672 msgid "Set @code{debug?} to @code{#t} to show debug messages."
41676 #: guix-git/doc/guix.texi:23425
41678 msgid "@code{wrap-lines} (default: @code{#t})"
41682 #: guix-git/doc/guix.texi:23429
41683 msgid "Initial line wrapping state in the web interface. Set to @code{#t} to initially wrap lines (the default), or to @code{#f} to initially not wrap lines."
41687 #: guix-git/doc/guix.texi:23430
41689 msgid "@code{http-auth} (default: @code{#f})"
41693 #: guix-git/doc/guix.texi:23434
41694 msgid "HTTP authentication type to use. Set to @code{#f} to disable authentication (the default). Supported values are @code{\"digest\"} or @code{\"basic\"}."
41698 #: guix-git/doc/guix.texi:23435
41700 msgid "@code{users} (default: @code{#f})"
41704 #: guix-git/doc/guix.texi:23440
41705 msgid "If HTTP authentication is enabled (see @code{http-auth}), access will be restricted to the credentials provided here. To configure users, use a list of pairs, where the first element of the pair is the username, and the 2nd element of the pair is the password."
41709 #: guix-git/doc/guix.texi:23446
41712 "(tailon-configuration-file\n"
41713 " (http-auth \"basic\")\n"
41714 " (users '((\"user1\" . \"password1\")\n"
41715 " (\"user2\" . \"password2\"))))\n"
41718 #. type: subsubheading
41719 #: guix-git/doc/guix.texi:23452
41721 msgid "Darkstat Service"
41725 #: guix-git/doc/guix.texi:23453
41730 #. type: Plain text
41731 #: guix-git/doc/guix.texi:23456
41732 msgid "Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP."
41736 #: guix-git/doc/guix.texi:23457
41738 msgid "{Scheme Variable} darkstat-service-type"
41742 #: guix-git/doc/guix.texi:23462
41743 msgid "This is the service type for the @uref{https://unix4lyfe.org/darkstat/, darkstat} service, its value must be a @code{darkstat-configuration} record as in this example:"
41747 #: guix-git/doc/guix.texi:23467
41750 "(service darkstat-service-type\n"
41751 " (darkstat-configuration\n"
41752 " (interface \"eno1\")))\n"
41756 #: guix-git/doc/guix.texi:23470
41758 msgid "{Data Type} darkstat-configuration"
41762 #: guix-git/doc/guix.texi:23472
41763 msgid "Data type representing the configuration of @command{darkstat}."
41767 #: guix-git/doc/guix.texi:23474
41769 msgid "@code{package} (default: @code{darkstat})"
41773 #: guix-git/doc/guix.texi:23476
41774 msgid "The darkstat package to use."
41778 #: guix-git/doc/guix.texi:23477
41784 #: guix-git/doc/guix.texi:23479
41785 msgid "Capture traffic on the specified network interface."
41789 #: guix-git/doc/guix.texi:23480
41791 msgid "@code{port} (default: @code{\"667\"})"
41795 #: guix-git/doc/guix.texi:23482
41796 msgid "Bind the web interface to the specified port."
41800 #: guix-git/doc/guix.texi:23485 guix-git/doc/guix.texi:23520
41801 msgid "Bind the web interface to the specified address."
41805 #: guix-git/doc/guix.texi:23486
41807 msgid "@code{base} (default: @code{\"/\"})"
41811 #: guix-git/doc/guix.texi:23489
41812 msgid "Specify the path of the base URL@. This can be useful if @command{darkstat} is accessed via a reverse proxy."
41815 #. type: subsubheading
41816 #: guix-git/doc/guix.texi:23493
41818 msgid "Prometheus Node Exporter Service"
41822 #: guix-git/doc/guix.texi:23495
41824 msgid "prometheus-node-exporter"
41827 #. type: Plain text
41828 #: guix-git/doc/guix.texi:23500
41829 msgid "The Prometheus ``node exporter'' makes hardware and operating system statistics provided by the Linux kernel available for the Prometheus monitoring system. This service should be deployed on all physical nodes and virtual machines, where monitoring these statistics is desirable."
41833 #: guix-git/doc/guix.texi:23501
41835 msgid "{Scheme variable} prometheus-node-exporter-service-type"
41839 #: guix-git/doc/guix.texi:23505
41840 msgid "This is the service type for the @uref{https://github.com/prometheus/node_exporter/, prometheus-node-exporter} service, its value must be a @code{prometheus-node-exporter-configuration}."
41844 #: guix-git/doc/guix.texi:23508
41846 msgid "(service prometheus-node-exporter-service-type)\n"
41850 #: guix-git/doc/guix.texi:23511
41852 msgid "{Data Type} prometheus-node-exporter-configuration"
41856 #: guix-git/doc/guix.texi:23513
41857 msgid "Data type representing the configuration of @command{node_exporter}."
41861 #: guix-git/doc/guix.texi:23515
41863 msgid "@code{package} (default: @code{go-github-com-prometheus-node-exporter})"
41867 #: guix-git/doc/guix.texi:23517
41868 msgid "The prometheus-node-exporter package to use."
41872 #: guix-git/doc/guix.texi:23518
41874 msgid "@code{web-listen-address} (default: @code{\":9100\"})"
41878 #: guix-git/doc/guix.texi:23521
41880 msgid "@code{textfile-directory} (default: @code{\"/var/lib/prometheus/node-exporter\"})"
41884 #: guix-git/doc/guix.texi:23525
41885 msgid "This directory can be used to export metrics specific to this machine. Files containing metrics in the text format, with the filename ending in @code{.prom} should be placed in this directory."
41889 #: guix-git/doc/guix.texi:23528
41890 msgid "Extra options to pass to the Prometheus node exporter."
41893 #. type: subsubheading
41894 #: guix-git/doc/guix.texi:23532
41896 msgid "Zabbix server"
41900 #: guix-git/doc/guix.texi:23533
41902 msgid "zabbix zabbix-server"
41905 #. type: Plain text
41906 #: guix-git/doc/guix.texi:23536
41907 msgid "Zabbix provides monitoring metrics, among others network utilization, CPU load and disk space consumption:"
41911 #: guix-git/doc/guix.texi:23538
41913 msgid "High performance, high capacity (able to monitor hundreds of thousands of devices)."
41917 #: guix-git/doc/guix.texi:23539
41919 msgid "Auto-discovery of servers and network devices and interfaces."
41923 #: guix-git/doc/guix.texi:23540
41925 msgid "Low-level discovery, allows to automatically start monitoring new items, file systems or network interfaces among others."
41929 #: guix-git/doc/guix.texi:23541
41931 msgid "Distributed monitoring with centralized web administration."
41935 #: guix-git/doc/guix.texi:23542
41937 msgid "Native high performance agents."
41941 #: guix-git/doc/guix.texi:23543
41943 msgid "SLA, and ITIL KPI metrics on reporting."
41947 #: guix-git/doc/guix.texi:23544
41949 msgid "High-level (business) view of monitored resources through user-defined visual console screens and dashboards."
41953 #: guix-git/doc/guix.texi:23545
41955 msgid "Remote command execution through Zabbix proxies."
41958 #. type: Plain text
41959 #: guix-git/doc/guix.texi:23551
41960 msgid "Available @code{zabbix-server-configuration} fields are:"
41964 #: guix-git/doc/guix.texi:23552
41966 msgid "{@code{zabbix-server-configuration} parameter} package zabbix-server"
41970 #: guix-git/doc/guix.texi:23554
41971 msgid "The zabbix-server package."
41975 #: guix-git/doc/guix.texi:23557
41977 msgid "{@code{zabbix-server-configuration} parameter} string user"
41981 #: guix-git/doc/guix.texi:23559
41982 msgid "User who will run the Zabbix server."
41986 #: guix-git/doc/guix.texi:23561 guix-git/doc/guix.texi:23568
41987 #: guix-git/doc/guix.texi:23582 guix-git/doc/guix.texi:23589
41988 #: guix-git/doc/guix.texi:23690 guix-git/doc/guix.texi:23697
41989 #: guix-git/doc/guix.texi:23808 guix-git/doc/guix.texi:23815
41990 msgid "Defaults to @samp{\"zabbix\"}."
41994 #: guix-git/doc/guix.texi:23564
41996 msgid "{@code{zabbix-server-configuration} parameter} group group"
42000 #: guix-git/doc/guix.texi:23566
42001 msgid "Group who will run the Zabbix server."
42005 #: guix-git/doc/guix.texi:23571
42007 msgid "{@code{zabbix-server-configuration} parameter} string db-host"
42011 #: guix-git/doc/guix.texi:23573 guix-git/doc/guix.texi:23792
42012 msgid "Database host name."
42016 #: guix-git/doc/guix.texi:23575
42017 msgid "Defaults to @samp{\"127.0.0.1\"}."
42021 #: guix-git/doc/guix.texi:23578
42023 msgid "{@code{zabbix-server-configuration} parameter} string db-name"
42027 #: guix-git/doc/guix.texi:23580 guix-git/doc/guix.texi:23806
42028 msgid "Database name."
42032 #: guix-git/doc/guix.texi:23585
42034 msgid "{@code{zabbix-server-configuration} parameter} string db-user"
42038 #: guix-git/doc/guix.texi:23587 guix-git/doc/guix.texi:23813
42039 msgid "Database user."
42043 #: guix-git/doc/guix.texi:23592
42045 msgid "{@code{zabbix-server-configuration} parameter} string db-password"
42049 #: guix-git/doc/guix.texi:23595
42050 msgid "Database password. Please, use @code{include-files} with @code{DBPassword=SECRET} inside a specified file instead."
42054 #: guix-git/doc/guix.texi:23600
42056 msgid "{@code{zabbix-server-configuration} parameter} number db-port"
42060 #: guix-git/doc/guix.texi:23602 guix-git/doc/guix.texi:23799
42061 msgid "Database port."
42065 #: guix-git/doc/guix.texi:23604 guix-git/doc/guix.texi:23801
42066 msgid "Defaults to @samp{5432}."
42070 #: guix-git/doc/guix.texi:23607
42072 msgid "{@code{zabbix-server-configuration} parameter} string log-type"
42076 #: guix-git/doc/guix.texi:23609 guix-git/doc/guix.texi:23710
42077 msgid "Specifies where log messages are written to:"
42081 #: guix-git/doc/guix.texi:23613 guix-git/doc/guix.texi:23714
42082 msgid "@code{system} - syslog."
42086 #: guix-git/doc/guix.texi:23616 guix-git/doc/guix.texi:23717
42087 msgid "@code{file} - file specified with @code{log-file} parameter."
42091 #: guix-git/doc/guix.texi:23619 guix-git/doc/guix.texi:23720
42092 msgid "@code{console} - standard output."
42096 #: guix-git/doc/guix.texi:23626
42098 msgid "{@code{zabbix-server-configuration} parameter} string log-file"
42102 #: guix-git/doc/guix.texi:23628 guix-git/doc/guix.texi:23729
42103 msgid "Log file name for @code{log-type} @code{file} parameter."
42107 #: guix-git/doc/guix.texi:23630
42108 msgid "Defaults to @samp{\"/var/log/zabbix/server.log\"}."
42112 #: guix-git/doc/guix.texi:23633
42114 msgid "{@code{zabbix-server-configuration} parameter} string pid-file"
42118 #: guix-git/doc/guix.texi:23635 guix-git/doc/guix.texi:23736
42119 msgid "Name of PID file."
42123 #: guix-git/doc/guix.texi:23637
42124 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_server.pid\"}."
42128 #: guix-git/doc/guix.texi:23640
42130 msgid "{@code{zabbix-server-configuration} parameter} string ssl-ca-location"
42134 #: guix-git/doc/guix.texi:23643
42135 msgid "The location of certificate authority (CA) files for SSL server certificate verification."
42139 #: guix-git/doc/guix.texi:23645
42140 msgid "Defaults to @samp{\"/etc/ssl/certs/ca-certificates.crt\"}."
42144 #: guix-git/doc/guix.texi:23648
42146 msgid "{@code{zabbix-server-configuration} parameter} string ssl-cert-location"
42150 #: guix-git/doc/guix.texi:23650
42151 msgid "Location of SSL client certificates."
42155 #: guix-git/doc/guix.texi:23652
42156 msgid "Defaults to @samp{\"/etc/ssl/certs\"}."
42160 #: guix-git/doc/guix.texi:23655
42162 msgid "{@code{zabbix-server-configuration} parameter} string extra-options"
42166 #: guix-git/doc/guix.texi:23657 guix-git/doc/guix.texi:23761
42167 msgid "Extra options will be appended to Zabbix server configuration file."
42171 #: guix-git/doc/guix.texi:23662
42173 msgid "{@code{zabbix-server-configuration} parameter} include-files include-files"
42177 #: guix-git/doc/guix.texi:23665 guix-git/doc/guix.texi:23769
42178 msgid "You may include individual files or all files in a directory in the configuration file."
42181 #. type: subsubheading
42182 #: guix-git/doc/guix.texi:23672
42184 msgid "Zabbix agent"
42188 #: guix-git/doc/guix.texi:23673
42190 msgid "zabbix zabbix-agent"
42193 #. type: Plain text
42194 #: guix-git/doc/guix.texi:23676
42195 msgid "Zabbix agent gathers information for Zabbix server."
42198 #. type: Plain text
42199 #: guix-git/doc/guix.texi:23680
42200 msgid "Available @code{zabbix-agent-configuration} fields are:"
42204 #: guix-git/doc/guix.texi:23681
42206 msgid "{@code{zabbix-agent-configuration} parameter} package zabbix-agent"
42210 #: guix-git/doc/guix.texi:23683
42211 msgid "The zabbix-agent package."
42215 #: guix-git/doc/guix.texi:23686
42217 msgid "{@code{zabbix-agent-configuration} parameter} string user"
42221 #: guix-git/doc/guix.texi:23688
42222 msgid "User who will run the Zabbix agent."
42226 #: guix-git/doc/guix.texi:23693
42228 msgid "{@code{zabbix-agent-configuration} parameter} group group"
42232 #: guix-git/doc/guix.texi:23695
42233 msgid "Group who will run the Zabbix agent."
42237 #: guix-git/doc/guix.texi:23700
42239 msgid "{@code{zabbix-agent-configuration} parameter} string hostname"
42243 #: guix-git/doc/guix.texi:23703
42244 msgid "Unique, case sensitive hostname which is required for active checks and must match hostname as configured on the server."
42248 #: guix-git/doc/guix.texi:23708
42250 msgid "{@code{zabbix-agent-configuration} parameter} string log-type"
42254 #: guix-git/doc/guix.texi:23727
42256 msgid "{@code{zabbix-agent-configuration} parameter} string log-file"
42260 #: guix-git/doc/guix.texi:23731
42261 msgid "Defaults to @samp{\"/var/log/zabbix/agent.log\"}."
42265 #: guix-git/doc/guix.texi:23734
42267 msgid "{@code{zabbix-agent-configuration} parameter} string pid-file"
42271 #: guix-git/doc/guix.texi:23738
42272 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_agent.pid\"}."
42276 #: guix-git/doc/guix.texi:23741
42278 msgid "{@code{zabbix-agent-configuration} parameter} list server"
42282 #: guix-git/doc/guix.texi:23745
42283 msgid "List of IP addresses, optionally in CIDR notation, or hostnames of Zabbix servers and Zabbix proxies. Incoming connections will be accepted only from the hosts listed here."
42287 #: guix-git/doc/guix.texi:23747 guix-git/doc/guix.texi:23756
42288 msgid "Defaults to @samp{(\"127.0.0.1\")}."
42292 #: guix-git/doc/guix.texi:23750
42294 msgid "{@code{zabbix-agent-configuration} parameter} list server-active"
42298 #: guix-git/doc/guix.texi:23754
42299 msgid "List of IP:port (or hostname:port) pairs of Zabbix servers and Zabbix proxies for active checks. If port is not specified, default port is used. If this parameter is not specified, active checks are disabled."
42303 #: guix-git/doc/guix.texi:23759
42305 msgid "{@code{zabbix-agent-configuration} parameter} string extra-options"
42309 #: guix-git/doc/guix.texi:23766
42311 msgid "{@code{zabbix-agent-configuration} parameter} include-files include-files"
42314 #. type: subsubheading
42315 #: guix-git/doc/guix.texi:23776
42317 msgid "Zabbix front-end"
42321 #: guix-git/doc/guix.texi:23777
42323 msgid "zabbix zabbix-front-end"
42326 #. type: Plain text
42327 #: guix-git/doc/guix.texi:23780
42328 msgid "This service provides a WEB interface to Zabbix server."
42331 #. type: Plain text
42332 #: guix-git/doc/guix.texi:23784
42333 msgid "Available @code{zabbix-front-end-configuration} fields are:"
42337 #: guix-git/doc/guix.texi:23785
42339 msgid "{@code{zabbix-front-end-configuration} parameter} nginx-server-configuration-list nginx"
42343 #: guix-git/doc/guix.texi:23787 guix-git/doc/guix.texi:29949
42344 msgid "NGINX configuration."
42348 #: guix-git/doc/guix.texi:23790
42350 msgid "{@code{zabbix-front-end-configuration} parameter} string db-host"
42354 #: guix-git/doc/guix.texi:23797
42356 msgid "{@code{zabbix-front-end-configuration} parameter} number db-port"
42360 #: guix-git/doc/guix.texi:23804
42362 msgid "{@code{zabbix-front-end-configuration} parameter} string db-name"
42366 #: guix-git/doc/guix.texi:23811
42368 msgid "{@code{zabbix-front-end-configuration} parameter} string db-user"
42372 #: guix-git/doc/guix.texi:23818
42374 msgid "{@code{zabbix-front-end-configuration} parameter} string db-password"
42378 #: guix-git/doc/guix.texi:23820
42379 msgid "Database password. Please, use @code{db-secret-file} instead."
42383 #: guix-git/doc/guix.texi:23825
42385 msgid "{@code{zabbix-front-end-configuration} parameter} string db-secret-file"
42389 #: guix-git/doc/guix.texi:23830
42390 msgid "Secret file containing the credentials for the Zabbix front-end. The value must be a local file name, not a G-expression. You are expected to create this file manually. Its contents will be copied into @file{zabbix.conf.php} as the value of @code{$DB['PASSWORD']}."
42394 #: guix-git/doc/guix.texi:23835
42396 msgid "{@code{zabbix-front-end-configuration} parameter} string zabbix-host"
42400 #: guix-git/doc/guix.texi:23837
42401 msgid "Zabbix server hostname."
42405 #: guix-git/doc/guix.texi:23842
42407 msgid "{@code{zabbix-front-end-configuration} parameter} number zabbix-port"
42411 #: guix-git/doc/guix.texi:23844
42412 msgid "Zabbix server port."
42416 #: guix-git/doc/guix.texi:23846
42417 msgid "Defaults to @samp{10051}."
42421 #: guix-git/doc/guix.texi:23854
42426 #. type: Plain text
42427 #: guix-git/doc/guix.texi:23858
42428 msgid "The @code{(gnu services kerberos)} module provides services relating to the authentication protocol @dfn{Kerberos}."
42431 #. type: subsubheading
42432 #: guix-git/doc/guix.texi:23859
42434 msgid "Krb5 Service"
42437 #. type: Plain text
42438 #: guix-git/doc/guix.texi:23866
42439 msgid "Programs using a Kerberos client library normally expect a configuration file in @file{/etc/krb5.conf}. This service generates such a file from a definition provided in the operating system declaration. It does not cause any daemon to be started."
42442 #. type: Plain text
42443 #: guix-git/doc/guix.texi:23870
42444 msgid "No ``keytab'' files are provided by this service---you must explicitly create them. This service is known to work with the MIT client library, @code{mit-krb5}. Other implementations have not been tested."
42448 #: guix-git/doc/guix.texi:23871
42450 msgid "{Scheme Variable} krb5-service-type"
42454 #: guix-git/doc/guix.texi:23873
42455 msgid "A service type for Kerberos 5 clients."
42458 #. type: Plain text
42459 #: guix-git/doc/guix.texi:23877
42460 msgid "Here is an example of its use:"
42464 #: guix-git/doc/guix.texi:23891
42467 "(service krb5-service-type\n"
42468 " (krb5-configuration\n"
42469 " (default-realm \"EXAMPLE.COM\")\n"
42470 " (allow-weak-crypto? #t)\n"
42473 " (name \"EXAMPLE.COM\")\n"
42474 " (admin-server \"groucho.example.com\")\n"
42475 " (kdc \"karl.example.com\"))\n"
42477 " (name \"ARGRX.EDU\")\n"
42478 " (admin-server \"kerb-admin.argrx.edu\")\n"
42479 " (kdc \"keys.argrx.edu\"))))))\n"
42482 #. type: Plain text
42483 #: guix-git/doc/guix.texi:23895
42484 msgid "This example provides a Kerberos@tie{}5 client configuration which:"
42488 #: guix-git/doc/guix.texi:23896
42490 msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both"
42494 #: guix-git/doc/guix.texi:23898
42495 msgid "of which have distinct administration servers and key distribution centers;"
42499 #: guix-git/doc/guix.texi:23898
42501 msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly"
42505 #: guix-git/doc/guix.texi:23900
42506 msgid "specified by clients;"
42510 #: guix-git/doc/guix.texi:23900
42512 msgid "Accepts services which only support encryption types known to be weak."
42515 #. type: Plain text
42516 #: guix-git/doc/guix.texi:23908
42517 msgid "The @code{krb5-realm} and @code{krb5-configuration} types have many fields. Only the most commonly used ones are described here. For a full list, and more detailed explanation of each, see the MIT @uref{https://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} documentation."
42521 #: guix-git/doc/guix.texi:23910
42523 msgid "{Data Type} krb5-realm"
42527 #: guix-git/doc/guix.texi:23911
42529 msgid "realm, kerberos"
42533 #: guix-git/doc/guix.texi:23917
42534 msgid "This field is a string identifying the name of the realm. A common convention is to use the fully qualified DNS name of your organization, converted to upper case."
42538 #: guix-git/doc/guix.texi:23918
42540 msgid "admin-server"
42544 #: guix-git/doc/guix.texi:23921
42545 msgid "This field is a string identifying the host where the administration server is running."
42549 #: guix-git/doc/guix.texi:23922
42555 #: guix-git/doc/guix.texi:23925
42556 msgid "This field is a string identifying the key distribution center for the realm."
42560 #: guix-git/doc/guix.texi:23928
42562 msgid "{Data Type} krb5-configuration"
42566 #: guix-git/doc/guix.texi:23931
42568 msgid "@code{allow-weak-crypto?} (default: @code{#f})"
42572 #: guix-git/doc/guix.texi:23934
42573 msgid "If this flag is @code{#t} then services which only offer encryption algorithms known to be weak will be accepted."
42577 #: guix-git/doc/guix.texi:23935
42579 msgid "@code{default-realm} (default: @code{#f})"
42583 #: guix-git/doc/guix.texi:23942
42584 msgid "This field should be a string identifying the default Kerberos realm for the client. You should set this field to the name of your Kerberos realm. If this value is @code{#f} then a realm must be specified with every Kerberos principal when invoking programs such as @command{kinit}."
42588 #: guix-git/doc/guix.texi:23943
42594 #: guix-git/doc/guix.texi:23948
42595 msgid "This should be a non-empty list of @code{krb5-realm} objects, which clients may access. Normally, one of them will have a @code{name} field matching the @code{default-realm} field."
42598 #. type: subsubheading
42599 #: guix-git/doc/guix.texi:23952
42601 msgid "PAM krb5 Service"
42605 #: guix-git/doc/guix.texi:23953
42610 #. type: Plain text
42611 #: guix-git/doc/guix.texi:23959
42612 msgid "The @code{pam-krb5} service allows for login authentication and password management via Kerberos. You will need this service if you want PAM enabled applications to authenticate users using Kerberos."
42616 #: guix-git/doc/guix.texi:23960
42618 msgid "{Scheme Variable} pam-krb5-service-type"
42622 #: guix-git/doc/guix.texi:23962
42623 msgid "A service type for the Kerberos 5 PAM module."
42627 #: guix-git/doc/guix.texi:23964
42629 msgid "{Data Type} pam-krb5-configuration"
42633 #: guix-git/doc/guix.texi:23967
42634 msgid "Data type representing the configuration of the Kerberos 5 PAM module. This type has the following parameters:"
42638 #: guix-git/doc/guix.texi:23968
42640 msgid "@code{pam-krb5} (default: @code{pam-krb5})"
42644 #: guix-git/doc/guix.texi:23970
42645 msgid "The pam-krb5 package to use."
42649 #: guix-git/doc/guix.texi:23971
42651 msgid "@code{minimum-uid} (default: @code{1000})"
42655 #: guix-git/doc/guix.texi:23974
42656 msgid "The smallest user ID for which Kerberos authentications should be attempted. Local accounts with lower values will silently fail to authenticate."
42660 #: guix-git/doc/guix.texi:23980
42666 #: guix-git/doc/guix.texi:23981
42668 msgid "nslcd, LDAP service"
42671 #. type: Plain text
42672 #: guix-git/doc/guix.texi:23988
42673 msgid "The @code{(gnu services authentication)} module provides the @code{nslcd-service-type}, which can be used to authenticate against an LDAP server. In addition to configuring the service itself, you may want to add @code{ldap} as a name service to the Name Service Switch. @xref{Name Service Switch} for detailed information."
42676 #. type: Plain text
42677 #: guix-git/doc/guix.texi:23992
42678 msgid "Here is a simple operating system declaration with a default configuration of the @code{nslcd-service-type} and a Name Service Switch configuration that consults the @code{ldap} name service last:"
42682 #: guix-git/doc/guix.texi:24015
42685 "(use-service-modules authentication)\n"
42686 "(use-modules (gnu system nss))\n"
42688 "(operating-system\n"
42692 " (service nslcd-service-type)\n"
42693 " (service dhcp-client-service-type)\n"
42694 " %base-services))\n"
42695 " (name-service-switch\n"
42696 " (let ((services (list (name-service (name \"db\"))\n"
42697 " (name-service (name \"files\"))\n"
42698 " (name-service (name \"ldap\")))))\n"
42699 " (name-service-switch\n"
42700 " (inherit %mdns-host-lookup-nss)\n"
42701 " (password services)\n"
42702 " (shadow services)\n"
42703 " (group services)\n"
42704 " (netgroup services)\n"
42705 " (gshadow services)))))\n"
42708 #. type: Plain text
42709 #: guix-git/doc/guix.texi:24020
42710 msgid "Available @code{nslcd-configuration} fields are:"
42714 #: guix-git/doc/guix.texi:24021
42716 msgid "{@code{nslcd-configuration} parameter} package nss-pam-ldapd"
42720 #: guix-git/doc/guix.texi:24023
42721 msgid "The @code{nss-pam-ldapd} package to use."
42725 #: guix-git/doc/guix.texi:24026
42727 msgid "{@code{nslcd-configuration} parameter} maybe-number threads"
42731 #: guix-git/doc/guix.texi:24030
42732 msgid "The number of threads to start that can handle requests and perform LDAP queries. Each thread opens a separate connection to the LDAP server. The default is to start 5 threads."
42736 #: guix-git/doc/guix.texi:24035
42738 msgid "{@code{nslcd-configuration} parameter} string uid"
42742 #: guix-git/doc/guix.texi:24037
42743 msgid "This specifies the user id with which the daemon should be run."
42747 #: guix-git/doc/guix.texi:24039 guix-git/doc/guix.texi:24046
42748 msgid "Defaults to @samp{\"nslcd\"}."
42752 #: guix-git/doc/guix.texi:24042
42754 msgid "{@code{nslcd-configuration} parameter} string gid"
42758 #: guix-git/doc/guix.texi:24044
42759 msgid "This specifies the group id with which the daemon should be run."
42763 #: guix-git/doc/guix.texi:24049
42765 msgid "{@code{nslcd-configuration} parameter} log-option log"
42769 #: guix-git/doc/guix.texi:24057
42770 msgid "This option controls the way logging is done via a list containing SCHEME and LEVEL@. The SCHEME argument may either be the symbols @samp{none} or @samp{syslog}, or an absolute file name. The LEVEL argument is optional and specifies the log level. The log level may be one of the following symbols: @samp{crit}, @samp{error}, @samp{warning}, @samp{notice}, @samp{info} or @samp{debug}. All messages with the specified log level or higher are logged."
42774 #: guix-git/doc/guix.texi:24059
42775 msgid "Defaults to @samp{(\"/var/log/nslcd\" info)}."
42779 #: guix-git/doc/guix.texi:24062
42781 msgid "{@code{nslcd-configuration} parameter} list uri"
42785 #: guix-git/doc/guix.texi:24065
42786 msgid "The list of LDAP server URIs. Normally, only the first server will be used with the following servers as fall-back."
42790 #: guix-git/doc/guix.texi:24067
42791 msgid "Defaults to @samp{(\"ldap://localhost:389/\")}."
42795 #: guix-git/doc/guix.texi:24070
42797 msgid "{@code{nslcd-configuration} parameter} maybe-string ldap-version"
42801 #: guix-git/doc/guix.texi:24073
42802 msgid "The version of the LDAP protocol to use. The default is to use the maximum version supported by the LDAP library."
42806 #: guix-git/doc/guix.texi:24078
42808 msgid "{@code{nslcd-configuration} parameter} maybe-string binddn"
42812 #: guix-git/doc/guix.texi:24081
42813 msgid "Specifies the distinguished name with which to bind to the directory server for lookups. The default is to bind anonymously."
42817 #: guix-git/doc/guix.texi:24086
42819 msgid "{@code{nslcd-configuration} parameter} maybe-string bindpw"
42823 #: guix-git/doc/guix.texi:24089
42824 msgid "Specifies the credentials with which to bind. This option is only applicable when used with binddn."
42828 #: guix-git/doc/guix.texi:24094
42830 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmoddn"
42834 #: guix-git/doc/guix.texi:24097
42835 msgid "Specifies the distinguished name to use when the root user tries to modify a user's password using the PAM module."
42839 #: guix-git/doc/guix.texi:24102
42841 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmodpw"
42845 #: guix-git/doc/guix.texi:24106
42846 msgid "Specifies the credentials with which to bind if the root user tries to change a user's password. This option is only applicable when used with rootpwmoddn"
42850 #: guix-git/doc/guix.texi:24111
42852 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-mech"
42856 #: guix-git/doc/guix.texi:24114
42857 msgid "Specifies the SASL mechanism to be used when performing SASL authentication."
42861 #: guix-git/doc/guix.texi:24119
42863 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-realm"
42867 #: guix-git/doc/guix.texi:24121
42868 msgid "Specifies the SASL realm to be used when performing SASL authentication."
42872 #: guix-git/doc/guix.texi:24126
42874 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authcid"
42878 #: guix-git/doc/guix.texi:24129
42879 msgid "Specifies the authentication identity to be used when performing SASL authentication."
42883 #: guix-git/doc/guix.texi:24134
42885 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authzid"
42889 #: guix-git/doc/guix.texi:24137
42890 msgid "Specifies the authorization identity to be used when performing SASL authentication."
42894 #: guix-git/doc/guix.texi:24142
42896 msgid "{@code{nslcd-configuration} parameter} maybe-boolean sasl-canonicalize?"
42900 #: guix-git/doc/guix.texi:24147
42901 msgid "Determines whether the LDAP server host name should be canonicalised. If this is enabled the LDAP library will do a reverse host name lookup. By default, it is left up to the LDAP library whether this check is performed or not."
42905 #: guix-git/doc/guix.texi:24152
42907 msgid "{@code{nslcd-configuration} parameter} maybe-string krb5-ccname"
42911 #: guix-git/doc/guix.texi:24154
42912 msgid "Set the name for the GSS-API Kerberos credentials cache."
42916 #: guix-git/doc/guix.texi:24159
42918 msgid "{@code{nslcd-configuration} parameter} string base"
42922 #: guix-git/doc/guix.texi:24161
42923 msgid "The directory search base."
42927 #: guix-git/doc/guix.texi:24163
42928 msgid "Defaults to @samp{\"dc=example,dc=com\"}."
42932 #: guix-git/doc/guix.texi:24166
42934 msgid "{@code{nslcd-configuration} parameter} scope-option scope"
42938 #: guix-git/doc/guix.texi:24170
42939 msgid "Specifies the search scope (subtree, onelevel, base or children). The default scope is subtree; base scope is almost never useful for name service lookups; children scope is not supported on all servers."
42943 #: guix-git/doc/guix.texi:24172
42944 msgid "Defaults to @samp{(subtree)}."
42948 #: guix-git/doc/guix.texi:24175
42950 msgid "{@code{nslcd-configuration} parameter} maybe-deref-option deref"
42954 #: guix-git/doc/guix.texi:24178
42955 msgid "Specifies the policy for dereferencing aliases. The default policy is to never dereference aliases."
42959 #: guix-git/doc/guix.texi:24183
42961 msgid "{@code{nslcd-configuration} parameter} maybe-boolean referrals"
42965 #: guix-git/doc/guix.texi:24186
42966 msgid "Specifies whether automatic referral chasing should be enabled. The default behaviour is to chase referrals."
42970 #: guix-git/doc/guix.texi:24191
42972 msgid "{@code{nslcd-configuration} parameter} list-of-map-entries maps"
42976 #: guix-git/doc/guix.texi:24196
42977 msgid "This option allows for custom attributes to be looked up instead of the default RFC 2307 attributes. It is a list of maps, each consisting of the name of a map, the RFC 2307 attribute to match and the query expression for the attribute as it is available in the directory."
42981 #: guix-git/doc/guix.texi:24201
42983 msgid "{@code{nslcd-configuration} parameter} list-of-filter-entries filters"
42987 #: guix-git/doc/guix.texi:24204
42988 msgid "A list of filters consisting of the name of a map to which the filter applies and an LDAP search filter expression."
42992 #: guix-git/doc/guix.texi:24209
42994 msgid "{@code{nslcd-configuration} parameter} maybe-number bind-timelimit"
42998 #: guix-git/doc/guix.texi:24212
42999 msgid "Specifies the time limit in seconds to use when connecting to the directory server. The default value is 10 seconds."
43003 #: guix-git/doc/guix.texi:24217
43005 msgid "{@code{nslcd-configuration} parameter} maybe-number timelimit"
43009 #: guix-git/doc/guix.texi:24221
43010 msgid "Specifies the time limit (in seconds) to wait for a response from the LDAP server. A value of zero, which is the default, is to wait indefinitely for searches to be completed."
43014 #: guix-git/doc/guix.texi:24226
43016 msgid "{@code{nslcd-configuration} parameter} maybe-number idle-timelimit"
43020 #: guix-git/doc/guix.texi:24230
43021 msgid "Specifies the period if inactivity (in seconds) after which the con‐ nection to the LDAP server will be closed. The default is not to time out connections."
43025 #: guix-git/doc/guix.texi:24235
43027 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-sleeptime"
43031 #: guix-git/doc/guix.texi:24239
43032 msgid "Specifies the number of seconds to sleep when connecting to all LDAP servers fails. By default one second is waited between the first failure and the first retry."
43036 #: guix-git/doc/guix.texi:24244
43038 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-retrytime"
43042 #: guix-git/doc/guix.texi:24248
43043 msgid "Specifies the time after which the LDAP server is considered to be permanently unavailable. Once this time is reached retries will be done only once per this time period. The default value is 10 seconds."
43047 #: guix-git/doc/guix.texi:24253
43049 msgid "{@code{nslcd-configuration} parameter} maybe-ssl-option ssl"
43053 #: guix-git/doc/guix.texi:24257
43054 msgid "Specifies whether to use SSL/TLS or not (the default is not to). If 'start-tls is specified then StartTLS is used rather than raw LDAP over SSL."
43058 #: guix-git/doc/guix.texi:24262
43060 msgid "{@code{nslcd-configuration} parameter} maybe-tls-reqcert-option tls-reqcert"
43064 #: guix-git/doc/guix.texi:24265
43065 msgid "Specifies what checks to perform on a server-supplied certificate. The meaning of the values is described in the ldap.conf(5) manual page."
43069 #: guix-git/doc/guix.texi:24270
43071 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertdir"
43075 #: guix-git/doc/guix.texi:24273
43076 msgid "Specifies the directory containing X.509 certificates for peer authen‐ tication. This parameter is ignored when using GnuTLS."
43080 #: guix-git/doc/guix.texi:24278
43082 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertfile"
43086 #: guix-git/doc/guix.texi:24280
43087 msgid "Specifies the path to the X.509 certificate for peer authentication."
43091 #: guix-git/doc/guix.texi:24285
43093 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-randfile"
43097 #: guix-git/doc/guix.texi:24288
43098 msgid "Specifies the path to an entropy source. This parameter is ignored when using GnuTLS."
43102 #: guix-git/doc/guix.texi:24293
43104 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-ciphers"
43108 #: guix-git/doc/guix.texi:24295
43109 msgid "Specifies the ciphers to use for TLS as a string."
43113 #: guix-git/doc/guix.texi:24300
43115 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cert"
43119 #: guix-git/doc/guix.texi:24303
43120 msgid "Specifies the path to the file containing the local certificate for client TLS authentication."
43124 #: guix-git/doc/guix.texi:24308
43126 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-key"
43130 #: guix-git/doc/guix.texi:24311
43131 msgid "Specifies the path to the file containing the private key for client TLS authentication."
43135 #: guix-git/doc/guix.texi:24316
43137 msgid "{@code{nslcd-configuration} parameter} maybe-number pagesize"
43141 #: guix-git/doc/guix.texi:24320
43142 msgid "Set this to a number greater than 0 to request paged results from the LDAP server in accordance with RFC2696. The default (0) is to not request paged results."
43146 #: guix-git/doc/guix.texi:24325
43148 msgid "{@code{nslcd-configuration} parameter} maybe-ignore-users-option nss-initgroups-ignoreusers"
43152 #: guix-git/doc/guix.texi:24329
43153 msgid "This option prevents group membership lookups through LDAP for the specified users. Alternatively, the value 'all-local may be used. With that value nslcd builds a full list of non-LDAP users on startup."
43157 #: guix-git/doc/guix.texi:24334
43159 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-min-uid"
43163 #: guix-git/doc/guix.texi:24337
43164 msgid "This option ensures that LDAP users with a numeric user id lower than the specified value are ignored."
43168 #: guix-git/doc/guix.texi:24342
43170 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-uid-offset"
43174 #: guix-git/doc/guix.texi:24345
43175 msgid "This option specifies an offset that is added to all LDAP numeric user ids. This can be used to avoid user id collisions with local users."
43179 #: guix-git/doc/guix.texi:24350
43181 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-gid-offset"
43185 #: guix-git/doc/guix.texi:24353
43186 msgid "This option specifies an offset that is added to all LDAP numeric group ids. This can be used to avoid user id collisions with local groups."
43190 #: guix-git/doc/guix.texi:24358
43192 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-nested-groups"
43196 #: guix-git/doc/guix.texi:24364
43197 msgid "If this option is set, the member attribute of a group may point to another group. Members of nested groups are also returned in the higher level group and parent groups are returned when finding groups for a specific user. The default is not to perform extra searches for nested groups."
43201 #: guix-git/doc/guix.texi:24369
43203 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-getgrent-skipmembers"
43207 #: guix-git/doc/guix.texi:24374
43208 msgid "If this option is set, the group member list is not retrieved when looking up groups. Lookups for finding which groups a user belongs to will remain functional so the user will likely still get the correct groups assigned on login."
43212 #: guix-git/doc/guix.texi:24379
43214 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-disable-enumeration"
43218 #: guix-git/doc/guix.texi:24385
43219 msgid "If this option is set, functions which cause all user/group entries to be loaded from the directory will not succeed in doing so. This can dramatically reduce LDAP server load in situations where there are a great number of users and/or groups. This option is not recommended for most configurations."
43223 #: guix-git/doc/guix.texi:24390
43225 msgid "{@code{nslcd-configuration} parameter} maybe-string validnames"
43229 #: guix-git/doc/guix.texi:24394
43230 msgid "This option can be used to specify how user and group names are verified within the system. This pattern is used to check all user and group names that are requested and returned from LDAP."
43234 #: guix-git/doc/guix.texi:24399
43236 msgid "{@code{nslcd-configuration} parameter} maybe-boolean ignorecase"
43240 #: guix-git/doc/guix.texi:24404
43241 msgid "This specifies whether or not to perform searches using case-insensitive matching. Enabling this could open up the system to authorization bypass vulnerabilities and introduce nscd cache poisoning vulnerabilities which allow denial of service."
43245 #: guix-git/doc/guix.texi:24409
43247 msgid "{@code{nslcd-configuration} parameter} maybe-boolean pam-authc-ppolicy"
43251 #: guix-git/doc/guix.texi:24412
43252 msgid "This option specifies whether password policy controls are requested and handled from the LDAP server when performing user authentication."
43256 #: guix-git/doc/guix.texi:24417
43258 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authc-search"
43262 #: guix-git/doc/guix.texi:24423
43263 msgid "By default nslcd performs an LDAP search with the user's credentials after BIND (authentication) to ensure that the BIND operation was successful. The default search is a simple check to see if the user's DN exists. A search filter can be specified that will be used instead. It should return at least one entry."
43267 #: guix-git/doc/guix.texi:24428
43269 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authz-search"
43273 #: guix-git/doc/guix.texi:24432
43274 msgid "This option allows flexible fine tuning of the authorisation check that should be performed. The search filter specified is executed and if any entries match, access is granted, otherwise access is denied."
43278 #: guix-git/doc/guix.texi:24437
43280 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-password-prohibit-message"
43284 #: guix-git/doc/guix.texi:24442
43285 msgid "If this option is set password modification using pam_ldap will be denied and the specified message will be presented to the user instead. The message can be used to direct the user to an alternative means of changing their password."
43289 #: guix-git/doc/guix.texi:24447
43291 msgid "{@code{nslcd-configuration} parameter} list pam-services"
43295 #: guix-git/doc/guix.texi:24449
43296 msgid "List of pam service names for which LDAP authentication should suffice."
43300 #: guix-git/doc/guix.texi:24460
43306 #: guix-git/doc/guix.texi:24461
43312 #: guix-git/doc/guix.texi:24462
43317 #. type: Plain text
43318 #: guix-git/doc/guix.texi:24465
43319 msgid "The @code{(gnu services web)} module provides the Apache HTTP Server, the nginx web server, and also a fastcgi wrapper daemon."
43322 #. type: subsubheading
43323 #: guix-git/doc/guix.texi:24466
43325 msgid "Apache HTTP Server"
43329 #: guix-git/doc/guix.texi:24468
43331 msgid "{Scheme Variable} httpd-service-type"
43335 #: guix-git/doc/guix.texi:24472
43336 msgid "Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server (@dfn{httpd}). The value for this service type is a @code{httpd-configuration} record."
43340 #: guix-git/doc/guix.texi:24474 guix-git/doc/guix.texi:24655
43341 msgid "A simple example configuration is given below."
43345 #: guix-git/doc/guix.texi:24482
43348 "(service httpd-service-type\n"
43349 " (httpd-configuration\n"
43351 " (httpd-config-file\n"
43352 " (server-name \"www.example.com\")\n"
43353 " (document-root \"/srv/http/www.example.com\")))))\n"
43357 #: guix-git/doc/guix.texi:24486
43358 msgid "Other services can also extend the @code{httpd-service-type} to add to the configuration."
43362 #: guix-git/doc/guix.texi:24495 guix-git/doc/guix.texi:24635
43365 "(simple-service 'www.example.com-server httpd-service-type\n"
43367 " (httpd-virtualhost\n"
43369 " (list (string-join '(\"ServerName www.example.com\"\n"
43370 " \"DocumentRoot /srv/http/www.example.com\")\n"
43374 #. type: Plain text
43375 #: guix-git/doc/guix.texi:24501
43376 msgid "The details for the @code{httpd-configuration}, @code{httpd-module}, @code{httpd-config-file} and @code{httpd-virtualhost} record types are given below."
43380 #: guix-git/doc/guix.texi:24502
43382 msgid "{Data Type} httpd-configuration"
43386 #: guix-git/doc/guix.texi:24504
43387 msgid "This data type represents the configuration for the httpd service."
43391 #: guix-git/doc/guix.texi:24506
43393 msgid "@code{package} (default: @code{httpd})"
43397 #: guix-git/doc/guix.texi:24508
43398 msgid "The httpd package to use."
43402 #: guix-git/doc/guix.texi:24509 guix-git/doc/guix.texi:24598
43404 msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})"
43408 #: guix-git/doc/guix.texi:24511
43409 msgid "The pid file used by the shepherd-service."
43413 #: guix-git/doc/guix.texi:24512
43415 msgid "@code{config} (default: @code{(httpd-config-file)})"
43419 #: guix-git/doc/guix.texi:24517
43420 msgid "The configuration file to use with the httpd service. The default value is a @code{httpd-config-file} record, but this can also be a different G-expression that generates a file, for example a @code{plain-file}. A file outside of the store can also be specified through a string."
43424 #: guix-git/doc/guix.texi:24521
43426 msgid "{Data Type} httpd-module"
43430 #: guix-git/doc/guix.texi:24523
43431 msgid "This data type represents a module for the httpd service."
43435 #: guix-git/doc/guix.texi:24527
43436 msgid "The name of the module."
43440 #: guix-git/doc/guix.texi:24533
43441 msgid "The file for the module. This can be relative to the httpd package being used, the absolute location of a file, or a G-expression for a file within the store, for example @code{(file-append mod-wsgi \"/modules/mod_wsgi.so\")}."
43445 #: guix-git/doc/guix.texi:24537
43447 msgid "{Scheme Variable} %default-httpd-modules"
43451 #: guix-git/doc/guix.texi:24539
43452 msgid "A default list of @code{httpd-module} objects."
43456 #: guix-git/doc/guix.texi:24541
43458 msgid "{Data Type} httpd-config-file"
43462 #: guix-git/doc/guix.texi:24543
43463 msgid "This data type represents a configuration file for the httpd service."
43467 #: guix-git/doc/guix.texi:24545
43469 msgid "@code{modules} (default: @code{%default-httpd-modules})"
43473 #: guix-git/doc/guix.texi:24548
43474 msgid "The modules to load. Additional modules can be added here, or loaded by additional configuration."
43478 #: guix-git/doc/guix.texi:24551
43479 msgid "For example, in order to handle requests for PHP files, you can use Apache’s @code{mod_proxy_fcgi} module along with @code{php-fpm-service-type}:"
43483 #: guix-git/doc/guix.texi:24573
43486 "(service httpd-service-type\n"
43487 " (httpd-configuration\n"
43489 " (httpd-config-file\n"
43490 " (modules (cons*\n"
43492 " (name \"proxy_module\")\n"
43493 " (file \"modules/mod_proxy.so\"))\n"
43495 " (name \"proxy_fcgi_module\")\n"
43496 " (file \"modules/mod_proxy_fcgi.so\"))\n"
43497 " %default-httpd-modules))\n"
43498 " (extra-config (list \"\\\n"
43499 "<FilesMatch \\\\.php$>\n"
43500 " SetHandler \\\"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\\\"\n"
43501 "</FilesMatch>\"))))))\n"
43502 "(service php-fpm-service-type\n"
43503 " (php-fpm-configuration\n"
43504 " (socket \"/var/run/php-fpm.sock\")\n"
43505 " (socket-group \"httpd\")))\n"
43509 #: guix-git/doc/guix.texi:24575
43511 msgid "@code{server-root} (default: @code{httpd})"
43515 #: guix-git/doc/guix.texi:24579
43516 msgid "The @code{ServerRoot} in the configuration file, defaults to the httpd package. Directives including @code{Include} and @code{LoadModule} are taken as relative to the server root."
43520 #: guix-git/doc/guix.texi:24580
43522 msgid "@code{server-name} (default: @code{#f})"
43526 #: guix-git/doc/guix.texi:24584
43527 msgid "The @code{ServerName} in the configuration file, used to specify the request scheme, hostname and port that the server uses to identify itself."
43531 #: guix-git/doc/guix.texi:24588
43532 msgid "This doesn't need to be set in the server config, and can be specified in virtual hosts. The default is @code{#f} to not specify a @code{ServerName}."
43536 #: guix-git/doc/guix.texi:24589
43538 msgid "@code{document-root} (default: @code{\"/srv/http\"})"
43542 #: guix-git/doc/guix.texi:24591
43543 msgid "The @code{DocumentRoot} from which files will be served."
43547 #: guix-git/doc/guix.texi:24592
43549 msgid "@code{listen} (default: @code{'(\"80\")})"
43553 #: guix-git/doc/guix.texi:24597
43554 msgid "The list of values for the @code{Listen} directives in the config file. The value should be a list of strings, when each string can specify the port number to listen on, and optionally the IP address and protocol to use."
43558 #: guix-git/doc/guix.texi:24602
43559 msgid "The @code{PidFile} to use. This should match the @code{pid-file} set in the @code{httpd-configuration} so that the Shepherd service is configured correctly."
43563 #: guix-git/doc/guix.texi:24603
43565 msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})"
43569 #: guix-git/doc/guix.texi:24605
43570 msgid "The @code{ErrorLog} to which the server will log errors."
43574 #: guix-git/doc/guix.texi:24606 guix-git/doc/guix.texi:25167
43576 msgid "@code{user} (default: @code{\"httpd\"})"
43580 #: guix-git/doc/guix.texi:24608
43581 msgid "The @code{User} which the server will answer requests as."
43585 #: guix-git/doc/guix.texi:24609
43587 msgid "@code{group} (default: @code{\"httpd\"})"
43591 #: guix-git/doc/guix.texi:24611
43592 msgid "The @code{Group} which the server will answer requests as."
43596 #: guix-git/doc/guix.texi:24612
43598 msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})"
43602 #: guix-git/doc/guix.texi:24615
43603 msgid "A flat list of strings and G-expressions which will be added to the end of the configuration file."
43607 #: guix-git/doc/guix.texi:24618
43608 msgid "Any values which the service is extended with will be appended to this list."
43612 #: guix-git/doc/guix.texi:24622
43614 msgid "{Data Type} httpd-virtualhost"
43618 #: guix-git/doc/guix.texi:24624
43619 msgid "This data type represents a virtualhost configuration block for the httpd service."
43623 #: guix-git/doc/guix.texi:24626
43624 msgid "These should be added to the extra-config for the httpd-service."
43628 #: guix-git/doc/guix.texi:24638
43630 msgid "addresses-and-ports"
43634 #: guix-git/doc/guix.texi:24640
43635 msgid "The addresses and ports for the @code{VirtualHost} directive."
43639 #: guix-git/doc/guix.texi:24641
43645 #: guix-git/doc/guix.texi:24644
43646 msgid "The contents of the @code{VirtualHost} directive, this should be a list of strings and G-expressions."
43649 #. type: subsubheading
43650 #: guix-git/doc/guix.texi:24648
43656 #: guix-git/doc/guix.texi:24650
43658 msgid "{Scheme Variable} nginx-service-type"
43662 #: guix-git/doc/guix.texi:24653
43663 msgid "Service type for the @uref{https://nginx.org/,NGinx} web server. The value for this service type is a @code{<nginx-configuration>} record."
43667 #: guix-git/doc/guix.texi:24663 guix-git/doc/guix.texi:24717
43670 "(service nginx-service-type\n"
43671 " (nginx-configuration\n"
43672 " (server-blocks\n"
43673 " (list (nginx-server-configuration\n"
43674 " (server-name '(\"www.example.com\"))\n"
43675 " (root \"/srv/http/www.example.com\"))))))\n"
43679 #: guix-git/doc/guix.texi:24668
43680 msgid "In addition to adding server blocks to the service configuration directly, this service can be extended by other services to add server blocks, as in this example:"
43684 #: guix-git/doc/guix.texi:24674
43687 "(simple-service 'my-extra-server nginx-service-type\n"
43688 " (list (nginx-server-configuration\n"
43689 " (root \"/srv/http/extra-website\")\n"
43690 " (try-files (list \"$uri\" \"$uri/index.html\")))))\n"
43693 #. type: Plain text
43694 #: guix-git/doc/guix.texi:24685
43695 msgid "At startup, @command{nginx} has not yet read its configuration file, so it uses a default file to log error messages. If it fails to load its configuration file, that is where error messages are logged. After the configuration file is loaded, the default error log file changes as per configuration. In our case, startup error messages can be found in @file{/var/run/nginx/logs/error.log}, and after configuration in @file{/var/log/nginx/error.log}. The second location can be changed with the @var{log-directory} configuration option."
43699 #: guix-git/doc/guix.texi:24686
43701 msgid "{Data Type} nginx-configuration"
43705 #: guix-git/doc/guix.texi:24690
43706 msgid "This data type represents the configuration for NGinx. Some configuration can be done through this and the other provided record types, or alternatively, a config file can be provided."
43710 #: guix-git/doc/guix.texi:24692
43712 msgid "@code{nginx} (default: @code{nginx})"
43716 #: guix-git/doc/guix.texi:24694
43717 msgid "The nginx package to use."
43721 #: guix-git/doc/guix.texi:24695
43723 msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})"
43727 #: guix-git/doc/guix.texi:24697
43728 msgid "The directory to which NGinx will write log files."
43732 #: guix-git/doc/guix.texi:24698
43734 msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})"
43738 #: guix-git/doc/guix.texi:24701
43739 msgid "The directory in which NGinx will create a pid file, and write temporary files."
43743 #: guix-git/doc/guix.texi:24702
43745 msgid "@code{server-blocks} (default: @code{'()})"
43749 #: guix-git/doc/guix.texi:24706
43750 msgid "A list of @dfn{server blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-server-configuration>}."
43754 #: guix-git/doc/guix.texi:24710
43755 msgid "The following example would setup NGinx to serve @code{www.example.com} from the @code{/srv/http/www.example.com} directory, without using HTTPS."
43759 #: guix-git/doc/guix.texi:24719
43761 msgid "@code{upstream-blocks} (default: @code{'()})"
43765 #: guix-git/doc/guix.texi:24723
43766 msgid "A list of @dfn{upstream blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-upstream-configuration>}."
43770 #: guix-git/doc/guix.texi:24730
43771 msgid "Configuring upstreams through the @code{upstream-blocks} can be useful when combined with @code{locations} in the @code{<nginx-server-configuration>} records. The following example creates a server configuration with one location configuration, that will proxy requests to a upstream configuration, which will handle requests with two servers."
43775 #: guix-git/doc/guix.texi:24749
43779 " nginx-service-type\n"
43780 " (nginx-configuration\n"
43781 " (server-blocks\n"
43782 " (list (nginx-server-configuration\n"
43783 " (server-name '(\"www.example.com\"))\n"
43784 " (root \"/srv/http/www.example.com\")\n"
43787 " (nginx-location-configuration\n"
43788 " (uri \"/path1\")\n"
43789 " (body '(\"proxy_pass http://server-proxy;\"))))))))\n"
43790 " (upstream-blocks\n"
43791 " (list (nginx-upstream-configuration\n"
43792 " (name \"server-proxy\")\n"
43793 " (servers (list \"server1.example.com\"\n"
43794 " \"server2.example.com\")))))))\n"
43798 #: guix-git/doc/guix.texi:24757
43799 msgid "If a configuration @var{file} is provided, this will be used, rather than generating a configuration file from the provided @code{log-directory}, @code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For proper operation, these arguments should match what is in @var{file} to ensure that the directories are created when the service is activated."
43803 #: guix-git/doc/guix.texi:24761
43804 msgid "This can be useful if you have an existing configuration file, or it's not possible to do what is required through the other parts of the nginx-configuration record."
43808 #: guix-git/doc/guix.texi:24762
43810 msgid "@code{server-names-hash-bucket-size} (default: @code{#f})"
43814 #: guix-git/doc/guix.texi:24765
43815 msgid "Bucket size for the server names hash tables, defaults to @code{#f} to use the size of the processors cache line."
43819 #: guix-git/doc/guix.texi:24766
43821 msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})"
43825 #: guix-git/doc/guix.texi:24768
43826 msgid "Maximum bucket size for the server names hash tables."
43830 #: guix-git/doc/guix.texi:24772
43831 msgid "List of nginx dynamic modules to load. This should be a list of file names of loadable modules, as in this example:"
43835 #: guix-git/doc/guix.texi:24780
43840 " (file-append nginx-accept-language-module \"\\\n"
43841 "/etc/nginx/modules/ngx_http_accept_language_module.so\")\n"
43842 " (file-append nginx-lua-module \"\\\n"
43843 "/etc/nginx/modules/ngx_http_lua_module.so\")))\n"
43847 #: guix-git/doc/guix.texi:24782
43849 msgid "@code{lua-package-path} (default: @code{'()})"
43853 #: guix-git/doc/guix.texi:24785
43854 msgid "List of nginx lua packages to load. This should be a list of package names of loadable lua modules, as in this example:"
43858 #: guix-git/doc/guix.texi:24792
43861 "(lua-package-path (list lua-resty-core\n"
43862 " lua-resty-lrucache\n"
43863 " lua-resty-signal\n"
43865 " lua-resty-shell))\n"
43869 #: guix-git/doc/guix.texi:24794
43871 msgid "@code{lua-package-cpath} (default: @code{'()})"
43875 #: guix-git/doc/guix.texi:24797
43876 msgid "List of nginx lua C packages to load. This should be a list of package names of loadable lua C modules, as in this example:"
43880 #: guix-git/doc/guix.texi:24800
43882 msgid "(lua-package-cpath (list lua-resty-signal))\n"
43886 #: guix-git/doc/guix.texi:24802
43888 msgid "@code{global-directives} (default: @code{'((events . ()))})"
43892 #: guix-git/doc/guix.texi:24805
43893 msgid "Association list of global directives for the top level of the nginx configuration. Values may themselves be association lists."
43897 #: guix-git/doc/guix.texi:24811
43900 "(global-directives\n"
43901 " `((worker_processes . 16)\n"
43902 " (pcre_jit . on)\n"
43903 " (events . ((worker_connections . 1024)))))\n"
43907 #: guix-git/doc/guix.texi:24816
43908 msgid "Extra content for the @code{http} block. Should be string or a string valued G-expression."
43912 #: guix-git/doc/guix.texi:24820
43914 msgid "{Data Type} nginx-server-configuration"
43918 #: guix-git/doc/guix.texi:24823
43919 msgid "Data type representing the configuration of an nginx server block. This type has the following parameters:"
43923 #: guix-git/doc/guix.texi:24825
43925 msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})"
43929 #: guix-git/doc/guix.texi:24830
43930 msgid "Each @code{listen} directive sets the address and port for IP, or the path for a UNIX-domain socket on which the server will accept requests. Both address and port, or only address or only port can be specified. An address may also be a hostname, for example:"
43934 #: guix-git/doc/guix.texi:24833
43936 msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n"
43940 #: guix-git/doc/guix.texi:24835
43942 msgid "@code{server-name} (default: @code{(list 'default)})"
43946 #: guix-git/doc/guix.texi:24838
43947 msgid "A list of server names this server represents. @code{'default} represents the default server for connections matching no other server."
43951 #: guix-git/doc/guix.texi:24839
43953 msgid "@code{root} (default: @code{\"/srv/http\"})"
43957 #: guix-git/doc/guix.texi:24841
43958 msgid "Root of the website nginx will serve."
43962 #: guix-git/doc/guix.texi:24842
43964 msgid "@code{locations} (default: @code{'()})"
43968 #: guix-git/doc/guix.texi:24846
43969 msgid "A list of @dfn{nginx-location-configuration} or @dfn{nginx-named-location-configuration} records to use within this server block."
43973 #: guix-git/doc/guix.texi:24847
43975 msgid "@code{index} (default: @code{(list \"index.html\")})"
43979 #: guix-git/doc/guix.texi:24850
43980 msgid "Index files to look for when clients ask for a directory. If it cannot be found, Nginx will send the list of files in the directory."
43984 #: guix-git/doc/guix.texi:24851
43986 msgid "@code{try-files} (default: @code{'()})"
43990 #: guix-git/doc/guix.texi:24854
43991 msgid "A list of files whose existence is checked in the specified order. @code{nginx} will use the first file it finds to process the request."
43995 #: guix-git/doc/guix.texi:24855
43997 msgid "@code{ssl-certificate} (default: @code{#f})"
44001 #: guix-git/doc/guix.texi:24858
44002 msgid "Where to find the certificate for secure connections. Set it to @code{#f} if you don't have a certificate or you don't want to use HTTPS."
44006 #: guix-git/doc/guix.texi:24859
44008 msgid "@code{ssl-certificate-key} (default: @code{#f})"
44012 #: guix-git/doc/guix.texi:24862
44013 msgid "Where to find the private key for secure connections. Set it to @code{#f} if you don't have a key or you don't want to use HTTPS."
44017 #: guix-git/doc/guix.texi:24863
44019 msgid "@code{server-tokens?} (default: @code{#f})"
44023 #: guix-git/doc/guix.texi:24865
44024 msgid "Whether the server should add its configuration to response."
44028 #: guix-git/doc/guix.texi:24866
44030 msgid "@code{raw-content} (default: @code{'()})"
44034 #: guix-git/doc/guix.texi:24868
44035 msgid "A list of raw lines added to the server block."
44039 #: guix-git/doc/guix.texi:24872
44041 msgid "{Data Type} nginx-upstream-configuration"
44045 #: guix-git/doc/guix.texi:24875
44046 msgid "Data type representing the configuration of an nginx @code{upstream} block. This type has the following parameters:"
44050 #: guix-git/doc/guix.texi:24879
44051 msgid "Name for this group of servers."
44055 #: guix-git/doc/guix.texi:24880
44061 #: guix-git/doc/guix.texi:24887
44062 msgid "Specify the addresses of the servers in the group. The address can be specified as a IP address (e.g.@: @samp{127.0.0.1}), domain name (e.g.@: @samp{backend1.example.com}) or a path to a UNIX socket using the prefix @samp{unix:}. For addresses using an IP address or domain name, the default port is 80, and a different port can be specified explicitly."
44066 #: guix-git/doc/guix.texi:24891
44068 msgid "{Data Type} nginx-location-configuration"
44072 #: guix-git/doc/guix.texi:24894
44073 msgid "Data type representing the configuration of an nginx @code{location} block. This type has the following parameters:"
44077 #: guix-git/doc/guix.texi:24898
44078 msgid "URI which this location block matches."
44081 #. type: anchor{#1}
44082 #: guix-git/doc/guix.texi:24900
44083 msgid "nginx-location-configuration body"
44087 #: guix-git/doc/guix.texi:24900 guix-git/doc/guix.texi:24921
44093 #: guix-git/doc/guix.texi:24907
44094 msgid "Body of the location block, specified as a list of strings. This can contain many configuration directives. For example, to pass requests to a upstream server group defined using an @code{nginx-upstream-configuration} block, the following directive would be specified in the body @samp{(list \"proxy_pass http://upstream-name;\")}."
44098 #: guix-git/doc/guix.texi:24911
44100 msgid "{Data Type} nginx-named-location-configuration"
44104 #: guix-git/doc/guix.texi:24916
44105 msgid "Data type representing the configuration of an nginx named location block. Named location blocks are used for request redirection, and not used for regular request processing. This type has the following parameters:"
44109 #: guix-git/doc/guix.texi:24920
44110 msgid "Name to identify this location block."
44114 #: guix-git/doc/guix.texi:24926
44115 msgid "@xref{nginx-location-configuration body}, as the body for named location blocks can be used in a similar way to the @code{nginx-location-configuration body}. One restriction is that the body of a named location block cannot contain location blocks."
44118 #. type: subsubheading
44119 #: guix-git/doc/guix.texi:24930
44121 msgid "Varnish Cache"
44125 #: guix-git/doc/guix.texi:24931
44130 #. type: Plain text
44131 #: guix-git/doc/guix.texi:24936
44132 msgid "Varnish is a fast cache server that sits in between web applications and end users. It proxies requests from clients and caches the accessed URLs such that multiple requests for the same resource only creates one request to the back-end."
44136 #: guix-git/doc/guix.texi:24937
44138 msgid "{Scheme Variable} varnish-service-type"
44142 #: guix-git/doc/guix.texi:24939
44143 msgid "Service type for the Varnish daemon."
44147 #: guix-git/doc/guix.texi:24941
44149 msgid "{Data Type} varnish-configuration"
44153 #: guix-git/doc/guix.texi:24944
44154 msgid "Data type representing the @code{varnish} service configuration. This type has the following parameters:"
44158 #: guix-git/doc/guix.texi:24946
44160 msgid "@code{package} (default: @code{varnish})"
44164 #: guix-git/doc/guix.texi:24948
44165 msgid "The Varnish package to use."
44169 #: guix-git/doc/guix.texi:24949
44171 msgid "@code{name} (default: @code{\"default\"})"
44175 #: guix-git/doc/guix.texi:24954
44176 msgid "A name for this Varnish instance. Varnish will create a directory in @file{/var/varnish/} with this name and keep temporary files there. If the name starts with a forward slash, it is interpreted as an absolute directory name."
44180 #: guix-git/doc/guix.texi:24957
44181 msgid "Pass the @code{-n} argument to other Varnish programs to connect to the named instance, e.g.@: @command{varnishncsa -n default}."
44185 #: guix-git/doc/guix.texi:24958
44187 msgid "@code{backend} (default: @code{\"localhost:8080\"})"
44191 #: guix-git/doc/guix.texi:24960
44192 msgid "The backend to use. This option has no effect if @code{vcl} is set."
44196 #: guix-git/doc/guix.texi:24961
44198 msgid "@code{vcl} (default: #f)"
44202 #: guix-git/doc/guix.texi:24966
44203 msgid "The @dfn{VCL} (Varnish Configuration Language) program to run. If this is @code{#f}, Varnish will proxy @code{backend} using the default configuration. Otherwise this must be a file-like object with valid VCL syntax."
44207 #: guix-git/doc/guix.texi:24970
44208 msgid "For example, to mirror @url{https://www.gnu.org,www.gnu.org} with VCL you can do something along these lines:"
44212 #: guix-git/doc/guix.texi:24976
44215 "(define %gnu-mirror\n"
44216 " (plain-file \"gnu.vcl\"\n"
44218 "backend gnu @{ .host = \\\"www.gnu.org\\\"; @}\"))\n"
44223 #: guix-git/doc/guix.texi:24984
44226 "(operating-system\n"
44228 " (services (cons (service varnish-service-type\n"
44229 " (varnish-configuration\n"
44230 " (listen '(\":80\"))\n"
44231 " (vcl %gnu-mirror)))\n"
44232 " %base-services)))\n"
44236 #: guix-git/doc/guix.texi:24988
44237 msgid "The configuration of an already running Varnish instance can be inspected and changed using the @command{varnishadm} program."
44241 #: guix-git/doc/guix.texi:24992
44242 msgid "Consult the @url{https://varnish-cache.org/docs/,Varnish User Guide} and @url{https://book.varnish-software.com/4.0/,Varnish Book} for comprehensive documentation on Varnish and its configuration language."
44246 #: guix-git/doc/guix.texi:24993
44248 msgid "@code{listen} (default: @code{'(\"localhost:80\")})"
44252 #: guix-git/doc/guix.texi:24995
44253 msgid "List of addresses Varnish will listen on."
44257 #: guix-git/doc/guix.texi:24996
44259 msgid "@code{storage} (default: @code{'(\"malloc,128m\")})"
44263 #: guix-git/doc/guix.texi:24998
44264 msgid "List of storage backends that will be available in VCL."
44268 #: guix-git/doc/guix.texi:24999
44270 msgid "@code{parameters} (default: @code{'()})"
44274 #: guix-git/doc/guix.texi:25001
44275 msgid "List of run-time parameters in the form @code{'((\"parameter\" . \"value\"))}."
44279 #: guix-git/doc/guix.texi:25004
44280 msgid "Additional arguments to pass to the @command{varnishd} process."
44284 #: guix-git/doc/guix.texi:25008 guix-git/doc/guix.texi:25009
44289 #. type: Plain text
44290 #: guix-git/doc/guix.texi:25012
44291 msgid "Patchwork is a patch tracking system. It can collect patches sent to a mailing list, and display them in a web interface."
44295 #: guix-git/doc/guix.texi:25013
44297 msgid "{Scheme Variable} patchwork-service-type"
44301 #: guix-git/doc/guix.texi:25015
44302 msgid "Service type for Patchwork."
44305 #. type: Plain text
44306 #: guix-git/doc/guix.texi:25019
44307 msgid "The following example is an example of a minimal service for Patchwork, for the @code{patchwork.example.com} domain."
44311 #: guix-git/doc/guix.texi:25039
44314 "(service patchwork-service-type\n"
44315 " (patchwork-configuration\n"
44316 " (domain \"patchwork.example.com\")\n"
44317 " (settings-module\n"
44318 " (patchwork-settings-module\n"
44319 " (allowed-hosts (list domain))\n"
44320 " (default-from-email \"patchwork@@patchwork.example.com\")))\n"
44321 " (getmail-retriever-config\n"
44322 " (getmail-retriever-configuration\n"
44323 " (type \"SimpleIMAPSSLRetriever\")\n"
44324 " (server \"imap.example.com\")\n"
44326 " (username \"patchwork\")\n"
44327 " (password-command\n"
44328 " (list (file-append coreutils \"/bin/cat\")\n"
44329 " \"/etc/getmail-patchwork-imap-password\"))\n"
44330 " (extra-parameters\n"
44331 " '((mailboxes . (\"Patches\"))))))))\n"
44335 #. type: Plain text
44336 #: guix-git/doc/guix.texi:25045
44337 msgid "There are three records for configuring the Patchwork service. The @code{<patchwork-configuration>} relates to the configuration for Patchwork within the HTTPD service."
44340 #. type: Plain text
44341 #: guix-git/doc/guix.texi:25049
44342 msgid "The @code{settings-module} field within the @code{<patchwork-configuration>} record can be populated with the @code{<patchwork-settings-module>} record, which describes a settings module that is generated within the Guix store."
44345 #. type: Plain text
44346 #: guix-git/doc/guix.texi:25053
44347 msgid "For the @code{database-configuration} field within the @code{<patchwork-settings-module>}, the @code{<patchwork-database-configuration>} must be used."
44351 #: guix-git/doc/guix.texi:25054
44353 msgid "{Data Type} patchwork-configuration"
44357 #: guix-git/doc/guix.texi:25057
44358 msgid "Data type representing the Patchwork service configuration. This type has the following parameters:"
44362 #: guix-git/doc/guix.texi:25059
44364 msgid "@code{patchwork} (default: @code{patchwork})"
44368 #: guix-git/doc/guix.texi:25061
44369 msgid "The Patchwork package to use."
44373 #: guix-git/doc/guix.texi:25062
44379 #: guix-git/doc/guix.texi:25065
44380 msgid "The domain to use for Patchwork, this is used in the HTTPD service virtual host."
44384 #: guix-git/doc/guix.texi:25066
44386 msgid "settings-module"
44390 #: guix-git/doc/guix.texi:25072
44391 msgid "The settings module to use for Patchwork. As a Django application, Patchwork is configured with a Python module containing the settings. This can either be an instance of the @code{<patchwork-settings-module>} record, any other record that represents the settings in the store, or a directory outside of the store."
44395 #: guix-git/doc/guix.texi:25073
44397 msgid "@code{static-path} (default: @code{\"/static/\"})"
44401 #: guix-git/doc/guix.texi:25075
44402 msgid "The path under which the HTTPD service should serve the static files."
44406 #: guix-git/doc/guix.texi:25076
44408 msgid "getmail-retriever-config"
44412 #: guix-git/doc/guix.texi:25080
44413 msgid "The getmail-retriever-configuration record value to use with Patchwork. Getmail will be configured with this value, the messages will be delivered to Patchwork."
44417 #: guix-git/doc/guix.texi:25084
44419 msgid "{Data Type} patchwork-settings-module"
44423 #: guix-git/doc/guix.texi:25089
44424 msgid "Data type representing a settings module for Patchwork. Some of these settings relate directly to Patchwork, but others relate to Django, the web framework used by Patchwork, or the Django Rest Framework library. This type has the following parameters:"
44428 #: guix-git/doc/guix.texi:25091
44430 msgid "@code{database-configuration} (default: @code{(patchwork-database-configuration)})"
44434 #: guix-git/doc/guix.texi:25094
44435 msgid "The database connection settings used for Patchwork. See the @code{<patchwork-database-configuration>} record type for more information."
44439 #: guix-git/doc/guix.texi:25095
44441 msgid "@code{secret-key-file} (default: @code{\"/etc/patchwork/django-secret-key\"})"
44445 #: guix-git/doc/guix.texi:25098
44446 msgid "Patchwork, as a Django web application uses a secret key for cryptographically signing values. This file should contain a unique unpredictable value."
44450 #: guix-git/doc/guix.texi:25101
44451 msgid "If this file does not exist, it will be created and populated with a random value by the patchwork-setup shepherd service."
44455 #: guix-git/doc/guix.texi:25103
44456 msgid "This setting relates to Django."
44460 #: guix-git/doc/guix.texi:25104
44462 msgid "allowed-hosts"
44466 #: guix-git/doc/guix.texi:25107
44467 msgid "A list of valid hosts for this Patchwork service. This should at least include the domain specified in the @code{<patchwork-configuration>} record."
44471 #: guix-git/doc/guix.texi:25109 guix-git/doc/guix.texi:25123
44472 #: guix-git/doc/guix.texi:25129 guix-git/doc/guix.texi:25135
44473 msgid "This is a Django setting."
44477 #: guix-git/doc/guix.texi:25110
44479 msgid "default-from-email"
44483 #: guix-git/doc/guix.texi:25112
44484 msgid "The email address from which Patchwork should send email by default."
44488 #: guix-git/doc/guix.texi:25114 guix-git/doc/guix.texi:25140
44489 #: guix-git/doc/guix.texi:25145 guix-git/doc/guix.texi:25150
44490 msgid "This is a Patchwork setting."
44494 #: guix-git/doc/guix.texi:25115
44496 msgid "@code{static-url} (default: @code{#f})"
44500 #: guix-git/doc/guix.texi:25118
44501 msgid "The URL to use when serving static assets. It can be part of a URL, or a full URL, but must end in a @code{/}."
44505 #: guix-git/doc/guix.texi:25121
44506 msgid "If the default value is used, the @code{static-path} value from the @code{<patchwork-configuration>} record will be used."
44510 #: guix-git/doc/guix.texi:25124
44512 msgid "@code{admins} (default: @code{'()})"
44516 #: guix-git/doc/guix.texi:25127
44517 msgid "Email addresses to send the details of errors that occur. Each value should be a list containing two elements, the name and then the email address."
44521 #: guix-git/doc/guix.texi:25133
44522 msgid "Whether to run Patchwork in debug mode. If set to @code{#t}, detailed error messages will be shown."
44526 #: guix-git/doc/guix.texi:25136
44528 msgid "@code{enable-rest-api?} (default: @code{#t})"
44532 #: guix-git/doc/guix.texi:25138
44533 msgid "Whether to enable the Patchwork REST API."
44537 #: guix-git/doc/guix.texi:25141
44539 msgid "@code{enable-xmlrpc?} (default: @code{#t})"
44543 #: guix-git/doc/guix.texi:25143
44544 msgid "Whether to enable the XML RPC API."
44548 #: guix-git/doc/guix.texi:25146
44550 msgid "@code{force-https-links?} (default: @code{#t})"
44554 #: guix-git/doc/guix.texi:25148
44555 msgid "Whether to use HTTPS links on Patchwork pages."
44559 #: guix-git/doc/guix.texi:25153
44560 msgid "Extra code to place at the end of the Patchwork settings module."
44564 #: guix-git/doc/guix.texi:25157
44566 msgid "{Data Type} patchwork-database-configuration"
44570 #: guix-git/doc/guix.texi:25159
44571 msgid "Data type representing the database configuration for Patchwork."
44575 #: guix-git/doc/guix.texi:25161
44577 msgid "@code{engine} (default: @code{\"django.db.backends.postgresql_psycopg2\"})"
44581 #: guix-git/doc/guix.texi:25163
44582 msgid "The database engine to use."
44586 #: guix-git/doc/guix.texi:25164
44588 msgid "@code{name} (default: @code{\"patchwork\"})"
44592 #: guix-git/doc/guix.texi:25166
44593 msgid "The name of the database to use."
44597 #: guix-git/doc/guix.texi:25169
44598 msgid "The user to connect to the database as."
44602 #: guix-git/doc/guix.texi:25170
44604 msgid "@code{password} (default: @code{\"\"})"
44608 #: guix-git/doc/guix.texi:25172
44609 msgid "The password to use when connecting to the database."
44613 #: guix-git/doc/guix.texi:25173
44615 msgid "@code{host} (default: @code{\"\"})"
44619 #: guix-git/doc/guix.texi:25175
44620 msgid "The host to make the database connection to."
44624 #: guix-git/doc/guix.texi:25176
44626 msgid "@code{port} (default: @code{\"\"})"
44630 #: guix-git/doc/guix.texi:25178
44631 msgid "The port on which to connect to the database."
44634 #. type: subsubheading
44635 #: guix-git/doc/guix.texi:25182
44641 #: guix-git/doc/guix.texi:25184
44643 msgid "Mumi, Debbugs Web interface"
44647 #: guix-git/doc/guix.texi:25185
44649 msgid "Debbugs, Mumi Web interface"
44652 #. type: Plain text
44653 #: guix-git/doc/guix.texi:25190
44654 msgid "@uref{https://git.elephly.net/gitweb.cgi?p=software/mumi.git, Mumi} is a Web interface to the Debbugs bug tracker, by default for @uref{https://bugs.gnu.org, the GNU instance}. Mumi is a Web server, but it also fetches and indexes mail retrieved from Debbugs."
44658 #: guix-git/doc/guix.texi:25191
44660 msgid "{Scheme Variable} mumi-service-type"
44664 #: guix-git/doc/guix.texi:25193
44665 msgid "This is the service type for Mumi."
44669 #: guix-git/doc/guix.texi:25195
44671 msgid "{Data Type} mumi-configuration"
44675 #: guix-git/doc/guix.texi:25198
44676 msgid "Data type representing the Mumi service configuration. This type has the following fields:"
44680 #: guix-git/doc/guix.texi:25200
44682 msgid "@code{mumi} (default: @code{mumi})"
44686 #: guix-git/doc/guix.texi:25202
44687 msgid "The Mumi package to use."
44691 #: guix-git/doc/guix.texi:25203
44693 msgid "@code{mailer?} (default: @code{#true})"
44697 #: guix-git/doc/guix.texi:25205
44698 msgid "Whether to enable or disable the mailer component."
44702 #: guix-git/doc/guix.texi:25206
44704 msgid "mumi-configuration-sender"
44708 #: guix-git/doc/guix.texi:25208
44709 msgid "The email address used as the sender for comments."
44713 #: guix-git/doc/guix.texi:25209
44715 msgid "mumi-configuration-smtp"
44719 #: guix-git/doc/guix.texi:25214
44720 msgid "A URI to configure the SMTP settings for Mailutils. This could be something like @code{sendmail:///path/to/bin/msmtp} or any other URI supported by Mailutils. @xref{SMTP Mailboxes, SMTP Mailboxes,, mailutils, GNU@tie{}Mailutils}."
44723 #. type: subsubheading
44724 #: guix-git/doc/guix.texi:25219
44730 #: guix-git/doc/guix.texi:25220
44736 #: guix-git/doc/guix.texi:25221
44741 #. type: Plain text
44742 #: guix-git/doc/guix.texi:25228
44743 msgid "FastCGI is an interface between the front-end and the back-end of a web service. It is a somewhat legacy facility; new web services should generally just talk HTTP between the front-end and the back-end. However there are a number of back-end services such as PHP or the optimized HTTP Git repository access that use FastCGI, so we have support for it in Guix."
44746 #. type: Plain text
44747 #: guix-git/doc/guix.texi:25235
44748 msgid "To use FastCGI, you configure the front-end web server (e.g., nginx) to dispatch some subset of its requests to the fastcgi backend, which listens on a local TCP or UNIX socket. There is an intermediary @code{fcgiwrap} program that sits between the actual backend process and the web server. The front-end indicates which backend program to run, passing that information to the @code{fcgiwrap} process."
44752 #: guix-git/doc/guix.texi:25236
44754 msgid "{Scheme Variable} fcgiwrap-service-type"
44758 #: guix-git/doc/guix.texi:25238
44759 msgid "A service type for the @code{fcgiwrap} FastCGI proxy."
44763 #: guix-git/doc/guix.texi:25240
44765 msgid "{Data Type} fcgiwrap-configuration"
44769 #: guix-git/doc/guix.texi:25243
44770 msgid "Data type representing the configuration of the @code{fcgiwrap} service. This type has the following parameters:"
44774 #: guix-git/doc/guix.texi:25244
44776 msgid "@code{package} (default: @code{fcgiwrap})"
44780 #: guix-git/doc/guix.texi:25246
44781 msgid "The fcgiwrap package to use."
44785 #: guix-git/doc/guix.texi:25247
44787 msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})"
44791 #: guix-git/doc/guix.texi:25253
44792 msgid "The socket on which the @code{fcgiwrap} process should listen, as a string. Valid @var{socket} values include @code{unix:@var{/path/to/unix/socket}}, @code{tcp:@var{dot.ted.qu.ad}:@var{port}} and @code{tcp6:[@var{ipv6_addr}]:port}."
44796 #: guix-git/doc/guix.texi:25254
44798 msgid "@code{user} (default: @code{fcgiwrap})"
44802 #: guix-git/doc/guix.texi:25255
44804 msgid "@code{group} (default: @code{fcgiwrap})"
44808 #: guix-git/doc/guix.texi:25260
44809 msgid "The user and group names, as strings, under which to run the @code{fcgiwrap} process. The @code{fastcgi} service will ensure that if the user asks for the specific user or group names @code{fcgiwrap} that the corresponding user and/or group is present on the system."
44813 #: guix-git/doc/guix.texi:25267
44814 msgid "It is possible to configure a FastCGI-backed web service to pass HTTP authentication information from the front-end to the back-end, and to allow @code{fcgiwrap} to run the back-end process as a corresponding local user. To enable this capability on the back-end, run @code{fcgiwrap} as the @code{root} user and group. Note that this capability also has to be configured on the front-end as well."
44818 #: guix-git/doc/guix.texi:25270
44823 #. type: Plain text
44824 #: guix-git/doc/guix.texi:25273
44825 msgid "PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size."
44828 #. type: Plain text
44829 #: guix-git/doc/guix.texi:25275
44830 msgid "These features include:"
44834 #: guix-git/doc/guix.texi:25276
44836 msgid "Adaptive process spawning"
44840 #: guix-git/doc/guix.texi:25277
44842 msgid "Basic statistics (similar to Apache's mod_status)"
44846 #: guix-git/doc/guix.texi:25278
44848 msgid "Advanced process management with graceful stop/start"
44852 #: guix-git/doc/guix.texi:25279
44854 msgid "Ability to start workers with different uid/gid/chroot/environment"
44858 #: guix-git/doc/guix.texi:25281
44859 msgid "and different php.ini (replaces safe_mode)"
44863 #: guix-git/doc/guix.texi:25281
44865 msgid "Stdout & stderr logging"
44869 #: guix-git/doc/guix.texi:25282
44871 msgid "Emergency restart in case of accidental opcode cache destruction"
44875 #: guix-git/doc/guix.texi:25283
44877 msgid "Accelerated upload support"
44881 #: guix-git/doc/guix.texi:25284
44883 msgid "Support for a \"slowlog\""
44887 #: guix-git/doc/guix.texi:25285
44889 msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -"
44893 #: guix-git/doc/guix.texi:25288
44894 msgid "a special function to finish request & flush all data while continuing to do something time-consuming (video converting, stats processing, etc.)"
44897 #. type: Plain text
44898 #: guix-git/doc/guix.texi:25290
44899 msgid "...@: and much more."
44903 #: guix-git/doc/guix.texi:25291
44905 msgid "{Scheme Variable} php-fpm-service-type"
44909 #: guix-git/doc/guix.texi:25293
44910 msgid "A Service type for @code{php-fpm}."
44914 #: guix-git/doc/guix.texi:25295
44916 msgid "{Data Type} php-fpm-configuration"
44920 #: guix-git/doc/guix.texi:25297
44921 msgid "Data Type for php-fpm service configuration."
44925 #: guix-git/doc/guix.texi:25298
44927 msgid "@code{php} (default: @code{php})"
44931 #: guix-git/doc/guix.texi:25300
44932 msgid "The php package to use."
44936 #: guix-git/doc/guix.texi:25300
44938 msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})"
44942 #: guix-git/doc/guix.texi:25302
44943 msgid "The address on which to accept FastCGI requests. Valid syntaxes are:"
44947 #: guix-git/doc/guix.texi:25303
44949 msgid "\"ip.add.re.ss:port\""
44953 #: guix-git/doc/guix.texi:25305
44954 msgid "Listen on a TCP socket to a specific address on a specific port."
44958 #: guix-git/doc/guix.texi:25305
44964 #: guix-git/doc/guix.texi:25307
44965 msgid "Listen on a TCP socket to all addresses on a specific port."
44969 #: guix-git/doc/guix.texi:25307
44971 msgid "\"/path/to/unix/socket\""
44975 #: guix-git/doc/guix.texi:25309
44976 msgid "Listen on a unix socket."
44980 #: guix-git/doc/guix.texi:25311
44982 msgid "@code{user} (default: @code{php-fpm})"
44986 #: guix-git/doc/guix.texi:25313
44987 msgid "User who will own the php worker processes."
44991 #: guix-git/doc/guix.texi:25313
44993 msgid "@code{group} (default: @code{php-fpm})"
44997 #: guix-git/doc/guix.texi:25315
44998 msgid "Group of the worker processes."
45002 #: guix-git/doc/guix.texi:25315
45004 msgid "@code{socket-user} (default: @code{php-fpm})"
45008 #: guix-git/doc/guix.texi:25317
45009 msgid "User who can speak to the php-fpm socket."
45013 #: guix-git/doc/guix.texi:25317
45015 msgid "@code{socket-group} (default: @code{nginx})"
45019 #: guix-git/doc/guix.texi:25319
45020 msgid "Group that can speak to the php-fpm socket."
45024 #: guix-git/doc/guix.texi:25319
45026 msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})"
45030 #: guix-git/doc/guix.texi:25322
45031 msgid "The process id of the php-fpm process is written to this file once the service has started."
45035 #: guix-git/doc/guix.texi:25322
45037 msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})"
45041 #: guix-git/doc/guix.texi:25324
45042 msgid "Log for the php-fpm master process."
45046 #: guix-git/doc/guix.texi:25324
45048 msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})"
45052 #: guix-git/doc/guix.texi:25327
45053 msgid "Detailed settings for the php-fpm process manager. Must be one of:"
45057 #: guix-git/doc/guix.texi:25328
45059 msgid "<php-fpm-dynamic-process-manager-configuration>"
45063 #: guix-git/doc/guix.texi:25329
45065 msgid "<php-fpm-static-process-manager-configuration>"
45069 #: guix-git/doc/guix.texi:25330
45071 msgid "<php-fpm-on-demand-process-manager-configuration>"
45075 #: guix-git/doc/guix.texi:25332
45077 msgid "@code{display-errors} (default @code{#f})"
45081 #: guix-git/doc/guix.texi:25337
45082 msgid "Determines whether php errors and warning should be sent to clients and displayed in their browsers. This is useful for local php development, but a security risk for public sites, as error messages can reveal passwords and personal data."
45086 #: guix-git/doc/guix.texi:25337
45088 msgid "@code{timezone} (default @code{#f})"
45092 #: guix-git/doc/guix.texi:25339
45093 msgid "Specifies @code{php_admin_value[date.timezone]} parameter."
45097 #: guix-git/doc/guix.texi:25339
45099 msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})"
45103 #: guix-git/doc/guix.texi:25342
45104 msgid "This file will log the @code{stderr} outputs of php worker processes. Can be set to @code{#f} to disable logging."
45108 #: guix-git/doc/guix.texi:25342
45110 msgid "@code{file} (default @code{#f})"
45114 #: guix-git/doc/guix.texi:25345
45115 msgid "An optional override of the whole configuration. You can use the @code{mixed-text-file} function or an absolute filepath for it."
45119 #: guix-git/doc/guix.texi:25345
45121 msgid "@code{php-ini-file} (default @code{#f})"
45125 #: guix-git/doc/guix.texi:25349
45126 msgid "An optional override of the default php settings. It may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). You can use the @code{mixed-text-file} function or an absolute filepath for it."
45130 #: guix-git/doc/guix.texi:25353
45131 msgid "For local development it is useful to set a higher timeout and memory limit for spawned php processes. This be accomplished with the following operating system configuration snippet:"
45135 #: guix-git/doc/guix.texi:25358
45138 "(define %local-php-ini\n"
45139 " (plain-file \"php.ini\"\n"
45140 " \"memory_limit = 2G\n"
45141 "max_execution_time = 1800\"))\n"
45146 #: guix-git/doc/guix.texi:25365
45149 "(operating-system\n"
45151 " (services (cons (service php-fpm-service-type\n"
45152 " (php-fpm-configuration\n"
45153 " (php-ini-file %local-php-ini)))\n"
45154 " %base-services)))\n"
45158 #: guix-git/doc/guix.texi:25370
45159 msgid "Consult the @url{https://www.php.net/manual/en/ini.core.php,core php.ini directives} for comprehensive documentation on the acceptable @file{php.ini} directives."
45163 #: guix-git/doc/guix.texi:25373
45165 msgid "{Data type} php-fpm-dynamic-process-manager-configuration"
45169 #: guix-git/doc/guix.texi:25377
45170 msgid "Data Type for the @code{dynamic} php-fpm process manager. With the @code{dynamic} process manager, spare worker processes are kept around based on it's configured limits."
45174 #: guix-git/doc/guix.texi:25378 guix-git/doc/guix.texi:25394
45175 #: guix-git/doc/guix.texi:25404
45177 msgid "@code{max-children} (default: @code{5})"
45181 #: guix-git/doc/guix.texi:25380 guix-git/doc/guix.texi:25396
45182 #: guix-git/doc/guix.texi:25406
45183 msgid "Maximum of worker processes."
45187 #: guix-git/doc/guix.texi:25380
45189 msgid "@code{start-servers} (default: @code{2})"
45193 #: guix-git/doc/guix.texi:25382
45194 msgid "How many worker processes should be started on start-up."
45198 #: guix-git/doc/guix.texi:25382
45200 msgid "@code{min-spare-servers} (default: @code{1})"
45204 #: guix-git/doc/guix.texi:25384
45205 msgid "How many spare worker processes should be kept around at minimum."
45209 #: guix-git/doc/guix.texi:25384
45211 msgid "@code{max-spare-servers} (default: @code{3})"
45215 #: guix-git/doc/guix.texi:25386
45216 msgid "How many spare worker processes should be kept around at maximum."
45220 #: guix-git/doc/guix.texi:25389
45222 msgid "{Data type} php-fpm-static-process-manager-configuration"
45226 #: guix-git/doc/guix.texi:25393
45227 msgid "Data Type for the @code{static} php-fpm process manager. With the @code{static} process manager, an unchanging number of worker processes are created."
45231 #: guix-git/doc/guix.texi:25399
45233 msgid "{Data type} php-fpm-on-demand-process-manager-configuration"
45237 #: guix-git/doc/guix.texi:25403
45238 msgid "Data Type for the @code{on-demand} php-fpm process manager. With the @code{on-demand} process manager, worker processes are only created as requests arrive."
45242 #: guix-git/doc/guix.texi:25406
45244 msgid "@code{process-idle-timeout} (default: @code{10})"
45248 #: guix-git/doc/guix.texi:25408
45249 msgid "The time in seconds after which a process with no requests is killed."
45253 #: guix-git/doc/guix.texi:25412
45255 msgid "{Scheme Procedure} nginx-php-location @"
45259 #: guix-git/doc/guix.texi:25418
45260 msgid "[#:nginx-package nginx] @ [socket (string-append \"/var/run/php\" @ (version-major (package-version php)) @ \"-fpm.sock\")] A helper function to quickly add php to an @code{nginx-server-configuration}."
45263 #. type: Plain text
45264 #: guix-git/doc/guix.texi:25421
45265 msgid "A simple services setup for nginx with php can look like this:"
45269 #: guix-git/doc/guix.texi:25434
45272 "(services (cons* (service dhcp-client-service-type)\n"
45273 " (service php-fpm-service-type)\n"
45274 " (service nginx-service-type\n"
45275 " (nginx-server-configuration\n"
45276 " (server-name '(\"example.com\"))\n"
45277 " (root \"/srv/http/\")\n"
45279 " (list (nginx-php-location)))\n"
45280 " (listen '(\"80\"))\n"
45281 " (ssl-certificate #f)\n"
45282 " (ssl-certificate-key #f)))\n"
45283 " %base-services))\n"
45287 #: guix-git/doc/guix.texi:25436
45289 msgid "cat-avatar-generator"
45292 #. type: Plain text
45293 #: guix-git/doc/guix.texi:25440
45294 msgid "The cat avatar generator is a simple service to demonstrate the use of php-fpm in @code{Nginx}. It is used to generate cat avatar from a seed, for instance the hash of a user's email address."
45298 #: guix-git/doc/guix.texi:25441
45300 msgid "{Scheme Procedure} cat-avatar-generator-service @"
45304 #: guix-git/doc/guix.texi:25449
45305 msgid "[#:cache-dir \"/var/cache/cat-avatar-generator\"] @ [#:package cat-avatar-generator] @ [#:configuration (nginx-server-configuration)] Returns an nginx-server-configuration that inherits @code{configuration}. It extends the nginx configuration to add a server block that serves @code{package}, a version of cat-avatar-generator. During execution, cat-avatar-generator will be able to use @code{cache-dir} as its cache directory."
45308 #. type: Plain text
45309 #: guix-git/doc/guix.texi:25452
45310 msgid "A simple setup for cat-avatar-generator can look like this:"
45314 #: guix-git/doc/guix.texi:25459
45317 "(services (cons* (cat-avatar-generator-service\n"
45318 " #:configuration\n"
45319 " (nginx-server-configuration\n"
45320 " (server-name '(\"example.com\"))))\n"
45322 " %base-services))\n"
45325 #. type: subsubheading
45326 #: guix-git/doc/guix.texi:25461
45328 msgid "Hpcguix-web"
45332 #: guix-git/doc/guix.texi:25463
45334 msgid "hpcguix-web"
45337 #. type: Plain text
45338 #: guix-git/doc/guix.texi:25468
45339 msgid "The @uref{https://github.com/UMCUGenetics/hpcguix-web/, hpcguix-web} program is a customizable web interface to browse Guix packages, initially designed for users of high-performance computing (HPC) clusters."
45343 #: guix-git/doc/guix.texi:25469
45345 msgid "{Scheme Variable} hpcguix-web-service-type"
45349 #: guix-git/doc/guix.texi:25471
45350 msgid "The service type for @code{hpcguix-web}."
45354 #: guix-git/doc/guix.texi:25473
45356 msgid "{Data Type} hpcguix-web-configuration"
45360 #: guix-git/doc/guix.texi:25475
45361 msgid "Data type for the hpcguix-web service configuration."
45365 #: guix-git/doc/guix.texi:25477
45371 #: guix-git/doc/guix.texi:25480
45372 msgid "A gexp (@pxref{G-Expressions}) specifying the hpcguix-web service configuration. The main items available in this spec are:"
45376 #: guix-git/doc/guix.texi:25482
45378 msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})"
45382 #: guix-git/doc/guix.texi:25484
45383 msgid "The page title prefix."
45387 #: guix-git/doc/guix.texi:25485
45389 msgid "@code{guix-command} (default: @code{\"guix\"})"
45393 #: guix-git/doc/guix.texi:25487
45394 msgid "The @command{guix} command."
45398 #: guix-git/doc/guix.texi:25488
45400 msgid "@code{package-filter-proc} (default: @code{(const #t)})"
45404 #: guix-git/doc/guix.texi:25490
45405 msgid "A procedure specifying how to filter packages that are displayed."
45409 #: guix-git/doc/guix.texi:25491
45411 msgid "@code{package-page-extension-proc} (default: @code{(const '())})"
45415 #: guix-git/doc/guix.texi:25493
45416 msgid "Extension package for @code{hpcguix-web}."
45420 #: guix-git/doc/guix.texi:25494
45422 msgid "@code{menu} (default: @code{'()})"
45426 #: guix-git/doc/guix.texi:25496
45427 msgid "Additional entry in page @code{menu}."
45431 #: guix-git/doc/guix.texi:25497
45433 msgid "@code{channels} (default: @code{%default-channels})"
45437 #: guix-git/doc/guix.texi:25499
45438 msgid "List of channels from which the package list is built (@pxref{Channels})."
45442 #: guix-git/doc/guix.texi:25500
45444 msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})"
45448 #: guix-git/doc/guix.texi:25503
45449 msgid "The expiration time, in seconds, after which the package list is rebuilt from the latest instances of the given channels."
45453 #: guix-git/doc/guix.texi:25508
45454 msgid "See the hpcguix-web repository for a @uref{https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm, complete example}."
45458 #: guix-git/doc/guix.texi:25509
45460 msgid "@code{package} (default: @code{hpcguix-web})"
45464 #: guix-git/doc/guix.texi:25511
45465 msgid "The hpcguix-web package to use."
45468 #. type: Plain text
45469 #: guix-git/doc/guix.texi:25515
45470 msgid "A typical hpcguix-web service declaration looks like this:"
45474 #: guix-git/doc/guix.texi:25524
45477 "(service hpcguix-web-service-type\n"
45478 " (hpcguix-web-configuration\n"
45480 " #~(define site-config\n"
45481 " (hpcweb-configuration\n"
45482 " (title-prefix \"Guix-HPC - \")\n"
45483 " (menu '((\"/about\" \"ABOUT\"))))))))\n"
45487 #: guix-git/doc/guix.texi:25531
45488 msgid "The hpcguix-web service periodically updates the package list it publishes by pulling channels from Git. To that end, it needs to access X.509 certificates so that it can authenticate Git servers when communicating over HTTPS, and it assumes that @file{/etc/ssl/certs} contains those certificates."
45492 #: guix-git/doc/guix.texi:25535
45493 msgid "Thus, make sure to add @code{nss-certs} or another certificate package to the @code{packages} field of your configuration. @ref{X.509 Certificates}, for more information on X.509 certificates."
45497 #: guix-git/doc/guix.texi:25537 guix-git/doc/guix.texi:25539
45502 #. type: Plain text
45503 #: guix-git/doc/guix.texi:25542
45504 msgid "The @uref{https://git.sr.ht/~sircmpwn/gmnisrv, gmnisrv} program is a simple @uref{https://gemini.circumlunar.space/, Gemini} protocol server."
45508 #: guix-git/doc/guix.texi:25543
45510 msgid "{Scheme Variable} gmnisrv-service-type"
45514 #: guix-git/doc/guix.texi:25546
45515 msgid "This is the type of the gmnisrv service, whose value should be a @code{gmnisrv-configuration} object, as in this example:"
45519 #: guix-git/doc/guix.texi:25551
45522 "(service gmnisrv-service-type\n"
45523 " (gmnisrv-configuration\n"
45524 " (config-file (local-file \"./my-gmnisrv.ini\"))))\n"
45528 #: guix-git/doc/guix.texi:25554
45530 msgid "{Data Type} gmnisrv-configuration"
45534 #: guix-git/doc/guix.texi:25556
45535 msgid "Data type representing the configuration of gmnisrv."
45539 #: guix-git/doc/guix.texi:25558
45541 msgid "@code{package} (default: @var{gmnisrv})"
45545 #: guix-git/doc/guix.texi:25560
45546 msgid "Package object of the gmnisrv server."
45550 #: guix-git/doc/guix.texi:25561
45552 msgid "@code{config-file} (default: @code{%default-gmnisrv-config-file})"
45556 #: guix-git/doc/guix.texi:25567
45557 msgid "File-like object of the gmnisrv configuration file to use. The default configuration listens on port 1965 and serves files from @file{/srv/gemini}. Certificates are stored in @file{/var/lib/gemini/certs}. For more information, run @command{man gmnisrv} and @command{man gmnisrv.ini}."
45560 #. type: subsubheading
45561 #: guix-git/doc/guix.texi:25571
45567 #: guix-git/doc/guix.texi:25573
45572 #. type: Plain text
45573 #: guix-git/doc/guix.texi:25578
45574 msgid "The @uref{gemini://qwertqwefsday.eu/agate.gmi, Agate} (@uref{https://github.com/mbrubeck/agate, GitHub page over HTTPS}) program is a simple @uref{https://gemini.circumlunar.space/, Gemini} protocol server written in Rust."
45578 #: guix-git/doc/guix.texi:25579
45580 msgid "{Scheme Variable} agate-service-type"
45584 #: guix-git/doc/guix.texi:25582
45585 msgid "This is the type of the agate service, whose value should be an @code{agate-service-type} object, as in this example:"
45589 #: guix-git/doc/guix.texi:25589
45592 "(service agate-service-type\n"
45593 "\t (agate-configuration\n"
45594 "\t (content \"/srv/gemini\")\n"
45595 "\t (cert \"/srv/cert.pem\")\n"
45596 "\t (key \"/srv/key.rsa\")))\n"
45600 #: guix-git/doc/guix.texi:25594
45601 msgid "The example above represents the minimal tweaking necessary to get Agate up and running. Specifying the path to the certificate and key is always necessary, as the Gemini protocol requires TLS by default."
45605 #: guix-git/doc/guix.texi:25597
45606 msgid "To obtain a certificate and a key, you could, for example, use OpenSSL, running a command similar to the following example:"
45610 #: guix-git/doc/guix.texi:25601
45613 "openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \\\n"
45614 " -days 3650 -nodes -subj \"/CN=example.com\"\n"
45618 #: guix-git/doc/guix.texi:25606
45619 msgid "Of course, you'll have to replace @i{example.com} with your own domain name, and then point the Agate configuration towards the path of the generated key and certificate."
45623 #: guix-git/doc/guix.texi:25609
45625 msgid "{Data Type} agate-configuration"
45629 #: guix-git/doc/guix.texi:25611
45630 msgid "Data type representing the configuration of Agate."
45634 #: guix-git/doc/guix.texi:25613
45636 msgid "@code{package} (default: @code{agate})"
45640 #: guix-git/doc/guix.texi:25615
45641 msgid "The package object of the Agate server."
45645 #: guix-git/doc/guix.texi:25616
45647 msgid "@code{content} (default: @file{\"/srv/gemini\"})"
45651 #: guix-git/doc/guix.texi:25618
45652 msgid "The directory from which Agate will serve files."
45656 #: guix-git/doc/guix.texi:25619
45658 msgid "@code{cert} (default: @code{#f})"
45662 #: guix-git/doc/guix.texi:25622
45663 msgid "The path to the TLS certificate PEM file to be used for encrypted connections. Must be filled in with a value from the user."
45667 #: guix-git/doc/guix.texi:25623 guix-git/doc/guix.texi:26051
45669 msgid "@code{key} (default: @code{#f})"
45673 #: guix-git/doc/guix.texi:25626
45674 msgid "The path to the PKCS8 private key file to be used for encrypted connections. Must be filled in with a value from the user."
45678 #: guix-git/doc/guix.texi:25627
45680 msgid "@code{addr} (default: @code{'(\"0.0.0.0:1965\" \"[::]:1965\")})"
45684 #: guix-git/doc/guix.texi:25629
45685 msgid "A list of the addresses to listen on."
45689 #: guix-git/doc/guix.texi:25632
45690 msgid "The domain name of this Gemini server. Optional."
45694 #: guix-git/doc/guix.texi:25633
45696 msgid "@code{lang} (default: @code{#f})"
45700 #: guix-git/doc/guix.texi:25635
45701 msgid "RFC 4646 language code(s) for text/gemini documents. Optional."
45705 #: guix-git/doc/guix.texi:25636
45707 msgid "@code{silent?} (default: @code{#f})"
45711 #: guix-git/doc/guix.texi:25638
45712 msgid "Set to @code{#t} to disable logging output."
45716 #: guix-git/doc/guix.texi:25639
45718 msgid "@code{serve-secret?} (default: @code{#f})"
45722 #: guix-git/doc/guix.texi:25642
45723 msgid "Set to @code{#t} to serve secret files (files/directories starting with a dot)."
45727 #: guix-git/doc/guix.texi:25643
45729 msgid "@code{log-ip?} (default: @code{#t})"
45733 #: guix-git/doc/guix.texi:25645
45734 msgid "Whether or not to output IP addresses when logging."
45738 #: guix-git/doc/guix.texi:25646
45740 msgid "@code{user} (default: @code{\"agate\"})"
45744 #: guix-git/doc/guix.texi:25648
45745 msgid "Owner of the @code{agate} process."
45749 #: guix-git/doc/guix.texi:25649
45751 msgid "@code{group} (default: @code{\"agate\"})"
45755 #: guix-git/doc/guix.texi:25651
45756 msgid "Owner's group of the @code{agate} process."
45760 #: guix-git/doc/guix.texi:25652
45762 msgid "@code{log-file} (default: @file{\"/var/log/agate.log\"})"
45766 #: guix-git/doc/guix.texi:25654
45767 msgid "The file which should store the logging output of Agate."
45771 #: guix-git/doc/guix.texi:25661
45777 #: guix-git/doc/guix.texi:25662
45779 msgid "HTTP, HTTPS"
45783 #: guix-git/doc/guix.texi:25663
45785 msgid "Let's Encrypt"
45789 #: guix-git/doc/guix.texi:25664
45791 msgid "TLS certificates"
45794 #. type: Plain text
45795 #: guix-git/doc/guix.texi:25671
45796 msgid "The @code{(gnu services certbot)} module provides a service to automatically obtain a valid TLS certificate from the Let's Encrypt certificate authority. These certificates can then be used to serve content securely over HTTPS or other TLS-based protocols, with the knowledge that the client will be able to verify the server's authenticity."
45799 #. type: Plain text
45800 #: guix-git/doc/guix.texi:25683
45801 msgid "@url{https://letsencrypt.org/, Let's Encrypt} provides the @code{certbot} tool to automate the certification process. This tool first securely generates a key on the server. It then makes a request to the Let's Encrypt certificate authority (CA) to sign the key. The CA checks that the request originates from the host in question by using a challenge-response protocol, requiring the server to provide its response over HTTP@. If that protocol completes successfully, the CA signs the key, resulting in a certificate. That certificate is valid for a limited period of time, and therefore to continue to provide TLS services, the server needs to periodically ask the CA to renew its signature."
45804 #. type: Plain text
45805 #: guix-git/doc/guix.texi:25690
45806 msgid "The certbot service automates this process: the initial key generation, the initial certification request to the Let's Encrypt service, the web server challenge/response integration, writing the certificate to disk, the automated periodic renewals, and the deployment tasks associated with the renewal (e.g.@: reloading services, copying keys with different permissions)."
45809 #. type: Plain text
45810 #: guix-git/doc/guix.texi:25696
45811 msgid "Certbot is run twice a day, at a random minute within the hour. It won't do anything until your certificates are due for renewal or revoked, but running it regularly would give your service a chance of staying online in case a Let's Encrypt-initiated revocation happened for some reason."
45814 #. type: Plain text
45815 #: guix-git/doc/guix.texi:25700
45816 msgid "By using this service, you agree to the ACME Subscriber Agreement, which can be found there: @url{https://acme-v01.api.letsencrypt.org/directory}."
45820 #: guix-git/doc/guix.texi:25701
45822 msgid "{Scheme Variable} certbot-service-type"
45826 #: guix-git/doc/guix.texi:25704
45827 msgid "A service type for the @code{certbot} Let's Encrypt client. Its value must be a @code{certbot-configuration} record as in this example:"
45831 #: guix-git/doc/guix.texi:25711
45834 "(define %nginx-deploy-hook\n"
45836 " \"nginx-deploy-hook\"\n"
45837 " #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n"
45838 " (kill pid SIGHUP))))\n"
45843 #: guix-git/doc/guix.texi:25722
45846 "(service certbot-service-type\n"
45847 " (certbot-configuration\n"
45848 " (email \"foo@@example.net\")\n"
45851 " (certificate-configuration\n"
45852 " (domains '(\"example.net\" \"www.example.net\"))\n"
45853 " (deploy-hook %nginx-deploy-hook))\n"
45854 " (certificate-configuration\n"
45855 " (domains '(\"bar.example.net\")))))))\n"
45859 #: guix-git/doc/guix.texi:25725
45860 msgid "See below for details about @code{certbot-configuration}."
45864 #: guix-git/doc/guix.texi:25727
45866 msgid "{Data Type} certbot-configuration"
45870 #: guix-git/doc/guix.texi:25730
45871 msgid "Data type representing the configuration of the @code{certbot} service. This type has the following parameters:"
45875 #: guix-git/doc/guix.texi:25732
45877 msgid "@code{package} (default: @code{certbot})"
45881 #: guix-git/doc/guix.texi:25734
45882 msgid "The certbot package to use."
45886 #: guix-git/doc/guix.texi:25735
45888 msgid "@code{webroot} (default: @code{/var/www})"
45892 #: guix-git/doc/guix.texi:25738
45893 msgid "The directory from which to serve the Let's Encrypt challenge/response files."
45897 #: guix-git/doc/guix.texi:25739
45899 msgid "@code{certificates} (default: @code{()})"
45903 #: guix-git/doc/guix.texi:25743
45904 msgid "A list of @code{certificates-configuration}s for which to generate certificates and request signatures. Each certificate has a @code{name} and several @code{domains}."
45908 #: guix-git/doc/guix.texi:25744
45910 msgid "@code{email} (default: @code{#f})"
45914 #: guix-git/doc/guix.texi:25748
45915 msgid "Optional email address used for registration and recovery contact. Setting this is encouraged as it allows you to receive important notifications about the account and issued certificates."
45919 #: guix-git/doc/guix.texi:25749 guix-git/doc/guix.texi:27429
45921 msgid "@code{server} (default: @code{#f})"
45925 #: guix-git/doc/guix.texi:25752
45926 msgid "Optional URL of ACME server. Setting this overrides certbot's default, which is the Let's Encrypt server."
45930 #: guix-git/doc/guix.texi:25753
45932 msgid "@code{rsa-key-size} (default: @code{2048})"
45936 #: guix-git/doc/guix.texi:25755
45937 msgid "Size of the RSA key."
45941 #: guix-git/doc/guix.texi:25756
45943 msgid "@code{default-location} (default: @i{see below})"
45947 #: guix-git/doc/guix.texi:25765
45948 msgid "The default @code{nginx-location-configuration}. Because @code{certbot} needs to be able to serve challenges and responses, it needs to be able to run a web server. It does so by extending the @code{nginx} web service with an @code{nginx-server-configuration} listening on the @var{domains} on port 80, and which has a @code{nginx-location-configuration} for the @code{/.well-known/} URI path subspace used by Let's Encrypt. @xref{Web Services}, for more on these nginx configuration data types."
45952 #: guix-git/doc/guix.texi:25769
45953 msgid "Requests to other URL paths will be matched by the @code{default-location}, which if present is added to all @code{nginx-server-configuration}s."
45957 #: guix-git/doc/guix.texi:25773
45958 msgid "By default, the @code{default-location} will issue a redirect from @code{http://@var{domain}/...} to @code{https://@var{domain}/...}, leaving you to define what to serve on your site via @code{https}."
45962 #: guix-git/doc/guix.texi:25775
45963 msgid "Pass @code{#f} to not issue a default location."
45967 #: guix-git/doc/guix.texi:25778
45969 msgid "{Data Type} certificate-configuration"
45973 #: guix-git/doc/guix.texi:25781
45974 msgid "Data type representing the configuration of a certificate. This type has the following parameters:"
45978 #: guix-git/doc/guix.texi:25783
45980 msgid "@code{name} (default: @i{see below})"
45984 #: guix-git/doc/guix.texi:25787
45985 msgid "This name is used by Certbot for housekeeping and in file paths; it doesn't affect the content of the certificate itself. To see certificate names, run @code{certbot certificates}."
45989 #: guix-git/doc/guix.texi:25789
45990 msgid "Its default is the first provided domain."
45994 #: guix-git/doc/guix.texi:25790
45996 msgid "@code{domains} (default: @code{()})"
46000 #: guix-git/doc/guix.texi:25793
46001 msgid "The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate."
46005 #: guix-git/doc/guix.texi:25794
46007 msgid "@code{challenge} (default: @code{#f})"
46011 #: guix-git/doc/guix.texi:25801
46012 msgid "The challenge type that has to be run by certbot. If @code{#f} is specified, default to the HTTP challenge. If a value is specified, defaults to the manual plugin (see @code{authentication-hook}, @code{cleanup-hook} and the documentation at @url{https://certbot.eff.org/docs/using.html#hooks}), and gives Let's Encrypt permission to log the public IP address of the requesting machine."
46016 #: guix-git/doc/guix.texi:25802
46018 msgid "@code{authentication-hook} (default: @code{#f})"
46022 #: guix-git/doc/guix.texi:25808
46023 msgid "Command to be run in a shell once for each certificate challenge to be answered. For this command, the shell variable @code{$CERTBOT_DOMAIN} will contain the domain being authenticated, @code{$CERTBOT_VALIDATION} contains the validation string and @code{$CERTBOT_TOKEN} contains the file name of the resource requested when performing an HTTP-01 challenge."
46027 #: guix-git/doc/guix.texi:25809
46029 msgid "@code{cleanup-hook} (default: @code{#f})"
46033 #: guix-git/doc/guix.texi:25815
46034 msgid "Command to be run in a shell once for each certificate challenge that have been answered by the @code{auth-hook}. For this command, the shell variables available in the @code{auth-hook} script are still available, and additionally @code{$CERTBOT_AUTH_OUTPUT} will contain the standard output of the @code{auth-hook} script."
46038 #: guix-git/doc/guix.texi:25816
46040 msgid "@code{deploy-hook} (default: @code{#f})"
46044 #: guix-git/doc/guix.texi:25824
46045 msgid "Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable @code{$RENEWED_LINEAGE} will point to the config live subdirectory (for example, @samp{\"/etc/letsencrypt/live/example.com\"}) containing the new certificates and keys; the shell variable @code{$RENEWED_DOMAINS} will contain a space-delimited list of renewed certificate domains (for example, @samp{\"example.com www.example.com\"}."
46048 #. type: Plain text
46049 #: guix-git/doc/guix.texi:25831
46050 msgid "For each @code{certificate-configuration}, the certificate is saved to @code{/etc/letsencrypt/live/@var{name}/fullchain.pem} and the key is saved to @code{/etc/letsencrypt/live/@var{name}/privkey.pem}."
46054 #: guix-git/doc/guix.texi:25833
46056 msgid "DNS (domain name system)"
46060 #: guix-git/doc/guix.texi:25834
46062 msgid "domain name system (DNS)"
46065 #. type: Plain text
46066 #: guix-git/doc/guix.texi:25842
46067 msgid "The @code{(gnu services dns)} module provides services related to the @dfn{domain name system} (DNS). It provides a server service for hosting an @emph{authoritative} DNS server for multiple zones, slave or master. This service uses @uref{https://www.knot-dns.cz/, Knot DNS}. And also a caching and forwarding DNS server for the LAN, which uses @uref{http://www.thekelleys.org.uk/dnsmasq/doc.html, dnsmasq}."
46070 #. type: subsubheading
46071 #: guix-git/doc/guix.texi:25843
46073 msgid "Knot Service"
46076 #. type: Plain text
46077 #: guix-git/doc/guix.texi:25847
46078 msgid "An example configuration of an authoritative server for two zones, one master and one slave, is:"
46082 #: guix-git/doc/guix.texi:25854
46085 "(define-zone-entries example.org.zone\n"
46086 ";; Name TTL Class Type Data\n"
46087 " (\"@@\" \"\" \"IN\" \"A\" \"127.0.0.1\")\n"
46088 " (\"@@\" \"\" \"IN\" \"NS\" \"ns\")\n"
46089 " (\"ns\" \"\" \"IN\" \"A\" \"127.0.0.1\"))\n"
46094 #: guix-git/doc/guix.texi:25861
46097 "(define master-zone\n"
46098 " (knot-zone-configuration\n"
46099 " (domain \"example.org\")\n"
46100 " (zone (zone-file\n"
46101 " (origin \"example.org\")\n"
46102 " (entries example.org.zone)))))\n"
46107 #: guix-git/doc/guix.texi:25867
46110 "(define slave-zone\n"
46111 " (knot-zone-configuration\n"
46112 " (domain \"plop.org\")\n"
46113 " (dnssec-policy \"default\")\n"
46114 " (master (list \"plop-master\"))))\n"
46119 #: guix-git/doc/guix.texi:25872
46122 "(define plop-master\n"
46123 " (knot-remote-configuration\n"
46124 " (id \"plop-master\")\n"
46125 " (address (list \"208.76.58.171\"))))\n"
46130 #: guix-git/doc/guix.texi:25881
46133 "(operating-system\n"
46135 " (services (cons* (service knot-service-type\n"
46136 " (knot-configuration\n"
46137 " (remotes (list plop-master))\n"
46138 " (zones (list master-zone slave-zone))))\n"
46140 " %base-services)))\n"
46144 #: guix-git/doc/guix.texi:25883
46146 msgid "{Scheme Variable} knot-service-type"
46150 #: guix-git/doc/guix.texi:25885
46151 msgid "This is the type for the Knot DNS server."
46155 #: guix-git/doc/guix.texi:25893
46156 msgid "Knot DNS is an authoritative DNS server, meaning that it can serve multiple zones, that is to say domain names you would buy from a registrar. This server is not a resolver, meaning that it can only resolve names for which it is authoritative. This server can be configured to serve zones as a master server or a slave server as a per-zone basis. Slave zones will get their data from masters, and will serve it as an authoritative server. From the point of view of a resolver, there is no difference between master and slave."
46160 #: guix-git/doc/guix.texi:25895
46161 msgid "The following data types are used to configure the Knot DNS server:"
46165 #: guix-git/doc/guix.texi:25897
46167 msgid "{Data Type} knot-key-configuration"
46171 #: guix-git/doc/guix.texi:25900
46172 msgid "Data type representing a key. This type has the following parameters:"
46176 #: guix-git/doc/guix.texi:25902 guix-git/doc/guix.texi:25922
46177 #: guix-git/doc/guix.texi:26037 guix-git/doc/guix.texi:26063
46178 #: guix-git/doc/guix.texi:26098
46180 msgid "@code{id} (default: @code{\"\"})"
46184 #: guix-git/doc/guix.texi:25905 guix-git/doc/guix.texi:25925
46185 msgid "An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty."
46189 #: guix-git/doc/guix.texi:25906
46191 msgid "@code{algorithm} (default: @code{#f})"
46195 #: guix-git/doc/guix.texi:25910
46196 msgid "The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, @code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, @code{'hmac-sha384} and @code{'hmac-sha512}."
46200 #: guix-git/doc/guix.texi:25911
46202 msgid "@code{secret} (default: @code{\"\"})"
46206 #: guix-git/doc/guix.texi:25913
46207 msgid "The secret key itself."
46211 #: guix-git/doc/guix.texi:25917
46213 msgid "{Data Type} knot-acl-configuration"
46217 #: guix-git/doc/guix.texi:25920
46218 msgid "Data type representing an Access Control List (ACL) configuration. This type has the following parameters:"
46222 #: guix-git/doc/guix.texi:25926 guix-git/doc/guix.texi:26041
46224 msgid "@code{address} (default: @code{'()})"
46228 #: guix-git/doc/guix.texi:25930
46229 msgid "An ordered list of IP addresses, network subnets, or network ranges represented with strings. The query must match one of them. Empty value means that address match is not required."
46233 #: guix-git/doc/guix.texi:25931
46235 msgid "@code{key} (default: @code{'()})"
46239 #: guix-git/doc/guix.texi:25935
46240 msgid "An ordered list of references to keys represented with strings. The string must match a key ID defined in a @code{knot-key-configuration}. No key means that a key is not require to match that ACL."
46244 #: guix-git/doc/guix.texi:25936
46246 msgid "@code{action} (default: @code{'()})"
46250 #: guix-git/doc/guix.texi:25940
46251 msgid "An ordered list of actions that are permitted or forbidden by this ACL@. Possible values are lists of zero or more elements from @code{'transfer}, @code{'notify} and @code{'update}."
46255 #: guix-git/doc/guix.texi:25941
46257 msgid "@code{deny?} (default: @code{#f})"
46261 #: guix-git/doc/guix.texi:25944
46262 msgid "When true, the ACL defines restrictions. Listed actions are forbidden. When false, listed actions are allowed."
46266 #: guix-git/doc/guix.texi:25948
46268 msgid "{Data Type} zone-entry"
46272 #: guix-git/doc/guix.texi:25951
46273 msgid "Data type representing a record entry in a zone file. This type has the following parameters:"
46277 #: guix-git/doc/guix.texi:25953
46279 msgid "@code{name} (default: @code{\"@@\"})"
46283 #: guix-git/doc/guix.texi:25959
46284 msgid "The name of the record. @code{\"@@\"} refers to the origin of the zone. Names are relative to the origin of the zone. For example, in the @code{example.org} zone, @code{\"ns.example.org\"} actually refers to @code{ns.example.org.example.org}. Names ending with a dot are absolute, which means that @code{\"ns.example.org.\"} refers to @code{ns.example.org}."
46288 #: guix-git/doc/guix.texi:25960
46290 msgid "@code{ttl} (default: @code{\"\"})"
46294 #: guix-git/doc/guix.texi:25962
46295 msgid "The Time-To-Live (TTL) of this record. If not set, the default TTL is used."
46299 #: guix-git/doc/guix.texi:25963
46301 msgid "@code{class} (default: @code{\"IN\"})"
46305 #: guix-git/doc/guix.texi:25966
46306 msgid "The class of the record. Knot currently supports only @code{\"IN\"} and partially @code{\"CH\"}."
46310 #: guix-git/doc/guix.texi:25967
46312 msgid "@code{type} (default: @code{\"A\"})"
46316 #: guix-git/doc/guix.texi:25971
46317 msgid "The type of the record. Common types include A (IPv4 address), AAAA (IPv6 address), NS (Name Server) and MX (Mail eXchange). Many other types are defined."
46321 #: guix-git/doc/guix.texi:25972
46323 msgid "@code{data} (default: @code{\"\"})"
46327 #: guix-git/doc/guix.texi:25976
46328 msgid "The data contained in the record. For instance an IP address associated with an A record, or a domain name associated with an NS record. Remember that domain names are relative to the origin unless they end with a dot."
46332 #: guix-git/doc/guix.texi:25980
46334 msgid "{Data Type} zone-file"
46338 #: guix-git/doc/guix.texi:25983
46339 msgid "Data type representing the content of a zone file. This type has the following parameters:"
46343 #: guix-git/doc/guix.texi:25992
46344 msgid "The list of entries. The SOA record is taken care of, so you don't need to put it in the list of entries. This list should probably contain an entry for your primary authoritative DNS server. Other than using a list of entries directly, you can use @code{define-zone-entries} to define a object containing the list of entries more easily, that you can later pass to the @code{entries} field of the @code{zone-file}."
46348 #: guix-git/doc/guix.texi:25993
46350 msgid "@code{origin} (default: @code{\"\"})"
46354 #: guix-git/doc/guix.texi:25995
46355 msgid "The name of your zone. This parameter cannot be empty."
46359 #: guix-git/doc/guix.texi:25996
46361 msgid "@code{ns} (default: @code{\"ns\"})"
46365 #: guix-git/doc/guix.texi:26001
46366 msgid "The domain of your primary authoritative DNS server. The name is relative to the origin, unless it ends with a dot. It is mandatory that this primary DNS server corresponds to an NS record in the zone and that it is associated to an IP address in the list of entries."
46370 #: guix-git/doc/guix.texi:26002
46372 msgid "@code{mail} (default: @code{\"hostmaster\"})"
46376 #: guix-git/doc/guix.texi:26005
46377 msgid "An email address people can contact you at, as the owner of the zone. This is translated as @code{<mail>@@<origin>}."
46381 #: guix-git/doc/guix.texi:26006
46383 msgid "@code{serial} (default: @code{1})"
46387 #: guix-git/doc/guix.texi:26010
46388 msgid "The serial number of the zone. As this is used to keep track of changes by both slaves and resolvers, it is mandatory that it @emph{never} decreases. Always increment it when you make a change in your zone."
46392 #: guix-git/doc/guix.texi:26011
46394 msgid "@code{refresh} (default: @code{(* 2 24 3600)})"
46398 #: guix-git/doc/guix.texi:26015
46399 msgid "The frequency at which slaves will do a zone transfer. This value is a number of seconds. It can be computed by multiplications or with @code{(string->duration)}."
46403 #: guix-git/doc/guix.texi:26016
46405 msgid "@code{retry} (default: @code{(* 15 60)})"
46409 #: guix-git/doc/guix.texi:26019
46410 msgid "The period after which a slave will retry to contact its master when it fails to do so a first time."
46414 #: guix-git/doc/guix.texi:26020
46416 msgid "@code{expiry} (default: @code{(* 14 24 3600)})"
46420 #: guix-git/doc/guix.texi:26024
46421 msgid "Default TTL of records. Existing records are considered correct for at most this amount of time. After this period, resolvers will invalidate their cache and check again that it still exists."
46425 #: guix-git/doc/guix.texi:26025
46427 msgid "@code{nx} (default: @code{3600})"
46431 #: guix-git/doc/guix.texi:26028
46432 msgid "Default TTL of inexistent records. This delay is usually short because you want your new domains to reach everyone quickly."
46436 #: guix-git/doc/guix.texi:26032
46438 msgid "{Data Type} knot-remote-configuration"
46442 #: guix-git/doc/guix.texi:26035
46443 msgid "Data type representing a remote configuration. This type has the following parameters:"
46447 #: guix-git/doc/guix.texi:26040
46448 msgid "An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty."
46452 #: guix-git/doc/guix.texi:26045
46453 msgid "An ordered list of destination IP addresses. Addresses are tried in sequence. An optional port can be given with the @@ separator. For instance: @code{(list \"1.2.3.4\" \"2.3.4.5@@53\")}. Default port is 53."
46457 #: guix-git/doc/guix.texi:26046
46459 msgid "@code{via} (default: @code{'()})"
46463 #: guix-git/doc/guix.texi:26050
46464 msgid "An ordered list of source IP addresses. An empty list will have Knot choose an appropriate source IP@. An optional port can be given with the @@ separator. The default is to choose at random."
46468 #: guix-git/doc/guix.texi:26054
46469 msgid "A reference to a key, that is a string containing the identifier of a key defined in a @code{knot-key-configuration} field."
46473 #: guix-git/doc/guix.texi:26058
46475 msgid "{Data Type} knot-keystore-configuration"
46479 #: guix-git/doc/guix.texi:26061
46480 msgid "Data type representing a keystore to hold dnssec keys. This type has the following parameters:"
46484 #: guix-git/doc/guix.texi:26065
46485 msgid "The id of the keystore. It must not be empty."
46489 #: guix-git/doc/guix.texi:26066
46491 msgid "@code{backend} (default: @code{'pem})"
46495 #: guix-git/doc/guix.texi:26068
46496 msgid "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}."
46500 #: guix-git/doc/guix.texi:26069
46502 msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})"
46506 #: guix-git/doc/guix.texi:26073
46507 msgid "The configuration string of the backend. An example for the PKCS#11 is: @code{\"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so\"}. For the pem backend, the string represents a path in the file system."
46511 #: guix-git/doc/guix.texi:26077
46513 msgid "{Data Type} knot-policy-configuration"
46517 #: guix-git/doc/guix.texi:26081
46518 msgid "Data type representing a dnssec policy. Knot DNS is able to automatically sign your zones. It can either generate and manage your keys automatically or use keys that you generate."
46522 #: guix-git/doc/guix.texi:26088
46523 msgid "Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that is used to sign the second, and a Zone Signing Key (ZSK) that is used to sign the zone. In order to be trusted, the KSK needs to be present in the parent zone (usually a top-level domain). If your registrar supports dnssec, you will have to send them your KSK's hash so they can add a DS record in their zone. This is not automated and need to be done each time you change your KSK."
46527 #: guix-git/doc/guix.texi:26094
46528 msgid "The policy also defines the lifetime of keys. Usually, ZSK can be changed easily and use weaker cryptographic functions (they use lower parameters) in order to sign records quickly, so they are changed often. The KSK however requires manual interaction with the registrar, so they are changed less often and use stronger parameters because they sign only one record."
46532 #: guix-git/doc/guix.texi:26096
46533 msgid "This type has the following parameters:"
46537 #: guix-git/doc/guix.texi:26100
46538 msgid "The id of the policy. It must not be empty."
46542 #: guix-git/doc/guix.texi:26101
46544 msgid "@code{keystore} (default: @code{\"default\"})"
46548 #: guix-git/doc/guix.texi:26106
46549 msgid "A reference to a keystore, that is a string containing the identifier of a keystore defined in a @code{knot-keystore-configuration} field. The @code{\"default\"} identifier means the default keystore (a kasp database that was setup by this service)."
46553 #: guix-git/doc/guix.texi:26107
46555 msgid "@code{manual?} (default: @code{#f})"
46559 #: guix-git/doc/guix.texi:26109
46560 msgid "Whether the key management is manual or automatic."
46564 #: guix-git/doc/guix.texi:26110
46566 msgid "@code{single-type-signing?} (default: @code{#f})"
46570 #: guix-git/doc/guix.texi:26112
46571 msgid "When @code{#t}, use the Single-Type Signing Scheme."
46575 #: guix-git/doc/guix.texi:26113
46577 msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})"
46581 #: guix-git/doc/guix.texi:26115
46582 msgid "An algorithm of signing keys and issued signatures."
46586 #: guix-git/doc/guix.texi:26116
46588 msgid "@code{ksk-size} (default: @code{256})"
46592 #: guix-git/doc/guix.texi:26119
46593 msgid "The length of the KSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
46597 #: guix-git/doc/guix.texi:26120
46599 msgid "@code{zsk-size} (default: @code{256})"
46603 #: guix-git/doc/guix.texi:26123
46604 msgid "The length of the ZSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
46608 #: guix-git/doc/guix.texi:26124
46610 msgid "@code{dnskey-ttl} (default: @code{'default})"
46614 #: guix-git/doc/guix.texi:26127
46615 msgid "The TTL value for DNSKEY records added into zone apex. The special @code{'default} value means same as the zone SOA TTL."
46619 #: guix-git/doc/guix.texi:26128
46621 msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})"
46625 #: guix-git/doc/guix.texi:26130
46626 msgid "The period between ZSK publication and the next rollover initiation."
46630 #: guix-git/doc/guix.texi:26131
46632 msgid "@code{propagation-delay} (default: @code{(* 24 3600)})"
46636 #: guix-git/doc/guix.texi:26134
46637 msgid "An extra delay added for each key rollover step. This value should be high enough to cover propagation of data from the master server to all slaves."
46641 #: guix-git/doc/guix.texi:26135
46643 msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})"
46647 #: guix-git/doc/guix.texi:26137
46648 msgid "A validity period of newly issued signatures."
46652 #: guix-git/doc/guix.texi:26138
46654 msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})"
46658 #: guix-git/doc/guix.texi:26140
46659 msgid "A period how long before a signature expiration the signature will be refreshed."
46663 #: guix-git/doc/guix.texi:26141
46665 msgid "@code{nsec3?} (default: @code{#f})"
46669 #: guix-git/doc/guix.texi:26143
46670 msgid "When @code{#t}, NSEC3 will be used instead of NSEC."
46674 #: guix-git/doc/guix.texi:26144
46676 msgid "@code{nsec3-iterations} (default: @code{5})"
46680 #: guix-git/doc/guix.texi:26146
46681 msgid "The number of additional times the hashing is performed."
46685 #: guix-git/doc/guix.texi:26147
46687 msgid "@code{nsec3-salt-length} (default: @code{8})"
46691 #: guix-git/doc/guix.texi:26150
46692 msgid "The length of a salt field in octets, which is appended to the original owner name before hashing."
46696 #: guix-git/doc/guix.texi:26151
46698 msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})"
46702 #: guix-git/doc/guix.texi:26153
46703 msgid "The validity period of newly issued salt field."
46707 #: guix-git/doc/guix.texi:26157
46709 msgid "{Data Type} knot-zone-configuration"
46713 #: guix-git/doc/guix.texi:26160
46714 msgid "Data type representing a zone served by Knot. This type has the following parameters:"
46718 #: guix-git/doc/guix.texi:26162
46720 msgid "@code{domain} (default: @code{\"\"})"
46724 #: guix-git/doc/guix.texi:26164
46725 msgid "The domain served by this configuration. It must not be empty."
46729 #: guix-git/doc/guix.texi:26165
46731 msgid "@code{file} (default: @code{\"\"})"
46735 #: guix-git/doc/guix.texi:26168
46736 msgid "The file where this zone is saved. This parameter is ignored by master zones. Empty means default location that depends on the domain name."
46740 #: guix-git/doc/guix.texi:26169
46742 msgid "@code{zone} (default: @code{(zone-file)})"
46746 #: guix-git/doc/guix.texi:26172
46747 msgid "The content of the zone file. This parameter is ignored by slave zones. It must contain a zone-file record."
46751 #: guix-git/doc/guix.texi:26173
46753 msgid "@code{master} (default: @code{'()})"
46757 #: guix-git/doc/guix.texi:26176
46758 msgid "A list of master remotes. When empty, this zone is a master. When set, this zone is a slave. This is a list of remotes identifiers."
46762 #: guix-git/doc/guix.texi:26177
46764 msgid "@code{ddns-master} (default: @code{#f})"
46768 #: guix-git/doc/guix.texi:26180
46769 msgid "The main master. When empty, it defaults to the first master in the list of masters."
46773 #: guix-git/doc/guix.texi:26181
46775 msgid "@code{notify} (default: @code{'()})"
46779 #: guix-git/doc/guix.texi:26183
46780 msgid "A list of slave remote identifiers."
46784 #: guix-git/doc/guix.texi:26184
46786 msgid "@code{acl} (default: @code{'()})"
46790 #: guix-git/doc/guix.texi:26186
46791 msgid "A list of acl identifiers."
46795 #: guix-git/doc/guix.texi:26187
46797 msgid "@code{semantic-checks?} (default: @code{#f})"
46801 #: guix-git/doc/guix.texi:26189
46802 msgid "When set, this adds more semantic checks to the zone."
46806 #: guix-git/doc/guix.texi:26190
46808 msgid "@code{disable-any?} (default: @code{#f})"
46812 #: guix-git/doc/guix.texi:26192
46813 msgid "When set, this forbids queries of the ANY type."
46817 #: guix-git/doc/guix.texi:26193
46819 msgid "@code{zonefile-sync} (default: @code{0})"
46823 #: guix-git/doc/guix.texi:26196
46824 msgid "The delay between a modification in memory and on disk. 0 means immediate synchronization."
46828 #: guix-git/doc/guix.texi:26197
46830 msgid "@code{zonefile-load} (default: @code{#f})"
46834 #: guix-git/doc/guix.texi:26200
46835 msgid "The way the zone file contents are applied during zone load. Possible values are:"
46839 #: guix-git/doc/guix.texi:26202
46841 msgid "@code{#f} for using the default value from Knot,"
46845 #: guix-git/doc/guix.texi:26203
46847 msgid "@code{'none} for not using the zone file at all,"
46851 #: guix-git/doc/guix.texi:26204
46853 msgid "@code{'difference} for computing the difference between already available"
46857 #: guix-git/doc/guix.texi:26206
46858 msgid "contents and zone contents and applying it to the current zone contents,"
46862 #: guix-git/doc/guix.texi:26206
46864 msgid "@code{'difference-no-serial} for the same as @code{'difference}, but"
46868 #: guix-git/doc/guix.texi:26209
46869 msgid "ignoring the SOA serial in the zone file, while the server takes care of it automatically."
46873 #: guix-git/doc/guix.texi:26209
46875 msgid "@code{'whole} for loading zone contents from the zone file."
46879 #: guix-git/doc/guix.texi:26212
46881 msgid "@code{journal-content} (default: @code{#f})"
46885 #: guix-git/doc/guix.texi:26217
46886 msgid "The way the journal is used to store zone and its changes. Possible values are @code{'none} to not use it at all, @code{'changes} to store changes and @code{'all} to store contents. @code{#f} does not set this option, so the default value from Knot is used."
46890 #: guix-git/doc/guix.texi:26218
46892 msgid "@code{max-journal-usage} (default: @code{#f})"
46896 #: guix-git/doc/guix.texi:26221
46897 msgid "The maximum size for the journal on disk. @code{#f} does not set this option, so the default value from Knot is used."
46901 #: guix-git/doc/guix.texi:26222
46903 msgid "@code{max-journal-depth} (default: @code{#f})"
46907 #: guix-git/doc/guix.texi:26225
46908 msgid "The maximum size of the history. @code{#f} does not set this option, so the default value from Knot is used."
46912 #: guix-git/doc/guix.texi:26226
46914 msgid "@code{max-zone-size} (default: @code{#f})"
46918 #: guix-git/doc/guix.texi:26230
46919 msgid "The maximum size of the zone file. This limit is enforced for incoming transfer and updates. @code{#f} does not set this option, so the default value from Knot is used."
46923 #: guix-git/doc/guix.texi:26231
46925 msgid "@code{dnssec-policy} (default: @code{#f})"
46929 #: guix-git/doc/guix.texi:26235
46930 msgid "A reference to a @code{knot-policy-configuration} record, or the special name @code{\"default\"}. If the value is @code{#f}, there is no dnssec signing on this zone."
46934 #: guix-git/doc/guix.texi:26236
46936 msgid "@code{serial-policy} (default: @code{'increment})"
46940 #: guix-git/doc/guix.texi:26238
46941 msgid "A policy between @code{'increment} and @code{'unixtime}."
46945 #: guix-git/doc/guix.texi:26242
46947 msgid "{Data Type} knot-configuration"
46951 #: guix-git/doc/guix.texi:26245
46952 msgid "Data type representing the Knot configuration. This type has the following parameters:"
46956 #: guix-git/doc/guix.texi:26247
46958 msgid "@code{knot} (default: @code{knot})"
46962 #: guix-git/doc/guix.texi:26249
46963 msgid "The Knot package."
46967 #: guix-git/doc/guix.texi:26250
46969 msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})"
46973 #: guix-git/doc/guix.texi:26252
46974 msgid "The run directory. This directory will be used for pid file and sockets."
46978 #: guix-git/doc/guix.texi:26253
46980 msgid "@code{includes} (default: @code{'()})"
46984 #: guix-git/doc/guix.texi:26256
46985 msgid "A list of strings or file-like objects denoting other files that must be included at the top of the configuration file."
46989 #: guix-git/doc/guix.texi:26257
46991 msgid "secrets, Knot service"
46995 #: guix-git/doc/guix.texi:26263
46996 msgid "This can be used to manage secrets out-of-band. For example, secret keys may be stored in an out-of-band file not managed by Guix, and thus not visible in @file{/gnu/store}---e.g., you could store secret key configuration in @file{/etc/knot/secrets.conf} and add this file to the @code{includes} list."
47000 #: guix-git/doc/guix.texi:26268
47001 msgid "One can generate a secret tsig key (for nsupdate and zone transfers with the keymgr command from the knot package. Note that the package is not automatically installed by the service. The following example shows how to generate a new tsig key:"
47005 #: guix-git/doc/guix.texi:26272
47008 "keymgr -t mysecret > /etc/knot/secrets.conf\n"
47009 "chmod 600 /etc/knot/secrets.conf\n"
47013 #: guix-git/doc/guix.texi:26278
47014 msgid "Also note that the generated key will be named @var{mysecret}, so it is the name that needs to be used in the @var{key} field of the @code{knot-acl-configuration} record and in other places that need to refer to that key."
47018 #: guix-git/doc/guix.texi:26280
47019 msgid "It can also be used to add configuration not supported by this interface."
47023 #: guix-git/doc/guix.texi:26281
47025 msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})"
47029 #: guix-git/doc/guix.texi:26283 guix-git/doc/guix.texi:26286
47030 msgid "An ip address on which to listen."
47034 #: guix-git/doc/guix.texi:26284
47036 msgid "@code{listen-v6} (default: @code{\"::\"})"
47040 #: guix-git/doc/guix.texi:26287
47042 msgid "@code{listen-port} (default: @code{53})"
47046 #: guix-git/doc/guix.texi:26289
47047 msgid "A port on which to listen."
47051 #: guix-git/doc/guix.texi:26290
47053 msgid "@code{keys} (default: @code{'()})"
47057 #: guix-git/doc/guix.texi:26292
47058 msgid "The list of knot-key-configuration used by this configuration."
47062 #: guix-git/doc/guix.texi:26293
47064 msgid "@code{acls} (default: @code{'()})"
47068 #: guix-git/doc/guix.texi:26295
47069 msgid "The list of knot-acl-configuration used by this configuration."
47073 #: guix-git/doc/guix.texi:26296
47075 msgid "@code{remotes} (default: @code{'()})"
47079 #: guix-git/doc/guix.texi:26298
47080 msgid "The list of knot-remote-configuration used by this configuration."
47084 #: guix-git/doc/guix.texi:26299
47086 msgid "@code{zones} (default: @code{'()})"
47090 #: guix-git/doc/guix.texi:26301
47091 msgid "The list of knot-zone-configuration used by this configuration."
47094 #. type: subsubheading
47095 #: guix-git/doc/guix.texi:26305
47097 msgid "Knot Resolver Service"
47101 #: guix-git/doc/guix.texi:26307
47103 msgid "{Scheme Variable} knot-resolver-service-type"
47107 #: guix-git/doc/guix.texi:26310
47108 msgid "This is the type of the knot resolver service, whose value should be an @code{knot-resolver-configuration} object as in this example:"
47112 #: guix-git/doc/guix.texi:26320
47115 "(service knot-resolver-service-type\n"
47116 " (knot-resolver-configuration\n"
47117 " (kresd-config-file (plain-file \"kresd.conf\" \"\n"
47118 "net.listen('192.168.0.1', 5353)\n"
47119 "user('knot-resolver', 'knot-resolver')\n"
47120 "modules = @{ 'hints > iterate', 'stats', 'predict' @}\n"
47121 "cache.size = 100 * MB\n"
47126 #: guix-git/doc/guix.texi:26323
47127 msgid "For more information, refer its @url{https://knot-resolver.readthedocs.org/en/stable/daemon.html#configuration, manual}."
47131 #: guix-git/doc/guix.texi:26325
47133 msgid "{Data Type} knot-resolver-configuration"
47137 #: guix-git/doc/guix.texi:26327
47138 msgid "Data type representing the configuration of knot-resolver."
47142 #: guix-git/doc/guix.texi:26329
47144 msgid "@code{package} (default: @var{knot-resolver})"
47148 #: guix-git/doc/guix.texi:26331
47149 msgid "Package object of the knot DNS resolver."
47153 #: guix-git/doc/guix.texi:26332
47155 msgid "@code{kresd-config-file} (default: %kresd.conf)"
47159 #: guix-git/doc/guix.texi:26335
47160 msgid "File-like object of the kresd configuration file to use, by default it will listen on @code{127.0.0.1} and @code{::1}."
47164 #: guix-git/doc/guix.texi:26336
47166 msgid "@code{garbage-collection-interval} (default: 1000)"
47170 #: guix-git/doc/guix.texi:26338
47171 msgid "Number of milliseconds for @code{kres-cache-gc} to periodically trim the cache."
47174 #. type: subsubheading
47175 #: guix-git/doc/guix.texi:26343
47177 msgid "Dnsmasq Service"
47181 #: guix-git/doc/guix.texi:26345
47183 msgid "{Scheme Variable} dnsmasq-service-type"
47187 #: guix-git/doc/guix.texi:26348
47188 msgid "This is the type of the dnsmasq service, whose value should be an @code{dnsmasq-configuration} object as in this example:"
47192 #: guix-git/doc/guix.texi:26354
47195 "(service dnsmasq-service-type\n"
47196 " (dnsmasq-configuration\n"
47197 " (no-resolv? #t)\n"
47198 " (servers '(\"192.168.1.1\"))))\n"
47202 #: guix-git/doc/guix.texi:26357
47204 msgid "{Data Type} dnsmasq-configuration"
47208 #: guix-git/doc/guix.texi:26359
47209 msgid "Data type representing the configuration of dnsmasq."
47213 #: guix-git/doc/guix.texi:26361
47215 msgid "@code{package} (default: @var{dnsmasq})"
47219 #: guix-git/doc/guix.texi:26363
47220 msgid "Package object of the dnsmasq server."
47224 #: guix-git/doc/guix.texi:26364
47226 msgid "@code{no-hosts?} (default: @code{#f})"
47230 #: guix-git/doc/guix.texi:26366
47231 msgid "When true, don't read the hostnames in /etc/hosts."
47235 #: guix-git/doc/guix.texi:26367
47237 msgid "@code{port} (default: @code{53})"
47241 #: guix-git/doc/guix.texi:26370
47242 msgid "The port to listen on. Setting this to zero completely disables DNS responses, leaving only DHCP and/or TFTP functions."
47246 #: guix-git/doc/guix.texi:26371
47248 msgid "@code{local-service?} (default: @code{#t})"
47252 #: guix-git/doc/guix.texi:26374
47253 msgid "Accept DNS queries only from hosts whose address is on a local subnet, ie a subnet for which an interface exists on the server."
47257 #: guix-git/doc/guix.texi:26375
47259 msgid "@code{listen-addresses} (default: @code{'()})"
47263 #: guix-git/doc/guix.texi:26377
47264 msgid "Listen on the given IP addresses."
47268 #: guix-git/doc/guix.texi:26378
47270 msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})"
47274 #: guix-git/doc/guix.texi:26380
47275 msgid "The file to read the IP address of the upstream nameservers from."
47279 #: guix-git/doc/guix.texi:26381
47281 msgid "@code{no-resolv?} (default: @code{#f})"
47285 #: guix-git/doc/guix.texi:26383
47286 msgid "When true, don't read @var{resolv-file}."
47290 #: guix-git/doc/guix.texi:26384
47292 msgid "@code{servers} (default: @code{'()})"
47296 #: guix-git/doc/guix.texi:26386
47297 msgid "Specify IP address of upstream servers directly."
47301 #: guix-git/doc/guix.texi:26387
47303 msgid "@code{addresses} (default: @code{'()})"
47307 #: guix-git/doc/guix.texi:26391
47308 msgid "For each entry, specify an IP address to return for any host in the given domains. Queries in the domains are never forwarded and always replied to with the specified IP address."
47312 #: guix-git/doc/guix.texi:26393
47313 msgid "This is useful for redirecting hosts locally, for example:"
47317 #: guix-git/doc/guix.texi:26402
47320 "(service dnsmasq-service-type\n"
47321 " (dnsmasq-configuration\n"
47323 " '(; Redirect to a local web-server.\n"
47324 " \"/example.org/127.0.0.1\"\n"
47325 " ; Redirect subdomain to a specific IP.\n"
47326 " \"/subdomain.example.org/192.168.1.42\"))))\n"
47330 #: guix-git/doc/guix.texi:26405
47331 msgid "Note that rules in @file{/etc/hosts} take precedence over this."
47335 #: guix-git/doc/guix.texi:26406
47337 msgid "@code{cache-size} (default: @code{150})"
47341 #: guix-git/doc/guix.texi:26409
47342 msgid "Set the size of dnsmasq's cache. Setting the cache size to zero disables caching."
47346 #: guix-git/doc/guix.texi:26410
47348 msgid "@code{negative-cache?} (default: @code{#t})"
47352 #: guix-git/doc/guix.texi:26412
47353 msgid "When false, disable negative caching."
47357 #: guix-git/doc/guix.texi:26413
47359 msgid "@code{tftp-enable?} (default: @code{#f})"
47363 #: guix-git/doc/guix.texi:26415
47364 msgid "Whether to enable the built-in TFTP server."
47368 #: guix-git/doc/guix.texi:26416
47370 msgid "@code{tftp-no-fail?} (default: @code{#f})"
47374 #: guix-git/doc/guix.texi:26418
47375 msgid "If true, does not fail dnsmasq if the TFTP server could not start up."
47379 #: guix-git/doc/guix.texi:26419
47381 msgid "@code{tftp-single-port?} (default: @code{#f})"
47385 #: guix-git/doc/guix.texi:26421
47386 msgid "Whether to use only one single port for TFTP."
47390 #: guix-git/doc/guix.texi:26422
47392 msgid "@code{tftp-secure?} (default: @code{#f})"
47396 #: guix-git/doc/guix.texi:26424
47397 msgid "If true, only files owned by the user running the dnsmasq process are accessible."
47401 #: guix-git/doc/guix.texi:26428
47402 msgid "If dnsmasq is being run as root, different rules apply: @code{tftp-secure?} has no effect, but only files which have the world-readable bit set are accessible."
47406 #: guix-git/doc/guix.texi:26429
47408 msgid "@code{tftp-max} (default: @code{#f})"
47412 #: guix-git/doc/guix.texi:26431
47413 msgid "If set, sets the maximal number of concurrent connections allowed."
47417 #: guix-git/doc/guix.texi:26432
47419 msgid "@code{tftp-mtu} (default: @code{#f})"
47423 #: guix-git/doc/guix.texi:26434
47424 msgid "If set, sets the MTU for TFTP packets to that value."
47428 #: guix-git/doc/guix.texi:26435
47430 msgid "@code{tftp-no-blocksize?} (default: @code{#f})"
47434 #: guix-git/doc/guix.texi:26437
47435 msgid "If true, stops the TFTP server from negotiating the blocksize with a client."
47439 #: guix-git/doc/guix.texi:26438
47441 msgid "@code{tftp-lowercase?} (default: @code{#f})"
47445 #: guix-git/doc/guix.texi:26440
47446 msgid "Whether to convert all filenames in TFTP requests to lowercase."
47450 #: guix-git/doc/guix.texi:26441
47452 msgid "@code{tftp-port-range} (default: @code{#f})"
47456 #: guix-git/doc/guix.texi:26444
47457 msgid "If set, fixes the dynamical ports (one per client) to the given range (@code{\"<start>,<end>\"})."
47461 #: guix-git/doc/guix.texi:26445
47463 msgid "@code{tftp-root} (default: @code{/var/empty,lo})"
47467 #: guix-git/doc/guix.texi:26452
47468 msgid "Look for files to transfer using TFTP relative to the given directory. When this is set, TFTP paths which include @samp{..} are rejected, to stop clients getting outside the specified root. Absolute paths (starting with @samp{/}) are allowed, but they must be within the TFTP-root. If the optional interface argument is given, the directory is only used for TFTP requests via that interface."
47472 #: guix-git/doc/guix.texi:26453
47474 msgid "@code{tftp-unique-root} (default: @code{#f})"
47478 #: guix-git/doc/guix.texi:26458
47479 msgid "If set, add the IP or hardware address of the TFTP client as a path component on the end of the TFTP-root. Only valid if a TFTP root is set and the directory exists. Defaults to adding IP address (in standard dotted-quad format)."
47483 #: guix-git/doc/guix.texi:26467
47484 msgid "For instance, if @option{--tftp-root} is @samp{/tftp} and client @samp{1.2.3.4} requests file @file{myfile} then the effective path will be @file{/tftp/1.2.3.4/myfile} if @file{/tftp/1.2.3.4} exists or @file{/tftp/myfile} otherwise. When @samp{=mac} is specified it will append the MAC address instead, using lowercase zero padded digits separated by dashes, e.g.: @samp{01-02-03-04-aa-bb}. Note that resolving MAC addresses is only possible if the client is in the local network or obtained a DHCP lease from dnsmasq."
47487 #. type: subsubheading
47488 #: guix-git/doc/guix.texi:26471
47490 msgid "ddclient Service"
47494 #: guix-git/doc/guix.texi:26473
47499 #. type: Plain text
47500 #: guix-git/doc/guix.texi:26477
47501 msgid "The ddclient service described below runs the ddclient daemon, which takes care of automatically updating DNS entries for service providers such as @uref{https://dyn.com/dns/, Dyn}."
47504 #. type: Plain text
47505 #: guix-git/doc/guix.texi:26480
47506 msgid "The following example show instantiates the service with its default configuration:"
47510 #: guix-git/doc/guix.texi:26483
47512 msgid "(service ddclient-service-type)\n"
47515 #. type: Plain text
47516 #: guix-git/doc/guix.texi:26492
47517 msgid "Note that ddclient needs to access credentials that are stored in a @dfn{secret file}, by default @file{/etc/ddclient/secrets} (see @code{secret-file} below). You are expected to create this file manually, in an ``out-of-band'' fashion (you @emph{could} make this file part of the service configuration, for instance by using @code{plain-file}, but it will be world-readable @i{via} @file{/gnu/store}). See the examples in the @file{share/ddclient} directory of the @code{ddclient} package."
47520 #. type: Plain text
47521 #: guix-git/doc/guix.texi:26496
47522 msgid "Available @code{ddclient-configuration} fields are:"
47526 #: guix-git/doc/guix.texi:26497
47528 msgid "{@code{ddclient-configuration} parameter} package ddclient"
47532 #: guix-git/doc/guix.texi:26499
47533 msgid "The ddclient package."
47537 #: guix-git/doc/guix.texi:26502
47539 msgid "{@code{ddclient-configuration} parameter} integer daemon"
47543 #: guix-git/doc/guix.texi:26504
47544 msgid "The period after which ddclient will retry to check IP and domain name."
47548 #: guix-git/doc/guix.texi:26509
47550 msgid "{@code{ddclient-configuration} parameter} boolean syslog"
47554 #: guix-git/doc/guix.texi:26511
47555 msgid "Use syslog for the output."
47559 #: guix-git/doc/guix.texi:26516
47561 msgid "{@code{ddclient-configuration} parameter} string mail"
47565 #: guix-git/doc/guix.texi:26518
47566 msgid "Mail to user."
47570 #: guix-git/doc/guix.texi:26520 guix-git/doc/guix.texi:26527
47571 #: guix-git/doc/guix.texi:28264
47572 msgid "Defaults to @samp{\"root\"}."
47576 #: guix-git/doc/guix.texi:26523
47578 msgid "{@code{ddclient-configuration} parameter} string mail-failure"
47582 #: guix-git/doc/guix.texi:26525
47583 msgid "Mail failed update to user."
47587 #: guix-git/doc/guix.texi:26530
47589 msgid "{@code{ddclient-configuration} parameter} string pid"
47593 #: guix-git/doc/guix.texi:26532
47594 msgid "The ddclient PID file."
47598 #: guix-git/doc/guix.texi:26534
47599 msgid "Defaults to @samp{\"/var/run/ddclient/ddclient.pid\"}."
47603 #: guix-git/doc/guix.texi:26537
47605 msgid "{@code{ddclient-configuration} parameter} boolean ssl"
47609 #: guix-git/doc/guix.texi:26539
47610 msgid "Enable SSL support."
47614 #: guix-git/doc/guix.texi:26544
47616 msgid "{@code{ddclient-configuration} parameter} string user"
47620 #: guix-git/doc/guix.texi:26547
47621 msgid "Specifies the user name or ID that is used when running ddclient program."
47625 #: guix-git/doc/guix.texi:26549 guix-git/doc/guix.texi:26556
47626 msgid "Defaults to @samp{\"ddclient\"}."
47630 #: guix-git/doc/guix.texi:26552
47632 msgid "{@code{ddclient-configuration} parameter} string group"
47636 #: guix-git/doc/guix.texi:26554
47637 msgid "Group of the user who will run the ddclient program."
47641 #: guix-git/doc/guix.texi:26559
47643 msgid "{@code{ddclient-configuration} parameter} string secret-file"
47647 #: guix-git/doc/guix.texi:26563
47648 msgid "Secret file which will be appended to @file{ddclient.conf} file. This file contains credentials for use by ddclient. You are expected to create it manually."
47652 #: guix-git/doc/guix.texi:26565
47653 msgid "Defaults to @samp{\"/etc/ddclient/secrets.conf\"}."
47657 #: guix-git/doc/guix.texi:26568
47659 msgid "{@code{ddclient-configuration} parameter} list extra-options"
47663 #: guix-git/doc/guix.texi:26570
47664 msgid "Extra options will be appended to @file{ddclient.conf} file."
47668 #: guix-git/doc/guix.texi:26581
47670 msgid "VPN (virtual private network)"
47674 #: guix-git/doc/guix.texi:26582
47676 msgid "virtual private network (VPN)"
47679 #. type: Plain text
47680 #: guix-git/doc/guix.texi:26586
47681 msgid "The @code{(gnu services vpn)} module provides services related to @dfn{virtual private networks} (VPNs)."
47684 #. type: subsubheading
47685 #: guix-git/doc/guix.texi:26587
47690 #. type: Plain text
47691 #: guix-git/doc/guix.texi:26591
47692 msgid "It provides a @emph{client} service for your machine to connect to a VPN, and a @emph{server} service for your machine to host a VPN@."
47696 #: guix-git/doc/guix.texi:26592
47698 msgid "{Scheme Procedure} openvpn-client-service @"
47702 #: guix-git/doc/guix.texi:26594
47703 msgid "[#:config (openvpn-client-configuration)]"
47707 #: guix-git/doc/guix.texi:26596
47708 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a client."
47712 #: guix-git/doc/guix.texi:26598
47714 msgid "{Scheme Procedure} openvpn-server-service @"
47718 #: guix-git/doc/guix.texi:26600
47719 msgid "[#:config (openvpn-server-configuration)]"
47723 #: guix-git/doc/guix.texi:26602
47724 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a server."
47728 #: guix-git/doc/guix.texi:26604
47729 msgid "Both can be run simultaneously."
47732 #. type: Plain text
47733 #: guix-git/doc/guix.texi:26609
47734 msgid "Available @code{openvpn-client-configuration} fields are:"
47738 #: guix-git/doc/guix.texi:26610
47740 msgid "{@code{openvpn-client-configuration} parameter} package openvpn"
47744 #: guix-git/doc/guix.texi:26612 guix-git/doc/guix.texi:26767
47745 msgid "The OpenVPN package."
47749 #: guix-git/doc/guix.texi:26615
47751 msgid "{@code{openvpn-client-configuration} parameter} string pid-file"
47755 #: guix-git/doc/guix.texi:26617 guix-git/doc/guix.texi:26772
47756 msgid "The OpenVPN pid file."
47760 #: guix-git/doc/guix.texi:26619 guix-git/doc/guix.texi:26774
47761 msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}."
47765 #: guix-git/doc/guix.texi:26622
47767 msgid "{@code{openvpn-client-configuration} parameter} proto proto"
47771 #: guix-git/doc/guix.texi:26625 guix-git/doc/guix.texi:26780
47772 msgid "The protocol (UDP or TCP) used to open a channel between clients and servers."
47776 #: guix-git/doc/guix.texi:26627 guix-git/doc/guix.texi:26782
47777 msgid "Defaults to @samp{udp}."
47781 #: guix-git/doc/guix.texi:26630
47783 msgid "{@code{openvpn-client-configuration} parameter} dev dev"
47787 #: guix-git/doc/guix.texi:26632 guix-git/doc/guix.texi:26787
47788 msgid "The device type used to represent the VPN connection."
47792 #: guix-git/doc/guix.texi:26634 guix-git/doc/guix.texi:26789
47793 msgid "Defaults to @samp{tun}."
47796 #. type: Plain text
47797 #: guix-git/doc/guix.texi:26640 guix-git/doc/guix.texi:26795
47798 msgid "If you do not have some of these files (eg.@: you use a username and password), you can disable any of the following three fields by setting it to @code{'disabled}."
47802 #: guix-git/doc/guix.texi:26641
47804 msgid "{@code{openvpn-client-configuration} parameter} maybe-string ca"
47808 #: guix-git/doc/guix.texi:26643 guix-git/doc/guix.texi:26798
47809 msgid "The certificate authority to check connections against."
47813 #: guix-git/doc/guix.texi:26645 guix-git/doc/guix.texi:26800
47814 msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}."
47818 #: guix-git/doc/guix.texi:26648
47820 msgid "{@code{openvpn-client-configuration} parameter} maybe-string cert"
47824 #: guix-git/doc/guix.texi:26651 guix-git/doc/guix.texi:26806
47825 msgid "The certificate of the machine the daemon is running on. It should be signed by the authority given in @code{ca}."
47829 #: guix-git/doc/guix.texi:26653 guix-git/doc/guix.texi:26808
47830 msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}."
47834 #: guix-git/doc/guix.texi:26656
47836 msgid "{@code{openvpn-client-configuration} parameter} maybe-string key"
47840 #: guix-git/doc/guix.texi:26659 guix-git/doc/guix.texi:26814
47841 msgid "The key of the machine the daemon is running on. It must be the key whose certificate is @code{cert}."
47845 #: guix-git/doc/guix.texi:26661 guix-git/doc/guix.texi:26816
47846 msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}."
47850 #: guix-git/doc/guix.texi:26664
47852 msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?"
47856 #: guix-git/doc/guix.texi:26666 guix-git/doc/guix.texi:26821
47857 msgid "Whether to use the lzo compression algorithm."
47861 #: guix-git/doc/guix.texi:26671
47863 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?"
47867 #: guix-git/doc/guix.texi:26673 guix-git/doc/guix.texi:26828
47868 msgid "Don't re-read key files across SIGUSR1 or --ping-restart."
47872 #: guix-git/doc/guix.texi:26678
47874 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?"
47878 #: guix-git/doc/guix.texi:26681 guix-git/doc/guix.texi:26836
47879 msgid "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts."
47883 #: guix-git/doc/guix.texi:26686
47885 msgid "{@code{openvpn-client-configuration} parameter} boolean fast-io?"
47889 #: guix-git/doc/guix.texi:26689 guix-git/doc/guix.texi:26844
47890 msgid "(Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/epoll/select prior to the write operation."
47894 #: guix-git/doc/guix.texi:26693
47896 msgid "{@code{openvpn-client-configuration} parameter} number verbosity"
47900 #: guix-git/doc/guix.texi:26695 guix-git/doc/guix.texi:26850
47901 msgid "Verbosity level."
47905 #: guix-git/doc/guix.texi:26697 guix-git/doc/guix.texi:26852
47906 #: guix-git/doc/guix.texi:28532 guix-git/doc/guix.texi:28756
47907 msgid "Defaults to @samp{3}."
47911 #: guix-git/doc/guix.texi:26700
47913 msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth"
47917 #: guix-git/doc/guix.texi:26703 guix-git/doc/guix.texi:26858
47918 msgid "Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks."
47922 #: guix-git/doc/guix.texi:26708
47924 msgid "{@code{openvpn-client-configuration} parameter} maybe-string auth-user-pass"
47928 #: guix-git/doc/guix.texi:26712
47929 msgid "Authenticate with server using username/password. The option is a file containing username/password on 2 lines. Do not use a file-like object as it would be added to the store and readable by any user."
47933 #: guix-git/doc/guix.texi:26714
47934 msgid "Defaults to @samp{'disabled}."
47938 #: guix-git/doc/guix.texi:26716
47940 msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?"
47944 #: guix-git/doc/guix.texi:26718
47945 msgid "Whether to check the server certificate has server usage extension."
47949 #: guix-git/doc/guix.texi:26723
47951 msgid "{@code{openvpn-client-configuration} parameter} bind bind?"
47955 #: guix-git/doc/guix.texi:26725
47956 msgid "Bind to a specific local port number."
47960 #: guix-git/doc/guix.texi:26730
47962 msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?"
47966 #: guix-git/doc/guix.texi:26732
47967 msgid "Retry resolving server address."
47971 #: guix-git/doc/guix.texi:26737
47973 msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote"
47977 #: guix-git/doc/guix.texi:26739
47978 msgid "A list of remote servers to connect to."
47982 #: guix-git/doc/guix.texi:26743
47983 msgid "Available @code{openvpn-remote-configuration} fields are:"
47987 #: guix-git/doc/guix.texi:26744
47989 msgid "{@code{openvpn-remote-configuration} parameter} string name"
47993 #: guix-git/doc/guix.texi:26746
47994 msgid "Server name."
47998 #: guix-git/doc/guix.texi:26748
47999 msgid "Defaults to @samp{\"my-server\"}."
48003 #: guix-git/doc/guix.texi:26751
48005 msgid "{@code{openvpn-remote-configuration} parameter} number port"
48009 #: guix-git/doc/guix.texi:26753
48010 msgid "Port number the server listens to."
48014 #: guix-git/doc/guix.texi:26755 guix-git/doc/guix.texi:26867
48015 msgid "Defaults to @samp{1194}."
48018 #. type: Plain text
48019 #: guix-git/doc/guix.texi:26764
48020 msgid "Available @code{openvpn-server-configuration} fields are:"
48024 #: guix-git/doc/guix.texi:26765
48026 msgid "{@code{openvpn-server-configuration} parameter} package openvpn"
48030 #: guix-git/doc/guix.texi:26770
48032 msgid "{@code{openvpn-server-configuration} parameter} string pid-file"
48036 #: guix-git/doc/guix.texi:26777
48038 msgid "{@code{openvpn-server-configuration} parameter} proto proto"
48042 #: guix-git/doc/guix.texi:26785
48044 msgid "{@code{openvpn-server-configuration} parameter} dev dev"
48048 #: guix-git/doc/guix.texi:26796
48050 msgid "{@code{openvpn-server-configuration} parameter} maybe-string ca"
48054 #: guix-git/doc/guix.texi:26803
48056 msgid "{@code{openvpn-server-configuration} parameter} maybe-string cert"
48060 #: guix-git/doc/guix.texi:26811
48062 msgid "{@code{openvpn-server-configuration} parameter} maybe-string key"
48066 #: guix-git/doc/guix.texi:26819
48068 msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?"
48072 #: guix-git/doc/guix.texi:26826
48074 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?"
48078 #: guix-git/doc/guix.texi:26833
48080 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?"
48084 #: guix-git/doc/guix.texi:26841
48086 msgid "{@code{openvpn-server-configuration} parameter} boolean fast-io?"
48090 #: guix-git/doc/guix.texi:26848
48092 msgid "{@code{openvpn-server-configuration} parameter} number verbosity"
48096 #: guix-git/doc/guix.texi:26855
48098 msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth"
48102 #: guix-git/doc/guix.texi:26863
48104 msgid "{@code{openvpn-server-configuration} parameter} number port"
48108 #: guix-git/doc/guix.texi:26865
48109 msgid "Specifies the port number on which the server listens."
48113 #: guix-git/doc/guix.texi:26870
48115 msgid "{@code{openvpn-server-configuration} parameter} ip-mask server"
48119 #: guix-git/doc/guix.texi:26872
48120 msgid "An ip and mask specifying the subnet inside the virtual network."
48124 #: guix-git/doc/guix.texi:26874
48125 msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}."
48129 #: guix-git/doc/guix.texi:26877
48131 msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6"
48135 #: guix-git/doc/guix.texi:26879
48136 msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network."
48140 #: guix-git/doc/guix.texi:26884
48142 msgid "{@code{openvpn-server-configuration} parameter} string dh"
48146 #: guix-git/doc/guix.texi:26886
48147 msgid "The Diffie-Hellman parameters file."
48151 #: guix-git/doc/guix.texi:26888
48152 msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}."
48156 #: guix-git/doc/guix.texi:26891
48158 msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist"
48162 #: guix-git/doc/guix.texi:26893
48163 msgid "The file that records client IPs."
48167 #: guix-git/doc/guix.texi:26895
48168 msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}."
48172 #: guix-git/doc/guix.texi:26898
48174 msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?"
48178 #: guix-git/doc/guix.texi:26900
48179 msgid "When true, the server will act as a gateway for its clients."
48183 #: guix-git/doc/guix.texi:26905
48185 msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?"
48189 #: guix-git/doc/guix.texi:26907
48190 msgid "When true, clients are allowed to talk to each other inside the VPN."
48194 #: guix-git/doc/guix.texi:26912
48196 msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive"
48200 #: guix-git/doc/guix.texi:26918
48201 msgid "Causes ping-like messages to be sent back and forth over the link so that each side knows when the other side has gone down. @code{keepalive} requires a pair. The first element is the period of the ping sending, and the second element is the timeout before considering the other side down."
48205 #: guix-git/doc/guix.texi:26921
48207 msgid "{@code{openvpn-server-configuration} parameter} number max-clients"
48211 #: guix-git/doc/guix.texi:26923
48212 msgid "The maximum number of clients."
48216 #: guix-git/doc/guix.texi:26928
48218 msgid "{@code{openvpn-server-configuration} parameter} string status"
48222 #: guix-git/doc/guix.texi:26931
48223 msgid "The status file. This file shows a small report on current connection. It is truncated and rewritten every minute."
48227 #: guix-git/doc/guix.texi:26933
48228 msgid "Defaults to @samp{\"/var/run/openvpn/status\"}."
48232 #: guix-git/doc/guix.texi:26936
48234 msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir"
48238 #: guix-git/doc/guix.texi:26938
48239 msgid "The list of configuration for some clients."
48243 #: guix-git/doc/guix.texi:26942
48244 msgid "Available @code{openvpn-ccd-configuration} fields are:"
48248 #: guix-git/doc/guix.texi:26943
48250 msgid "{@code{openvpn-ccd-configuration} parameter} string name"
48254 #: guix-git/doc/guix.texi:26945
48255 msgid "Client name."
48259 #: guix-git/doc/guix.texi:26947
48260 msgid "Defaults to @samp{\"client\"}."
48264 #: guix-git/doc/guix.texi:26950
48266 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute"
48270 #: guix-git/doc/guix.texi:26952
48271 msgid "Client own network"
48275 #: guix-git/doc/guix.texi:26957
48277 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push"
48281 #: guix-git/doc/guix.texi:26959
48282 msgid "Client VPN IP."
48285 #. type: subsubheading
48286 #: guix-git/doc/guix.texi:26969
48292 #: guix-git/doc/guix.texi:26971
48294 msgid "{Scheme Variable} wireguard-service-type"
48298 #: guix-git/doc/guix.texi:26974
48299 msgid "A service type for a Wireguard tunnel interface. Its value must be a @code{wireguard-configuration} record as in this example:"
48303 #: guix-git/doc/guix.texi:26985
48306 "(service wireguard-service-type\n"
48307 " (wireguard-configuration\n"
48310 " (wireguard-peer\n"
48311 " (name \"my-peer\")\n"
48312 " (endpoint \"my.wireguard.com:51820\")\n"
48313 " (public-key \"hzpKg9X1yqu1axN6iJp0mWf6BZGo8m1wteKwtTmDGF4=\")\n"
48314 " (allowed-ips '(\"10.0.0.2/32\")))))))\n"
48318 #: guix-git/doc/guix.texi:26989
48320 msgid "{Data Type} wireguard-configuration"
48324 #: guix-git/doc/guix.texi:26991
48325 msgid "Data type representing the configuration of the Wireguard service."
48329 #: guix-git/doc/guix.texi:26993
48335 #: guix-git/doc/guix.texi:26995
48336 msgid "The wireguard package to use for this service."
48340 #: guix-git/doc/guix.texi:26996
48342 msgid "@code{interface} (default: @code{\"wg0\"})"
48346 #: guix-git/doc/guix.texi:26998
48347 msgid "The interface name for the VPN."
48351 #: guix-git/doc/guix.texi:26999
48353 msgid "@code{addresses} (default: @code{'(\"10.0.0.1/32\")})"
48357 #: guix-git/doc/guix.texi:27001
48358 msgid "The IP addresses to be assigned to the above interface."
48362 #: guix-git/doc/guix.texi:27002
48364 msgid "@code{private-key} (default: @code{\"/etc/wireguard/private.key\"})"
48368 #: guix-git/doc/guix.texi:27005
48369 msgid "The private key file for the interface. It is automatically generated if the file does not exist."
48373 #: guix-git/doc/guix.texi:27006
48375 msgid "@code{peers} (default: @code{'()})"
48379 #: guix-git/doc/guix.texi:27009
48380 msgid "The authorized peers on this interface. This is a list of @var{wireguard-peer} records."
48384 #: guix-git/doc/guix.texi:27013
48386 msgid "{Data Type} wireguard-peer"
48390 #: guix-git/doc/guix.texi:27015
48391 msgid "Data type representing a Wireguard peer attached to a given interface."
48395 #: guix-git/doc/guix.texi:27019
48396 msgid "The peer name."
48400 #: guix-git/doc/guix.texi:27020
48402 msgid "@code{endpoint} (default: @code{#f})"
48406 #: guix-git/doc/guix.texi:27023
48407 msgid "The optional endpoint for the peer, such as @code{\"demo.wireguard.com:51820\"}."
48411 #: guix-git/doc/guix.texi:27024 guix-git/doc/guix.texi:27408
48412 #: guix-git/doc/guix.texi:27442 guix-git/doc/guix.texi:32244
48418 #: guix-git/doc/guix.texi:27026
48419 msgid "The peer public-key represented as a base64 string."
48423 #: guix-git/doc/guix.texi:27027
48425 msgid "allowed-ips"
48429 #: guix-git/doc/guix.texi:27030
48430 msgid "A list of IP addresses from which incoming traffic for this peer is allowed and to which incoming traffic for this peer is directed."
48434 #: guix-git/doc/guix.texi:27036
48439 #. type: Plain text
48440 #: guix-git/doc/guix.texi:27041
48441 msgid "The @code{(gnu services nfs)} module provides the following services, which are most commonly used in relation to mounting or exporting directory trees as @dfn{network file systems} (NFS)."
48444 #. type: Plain text
48445 #: guix-git/doc/guix.texi:27045
48446 msgid "While it is possible to use the individual components that together make up a Network File System service, we recommended to configure an NFS server with the @code{nfs-service-type}."
48449 #. type: subsubheading
48450 #: guix-git/doc/guix.texi:27046
48452 msgid "NFS Service"
48456 #: guix-git/doc/guix.texi:27047
48458 msgid "NFS, server"
48461 #. type: Plain text
48462 #: guix-git/doc/guix.texi:27052
48463 msgid "The NFS service takes care of setting up all NFS component services, kernel configuration file systems, and installs configuration files in the locations that NFS expects."
48467 #: guix-git/doc/guix.texi:27053
48469 msgid "{Scheme Variable} nfs-service-type"
48473 #: guix-git/doc/guix.texi:27055
48474 msgid "A service type for a complete NFS server."
48478 #: guix-git/doc/guix.texi:27057
48480 msgid "{Data Type} nfs-configuration"
48484 #: guix-git/doc/guix.texi:27060
48485 msgid "This data type represents the configuration of the NFS service and all of its subsystems."
48489 #: guix-git/doc/guix.texi:27062
48490 msgid "It has the following parameters:"
48494 #: guix-git/doc/guix.texi:27063 guix-git/doc/guix.texi:27188
48495 #: guix-git/doc/guix.texi:27213
48497 msgid "@code{nfs-utils} (default: @code{nfs-utils})"
48501 #: guix-git/doc/guix.texi:27065
48502 msgid "The nfs-utils package to use."
48506 #: guix-git/doc/guix.texi:27066
48508 msgid "@code{nfs-versions} (default: @code{'(\"4.2\" \"4.1\" \"4.0\")})"
48512 #: guix-git/doc/guix.texi:27069
48513 msgid "If a list of string values is provided, the @command{rpc.nfsd} daemon will be limited to supporting the given versions of the NFS protocol."
48517 #: guix-git/doc/guix.texi:27070
48519 msgid "@code{exports} (default: @code{'()})"
48523 #: guix-git/doc/guix.texi:27075
48524 msgid "This is a list of directories the NFS server should export. Each entry is a list consisting of two elements: a directory name and a string containing all options. This is an example in which the directory @file{/export} is served to all NFS clients as a read-only share:"
48528 #: guix-git/doc/guix.texi:27081
48531 "(nfs-configuration\n"
48533 " '((\"/export\"\n"
48534 " \"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)\"))))\n"
48538 #: guix-git/doc/guix.texi:27083
48540 msgid "@code{rpcmountd-port} (default: @code{#f})"
48544 #: guix-git/doc/guix.texi:27085
48545 msgid "The network port that the @command{rpc.mountd} daemon should use."
48549 #: guix-git/doc/guix.texi:27086
48551 msgid "@code{rpcstatd-port} (default: @code{#f})"
48555 #: guix-git/doc/guix.texi:27088
48556 msgid "The network port that the @command{rpc.statd} daemon should use."
48560 #: guix-git/doc/guix.texi:27089 guix-git/doc/guix.texi:27137
48562 msgid "@code{rpcbind} (default: @code{rpcbind})"
48566 #: guix-git/doc/guix.texi:27091 guix-git/doc/guix.texi:27139
48567 msgid "The rpcbind package to use."
48571 #: guix-git/doc/guix.texi:27092
48573 msgid "@code{idmap-domain} (default: @code{\"localdomain\"})"
48577 #: guix-git/doc/guix.texi:27094
48578 msgid "The local NFSv4 domain name."
48582 #: guix-git/doc/guix.texi:27095
48584 msgid "@code{nfsd-port} (default: @code{2049})"
48588 #: guix-git/doc/guix.texi:27097
48589 msgid "The network port that the @command{nfsd} daemon should use."
48593 #: guix-git/doc/guix.texi:27098
48595 msgid "@code{nfsd-threads} (default: @code{8})"
48599 #: guix-git/doc/guix.texi:27100
48600 msgid "The number of threads used by the @command{nfsd} daemon."
48604 #: guix-git/doc/guix.texi:27101
48606 msgid "@code{nfsd-tcp?} (default: @code{#t})"
48610 #: guix-git/doc/guix.texi:27103
48611 msgid "Whether the @command{nfsd} daemon should listen on a TCP socket."
48615 #: guix-git/doc/guix.texi:27104
48617 msgid "@code{nfsd-udp?} (default: @code{#f})"
48621 #: guix-git/doc/guix.texi:27106
48622 msgid "Whether the @command{nfsd} daemon should listen on a UDP socket."
48626 #: guix-git/doc/guix.texi:27107 guix-git/doc/guix.texi:27191
48627 #: guix-git/doc/guix.texi:27216
48629 msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48633 #: guix-git/doc/guix.texi:27109 guix-git/doc/guix.texi:27193
48634 #: guix-git/doc/guix.texi:27218
48635 msgid "The directory where the pipefs file system is mounted."
48639 #: guix-git/doc/guix.texi:27110
48641 msgid "@code{debug} (default: @code{'()\"})"
48645 #: guix-git/doc/guix.texi:27114
48646 msgid "A list of subsystems for which debugging output should be enabled. This is a list of symbols. Any of these symbols are valid: @code{nfsd}, @code{nfs}, @code{rpc}, @code{idmap}, @code{statd}, or @code{mountd}."
48649 #. type: Plain text
48650 #: guix-git/doc/guix.texi:27119
48651 msgid "If you don't need a complete NFS service or prefer to build it yourself you can use the individual component services that are documented below."
48654 #. type: subsubheading
48655 #: guix-git/doc/guix.texi:27120
48657 msgid "RPC Bind Service"
48661 #: guix-git/doc/guix.texi:27121
48666 #. type: Plain text
48667 #: guix-git/doc/guix.texi:27127
48668 msgid "The RPC Bind service provides a facility to map program numbers into universal addresses. Many NFS related services use this facility. Hence it is automatically started when a dependent service starts."
48672 #: guix-git/doc/guix.texi:27128
48674 msgid "{Scheme Variable} rpcbind-service-type"
48678 #: guix-git/doc/guix.texi:27130
48679 msgid "A service type for the RPC portmapper daemon."
48683 #: guix-git/doc/guix.texi:27133
48685 msgid "{Data Type} rpcbind-configuration"
48689 #: guix-git/doc/guix.texi:27136
48690 msgid "Data type representing the configuration of the RPC Bind Service. This type has the following parameters:"
48694 #: guix-git/doc/guix.texi:27140
48696 msgid "@code{warm-start?} (default: @code{#t})"
48700 #: guix-git/doc/guix.texi:27144
48701 msgid "If this parameter is @code{#t}, then the daemon will read a state file on startup thus reloading state information saved by a previous instance."
48704 #. type: subsubheading
48705 #: guix-git/doc/guix.texi:27148
48707 msgid "Pipefs Pseudo File System"
48711 #: guix-git/doc/guix.texi:27149
48717 #: guix-git/doc/guix.texi:27150
48722 #. type: Plain text
48723 #: guix-git/doc/guix.texi:27154
48724 msgid "The pipefs file system is used to transfer NFS related data between the kernel and user space programs."
48728 #: guix-git/doc/guix.texi:27155
48730 msgid "{Scheme Variable} pipefs-service-type"
48734 #: guix-git/doc/guix.texi:27157
48735 msgid "A service type for the pipefs pseudo file system."
48739 #: guix-git/doc/guix.texi:27159
48741 msgid "{Data Type} pipefs-configuration"
48745 #: guix-git/doc/guix.texi:27162
48746 msgid "Data type representing the configuration of the pipefs pseudo file system service. This type has the following parameters:"
48750 #: guix-git/doc/guix.texi:27163
48752 msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48756 #: guix-git/doc/guix.texi:27165
48757 msgid "The directory to which the file system is to be attached."
48760 #. type: subsubheading
48761 #: guix-git/doc/guix.texi:27169
48763 msgid "GSS Daemon Service"
48767 #: guix-git/doc/guix.texi:27170
48773 #: guix-git/doc/guix.texi:27171
48779 #: guix-git/doc/guix.texi:27172
48781 msgid "global security system"
48784 #. type: Plain text
48785 #: guix-git/doc/guix.texi:27179
48786 msgid "The @dfn{global security system} (GSS) daemon provides strong security for RPC based protocols. Before exchanging RPC requests an RPC client must establish a security context. Typically this is done using the Kerberos command @command{kinit} or automatically at login time using PAM services (@pxref{Kerberos Services})."
48790 #: guix-git/doc/guix.texi:27180
48792 msgid "{Scheme Variable} gss-service-type"
48796 #: guix-git/doc/guix.texi:27182
48797 msgid "A service type for the Global Security System (GSS) daemon."
48801 #: guix-git/doc/guix.texi:27184
48803 msgid "{Data Type} gss-configuration"
48807 #: guix-git/doc/guix.texi:27187
48808 msgid "Data type representing the configuration of the GSS daemon service. This type has the following parameters:"
48812 #: guix-git/doc/guix.texi:27190
48813 msgid "The package in which the @command{rpc.gssd} command is to be found."
48816 #. type: subsubheading
48817 #: guix-git/doc/guix.texi:27198
48819 msgid "IDMAP Daemon Service"
48823 #: guix-git/doc/guix.texi:27199
48829 #: guix-git/doc/guix.texi:27200
48831 msgid "name mapper"
48834 #. type: Plain text
48835 #: guix-git/doc/guix.texi:27204
48836 msgid "The idmap daemon service provides mapping between user IDs and user names. Typically it is required in order to access file systems mounted via NFSv4."
48840 #: guix-git/doc/guix.texi:27205
48842 msgid "{Scheme Variable} idmap-service-type"
48846 #: guix-git/doc/guix.texi:27207
48847 msgid "A service type for the Identity Mapper (IDMAP) daemon."
48851 #: guix-git/doc/guix.texi:27209
48853 msgid "{Data Type} idmap-configuration"
48857 #: guix-git/doc/guix.texi:27212
48858 msgid "Data type representing the configuration of the IDMAP daemon service. This type has the following parameters:"
48862 #: guix-git/doc/guix.texi:27215
48863 msgid "The package in which the @command{rpc.idmapd} command is to be found."
48867 #: guix-git/doc/guix.texi:27219
48869 msgid "@code{domain} (default: @code{#f})"
48873 #: guix-git/doc/guix.texi:27223
48874 msgid "The local NFSv4 domain name. This must be a string or @code{#f}. If it is @code{#f} then the daemon will use the host's fully qualified domain name."
48878 #: guix-git/doc/guix.texi:27224
48880 msgid "@code{verbosity} (default: @code{0})"
48884 #: guix-git/doc/guix.texi:27226
48885 msgid "The verbosity level of the daemon."
48888 #. type: Plain text
48889 #: guix-git/doc/guix.texi:27237
48890 msgid "@uref{https://guix.gnu.org/cuirass/, Cuirass} is a continuous integration tool for Guix. It can be used both for development and for providing substitutes to others (@pxref{Substitutes})."
48893 #. type: Plain text
48894 #: guix-git/doc/guix.texi:27239
48895 msgid "The @code{(gnu services cuirass)} module provides the following service."
48899 #: guix-git/doc/guix.texi:27240
48901 msgid "{Scheme Procedure} cuirass-service-type"
48905 #: guix-git/doc/guix.texi:27243
48906 msgid "The type of the Cuirass service. Its value must be a @code{cuirass-configuration} object, as described below."
48909 #. type: Plain text
48910 #: guix-git/doc/guix.texi:27248
48911 msgid "To add build jobs, you have to set the @code{specifications} field of the configuration. For instance, the following example will build all the packages provided by the @code{my-channel} channel."
48915 #: guix-git/doc/guix.texi:27259
48918 "(define %cuirass-specs\n"
48919 " #~(list (specification\n"
48920 " (name \"my-channel\")\n"
48921 " (build '(channels my-channel))\n"
48923 " (cons (channel\n"
48924 " (name 'my-channel)\n"
48925 " (url \"https://my-channel.git\"))\n"
48926 " %default-channels)))))\n"
48931 #: guix-git/doc/guix.texi:27263 guix-git/doc/guix.texi:27277
48934 "(service cuirass-service-type\n"
48935 " (cuirass-configuration\n"
48936 " (specifications %cuirass-specs)))\n"
48939 #. type: Plain text
48940 #: guix-git/doc/guix.texi:27267
48941 msgid "To build the @code{linux-libre} package defined by the default Guix channel, one can use the following configuration."
48945 #: guix-git/doc/guix.texi:27273
48948 "(define %cuirass-specs\n"
48949 " #~(list (specification\n"
48950 " (name \"my-linux\")\n"
48951 " (build '(packages \"linux-libre\")))))\n"
48955 #. type: Plain text
48956 #: guix-git/doc/guix.texi:27282
48957 msgid "The other configuration possibilities, as well as the specification record itself are described in the Cuirass manual (@pxref{Specifications,,, cuirass, Cuirass})."
48960 #. type: Plain text
48961 #: guix-git/doc/guix.texi:27286
48962 msgid "While information related to build jobs is located directly in the specifications, global settings for the @command{cuirass} process are accessible in other @code{cuirass-configuration} fields."
48966 #: guix-git/doc/guix.texi:27287
48968 msgid "{Data Type} cuirass-configuration"
48972 #: guix-git/doc/guix.texi:27289
48973 msgid "Data type representing the configuration of Cuirass."
48977 #: guix-git/doc/guix.texi:27291 guix-git/doc/guix.texi:27423
48979 msgid "@code{cuirass} (default: @code{cuirass})"
48983 #: guix-git/doc/guix.texi:27293 guix-git/doc/guix.texi:27425
48984 msgid "The Cuirass package to use."
48988 #: guix-git/doc/guix.texi:27294
48990 msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})"
48994 #: guix-git/doc/guix.texi:27296 guix-git/doc/guix.texi:27400
48995 #: guix-git/doc/guix.texi:27438
48996 msgid "Location of the log file."
49000 #: guix-git/doc/guix.texi:27297
49002 msgid "@code{web-log-file} (default: @code{\"/var/log/cuirass-web.log\"})"
49006 #: guix-git/doc/guix.texi:27299
49007 msgid "Location of the log file used by the web interface."
49011 #: guix-git/doc/guix.texi:27300
49013 msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})"
49017 #: guix-git/doc/guix.texi:27302
49018 msgid "Location of the repository cache."
49022 #: guix-git/doc/guix.texi:27303
49024 msgid "@code{user} (default: @code{\"cuirass\"})"
49028 #: guix-git/doc/guix.texi:27305
49029 msgid "Owner of the @code{cuirass} process."
49033 #: guix-git/doc/guix.texi:27306
49035 msgid "@code{group} (default: @code{\"cuirass\"})"
49039 #: guix-git/doc/guix.texi:27308
49040 msgid "Owner's group of the @code{cuirass} process."
49044 #: guix-git/doc/guix.texi:27309
49046 msgid "@code{interval} (default: @code{60})"
49050 #: guix-git/doc/guix.texi:27312
49051 msgid "Number of seconds between the poll of the repositories followed by the Cuirass jobs."
49055 #: guix-git/doc/guix.texi:27313
49057 msgid "@code{parameters} (default: @code{#f})"
49061 #: guix-git/doc/guix.texi:27316
49062 msgid "Read parameters from the given @var{parameters} file. The supported parameters are described here (@pxref{Parameters,,, cuirass, Cuirass})."
49066 #: guix-git/doc/guix.texi:27317
49068 msgid "@code{remote-server} (default: @code{#f})"
49072 #: guix-git/doc/guix.texi:27320
49073 msgid "A @code{cuirass-remote-server-configuration} record to use the build remote mechanism or @code{#f} to use the default build mechanism."
49077 #: guix-git/doc/guix.texi:27321
49079 msgid "@code{database} (default: @code{\"dbname=cuirass host=/var/run/postgresql\"})"
49083 #: guix-git/doc/guix.texi:27326
49084 msgid "Use @var{database} as the database containing the jobs and the past build results. Since Cuirass uses PostgreSQL as a database engine, @var{database} must be a string such as @code{\"dbname=cuirass host=localhost\"}."
49088 #: guix-git/doc/guix.texi:27327
49090 msgid "@code{port} (default: @code{8081})"
49094 #: guix-git/doc/guix.texi:27329
49095 msgid "Port number used by the HTTP server."
49099 #: guix-git/doc/guix.texi:27333
49100 msgid "Listen on the network interface for @var{host}. The default is to accept connections from localhost."
49104 #: guix-git/doc/guix.texi:27334
49106 msgid "@code{specifications} (default: @code{#~'()})"
49110 #: guix-git/doc/guix.texi:27338
49111 msgid "A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications records. The specification record is described in the Cuirass manual (@pxref{Specifications,,, cuirass, Cuirass})."
49115 #: guix-git/doc/guix.texi:27339
49117 msgid "@code{use-substitutes?} (default: @code{#f})"
49121 #: guix-git/doc/guix.texi:27342
49122 msgid "This allows using substitutes to avoid building every dependencies of a job from source."
49126 #: guix-git/doc/guix.texi:27343 guix-git/doc/guix.texi:34213
49128 msgid "@code{one-shot?} (default: @code{#f})"
49132 #: guix-git/doc/guix.texi:27345
49133 msgid "Only evaluate specifications and build derivations once."
49137 #: guix-git/doc/guix.texi:27346
49139 msgid "@code{fallback?} (default: @code{#f})"
49143 #: guix-git/doc/guix.texi:27349
49144 msgid "When substituting a pre-built binary fails, fall back to building packages locally."
49148 #: guix-git/doc/guix.texi:27352
49149 msgid "Extra options to pass when running the Cuirass processes."
49153 #: guix-git/doc/guix.texi:27356
49155 msgid "remote build"
49158 #. type: subsubheading
49159 #: guix-git/doc/guix.texi:27357
49161 msgid "Cuirass remote building"
49164 #. type: Plain text
49165 #: guix-git/doc/guix.texi:27360
49166 msgid "Cuirass supports two mechanisms to build derivations."
49170 #: guix-git/doc/guix.texi:27362
49172 msgid "Using the local Guix daemon."
49176 #: guix-git/doc/guix.texi:27366
49177 msgid "This is the default build mechanism. Once the build jobs are evaluated, they are sent to the local Guix daemon. Cuirass then listens to the Guix daemon output to detect the various build events."
49181 #: guix-git/doc/guix.texi:27367
49183 msgid "Using the remote build mechanism."
49187 #: guix-git/doc/guix.texi:27371
49188 msgid "The build jobs are not submitted to the local Guix daemon. Instead, a remote server dispatches build requests to the connect remote workers, according to the build priorities."
49191 #. type: Plain text
49192 #: guix-git/doc/guix.texi:27378
49193 msgid "To enable this build mode a @code{cuirass-remote-server-configuration} record must be passed as @code{remote-server} argument of the @code{cuirass-configuration} record. The @code{cuirass-remote-server-configuration} record is described below."
49196 #. type: Plain text
49197 #: guix-git/doc/guix.texi:27383
49198 msgid "This build mode scales way better than the default build mode. This is the build mode that is used on the GNU Guix build farm at @url{https://ci.guix.gnu.org}. It should be preferred when using Cuirass to build large amount of packages."
49202 #: guix-git/doc/guix.texi:27384
49204 msgid "{Data Type} cuirass-remote-server-configuration"
49208 #: guix-git/doc/guix.texi:27386
49209 msgid "Data type representing the configuration of the Cuirass remote-server."
49213 #: guix-git/doc/guix.texi:27388
49215 msgid "@code{backend-port} (default: @code{5555})"
49219 #: guix-git/doc/guix.texi:27391
49220 msgid "The TCP port for communicating with @code{remote-worker} processes using ZMQ. It defaults to @code{5555}."
49224 #: guix-git/doc/guix.texi:27392
49226 msgid "@code{log-port} (default: @code{5556})"
49230 #: guix-git/doc/guix.texi:27394
49231 msgid "The TCP port of the log server. It defaults to @code{5556}."
49235 #: guix-git/doc/guix.texi:27395
49237 msgid "@code{publish-port} (default: @code{5557})"
49241 #: guix-git/doc/guix.texi:27397
49242 msgid "The TCP port of the publish server. It defaults to @code{5557}."
49246 #: guix-git/doc/guix.texi:27398
49248 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-server.log\"})"
49252 #: guix-git/doc/guix.texi:27401
49254 msgid "@code{cache} (default: @code{\"/var/cache/cuirass/remote\"})"
49258 #: guix-git/doc/guix.texi:27403
49259 msgid "Use @var{cache} directory to cache build log files."
49263 #: guix-git/doc/guix.texi:27404
49265 msgid "@code{trigger-url} (default: @code{#f})"
49269 #: guix-git/doc/guix.texi:27407
49270 msgid "Once a substitute is successfully fetched, trigger substitute baking at @var{trigger-url}."
49274 #: guix-git/doc/guix.texi:27409 guix-git/doc/guix.texi:27443
49276 msgid "private-key"
49279 #. type: Plain text
49280 #: guix-git/doc/guix.texi:27418
49281 msgid "At least one remote worker must also be started on any machine of the local network to actually perform the builds and report their status."
49285 #: guix-git/doc/guix.texi:27419
49287 msgid "{Data Type} cuirass-remote-worker-configuration"
49291 #: guix-git/doc/guix.texi:27421
49292 msgid "Data type representing the configuration of the Cuirass remote-worker."
49296 #: guix-git/doc/guix.texi:27426
49298 msgid "@code{workers} (default: @code{1})"
49302 #: guix-git/doc/guix.texi:27428
49303 msgid "Start @var{workers} parallel workers."
49307 #: guix-git/doc/guix.texi:27432
49308 msgid "Do not use Avahi discovery and connect to the given @code{server} IP address instead."
49312 #: guix-git/doc/guix.texi:27433
49314 msgid "@code{systems} (default: @code{(list (%current-system))})"
49318 #: guix-git/doc/guix.texi:27435
49319 msgid "Only request builds for the given @var{systems}."
49323 #: guix-git/doc/guix.texi:27436
49325 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-worker.log\"})"
49329 #: guix-git/doc/guix.texi:27439
49331 msgid "@code{publish-port} (default: @code{5558})"
49335 #: guix-git/doc/guix.texi:27441
49336 msgid "The TCP port of the publish server. It defaults to @code{5558}."
49339 #. type: subsubheading
49340 #: guix-git/doc/guix.texi:27450
49345 #. type: Plain text
49346 #: guix-git/doc/guix.texi:27455
49347 msgid "@uref{https://laminar.ohwg.net/, Laminar} is a lightweight and modular Continuous Integration service. It doesn't have a configuration web UI instead uses version-controllable configuration files and scripts."
49350 #. type: Plain text
49351 #: guix-git/doc/guix.texi:27458
49352 msgid "Laminar encourages the use of existing tools such as bash and cron instead of reinventing them."
49356 #: guix-git/doc/guix.texi:27459
49358 msgid "{Scheme Procedure} laminar-service-type"
49362 #: guix-git/doc/guix.texi:27462
49363 msgid "The type of the Laminar service. Its value must be a @code{laminar-configuration} object, as described below."
49367 #: guix-git/doc/guix.texi:27466
49368 msgid "All configuration values have defaults, a minimal configuration to get Laminar running is shown below. By default, the web interface is available on port 8080."
49372 #: guix-git/doc/guix.texi:27469
49374 msgid "(service laminar-service-type)\n"
49378 #: guix-git/doc/guix.texi:27472
49380 msgid "{Data Type} laminar-configuration"
49384 #: guix-git/doc/guix.texi:27474
49385 msgid "Data type representing the configuration of Laminar."
49389 #: guix-git/doc/guix.texi:27476
49391 msgid "@code{laminar} (default: @code{laminar})"
49395 #: guix-git/doc/guix.texi:27478
49396 msgid "The Laminar package to use."
49400 #: guix-git/doc/guix.texi:27479
49402 msgid "@code{home-directory} (default: @code{\"/var/lib/laminar\"})"
49406 #: guix-git/doc/guix.texi:27481
49407 msgid "The directory for job configurations and run directories."
49411 #: guix-git/doc/guix.texi:27482
49413 msgid "@code{bind-http} (default: @code{\"*:8080\"})"
49417 #: guix-git/doc/guix.texi:27485
49418 msgid "The interface/port or unix socket on which laminard should listen for incoming connections to the web frontend."
49422 #: guix-git/doc/guix.texi:27486
49424 msgid "@code{bind-rpc} (default: @code{\"unix-abstract:laminar\"})"
49428 #: guix-git/doc/guix.texi:27489
49429 msgid "The interface/port or unix socket on which laminard should listen for incoming commands such as build triggers."
49433 #: guix-git/doc/guix.texi:27490
49435 msgid "@code{title} (default: @code{\"Laminar\"})"
49439 #: guix-git/doc/guix.texi:27492
49440 msgid "The page title to show in the web frontend."
49444 #: guix-git/doc/guix.texi:27493
49446 msgid "@code{keep-rundirs} (default: @code{0})"
49450 #: guix-git/doc/guix.texi:27497
49451 msgid "Set to an integer defining how many rundirs to keep per job. The lowest-numbered ones will be deleted. The default is 0, meaning all run dirs will be immediately deleted."
49455 #: guix-git/doc/guix.texi:27498
49457 msgid "@code{archive-url} (default: @code{#f})"
49461 #: guix-git/doc/guix.texi:27501
49462 msgid "The web frontend served by laminard will use this URL to form links to artefacts archived jobs."
49466 #: guix-git/doc/guix.texi:27502
49468 msgid "@code{base-url} (default: @code{#f})"
49472 #: guix-git/doc/guix.texi:27504
49473 msgid "Base URL to use for links to laminar itself."
49477 #: guix-git/doc/guix.texi:27511
49483 #: guix-git/doc/guix.texi:27512
49485 msgid "power management with TLP"
49488 #. type: subsubheading
49489 #: guix-git/doc/guix.texi:27513
49494 #. type: Plain text
49495 #: guix-git/doc/guix.texi:27517
49496 msgid "The @code{(gnu services pm)} module provides a Guix service definition for the Linux power management tool TLP."
49499 #. type: Plain text
49500 #: guix-git/doc/guix.texi:27523
49501 msgid "TLP enables various powersaving modes in userspace and kernel. Contrary to @code{upower-service}, it is not a passive, monitoring tool, as it will apply custom settings each time a new power source is detected. More information can be found at @uref{https://linrunner.de/en/tlp/tlp.html, TLP home page}."
49505 #: guix-git/doc/guix.texi:27524
49507 msgid "{Scheme Variable} tlp-service-type"
49511 #: guix-git/doc/guix.texi:27528
49512 msgid "The service type for the TLP tool. The default settings are optimised for battery life on most systems, but you can tweak them to your heart's content by adding a valid @code{tlp-configuration}:"
49516 #: guix-git/doc/guix.texi:27533
49519 "(service tlp-service-type\n"
49520 " (tlp-configuration\n"
49521 " (cpu-scaling-governor-on-ac (list \"performance\"))\n"
49522 " (sched-powersave-on-bat? #t)))\n"
49525 #. type: Plain text
49526 #: guix-git/doc/guix.texi:27541
49527 msgid "Each parameter definition is preceded by its type; for example, @samp{boolean foo} indicates that the @code{foo} parameter should be specified as a boolean. Types starting with @code{maybe-} denote parameters that won't show up in TLP config file when their value is @code{'disabled}."
49530 #. type: Plain text
49531 #: guix-git/doc/guix.texi:27551
49532 msgid "Available @code{tlp-configuration} fields are:"
49536 #: guix-git/doc/guix.texi:27552
49538 msgid "{@code{tlp-configuration} parameter} package tlp"
49542 #: guix-git/doc/guix.texi:27554
49543 msgid "The TLP package."
49547 #: guix-git/doc/guix.texi:27557
49549 msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?"
49553 #: guix-git/doc/guix.texi:27559
49554 msgid "Set to true if you wish to enable TLP."
49558 #: guix-git/doc/guix.texi:27564
49560 msgid "{@code{tlp-configuration} parameter} string tlp-default-mode"
49564 #: guix-git/doc/guix.texi:27567
49565 msgid "Default mode when no power supply can be detected. Alternatives are AC and BAT."
49569 #: guix-git/doc/guix.texi:27569
49570 msgid "Defaults to @samp{\"AC\"}."
49574 #: guix-git/doc/guix.texi:27572
49576 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac"
49580 #: guix-git/doc/guix.texi:27575
49581 msgid "Number of seconds Linux kernel has to wait after the disk goes idle, before syncing on AC."
49585 #: guix-git/doc/guix.texi:27580
49587 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat"
49591 #: guix-git/doc/guix.texi:27582
49592 msgid "Same as @code{disk-idle-ac} but on BAT mode."
49596 #: guix-git/doc/guix.texi:27584
49597 msgid "Defaults to @samp{2}."
49601 #: guix-git/doc/guix.texi:27587
49603 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac"
49607 #: guix-git/doc/guix.texi:27589
49608 msgid "Dirty pages flushing periodicity, expressed in seconds."
49612 #: guix-git/doc/guix.texi:27591 guix-git/doc/guix.texi:27814
49613 #: guix-git/doc/guix.texi:30028 guix-git/doc/guix.texi:30036
49614 msgid "Defaults to @samp{15}."
49618 #: guix-git/doc/guix.texi:27594
49620 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat"
49624 #: guix-git/doc/guix.texi:27596
49625 msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode."
49629 #: guix-git/doc/guix.texi:27598
49630 msgid "Defaults to @samp{60}."
49634 #: guix-git/doc/guix.texi:27601
49636 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac"
49640 #: guix-git/doc/guix.texi:27605
49641 msgid "CPU frequency scaling governor on AC mode. With intel_pstate driver, alternatives are powersave and performance. With acpi-cpufreq driver, alternatives are ondemand, powersave, performance and conservative."
49645 #: guix-git/doc/guix.texi:27610
49647 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat"
49651 #: guix-git/doc/guix.texi:27612
49652 msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode."
49656 #: guix-git/doc/guix.texi:27617
49658 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac"
49662 #: guix-git/doc/guix.texi:27619
49663 msgid "Set the min available frequency for the scaling governor on AC."
49667 #: guix-git/doc/guix.texi:27624
49669 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac"
49673 #: guix-git/doc/guix.texi:27626
49674 msgid "Set the max available frequency for the scaling governor on AC."
49678 #: guix-git/doc/guix.texi:27631
49680 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat"
49684 #: guix-git/doc/guix.texi:27633
49685 msgid "Set the min available frequency for the scaling governor on BAT."
49689 #: guix-git/doc/guix.texi:27638
49691 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat"
49695 #: guix-git/doc/guix.texi:27640
49696 msgid "Set the max available frequency for the scaling governor on BAT."
49700 #: guix-git/doc/guix.texi:27645
49702 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac"
49706 #: guix-git/doc/guix.texi:27648
49707 msgid "Limit the min P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance."
49711 #: guix-git/doc/guix.texi:27653
49713 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac"
49717 #: guix-git/doc/guix.texi:27656
49718 msgid "Limit the max P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance."
49722 #: guix-git/doc/guix.texi:27661
49724 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat"
49728 #: guix-git/doc/guix.texi:27663
49729 msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode."
49733 #: guix-git/doc/guix.texi:27668
49735 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat"
49739 #: guix-git/doc/guix.texi:27670
49740 msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode."
49744 #: guix-git/doc/guix.texi:27675
49746 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?"
49750 #: guix-git/doc/guix.texi:27677
49751 msgid "Enable CPU turbo boost feature on AC mode."
49755 #: guix-git/doc/guix.texi:27682
49757 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?"
49761 #: guix-git/doc/guix.texi:27684
49762 msgid "Same as @code{cpu-boost-on-ac?} on BAT mode."
49766 #: guix-git/doc/guix.texi:27689
49768 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?"
49772 #: guix-git/doc/guix.texi:27692
49773 msgid "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions."
49777 #: guix-git/doc/guix.texi:27697
49779 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?"
49783 #: guix-git/doc/guix.texi:27699
49784 msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode."
49788 #: guix-git/doc/guix.texi:27704
49790 msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?"
49794 #: guix-git/doc/guix.texi:27706
49795 msgid "Enable Linux kernel NMI watchdog."
49799 #: guix-git/doc/guix.texi:27711
49801 msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls"
49805 #: guix-git/doc/guix.texi:27714
49806 msgid "For Linux kernels with PHC patch applied, change CPU voltages. An example value would be @samp{\"F:V F:V F:V F:V\"}."
49810 #: guix-git/doc/guix.texi:27719
49812 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac"
49816 #: guix-git/doc/guix.texi:27722
49817 msgid "Set CPU performance versus energy saving policy on AC@. Alternatives are performance, normal, powersave."
49821 #: guix-git/doc/guix.texi:27724 guix-git/doc/guix.texi:27822
49822 #: guix-git/doc/guix.texi:27852
49823 msgid "Defaults to @samp{\"performance\"}."
49827 #: guix-git/doc/guix.texi:27727
49829 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat"
49833 #: guix-git/doc/guix.texi:27729
49834 msgid "Same as @code{energy-perf-policy-ac} but on BAT mode."
49838 #: guix-git/doc/guix.texi:27731 guix-git/doc/guix.texi:27829
49839 msgid "Defaults to @samp{\"powersave\"}."
49843 #: guix-git/doc/guix.texi:27734
49845 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices"
49849 #: guix-git/doc/guix.texi:27736
49850 msgid "Hard disk devices."
49854 #: guix-git/doc/guix.texi:27739
49856 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac"
49860 #: guix-git/doc/guix.texi:27741
49861 msgid "Hard disk advanced power management level."
49865 #: guix-git/doc/guix.texi:27744
49867 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat"
49871 #: guix-git/doc/guix.texi:27746
49872 msgid "Same as @code{disk-apm-bat} but on BAT mode."
49876 #: guix-git/doc/guix.texi:27749
49878 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac"
49882 #: guix-git/doc/guix.texi:27752
49883 msgid "Hard disk spin down timeout. One value has to be specified for each declared hard disk."
49887 #: guix-git/doc/guix.texi:27757
49889 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat"
49893 #: guix-git/doc/guix.texi:27759
49894 msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode."
49898 #: guix-git/doc/guix.texi:27764
49900 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched"
49904 #: guix-git/doc/guix.texi:27768
49905 msgid "Select IO scheduler for disk devices. One value has to be specified for each declared hard disk. Example alternatives are cfq, deadline and noop."
49909 #: guix-git/doc/guix.texi:27773
49911 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac"
49915 #: guix-git/doc/guix.texi:27776
49916 msgid "SATA aggressive link power management (ALPM) level. Alternatives are min_power, medium_power, max_performance."
49920 #: guix-git/doc/guix.texi:27778
49921 msgid "Defaults to @samp{\"max_performance\"}."
49925 #: guix-git/doc/guix.texi:27781
49927 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat"
49931 #: guix-git/doc/guix.texi:27783
49932 msgid "Same as @code{sata-linkpwr-ac} but on BAT mode."
49936 #: guix-git/doc/guix.texi:27785
49937 msgid "Defaults to @samp{\"min_power\"}."
49941 #: guix-git/doc/guix.texi:27788
49943 msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist"
49947 #: guix-git/doc/guix.texi:27790
49948 msgid "Exclude specified SATA host devices for link power management."
49952 #: guix-git/doc/guix.texi:27795
49954 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?"
49958 #: guix-git/doc/guix.texi:27798
49959 msgid "Enable Runtime Power Management for AHCI controller and disks on AC mode."
49963 #: guix-git/doc/guix.texi:27803
49965 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?"
49969 #: guix-git/doc/guix.texi:27805
49970 msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode."
49974 #: guix-git/doc/guix.texi:27810
49976 msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout"
49980 #: guix-git/doc/guix.texi:27812
49981 msgid "Seconds of inactivity before disk is suspended."
49985 #: guix-git/doc/guix.texi:27817
49987 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac"
49991 #: guix-git/doc/guix.texi:27820
49992 msgid "PCI Express Active State Power Management level. Alternatives are default, performance, powersave."
49996 #: guix-git/doc/guix.texi:27825
49998 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat"
50002 #: guix-git/doc/guix.texi:27827
50003 msgid "Same as @code{pcie-aspm-ac} but on BAT mode."
50007 #: guix-git/doc/guix.texi:27832
50009 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac"
50013 #: guix-git/doc/guix.texi:27835
50014 msgid "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, default."
50018 #: guix-git/doc/guix.texi:27837
50019 msgid "Defaults to @samp{\"high\"}."
50023 #: guix-git/doc/guix.texi:27840
50025 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat"
50029 #: guix-git/doc/guix.texi:27842
50030 msgid "Same as @code{radeon-power-ac} but on BAT mode."
50034 #: guix-git/doc/guix.texi:27844
50035 msgid "Defaults to @samp{\"low\"}."
50039 #: guix-git/doc/guix.texi:27847
50041 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac"
50045 #: guix-git/doc/guix.texi:27850
50046 msgid "Radeon dynamic power management method (DPM). Alternatives are battery, performance."
50050 #: guix-git/doc/guix.texi:27855
50052 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat"
50056 #: guix-git/doc/guix.texi:27857
50057 msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode."
50061 #: guix-git/doc/guix.texi:27859
50062 msgid "Defaults to @samp{\"battery\"}."
50066 #: guix-git/doc/guix.texi:27862
50068 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac"
50072 #: guix-git/doc/guix.texi:27864
50073 msgid "Radeon DPM performance level. Alternatives are auto, low, high."
50077 #: guix-git/doc/guix.texi:27866 guix-git/doc/guix.texi:27873
50078 #: guix-git/doc/guix.texi:27947
50079 msgid "Defaults to @samp{\"auto\"}."
50083 #: guix-git/doc/guix.texi:27869
50085 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat"
50089 #: guix-git/doc/guix.texi:27871
50090 msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode."
50094 #: guix-git/doc/guix.texi:27876
50096 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?"
50100 #: guix-git/doc/guix.texi:27878
50101 msgid "Wifi power saving mode."
50105 #: guix-git/doc/guix.texi:27883
50107 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?"
50111 #: guix-git/doc/guix.texi:27885
50112 msgid "Same as @code{wifi-power-ac?} but on BAT mode."
50116 #: guix-git/doc/guix.texi:27890
50118 msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?"
50122 #: guix-git/doc/guix.texi:27892
50123 msgid "Disable wake on LAN."
50127 #: guix-git/doc/guix.texi:27897
50129 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac"
50133 #: guix-git/doc/guix.texi:27900
50134 msgid "Timeout duration in seconds before activating audio power saving on Intel HDA and AC97 devices. A value of 0 disables power saving."
50138 #: guix-git/doc/guix.texi:27905
50140 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat"
50144 #: guix-git/doc/guix.texi:27907
50145 msgid "Same as @code{sound-powersave-ac} but on BAT mode."
50149 #: guix-git/doc/guix.texi:27912
50151 msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?"
50155 #: guix-git/doc/guix.texi:27914
50156 msgid "Disable controller in powersaving mode on Intel HDA devices."
50160 #: guix-git/doc/guix.texi:27919
50162 msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?"
50166 #: guix-git/doc/guix.texi:27923
50167 msgid "Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be powered on again by releasing (and reinserting) the eject lever or by pressing the disc eject button on newer models."
50171 #: guix-git/doc/guix.texi:27928
50173 msgid "{@code{tlp-configuration} parameter} string bay-device"
50177 #: guix-git/doc/guix.texi:27930
50178 msgid "Name of the optical drive device to power off."
50182 #: guix-git/doc/guix.texi:27932
50183 msgid "Defaults to @samp{\"sr0\"}."
50187 #: guix-git/doc/guix.texi:27935
50189 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac"
50193 #: guix-git/doc/guix.texi:27938
50194 msgid "Runtime Power Management for PCI(e) bus devices. Alternatives are on and auto."
50198 #: guix-git/doc/guix.texi:27940
50199 msgid "Defaults to @samp{\"on\"}."
50203 #: guix-git/doc/guix.texi:27943
50205 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat"
50209 #: guix-git/doc/guix.texi:27945
50210 msgid "Same as @code{runtime-pm-ac} but on BAT mode."
50214 #: guix-git/doc/guix.texi:27950
50216 msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?"
50220 #: guix-git/doc/guix.texi:27953
50221 msgid "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones."
50225 #: guix-git/doc/guix.texi:27958
50227 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist"
50231 #: guix-git/doc/guix.texi:27960
50232 msgid "Exclude specified PCI(e) device addresses from Runtime Power Management."
50236 #: guix-git/doc/guix.texi:27965
50238 msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist"
50242 #: guix-git/doc/guix.texi:27968
50243 msgid "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management."
50247 #: guix-git/doc/guix.texi:27971
50249 msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?"
50253 #: guix-git/doc/guix.texi:27973
50254 msgid "Enable USB autosuspend feature."
50258 #: guix-git/doc/guix.texi:27978
50260 msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist"
50264 #: guix-git/doc/guix.texi:27980
50265 msgid "Exclude specified devices from USB autosuspend."
50269 #: guix-git/doc/guix.texi:27985
50271 msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?"
50275 #: guix-git/doc/guix.texi:27987
50276 msgid "Exclude WWAN devices from USB autosuspend."
50280 #: guix-git/doc/guix.texi:27992
50282 msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist"
50286 #: guix-git/doc/guix.texi:27995
50287 msgid "Include specified devices into USB autosuspend, even if they are already excluded by the driver or via @code{usb-blacklist-wwan?}."
50291 #: guix-git/doc/guix.texi:28000
50293 msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?"
50297 #: guix-git/doc/guix.texi:28002
50298 msgid "Enable USB autosuspend before shutdown."
50302 #: guix-git/doc/guix.texi:28007
50304 msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?"
50308 #: guix-git/doc/guix.texi:28010
50309 msgid "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup."
50313 #: guix-git/doc/guix.texi:28015
50319 #: guix-git/doc/guix.texi:28016
50321 msgid "CPU frequency scaling with thermald"
50324 #. type: subsubheading
50325 #: guix-git/doc/guix.texi:28017
50327 msgid "Thermald daemon"
50330 #. type: Plain text
50331 #: guix-git/doc/guix.texi:28021
50332 msgid "The @code{(gnu services pm)} module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating."
50336 #: guix-git/doc/guix.texi:28022
50338 msgid "{Scheme Variable} thermald-service-type"
50342 #: guix-git/doc/guix.texi:28027
50343 msgid "This is the service type for @uref{https://01.org/linux-thermal-daemon/, thermald}, the Linux Thermal Daemon, which is responsible for controlling the thermal state of processors and preventing overheating."
50347 #: guix-git/doc/guix.texi:28029
50349 msgid "{Data Type} thermald-configuration"
50353 #: guix-git/doc/guix.texi:28031
50354 msgid "Data type representing the configuration of @code{thermald-service-type}."
50358 #: guix-git/doc/guix.texi:28033
50360 msgid "@code{ignore-cpuid-check?} (default: @code{#f})"
50364 #: guix-git/doc/guix.texi:28035
50365 msgid "Ignore cpuid check for supported CPU models."
50369 #: guix-git/doc/guix.texi:28036
50371 msgid "@code{thermald} (default: @var{thermald})"
50375 #: guix-git/doc/guix.texi:28038
50376 msgid "Package object of thermald."
50379 #. type: Plain text
50380 #: guix-git/doc/guix.texi:28047
50381 msgid "The @code{(gnu services audio)} module provides a service to start MPD (the Music Player Daemon)."
50385 #: guix-git/doc/guix.texi:28048
50390 #. type: subsubheading
50391 #: guix-git/doc/guix.texi:28049
50393 msgid "Music Player Daemon"
50396 #. type: Plain text
50397 #: guix-git/doc/guix.texi:28054
50398 msgid "The Music Player Daemon (MPD) is a service that can play music while being controlled from the local machine or over the network by a variety of clients."
50401 #. type: Plain text
50402 #: guix-git/doc/guix.texi:28057
50403 msgid "The following example shows how one might run @code{mpd} as user @code{\"bob\"} on port @code{6666}. It uses pulseaudio for output."
50407 #: guix-git/doc/guix.texi:28063
50410 "(service mpd-service-type\n"
50411 " (mpd-configuration\n"
50412 " (user \"bob\")\n"
50413 " (port \"6666\")))\n"
50417 #: guix-git/doc/guix.texi:28065
50419 msgid "{Scheme Variable} mpd-service-type"
50423 #: guix-git/doc/guix.texi:28067
50424 msgid "The service type for @command{mpd}"
50428 #: guix-git/doc/guix.texi:28069
50430 msgid "{Data Type} mpd-configuration"
50434 #: guix-git/doc/guix.texi:28071
50435 msgid "Data type representing the configuration of @command{mpd}."
50439 #: guix-git/doc/guix.texi:28073
50441 msgid "@code{user} (default: @code{\"mpd\"})"
50445 #: guix-git/doc/guix.texi:28075
50446 msgid "The user to run mpd as."
50450 #: guix-git/doc/guix.texi:28076
50452 msgid "@code{music-dir} (default: @code{\"~/Music\"})"
50456 #: guix-git/doc/guix.texi:28078
50457 msgid "The directory to scan for music files."
50461 #: guix-git/doc/guix.texi:28079
50463 msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})"
50467 #: guix-git/doc/guix.texi:28081
50468 msgid "The directory to store playlists."
50472 #: guix-git/doc/guix.texi:28082
50474 msgid "@code{db-file} (default: @code{\"~/.mpd/tag_cache\"})"
50478 #: guix-git/doc/guix.texi:28084
50479 msgid "The location of the music database."
50483 #: guix-git/doc/guix.texi:28085
50485 msgid "@code{state-file} (default: @code{\"~/.mpd/state\"})"
50489 #: guix-git/doc/guix.texi:28087
50490 msgid "The location of the file that stores current MPD's state."
50494 #: guix-git/doc/guix.texi:28088
50496 msgid "@code{sticker-file} (default: @code{\"~/.mpd/sticker.sql\"})"
50500 #: guix-git/doc/guix.texi:28090
50501 msgid "The location of the sticker database."
50505 #: guix-git/doc/guix.texi:28091
50507 msgid "@code{port} (default: @code{\"6600\"})"
50511 #: guix-git/doc/guix.texi:28093
50512 msgid "The port to run mpd on."
50516 #: guix-git/doc/guix.texi:28094
50518 msgid "@code{address} (default: @code{\"any\"})"
50522 #: guix-git/doc/guix.texi:28097
50523 msgid "The address that mpd will bind to. To use a Unix domain socket, an absolute path can be specified here."
50527 #: guix-git/doc/guix.texi:28098
50529 msgid "@code{outputs} (default: @code{\"(list (mpd-output))\"})"
50533 #: guix-git/doc/guix.texi:28100
50534 msgid "The audio outputs that MPD can use. By default this is a single output using pulseaudio."
50538 #: guix-git/doc/guix.texi:28104
50540 msgid "{Data Type} mpd-output"
50544 #: guix-git/doc/guix.texi:28106
50545 msgid "Data type representing an @command{mpd} audio output."
50549 #: guix-git/doc/guix.texi:28108
50551 msgid "@code{name} (default: @code{\"MPD\"})"
50555 #: guix-git/doc/guix.texi:28110
50556 msgid "The name of the audio output."
50560 #: guix-git/doc/guix.texi:28111
50562 msgid "@code{type} (default: @code{\"pulse\"})"
50566 #: guix-git/doc/guix.texi:28113
50567 msgid "The type of audio output."
50571 #: guix-git/doc/guix.texi:28114
50573 msgid "@code{enabled?} (default: @code{#t})"
50577 #: guix-git/doc/guix.texi:28119
50578 msgid "Specifies whether this audio output is enabled when MPD is started. By default, all audio outputs are enabled. This is just the default setting when there is no state file; with a state file, the previous state is restored."
50582 #: guix-git/doc/guix.texi:28120
50584 msgid "@code{tags?} (default: @code{#t})"
50588 #: guix-git/doc/guix.texi:28124
50589 msgid "If set to @code{#f}, then MPD will not send tags to this output. This is only useful for output plugins that can receive tags, for example the @code{httpd} output plugin."
50593 #: guix-git/doc/guix.texi:28125
50595 msgid "@code{always-on?} (default: @code{#f})"
50599 #: guix-git/doc/guix.texi:28129
50600 msgid "If set to @code{#t}, then MPD attempts to keep this audio output always open. This may be useful for streaming servers, when you don’t want to disconnect all listeners even when playback is accidentally stopped."
50604 #: guix-git/doc/guix.texi:28130
50610 #: guix-git/doc/guix.texi:28136
50611 msgid "This field accepts a symbol that specifies which mixer should be used for this audio output: the @code{hardware} mixer, the @code{software} mixer, the @code{null} mixer (allows setting the volume, but with no effect; this can be used as a trick to implement an external mixer External Mixer) or no mixer (@code{none})."
50615 #: guix-git/doc/guix.texi:28140
50616 msgid "An association list of option symbols to string values to be appended to the audio output configuration."
50619 #. type: Plain text
50620 #: guix-git/doc/guix.texi:28146
50621 msgid "The following example shows a configuration of @code{mpd} that provides an HTTP audio streaming output."
50625 #: guix-git/doc/guix.texi:28158
50628 "(service mpd-service-type\n"
50629 " (mpd-configuration\n"
50631 " (list (mpd-output\n"
50632 " (name \"streaming\")\n"
50633 " (type \"httpd\")\n"
50634 " (mixer-type 'null)\n"
50635 " (extra-options\n"
50636 " `((encoder . \"vorbis\")\n"
50637 " (port . \"8080\"))))))))\n"
50640 #. type: Plain text
50641 #: guix-git/doc/guix.texi:28167
50642 msgid "The @code{(gnu services virtualization)} module provides services for the libvirt and virtlog daemons, as well as other virtualization-related services."
50645 #. type: subsubheading
50646 #: guix-git/doc/guix.texi:28168
50648 msgid "Libvirt daemon"
50651 #. type: Plain text
50652 #: guix-git/doc/guix.texi:28173
50653 msgid "@code{libvirtd} is the server side daemon component of the libvirt virtualization management system. This daemon runs on host servers and performs required management tasks for virtualized guests."
50657 #: guix-git/doc/guix.texi:28174
50659 msgid "{Scheme Variable} libvirt-service-type"
50663 #: guix-git/doc/guix.texi:28177
50664 msgid "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its value must be a @code{libvirt-configuration}."
50668 #: guix-git/doc/guix.texi:28183
50671 "(service libvirt-service-type\n"
50672 " (libvirt-configuration\n"
50673 " (unix-sock-group \"libvirt\")\n"
50674 " (tls-port \"16555\")))\n"
50677 #. type: Plain text
50678 #: guix-git/doc/guix.texi:28188
50679 msgid "Available @code{libvirt-configuration} fields are:"
50683 #: guix-git/doc/guix.texi:28189
50685 msgid "{@code{libvirt-configuration} parameter} package libvirt"
50689 #: guix-git/doc/guix.texi:28191
50690 msgid "Libvirt package."
50694 #: guix-git/doc/guix.texi:28194
50696 msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?"
50700 #: guix-git/doc/guix.texi:28197
50701 msgid "Flag listening for secure TLS connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
50705 #: guix-git/doc/guix.texi:28200
50706 msgid "It is necessary to setup a CA and issue server certificates before using this capability."
50710 #: guix-git/doc/guix.texi:28205
50712 msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?"
50716 #: guix-git/doc/guix.texi:28208
50717 msgid "Listen for unencrypted TCP connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
50721 #: guix-git/doc/guix.texi:28212
50722 msgid "Using the TCP socket requires SASL authentication by default. Only SASL mechanisms which support data encryption are allowed. This is DIGEST_MD5 and GSSAPI (Kerberos5)."
50726 #: guix-git/doc/guix.texi:28217
50728 msgid "{@code{libvirt-configuration} parameter} string tls-port"
50732 #: guix-git/doc/guix.texi:28220
50733 msgid "Port for accepting secure TLS connections. This can be a port number, or service name."
50737 #: guix-git/doc/guix.texi:28222
50738 msgid "Defaults to @samp{\"16514\"}."
50742 #: guix-git/doc/guix.texi:28225
50744 msgid "{@code{libvirt-configuration} parameter} string tcp-port"
50748 #: guix-git/doc/guix.texi:28228
50749 msgid "Port for accepting insecure TCP connections. This can be a port number, or service name."
50753 #: guix-git/doc/guix.texi:28230
50754 msgid "Defaults to @samp{\"16509\"}."
50758 #: guix-git/doc/guix.texi:28233
50760 msgid "{@code{libvirt-configuration} parameter} string listen-addr"
50764 #: guix-git/doc/guix.texi:28235
50765 msgid "IP address or hostname used for client connections."
50769 #: guix-git/doc/guix.texi:28240
50771 msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?"
50775 #: guix-git/doc/guix.texi:28242
50776 msgid "Flag toggling mDNS advertisement of the libvirt service."
50780 #: guix-git/doc/guix.texi:28245
50781 msgid "Alternatively can disable for all services on a host by stopping the Avahi daemon."
50785 #: guix-git/doc/guix.texi:28250
50787 msgid "{@code{libvirt-configuration} parameter} string mdns-name"
50791 #: guix-git/doc/guix.texi:28253
50792 msgid "Default mDNS advertisement name. This must be unique on the immediate broadcast network."
50796 #: guix-git/doc/guix.texi:28255
50797 msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}."
50801 #: guix-git/doc/guix.texi:28258
50803 msgid "{@code{libvirt-configuration} parameter} string unix-sock-group"
50807 #: guix-git/doc/guix.texi:28262
50808 msgid "UNIX domain socket group ownership. This can be used to allow a 'trusted' set of users access to management capabilities without becoming root."
50812 #: guix-git/doc/guix.texi:28267
50814 msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms"
50818 #: guix-git/doc/guix.texi:28270
50819 msgid "UNIX socket permissions for the R/O socket. This is used for monitoring VM status only."
50823 #: guix-git/doc/guix.texi:28272 guix-git/doc/guix.texi:28290
50824 msgid "Defaults to @samp{\"0777\"}."
50828 #: guix-git/doc/guix.texi:28275
50830 msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms"
50834 #: guix-git/doc/guix.texi:28279
50835 msgid "UNIX socket permissions for the R/W socket. Default allows only root. If PolicyKit is enabled on the socket, the default will change to allow everyone (eg, 0777)"
50839 #: guix-git/doc/guix.texi:28281
50840 msgid "Defaults to @samp{\"0770\"}."
50844 #: guix-git/doc/guix.texi:28284
50846 msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms"
50850 #: guix-git/doc/guix.texi:28288
50851 msgid "UNIX socket permissions for the admin socket. Default allows only owner (root), do not change it unless you are sure to whom you are exposing the access to."
50855 #: guix-git/doc/guix.texi:28293
50857 msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir"
50861 #: guix-git/doc/guix.texi:28295
50862 msgid "The directory in which sockets will be found/created."
50866 #: guix-git/doc/guix.texi:28297
50867 msgid "Defaults to @samp{\"/var/run/libvirt\"}."
50871 #: guix-git/doc/guix.texi:28300
50873 msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro"
50877 #: guix-git/doc/guix.texi:28303
50878 msgid "Authentication scheme for UNIX read-only sockets. By default socket permissions allow anyone to connect"
50882 #: guix-git/doc/guix.texi:28305 guix-git/doc/guix.texi:28314
50883 msgid "Defaults to @samp{\"polkit\"}."
50887 #: guix-git/doc/guix.texi:28308
50889 msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw"
50893 #: guix-git/doc/guix.texi:28312
50894 msgid "Authentication scheme for UNIX read-write sockets. By default socket permissions only allow root. If PolicyKit support was compiled into libvirt, the default will be to use 'polkit' auth."
50898 #: guix-git/doc/guix.texi:28317
50900 msgid "{@code{libvirt-configuration} parameter} string auth-tcp"
50904 #: guix-git/doc/guix.texi:28321
50905 msgid "Authentication scheme for TCP sockets. If you don't enable SASL, then all TCP traffic is cleartext. Don't do this outside of a dev/test scenario."
50909 #: guix-git/doc/guix.texi:28323
50910 msgid "Defaults to @samp{\"sasl\"}."
50914 #: guix-git/doc/guix.texi:28326
50916 msgid "{@code{libvirt-configuration} parameter} string auth-tls"
50920 #: guix-git/doc/guix.texi:28330
50921 msgid "Authentication scheme for TLS sockets. TLS sockets already have encryption provided by the TLS layer, and limited authentication is done by certificates."
50925 #: guix-git/doc/guix.texi:28333
50926 msgid "It is possible to make use of any SASL authentication mechanism as well, by using 'sasl' for this option"
50930 #: guix-git/doc/guix.texi:28335
50931 msgid "Defaults to @samp{\"none\"}."
50935 #: guix-git/doc/guix.texi:28338
50937 msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers"
50941 #: guix-git/doc/guix.texi:28340
50942 msgid "API access control scheme."
50946 #: guix-git/doc/guix.texi:28343
50947 msgid "By default an authenticated user is allowed access to all APIs. Access drivers can place restrictions on this."
50951 #: guix-git/doc/guix.texi:28348
50953 msgid "{@code{libvirt-configuration} parameter} string key-file"
50957 #: guix-git/doc/guix.texi:28351
50958 msgid "Server key file path. If set to an empty string, then no private key is loaded."
50962 #: guix-git/doc/guix.texi:28356
50964 msgid "{@code{libvirt-configuration} parameter} string cert-file"
50968 #: guix-git/doc/guix.texi:28359
50969 msgid "Server key file path. If set to an empty string, then no certificate is loaded."
50973 #: guix-git/doc/guix.texi:28364
50975 msgid "{@code{libvirt-configuration} parameter} string ca-file"
50979 #: guix-git/doc/guix.texi:28367
50980 msgid "Server key file path. If set to an empty string, then no CA certificate is loaded."
50984 #: guix-git/doc/guix.texi:28372
50986 msgid "{@code{libvirt-configuration} parameter} string crl-file"
50990 #: guix-git/doc/guix.texi:28375
50991 msgid "Certificate revocation list path. If set to an empty string, then no CRL is loaded."
50995 #: guix-git/doc/guix.texi:28380
50997 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert"
51001 #: guix-git/doc/guix.texi:28382
51002 msgid "Disable verification of our own server certificates."
51006 #: guix-git/doc/guix.texi:28385
51007 msgid "When libvirtd starts it performs some sanity checks against its own certificates."
51011 #: guix-git/doc/guix.texi:28390
51013 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert"
51017 #: guix-git/doc/guix.texi:28392
51018 msgid "Disable verification of client certificates."
51022 #: guix-git/doc/guix.texi:28396
51023 msgid "Client certificate verification is the primary authentication mechanism. Any client which does not present a certificate signed by the CA will be rejected."
51027 #: guix-git/doc/guix.texi:28401
51029 msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list"
51033 #: guix-git/doc/guix.texi:28403
51034 msgid "Whitelist of allowed x509 Distinguished Name."
51038 #: guix-git/doc/guix.texi:28408
51040 msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames"
51044 #: guix-git/doc/guix.texi:28411
51045 msgid "Whitelist of allowed SASL usernames. The format for username depends on the SASL authentication mechanism."
51049 #: guix-git/doc/guix.texi:28416
51051 msgid "{@code{libvirt-configuration} parameter} string tls-priority"
51055 #: guix-git/doc/guix.texi:28420
51056 msgid "Override the compile time default TLS priority string. The default is usually @samp{\"NORMAL\"} unless overridden at build time. Only set this is it is desired for libvirt to deviate from the global default settings."
51060 #: guix-git/doc/guix.texi:28422
51061 msgid "Defaults to @samp{\"NORMAL\"}."
51065 #: guix-git/doc/guix.texi:28425
51067 msgid "{@code{libvirt-configuration} parameter} integer max-clients"
51071 #: guix-git/doc/guix.texi:28428 guix-git/doc/guix.texi:28852
51072 msgid "Maximum number of concurrent client connections to allow over all sockets combined."
51076 #: guix-git/doc/guix.texi:28430
51077 msgid "Defaults to @samp{5000}."
51081 #: guix-git/doc/guix.texi:28433
51083 msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients"
51087 #: guix-git/doc/guix.texi:28437
51088 msgid "Maximum length of queue of connections waiting to be accepted by the daemon. Note, that some protocols supporting retransmission may obey this so that a later reattempt at connection succeeds."
51092 #: guix-git/doc/guix.texi:28442
51094 msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients"
51098 #: guix-git/doc/guix.texi:28445
51099 msgid "Maximum length of queue of accepted but not yet authenticated clients. Set this to zero to turn this feature off"
51103 #: guix-git/doc/guix.texi:28447 guix-git/doc/guix.texi:28465
51104 #: guix-git/doc/guix.texi:28481
51105 msgid "Defaults to @samp{20}."
51109 #: guix-git/doc/guix.texi:28450
51111 msgid "{@code{libvirt-configuration} parameter} integer min-workers"
51115 #: guix-git/doc/guix.texi:28452
51116 msgid "Number of workers to start up initially."
51120 #: guix-git/doc/guix.texi:28457
51122 msgid "{@code{libvirt-configuration} parameter} integer max-workers"
51126 #: guix-git/doc/guix.texi:28459
51127 msgid "Maximum number of worker threads."
51131 #: guix-git/doc/guix.texi:28463
51132 msgid "If the number of active clients exceeds @code{min-workers}, then more threads are spawned, up to max_workers limit. Typically you'd want max_workers to equal maximum number of clients allowed."
51136 #: guix-git/doc/guix.texi:28468
51138 msgid "{@code{libvirt-configuration} parameter} integer prio-workers"
51142 #: guix-git/doc/guix.texi:28472
51143 msgid "Number of priority workers. If all workers from above pool are stuck, some calls marked as high priority (notably domainDestroy) can be executed in this pool."
51147 #: guix-git/doc/guix.texi:28477
51149 msgid "{@code{libvirt-configuration} parameter} integer max-requests"
51153 #: guix-git/doc/guix.texi:28479
51154 msgid "Total global limit on concurrent RPC calls."
51158 #: guix-git/doc/guix.texi:28484
51160 msgid "{@code{libvirt-configuration} parameter} integer max-client-requests"
51164 #: guix-git/doc/guix.texi:28488
51165 msgid "Limit on concurrent requests from a single client connection. To avoid one client monopolizing the server this should be a small fraction of the global max_requests and max_workers parameter."
51169 #: guix-git/doc/guix.texi:28493
51171 msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers"
51175 #: guix-git/doc/guix.texi:28495
51176 msgid "Same as @code{min-workers} but for the admin interface."
51180 #: guix-git/doc/guix.texi:28500
51182 msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers"
51186 #: guix-git/doc/guix.texi:28502
51187 msgid "Same as @code{max-workers} but for the admin interface."
51191 #: guix-git/doc/guix.texi:28507
51193 msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients"
51197 #: guix-git/doc/guix.texi:28509
51198 msgid "Same as @code{max-clients} but for the admin interface."
51202 #: guix-git/doc/guix.texi:28514
51204 msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients"
51208 #: guix-git/doc/guix.texi:28516
51209 msgid "Same as @code{max-queued-clients} but for the admin interface."
51213 #: guix-git/doc/guix.texi:28521
51215 msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests"
51219 #: guix-git/doc/guix.texi:28523
51220 msgid "Same as @code{max-client-requests} but for the admin interface."
51224 #: guix-git/doc/guix.texi:28528
51226 msgid "{@code{libvirt-configuration} parameter} integer log-level"
51230 #: guix-git/doc/guix.texi:28530 guix-git/doc/guix.texi:28754
51231 msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug."
51235 #: guix-git/doc/guix.texi:28535
51237 msgid "{@code{libvirt-configuration} parameter} string log-filters"
51241 #: guix-git/doc/guix.texi:28537 guix-git/doc/guix.texi:28761
51242 msgid "Logging filters."
51246 #: guix-git/doc/guix.texi:28540
51247 msgid "A filter allows to select a different logging level for a given category of logs. The format for a filter is one of:"
51251 #: guix-git/doc/guix.texi:28544 guix-git/doc/guix.texi:28768
51256 #: guix-git/doc/guix.texi:28547 guix-git/doc/guix.texi:28771
51261 #: guix-git/doc/guix.texi:28558
51262 msgid "where @code{name} is a string which is matched against the category given in the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., @samp{\"remote\"}, @samp{\"qemu\"}, or @samp{\"util.json\"} (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional @samp{\"+\"} prefix tells libvirt to log stack trace for each message matching name, and @code{x} is the minimal level where matching messages should be logged:"
51266 #: guix-git/doc/guix.texi:28562 guix-git/doc/guix.texi:28607
51267 #: guix-git/doc/guix.texi:28785 guix-git/doc/guix.texi:28830
51272 #: guix-git/doc/guix.texi:28565 guix-git/doc/guix.texi:28610
51273 #: guix-git/doc/guix.texi:28788 guix-git/doc/guix.texi:28833
51278 #: guix-git/doc/guix.texi:28568 guix-git/doc/guix.texi:28613
51279 #: guix-git/doc/guix.texi:28791 guix-git/doc/guix.texi:28836
51284 #: guix-git/doc/guix.texi:28571 guix-git/doc/guix.texi:28616
51285 #: guix-git/doc/guix.texi:28794 guix-git/doc/guix.texi:28839
51290 #: guix-git/doc/guix.texi:28576 guix-git/doc/guix.texi:28799
51291 msgid "Multiple filters can be defined in a single filters statement, they just need to be separated by spaces."
51295 #: guix-git/doc/guix.texi:28578 guix-git/doc/guix.texi:28801
51296 msgid "Defaults to @samp{\"3:remote 4:event\"}."
51300 #: guix-git/doc/guix.texi:28581
51302 msgid "{@code{libvirt-configuration} parameter} string log-outputs"
51306 #: guix-git/doc/guix.texi:28583 guix-git/doc/guix.texi:28806
51307 msgid "Logging outputs."
51311 #: guix-git/doc/guix.texi:28586
51312 msgid "An output is one of the places to save logging information. The format for an output can be:"
51316 #: guix-git/doc/guix.texi:28588 guix-git/doc/guix.texi:28811
51322 #: guix-git/doc/guix.texi:28590 guix-git/doc/guix.texi:28813
51323 msgid "output goes to stderr"
51327 #: guix-git/doc/guix.texi:28591 guix-git/doc/guix.texi:28814
51329 msgid "x:syslog:name"
51333 #: guix-git/doc/guix.texi:28593 guix-git/doc/guix.texi:28816
51334 msgid "use syslog for the output and use the given name as the ident"
51338 #: guix-git/doc/guix.texi:28594 guix-git/doc/guix.texi:28817
51340 msgid "x:file:file_path"
51344 #: guix-git/doc/guix.texi:28596 guix-git/doc/guix.texi:28819
51345 msgid "output to a file, with the given filepath"
51349 #: guix-git/doc/guix.texi:28597 guix-git/doc/guix.texi:28820
51355 #: guix-git/doc/guix.texi:28599 guix-git/doc/guix.texi:28822
51356 msgid "output to journald logging system"
51360 #: guix-git/doc/guix.texi:28603 guix-git/doc/guix.texi:28826
51361 msgid "In all case the x prefix is the minimal level, acting as a filter"
51365 #: guix-git/doc/guix.texi:28621 guix-git/doc/guix.texi:28844
51366 msgid "Multiple outputs can be defined, they just need to be separated by spaces."
51370 #: guix-git/doc/guix.texi:28623 guix-git/doc/guix.texi:28846
51371 msgid "Defaults to @samp{\"3:stderr\"}."
51375 #: guix-git/doc/guix.texi:28626
51377 msgid "{@code{libvirt-configuration} parameter} integer audit-level"
51381 #: guix-git/doc/guix.texi:28628
51382 msgid "Allows usage of the auditing subsystem to be altered"
51386 #: guix-git/doc/guix.texi:28632
51387 msgid "0: disable all auditing"
51391 #: guix-git/doc/guix.texi:28635
51392 msgid "1: enable auditing, only if enabled on host"
51396 #: guix-git/doc/guix.texi:28638
51397 msgid "2: enable auditing, and exit if disabled on host."
51401 #: guix-git/doc/guix.texi:28645
51403 msgid "{@code{libvirt-configuration} parameter} boolean audit-logging"
51407 #: guix-git/doc/guix.texi:28647
51408 msgid "Send audit messages via libvirt logging infrastructure."
51412 #: guix-git/doc/guix.texi:28652
51414 msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid"
51418 #: guix-git/doc/guix.texi:28654
51419 msgid "Host UUID@. UUID must not have all digits be the same."
51423 #: guix-git/doc/guix.texi:28659
51425 msgid "{@code{libvirt-configuration} parameter} string host-uuid-source"
51429 #: guix-git/doc/guix.texi:28661
51430 msgid "Source to read host UUID."
51434 #: guix-git/doc/guix.texi:28665
51435 msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}"
51439 #: guix-git/doc/guix.texi:28668
51440 msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}"
51444 #: guix-git/doc/guix.texi:28673
51445 msgid "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be generated."
51449 #: guix-git/doc/guix.texi:28675
51450 msgid "Defaults to @samp{\"smbios\"}."
51454 #: guix-git/doc/guix.texi:28678
51456 msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval"
51460 #: guix-git/doc/guix.texi:28683
51461 msgid "A keepalive message is sent to a client after @code{keepalive_interval} seconds of inactivity to check if the client is still responding. If set to -1, libvirtd will never send keepalive requests; however clients can still send them and the daemon will send responses."
51465 #: guix-git/doc/guix.texi:28688
51467 msgid "{@code{libvirt-configuration} parameter} integer keepalive-count"
51471 #: guix-git/doc/guix.texi:28692
51472 msgid "Maximum number of keepalive messages that are allowed to be sent to the client without getting any response before the connection is considered broken."
51476 #: guix-git/doc/guix.texi:28699
51477 msgid "In other words, the connection is automatically closed approximately after @code{keepalive_interval * (keepalive_count + 1)} seconds since the last message received from the client. When @code{keepalive-count} is set to 0, connections will be automatically closed after @code{keepalive-interval} seconds of inactivity without sending any keepalive messages."
51481 #: guix-git/doc/guix.texi:28704
51483 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval"
51487 #: guix-git/doc/guix.texi:28706 guix-git/doc/guix.texi:28713
51488 msgid "Same as above but for admin interface."
51492 #: guix-git/doc/guix.texi:28711
51494 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count"
51498 #: guix-git/doc/guix.texi:28718
51500 msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout"
51504 #: guix-git/doc/guix.texi:28720
51505 msgid "Timeout for Open vSwitch calls."
51509 #: guix-git/doc/guix.texi:28724
51510 msgid "The @code{ovs-vsctl} utility is used for the configuration and its timeout option is set by default to 5 seconds to avoid potential infinite waits blocking libvirt."
51513 #. type: subsubheading
51514 #: guix-git/doc/guix.texi:28731
51516 msgid "Virtlog daemon"
51519 #. type: Plain text
51520 #: guix-git/doc/guix.texi:28734
51521 msgid "The virtlogd service is a server side daemon component of libvirt that is used to manage logs from virtual machine consoles."
51524 #. type: Plain text
51525 #: guix-git/doc/guix.texi:28740
51526 msgid "This daemon is not used directly by libvirt client applications, rather it is called on their behalf by @code{libvirtd}. By maintaining the logs in a standalone daemon, the main @code{libvirtd} daemon can be restarted without risk of losing logs. The @code{virtlogd} daemon has the ability to re-exec() itself upon receiving @code{SIGUSR1}, to allow live upgrades without downtime."
51530 #: guix-git/doc/guix.texi:28741
51532 msgid "{Scheme Variable} virtlog-service-type"
51536 #: guix-git/doc/guix.texi:28744
51537 msgid "This is the type of the virtlog daemon. Its value must be a @code{virtlog-configuration}."
51541 #: guix-git/doc/guix.texi:28749
51544 "(service virtlog-service-type\n"
51545 " (virtlog-configuration\n"
51546 " (max-clients 1000)))\n"
51550 #: guix-git/doc/guix.texi:28752
51552 msgid "{@code{virtlog-configuration} parameter} integer log-level"
51556 #: guix-git/doc/guix.texi:28759
51558 msgid "{@code{virtlog-configuration} parameter} string log-filters"
51562 #: guix-git/doc/guix.texi:28764
51563 msgid "A filter allows to select a different logging level for a given category of logs The format for a filter is one of:"
51567 #: guix-git/doc/guix.texi:28781
51568 msgid "where @code{name} is a string which is matched against the category given in the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., \"remote\", \"qemu\", or \"util.json\" (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional \"+\" prefix tells libvirt to log stack trace for each message matching name, and @code{x} is the minimal level where matching messages should be logged:"
51572 #: guix-git/doc/guix.texi:28804
51574 msgid "{@code{virtlog-configuration} parameter} string log-outputs"
51578 #: guix-git/doc/guix.texi:28809
51579 msgid "An output is one of the places to save logging information The format for an output can be:"
51583 #: guix-git/doc/guix.texi:28849
51585 msgid "{@code{virtlog-configuration} parameter} integer max-clients"
51589 #: guix-git/doc/guix.texi:28854
51590 msgid "Defaults to @samp{1024}."
51594 #: guix-git/doc/guix.texi:28857
51596 msgid "{@code{virtlog-configuration} parameter} integer max-size"
51600 #: guix-git/doc/guix.texi:28859
51601 msgid "Maximum file size before rolling over."
51605 #: guix-git/doc/guix.texi:28861
51606 msgid "Defaults to @samp{2MB}"
51610 #: guix-git/doc/guix.texi:28864
51612 msgid "{@code{virtlog-configuration} parameter} integer max-backups"
51616 #: guix-git/doc/guix.texi:28866
51617 msgid "Maximum number of backup files to keep."
51621 #: guix-git/doc/guix.texi:28868
51622 msgid "Defaults to @samp{3}"
51625 #. type: anchor{#1}
51626 #: guix-git/doc/guix.texi:28872
51627 msgid "transparent-emulation-qemu"
51630 #. type: subsubheading
51631 #: guix-git/doc/guix.texi:28872
51633 msgid "Transparent Emulation with QEMU"
51637 #: guix-git/doc/guix.texi:28874
51643 #: guix-git/doc/guix.texi:28875
51645 msgid "binfmt_misc"
51648 #. type: Plain text
51649 #: guix-git/doc/guix.texi:28883
51650 msgid "@code{qemu-binfmt-service-type} provides support for transparent emulation of program binaries built for different architectures---e.g., it allows you to transparently execute an ARMv7 program on an x86_64 machine. It achieves this by combining the @uref{https://www.qemu.org, QEMU} emulator and the @code{binfmt_misc} feature of the kernel Linux. This feature only allows you to emulate GNU/Linux on a different architecture, but see below for GNU/Hurd support."
51654 #: guix-git/doc/guix.texi:28884
51656 msgid "{Scheme Variable} qemu-binfmt-service-type"
51660 #: guix-git/doc/guix.texi:28889
51661 msgid "This is the type of the QEMU/binfmt service for transparent emulation. Its value must be a @code{qemu-binfmt-configuration} object, which specifies the QEMU package to use as well as the architecture we want to emulated:"
51665 #: guix-git/doc/guix.texi:28894
51668 "(service qemu-binfmt-service-type\n"
51669 " (qemu-binfmt-configuration\n"
51670 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n"
51674 #: guix-git/doc/guix.texi:28900
51675 msgid "In this example, we enable transparent emulation for the ARM and aarch64 platforms. Running @code{herd stop qemu-binfmt} turns it off, and running @code{herd start qemu-binfmt} turns it back on (@pxref{Invoking herd, the @command{herd} command,, shepherd, The GNU Shepherd Manual})."
51679 #: guix-git/doc/guix.texi:28902
51681 msgid "{Data Type} qemu-binfmt-configuration"
51685 #: guix-git/doc/guix.texi:28904
51686 msgid "This is the configuration for the @code{qemu-binfmt} service."
51690 #: guix-git/doc/guix.texi:28906
51692 msgid "@code{platforms} (default: @code{'()})"
51696 #: guix-git/doc/guix.texi:28909
51697 msgid "The list of emulated QEMU platforms. Each item must be a @dfn{platform object} as returned by @code{lookup-qemu-platforms} (see below)."
51701 #: guix-git/doc/guix.texi:28912
51702 msgid "For example, let's suppose you're on an x86_64 machine and you have this service:"
51706 #: guix-git/doc/guix.texi:28917
51709 "(service qemu-binfmt-service-type\n"
51710 " (qemu-binfmt-configuration\n"
51711 " (platforms (lookup-qemu-platforms \"arm\"))))\n"
51715 #: guix-git/doc/guix.texi:28920
51716 msgid "You can run:"
51720 #: guix-git/doc/guix.texi:28923
51722 msgid "guix build -s armhf-linux inkscape\n"
51726 #: guix-git/doc/guix.texi:28930
51727 msgid "and it will build Inkscape for ARMv7 @emph{as if it were a native build}, transparently using QEMU to emulate the ARMv7 CPU@. Pretty handy if you'd like to test a package build for an architecture you don't have access to!"
51731 #: guix-git/doc/guix.texi:28931
51733 msgid "@code{qemu} (default: @code{qemu})"
51737 #: guix-git/doc/guix.texi:28933 guix-git/doc/guix.texi:29027
51738 msgid "The QEMU package to use."
51742 #: guix-git/doc/guix.texi:28936
51744 msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}"
51748 #: guix-git/doc/guix.texi:28941
51749 msgid "Return the list of QEMU platform objects corresponding to @var{platforms}@dots{}. @var{platforms} must be a list of strings corresponding to platform names, such as @code{\"arm\"}, @code{\"sparc\"}, @code{\"mips64el\"}, and so on."
51753 #: guix-git/doc/guix.texi:28943
51755 msgid "{Scheme Procedure} qemu-platform? @var{obj}"
51759 #: guix-git/doc/guix.texi:28945
51760 msgid "Return true if @var{obj} is a platform object."
51764 #: guix-git/doc/guix.texi:28947
51766 msgid "{Scheme Procedure} qemu-platform-name @var{platform}"
51770 #: guix-git/doc/guix.texi:28949
51771 msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}."
51774 #. type: subsubheading
51775 #: guix-git/doc/guix.texi:28952
51777 msgid "The Hurd in a Virtual Machine"
51781 #: guix-git/doc/guix.texi:28955
51787 #: guix-git/doc/guix.texi:28956
51792 #. type: Plain text
51793 #: guix-git/doc/guix.texi:28964
51794 msgid "Service @code{hurd-vm} provides support for running GNU/Hurd in a virtual machine (VM), a so-called @dfn{childhurd}. This service is meant to be used on GNU/Linux and the given GNU/Hurd operating system configuration is cross-compiled. The virtual machine is a Shepherd service that can be referred to by the names @code{hurd-vm} and @code{childhurd} and be controlled with commands such as:"
51798 #: guix-git/doc/guix.texi:28968
51801 "herd start hurd-vm\n"
51802 "herd stop childhurd\n"
51805 #. type: Plain text
51806 #: guix-git/doc/guix.texi:28972
51807 msgid "When the service is running, you can view its console by connecting to it with a VNC client, for example with:"
51811 #: guix-git/doc/guix.texi:28976
51814 "guix environment --ad-hoc tigervnc-client -- \\\n"
51815 " vncviewer localhost:5900\n"
51818 #. type: Plain text
51819 #: guix-git/doc/guix.texi:28982
51820 msgid "The default configuration (see @code{hurd-vm-configuration} below) spawns a secure shell (SSH) server in your GNU/Hurd system, which QEMU (the virtual machine emulator) redirects to port 10222 on the host. Thus, you can connect over SSH to the childhurd with:"
51824 #: guix-git/doc/guix.texi:28985
51826 msgid "ssh root@@localhost -p 10022\n"
51829 #. type: Plain text
51830 #: guix-git/doc/guix.texi:28994
51831 msgid "The childhurd is volatile and stateless: it starts with a fresh root file system every time you restart it. By default though, all the files under @file{/etc/childhurd} on the host are copied as is to the root file system of the childhurd when it boots. This allows you to initialize ``secrets'' inside the VM: SSH host keys, authorized substitute keys, and so on---see the explanation of @code{secret-root} below."
51835 #: guix-git/doc/guix.texi:28995
51837 msgid "{Scheme Variable} hurd-vm-service-type"
51841 #: guix-git/doc/guix.texi:29001
51842 msgid "This is the type of the Hurd in a Virtual Machine service. Its value must be a @code{hurd-vm-configuration} object, which specifies the operating system (@pxref{operating-system Reference}) and the disk size for the Hurd Virtual Machine, the QEMU package to use as well as the options for running it."
51846 #: guix-git/doc/guix.texi:29009
51849 "(service hurd-vm-service-type\n"
51850 " (hurd-vm-configuration\n"
51851 " (disk-size (* 5000 (expt 2 20))) ;5G\n"
51852 " (memory-size 1024))) ;1024MiB\n"
51856 #: guix-git/doc/guix.texi:29013
51857 msgid "would create a disk image big enough to build GNU@tie{}Hello, with some extra memory."
51861 #: guix-git/doc/guix.texi:29015
51863 msgid "{Data Type} hurd-vm-configuration"
51867 #: guix-git/doc/guix.texi:29018
51868 msgid "The data type representing the configuration for @code{hurd-vm-service-type}."
51872 #: guix-git/doc/guix.texi:29020
51874 msgid "@code{os} (default: @var{%hurd-vm-operating-system})"
51878 #: guix-git/doc/guix.texi:29024
51879 msgid "The operating system to instantiate. This default is bare-bones with a permissive OpenSSH secure shell daemon listening on port 2222 (@pxref{Networking Services, @code{openssh-service-type}})."
51883 #: guix-git/doc/guix.texi:29025
51885 msgid "@code{qemu} (default: @code{qemu-minimal})"
51889 #: guix-git/doc/guix.texi:29028
51891 msgid "@code{image} (default: @var{hurd-vm-disk-image})"
51895 #: guix-git/doc/guix.texi:29031
51896 msgid "The procedure used to build the disk-image built from this configuration."
51900 #: guix-git/doc/guix.texi:29032
51902 msgid "@code{disk-size} (default: @code{'guess})"
51906 #: guix-git/doc/guix.texi:29034
51907 msgid "The size of the disk image."
51911 #: guix-git/doc/guix.texi:29035
51913 msgid "@code{memory-size} (default: @code{512})"
51917 #: guix-git/doc/guix.texi:29037
51918 msgid "The memory size of the Virtual Machine in mebibytes."
51922 #: guix-git/doc/guix.texi:29038
51924 msgid "@code{options} (default: @code{'(\"--snapshot\")})"
51928 #: guix-git/doc/guix.texi:29040
51929 msgid "The extra options for running QEMU."
51933 #: guix-git/doc/guix.texi:29045
51934 msgid "If set, a non-zero positive integer used to parameterize Childhurd instances. It is appended to the service's name, e.g. @code{childhurd1}."
51938 #: guix-git/doc/guix.texi:29046
51940 msgid "@code{net-options} (default: @var{hurd-vm-net-options})"
51944 #: guix-git/doc/guix.texi:29048
51945 msgid "The procedure used to produce the list of QEMU networking options."
51949 #: guix-git/doc/guix.texi:29050
51950 msgid "By default, it produces"
51954 #: guix-git/doc/guix.texi:29057
51957 "'(\"--device\" \"rtl8139,netdev=net0\"\n"
51958 " \"--netdev\" \"user,id=net0\\\n"
51959 " ,hostfwd=tcp:127.0.0.1:@var{secrets-port}-:1004\\\n"
51960 " ,hostfwd=tcp:127.0.0.1:@var{ssh-port}-:2222\\\n"
51961 " ,hostfwd=tcp:127.0.0.1:@var{vnc-port}-:5900\")\n"
51965 #: guix-git/doc/guix.texi:29060
51966 msgid "with forwarded ports:"
51970 #: guix-git/doc/guix.texi:29065
51973 "@var{secrets-port}: @code{(+ 11004 (* 1000 @var{ID}))}\n"
51974 "@var{ssh-port}: @code{(+ 10022 (* 1000 @var{ID}))}\n"
51975 "@var{vnc-port}: @code{(+ 15900 (* 1000 @var{ID}))}\n"
51979 #: guix-git/doc/guix.texi:29067
51981 msgid "@code{secret-root} (default: @file{/etc/childhurd})"
51985 #: guix-git/doc/guix.texi:29072
51986 msgid "The root directory with out-of-band secrets to be installed into the childhurd once it runs. Childhurds are volatile which means that on every startup, secrets such as the SSH host keys and Guix signing key are recreated."
51990 #: guix-git/doc/guix.texi:29076
51991 msgid "If the @file{/etc/childhurd} directory does not exist, the @code{secret-service} running in the Childhurd will be sent an empty list of secrets."
51995 #: guix-git/doc/guix.texi:29079
51996 msgid "By default, the service automatically populates @file{/etc/childhurd} with the following non-volatile secrets, unless they already exist:"
52000 #: guix-git/doc/guix.texi:29088
52003 "/etc/childhurd/etc/guix/acl\n"
52004 "/etc/childhurd/etc/guix/signing-key.pub\n"
52005 "/etc/childhurd/etc/guix/signing-key.sec\n"
52006 "/etc/childhurd/etc/ssh/ssh_host_ed25519_key\n"
52007 "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key\n"
52008 "/etc/childhurd/etc/ssh/ssh_host_ed25519_key.pub\n"
52009 "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key.pub\n"
52013 #: guix-git/doc/guix.texi:29092
52014 msgid "These files are automatically sent to the guest Hurd VM when it boots, including permissions."
52018 #: guix-git/doc/guix.texi:29093
52020 msgid "childhurd, offloading"
52024 #: guix-git/doc/guix.texi:29094
52026 msgid "Hurd, offloading"
52030 #: guix-git/doc/guix.texi:29098
52031 msgid "Having these files in place means that only a couple of things are missing to allow the host to offload @code{i586-gnu} builds to the childhurd:"
52035 #: guix-git/doc/guix.texi:29103
52036 msgid "Authorizing the childhurd's key on the host so that the host accepts build results coming from the childhurd, which can be done like so:"
52040 #: guix-git/doc/guix.texi:29107
52043 "guix archive --authorize < \\\n"
52044 " /etc/childhurd/etc/guix/signing-key.pub\n"
52048 #: guix-git/doc/guix.texi:29112
52049 msgid "Adding the childhurd to @file{/etc/guix/machines.scm} (@pxref{Daemon Offload Setup})."
52053 #: guix-git/doc/guix.texi:29116
52054 msgid "We're working towards making that happen automatically---get in touch with us at @email{guix-devel@@gnu.org} to discuss it!"
52057 #. type: Plain text
52058 #: guix-git/doc/guix.texi:29123
52059 msgid "Note that by default the VM image is volatile, i.e., once stopped the contents are lost. If you want a stateful image instead, override the configuration's @code{image} and @code{options} without the @code{--snapshot} flag using something along these lines:"
52063 #: guix-git/doc/guix.texi:29129
52066 "(service hurd-vm-service-type\n"
52067 " (hurd-vm-configuration\n"
52068 " (image (const \"/out/of/store/writable/hurd.img\"))\n"
52069 " (options '())))\n"
52072 #. type: subsubheading
52073 #: guix-git/doc/guix.texi:29131
52079 #: guix-git/doc/guix.texi:29133
52085 #: guix-git/doc/guix.texi:29140
52086 msgid "This service is considered experimental. Configuration options may be changed in a backwards-incompatible manner, and not all features have been thorougly tested. Users of this service are encouraged to share their experience at @email{guix-devel@@gnu.org}."
52089 #. type: Plain text
52090 #: guix-git/doc/guix.texi:29150
52091 msgid "Ganeti is a virtual machine management system. It is designed to keep virtual machines running on a cluster of servers even in the event of hardware failures, and to make maintenance and recovery tasks easy. It consists of multiple services which are described later in this section. In addition to the Ganeti service, you will need the OpenSSH service (@pxref{Networking Services, @code{openssh-service-type}}), and update the @file{/etc/hosts} file (@pxref{operating-system Reference, @code{hosts-file}}) with the cluster name and address (or use a DNS server)."
52094 #. type: Plain text
52095 #: guix-git/doc/guix.texi:29155
52096 msgid "All nodes participating in a Ganeti cluster should have the same Ganeti and @file{/etc/hosts} configuration. Here is an example configuration for a Ganeti cluster node that supports multiple storage backends, and installs the @code{debootstrap} and @code{guix} @dfn{OS providers}:"
52100 #: guix-git/doc/guix.texi:29165
52103 "(use-package-modules virtualization)\n"
52104 "(use-service-modules base ganeti networking ssh)\n"
52105 "(operating-system\n"
52107 " (host-name \"node1\")\n"
52108 " (hosts-file (plain-file \"hosts\" (format #f \"\n"
52109 "127.0.0.1 localhost\n"
52115 #: guix-git/doc/guix.texi:29170
52118 "192.168.1.200 ganeti.example.com\n"
52119 "192.168.1.201 node1.example.com node1\n"
52120 "192.168.1.202 node2.example.com node2\n"
52126 #: guix-git/doc/guix.texi:29184
52129 " ;; Install QEMU so we can use KVM-based instances, and LVM, DRBD and Ceph\n"
52130 " ;; in order to use the \"plain\", \"drbd\" and \"rbd\" storage backends.\n"
52131 " (packages (append (map specification->package\n"
52132 " '(\"qemu\" \"lvm2\" \"drbd-utils\" \"ceph\"\n"
52133 " ;; Add the debootstrap and guix OS providers.\n"
52134 " \"ganeti-instance-guix\" \"ganeti-instance-debootstrap\"))\n"
52135 " %base-packages))\n"
52137 " (append (list (static-networking-service \"eth0\" \"192.168.1.201\"\n"
52138 " #:netmask \"255.255.255.0\"\n"
52139 " #:gateway \"192.168.1.254\"\n"
52140 " #:name-servers '(\"192.168.1.252\"\n"
52141 " \"192.168.1.253\"))\n"
52146 #: guix-git/doc/guix.texi:29189
52149 " ;; Ganeti uses SSH to communicate between nodes.\n"
52150 " (service openssh-service-type\n"
52151 " (openssh-configuration\n"
52152 " (permit-root-login 'without-password)))\n"
52157 #: guix-git/doc/guix.texi:29199
52160 " (service ganeti-service-type\n"
52161 " (ganeti-configuration\n"
52162 " ;; This list specifies allowed file system paths\n"
52163 " ;; for storing virtual machine images.\n"
52164 " (file-storage-paths '(\"/srv/ganeti/file-storage\"))\n"
52165 " ;; This variable configures a single \"variant\" for\n"
52166 " ;; both Debootstrap and Guix that works with KVM.\n"
52167 " (os %default-ganeti-os))))\n"
52168 " %base-services)))\n"
52171 #. type: Plain text
52172 #: guix-git/doc/guix.texi:29207
52173 msgid "Users are advised to read the @url{http://docs.ganeti.org/ganeti/master/html/admin.html,Ganeti administrators guide} to learn about the various cluster options and day-to-day operations. There is also a @url{https://guix.gnu.org/blog/2020/running-a-ganeti-cluster-on-guix/,blog post} describing how to configure and initialize a small cluster."
52177 #: guix-git/doc/guix.texi:29208
52179 msgid "{Scheme Variable} ganeti-service-type"
52183 #: guix-git/doc/guix.texi:29211
52184 msgid "This is a service type that includes all the various services that Ganeti nodes should run."
52188 #: guix-git/doc/guix.texi:29216
52189 msgid "Its value is a @code{ganeti-configuration} object that defines the package to use for CLI operations, as well as configuration for the various daemons. Allowed file storage paths and available guest operating systems are also configured through this data type."
52193 #: guix-git/doc/guix.texi:29218
52195 msgid "{Data Type} ganeti-configuration"
52199 #: guix-git/doc/guix.texi:29220
52200 msgid "The @code{ganeti} service takes the following configuration options:"
52204 #: guix-git/doc/guix.texi:29222 guix-git/doc/guix.texi:29450
52205 #: guix-git/doc/guix.texi:29500 guix-git/doc/guix.texi:29530
52206 #: guix-git/doc/guix.texi:29557 guix-git/doc/guix.texi:29589
52207 #: guix-git/doc/guix.texi:29642 guix-git/doc/guix.texi:29662
52208 #: guix-git/doc/guix.texi:29688 guix-git/doc/guix.texi:29721
52209 #: guix-git/doc/guix.texi:29761
52211 msgid "@code{ganeti} (default: @code{ganeti})"
52215 #: guix-git/doc/guix.texi:29227
52216 msgid "The @code{ganeti} package to use. It will be installed to the system profile and make @command{gnt-cluster}, @command{gnt-instance}, etc available. Note that the value specified here does not affect the other services as each refer to a specific @code{ganeti} package (see below)."
52220 #: guix-git/doc/guix.texi:29228
52222 msgid "@code{noded-configuration} (default: @code{(ganeti-noded-configuration)})"
52226 #: guix-git/doc/guix.texi:29229
52228 msgid "@code{confd-configuration} (default: @code{(ganeti-confd-configuration)})"
52232 #: guix-git/doc/guix.texi:29230
52234 msgid "@code{wconfd-configuration} (default: @code{(ganeti-wconfd-configuration)})"
52238 #: guix-git/doc/guix.texi:29231
52240 msgid "@code{luxid-configuration} (default: @code{(ganeti-luxid-configuration)})"
52244 #: guix-git/doc/guix.texi:29232
52246 msgid "@code{rapi-configuration} (default: @code{(ganeti-rapi-configuration)})"
52250 #: guix-git/doc/guix.texi:29233
52252 msgid "@code{kvmd-configuration} (default: @code{(ganeti-kvmd-configuration)})"
52256 #: guix-git/doc/guix.texi:29234
52258 msgid "@code{mond-configuration} (default: @code{(ganeti-mond-configuration)})"
52262 #: guix-git/doc/guix.texi:29235
52264 msgid "@code{metad-configuration} (default: @code{(ganeti-metad-configuration)})"
52268 #: guix-git/doc/guix.texi:29236
52270 msgid "@code{watcher-configuration} (default: @code{(ganeti-watcher-configuration)})"
52274 #: guix-git/doc/guix.texi:29237
52276 msgid "@code{cleaner-configuration} (default: @code{(ganeti-cleaner-configuration)})"
52280 #: guix-git/doc/guix.texi:29242
52281 msgid "These options control the various daemons and cron jobs that are distributed with Ganeti. The possible values for these are described in detail below. To override a setting, you must use the configuration type for that service:"
52285 #: guix-git/doc/guix.texi:29252
52288 "(service ganeti-service-type\n"
52289 " (ganeti-configuration\n"
52290 " (rapi-configuration\n"
52291 " (ganeti-rapi-configuration\n"
52292 " (interface \"eth1\"))))\n"
52293 " (watcher-configuration\n"
52294 " (ganeti-watcher-configuration\n"
52295 " (rapi-ip \"10.0.0.1\"))))\n"
52299 #: guix-git/doc/guix.texi:29254
52301 msgid "@code{file-storage-paths} (default: @code{'()})"
52305 #: guix-git/doc/guix.texi:29256
52306 msgid "List of allowed directories for file storage backend."
52310 #: guix-git/doc/guix.texi:29257
52312 msgid "@code{os} (default: @code{%default-ganeti-os})"
52316 #: guix-git/doc/guix.texi:29259
52317 msgid "List of @code{<ganeti-os>} records."
52321 #: guix-git/doc/guix.texi:29263
52322 msgid "In essence @code{ganeti-service-type} is shorthand for declaring each service individually:"
52326 #: guix-git/doc/guix.texi:29274
52329 "(service ganeti-noded-service-type)\n"
52330 "(service ganeti-confd-service-type)\n"
52331 "(service ganeti-wconfd-service-type)\n"
52332 "(service ganeti-luxid-service-type)\n"
52333 "(service ganeti-kvmd-service-type)\n"
52334 "(service ganeti-mond-service-type)\n"
52335 "(service ganeti-metad-service-type)\n"
52336 "(service ganeti-watcher-service-type)\n"
52337 "(service ganeti-cleaner-service-type)\n"
52341 #: guix-git/doc/guix.texi:29278
52342 msgid "Plus a service extension for @code{etc-service-type} that configures the file storage backend and OS variants."
52346 #: guix-git/doc/guix.texi:29281
52348 msgid "{Data Type} ganeti-os"
52352 #: guix-git/doc/guix.texi:29284
52353 msgid "This data type is suitable for passing to the @code{os} parameter of @code{ganeti-configuration}. It takes the following parameters:"
52357 #: guix-git/doc/guix.texi:29290
52358 msgid "The name for this OS provider. It is only used to specify where the configuration ends up. Setting it to ``debootstrap'' will create @file{/etc/ganeti/instance-debootstrap}."
52362 #: guix-git/doc/guix.texi:29291
52368 #: guix-git/doc/guix.texi:29294
52369 msgid "The file extension for variants of this OS type. For example @file{.conf} or @file{.scm}."
52373 #: guix-git/doc/guix.texi:29295
52375 msgid "@code{variants} (default: @code{'()})"
52379 #: guix-git/doc/guix.texi:29297
52380 msgid "List of @code{ganeti-os-variant} objects for this OS."
52384 #: guix-git/doc/guix.texi:29301
52386 msgid "{Data Type} ganeti-os-variant"
52390 #: guix-git/doc/guix.texi:29304
52391 msgid "This is the data type for a Ganeti OS variant. It takes the following parameters:"
52395 #: guix-git/doc/guix.texi:29308
52396 msgid "The name of this variant."
52400 #: guix-git/doc/guix.texi:29309
52402 msgid "configuration"
52406 #: guix-git/doc/guix.texi:29311
52407 msgid "A configuration file for this variant."
52411 #: guix-git/doc/guix.texi:29314
52413 msgid "{Scheme Variable} %default-debootstrap-hooks"
52417 #: guix-git/doc/guix.texi:29316
52418 msgid "This variable contains hooks to configure networking and the GRUB bootloader."
52422 #: guix-git/doc/guix.texi:29318
52424 msgid "{Scheme Variable} %default-debootstrap-extra-pkgs"
52428 #: guix-git/doc/guix.texi:29320
52429 msgid "This variable contains a list of packages suitable for a fully-virtualized guest."
52433 #: guix-git/doc/guix.texi:29322
52435 msgid "{Data Type} debootstrap-configuration"
52439 #: guix-git/doc/guix.texi:29325
52440 msgid "This data type creates configuration files suitable for the debootstrap OS provider."
52444 #: guix-git/doc/guix.texi:29327
52446 msgid "@code{hooks} (default: @code{%default-debootstrap-hooks})"
52450 #: guix-git/doc/guix.texi:29331
52451 msgid "When not @code{#f}, this must be a G-expression that specifies a directory with scripts that will run when the OS is installed. It can also be a list of @code{(name . file-like)} pairs. For example:"
52455 #: guix-git/doc/guix.texi:29334
52457 msgid "`((99-hello-world . ,(plain-file \"#!/bin/sh\\necho Hello, World\")))\n"
52461 #: guix-git/doc/guix.texi:29339
52462 msgid "That will create a directory with one executable named @code{99-hello-world} and run it every time this variant is installed. If set to @code{#f}, hooks in @file{/etc/ganeti/instance-debootstrap/hooks} will be used, if any."
52466 #: guix-git/doc/guix.texi:29339
52468 msgid "@code{proxy} (default: @code{#f})"
52472 #: guix-git/doc/guix.texi:29341
52473 msgid "Optional HTTP proxy to use."
52477 #: guix-git/doc/guix.texi:29341
52479 msgid "@code{mirror} (default: @code{#f})"
52483 #: guix-git/doc/guix.texi:29344
52484 msgid "The Debian mirror. Typically something like @code{http://ftp.no.debian.org/debian}. The default varies depending on the distribution."
52488 #: guix-git/doc/guix.texi:29344
52490 msgid "@code{arch} (default: @code{#f})"
52494 #: guix-git/doc/guix.texi:29347
52495 msgid "The dpkg architecture. Set to @code{armhf} to debootstrap an ARMv7 instance on an AArch64 host. Default is to use the current system architecture."
52499 #: guix-git/doc/guix.texi:29347
52501 msgid "@code{suite} (default: @code{\"stable\"})"
52505 #: guix-git/doc/guix.texi:29350
52506 msgid "When set, this must be a Debian distribution ``suite'' such as @code{buster} or @code{focal}. If set to @code{#f}, the default for the OS provider is used."
52510 #: guix-git/doc/guix.texi:29350
52512 msgid "@code{extra-pkgs} (default: @code{%default-debootstrap-extra-pkgs})"
52516 #: guix-git/doc/guix.texi:29353
52517 msgid "List of extra packages that will get installed by dpkg in addition to the minimal system."
52521 #: guix-git/doc/guix.texi:29353
52523 msgid "@code{components} (default: @code{#f})"
52527 #: guix-git/doc/guix.texi:29356
52528 msgid "When set, must be a list of Debian repository ``components''. For example @code{'(\"main\" \"contrib\")}."
52532 #: guix-git/doc/guix.texi:29356
52534 msgid "@code{generate-cache?} (default: @code{#t})"
52538 #: guix-git/doc/guix.texi:29358
52539 msgid "Whether to automatically cache the generated debootstrap archive."
52543 #: guix-git/doc/guix.texi:29358
52545 msgid "@code{clean-cache} (default: @code{14})"
52549 #: guix-git/doc/guix.texi:29361
52550 msgid "Discard the cache after this amount of days. Use @code{#f} to never clear the cache."
52554 #: guix-git/doc/guix.texi:29361
52556 msgid "@code{partition-style} (default: @code{'msdos})"
52560 #: guix-git/doc/guix.texi:29364
52561 msgid "The type of partition to create. When set, it must be one of @code{'msdos}, @code{'none} or a string."
52565 #: guix-git/doc/guix.texi:29364
52567 msgid "@code{partition-alignment} (default: @code{2048})"
52571 #: guix-git/doc/guix.texi:29366
52572 msgid "Alignment of the partition in sectors."
52576 #: guix-git/doc/guix.texi:29369
52578 msgid "{Scheme Procedure} debootstrap-variant @var{name} @var{configuration}"
52582 #: guix-git/doc/guix.texi:29372
52583 msgid "This is a helper procedure that creates a @code{ganeti-os-variant} record. It takes two parameters: a name and a @code{debootstrap-configuration} object."
52587 #: guix-git/doc/guix.texi:29374
52589 msgid "{Scheme Procedure} debootstrap-os @var{variants}@dots{}"
52593 #: guix-git/doc/guix.texi:29377
52594 msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants created with @code{debootstrap-variant}."
52598 #: guix-git/doc/guix.texi:29379
52600 msgid "{Scheme Procedure} guix-variant @var{name} @var{configuration}"
52604 #: guix-git/doc/guix.texi:29384
52605 msgid "This is a helper procedure that creates a @code{ganeti-os-variant} record for use with the Guix OS provider. It takes a name and a G-expression that returns a ``file-like'' (@pxref{G-Expressions, file-like objects}) object containing a Guix System configuration."
52609 #: guix-git/doc/guix.texi:29386
52611 msgid "{Scheme Procedure} guix-os @var{variants}@dots{}"
52615 #: guix-git/doc/guix.texi:29389
52616 msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants produced by @code{guix-variant}."
52620 #: guix-git/doc/guix.texi:29391
52622 msgid "{Scheme Variable} %default-debootstrap-variants"
52626 #: guix-git/doc/guix.texi:29395
52627 msgid "This is a convenience variable to make the debootstrap provider work ``out of the box'' without users having to declare variants manually. It contains a single debootstrap variant with the default configuration:"
52631 #: guix-git/doc/guix.texi:29400
52634 "(list (debootstrap-variant\n"
52636 " (debootstrap-configuration)))\n"
52640 #: guix-git/doc/guix.texi:29403
52642 msgid "{Scheme Variable} %default-guix-variants"
52646 #: guix-git/doc/guix.texi:29407
52647 msgid "This is a convenience variable to make the Guix OS provider work without additional configuration. It creates a virtual machine that has an SSH server, a serial console, and authorizes the Ganeti hosts SSH keys."
52651 #: guix-git/doc/guix.texi:29413
52654 "(list (guix-variant\n"
52656 " (file-append ganeti-instance-guix\n"
52657 " \"/share/doc/ganeti-instance-guix/examples/dynamic.scm\")))\n"
52660 #. type: Plain text
52661 #: guix-git/doc/guix.texi:29419
52662 msgid "Users can implement support for OS providers unbeknownst to Guix by extending the @code{ganeti-os} and @code{ganeti-os-variant} records appropriately. For example:"
52666 #: guix-git/doc/guix.texi:29428
52670 " (name \"custom\")\n"
52671 " (extension \".conf\")\n"
52673 " (list (ganeti-os-variant\n"
52674 " (name \"foo\")\n"
52675 " (configuration (plain-file \"bar\" \"this is fine\"))))))\n"
52678 #. type: Plain text
52679 #: guix-git/doc/guix.texi:29433
52680 msgid "That creates @file{/etc/ganeti/instance-custom/variants/foo.conf} which points to a file in the store with contents @code{this is fine}. It also creates @file{/etc/ganeti/instance-custom/variants/variants.list} with contents @code{foo}."
52683 #. type: Plain text
52684 #: guix-git/doc/guix.texi:29436
52685 msgid "Obviously this may not work for all OS providers out there. If you find the interface limiting, please reach out to @email{guix-devel@@gnu.org}."
52688 #. type: Plain text
52689 #: guix-git/doc/guix.texi:29439
52690 msgid "The rest of this section documents the various services that are included by @code{ganeti-service-type}."
52694 #: guix-git/doc/guix.texi:29440
52696 msgid "{Scheme Variable} ganeti-noded-service-type"
52700 #: guix-git/doc/guix.texi:29444
52701 msgid "@command{ganeti-noded} is the daemon responsible for node-specific functions within the Ganeti system. The value of this service must be a @code{ganeti-noded-configuration} object."
52705 #: guix-git/doc/guix.texi:29446
52707 msgid "{Data Type} ganeti-noded-configuration"
52711 #: guix-git/doc/guix.texi:29448
52712 msgid "This is the configuration for the @code{ganeti-noded} service."
52716 #: guix-git/doc/guix.texi:29452 guix-git/doc/guix.texi:29502
52717 #: guix-git/doc/guix.texi:29532 guix-git/doc/guix.texi:29559
52718 #: guix-git/doc/guix.texi:29591 guix-git/doc/guix.texi:29644
52719 #: guix-git/doc/guix.texi:29664 guix-git/doc/guix.texi:29690
52720 #: guix-git/doc/guix.texi:29723
52721 msgid "The @code{ganeti} package to use for this service."
52725 #: guix-git/doc/guix.texi:29453
52727 msgid "@code{port} (default: @code{1811})"
52731 #: guix-git/doc/guix.texi:29455
52732 msgid "The TCP port on which the node daemon listens for network requests."
52736 #: guix-git/doc/guix.texi:29456 guix-git/doc/guix.texi:29506
52737 #: guix-git/doc/guix.texi:29598 guix-git/doc/guix.texi:29668
52739 msgid "@code{address} (default: @code{\"0.0.0.0\"})"
52743 #: guix-git/doc/guix.texi:29459
52744 msgid "The network address that the daemon will bind to. The default address means bind to all available addresses."
52748 #: guix-git/doc/guix.texi:29463
52749 msgid "When this is set, it must be a specific network interface (e.g.@: @code{eth0}) that the daemon will bind to."
52753 #: guix-git/doc/guix.texi:29464 guix-git/doc/guix.texi:29606
52755 msgid "@code{max-clients} (default: @code{20})"
52759 #: guix-git/doc/guix.texi:29468
52760 msgid "This sets a limit on the maximum number of simultaneous client connections that the daemon will handle. Connections above this count are accepted, but no responses will be sent until enough connections have closed."
52764 #: guix-git/doc/guix.texi:29469 guix-git/doc/guix.texi:29611
52766 msgid "@code{ssl?} (default: @code{#t})"
52770 #: guix-git/doc/guix.texi:29473
52771 msgid "Whether to use SSL/TLS to encrypt network communications. The certificate is automatically provisioned by the cluster and can be rotated with @command{gnt-cluster renew-crypto}."
52775 #: guix-git/doc/guix.texi:29474 guix-git/doc/guix.texi:29614
52777 msgid "@code{ssl-key} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52781 #: guix-git/doc/guix.texi:29476 guix-git/doc/guix.texi:29616
52782 msgid "This can be used to provide a specific encryption key for TLS communications."
52786 #: guix-git/doc/guix.texi:29477 guix-git/doc/guix.texi:29617
52788 msgid "@code{ssl-cert} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52792 #: guix-git/doc/guix.texi:29479 guix-git/doc/guix.texi:29619
52793 msgid "This can be used to provide a specific certificate for TLS communications."
52797 #: guix-git/doc/guix.texi:29483 guix-git/doc/guix.texi:29623
52798 msgid "When true, the daemon performs additional logging for debugging purposes. Note that this will leak encryption details to the log files, use with caution."
52802 #: guix-git/doc/guix.texi:29487
52804 msgid "{Scheme Variable} ganeti-confd-service-type"
52808 #: guix-git/doc/guix.texi:29493
52809 msgid "@command{ganeti-confd} answers queries related to the configuration of a Ganeti cluster. The purpose of this daemon is to have a highly available and fast way to query cluster configuration values. It is automatically active on all @dfn{master candidates}. The value of this service must be a @code{ganeti-confd-configuration} object."
52813 #: guix-git/doc/guix.texi:29496
52815 msgid "{Data Type} ganeti-confd-configuration"
52819 #: guix-git/doc/guix.texi:29498
52820 msgid "This is the configuration for the @code{ganeti-confd} service."
52824 #: guix-git/doc/guix.texi:29503
52826 msgid "@code{port} (default: @code{1814})"
52830 #: guix-git/doc/guix.texi:29505
52831 msgid "The UDP port on which to listen for network requests."
52835 #: guix-git/doc/guix.texi:29508
52836 msgid "Network address that the daemon will bind to."
52840 #: guix-git/doc/guix.texi:29511 guix-git/doc/guix.texi:29540
52841 #: guix-git/doc/guix.texi:29567 guix-git/doc/guix.texi:29647
52842 #: guix-git/doc/guix.texi:29674 guix-git/doc/guix.texi:29700
52843 msgid "When true, the daemon performs additional logging for debugging purposes."
52847 #: guix-git/doc/guix.texi:29515
52849 msgid "{Scheme Variable} ganeti-wconfd-service-type"
52853 #: guix-git/doc/guix.texi:29521
52854 msgid "@command{ganeti-wconfd} is the daemon that has authoritative knowledge about the cluster configuration and is the only entity that can accept changes to it. All jobs that need to modify the configuration will do so by sending appropriate requests to this daemon. It only runs on the @dfn{master node} and will automatically disable itself on other nodes."
52858 #: guix-git/doc/guix.texi:29524
52859 msgid "The value of this service must be a @code{ganeti-wconfd-configuration} object."
52863 #: guix-git/doc/guix.texi:29526
52865 msgid "{Data Type} ganeti-wconfd-configuration"
52869 #: guix-git/doc/guix.texi:29528 guix-git/doc/guix.texi:29555
52870 msgid "This is the configuration for the @code{ganeti-wconfd} service."
52874 #: guix-git/doc/guix.texi:29533 guix-git/doc/guix.texi:29560
52876 msgid "@code{no-voting?} (default: @code{#f})"
52880 #: guix-git/doc/guix.texi:29537
52881 msgid "The daemon will refuse to start if the majority of cluster nodes does not agree that it is running on the master node. Set to @code{#t} to start even if a quorum can not be reached (dangerous, use with caution)."
52885 #: guix-git/doc/guix.texi:29544
52887 msgid "{Scheme Variable} ganeti-luxid-service-type"
52891 #: guix-git/doc/guix.texi:29549
52892 msgid "@command{ganeti-luxid} is a daemon used to answer queries related to the configuration and the current live state of a Ganeti cluster. Additionally, it is the authoritative daemon for the Ganeti job queue. Jobs can be submitted via this daemon and it schedules and starts them."
52896 #: guix-git/doc/guix.texi:29551
52897 msgid "It takes a @code{ganeti-luxid-configuration} object."
52901 #: guix-git/doc/guix.texi:29553
52903 msgid "{Data Type} ganeti-luxid-configuration"
52907 #: guix-git/doc/guix.texi:29564
52908 msgid "The daemon will refuse to start if it cannot verify that the majority of cluster nodes believes that it is running on the master node. Set to @code{#t} to ignore such checks and start anyway (this can be dangerous)."
52912 #: guix-git/doc/guix.texi:29571
52914 msgid "{Scheme Variable} ganeti-rapi-service-type"
52918 #: guix-git/doc/guix.texi:29575
52919 msgid "@command{ganeti-rapi} provides a remote API for Ganeti clusters. It runs on the master node and can be used to perform cluster actions programmatically via a JSON-based RPC protocol."
52923 #: guix-git/doc/guix.texi:29581
52924 msgid "Most query operations are allowed without authentication (unless @var{require-authentication?} is set), whereas write operations require explicit authorization via the @file{/var/lib/ganeti/rapi/users} file. See the @url{http://docs.ganeti.org/ganeti/master/html/rapi.html, Ganeti Remote API documentation} for more information."
52928 #: guix-git/doc/guix.texi:29583
52929 msgid "The value of this service must be a @code{ganeti-rapi-configuration} object."
52933 #: guix-git/doc/guix.texi:29585
52935 msgid "{Data Type} ganeti-rapi-configuration"
52939 #: guix-git/doc/guix.texi:29587
52940 msgid "This is the configuration for the @code{ganeti-rapi} service."
52944 #: guix-git/doc/guix.texi:29592
52946 msgid "@code{require-authentication?} (default: @code{#f})"
52950 #: guix-git/doc/guix.texi:29594
52951 msgid "Whether to require authentication even for read-only operations."
52955 #: guix-git/doc/guix.texi:29595
52957 msgid "@code{port} (default: @code{5080})"
52961 #: guix-git/doc/guix.texi:29597
52962 msgid "The TCP port on which to listen to API requests."
52966 #: guix-git/doc/guix.texi:29601
52967 msgid "The network address that the service will bind to. By default it listens on all configured addresses."
52971 #: guix-git/doc/guix.texi:29605
52972 msgid "When set, it must specify a specific network interface such as @code{eth0} that the daemon will bind to."
52976 #: guix-git/doc/guix.texi:29610
52977 msgid "The maximum number of simultaneous client requests to handle. Further connections are allowed, but no responses are sent until enough connections have closed."
52981 #: guix-git/doc/guix.texi:29613
52982 msgid "Whether to use SSL/TLS encryption on the RAPI port."
52986 #: guix-git/doc/guix.texi:29627
52988 msgid "{Scheme Variable} ganeti-kvmd-service-type"
52992 #: guix-git/doc/guix.texi:29635
52993 msgid "@command{ganeti-kvmd} is responsible for determining whether a given KVM instance was shut down by an administrator or a user. Normally Ganeti will restart an instance that was not stopped through Ganeti itself. If the cluster option @code{user_shutdown} is true, this daemon monitors the @code{QMP} socket provided by QEMU and listens for shutdown events, and marks the instance as @dfn{USER_down} instead of @dfn{ERROR_down} when it shuts down gracefully by itself."
52997 #: guix-git/doc/guix.texi:29637
52998 msgid "It takes a @code{ganeti-kvmd-configuration} object."
53002 #: guix-git/doc/guix.texi:29639
53004 msgid "{Data Type} ganeti-kvmd-configuration"
53008 #: guix-git/doc/guix.texi:29651
53010 msgid "{Scheme Variable} ganeti-mond-service-type"
53014 #: guix-git/doc/guix.texi:29655
53015 msgid "@command{ganeti-mond} is an optional daemon that provides Ganeti monitoring functionality. It is responsible for running data collectors and publish the collected information through a HTTP interface."
53019 #: guix-git/doc/guix.texi:29657
53020 msgid "It takes a @code{ganeti-mond-configuration} object."
53024 #: guix-git/doc/guix.texi:29659
53026 msgid "{Data Type} ganeti-mond-configuration"
53030 #: guix-git/doc/guix.texi:29665
53032 msgid "@code{port} (default: @code{1815})"
53036 #: guix-git/doc/guix.texi:29667 guix-git/doc/guix.texi:29693
53037 msgid "The port on which the daemon will listen."
53041 #: guix-git/doc/guix.texi:29671
53042 msgid "The network address that the daemon will bind to. By default it binds to all available interfaces."
53046 #: guix-git/doc/guix.texi:29678
53048 msgid "{Scheme Variable} ganeti-metad-service-type"
53052 #: guix-git/doc/guix.texi:29681
53053 msgid "@command{ganeti-metad} is an optional daemon that can be used to provide information about the cluster to instances or OS install scripts."
53057 #: guix-git/doc/guix.texi:29683
53058 msgid "It takes a @code{ganeti-metad-configuration} object."
53062 #: guix-git/doc/guix.texi:29685
53064 msgid "{Data Type} ganeti-metad-configuration"
53068 #: guix-git/doc/guix.texi:29694
53070 msgid "@code{address} (default: @code{#f})"
53074 #: guix-git/doc/guix.texi:29697
53075 msgid "If set, the daemon will bind to this address only. If left unset, the behavior depends on the cluster configuration."
53079 #: guix-git/doc/guix.texi:29704
53081 msgid "{Scheme Variable} ganeti-watcher-service-type"
53085 #: guix-git/doc/guix.texi:29712
53086 msgid "@command{ganeti-watcher} is a script designed to run periodically and ensure the health of a cluster. It will automatically restart instances that have stopped without Ganeti's consent, and repairs DRBD links in case a node has rebooted. It also archives old cluster jobs and restarts Ganeti daemons that are not running. If the cluster parameter @code{ensure_node_health} is set, the watcher will also shutdown instances and DRBD devices if the node it is running on is declared offline by known master candidates."
53090 #: guix-git/doc/guix.texi:29714
53091 msgid "It can be paused on all nodes with @command{gnt-cluster watcher pause}."
53095 #: guix-git/doc/guix.texi:29716
53096 msgid "The service takes a @code{ganeti-watcher-configuration} object."
53100 #: guix-git/doc/guix.texi:29718
53102 msgid "{Data Type} ganeti-watcher-configuration"
53106 #: guix-git/doc/guix.texi:29724
53108 msgid "@code{schedule} (default: @code{'(next-second-from (next-minute (range 0 60 5)))})"
53112 #: guix-git/doc/guix.texi:29726
53113 msgid "How often to run the script. The default is every five minutes."
53117 #: guix-git/doc/guix.texi:29727
53119 msgid "@code{rapi-ip} (default: @code{#f})"
53123 #: guix-git/doc/guix.texi:29730
53124 msgid "This option needs to be specified only if the RAPI daemon is configured to use a particular interface or address. By default the cluster address is used."
53128 #: guix-git/doc/guix.texi:29731
53130 msgid "@code{job-age} (default: @code{(* 6 3600)})"
53134 #: guix-git/doc/guix.texi:29734
53135 msgid "Archive cluster jobs older than this age, specified in seconds. The default is 6 hours. This keeps @command{gnt-job list} manageable."
53139 #: guix-git/doc/guix.texi:29735
53141 msgid "@code{verify-disks?} (default: @code{#t})"
53145 #: guix-git/doc/guix.texi:29739
53146 msgid "If this is @code{#f}, the watcher will not try to repair broken DRBD links automatically. Administrators will need to use @command{gnt-cluster verify-disks} manually instead."
53150 #: guix-git/doc/guix.texi:29742
53151 msgid "When @code{#t}, the script performs additional logging for debugging purposes."
53155 #: guix-git/doc/guix.texi:29746
53157 msgid "{Scheme Variable} ganeti-cleaner-service-type"
53161 #: guix-git/doc/guix.texi:29754
53162 msgid "@command{ganeti-cleaner} is a script designed to run periodically and remove old files from the cluster. This service type controls two @dfn{cron jobs}: one intended for the master node that permanently purges old cluster jobs, and one intended for every node that removes expired X509 certificates, keys, and outdated @command{ganeti-watcher} information. Like all Ganeti services, it is safe to include even on non-master nodes as it will disable itself as necessary."
53166 #: guix-git/doc/guix.texi:29756
53167 msgid "It takes a @code{ganeti-cleaner-configuration} object."
53171 #: guix-git/doc/guix.texi:29758
53173 msgid "{Data Type} ganeti-cleaner-configuration"
53177 #: guix-git/doc/guix.texi:29763
53178 msgid "The @code{ganeti} package to use for the @command{gnt-cleaner} command."
53182 #: guix-git/doc/guix.texi:29764
53184 msgid "@code{master-schedule} (default: @code{\"45 1 * * *\"})"
53188 #: guix-git/doc/guix.texi:29767
53189 msgid "How often to run the master cleaning job. The default is once per day, at 01:45:00."
53193 #: guix-git/doc/guix.texi:29768
53195 msgid "@code{node-schedule} (default: @code{\"45 2 * * *\"})"
53199 #: guix-git/doc/guix.texi:29771
53200 msgid "How often to run the node cleaning job. The default is once per day, at 02:45:00."
53203 #. type: Plain text
53204 #: guix-git/doc/guix.texi:29785
53205 msgid "The @code{(gnu services version-control)} module provides a service to allow remote access to local Git repositories. There are three options: the @code{git-daemon-service}, which provides access to repositories via the @code{git://} unsecured TCP-based protocol, extending the @code{nginx} web server to proxy some requests to @code{git-http-backend}, or providing a web interface with @code{cgit-service-type}."
53209 #: guix-git/doc/guix.texi:29786
53211 msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]"
53215 #: guix-git/doc/guix.texi:29790
53216 msgid "Return a service that runs @command{git daemon}, a simple TCP server to expose repositories over the Git protocol for anonymous access."
53220 #: guix-git/doc/guix.texi:29796
53221 msgid "The optional @var{config} argument should be a @code{<git-daemon-configuration>} object, by default it allows read-only access to exported@footnote{By creating the magic file @file{git-daemon-export-ok} in the repository directory.} repositories under @file{/srv/git}."
53225 #: guix-git/doc/guix.texi:29799
53227 msgid "{Data Type} git-daemon-configuration"
53231 #: guix-git/doc/guix.texi:29801
53232 msgid "Data type representing the configuration for @code{git-daemon-service}."
53236 #: guix-git/doc/guix.texi:29803
53238 msgid "@code{package} (default: @code{git})"
53242 #: guix-git/doc/guix.texi:29805 guix-git/doc/guix.texi:29865
53243 msgid "Package object of the Git distributed version control system."
53247 #: guix-git/doc/guix.texi:29806 guix-git/doc/guix.texi:29869
53249 msgid "@code{export-all?} (default: @code{#f})"
53253 #: guix-git/doc/guix.texi:29809
53254 msgid "Whether to allow access for all Git repositories, even if they do not have the @file{git-daemon-export-ok} file."
53258 #: guix-git/doc/guix.texi:29810
53260 msgid "@code{base-path} (default: @file{/srv/git})"
53264 #: guix-git/doc/guix.texi:29816
53265 msgid "Whether to remap all the path requests as relative to the given path. If you run @command{git daemon} with @code{(base-path \"/srv/git\")} on @samp{example.com}, then if you later try to pull @indicateurl{git://example.com/hello.git}, git daemon will interpret the path as @file{/srv/git/hello.git}."
53269 #: guix-git/doc/guix.texi:29817
53271 msgid "@code{user-path} (default: @code{#f})"
53275 #: guix-git/doc/guix.texi:29825
53276 msgid "Whether to allow @code{~user} notation to be used in requests. When specified with empty string, requests to @indicateurl{git://host/~alice/foo} is taken as a request to access @code{foo} repository in the home directory of user @code{alice}. If @code{(user-path \"@var{path}\")} is specified, the same request is taken as a request to access @file{@var{path}/foo} repository in the home directory of user @code{alice}."
53280 #: guix-git/doc/guix.texi:29826
53282 msgid "@code{listen} (default: @code{'()})"
53286 #: guix-git/doc/guix.texi:29829
53287 msgid "Whether to listen on specific IP addresses or hostnames, defaults to all."
53291 #: guix-git/doc/guix.texi:29830
53293 msgid "@code{port} (default: @code{#f})"
53297 #: guix-git/doc/guix.texi:29832
53298 msgid "Whether to listen on an alternative port, which defaults to 9418."
53302 #: guix-git/doc/guix.texi:29833
53304 msgid "@code{whitelist} (default: @code{'()})"
53308 #: guix-git/doc/guix.texi:29835
53309 msgid "If not empty, only allow access to this list of directories."
53313 #: guix-git/doc/guix.texi:29839
53314 msgid "Extra options will be passed to @command{git daemon}, please run @command{man git-daemon} for more information."
53317 #. type: Plain text
53318 #: guix-git/doc/guix.texi:29853
53319 msgid "The @code{git://} protocol lacks authentication. When you pull from a repository fetched via @code{git://}, you don't know whether the data you receive was modified or is even coming from the specified host, and your connection is subject to eavesdropping. It's better to use an authenticated and encrypted transport, such as @code{https}. Although Git allows you to serve repositories using unsophisticated file-based web servers, there is a faster protocol implemented by the @code{git-http-backend} program. This program is the back-end of a proper Git web service. It is designed to sit behind a FastCGI proxy. @xref{Web Services}, for more on running the necessary @code{fcgiwrap} daemon."
53322 #. type: Plain text
53323 #: guix-git/doc/guix.texi:29856
53324 msgid "Guix has a separate configuration data type for serving Git repositories over HTTP."
53328 #: guix-git/doc/guix.texi:29857
53330 msgid "{Data Type} git-http-configuration"
53334 #: guix-git/doc/guix.texi:29861
53335 msgid "Data type representing the configuration for a future @code{git-http-service-type}; can currently be used to configure Nginx through @code{git-http-nginx-location-configuration}."
53339 #: guix-git/doc/guix.texi:29863
53341 msgid "@code{package} (default: @var{git})"
53345 #: guix-git/doc/guix.texi:29866
53347 msgid "@code{git-root} (default: @file{/srv/git})"
53351 #: guix-git/doc/guix.texi:29868
53352 msgid "Directory containing the Git repositories to expose to the world."
53356 #: guix-git/doc/guix.texi:29872
53357 msgid "Whether to expose access for all Git repositories in @var{git-root}, even if they do not have the @file{git-daemon-export-ok} file."
53361 #: guix-git/doc/guix.texi:29873
53363 msgid "@code{uri-path} (default: @samp{/git/})"
53367 #: guix-git/doc/guix.texi:29878
53368 msgid "Path prefix for Git access. With the default @samp{/git/} prefix, this will map @indicateurl{http://@var{server}/git/@var{repo}.git} to @file{/srv/git/@var{repo}.git}. Requests whose URI paths do not begin with this prefix are not passed on to this Git instance."
53372 #: guix-git/doc/guix.texi:29879
53374 msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})"
53378 #: guix-git/doc/guix.texi:29882
53379 msgid "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web Services}."
53382 #. type: Plain text
53383 #: guix-git/doc/guix.texi:29889
53384 msgid "There is no @code{git-http-service-type}, currently; instead you can create an @code{nginx-location-configuration} from a @code{git-http-configuration} and then add that location to a web server."
53388 #: guix-git/doc/guix.texi:29890
53390 msgid "{Scheme Procedure} git-http-nginx-location-configuration @"
53394 #: guix-git/doc/guix.texi:29895
53395 msgid "[config=(git-http-configuration)] Compute an @code{nginx-location-configuration} that corresponds to the given Git http configuration. An example nginx service definition to serve the default @file{/srv/git} over HTTPS might be:"
53399 #: guix-git/doc/guix.texi:29912
53402 "(service nginx-service-type\n"
53403 " (nginx-configuration\n"
53404 " (server-blocks\n"
53406 " (nginx-server-configuration\n"
53407 " (listen '(\"443 ssl\"))\n"
53408 " (server-name \"git.my-host.org\")\n"
53409 " (ssl-certificate\n"
53410 " \"/etc/letsencrypt/live/git.my-host.org/fullchain.pem\")\n"
53411 " (ssl-certificate-key\n"
53412 " \"/etc/letsencrypt/live/git.my-host.org/privkey.pem\")\n"
53415 " (git-http-nginx-location-configuration\n"
53416 " (git-http-configuration (uri-path \"/\"))))))))))\n"
53420 #: guix-git/doc/guix.texi:29919
53421 msgid "This example assumes that you are using Let's Encrypt to get your TLS certificate. @xref{Certificate Services}. The default @code{certbot} service will redirect all HTTP traffic on @code{git.my-host.org} to HTTPS@. You will also need to add an @code{fcgiwrap} proxy to your system services. @xref{Web Services}."
53424 #. type: subsubheading
53425 #: guix-git/doc/guix.texi:29921
53427 msgid "Cgit Service"
53431 #: guix-git/doc/guix.texi:29923
53433 msgid "Cgit service"
53437 #: guix-git/doc/guix.texi:29924
53439 msgid "Git, web interface"
53442 #. type: Plain text
53443 #: guix-git/doc/guix.texi:29927
53444 msgid "@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git repositories written in C."
53447 #. type: Plain text
53448 #: guix-git/doc/guix.texi:29930
53449 msgid "The following example will configure the service with default values. By default, Cgit can be accessed on port 80 (@code{http://localhost:80})."
53453 #: guix-git/doc/guix.texi:29933
53455 msgid "(service cgit-service-type)\n"
53458 #. type: Plain text
53459 #: guix-git/doc/guix.texi:29937
53460 msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a string."
53463 #. type: Plain text
53464 #: guix-git/doc/guix.texi:29941
53465 msgid "Available @code{cgit-configuration} fields are:"
53469 #: guix-git/doc/guix.texi:29942
53471 msgid "{@code{cgit-configuration} parameter} package package"
53475 #: guix-git/doc/guix.texi:29944
53476 msgid "The CGIT package."
53480 #: guix-git/doc/guix.texi:29947
53482 msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx"
53486 #: guix-git/doc/guix.texi:29952
53488 msgid "{@code{cgit-configuration} parameter} file-object about-filter"
53492 #: guix-git/doc/guix.texi:29955
53493 msgid "Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository)."
53497 #: guix-git/doc/guix.texi:29960
53499 msgid "{@code{cgit-configuration} parameter} string agefile"
53503 #: guix-git/doc/guix.texi:29963
53504 msgid "Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository."
53508 #: guix-git/doc/guix.texi:29968
53510 msgid "{@code{cgit-configuration} parameter} file-object auth-filter"
53514 #: guix-git/doc/guix.texi:29971
53515 msgid "Specifies a command that will be invoked for authenticating repository access."
53519 #: guix-git/doc/guix.texi:29976
53521 msgid "{@code{cgit-configuration} parameter} string branch-sort"
53525 #: guix-git/doc/guix.texi:29979
53526 msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set @samp{name} enables ordering by branch name."
53530 #: guix-git/doc/guix.texi:29981
53531 msgid "Defaults to @samp{\"name\"}."
53535 #: guix-git/doc/guix.texi:29984
53537 msgid "{@code{cgit-configuration} parameter} string cache-root"
53541 #: guix-git/doc/guix.texi:29986
53542 msgid "Path used to store the cgit cache entries."
53546 #: guix-git/doc/guix.texi:29988
53547 msgid "Defaults to @samp{\"/var/cache/cgit\"}."
53551 #: guix-git/doc/guix.texi:29991
53553 msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl"
53557 #: guix-git/doc/guix.texi:29994
53558 msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1."
53562 #: guix-git/doc/guix.texi:29996 guix-git/doc/guix.texi:30439
53563 msgid "Defaults to @samp{-1}."
53567 #: guix-git/doc/guix.texi:29999
53569 msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl"
53573 #: guix-git/doc/guix.texi:30002
53574 msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1."
53578 #: guix-git/doc/guix.texi:30007
53580 msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl"
53584 #: guix-git/doc/guix.texi:30010
53585 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page."
53589 #: guix-git/doc/guix.texi:30015
53591 msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl"
53595 #: guix-git/doc/guix.texi:30018
53596 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository index page."
53600 #: guix-git/doc/guix.texi:30023
53602 msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl"
53606 #: guix-git/doc/guix.texi:30026
53607 msgid "Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories."
53611 #: guix-git/doc/guix.texi:30031
53613 msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl"
53617 #: guix-git/doc/guix.texi:30034
53618 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository about page."
53622 #: guix-git/doc/guix.texi:30039
53624 msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl"
53628 #: guix-git/doc/guix.texi:30042
53629 msgid "Number which specifies the time-to-live, in minutes, for the cached version of snapshots."
53633 #: guix-git/doc/guix.texi:30047
53635 msgid "{@code{cgit-configuration} parameter} integer cache-size"
53639 #: guix-git/doc/guix.texi:30050
53640 msgid "The maximum number of entries in the cgit cache. When set to @samp{0}, caching is disabled."
53644 #: guix-git/doc/guix.texi:30055
53646 msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?"
53650 #: guix-git/doc/guix.texi:30057
53651 msgid "Sort items in the repo list case sensitively."
53655 #: guix-git/doc/guix.texi:30062
53657 msgid "{@code{cgit-configuration} parameter} list clone-prefix"
53661 #: guix-git/doc/guix.texi:30065
53662 msgid "List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository."
53666 #: guix-git/doc/guix.texi:30070
53668 msgid "{@code{cgit-configuration} parameter} list clone-url"
53672 #: guix-git/doc/guix.texi:30072
53673 msgid "List of @code{clone-url} templates."
53677 #: guix-git/doc/guix.texi:30077
53679 msgid "{@code{cgit-configuration} parameter} file-object commit-filter"
53683 #: guix-git/doc/guix.texi:30079
53684 msgid "Command which will be invoked to format commit messages."
53688 #: guix-git/doc/guix.texi:30084
53690 msgid "{@code{cgit-configuration} parameter} string commit-sort"
53694 #: guix-git/doc/guix.texi:30088 guix-git/doc/guix.texi:30646
53695 msgid "Flag which, when set to @samp{date}, enables strict date ordering in the commit log, and when set to @samp{topo} enables strict topological ordering."
53699 #: guix-git/doc/guix.texi:30090
53700 msgid "Defaults to @samp{\"git log\"}."
53704 #: guix-git/doc/guix.texi:30093
53706 msgid "{@code{cgit-configuration} parameter} file-object css"
53710 #: guix-git/doc/guix.texi:30095
53711 msgid "URL which specifies the css document to include in all cgit pages."
53715 #: guix-git/doc/guix.texi:30097
53716 msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}."
53720 #: guix-git/doc/guix.texi:30100
53722 msgid "{@code{cgit-configuration} parameter} file-object email-filter"
53726 #: guix-git/doc/guix.texi:30104
53727 msgid "Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface."
53731 #: guix-git/doc/guix.texi:30109
53733 msgid "{@code{cgit-configuration} parameter} boolean embedded?"
53737 #: guix-git/doc/guix.texi:30112
53738 msgid "Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment suitable for embedding in other HTML pages."
53742 #: guix-git/doc/guix.texi:30117
53744 msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?"
53748 #: guix-git/doc/guix.texi:30121
53749 msgid "Flag which, when set to @samp{#t}, will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page."
53753 #: guix-git/doc/guix.texi:30126
53755 msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?"
53759 #: guix-git/doc/guix.texi:30129
53760 msgid "Flag which, when set to @samp{#t}, allows all filter settings to be overridden in repository-specific cgitrc files."
53764 #: guix-git/doc/guix.texi:30134
53766 msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?"
53770 #: guix-git/doc/guix.texi:30137
53771 msgid "Flag which, when set to @samp{#t}, allows users to follow a file in the log view."
53775 #: guix-git/doc/guix.texi:30142
53777 msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?"
53781 #: guix-git/doc/guix.texi:30145
53782 msgid "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones."
53786 #: guix-git/doc/guix.texi:30150
53788 msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?"
53792 #: guix-git/doc/guix.texi:30153
53793 msgid "Flag which, when set to @samp{#t}, will make cgit generate extra links \"summary\", \"commit\", \"tree\" for each repo in the repository index."
53797 #: guix-git/doc/guix.texi:30158
53799 msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?"
53803 #: guix-git/doc/guix.texi:30161
53804 msgid "Flag which, when set to @samp{#t}, will make cgit display the owner of each repo in the repository index."
53808 #: guix-git/doc/guix.texi:30166
53810 msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?"
53814 #: guix-git/doc/guix.texi:30169
53815 msgid "Flag which, when set to @samp{#t}, will make cgit print the number of modified files for each commit on the repository log page."
53819 #: guix-git/doc/guix.texi:30174
53821 msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?"
53825 #: guix-git/doc/guix.texi:30177
53826 msgid "Flag which, when set to @samp{#t}, will make cgit print the number of added and removed lines for each commit on the repository log page."
53830 #: guix-git/doc/guix.texi:30182
53832 msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?"
53836 #: guix-git/doc/guix.texi:30185 guix-git/doc/guix.texi:30709
53837 msgid "Flag which, when set to @code{#t}, will make cgit display remote branches in the summary and refs views."
53841 #: guix-git/doc/guix.texi:30190
53843 msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?"
53847 #: guix-git/doc/guix.texi:30194
53848 msgid "Flag which, when set to @code{1}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view."
53852 #: guix-git/doc/guix.texi:30199
53854 msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?"
53858 #: guix-git/doc/guix.texi:30203
53859 msgid "Flag which, when set to @samp{#t}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view."
53863 #: guix-git/doc/guix.texi:30208
53865 msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?"
53869 #: guix-git/doc/guix.texi:30211
53870 msgid "Flag which, when set to @samp{#t}, will make cgit generate linenumber links for plaintext blobs printed in the tree view."
53874 #: guix-git/doc/guix.texi:30216
53876 msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?"
53880 #: guix-git/doc/guix.texi:30219
53881 msgid "Flag which, when set to @samp{#f}, will allow cgit to use Git config to set any repo specific settings."
53885 #: guix-git/doc/guix.texi:30224
53887 msgid "{@code{cgit-configuration} parameter} file-object favicon"
53891 #: guix-git/doc/guix.texi:30226
53892 msgid "URL used as link to a shortcut icon for cgit."
53896 #: guix-git/doc/guix.texi:30228
53897 msgid "Defaults to @samp{\"/favicon.ico\"}."
53901 #: guix-git/doc/guix.texi:30231
53903 msgid "{@code{cgit-configuration} parameter} string footer"
53907 #: guix-git/doc/guix.texi:30235
53908 msgid "The content of the file specified with this option will be included verbatim at the bottom of all pages (i.e.@: it replaces the standard \"generated by...\"@: message)."
53912 #: guix-git/doc/guix.texi:30240
53914 msgid "{@code{cgit-configuration} parameter} string head-include"
53918 #: guix-git/doc/guix.texi:30243
53919 msgid "The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages."
53923 #: guix-git/doc/guix.texi:30248
53925 msgid "{@code{cgit-configuration} parameter} string header"
53929 #: guix-git/doc/guix.texi:30251
53930 msgid "The content of the file specified with this option will be included verbatim at the top of all pages."
53934 #: guix-git/doc/guix.texi:30256
53936 msgid "{@code{cgit-configuration} parameter} file-object include"
53940 #: guix-git/doc/guix.texi:30259
53941 msgid "Name of a configfile to include before the rest of the current config- file is parsed."
53945 #: guix-git/doc/guix.texi:30264
53947 msgid "{@code{cgit-configuration} parameter} string index-header"
53951 #: guix-git/doc/guix.texi:30267
53952 msgid "The content of the file specified with this option will be included verbatim above the repository index."
53956 #: guix-git/doc/guix.texi:30272
53958 msgid "{@code{cgit-configuration} parameter} string index-info"
53962 #: guix-git/doc/guix.texi:30275
53963 msgid "The content of the file specified with this option will be included verbatim below the heading on the repository index page."
53967 #: guix-git/doc/guix.texi:30280
53969 msgid "{@code{cgit-configuration} parameter} boolean local-time?"
53973 #: guix-git/doc/guix.texi:30283
53974 msgid "Flag which, if set to @samp{#t}, makes cgit print commit and tag times in the servers timezone."
53978 #: guix-git/doc/guix.texi:30288
53980 msgid "{@code{cgit-configuration} parameter} file-object logo"
53984 #: guix-git/doc/guix.texi:30291
53985 msgid "URL which specifies the source of an image which will be used as a logo on all cgit pages."
53989 #: guix-git/doc/guix.texi:30293
53990 msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}."
53994 #: guix-git/doc/guix.texi:30296
53996 msgid "{@code{cgit-configuration} parameter} string logo-link"
54000 #: guix-git/doc/guix.texi:30298 guix-git/doc/guix.texi:30755
54001 msgid "URL loaded when clicking on the cgit logo image."
54005 #: guix-git/doc/guix.texi:30303
54007 msgid "{@code{cgit-configuration} parameter} file-object owner-filter"
54011 #: guix-git/doc/guix.texi:30306
54012 msgid "Command which will be invoked to format the Owner column of the main page."
54016 #: guix-git/doc/guix.texi:30311
54018 msgid "{@code{cgit-configuration} parameter} integer max-atom-items"
54022 #: guix-git/doc/guix.texi:30313
54023 msgid "Number of items to display in atom feeds view."
54027 #: guix-git/doc/guix.texi:30318
54029 msgid "{@code{cgit-configuration} parameter} integer max-commit-count"
54033 #: guix-git/doc/guix.texi:30320
54034 msgid "Number of entries to list per page in \"log\" view."
54038 #: guix-git/doc/guix.texi:30325
54040 msgid "{@code{cgit-configuration} parameter} integer max-message-length"
54044 #: guix-git/doc/guix.texi:30327
54045 msgid "Number of commit message characters to display in \"log\" view."
54049 #: guix-git/doc/guix.texi:30329 guix-git/doc/guix.texi:30345
54050 msgid "Defaults to @samp{80}."
54054 #: guix-git/doc/guix.texi:30332
54056 msgid "{@code{cgit-configuration} parameter} integer max-repo-count"
54060 #: guix-git/doc/guix.texi:30335
54061 msgid "Specifies the number of entries to list per page on the repository index page."
54065 #: guix-git/doc/guix.texi:30340
54067 msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length"
54071 #: guix-git/doc/guix.texi:30343
54072 msgid "Specifies the maximum number of repo description characters to display on the repository index page."
54076 #: guix-git/doc/guix.texi:30348
54078 msgid "{@code{cgit-configuration} parameter} integer max-blob-size"
54082 #: guix-git/doc/guix.texi:30350
54083 msgid "Specifies the maximum size of a blob to display HTML for in KBytes."
54087 #: guix-git/doc/guix.texi:30355
54089 msgid "{@code{cgit-configuration} parameter} string max-stats"
54093 #: guix-git/doc/guix.texi:30358
54094 msgid "Maximum statistics period. Valid values are @samp{week},@samp{month}, @samp{quarter} and @samp{year}."
54098 #: guix-git/doc/guix.texi:30363
54100 msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype"
54104 #: guix-git/doc/guix.texi:30365
54105 msgid "Mimetype for the specified filename extension."
54109 #: guix-git/doc/guix.texi:30369
54110 msgid "Defaults to @samp{((gif \"image/gif\") (html \"text/html\") (jpg \"image/jpeg\") (jpeg \"image/jpeg\") (pdf \"application/pdf\") (png \"image/png\") (svg \"image/svg+xml\"))}."
54114 #: guix-git/doc/guix.texi:30372
54116 msgid "{@code{cgit-configuration} parameter} file-object mimetype-file"
54120 #: guix-git/doc/guix.texi:30374
54121 msgid "Specifies the file to use for automatic mimetype lookup."
54125 #: guix-git/doc/guix.texi:30379
54127 msgid "{@code{cgit-configuration} parameter} string module-link"
54131 #: guix-git/doc/guix.texi:30382
54132 msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing."
54136 #: guix-git/doc/guix.texi:30387
54138 msgid "{@code{cgit-configuration} parameter} boolean nocache?"
54142 #: guix-git/doc/guix.texi:30389
54143 msgid "If set to the value @samp{#t} caching will be disabled."
54147 #: guix-git/doc/guix.texi:30394
54149 msgid "{@code{cgit-configuration} parameter} boolean noplainemail?"
54153 #: guix-git/doc/guix.texi:30397
54154 msgid "If set to @samp{#t} showing full author email addresses will be disabled."
54158 #: guix-git/doc/guix.texi:30402
54160 msgid "{@code{cgit-configuration} parameter} boolean noheader?"
54164 #: guix-git/doc/guix.texi:30405
54165 msgid "Flag which, when set to @samp{#t}, will make cgit omit the standard header on all pages."
54169 #: guix-git/doc/guix.texi:30410
54171 msgid "{@code{cgit-configuration} parameter} project-list project-list"
54175 #: guix-git/doc/guix.texi:30414
54176 msgid "A list of subdirectories inside of @code{repository-directory}, relative to it, that should loaded as Git repositories. An empty list means that all subdirectories will be loaded."
54180 #: guix-git/doc/guix.texi:30419
54182 msgid "{@code{cgit-configuration} parameter} file-object readme"
54186 #: guix-git/doc/guix.texi:30421
54187 msgid "Text which will be used as default value for @code{cgit-repo-readme}."
54191 #: guix-git/doc/guix.texi:30426
54193 msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?"
54197 #: guix-git/doc/guix.texi:30430
54198 msgid "If set to @code{#t} and @code{repository-directory} is enabled, if any repositories are found with a suffix of @code{.git}, this suffix will be removed for the URL and name."
54202 #: guix-git/doc/guix.texi:30435
54204 msgid "{@code{cgit-configuration} parameter} integer renamelimit"
54208 #: guix-git/doc/guix.texi:30437
54209 msgid "Maximum number of files to consider when detecting renames."
54213 #: guix-git/doc/guix.texi:30442
54215 msgid "{@code{cgit-configuration} parameter} string repository-sort"
54219 #: guix-git/doc/guix.texi:30444
54220 msgid "The way in which repositories in each section are sorted."
54224 #: guix-git/doc/guix.texi:30449
54226 msgid "{@code{cgit-configuration} parameter} robots-list robots"
54230 #: guix-git/doc/guix.texi:30451
54231 msgid "Text used as content for the @code{robots} meta-tag."
54235 #: guix-git/doc/guix.texi:30453
54236 msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}."
54240 #: guix-git/doc/guix.texi:30456
54242 msgid "{@code{cgit-configuration} parameter} string root-desc"
54246 #: guix-git/doc/guix.texi:30458
54247 msgid "Text printed below the heading on the repository index page."
54251 #: guix-git/doc/guix.texi:30460
54252 msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}."
54256 #: guix-git/doc/guix.texi:30463
54258 msgid "{@code{cgit-configuration} parameter} string root-readme"
54262 #: guix-git/doc/guix.texi:30466
54263 msgid "The content of the file specified with this option will be included verbatim below the ``about'' link on the repository index page."
54267 #: guix-git/doc/guix.texi:30471
54269 msgid "{@code{cgit-configuration} parameter} string root-title"
54273 #: guix-git/doc/guix.texi:30473
54274 msgid "Text printed as heading on the repository index page."
54278 #: guix-git/doc/guix.texi:30478
54280 msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path"
54284 #: guix-git/doc/guix.texi:30484
54285 msgid "If set to @samp{#t} and repository-directory is enabled, repository-directory will recurse into directories whose name starts with a period. Otherwise, repository-directory will stay away from such directories, considered as ``hidden''. Note that this does not apply to the @file{.git} directory in non-bare repos."
54289 #: guix-git/doc/guix.texi:30489
54291 msgid "{@code{cgit-configuration} parameter} list snapshots"
54295 #: guix-git/doc/guix.texi:30492
54296 msgid "Text which specifies the default set of snapshot formats that cgit generates links for."
54300 #: guix-git/doc/guix.texi:30497
54302 msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory"
54306 #: guix-git/doc/guix.texi:30500
54307 msgid "Name of the directory to scan for repositories (represents @code{scan-path})."
54311 #: guix-git/doc/guix.texi:30502
54312 msgid "Defaults to @samp{\"/srv/git\"}."
54316 #: guix-git/doc/guix.texi:30505
54318 msgid "{@code{cgit-configuration} parameter} string section"
54322 #: guix-git/doc/guix.texi:30508 guix-git/doc/guix.texi:30824
54323 msgid "The name of the current repository section - all repositories defined after this option will inherit the current section name."
54327 #: guix-git/doc/guix.texi:30513
54329 msgid "{@code{cgit-configuration} parameter} string section-sort"
54333 #: guix-git/doc/guix.texi:30516
54334 msgid "Flag which, when set to @samp{1}, will sort the sections on the repository listing by name."
54338 #: guix-git/doc/guix.texi:30521
54340 msgid "{@code{cgit-configuration} parameter} integer section-from-path"
54344 #: guix-git/doc/guix.texi:30524
54345 msgid "A number which, if defined prior to repository-directory, specifies how many path elements from each repo path to use as a default section name."
54349 #: guix-git/doc/guix.texi:30529
54351 msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?"
54355 #: guix-git/doc/guix.texi:30532
54356 msgid "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default."
54360 #: guix-git/doc/guix.texi:30537
54362 msgid "{@code{cgit-configuration} parameter} file-object source-filter"
54366 #: guix-git/doc/guix.texi:30540
54367 msgid "Specifies a command which will be invoked to format plaintext blobs in the tree view."
54371 #: guix-git/doc/guix.texi:30545
54373 msgid "{@code{cgit-configuration} parameter} integer summary-branches"
54377 #: guix-git/doc/guix.texi:30548
54378 msgid "Specifies the number of branches to display in the repository ``summary'' view."
54382 #: guix-git/doc/guix.texi:30553
54384 msgid "{@code{cgit-configuration} parameter} integer summary-log"
54388 #: guix-git/doc/guix.texi:30556
54389 msgid "Specifies the number of log entries to display in the repository ``summary'' view."
54393 #: guix-git/doc/guix.texi:30561
54395 msgid "{@code{cgit-configuration} parameter} integer summary-tags"
54399 #: guix-git/doc/guix.texi:30564
54400 msgid "Specifies the number of tags to display in the repository ``summary'' view."
54404 #: guix-git/doc/guix.texi:30569
54406 msgid "{@code{cgit-configuration} parameter} string strict-export"
54410 #: guix-git/doc/guix.texi:30572
54411 msgid "Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository."
54415 #: guix-git/doc/guix.texi:30577
54417 msgid "{@code{cgit-configuration} parameter} string virtual-root"
54421 #: guix-git/doc/guix.texi:30579
54422 msgid "URL which, if specified, will be used as root for all cgit links."
54426 #: guix-git/doc/guix.texi:30581
54427 msgid "Defaults to @samp{\"/\"}."
54431 #: guix-git/doc/guix.texi:30584
54433 msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories"
54437 #: guix-git/doc/guix.texi:30586
54438 msgid "A list of @dfn{cgit-repo} records to use with config."
54442 #: guix-git/doc/guix.texi:30590
54443 msgid "Available @code{repository-cgit-configuration} fields are:"
54447 #: guix-git/doc/guix.texi:30591
54449 msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots"
54453 #: guix-git/doc/guix.texi:30594
54454 msgid "A mask of snapshot formats for this repo that cgit generates links for, restricted by the global @code{snapshots} setting."
54458 #: guix-git/doc/guix.texi:30599
54460 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter"
54464 #: guix-git/doc/guix.texi:30601
54465 msgid "Override the default @code{source-filter}."
54469 #: guix-git/doc/guix.texi:30606
54471 msgid "{@code{repository-cgit-configuration} parameter} repo-string url"
54475 #: guix-git/doc/guix.texi:30608
54476 msgid "The relative URL used to access the repository."
54480 #: guix-git/doc/guix.texi:30613
54482 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter"
54486 #: guix-git/doc/guix.texi:30615
54487 msgid "Override the default @code{about-filter}."
54491 #: guix-git/doc/guix.texi:30620
54493 msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort"
54497 #: guix-git/doc/guix.texi:30623
54498 msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set to @samp{name} enables ordering by branch name."
54502 #: guix-git/doc/guix.texi:30628
54504 msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url"
54508 #: guix-git/doc/guix.texi:30630
54509 msgid "A list of URLs which can be used to clone repo."
54513 #: guix-git/doc/guix.texi:30635
54515 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter"
54519 #: guix-git/doc/guix.texi:30637
54520 msgid "Override the default @code{commit-filter}."
54524 #: guix-git/doc/guix.texi:30642
54526 msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort"
54530 #: guix-git/doc/guix.texi:30651
54532 msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch"
54536 #: guix-git/doc/guix.texi:30656
54537 msgid "The name of the default branch for this repository. If no such branch exists in the repository, the first branch name (when sorted) is used as default instead. By default branch pointed to by HEAD, or ``master'' if there is no suitable HEAD."
54541 #: guix-git/doc/guix.texi:30661
54543 msgid "{@code{repository-cgit-configuration} parameter} repo-string desc"
54547 #: guix-git/doc/guix.texi:30663
54548 msgid "The value to show as repository description."
54552 #: guix-git/doc/guix.texi:30668
54554 msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage"
54558 #: guix-git/doc/guix.texi:30670
54559 msgid "The value to show as repository homepage."
54563 #: guix-git/doc/guix.texi:30675
54565 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter"
54569 #: guix-git/doc/guix.texi:30677
54570 msgid "Override the default @code{email-filter}."
54574 #: guix-git/doc/guix.texi:30682
54576 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph?"
54580 #: guix-git/doc/guix.texi:30685
54581 msgid "A flag which can be used to disable the global setting @code{enable-commit-graph?}."
54585 #: guix-git/doc/guix.texi:30690
54587 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount?"
54591 #: guix-git/doc/guix.texi:30693
54592 msgid "A flag which can be used to disable the global setting @code{enable-log-filecount?}."
54596 #: guix-git/doc/guix.texi:30698
54598 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount?"
54602 #: guix-git/doc/guix.texi:30701
54603 msgid "A flag which can be used to disable the global setting @code{enable-log-linecount?}."
54607 #: guix-git/doc/guix.texi:30706
54609 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches?"
54613 #: guix-git/doc/guix.texi:30714
54615 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links?"
54619 #: guix-git/doc/guix.texi:30717
54620 msgid "A flag which can be used to override the global setting @code{enable-subject-links?}."
54624 #: guix-git/doc/guix.texi:30722
54626 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving?"
54630 #: guix-git/doc/guix.texi:30725
54631 msgid "A flag which can be used to override the global setting @code{enable-html-serving?}."
54635 #: guix-git/doc/guix.texi:30730
54637 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?"
54641 #: guix-git/doc/guix.texi:30733
54642 msgid "Flag which, when set to @code{#t}, hides the repository from the repository index."
54646 #: guix-git/doc/guix.texi:30738
54648 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?"
54652 #: guix-git/doc/guix.texi:30740
54653 msgid "Flag which, when set to @samp{#t}, ignores the repository."
54657 #: guix-git/doc/guix.texi:30745
54659 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo"
54663 #: guix-git/doc/guix.texi:30748
54664 msgid "URL which specifies the source of an image which will be used as a logo on this repo’s pages."
54668 #: guix-git/doc/guix.texi:30753
54670 msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link"
54674 #: guix-git/doc/guix.texi:30760
54676 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter"
54680 #: guix-git/doc/guix.texi:30762
54681 msgid "Override the default @code{owner-filter}."
54685 #: guix-git/doc/guix.texi:30767
54687 msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link"
54691 #: guix-git/doc/guix.texi:30771
54692 msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing. The arguments for the formatstring are the path and SHA1 of the submodule commit."
54696 #: guix-git/doc/guix.texi:30776
54698 msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path"
54702 #: guix-git/doc/guix.texi:30780
54703 msgid "Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory listing."
54707 #: guix-git/doc/guix.texi:30785
54709 msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats"
54713 #: guix-git/doc/guix.texi:30787
54714 msgid "Override the default maximum statistics period."
54718 #: guix-git/doc/guix.texi:30792
54720 msgid "{@code{repository-cgit-configuration} parameter} repo-string name"
54724 #: guix-git/doc/guix.texi:30794
54725 msgid "The value to show as repository name."
54729 #: guix-git/doc/guix.texi:30799
54731 msgid "{@code{repository-cgit-configuration} parameter} repo-string owner"
54735 #: guix-git/doc/guix.texi:30801
54736 msgid "A value used to identify the owner of the repository."
54740 #: guix-git/doc/guix.texi:30806
54742 msgid "{@code{repository-cgit-configuration} parameter} repo-string path"
54746 #: guix-git/doc/guix.texi:30808
54747 msgid "An absolute path to the repository directory."
54751 #: guix-git/doc/guix.texi:30813
54753 msgid "{@code{repository-cgit-configuration} parameter} repo-string readme"
54757 #: guix-git/doc/guix.texi:30816
54758 msgid "A path (relative to repo) which specifies a file to include verbatim as the ``About'' page for this repo."
54762 #: guix-git/doc/guix.texi:30821
54764 msgid "{@code{repository-cgit-configuration} parameter} repo-string section"
54768 #: guix-git/doc/guix.texi:30829
54770 msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options"
54774 #: guix-git/doc/guix.texi:30831 guix-git/doc/guix.texi:30840
54775 msgid "Extra options will be appended to cgitrc file."
54779 #: guix-git/doc/guix.texi:30838
54781 msgid "{@code{cgit-configuration} parameter} list extra-options"
54784 #. type: Plain text
54785 #: guix-git/doc/guix.texi:30852
54786 msgid "However, it could be that you just want to get a @code{cgitrc} up and running. In that case, you can pass an @code{opaque-cgit-configuration} as a record to @code{cgit-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities."
54789 #. type: Plain text
54790 #: guix-git/doc/guix.texi:30854
54791 msgid "Available @code{opaque-cgit-configuration} fields are:"
54795 #: guix-git/doc/guix.texi:30855
54797 msgid "{@code{opaque-cgit-configuration} parameter} package cgit"
54801 #: guix-git/doc/guix.texi:30857
54802 msgid "The cgit package."
54806 #: guix-git/doc/guix.texi:30859
54808 msgid "{@code{opaque-cgit-configuration} parameter} string string"
54812 #: guix-git/doc/guix.texi:30861
54813 msgid "The contents of the @code{cgitrc}, as a string."
54816 #. type: Plain text
54817 #: guix-git/doc/guix.texi:30865
54818 msgid "For example, if your @code{cgitrc} is just the empty string, you could instantiate a cgit service like this:"
54822 #: guix-git/doc/guix.texi:30870
54825 "(service cgit-service-type\n"
54826 " (opaque-cgit-configuration\n"
54827 " (cgitrc \"\")))\n"
54830 #. type: subsubheading
54831 #: guix-git/doc/guix.texi:30872
54833 msgid "Gitolite Service"
54837 #: guix-git/doc/guix.texi:30874
54839 msgid "Gitolite service"
54843 #: guix-git/doc/guix.texi:30875
54845 msgid "Git, hosting"
54848 #. type: Plain text
54849 #: guix-git/doc/guix.texi:30878
54850 msgid "@uref{https://gitolite.com/gitolite/, Gitolite} is a tool for hosting Git repositories on a central server."
54853 #. type: Plain text
54854 #: guix-git/doc/guix.texi:30881
54855 msgid "Gitolite can handle multiple repositories and users, and supports flexible configuration of the permissions for the users on the repositories."
54858 #. type: Plain text
54859 #: guix-git/doc/guix.texi:30884
54860 msgid "The following example will configure Gitolite using the default @code{git} user, and the provided SSH public key."
54864 #: guix-git/doc/guix.texi:30891
54867 "(service gitolite-service-type\n"
54868 " (gitolite-configuration\n"
54869 " (admin-pubkey (plain-file\n"
54870 " \"yourname.pub\"\n"
54871 " \"ssh-rsa AAAA... guix@@example.com\"))))\n"
54874 #. type: Plain text
54875 #: guix-git/doc/guix.texi:30896
54876 msgid "Gitolite is configured through a special admin repository which you can clone, for example, if you setup Gitolite on @code{example.com}, you would run the following command to clone the admin repository."
54880 #: guix-git/doc/guix.texi:30899
54882 msgid "git clone git@@example.com:gitolite-admin\n"
54885 #. type: Plain text
54886 #: guix-git/doc/guix.texi:30905
54887 msgid "When the Gitolite service is activated, the provided @code{admin-pubkey} will be inserted in to the @file{keydir} directory in the gitolite-admin repository. If this results in a change in the repository, it will be committed using the message ``gitolite setup by GNU Guix''."
54891 #: guix-git/doc/guix.texi:30906
54893 msgid "{Data Type} gitolite-configuration"
54897 #: guix-git/doc/guix.texi:30908
54898 msgid "Data type representing the configuration for @code{gitolite-service-type}."
54902 #: guix-git/doc/guix.texi:30910
54904 msgid "@code{package} (default: @var{gitolite})"
54908 #: guix-git/doc/guix.texi:30912
54909 msgid "Gitolite package to use."
54913 #: guix-git/doc/guix.texi:30913
54915 msgid "@code{user} (default: @var{git})"
54919 #: guix-git/doc/guix.texi:30916
54920 msgid "User to use for Gitolite. This will be user that you use when accessing Gitolite over SSH."
54924 #: guix-git/doc/guix.texi:30917
54926 msgid "@code{group} (default: @var{git})"
54930 #: guix-git/doc/guix.texi:30919
54931 msgid "Group to use for Gitolite."
54935 #: guix-git/doc/guix.texi:30920
54937 msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})"
54941 #: guix-git/doc/guix.texi:30922
54942 msgid "Directory in which to store the Gitolite configuration and repositories."
54946 #: guix-git/doc/guix.texi:30923
54948 msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})"
54952 #: guix-git/doc/guix.texi:30926
54953 msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}), representing the configuration for Gitolite."
54957 #: guix-git/doc/guix.texi:30927
54959 msgid "@code{admin-pubkey} (default: @var{#f})"
54963 #: guix-git/doc/guix.texi:30931
54964 msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}) used to setup Gitolite. This will be inserted in to the @file{keydir} directory within the gitolite-admin repository."
54968 #: guix-git/doc/guix.texi:30933
54969 msgid "To specify the SSH key as a string, use the @code{plain-file} function."
54973 #: guix-git/doc/guix.texi:30936
54975 msgid "(plain-file \"yourname.pub\" \"ssh-rsa AAAA... guix@@example.com\")\n"
54979 #: guix-git/doc/guix.texi:30941
54981 msgid "{Data Type} gitolite-rc-file"
54985 #: guix-git/doc/guix.texi:30943
54986 msgid "Data type representing the Gitolite RC file."
54990 #: guix-git/doc/guix.texi:30945
54992 msgid "@code{umask} (default: @code{#o0077})"
54996 #: guix-git/doc/guix.texi:30948
54997 msgid "This controls the permissions Gitolite sets on the repositories and their contents."
55001 #: guix-git/doc/guix.texi:30952
55002 msgid "A value like @code{#o0027} will give read access to the group used by Gitolite (by default: @code{git}). This is necessary when using Gitolite with software like cgit or gitweb."
55006 #: guix-git/doc/guix.texi:30953
55008 msgid "@code{git-config-keys} (default: @code{\"\"})"
55012 #: guix-git/doc/guix.texi:30956
55013 msgid "Gitolite allows you to set git config values using the @samp{config} keyword. This setting allows control over the config keys to accept."
55017 #: guix-git/doc/guix.texi:30957
55019 msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})"
55023 #: guix-git/doc/guix.texi:30959
55024 msgid "Set the role names allowed to be used by users running the perms command."
55028 #: guix-git/doc/guix.texi:30960
55030 msgid "@code{enable} (default: @code{'(\"help\" \"desc\" \"info\" \"perms\" \"writable\" \"ssh-authkeys\" \"git-config\" \"daemon\" \"gitweb\")})"
55034 #: guix-git/doc/guix.texi:30962
55035 msgid "This setting controls the commands and features to enable within Gitolite."
55038 #. type: subsubheading
55039 #: guix-git/doc/guix.texi:30970
55041 msgid "The Battle for Wesnoth Service"
55045 #: guix-git/doc/guix.texi:30971
55050 #. type: Plain text
55051 #: guix-git/doc/guix.texi:30975
55052 msgid "@uref{https://wesnoth.org, The Battle for Wesnoth} is a fantasy, turn based tactical strategy game, with several single player campaigns, and multiplayer games (both networked and local)."
55056 #: guix-git/doc/guix.texi:30976
55058 msgid "{Scheme Variable} wesnothd-service-type"
55062 #: guix-git/doc/guix.texi:30980
55063 msgid "Service type for the wesnothd service. Its value must be a @code{wesnothd-configuration} object. To run wesnothd in the default configuration, instantiate it as:"
55067 #: guix-git/doc/guix.texi:30983
55069 msgid "(service wesnothd-service-type)\n"
55073 #: guix-git/doc/guix.texi:30986
55075 msgid "{Data Type} wesnothd-configuration"
55079 #: guix-git/doc/guix.texi:30988
55080 msgid "Data type representing the configuration of @command{wesnothd}."
55084 #: guix-git/doc/guix.texi:30990
55086 msgid "@code{package} (default: @code{wesnoth-server})"
55090 #: guix-git/doc/guix.texi:30992
55091 msgid "The wesnoth server package to use."
55095 #: guix-git/doc/guix.texi:30993
55097 msgid "@code{port} (default: @code{15000})"
55101 #: guix-git/doc/guix.texi:30995
55102 msgid "The port to bind the server to."
55106 #: guix-git/doc/guix.texi:31001
55111 #. type: Plain text
55112 #: guix-git/doc/guix.texi:31006
55113 msgid "The @code{(gnu services pam-mount)} module provides a service allowing users to mount volumes when they log in. It should be able to mount any volume format supported by the system."
55117 #: guix-git/doc/guix.texi:31007
55119 msgid "{Scheme Variable} pam-mount-service-type"
55123 #: guix-git/doc/guix.texi:31009
55124 msgid "Service type for PAM Mount support."
55128 #: guix-git/doc/guix.texi:31011
55130 msgid "{Data Type} pam-mount-configuration"
55134 #: guix-git/doc/guix.texi:31013
55135 msgid "Data type representing the configuration of PAM Mount."
55139 #: guix-git/doc/guix.texi:31017
55145 #: guix-git/doc/guix.texi:31020
55146 msgid "The configuration rules that will be used to generate @file{/etc/security/pam_mount.conf.xml}."
55150 #: guix-git/doc/guix.texi:31024
55151 msgid "The configuration rules are SXML elements (@pxref{SXML,,, guile, GNU Guile Reference Manual}), and the default ones don't mount anything for anyone at login:"
55155 #: guix-git/doc/guix.texi:31039
55158 "`((debug (@@ (enable \"0\")))\n"
55159 " (mntoptions (@@ (allow ,(string-join\n"
55160 " '(\"nosuid\" \"nodev\" \"loop\"\n"
55161 " \"encryption\" \"fsck\" \"nonempty\"\n"
55162 " \"allow_root\" \"allow_other\")\n"
55164 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55165 " (logout (@@ (wait \"0\")\n"
55168 " (kill \"no\")))\n"
55169 " (mkmountpoint (@@ (enable \"1\")\n"
55170 " (remove \"true\"))))\n"
55174 #: guix-git/doc/guix.texi:31045
55175 msgid "Some @code{volume} elements must be added to automatically mount volumes at login. Here's an example allowing the user @code{alice} to mount her encrypted @env{HOME} directory and allowing the user @code{bob} to mount the partition where he stores his data:"
55179 #: guix-git/doc/guix.texi:31070
55182 "(define pam-mount-rules\n"
55183 "`((debug (@@ (enable \"0\")))\n"
55184 " (volume (@@ (user \"alice\")\n"
55185 " (fstype \"crypt\")\n"
55186 " (path \"/dev/sda2\")\n"
55187 " (mountpoint \"/home/alice\")))\n"
55188 " (volume (@@ (user \"bob\")\n"
55189 " (fstype \"auto\")\n"
55190 " (path \"/dev/sdb3\")\n"
55191 " (mountpoint \"/home/bob/data\")\n"
55192 " (options \"defaults,autodefrag,compress\")))\n"
55193 " (mntoptions (@@ (allow ,(string-join\n"
55194 " '(\"nosuid\" \"nodev\" \"loop\"\n"
55195 " \"encryption\" \"fsck\" \"nonempty\"\n"
55196 " \"allow_root\" \"allow_other\")\n"
55198 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55199 " (logout (@@ (wait \"0\")\n"
55202 " (kill \"no\")))\n"
55203 " (mkmountpoint (@@ (enable \"1\")\n"
55204 " (remove \"true\")))))\n"
55209 #: guix-git/doc/guix.texi:31074
55212 "(service pam-mount-service-type\n"
55213 " (pam-mount-configuration\n"
55214 " (rules pam-mount-rules)))\n"
55218 #: guix-git/doc/guix.texi:31078
55219 msgid "The complete list of possible options can be found in the man page for @uref{http://pam-mount.sourceforge.net/pam_mount.conf.5.html, pam_mount.conf}."
55222 #. type: subsubheading
55223 #: guix-git/doc/guix.texi:31085
55225 msgid "Guix Build Coordinator"
55228 #. type: Plain text
55229 #: guix-git/doc/guix.texi:31091
55230 msgid "The @uref{https://git.cbaines.net/guix/build-coordinator/,Guix Build Coordinator} aids in distributing derivation builds among machines running an @dfn{agent}. The build daemon is still used to build the derivations, but the Guix Build Coordinator manages allocating builds and working with the results."
55234 #: guix-git/doc/guix.texi:31096
55235 msgid "This service is considered experimental. Configuration options may be changed in a backwards-incompatible manner, and not all features have been thorougly tested."
55238 #. type: Plain text
55239 #: guix-git/doc/guix.texi:31103
55240 msgid "The Guix Build Coordinator consists of one @dfn{coordinator}, and one or more connected @dfn{agent} processes. The coordinator process handles clients submitting builds, and allocating builds to agents. The agent processes talk to a build daemon to actually perform the builds, then send the results back to the coordinator."
55243 #. type: Plain text
55244 #: guix-git/doc/guix.texi:31107
55245 msgid "There is a script to run the coordinator component of the Guix Build Coordinator, but the Guix service uses a custom Guile script instead, to provide better integration with G-expressions used in the configuration."
55249 #: guix-git/doc/guix.texi:31108
55251 msgid "{Scheme Variable} guix-build-coordinator-service-type"
55255 #: guix-git/doc/guix.texi:31111
55256 msgid "Service type for the Guix Build Coordinator. Its value must be a @code{guix-build-coordinator-configuration} object."
55260 #: guix-git/doc/guix.texi:31113
55262 msgid "{Data Type} guix-build-coordinator-configuration"
55266 #: guix-git/doc/guix.texi:31115
55267 msgid "Data type representing the configuration of the Guix Build Coordinator."
55271 #: guix-git/doc/guix.texi:31117 guix-git/doc/guix.texi:31161
55272 #: guix-git/doc/guix.texi:31278
55274 msgid "@code{package} (default: @code{guix-build-coordinator})"
55278 #: guix-git/doc/guix.texi:31119 guix-git/doc/guix.texi:31163
55279 #: guix-git/doc/guix.texi:31280
55280 msgid "The Guix Build Coordinator package to use."
55284 #: guix-git/doc/guix.texi:31120
55286 msgid "@code{user} (default: @code{\"guix-build-coordinator\"})"
55290 #: guix-git/doc/guix.texi:31122 guix-git/doc/guix.texi:31166
55291 #: guix-git/doc/guix.texi:31283 guix-git/doc/guix.texi:31329
55292 msgid "The system user to run the service as."
55296 #: guix-git/doc/guix.texi:31123
55298 msgid "@code{group} (default: @code{\"guix-build-coordinator\"})"
55302 #: guix-git/doc/guix.texi:31125 guix-git/doc/guix.texi:31332
55303 msgid "The system group to run the service as."
55307 #: guix-git/doc/guix.texi:31126
55309 msgid "@code{database-uri-string} (default: @code{\"sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db\"})"
55313 #: guix-git/doc/guix.texi:31128
55314 msgid "The URI to use for the database."
55318 #: guix-git/doc/guix.texi:31129
55320 msgid "@code{agent-communication-uri} (default: @code{\"http://0.0.0.0:8745\"})"
55324 #: guix-git/doc/guix.texi:31131
55325 msgid "The URI describing how to listen to requests from agent processes."
55329 #: guix-git/doc/guix.texi:31132
55331 msgid "@code{client-communication-uri} (default: @code{\"http://127.0.0.1:8746\"})"
55335 #: guix-git/doc/guix.texi:31136
55336 msgid "The URI describing how to listen to requests from clients. The client API allows submitting builds and currently isn't authenticated, so take care when configuring this value."
55340 #: guix-git/doc/guix.texi:31137
55342 msgid "@code{allocation-strategy} (default: @code{#~basic-build-allocation-strategy})"
55346 #: guix-git/doc/guix.texi:31141
55347 msgid "A G-expression for the allocation strategy to be used. This is a procedure that takes the datastore as an argument and populates the allocation plan in the database."
55351 #: guix-git/doc/guix.texi:31142
55353 msgid "@code{hooks} (default: @var{'()})"
55357 #: guix-git/doc/guix.texi:31145
55358 msgid "An association list of hooks. These provide a way to execute arbitrary code upon certain events, like a build result being processed."
55362 #: guix-git/doc/guix.texi:31146
55364 msgid "@code{guile} (default: @code{guile-3.0-latest})"
55368 #: guix-git/doc/guix.texi:31148
55369 msgid "The Guile package with which to run the Guix Build Coordinator."
55373 #: guix-git/doc/guix.texi:31152
55375 msgid "{Scheme Variable} guix-build-coordinator-agent-service-type"
55379 #: guix-git/doc/guix.texi:31155
55380 msgid "Service type for a Guix Build Coordinator agent. Its value must be a @code{guix-build-coordinator-agent-configuration} object."
55384 #: guix-git/doc/guix.texi:31157
55386 msgid "{Data Type} guix-build-coordinator-agent-configuration"
55390 #: guix-git/doc/guix.texi:31159
55391 msgid "Data type representing the configuration a Guix Build Coordinator agent."
55395 #: guix-git/doc/guix.texi:31164
55397 msgid "@code{user} (default: @code{\"guix-build-coordinator-agent\"})"
55401 #: guix-git/doc/guix.texi:31167 guix-git/doc/guix.texi:31284
55403 msgid "@code{coordinator} (default: @code{\"http://localhost:8745\"})"
55407 #: guix-git/doc/guix.texi:31169 guix-git/doc/guix.texi:31286
55408 msgid "The URI to use when connecting to the coordinator."
55412 #: guix-git/doc/guix.texi:31170
55414 msgid "authentication"
55418 #: guix-git/doc/guix.texi:31173
55419 msgid "Record describing how this agent should authenticate with the coordinator. Possible record types are described below."
55423 #: guix-git/doc/guix.texi:31174 guix-git/doc/guix.texi:31287
55425 msgid "@code{systems} (default: @code{#f})"
55429 #: guix-git/doc/guix.texi:31177
55430 msgid "The systems for which this agent should fetch builds. The agent process will use the current system it's running on as the default."
55434 #: guix-git/doc/guix.texi:31178
55436 msgid "@code{max-parallel-builds} (default: @code{1})"
55440 #: guix-git/doc/guix.texi:31180
55441 msgid "The number of builds to perform in parallel."
55445 #: guix-git/doc/guix.texi:31181
55447 msgid "@code{derivation-substitute-urls} (default: @code{#f})"
55451 #: guix-git/doc/guix.texi:31184
55452 msgid "URLs from which to attempt to fetch substitutes for derivations, if the derivations aren't already available."
55456 #: guix-git/doc/guix.texi:31185
55458 msgid "@code{non-derivation-substitute-urls} (default: @code{#f})"
55462 #: guix-git/doc/guix.texi:31188
55463 msgid "URLs from which to attempt to fetch substitutes for build inputs, if the input store items aren't already available."
55467 #: guix-git/doc/guix.texi:31192
55469 msgid "{Data Type} guix-build-coordinator-agent-password-auth"
55473 #: guix-git/doc/guix.texi:31195
55474 msgid "Data type representing an agent authenticating with a coordinator via a UUID and password."
55478 #: guix-git/doc/guix.texi:31201 guix-git/doc/guix.texi:31217
55479 msgid "The UUID of the agent. This should be generated by the coordinator process, stored in the coordinator database, and used by the intended agent."
55483 #: guix-git/doc/guix.texi:31204
55484 msgid "The password to use when connecting to the coordinator."
55488 #: guix-git/doc/guix.texi:31208
55490 msgid "{Data Type} guix-build-coordinator-agent-password-file-auth"
55494 #: guix-git/doc/guix.texi:31211
55495 msgid "Data type representing an agent authenticating with a coordinator via a UUID and password read from a file."
55499 #: guix-git/doc/guix.texi:31218
55501 msgid "password-file"
55505 #: guix-git/doc/guix.texi:31221
55506 msgid "A file containing the password to use when connecting to the coordinator."
55510 #: guix-git/doc/guix.texi:31225
55512 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth"
55516 #: guix-git/doc/guix.texi:31228
55517 msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token and agent name."
55521 #: guix-git/doc/guix.texi:31230 guix-git/doc/guix.texi:31247
55527 #: guix-git/doc/guix.texi:31234 guix-git/doc/guix.texi:31251
55528 msgid "Name of an agent, this is used to match up to an existing entry in the database if there is one. When no existing entry is found, a new entry is automatically added."
55532 #: guix-git/doc/guix.texi:31235
55538 #: guix-git/doc/guix.texi:31238
55539 msgid "Dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
55543 #: guix-git/doc/guix.texi:31242
55545 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth-with-file"
55549 #: guix-git/doc/guix.texi:31245
55550 msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token read from a file and agent name."
55554 #: guix-git/doc/guix.texi:31252
55560 #: guix-git/doc/guix.texi:31255
55561 msgid "File containing the dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
55564 #. type: Plain text
55565 #: guix-git/doc/guix.texi:31265
55566 msgid "The Guix Build Coordinator package contains a script to query an instance of the Guix Data Service for derivations to build, and then submit builds for those derivations to the coordinator. The service type below assists in running this script. This is an additional tool that may be useful when building derivations contained within an instance of the Guix Data Service."
55570 #: guix-git/doc/guix.texi:31266
55572 msgid "{Scheme Variable} guix-build-coordinator-queue-builds-service-type"
55576 #: guix-git/doc/guix.texi:31271
55577 msgid "Service type for the guix-build-coordinator-queue-builds-from-guix-data-service script. Its value must be a @code{guix-build-coordinator-queue-builds-configuration} object."
55581 #: guix-git/doc/guix.texi:31273
55583 msgid "{Data Type} guix-build-coordinator-queue-builds-configuration"
55587 #: guix-git/doc/guix.texi:31276
55588 msgid "Data type representing the options to the queue builds from guix data service script."
55592 #: guix-git/doc/guix.texi:31281
55594 msgid "@code{user} (default: @code{\"guix-build-coordinator-queue-builds\"})"
55598 #: guix-git/doc/guix.texi:31289
55599 msgid "The systems for which to fetch derivations to build."
55603 #: guix-git/doc/guix.texi:31290
55605 msgid "@code{systems-and-targets} (default: @code{#f})"
55609 #: guix-git/doc/guix.texi:31293
55610 msgid "An association list of system and target pairs for which to fetch derivations to build."
55614 #: guix-git/doc/guix.texi:31294
55616 msgid "@code{guix-data-service} (default: @code{\"https://data.guix.gnu.org\"})"
55620 #: guix-git/doc/guix.texi:31297
55621 msgid "The Guix Data Service instance from which to query to find out about derivations to build."
55625 #: guix-git/doc/guix.texi:31298
55627 msgid "@code{processed-commits-file} (default: @code{\"/var/cache/guix-build-coordinator-queue-builds/processed-commits\"})"
55631 #: guix-git/doc/guix.texi:31301
55632 msgid "A file to record which commits have been processed, to avoid needlessly processing them again if the service is restarted."
55635 #. type: subsubheading
55636 #: guix-git/doc/guix.texi:31305
55638 msgid "Guix Data Service"
55641 #. type: Plain text
55642 #: guix-git/doc/guix.texi:31309
55643 msgid "The @uref{http://data.guix.gnu.org,Guix Data Service} processes, stores and provides data about GNU Guix. This includes information about packages, derivations and lint warnings."
55646 #. type: Plain text
55647 #: guix-git/doc/guix.texi:31312
55648 msgid "The data is stored in a PostgreSQL database, and available through a web interface."
55652 #: guix-git/doc/guix.texi:31313
55654 msgid "{Scheme Variable} guix-data-service-type"
55658 #: guix-git/doc/guix.texi:31318
55659 msgid "Service type for the Guix Data Service. Its value must be a @code{guix-data-service-configuration} object. The service optionally extends the getmail service, as the guix-commits mailing list is used to find out about changes in the Guix git repository."
55663 #: guix-git/doc/guix.texi:31320
55665 msgid "{Data Type} guix-data-service-configuration"
55669 #: guix-git/doc/guix.texi:31322
55670 msgid "Data type representing the configuration of the Guix Data Service."
55674 #: guix-git/doc/guix.texi:31324
55676 msgid "@code{package} (default: @code{guix-data-service})"
55680 #: guix-git/doc/guix.texi:31326
55681 msgid "The Guix Data Service package to use."
55685 #: guix-git/doc/guix.texi:31327
55687 msgid "@code{user} (default: @code{\"guix-data-service\"})"
55691 #: guix-git/doc/guix.texi:31330
55693 msgid "@code{group} (default: @code{\"guix-data-service\"})"
55697 #: guix-git/doc/guix.texi:31333
55699 msgid "@code{port} (default: @code{8765})"
55703 #: guix-git/doc/guix.texi:31335
55704 msgid "The port to bind the web service to."
55708 #: guix-git/doc/guix.texi:31336
55710 msgid "@code{host} (default: @code{\"127.0.0.1\"})"
55714 #: guix-git/doc/guix.texi:31338
55715 msgid "The host to bind the web service to."
55719 #: guix-git/doc/guix.texi:31339
55721 msgid "@code{getmail-idle-mailboxes} (default: @code{#f})"
55725 #: guix-git/doc/guix.texi:31342
55726 msgid "If set, this is the list of mailboxes that the getmail service will be configured to listen to."
55730 #: guix-git/doc/guix.texi:31343
55732 msgid "@code{commits-getmail-retriever-configuration} (default: @code{#f})"
55736 #: guix-git/doc/guix.texi:31347
55737 msgid "If set, this is the @code{getmail-retriever-configuration} object with which to configure getmail to fetch mail from the guix-commits mailing list."
55741 #: guix-git/doc/guix.texi:31348
55743 msgid "@code{extra-options} (default: @var{'()})"
55747 #: guix-git/doc/guix.texi:31350
55748 msgid "Extra command line options for @code{guix-data-service}."
55752 #: guix-git/doc/guix.texi:31351
55754 msgid "@code{extra-process-jobs-options} (default: @var{'()})"
55758 #: guix-git/doc/guix.texi:31353
55759 msgid "Extra command line options for @code{guix-data-service-process-jobs}."
55763 #: guix-git/doc/guix.texi:31360
55769 #: guix-git/doc/guix.texi:31361
55771 msgid "out of memory killer"
55775 #: guix-git/doc/guix.texi:31362
55781 #: guix-git/doc/guix.texi:31363
55783 msgid "early out of memory daemon"
55786 #. type: subsubheading
55787 #: guix-git/doc/guix.texi:31364
55789 msgid "Early OOM Service"
55792 #. type: Plain text
55793 #: guix-git/doc/guix.texi:31371
55794 msgid "@uref{https://github.com/rfjakob/earlyoom,Early OOM}, also known as Earlyoom, is a minimalist out of memory (OOM) daemon that runs in user space and provides a more responsive and configurable alternative to the in-kernel OOM killer. It is useful to prevent the system from becoming unresponsive when it runs out of memory."
55798 #: guix-git/doc/guix.texi:31372
55800 msgid "{Scheme Variable} earlyoom-service-type"
55804 #: guix-git/doc/guix.texi:31377
55805 msgid "The service type for running @command{earlyoom}, the Early OOM daemon. Its value must be a @code{earlyoom-configuration} object, described below. The service can be instantiated in its default configuration with:"
55809 #: guix-git/doc/guix.texi:31380
55811 msgid "(service earlyoom-service-type)\n"
55815 #: guix-git/doc/guix.texi:31383
55817 msgid "{Data Type} earlyoom-configuration"
55821 #: guix-git/doc/guix.texi:31385
55822 msgid "This is the configuration record for the @code{earlyoom-service-type}."
55826 #: guix-git/doc/guix.texi:31387
55828 msgid "@code{earlyoom} (default: @var{earlyoom})"
55832 #: guix-git/doc/guix.texi:31389
55833 msgid "The Earlyoom package to use."
55837 #: guix-git/doc/guix.texi:31390
55839 msgid "@code{minimum-available-memory} (default: @code{10})"
55843 #: guix-git/doc/guix.texi:31392
55844 msgid "The threshold for the minimum @emph{available} memory, in percentages."
55848 #: guix-git/doc/guix.texi:31393
55850 msgid "@code{minimum-free-swap} (default: @code{10})"
55854 #: guix-git/doc/guix.texi:31395
55855 msgid "The threshold for the minimum free swap memory, in percentages."
55859 #: guix-git/doc/guix.texi:31396
55861 msgid "@code{prefer-regexp} (default: @code{#f})"
55865 #: guix-git/doc/guix.texi:31399
55866 msgid "A regular expression (as a string) to match the names of the processes that should be preferably killed."
55870 #: guix-git/doc/guix.texi:31400
55872 msgid "@code{avoid-regexp} (default: @code{#f})"
55876 #: guix-git/doc/guix.texi:31403
55877 msgid "A regular expression (as a string) to match the names of the processes that should @emph{not} be killed."
55881 #: guix-git/doc/guix.texi:31404
55883 msgid "@code{memory-report-interval} (default: @code{0})"
55887 #: guix-git/doc/guix.texi:31407
55888 msgid "The interval in seconds at which a memory report is printed. It is disabled by default."
55892 #: guix-git/doc/guix.texi:31408
55894 msgid "@code{ignore-positive-oom-score-adj?} (default: @code{#f})"
55898 #: guix-git/doc/guix.texi:31411
55899 msgid "A boolean indicating whether the positive adjustments set in @file{/proc/*/oom_score_adj} should be ignored."
55903 #: guix-git/doc/guix.texi:31412
55905 msgid "@code{show-debug-messages?} (default: @code{#f})"
55909 #: guix-git/doc/guix.texi:31415
55910 msgid "A boolean indicating whether debug messages should be printed. The logs are saved at @file{/var/log/earlyoom.log}."
55914 #: guix-git/doc/guix.texi:31416
55916 msgid "@code{send-notification-command} (default: @code{#f})"
55920 #: guix-git/doc/guix.texi:31419
55921 msgid "This can be used to provide a custom command used for sending notifications."
55925 #: guix-git/doc/guix.texi:31422
55931 #: guix-git/doc/guix.texi:31423
55933 msgid "kernel module loader"
55936 #. type: subsubheading
55937 #: guix-git/doc/guix.texi:31424
55939 msgid "Kernel Module Loader Service"
55942 #. type: Plain text
55943 #: guix-git/doc/guix.texi:31430
55944 msgid "The kernel module loader service allows one to load loadable kernel modules at boot. This is especially useful for modules that don't autoload and need to be manually loaded, as it's the case with @code{ddcci}."
55948 #: guix-git/doc/guix.texi:31431
55950 msgid "{Scheme Variable} kernel-module-loader-service-type"
55954 #: guix-git/doc/guix.texi:31437
55955 msgid "The service type for loading loadable kernel modules at boot with @command{modprobe}. Its value must be a list of strings representing module names. For example loading the drivers provided by @code{ddcci-driver-linux}, in debugging mode by passing some module parameters, can be done as follow:"
55959 #: guix-git/doc/guix.texi:31442
55962 "(use-modules (gnu) (gnu services))\n"
55963 "(use-package-modules linux)\n"
55964 "(use-service-modules linux)\n"
55969 #: guix-git/doc/guix.texi:31446
55972 "(define ddcci-config\n"
55973 " (plain-file \"ddcci.conf\"\n"
55974 " \"options ddcci dyndbg delay=120\"))\n"
55979 #: guix-git/doc/guix.texi:31456
55982 "(operating-system\n"
55984 " (services (cons* (service kernel-module-loader-service-type\n"
55985 " '(\"ddcci\" \"ddcci_backlight\"))\n"
55986 " (simple-service 'ddcci-config etc-service-type\n"
55987 " (list `(\"modprobe.d/ddcci.conf\"\n"
55988 " ,ddcci-config)))\n"
55989 " %base-services))\n"
55990 " (kernel-loadable-modules (list ddcci-driver-linux)))\n"
55994 #: guix-git/doc/guix.texi:31459
56000 #: guix-git/doc/guix.texi:31460
56002 msgid "compressed swap"
56006 #: guix-git/doc/guix.texi:31461
56008 msgid "Compressed RAM-based block devices"
56011 #. type: subsubheading
56012 #: guix-git/doc/guix.texi:31462
56014 msgid "Zram Device Service"
56017 #. type: Plain text
56018 #: guix-git/doc/guix.texi:31468
56019 msgid "The Zram device service provides a compressed swap device in system memory. The Linux Kernel documentation has more information about @uref{https://www.kernel.org/doc/html/latest/admin-guide/blockdev/zram.html,zram} devices."
56023 #: guix-git/doc/guix.texi:31469
56025 msgid "{Scheme Variable} zram-device-service-type"
56029 #: guix-git/doc/guix.texi:31473
56030 msgid "This service creates the zram block device, formats it as swap and enables it as a swap device. The service's value is a @code{zram-device-configuration} record."
56034 #: guix-git/doc/guix.texi:31474
56036 msgid "{Data Type} zram-device-configuration"
56040 #: guix-git/doc/guix.texi:31477
56041 msgid "This is the data type representing the configuration for the zram-device service."
56045 #: guix-git/doc/guix.texi:31479
56047 msgid "@code{size} (default @code{\"1G\"})"
56051 #: guix-git/doc/guix.texi:31483
56052 msgid "This is the amount of space you wish to provide for the zram device. It accepts a string and can be a number of bytes or use a suffix, eg.: @code{\"512M\"} or @code{1024000}."
56056 #: guix-git/doc/guix.texi:31483
56058 msgid "@code{compression-algorithm} (default @code{'lzo})"
56062 #: guix-git/doc/guix.texi:31487
56063 msgid "This is the compression algorithm you wish to use. It is difficult to list all the possible compression options, but common ones supported by Guix's Linux Libre Kernel include @code{'lzo}, @code{'lz4} and @code{'zstd}."
56067 #: guix-git/doc/guix.texi:31487
56069 msgid "@code{memory-limit} (default @code{0})"
56073 #: guix-git/doc/guix.texi:31494
56074 msgid "This is the maximum amount of memory which the zram device can use. Setting it to '0' disables the limit. While it is generally expected that compression will be 2:1, it is possible that uncompressable data can be written to swap and this is a method to limit how much memory can be used. It accepts a string and can be a number of bytes or use a suffix, eg.: @code{\"2G\"}."
56078 #: guix-git/doc/guix.texi:31494
56080 msgid "@code{priority} (default @code{-1})"
56084 #: guix-git/doc/guix.texi:31499
56085 msgid "This is the priority of the swap device created from the zram device. @code{swapon} accepts values between -1 and 32767, with higher values indicating higher priority. Higher priority swap will generally be used first."
56089 #: guix-git/doc/guix.texi:31507
56091 msgid "{Scheme Variable} hurd-console-service-type"
56095 #: guix-git/doc/guix.texi:31509
56096 msgid "This service starts the fancy @code{VGA} console client on the Hurd."
56100 #: guix-git/doc/guix.texi:31511
56101 msgid "The service's value is a @code{hurd-console-configuration} record."
56105 #: guix-git/doc/guix.texi:31513
56107 msgid "{Data Type} hurd-console-configuration"
56111 #: guix-git/doc/guix.texi:31516
56112 msgid "This is the data type representing the configuration for the hurd-console-service."
56116 #: guix-git/doc/guix.texi:31518 guix-git/doc/guix.texi:31534
56118 msgid "@code{hurd} (default: @var{hurd})"
56122 #: guix-git/doc/guix.texi:31520 guix-git/doc/guix.texi:31536
56123 msgid "The Hurd package to use."
56127 #: guix-git/doc/guix.texi:31523
56129 msgid "{Scheme Variable} hurd-getty-service-type"
56133 #: guix-git/doc/guix.texi:31525
56134 msgid "This service starts a tty using the Hurd @code{getty} program."
56138 #: guix-git/doc/guix.texi:31527
56139 msgid "The service's value is a @code{hurd-getty-configuration} record."
56143 #: guix-git/doc/guix.texi:31529
56145 msgid "{Data Type} hurd-getty-configuration"
56149 #: guix-git/doc/guix.texi:31532
56150 msgid "This is the data type representing the configuration for the hurd-getty-service."
56154 #: guix-git/doc/guix.texi:31539
56155 msgid "The name of the console this Getty runs on---e.g., @code{\"tty1\"}."
56159 #: guix-git/doc/guix.texi:31540
56161 msgid "@code{baud-rate} (default: @code{38400})"
56165 #: guix-git/doc/guix.texi:31542
56166 msgid "An integer specifying the baud rate of the tty."
56170 #: guix-git/doc/guix.texi:31549
56172 msgid "fingerprint"
56175 #. type: subsubheading
56176 #: guix-git/doc/guix.texi:31550
56178 msgid "Fingerprint Service"
56181 #. type: Plain text
56182 #: guix-git/doc/guix.texi:31554
56183 msgid "The @code{(gnu services authentication)} module provides a DBus service to read and identify fingerprints via a fingerprint sensor."
56187 #: guix-git/doc/guix.texi:31555
56189 msgid "{Scheme Variable} fprintd-service-type"
56193 #: guix-git/doc/guix.texi:31558
56194 msgid "The service type for @command{fprintd}, which provides the fingerprint reading capability."
56198 #: guix-git/doc/guix.texi:31561
56200 msgid "(service fprintd-service-type)\n"
56204 #: guix-git/doc/guix.texi:31564
56209 #. type: subsubheading
56210 #: guix-git/doc/guix.texi:31565
56212 msgid "System Control Service"
56215 #. type: Plain text
56216 #: guix-git/doc/guix.texi:31569
56217 msgid "The @code{(gnu services sysctl)} provides a service to configure kernel parameters at boot."
56221 #: guix-git/doc/guix.texi:31570
56223 msgid "{Scheme Variable} sysctl-service-type"
56227 #: guix-git/doc/guix.texi:31574
56228 msgid "The service type for @command{sysctl}, which modifies kernel parameters under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated as:"
56232 #: guix-git/doc/guix.texi:31579
56235 "(service sysctl-service-type\n"
56236 " (sysctl-configuration\n"
56237 " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n"
56241 #: guix-git/doc/guix.texi:31586
56242 msgid "Since @code{sysctl-service-type} is used in the default lists of services, @code{%base-services} and @code{%desktop-services}, you can use @code{modify-services} to change its configuration and add the kernel parameters that you want (@pxref{Service Reference, @code{modify-services}})."
56246 #: guix-git/doc/guix.texi:31593
56249 "(modify-services %base-services\n"
56250 " (sysctl-service-type config =>\n"
56251 " (sysctl-configuration\n"
56252 " (settings (append '((\"net.ipv4.ip_forward\" . \"1\"))\n"
56253 " %default-sysctl-settings)))))\n"
56257 #: guix-git/doc/guix.texi:31597
56259 msgid "{Data Type} sysctl-configuration"
56263 #: guix-git/doc/guix.texi:31599
56264 msgid "The data type representing the configuration of @command{sysctl}."
56268 #: guix-git/doc/guix.texi:31601
56270 msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})"
56274 #: guix-git/doc/guix.texi:31603
56275 msgid "The @command{sysctl} executable to use."
56279 #: guix-git/doc/guix.texi:31604
56281 msgid "@code{settings} (default: @code{%default-sysctl-settings})"
56285 #: guix-git/doc/guix.texi:31606
56286 msgid "An association list specifies kernel parameters and their values."
56290 #: guix-git/doc/guix.texi:31609
56292 msgid "{Scheme Variable} %default-sysctl-settings"
56296 #: guix-git/doc/guix.texi:31612
56297 msgid "An association list specifying the default @command{sysctl} parameters on Guix System."
56301 #: guix-git/doc/guix.texi:31614
56306 #. type: subsubheading
56307 #: guix-git/doc/guix.texi:31615
56309 msgid "PC/SC Smart Card Daemon Service"
56312 #. type: Plain text
56313 #: guix-git/doc/guix.texi:31622
56314 msgid "The @code{(gnu services security-token)} module provides the following service to run @command{pcscd}, the PC/SC Smart Card Daemon. @command{pcscd} is the daemon program for pcsc-lite and the MuscleCard framework. It is a resource manager that coordinates communications with smart card readers, smart cards and cryptographic tokens that are connected to the system."
56318 #: guix-git/doc/guix.texi:31623
56320 msgid "{Scheme Variable} pcscd-service-type"
56324 #: guix-git/doc/guix.texi:31627
56325 msgid "Service type for the @command{pcscd} service. Its value must be a @code{pcscd-configuration} object. To run pcscd in the default configuration, instantiate it as:"
56329 #: guix-git/doc/guix.texi:31630
56331 msgid "(service pcscd-service-type)\n"
56335 #: guix-git/doc/guix.texi:31633
56337 msgid "{Data Type} pcscd-configuration"
56341 #: guix-git/doc/guix.texi:31635
56342 msgid "The data type representing the configuration of @command{pcscd}."
56346 #: guix-git/doc/guix.texi:31637
56348 msgid "@code{pcsc-lite} (default: @code{pcsc-lite})"
56352 #: guix-git/doc/guix.texi:31639
56353 msgid "The pcsc-lite package that provides pcscd."
56357 #: guix-git/doc/guix.texi:31639
56359 msgid "@code{usb-drivers} (default: @code{(list ccid)})"
56363 #: guix-git/doc/guix.texi:31642
56364 msgid "List of packages that provide USB drivers to pcscd. Drivers are expected to be under @file{pcsc/drivers} in the store directory of the package."
56368 #: guix-git/doc/guix.texi:31645
56373 #. type: subsubheading
56374 #: guix-git/doc/guix.texi:31646
56376 msgid "Lirc Service"
56379 #. type: Plain text
56380 #: guix-git/doc/guix.texi:31649
56381 msgid "The @code{(gnu services lirc)} module provides the following service."
56385 #: guix-git/doc/guix.texi:31650
56387 msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @"
56391 #: guix-git/doc/guix.texi:31655
56392 msgid "[#:device #f] [#:driver #f] [#:config-file #f] @ [#:extra-options '()] Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that decodes infrared signals from remote controls."
56396 #: guix-git/doc/guix.texi:31659
56397 msgid "Optionally, @var{device}, @var{driver} and @var{config-file} (configuration file name) may be specified. See @command{lircd} manual for details."
56401 #: guix-git/doc/guix.texi:31662
56402 msgid "Finally, @var{extra-options} is a list of additional command-line options passed to @command{lircd}."
56406 #: guix-git/doc/guix.texi:31664
56411 #. type: subsubheading
56412 #: guix-git/doc/guix.texi:31665
56414 msgid "Spice Service"
56417 #. type: Plain text
56418 #: guix-git/doc/guix.texi:31668
56419 msgid "The @code{(gnu services spice)} module provides the following service."
56423 #: guix-git/doc/guix.texi:31669
56425 msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]"
56429 #: guix-git/doc/guix.texi:31673
56430 msgid "Returns a service that runs @url{https://www.spice-space.org,VDAGENT}, a daemon that enables sharing the clipboard with a vm and setting the guest display resolution when the graphical console window resizes."
56434 #: guix-git/doc/guix.texi:31675
56436 msgid "inputattach"
56439 #. type: subsubheading
56440 #: guix-git/doc/guix.texi:31676
56442 msgid "inputattach Service"
56446 #: guix-git/doc/guix.texi:31678
56448 msgid "tablet input, for Xorg"
56452 #: guix-git/doc/guix.texi:31679
56454 msgid "touchscreen input, for Xorg"
56457 #. type: Plain text
56458 #: guix-git/doc/guix.texi:31683
56459 msgid "The @uref{https://linuxwacom.github.io/, inputattach} service allows you to use input devices such as Wacom tablets, touchscreens, or joysticks with the Xorg display server."
56463 #: guix-git/doc/guix.texi:31684
56465 msgid "{Scheme Variable} inputattach-service-type"
56469 #: guix-git/doc/guix.texi:31687
56470 msgid "Type of a service that runs @command{inputattach} on a device and dispatches events from it."
56474 #: guix-git/doc/guix.texi:31689
56476 msgid "{Data Type} inputattach-configuration"
56480 #: guix-git/doc/guix.texi:31691
56482 msgid "@code{device-type} (default: @code{\"wacom\"})"
56486 #: guix-git/doc/guix.texi:31694
56487 msgid "The type of device to connect to. Run @command{inputattach --help}, from the @code{inputattach} package, to see the list of supported device types."
56491 #: guix-git/doc/guix.texi:31695
56493 msgid "@code{device} (default: @code{\"/dev/ttyS0\"})"
56497 #: guix-git/doc/guix.texi:31697
56498 msgid "The device file to connect to the device."
56502 #: guix-git/doc/guix.texi:31701
56503 msgid "Baud rate to use for the serial connection. Should be a number or @code{#f}."
56507 #: guix-git/doc/guix.texi:31702
56509 msgid "@code{log-file} (default: @code{#f})"
56513 #: guix-git/doc/guix.texi:31704
56514 msgid "If true, this must be the name of a file to log messages to."
56517 #. type: subsubheading
56518 #: guix-git/doc/guix.texi:31707
56520 msgid "Dictionary Service"
56524 #: guix-git/doc/guix.texi:31708
56529 #. type: Plain text
56530 #: guix-git/doc/guix.texi:31710
56531 msgid "The @code{(gnu services dict)} module provides the following service:"
56535 #: guix-git/doc/guix.texi:31711
56537 msgid "{Scheme Variable} dicod-service-type"
56541 #: guix-git/doc/guix.texi:31714
56542 msgid "This is the type of the service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
56546 #: guix-git/doc/guix.texi:31716
56548 msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]"
56552 #: guix-git/doc/guix.texi:31719
56553 msgid "Return a service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
56557 #: guix-git/doc/guix.texi:31723
56558 msgid "The optional @var{config} argument specifies the configuration for @command{dicod}, which should be a @code{<dicod-configuration>} object, by default it serves the GNU Collaborative International Dictionary of English."
56562 #: guix-git/doc/guix.texi:31727
56563 msgid "You can add @command{open localhost} to your @file{~/.dico} file to make @code{localhost} the default server for @command{dico} client (@pxref{Initialization File,,, dico, GNU Dico Manual})."
56567 #: guix-git/doc/guix.texi:31729
56569 msgid "{Data Type} dicod-configuration"
56573 #: guix-git/doc/guix.texi:31731
56574 msgid "Data type representing the configuration of dicod."
56578 #: guix-git/doc/guix.texi:31733
56580 msgid "@code{dico} (default: @var{dico})"
56584 #: guix-git/doc/guix.texi:31735
56585 msgid "Package object of the GNU Dico dictionary server."
56589 #: guix-git/doc/guix.texi:31736
56591 msgid "@code{interfaces} (default: @var{'(\"localhost\")})"
56595 #: guix-git/doc/guix.texi:31740
56596 msgid "This is the list of IP addresses and ports and possibly socket file names to listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico Manual})."
56600 #: guix-git/doc/guix.texi:31741
56602 msgid "@code{handlers} (default: @var{'()})"
56606 #: guix-git/doc/guix.texi:31743
56607 msgid "List of @code{<dicod-handler>} objects denoting handlers (module instances)."
56611 #: guix-git/doc/guix.texi:31744
56613 msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})"
56617 #: guix-git/doc/guix.texi:31746
56618 msgid "List of @code{<dicod-database>} objects denoting dictionaries to be served."
56622 #: guix-git/doc/guix.texi:31749
56624 msgid "{Data Type} dicod-handler"
56628 #: guix-git/doc/guix.texi:31751
56629 msgid "Data type representing a dictionary handler (module instance)."
56633 #: guix-git/doc/guix.texi:31755
56634 msgid "Name of the handler (module instance)."
56638 #: guix-git/doc/guix.texi:31756
56640 msgid "@code{module} (default: @var{#f})"
56644 #: guix-git/doc/guix.texi:31760
56645 msgid "Name of the dicod module of the handler (instance). If it is @code{#f}, the module has the same name as the handler. (@pxref{Modules,,, dico, GNU Dico Manual})."
56649 #: guix-git/doc/guix.texi:31763
56650 msgid "List of strings or gexps representing the arguments for the module handler"
56654 #: guix-git/doc/guix.texi:31766
56656 msgid "{Data Type} dicod-database"
56660 #: guix-git/doc/guix.texi:31768
56661 msgid "Data type representing a dictionary database."
56665 #: guix-git/doc/guix.texi:31772
56666 msgid "Name of the database, will be used in DICT commands."
56670 #: guix-git/doc/guix.texi:31773
56676 #: guix-git/doc/guix.texi:31776
56677 msgid "Name of the dicod handler (module instance) used by this database (@pxref{Handlers,,, dico, GNU Dico Manual})."
56681 #: guix-git/doc/guix.texi:31777
56683 msgid "@code{complex?} (default: @var{#f})"
56687 #: guix-git/doc/guix.texi:31780
56688 msgid "Whether the database configuration complex. The complex configuration will need a corresponding @code{<dicod-handler>} object, otherwise not."
56692 #: guix-git/doc/guix.texi:31784
56693 msgid "List of strings or gexps representing the arguments for the database (@pxref{Databases,,, dico, GNU Dico Manual})."
56697 #: guix-git/doc/guix.texi:31787
56699 msgid "{Scheme Variable} %dicod-database:gcide"
56703 #: guix-git/doc/guix.texi:31790
56704 msgid "A @code{<dicod-database>} object serving the GNU Collaborative International Dictionary of English using the @code{gcide} package."
56707 #. type: Plain text
56708 #: guix-git/doc/guix.texi:31793
56709 msgid "The following is an example @code{dicod-service} configuration."
56713 #: guix-git/doc/guix.texi:31808
56716 "(dicod-service #:config\n"
56717 " (dicod-configuration\n"
56718 " (handlers (list (dicod-handler\n"
56719 " (name \"wordnet\")\n"
56720 " (module \"dictorg\")\n"
56722 " (list #~(string-append \"dbdir=\" #$wordnet))))))\n"
56723 " (databases (list (dicod-database\n"
56724 " (name \"wordnet\")\n"
56726 " (handler \"wordnet\")\n"
56727 " (options '(\"database=wn\")))\n"
56728 " %dicod-database:gcide))))\n"
56732 #: guix-git/doc/guix.texi:31810
56737 #. type: subsubheading
56738 #: guix-git/doc/guix.texi:31811
56740 msgid "Docker Service"
56743 #. type: Plain text
56744 #: guix-git/doc/guix.texi:31814
56745 msgid "The @code{(gnu services docker)} module provides the following services."
56749 #: guix-git/doc/guix.texi:31815
56751 msgid "{Scheme Variable} docker-service-type"
56755 #: guix-git/doc/guix.texi:31820
56756 msgid "This is the type of the service that runs @url{https://www.docker.com,Docker}, a daemon that can execute application bundles (sometimes referred to as ``containers'') in isolated environments."
56760 #: guix-git/doc/guix.texi:31823
56762 msgid "{Data Type} docker-configuration"
56766 #: guix-git/doc/guix.texi:31825
56767 msgid "This is the data type representing the configuration of Docker and Containerd."
56771 #: guix-git/doc/guix.texi:31828
56773 msgid "@code{package} (default: @code{docker})"
56777 #: guix-git/doc/guix.texi:31830
56778 msgid "The Docker daemon package to use."
56782 #: guix-git/doc/guix.texi:31831
56784 msgid "@code{package} (default: @code{docker-cli})"
56788 #: guix-git/doc/guix.texi:31833
56789 msgid "The Docker client package to use."
56793 #: guix-git/doc/guix.texi:31834
56795 msgid "@code{containerd} (default: @var{containerd})"
56799 #: guix-git/doc/guix.texi:31836
56800 msgid "The Containerd package to use."
56804 #: guix-git/doc/guix.texi:31837
56806 msgid "@code{proxy} (default @var{docker-libnetwork-cmd-proxy})"
56810 #: guix-git/doc/guix.texi:31839
56811 msgid "The Docker user-land networking proxy package to use."
56815 #: guix-git/doc/guix.texi:31840
56817 msgid "@code{enable-proxy?} (default @code{#t})"
56821 #: guix-git/doc/guix.texi:31842
56822 msgid "Enable or disable the use of the Docker user-land networking proxy."
56826 #: guix-git/doc/guix.texi:31843
56828 msgid "@code{debug?} (default @code{#f})"
56832 #: guix-git/doc/guix.texi:31845
56833 msgid "Enable or disable debug output."
56837 #: guix-git/doc/guix.texi:31846
56839 msgid "@code{enable-iptables?} (default @code{#t})"
56843 #: guix-git/doc/guix.texi:31848
56844 msgid "Enable or disable the addition of iptables rules."
56848 #: guix-git/doc/guix.texi:31852
56850 msgid "Singularity, container service"
56854 #: guix-git/doc/guix.texi:31853
56856 msgid "{Scheme Variable} singularity-service-type"
56860 #: guix-git/doc/guix.texi:31858
56861 msgid "This is the type of the service that allows you to run @url{https://www.sylabs.io/singularity/, Singularity}, a Docker-style tool to create and run application bundles (aka. ``containers''). The value for this service is the Singularity package to use."
56865 #: guix-git/doc/guix.texi:31862
56866 msgid "The service does not install a daemon; instead, it installs helper programs as setuid-root (@pxref{Setuid Programs}) such that unprivileged users can invoke @command{singularity run} and similar commands."
56870 #: guix-git/doc/guix.texi:31864
56875 #. type: subsubheading
56876 #: guix-git/doc/guix.texi:31865
56878 msgid "Auditd Service"
56881 #. type: Plain text
56882 #: guix-git/doc/guix.texi:31868
56883 msgid "The @code{(gnu services auditd)} module provides the following service."
56887 #: guix-git/doc/guix.texi:31869
56889 msgid "{Scheme Variable} auditd-service-type"
56893 #: guix-git/doc/guix.texi:31874
56894 msgid "This is the type of the service that runs @url{https://people.redhat.com/sgrubb/audit/,auditd}, a daemon that tracks security-relevant information on your system."
56898 #: guix-git/doc/guix.texi:31876
56899 msgid "Examples of things that can be tracked:"
56903 #: guix-git/doc/guix.texi:31880
56904 msgid "File accesses"
56908 #: guix-git/doc/guix.texi:31882
56909 msgid "System calls"
56913 #: guix-git/doc/guix.texi:31884
56914 msgid "Invoked commands"
56918 #: guix-git/doc/guix.texi:31886
56919 msgid "Failed login attempts"
56923 #: guix-git/doc/guix.texi:31888
56924 msgid "Firewall filtering"
56928 #: guix-git/doc/guix.texi:31890
56929 msgid "Network access"
56933 #: guix-git/doc/guix.texi:31901
56934 msgid "@command{auditctl} from the @code{audit} package can be used in order to add or remove events to be tracked (until the next reboot). In order to permanently track events, put the command line arguments of auditctl into a file called @code{audit.rules} in the configuration directory (see below). @command{aureport} from the @code{audit} package can be used in order to view a report of all recorded events. The audit daemon by default logs into the file @file{/var/log/audit.log}."
56938 #: guix-git/doc/guix.texi:31904
56940 msgid "{Data Type} auditd-configuration"
56944 #: guix-git/doc/guix.texi:31906
56945 msgid "This is the data type representing the configuration of auditd."
56949 #: guix-git/doc/guix.texi:31909
56951 msgid "@code{audit} (default: @code{audit})"
56955 #: guix-git/doc/guix.texi:31911
56956 msgid "The audit package to use."
56960 #: guix-git/doc/guix.texi:31912
56962 msgid "@code{configuration-directory} (default: @code{%default-auditd-configuration-directory})"
56966 #: guix-git/doc/guix.texi:31916
56967 msgid "The directory containing the configuration file for the audit package, which must be named @code{auditd.conf}, and optionally some audit rules to instantiate on startup."
56971 #: guix-git/doc/guix.texi:31920
56976 #. type: subsubheading
56977 #: guix-git/doc/guix.texi:31921
56979 msgid "R-Shiny service"
56982 #. type: Plain text
56983 #: guix-git/doc/guix.texi:31924
56984 msgid "The @code{(gnu services science)} module provides the following service."
56988 #: guix-git/doc/guix.texi:31925
56990 msgid "{Scheme Variable} rshiny-service-type"
56994 #: guix-git/doc/guix.texi:31930
56995 msgid "This is a type of service which is used to run a webapp created with @code{r-shiny}. This service sets the @env{R_LIBS_USER} environment variable and runs the provided script to call @code{runApp}."
56999 #: guix-git/doc/guix.texi:31931
57001 msgid "{Data Type} rshiny-configuration"
57005 #: guix-git/doc/guix.texi:31933
57006 msgid "This is the data type representing the configuration of rshiny."
57010 #: guix-git/doc/guix.texi:31936
57012 msgid "@code{package} (default: @code{r-shiny})"
57016 #: guix-git/doc/guix.texi:31938
57017 msgid "The package to use."
57021 #: guix-git/doc/guix.texi:31939
57023 msgid "@code{binary} (defaunlt @code{\"rshiny\"})"
57027 #: guix-git/doc/guix.texi:31942
57028 msgid "The name of the binary or shell script located at @code{package/bin/} to run when the service is run."
57032 #: guix-git/doc/guix.texi:31944
57033 msgid "The common way to create this file is as follows:"
57037 #: guix-git/doc/guix.texi:31962
57041 "(let* ((out (assoc-ref %outputs \"out\"))\n"
57042 " (targetdir (string-append out \"/share/\" ,name))\n"
57043 " (app (string-append out \"/bin/\" ,name))\n"
57044 " (Rbin (string-append (assoc-ref %build-inputs \"r-min\")\n"
57045 " \"/bin/Rscript\")))\n"
57047 " (mkdir-p (string-append out \"/bin\"))\n"
57048 " (call-with-output-file app\n"
57049 " (lambda (port)\n"
57053 "setwd(\\\"~a\\\")\n"
57054 "runApp(launch.browser=0, port=4202)~%\\n\"\n"
57055 " Rbin targetdir))))\n"
57059 #: guix-git/doc/guix.texi:31968
57064 #. type: subsubheading
57065 #: guix-git/doc/guix.texi:31969
57067 msgid "Nix service"
57070 #. type: Plain text
57071 #: guix-git/doc/guix.texi:31972
57072 msgid "The @code{(gnu services nix)} module provides the following service."
57076 #: guix-git/doc/guix.texi:31973
57078 msgid "{Scheme Variable} nix-service-type"
57082 #: guix-git/doc/guix.texi:31978
57083 msgid "This is the type of the service that runs build daemon of the @url{https://nixos.org/nix/, Nix} package manager. Here is an example showing how to use it:"
57087 #: guix-git/doc/guix.texi:31983
57090 "(use-modules (gnu))\n"
57091 "(use-service-modules nix)\n"
57092 "(use-package-modules package-management)\n"
57097 #: guix-git/doc/guix.texi:31988
57100 "(operating-system\n"
57102 " (packages (append (list nix)\n"
57103 " %base-packages))\n"
57108 #: guix-git/doc/guix.texi:31991
57111 " (services (append (list (service nix-service-type))\n"
57112 " %base-services)))\n"
57116 #: guix-git/doc/guix.texi:31994
57117 msgid "After @command{guix system reconfigure} configure Nix for your user:"
57121 #: guix-git/doc/guix.texi:31996
57123 msgid "Add a Nix channel and update it. See"
57127 #: guix-git/doc/guix.texi:31998
57128 msgid "@url{https://nixos.org/nix/manual/, Nix Package Manager Guide}."
57132 #: guix-git/doc/guix.texi:31999
57134 msgid "Create a symlink to your profile and activate Nix profile:"
57138 #: guix-git/doc/guix.texi:32005
57141 "$ ln -s \"/nix/var/nix/profiles/per-user/$USER/profile\" ~/.nix-profile\n"
57142 "$ source /run/current-system/profile/etc/profile.d/nix.sh\n"
57146 #: guix-git/doc/guix.texi:32009
57148 msgid "{Data Type} nix-configuration"
57152 #: guix-git/doc/guix.texi:32011
57153 msgid "This data type represents the configuration of the Nix daemon."
57157 #: guix-git/doc/guix.texi:32013
57159 msgid "@code{nix} (default: @code{nix})"
57163 #: guix-git/doc/guix.texi:32015
57164 msgid "The Nix package to use."
57168 #: guix-git/doc/guix.texi:32016
57170 msgid "@code{sandbox} (default: @code{#t})"
57174 #: guix-git/doc/guix.texi:32018
57175 msgid "Specifies whether builds are sandboxed by default."
57179 #: guix-git/doc/guix.texi:32019
57181 msgid "@code{build-sandbox-items} (default: @code{'()})"
57185 #: guix-git/doc/guix.texi:32022
57186 msgid "This is a list of strings or objects appended to the @code{build-sandbox-items} field of the configuration file."
57190 #: guix-git/doc/guix.texi:32030
57191 msgid "Extra command line options for @code{nix-service-type}."
57195 #: guix-git/doc/guix.texi:32036
57197 msgid "setuid programs"
57200 #. type: Plain text
57201 #: guix-git/doc/guix.texi:32046
57202 msgid "Some programs need to run with ``root'' privileges, even when they are launched by unprivileged users. A notorious example is the @command{passwd} program, which users can run to change their password, and which needs to access the @file{/etc/passwd} and @file{/etc/shadow} files---something normally restricted to root, for obvious security reasons. To address that, these executables are @dfn{setuid-root}, meaning that they always run with root privileges (@pxref{How Change Persona,,, libc, The GNU C Library Reference Manual}, for more info about the setuid mechanism)."
57205 #. type: Plain text
57206 #: guix-git/doc/guix.texi:32053
57207 msgid "The store itself @emph{cannot} contain setuid programs: that would be a security issue since any user on the system can write derivations that populate the store (@pxref{The Store}). Thus, a different mechanism is used: instead of changing the setuid bit directly on files that are in the store, we let the system administrator @emph{declare} which programs should be setuid root."
57210 #. type: Plain text
57211 #: guix-git/doc/guix.texi:32059
57212 msgid "The @code{setuid-programs} field of an @code{operating-system} declaration contains a list of G-expressions denoting the names of programs to be setuid-root (@pxref{Using the Configuration System}). For instance, the @command{passwd} program, which is part of the Shadow package, can be designated by this G-expression (@pxref{G-Expressions}):"
57216 #: guix-git/doc/guix.texi:32062
57218 msgid "#~(string-append #$shadow \"/bin/passwd\")\n"
57221 #. type: Plain text
57222 #: guix-git/doc/guix.texi:32066
57223 msgid "A default set of setuid programs is defined by the @code{%setuid-programs} variable of the @code{(gnu system)} module."
57227 #: guix-git/doc/guix.texi:32067
57229 msgid "{Scheme Variable} %setuid-programs"
57233 #: guix-git/doc/guix.texi:32069
57234 msgid "A list of G-expressions denoting common programs that are setuid-root."
57238 #: guix-git/doc/guix.texi:32072
57239 msgid "The list includes commands such as @command{passwd}, @command{ping}, @command{su}, and @command{sudo}."
57242 #. type: Plain text
57243 #: guix-git/doc/guix.texi:32078
57244 msgid "Under the hood, the actual setuid programs are created in the @file{/run/setuid-programs} directory at system activation time. The files in this directory refer to the ``real'' binaries, which are in the store."
57248 #: guix-git/doc/guix.texi:32082
57250 msgid "HTTPS, certificates"
57254 #: guix-git/doc/guix.texi:32083
57256 msgid "X.509 certificates"
57260 #: guix-git/doc/guix.texi:32084
57265 #. type: Plain text
57266 #: guix-git/doc/guix.texi:32091
57267 msgid "Web servers available over HTTPS (that is, HTTP over the transport-layer security mechanism, TLS) send client programs an @dfn{X.509 certificate} that the client can then use to @emph{authenticate} the server. To do that, clients verify that the server's certificate is signed by a so-called @dfn{certificate authority} (CA). But to verify the CA's signature, clients must have first acquired the CA's certificate."
57270 #. type: Plain text
57271 #: guix-git/doc/guix.texi:32095
57272 msgid "Web browsers such as GNU@tie{}IceCat include their own set of CA certificates, such that they are able to verify CA signatures out-of-the-box."
57275 #. type: Plain text
57276 #: guix-git/doc/guix.texi:32099
57277 msgid "However, most other programs that can talk HTTPS---@command{wget}, @command{git}, @command{w3m}, etc.---need to be told where CA certificates can be found."
57280 #. type: Plain text
57281 #: guix-git/doc/guix.texi:32106
57282 msgid "In Guix, this is done by adding a package that provides certificates to the @code{packages} field of the @code{operating-system} declaration (@pxref{operating-system Reference}). Guix includes one such package, @code{nss-certs}, which is a set of CA certificates provided as part of Mozilla's Network Security Services."
57285 #. type: Plain text
57286 #: guix-git/doc/guix.texi:32111
57287 msgid "Note that it is @emph{not} part of @code{%base-packages}, so you need to explicitly add it. The @file{/etc/ssl/certs} directory, which is where most applications and libraries look for certificates by default, points to the certificates installed globally."
57290 #. type: Plain text
57291 #: guix-git/doc/guix.texi:32121
57292 msgid "Unprivileged users, including users of Guix on a foreign distro, can also install their own certificate package in their profile. A number of environment variables need to be defined so that applications and libraries know where to find them. Namely, the OpenSSL library honors the @env{SSL_CERT_DIR} and @env{SSL_CERT_FILE} variables. Some applications add their own environment variables; for instance, the Git version control system honors the certificate bundle pointed to by the @env{GIT_SSL_CAINFO} environment variable. Thus, you would typically run something like:"
57296 #: guix-git/doc/guix.texi:32127
57299 "guix install nss-certs\n"
57300 "export SSL_CERT_DIR=\"$HOME/.guix-profile/etc/ssl/certs\"\n"
57301 "export SSL_CERT_FILE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
57302 "export GIT_SSL_CAINFO=\"$SSL_CERT_FILE\"\n"
57305 #. type: Plain text
57306 #: guix-git/doc/guix.texi:32132
57307 msgid "As another example, R requires the @env{CURL_CA_BUNDLE} environment variable to point to a certificate bundle, so you would have to run something like this:"
57311 #: guix-git/doc/guix.texi:32136
57314 "guix install nss-certs\n"
57315 "export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
57318 #. type: Plain text
57319 #: guix-git/doc/guix.texi:32140
57320 msgid "For other applications you may want to look up the required environment variable in the relevant documentation."
57324 #: guix-git/doc/guix.texi:32145
57326 msgid "name service switch"
57330 #: guix-git/doc/guix.texi:32146
57335 #. type: Plain text
57336 #: guix-git/doc/guix.texi:32155
57337 msgid "The @code{(gnu system nss)} module provides bindings to the configuration file of the libc @dfn{name service switch} or @dfn{NSS} (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). In a nutshell, the NSS is a mechanism that allows libc to be extended with new ``name'' lookup methods for system databases, which includes host names, service names, user accounts, and more (@pxref{Name Service Switch, System Databases and Name Service Switch,, libc, The GNU C Library Reference Manual})."
57340 #. type: Plain text
57341 #: guix-git/doc/guix.texi:32162
57342 msgid "The NSS configuration specifies, for each system database, which lookup method is to be used, and how the various methods are chained together---for instance, under which circumstances NSS should try the next method in the list. The NSS configuration is given in the @code{name-service-switch} field of @code{operating-system} declarations (@pxref{operating-system Reference, @code{name-service-switch}})."
57346 #: guix-git/doc/guix.texi:32163
57352 #: guix-git/doc/guix.texi:32164
57354 msgid ".local, host name lookup"
57357 #. type: Plain text
57358 #: guix-git/doc/guix.texi:32169
57359 msgid "As an example, the declaration below configures the NSS to use the @uref{https://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} back-end}, which supports host name lookups over multicast DNS (mDNS) for host names ending in @code{.local}:"
57363 #: guix-git/doc/guix.texi:32173
57366 "(name-service-switch\n"
57367 " (hosts (list %files ;first, check /etc/hosts\n"
57372 #: guix-git/doc/guix.texi:32178
57375 " ;; If the above did not succeed, try\n"
57376 " ;; with 'mdns_minimal'.\n"
57378 " (name \"mdns_minimal\")\n"
57383 #: guix-git/doc/guix.texi:32184
57386 " ;; 'mdns_minimal' is authoritative for\n"
57387 " ;; '.local'. When it returns \"not found\",\n"
57388 " ;; no need to try the next methods.\n"
57389 " (reaction (lookup-specification\n"
57390 " (not-found => return))))\n"
57395 #: guix-git/doc/guix.texi:32188
57398 " ;; Then fall back to DNS.\n"
57400 " (name \"dns\"))\n"
57405 #: guix-git/doc/guix.texi:32192
57408 " ;; Finally, try with the \"full\" 'mdns'.\n"
57410 " (name \"mdns\")))))\n"
57413 #. type: Plain text
57414 #: guix-git/doc/guix.texi:32197
57415 msgid "Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) contains this configuration, so you will not have to type it if all you want is to have @code{.local} host lookup working."
57418 #. type: Plain text
57419 #: guix-git/doc/guix.texi:32205
57420 msgid "Note that, in this case, in addition to setting the @code{name-service-switch} of the @code{operating-system} declaration, you also need to use @code{avahi-service-type} (@pxref{Networking Services, @code{avahi-service-type}}), or @code{%desktop-services}, which includes it (@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible to the name service cache daemon (@pxref{Base Services, @code{nscd-service}})."
57423 #. type: Plain text
57424 #: guix-git/doc/guix.texi:32208
57425 msgid "For convenience, the following variables provide typical NSS configurations."
57429 #: guix-git/doc/guix.texi:32209
57431 msgid "{Scheme Variable} %default-nss"
57435 #: guix-git/doc/guix.texi:32212
57436 msgid "This is the default name service switch configuration, a @code{name-service-switch} object."
57440 #: guix-git/doc/guix.texi:32214
57442 msgid "{Scheme Variable} %mdns-host-lookup-nss"
57446 #: guix-git/doc/guix.texi:32217
57447 msgid "This is the name service switch configuration with support for host name lookup over multicast DNS (mDNS) for host names ending in @code{.local}."
57450 #. type: Plain text
57451 #: guix-git/doc/guix.texi:32227
57452 msgid "The reference for name service switch configuration is given below. It is a direct mapping of the configuration file format of the C library , so please refer to the C library manual for more information (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). Compared to the configuration file format of libc NSS, it has the advantage not only of adding this warm parenthetic feel that we like, but also static checks: you will know about syntax errors and typos as soon as you run @command{guix system}."
57456 #: guix-git/doc/guix.texi:32228
57458 msgid "{Data Type} name-service-switch"
57462 #: guix-git/doc/guix.texi:32233
57463 msgid "This is the data type representation the configuration of libc's name service switch (NSS). Each field below represents one of the supported system databases."
57467 #: guix-git/doc/guix.texi:32235
57473 #: guix-git/doc/guix.texi:32236
57479 #: guix-git/doc/guix.texi:32238
57485 #: guix-git/doc/guix.texi:32239
57491 #: guix-git/doc/guix.texi:32240
57497 #: guix-git/doc/guix.texi:32241
57503 #: guix-git/doc/guix.texi:32242
57509 #: guix-git/doc/guix.texi:32245
57515 #: guix-git/doc/guix.texi:32247
57521 #: guix-git/doc/guix.texi:32250
57522 msgid "The system databases handled by the NSS@. Each of these fields must be a list of @code{<name-service>} objects (see below)."
57526 #: guix-git/doc/guix.texi:32253
57528 msgid "{Data Type} name-service"
57532 #: guix-git/doc/guix.texi:32257
57533 msgid "This is the data type representing an actual name service and the associated lookup action."
57537 #: guix-git/doc/guix.texi:32262
57538 msgid "A string denoting the name service (@pxref{Services in the NSS configuration,,, libc, The GNU C Library Reference Manual})."
57542 #: guix-git/doc/guix.texi:32267
57543 msgid "Note that name services listed here must be visible to nscd. This is achieved by passing the @code{#:name-services} argument to @code{nscd-service} the list of packages providing the needed name services (@pxref{Base Services, @code{nscd-service}})."
57547 #: guix-git/doc/guix.texi:32268
57553 #: guix-git/doc/guix.texi:32272
57554 msgid "An action specified using the @code{lookup-specification} macro (@pxref{Actions in the NSS configuration,,, libc, The GNU C Library Reference Manual}). For example:"
57558 #: guix-git/doc/guix.texi:32276
57561 "(lookup-specification (unavailable => continue)\n"
57562 " (success => return))\n"
57565 #. type: Plain text
57566 #: guix-git/doc/guix.texi:32290
57567 msgid "For bootstrapping purposes, the Linux-Libre kernel is passed an @dfn{initial RAM disk}, or @dfn{initrd}. An initrd contains a temporary root file system as well as an initialization script. The latter is responsible for mounting the real root file system, and for loading any kernel modules that may be needed to achieve that."
57570 #. type: Plain text
57571 #: guix-git/doc/guix.texi:32299
57572 msgid "The @code{initrd-modules} field of an @code{operating-system} declaration allows you to specify Linux-libre kernel modules that must be available in the initrd. In particular, this is where you would list modules needed to actually drive the hard disk where your root partition is---although the default value of @code{initrd-modules} should cover most use cases. For example, assuming you need the @code{megaraid_sas} module in addition to the default modules to be able to access your root file system, you would write:"
57576 #: guix-git/doc/guix.texi:32304
57579 "(operating-system\n"
57581 " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n"
57585 #: guix-git/doc/guix.texi:32306
57587 msgid "{Scheme Variable} %base-initrd-modules"
57591 #: guix-git/doc/guix.texi:32308
57592 msgid "This is the list of kernel modules included in the initrd by default."
57595 #. type: Plain text
57596 #: guix-git/doc/guix.texi:32316
57597 msgid "Furthermore, if you need lower-level customization, the @code{initrd} field of an @code{operating-system} declaration allows you to specify which initrd you would like to use. The @code{(gnu system linux-initrd)} module provides three ways to build an initrd: the high-level @code{base-initrd} procedure and the low-level @code{raw-initrd} and @code{expression->initrd} procedures."
57600 #. type: Plain text
57601 #: guix-git/doc/guix.texi:32321
57602 msgid "The @code{base-initrd} procedure is intended to cover most common uses. For example, if you want to add a bunch of kernel modules to be loaded at boot time, you can define the @code{initrd} field of the operating system declaration like this:"
57606 #: guix-git/doc/guix.texi:32329
57609 "(initrd (lambda (file-systems . rest)\n"
57610 " ;; Create a standard initrd but set up networking\n"
57611 " ;; with the parameters QEMU expects by default.\n"
57612 " (apply base-initrd file-systems\n"
57613 " #:qemu-networking? #t\n"
57617 #. type: Plain text
57618 #: guix-git/doc/guix.texi:32334
57619 msgid "The @code{base-initrd} procedure also handles common use cases that involves using the system as a QEMU guest, or as a ``live'' system with volatile root file system."
57622 #. type: Plain text
57623 #: guix-git/doc/guix.texi:32341
57624 msgid "The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, such as trying to guess which kernel modules and packages should be included to the initrd. An example use of @code{raw-initrd} is when a user has a custom Linux kernel configuration and default kernel modules included by @code{base-initrd} are not available."
57627 #. type: Plain text
57628 #: guix-git/doc/guix.texi:32346
57629 msgid "The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} honors several options passed on the Linux kernel command line (that is, arguments passed @i{via} the @code{linux} command of GRUB, or the @code{-append} option of QEMU), notably:"
57633 #: guix-git/doc/guix.texi:32348
57635 msgid "--load=@var{boot}"
57639 #: guix-git/doc/guix.texi:32351
57640 msgid "Tell the initial RAM disk to load @var{boot}, a file containing a Scheme program, once it has mounted the root file system."
57644 #: guix-git/doc/guix.texi:32355
57645 msgid "Guix uses this option to yield control to a boot program that runs the service activation programs and then spawns the GNU@tie{}Shepherd, the initialization system."
57649 #: guix-git/doc/guix.texi:32356
57651 msgid "--root=@var{root}"
57655 #: guix-git/doc/guix.texi:32361
57656 msgid "Mount @var{root} as the root file system. @var{root} can be a device name like @code{/dev/sda1}, a file system label, or a file system UUID. When unspecified, the device name from the root file system of the operating system declaration is used."
57660 #: guix-git/doc/guix.texi:32365
57661 msgid "Have @file{/run/booted-system} and @file{/run/current-system} point to @var{system}."
57665 #: guix-git/doc/guix.texi:32366
57667 msgid "modprobe.blacklist=@var{modules}@dots{}"
57671 #: guix-git/doc/guix.texi:32367
57673 msgid "module, black-listing"
57677 #: guix-git/doc/guix.texi:32368
57679 msgid "black list, of kernel modules"
57683 #: guix-git/doc/guix.texi:32373
57684 msgid "Instruct the initial RAM disk as well as the @command{modprobe} command (from the kmod package) to refuse to load @var{modules}. @var{modules} must be a comma-separated list of module names---e.g., @code{usbkbd,9pnet}."
57688 #: guix-git/doc/guix.texi:32374
57694 #: guix-git/doc/guix.texi:32380
57695 msgid "Start a read-eval-print loop (REPL) from the initial RAM disk before it tries to load kernel modules and to mount the root file system. Our marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will love it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}, for more information on Guile's REPL."
57698 #. type: Plain text
57699 #: guix-git/doc/guix.texi:32386
57700 msgid "Now that you know all the features that initial RAM disks produced by @code{base-initrd} and @code{raw-initrd} provide, here is how to use it and customize it further."
57704 #: guix-git/doc/guix.texi:32389
57706 msgid "{Scheme Procedure} raw-initrd @var{file-systems} @"
57710 #: guix-git/doc/guix.texi:32403
57711 msgid "[#:linux-modules '()] [#:mapped-devices '()] @ [#:keyboard-layout #f] @ [#:helper-packages '()] [#:qemu-networking? #f] [#:volatile-root? #f] Return a derivation that builds a raw initrd. @var{file-systems} is a list of file systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @option{--root}. @var{linux-modules} is a list of kernel modules to be loaded at boot time. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted (@pxref{Mapped Devices}). @var{helper-packages} is a list of packages to be copied in the initrd. It may include @code{e2fsck/static} or other packages needed by the initrd to check the root file system."
57715 #: guix-git/doc/guix.texi:32409 guix-git/doc/guix.texi:32433
57716 msgid "When true, @var{keyboard-layout} is a @code{<keyboard-layout>} record denoting the desired console keyboard layout. This is done before @var{mapped-devices} are set up and before @var{file-systems} are mounted such that, should the user need to enter a passphrase or use the REPL, this happens using the intended keyboard layout."
57720 #: guix-git/doc/guix.texi:32413
57721 msgid "When @var{qemu-networking?} is true, set up networking with the standard QEMU parameters. When @var{virtio?} is true, load additional modules so that the initrd can be used as a QEMU guest with para-virtualized I/O drivers."
57725 #: guix-git/doc/guix.texi:32416
57726 msgid "When @var{volatile-root?} is true, the root file system is writable but any changes to it are lost."
57730 #: guix-git/doc/guix.texi:32418
57732 msgid "{Scheme Procedure} base-initrd @var{file-systems} @"
57736 #: guix-git/doc/guix.texi:32427
57737 msgid "[#:mapped-devices '()] [#:keyboard-layout #f] @ [#:qemu-networking? #f] [#:volatile-root? #f] @ [#:linux-modules '()] Return as a file-like object a generic initrd, with kernel modules taken from @var{linux}. @var{file-systems} is a list of file-systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @option{--root}. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted."
57741 #: guix-git/doc/guix.texi:32435
57742 msgid "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-initrd}."
57746 #: guix-git/doc/guix.texi:32440
57747 msgid "The initrd is automatically populated with all the kernel modules necessary for @var{file-systems} and for the given options. Additional kernel modules can be listed in @var{linux-modules}. They will be added to the initrd, and loaded at boot time in the order in which they appear."
57750 #. type: Plain text
57751 #: guix-git/doc/guix.texi:32447
57752 msgid "Needless to say, the initrds we produce and use embed a statically-linked Guile, and the initialization program is a Guile program. That gives a lot of flexibility. The @code{expression->initrd} procedure builds such an initrd, given the program to run in that initrd."
57756 #: guix-git/doc/guix.texi:32448
57758 msgid "{Scheme Procedure} expression->initrd @var{exp} @"
57762 #: guix-git/doc/guix.texi:32454
57763 msgid "[#:guile %guile-3.0-static-stripped] [#:name \"guile-initrd\"] Return as a file-like object a Linux initrd (a gzipped cpio archive) containing @var{guile} and that evaluates @var{exp}, a G-expression, upon booting. All the derivations referenced by @var{exp} are automatically copied to the initrd."
57767 #: guix-git/doc/guix.texi:32460
57769 msgid "boot loader"
57772 #. type: Plain text
57773 #: guix-git/doc/guix.texi:32467
57774 msgid "The operating system supports multiple bootloaders. The bootloader is configured using @code{bootloader-configuration} declaration. All the fields of this structure are bootloader agnostic except for one field, @code{bootloader} that indicates the bootloader to be configured and installed."
57777 #. type: Plain text
57778 #: guix-git/doc/guix.texi:32472
57779 msgid "Some of the bootloaders do not honor every field of @code{bootloader-configuration}. For instance, the extlinux bootloader does not support themes and thus ignores the @code{theme} field."
57783 #: guix-git/doc/guix.texi:32473
57785 msgid "{Data Type} bootloader-configuration"
57789 #: guix-git/doc/guix.texi:32475
57790 msgid "The type of a bootloader configuration declaration."
57794 #: guix-git/doc/guix.texi:32479
57796 msgid "EFI, bootloader"
57800 #: guix-git/doc/guix.texi:32480
57802 msgid "UEFI, bootloader"
57806 #: guix-git/doc/guix.texi:32481
57808 msgid "BIOS, bootloader"
57812 #: guix-git/doc/guix.texi:32486
57813 msgid "The bootloader to use, as a @code{bootloader} object. For now @code{grub-bootloader}, @code{grub-efi-bootloader}, @code{grub-efi-netboot-bootloader}, @code{extlinux-bootloader} and @code{u-boot-bootloader} are supported."
57817 #: guix-git/doc/guix.texi:32487
57819 msgid "ARM, bootloaders"
57823 #: guix-git/doc/guix.texi:32488
57825 msgid "AArch64, bootloaders"
57829 #: guix-git/doc/guix.texi:32493
57830 msgid "Available bootloaders are described in @code{(gnu bootloader @dots{})} modules. In particular, @code{(gnu bootloader u-boot)} contains definitions of bootloaders for a wide range of ARM and AArch64 systems, using the @uref{https://www.denx.de/wiki/U-Boot/, U-Boot bootloader}."
57834 #: guix-git/doc/guix.texi:32499
57835 msgid "@code{grub-efi-bootloader} allows to boot on modern systems using the @dfn{Unified Extensible Firmware Interface} (UEFI). This is what you should use if the installation image contains a @file{/sys/firmware/efi} directory when you boot it on your system."
57839 #: guix-git/doc/guix.texi:32503
57840 msgid "@code{grub-bootloader} allows you to boot in particular Intel-based machines in ``legacy'' BIOS mode."
57844 #: guix-git/doc/guix.texi:32504
57846 msgid "grub-efi-netboot-bootloader"
57850 #: guix-git/doc/guix.texi:32508
57851 msgid "@code{grub-efi-netboot-bootloader} allows you to boot your system over network through TFTP@. In combination with an NFS root file system this allows you to build a diskless Guix system."
57855 #: guix-git/doc/guix.texi:32514
57856 msgid "The installation of the @code{grub-efi-netboot-bootloader} generates the content of the TFTP root directory at @code{target} (@pxref{Bootloader Configuration, @code{target}}), to be served by a TFTP server. You may want to mount your TFTP server directory onto @code{target} to move the required files to the TFTP server automatically."
57860 #: guix-git/doc/guix.texi:32523
57861 msgid "If you plan to use an NFS root file system as well (actually if you mount the store from an NFS share), then the TFTP server needs to serve the file @file{/boot/grub/grub.cfg} and other files from the store (like GRUBs background image, the kernel (@pxref{operating-system Reference, @code{kernel}}) and the initrd (@pxref{operating-system Reference, @code{initrd}})), too. All these files from the store will be accessed by GRUB through TFTP with their normal store path, for example as @file{tftp://tftp-server/gnu/store/…-initrd/initrd.cpio.gz}."
57865 #: guix-git/doc/guix.texi:32531
57866 msgid "Two symlinks are created to make this possible. The first symlink is @code{target}@file{/efi/Guix/boot/grub/grub.cfg} pointing to @file{../../../boot/grub/grub.cfg}, where @code{target} may be @file{/boot}. In this case the link is not leaving the served TFTP root directory, but otherwise it does. The second link is @code{target}@file{/gnu/store} and points to @file{../gnu/store}. This link is leaving the served TFTP root directory."
57870 #: guix-git/doc/guix.texi:32536
57871 msgid "The assumption behind all this is that you have an NFS server exporting the root file system for your Guix system, and additionally a TFTP server exporting your @code{target} directory—usually @file{/boot}—from that same root file system for your Guix system. In this constellation the symlinks will work."
57875 #: guix-git/doc/guix.texi:32540
57876 msgid "For other constellations you will have to program your own bootloader installer, which then takes care to make necessary files from the store accessible through TFTP, for example by copying them into the TFTP root directory at @code{target}."
57880 #: guix-git/doc/guix.texi:32545
57881 msgid "It is important to note that symlinks pointing outside the TFTP root directory may need to be allowed in the configuration of your TFTP server. Further the store link exposes the whole store through TFTP@. Both points need to be considered carefully for security aspects."
57885 #: guix-git/doc/guix.texi:32550
57886 msgid "Beside the @code{grub-efi-netboot-bootloader}, the already mentioned TFTP and NFS servers, you also need a properly configured DHCP server to make the booting over netboot possible. For all this we can currently only recommend you to look for instructions about @acronym{PXE, Preboot eXecution Environment}."
57890 #: guix-git/doc/guix.texi:32554
57891 msgid "This is a string denoting the target onto which to install the bootloader."
57895 #: guix-git/doc/guix.texi:32563
57896 msgid "The interpretation depends on the bootloader in question. For @code{grub-bootloader}, for example, it should be a device name understood by the bootloader @command{installer} command, such as @code{/dev/sda} or @code{(hd0)} (@pxref{Invoking grub-install,,, grub, GNU GRUB Manual}). For @code{grub-efi-bootloader}, it should be the mount point of the EFI file system, usually @file{/boot/efi}. For @code{grub-efi-netboot-bootloader}, @code{target} should be the mount point corresponding to the TFTP root directory of your TFTP server."
57900 #: guix-git/doc/guix.texi:32564
57902 msgid "@code{menu-entries} (default: @code{()})"
57906 #: guix-git/doc/guix.texi:32568
57907 msgid "A possibly empty list of @code{menu-entry} objects (see below), denoting entries to appear in the bootloader menu, in addition to the current system entry and the entry pointing to previous system generations."
57911 #: guix-git/doc/guix.texi:32569
57913 msgid "@code{default-entry} (default: @code{0})"
57917 #: guix-git/doc/guix.texi:32572
57918 msgid "The index of the default boot menu entry. Index 0 is for the entry of the current system."
57922 #: guix-git/doc/guix.texi:32573
57924 msgid "@code{timeout} (default: @code{5})"
57928 #: guix-git/doc/guix.texi:32576
57929 msgid "The number of seconds to wait for keyboard input before booting. Set to 0 to boot immediately, and to -1 to wait indefinitely."
57933 #: guix-git/doc/guix.texi:32577
57935 msgid "keyboard layout, for the bootloader"
57939 #: guix-git/doc/guix.texi:32581
57940 msgid "If this is @code{#f}, the bootloader's menu (if any) uses the default keyboard layout, usually US@tie{}English (``qwerty'')."
57944 #: guix-git/doc/guix.texi:32584
57945 msgid "Otherwise, this must be a @code{keyboard-layout} object (@pxref{Keyboard Layout})."
57949 #: guix-git/doc/guix.texi:32588
57950 msgid "This option is currently ignored by bootloaders other than @code{grub} and @code{grub-efi}."
57954 #: guix-git/doc/guix.texi:32590
57956 msgid "@code{theme} (default: @var{#f})"
57960 #: guix-git/doc/guix.texi:32594
57961 msgid "The bootloader theme object describing the theme to use. If no theme is provided, some bootloaders might use a default theme, that's true for GRUB."
57965 #: guix-git/doc/guix.texi:32595
57967 msgid "@code{terminal-outputs} (default: @code{'(gfxterm)})"
57971 #: guix-git/doc/guix.texi:32602
57972 msgid "The output terminals used for the bootloader boot menu, as a list of symbols. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, @code{morse}, and @code{pkmodem}. This field corresponds to the GRUB variable @code{GRUB_TERMINAL_OUTPUT} (@pxref{Simple configuration,,, grub,GNU GRUB manual})."
57976 #: guix-git/doc/guix.texi:32603
57978 msgid "@code{terminal-inputs} (default: @code{'()})"
57982 #: guix-git/doc/guix.texi:32611
57983 msgid "The input terminals used for the bootloader boot menu, as a list of symbols. For GRUB, the default is the native platform terminal as determined at run-time. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and @code{usb_keyboard}. This field corresponds to the GRUB variable @code{GRUB_TERMINAL_INPUT} (@pxref{Simple configuration,,, grub,GNU GRUB manual})."
57987 #: guix-git/doc/guix.texi:32612
57989 msgid "@code{serial-unit} (default: @code{#f})"
57993 #: guix-git/doc/guix.texi:32616
57994 msgid "The serial unit used by the bootloader, as an integer from 0 to 3. For GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual})."
57998 #: guix-git/doc/guix.texi:32617
58000 msgid "@code{serial-speed} (default: @code{#f})"
58004 #: guix-git/doc/guix.texi:32621
58005 msgid "The speed of the serial interface, as an integer. For GRUB, the default value is chosen at run-time; currently GRUB chooses 9600@tie{}bps (@pxref{Serial terminal,,, grub,GNU GRUB manual})."
58009 #: guix-git/doc/guix.texi:32625
58015 #: guix-git/doc/guix.texi:32626
58020 #. type: Plain text
58021 #: guix-git/doc/guix.texi:32632
58022 msgid "Should you want to list additional boot menu entries @i{via} the @code{menu-entries} field above, you will need to create them with the @code{menu-entry} form. For example, imagine you want to be able to boot another distro (hard to imagine!), you can define a menu entry along these lines:"
58026 #: guix-git/doc/guix.texi:32639
58030 " (label \"The Other Distro\")\n"
58031 " (linux \"/boot/old/vmlinux-2.6.32\")\n"
58032 " (linux-arguments '(\"root=/dev/sda2\"))\n"
58033 " (initrd \"/boot/old/initrd\"))\n"
58036 #. type: Plain text
58037 #: guix-git/doc/guix.texi:32642
58038 msgid "Details below."
58042 #: guix-git/doc/guix.texi:32643
58044 msgid "{Data Type} menu-entry"
58048 #: guix-git/doc/guix.texi:32645
58049 msgid "The type of an entry in the bootloader menu."
58053 #: guix-git/doc/guix.texi:32650
58054 msgid "The label to show in the menu---e.g., @code{\"GNU\"}."
58058 #: guix-git/doc/guix.texi:32651
58060 msgid "@code{linux} (default: @code{#f})"
58064 #: guix-git/doc/guix.texi:32653
58065 msgid "The Linux kernel image to boot, for example:"
58069 #: guix-git/doc/guix.texi:32656
58071 msgid "(file-append linux-libre \"/bzImage\")\n"
58075 #: guix-git/doc/guix.texi:32661
58076 msgid "For GRUB, it is also possible to specify a device explicitly in the file path using GRUB's device naming convention (@pxref{Naming convention,,, grub, GNU GRUB manual}), for example:"
58080 #: guix-git/doc/guix.texi:32664
58082 msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n"
58086 #: guix-git/doc/guix.texi:32668
58087 msgid "If the device is specified explicitly as above, then the @code{device} field is ignored entirely."
58091 #: guix-git/doc/guix.texi:32669
58093 msgid "@code{linux-arguments} (default: @code{()})"
58097 #: guix-git/doc/guix.texi:32672
58098 msgid "The list of extra Linux kernel command-line arguments---e.g., @code{(\"console=ttyS0\")}."
58102 #: guix-git/doc/guix.texi:32673
58104 msgid "@code{initrd} (default: @code{#f})"
58108 #: guix-git/doc/guix.texi:32676
58109 msgid "A G-Expression or string denoting the file name of the initial RAM disk to use (@pxref{G-Expressions})."
58113 #: guix-git/doc/guix.texi:32677
58115 msgid "@code{device} (default: @code{#f})"
58119 #: guix-git/doc/guix.texi:32680
58120 msgid "The device where the kernel and initrd are to be found---i.e., for GRUB, @dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual})."
58124 #: guix-git/doc/guix.texi:32686
58125 msgid "This may be a file system label (a string), a file system UUID (a bytevector, @pxref{File Systems}), or @code{#f}, in which case the bootloader will search the device containing the file specified by the @code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It must @emph{not} be an OS device name such as @file{/dev/sda1}."
58129 #: guix-git/doc/guix.texi:32687
58131 msgid "@code{multiboot-kernel} (default: @code{#f})"
58135 #: guix-git/doc/guix.texi:32691
58136 msgid "The kernel to boot in Multiboot-mode (@pxref{multiboot,,, grub, GNU GRUB manual}). When this field is set, a Multiboot menu-entry is generated. For example:"
58140 #: guix-git/doc/guix.texi:32694
58142 msgid "(file-append mach \"/boot/gnumach\")\n"
58146 #: guix-git/doc/guix.texi:32696
58148 msgid "@code{multiboot-arguments} (default: @code{()})"
58152 #: guix-git/doc/guix.texi:32698
58153 msgid "The list of extra command-line arguments for the multiboot-kernel."
58157 #: guix-git/doc/guix.texi:32699
58159 msgid "@code{multiboot-modules} (default: @code{()})"
58163 #: guix-git/doc/guix.texi:32701
58164 msgid "The list of commands for loading Multiboot modules. For example:"
58168 #: guix-git/doc/guix.texi:32707
58171 "(list (list (file-append hurd \"/hurd/ext2fs.static\") \"ext2fs\"\n"
58173 " (list (file-append libc \"/lib/ld.so.1\") \"exec\"\n"
58178 #: guix-git/doc/guix.texi:32712 guix-git/doc/guix.texi:32771
58184 #: guix-git/doc/guix.texi:32713 guix-git/doc/guix.texi:32772
58190 #: guix-git/doc/guix.texi:32714 guix-git/doc/guix.texi:32773
58195 #. type: Plain text
58196 #: guix-git/doc/guix.texi:32718
58197 msgid "For now only GRUB has theme support. GRUB themes are created using the @code{grub-theme} form, which is not fully documented yet."
58201 #: guix-git/doc/guix.texi:32719
58203 msgid "{Data Type} grub-theme"
58207 #: guix-git/doc/guix.texi:32721
58208 msgid "Data type representing the configuration of the GRUB theme."
58212 #: guix-git/doc/guix.texi:32723
58214 msgid "@code{gfxmode} (default: @code{'(\"auto\")})"
58218 #: guix-git/doc/guix.texi:32726
58219 msgid "The GRUB @code{gfxmode} to set (a list of screen resolution strings, @pxref{gfxmode,,, grub, GNU GRUB manual})."
58223 #: guix-git/doc/guix.texi:32729
58225 msgid "{Scheme Procedure} grub-theme"
58229 #: guix-git/doc/guix.texi:32733
58230 msgid "Return the default GRUB theme used by the operating system if no @code{theme} field is specified in @code{bootloader-configuration} record."
58234 #: guix-git/doc/guix.texi:32736
58235 msgid "It comes with a fancy background image displaying the GNU and Guix logos."
58238 #. type: Plain text
58239 #: guix-git/doc/guix.texi:32740
58240 msgid "For example, to override the default resolution, you may use something like"
58244 #: guix-git/doc/guix.texi:32748
58248 " (bootloader-configuration\n"
58250 " (theme (grub-theme\n"
58251 " (inherit (grub-theme))\n"
58252 " (gfxmode '(\"1024x786x32\" \"auto\"))))))\n"
58256 #: guix-git/doc/guix.texi:32751
58258 msgid "Invoking @code{guix system}"
58261 #. type: Plain text
58262 #: guix-git/doc/guix.texi:32756
58263 msgid "Once you have written an operating system declaration as seen in the previous section, it can be @dfn{instantiated} using the @command{guix system} command. The synopsis is:"
58267 #: guix-git/doc/guix.texi:32759
58269 msgid "guix system @var{options}@dots{} @var{action} @var{file}\n"
58272 #. type: Plain text
58273 #: guix-git/doc/guix.texi:32765
58274 msgid "@var{file} must be the name of a file containing an @code{operating-system} declaration. @var{action} specifies how the operating system is instantiated. Currently the following values are supported:"
58278 #: guix-git/doc/guix.texi:32767
58284 #: guix-git/doc/guix.texi:32770
58285 msgid "Display available service type definitions that match the given regular expressions, sorted by relevance:"
58289 #: guix-git/doc/guix.texi:32792
58292 "$ guix system search console\n"
58293 "name: console-fonts\n"
58294 "location: gnu/services/base.scm:806:2\n"
58295 "extends: shepherd-root\n"
58296 "description: Install the given fonts on the specified ttys (fonts are per\n"
58297 "+ virtual console on GNU/Linux). The value of this service is a list of\n"
58298 "+ tty/font pairs. The font can be the name of a font provided by the `kbd'\n"
58299 "+ package or any valid argument to `setfont', as in this example:\n"
58301 "+ '((\"tty1\" . \"LatGrkCyr-8x16\")\n"
58302 "+ (\"tty2\" . (file-append\n"
58304 "+ \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
58305 "+ (\"tty3\" . (file-append\n"
58306 "+ font-terminus\n"
58307 "+ \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
58313 #: guix-git/doc/guix.texi:32798
58317 "location: gnu/services/base.scm:1190:2\n"
58318 "extends: shepherd-root\n"
58319 "description: Provide console login using the `mingetty' program.\n"
58325 #: guix-git/doc/guix.texi:32805
58329 "location: gnu/services/base.scm:860:2\n"
58331 "description: Provide a console log-in service as specified by its\n"
58332 "+ configuration value, a `login-configuration' object.\n"
58338 #: guix-git/doc/guix.texi:32807
58344 #: guix-git/doc/guix.texi:32812
58345 msgid "As for @command{guix package --search}, the result is written in @code{recutils} format, which makes it easy to filter the output (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})."
58349 #: guix-git/doc/guix.texi:32813
58351 msgid "reconfigure"
58355 #: guix-git/doc/guix.texi:32818
58356 msgid "Build the operating system described in @var{file}, activate it, and switch to it@footnote{This action (and the related actions @code{switch-generation} and @code{roll-back}) are usable only on systems already running Guix System.}."
58360 #: guix-git/doc/guix.texi:32826
58361 msgid "It is highly recommended to run @command{guix pull} once before you run @command{guix system reconfigure} for the first time (@pxref{Invoking guix pull}). Failing to do that you would see an older version of Guix once @command{reconfigure} has completed."
58365 #: guix-git/doc/guix.texi:32834
58366 msgid "This effects all the configuration specified in @var{file}: user accounts, system services, global package list, setuid programs, etc. The command starts system services specified in @var{file} that are not currently running; if a service is currently running this command will arrange for it to be upgraded the next time it is stopped (e.g.@: by @code{herd stop X} or @code{herd restart X})."
58370 #: guix-git/doc/guix.texi:32840
58371 msgid "This command creates a new generation whose number is one greater than the current generation (as reported by @command{guix system list-generations}). If that generation already exists, it will be overwritten. This behavior mirrors that of @command{guix package} (@pxref{Invoking guix package})."
58375 #: guix-git/doc/guix.texi:32845
58376 msgid "It also adds a bootloader menu entry for the new OS configuration, ---unless @option{--no-bootloader} is passed. For GRUB, it moves entries for older configurations to a submenu, allowing you to choose an older system generation at boot time should you need it."
58380 #: guix-git/doc/guix.texi:32846 guix-git/doc/guix.texi:33171
58381 #: guix-git/doc/guix.texi:34119
58383 msgid "provenance tracking, of the operating system"
58387 #: guix-git/doc/guix.texi:32851
58388 msgid "Upon completion, the new system is deployed under @file{/run/current-system}. This directory contains @dfn{provenance meta-data}: the list of channels in use (@pxref{Channels}) and @var{file} itself, when available. You can view it by running:"
58392 #: guix-git/doc/guix.texi:32854
58394 msgid "guix system describe\n"
58398 #: guix-git/doc/guix.texi:32860
58399 msgid "This information is useful should you later want to inspect how this particular generation was built. In fact, assuming @var{file} is self-contained, you can later rebuild generation @var{n} of your operating system with:"
58403 #: guix-git/doc/guix.texi:32866
58406 "guix time-machine \\\n"
58407 " -C /var/guix/profiles/system-@var{n}-link/channels.scm -- \\\n"
58408 " system reconfigure \\\n"
58409 " /var/guix/profiles/system-@var{n}-link/configuration.scm\n"
58413 #: guix-git/doc/guix.texi:32872
58414 msgid "You can think of it as some sort of built-in version control! Your system is not just a binary artifact: @emph{it carries its own source}. @xref{Service Reference, @code{provenance-service-type}}, for more information on provenance tracking."
58418 #: guix-git/doc/guix.texi:32878
58419 msgid "By default, @command{reconfigure} @emph{prevents you from downgrading your system}, which could (re)introduce security vulnerabilities and also cause problems with ``stateful'' services such as database management systems. You can override that behavior by passing @option{--allow-downgrades}."
58423 #: guix-git/doc/guix.texi:32879
58425 msgid "switch-generation"
58429 #: guix-git/doc/guix.texi:32888
58430 msgid "Switch to an existing system generation. This action atomically switches the system profile to the specified system generation. It also rearranges the system's existing bootloader menu entries. It makes the menu entry for the specified system generation the default, and it moves the entries for the other generations to a submenu, if supported by the bootloader being used. The next time the system boots, it will use the specified system generation."
58434 #: guix-git/doc/guix.texi:32892
58435 msgid "The bootloader itself is not being reinstalled when using this command. Thus, the installed bootloader is used with an updated configuration file."
58439 #: guix-git/doc/guix.texi:32896
58440 msgid "The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to system generation 7:"
58444 #: guix-git/doc/guix.texi:32899
58446 msgid "guix system switch-generation 7\n"
58450 #: guix-git/doc/guix.texi:32907
58451 msgid "The target generation can also be specified relative to the current generation with the form @code{+N} or @code{-N}, where @code{+3} means ``3 generations ahead of the current generation,'' and @code{-1} means ``1 generation prior to the current generation.'' When specifying a negative value such as @code{-1}, you must precede it with @code{--} to prevent it from being parsed as an option. For example:"
58455 #: guix-git/doc/guix.texi:32910
58457 msgid "guix system switch-generation -- -1\n"
58461 #: guix-git/doc/guix.texi:32918
58462 msgid "Currently, the effect of invoking this action is @emph{only} to switch the system profile to an existing generation and rearrange the bootloader menu entries. To actually start using the target system generation, you must reboot after running this action. In the future, it will be updated to do the same things as @command{reconfigure}, like activating and deactivating services."
58466 #: guix-git/doc/guix.texi:32920
58467 msgid "This action will fail if the specified generation does not exist."
58471 #: guix-git/doc/guix.texi:32921
58477 #: guix-git/doc/guix.texi:32927
58478 msgid "Switch to the preceding system generation. The next time the system boots, it will use the preceding system generation. This is the inverse of @command{reconfigure}, and it is exactly the same as invoking @command{switch-generation} with an argument of @code{-1}."
58482 #: guix-git/doc/guix.texi:32931
58483 msgid "Currently, as with @command{switch-generation}, you must reboot after running this action to actually start using the preceding system generation."
58487 #: guix-git/doc/guix.texi:32932
58489 msgid "delete-generations"
58493 #: guix-git/doc/guix.texi:32933
58495 msgid "deleting system generations"
58499 #: guix-git/doc/guix.texi:32934
58501 msgid "saving space"
58505 #: guix-git/doc/guix.texi:32938
58506 msgid "Delete system generations, making them candidates for garbage collection (@pxref{Invoking guix gc}, for information on how to run the ``garbage collector'')."
58510 #: guix-git/doc/guix.texi:32942
58511 msgid "This works in the same way as @samp{guix package --delete-generations} (@pxref{Invoking guix package, @option{--delete-generations}}). With no arguments, all system generations but the current one are deleted:"
58515 #: guix-git/doc/guix.texi:32945
58517 msgid "guix system delete-generations\n"
58521 #: guix-git/doc/guix.texi:32949
58522 msgid "You can also select the generations you want to delete. The example below deletes all the system generations that are more than two month old:"
58526 #: guix-git/doc/guix.texi:32952
58528 msgid "guix system delete-generations 2m\n"
58532 #: guix-git/doc/guix.texi:32957
58533 msgid "Running this command automatically reinstalls the bootloader with an updated list of menu entries---e.g., the ``old generations'' sub-menu in GRUB no longer lists the generations that have been deleted."
58537 #: guix-git/doc/guix.texi:32962
58538 msgid "Build the derivation of the operating system, which includes all the configuration files and programs needed to boot and run the system. This action does not actually install anything."
58542 #: guix-git/doc/guix.texi:32963
58548 #: guix-git/doc/guix.texi:32967
58549 msgid "Populate the given directory with all the files necessary to run the operating system specified in @var{file}. This is useful for first-time installations of Guix System. For instance:"
58553 #: guix-git/doc/guix.texi:32970
58555 msgid "guix system init my-os-config.scm /mnt\n"
58559 #: guix-git/doc/guix.texi:32977
58560 msgid "copies to @file{/mnt} all the store items required by the configuration specified in @file{my-os-config.scm}. This includes configuration files, packages, and so on. It also creates other essential files needed for the system to operate correctly---e.g., the @file{/etc}, @file{/var}, and @file{/run} directories, and the @file{/bin/sh} file."
58564 #: guix-git/doc/guix.texi:32981
58565 msgid "This command also installs bootloader on the target specified in @file{my-os-config}, unless the @option{--no-bootloader} option was passed."
58569 #: guix-git/doc/guix.texi:32982
58575 #: guix-git/doc/guix.texi:32983 guix-git/doc/guix.texi:33544
58577 msgid "virtual machine"
58581 #: guix-git/doc/guix.texi:32984
58586 #. type: anchor{#1}
58587 #: guix-git/doc/guix.texi:32988
58588 msgid "guix system vm"
58592 #: guix-git/doc/guix.texi:32988
58593 msgid "Build a virtual machine that contains the operating system declared in @var{file}, and return a script to run that virtual machine (VM)."
58597 #: guix-git/doc/guix.texi:32996
58598 msgid "The @code{vm} action and others below can use KVM support in the Linux-libre kernel. Specifically, if the machine has hardware virtualization support, the corresponding KVM kernel module should be loaded, and the @file{/dev/kvm} device node must exist and be readable and writable by the user and by the build users of the daemon (@pxref{Build Environment Setup})."
58602 #: guix-git/doc/guix.texi:33001
58603 msgid "Arguments given to the script are passed to QEMU as in the example below, which enables networking and requests 1@tie{}GiB of RAM for the emulated machine:"
58607 #: guix-git/doc/guix.texi:33004
58609 msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -smp 2 -net user,model=virtio-net-pci\n"
58613 #: guix-git/doc/guix.texi:33007
58614 msgid "The VM shares its store with the host system."
58618 #: guix-git/doc/guix.texi:33012
58619 msgid "Additional file systems can be shared between the host and the VM using the @option{--share} and @option{--expose} command-line options: the former specifies a directory to be shared with write access, while the latter provides read-only access to the shared directory."
58623 #: guix-git/doc/guix.texi:33016
58624 msgid "The example below creates a VM in which the user's home directory is accessible read-only, and where the @file{/exchange} directory is a read-write mapping of @file{$HOME/tmp} on the host:"
58628 #: guix-git/doc/guix.texi:33020
58631 "guix system vm my-config.scm \\\n"
58632 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58636 #: guix-git/doc/guix.texi:33025
58637 msgid "On GNU/Linux, the default is to boot directly to the kernel; this has the advantage of requiring only a very tiny root disk image since the store of the host can then be mounted."
58641 #: guix-git/doc/guix.texi:33031
58642 msgid "The @option{--full-boot} option forces a complete boot sequence, starting with the bootloader. This requires more disk space since a root image containing at least the kernel, initrd, and bootloader data files must be created. The @option{--image-size} option can be used to specify the size of the image."
58646 #: guix-git/doc/guix.texi:33032
58648 msgid "System images, creation in various formats"
58652 #: guix-git/doc/guix.texi:33033
58654 msgid "Creating system images in various formats"
58658 #: guix-git/doc/guix.texi:33034
58664 #: guix-git/doc/guix.texi:33035
58666 msgid "docker-image"
58670 #: guix-git/doc/guix.texi:33043
58671 msgid "Return a virtual machine, disk image, or Docker image of the operating system declared in @var{file} that stands alone. By default, @command{guix system} estimates the size of the image needed to store the system, but you can use the @option{--image-size} option to specify a value. Docker images are built to contain exactly what they need, so the @option{--image-size} option is ignored in the case of @code{docker-image}."
58675 #: guix-git/doc/guix.texi:33044
58677 msgid "image, creating disk images"
58681 #: guix-git/doc/guix.texi:33056
58682 msgid "The @code{image} command can produce various image types. The image type can be selected using the @option{--image-type} option. It defaults to @code{efi-raw}. When its value is @code{iso9660}, the @option{--label} option can be used to specify a volume ID with @code{image}. By default, the root file system of a disk image is mounted non-volatile; the @option{--volatile} option can be provided to make it volatile instead. When using @code{image}, the bootloader installed on the generated image is taken from the provided @code{operating-system} definition. The following example demonstrates how to generate an image that uses the @code{grub-efi-bootloader} bootloader and boot it with QEMU:"
58686 #: guix-git/doc/guix.texi:33064
58689 "image=$(guix system image --image-type=qcow2 \\\n"
58690 " gnu/system/examples/lightweight-desktop.tmpl)\n"
58691 "cp $image /tmp/my-image.qcow2\n"
58692 "chmod +w /tmp/my-image.qcow2\n"
58693 "qemu-system-x86_64 -enable-kvm -hda /tmp/my-image.qcow2 -m 1000 \\\n"
58694 " -bios $(guix build ovmf)/share/firmware/ovmf_x64.bin\n"
58698 #: guix-git/doc/guix.texi:33070
58699 msgid "When using the @code{efi-raw} image type, a raw disk image is produced; it can be copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is the device corresponding to a USB stick, one can copy the image to it using the following command:"
58703 #: guix-git/doc/guix.texi:33073
58705 msgid "# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress\n"
58709 #: guix-git/doc/guix.texi:33077
58710 msgid "The @code{--list-image-types} command lists all the available image types."
58714 #: guix-git/doc/guix.texi:33078
58716 msgid "creating virtual machine images"
58720 #: guix-git/doc/guix.texi:33087
58721 msgid "When using the @code{qcow2} image type, the returned image is in qcow2 format, which the QEMU emulator can efficiently use. @xref{Running Guix in a VM}, for more information on how to run the image in a virtual machine. The @code{grub-bootloader} bootloader is always used independently of what is declared in the @code{operating-system} file passed as argument. This is to make it easier to work with QEMU, which uses the SeaBIOS BIOS by default, expecting a bootloader to be installed in the Master Boot Record (MBR)."
58725 #: guix-git/doc/guix.texi:33088
58727 msgid "docker-image, creating docker images"
58731 #: guix-git/doc/guix.texi:33094
58732 msgid "When using @code{docker-image}, a Docker image is produced. Guix builds the image from scratch, not from a pre-existing Docker base image. As a result, it contains @emph{exactly} what you define in the operating system configuration file. You can then load the image and launch a Docker container using commands like the following:"
58736 #: guix-git/doc/guix.texi:33099
58739 "image_id=\"$(docker load < guix-system-docker-image.tar.gz)\"\n"
58740 "container_id=\"$(docker create $image_id)\"\n"
58741 "docker start $container_id\n"
58745 #: guix-git/doc/guix.texi:33106
58746 msgid "This command starts a new Docker container from the specified image. It will boot the Guix system in the usual manner, which means it will start any services you have defined in the operating system configuration. You can get an interactive shell running in the container using @command{docker exec}:"
58750 #: guix-git/doc/guix.texi:33109
58752 msgid "docker exec -ti $container_id /run/current-system/profile/bin/bash --login\n"
58756 #: guix-git/doc/guix.texi:33116
58757 msgid "Depending on what you run in the Docker container, it may be necessary to give the container additional permissions. For example, if you intend to build software using Guix inside of the Docker container, you may need to pass the @option{--privileged} option to @code{docker create}."
58761 #: guix-git/doc/guix.texi:33120
58762 msgid "Last, the @option{--network} option applies to @command{guix system docker-image}: it produces an image where network is supposedly shared with the host, and thus without services like nscd or NetworkManager."
58766 #: guix-git/doc/guix.texi:33128
58767 msgid "Return a script to run the operating system declared in @var{file} within a container. Containers are a set of lightweight isolation mechanisms provided by the kernel Linux-libre. Containers are substantially less resource-demanding than full virtual machines since the kernel, shared objects, and other resources can be shared with the host system; this also means they provide thinner isolation."
58771 #: guix-git/doc/guix.texi:33132
58772 msgid "Currently, the script must be run as root in order to support more than a single user and group. The container shares its store with the host system."
58776 #: guix-git/doc/guix.texi:33136
58777 msgid "As with the @code{vm} action (@pxref{guix system vm}), additional file systems to be shared between the host and container can be specified using the @option{--share} and @option{--expose} options:"
58781 #: guix-git/doc/guix.texi:33140
58784 "guix system container my-config.scm \\\n"
58785 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58789 #: guix-git/doc/guix.texi:33144
58790 msgid "This option requires Linux-libre 3.19 or newer."
58793 #. type: Plain text
58794 #: guix-git/doc/guix.texi:33151
58795 msgid "@var{options} can contain any of the common build options (@pxref{Common Build Options}). In addition, @var{options} can contain one of the following:"
58799 #: guix-git/doc/guix.texi:33160
58800 msgid "Consider the operating-system @var{expr} evaluates to. This is an alternative to specifying a file which evaluates to an operating system. This is used to generate the Guix system installer @pxref{Building the Installation Image})."
58804 #: guix-git/doc/guix.texi:33165
58805 msgid "Attempt to build for @var{system} instead of the host system type. This works as per @command{guix build} (@pxref{Invoking guix build})."
58809 #: guix-git/doc/guix.texi:33170
58810 msgid "Return the derivation file name of the given operating system without building anything."
58814 #: guix-git/doc/guix.texi:33179
58815 msgid "As discussed above, @command{guix system init} and @command{guix system reconfigure} always save provenance information @i{via} a dedicated service (@pxref{Service Reference, @code{provenance-service-type}}). However, other commands don't do that by default. If you wish to, say, create a virtual machine image that contains provenance information, you can run:"
58819 #: guix-git/doc/guix.texi:33182
58821 msgid "guix system image -t qcow2 --save-provenance config.scm\n"
58825 #: guix-git/doc/guix.texi:33189
58826 msgid "That way, the resulting image will effectively ``embed its own source'' in the form of meta-data in @file{/run/current-system}. With that information, one can rebuild the image to make sure it really contains what it pretends to contain; or they could use that to derive a variant of the image."
58830 #: guix-git/doc/guix.texi:33190
58832 msgid "--image-type=@var{type}"
58836 #: guix-git/doc/guix.texi:33193
58837 msgid "For the @code{image} action, create an image with given @var{type}."
58841 #: guix-git/doc/guix.texi:33196
58842 msgid "When this option is omitted, @command{guix system} uses the @code{efi-raw} image type."
58846 #: guix-git/doc/guix.texi:33197
58848 msgid "ISO-9660 format"
58852 #: guix-git/doc/guix.texi:33198
58854 msgid "CD image format"
58858 #: guix-git/doc/guix.texi:33199
58860 msgid "DVD image format"
58864 #: guix-git/doc/guix.texi:33202
58865 msgid "@option{--image-type=iso9660} produces an ISO-9660 image, suitable for burning on CDs and DVDs."
58869 #: guix-git/doc/guix.texi:33203
58871 msgid "--image-size=@var{size}"
58875 #: guix-git/doc/guix.texi:33208
58876 msgid "For the @code{image} action, create an image of the given @var{size}. @var{size} may be a number of bytes, or it may include a unit as a suffix (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})."
58880 #: guix-git/doc/guix.texi:33212
58881 msgid "When this option is omitted, @command{guix system} computes an estimate of the image size as a function of the size of the system declared in @var{file}."
58885 #: guix-git/doc/guix.texi:33217
58886 msgid "For the @code{container} action, allow containers to access the host network, that is, do not create a network namespace."
58890 #: guix-git/doc/guix.texi:33223
58892 msgid "--skip-checks"
58896 #: guix-git/doc/guix.texi:33225
58897 msgid "Skip pre-installation safety checks."
58901 #: guix-git/doc/guix.texi:33232
58902 msgid "By default, @command{guix system init} and @command{guix system reconfigure} perform safety checks: they make sure the file systems that appear in the @code{operating-system} declaration actually exist (@pxref{File Systems}), and that any Linux kernel modules that may be needed at boot time are listed in @code{initrd-modules} (@pxref{Initial RAM Disk}). Passing this option skips these tests altogether."
58906 #: guix-git/doc/guix.texi:33235
58907 msgid "Instruct @command{guix system reconfigure} to allow system downgrades."
58911 #: guix-git/doc/guix.texi:33243
58912 msgid "By default, @command{reconfigure} prevents you from downgrading your system. It achieves that by comparing the provenance info of your system (shown by @command{guix system describe}) with that of your @command{guix} command (shown by @command{guix describe}). If the commits for @command{guix} are not descendants of those used for your system, @command{guix system reconfigure} errors out. Passing @option{--allow-downgrades} allows you to bypass these checks."
58916 #: guix-git/doc/guix.texi:33249
58922 #: guix-git/doc/guix.texi:33250
58924 msgid "on-error strategy"
58928 #: guix-git/doc/guix.texi:33251
58930 msgid "error strategy"
58934 #: guix-git/doc/guix.texi:33252
58936 msgid "--on-error=@var{strategy}"
58940 #: guix-git/doc/guix.texi:33255
58941 msgid "Apply @var{strategy} when an error occurs when reading @var{file}. @var{strategy} may be one of the following:"
58945 #: guix-git/doc/guix.texi:33257
58947 msgid "nothing-special"
58951 #: guix-git/doc/guix.texi:33259
58952 msgid "Report the error concisely and exit. This is the default strategy."
58956 #: guix-git/doc/guix.texi:33260
58962 #: guix-git/doc/guix.texi:33262
58963 msgid "Likewise, but also display a backtrace."
58967 #: guix-git/doc/guix.texi:33263
58973 #: guix-git/doc/guix.texi:33269
58974 msgid "Report the error and enter Guile's debugger. From there, you can run commands such as @code{,bt} to get a backtrace, @code{,locals} to display local variable values, and more generally inspect the state of the program. @xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for a list of available debugging commands."
58977 #. type: Plain text
58978 #: guix-git/doc/guix.texi:33276
58979 msgid "Once you have built, configured, re-configured, and re-re-configured your Guix installation, you may find it useful to list the operating system generations available on disk---and that you can choose from the bootloader boot menu:"
58983 #: guix-git/doc/guix.texi:33279
58989 #: guix-git/doc/guix.texi:33282
58990 msgid "Describe the current system generation: its file name, the kernel and bootloader used, etc., as well as provenance information when available."
58994 #: guix-git/doc/guix.texi:33283
58996 msgid "list-generations"
59000 #: guix-git/doc/guix.texi:33288
59001 msgid "List a summary of each generation of the operating system available on disk, in a human-readable way. This is similar to the @option{--list-generations} option of @command{guix package} (@pxref{Invoking guix package})."
59005 #: guix-git/doc/guix.texi:33293
59006 msgid "Optionally, one can specify a pattern, with the same syntax that is used in @command{guix package --list-generations}, to restrict the list of generations displayed. For instance, the following command displays generations that are up to 10 days old:"
59010 #: guix-git/doc/guix.texi:33296
59012 msgid "$ guix system list-generations 10d\n"
59015 #. type: Plain text
59016 #: guix-git/doc/guix.texi:33303
59017 msgid "The @command{guix system} command has even more to offer! The following sub-commands allow you to visualize how your system services relate to each other:"
59020 #. type: anchor{#1}
59021 #: guix-git/doc/guix.texi:33305
59022 msgid "system-extension-graph"
59026 #: guix-git/doc/guix.texi:33307
59028 msgid "extension-graph"
59032 #: guix-git/doc/guix.texi:33314
59033 msgid "Emit to standard output the @dfn{service extension graph} of the operating system defined in @var{file} (@pxref{Service Composition}, for more information on service extensions). By default the output is in Dot/Graphviz format, but you can choose a different format with @option{--graph-backend}, as with @command{guix graph} (@pxref{Invoking guix graph, @option{--backend}}):"
59037 #: guix-git/doc/guix.texi:33316
59038 msgid "The command:"
59042 #: guix-git/doc/guix.texi:33319
59044 msgid "$ guix system extension-graph @var{file} | xdot -\n"
59048 #: guix-git/doc/guix.texi:33322
59049 msgid "shows the extension relations among services."
59052 #. type: anchor{#1}
59053 #: guix-git/doc/guix.texi:33324
59054 msgid "system-shepherd-graph"
59058 #: guix-git/doc/guix.texi:33324
59060 msgid "shepherd-graph"
59064 #: guix-git/doc/guix.texi:33329
59065 msgid "Emit to standard output the @dfn{dependency graph} of shepherd services of the operating system defined in @var{file}. @xref{Shepherd Services}, for more information and for an example graph."
59069 #: guix-git/doc/guix.texi:33332
59070 msgid "Again, the default output format is Dot/Graphviz, but you can pass @option{--graph-backend} to select a different one."
59074 #: guix-git/doc/guix.texi:33336
59076 msgid "Invoking @code{guix deploy}"
59079 #. type: Plain text
59080 #: guix-git/doc/guix.texi:33344
59081 msgid "We've already seen @code{operating-system} declarations used to manage a machine's configuration locally. Suppose you need to configure multiple machines, though---perhaps you're managing a service on the web that's comprised of several servers. @command{guix deploy} enables you to use those same @code{operating-system} declarations to manage multiple remote hosts at once as a logical ``deployment''."
59085 #: guix-git/doc/guix.texi:33349
59086 msgid "The functionality described in this section is still under development and is subject to change. Get in touch with us on @email{guix-devel@@gnu.org}!"
59090 #: guix-git/doc/guix.texi:33353
59092 msgid "guix deploy @var{file}\n"
59095 #. type: Plain text
59096 #: guix-git/doc/guix.texi:33357
59097 msgid "Such an invocation will deploy the machines that the code within @var{file} evaluates to. As an example, @var{file} might contain a definition like this:"
59101 #: guix-git/doc/guix.texi:33364
59104 ";; This is a Guix deployment of a \"bare bones\" setup, with\n"
59105 ";; no X11 display server, to a machine with an SSH daemon\n"
59106 ";; listening on localhost:2222. A configuration such as this\n"
59107 ";; may be appropriate for virtual machine with ports\n"
59108 ";; forwarded to the host's loopback interface.\n"
59113 #: guix-git/doc/guix.texi:33367
59116 "(use-service-modules networking ssh)\n"
59117 "(use-package-modules bootloaders)\n"
59122 #: guix-git/doc/guix.texi:33388
59125 "(define %system\n"
59126 " (operating-system\n"
59127 " (host-name \"gnu-deployed\")\n"
59128 " (timezone \"Etc/UTC\")\n"
59129 " (bootloader (bootloader-configuration\n"
59130 " (bootloader grub-bootloader)\n"
59131 " (target \"/dev/vda\")\n"
59132 " (terminal-outputs '(console))))\n"
59133 " (file-systems (cons (file-system\n"
59134 " (mount-point \"/\")\n"
59135 " (device \"/dev/vda1\")\n"
59136 " (type \"ext4\"))\n"
59137 " %base-file-systems))\n"
59139 " (append (list (service dhcp-client-service-type)\n"
59140 " (service openssh-service-type\n"
59141 " (openssh-configuration\n"
59142 " (permit-root-login #t)\n"
59143 " (allow-empty-passwords? #t))))\n"
59144 " %base-services))))\n"
59149 #: guix-git/doc/guix.texi:33398
59153 " (operating-system %system)\n"
59154 " (environment managed-host-environment-type)\n"
59155 " (configuration (machine-ssh-configuration\n"
59156 " (host-name \"localhost\")\n"
59157 " (system \"x86_64-linux\")\n"
59158 " (user \"alice\")\n"
59159 " (identity \"./id_rsa\")\n"
59160 " (port 2222)))))\n"
59163 #. type: Plain text
59164 #: guix-git/doc/guix.texi:33411
59165 msgid "The file should evaluate to a list of @var{machine} objects. This example, upon being deployed, will create a new generation on the remote system realizing the @code{operating-system} declaration @code{%system}. @code{environment} and @code{configuration} specify how the machine should be provisioned---that is, how the computing resources should be created and managed. The above example does not create any resources, as a @code{'managed-host} is a machine that is already running the Guix system and available over the network. This is a particularly simple case; a more complex deployment may involve, for example, starting virtual machines through a Virtual Private Server (VPS) provider. In such a case, a different @var{environment} type would be used."
59168 #. type: Plain text
59169 #: guix-git/doc/guix.texi:33416
59170 msgid "Do note that you first need to generate a key pair on the coordinator machine to allow the daemon to export signed archives of files from the store (@pxref{Invoking guix archive}), though this step is automatic on Guix System:"
59173 #. type: Plain text
59174 #: guix-git/doc/guix.texi:33424
59175 msgid "Each target machine must authorize the key of the master machine so that it accepts store items it receives from the coordinator:"
59179 #: guix-git/doc/guix.texi:33427
59181 msgid "# guix archive --authorize < coordinator-public-key.txt\n"
59184 #. type: Plain text
59185 #: guix-git/doc/guix.texi:33438
59186 msgid "@code{user}, in this example, specifies the name of the user account to log in as to perform the deployment. Its default value is @code{root}, but root login over SSH may be forbidden in some cases. To work around this, @command{guix deploy} can log in as an unprivileged user and employ @code{sudo} to escalate privileges. This will only work if @code{sudo} is currently installed on the remote and can be invoked non-interactively as @code{user}. That is, the line in @code{sudoers} granting @code{user} the ability to use @code{sudo} must contain the @code{NOPASSWD} tag. This can be accomplished with the following operating system configuration snippet:"
59190 #: guix-git/doc/guix.texi:33442
59193 "(use-modules ...\n"
59194 " (gnu system)) ;for %sudoers-specification\n"
59199 #: guix-git/doc/guix.texi:33444
59202 "(define %user \"username\")\n"
59207 #: guix-git/doc/guix.texi:33452
59210 "(operating-system\n"
59213 " (plain-file \"sudoers\"\n"
59214 " (string-append (plain-file-content %sudoers-specification)\n"
59215 " (format #f \"~a ALL = NOPASSWD: ALL~%\"\n"
59220 #. type: Plain text
59221 #: guix-git/doc/guix.texi:33457
59222 msgid "For more information regarding the format of the @file{sudoers} file, consult @command{man sudoers}."
59226 #: guix-git/doc/guix.texi:33458
59228 msgid "{Data Type} machine"
59232 #: guix-git/doc/guix.texi:33461
59233 msgid "This is the data type representing a single machine in a heterogeneous Guix deployment."
59237 #: guix-git/doc/guix.texi:33465
59238 msgid "The object of the operating system configuration to deploy."
59242 #: guix-git/doc/guix.texi:33466
59244 msgid "environment"
59248 #: guix-git/doc/guix.texi:33468
59249 msgid "An @code{environment-type} describing how the machine should be provisioned."
59253 #: guix-git/doc/guix.texi:33469
59255 msgid "@code{configuration} (default: @code{#f})"
59259 #: guix-git/doc/guix.texi:33474
59260 msgid "An object describing the configuration for the machine's @code{environment}. If the @code{environment} has a default configuration, @code{#f} may be used. If @code{#f} is used for an environment with no default configuration, however, an error will be thrown."
59264 #: guix-git/doc/guix.texi:33477
59266 msgid "{Data Type} machine-ssh-configuration"
59270 #: guix-git/doc/guix.texi:33480
59271 msgid "This is the data type representing the SSH client parameters for a machine with an @code{environment} of @code{managed-host-environment-type}."
59275 #: guix-git/doc/guix.texi:33483
59277 msgid "@code{build-locally?} (default: @code{#t})"
59281 #: guix-git/doc/guix.texi:33485
59282 msgid "If false, system derivations will be built on the machine being deployed to."
59286 #: guix-git/doc/guix.texi:33485
59292 #: guix-git/doc/guix.texi:33488
59293 msgid "The system type describing the architecture of the machine being deployed to---e.g., @code{\"x86_64-linux\"}."
59297 #: guix-git/doc/guix.texi:33488
59299 msgid "@code{authorize?} (default: @code{#t})"
59303 #: guix-git/doc/guix.texi:33491
59304 msgid "If true, the coordinator's signing key will be added to the remote's ACL keyring."
59308 #: guix-git/doc/guix.texi:33492
59310 msgid "@code{user} (default: @code{\"root\"})"
59314 #: guix-git/doc/guix.texi:33493
59316 msgid "@code{identity} (default: @code{#f})"
59320 #: guix-git/doc/guix.texi:33496
59321 msgid "If specified, the path to the SSH private key to use to authenticate with the remote host."
59325 #: guix-git/doc/guix.texi:33497
59327 msgid "@code{host-key} (default: @code{#f})"
59331 #: guix-git/doc/guix.texi:33499
59332 msgid "This should be the SSH host key of the machine, which looks like this:"
59336 #: guix-git/doc/guix.texi:33502
59338 msgid "ssh-ed25519 AAAAC3Nz@dots{} root@@example.org\n"
59342 #: guix-git/doc/guix.texi:33507
59343 msgid "When @code{host-key} is @code{#f}, the server is authenticated against the @file{~/.ssh/known_hosts} file, just like the OpenSSH @command{ssh} client does."
59347 #: guix-git/doc/guix.texi:33508
59349 msgid "@code{allow-downgrades?} (default: @code{#f})"
59353 #: guix-git/doc/guix.texi:33510
59354 msgid "Whether to allow potential downgrades."
59358 #: guix-git/doc/guix.texi:33518
59359 msgid "Like @command{guix system reconfigure}, @command{guix deploy} compares the channel commits currently deployed on the remote host (as returned by @command{guix system describe}) to those currently in use (as returned by @command{guix describe}) to determine whether commits currently in use are descendants of those deployed. When this is not the case and @code{allow-downgrades?} is false, it raises an error. This ensures you do not accidentally downgrade remote machines."
59363 #: guix-git/doc/guix.texi:33521
59365 msgid "{Data Type} digital-ocean-configuration"
59369 #: guix-git/doc/guix.texi:33524
59370 msgid "This is the data type describing the Droplet that should be created for a machine with an @code{environment} of @code{digital-ocean-environment-type}."
59374 #: guix-git/doc/guix.texi:33526
59380 #: guix-git/doc/guix.texi:33529
59381 msgid "The path to the SSH private key to use to authenticate with the remote host. In the future, this field may not exist."
59385 #: guix-git/doc/guix.texi:33529
59391 #: guix-git/doc/guix.texi:33532
59392 msgid "A list of string ``tags'' that uniquely identify the machine. Must be given such that no two machines in the deployment have the same set of tags."
59396 #: guix-git/doc/guix.texi:33532
59402 #: guix-git/doc/guix.texi:33534
59403 msgid "A Digital Ocean region slug, such as @code{\"nyc3\"}."
59407 #: guix-git/doc/guix.texi:33536
59408 msgid "A Digital Ocean size slug, such as @code{\"s-1vcpu-1gb\"}"
59412 #: guix-git/doc/guix.texi:33536
59414 msgid "enable-ipv6?"
59418 #: guix-git/doc/guix.texi:33538
59419 msgid "Whether or not the droplet should be created with IPv6 networking."
59423 #: guix-git/doc/guix.texi:33542
59425 msgid "Running Guix in a Virtual Machine"
59428 #. type: Plain text
59429 #: guix-git/doc/guix.texi:33551
59430 msgid "To run Guix in a virtual machine (VM), one can use the pre-built Guix VM image distributed at @url{@value{BASE-URL}/guix-system-vm-image-@value{VERSION}.x86_64-linux.xz}. This image is a compressed image in QCOW format. You will first need to decompress with @command{xz -d}, and then you can pass it to an emulator such as QEMU (see below for details)."
59433 #. type: Plain text
59434 #: guix-git/doc/guix.texi:33558
59435 msgid "This image boots the Xfce graphical environment and it contains some commonly used tools. You can install more software in the image by running @command{guix package} in a terminal (@pxref{Invoking guix package}). You can also reconfigure the system based on its initial configuration file available as @file{/run/current-system/configuration.scm} (@pxref{Using the Configuration System})."
59438 #. type: Plain text
59439 #: guix-git/doc/guix.texi:33563
59440 msgid "Instead of using this pre-built image, one can also build their own virtual machine image using @command{guix system vm-image} (@pxref{Invoking guix system}). The returned image is in qcow2 format, which the @uref{https://qemu.org/, QEMU emulator} can efficiently use."
59444 #: guix-git/doc/guix.texi:33564
59449 #. type: Plain text
59450 #: guix-git/doc/guix.texi:33571
59451 msgid "If you built your own image, you must copy it out of the store (@pxref{The Store}) and give yourself permission to write to the copy before you can use it. When invoking QEMU, you must choose a system emulator that is suitable for your hardware platform. Here is a minimal QEMU invocation that will boot the result of @command{guix system image -t qcow2} on x86_64 hardware:"
59455 #: guix-git/doc/guix.texi:33578
59458 "$ qemu-system-x86_64 \\\n"
59459 " -nic user,model=virtio-net-pci \\\n"
59460 " -enable-kvm -m 1024 \\\n"
59461 " -device virtio-blk,drive=myhd \\\n"
59462 " -drive if=none,file=/tmp/qemu-image,id=myhd\n"
59465 #. type: Plain text
59466 #: guix-git/doc/guix.texi:33581
59467 msgid "Here is what each of these options means:"
59471 #: guix-git/doc/guix.texi:33583
59473 msgid "qemu-system-x86_64"
59477 #: guix-git/doc/guix.texi:33586
59478 msgid "This specifies the hardware platform to emulate. This should match the host."
59482 #: guix-git/doc/guix.texi:33587
59484 msgid "-nic user,model=virtio-net-pci"
59488 #: guix-git/doc/guix.texi:33595
59489 msgid "Enable the unprivileged user-mode network stack. The guest OS can access the host but not vice versa. This is the simplest way to get the guest OS online. @code{model} specifies which network device to emulate: @code{virtio-net-pci} is a special device made for virtualized operating systems and recommended for most uses. Assuming your hardware platform is x86_64, you can get a list of available NIC models by running @command{qemu-system-x86_64 -nic model=help}."
59493 #: guix-git/doc/guix.texi:33596
59495 msgid "-enable-kvm"
59499 #: guix-git/doc/guix.texi:33600
59500 msgid "If your system has hardware virtualization extensions, enabling the virtual machine support (KVM) of the Linux kernel will make things run faster."
59504 #: guix-git/doc/guix.texi:33602
59510 #: guix-git/doc/guix.texi:33605
59511 msgid "RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, which may be insufficient for some operations."
59515 #: guix-git/doc/guix.texi:33606
59517 msgid "-device virtio-blk,drive=myhd"
59521 #: guix-git/doc/guix.texi:33611
59522 msgid "Create a @code{virtio-blk} drive called ``myhd''. @code{virtio-blk} is a ``paravirtualization'' mechanism for block devices that allows QEMU to achieve better performance than if it were emulating a complete disk drive. See the QEMU and KVM documentation for more info."
59526 #: guix-git/doc/guix.texi:33612
59528 msgid "-drive if=none,file=/tmp/qemu-image,id=myhd"
59532 #: guix-git/doc/guix.texi:33615
59533 msgid "Use our QCOW image, the @file{/tmp/qemu-image} file, as the backing store of the ``myhd'' drive."
59536 #. type: Plain text
59537 #: guix-git/doc/guix.texi:33625
59538 msgid "The default @command{run-vm.sh} script that is returned by an invocation of @command{guix system vm} does not add a @command{-nic user} flag by default. To get network access from within the vm add the @code{(dhcp-client-service)} to your system definition and start the VM using @command{$(guix system vm config.scm) -nic user}. An important caveat of using @command{-nic user} for networking is that @command{ping} will not work, because it uses the ICMP protocol. You'll have to use a different command to check for network connectivity, for example @command{guix download}."
59541 #. type: subsection
59542 #: guix-git/doc/guix.texi:33626
59544 msgid "Connecting Through SSH"
59547 #. type: Plain text
59548 #: guix-git/doc/guix.texi:33634
59549 msgid "To enable SSH inside a VM you need to add an SSH server like @code{openssh-service-type} to your VM (@pxref{Networking Services, @code{openssh-service-type}}). In addition you need to forward the SSH port, 22 by default, to the host. You can do this with"
59553 #: guix-git/doc/guix.texi:33637
59555 msgid "$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22\n"
59558 #. type: Plain text
59559 #: guix-git/doc/guix.texi:33640
59560 msgid "To connect to the VM you can run"
59564 #: guix-git/doc/guix.texi:33643
59566 msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost\n"
59569 #. type: Plain text
59570 #: guix-git/doc/guix.texi:33650
59571 msgid "The @command{-p} tells @command{ssh} the port you want to connect to. @command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from complaining every time you modify your @command{config.scm} file and the @command{-o StrictHostKeyChecking=no} prevents you from having to allow a connection to an unknown host every time you connect."
59574 #. type: subsection
59575 #: guix-git/doc/guix.texi:33651
59577 msgid "Using @command{virt-viewer} with Spice"
59580 #. type: Plain text
59581 #: guix-git/doc/guix.texi:33657
59582 msgid "As an alternative to the default @command{qemu} graphical client you can use the @command{remote-viewer} from the @command{virt-viewer} package. To connect pass the @command{-spice port=5930,disable-ticketing} flag to @command{qemu}. See previous section for further information on how to do this."
59585 #. type: Plain text
59586 #: guix-git/doc/guix.texi:33660
59587 msgid "Spice also allows you to do some nice stuff like share your clipboard with your VM@. To enable that you'll also have to pass the following flags to @command{qemu}:"
59591 #: guix-git/doc/guix.texi:33666
59594 "-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5\n"
59595 "-chardev spicevmc,name=vdagent,id=vdagent\n"
59596 "-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\n"
59597 "name=com.redhat.spice.0\n"
59600 #. type: Plain text
59601 #: guix-git/doc/guix.texi:33670
59602 msgid "You'll also need to add the @code{(spice-vdagent-service)} to your system definition (@pxref{Miscellaneous Services, Spice service})."
59605 #. type: Plain text
59606 #: guix-git/doc/guix.texi:33677
59607 msgid "The previous sections show the available services and how one can combine them in an @code{operating-system} declaration. But how do we define them in the first place? And what is a service anyway?"
59611 #: guix-git/doc/guix.texi:33689
59616 #. type: Plain text
59617 #: guix-git/doc/guix.texi:33702
59618 msgid "Here we define a @dfn{service} as, broadly, something that extends the functionality of the operating system. Often a service is a process---a @dfn{daemon}---started when the system boots: a secure shell server, a Web server, the Guix build daemon, etc. Sometimes a service is a daemon whose execution can be triggered by another daemon---e.g., an FTP server started by @command{inetd} or a D-Bus service activated by @command{dbus-daemon}. Occasionally, a service does not map to a daemon. For instance, the ``account'' service collects user accounts and makes sure they exist when the system runs; the ``udev'' service collects device management rules and makes them available to the eudev daemon; the @file{/etc} service populates the @file{/etc} directory of the system."
59622 #: guix-git/doc/guix.texi:33703
59624 msgid "service extensions"
59627 #. type: Plain text
59628 #: guix-git/doc/guix.texi:33715
59629 msgid "Guix system services are connected by @dfn{extensions}. For instance, the secure shell service @emph{extends} the Shepherd---the initialization system, running as PID@tie{}1---by giving it the command lines to start and stop the secure shell daemon (@pxref{Networking Services, @code{openssh-service-type}}); the UPower service extends the D-Bus service by passing it its @file{.service} specification, and extends the udev service by passing it device management rules (@pxref{Desktop Services, @code{upower-service}}); the Guix daemon service extends the Shepherd by passing it the command lines to start and stop the daemon, and extends the account service by passing it a list of required build user accounts (@pxref{Base Services})."
59632 #. type: Plain text
59633 #: guix-git/doc/guix.texi:33719
59634 msgid "All in all, services and their ``extends'' relations form a directed acyclic graph (DAG). If we represent services as boxes and extensions as arrows, a typical system might provide something like this:"
59637 #. type: Plain text
59638 #: guix-git/doc/guix.texi:33721
59639 msgid "@image{images/service-graph,,5in,Typical service extension graph.}"
59643 #: guix-git/doc/guix.texi:33722
59645 msgid "system service"
59648 #. type: Plain text
59649 #: guix-git/doc/guix.texi:33730
59650 msgid "At the bottom, we see the @dfn{system service}, which produces the directory containing everything to run and boot the system, as returned by the @command{guix system build} command. @xref{Service Reference}, to learn about the other service types shown here. @xref{system-extension-graph, the @command{guix system extension-graph} command}, for information on how to generate this representation for a particular operating system definition."
59654 #: guix-git/doc/guix.texi:33731
59656 msgid "service types"
59659 #. type: Plain text
59660 #: guix-git/doc/guix.texi:33737
59661 msgid "Technically, developers can define @dfn{service types} to express these relations. There can be any number of services of a given type on the system---for instance, a system running two instances of the GNU secure shell server (lsh) has two instances of @code{lsh-service-type}, with different parameters."
59664 #. type: Plain text
59665 #: guix-git/doc/guix.texi:33740
59666 msgid "The following section describes the programming interface for service types and services."
59669 #. type: Plain text
59670 #: guix-git/doc/guix.texi:33747
59671 msgid "A @dfn{service type} is a node in the DAG described above. Let us start with a simple example, the service type for the Guix build daemon (@pxref{Invoking guix-daemon}):"
59675 #: guix-git/doc/guix.texi:33757
59678 "(define guix-service-type\n"
59682 " (list (service-extension shepherd-root-service-type guix-shepherd-service)\n"
59683 " (service-extension account-service-type guix-accounts)\n"
59684 " (service-extension activation-service-type guix-activation)))\n"
59685 " (default-value (guix-configuration))))\n"
59688 #. type: Plain text
59689 #: guix-git/doc/guix.texi:33761
59690 msgid "It defines three things:"
59694 #: guix-git/doc/guix.texi:33765
59695 msgid "A name, whose sole purpose is to make inspection and debugging easier."
59699 #: guix-git/doc/guix.texi:33770
59700 msgid "A list of @dfn{service extensions}, where each extension designates the target service type and a procedure that, given the parameters of the service, returns a list of objects to extend the service of that type."
59704 #: guix-git/doc/guix.texi:33773
59705 msgid "Every service type has at least one service extension. The only exception is the @dfn{boot service type}, which is the ultimate service."
59709 #: guix-git/doc/guix.texi:33776
59710 msgid "Optionally, a default value for instances of this type."
59713 #. type: Plain text
59714 #: guix-git/doc/guix.texi:33779
59715 msgid "In this example, @code{guix-service-type} extends three services:"
59719 #: guix-git/doc/guix.texi:33781
59721 msgid "shepherd-root-service-type"
59725 #: guix-git/doc/guix.texi:33786
59726 msgid "The @code{guix-shepherd-service} procedure defines how the Shepherd service is extended. Namely, it returns a @code{<shepherd-service>} object that defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd Services})."
59730 #: guix-git/doc/guix.texi:33787
59732 msgid "account-service-type"
59736 #: guix-git/doc/guix.texi:33792
59737 msgid "This extension for this service is computed by @code{guix-accounts}, which returns a list of @code{user-group} and @code{user-account} objects representing the build user accounts (@pxref{Invoking guix-daemon})."
59741 #: guix-git/doc/guix.texi:33793
59743 msgid "activation-service-type"
59747 #: guix-git/doc/guix.texi:33797
59748 msgid "Here @code{guix-activation} is a procedure that returns a gexp, which is a code snippet to run at ``activation time''---e.g., when the service is booted."
59751 #. type: Plain text
59752 #: guix-git/doc/guix.texi:33800
59753 msgid "A service of this type is instantiated like this:"
59757 #: guix-git/doc/guix.texi:33806
59760 "(service guix-service-type\n"
59761 " (guix-configuration\n"
59762 " (build-accounts 5)\n"
59763 " (extra-options '(\"--gc-keep-derivations\"))))\n"
59766 #. type: Plain text
59767 #: guix-git/doc/guix.texi:33814
59768 msgid "The second argument to the @code{service} form is a value representing the parameters of this specific service instance. @xref{guix-configuration-type, @code{guix-configuration}}, for information about the @code{guix-configuration} data type. When the value is omitted, the default value specified by @code{guix-service-type} is used:"
59772 #: guix-git/doc/guix.texi:33817
59774 msgid "(service guix-service-type)\n"
59777 #. type: Plain text
59778 #: guix-git/doc/guix.texi:33821
59779 msgid "@code{guix-service-type} is quite simple because it extends other services but is not extensible itself."
59782 #. type: Plain text
59783 #: guix-git/doc/guix.texi:33825
59784 msgid "The service type for an @emph{extensible} service looks like this:"
59788 #: guix-git/doc/guix.texi:33832
59791 "(define udev-service-type\n"
59792 " (service-type (name 'udev)\n"
59794 " (list (service-extension shepherd-root-service-type\n"
59795 " udev-shepherd-service)))\n"
59800 #: guix-git/doc/guix.texi:33840
59803 " (compose concatenate) ;concatenate the list of rules\n"
59804 " (extend (lambda (config rules)\n"
59806 " (($ <udev-configuration> udev initial-rules)\n"
59807 " (udev-configuration\n"
59808 " (udev udev) ;the udev package to use\n"
59809 " (rules (append initial-rules rules)))))))))\n"
59812 #. type: Plain text
59813 #: guix-git/doc/guix.texi:33846
59814 msgid "This is the service type for the @uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device management daemon}. Compared to the previous example, in addition to an extension of @code{shepherd-root-service-type}, we see two new fields:"
59818 #: guix-git/doc/guix.texi:33848
59824 #: guix-git/doc/guix.texi:33851
59825 msgid "This is the procedure to @dfn{compose} the list of extensions to services of this type."
59829 #: guix-git/doc/guix.texi:33854
59830 msgid "Services can extend the udev service by passing it lists of rules; we compose those extensions simply by concatenating them."
59834 #: guix-git/doc/guix.texi:33855
59840 #: guix-git/doc/guix.texi:33858
59841 msgid "This procedure defines how the value of the service is @dfn{extended} with the composition of the extensions."
59845 #: guix-git/doc/guix.texi:33863
59846 msgid "Udev extensions are composed into a list of rules, but the udev service value is itself a @code{<udev-configuration>} record. So here, we extend that record by appending the list of rules it contains to the list of contributed rules."
59850 #: guix-git/doc/guix.texi:33869
59851 msgid "This is a string giving an overview of the service type. The string can contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The @command{guix system search} command searches these strings and displays them (@pxref{Invoking guix system})."
59854 #. type: Plain text
59855 #: guix-git/doc/guix.texi:33874
59856 msgid "There can be only one instance of an extensible service type such as @code{udev-service-type}. If there were more, the @code{service-extension} specifications would be ambiguous."
59859 #. type: Plain text
59860 #: guix-git/doc/guix.texi:33877
59861 msgid "Still here? The next section provides a reference of the programming interface for services."
59864 #. type: Plain text
59865 #: guix-git/doc/guix.texi:33885
59866 msgid "We have seen an overview of service types (@pxref{Service Types and Services}). This section provides a reference on how to manipulate services and service types. This interface is provided by the @code{(gnu services)} module."
59870 #: guix-git/doc/guix.texi:33886
59872 msgid "{Scheme Procedure} service @var{type} [@var{value}]"
59876 #: guix-git/doc/guix.texi:33890
59877 msgid "Return a new service of @var{type}, a @code{<service-type>} object (see below). @var{value} can be any object; it represents the parameters of this particular service instance."
59881 #: guix-git/doc/guix.texi:33894
59882 msgid "When @var{value} is omitted, the default value specified by @var{type} is used; if @var{type} does not specify a default value, an error is raised."
59886 #: guix-git/doc/guix.texi:33896
59887 msgid "For instance, this:"
59891 #: guix-git/doc/guix.texi:33899
59893 msgid "(service openssh-service-type)\n"
59897 #: guix-git/doc/guix.texi:33903
59898 msgid "is equivalent to this:"
59902 #: guix-git/doc/guix.texi:33907
59905 "(service openssh-service-type\n"
59906 " (openssh-configuration))\n"
59910 #: guix-git/doc/guix.texi:33911
59911 msgid "In both cases the result is an instance of @code{openssh-service-type} with the default configuration."
59915 #: guix-git/doc/guix.texi:33913
59917 msgid "{Scheme Procedure} service? @var{obj}"
59921 #: guix-git/doc/guix.texi:33915
59922 msgid "Return true if @var{obj} is a service."
59926 #: guix-git/doc/guix.texi:33917
59928 msgid "{Scheme Procedure} service-kind @var{service}"
59932 #: guix-git/doc/guix.texi:33919
59933 msgid "Return the type of @var{service}---i.e., a @code{<service-type>} object."
59937 #: guix-git/doc/guix.texi:33921
59939 msgid "{Scheme Procedure} service-value @var{service}"
59943 #: guix-git/doc/guix.texi:33924
59944 msgid "Return the value associated with @var{service}. It represents its parameters."
59947 #. type: Plain text
59948 #: guix-git/doc/guix.texi:33927
59949 msgid "Here is an example of how a service is created and manipulated:"
59953 #: guix-git/doc/guix.texi:33936
59957 " (service nginx-service-type\n"
59958 " (nginx-configuration\n"
59960 " (log-directory log-directory)\n"
59961 " (run-directory run-directory)\n"
59962 " (file config-file))))\n"
59967 #: guix-git/doc/guix.texi:33939
59976 #: guix-git/doc/guix.texi:33942
59979 "(eq? (service-kind s) nginx-service-type)\n"
59983 #. type: Plain text
59984 #: guix-git/doc/guix.texi:33952
59985 msgid "The @code{modify-services} form provides a handy way to change the parameters of some of the services of a list such as @code{%base-services} (@pxref{Base Services, @code{%base-services}}). It evaluates to a list of services. Of course, you could always use standard list combinators such as @code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual}); @code{modify-services} simply provides a more concise form for this common pattern."
59989 #: guix-git/doc/guix.texi:33953
59991 msgid "{Scheme Syntax} modify-services @var{services} @"
59995 #: guix-git/doc/guix.texi:33955
59996 msgid "(@var{type} @var{variable} => @var{body}) @dots{}"
60000 #: guix-git/doc/guix.texi:33958
60001 msgid "Modify the services listed in @var{services} according to the given clauses. Each clause has the form:"
60005 #: guix-git/doc/guix.texi:33961
60007 msgid "(@var{type} @var{variable} => @var{body})\n"
60011 #: guix-git/doc/guix.texi:33968
60012 msgid "where @var{type} is a service type---e.g., @code{guix-service-type}---and @var{variable} is an identifier that is bound within the @var{body} to the service parameters---e.g., a @code{guix-configuration} instance---of the original service of that @var{type}."
60016 #: guix-git/doc/guix.texi:33975
60017 msgid "The @var{body} should evaluate to the new service parameters, which will be used to configure the new service. This new service will replace the original in the resulting list. Because a service's service parameters are created using @code{define-record-type*}, you can write a succinct @var{body} that evaluates to the new service parameters by using the @code{inherit} feature that @code{define-record-type*} provides."
60021 #: guix-git/doc/guix.texi:33977
60022 msgid "@xref{Using the Configuration System}, for example usage."
60025 #. type: Plain text
60026 #: guix-git/doc/guix.texi:33984
60027 msgid "Next comes the programming interface for service types. This is something you want to know when writing new service definitions, but not necessarily when simply looking for ways to customize your @code{operating-system} declaration."
60031 #: guix-git/doc/guix.texi:33985
60033 msgid "{Data Type} service-type"
60037 #: guix-git/doc/guix.texi:33986
60039 msgid "service type"
60043 #: guix-git/doc/guix.texi:33989
60044 msgid "This is the representation of a @dfn{service type} (@pxref{Service Types and Services})."
60048 #: guix-git/doc/guix.texi:33993
60049 msgid "This is a symbol, used only to simplify inspection and debugging."
60053 #: guix-git/doc/guix.texi:33994
60059 #: guix-git/doc/guix.texi:33996
60060 msgid "A non-empty list of @code{<service-extension>} objects (see below)."
60064 #: guix-git/doc/guix.texi:33997
60066 msgid "@code{compose} (default: @code{#f})"
60070 #: guix-git/doc/guix.texi:34001
60071 msgid "If this is @code{#f}, then the service type denotes services that cannot be extended---i.e., services that do not receive ``values'' from other services."
60075 #: guix-git/doc/guix.texi:34005
60076 msgid "Otherwise, it must be a one-argument procedure. The procedure is called by @code{fold-services} and is passed a list of values collected from extensions. It may return any single value."
60080 #: guix-git/doc/guix.texi:34006
60082 msgid "@code{extend} (default: @code{#f})"
60086 #: guix-git/doc/guix.texi:34008
60087 msgid "If this is @code{#f}, services of this type cannot be extended."
60091 #: guix-git/doc/guix.texi:34014
60092 msgid "Otherwise, it must be a two-argument procedure: @code{fold-services} calls it, passing it the initial value of the service as the first argument and the result of applying @code{compose} to the extension values as the second argument. It must return a value that is a valid parameter value for the service instance."
60096 #: guix-git/doc/guix.texi:34020
60097 msgid "This is a string, possibly using Texinfo markup, describing in a couple of sentences what the service is about. This string allows users to find about the service through @command{guix system search} (@pxref{Invoking guix system})."
60101 #: guix-git/doc/guix.texi:34021
60103 msgid "@code{default-value} (default: @code{&no-default-value})"
60107 #: guix-git/doc/guix.texi:34024
60108 msgid "The default value associated for instances of this service type. This allows users to use the @code{service} form without its second argument:"
60112 #: guix-git/doc/guix.texi:34027
60114 msgid "(service @var{type})\n"
60118 #: guix-git/doc/guix.texi:34031
60119 msgid "The returned service in this case has the default value specified by @var{type}."
60123 #: guix-git/doc/guix.texi:34034
60124 msgid "@xref{Service Types and Services}, for examples."
60128 #: guix-git/doc/guix.texi:34036
60130 msgid "{Scheme Procedure} service-extension @var{target-type} @"
60134 #: guix-git/doc/guix.texi:34042
60135 msgid "@var{compute} Return a new extension for services of type @var{target-type}. @var{compute} must be a one-argument procedure: @code{fold-services} calls it, passing it the value associated with the service that provides the extension; it must return a valid value for the target service."
60139 #: guix-git/doc/guix.texi:34044
60141 msgid "{Scheme Procedure} service-extension? @var{obj}"
60145 #: guix-git/doc/guix.texi:34046
60146 msgid "Return true if @var{obj} is a service extension."
60149 #. type: Plain text
60150 #: guix-git/doc/guix.texi:34052
60151 msgid "Occasionally, you might want to simply extend an existing service. This involves creating a new service type and specifying the extension of interest, which can be verbose; the @code{simple-service} procedure provides a shorthand for this."
60155 #: guix-git/doc/guix.texi:34053
60157 msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}"
60161 #: guix-git/doc/guix.texi:34057
60162 msgid "Return a service that extends @var{target} with @var{value}. This works by creating a singleton service type @var{name}, of which the returned service is an instance."
60166 #: guix-git/doc/guix.texi:34060
60167 msgid "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an additional job:"
60171 #: guix-git/doc/guix.texi:34064
60174 "(simple-service 'my-mcron-job mcron-service-type\n"
60175 " #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n"
60178 #. type: Plain text
60179 #: guix-git/doc/guix.texi:34074
60180 msgid "At the core of the service abstraction lies the @code{fold-services} procedure, which is responsible for ``compiling'' a list of services down to a single directory that contains everything needed to boot and run the system---the directory shown by the @command{guix system build} command (@pxref{Invoking guix system}). In essence, it propagates service extensions down the service graph, updating each node parameters on the way, until it reaches the root node."
60184 #: guix-git/doc/guix.texi:34075
60186 msgid "{Scheme Procedure} fold-services @var{services} @"
60190 #: guix-git/doc/guix.texi:34079
60191 msgid "[#:target-type @var{system-service-type}] Fold @var{services} by propagating their extensions down to the root of type @var{target-type}; return the root service adjusted accordingly."
60194 #. type: Plain text
60195 #: guix-git/doc/guix.texi:34083
60196 msgid "Lastly, the @code{(gnu services)} module also defines several essential service types, some of which are listed below."
60200 #: guix-git/doc/guix.texi:34084
60202 msgid "{Scheme Variable} system-service-type"
60206 #: guix-git/doc/guix.texi:34087
60207 msgid "This is the root of the service graph. It produces the system directory as returned by the @command{guix system build} command."
60211 #: guix-git/doc/guix.texi:34089
60213 msgid "{Scheme Variable} boot-service-type"
60217 #: guix-git/doc/guix.texi:34092
60218 msgid "The type of the ``boot service'', which produces the @dfn{boot script}. The boot script is what the initial RAM disk runs when booting."
60222 #: guix-git/doc/guix.texi:34094
60224 msgid "{Scheme Variable} etc-service-type"
60228 #: guix-git/doc/guix.texi:34098
60229 msgid "The type of the @file{/etc} service. This service is used to create files under @file{/etc} and can be extended by passing it name/file tuples such as:"
60233 #: guix-git/doc/guix.texi:34101
60235 msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n"
60239 #: guix-git/doc/guix.texi:34105
60240 msgid "In this example, the effect would be to add an @file{/etc/issue} file pointing to the given file."
60244 #: guix-git/doc/guix.texi:34107
60246 msgid "{Scheme Variable} setuid-program-service-type"
60250 #: guix-git/doc/guix.texi:34111
60251 msgid "Type for the ``setuid-program service''. This service collects lists of executable file names, passed as gexps, and adds them to the set of setuid-root programs on the system (@pxref{Setuid Programs})."
60255 #: guix-git/doc/guix.texi:34113
60257 msgid "{Scheme Variable} profile-service-type"
60261 #: guix-git/doc/guix.texi:34117
60262 msgid "Type of the service that populates the @dfn{system profile}---i.e., the programs under @file{/run/current-system/profile}. Other services can extend it by passing it lists of packages to add to the system profile."
60265 #. type: anchor{#1}
60266 #: guix-git/doc/guix.texi:34121
60267 msgid "provenance-service-type"
60271 #: guix-git/doc/guix.texi:34121
60273 msgid "{Scheme Variable} provenance-service-type"
60277 #: guix-git/doc/guix.texi:34125
60278 msgid "This is the type of the service that records @dfn{provenance meta-data} in the system itself. It creates several files under @file{/run/current-system}:"
60282 #: guix-git/doc/guix.texi:34127
60284 msgid "channels.scm"
60288 #: guix-git/doc/guix.texi:34132
60289 msgid "This is a ``channel file'' that can be passed to @command{guix pull -C} or @command{guix time-machine -C}, and which describes the channels used to build the system, if that information was available (@pxref{Channels})."
60293 #: guix-git/doc/guix.texi:34133
60295 msgid "configuration.scm"
60299 #: guix-git/doc/guix.texi:34138
60300 msgid "This is the file that was passed as the value for this @code{provenance-service-type} service. By default, @command{guix system reconfigure} automatically passes the OS configuration file it received on the command line."
60304 #: guix-git/doc/guix.texi:34139
60310 #: guix-git/doc/guix.texi:34142
60311 msgid "This contains the same information as the two other files but in a format that is more readily processable."
60315 #: guix-git/doc/guix.texi:34146
60316 msgid "In general, these two pieces of information (channels and configuration file) are enough to reproduce the operating system ``from source''."
60320 #: guix-git/doc/guix.texi:34147
60326 #: guix-git/doc/guix.texi:34154
60327 msgid "This information is necessary to rebuild your operating system, but it is not always sufficient. In particular, @file{configuration.scm} itself is insufficient if it is not self-contained---if it refers to external Guile modules or to extra files. If you want @file{configuration.scm} to be self-contained, we recommend that modules or files it refers to be part of a channel."
60331 #: guix-git/doc/guix.texi:34162
60332 msgid "Besides, provenance meta-data is ``silent'' in the sense that it does not change the bits contained in your system, @emph{except for the meta-data bits themselves}. Two different OS configurations or sets of channels can lead to the same system, bit-for-bit; when @code{provenance-service-type} is used, these two systems will have different meta-data and thus different store file names, which makes comparison less trivial."
60336 #: guix-git/doc/guix.texi:34167
60337 msgid "This service is automatically added to your operating system configuration when you use @command{guix system reconfigure}, @command{guix system init}, or @command{guix deploy}."
60341 #: guix-git/doc/guix.texi:34172
60343 msgid "shepherd services"
60347 #: guix-git/doc/guix.texi:34173
60353 #: guix-git/doc/guix.texi:34174
60355 msgid "init system"
60358 #. type: Plain text
60359 #: guix-git/doc/guix.texi:34180
60360 msgid "The @code{(gnu services shepherd)} module provides a way to define services managed by the GNU@tie{}Shepherd, which is the initialization system---the first process that is started when the system boots, also known as PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual})."
60363 #. type: Plain text
60364 #: guix-git/doc/guix.texi:34186
60365 msgid "Services in the Shepherd can depend on each other. For instance, the SSH daemon may need to be started after the syslog daemon has been started, which in turn can only happen once all the file systems have been mounted. The simple operating system defined earlier (@pxref{Using the Configuration System}) results in a service graph like this:"
60368 #. type: Plain text
60369 #: guix-git/doc/guix.texi:34188
60370 msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}"
60373 #. type: Plain text
60374 #: guix-git/doc/guix.texi:34192
60375 msgid "You can actually generate such a graph for any operating system definition using the @command{guix system shepherd-graph} command (@pxref{system-shepherd-graph, @command{guix system shepherd-graph}})."
60378 #. type: Plain text
60379 #: guix-git/doc/guix.texi:34196
60380 msgid "The @code{%shepherd-root-service} is a service object representing PID@tie{}1, of type @code{shepherd-root-service-type}; it can be extended by passing it lists of @code{<shepherd-service>} objects."
60384 #: guix-git/doc/guix.texi:34197
60386 msgid "{Data Type} shepherd-service"
60390 #: guix-git/doc/guix.texi:34199
60391 msgid "The data type representing a service managed by the Shepherd."
60395 #: guix-git/doc/guix.texi:34201
60401 #: guix-git/doc/guix.texi:34203
60402 msgid "This is a list of symbols denoting what the service provides."
60406 #: guix-git/doc/guix.texi:34208
60407 msgid "These are the names that may be passed to @command{herd start}, @command{herd status}, and similar commands (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the @code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details."
60411 #: guix-git/doc/guix.texi:34209
60413 msgid "@code{requirement} (default: @code{'()})"
60417 #: guix-git/doc/guix.texi:34211
60418 msgid "List of symbols denoting the Shepherd services this one depends on."
60422 #: guix-git/doc/guix.texi:34212
60424 msgid "one-shot services, for the Shepherd"
60428 #: guix-git/doc/guix.texi:34217
60429 msgid "Whether this service is @dfn{one-shot}. One-shot services stop immediately after their @code{start} action has completed. @xref{Slots of services,,, shepherd, The GNU Shepherd Manual}, for more info."
60433 #: guix-git/doc/guix.texi:34218
60435 msgid "@code{respawn?} (default: @code{#t})"
60439 #: guix-git/doc/guix.texi:34221
60440 msgid "Whether to restart the service when it stops, for instance when the underlying process dies."
60444 #: guix-git/doc/guix.texi:34222
60450 #: guix-git/doc/guix.texi:34223
60452 msgid "@code{stop} (default: @code{#~(const #f)})"
60456 #: guix-git/doc/guix.texi:34229
60457 msgid "The @code{start} and @code{stop} fields refer to the Shepherd's facilities to start and stop processes (@pxref{Service De- and Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as G-expressions that get expanded in the Shepherd configuration file (@pxref{G-Expressions})."
60461 #: guix-git/doc/guix.texi:34230
60463 msgid "@code{actions} (default: @code{'()})"
60467 #: guix-git/doc/guix.texi:34231
60469 msgid "actions, of Shepherd services"
60473 #: guix-git/doc/guix.texi:34236
60474 msgid "This is a list of @code{shepherd-action} objects (see below) defining @dfn{actions} supported by the service, in addition to the standard @code{start} and @code{stop} actions. Actions listed here become available as @command{herd} sub-commands:"
60478 #: guix-git/doc/guix.texi:34239
60480 msgid "herd @var{action} @var{service} [@var{arguments}@dots{}]\n"
60484 #: guix-git/doc/guix.texi:34241
60486 msgid "@code{auto-start?} (default: @code{#t})"
60490 #: guix-git/doc/guix.texi:34244
60491 msgid "Whether this service should be started automatically by the Shepherd. If it is @code{#f} the service has to be started manually with @code{herd start}."
60495 #: guix-git/doc/guix.texi:34247
60496 msgid "A documentation string, as shown when running:"
60500 #: guix-git/doc/guix.texi:34250
60502 msgid "herd doc @var{service-name}\n"
60506 #: guix-git/doc/guix.texi:34254
60507 msgid "where @var{service-name} is one of the symbols in @code{provision} (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})."
60511 #: guix-git/doc/guix.texi:34255
60513 msgid "@code{modules} (default: @code{%default-modules})"
60517 #: guix-git/doc/guix.texi:34258
60518 msgid "This is the list of modules that must be in scope when @code{start} and @code{stop} are evaluated."
60521 #. type: Plain text
60522 #: guix-git/doc/guix.texi:34266
60523 msgid "The example below defines a Shepherd service that spawns @command{syslogd}, the system logger from the GNU Networking Utilities (@pxref{syslogd invocation, @command{syslogd},, inetutils, GNU Inetutils}):"
60527 #: guix-git/doc/guix.texi:34278
60530 "(let ((config (plain-file \"syslogd.conf\" \"@dots{}\")))\n"
60531 " (shepherd-service\n"
60532 " (documentation \"Run the syslog daemon (syslogd).\")\n"
60533 " (provision '(syslogd))\n"
60534 " (requirement '(user-processes))\n"
60535 " (start #~(make-forkexec-constructor\n"
60536 " (list #$(file-append inetutils \"/libexec/syslogd\")\n"
60537 " \"--rcfile\" #$config)\n"
60538 " #:pid-file \"/var/run/syslog.pid\"))\n"
60539 " (stop #~(make-kill-destructor))))\n"
60542 #. type: Plain text
60543 #: guix-git/doc/guix.texi:34293
60544 msgid "Key elements in this example are the @code{start} and @code{stop} fields: they are @dfn{staged} code snippets that use the @code{make-forkexec-constructor} procedure provided by the Shepherd and its dual, @code{make-kill-destructor} (@pxref{Service De- and Constructors,,, shepherd, The GNU Shepherd Manual}). The @code{start} field will have @command{shepherd} spawn @command{syslogd} with the given option; note that we pass @code{config} after @option{--rcfile}, which is a configuration file declared above (contents of this file are omitted). Likewise, the @code{stop} field tells how this service is to be stopped; in this case, it is stopped by making the @code{kill} system call on its PID@. Code staging is achieved using G-expressions: @code{#~} stages code, while @code{#$} ``escapes'' back to host code (@pxref{G-Expressions})."
60548 #: guix-git/doc/guix.texi:34294
60550 msgid "{Data Type} shepherd-action"
60554 #: guix-git/doc/guix.texi:34297
60555 msgid "This is the data type that defines additional actions implemented by a Shepherd service (see above)."
60559 #: guix-git/doc/guix.texi:34301
60560 msgid "Symbol naming the action."
60564 #: guix-git/doc/guix.texi:34304
60565 msgid "This is a documentation string for the action. It can be viewed by running:"
60569 #: guix-git/doc/guix.texi:34307
60571 msgid "herd doc @var{service} action @var{action}\n"
60575 #: guix-git/doc/guix.texi:34309
60581 #: guix-git/doc/guix.texi:34313
60582 msgid "This should be a gexp that evaluates to a procedure of at least one argument, which is the ``running value'' of the service (@pxref{Slots of services,,, shepherd, The GNU Shepherd Manual})."
60586 #: guix-git/doc/guix.texi:34317
60587 msgid "The following example defines an action called @code{say-hello} that kindly greets the user:"
60591 #: guix-git/doc/guix.texi:34326
60594 "(shepherd-action\n"
60595 " (name 'say-hello)\n"
60596 " (documentation \"Say hi!\")\n"
60597 " (procedure #~(lambda (running . args)\n"
60598 " (format #t \"Hello, friend! arguments: ~s\\n\"\n"
60604 #: guix-git/doc/guix.texi:34329
60605 msgid "Assuming this action is added to the @code{example} service, then you can do:"
60609 #: guix-git/doc/guix.texi:34335
60612 "# herd say-hello example\n"
60613 "Hello, friend! arguments: ()\n"
60614 "# herd say-hello example a b c\n"
60615 "Hello, friend! arguments: (\"a\" \"b\" \"c\")\n"
60619 #: guix-git/doc/guix.texi:34340
60620 msgid "This, as you can see, is a fairly sophisticated way to say hello. @xref{Service Convenience,,, shepherd, The GNU Shepherd Manual}, for more info on actions."
60624 #: guix-git/doc/guix.texi:34342
60626 msgid "{Scheme Variable} shepherd-root-service-type"
60630 #: guix-git/doc/guix.texi:34344
60631 msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1."
60635 #: guix-git/doc/guix.texi:34349
60636 msgid "This is the service type that extensions target when they want to create shepherd services (@pxref{Service Types and Services}, for an example). Each extension must pass a list of @code{<shepherd-service>}. Its value must be a @code{shepherd-configuration}, as described below."
60640 #: guix-git/doc/guix.texi:34351
60642 msgid "{Data Type} shepherd-configuration"
60646 #: guix-git/doc/guix.texi:34353
60647 msgid "This data type represents the Shepherd's configuration."
60651 #: guix-git/doc/guix.texi:34355
60653 msgid "shepherd (default: @code{shepherd})"
60657 #: guix-git/doc/guix.texi:34357
60658 msgid "The Shepherd package to use."
60662 #: guix-git/doc/guix.texi:34358
60664 msgid "services (default: @code{'()})"
60668 #: guix-git/doc/guix.texi:34362
60669 msgid "A list of @code{<shepherd-service>} to start. You should probably use the service extension mechanism instead (@pxref{Shepherd Services})."
60672 #. type: Plain text
60673 #: guix-git/doc/guix.texi:34367
60674 msgid "The following example specifies the Shepherd package for the operating system:"
60678 #: guix-git/doc/guix.texi:34382
60681 "(operating-system\n"
60683 " (services (append (list openssh-service-type))\n"
60685 " %desktop-services)\n"
60687 " ;; Use own Shepherd package.\n"
60688 " (essential-services\n"
60689 " (modify-services (operating-system-default-essential-services\n"
60690 " this-operating-system)\n"
60691 " (shepherd-root-service-type config => (shepherd-configuration\n"
60692 " (inherit config)\n"
60693 " (shepherd my-shepherd))))))\n"
60697 #: guix-git/doc/guix.texi:34384
60699 msgid "{Scheme Variable} %shepherd-root-service"
60703 #: guix-git/doc/guix.texi:34386
60704 msgid "This service represents PID@tie{}1."
60708 #: guix-git/doc/guix.texi:34392
60710 msgid "documentation, searching for"
60714 #: guix-git/doc/guix.texi:34393
60716 msgid "searching for documentation"
60720 #: guix-git/doc/guix.texi:34394
60722 msgid "Info, documentation format"
60726 #: guix-git/doc/guix.texi:34395
60732 #: guix-git/doc/guix.texi:34396
60734 msgid "manual pages"
60737 #. type: Plain text
60738 #: guix-git/doc/guix.texi:34403
60739 msgid "In most cases packages installed with Guix come with documentation. There are two main documentation formats: ``Info'', a browsable hypertext format used for GNU software, and ``manual pages'' (or ``man pages''), the linear documentation format traditionally found on Unix. Info manuals are accessed with the @command{info} command or with Emacs, and man pages are accessed using @command{man}."
60742 #. type: Plain text
60743 #: guix-git/doc/guix.texi:34407
60744 msgid "You can look for documentation of software installed on your system by keyword. For example, the following command searches for information about ``TLS'' in Info manuals:"
60748 #: guix-git/doc/guix.texi:34415
60752 "\"(emacs)Network Security\" -- STARTTLS\n"
60753 "\"(emacs)Network Security\" -- TLS\n"
60754 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_flags\n"
60755 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_function\n"
60759 #. type: Plain text
60760 #: guix-git/doc/guix.texi:34419
60761 msgid "The command below searches for the same keyword in man pages:"
60765 #: guix-git/doc/guix.texi:34425
60769 "SSL (7) - OpenSSL SSL/TLS library\n"
60770 "certtool (1) - GnuTLS certificate tool\n"
60774 #. type: Plain text
60775 #: guix-git/doc/guix.texi:34431
60776 msgid "These searches are purely local to your computer so you have the guarantee that documentation you find corresponds to what you have actually installed, you can access it off-line, and your privacy is respected."
60779 #. type: Plain text
60780 #: guix-git/doc/guix.texi:34434
60781 msgid "Once you have these results, you can view the relevant documentation by running, say:"
60785 #: guix-git/doc/guix.texi:34437
60787 msgid "$ info \"(gnutls)Core TLS API\"\n"
60790 #. type: Plain text
60791 #: guix-git/doc/guix.texi:34441
60796 #: guix-git/doc/guix.texi:34444
60798 msgid "$ man certtool\n"
60801 #. type: Plain text
60802 #: guix-git/doc/guix.texi:34452
60803 msgid "Info manuals contain sections and indices as well as hyperlinks like those found in Web pages. The @command{info} reader (@pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}) and its Emacs counterpart (@pxref{Misc Help,,, emacs, The GNU Emacs Manual}) provide intuitive key bindings to navigate manuals. @xref{Getting Started,,, info, Info: An Introduction}, for an introduction to Info navigation."
60807 #: guix-git/doc/guix.texi:34456
60809 msgid "debugging files"
60812 #. type: Plain text
60813 #: guix-git/doc/guix.texi:34462
60814 msgid "Program binaries, as produced by the GCC compilers for instance, are typically written in the ELF format, with a section containing @dfn{debugging information}. Debugging information is what allows the debugger, GDB, to map binary code to source code; it is required to debug a compiled program in good conditions."
60817 #. type: Plain text
60818 #: guix-git/doc/guix.texi:34466
60819 msgid "This chapter explains how to use separate debug info when packages provide it, and how to rebuild packages with debug info when it's missing."
60822 #. type: Plain text
60823 #: guix-git/doc/guix.texi:34482
60824 msgid "The problem with debugging information is that is takes up a fair amount of disk space. For example, debugging information for the GNU C Library weighs in at more than 60 MiB@. Thus, as a user, keeping all the debugging info of all the installed programs is usually not an option. Yet, space savings should not come at the cost of an impediment to debugging---especially in the GNU system, which should make it easier for users to exert their computing freedom (@pxref{GNU Distribution})."
60827 #. type: Plain text
60828 #: guix-git/doc/guix.texi:34489
60829 msgid "Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism that allows users to get the best of both worlds: debugging information can be stripped from the binaries and stored in separate files. GDB is then able to load debugging information from those files, when they are available (@pxref{Separate Debug Files,,, gdb, Debugging with GDB})."
60832 #. type: Plain text
60833 #: guix-git/doc/guix.texi:34497
60834 msgid "The GNU distribution takes advantage of this by storing debugging information in the @code{lib/debug} sub-directory of a separate package output unimaginatively called @code{debug} (@pxref{Packages with Multiple Outputs}). Users can choose to install the @code{debug} output of a package when they need it. For instance, the following command installs the debugging information for the GNU C Library and for GNU Guile:"
60838 #: guix-git/doc/guix.texi:34500
60840 msgid "guix install glibc:debug guile:debug\n"
60843 #. type: Plain text
60844 #: guix-git/doc/guix.texi:34506
60845 msgid "GDB must then be told to look for debug files in the user's profile, by setting the @code{debug-file-directory} variable (consider setting it from the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with GDB}):"
60849 #: guix-git/doc/guix.texi:34509
60851 msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n"
60854 #. type: Plain text
60855 #: guix-git/doc/guix.texi:34513
60856 msgid "From there on, GDB will pick up debugging information from the @file{.debug} files under @file{~/.guix-profile/lib/debug}."
60859 #. type: Plain text
60860 #: guix-git/doc/guix.texi:34520
60861 msgid "In addition, you will most likely want GDB to be able to show the source code being debugged. To do that, you will have to unpack the source code of the package of interest (obtained with @code{guix build --source}, @pxref{Invoking guix build}), and to point GDB to that source directory using the @code{directory} command (@pxref{Source Path, @code{directory},, gdb, Debugging with GDB})."
60864 #. type: Plain text
60865 #: guix-git/doc/guix.texi:34528
60866 msgid "The @code{debug} output mechanism in Guix is implemented by the @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is opt-in---debugging information is available only for the packages with definitions explicitly declaring a @code{debug} output. To check whether a package has a @code{debug} output, use @command{guix package --list-available} (@pxref{Invoking guix package})."
60869 #. type: Plain text
60870 #: guix-git/doc/guix.texi:34530
60871 msgid "Read on for how to deal with packages lacking a @code{debug} output."
60874 #. type: Plain text
60875 #: guix-git/doc/guix.texi:34542
60876 msgid "As we saw above, some packages, but not all, provide debugging info in a @code{debug} output. What can you do when debugging info is missing? The @option{--with-debug-info} option provides a solution to that: it allows you to rebuild the package(s) for which debugging info is missing---and only those---and to graft those onto the application you're debugging. Thus, while it's not as fast as installing a @code{debug} output, it is relatively inexpensive."
60879 #. type: Plain text
60880 #: guix-git/doc/guix.texi:34547
60881 msgid "Let's illustrate that. Suppose you're experiencing a bug in Inkscape and would like to see what's going on in GLib, a library that's deep down in its dependency graph. As it turns out, GLib does not have a @code{debug} output and the backtrace GDB shows is all sadness:"
60885 #: guix-git/doc/guix.texi:34558
60889 "#0 0x00007ffff5f92190 in g_getenv ()\n"
60890 " from /gnu/store/@dots{}-glib-2.62.6/lib/libglib-2.0.so.0\n"
60891 "#1 0x00007ffff608a7d6 in gobject_init_ctor ()\n"
60892 " from /gnu/store/@dots{}-glib-2.62.6/lib/libgobject-2.0.so.0\n"
60893 "#2 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=1, argv=argv@@entry=0x7fffffffcfd8, \n"
60894 " env=env@@entry=0x7fffffffcfe8) at dl-init.c:72\n"
60895 "#3 0x00007ffff7fe2866 in call_init (env=0x7fffffffcfe8, argv=0x7fffffffcfd8, argc=1, l=<optimized out>)\n"
60896 " at dl-init.c:118\n"
60899 #. type: Plain text
60900 #: guix-git/doc/guix.texi:34562
60901 msgid "To address that, you install Inkscape linked against a variant GLib that contains debug info:"
60904 #. type: Plain text
60905 #: guix-git/doc/guix.texi:34568
60906 msgid "This time, debugging will be a whole lot nicer:"
60910 #: guix-git/doc/guix.texi:34586
60913 "$ gdb --args sh -c 'exec inkscape'\n"
60915 "(gdb) b g_getenv\n"
60916 "Function \"g_getenv\" not defined.\n"
60917 "Make breakpoint pending on future shared library load? (y or [n]) y\n"
60918 "Breakpoint 1 (g_getenv) pending.\n"
60920 "Starting program: /gnu/store/@dots{}-profile/bin/sh -c exec\\ inkscape\n"
60923 "#0 g_getenv (variable=variable@@entry=0x7ffff60c7a2e \"GOBJECT_DEBUG\") at ../glib-2.62.6/glib/genviron.c:252\n"
60924 "#1 0x00007ffff608a7d6 in gobject_init () at ../glib-2.62.6/gobject/gtype.c:4380\n"
60925 "#2 gobject_init_ctor () at ../glib-2.62.6/gobject/gtype.c:4493\n"
60926 "#3 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=3, argv=argv@@entry=0x7fffffffd088, \n"
60927 " env=env@@entry=0x7fffffffd0a8) at dl-init.c:72\n"
60931 #. type: Plain text
60932 #: guix-git/doc/guix.texi:34589
60933 msgid "Much better!"
60936 #. type: Plain text
60937 #: guix-git/doc/guix.texi:34593
60938 msgid "Note that there can be packages for which @option{--with-debug-info} will not have the desired effect. @xref{Package Transformation Options, @option{--with-debug-info}}, for more information."
60942 #: guix-git/doc/guix.texi:34597
60944 msgid "security updates"
60947 #. type: Plain text
60948 #: guix-git/doc/guix.texi:34606
60949 msgid "Occasionally, important security vulnerabilities are discovered in software packages and must be patched. Guix developers try hard to keep track of known vulnerabilities and to apply fixes as soon as possible in the @code{master} branch of Guix (we do not yet provide a ``stable'' branch containing only security updates). The @command{guix lint} tool helps developers find out about vulnerable versions of software packages in the distribution:"
60952 #. type: smallexample
60953 #: guix-git/doc/guix.texi:34613
60956 "$ guix lint -c cve\n"
60957 "gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547\n"
60958 "gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276\n"
60959 "gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924\n"
60963 #. type: Plain text
60964 #: guix-git/doc/guix.texi:34616
60965 msgid "@xref{Invoking guix lint}, for more information."
60968 #. type: Plain text
60969 #: guix-git/doc/guix.texi:34625
60970 msgid "Guix follows a functional package management discipline (@pxref{Introduction}), which implies that, when a package is changed, @emph{every package that depends on it} must be rebuilt. This can significantly slow down the deployment of fixes in core packages such as libc or Bash, since basically the whole distribution would need to be rebuilt. Using pre-built binaries helps (@pxref{Substitutes}), but deployment may still take more time than desired."
60974 #: guix-git/doc/guix.texi:34626
60979 #. type: Plain text
60980 #: guix-git/doc/guix.texi:34634
60981 msgid "To address this, Guix implements @dfn{grafts}, a mechanism that allows for fast deployment of critical updates without the costs associated with a whole-distribution rebuild. The idea is to rebuild only the package that needs to be patched, and then to ``graft'' it onto packages explicitly installed by the user and that were previously referring to the original package. The cost of grafting is typically very low, and order of magnitudes lower than a full rebuild of the dependency chain."
60985 #: guix-git/doc/guix.texi:34635
60987 msgid "replacements of packages, for grafts"
60990 #. type: Plain text
60991 #: guix-git/doc/guix.texi:34641
60992 msgid "For instance, suppose a security update needs to be applied to Bash. Guix developers will provide a package definition for the ``fixed'' Bash, say @code{bash-fixed}, in the usual way (@pxref{Defining Packages}). Then, the original package definition is augmented with a @code{replacement} field pointing to the package containing the bug fix:"
60996 #: guix-git/doc/guix.texi:34648
61001 " (name \"bash\")\n"
61003 " (replacement bash-fixed)))\n"
61006 #. type: Plain text
61007 #: guix-git/doc/guix.texi:34658
61008 msgid "From there on, any package depending directly or indirectly on Bash---as reported by @command{guix gc --requisites} (@pxref{Invoking guix gc})---that is installed is automatically ``rewritten'' to refer to @code{bash-fixed} instead of @code{bash}. This grafting process takes time proportional to the size of the package, usually less than a minute for an ``average'' package on a recent machine. Grafting is recursive: when an indirect dependency requires grafting, then grafting ``propagates'' up to the package that the user is installing."
61011 #. type: Plain text
61012 #: guix-git/doc/guix.texi:34666
61013 msgid "Currently, the length of the name and version of the graft and that of the package it replaces (@code{bash-fixed} and @code{bash} in the example above) must be equal. This restriction mostly comes from the fact that grafting works by patching files, including binary files, directly. Other restrictions may apply: for instance, when adding a graft to a package providing a shared library, the original shared library and its replacement must have the same @code{SONAME} and be binary-compatible."
61016 #. type: Plain text
61017 #: guix-git/doc/guix.texi:34670
61018 msgid "The @option{--no-grafts} command-line option allows you to forcefully avoid grafting (@pxref{Common Build Options, @option{--no-grafts}}). Thus, the command:"
61022 #: guix-git/doc/guix.texi:34673
61024 msgid "guix build bash --no-grafts\n"
61027 #. type: Plain text
61028 #: guix-git/doc/guix.texi:34677
61029 msgid "returns the store file name of the original Bash, whereas:"
61033 #: guix-git/doc/guix.texi:34680
61035 msgid "guix build bash\n"
61038 #. type: Plain text
61039 #: guix-git/doc/guix.texi:34685
61040 msgid "returns the store file name of the ``fixed'', replacement Bash. This allows you to distinguish between the two variants of Bash."
61043 #. type: Plain text
61044 #: guix-git/doc/guix.texi:34688
61045 msgid "To verify which Bash your whole profile refers to, you can run (@pxref{Invoking guix gc}):"
61049 #: guix-git/doc/guix.texi:34691
61051 msgid "guix gc -R $(readlink -f ~/.guix-profile) | grep bash\n"
61054 #. type: Plain text
61055 #: guix-git/doc/guix.texi:34696
61056 msgid "@dots{} and compare the store file names that you get with those above. Likewise for a complete Guix system generation:"
61060 #: guix-git/doc/guix.texi:34699
61062 msgid "guix gc -R $(guix system build my-config.scm) | grep bash\n"
61065 #. type: Plain text
61066 #: guix-git/doc/guix.texi:34703
61067 msgid "Lastly, to check which Bash running processes are using, you can use the @command{lsof} command:"
61071 #: guix-git/doc/guix.texi:34706
61073 msgid "lsof | grep /gnu/store/.*bash\n"
61077 #: guix-git/doc/guix.texi:34714
61079 msgid "bootstrapping"
61082 #. type: Plain text
61083 #: guix-git/doc/guix.texi:34721
61084 msgid "Bootstrapping in our context refers to how the distribution gets built ``from nothing''. Remember that the build environment of a derivation contains nothing but its declared inputs (@pxref{Introduction}). So there's an obvious chicken-and-egg problem: how does the first package get built? How does the first compiler get compiled?"
61087 #. type: Plain text
61088 #: guix-git/doc/guix.texi:34729
61089 msgid "It is tempting to think of this question as one that only die-hard hackers may care about. However, while the answer to that question is technical in nature, its implications are wide-ranging. How the distribution is bootstrapped defines the extent to which we, as individuals and as a collective of users and hackers, can trust the software we run. It is a central concern from the standpoint of @emph{security} and from a @emph{user freedom} viewpoint."
61093 #: guix-git/doc/guix.texi:34730 guix-git/doc/guix.texi:34942
61095 msgid "bootstrap binaries"
61098 #. type: Plain text
61099 #: guix-git/doc/guix.texi:34740
61100 msgid "The GNU system is primarily made of C code, with libc at its core. The GNU build system itself assumes the availability of a Bourne shell and command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep'. Furthermore, build programs---programs that run @code{./configure}, @code{make}, etc.---are written in Guile Scheme (@pxref{Derivations}). Consequently, to be able to build anything at all, from scratch, Guix relies on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages mentioned above---the @dfn{bootstrap binaries}."
61103 #. type: Plain text
61104 #: guix-git/doc/guix.texi:34744
61105 msgid "These bootstrap binaries are ``taken for granted'', though we can also re-create them if needed (@pxref{Preparing to Use the Bootstrap Binaries})."
61109 #: guix-git/doc/guix.texi:34751
61111 msgid "The Reduced Binary Seed Bootstrap"
61114 #. type: Plain text
61115 #: guix-git/doc/guix.texi:34758
61116 msgid "Guix---like other GNU/Linux distributions---is traditionally bootstrapped from a set of bootstrap binaries: Bourne shell, command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep' and Guile, GCC, Binutils, and the GNU C Library (@pxref{Bootstrapping}). Usually, these bootstrap binaries are ``taken for granted.''"
61119 #. type: Plain text
61120 #: guix-git/doc/guix.texi:34764
61121 msgid "Taking the bootstrap binaries for granted means that we consider them to be a correct and trustworthy ``seed'' for building the complete system. Therein lies a problem: the combined size of these bootstrap binaries is about 250MB (@pxref{Bootstrappable Builds,,, mes, GNU Mes}). Auditing or even inspecting these is next to impossible."
61124 #. type: Plain text
61125 #: guix-git/doc/guix.texi:34769
61126 msgid "For @code{i686-linux} and @code{x86_64-linux}, Guix now features a ``Reduced Binary Seed'' bootstrap @footnote{We would like to say: ``Full Source Bootstrap'' and while we are working towards that goal it would be hyperbole to use that term for what we do now.}."
61129 #. type: Plain text
61130 #: guix-git/doc/guix.texi:34775
61131 msgid "The Reduced Binary Seed bootstrap removes the most critical tools---from a trust perspective---from the bootstrap binaries: GCC, Binutils and the GNU C Library are replaced by: @code{bootstrap-mescc-tools} (a tiny assembler and linker) and @code{bootstrap-mes} (a small Scheme Interpreter and a C compiler written in Scheme and the Mes C Library, built for TinyCC and for GCC)."
61134 #. type: Plain text
61135 #: guix-git/doc/guix.texi:34780
61136 msgid "Using these new binary seeds the ``missing'' Binutils, GCC, and the GNU C Library are built from source. From here on the more traditional bootstrap process resumes. This approach has reduced the bootstrap binaries in size to about 145MB in Guix v1.1."
61139 #. type: Plain text
61140 #: guix-git/doc/guix.texi:34788
61141 msgid "The next step that Guix has taken is to replace the shell and all its utilities with implementations in Guile Scheme, the @emph{Scheme-only bootstrap}. Gash (@pxref{Gash,,, gash, The Gash manual}) is a POSIX-compatible shell that replaces Bash, and it comes with Gash Utils which has minimalist replacements for Awk, the GNU Core Utilities, Grep, Gzip, Sed, and Tar. The rest of the bootstrap binary seeds that were removed are now built from source."
61144 #. type: Plain text
61145 #: guix-git/doc/guix.texi:34798
61146 msgid "Building the GNU System from source is currently only possible by adding some historical GNU packages as intermediate steps@footnote{Packages such as @code{gcc-2.95.3}, @code{binutils-2.14}, @code{glibc-2.2.5}, @code{gzip-1.2.4}, @code{tar-1.22}, and some others. For details, see @file{gnu/packages/commencement.scm}.}. As Gash and Gash Utils mature, and GNU packages become more bootstrappable again (e.g., new releases of GNU Sed will also ship as gzipped tarballs again, as alternative to the hard to bootstrap @code{xz}-compression), this set of added packages can hopefully be reduced again."
61149 #. type: Plain text
61150 #: guix-git/doc/guix.texi:34802
61151 msgid "The graph below shows the resulting dependency graph for @code{gcc-core-mesboot0}, the bootstrap compiler used for the traditional bootstrap of the rest of the Guix System."
61154 #. type: Plain text
61155 #: guix-git/doc/guix.texi:34805
61156 msgid "@image{images/gcc-core-mesboot0-graph,6in,,Dependency graph of gcc-core-mesboot0}"
61159 #. type: Plain text
61160 #: guix-git/doc/guix.texi:34812
61161 msgid "The only significant binary bootstrap seeds that remain@footnote{ Ignoring the 68KB @code{mescc-tools}; that will be removed later, together with @code{mes}.} are a Scheme interpreter and a Scheme compiler: GNU Mes and GNU Guile@footnote{Not shown in this graph are the static binaries for @file{bash}, @code{tar}, and @code{xz} that are used to get Guile running.}."
61164 #. type: Plain text
61165 #: guix-git/doc/guix.texi:34815
61166 msgid "This further reduction has brought down the size of the binary seed to about 60MB for @code{i686-linux} and @code{x86_64-linux}."
61169 #. type: Plain text
61170 #: guix-git/doc/guix.texi:34820
61171 msgid "Work is ongoing to remove all binary blobs from our free software bootstrap stack, working towards a Full Source Bootstrap. Also ongoing is work to bring these bootstraps to the @code{arm-linux} and @code{aarch64-linux} architectures and to the Hurd."
61174 #. type: Plain text
61175 #: guix-git/doc/guix.texi:34824
61176 msgid "If you are interested, join us on @samp{#bootstrappable} on the Freenode IRC network or discuss on @email{bug-mes@@gnu.org} or @email{gash-devel@@nongnu.org}."
61179 #. type: Plain text
61180 #: guix-git/doc/guix.texi:34831
61181 msgid "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations}"
61184 #. type: Plain text
61185 #: guix-git/doc/guix.texi:34836
61186 msgid "The figure above shows the very beginning of the dependency graph of the distribution, corresponding to the package definitions of the @code{(gnu packages bootstrap)} module. A similar figure can be generated with @command{guix graph} (@pxref{Invoking guix graph}), along the lines of:"
61190 #: guix-git/doc/guix.texi:34841
61193 "guix graph -t derivation \\\n"
61194 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n"
61195 " | dot -Tps > gcc.ps\n"
61198 #. type: Plain text
61199 #: guix-git/doc/guix.texi:34844
61200 msgid "or, for the further Reduced Binary Seed bootstrap"
61204 #: guix-git/doc/guix.texi:34849
61207 "guix graph -t derivation \\\n"
61208 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-mes)' \\\n"
61209 " | dot -Tps > mes.ps\n"
61212 #. type: Plain text
61213 #: guix-git/doc/guix.texi:34858
61214 msgid "At this level of detail, things are slightly complex. First, Guile itself consists of an ELF executable, along with many source and compiled Scheme files that are dynamically loaded when it runs. This gets stored in the @file{guile-2.0.7.tar.xz} tarball shown in this graph. This tarball is part of Guix's ``source'' distribution, and gets inserted into the store with @code{add-to-store} (@pxref{The Store})."
61217 #. type: Plain text
61218 #: guix-git/doc/guix.texi:34867
61219 msgid "But how do we write a derivation that unpacks this tarball and adds it to the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} derivation---the first one that gets built---uses @code{bash} as its builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls @code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, @file{xz}, and @file{mkdir} are statically-linked binaries, also part of the Guix source distribution, whose sole purpose is to allow the Guile tarball to be unpacked."
61222 #. type: Plain text
61223 #: guix-git/doc/guix.texi:34879
61224 msgid "Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile that can be used to run subsequent build programs. Its first task is to download tarballs containing the other pre-built binaries---this is what the @file{.tar.xz.drv} derivations do. Guix modules such as @code{ftp-client.scm} are used for this purpose. The @code{module-import.drv} derivations import those modules in a directory in the store, using the original layout. The @code{module-import-compiled.drv} derivations compile those modules, and write them in an output directory with the right layout. This corresponds to the @code{#:modules} argument of @code{build-expression->derivation} (@pxref{Derivations})."
61227 #. type: Plain text
61228 #: guix-git/doc/guix.texi:34884
61229 msgid "Finally, the various tarballs are unpacked by the derivations @code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, or @code{bootstrap-mes-0.drv} and @code{bootstrap-mescc-tools-0.drv}, at which point we have a working C tool chain."
61232 #. type: unnumberedsec
61233 #: guix-git/doc/guix.texi:34885
61235 msgid "Building the Build Tools"
61238 #. type: Plain text
61239 #: guix-git/doc/guix.texi:34894
61240 msgid "Bootstrapping is complete when we have a full tool chain that does not depend on the pre-built bootstrap tools discussed above. This no-dependency requirement is verified by checking whether the files of the final tool chain contain references to the @file{/gnu/store} directories of the bootstrap inputs. The process that leads to this ``final'' tool chain is described by the package definitions found in the @code{(gnu packages commencement)} module."
61243 #. type: Plain text
61244 #: guix-git/doc/guix.texi:34901
61245 msgid "The @command{guix graph} command allows us to ``zoom out'' compared to the graph above, by looking at the level of package objects instead of individual derivations---remember that a package may translate to several derivations, typically one derivation to download its source, one to build the Guile modules it needs, and one to actually build the package from source. The command:"
61249 #: guix-git/doc/guix.texi:34906
61252 "guix graph -t bag \\\n"
61253 " -e '(@@@@ (gnu packages commencement)\n"
61254 " glibc-final-with-bootstrap-bash)' | xdot -\n"
61257 #. type: Plain text
61258 #: guix-git/doc/guix.texi:34913
61259 msgid "displays the dependency graph leading to the ``final'' C library@footnote{You may notice the @code{glibc-intermediate} label, suggesting that it is not @emph{quite} final, but as a good approximation, we will consider it final.}, depicted below."
61262 #. type: Plain text
61263 #: guix-git/doc/guix.texi:34915
61264 msgid "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}"
61267 #. type: Plain text
61268 #: guix-git/doc/guix.texi:34921
61269 msgid "The first tool that gets built with the bootstrap binaries is GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite for all the following packages. From there Findutils and Diffutils get built."
61272 #. type: Plain text
61273 #: guix-git/doc/guix.texi:34926
61274 msgid "Then come the first-stage Binutils and GCC, built as pseudo cross tools---i.e., with @option{--target} equal to @option{--host}. They are used to build libc. Thanks to this cross-build trick, this libc is guaranteed not to hold any reference to the initial tool chain."
61277 #. type: Plain text
61278 #: guix-git/doc/guix.texi:34932
61279 msgid "From there the final Binutils and GCC (not shown above) are built. GCC uses @command{ld} from the final Binutils, and links programs against the just-built libc. This tool chain is used to build the other packages used by Guix and by the GNU Build System: Guile, Bash, Coreutils, etc."
61282 #. type: Plain text
61283 #: guix-git/doc/guix.texi:34938
61284 msgid "And voilà! At this point we have the complete set of build tools that the GNU Build System expects. These are in the @code{%final-inputs} variable of the @code{(gnu packages commencement)} module, and are implicitly used by any package that uses @code{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})."
61287 #. type: unnumberedsec
61288 #: guix-git/doc/guix.texi:34940
61290 msgid "Building the Bootstrap Binaries"
61293 #. type: Plain text
61294 #: guix-git/doc/guix.texi:34947
61295 msgid "Because the final tool chain does not depend on the bootstrap binaries, those rarely need to be updated. Nevertheless, it is useful to have an automated way to produce them, should an update occur, and this is what the @code{(gnu packages make-bootstrap)} module provides."
61298 #. type: Plain text
61299 #: guix-git/doc/guix.texi:34953
61300 msgid "The following command builds the tarballs containing the bootstrap binaries (Binutils, GCC, glibc, for the traditional bootstrap and linux-libre-headers, bootstrap-mescc-tools, bootstrap-mes for the Reduced Binary Seed bootstrap, and Guile, and a tarball containing a mixture of Coreutils and other basic command-line tools):"
61304 #: guix-git/doc/guix.texi:34956
61306 msgid "guix build bootstrap-tarballs\n"
61309 #. type: Plain text
61310 #: guix-git/doc/guix.texi:34961
61311 msgid "The generated tarballs are those that should be referred to in the @code{(gnu packages bootstrap)} module mentioned at the beginning of this section."
61314 #. type: Plain text
61315 #: guix-git/doc/guix.texi:34967
61316 msgid "Still here? Then perhaps by now you've started to wonder: when do we reach a fixed point? That is an interesting question! The answer is unknown, but if you would like to investigate further (and have significant computational and storage resources to do so), then let us know."
61319 #. type: unnumberedsec
61320 #: guix-git/doc/guix.texi:34968
61322 msgid "Reducing the Set of Bootstrap Binaries"
61325 #. type: Plain text
61326 #: guix-git/doc/guix.texi:34976
61327 msgid "Our traditional bootstrap includes GCC, GNU Libc, Guile, etc. That's a lot of binary code! Why is that a problem? It's a problem because these big chunks of binary code are practically non-auditable, which makes it hard to establish what source code produced them. Every unauditable binary also leaves us vulnerable to compiler backdoors as described by Ken Thompson in the 1984 paper @emph{Reflections on Trusting Trust}."
61330 #. type: Plain text
61331 #: guix-git/doc/guix.texi:34982
61332 msgid "This is mitigated by the fact that our bootstrap binaries were generated from an earlier Guix revision. Nevertheless it lacks the level of transparency that we get in the rest of the package dependency graph, where Guix always gives us a source-to-binary mapping. Thus, our goal is to reduce the set of bootstrap binaries to the bare minimum."
61335 #. type: Plain text
61336 #: guix-git/doc/guix.texi:34988
61337 msgid "The @uref{https://bootstrappable.org, Bootstrappable.org web site} lists on-going projects to do that. One of these is about replacing the bootstrap GCC with a sequence of assemblers, interpreters, and compilers of increasing complexity, which could be built from source starting from a simple and auditable assembler."
61340 #. type: Plain text
61341 #: guix-git/doc/guix.texi:34997
61342 msgid "Our first major achievement is the replacement of of GCC, the GNU C Library and Binutils by MesCC-Tools (a simple hex linker and macro assembler) and Mes (@pxref{Top, GNU Mes Reference Manual,, mes, GNU Mes}, a Scheme interpreter and C compiler in Scheme). Neither MesCC-Tools nor Mes can be fully bootstrapped yet and thus we inject them as binary seeds. We call this the Reduced Binary Seed bootstrap, as it has halved the size of our bootstrap binaries! Also, it has eliminated the C compiler binary; i686-linux and x86_64-linux Guix packages are now bootstrapped without any binary C compiler."
61345 #. type: Plain text
61346 #: guix-git/doc/guix.texi:35000
61347 msgid "Work is ongoing to make MesCC-Tools and Mes fully bootstrappable and we are also looking at any other bootstrap binaries. Your help is welcome!"
61351 #: guix-git/doc/guix.texi:35002
61353 msgid "Porting to a New Platform"
61356 #. type: Plain text
61357 #: guix-git/doc/guix.texi:35011
61358 msgid "As discussed above, the GNU distribution is self-contained, and self-containment is achieved by relying on pre-built ``bootstrap binaries'' (@pxref{Bootstrapping}). These binaries are specific to an operating system kernel, CPU architecture, and application binary interface (ABI). Thus, to port the distribution to a platform that is not yet supported, one must build those bootstrap binaries, and update the @code{(gnu packages bootstrap)} module to use them on that platform."
61361 #. type: Plain text
61362 #: guix-git/doc/guix.texi:35016
61363 msgid "Fortunately, Guix can @emph{cross compile} those bootstrap binaries. When everything goes well, and assuming the GNU tool chain supports the target platform, this can be as simple as running a command like this one:"
61367 #: guix-git/doc/guix.texi:35019
61369 msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n"
61372 #. type: Plain text
61373 #: guix-git/doc/guix.texi:35026
61374 msgid "For this to work, the @code{glibc-dynamic-linker} procedure in @code{(gnu packages bootstrap)} must be augmented to return the right file name for libc's dynamic linker on that platform; likewise, @code{system->linux-architecture} in @code{(gnu packages linux)} must be taught about the new platform."
61377 #. type: Plain text
61378 #: guix-git/doc/guix.texi:35035
61379 msgid "Once these are built, the @code{(gnu packages bootstrap)} module needs to be updated to refer to these binaries on the target platform. That is, the hashes and URLs of the bootstrap tarballs for the new platform must be added alongside those of the currently supported platforms. The bootstrap Guile tarball is treated specially: it is expected to be available locally, and @file{gnu/local.mk} has rules to download it for the supported architectures; a rule for the new platform must be added as well."
61382 #. type: Plain text
61383 #: guix-git/doc/guix.texi:35044
61384 msgid "In practice, there may be some complications. First, it may be that the extended GNU triplet that specifies an ABI (like the @code{eabi} suffix above) is not recognized by all the GNU tools. Typically, glibc recognizes some of these, whereas GCC uses an extra @option{--with-abi} configure flag (see @code{gcc.scm} for examples of how to handle this). Second, some of the required packages could fail to build for that platform. Lastly, the generated binaries could be broken for some reason."
61388 #: guix-git/doc/guix.texi:35046
61390 msgid "contributing.texi"
61391 msgstr "contributing.sk.texi"
61393 #. type: Plain text
61394 #: guix-git/doc/guix.texi:35059
61395 msgid "Guix is based on the @uref{https://nixos.org/nix/, Nix package manager}, which was designed and implemented by Eelco Dolstra, with contributions from other people (see the @file{nix/AUTHORS} file in Guix). Nix pioneered functional package management, and promoted unprecedented features, such as transactional package upgrades and rollbacks, per-user profiles, and referentially transparent build processes. Without this work, Guix would not exist."
61398 #. type: Plain text
61399 #: guix-git/doc/guix.texi:35062
61400 msgid "The Nix-based software distributions, Nixpkgs and NixOS, have also been an inspiration for Guix."
61403 #. type: Plain text
61404 #: guix-git/doc/guix.texi:35068
61405 msgid "GNU@tie{}Guix itself is a collective work with contributions from a number of people. See the @file{AUTHORS} file in Guix for more information on these fine people. The @file{THANKS} file lists people who have helped by reporting bugs, taking care of the infrastructure, providing artwork and themes, making suggestions, and more---thank you!"
61409 #: guix-git/doc/guix.texi:35073
61411 msgid "license, GNU Free Documentation License"
61415 #: guix-git/doc/guix.texi:35074
61417 msgid "fdl-1.3.texi"