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-06 13:33+0200\n"
10 "PO-Revision-Date: 2021-05-05 03:02+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.6.1\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 "zásady správania, prispievateľov"
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"
98 msgstr "Zásady pridávania balíkov"
101 #: guix-git/doc/contributing.texi:32
102 msgid "Growing the distribution."
103 msgstr "Rast distribúcie."
106 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:873
107 #: guix-git/doc/contributing.texi:874
110 msgstr "Štýl kódovania"
113 #: guix-git/doc/contributing.texi:32
114 msgid "Hygiene of the contributor."
115 msgstr "Návyky prispievateľa."
118 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:972
119 #: guix-git/doc/contributing.texi:973
121 msgid "Submitting Patches"
122 msgstr "Odovzdávanie záplat"
125 #: guix-git/doc/contributing.texi:32
126 msgid "Share your work."
127 msgstr "Zdieľajte vašu prácu."
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"
134 msgstr "Sledovanie chýb a záplat"
137 #: guix-git/doc/contributing.texi:32
138 msgid "Using Debbugs."
139 msgstr "Používanie 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"
146 msgstr "Právo na úpravu"
149 #: guix-git/doc/contributing.texi:32
150 msgid "Pushing to the official repository."
151 msgstr "Odosielanie úprav do oficiálneho repozitára."
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"
158 msgstr "Aktualizácia balíka Guix"
161 #: guix-git/doc/contributing.texi:32
162 msgid "Updating the Guix package definition."
163 msgstr "Aktualizovať zadanie balíka Guix."
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:"
168 msgstr "Ak chcete pracovať na Guixe samotnom, odporúčame vám použiť najnovšiu verziu z Git repozitára:"
171 #: guix-git/doc/contributing.texi:42
173 msgid "git clone https://git.savannah.gnu.org/git/guix.git\n"
174 msgstr "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"
180 msgstr "overenie, miestneho Git repozitára Guixu"
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}):"
185 msgstr "Ako sa uistíte, že ste získali pravú kópiu repozitára? Spustite @command{guix git authenticate} a ako parametre použite číslo úpravy (commit) a OpenPGP odtlačok @dfn{úvodu kanála} (@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"
195 "git fetch origin keyring:keyring\n"
196 "guix git authenticate 9edb3f66fd807b096b48283debdcddccfea34bad \\\n"
197 " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\"\n"
200 #: guix-git/doc/contributing.texi:61
201 msgid "This command completes with exit code zero on success; it prints an error message and exits with a non-zero code otherwise."
202 msgstr "Tento príkaz má v prípade úspešného ukončenia nulovú návratovú hodnotu; v opačnom prípade zobrazí chybové hlásenie a vráti nenulovú hodnotu."
205 #: guix-git/doc/contributing.texi:68
206 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 msgstr "Ako vidíte, je to rovnaký problém ako v prípade sliepky a vajca: najprv musíte mať nainštalovaný Guix. Obyčajne by ste si nainštalovali Guix ako samostatný systém (@pxref{System Installation}) alebo ako doplnkového správcu balíkov na inej distribúcii (@pxref{Binary Installation}); v každom prípade by ste si overili OpenPGP podpis na inštalačnom nosiči. Toto predstavuje začiatok reťazca dôvery."
210 #: guix-git/doc/contributing.texi:73
211 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 msgstr "Najjednoduchší spôsob nastavenia vývojového prostredia pre Guix je samozrejme s použitím Guixu! Nasledovný príkaz spustí nový shell so všetkými závislosťami a premennými prostrediami potrebnými na prácu s Guixom:"
215 #: guix-git/doc/contributing.texi:76
217 msgid "guix environment guix --pure\n"
218 msgstr "guix environment guix --pure\n"
221 #: guix-git/doc/contributing.texi:79
222 msgid "@xref{Invoking guix environment}, for more information on that command."
223 msgstr "@xref{Invoking guix environment}, pre viac podrobností o tomto príkaze."
226 #: guix-git/doc/contributing.texi:83
227 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 msgstr "Ak nemáte možnosť použiť Guix na zostavenie Guixu zo zdrojových súborov, budete ešte okrem balíkov spomenutých v návode na inštaláciu (@pxref{Requirements}) potrebovať aj nasledovné balíky."
231 #: guix-git/doc/contributing.texi:85
233 msgid "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
234 msgstr "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
237 #: guix-git/doc/contributing.texi:86
239 msgid "@url{https://gnu.org/software/automake/, GNU Automake};"
240 msgstr "@url{https://gnu.org/software/automake/, GNU Automake};"
243 #: guix-git/doc/contributing.texi:87
245 msgid "@url{https://gnu.org/software/gettext/, GNU Gettext};"
246 msgstr "@url{https://gnu.org/software/gettext/, GNU Gettext};"
249 #: guix-git/doc/contributing.texi:88
251 msgid "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
252 msgstr "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
255 #: guix-git/doc/contributing.texi:89
257 msgid "@url{https://www.graphviz.org/, Graphviz};"
258 msgstr "@url{https://www.graphviz.org/, Graphviz};"
261 #: guix-git/doc/contributing.texi:90
263 msgid "@url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}."
264 msgstr "@url{https://www.gnu.org/software/help2man/, GNU Help2man (nepovinné)}."
267 #: guix-git/doc/contributing.texi:95
268 msgid "On Guix, extra dependencies can be added by instead running @command{guix environment} with @option{--ad-hoc}:"
269 msgstr "S Guixom môžete pridať dodatočné závislosti pomocou príkazu @command{guix environment} s prepínačom @option{--ad-hoc}:"
272 #: guix-git/doc/contributing.texi:98
274 msgid "guix environment guix --pure --ad-hoc help2man git strace\n"
275 msgstr "guix environment guix --pure --ad-hoc help2man git strace\n"
278 #: guix-git/doc/contributing.texi:102
279 msgid "Run @command{./bootstrap} to generate the build system infrastructure using Autoconf and Automake. If you get an error like this one:"
280 msgstr "Spustite @command{./bootstrap} pre vytvorenie kostry zostavovacieho systému pomocou nástrojov Autoconf a Automake. V prípade chyby ako je táto:"
283 #: guix-git/doc/contributing.texi:105
285 msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
286 msgstr "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n"
289 #: guix-git/doc/contributing.texi:114
290 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:"
294 #: guix-git/doc/contributing.texi:117
296 msgid "export ACLOCAL_PATH=/usr/share/aclocal\n"
300 #: guix-git/doc/contributing.texi:121
301 msgid "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more information."
305 #: guix-git/doc/contributing.texi:128
306 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}."
310 #: guix-git/doc/contributing.texi:133
311 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}."
315 #: guix-git/doc/contributing.texi:136
316 msgid "From there on, you can authenticate all the commits included in your checkout by running:"
320 #: guix-git/doc/contributing.texi:139
322 msgid "make authenticate\n"
326 #: guix-git/doc/contributing.texi:142
327 msgid "The first run takes a couple of minutes, but subsequent runs are faster."
331 #: guix-git/doc/contributing.texi:148
332 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:"
336 #: guix-git/doc/contributing.texi:151
338 msgid "make authenticate GUIX_GIT_KEYRING=myremote/keyring\n"
342 #: guix-git/doc/contributing.texi:153 guix-git/doc/contributing.texi:1316
343 #: guix-git/doc/guix.texi:565 guix-git/doc/guix.texi:614
344 #: guix-git/doc/guix.texi:1764 guix-git/doc/guix.texi:2011
345 #: guix-git/doc/guix.texi:2195 guix-git/doc/guix.texi:2416
346 #: guix-git/doc/guix.texi:2617 guix-git/doc/guix.texi:3734
347 #: guix-git/doc/guix.texi:4470 guix-git/doc/guix.texi:4484
348 #: guix-git/doc/guix.texi:4566 guix-git/doc/guix.texi:4796
349 #: guix-git/doc/guix.texi:5646 guix-git/doc/guix.texi:5892
350 #: guix-git/doc/guix.texi:6013 guix-git/doc/guix.texi:6065
351 #: guix-git/doc/guix.texi:8752 guix-git/doc/guix.texi:8822
352 #: guix-git/doc/guix.texi:10487 guix-git/doc/guix.texi:10527
353 #: guix-git/doc/guix.texi:10800 guix-git/doc/guix.texi:10812
354 #: guix-git/doc/guix.texi:13027 guix-git/doc/guix.texi:13654
355 #: guix-git/doc/guix.texi:14437 guix-git/doc/guix.texi:15412
356 #: guix-git/doc/guix.texi:17728 guix-git/doc/guix.texi:17877
357 #: guix-git/doc/guix.texi:25473 guix-git/doc/guix.texi:29082
358 #: guix-git/doc/guix.texi:31039 guix-git/doc/guix.texi:32532
359 #: guix-git/doc/guix.texi:32766 guix-git/doc/guix.texi:32936
360 #: guix-git/doc/guix.texi:33089 guix-git/doc/guix.texi:33191
361 #: guix-git/doc/guix.texi:33292
367 #: guix-git/doc/contributing.texi:157
368 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."
372 #: guix-git/doc/contributing.texi:167
373 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."
377 #: guix-git/doc/contributing.texi:178
378 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):"
382 #: guix-git/doc/contributing.texi:181
384 msgid "$ ./pre-inst-env guix build hello\n"
388 #: guix-git/doc/contributing.texi:185
389 msgid "Similarly, an example for a Guile session using the Guix modules:"
393 #: guix-git/doc/contributing.texi:188
396 "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
401 #: guix-git/doc/contributing.texi:190
403 msgid ";;; (\"x86_64-linux\")\n"
407 #: guix-git/doc/contributing.texi:193
413 #: guix-git/doc/contributing.texi:194
415 msgid "read-eval-print loop"
419 #: guix-git/doc/contributing.texi:197
420 msgid "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):"
424 #: guix-git/doc/contributing.texi:212
427 "$ ./pre-inst-env guile\n"
428 "scheme@@(guile-user)> ,use(guix)\n"
429 "scheme@@(guile-user)> ,use(gnu)\n"
430 "scheme@@(guile-user)> (define snakes\n"
432 " (lambda (package lst)\n"
433 " (if (string-prefix? \"python\"\n"
434 " (package-name package))\n"
435 " (cons package lst)\n"
438 "scheme@@(guile-user)> (length snakes)\n"
443 #: guix-git/doc/contributing.texi:220
444 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.}:"
448 #: guix-git/doc/contributing.texi:223
450 msgid "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
454 #: guix-git/doc/contributing.texi:227
455 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}."
459 #: guix-git/doc/contributing.texi:232
460 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."
464 #: guix-git/doc/contributing.texi:242
465 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:"
469 #: guix-git/doc/contributing.texi:245
471 msgid "guix package -i emacs guile emacs-geiser\n"
475 #: guix-git/doc/contributing.texi:254
476 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:"
480 #: guix-git/doc/contributing.texi:259
483 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
484 "(with-eval-after-load 'geiser-guile\n"
485 " (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n"
489 #: guix-git/doc/contributing.texi:267
490 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."
494 #: guix-git/doc/contributing.texi:268
496 msgid "code snippets"
500 #: guix-git/doc/contributing.texi:269
506 #: guix-git/doc/contributing.texi:270
508 msgid "reducing boilerplate"
512 #: guix-git/doc/contributing.texi:277
513 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."
517 #: guix-git/doc/contributing.texi:282
520 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
521 "(with-eval-after-load 'yasnippet\n"
522 " (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n"
526 #: guix-git/doc/contributing.texi:290
527 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."
531 #: guix-git/doc/contributing.texi:296
532 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."
536 #: guix-git/doc/contributing.texi:297
538 msgid "insert or update copyright"
542 #: guix-git/doc/contributing.texi:298
544 msgid "M-x guix-copyright"
548 #: guix-git/doc/contributing.texi:299
550 msgid "M-x copyright-update"
554 #: guix-git/doc/contributing.texi:303
555 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."
559 #: guix-git/doc/contributing.texi:309
562 "(setq user-full-name \"Alice Doe\")\n"
563 "(setq user-mail-address \"alice@@mail.org\")\n"
564 ";; @r{Assuming the Guix checkout is in ~/src/guix.}\n"
565 "(load-file \"~/src/guix/etc/copyright.el\")\n"
569 #: guix-git/doc/contributing.texi:312
570 msgid "To insert a copyright at the current line invoke @code{M-x guix-copyright}."
574 #: guix-git/doc/contributing.texi:314
575 msgid "To update a copyright you need to specify a @code{copyright-names-regexp}."
579 #: guix-git/doc/contributing.texi:318
582 "(setq copyright-names-regexp\n"
583 " (format \"%s <%s>\" user-full-name user-mail-address))\n"
587 #: guix-git/doc/contributing.texi:324
588 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."
592 #: guix-git/doc/contributing.texi:328
594 msgid "packages, creating"
598 #: guix-git/doc/contributing.texi:332
599 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."
603 #: guix-git/doc/contributing.texi:340
604 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."
608 #: guix-git/doc/contributing.texi:349
609 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}."
613 #: guix-git/doc/contributing.texi:355
614 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}):"
618 #: guix-git/doc/contributing.texi:358
620 msgid "./pre-inst-env guix build gnew --keep-failed\n"
624 #: guix-git/doc/contributing.texi:364
625 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."
629 #: guix-git/doc/contributing.texi:369
630 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:"
634 #: guix-git/doc/contributing.texi:372
636 msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n"
640 #: guix-git/doc/contributing.texi:379
641 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}."
645 #: guix-git/doc/contributing.texi:380
651 #: guix-git/doc/contributing.texi:387
652 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."
656 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:403
657 #: guix-git/doc/contributing.texi:404
659 msgid "Software Freedom"
663 #: guix-git/doc/contributing.texi:401
664 msgid "What may go into the distribution."
668 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:431
669 #: guix-git/doc/contributing.texi:432
671 msgid "Package Naming"
675 #: guix-git/doc/contributing.texi:401
676 msgid "What's in a name?"
680 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:464
681 #: guix-git/doc/contributing.texi:465
683 msgid "Version Numbers"
687 #: guix-git/doc/contributing.texi:401
688 msgid "When the name is not enough."
692 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:555
693 #: guix-git/doc/contributing.texi:556
695 msgid "Synopses and Descriptions"
699 #: guix-git/doc/contributing.texi:401
700 msgid "Helping users find the right package."
704 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:634
705 #: guix-git/doc/contributing.texi:635
707 msgid "Snippets versus Phases"
711 #: guix-git/doc/contributing.texi:401
712 msgid "Whether to use a snippet, or a build phase."
716 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:649
717 #: guix-git/doc/contributing.texi:650 guix-git/doc/guix.texi:1946
719 msgid "Emacs Packages"
723 #: guix-git/doc/contributing.texi:401
724 msgid "Your Elisp fix."
728 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:689
729 #: guix-git/doc/contributing.texi:690
731 msgid "Python Modules"
735 #: guix-git/doc/contributing.texi:401
736 msgid "A touch of British comedy."
740 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:765
741 #: guix-git/doc/contributing.texi:766
747 #: guix-git/doc/contributing.texi:401
748 msgid "Little pearls."
752 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:781
753 #: guix-git/doc/contributing.texi:782
755 msgid "Java Packages"
759 #: guix-git/doc/contributing.texi:401
760 msgid "Coffee break."
764 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:801
765 #: guix-git/doc/contributing.texi:802
771 #: guix-git/doc/contributing.texi:401
772 msgid "Beware of oxidation."
776 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:835
777 #: guix-git/doc/contributing.texi:836
783 #: guix-git/doc/contributing.texi:401
784 msgid "Fond of fonts."
788 #: guix-git/doc/contributing.texi:407
790 msgid "free software"
794 #: guix-git/doc/contributing.texi:415
795 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."
799 #: guix-git/doc/contributing.texi:421
800 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."
804 #: guix-git/doc/contributing.texi:429
805 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."
809 #: guix-git/doc/contributing.texi:434
815 #: guix-git/doc/contributing.texi:442
816 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}."
820 #: guix-git/doc/contributing.texi:447
821 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}."
825 #: guix-git/doc/contributing.texi:455
826 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."
830 #: guix-git/doc/contributing.texi:460
831 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."
835 #: guix-git/doc/contributing.texi:462
836 msgid "Font package names are handled differently, @pxref{Fonts}."
840 #: guix-git/doc/contributing.texi:467
842 msgid "package version"
846 #: guix-git/doc/contributing.texi:476
847 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."
851 #: guix-git/doc/contributing.texi:479
852 msgid "The name inside the package definition is the same for all versions of a package and does not contain any version number."
856 #: guix-git/doc/contributing.texi:481
857 msgid "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows:"
861 #: guix-git/doc/contributing.texi:493
864 "(define-public gtk+\n"
867 " (version \"3.9.12\")\n"
869 "(define-public gtk+-2\n"
872 " (version \"2.24.20\")\n"
877 #: guix-git/doc/contributing.texi:495
878 msgid "If we also wanted GTK+ 3.8.2, this would be packaged as"
882 #: guix-git/doc/contributing.texi:501
885 "(define-public gtk+-3.8\n"
888 " (version \"3.8.2\")\n"
893 #: guix-git/doc/contributing.texi:505
895 msgid "version number, for VCS snapshots"
899 #: guix-git/doc/contributing.texi:511
900 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?"
904 #: guix-git/doc/contributing.texi:519
905 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:"
909 #: guix-git/doc/contributing.texi:528
914 " | | `-- upstream commit ID\n"
916 " | `--- Guix package revision\n"
918 "latest upstream version\n"
922 #: guix-git/doc/contributing.texi:537
923 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:"
927 #: guix-git/doc/contributing.texi:553
930 "(define my-package\n"
931 " (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n"
932 " (revision \"1\")) ;Guix package revision\n"
934 " (version (git-version \"0.9\" revision commit))\n"
936 " (method git-fetch)\n"
937 " (uri (git-reference\n"
938 " (url \"git://example.org/my-package.git\")\n"
939 " (commit commit)))\n"
940 " (sha256 (base32 \"1mbikn@dots{}\"))\n"
941 " (file-name (git-file-name name version))))\n"
947 #: guix-git/doc/contributing.texi:558
949 msgid "package description"
953 #: guix-git/doc/contributing.texi:559
955 msgid "package synopsis"
959 #: guix-git/doc/contributing.texi:566
960 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."
964 #: guix-git/doc/contributing.texi:574
965 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''."
969 #: guix-git/doc/contributing.texi:584
970 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."
974 #: guix-git/doc/contributing.texi:592
975 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."
979 #: guix-git/doc/contributing.texi:593
981 msgid "Texinfo markup, in package descriptions"
985 #: guix-git/doc/contributing.texi:602
986 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."
990 #: guix-git/doc/contributing.texi:608
991 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."
995 #: guix-git/doc/contributing.texi:613
996 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:"
1000 #: guix-git/doc/contributing.texi:619
1005 " (synopsis \"This is translatable\")\n"
1006 " (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n"
1010 #: guix-git/doc/contributing.texi:627
1011 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}):"
1015 #: guix-git/doc/contributing.texi:632
1018 ";; TRANSLATORS: \"X11 resize-and-rotate\" should not be translated.\n"
1019 "(description \"ARandR is designed to provide a simple visual front end\n"
1020 "for the X11 resize-and-rotate (RandR) extension. @dots{}\")\n"
1024 #: guix-git/doc/contributing.texi:637
1026 msgid "snippets, when to use"
1030 #: guix-git/doc/contributing.texi:648
1031 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})."
1035 #: guix-git/doc/contributing.texi:652
1037 msgid "emacs, packaging"
1041 #: guix-git/doc/contributing.texi:653
1043 msgid "elisp, packaging"
1047 #: guix-git/doc/contributing.texi:665
1048 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."
1052 #: guix-git/doc/contributing.texi:670
1053 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}."
1057 #: guix-git/doc/contributing.texi:679
1058 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:"
1062 #: guix-git/doc/contributing.texi:682
1064 msgid "#:include (cons \"^snippets/\" %default-include))\n"
1068 #: guix-git/doc/contributing.texi:688
1069 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."
1073 #: guix-git/doc/contributing.texi:692
1079 #: guix-git/doc/contributing.texi:698
1080 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}."
1084 #: guix-git/doc/contributing.texi:705
1085 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."
1089 #: guix-git/doc/contributing.texi:711
1090 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."
1093 #. type: subsubsection
1094 #: guix-git/doc/contributing.texi:712
1096 msgid "Specifying Dependencies"
1100 #: guix-git/doc/contributing.texi:713
1102 msgid "inputs, for Python packages"
1106 #: guix-git/doc/contributing.texi:718
1107 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}."
1111 #: guix-git/doc/contributing.texi:724
1112 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."
1116 #: guix-git/doc/contributing.texi:732
1117 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."
1121 #: guix-git/doc/contributing.texi:738
1122 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."
1126 #: guix-git/doc/contributing.texi:746
1127 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."
1131 #: guix-git/doc/contributing.texi:750
1132 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}."
1136 #: guix-git/doc/contributing.texi:755
1137 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."
1141 #: guix-git/doc/contributing.texi:761
1142 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}})."
1146 #: guix-git/doc/contributing.texi:768
1152 #: guix-git/doc/contributing.texi:779
1153 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}."
1157 #: guix-git/doc/contributing.texi:784
1163 #: guix-git/doc/contributing.texi:787
1164 msgid "Java programs standing for themselves are named as any other package, using the lowercase upstream name."
1168 #: guix-git/doc/contributing.texi:793
1169 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}."
1173 #: guix-git/doc/contributing.texi:799
1174 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}."
1178 #: guix-git/doc/contributing.texi:804
1184 #: guix-git/doc/contributing.texi:807
1185 msgid "Rust programs standing for themselves are named as any other package, using the lowercase upstream name."
1189 #: guix-git/doc/contributing.texi:811
1190 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."
1194 #: guix-git/doc/contributing.texi:817
1195 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}."
1199 #: guix-git/doc/contributing.texi:827
1200 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."
1204 #: guix-git/doc/contributing.texi:833
1205 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."
1209 #: guix-git/doc/contributing.texi:838 guix-git/doc/guix.texi:1881
1215 #: guix-git/doc/contributing.texi:844
1216 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."
1220 #: guix-git/doc/contributing.texi:848
1221 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."
1225 #: guix-git/doc/contributing.texi:856
1226 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}."
1230 #: guix-git/doc/contributing.texi:865
1231 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}."
1235 #: guix-git/doc/contributing.texi:871
1236 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."
1240 #: guix-git/doc/contributing.texi:879
1241 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."
1245 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:887
1246 #: guix-git/doc/contributing.texi:888
1248 msgid "Programming Paradigm"
1252 #: guix-git/doc/contributing.texi:885
1253 msgid "How to compose your elements."
1257 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:894
1258 #: guix-git/doc/contributing.texi:895
1264 #: guix-git/doc/contributing.texi:885
1265 msgid "Where to store your code?"
1269 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:905
1270 #: guix-git/doc/contributing.texi:906
1272 msgid "Data Types and Pattern Matching"
1276 #: guix-git/doc/contributing.texi:885
1277 msgid "Implementing data structures."
1281 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:920
1282 #: guix-git/doc/contributing.texi:921
1284 msgid "Formatting Code"
1288 #: guix-git/doc/contributing.texi:885
1289 msgid "Writing conventions."
1293 #: guix-git/doc/contributing.texi:893
1294 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."
1298 #: guix-git/doc/contributing.texi:901
1299 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."
1303 #: guix-git/doc/contributing.texi:904
1304 msgid "Modules that deal with the broader GNU system should be in the @code{(gnu @dots{})} name space rather than @code{(guix @dots{})}."
1308 #: guix-git/doc/contributing.texi:913
1309 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."
1313 #: guix-git/doc/contributing.texi:919
1314 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})."
1318 #: guix-git/doc/contributing.texi:923
1320 msgid "formatting code"
1324 #: guix-git/doc/contributing.texi:924
1326 msgid "coding style"
1330 #: guix-git/doc/contributing.texi:931
1331 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."
1335 #: guix-git/doc/contributing.texi:938
1336 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})."
1340 #: guix-git/doc/contributing.texi:939
1342 msgid "indentation, of code"
1346 #: guix-git/doc/contributing.texi:940
1348 msgid "formatting, of code"
1352 #: guix-git/doc/contributing.texi:943
1353 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:"
1357 #: guix-git/doc/contributing.texi:946
1359 msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
1363 #: guix-git/doc/contributing.texi:952
1364 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:"
1368 #: guix-git/doc/contributing.texi:955
1370 msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n"
1374 #: guix-git/doc/contributing.texi:957
1376 msgid "Vim, Scheme code editing"
1380 #: guix-git/doc/contributing.texi:963
1381 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."
1385 #: guix-git/doc/contributing.texi:967
1386 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."
1390 #: guix-git/doc/contributing.texi:970
1391 msgid "Procedures should not have more than four positional parameters. Use keyword parameters for procedures that take more than four parameters."
1395 #: guix-git/doc/contributing.texi:981
1396 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})."
1400 #: guix-git/doc/contributing.texi:988
1401 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})."
1405 #: guix-git/doc/contributing.texi:992
1406 msgid "Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, standards, GNU Coding Standards}); you can check the commit history for examples."
1410 #: guix-git/doc/contributing.texi:995
1411 msgid "Before submitting a patch that adds or modifies a package definition, please run through this check list:"
1415 #: guix-git/doc/contributing.texi:1002
1416 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."
1420 #: guix-git/doc/contributing.texi:1006
1421 msgid "Take some time to provide an adequate synopsis and description for the package. @xref{Synopses and Descriptions}, for some guidelines."
1425 #: guix-git/doc/contributing.texi:1011
1426 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})."
1430 #: guix-git/doc/contributing.texi:1015
1431 msgid "Make sure the package builds on your platform, using @code{guix build @var{package}}."
1435 #: guix-git/doc/contributing.texi:1022
1436 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:"
1440 #: guix-git/doc/contributing.texi:1027
1443 "(service qemu-binfmt-service-type\n"
1444 " (qemu-binfmt-configuration\n"
1445 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))\n"
1449 #: guix-git/doc/contributing.texi:1030
1450 msgid "Then reconfigure your system."
1454 #: guix-git/doc/contributing.texi:1035
1455 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:"
1459 #: guix-git/doc/contributing.texi:1038
1462 "guix build --system=armhf-linux --rounds=2 hello\n"
1463 "guix build --system=aarch64-linux --rounds=2 hello\n"
1467 #: guix-git/doc/contributing.texi:1041
1473 #: guix-git/doc/contributing.texi:1044
1474 msgid "Make sure the package does not use bundled copies of software already available as separate packages."
1478 #: guix-git/doc/contributing.texi:1053
1479 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."
1483 #: guix-git/doc/contributing.texi:1062
1484 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."
1488 #: guix-git/doc/contributing.texi:1067
1489 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})."
1493 #: guix-git/doc/contributing.texi:1069
1495 msgid "branching strategy"
1499 #: guix-git/doc/contributing.texi:1070
1501 msgid "rebuild scheduling strategy"
1505 #: guix-git/doc/contributing.texi:1073
1506 msgid "Depending on the number of dependent packages and thus the amount of rebuilding induced, commits go to different branches, along these lines:"
1510 #: guix-git/doc/contributing.texi:1075
1512 msgid "300 dependent packages or less"
1516 #: guix-git/doc/contributing.texi:1077
1517 msgid "@code{master} branch (non-disruptive changes)."
1521 #: guix-git/doc/contributing.texi:1078
1523 msgid "between 300 and 1,800 dependent packages"
1527 #: guix-git/doc/contributing.texi:1083
1528 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})."
1532 #: guix-git/doc/contributing.texi:1084
1534 msgid "more than 1,800 dependent packages"
1538 #: guix-git/doc/contributing.texi:1088
1539 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."
1543 #: guix-git/doc/contributing.texi:1095
1544 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."
1548 #: guix-git/doc/contributing.texi:1104
1549 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."
1553 #: guix-git/doc/contributing.texi:1106
1555 msgid "determinism, of build processes"
1559 #: guix-git/doc/contributing.texi:1107
1561 msgid "reproducible builds, checking"
1565 #: guix-git/doc/contributing.texi:1111
1566 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."
1570 #: guix-git/doc/contributing.texi:1114
1571 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}):"
1575 #: guix-git/doc/contributing.texi:1117
1577 msgid "guix build --rounds=2 my-package\n"
1581 #: guix-git/doc/contributing.texi:1121
1582 msgid "This is enough to catch a class of common non-determinism issues, such as timestamps or randomly-generated output in the build result."
1586 #: guix-git/doc/contributing.texi:1131
1587 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."
1591 #: guix-git/doc/contributing.texi:1137
1592 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."
1596 #: guix-git/doc/contributing.texi:1141
1597 msgid "Verify that your patch contains only one set of related changes. Bundling unrelated changes together makes reviewing harder and slower."
1601 #: guix-git/doc/contributing.texi:1144
1602 msgid "Examples of unrelated changes include the addition of several packages, or a package update along with fixes to that package."
1606 #: guix-git/doc/contributing.texi:1149
1607 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})."
1611 #: guix-git/doc/contributing.texi:1157
1612 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."
1616 #: guix-git/doc/contributing.texi:1161
1617 msgid "Check if Guix builds (@pxref{Building from Git}) and address the warnings, especially those about use of undefined symbols."
1621 #: guix-git/doc/contributing.texi:1164
1622 msgid "Make sure your changes do not break Guix and simulate a @code{guix pull} with:"
1626 #: guix-git/doc/contributing.texi:1166
1628 msgid "guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master\n"
1632 #: guix-git/doc/contributing.texi:1179
1633 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."
1637 #: guix-git/doc/contributing.texi:1182
1638 msgid "When a bug is resolved, please close the thread by sending an email to @email{@var{NNN}-done@@debbugs.gnu.org}."
1642 #: guix-git/doc/contributing.texi:1183 guix-git/doc/contributing.texi:1185
1644 msgid "Sending a Patch Series"
1648 #: guix-git/doc/contributing.texi:1185
1650 msgid "patch series"
1654 #: guix-git/doc/contributing.texi:1186
1656 msgid "git send-email"
1660 #: guix-git/doc/contributing.texi:1187
1662 msgid "git-send-email"
1666 #: guix-git/doc/contributing.texi:1197
1667 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}."
1671 #: guix-git/doc/contributing.texi:1201
1673 msgid "bug reports, tracking"
1677 #: guix-git/doc/contributing.texi:1202
1679 msgid "patch submissions, tracking"
1683 #: guix-git/doc/contributing.texi:1203
1685 msgid "issue tracking"
1689 #: guix-git/doc/contributing.texi:1204
1691 msgid "Debbugs, issue tracking system"
1695 #: guix-git/doc/contributing.texi:1211
1696 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})."
1700 #: guix-git/doc/contributing.texi:1214
1701 msgid "A web interface (actually @emph{two} web interfaces!) are available to browse issues:"
1705 #: guix-git/doc/contributing.texi:1223
1706 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;"
1710 #: guix-git/doc/contributing.texi:1225
1711 msgid "@url{https://bugs.gnu.org/guix} lists bug reports;"
1715 #: guix-git/doc/contributing.texi:1227
1716 msgid "@url{https://bugs.gnu.org/guix-patches} lists patch submissions."
1720 #: guix-git/doc/contributing.texi:1232
1721 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}}."
1725 #: guix-git/doc/contributing.texi:1235
1726 msgid "If you use Emacs, you may find it more convenient to interact with issues using @file{debbugs.el}, which you can install with:"
1730 #: guix-git/doc/contributing.texi:1238
1732 msgid "guix install emacs-debbugs\n"
1736 #: guix-git/doc/contributing.texi:1241
1737 msgid "For example, to list all open issues on @code{guix-patches}, hit:"
1741 #: guix-git/doc/contributing.texi:1244
1743 msgid "@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y\n"
1747 #: guix-git/doc/contributing.texi:1248
1748 msgid "@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on this nifty tool!"
1752 #: guix-git/doc/contributing.texi:1252
1754 msgid "commit access, for developers"
1758 #: guix-git/doc/contributing.texi:1256
1759 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:"
1763 #: guix-git/doc/contributing.texi:1265
1764 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."
1768 #: guix-git/doc/contributing.texi:1271
1769 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''."
1773 #: guix-git/doc/contributing.texi:1278
1774 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."
1778 #: guix-git/doc/contributing.texi:1284
1779 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}):"
1783 #: guix-git/doc/contributing.texi:1287
1785 msgid "digest-algo sha512\n"
1789 #: guix-git/doc/contributing.texi:1292
1790 msgid "Maintainers ultimately decide whether to grant you commit access, usually following your referrals' recommendation."
1794 #: guix-git/doc/contributing.texi:1294
1796 msgid "OpenPGP, signed commits"
1800 #: guix-git/doc/contributing.texi:1299
1801 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."
1805 #: guix-git/doc/contributing.texi:1300
1811 #: guix-git/doc/contributing.texi:1302
1812 msgid "Before you can push for the first time, maintainers must:"
1816 #: guix-git/doc/contributing.texi:1306
1817 msgid "add your OpenPGP key to the @code{keyring} branch;"
1821 #: guix-git/doc/contributing.texi:1309
1822 msgid "add your OpenPGP fingerprint to the @file{.guix-authorizations} file of the branch(es) you will commit to."
1826 #: guix-git/doc/contributing.texi:1314
1827 msgid "Make sure to read the rest of this section and... profit!"
1831 #: guix-git/doc/contributing.texi:1320
1832 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!"
1836 #: guix-git/doc/contributing.texi:1324
1837 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!"
1841 #: guix-git/doc/contributing.texi:1329
1842 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})."
1846 #: guix-git/doc/contributing.texi:1334
1847 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})."
1851 #: guix-git/doc/contributing.texi:1343
1852 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}."
1856 #: guix-git/doc/contributing.texi:1349
1857 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:"
1861 #: guix-git/doc/contributing.texi:1353
1864 "git config commit.gpgsign true\n"
1865 "git config user.signingkey CABBA6EA1DC0FF33\n"
1869 #: guix-git/doc/contributing.texi:1358
1870 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}:"
1874 #: guix-git/doc/contributing.texi:1361
1876 msgid "cp etc/git/pre-push .git/hooks/pre-push\n"
1880 #: guix-git/doc/contributing.texi:1367
1881 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."
1885 #: guix-git/doc/contributing.texi:1371
1886 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:"
1890 #: guix-git/doc/contributing.texi:1374
1892 msgid "make check-channel-news\n"
1896 #: guix-git/doc/contributing.texi:1380
1897 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."
1901 #: guix-git/doc/contributing.texi:1383
1902 msgid "That last part is subject to being adjusted, allowing individuals to commit directly on non-controversial changes on parts they’re familiar with."
1906 #: guix-git/doc/contributing.texi:1389
1907 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."
1911 #: guix-git/doc/contributing.texi:1395
1912 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!"
1916 #: guix-git/doc/contributing.texi:1399
1918 msgid "update-guix-package, updating the guix package"
1922 #: guix-git/doc/contributing.texi:1405
1923 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:"
1927 #: guix-git/doc/contributing.texi:1408
1929 msgid "make update-guix-package\n"
1933 #: guix-git/doc/contributing.texi:1415
1934 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."
1938 #: guix-git/doc/contributing.texi:1419
1939 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:"
1943 #: guix-git/doc/contributing.texi:1422
1945 msgid "./pre-inst-env guix build guix\n"
1949 #: guix-git/doc/contributing.texi:1427
1950 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."
1954 #: guix-git/doc/contributing.texi:1431
1955 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."
1959 #: guix-git/doc/guix.texi:7
1960 msgid "@documentencoding UTF-8"
1964 #: guix-git/doc/guix.texi:7 guix-git/doc/guix.texi:118
1966 msgid "GNU Guix Reference Manual"
1970 #: guix-git/doc/guix.texi:10
1972 msgid "version.texi"
1973 msgstr "version-sk.texi"
1976 #: guix-git/doc/guix.texi:91
1977 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@*"
1981 #: guix-git/doc/guix.texi:98
1982 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''."
1985 #. type: dircategory
1986 #: guix-git/doc/guix.texi:100
1988 msgid "System administration"
1992 #: guix-git/doc/guix.texi:108
1993 msgid "Guix: (guix)"
1997 #: guix-git/doc/guix.texi:108
1998 msgid "Manage installed software and system configuration."
2002 #: guix-git/doc/guix.texi:108
2003 msgid "guix package: (guix)Invoking guix package"
2007 #: guix-git/doc/guix.texi:108
2008 msgid "Installing, removing, and upgrading packages."
2012 #: guix-git/doc/guix.texi:108
2013 msgid "guix gc: (guix)Invoking guix gc"
2017 #: guix-git/doc/guix.texi:108
2018 msgid "Reclaiming unused disk space."
2022 #: guix-git/doc/guix.texi:108
2023 msgid "guix pull: (guix)Invoking guix pull"
2027 #: guix-git/doc/guix.texi:108
2028 msgid "Update the list of available packages."
2032 #: guix-git/doc/guix.texi:108
2033 msgid "guix system: (guix)Invoking guix system"
2037 #: guix-git/doc/guix.texi:108
2038 msgid "Manage the operating system configuration."
2042 #: guix-git/doc/guix.texi:108
2043 msgid "guix deploy: (guix)Invoking guix deploy"
2047 #: guix-git/doc/guix.texi:108
2048 msgid "Manage operating system configurations for remote hosts."
2051 #. type: dircategory
2052 #: guix-git/doc/guix.texi:110
2054 msgid "Software development"
2058 #: guix-git/doc/guix.texi:115
2059 msgid "guix environment: (guix)Invoking guix environment"
2063 #: guix-git/doc/guix.texi:115
2064 msgid "Building development environments with Guix."
2068 #: guix-git/doc/guix.texi:115
2069 msgid "guix build: (guix)Invoking guix build"
2073 #: guix-git/doc/guix.texi:115
2074 msgid "Building packages."
2078 #: guix-git/doc/guix.texi:115
2079 msgid "guix pack: (guix)Invoking guix pack"
2083 #: guix-git/doc/guix.texi:115
2084 msgid "Creating binary bundles."
2088 #: guix-git/doc/guix.texi:119
2090 msgid "Using the GNU Guix Functional Package Manager"
2094 #: guix-git/doc/guix.texi:120
2096 msgid "The GNU Guix Developers"
2100 #: guix-git/doc/guix.texi:126
2101 msgid "Edition @value{EDITION} @* @value{UPDATED} @*"
2105 #: guix-git/doc/guix.texi:133
2111 #: guix-git/doc/guix.texi:134
2117 #: guix-git/doc/guix.texi:138
2118 msgid "This document describes GNU Guix version @value{VERSION}, a functional package management tool written for the GNU system."
2121 #. You can replace the following paragraph with information on
2123 #: guix-git/doc/guix.texi:150
2124 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}."
2128 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:178
2129 #: guix-git/doc/guix.texi:379 guix-git/doc/guix.texi:380
2131 msgid "Introduction"
2135 #: guix-git/doc/guix.texi:168
2136 msgid "What is Guix about?"
2140 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:183
2141 #: guix-git/doc/guix.texi:560 guix-git/doc/guix.texi:561
2143 msgid "Installation"
2147 #: guix-git/doc/guix.texi:168
2148 msgid "Installing Guix."
2152 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:199
2153 #: guix-git/doc/guix.texi:2000 guix-git/doc/guix.texi:2001
2155 msgid "System Installation"
2159 #: guix-git/doc/guix.texi:168
2160 msgid "Installing the whole operating system."
2164 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:2717
2165 #: guix-git/doc/guix.texi:2718
2167 msgid "Getting Started"
2171 #: guix-git/doc/guix.texi:168
2172 msgid "Your first steps."
2176 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:216
2177 #: guix-git/doc/guix.texi:2925 guix-git/doc/guix.texi:2926
2179 msgid "Package Management"
2183 #: guix-git/doc/guix.texi:168
2184 msgid "Package installation, upgrade, etc."
2188 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:239
2189 #: guix-git/doc/guix.texi:4975 guix-git/doc/guix.texi:4976
2195 #: guix-git/doc/guix.texi:168
2196 msgid "Customizing the package collection."
2200 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:253
2201 #: guix-git/doc/guix.texi:5503 guix-git/doc/guix.texi:5504
2207 #: guix-git/doc/guix.texi:168
2208 msgid "Guix-aided software development."
2212 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:260
2213 #: guix-git/doc/guix.texi:6329 guix-git/doc/guix.texi:6330
2215 msgid "Programming Interface"
2219 #: guix-git/doc/guix.texi:168
2220 msgid "Using Guix in Scheme."
2224 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:279
2225 #: guix-git/doc/guix.texi:10125 guix-git/doc/guix.texi:10126
2231 #: guix-git/doc/guix.texi:168
2232 msgid "Package management commands."
2236 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:304
2237 #: guix-git/doc/guix.texi:13305 guix-git/doc/guix.texi:13306
2239 msgid "System Configuration"
2243 #: guix-git/doc/guix.texi:168
2244 msgid "Configuring the operating system."
2248 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34336
2249 #: guix-git/doc/guix.texi:34337
2251 msgid "Documentation"
2252 msgstr "Dokumentácia"
2255 #: guix-git/doc/guix.texi:168
2256 msgid "Browsing software user manuals."
2260 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:366
2261 #: guix-git/doc/guix.texi:34400 guix-git/doc/guix.texi:34401
2263 msgid "Installing Debugging Files"
2267 #: guix-git/doc/guix.texi:168
2268 msgid "Feeding the debugger."
2272 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34541
2273 #: guix-git/doc/guix.texi:34542
2275 msgid "Security Updates"
2279 #: guix-git/doc/guix.texi:168
2280 msgid "Deploying security fixes quickly."
2284 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:371
2285 #: guix-git/doc/guix.texi:34656 guix-git/doc/guix.texi:34657
2287 msgid "Bootstrapping"
2291 #: guix-git/doc/guix.texi:168
2292 msgid "GNU/Linux built from scratch."
2296 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34948
2302 #: guix-git/doc/guix.texi:168
2303 msgid "Targeting another platform or kernel."
2307 #: guix-git/doc/guix.texi:168
2308 msgid "Your help needed!"
2312 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:34996
2313 #: guix-git/doc/guix.texi:34997
2315 msgid "Acknowledgments"
2319 #: guix-git/doc/guix.texi:173
2324 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35018
2325 #: guix-git/doc/guix.texi:35019
2327 msgid "GNU Free Documentation License"
2331 #: guix-git/doc/guix.texi:173
2332 msgid "The license of this manual."
2336 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35024
2337 #: guix-git/doc/guix.texi:35025
2339 msgid "Concept Index"
2343 #: guix-git/doc/guix.texi:173
2348 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35028
2349 #: guix-git/doc/guix.texi:35029
2351 msgid "Programming Index"
2355 #: guix-git/doc/guix.texi:173
2356 msgid "Data types, functions, and variables."
2360 #: guix-git/doc/guix.texi:176
2361 msgid "--- The Detailed Node Listing ---"
2365 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2366 #: guix-git/doc/guix.texi:408 guix-git/doc/guix.texi:409
2368 msgid "Managing Software the Guix Way"
2372 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2373 msgid "What's special."
2377 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2378 #: guix-git/doc/guix.texi:463 guix-git/doc/guix.texi:464
2380 msgid "GNU Distribution"
2384 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2385 msgid "The packages and tools."
2389 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2390 #: guix-git/doc/guix.texi:602 guix-git/doc/guix.texi:603
2392 msgid "Binary Installation"
2396 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2397 msgid "Getting Guix running in no time!"
2401 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2402 #: guix-git/doc/guix.texi:820 guix-git/doc/guix.texi:821
2404 msgid "Requirements"
2408 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2409 msgid "Software needed to build and run Guix."
2413 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2414 #: guix-git/doc/guix.texi:909 guix-git/doc/guix.texi:910
2416 msgid "Running the Test Suite"
2420 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2421 msgid "Testing Guix."
2425 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:193
2426 #: guix-git/doc/guix.texi:600 guix-git/doc/guix.texi:1006
2427 #: guix-git/doc/guix.texi:1007
2429 msgid "Setting Up the Daemon"
2433 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2434 msgid "Preparing the build daemon's environment."
2438 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2439 #: guix-git/doc/guix.texi:1476
2441 msgid "Invoking guix-daemon"
2445 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2446 msgid "Running the build daemon."
2450 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2451 #: guix-git/doc/guix.texi:1778 guix-git/doc/guix.texi:1779
2453 msgid "Application Setup"
2457 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2458 msgid "Application-specific setup."
2462 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2463 #: guix-git/doc/guix.texi:1963 guix-git/doc/guix.texi:1964
2465 msgid "Upgrading Guix"
2469 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2470 msgid "Upgrading Guix and its build daemon."
2474 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2475 #: guix-git/doc/guix.texi:1028 guix-git/doc/guix.texi:1029
2477 msgid "Build Environment Setup"
2481 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2482 msgid "Preparing the isolated build environment."
2486 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2487 #: guix-git/doc/guix.texi:1147
2489 msgid "Daemon Offload Setup"
2493 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2494 msgid "Offloading builds to remote machines."
2498 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2499 #: guix-git/doc/guix.texi:1385 guix-git/doc/guix.texi:1386
2501 msgid "SELinux Support"
2505 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2506 msgid "Using an SELinux policy for the daemon."
2510 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:1421
2511 #: guix-git/doc/guix.texi:2034 guix-git/doc/guix.texi:2036
2512 #: guix-git/doc/guix.texi:2037
2518 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2519 msgid "What you can expect."
2523 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2524 #: guix-git/doc/guix.texi:2062 guix-git/doc/guix.texi:2063
2526 msgid "Hardware Considerations"
2530 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2531 msgid "Supported hardware."
2535 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2536 #: guix-git/doc/guix.texi:2097 guix-git/doc/guix.texi:2098
2538 msgid "USB Stick and DVD Installation"
2542 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2543 msgid "Preparing the installation medium."
2547 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2548 #: guix-git/doc/guix.texi:2178 guix-git/doc/guix.texi:2179
2550 msgid "Preparing for Installation"
2554 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2555 msgid "Networking, partitioning, etc."
2559 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2560 #: guix-git/doc/guix.texi:2201 guix-git/doc/guix.texi:2202
2562 msgid "Guided Graphical Installation"
2566 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2567 msgid "Easy graphical installation."
2571 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:211
2572 #: guix-git/doc/guix.texi:2034 guix-git/doc/guix.texi:2232
2573 #: guix-git/doc/guix.texi:2233
2575 msgid "Manual Installation"
2579 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2580 msgid "Manual installation for wizards."
2584 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2585 #: guix-git/doc/guix.texi:2600 guix-git/doc/guix.texi:2601
2587 msgid "After System Installation"
2591 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2592 msgid "When installation succeeded."
2596 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2597 #: guix-git/doc/guix.texi:2634
2599 msgid "Installing Guix in a VM"
2603 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2604 msgid "Guix System playground."
2608 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2609 #: guix-git/doc/guix.texi:2685 guix-git/doc/guix.texi:2686
2611 msgid "Building the Installation Image"
2615 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2616 msgid "How this comes to be."
2620 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2621 #: guix-git/doc/guix.texi:2252
2623 msgid "Keyboard Layout and Networking and Partitioning"
2627 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2628 msgid "Initial setup."
2632 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2633 #: guix-git/doc/guix.texi:2512 guix-git/doc/guix.texi:2513
2635 msgid "Proceeding with the Installation"
2639 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2644 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2645 #: guix-git/doc/guix.texi:2959 guix-git/doc/guix.texi:2960
2651 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2652 msgid "How Guix will make your life brighter."
2656 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2657 #: guix-git/doc/guix.texi:3049
2659 msgid "Invoking guix package"
2663 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2664 msgid "Package installation, removal, etc."
2668 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:229
2669 #: guix-git/doc/guix.texi:2957 guix-git/doc/guix.texi:3665
2670 #: guix-git/doc/guix.texi:3666
2676 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2677 msgid "Downloading pre-built binaries."
2681 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2682 #: guix-git/doc/guix.texi:3996 guix-git/doc/guix.texi:3997
2684 msgid "Packages with Multiple Outputs"
2688 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2689 msgid "Single source package, multiple outputs."
2693 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2694 #: guix-git/doc/guix.texi:4050
2696 msgid "Invoking guix gc"
2700 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2701 msgid "Running the garbage collector."
2705 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2706 #: guix-git/doc/guix.texi:4260
2708 msgid "Invoking guix pull"
2712 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2713 msgid "Fetching the latest Guix and distribution."
2717 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2718 #: guix-git/doc/guix.texi:4507
2720 msgid "Invoking guix time-machine"
2724 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2725 msgid "Running an older revision of Guix."
2729 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2730 #: guix-git/doc/guix.texi:4562 guix-git/doc/guix.texi:4563
2736 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2737 msgid "Interacting with another revision of Guix."
2741 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2742 #: guix-git/doc/guix.texi:4690
2744 msgid "Invoking guix describe"
2748 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2749 msgid "Display information about your Guix revision."
2753 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2754 #: guix-git/doc/guix.texi:4785
2756 msgid "Invoking guix archive"
2760 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2761 msgid "Exporting and importing store files."
2765 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2766 #: guix-git/doc/guix.texi:3691 guix-git/doc/guix.texi:3692
2768 msgid "Official Substitute Server"
2772 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2773 msgid "One particular source of substitutes."
2777 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2778 #: guix-git/doc/guix.texi:3720 guix-git/doc/guix.texi:3721
2780 msgid "Substitute Server Authorization"
2784 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2785 msgid "How to enable or disable substitutes."
2789 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2790 #: guix-git/doc/guix.texi:3789 guix-git/doc/guix.texi:3790
2792 msgid "Getting Substitutes from Other Servers"
2796 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2797 msgid "Substitute diversity."
2801 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2802 #: guix-git/doc/guix.texi:3891 guix-git/doc/guix.texi:3892
2804 msgid "Substitute Authentication"
2808 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2809 msgid "How Guix verifies substitutes."
2813 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2814 #: guix-git/doc/guix.texi:3926 guix-git/doc/guix.texi:3927
2816 msgid "Proxy Settings"
2820 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2821 msgid "How to get substitutes via proxy."
2825 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2826 #: guix-git/doc/guix.texi:3938 guix-git/doc/guix.texi:3939
2828 msgid "Substitution Failure"
2832 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2833 msgid "What happens when substitution fails."
2837 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2838 #: guix-git/doc/guix.texi:3966 guix-git/doc/guix.texi:3967
2840 msgid "On Trusting Binaries"
2844 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2845 msgid "How can you trust that binary blob?"
2849 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2850 #: guix-git/doc/guix.texi:5008 guix-git/doc/guix.texi:5009
2852 msgid "Specifying Additional Channels"
2856 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2857 msgid "Extending the package collection."
2861 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2862 #: guix-git/doc/guix.texi:5058 guix-git/doc/guix.texi:5059
2864 msgid "Using a Custom Guix Channel"
2868 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2869 msgid "Using a customized Guix."
2873 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2874 #: guix-git/doc/guix.texi:5080 guix-git/doc/guix.texi:5081
2876 msgid "Replicating Guix"
2880 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2881 msgid "Running the @emph{exact same} Guix."
2885 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2886 #: guix-git/doc/guix.texi:5121 guix-git/doc/guix.texi:5122
2888 msgid "Channel Authentication"
2892 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2893 msgid "How Guix verifies what it fetches."
2897 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2898 #: guix-git/doc/guix.texi:5161 guix-git/doc/guix.texi:5162
2900 msgid "Channels with Substitutes"
2904 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2905 msgid "Using channels with available substitutes."
2909 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2910 #: guix-git/doc/guix.texi:5186 guix-git/doc/guix.texi:5187
2912 msgid "Creating a Channel"
2916 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2917 msgid "How to write your custom channel."
2921 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2922 #: guix-git/doc/guix.texi:5253 guix-git/doc/guix.texi:5254
2924 msgid "Package Modules in a Sub-directory"
2928 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2929 msgid "Specifying the channel's package modules location."
2933 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2934 #: guix-git/doc/guix.texi:5267 guix-git/doc/guix.texi:5268
2936 msgid "Declaring Channel Dependencies"
2940 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2941 msgid "How to depend on other channels."
2945 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2946 #: guix-git/doc/guix.texi:5309 guix-git/doc/guix.texi:5310
2948 msgid "Specifying Channel Authorizations"
2952 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2953 msgid "Defining channel authors authorizations."
2957 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2958 #: guix-git/doc/guix.texi:5410 guix-git/doc/guix.texi:5411
2964 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2965 msgid "Distinguishing mirror to original."
2969 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2970 #: guix-git/doc/guix.texi:5433 guix-git/doc/guix.texi:5434
2972 msgid "Writing Channel News"
2976 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2977 msgid "Communicating information to channel's users."
2981 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2982 #: guix-git/doc/guix.texi:5524
2984 msgid "Invoking guix environment"
2988 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2989 msgid "Setting up development environments."
2993 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2994 #: guix-git/doc/guix.texi:5884
2996 msgid "Invoking guix pack"
3000 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3001 msgid "Creating software bundles."
3005 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3006 #: guix-git/doc/guix.texi:6241 guix-git/doc/guix.texi:6242
3008 msgid "The GCC toolchain"
3012 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3013 msgid "Working with languages supported by GCC."
3017 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3018 #: guix-git/doc/guix.texi:6267
3020 msgid "Invoking guix git authenticate"
3024 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3025 msgid "Authenticating Git repositories."
3029 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3030 #: guix-git/doc/guix.texi:6371 guix-git/doc/guix.texi:6372
3032 msgid "Package Modules"
3036 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3037 msgid "Packages from the programmer's viewpoint."
3041 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:274
3042 #: guix-git/doc/guix.texi:6369 guix-git/doc/guix.texi:6433
3043 #: guix-git/doc/guix.texi:6434
3045 msgid "Defining Packages"
3049 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3050 msgid "Defining new packages."
3054 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3055 #: guix-git/doc/guix.texi:7001 guix-git/doc/guix.texi:7002
3057 msgid "Defining Package Variants"
3061 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3062 msgid "Customizing packages."
3066 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3067 #: guix-git/doc/guix.texi:7233 guix-git/doc/guix.texi:7234
3069 msgid "Build Systems"
3073 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3074 msgid "Specifying how packages are built."
3078 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3079 #: guix-git/doc/guix.texi:8249 guix-git/doc/guix.texi:8250
3080 #: guix-git/doc/guix.texi:8653
3082 msgid "Build Phases"
3086 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3087 msgid "Phases of the build process of a package."
3091 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3092 #: guix-git/doc/guix.texi:8443 guix-git/doc/guix.texi:8444
3094 msgid "Build Utilities"
3098 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3099 msgid "Helpers for your package definitions and more."
3103 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3104 #: guix-git/doc/guix.texi:8730 guix-git/doc/guix.texi:8731
3110 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3111 msgid "Manipulating the package store."
3115 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3116 #: guix-git/doc/guix.texi:8883 guix-git/doc/guix.texi:8884
3122 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3123 msgid "Low-level interface to package derivations."
3127 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3128 #: guix-git/doc/guix.texi:9077 guix-git/doc/guix.texi:9078
3130 msgid "The Store Monad"
3134 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3135 msgid "Purely functional interface to the store."
3139 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3140 #: guix-git/doc/guix.texi:9396 guix-git/doc/guix.texi:9397
3142 msgid "G-Expressions"
3146 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3147 msgid "Manipulating build expressions."
3151 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3152 #: guix-git/doc/guix.texi:10025
3154 msgid "Invoking guix repl"
3158 #: guix-git/doc/guix.texi:272
3159 msgid "Programming Guix in Guile."
3163 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3164 #: guix-git/doc/guix.texi:6639
3166 msgid "package Reference"
3170 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3171 msgid "The package data type."
3175 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3176 #: guix-git/doc/guix.texi:6810
3178 msgid "origin Reference"
3182 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3183 msgid "The origin data type."
3187 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3188 #: guix-git/doc/guix.texi:10151
3190 msgid "Invoking guix build"
3194 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3195 msgid "Building packages from the command line."
3199 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3200 #: guix-git/doc/guix.texi:10987
3202 msgid "Invoking guix edit"
3206 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3207 msgid "Editing package definitions."
3211 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3212 #: guix-git/doc/guix.texi:11017
3214 msgid "Invoking guix download"
3218 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3219 msgid "Downloading a file and printing its hash."
3223 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3224 #: guix-git/doc/guix.texi:11075
3226 msgid "Invoking guix hash"
3230 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3231 msgid "Computing the cryptographic hash of a file."
3235 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3236 #: guix-git/doc/guix.texi:11147
3238 msgid "Invoking guix import"
3242 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3243 msgid "Importing package definitions."
3247 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3248 #: guix-git/doc/guix.texi:11602
3250 msgid "Invoking guix refresh"
3254 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3255 msgid "Updating package definitions."
3259 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3260 #: guix-git/doc/guix.texi:11938
3262 msgid "Invoking guix lint"
3266 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3267 msgid "Finding errors in package definitions."
3271 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3272 #: guix-git/doc/guix.texi:12107
3274 msgid "Invoking guix size"
3278 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3279 msgid "Profiling disk usage."
3283 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3284 #: guix-git/doc/guix.texi:12251
3286 msgid "Invoking guix graph"
3290 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3291 msgid "Visualizing the graph of packages."
3295 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3296 #: guix-git/doc/guix.texi:12518
3298 msgid "Invoking guix publish"
3302 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3303 msgid "Sharing substitutes."
3307 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3308 #: guix-git/doc/guix.texi:12777
3310 msgid "Invoking guix challenge"
3314 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3315 msgid "Challenging substitute servers."
3319 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3320 #: guix-git/doc/guix.texi:12960
3322 msgid "Invoking guix copy"
3326 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3327 msgid "Copying to and from a remote store."
3331 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3332 #: guix-git/doc/guix.texi:13023
3334 msgid "Invoking guix container"
3338 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3339 msgid "Process isolation."
3343 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3344 #: guix-git/doc/guix.texi:13077
3346 msgid "Invoking guix weather"
3350 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3351 msgid "Assessing substitute availability."
3355 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3356 #: guix-git/doc/guix.texi:13207
3358 msgid "Invoking guix processes"
3362 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3363 msgid "Listing client processes."
3367 #: guix-git/doc/guix.texi:297 guix-git/doc/guix.texi:10152
3369 msgid "Invoking @command{guix build}"
3373 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3374 #: guix-git/doc/guix.texi:10205 guix-git/doc/guix.texi:10206
3376 msgid "Common Build Options"
3380 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3381 msgid "Build options for most commands."
3385 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3386 #: guix-git/doc/guix.texi:10360 guix-git/doc/guix.texi:10361
3388 msgid "Package Transformation Options"
3392 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3393 msgid "Creating variants of packages."
3397 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3398 #: guix-git/doc/guix.texi:10669 guix-git/doc/guix.texi:10670
3400 msgid "Additional Build Options"
3404 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3405 msgid "Options specific to 'guix build'."
3409 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3410 #: guix-git/doc/guix.texi:10907 guix-git/doc/guix.texi:10908
3412 msgid "Debugging Build Failures"
3416 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3417 msgid "Real life packaging experience."
3421 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3422 #: guix-git/doc/guix.texi:13350 guix-git/doc/guix.texi:13351
3424 msgid "Using the Configuration System"
3428 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3429 msgid "Customizing your GNU system."
3433 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3434 #: guix-git/doc/guix.texi:13598
3436 msgid "operating-system Reference"
3440 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3441 msgid "Detail of operating-system declarations."
3445 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3446 #: guix-git/doc/guix.texi:13850 guix-git/doc/guix.texi:13851
3448 msgid "File Systems"
3452 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3453 msgid "Configuring file system mounts."
3457 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3458 #: guix-git/doc/guix.texi:14173 guix-git/doc/guix.texi:14174
3460 msgid "Mapped Devices"
3464 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3465 msgid "Block device extra processing."
3469 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3470 #: guix-git/doc/guix.texi:14321 guix-git/doc/guix.texi:14322
3472 msgid "User Accounts"
3476 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3477 msgid "Specifying user accounts."
3481 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:2259
3482 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:14497
3483 #: guix-git/doc/guix.texi:14498
3485 msgid "Keyboard Layout"
3489 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3490 msgid "How the system interprets key strokes."
3494 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1786
3495 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:14643
3496 #: guix-git/doc/guix.texi:14644
3502 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3503 msgid "Language and cultural convention settings."
3507 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:324
3508 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:14783
3509 #: guix-git/doc/guix.texi:14784
3515 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3516 msgid "Specifying system services."
3520 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3521 #: guix-git/doc/guix.texi:31980 guix-git/doc/guix.texi:31981
3523 msgid "Setuid Programs"
3527 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3528 msgid "Programs running with root privileges."
3532 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1935
3533 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:32026
3534 #: guix-git/doc/guix.texi:32027
3536 msgid "X.509 Certificates"
3540 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3541 msgid "Authenticating HTTPS servers."
3545 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:1829
3546 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:32089
3547 #: guix-git/doc/guix.texi:32090
3549 msgid "Name Service Switch"
3553 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3554 msgid "Configuring libc's name service switch."
3558 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3559 #: guix-git/doc/guix.texi:32227 guix-git/doc/guix.texi:32228
3561 msgid "Initial RAM Disk"
3565 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3566 msgid "Linux-Libre bootstrapping."
3570 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3571 #: guix-git/doc/guix.texi:32403 guix-git/doc/guix.texi:32404
3573 msgid "Bootloader Configuration"
3577 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3578 msgid "Configuring the boot loader."
3582 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3583 #: guix-git/doc/guix.texi:32697
3585 msgid "Invoking guix system"
3589 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3590 msgid "Instantiating a system configuration."
3594 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3595 #: guix-git/doc/guix.texi:33282
3597 msgid "Invoking guix deploy"
3601 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3602 msgid "Deploying a system configuration to a remote host."
3606 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3607 #: guix-git/doc/guix.texi:33488
3609 msgid "Running Guix in a VM"
3613 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3614 msgid "How to run Guix System in a virtual machine."
3618 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:359
3619 #: guix-git/doc/guix.texi:13348 guix-git/doc/guix.texi:33618
3620 #: guix-git/doc/guix.texi:33619
3622 msgid "Defining Services"
3626 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3627 msgid "Adding new service definitions."
3631 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3632 #: guix-git/doc/guix.texi:14868 guix-git/doc/guix.texi:14869
3634 msgid "Base Services"
3638 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3639 msgid "Essential system services."
3643 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3644 #: guix-git/doc/guix.texi:15784 guix-git/doc/guix.texi:15785
3646 msgid "Scheduled Job Execution"
3650 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3651 msgid "The mcron service."
3655 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3656 #: guix-git/doc/guix.texi:15925 guix-git/doc/guix.texi:15926
3658 msgid "Log Rotation"
3662 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3663 msgid "The rottlog service."
3667 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3668 #: guix-git/doc/guix.texi:16038 guix-git/doc/guix.texi:16039
3670 msgid "Networking Services"
3674 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3675 msgid "Network setup, SSH daemon, etc."
3679 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3680 #: guix-git/doc/guix.texi:17608 guix-git/doc/guix.texi:17609
3682 msgid "Unattended Upgrades"
3686 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3687 msgid "Automated system upgrades."
3691 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3692 #: guix-git/doc/guix.texi:17746 guix-git/doc/guix.texi:17747
3698 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3699 msgid "Graphical display."
3703 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3704 #: guix-git/doc/guix.texi:18123 guix-git/doc/guix.texi:18124
3706 msgid "Printing Services"
3710 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3711 msgid "Local and remote printer support."
3715 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3716 #: guix-git/doc/guix.texi:18976 guix-git/doc/guix.texi:18977
3718 msgid "Desktop Services"
3722 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3723 msgid "D-Bus and desktop services."
3727 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3728 #: guix-git/doc/guix.texi:19494 guix-git/doc/guix.texi:19495
3730 msgid "Sound Services"
3734 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3735 msgid "ALSA and Pulseaudio services."
3739 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3740 #: guix-git/doc/guix.texi:19634 guix-git/doc/guix.texi:19635
3742 msgid "Database Services"
3746 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3747 msgid "SQL databases, key-value stores, etc."
3751 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3752 #: guix-git/doc/guix.texi:19966 guix-git/doc/guix.texi:19967
3754 msgid "Mail Services"
3758 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3759 msgid "IMAP, POP3, SMTP, and all that."
3763 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3764 #: guix-git/doc/guix.texi:21782 guix-git/doc/guix.texi:21783
3766 msgid "Messaging Services"
3770 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3771 msgid "Messaging services."
3775 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3776 #: guix-git/doc/guix.texi:22285 guix-git/doc/guix.texi:22286
3778 msgid "Telephony Services"
3782 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3783 msgid "Telephony services."
3787 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3788 #: guix-git/doc/guix.texi:23288 guix-git/doc/guix.texi:23289
3790 msgid "Monitoring Services"
3794 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3795 msgid "Monitoring services."
3799 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3800 #: guix-git/doc/guix.texi:23799 guix-git/doc/guix.texi:23800
3802 msgid "Kerberos Services"
3806 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3807 msgid "Kerberos services."
3811 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3812 #: guix-git/doc/guix.texi:23925 guix-git/doc/guix.texi:23926
3814 msgid "LDAP Services"
3818 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3819 msgid "LDAP services."
3823 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3824 #: guix-git/doc/guix.texi:24404 guix-git/doc/guix.texi:24405
3826 msgid "Web Services"
3830 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3831 msgid "Web servers."
3835 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3836 #: guix-git/doc/guix.texi:25605 guix-git/doc/guix.texi:25606
3838 msgid "Certificate Services"
3842 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3843 msgid "TLS certificates via Let's Encrypt."
3847 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3848 #: guix-git/doc/guix.texi:25778 guix-git/doc/guix.texi:25779
3850 msgid "DNS Services"
3854 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3855 msgid "DNS daemons."
3859 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3860 #: guix-git/doc/guix.texi:26526 guix-git/doc/guix.texi:26527
3862 msgid "VPN Services"
3866 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3867 msgid "VPN daemons."
3871 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3872 #: guix-git/doc/guix.texi:26981 guix-git/doc/guix.texi:26982
3874 msgid "Network File System"
3878 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3879 msgid "NFS related services."
3883 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3884 #: guix-git/doc/guix.texi:27177 guix-git/doc/guix.texi:27178
3886 msgid "Continuous Integration"
3890 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3891 msgid "Cuirass and Laminar services."
3895 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3896 #: guix-git/doc/guix.texi:27455 guix-git/doc/guix.texi:27456
3898 msgid "Power Management Services"
3902 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3903 msgid "Extending battery life."
3907 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3908 #: guix-git/doc/guix.texi:27989 guix-git/doc/guix.texi:27990
3910 msgid "Audio Services"
3914 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3919 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3920 #: guix-git/doc/guix.texi:28108 guix-git/doc/guix.texi:28109
3922 msgid "Virtualization Services"
3926 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3927 msgid "Virtualization services."
3931 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3932 #: guix-git/doc/guix.texi:29722 guix-git/doc/guix.texi:29723
3934 msgid "Version Control Services"
3938 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3939 msgid "Providing remote access to Git repositories."
3943 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3944 #: guix-git/doc/guix.texi:30914 guix-git/doc/guix.texi:30915
3946 msgid "Game Services"
3950 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3951 msgid "Game servers."
3955 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3956 #: guix-git/doc/guix.texi:30946 guix-git/doc/guix.texi:30947
3958 msgid "PAM Mount Service"
3962 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3963 msgid "Service to mount volumes when logging in."
3967 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3968 #: guix-git/doc/guix.texi:31029 guix-git/doc/guix.texi:31030
3970 msgid "Guix Services"
3974 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3975 msgid "Services relating specifically to Guix."
3979 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3980 #: guix-git/doc/guix.texi:31304 guix-git/doc/guix.texi:31305
3982 msgid "Linux Services"
3986 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3987 msgid "Services tied to the Linux kernel."
3991 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3992 #: guix-git/doc/guix.texi:31451 guix-git/doc/guix.texi:31452
3994 msgid "Hurd Services"
3998 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3999 msgid "Services specific for a Hurd System."
4003 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
4004 #: guix-git/doc/guix.texi:31493 guix-git/doc/guix.texi:31494
4006 msgid "Miscellaneous Services"
4010 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
4011 msgid "Other services."
4015 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4016 #: guix-git/doc/guix.texi:33632 guix-git/doc/guix.texi:33633
4018 msgid "Service Composition"
4022 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4023 msgid "The model for composing services."
4027 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4028 #: guix-git/doc/guix.texi:33688 guix-git/doc/guix.texi:33689
4030 msgid "Service Types and Services"
4034 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4035 msgid "Types and services."
4039 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4040 #: guix-git/doc/guix.texi:33825 guix-git/doc/guix.texi:33826
4042 msgid "Service Reference"
4046 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4047 msgid "API reference."
4051 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4052 #: guix-git/doc/guix.texi:34116 guix-git/doc/guix.texi:34117
4054 msgid "Shepherd Services"
4058 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4059 msgid "A particular type of service."
4063 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4064 #: guix-git/doc/guix.texi:34419 guix-git/doc/guix.texi:34420
4066 msgid "Separate Debug Info"
4070 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4071 msgid "Installing 'debug' outputs."
4075 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4076 #: guix-git/doc/guix.texi:34478 guix-git/doc/guix.texi:34479
4078 msgid "Rebuilding Debug Info"
4082 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4083 msgid "Building missing debug info."
4087 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4088 #: guix-git/doc/guix.texi:34697
4090 msgid "Reduced Binary Seed Bootstrap"
4094 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4095 msgid "A Bootstrap worthy of GNU."
4099 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4100 #: guix-git/doc/guix.texi:34772 guix-git/doc/guix.texi:34773
4102 msgid "Preparing to Use the Bootstrap Binaries"
4106 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4107 msgid "Building that what matters most."
4111 #: guix-git/doc/guix.texi:382
4117 #: guix-git/doc/guix.texi:390
4118 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."
4122 #: guix-git/doc/guix.texi:391 guix-git/doc/guix.texi:466
4128 #: guix-git/doc/guix.texi:392
4130 msgid "GuixSD, now Guix System"
4134 #: guix-git/doc/guix.texi:393
4136 msgid "Guix System Distribution, now Guix System"
4140 #: guix-git/doc/guix.texi:402
4141 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}."
4145 #: guix-git/doc/guix.texi:411
4147 msgid "user interfaces"
4151 #: guix-git/doc/guix.texi:417
4152 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})."
4156 #: guix-git/doc/guix.texi:417
4158 msgid "build daemon"
4162 #: guix-git/doc/guix.texi:421
4163 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})."
4167 #: guix-git/doc/guix.texi:422
4169 msgid "extensibility of the distribution"
4173 #: guix-git/doc/guix.texi:423 guix-git/doc/guix.texi:6393
4175 msgid "customization, of packages"
4179 #: guix-git/doc/guix.texi:432
4180 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})."
4184 #: guix-git/doc/guix.texi:433
4186 msgid "functional package management"
4190 #: guix-git/doc/guix.texi:434
4196 #: guix-git/doc/guix.texi:449
4197 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."
4201 #: guix-git/doc/guix.texi:450 guix-git/doc/guix.texi:8733
4207 #: guix-git/doc/guix.texi:457
4208 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."
4212 #: guix-git/doc/guix.texi:461
4213 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})."
4217 #: guix-git/doc/guix.texi:476
4218 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."
4222 #: guix-git/doc/guix.texi:482
4223 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}):"
4227 #: guix-git/doc/guix.texi:485
4229 msgid "guix package --list-available\n"
4233 #: guix-git/doc/guix.texi:491
4234 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."
4238 #: guix-git/doc/guix.texi:493
4239 msgid "Packages are currently available on the following platforms:"
4243 #: guix-git/doc/guix.texi:496 guix-git/doc/guix.texi:2106
4245 msgid "x86_64-linux"
4249 #: guix-git/doc/guix.texi:498
4250 msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel."
4254 #: guix-git/doc/guix.texi:499 guix-git/doc/guix.texi:2109
4260 #: guix-git/doc/guix.texi:501
4261 msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel."
4265 #: guix-git/doc/guix.texi:502
4271 #: guix-git/doc/guix.texi:506
4272 msgid "ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-float application binary interface (ABI), and Linux-Libre kernel."
4276 #: guix-git/doc/guix.texi:507
4278 msgid "aarch64-linux"
4282 #: guix-git/doc/guix.texi:509
4283 msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel."
4287 #: guix-git/doc/guix.texi:510
4293 #: guix-git/doc/guix.texi:513
4294 msgid "@uref{https://hurd.gnu.org, GNU/Hurd} on the Intel 32-bit architecture (IA32)."
4298 #: guix-git/doc/guix.texi:519
4299 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!"
4303 #: guix-git/doc/guix.texi:520
4305 msgid "mips64el-linux (deprecated)"
4309 #: guix-git/doc/guix.texi:526
4310 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."
4314 #: guix-git/doc/guix.texi:527
4316 msgid "powerpc64le-linux"
4320 #: guix-git/doc/guix.texi:537
4321 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!"
4325 #: guix-git/doc/guix.texi:547
4326 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."
4330 #: guix-git/doc/guix.texi:550
4331 msgid "Guix System is available on all the above platforms except @code{mips64el-linux} and @code{powerpc64le-linux}."
4335 #: guix-git/doc/guix.texi:554
4336 msgid "For information on porting to other architectures or kernels, @pxref{Porting}."
4340 #: guix-git/doc/guix.texi:557
4341 msgid "Building this distribution is a cooperative effort, and you are invited to join! @xref{Contributing}, for information about how you can help."
4345 #: guix-git/doc/guix.texi:563
4347 msgid "installing Guix"
4351 #: guix-git/doc/guix.texi:575
4352 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."
4356 #: guix-git/doc/guix.texi:577 guix-git/doc/guix.texi:1781
4358 msgid "foreign distro"
4362 #: guix-git/doc/guix.texi:578
4364 msgid "directories related to foreign distro"
4368 #: guix-git/doc/guix.texi:583
4369 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."
4373 #: guix-git/doc/guix.texi:586
4374 msgid "Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull})."
4378 #: guix-git/doc/guix.texi:591
4379 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."
4383 #: guix-git/doc/guix.texi:605
4385 msgid "installing Guix from binaries"
4389 #: guix-git/doc/guix.texi:606
4391 msgid "installer script"
4395 #: guix-git/doc/guix.texi:612
4396 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."
4400 #: guix-git/doc/guix.texi:620
4401 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:"
4405 #: guix-git/doc/guix.texi:626
4409 "wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh\n"
4410 "chmod +x guix-install.sh\n"
4411 "./guix-install.sh\n"
4415 #: guix-git/doc/guix.texi:630
4416 msgid "When you're done, @pxref{Application Setup} for extra configuration you might need, and @ref{Getting Started} for your first steps!"
4420 #: guix-git/doc/guix.texi:633
4421 msgid "Installing goes along these lines:"
4425 #: guix-git/doc/guix.texi:636
4427 msgid "downloading Guix binary"
4431 #: guix-git/doc/guix.texi:642
4432 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})."
4436 #: guix-git/doc/guix.texi:646
4437 msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the tarball against it, along these lines:"
4441 #: guix-git/doc/guix.texi:650
4444 "$ wget @value{BASE-URL}/guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
4445 "$ gpg --verify guix-binary-@value{VERSION}.x86_64-linux.tar.xz.sig\n"
4449 #: guix-git/doc/guix.texi:654 guix-git/doc/guix.texi:2124
4450 msgid "If that command fails because you do not have the required public key, then run this command to import it:"
4454 #: guix-git/doc/guix.texi:658
4457 "$ wget '@value{OPENPGP-SIGNING-KEY-URL}' \\\n"
4458 " -qO - | gpg --import -\n"
4462 #: guix-git/doc/guix.texi:662 guix-git/doc/guix.texi:2132
4463 msgid "and rerun the @code{gpg --verify} command."
4467 #: guix-git/doc/guix.texi:665 guix-git/doc/guix.texi:2135
4468 msgid "Take note that a warning like ``This key is not certified with a trusted signature!'' is normal."
4472 #: guix-git/doc/guix.texi:671
4473 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:"
4477 #: guix-git/doc/guix.texi:677
4481 "# tar --warning=no-timestamp -xf \\\n"
4482 " /path/to/guix-binary-@value{VERSION}.x86_64-linux.tar.xz\n"
4483 "# mv var/guix /var/ && mv gnu /\n"
4487 #: guix-git/doc/guix.texi:682
4488 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)."
4492 #: guix-git/doc/guix.texi:685
4493 msgid "Do @emph{not} unpack the tarball on a working Guix system since that would overwrite its own essential files."
4497 #: guix-git/doc/guix.texi:695
4498 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."
4502 #: guix-git/doc/guix.texi:699
4503 msgid "Make the profile available under @file{~root/.config/guix/current}, which is where @command{guix pull} will install updates (@pxref{Invoking guix pull}):"
4507 #: guix-git/doc/guix.texi:704
4510 "# mkdir -p ~root/.config/guix\n"
4511 "# ln -sf /var/guix/profiles/per-user/root/current-guix \\\n"
4512 " ~root/.config/guix/current\n"
4516 #: guix-git/doc/guix.texi:708
4517 msgid "Source @file{etc/profile} to augment @env{PATH} and other relevant environment variables:"
4521 #: guix-git/doc/guix.texi:712
4524 "# GUIX_PROFILE=\"`echo ~root`/.config/guix/current\" ; \\\n"
4525 " source $GUIX_PROFILE/etc/profile\n"
4529 #: guix-git/doc/guix.texi:717
4530 msgid "Create the group and user accounts for build users as explained below (@pxref{Build Environment Setup})."
4534 #: guix-git/doc/guix.texi:720
4535 msgid "Run the daemon, and set it to automatically start on boot."
4539 #: guix-git/doc/guix.texi:723
4540 msgid "If your host distro uses the systemd init system, this can be achieved with these commands:"
4544 #: guix-git/doc/guix.texi:736
4547 "# cp ~root/.config/guix/current/lib/systemd/system/gnu-store.mount \\\n"
4548 " ~root/.config/guix/current/lib/systemd/system/guix-daemon.service \\\n"
4549 " /etc/systemd/system/\n"
4550 "# systemctl enable --now gnu-store.mount guix-daemon\n"
4554 #: guix-git/doc/guix.texi:739 guix-git/doc/guix.texi:12767
4555 msgid "If your host distro uses the Upstart init system:"
4559 #: guix-git/doc/guix.texi:745
4562 "# initctl reload-configuration\n"
4563 "# cp ~root/.config/guix/current/lib/upstart/system/guix-daemon.conf \\\n"
4565 "# start guix-daemon\n"
4569 #: guix-git/doc/guix.texi:748
4570 msgid "Otherwise, you can still start the daemon manually with:"
4574 #: guix-git/doc/guix.texi:752
4577 "# ~root/.config/guix/current/bin/guix-daemon \\\n"
4578 " --build-users-group=guixbuild\n"
4582 #: guix-git/doc/guix.texi:757
4583 msgid "Make the @command{guix} command available to other users on the machine, for instance with:"
4587 #: guix-git/doc/guix.texi:762
4590 "# mkdir -p /usr/local/bin\n"
4591 "# cd /usr/local/bin\n"
4592 "# ln -s /var/guix/profiles/per-user/root/current-guix/bin/guix\n"
4596 #: guix-git/doc/guix.texi:766
4597 msgid "It is also a good idea to make the Info version of this manual available there:"
4601 #: guix-git/doc/guix.texi:772
4604 "# mkdir -p /usr/local/share/info\n"
4605 "# cd /usr/local/share/info\n"
4606 "# for i in /var/guix/profiles/per-user/root/current-guix/share/info/* ;\n"
4607 " do ln -s $i ; done\n"
4611 #: guix-git/doc/guix.texi:778
4612 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)."
4616 #: guix-git/doc/guix.texi:780 guix-git/doc/guix.texi:3724
4617 #: guix-git/doc/guix.texi:15401
4619 msgid "substitutes, authorization thereof"
4623 #: guix-git/doc/guix.texi:783
4624 msgid "To use substitutes from @code{@value{SUBSTITUTE-SERVER}} or one of its mirrors (@pxref{Substitutes}), authorize them:"
4628 #: guix-git/doc/guix.texi:787
4631 "# guix archive --authorize < \\\n"
4632 " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
4636 #: guix-git/doc/guix.texi:792
4637 msgid "Each user may need to perform a few additional steps to make their Guix environment ready for use, @pxref{Application Setup}."
4641 #: guix-git/doc/guix.texi:795
4642 msgid "Voilà, the installation is complete!"
4646 #: guix-git/doc/guix.texi:798
4647 msgid "You can confirm that Guix is working by installing a sample package into the root profile:"
4651 #: guix-git/doc/guix.texi:801
4653 msgid "# guix install hello\n"
4657 #: guix-git/doc/guix.texi:805
4658 msgid "The binary installation tarball can be (re)produced and verified simply by running the following command in the Guix source tree:"
4662 #: guix-git/doc/guix.texi:808
4664 msgid "make guix-binary.@var{system}.tar.xz\n"
4668 #: guix-git/doc/guix.texi:812
4669 msgid "...@: which, in turn, runs:"
4673 #: guix-git/doc/guix.texi:816
4676 "guix pack -s @var{system} --localstatedir \\\n"
4677 " --profile-name=current-guix guix\n"
4681 #: guix-git/doc/guix.texi:819
4682 msgid "@xref{Invoking guix pack}, for more info on this handy tool."
4686 #: guix-git/doc/guix.texi:827
4687 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."
4691 #: guix-git/doc/guix.texi:828
4693 msgid "official website"
4697 #: guix-git/doc/guix.texi:831
4698 msgid "GNU Guix is available for download from its website at @url{https://www.gnu.org/software/guix/}."
4702 #: guix-git/doc/guix.texi:833
4703 msgid "GNU Guix depends on the following packages:"
4707 #: guix-git/doc/guix.texi:835
4709 msgid "@url{https://gnu.org/software/guile/, GNU Guile}, version 3.0.x or"
4713 #: guix-git/doc/guix.texi:837
4718 #: guix-git/doc/guix.texi:837
4720 msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version"
4724 #: guix-git/doc/guix.texi:839
4725 msgid "0.1.0 or later;"
4729 #: guix-git/doc/guix.texi:843
4730 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});"
4734 #: guix-git/doc/guix.texi:846
4735 msgid "@uref{https://notabug.org/guile-sqlite3/guile-sqlite3, Guile-SQLite3}, version 0.1.0 or later;"
4739 #: guix-git/doc/guix.texi:846
4741 msgid "@uref{https://notabug.org/guile-zlib/guile-zlib, Guile-zlib},"
4745 #: guix-git/doc/guix.texi:848
4746 msgid "version 0.1.0 or later;"
4750 #: guix-git/doc/guix.texi:848
4752 msgid "@uref{https://notabug.org/guile-lzlib/guile-lzlib, Guile-lzlib};"
4756 #: guix-git/doc/guix.texi:849
4758 msgid "@uref{https://www.nongnu.org/guile-avahi/, Guile-Avahi};"
4762 #: guix-git/doc/guix.texi:855
4763 msgid "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, version 0.3.0 or later;"
4767 #: guix-git/doc/guix.texi:855
4769 msgid "@uref{https://savannah.nongnu.org/projects/guile-json/, Guile-JSON}"
4773 #: guix-git/doc/guix.texi:857
4774 msgid "4.3.0 or later;"
4778 #: guix-git/doc/guix.texi:857
4780 msgid "@url{https://www.gnu.org/software/make/, GNU Make}."
4784 #: guix-git/doc/guix.texi:861
4785 msgid "The following dependencies are optional:"
4789 #: guix-git/doc/guix.texi:869
4790 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."
4794 #: guix-git/doc/guix.texi:874
4795 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})."
4799 #: guix-git/doc/guix.texi:878
4800 msgid "@uref{https://ngyro.com/software/guile-semver.html, Guile-Semver} for the @code{crate} importer (@pxref{Invoking guix import})."
4804 #: guix-git/doc/guix.texi:883
4805 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})."
4809 #: guix-git/doc/guix.texi:887
4810 msgid "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} can use it to compress build logs."
4814 #: guix-git/doc/guix.texi:891
4815 msgid "Unless @option{--disable-daemon} was passed to @command{configure}, the following packages are also needed:"
4819 #: guix-git/doc/guix.texi:893
4821 msgid "@url{https://gnupg.org/, GNU libgcrypt};"
4825 #: guix-git/doc/guix.texi:894
4827 msgid "@url{https://sqlite.org, SQLite 3};"
4831 #: guix-git/doc/guix.texi:895
4833 msgid "@url{https://gcc.gnu.org, GCC's g++}, with support for the"
4837 #: guix-git/doc/guix.texi:897
4838 msgid "C++11 standard."
4842 #: guix-git/doc/guix.texi:899
4844 msgid "state directory"
4848 #: guix-git/doc/guix.texi:908
4849 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})."
4853 #: guix-git/doc/guix.texi:912
4859 #: guix-git/doc/guix.texi:918
4860 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:"
4864 #: guix-git/doc/guix.texi:921
4866 msgid "make check\n"
4870 #: guix-git/doc/guix.texi:928
4871 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."
4875 #: guix-git/doc/guix.texi:931
4876 msgid "It is also possible to run a subset of the tests by defining the @code{TESTS} makefile variable as in this example:"
4880 #: guix-git/doc/guix.texi:934
4882 msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n"
4886 #: guix-git/doc/guix.texi:939
4887 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:"
4891 #: guix-git/doc/guix.texi:942
4893 msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n"
4897 #: guix-git/doc/guix.texi:950
4898 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'':"
4902 #: guix-git/doc/guix.texi:954
4905 "export SCM_LOG_DRIVER_FLAGS=\"--select=^transaction-upgrade-entry\"\n"
4906 "make check TESTS=\"tests/packages.scm\"\n"
4910 #: guix-git/doc/guix.texi:960
4911 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:"
4915 #: guix-git/doc/guix.texi:963
4917 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --errors-only=yes\" VERBOSE=1\n"
4921 #: guix-git/doc/guix.texi:968
4922 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}:"
4926 #: guix-git/doc/guix.texi:971
4928 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --show-duration=yes\"\n"
4932 #: guix-git/doc/guix.texi:975
4933 msgid "@xref{Parallel Test Harness,,,automake,GNU Automake} for more information about the Automake Parallel Test Harness."
4937 #: guix-git/doc/guix.texi:980
4938 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."
4942 #: guix-git/doc/guix.texi:984
4943 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:"
4947 #: guix-git/doc/guix.texi:987
4949 msgid "make check-system\n"
4953 #: guix-git/doc/guix.texi:991
4954 msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:"
4958 #: guix-git/doc/guix.texi:994
4960 msgid "make check-system TESTS=\"basic mcron\"\n"
4964 #: guix-git/doc/guix.texi:1002
4965 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."
4969 #: guix-git/doc/guix.texi:1005
4970 msgid "Again in case of test failures, please send @email{bug-guix@@gnu.org} all the details."
4974 #: guix-git/doc/guix.texi:1009
4980 #: guix-git/doc/guix.texi:1017
4981 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."
4985 #: guix-git/doc/guix.texi:1021
4986 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."
4990 #: guix-git/doc/guix.texi:1031 guix-git/doc/guix.texi:1493
4992 msgid "build environment"
4996 #: guix-git/doc/guix.texi:1039
4997 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."
5001 #: guix-git/doc/guix.texi:1040
5007 #: guix-git/doc/guix.texi:1051
5008 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})."
5012 #: guix-git/doc/guix.texi:1054
5013 msgid "On a GNU/Linux system, a build user pool may be created like this (using Bash syntax and the @code{shadow} commands):"
5017 #: guix-git/doc/guix.texi:1066
5020 "# groupadd --system guixbuild\n"
5021 "# for i in $(seq -w 1 10);\n"
5023 " useradd -g guixbuild -G guixbuild \\\n"
5024 " -d /var/empty -s $(which nologin) \\\n"
5025 " -c \"Guix build user $i\" --system \\\n"
5031 #: guix-git/doc/guix.texi:1076
5032 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})."
5036 #: guix-git/doc/guix.texi:1085
5037 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}.}:"
5041 #: guix-git/doc/guix.texi:1088 guix-git/doc/guix.texi:1486
5043 msgid "# guix-daemon --build-users-group=guixbuild\n"
5047 #: guix-git/doc/guix.texi:1090 guix-git/doc/guix.texi:1491
5053 #: guix-git/doc/guix.texi:1095
5054 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:"
5058 #: guix-git/doc/guix.texi:1103
5059 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.};"
5063 #: guix-git/doc/guix.texi:1107
5064 msgid "the @code{/proc} directory; it only shows the processes of the container since a separate PID name space is used;"
5068 #: guix-git/doc/guix.texi:1111
5069 msgid "@file{/etc/passwd} with an entry for the current user and an entry for user @file{nobody};"
5073 #: guix-git/doc/guix.texi:1114
5074 msgid "@file{/etc/group} with an entry for the user's group;"
5078 #: guix-git/doc/guix.texi:1118
5079 msgid "@file{/etc/hosts} with an entry that maps @code{localhost} to @code{127.0.0.1};"
5083 #: guix-git/doc/guix.texi:1121
5084 msgid "a writable @file{/tmp} directory."
5088 #: guix-git/doc/guix.texi:1130
5089 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."
5093 #: guix-git/doc/guix.texi:1131 guix-git/doc/guix.texi:3929
5099 #: guix-git/doc/guix.texi:1132 guix-git/doc/guix.texi:3930
5105 #: guix-git/doc/guix.texi:1137
5106 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})."
5110 #: guix-git/doc/guix.texi:1145
5111 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."
5115 #: guix-git/doc/guix.texi:1148
5117 msgid "Using the Offload Facility"
5121 #: guix-git/doc/guix.texi:1150 guix-git/doc/guix.texi:1552
5127 #: guix-git/doc/guix.texi:1151
5133 #: guix-git/doc/guix.texi:1170
5134 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:"
5138 #: guix-git/doc/guix.texi:1176
5139 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."
5143 #: guix-git/doc/guix.texi:1180
5144 msgid "Its relative speed, as defined via the @code{speed} field of its @code{build-machine} object."
5148 #: guix-git/doc/guix.texi:1185
5149 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."
5153 #: guix-git/doc/guix.texi:1188
5154 msgid "Disk space availability. More than a 100 MiB must be available."
5158 #: guix-git/doc/guix.texi:1191
5159 msgid "The @file{/etc/guix/machines.scm} file typically looks like this:"
5163 #: guix-git/doc/guix.texi:1199
5166 "(list (build-machine\n"
5167 " (name \"eightysix.example.org\")\n"
5168 " (systems (list \"x86_64-linux\" \"i686-linux\"))\n"
5169 " (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n"
5171 " (speed 2.)) ;incredibly fast!\n"
5176 #: guix-git/doc/guix.texi:1208
5180 " (name \"armeight.example.org\")\n"
5181 " (systems (list \"aarch64-linux\"))\n"
5182 " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n"
5183 " (user \"alice\")\n"
5185 " (string-append (getenv \"HOME\")\n"
5186 " \"/.ssh/identity-for-guix\"))))\n"
5190 #: guix-git/doc/guix.texi:1214
5191 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."
5195 #: guix-git/doc/guix.texi:1223
5196 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."
5200 #: guix-git/doc/guix.texi:1224
5202 msgid "{Data Type} build-machine"
5206 #: guix-git/doc/guix.texi:1227
5207 msgid "This data type represents build machines to which the daemon may offload builds. The important fields are:"
5211 #: guix-git/doc/guix.texi:1230 guix-git/doc/guix.texi:6649
5212 #: guix-git/doc/guix.texi:14367 guix-git/doc/guix.texi:14461
5213 #: guix-git/doc/guix.texi:14702 guix-git/doc/guix.texi:16651
5214 #: guix-git/doc/guix.texi:19835 guix-git/doc/guix.texi:22471
5215 #: guix-git/doc/guix.texi:23860 guix-git/doc/guix.texi:24472
5216 #: guix-git/doc/guix.texi:24824 guix-git/doc/guix.texi:24865
5217 #: guix-git/doc/guix.texi:26964 guix-git/doc/guix.texi:29233
5218 #: guix-git/doc/guix.texi:29253 guix-git/doc/guix.texi:31700
5219 #: guix-git/doc/guix.texi:31717 guix-git/doc/guix.texi:32206
5220 #: guix-git/doc/guix.texi:33938 guix-git/doc/guix.texi:34246
5226 #: guix-git/doc/guix.texi:1232
5227 msgid "The host name of the remote machine."
5231 #: guix-git/doc/guix.texi:1233
5237 #: guix-git/doc/guix.texi:1236
5238 msgid "The system types the remote machine supports---e.g., @code{(list \"x86_64-linux\" \"i686-linux\")}."
5242 #: guix-git/doc/guix.texi:1237 guix-git/doc/guix.texi:16661
5248 #: guix-git/doc/guix.texi:1241
5249 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."
5253 #: guix-git/doc/guix.texi:1242
5259 #: guix-git/doc/guix.texi:1246
5260 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:"
5264 #: guix-git/doc/guix.texi:1249
5266 msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n"
5270 #: guix-git/doc/guix.texi:1254
5271 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}."
5275 #: guix-git/doc/guix.texi:1259
5276 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}):"
5280 #: guix-git/doc/guix.texi:1263
5283 "$ lsh-export-key --openssh < /etc/lsh/host-key.pub\n"
5284 "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n"
5288 #: guix-git/doc/guix.texi:1268
5289 msgid "A number of optional fields may be specified:"
5293 #: guix-git/doc/guix.texi:1271 guix-git/doc/guix.texi:33438
5295 msgid "@code{port} (default: @code{22})"
5299 #: guix-git/doc/guix.texi:1273
5300 msgid "Port number of SSH server on the machine."
5304 #: guix-git/doc/guix.texi:1274
5306 msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})"
5310 #: guix-git/doc/guix.texi:1277
5311 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."
5315 #: guix-git/doc/guix.texi:1280
5316 msgid "Note that the default value is the private key @emph{of the root account}. Make sure it exists if you use the default."
5320 #: guix-git/doc/guix.texi:1281
5322 msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})"
5326 #: guix-git/doc/guix.texi:1282
5328 msgid "@code{compression-level} (default: @code{3})"
5332 #: guix-git/doc/guix.texi:1284
5333 msgid "The SSH-level compression methods and compression level requested."
5337 #: guix-git/doc/guix.texi:1287
5338 msgid "Note that offloading relies on SSH compression to reduce bandwidth usage when transferring files to and from build machines."
5342 #: guix-git/doc/guix.texi:1288
5344 msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})"
5348 #: guix-git/doc/guix.texi:1291
5349 msgid "File name of the Unix-domain socket @command{guix-daemon} is listening to on that machine."
5353 #: guix-git/doc/guix.texi:1292
5355 msgid "@code{overload-threshold} (default: @code{0.6})"
5359 #: guix-git/doc/guix.texi:1298
5360 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}."
5364 #: guix-git/doc/guix.texi:1299
5366 msgid "@code{parallel-builds} (default: @code{1})"
5370 #: guix-git/doc/guix.texi:1301
5371 msgid "The number of builds that may run in parallel on the machine."
5375 #: guix-git/doc/guix.texi:1302
5377 msgid "@code{speed} (default: @code{1.0})"
5381 #: guix-git/doc/guix.texi:1305
5382 msgid "A ``relative speed factor''. The offload scheduler will tend to prefer machines with a higher speed factor."
5386 #: guix-git/doc/guix.texi:1306
5388 msgid "@code{features} (default: @code{'()})"
5392 #: guix-git/doc/guix.texi:1311
5393 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."
5397 #: guix-git/doc/guix.texi:1317
5398 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:"
5402 #: guix-git/doc/guix.texi:1320
5404 msgid "ssh build-machine guix repl --version\n"
5408 #: guix-git/doc/guix.texi:1327
5409 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}):"
5413 #: guix-git/doc/guix.texi:1330 guix-git/doc/guix.texi:33366
5415 msgid "# guix archive --generate-key\n"
5419 #: guix-git/doc/guix.texi:1335
5420 msgid "Each build machine must authorize the key of the master machine so that it accepts store items it receives from the master:"
5424 #: guix-git/doc/guix.texi:1338
5426 msgid "# guix archive --authorize < master-public-key.txt\n"
5430 #: guix-git/doc/guix.texi:1342
5431 msgid "Likewise, the master machine must authorize the key of each build machine."
5435 #: guix-git/doc/guix.texi:1348
5436 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."
5440 #: guix-git/doc/guix.texi:1349
5442 msgid "offload test"
5446 #: guix-git/doc/guix.texi:1352
5447 msgid "To test whether your setup is operational, run this command on the master node:"
5451 #: guix-git/doc/guix.texi:1355
5453 msgid "# guix offload test\n"
5457 #: guix-git/doc/guix.texi:1361
5458 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."
5462 #: guix-git/doc/guix.texi:1364
5463 msgid "If you want to test a different machine file, just specify it on the command line:"
5467 #: guix-git/doc/guix.texi:1367
5469 msgid "# guix offload test machines-qualif.scm\n"
5473 #: guix-git/doc/guix.texi:1371
5474 msgid "Last, you can test the subset of the machines whose name matches a regular expression like this:"
5478 #: guix-git/doc/guix.texi:1374
5480 msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n"
5484 #: guix-git/doc/guix.texi:1376
5486 msgid "offload status"
5490 #: guix-git/doc/guix.texi:1379
5491 msgid "To display the current load of all build hosts, run this command on the main node:"
5495 #: guix-git/doc/guix.texi:1382
5497 msgid "# guix offload status\n"
5501 #: guix-git/doc/guix.texi:1388
5503 msgid "SELinux, daemon policy"
5507 #: guix-git/doc/guix.texi:1389
5509 msgid "mandatory access control, SELinux"
5513 #: guix-git/doc/guix.texi:1390
5515 msgid "security, guix-daemon"
5519 #: guix-git/doc/guix.texi:1396
5520 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."
5523 #. type: subsubsection
5524 #: guix-git/doc/guix.texi:1397
5526 msgid "Installing the SELinux policy"
5530 #: guix-git/doc/guix.texi:1398
5532 msgid "SELinux, policy installation"
5536 #: guix-git/doc/guix.texi:1400
5537 msgid "To install the policy run this command as root:"
5541 #: guix-git/doc/guix.texi:1403
5543 msgid "semodule -i etc/guix-daemon.cil\n"
5547 #: guix-git/doc/guix.texi:1407
5548 msgid "Then relabel the file system with @code{restorecon} or by a different mechanism provided by your system."
5552 #: guix-git/doc/guix.texi:1412
5553 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:"
5557 #: guix-git/doc/guix.texi:1415
5559 msgid "ps -Zax | grep guix-daemon\n"
5563 #: guix-git/doc/guix.texi:1420
5564 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."
5568 #: guix-git/doc/guix.texi:1422
5570 msgid "SELinux, limitations"
5574 #: guix-git/doc/guix.texi:1427
5575 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."
5579 #: guix-git/doc/guix.texi:1434
5580 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."
5584 #: guix-git/doc/guix.texi:1445
5585 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."
5589 #: guix-git/doc/guix.texi:1450
5590 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."
5594 #: guix-git/doc/guix.texi:1461
5595 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."
5599 #: guix-git/doc/guix.texi:1466
5600 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."
5604 #: guix-git/doc/guix.texi:1474
5605 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."
5609 #: guix-git/doc/guix.texi:1477
5611 msgid "Invoking @command{guix-daemon}"
5615 #: guix-git/doc/guix.texi:1483
5616 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:"
5620 #: guix-git/doc/guix.texi:1490
5621 msgid "For details on how to set it up, @pxref{Setting Up the Daemon}."
5625 #: guix-git/doc/guix.texi:1492
5627 msgid "container, build environment"
5631 #: guix-git/doc/guix.texi:1494 guix-git/doc/guix.texi:3011
5632 #: guix-git/doc/guix.texi:3910 guix-git/doc/guix.texi:12780
5634 msgid "reproducible builds"
5638 #: guix-git/doc/guix.texi:1506
5639 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})."
5643 #: guix-git/doc/guix.texi:1512
5644 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}."
5648 #: guix-git/doc/guix.texi:1516
5649 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}})."
5653 #: guix-git/doc/guix.texi:1522
5654 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."
5658 #: guix-git/doc/guix.texi:1524
5659 msgid "The following command-line options are supported:"
5663 #: guix-git/doc/guix.texi:1526
5665 msgid "--build-users-group=@var{group}"
5669 #: guix-git/doc/guix.texi:1529
5670 msgid "Take users from @var{group} to run build processes (@pxref{Setting Up the Daemon, build users})."
5674 #: guix-git/doc/guix.texi:1530 guix-git/doc/guix.texi:10265
5676 msgid "--no-substitutes"
5680 #: guix-git/doc/guix.texi:1531 guix-git/doc/guix.texi:3023
5681 #: guix-git/doc/guix.texi:3668
5687 #: guix-git/doc/guix.texi:1535 guix-git/doc/guix.texi:10269
5688 msgid "Do not use substitutes for build products. That is, always build things locally instead of allowing downloads of pre-built binaries (@pxref{Substitutes})."
5692 #: guix-git/doc/guix.texi:1539
5693 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})."
5697 #: guix-git/doc/guix.texi:1541
5698 msgid "daemon-substitute-urls"
5702 #: guix-git/doc/guix.texi:1541 guix-git/doc/guix.texi:10252
5703 #: guix-git/doc/guix.texi:12211 guix-git/doc/guix.texi:12926
5704 #: guix-git/doc/guix.texi:13151
5706 msgid "--substitute-urls=@var{urls}"
5710 #: guix-git/doc/guix.texi:1545
5711 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."
5715 #: guix-git/doc/guix.texi:1548
5716 msgid "This means that substitutes may be downloaded from @var{urls}, as long as they are signed by a trusted signature (@pxref{Substitutes})."
5720 #: guix-git/doc/guix.texi:1551
5721 msgid "@xref{Getting Substitutes from Other Servers}, for more information on how to configure the daemon to get substitutes from other servers."
5725 #: guix-git/doc/guix.texi:1553 guix-git/doc/guix.texi:10288
5727 msgid "--no-offload"
5731 #: guix-git/doc/guix.texi:1557 guix-git/doc/guix.texi:10292
5732 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."
5736 #: guix-git/doc/guix.texi:1558
5738 msgid "--cache-failures"
5742 #: guix-git/doc/guix.texi:1560
5743 msgid "Cache build failures. By default, only successful builds are cached."
5747 #: guix-git/doc/guix.texi:1565
5748 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}."
5752 #: guix-git/doc/guix.texi:1566 guix-git/doc/guix.texi:10318
5754 msgid "--cores=@var{n}"
5758 #: guix-git/doc/guix.texi:1567 guix-git/doc/guix.texi:10319
5764 #: guix-git/doc/guix.texi:1570
5765 msgid "Use @var{n} CPU cores to build each derivation; @code{0} means as many as available."
5769 #: guix-git/doc/guix.texi:1574
5770 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})."
5774 #: guix-git/doc/guix.texi:1578
5775 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}."
5779 #: guix-git/doc/guix.texi:1579 guix-git/doc/guix.texi:10323
5781 msgid "--max-jobs=@var{n}"
5785 #: guix-git/doc/guix.texi:1580 guix-git/doc/guix.texi:10324
5791 #: guix-git/doc/guix.texi:1585
5792 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."
5796 #: guix-git/doc/guix.texi:1586 guix-git/doc/guix.texi:10293
5798 msgid "--max-silent-time=@var{seconds}"
5802 #: guix-git/doc/guix.texi:1589 guix-git/doc/guix.texi:10296
5803 msgid "When the build or substitution process remains silent for more than @var{seconds}, terminate it and report a build failure."
5807 #: guix-git/doc/guix.texi:1591 guix-git/doc/guix.texi:1600
5808 msgid "The default value is @code{0}, which disables the timeout."
5812 #: guix-git/doc/guix.texi:1594
5813 msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--max-silent-time}})."
5817 #: guix-git/doc/guix.texi:1595 guix-git/doc/guix.texi:10300
5819 msgid "--timeout=@var{seconds}"
5823 #: guix-git/doc/guix.texi:1598 guix-git/doc/guix.texi:10303
5824 msgid "Likewise, when the build or substitution process lasts for more than @var{seconds}, terminate it and report a build failure."
5828 #: guix-git/doc/guix.texi:1603
5829 msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--timeout}})."
5833 #: guix-git/doc/guix.texi:1604
5835 msgid "--rounds=@var{N}"
5839 #: guix-git/doc/guix.texi:1609
5840 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})."
5844 #: guix-git/doc/guix.texi:1613 guix-git/doc/guix.texi:10287
5845 #: guix-git/doc/guix.texi:10849
5846 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."
5850 #: guix-git/doc/guix.texi:1614
5856 #: guix-git/doc/guix.texi:1616
5857 msgid "Produce debugging output."
5861 #: guix-git/doc/guix.texi:1620
5862 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})."
5866 #: guix-git/doc/guix.texi:1621
5868 msgid "--chroot-directory=@var{dir}"
5872 #: guix-git/doc/guix.texi:1623
5873 msgid "Add @var{dir} to the build chroot."
5877 #: guix-git/doc/guix.texi:1629
5878 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."
5882 #: guix-git/doc/guix.texi:1630
5884 msgid "--disable-chroot"
5888 #: guix-git/doc/guix.texi:1632
5889 msgid "Disable chroot builds."
5893 #: guix-git/doc/guix.texi:1637
5894 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."
5898 #: guix-git/doc/guix.texi:1638
5900 msgid "--log-compression=@var{type}"
5904 #: guix-git/doc/guix.texi:1641
5905 msgid "Compress build logs according to @var{type}, one of @code{gzip}, @code{bzip2}, or @code{none}."
5909 #: guix-git/doc/guix.texi:1645
5910 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."
5914 #: guix-git/doc/guix.texi:1646
5916 msgid "--discover[=yes|no]"
5920 #: guix-git/doc/guix.texi:1649 guix-git/doc/guix.texi:15467
5921 msgid "Whether to discover substitute servers on the local network using mDNS and DNS-SD."
5925 #: guix-git/doc/guix.texi:1652
5926 msgid "This feature is still experimental. However, here are a few considerations."
5930 #: guix-git/doc/guix.texi:1656
5931 msgid "It might be faster/less expensive than fetching from remote servers;"
5935 #: guix-git/doc/guix.texi:1659
5936 msgid "There are no security risks, only genuine substitutes will be used (@pxref{Substitute Authentication});"
5940 #: guix-git/doc/guix.texi:1663
5941 msgid "An attacker advertising @command{guix publish} on your LAN cannot serve you malicious binaries, but they can learn what software you’re installing;"
5945 #: guix-git/doc/guix.texi:1666
5946 msgid "Servers may serve substitute over HTTP, unencrypted, so anyone on the LAN can see what software you’re installing."
5950 #: guix-git/doc/guix.texi:1670
5951 msgid "It is also possible to enable or disable substitute server discovery at run-time by running:"
5955 #: guix-git/doc/guix.texi:1674
5958 "herd discover guix-daemon on\n"
5959 "herd discover guix-daemon off\n"
5963 #: guix-git/doc/guix.texi:1676
5965 msgid "--disable-deduplication"
5969 #: guix-git/doc/guix.texi:1677 guix-git/doc/guix.texi:4248
5971 msgid "deduplication"
5975 #: guix-git/doc/guix.texi:1679
5976 msgid "Disable automatic file ``deduplication'' in the store."
5980 #: guix-git/doc/guix.texi:1686
5981 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."
5985 #: guix-git/doc/guix.texi:1687
5987 msgid "--gc-keep-outputs[=yes|no]"
5991 #: guix-git/doc/guix.texi:1690
5992 msgid "Tell whether the garbage collector (GC) must keep outputs of live derivations."
5996 #: guix-git/doc/guix.texi:1691 guix-git/doc/guix.texi:4061
6002 #: guix-git/doc/guix.texi:1692 guix-git/doc/guix.texi:4062
6004 msgid "garbage collector roots"
6008 #: guix-git/doc/guix.texi:1698
6009 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."
6013 #: guix-git/doc/guix.texi:1699
6015 msgid "--gc-keep-derivations[=yes|no]"
6019 #: guix-git/doc/guix.texi:1702
6020 msgid "Tell whether the garbage collector (GC) must keep derivations corresponding to live outputs."
6024 #: guix-git/doc/guix.texi:1708
6025 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."
6029 #: guix-git/doc/guix.texi:1717
6030 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."
6034 #: guix-git/doc/guix.texi:1718
6036 msgid "--impersonate-linux-2.6"
6040 #: guix-git/doc/guix.texi:1721
6041 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."
6045 #: guix-git/doc/guix.texi:1724
6046 msgid "This might be helpful to build programs that (usually wrongfully) depend on the kernel version number."
6050 #: guix-git/doc/guix.texi:1725
6056 #: guix-git/doc/guix.texi:1728
6057 msgid "Do not keep build logs. By default they are kept under @file{@var{localstatedir}/guix/log}."
6061 #: guix-git/doc/guix.texi:1729 guix-git/doc/guix.texi:4489
6062 #: guix-git/doc/guix.texi:5788 guix-git/doc/guix.texi:6159
6063 #: guix-git/doc/guix.texi:10793 guix-git/doc/guix.texi:12238
6064 #: guix-git/doc/guix.texi:12489 guix-git/doc/guix.texi:13156
6065 #: guix-git/doc/guix.texi:32309 guix-git/doc/guix.texi:33108
6067 msgid "--system=@var{system}"
6071 #: guix-git/doc/guix.texi:1733
6072 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}."
6076 #: guix-git/doc/guix.texi:1734 guix-git/doc/guix.texi:10098
6078 msgid "--listen=@var{endpoint}"
6082 #: guix-git/doc/guix.texi:1739
6083 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:"
6087 #: guix-git/doc/guix.texi:1741
6089 msgid "--listen=/gnu/var/daemon"
6093 #: guix-git/doc/guix.texi:1744
6094 msgid "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, creating it if needed."
6098 #: guix-git/doc/guix.texi:1745
6100 msgid "--listen=localhost"
6104 #: guix-git/doc/guix.texi:1746 guix-git/doc/guix.texi:8782
6106 msgid "daemon, remote access"
6110 #: guix-git/doc/guix.texi:1747 guix-git/doc/guix.texi:8783
6112 msgid "remote access to the daemon"
6116 #: guix-git/doc/guix.texi:1748 guix-git/doc/guix.texi:8784
6118 msgid "daemon, cluster setup"
6122 #: guix-git/doc/guix.texi:1749 guix-git/doc/guix.texi:8785
6124 msgid "clusters, daemon setup"
6128 #: guix-git/doc/guix.texi:1752
6129 msgid "Listen for TCP connections on the network interface corresponding to @code{localhost}, on port 44146."
6133 #: guix-git/doc/guix.texi:1753
6135 msgid "--listen=128.0.0.42:1234"
6139 #: guix-git/doc/guix.texi:1756
6140 msgid "Listen for TCP connections on the network interface corresponding to @code{128.0.0.42}, on port 1234."
6144 #: guix-git/doc/guix.texi:1763
6145 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}})."
6149 #: guix-git/doc/guix.texi:1770
6150 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."
6154 #: guix-git/doc/guix.texi:1775
6155 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}."
6159 #: guix-git/doc/guix.texi:1785
6160 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."
6164 #: guix-git/doc/guix.texi:1789
6165 msgid "locales-and-locpath"
6169 #: guix-git/doc/guix.texi:1789
6171 msgid "locales, when not on Guix System"
6175 #: guix-git/doc/guix.texi:1790 guix-git/doc/guix.texi:14686
6181 #: guix-git/doc/guix.texi:1791
6183 msgid "GUIX_LOCPATH"
6187 #: guix-git/doc/guix.texi:1796
6188 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:"
6192 #: guix-git/doc/guix.texi:1800
6195 "$ guix install glibc-locales\n"
6196 "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n"
6200 #: guix-git/doc/guix.texi:1806
6201 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."
6205 #: guix-git/doc/guix.texi:1810
6206 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:"
6210 #: guix-git/doc/guix.texi:1817
6211 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."
6215 #: guix-git/doc/guix.texi:1824
6216 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."
6220 #: guix-git/doc/guix.texi:1828
6221 msgid "This is important because the locale data format used by different libc versions may be incompatible."
6225 #: guix-git/doc/guix.texi:1831
6227 msgid "name service switch, glibc"
6231 #: guix-git/doc/guix.texi:1832
6233 msgid "NSS (name service switch), glibc"
6237 #: guix-git/doc/guix.texi:1833
6239 msgid "nscd (name service caching daemon)"
6243 #: guix-git/doc/guix.texi:1834
6245 msgid "name service caching daemon (nscd)"
6249 #: guix-git/doc/guix.texi:1841
6250 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."
6254 #: guix-git/doc/guix.texi:1842
6256 msgid "nsswitch.conf"
6260 #: guix-git/doc/guix.texi:1847
6261 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})."
6265 #: guix-git/doc/guix.texi:1848
6267 msgid "Network information service (NIS)"
6271 #: guix-git/doc/guix.texi:1849
6273 msgid "NIS (Network information service)"
6277 #: guix-git/doc/guix.texi:1858
6278 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})."
6282 #: guix-git/doc/guix.texi:1868
6283 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)."
6287 #: guix-git/doc/guix.texi:1873
6288 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."
6292 #: guix-git/doc/guix.texi:1878
6293 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."
6297 #: guix-git/doc/guix.texi:1879
6303 #: guix-git/doc/guix.texi:1889
6304 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}."
6308 #: guix-git/doc/guix.texi:1890
6314 #: guix-git/doc/guix.texi:1891
6320 #: guix-git/doc/guix.texi:1895
6321 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:"
6325 #: guix-git/doc/guix.texi:1899
6328 "guix install fontconfig\n"
6333 #: guix-git/doc/guix.texi:1907
6334 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:"
6338 #: guix-git/doc/guix.texi:1910
6340 msgid "guix install font-adobe-source-han-sans:cn\n"
6344 #: guix-git/doc/guix.texi:1912
6350 #: guix-git/doc/guix.texi:1916
6351 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:"
6355 #: guix-git/doc/guix.texi:1919
6357 msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n"
6361 #: guix-git/doc/guix.texi:1923
6362 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:"
6366 #: guix-git/doc/guix.texi:1928
6368 msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n"
6372 #: guix-git/doc/guix.texi:1930
6378 #: guix-git/doc/guix.texi:1933
6379 msgid "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to make sure your TrueType fonts are listed there."
6383 #: guix-git/doc/guix.texi:1937 guix-git/doc/guix.texi:32047
6389 #: guix-git/doc/guix.texi:1940
6390 msgid "The @code{nss-certs} package provides X.509 certificates, which allow programs to authenticate Web servers accessed over HTTPS."
6394 #: guix-git/doc/guix.texi:1945
6395 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."
6399 #: guix-git/doc/guix.texi:1948
6405 #: guix-git/doc/guix.texi:1954
6406 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."
6410 #: guix-git/doc/guix.texi:1961
6411 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})."
6415 #: guix-git/doc/guix.texi:1966
6417 msgid "Upgrading Guix, on a foreign distro"
6421 #: guix-git/doc/guix.texi:1969
6422 msgid "To upgrade Guix, run:"
6426 #: guix-git/doc/guix.texi:1972 guix-git/doc/guix.texi:2819
6432 #: guix-git/doc/guix.texi:1975
6433 msgid "@xref{Invoking guix pull}, for more information."
6437 #: guix-git/doc/guix.texi:1976
6439 msgid "upgrading Guix for the root user, on a foreign distro"
6443 #: guix-git/doc/guix.texi:1977
6445 msgid "upgrading the Guix daemon, on a foreign distro"
6449 #: guix-git/doc/guix.texi:1978
6451 msgid "@command{guix pull} for the root user, on a foreign distro"
6455 #: guix-git/doc/guix.texi:1981
6456 msgid "On a foreign distro, you can upgrade the build daemon by running:"
6460 #: guix-git/doc/guix.texi:1984
6462 msgid "sudo -i guix pull\n"
6466 #: guix-git/doc/guix.texi:1989
6467 msgid "followed by (assuming your distro uses the systemd service management tool):"
6471 #: guix-git/doc/guix.texi:1992
6473 msgid "systemctl restart guix-daemon.service\n"
6477 #: guix-git/doc/guix.texi:1996
6478 msgid "On Guix System, upgrading the daemon is achieved by reconfiguring the system (@pxref{Invoking guix system, @code{guix system reconfigure}})."
6482 #: guix-git/doc/guix.texi:2003
6484 msgid "installing Guix System"
6488 #: guix-git/doc/guix.texi:2004
6490 msgid "Guix System, installation"
6494 #: guix-git/doc/guix.texi:2009
6495 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}."
6499 #: guix-git/doc/guix.texi:2018
6500 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."
6504 #: guix-git/doc/guix.texi:2021
6505 msgid "Alternatively, run @command{info info} in another tty to keep the manual available."
6509 #: guix-git/doc/guix.texi:2042
6510 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."
6514 #: guix-git/doc/guix.texi:2045
6515 msgid "Nevertheless, before you proceed with the installation, be aware of the following noteworthy limitations applicable to version @value{VERSION}:"
6519 #: guix-git/doc/guix.texi:2050
6520 msgid "More and more system services are provided (@pxref{Services}), but some may be missing."
6524 #: guix-git/doc/guix.texi:2055
6525 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."
6529 #: guix-git/doc/guix.texi:2060
6530 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."
6534 #: guix-git/doc/guix.texi:2065
6536 msgid "hardware support on Guix System"
6540 #: guix-git/doc/guix.texi:2074
6541 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."
6545 #: guix-git/doc/guix.texi:2075
6547 msgid "WiFi, hardware support"
6551 #: guix-git/doc/guix.texi:2084
6552 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}})."
6556 #: guix-git/doc/guix.texi:2085
6558 msgid "RYF, Respects Your Freedom"
6562 #: guix-git/doc/guix.texi:2091
6563 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."
6567 #: guix-git/doc/guix.texi:2095
6568 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."
6572 #: guix-git/doc/guix.texi:2104
6573 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}, where you can replace @code{x86_64-linux} with one of:"
6577 #: guix-git/doc/guix.texi:2108
6578 msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;"
6582 #: guix-git/doc/guix.texi:2111
6583 msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs."
6587 #: guix-git/doc/guix.texi:2116
6588 msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines:"
6592 #: guix-git/doc/guix.texi:2120
6595 "$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n"
6596 "$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.sig\n"
6600 #: guix-git/doc/guix.texi:2128
6603 "$ wget @value{OPENPGP-SIGNING-KEY-URL} \\\n"
6604 " -qO - | gpg --import -\n"
6608 #: guix-git/doc/guix.texi:2140
6609 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."
6612 #. type: unnumberedsubsec
6613 #: guix-git/doc/guix.texi:2141
6615 msgid "Copying to a USB Stick"
6619 #: guix-git/doc/guix.texi:2146
6620 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:"
6624 #: guix-git/doc/guix.texi:2150
6627 "dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX status=progress\n"
6632 #: guix-git/doc/guix.texi:2153
6633 msgid "Access to @file{/dev/sdX} usually requires root privileges."
6636 #. type: unnumberedsubsec
6637 #: guix-git/doc/guix.texi:2154
6639 msgid "Burning on a DVD"
6643 #: guix-git/doc/guix.texi:2159
6644 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:"
6648 #: guix-git/doc/guix.texi:2162
6650 msgid "growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso\n"
6654 #: guix-git/doc/guix.texi:2165
6655 msgid "Access to @file{/dev/srX} usually requires root privileges."
6658 #. type: unnumberedsubsec
6659 #: guix-git/doc/guix.texi:2166
6665 #: guix-git/doc/guix.texi:2173
6666 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}."
6670 #: guix-git/doc/guix.texi:2176
6671 msgid "@xref{Installing Guix in a VM}, if, instead, you would like to install Guix System in a virtual machine (VM)."
6675 #: guix-git/doc/guix.texi:2186
6676 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})."
6680 #: guix-git/doc/guix.texi:2194
6681 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."
6685 #: guix-git/doc/guix.texi:2199
6686 msgid "Installation requires access to the Internet so that any missing dependencies of your system configuration can be downloaded. See the ``Networking'' section below."
6690 #: guix-git/doc/guix.texi:2206
6691 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."
6695 #: guix-git/doc/guix.texi:2211
6696 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."
6700 #: guix-git/doc/guix.texi:2213
6701 msgid "@image{images/installer-network,5in,, networking setup with the graphical installer}"
6705 #: guix-git/doc/guix.texi:2218
6706 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."
6710 #: guix-git/doc/guix.texi:2220
6711 msgid "@image{images/installer-partitions,5in,, partitioning with the graphical installer}"
6715 #: guix-git/doc/guix.texi:2223
6716 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."
6720 #: guix-git/doc/guix.texi:2225
6721 msgid "@image{images/installer-resume,5in,, resuming the installation process}"
6725 #: guix-git/doc/guix.texi:2230
6726 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!"
6730 #: guix-git/doc/guix.texi:2240
6731 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})."
6735 #: guix-git/doc/guix.texi:2246
6736 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})."
6740 #: guix-git/doc/guix.texi:2253
6742 msgid "Keyboard Layout, Networking, and Partitioning"
6746 #: guix-git/doc/guix.texi:2258
6747 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."
6751 #: guix-git/doc/guix.texi:2261 guix-git/doc/guix.texi:14500
6753 msgid "keyboard layout"
6757 #: guix-git/doc/guix.texi:2265
6758 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:"
6762 #: guix-git/doc/guix.texi:2268
6764 msgid "loadkeys dvorak\n"
6768 #: guix-git/doc/guix.texi:2273
6769 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."
6772 #. type: subsubsection
6773 #: guix-git/doc/guix.texi:2274
6779 #: guix-git/doc/guix.texi:2277
6780 msgid "Run the following command to see what your network interfaces are called:"
6784 #: guix-git/doc/guix.texi:2280
6786 msgid "ifconfig -a\n"
6790 #: guix-git/doc/guix.texi:2284 guix-git/doc/guix.texi:2306
6791 msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:"
6795 #: guix-git/doc/guix.texi:2287
6797 msgid "ip address\n"
6801 #: guix-git/doc/guix.texi:2294
6802 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}."
6806 #: guix-git/doc/guix.texi:2296
6808 msgid "Wired connection"
6812 #: guix-git/doc/guix.texi:2299
6813 msgid "To configure a wired network run the following command, substituting @var{interface} with the name of the wired interface you want to use."
6817 #: guix-git/doc/guix.texi:2302
6819 msgid "ifconfig @var{interface} up\n"
6823 #: guix-git/doc/guix.texi:2309
6825 msgid "ip link set @var{interface} up\n"
6829 #: guix-git/doc/guix.texi:2311
6831 msgid "Wireless connection"
6835 #: guix-git/doc/guix.texi:2312 guix-git/doc/guix.texi:16125
6841 #: guix-git/doc/guix.texi:2313 guix-git/doc/guix.texi:16126
6847 #: guix-git/doc/guix.texi:2318
6848 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}:"
6852 #: guix-git/doc/guix.texi:2321
6854 msgid "nano wpa_supplicant.conf\n"
6858 #: guix-git/doc/guix.texi:2326
6859 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:"
6863 #: guix-git/doc/guix.texi:2333
6867 " ssid=\"@var{my-ssid}\"\n"
6868 " key_mgmt=WPA-PSK\n"
6869 " psk=\"the network's secret passphrase\"\n"
6874 #: guix-git/doc/guix.texi:2338
6875 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):"
6879 #: guix-git/doc/guix.texi:2341
6881 msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n"
6885 #: guix-git/doc/guix.texi:2344
6886 msgid "Run @command{man wpa_supplicant} for more information."
6890 #: guix-git/doc/guix.texi:2346
6896 #: guix-git/doc/guix.texi:2349
6897 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:"
6901 #: guix-git/doc/guix.texi:2352
6903 msgid "dhclient -v @var{interface}\n"
6907 #: guix-git/doc/guix.texi:2355
6908 msgid "Try to ping a server to see if networking is up and running:"
6912 #: guix-git/doc/guix.texi:2358
6914 msgid "ping -c 3 gnu.org\n"
6918 #: guix-git/doc/guix.texi:2362
6919 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."
6923 #: guix-git/doc/guix.texi:2363
6925 msgid "proxy, during system installation"
6929 #: guix-git/doc/guix.texi:2366
6930 msgid "If you need HTTP and HTTPS access to go through a proxy, run the following command:"
6934 #: guix-git/doc/guix.texi:2369
6936 msgid "herd set-http-proxy guix-daemon @var{URL}\n"
6940 #: guix-git/doc/guix.texi:2374
6941 msgid "where @var{URL} is the proxy URL, for example @code{http://example.org:8118}."
6945 #: guix-git/doc/guix.texi:2375
6947 msgid "installing over SSH"
6951 #: guix-git/doc/guix.texi:2378
6952 msgid "If you want to, you can continue the installation remotely by starting an SSH server:"
6956 #: guix-git/doc/guix.texi:2381
6958 msgid "herd start ssh-daemon\n"
6962 #: guix-git/doc/guix.texi:2385
6963 msgid "Make sure to either set a password with @command{passwd}, or configure OpenSSH public key authentication before logging in."
6966 #. type: subsubsection
6967 #: guix-git/doc/guix.texi:2386
6969 msgid "Disk Partitioning"
6973 #: guix-git/doc/guix.texi:2390
6974 msgid "Unless this has already been done, the next step is to partition, and then format the target partition(s)."
6978 #: guix-git/doc/guix.texi:2395
6979 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:"
6983 #: guix-git/doc/guix.texi:2398
6989 #: guix-git/doc/guix.texi:2404
6990 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})."
6994 #: guix-git/doc/guix.texi:2405
6996 msgid "EFI, installation"
7000 #: guix-git/doc/guix.texi:2406
7002 msgid "UEFI, installation"
7006 #: guix-git/doc/guix.texi:2407
7008 msgid "ESP, EFI system partition"
7012 #: guix-git/doc/guix.texi:2411
7013 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}:"
7017 #: guix-git/doc/guix.texi:2414
7019 msgid "parted /dev/sda set 1 esp on\n"
7023 #: guix-git/doc/guix.texi:2417 guix-git/doc/guix.texi:32447
7025 msgid "grub-bootloader"
7029 #: guix-git/doc/guix.texi:2418 guix-git/doc/guix.texi:32441
7031 msgid "grub-efi-bootloader"
7035 #: guix-git/doc/guix.texi:2425
7036 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."
7040 #: guix-git/doc/guix.texi:2433
7041 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:"
7045 #: guix-git/doc/guix.texi:2436
7047 msgid "mkfs.fat -F32 /dev/sda1\n"
7051 #: guix-git/doc/guix.texi:2443
7052 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})."
7056 #: guix-git/doc/guix.texi:2450
7057 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:"
7061 #: guix-git/doc/guix.texi:2453
7063 msgid "mkfs.ext4 -L my-root /dev/sda2\n"
7067 #: guix-git/doc/guix.texi:2455 guix-git/doc/guix.texi:13498
7069 msgid "encrypted disk"
7073 #: guix-git/doc/guix.texi:2462
7074 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:"
7078 #: guix-git/doc/guix.texi:2467
7081 "cryptsetup luksFormat /dev/sda2\n"
7082 "cryptsetup open --type luks /dev/sda2 my-partition\n"
7083 "mkfs.ext4 -L my-root /dev/mapper/my-partition\n"
7087 #: guix-git/doc/guix.texi:2472
7088 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):"
7092 #: guix-git/doc/guix.texi:2475
7094 msgid "mount LABEL=my-root /mnt\n"
7098 #: guix-git/doc/guix.texi:2481
7099 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."
7103 #: guix-git/doc/guix.texi:2486
7104 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:"
7108 #: guix-git/doc/guix.texi:2490
7111 "mkswap /dev/sda3\n"
7112 "swapon /dev/sda3\n"
7116 #: guix-git/doc/guix.texi:2498
7117 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}.}:"
7121 #: guix-git/doc/guix.texi:2506
7124 "# This is 10 GiB of swap space. Adjust \"count\" to change the size.\n"
7125 "dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240\n"
7126 "# For security, make the file readable and writable only by root.\n"
7127 "chmod 600 /mnt/swapfile\n"
7128 "mkswap /mnt/swapfile\n"
7129 "swapon /mnt/swapfile\n"
7133 #: guix-git/doc/guix.texi:2511
7134 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."
7138 #: guix-git/doc/guix.texi:2517
7139 msgid "With the target partitions ready and the target root mounted on @file{/mnt}, we're ready to go. First, run:"
7143 #: guix-git/doc/guix.texi:2520
7145 msgid "herd start cow-store /mnt\n"
7149 #: guix-git/doc/guix.texi:2527
7150 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."
7154 #: guix-git/doc/guix.texi:2538
7155 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."
7159 #: guix-git/doc/guix.texi:2545
7160 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:"
7164 #: guix-git/doc/guix.texi:2550
7167 "# mkdir /mnt/etc\n"
7168 "# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n"
7169 "# nano /mnt/etc/config.scm\n"
7173 #: guix-git/doc/guix.texi:2554
7174 msgid "You should pay attention to what your configuration file contains, and in particular:"
7178 #: guix-git/doc/guix.texi:2565
7179 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."
7183 #: guix-git/doc/guix.texi:2571
7184 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."
7188 #: guix-git/doc/guix.texi:2575
7189 msgid "If there are encrypted or RAID partitions, make sure to add a @code{mapped-devices} field to describe them (@pxref{Mapped Devices})."
7193 #: guix-git/doc/guix.texi:2580
7194 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}):"
7198 #: guix-git/doc/guix.texi:2583
7200 msgid "guix system init /mnt/etc/config.scm /mnt\n"
7204 #: guix-git/doc/guix.texi:2590
7205 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."
7209 #: guix-git/doc/guix.texi:2598
7210 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!"
7214 #: guix-git/doc/guix.texi:2605
7215 msgid "Success, you've now booted into Guix System! From then on, you can update the system whenever you want by running, say:"
7219 #: guix-git/doc/guix.texi:2609
7223 "sudo guix system reconfigure /etc/config.scm\n"
7227 #: guix-git/doc/guix.texi:2615
7228 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})."
7232 #: guix-git/doc/guix.texi:2618
7234 msgid "sudo vs. @command{guix pull}"
7238 #: guix-git/doc/guix.texi:2622
7239 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{}}."
7243 #: guix-git/doc/guix.texi:2627
7244 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."
7248 #: guix-git/doc/guix.texi:2632
7249 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!"
7253 #: guix-git/doc/guix.texi:2635
7255 msgid "Installing Guix in a Virtual Machine"
7259 #: guix-git/doc/guix.texi:2637
7261 msgid "virtual machine, Guix System installation"
7265 #: guix-git/doc/guix.texi:2638
7267 msgid "virtual private server (VPS)"
7271 #: guix-git/doc/guix.texi:2639
7273 msgid "VPS (virtual private server)"
7277 #: guix-git/doc/guix.texi:2643
7278 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."
7282 #: guix-git/doc/guix.texi:2646
7283 msgid "To boot a @uref{https://qemu.org/,QEMU} VM for installing Guix System in a disk image, follow these steps:"
7287 #: guix-git/doc/guix.texi:2651
7288 msgid "First, retrieve and decompress the Guix system installation image as described previously (@pxref{USB Stick and DVD Installation})."
7292 #: guix-git/doc/guix.texi:2655
7293 msgid "Create a disk image that will hold the installed system. To make a qcow2-formatted disk image, use the @command{qemu-img} command:"
7297 #: guix-git/doc/guix.texi:2658
7299 msgid "qemu-img create -f qcow2 guix-system.img 50G\n"
7303 #: guix-git/doc/guix.texi:2662
7304 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."
7308 #: guix-git/doc/guix.texi:2665
7309 msgid "Boot the USB installation image in an VM:"
7313 #: guix-git/doc/guix.texi:2671
7316 "qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \\\n"
7317 " -nic user,model=virtio-net-pci -boot menu=on,order=d \\\n"
7318 " -drive file=guix-system.img \\\n"
7319 " -drive media=cdrom,file=guix-system-install-@value{VERSION}.@var{system}.iso\n"
7323 #: guix-git/doc/guix.texi:2675
7324 msgid "@code{-enable-kvm} is optional, but significantly improves performance, @pxref{Running Guix in a VM}."
7328 #: guix-git/doc/guix.texi:2679
7329 msgid "You're now root in the VM, proceed with the installation process. @xref{Preparing for Installation}, and follow the instructions."
7333 #: guix-git/doc/guix.texi:2684
7334 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."
7338 #: guix-git/doc/guix.texi:2688
7340 msgid "installation image"
7344 #: guix-git/doc/guix.texi:2691
7345 msgid "The installation image described above was built using the @command{guix system} command, specifically:"
7349 #: guix-git/doc/guix.texi:2694
7351 msgid "guix system image -t iso9660 gnu/system/install.scm\n"
7355 #: guix-git/doc/guix.texi:2699
7356 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."
7360 #: guix-git/doc/guix.texi:2700
7362 msgid "Building the Installation Image for ARM Boards"
7366 #: guix-git/doc/guix.texi:2704
7367 msgid "Many ARM boards require a specific variant of the @uref{https://www.denx.de/wiki/U-Boot/, U-Boot} bootloader."
7371 #: guix-git/doc/guix.texi:2708
7372 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:"
7376 #: guix-git/doc/guix.texi:2711
7378 msgid "guix system image --system=armhf-linux -e '((@@ (gnu system install) os-with-u-boot) (@@ (gnu system install) installation-os) \"A20-OLinuXino-Lime2\")'\n"
7382 #: guix-git/doc/guix.texi:2715
7383 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."
7387 #: guix-git/doc/guix.texi:2725
7388 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."
7392 #: guix-git/doc/guix.texi:2729
7393 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:"
7397 #: guix-git/doc/guix.texi:2732
7399 msgid "guix search text editor\n"
7403 #: guix-git/doc/guix.texi:2739
7404 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}!):"
7408 #: guix-git/doc/guix.texi:2742
7410 msgid "guix install emacs\n"
7414 #: guix-git/doc/guix.texi:2744 guix-git/doc/guix.texi:3056
7415 #: guix-git/doc/guix.texi:3108
7421 #: guix-git/doc/guix.texi:2752
7422 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)."
7426 #: guix-git/doc/guix.texi:2755
7427 msgid "Unless you're using Guix System, the @command{guix install} command must have printed this hint:"
7431 #: guix-git/doc/guix.texi:2758
7434 "hint: Consider setting the necessary environment variables by running:\n"
7439 #: guix-git/doc/guix.texi:2761
7442 " GUIX_PROFILE=\"$HOME/.guix-profile\"\n"
7443 " . \"$GUIX_PROFILE/etc/profile\"\n"
7448 #: guix-git/doc/guix.texi:2763
7450 msgid "Alternately, see `guix package --search-paths -p \"$HOME/.guix-profile\"'.\n"
7454 #: guix-git/doc/guix.texi:2777
7455 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."
7459 #: guix-git/doc/guix.texi:2780
7460 msgid "You can go on installing packages at your will. To list installed packages, run:"
7464 #: guix-git/doc/guix.texi:2783
7466 msgid "guix package --list-installed\n"
7470 #: guix-git/doc/guix.texi:2788
7471 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:"
7475 #: guix-git/doc/guix.texi:2791
7477 msgid "guix package --roll-back\n"
7481 #: guix-git/doc/guix.texi:2796
7482 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:"
7486 #: guix-git/doc/guix.texi:2799
7488 msgid "guix package --list-generations\n"
7492 #: guix-git/doc/guix.texi:2802
7493 msgid "Now you know the basics of package management!"
7497 #: guix-git/doc/guix.texi:2803 guix-git/doc/guix.texi:2862
7499 msgid "Going further"
7503 #: guix-git/doc/guix.texi:2811
7504 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."
7508 #: guix-git/doc/guix.texi:2816
7509 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:"
7513 #: guix-git/doc/guix.texi:2826
7514 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}:"
7518 #: guix-git/doc/guix.texi:2830
7521 "GUIX_PROFILE=\"$HOME/.config/guix/current\"\n"
7522 ". \"$GUIX_PROFILE/etc/profile\"\n"
7526 #: guix-git/doc/guix.texi:2834
7527 msgid "You must also instruct your shell to point to this new @command{guix}:"
7531 #: guix-git/doc/guix.texi:2837
7537 #: guix-git/doc/guix.texi:2841
7538 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:"
7542 #: guix-git/doc/guix.texi:2844
7544 msgid "guix upgrade\n"
7548 #: guix-git/doc/guix.texi:2850
7549 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!"
7553 #: guix-git/doc/guix.texi:2853
7554 msgid "You can display the exact revision of Guix you're currently using by running:"
7558 #: guix-git/doc/guix.texi:2856
7560 msgid "guix describe\n"
7564 #: guix-git/doc/guix.texi:2861
7565 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."
7569 #: guix-git/doc/guix.texi:2867
7570 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})."
7574 #: guix-git/doc/guix.texi:2872
7575 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:"
7579 #: guix-git/doc/guix.texi:2875
7581 msgid "sudo guix system reconfigure /etc/config.scm\n"
7585 #: guix-git/doc/guix.texi:2884
7586 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}:"
7590 #: guix-git/doc/guix.texi:2887
7592 msgid "sudo guix system roll-back\n"
7596 #: guix-git/doc/guix.texi:2894
7597 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."
7601 #: guix-git/doc/guix.texi:2896
7602 msgid "Now you know enough to get started!"
7606 #: guix-git/doc/guix.texi:2897
7612 #: guix-git/doc/guix.texi:2900
7613 msgid "The rest of this manual provides a reference for all things Guix. Here are some additional resources you may find useful:"
7617 #: guix-git/doc/guix.texi:2905
7618 msgid "@xref{Top,,, guix-cookbook, The GNU Guix Cookbook}, for a list of ``how-to'' style of recipes for a variety of applications."
7622 #: guix-git/doc/guix.texi:2910
7623 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."
7627 #: guix-git/doc/guix.texi:2915
7628 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."
7632 #: guix-git/doc/guix.texi:2919
7633 msgid "@xref{Documentation}, to learn how to access documentation on your computer."
7637 #: guix-git/doc/guix.texi:2922
7638 msgid "We hope you will enjoy Guix as much as the community enjoys building it!"
7642 #: guix-git/doc/guix.texi:2928
7648 #: guix-git/doc/guix.texi:2933
7649 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."
7653 #: guix-git/doc/guix.texi:2941
7654 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):"
7658 #: guix-git/doc/guix.texi:2944
7660 msgid "guix install emacs-guix\n"
7664 #: guix-git/doc/guix.texi:2965
7665 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."
7669 #: guix-git/doc/guix.texi:2969
7670 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."
7674 #: guix-git/doc/guix.texi:2974
7675 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}."
7679 #: guix-git/doc/guix.texi:2982
7680 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."
7684 #: guix-git/doc/guix.texi:2986
7685 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}."
7689 #: guix-git/doc/guix.texi:2987 guix-git/doc/guix.texi:3070
7691 msgid "transactions"
7695 #: guix-git/doc/guix.texi:2994
7696 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."
7700 #: guix-git/doc/guix.texi:3002
7701 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})."
7705 #: guix-git/doc/guix.texi:3009
7706 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."
7710 #: guix-git/doc/guix.texi:3010 guix-git/doc/guix.texi:4693
7712 msgid "reproducibility"
7716 #: guix-git/doc/guix.texi:3022
7717 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})."
7721 #: guix-git/doc/guix.texi:3033
7722 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})."
7726 #: guix-git/doc/guix.texi:3039
7727 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})."
7731 #: guix-git/doc/guix.texi:3040
7733 msgid "replication, of software environments"
7737 #: guix-git/doc/guix.texi:3041
7739 msgid "provenance tracking, of software artifacts"
7743 #: guix-git/doc/guix.texi:3048
7744 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."
7748 #: guix-git/doc/guix.texi:3050
7750 msgid "Invoking @command{guix package}"
7754 #: guix-git/doc/guix.texi:3052
7756 msgid "installing packages"
7760 #: guix-git/doc/guix.texi:3053
7762 msgid "removing packages"
7766 #: guix-git/doc/guix.texi:3054
7768 msgid "package installation"
7772 #: guix-git/doc/guix.texi:3055
7774 msgid "package removal"
7778 #: guix-git/doc/guix.texi:3065
7779 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:"
7783 #: guix-git/doc/guix.texi:3068
7785 msgid "guix package @var{options}\n"
7789 #: guix-git/doc/guix.texi:3075
7790 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."
7794 #: guix-git/doc/guix.texi:3078
7795 msgid "For example, to remove @code{lua} and install @code{guile} and @code{guile-cairo} in a single transaction:"
7799 #: guix-git/doc/guix.texi:3081
7801 msgid "guix package -r lua -i guile guile-cairo\n"
7805 #: guix-git/doc/guix.texi:3083
7807 msgid "aliases, for @command{guix package}"
7811 #: guix-git/doc/guix.texi:3085
7812 msgid "For your convenience, we also provide the following aliases:"
7816 #: guix-git/doc/guix.texi:3089
7817 msgid "@command{guix search} is an alias for @command{guix package -s},"
7821 #: guix-git/doc/guix.texi:3091
7822 msgid "@command{guix install} is an alias for @command{guix package -i},"
7826 #: guix-git/doc/guix.texi:3093
7827 msgid "@command{guix remove} is an alias for @command{guix package -r},"
7831 #: guix-git/doc/guix.texi:3095
7832 msgid "@command{guix upgrade} is an alias for @command{guix package -u},"
7836 #: guix-git/doc/guix.texi:3097
7837 msgid "and @command{guix show} is an alias for @command{guix package --show=}."
7841 #: guix-git/doc/guix.texi:3102
7842 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."
7846 #: guix-git/doc/guix.texi:3107
7847 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}})."
7851 #: guix-git/doc/guix.texi:3114
7852 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."
7856 #: guix-git/doc/guix.texi:3114 guix-git/doc/guix.texi:3347
7858 msgid "search paths"
7862 #: guix-git/doc/guix.texi:3119
7863 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:"
7867 #: guix-git/doc/guix.texi:3123
7870 "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n"
7871 "source \"$GUIX_PROFILE/etc/profile\"\n"
7875 #: guix-git/doc/guix.texi:3134
7876 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}."
7880 #: guix-git/doc/guix.texi:3136
7881 msgid "The @var{options} can be among the following:"
7885 #: guix-git/doc/guix.texi:3139
7887 msgid "--install=@var{package} @dots{}"
7891 #: guix-git/doc/guix.texi:3140
7893 msgid "-i @var{package} @dots{}"
7897 #: guix-git/doc/guix.texi:3142
7898 msgid "Install the specified @var{package}s."
7902 #: guix-git/doc/guix.texi:3147
7903 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)."
7907 #: guix-git/doc/guix.texi:3155
7908 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})."
7912 #: guix-git/doc/guix.texi:3156
7914 msgid "propagated inputs"
7918 #: guix-git/doc/guix.texi:3162
7919 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)."
7923 #: guix-git/doc/guix.texi:3169
7924 msgid "package-cmd-propagated-inputs"
7928 #: guix-git/doc/guix.texi:3169
7929 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."
7933 #: guix-git/doc/guix.texi:3174
7934 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."
7938 #: guix-git/doc/guix.texi:3175
7940 msgid "--install-from-expression=@var{exp}"
7944 #: guix-git/doc/guix.texi:3176
7946 msgid "-e @var{exp}"
7950 #: guix-git/doc/guix.texi:3178
7951 msgid "Install the package @var{exp} evaluates to."
7955 #: guix-git/doc/guix.texi:3183
7956 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)}."
7960 #: guix-git/doc/guix.texi:3187
7961 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."
7965 #: guix-git/doc/guix.texi:3188
7967 msgid "--install-from-file=@var{file}"
7971 #: guix-git/doc/guix.texi:3189 guix-git/doc/guix.texi:10684
7973 msgid "-f @var{file}"
7977 #: guix-git/doc/guix.texi:3191
7978 msgid "Install the package that the code within @var{file} evaluates to."
7982 #: guix-git/doc/guix.texi:3194 guix-git/doc/guix.texi:5721
7983 msgid "As an example, @var{file} might contain a definition like this (@pxref{Defining Packages}):"
7987 #: guix-git/doc/guix.texi:3196 guix-git/doc/guix.texi:10692
7989 msgid "package-hello.scm"
7993 #: guix-git/doc/guix.texi:3203
7994 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})."
7998 #: guix-git/doc/guix.texi:3208
7999 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}:"
8003 #: guix-git/doc/guix.texi:3211 guix-git/doc/guix.texi:10702
8005 msgid "@verbatiminclude package-hello.json\n"
8009 #: guix-git/doc/guix.texi:3213
8011 msgid "--remove=@var{package} @dots{}"
8015 #: guix-git/doc/guix.texi:3214
8017 msgid "-r @var{package} @dots{}"
8021 #: guix-git/doc/guix.texi:3216
8022 msgid "Remove the specified @var{package}s."
8026 #: guix-git/doc/guix.texi:3221
8027 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}."
8031 #: guix-git/doc/guix.texi:3222
8033 msgid "--upgrade[=@var{regexp} @dots{}]"
8037 #: guix-git/doc/guix.texi:3223
8039 msgid "-u [@var{regexp} @dots{}]"
8043 #: guix-git/doc/guix.texi:3224
8045 msgid "upgrading packages"
8049 #: guix-git/doc/guix.texi:3228
8050 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."
8054 #: guix-git/doc/guix.texi:3233
8055 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})."
8059 #: guix-git/doc/guix.texi:3234
8061 msgid "package transformations, upgrades"
8065 #: guix-git/doc/guix.texi:3239
8066 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:"
8070 #: guix-git/doc/guix.texi:3242
8072 msgid "guix install emacs-next --with-branch=emacs-next=master\n"
8076 #: guix-git/doc/guix.texi:3247
8077 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."
8081 #: guix-git/doc/guix.texi:3252
8082 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:"
8086 #: guix-git/doc/guix.texi:3255
8088 msgid "guix install @var{package}\n"
8092 #: guix-git/doc/guix.texi:3257
8094 msgid "--do-not-upgrade[=@var{regexp} @dots{}]"
8098 #: guix-git/doc/guix.texi:3262
8099 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'':"
8103 #: guix-git/doc/guix.texi:3265
8105 msgid "$ guix package --upgrade . --do-not-upgrade emacs\n"
8109 #: guix-git/doc/guix.texi:3267
8111 msgid "profile-manifest"
8115 #: guix-git/doc/guix.texi:3267 guix-git/doc/guix.texi:5726
8116 #: guix-git/doc/guix.texi:6145 guix-git/doc/guix.texi:11725
8117 #: guix-git/doc/guix.texi:13162
8119 msgid "--manifest=@var{file}"
8123 #: guix-git/doc/guix.texi:3268 guix-git/doc/guix.texi:5727
8124 #: guix-git/doc/guix.texi:6146 guix-git/doc/guix.texi:11726
8126 msgid "-m @var{file}"
8130 #: guix-git/doc/guix.texi:3269
8132 msgid "profile declaration"
8136 #: guix-git/doc/guix.texi:3270
8138 msgid "profile manifest"
8142 #: guix-git/doc/guix.texi:3274
8143 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."
8147 #: guix-git/doc/guix.texi:3280
8148 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."
8152 #: guix-git/doc/guix.texi:3284
8153 msgid "@var{file} must return a @dfn{manifest} object, which is roughly a list of packages:"
8157 #: guix-git/doc/guix.texi:3285
8159 msgid "packages->manifest"
8163 #: guix-git/doc/guix.texi:3288
8166 "(use-package-modules guile emacs)\n"
8171 #: guix-git/doc/guix.texi:3294
8174 "(packages->manifest\n"
8177 " ;; Use a specific package output.\n"
8178 " (list guile-2.0 \"debug\")))\n"
8182 #: guix-git/doc/guix.texi:3296
8184 msgid "specifications->manifest"
8188 #: guix-git/doc/guix.texi:3303
8189 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:"
8193 #: guix-git/doc/guix.texi:3307
8196 "(specifications->manifest\n"
8197 " '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n"
8201 #: guix-git/doc/guix.texi:3311
8202 msgid "@xref{export-manifest, @option{--export-manifest}}, to learn how to obtain a manifest file from an existing profile."
8206 #: guix-git/doc/guix.texi:3312 guix-git/doc/guix.texi:4414
8212 #: guix-git/doc/guix.texi:3313 guix-git/doc/guix.texi:4415
8213 #: guix-git/doc/guix.texi:32869
8215 msgid "rolling back"
8219 #: guix-git/doc/guix.texi:3314 guix-git/doc/guix.texi:4416
8221 msgid "undoing transactions"
8225 #: guix-git/doc/guix.texi:3315 guix-git/doc/guix.texi:4417
8227 msgid "transactions, undoing"
8231 #: guix-git/doc/guix.texi:3318
8232 msgid "Roll back to the previous @dfn{generation} of the profile---i.e., undo the last transaction."
8236 #: guix-git/doc/guix.texi:3321
8237 msgid "When combined with options such as @option{--install}, roll back occurs before any other actions."
8241 #: guix-git/doc/guix.texi:3325
8242 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."
8246 #: guix-git/doc/guix.texi:3329
8247 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."
8251 #: guix-git/doc/guix.texi:3330 guix-git/doc/guix.texi:4421
8253 msgid "--switch-generation=@var{pattern}"
8257 #: guix-git/doc/guix.texi:3331 guix-git/doc/guix.texi:4422
8259 msgid "-S @var{pattern}"
8263 #: guix-git/doc/guix.texi:3332 guix-git/doc/guix.texi:3562
8264 #: guix-git/doc/guix.texi:4423 guix-git/doc/guix.texi:32827
8270 #: guix-git/doc/guix.texi:3334 guix-git/doc/guix.texi:4425
8271 msgid "Switch to a particular generation defined by @var{pattern}."
8275 #: guix-git/doc/guix.texi:3340 guix-git/doc/guix.texi:4431
8276 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}."
8280 #: guix-git/doc/guix.texi:3345
8281 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."
8285 #: guix-git/doc/guix.texi:3346
8287 msgid "--search-paths[=@var{kind}]"
8291 #: guix-git/doc/guix.texi:3352
8292 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."
8296 #: guix-git/doc/guix.texi:3360
8297 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."
8301 #: guix-git/doc/guix.texi:3363
8302 msgid "The typical use case is to define these environment variables in the shell:"
8306 #: guix-git/doc/guix.texi:3366
8308 msgid "$ eval `guix package --search-paths`\n"
8312 #: guix-git/doc/guix.texi:3372
8313 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}."
8317 #: guix-git/doc/guix.texi:3375
8318 msgid "This option can also be used to compute the @emph{combined} search paths of several profiles. Consider this example:"
8322 #: guix-git/doc/guix.texi:3380
8325 "$ guix package -p foo -i guile\n"
8326 "$ guix package -p bar -i guile-json\n"
8327 "$ guix package -p foo -p bar --search-paths\n"
8331 #: guix-git/doc/guix.texi:3385
8332 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."
8336 #: guix-git/doc/guix.texi:3387
8338 msgid "profile, choosing"
8342 #: guix-git/doc/guix.texi:3388 guix-git/doc/guix.texi:4451
8343 #: guix-git/doc/guix.texi:4780
8345 msgid "--profile=@var{profile}"
8349 #: guix-git/doc/guix.texi:3389 guix-git/doc/guix.texi:4452
8350 #: guix-git/doc/guix.texi:4781
8352 msgid "-p @var{profile}"
8356 #: guix-git/doc/guix.texi:3391
8357 msgid "Use @var{profile} instead of the user's default profile."
8361 #: guix-git/doc/guix.texi:3396
8362 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:"
8366 #: guix-git/doc/guix.texi:3402
8369 "$ guix install hello -p ~/code/my-profile\n"
8371 "$ ~/code/my-profile/bin/hello\n"
8376 #: guix-git/doc/guix.texi:3406
8377 msgid "All it takes to get rid of the profile is to remove this symlink and its siblings that point to specific generations:"
8381 #: guix-git/doc/guix.texi:3409
8383 msgid "$ rm ~/code/my-profile ~/code/my-profile-*-link\n"
8387 #: guix-git/doc/guix.texi:3411
8389 msgid "--list-profiles"
8393 #: guix-git/doc/guix.texi:3413
8394 msgid "List all the user's profiles:"
8398 #: guix-git/doc/guix.texi:3420
8401 "$ guix package --list-profiles\n"
8402 "/home/charlie/.guix-profile\n"
8403 "/home/charlie/code/my-profile\n"
8404 "/home/charlie/code/devel-profile\n"
8405 "/home/charlie/tmp/test\n"
8409 #: guix-git/doc/guix.texi:3423
8410 msgid "When running as root, list all the profiles of all the users."
8414 #: guix-git/doc/guix.texi:3424
8416 msgid "collisions, in a profile"
8420 #: guix-git/doc/guix.texi:3425
8422 msgid "colliding packages in profiles"
8426 #: guix-git/doc/guix.texi:3426
8428 msgid "profile collisions"
8432 #: guix-git/doc/guix.texi:3427
8434 msgid "--allow-collisions"
8438 #: guix-git/doc/guix.texi:3429
8439 msgid "Allow colliding packages in the new profile. Use at your own risk!"
8443 #: guix-git/doc/guix.texi:3433
8444 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."
8448 #: guix-git/doc/guix.texi:3434 guix-git/doc/guix.texi:4494
8449 #: guix-git/doc/guix.texi:6231
8455 #: guix-git/doc/guix.texi:3437
8456 msgid "Use the bootstrap Guile to build the profile. This option is only useful to distribution developers."
8460 #: guix-git/doc/guix.texi:3443
8461 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:"
8465 #: guix-git/doc/guix.texi:3446
8467 msgid "--search=@var{regexp}"
8471 #: guix-git/doc/guix.texi:3447
8473 msgid "-s @var{regexp}"
8477 #: guix-git/doc/guix.texi:3449
8482 #: guix-git/doc/guix.texi:3449
8484 msgid "searching for packages"
8488 #: guix-git/doc/guix.texi:3455
8489 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})."
8493 #: guix-git/doc/guix.texi:3458
8494 msgid "This allows specific fields to be extracted using the @command{recsel} command, for instance:"
8498 #: guix-git/doc/guix.texi:3464
8501 "$ guix package -s malloc | recsel -p name,version,relevance\n"
8509 #: guix-git/doc/guix.texi:3468
8519 #: guix-git/doc/guix.texi:3472
8528 #: guix-git/doc/guix.texi:3476
8529 msgid "Similarly, to show the name of all the packages available under the terms of the GNU@tie{}LGPL version 3:"
8533 #: guix-git/doc/guix.texi:3480
8536 "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n"
8542 #: guix-git/doc/guix.texi:3483
8550 #: guix-git/doc/guix.texi:3489
8551 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):"
8555 #: guix-git/doc/guix.texi:3494
8558 "$ guix search '\\<board\\>' game | recsel -p name\n"
8564 #: guix-git/doc/guix.texi:3500
8565 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."
8569 #: guix-git/doc/guix.texi:3504
8570 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:"
8574 #: guix-git/doc/guix.texi:3508
8577 "$ guix search crypto library | \\\n"
8578 " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n"
8582 #: guix-git/doc/guix.texi:3513
8583 msgid "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more information on @dfn{selection expressions} for @code{recsel -e}."
8587 #: guix-git/doc/guix.texi:3514
8589 msgid "--show=@var{package}"
8593 #: guix-git/doc/guix.texi:3518
8594 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})."
8598 #: guix-git/doc/guix.texi:3523
8601 "$ guix package --show=python | recsel -p name,version\n"
8608 #: guix-git/doc/guix.texi:3526
8616 #: guix-git/doc/guix.texi:3530
8617 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):"
8621 #: guix-git/doc/guix.texi:3534
8624 "$ guix show python@@3.4 | recsel -p name,version\n"
8630 #: guix-git/doc/guix.texi:3538
8632 msgid "--list-installed[=@var{regexp}]"
8636 #: guix-git/doc/guix.texi:3539
8638 msgid "-I [@var{regexp}]"
8642 #: guix-git/doc/guix.texi:3543
8643 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}."
8647 #: guix-git/doc/guix.texi:3549
8648 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."
8652 #: guix-git/doc/guix.texi:3550
8654 msgid "--list-available[=@var{regexp}]"
8658 #: guix-git/doc/guix.texi:3551
8660 msgid "-A [@var{regexp}]"
8664 #: guix-git/doc/guix.texi:3555
8665 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}."
8669 #: guix-git/doc/guix.texi:3559
8670 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."
8674 #: guix-git/doc/guix.texi:3560 guix-git/doc/guix.texi:4407
8676 msgid "--list-generations[=@var{pattern}]"
8680 #: guix-git/doc/guix.texi:3561 guix-git/doc/guix.texi:4408
8682 msgid "-l [@var{pattern}]"
8686 #: guix-git/doc/guix.texi:3567
8687 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."
8691 #: guix-git/doc/guix.texi:3572
8692 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."
8696 #: guix-git/doc/guix.texi:3575
8697 msgid "When @var{pattern} is used, the command returns only matching generations. Valid patterns include:"
8701 #: guix-git/doc/guix.texi:3577
8703 msgid "@emph{Integers and comma-separated integers}. Both patterns denote"
8707 #: guix-git/doc/guix.texi:3580
8708 msgid "generation numbers. For instance, @option{--list-generations=1} returns the first one."
8712 #: guix-git/doc/guix.texi:3583
8713 msgid "And @option{--list-generations=1,8,2} outputs three generations in the specified order. Neither spaces nor trailing commas are allowed."
8717 #: guix-git/doc/guix.texi:3584
8719 msgid "@emph{Ranges}. @option{--list-generations=2..9} prints the"
8723 #: guix-git/doc/guix.texi:3587
8724 msgid "specified generations and everything in between. Note that the start of a range must be smaller than its end."
8728 #: guix-git/doc/guix.texi:3591
8729 msgid "It is also possible to omit the endpoint. For example, @option{--list-generations=2..}, returns all generations starting from the second one."
8733 #: guix-git/doc/guix.texi:3592
8735 msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks,"
8739 #: guix-git/doc/guix.texi:3596
8740 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."
8744 #: guix-git/doc/guix.texi:3598 guix-git/doc/guix.texi:4432
8746 msgid "--delete-generations[=@var{pattern}]"
8750 #: guix-git/doc/guix.texi:3599 guix-git/doc/guix.texi:4433
8752 msgid "-d [@var{pattern}]"
8756 #: guix-git/doc/guix.texi:3602 guix-git/doc/guix.texi:4436
8757 msgid "When @var{pattern} is omitted, delete all generations except the current one."
8761 #: guix-git/doc/guix.texi:3608 guix-git/doc/guix.texi:4442
8762 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."
8766 #: guix-git/doc/guix.texi:3611
8767 msgid "If the current generation matches, it is @emph{not} deleted. Also, the zeroth generation is never deleted."
8771 #: guix-git/doc/guix.texi:3614 guix-git/doc/guix.texi:4447
8772 msgid "Note that deleting generations prevents rolling back to them. Consequently, this command must be used with care."
8776 #: guix-git/doc/guix.texi:3615
8778 msgid "manifest, exporting"
8782 #: guix-git/doc/guix.texi:3617
8783 msgid "export-manifest"
8787 #: guix-git/doc/guix.texi:3617
8789 msgid "--export-manifest"
8793 #: guix-git/doc/guix.texi:3620
8794 msgid "Write to standard output a manifest suitable for @option{--manifest} corresponding to the chosen profile(s)."
8798 #: guix-git/doc/guix.texi:3624
8799 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."
8803 #: guix-git/doc/guix.texi:3629
8804 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."
8808 #: guix-git/doc/guix.texi:3634
8809 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."
8813 #: guix-git/doc/guix.texi:3635
8815 msgid "pinning, channel revisions of a profile"
8819 #: guix-git/doc/guix.texi:3636
8821 msgid "--export-channels"
8825 #: guix-git/doc/guix.texi:3640
8826 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})."
8830 #: guix-git/doc/guix.texi:3644
8831 msgid "Together with @option{--export-manifest}, this option provides information allowing you to replicate the current profile (@pxref{Replicating Guix})."
8835 #: guix-git/doc/guix.texi:3652
8836 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})."
8840 #: guix-git/doc/guix.texi:3657
8841 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."
8845 #: guix-git/doc/guix.texi:3664
8846 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})."
8850 #: guix-git/doc/guix.texi:3669
8852 msgid "pre-built binaries"
8856 #: guix-git/doc/guix.texi:3675
8857 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."
8861 #: guix-git/doc/guix.texi:3680
8862 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."
8866 #: guix-git/doc/guix.texi:3694
8872 #: guix-git/doc/guix.texi:3704
8873 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})."
8877 #: guix-git/doc/guix.texi:3710
8878 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."
8882 #: guix-git/doc/guix.texi:3719
8883 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."
8887 #: guix-git/doc/guix.texi:3723
8893 #: guix-git/doc/guix.texi:3725
8895 msgid "access control list (ACL), for substitutes"
8899 #: guix-git/doc/guix.texi:3726
8901 msgid "ACL (access control list), for substitutes"
8905 #: guix-git/doc/guix.texi:3733
8906 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."
8910 #: guix-git/doc/guix.texi:3737
8911 msgid "If you are using Guix System, you can skip this section: Guix System authorizes substitutes from @code{@value{SUBSTITUTE-SERVER}} by default."
8915 #: guix-git/doc/guix.texi:3745
8916 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:"
8920 #: guix-git/doc/guix.texi:3748
8922 msgid "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
8926 #: guix-git/doc/guix.texi:3752
8927 msgid "Once this is in place, the output of a command like @code{guix build} should change from something like:"
8931 #: guix-git/doc/guix.texi:3761
8934 "$ guix build emacs --dry-run\n"
8935 "The following derivations would be built:\n"
8936 " /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n"
8937 " /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n"
8938 " /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n"
8939 " /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n"
8944 #: guix-git/doc/guix.texi:3765
8945 msgid "to something like:"
8949 #: guix-git/doc/guix.texi:3774
8952 "$ guix build emacs --dry-run\n"
8953 "112.3 MB would be downloaded:\n"
8954 " /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n"
8955 " /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n"
8956 " /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n"
8957 " /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n"
8962 #: guix-git/doc/guix.texi:3781
8963 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."
8967 #: guix-git/doc/guix.texi:3782
8969 msgid "substitutes, how to disable"
8973 #: guix-git/doc/guix.texi:3788
8974 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."
8978 #: guix-git/doc/guix.texi:3792
8980 msgid "substitute servers, adding more"
8984 #: guix-git/doc/guix.texi:3799
8985 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."
8989 #: guix-git/doc/guix.texi:3804
8990 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."
8994 #: guix-git/doc/guix.texi:3811
8995 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}})."
8999 #: guix-git/doc/guix.texi:3816
9000 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:"
9004 #: guix-git/doc/guix.texi:3833
9007 "(operating-system\n"
9010 " ;; Assume we're starting from '%desktop-services'. Replace it\n"
9011 " ;; with the list of services you're actually using.\n"
9012 " (modify-services %desktop-services\n"
9013 " (guix-service-type config =>\n"
9014 " (guix-configuration\n"
9015 " (inherit config)\n"
9016 " (substitute-urls\n"
9017 " (append (list \"https://guix.example.org\")\n"
9018 " %default-substitute-urls))\n"
9019 " (authorized-keys\n"
9020 " (append (list (local-file \"./key.pub\"))\n"
9021 " %default-authorized-guix-keys)))))))\n"
9025 #: guix-git/doc/guix.texi:3840
9026 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:"
9030 #: guix-git/doc/guix.texi:3844
9033 "$ sudo guix system reconfigure /etc/config.scm\n"
9034 "$ sudo herd restart guix-daemon\n"
9038 #: guix-git/doc/guix.texi:3848
9039 msgid "If you're running Guix on a ``foreign distro'', you would instead take the following steps to get substitutes from additional servers:"
9043 #: guix-git/doc/guix.texi:3857
9044 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}}):"
9048 #: guix-git/doc/guix.texi:3860
9050 msgid "@dots{} --substitute-urls='https://guix.example.org https://@value{SUBSTITUTE-SERVER}'\n"
9054 #: guix-git/doc/guix.texi:3864
9055 msgid "Restart the daemon. For systemd, it goes like this:"
9059 #: guix-git/doc/guix.texi:3868
9062 "systemctl daemon-reload\n"
9063 "systemctl restart guix-daemon.service\n"
9067 #: guix-git/doc/guix.texi:3872
9068 msgid "Authorize the key of the new server (@pxref{Invoking guix archive}):"
9072 #: guix-git/doc/guix.texi:3875
9074 msgid "guix archive --authorize < key.pub\n"
9078 #: guix-git/doc/guix.texi:3879
9079 msgid "Again this assumes @file{key.pub} contains the public key that @code{guix.example.org} uses to sign substitutes."
9083 #: guix-git/doc/guix.texi:3886
9084 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."
9088 #: guix-git/doc/guix.texi:3890
9089 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."
9093 #: guix-git/doc/guix.texi:3894
9095 msgid "digital signatures"
9099 #: guix-git/doc/guix.texi:3898
9100 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."
9104 #: guix-git/doc/guix.texi:3904
9105 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:"
9109 #: guix-git/doc/guix.texi:3907
9111 msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n"
9115 #: guix-git/doc/guix.texi:3918
9116 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)."
9120 #: guix-git/doc/guix.texi:3925
9121 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)."
9125 #: guix-git/doc/guix.texi:3937
9126 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}."
9130 #: guix-git/doc/guix.texi:3946
9131 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."
9135 #: guix-git/doc/guix.texi:3960
9136 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."
9140 #: guix-git/doc/guix.texi:3965
9141 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."
9145 #: guix-git/doc/guix.texi:3969
9147 msgid "trust, of pre-built binaries"
9151 #: guix-git/doc/guix.texi:3979
9152 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})."
9156 #: guix-git/doc/guix.texi:3991
9157 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}})."
9161 #: guix-git/doc/guix.texi:3995
9162 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}."
9166 #: guix-git/doc/guix.texi:3999
9168 msgid "multiple-output packages"
9172 #: guix-git/doc/guix.texi:4000
9174 msgid "package outputs"
9178 #: guix-git/doc/guix.texi:4001
9184 #: guix-git/doc/guix.texi:4011
9185 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."
9189 #: guix-git/doc/guix.texi:4019
9190 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:"
9194 #: guix-git/doc/guix.texi:4022
9196 msgid "guix install glib\n"
9200 #: guix-git/doc/guix.texi:4024 guix-git/doc/guix.texi:34192
9201 #: guix-git/doc/guix.texi:34249
9203 msgid "documentation"
9207 #: guix-git/doc/guix.texi:4026
9208 msgid "The command to install its documentation is:"
9212 #: guix-git/doc/guix.texi:4029
9214 msgid "guix install glib:doc\n"
9218 #: guix-git/doc/guix.texi:4040
9219 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})."
9223 #: guix-git/doc/guix.texi:4048
9224 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})."
9228 #: guix-git/doc/guix.texi:4051
9230 msgid "Invoking @command{guix gc}"
9234 #: guix-git/doc/guix.texi:4053
9236 msgid "garbage collector"
9240 #: guix-git/doc/guix.texi:4054
9246 #: guix-git/doc/guix.texi:4060
9247 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!"
9251 #: guix-git/doc/guix.texi:4071
9252 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."
9256 #: guix-git/doc/guix.texi:4077
9257 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})."
9261 #: guix-git/doc/guix.texi:4081
9262 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:"
9266 #: guix-git/doc/guix.texi:4084
9268 msgid "guix gc -F 5G\n"
9272 #: guix-git/doc/guix.texi:4093
9273 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."
9277 #: guix-git/doc/guix.texi:4099
9278 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:"
9282 #: guix-git/doc/guix.texi:4101
9284 msgid "--collect-garbage[=@var{min}]"
9288 #: guix-git/doc/guix.texi:4102
9290 msgid "-C [@var{min}]"
9294 #: guix-git/doc/guix.texi:4106
9295 msgid "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-directories. This is the default operation when no option is specified."
9299 #: guix-git/doc/guix.texi:4111
9300 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})."
9304 #: guix-git/doc/guix.texi:4113
9305 msgid "When @var{min} is omitted, collect all the garbage."
9309 #: guix-git/doc/guix.texi:4114
9311 msgid "--free-space=@var{free}"
9315 #: guix-git/doc/guix.texi:4115
9317 msgid "-F @var{free}"
9321 #: guix-git/doc/guix.texi:4119
9322 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."
9326 #: guix-git/doc/guix.texi:4122
9327 msgid "When @var{free} or more is already available in @file{/gnu/store}, do nothing and exit immediately."
9331 #: guix-git/doc/guix.texi:4123
9333 msgid "--delete-generations[=@var{duration}]"
9337 #: guix-git/doc/guix.texi:4124
9339 msgid "-d [@var{duration}]"
9343 #: guix-git/doc/guix.texi:4128
9344 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}."
9348 #: guix-git/doc/guix.texi:4132
9349 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:"
9353 #: guix-git/doc/guix.texi:4135
9355 msgid "guix gc -d 2m -F 10G\n"
9359 #: guix-git/doc/guix.texi:4137
9365 #: guix-git/doc/guix.texi:4138
9371 #: guix-git/doc/guix.texi:4142
9372 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."
9376 #: guix-git/doc/guix.texi:4143
9378 msgid "--list-failures"
9382 #: guix-git/doc/guix.texi:4145
9383 msgid "List store items corresponding to cached build failures."
9387 #: guix-git/doc/guix.texi:4149
9388 msgid "This prints nothing unless the daemon was started with @option{--cache-failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})."
9392 #: guix-git/doc/guix.texi:4150
9394 msgid "--list-roots"
9398 #: guix-git/doc/guix.texi:4153
9399 msgid "List the GC roots owned by the user; when run as root, list @emph{all} the GC roots."
9403 #: guix-git/doc/guix.texi:4154
9409 #: guix-git/doc/guix.texi:4157
9410 msgid "List store items in use by currently running processes. These store items are effectively considered GC roots: they cannot be deleted."
9414 #: guix-git/doc/guix.texi:4158
9416 msgid "--clear-failures"
9420 #: guix-git/doc/guix.texi:4160
9421 msgid "Remove the specified store items from the failed-build cache."
9425 #: guix-git/doc/guix.texi:4163
9426 msgid "Again, this option only makes sense when the daemon is started with @option{--cache-failures}. Otherwise, it does nothing."
9430 #: guix-git/doc/guix.texi:4164
9436 #: guix-git/doc/guix.texi:4167
9437 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."
9441 #: guix-git/doc/guix.texi:4168
9447 #: guix-git/doc/guix.texi:4170
9448 msgid "Show the list of live store files and directories."
9452 #: guix-git/doc/guix.texi:4174
9453 msgid "In addition, the references among existing store files can be queried:"
9457 #: guix-git/doc/guix.texi:4177
9459 msgid "--references"
9463 #: guix-git/doc/guix.texi:4178
9469 #: guix-git/doc/guix.texi:4179 guix-git/doc/guix.texi:12256
9471 msgid "package dependencies"
9475 #: guix-git/doc/guix.texi:4182
9476 msgid "List the references (respectively, the referrers) of store files given as arguments."
9480 #: guix-git/doc/guix.texi:4183
9482 msgid "--requisites"
9486 #: guix-git/doc/guix.texi:4184 guix-git/doc/guix.texi:6031
9492 #: guix-git/doc/guix.texi:4185 guix-git/doc/guix.texi:12112
9493 #: guix-git/doc/guix.texi:12140 guix-git/doc/guix.texi:12221
9499 #: guix-git/doc/guix.texi:4190
9500 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."
9504 #: guix-git/doc/guix.texi:4194
9505 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."
9509 #: guix-git/doc/guix.texi:4195
9515 #: guix-git/doc/guix.texi:4196 guix-git/doc/guix.texi:6345
9516 #: guix-git/doc/guix.texi:11975 guix-git/doc/guix.texi:12365
9522 #: guix-git/doc/guix.texi:4199
9523 msgid "Return the derivation(s) leading to the given store items (@pxref{Derivations})."
9527 #: guix-git/doc/guix.texi:4201
9528 msgid "For example, this command:"
9532 #: guix-git/doc/guix.texi:4204
9534 msgid "guix gc --derivers $(guix package -I ^emacs$ | cut -f4)\n"
9538 #: guix-git/doc/guix.texi:4209
9539 msgid "returns the @file{.drv} file(s) leading to the @code{emacs} package installed in your profile."
9543 #: guix-git/doc/guix.texi:4213
9544 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."
9548 #: guix-git/doc/guix.texi:4217
9549 msgid "Lastly, the following options allow you to check the integrity of the store and to control disk usage."
9553 #: guix-git/doc/guix.texi:4220
9555 msgid "--verify[=@var{options}]"
9559 #: guix-git/doc/guix.texi:4221
9561 msgid "integrity, of the store"
9565 #: guix-git/doc/guix.texi:4222
9567 msgid "integrity checking"
9571 #: guix-git/doc/guix.texi:4224
9572 msgid "Verify the integrity of the store."
9576 #: guix-git/doc/guix.texi:4227
9577 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}."
9581 #: guix-git/doc/guix.texi:4230
9582 msgid "When provided, @var{options} must be a comma-separated list containing one or more of @code{contents} and @code{repair}."
9586 #: guix-git/doc/guix.texi:4236
9587 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."
9591 #: guix-git/doc/guix.texi:4237
9593 msgid "repairing the store"
9597 #: guix-git/doc/guix.texi:4238 guix-git/doc/guix.texi:10852
9599 msgid "corruption, recovering from"
9603 #: guix-git/doc/guix.texi:4246
9604 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})."
9608 #: guix-git/doc/guix.texi:4247
9614 #: guix-git/doc/guix.texi:4251
9615 msgid "Optimize the store by hard-linking identical files---this is @dfn{deduplication}."
9619 #: guix-git/doc/guix.texi:4257
9620 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}."
9624 #: guix-git/doc/guix.texi:4261
9626 msgid "Invoking @command{guix pull}"
9630 #: guix-git/doc/guix.texi:4263
9632 msgid "upgrading Guix"
9636 #: guix-git/doc/guix.texi:4264
9638 msgid "updating Guix"
9641 #. type: command{#1}
9642 #: guix-git/doc/guix.texi:4265
9648 #: guix-git/doc/guix.texi:4266
9654 #: guix-git/doc/guix.texi:4267
9656 msgid "security, @command{guix pull}"
9660 #: guix-git/doc/guix.texi:4268
9662 msgid "authenticity, of code obtained with @command{guix pull}"
9666 #: guix-git/doc/guix.texi:4278
9667 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."
9671 #: guix-git/doc/guix.texi:4281
9672 msgid "Specifically, @command{guix pull} downloads code from the @dfn{channels} (@pxref{Channels}) specified by one of the followings, in this order:"
9676 #: guix-git/doc/guix.texi:4285
9677 msgid "the @option{--channels} option;"
9681 #: guix-git/doc/guix.texi:4287
9682 msgid "the user's @file{~/.config/guix/channels.scm} file;"
9686 #: guix-git/doc/guix.texi:4289
9687 msgid "the system-wide @file{/etc/guix/channels.scm} file;"
9691 #: guix-git/doc/guix.texi:4292
9692 msgid "the built-in default channels specified in the @code{%default-channels} variable."
9696 #: guix-git/doc/guix.texi:4299
9697 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."
9701 #: guix-git/doc/guix.texi:4305
9702 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."
9706 #: guix-git/doc/guix.texi:4311
9707 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}):"
9711 #: guix-git/doc/guix.texi:4315
9714 "export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n"
9715 "export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n"
9719 #: guix-git/doc/guix.texi:4319
9720 msgid "The @option{--list-generations} or @option{-l} option lists past generations produced by @command{guix pull}, along with details about their provenance:"
9724 #: guix-git/doc/guix.texi:4327
9728 "Generation 1\tJun 10 2018 00:18:18\n"
9730 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9731 " branch: origin/master\n"
9732 " commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n"
9737 #: guix-git/doc/guix.texi:4337
9740 "Generation 2\tJun 11 2018 11:02:49\n"
9742 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9743 " branch: origin/master\n"
9744 " commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n"
9745 " 2 new packages: keepalived, libnfnetlink\n"
9746 " 6 packages upgraded: emacs-nix-mode@@2.0.4,\n"
9747 " guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac,\n"
9748 " heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4\n"
9753 #: guix-git/doc/guix.texi:4345
9756 "Generation 3\tJun 13 2018 23:31:07\t(current)\n"
9758 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9759 " branch: origin/master\n"
9760 " commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n"
9761 " 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{}\n"
9762 " 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{}\n"
9766 #: guix-git/doc/guix.texi:4349
9767 msgid "@xref{Invoking guix describe, @command{guix describe}}, for other ways to describe the current status of Guix."
9771 #: guix-git/doc/guix.texi:4354
9772 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:"
9776 #: guix-git/doc/guix.texi:4360
9779 "$ guix pull --roll-back\n"
9780 "switched from generation 3 to 2\n"
9781 "$ guix pull --delete-generations=1\n"
9782 "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
9786 #: guix-git/doc/guix.texi:4364
9787 msgid "You can also use @command{guix package} (@pxref{Invoking guix package}) to manage the profile by naming it explicitly:"
9791 #: guix-git/doc/guix.texi:4369
9794 "$ guix package -p ~/.config/guix/current --roll-back\n"
9795 "switched from generation 3 to 2\n"
9796 "$ guix package -p ~/.config/guix/current --delete-generations=1\n"
9797 "deleting /var/guix/profiles/per-user/charlie/current-guix-1-link\n"
9801 #: guix-git/doc/guix.texi:4373
9802 msgid "The @command{guix pull} command is usually invoked with no arguments, but it supports the following options:"
9806 #: guix-git/doc/guix.texi:4375 guix-git/doc/guix.texi:4533
9808 msgid "--url=@var{url}"
9812 #: guix-git/doc/guix.texi:4376 guix-git/doc/guix.texi:4534
9814 msgid "--commit=@var{commit}"
9818 #: guix-git/doc/guix.texi:4377 guix-git/doc/guix.texi:4535
9820 msgid "--branch=@var{branch}"
9824 #: guix-git/doc/guix.texi:4381
9825 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}."
9829 #: guix-git/doc/guix.texi:4382 guix-git/doc/guix.texi:4979
9831 msgid "@file{channels.scm}, configuration file"
9835 #: guix-git/doc/guix.texi:4383 guix-git/doc/guix.texi:4980
9837 msgid "configuration file for channels"
9841 #: guix-git/doc/guix.texi:4387
9842 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)."
9846 #: guix-git/doc/guix.texi:4388 guix-git/doc/guix.texi:4540
9848 msgid "--channels=@var{file}"
9852 #: guix-git/doc/guix.texi:4389 guix-git/doc/guix.texi:4541
9854 msgid "-C @var{file}"
9858 #: guix-git/doc/guix.texi:4395
9859 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."
9863 #: guix-git/doc/guix.texi:4396
9865 msgid "channel news"
9869 #: guix-git/doc/guix.texi:4397
9875 #: guix-git/doc/guix.texi:4398 guix-git/doc/guix.texi:5806
9876 #: guix-git/doc/guix.texi:33161
9882 #: guix-git/doc/guix.texi:4402
9883 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})."
9887 #: guix-git/doc/guix.texi:4406
9888 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)."
9892 #: guix-git/doc/guix.texi:4413
9893 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})."
9897 #: guix-git/doc/guix.texi:4420
9898 msgid "Roll back to the previous @dfn{generation} of @file{~/.config/guix/current}---i.e., undo the last transaction."
9902 #: guix-git/doc/guix.texi:4444
9903 msgid "If the current generation matches, it is @emph{not} deleted."
9907 #: guix-git/doc/guix.texi:4450
9908 msgid "@xref{Invoking guix describe}, for a way to display information about the current generation only."
9912 #: guix-git/doc/guix.texi:4454
9913 msgid "Use @var{profile} instead of @file{~/.config/guix/current}."
9917 #: guix-git/doc/guix.texi:4455 guix-git/doc/guix.texi:10243
9923 #: guix-git/doc/guix.texi:4456 guix-git/doc/guix.texi:10244
9924 #: guix-git/doc/guix.texi:12094
9930 #: guix-git/doc/guix.texi:4459
9931 msgid "Show which channel commit(s) would be used and what would be built or substituted but do not actually do it."
9935 #: guix-git/doc/guix.texi:4460 guix-git/doc/guix.texi:33180
9937 msgid "--allow-downgrades"
9941 #: guix-git/doc/guix.texi:4463
9942 msgid "Allow pulling older or unrelated revisions of channels than those currently in use."
9946 #: guix-git/doc/guix.texi:4464
9948 msgid "downgrade attacks, protection against"
9952 #: guix-git/doc/guix.texi:4469
9953 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."
9957 #: guix-git/doc/guix.texi:4473 guix-git/doc/guix.texi:33194
9958 msgid "Make sure you understand its security implications before using @option{--allow-downgrades}."
9962 #: guix-git/doc/guix.texi:4475
9964 msgid "--disable-authentication"
9968 #: guix-git/doc/guix.texi:4477
9969 msgid "Allow pulling channel code without authenticating it."
9973 #: guix-git/doc/guix.texi:4478 guix-git/doc/guix.texi:5125
9975 msgid "authentication, of channel code"
9979 #: guix-git/doc/guix.texi:4483
9980 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."
9984 #: guix-git/doc/guix.texi:4487
9985 msgid "Make sure you understand its security implications before using @option{--disable-authentication}."
9989 #: guix-git/doc/guix.texi:4490 guix-git/doc/guix.texi:5789
9990 #: guix-git/doc/guix.texi:6160 guix-git/doc/guix.texi:10794
9991 #: guix-git/doc/guix.texi:12239 guix-git/doc/guix.texi:12490
9992 #: guix-git/doc/guix.texi:13157 guix-git/doc/guix.texi:33109
9994 msgid "-s @var{system}"
9998 #: guix-git/doc/guix.texi:4493 guix-git/doc/guix.texi:6163
9999 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host."
10003 #: guix-git/doc/guix.texi:4497
10004 msgid "Use the bootstrap Guile to build the latest Guix. This option is only useful to Guix developers."
10007 #. type: Plain text
10008 #: guix-git/doc/guix.texi:4503
10009 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."
10012 #. type: Plain text
10013 #: guix-git/doc/guix.texi:4506
10014 msgid "In addition, @command{guix pull} supports all the common build options (@pxref{Common Build Options})."
10018 #: guix-git/doc/guix.texi:4508
10020 msgid "Invoking @command{guix time-machine}"
10023 #. type: command{#1}
10024 #: guix-git/doc/guix.texi:4510
10026 msgid "guix time-machine"
10030 #: guix-git/doc/guix.texi:4511 guix-git/doc/guix.texi:5083
10032 msgid "pinning, channels"
10036 #: guix-git/doc/guix.texi:4512 guix-git/doc/guix.texi:4694
10037 #: guix-git/doc/guix.texi:5084
10039 msgid "replicating Guix"
10043 #: guix-git/doc/guix.texi:4513 guix-git/doc/guix.texi:5085
10045 msgid "reproducibility, of Guix"
10048 #. type: Plain text
10049 #: guix-git/doc/guix.texi:4521
10050 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})."
10053 #. type: Plain text
10054 #: guix-git/doc/guix.texi:4523 guix-git/doc/guix.texi:5538
10055 #: guix-git/doc/guix.texi:6283 guix-git/doc/guix.texi:10040
10056 #: guix-git/doc/guix.texi:10163 guix-git/doc/guix.texi:11085
10057 #: guix-git/doc/guix.texi:11162 guix-git/doc/guix.texi:12069
10058 #: guix-git/doc/guix.texi:12548 guix-git/doc/guix.texi:12911
10059 #: guix-git/doc/guix.texi:13000 guix-git/doc/guix.texi:13039
10060 #: guix-git/doc/guix.texi:13136
10061 msgid "The general syntax is:"
10065 #: guix-git/doc/guix.texi:4526
10067 msgid "guix time-machine @var{options}@dots{} -- @var{command} @var {arg}@dots{}\n"
10070 #. type: Plain text
10071 #: guix-git/doc/guix.texi:4531
10072 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}):"
10076 #: guix-git/doc/guix.texi:4539
10077 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}."
10081 #: guix-git/doc/guix.texi:4545
10082 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."
10085 #. type: Plain text
10086 #: guix-git/doc/guix.texi:4549
10087 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"
10091 #: guix-git/doc/guix.texi:4552
10093 msgid "guix time-machine -- build hello\n"
10096 #. type: Plain text
10097 #: guix-git/doc/guix.texi:4557
10098 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!"
10101 #. type: Plain text
10102 #: guix-git/doc/guix.texi:4561
10103 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})."
10107 #: guix-git/doc/guix.texi:4569
10108 msgid "The functionality described here is a ``technology preview'' as of version @value{VERSION}. As such, the interface is subject to change."
10112 #: guix-git/doc/guix.texi:4571 guix-git/doc/guix.texi:10077
10118 #: guix-git/doc/guix.texi:4572
10120 msgid "composition of Guix revisions"
10123 #. type: Plain text
10124 #: guix-git/doc/guix.texi:4577
10125 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."
10129 #: guix-git/doc/guix.texi:4578 guix-git/doc/guix.texi:4643
10131 msgid "inferior packages"
10134 #. type: Plain text
10135 #: guix-git/doc/guix.texi:4584
10136 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}."
10139 #. type: Plain text
10140 #: guix-git/doc/guix.texi:4594
10141 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:"
10145 #: guix-git/doc/guix.texi:4598
10148 "(use-modules (guix inferior) (guix channels)\n"
10149 " (srfi srfi-1)) ;for 'first'\n"
10154 #: guix-git/doc/guix.texi:4607
10157 "(define channels\n"
10158 " ;; This is the old revision from which we want to\n"
10159 " ;; extract guile-json.\n"
10160 " (list (channel\n"
10162 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10164 " \"65956ad3526ba09e1f7a40722c96c6ef7c0936fe\"))))\n"
10169 #: guix-git/doc/guix.texi:4611
10172 "(define inferior\n"
10173 " ;; An inferior representing the above revision.\n"
10174 " (inferior-for-channels channels))\n"
10179 #: guix-git/doc/guix.texi:4617
10182 ";; Now create a manifest with the current \"guile\" package\n"
10183 ";; and the old \"guile-json\" package.\n"
10184 "(packages->manifest\n"
10185 " (list (first (lookup-inferior-packages inferior \"guile-json\"))\n"
10186 " (specification->package \"guile\")))\n"
10189 #. type: Plain text
10190 #: guix-git/doc/guix.texi:4622
10191 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."
10194 #. type: Plain text
10195 #: guix-git/doc/guix.texi:4625
10196 msgid "The @code{(guix inferior)} module provides the following procedures to open an inferior:"
10200 #: guix-git/doc/guix.texi:4626
10202 msgid "{Scheme Procedure} inferior-for-channels @var{channels} @"
10206 #: guix-git/doc/guix.texi:4631
10207 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."
10211 #: guix-git/doc/guix.texi:4634
10212 msgid "As a side effect, this procedure may build or substitute binaries for @var{channels}, which can take time."
10216 #: guix-git/doc/guix.texi:4636
10218 msgid "{Scheme Procedure} open-inferior @var{directory} @"
10222 #: guix-git/doc/guix.texi:4641
10223 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."
10226 #. type: Plain text
10227 #: guix-git/doc/guix.texi:4646
10228 msgid "The procedures listed below allow you to obtain and manipulate inferior packages."
10232 #: guix-git/doc/guix.texi:4647
10234 msgid "{Scheme Procedure} inferior-packages @var{inferior}"
10238 #: guix-git/doc/guix.texi:4649
10239 msgid "Return the list of packages known to @var{inferior}."
10243 #: guix-git/doc/guix.texi:4651
10245 msgid "{Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @"
10249 #: guix-git/doc/guix.texi:4656
10250 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}."
10254 #: guix-git/doc/guix.texi:4658
10256 msgid "{Scheme Procedure} inferior-package? @var{obj}"
10260 #: guix-git/doc/guix.texi:4660
10261 msgid "Return true if @var{obj} is an inferior package."
10265 #: guix-git/doc/guix.texi:4662
10267 msgid "{Scheme Procedure} inferior-package-name @var{package}"
10271 #: guix-git/doc/guix.texi:4663
10273 msgid "{Scheme Procedure} inferior-package-version @var{package}"
10277 #: guix-git/doc/guix.texi:4664
10279 msgid "{Scheme Procedure} inferior-package-synopsis @var{package}"
10283 #: guix-git/doc/guix.texi:4665
10285 msgid "{Scheme Procedure} inferior-package-description @var{package}"
10289 #: guix-git/doc/guix.texi:4666
10291 msgid "{Scheme Procedure} inferior-package-home-page @var{package}"
10295 #: guix-git/doc/guix.texi:4667
10297 msgid "{Scheme Procedure} inferior-package-location @var{package}"
10301 #: guix-git/doc/guix.texi:4668
10303 msgid "{Scheme Procedure} inferior-package-inputs @var{package}"
10307 #: guix-git/doc/guix.texi:4669
10309 msgid "{Scheme Procedure} inferior-package-native-inputs @var{package}"
10313 #: guix-git/doc/guix.texi:4670
10315 msgid "{Scheme Procedure} inferior-package-propagated-inputs @var{package}"
10319 #: guix-git/doc/guix.texi:4671
10321 msgid "{Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package}"
10325 #: guix-git/doc/guix.texi:4672
10327 msgid "{Scheme Procedure} inferior-package-native-search-paths @var{package}"
10331 #: guix-git/doc/guix.texi:4673
10333 msgid "{Scheme Procedure} inferior-package-transitive-native-search-paths @var{package}"
10337 #: guix-git/doc/guix.texi:4674
10339 msgid "{Scheme Procedure} inferior-package-search-paths @var{package}"
10343 #: guix-git/doc/guix.texi:4679
10344 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."
10347 #. type: Plain text
10348 #: guix-git/doc/guix.texi:4689
10349 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."
10353 #: guix-git/doc/guix.texi:4691
10355 msgid "Invoking @command{guix describe}"
10358 #. type: Plain text
10359 #: guix-git/doc/guix.texi:4702
10360 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."
10363 #. type: Plain text
10364 #: guix-git/doc/guix.texi:4706
10365 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}):"
10369 #: guix-git/doc/guix.texi:4714
10372 "$ guix describe\n"
10373 "Generation 10\tSep 03 2018 17:32:44\t(current)\n"
10375 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
10376 " branch: master\n"
10377 " commit: e0fa68c7718fffd33d81af415279d6ddb518f727\n"
10380 #. type: Plain text
10381 #: guix-git/doc/guix.texi:4723
10382 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."
10385 #. type: Plain text
10386 #: guix-git/doc/guix.texi:4726
10387 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:"
10391 #: guix-git/doc/guix.texi:4739
10394 "$ guix describe -f channels\n"
10397 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10399 " \"e0fa68c7718fffd33d81af415279d6ddb518f727\")\n"
10401 " (make-channel-introduction\n"
10402 " \"9edb3f66fd807b096b48283debdcddccfea34bad\"\n"
10403 " (openpgp-fingerprint\n"
10404 " \"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA\")))))\n"
10407 #. type: Plain text
10408 #: guix-git/doc/guix.texi:4748
10409 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!"
10412 #. type: Plain text
10413 #: guix-git/doc/guix.texi:4751
10414 msgid "The details of the options supported by @command{guix describe} are as follows:"
10418 #: guix-git/doc/guix.texi:4753 guix-git/doc/guix.texi:5990
10419 #: guix-git/doc/guix.texi:13269
10421 msgid "--format=@var{format}"
10425 #: guix-git/doc/guix.texi:4754 guix-git/doc/guix.texi:5991
10426 #: guix-git/doc/guix.texi:13270
10428 msgid "-f @var{format}"
10432 #: guix-git/doc/guix.texi:4756 guix-git/doc/guix.texi:13272
10433 msgid "Produce output in the specified @var{format}, one of:"
10437 #: guix-git/doc/guix.texi:4758
10443 #: guix-git/doc/guix.texi:4760
10444 msgid "produce human-readable output;"
10448 #: guix-git/doc/guix.texi:4760 guix-git/doc/guix.texi:4978
10454 #: guix-git/doc/guix.texi:4764
10455 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});"
10459 #: guix-git/doc/guix.texi:4764
10461 msgid "channels-sans-intro"
10465 #: guix-git/doc/guix.texi:4770
10466 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;"
10470 #: guix-git/doc/guix.texi:4770 guix-git/doc/guix.texi:11348
10476 #: guix-git/doc/guix.texi:4771
10482 #: guix-git/doc/guix.texi:4773
10483 msgid "produce a list of channel specifications in JSON format;"
10487 #: guix-git/doc/guix.texi:4773 guix-git/doc/guix.texi:13274
10493 #: guix-git/doc/guix.texi:4775
10494 msgid "produce a list of channel specifications in Recutils format."
10498 #: guix-git/doc/guix.texi:4777
10500 msgid "--list-formats"
10504 #: guix-git/doc/guix.texi:4779
10505 msgid "Display available formats for @option{--format} option."
10509 #: guix-git/doc/guix.texi:4783
10510 msgid "Display information about @var{profile}."
10514 #: guix-git/doc/guix.texi:4786
10516 msgid "Invoking @command{guix archive}"
10519 #. type: command{#1}
10520 #: guix-git/doc/guix.texi:4788
10522 msgid "guix archive"
10526 #: guix-git/doc/guix.texi:4789
10531 #. type: Plain text
10532 #: guix-git/doc/guix.texi:4795
10533 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."
10537 #: guix-git/doc/guix.texi:4799
10538 msgid "If you're looking for a way to produce archives in a format suitable for tools other than Guix, @pxref{Invoking guix pack}."
10542 #: guix-git/doc/guix.texi:4801
10544 msgid "exporting store items"
10547 #. type: Plain text
10548 #: guix-git/doc/guix.texi:4803
10549 msgid "To export store files as an archive to standard output, run:"
10553 #: guix-git/doc/guix.texi:4806
10555 msgid "guix archive --export @var{options} @var{specifications}...\n"
10558 #. type: Plain text
10559 #: guix-git/doc/guix.texi:4813
10560 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}:"
10564 #: guix-git/doc/guix.texi:4816
10566 msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n"
10569 #. type: Plain text
10570 #: guix-git/doc/guix.texi:4821
10571 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})."
10574 #. type: Plain text
10575 #: guix-git/doc/guix.texi:4824
10576 msgid "To transfer the @code{emacs} package to a machine connected over SSH, one would run:"
10580 #: guix-git/doc/guix.texi:4827
10582 msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n"
10585 #. type: Plain text
10586 #: guix-git/doc/guix.texi:4832
10587 msgid "Similarly, a complete user profile may be transferred from one machine to another like this:"
10591 #: guix-git/doc/guix.texi:4836
10594 "guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n"
10595 " ssh the-machine guix archive --import\n"
10598 #. type: Plain text
10599 #: guix-git/doc/guix.texi:4846
10600 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})."
10604 #: guix-git/doc/guix.texi:4847
10606 msgid "nar, archive format"
10610 #: guix-git/doc/guix.texi:4848
10612 msgid "normalized archive (nar)"
10616 #: guix-git/doc/guix.texi:4849
10618 msgid "nar bundle, archive format"
10621 #. type: Plain text
10622 #: guix-git/doc/guix.texi:4854
10623 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}."
10626 #. type: Plain text
10627 #: guix-git/doc/guix.texi:4864
10628 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."
10631 #. type: Plain text
10632 #: guix-git/doc/guix.texi:4868
10633 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."
10636 #. type: Plain text
10637 #: guix-git/doc/guix.texi:4874
10638 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."
10641 #. type: Plain text
10642 #: guix-git/doc/guix.texi:4876
10643 msgid "The main options are:"
10647 #: guix-git/doc/guix.texi:4878
10653 #: guix-git/doc/guix.texi:4881
10654 msgid "Export the specified store files or packages (see below). Write the resulting archive to the standard output."
10658 #: guix-git/doc/guix.texi:4884
10659 msgid "Dependencies are @emph{not} included in the output, unless @option{--recursive} is passed."
10663 #: guix-git/doc/guix.texi:4885 guix-git/doc/guix.texi:11118
10664 #: guix-git/doc/guix.texi:11220 guix-git/doc/guix.texi:11245
10665 #: guix-git/doc/guix.texi:11423 guix-git/doc/guix.texi:11464
10666 #: guix-git/doc/guix.texi:11511 guix-git/doc/guix.texi:11536
10667 #: guix-git/doc/guix.texi:11552 guix-git/doc/guix.texi:11583
10673 #: guix-git/doc/guix.texi:4886 guix-git/doc/guix.texi:11117
10674 #: guix-git/doc/guix.texi:11219 guix-git/doc/guix.texi:11244
10675 #: guix-git/doc/guix.texi:11422 guix-git/doc/guix.texi:11463
10676 #: guix-git/doc/guix.texi:11510 guix-git/doc/guix.texi:11535
10677 #: guix-git/doc/guix.texi:11551 guix-git/doc/guix.texi:11582
10678 #: guix-git/doc/guix.texi:11639
10680 msgid "--recursive"
10684 #: guix-git/doc/guix.texi:4891
10685 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."
10689 #: guix-git/doc/guix.texi:4892
10695 #: guix-git/doc/guix.texi:4897
10696 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)."
10700 #: guix-git/doc/guix.texi:4898
10706 #: guix-git/doc/guix.texi:4902
10707 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."
10711 #: guix-git/doc/guix.texi:4903
10713 msgid "--generate-key[=@var{parameters}]"
10717 #: guix-git/doc/guix.texi:4904
10719 msgid "signing, archives"
10723 #: guix-git/doc/guix.texi:4911
10724 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."
10728 #: guix-git/doc/guix.texi:4921
10729 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})."
10733 #: guix-git/doc/guix.texi:4922
10735 msgid "--authorize"
10739 #: guix-git/doc/guix.texi:4923
10741 msgid "authorizing, archives"
10745 #: guix-git/doc/guix.texi:4927
10746 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."
10750 #: guix-git/doc/guix.texi:4934
10751 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)}."
10755 #: guix-git/doc/guix.texi:4935
10757 msgid "--extract=@var{directory}"
10761 #: guix-git/doc/guix.texi:4936
10763 msgid "-x @var{directory}"
10767 #: guix-git/doc/guix.texi:4940
10768 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."
10772 #: guix-git/doc/guix.texi:4943
10773 msgid "For example, the following command extracts the substitute for Emacs served by @code{@value{SUBSTITUTE-SERVER}} to @file{/tmp/emacs}:"
10777 #: guix-git/doc/guix.texi:4948
10781 " https://@value{SUBSTITUTE-SERVER}/nar/gzip/@dots{}-emacs-24.5 \\\n"
10782 " | gunzip | guix archive -x /tmp/emacs\n"
10786 #: guix-git/doc/guix.texi:4955
10787 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."
10791 #: guix-git/doc/guix.texi:4959
10792 msgid "The primary purpose of this operation is to facilitate inspection of archive contents coming from possibly untrusted substitute servers (@pxref{Invoking guix challenge})."
10796 #: guix-git/doc/guix.texi:4960
10802 #: guix-git/doc/guix.texi:4961 guix-git/doc/guix.texi:11410
10803 #: guix-git/doc/guix.texi:11457
10809 #: guix-git/doc/guix.texi:4965
10810 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:"
10814 #: guix-git/doc/guix.texi:4970
10818 " https://@value{SUBSTITUTE-SERVER}/nar/lzip/@dots{}-emacs-26.3 \\\n"
10819 " | lzip -d | guix archive -t\n"
10823 #: guix-git/doc/guix.texi:4981
10825 msgid "@command{guix pull}, configuration file"
10829 #: guix-git/doc/guix.texi:4982
10831 msgid "configuration of @command{guix pull}"
10834 #. type: Plain text
10835 #: guix-git/doc/guix.texi:4993
10836 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."
10840 #: guix-git/doc/guix.texi:5011
10842 msgid "extending the package collection (channels)"
10846 #: guix-git/doc/guix.texi:5012
10848 msgid "variant packages (channels)"
10851 #. type: Plain text
10852 #: guix-git/doc/guix.texi:5016
10853 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):"
10857 #: guix-git/doc/guix.texi:5017
10859 msgid "%default-channels"
10863 #: guix-git/doc/guix.texi:5024
10866 ";; Add variant packages to those Guix provides.\n"
10868 " (name 'variant-packages)\n"
10869 " (url \"https://example.org/variant-packages.git\"))\n"
10870 " %default-channels)\n"
10873 #. type: Plain text
10874 #: guix-git/doc/guix.texi:5034
10875 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:"
10879 #: guix-git/doc/guix.texi:5049
10882 "$ guix pull --list-generations\n"
10884 "Generation 19\tAug 27 2018 16:20:48\n"
10886 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
10887 " branch: master\n"
10888 " commit: d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300\n"
10889 " variant-packages dd3df5e\n"
10890 " repository URL: https://example.org/variant-packages.git\n"
10891 " branch: master\n"
10892 " commit: dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\n"
10893 " 11 new packages: variant-gimp, variant-emacs-with-cool-features, @dots{}\n"
10894 " 4 packages upgraded: emacs-racket-mode@@0.0.2-2.1b78827, @dots{}\n"
10897 #. type: Plain text
10898 #: guix-git/doc/guix.texi:5057
10899 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."
10902 #. type: Plain text
10903 #: guix-git/doc/guix.texi:5066
10904 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:"
10908 #: guix-git/doc/guix.texi:5073
10911 ";; Tell 'guix pull' to use another repo.\n"
10914 " (url \"https://example.org/another-guix.git\")\n"
10915 " (branch \"super-hacks\")))\n"
10918 #. type: Plain text
10919 #: guix-git/doc/guix.texi:5079
10920 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})."
10923 #. type: Plain text
10924 #: guix-git/doc/guix.texi:5090
10925 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:"
10929 #: guix-git/doc/guix.texi:5101
10932 ";; Deploy specific commits of my channels of interest.\n"
10935 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10936 " (commit \"6298c3ffd9654d3231a6f25390b056483e8f407c\"))\n"
10938 " (name 'variant-packages)\n"
10939 " (url \"https://example.org/variant-packages.git\")\n"
10940 " (commit \"dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\")))\n"
10943 #. type: Plain text
10944 #: guix-git/doc/guix.texi:5108
10945 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})."
10948 #. type: Plain text
10949 #: guix-git/doc/guix.texi:5115
10950 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."
10953 #. type: Plain text
10954 #: guix-git/doc/guix.texi:5120
10955 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."
10958 #. type: anchor{#1}
10959 #: guix-git/doc/guix.texi:5125
10960 msgid "channel-authentication"
10963 #. type: Plain text
10964 #: guix-git/doc/guix.texi:5131
10965 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."
10968 #. type: Plain text
10969 #: guix-git/doc/guix.texi:5136
10970 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:"
10974 #: guix-git/doc/guix.texi:5146
10978 " (name 'some-channel)\n"
10979 " (url \"https://example.org/some-channel.git\")\n"
10981 " (make-channel-introduction\n"
10982 " \"6f0d8cc0d88abb59c324b2990bfee2876016bb86\"\n"
10983 " (openpgp-fingerprint\n"
10984 " \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
10987 #. type: Plain text
10988 #: guix-git/doc/guix.texi:5152
10989 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{}}."
10992 #. type: Plain text
10993 #: guix-git/doc/guix.texi:5158
10994 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."
10997 #. type: Plain text
10998 #: guix-git/doc/guix.texi:5160
10999 msgid "If you're curious about the authentication mechanics, read on!"
11002 #. type: Plain text
11003 #: guix-git/doc/guix.texi:5171
11004 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}."
11008 #: guix-git/doc/guix.texi:5174
11011 "(use-modules (guix ci))\n"
11016 #: guix-git/doc/guix.texi:5178
11019 "(list (channel-with-substitutes-available\n"
11020 " %default-guix-channel\n"
11021 " \"https://ci.guix.gnu.org\"))\n"
11024 #. type: Plain text
11025 #: guix-git/doc/guix.texi:5185
11026 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."
11030 #: guix-git/doc/guix.texi:5189
11032 msgid "personal packages (channels)"
11036 #: guix-git/doc/guix.texi:5190
11038 msgid "channels, for personal packages"
11041 #. type: Plain text
11042 #: guix-git/doc/guix.texi:5198
11043 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?"
11047 #: guix-git/doc/guix.texi:5202 guix-git/doc/guix.texi:13624
11048 #: guix-git/doc/guix.texi:19579 guix-git/doc/guix.texi:19586
11054 #: guix-git/doc/guix.texi:5206
11055 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:"
11059 #: guix-git/doc/guix.texi:5214
11060 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."
11064 #: guix-git/doc/guix.texi:5223
11065 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."
11069 #: guix-git/doc/guix.texi:5227
11070 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."
11074 #: guix-git/doc/guix.texi:5234
11075 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."
11078 #. type: Plain text
11079 #: guix-git/doc/guix.texi:5246
11080 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})."
11083 #. type: Plain text
11084 #: guix-git/doc/guix.texi:5251
11085 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."
11089 #: guix-git/doc/guix.texi:5256
11091 msgid "subdirectory, channels"
11094 #. type: Plain text
11095 #: guix-git/doc/guix.texi:5260
11096 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:"
11100 #: guix-git/doc/guix.texi:5265
11105 " (directory \"guix\"))\n"
11109 #: guix-git/doc/guix.texi:5270
11111 msgid "dependencies, channels"
11115 #: guix-git/doc/guix.texi:5271
11117 msgid "meta-data, channels"
11120 #. type: Plain text
11121 #: guix-git/doc/guix.texi:5276
11122 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."
11125 #. type: Plain text
11126 #: guix-git/doc/guix.texi:5278
11127 msgid "The meta-data file should contain a simple S-expression like this:"
11131 #: guix-git/doc/guix.texi:5286
11138 " (name some-collection)\n"
11139 " (url \"https://example.org/first-collection.git\")\n"
11144 #: guix-git/doc/guix.texi:5298
11147 " ;; The 'introduction' bit below is optional: you would\n"
11148 " ;; provide it for dependencies that can be authenticated.\n"
11150 " (channel-introduction\n"
11152 " (commit \"a8883b58dc82e167c96506cf05095f37c2c2c6cd\")\n"
11153 " (signer \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
11155 " (name some-other-collection)\n"
11156 " (url \"https://example.org/second-collection.git\")\n"
11157 " (branch \"testing\"))))\n"
11160 #. type: Plain text
11161 #: guix-git/doc/guix.texi:5304
11162 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."
11165 #. type: Plain text
11166 #: guix-git/doc/guix.texi:5308
11167 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."
11171 #: guix-git/doc/guix.texi:5312
11173 msgid "channel authorizations"
11176 #. type: anchor{#1}
11177 #: guix-git/doc/guix.texi:5326
11178 msgid "channel-authorizations"
11181 #. type: Plain text
11182 #: guix-git/doc/guix.texi:5326
11183 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:"
11187 #: guix-git/doc/guix.texi:5329
11190 ";; Example '.guix-authorizations' file.\n"
11195 #: guix-git/doc/guix.texi:5332
11198 "(authorizations\n"
11199 " (version 0) ;current file format version\n"
11204 #: guix-git/doc/guix.texi:5339
11207 " ((\"AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3\"\n"
11208 " (name \"alice\"))\n"
11209 " (\"2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5\"\n"
11210 " (name \"bob\"))\n"
11211 " (\"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"\n"
11212 " (name \"charlie\"))))\n"
11215 #. type: Plain text
11216 #: guix-git/doc/guix.texi:5343
11217 msgid "Each fingerprint is followed by optional key/value pairs, as in the example above. Currently these key/value pairs are ignored."
11220 #. type: Plain text
11221 #: guix-git/doc/guix.texi:5348
11222 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?"
11226 #: guix-git/doc/guix.texi:5349
11228 msgid "channel introduction"
11231 #. type: Plain text
11232 #: guix-git/doc/guix.texi:5356
11233 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."
11236 #. type: Plain text
11237 #: guix-git/doc/guix.texi:5363
11238 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:"
11242 #: guix-git/doc/guix.texi:5368
11247 " (keyring-reference \"my-keyring-branch\"))\n"
11250 #. type: Plain text
11251 #: guix-git/doc/guix.texi:5372
11252 msgid "To summarize, as the author of a channel, there are three things you have to do to allow users to authenticate your code:"
11256 #: guix-git/doc/guix.texi:5378
11257 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})."
11261 #: guix-git/doc/guix.texi:5383
11262 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.)"
11266 #: guix-git/doc/guix.texi:5389
11267 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."
11270 #. type: Plain text
11271 #: guix-git/doc/guix.texi:5394
11272 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:"
11276 #: guix-git/doc/guix.texi:5397
11278 msgid "guix git authenticate @var{commit} @var{signer}\n"
11281 #. type: Plain text
11282 #: guix-git/doc/guix.texi:5402
11283 msgid "where @var{commit} and @var{signer} are your channel introduction. @xref{Invoking guix git authenticate}, for details."
11286 #. type: Plain text
11287 #: guix-git/doc/guix.texi:5409
11288 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."
11292 #: guix-git/doc/guix.texi:5413
11294 msgid "primary URL, channels"
11297 #. type: Plain text
11298 #: guix-git/doc/guix.texi:5416
11299 msgid "Channel authors can indicate the primary URL of their channel's Git repository in the @file{.guix-channel} file, like so:"
11303 #: guix-git/doc/guix.texi:5421
11308 " (url \"https://example.org/guix.git\"))\n"
11311 #. type: Plain text
11312 #: guix-git/doc/guix.texi:5428
11313 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."
11316 #. type: Plain text
11317 #: guix-git/doc/guix.texi:5432
11318 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."
11322 #: guix-git/doc/guix.texi:5436
11324 msgid "news, for channels"
11327 #. type: Plain text
11328 #: guix-git/doc/guix.texi:5440
11329 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."
11332 #. type: Plain text
11333 #: guix-git/doc/guix.texi:5445
11334 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."
11337 #. type: Plain text
11338 #: guix-git/doc/guix.texi:5448
11339 msgid "To do that, channel authors must first declare the name of the news file in their @file{.guix-channel} file:"
11343 #: guix-git/doc/guix.texi:5453
11348 " (news-file \"etc/news.txt\"))\n"
11351 #. type: Plain text
11352 #: guix-git/doc/guix.texi:5457
11353 msgid "The news file itself, @file{etc/news.txt} in this example, must look something like this:"
11357 #: guix-git/doc/guix.texi:5470
11362 " (entry (tag \"the-bug-fix\")\n"
11363 " (title (en \"Fixed terrible bug\")\n"
11364 " (fr \"Oh la la\"))\n"
11365 " (body (en \"@@emph@{Good news@}! It's fixed!\")\n"
11366 " (eo \"Certe ĝi pli bone funkcias nun!\")))\n"
11367 " (entry (commit \"bdcabe815cd28144a2d2b4bc3c5057b051fa9906\")\n"
11368 " (title (en \"Added a great package\")\n"
11369 " (ca \"Què vol dir guix?\"))\n"
11370 " (body (en \"Don't miss the @@code@{hello@} package!\"))))\n"
11373 #. type: Plain text
11374 #: guix-git/doc/guix.texi:5477
11375 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."
11378 #. type: Plain text
11379 #: guix-git/doc/guix.texi:5482
11380 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."
11383 #. type: Plain text
11384 #: guix-git/doc/guix.texi:5488
11385 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."
11388 #. type: Plain text
11389 #: guix-git/doc/guix.texi:5494
11390 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:"
11394 #: guix-git/doc/guix.texi:5497
11396 msgid "xgettext -o news.po -l scheme -ken etc/news.txt\n"
11399 #. type: Plain text
11400 #: guix-git/doc/guix.texi:5501
11401 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."
11405 #: guix-git/doc/guix.texi:5506
11407 msgid "software development"
11410 #. type: Plain text
11411 #: guix-git/doc/guix.texi:5510
11412 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."
11415 #. type: Plain text
11416 #: guix-git/doc/guix.texi:5516
11417 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."
11421 #: guix-git/doc/guix.texi:5525
11423 msgid "Invoking @command{guix environment}"
11427 #: guix-git/doc/guix.texi:5527
11429 msgid "reproducible build environments"
11433 #: guix-git/doc/guix.texi:5528
11435 msgid "development environments"
11438 #. type: command{#1}
11439 #: guix-git/doc/guix.texi:5529
11441 msgid "guix environment"
11445 #: guix-git/doc/guix.texi:5530
11447 msgid "environment, package build environment"
11450 #. type: Plain text
11451 #: guix-git/doc/guix.texi:5536
11452 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."
11456 #: guix-git/doc/guix.texi:5541
11458 msgid "guix environment @var{options} @var{package}@dots{}\n"
11461 #. type: Plain text
11462 #: guix-git/doc/guix.texi:5545
11463 msgid "The following example spawns a new shell set up for the development of GNU@tie{}Guile:"
11467 #: guix-git/doc/guix.texi:5548
11469 msgid "guix environment guile\n"
11472 #. type: Plain text
11473 #: guix-git/doc/guix.texi:5565
11474 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.}."
11477 #. type: Plain text
11478 #: guix-git/doc/guix.texi:5571
11479 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."
11483 #: guix-git/doc/guix.texi:5572
11485 msgid "GUIX_ENVIRONMENT"
11488 #. type: Plain text
11489 #: guix-git/doc/guix.texi:5578
11490 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}):"
11494 #: guix-git/doc/guix.texi:5584
11497 "if [ -n \"$GUIX_ENVIRONMENT\" ]\n"
11499 " export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n"
11503 #. type: Plain text
11504 #: guix-git/doc/guix.texi:5588
11505 msgid "...@: or to browse the profile:"
11509 #: guix-git/doc/guix.texi:5591
11511 msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n"
11514 #. type: Plain text
11515 #: guix-git/doc/guix.texi:5597
11516 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:"
11520 #: guix-git/doc/guix.texi:5600
11522 msgid "guix environment guile emacs\n"
11525 #. type: Plain text
11526 #: guix-git/doc/guix.texi:5605
11527 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:"
11531 #: guix-git/doc/guix.texi:5608
11533 msgid "guix environment guile -- make -j4\n"
11536 #. type: Plain text
11537 #: guix-git/doc/guix.texi:5614
11538 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:"
11542 #: guix-git/doc/guix.texi:5617
11544 msgid "guix environment --ad-hoc python2-numpy python-2.7 -- python\n"
11547 #. type: Plain text
11548 #: guix-git/doc/guix.texi:5628
11549 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:"
11553 #: guix-git/doc/guix.texi:5631
11555 msgid "guix environment --pure guix --ad-hoc git strace\n"
11559 #: guix-git/doc/guix.texi:5633 guix-git/doc/guix.texi:5794
11560 #: guix-git/doc/guix.texi:13025 guix-git/doc/guix.texi:33068
11565 #. type: Plain text
11566 #: guix-git/doc/guix.texi:5641
11567 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:"
11571 #: guix-git/doc/guix.texi:5644
11573 msgid "guix environment --ad-hoc --container guile -- guile\n"
11577 #: guix-git/doc/guix.texi:5648
11578 msgid "The @option{--container} option requires Linux-libre 3.19 or newer."
11582 #: guix-git/doc/guix.texi:5650
11584 msgid "certificates"
11587 #. type: Plain text
11588 #: guix-git/doc/guix.texi:5657
11589 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."
11593 #: guix-git/doc/guix.texi:5664
11596 "guix environment --preserve='^DISPLAY$' --container --network \\\n"
11597 " --expose=/etc/machine-id \\\n"
11598 " --expose=/etc/ssl/certs/ \\\n"
11599 " --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \\\n"
11600 " --ad-hoc eolie nss-certs dbus -- eolie\n"
11603 #. type: Plain text
11604 #: guix-git/doc/guix.texi:5667
11605 msgid "The available options are summarized below."
11609 #: guix-git/doc/guix.texi:5669 guix-git/doc/guix.texi:6205
11610 #: guix-git/doc/guix.texi:10863 guix-git/doc/guix.texi:33165
11612 msgid "--root=@var{file}"
11616 #: guix-git/doc/guix.texi:5670 guix-git/doc/guix.texi:6206
11617 #: guix-git/doc/guix.texi:10864 guix-git/doc/guix.texi:33166
11619 msgid "-r @var{file}"
11623 #: guix-git/doc/guix.texi:5671
11625 msgid "persistent environment"
11629 #: guix-git/doc/guix.texi:5672
11631 msgid "garbage collector root, for environments"
11635 #: guix-git/doc/guix.texi:5675
11636 msgid "Make @var{file} a symlink to the profile for this environment, and register it as a garbage collector root."
11640 #: guix-git/doc/guix.texi:5678
11641 msgid "This is useful if you want to protect your environment from garbage collection, to make it ``persistent''."
11645 #: guix-git/doc/guix.texi:5684
11646 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."
11650 #: guix-git/doc/guix.texi:5685 guix-git/doc/guix.texi:6137
11651 #: guix-git/doc/guix.texi:10709 guix-git/doc/guix.texi:11684
11652 #: guix-git/doc/guix.texi:12479 guix-git/doc/guix.texi:33100
11654 msgid "--expression=@var{expr}"
11658 #: guix-git/doc/guix.texi:5686 guix-git/doc/guix.texi:6138
11659 #: guix-git/doc/guix.texi:10710 guix-git/doc/guix.texi:11685
11660 #: guix-git/doc/guix.texi:12480 guix-git/doc/guix.texi:33101
11662 msgid "-e @var{expr}"
11666 #: guix-git/doc/guix.texi:5689
11667 msgid "Create an environment for the package or list of packages that @var{expr} evaluates to."
11671 #: guix-git/doc/guix.texi:5691
11672 msgid "For example, running:"
11676 #: guix-git/doc/guix.texi:5694
11678 msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
11682 #: guix-git/doc/guix.texi:5698
11683 msgid "starts a shell with the environment for this specific variant of the PETSc package."
11687 #: guix-git/doc/guix.texi:5700
11692 #: guix-git/doc/guix.texi:5703
11694 msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n"
11698 #: guix-git/doc/guix.texi:5706
11699 msgid "starts a shell with all the base system packages available."
11703 #: guix-git/doc/guix.texi:5709
11704 msgid "The above commands only use the default output of the given packages. To select other outputs, two element tuples can be specified:"
11708 #: guix-git/doc/guix.texi:5712
11710 msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
11714 #: guix-git/doc/guix.texi:5714
11716 msgid "--load=@var{file}"
11720 #: guix-git/doc/guix.texi:5715
11722 msgid "-l @var{file}"
11726 #: guix-git/doc/guix.texi:5718
11727 msgid "Create an environment for the package or list of packages that the code within @var{file} evaluates to."
11731 #: guix-git/doc/guix.texi:5724
11733 msgid "@verbatiminclude environment-gdb.scm\n"
11737 #: guix-git/doc/guix.texi:5731
11738 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."
11742 #: guix-git/doc/guix.texi:5735
11743 msgid "This is similar to the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files."
11747 #: guix-git/doc/guix.texi:5736
11753 #: guix-git/doc/guix.texi:5741
11754 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."
11758 #: guix-git/doc/guix.texi:5743
11759 msgid "For instance, the command:"
11763 #: guix-git/doc/guix.texi:5746
11765 msgid "guix environment --ad-hoc guile guile-sdl -- guile\n"
11769 #: guix-git/doc/guix.texi:5750
11770 msgid "runs @command{guile} in an environment where Guile and Guile-SDL are available."
11774 #: guix-git/doc/guix.texi:5755
11775 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})."
11779 #: guix-git/doc/guix.texi:5761
11780 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."
11784 #: guix-git/doc/guix.texi:5762
11790 #: guix-git/doc/guix.texi:5766
11791 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."
11795 #: guix-git/doc/guix.texi:5767
11797 msgid "--preserve=@var{regexp}"
11801 #: guix-git/doc/guix.texi:5768
11803 msgid "-E @var{regexp}"
11807 #: guix-git/doc/guix.texi:5773
11808 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."
11812 #: guix-git/doc/guix.texi:5777
11815 "guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \\\n"
11816 " -- mpirun @dots{}\n"
11820 #: guix-git/doc/guix.texi:5783
11821 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.)."
11825 #: guix-git/doc/guix.texi:5784
11827 msgid "--search-paths"
11831 #: guix-git/doc/guix.texi:5787
11832 msgid "Display the environment variable definitions that make up the environment."
11836 #: guix-git/doc/guix.texi:5791
11837 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}."
11841 #: guix-git/doc/guix.texi:5792
11843 msgid "--container"
11847 #: guix-git/doc/guix.texi:5793
11853 #: guix-git/doc/guix.texi:5800
11854 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."
11858 #: guix-git/doc/guix.texi:5804
11859 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)."
11863 #: guix-git/doc/guix.texi:5805 guix-git/doc/guix.texi:33160
11869 #: guix-git/doc/guix.texi:5810
11870 msgid "For containers, share the network namespace with the host system. Containers created without this flag only have access to the loopback device."
11874 #: guix-git/doc/guix.texi:5811
11876 msgid "--link-profile"
11880 #: guix-git/doc/guix.texi:5812
11886 #: guix-git/doc/guix.texi:5820
11887 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."
11891 #: guix-git/doc/guix.texi:5826
11892 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."
11896 #: guix-git/doc/guix.texi:5827 guix-git/doc/guix.texi:12612
11898 msgid "--user=@var{user}"
11902 #: guix-git/doc/guix.texi:5828 guix-git/doc/guix.texi:12613
11904 msgid "-u @var{user}"
11908 #: guix-git/doc/guix.texi:5835
11909 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."
11913 #: guix-git/doc/guix.texi:5840
11914 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."
11918 #: guix-git/doc/guix.texi:5847
11921 "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
11923 "guix environment --container --user=foo \\\n"
11924 " --expose=$HOME/test \\\n"
11925 " --expose=/tmp/target=$HOME/target\n"
11929 #: guix-git/doc/guix.texi:5852
11930 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."
11934 #: guix-git/doc/guix.texi:5853
11940 #: guix-git/doc/guix.texi:5860
11941 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}."
11945 #: guix-git/doc/guix.texi:5861
11947 msgid "--expose=@var{source}[=@var{target}]"
11951 #: guix-git/doc/guix.texi:5862
11953 msgid "--share=@var{source}[=@var{target}]"
11957 #: guix-git/doc/guix.texi:5868
11958 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."
11962 #: guix-git/doc/guix.texi:5872
11963 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:"
11967 #: guix-git/doc/guix.texi:5875
11969 msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n"
11972 #. type: Plain text
11973 #: guix-git/doc/guix.texi:5883
11974 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})."
11978 #: guix-git/doc/guix.texi:5885
11980 msgid "Invoking @command{guix pack}"
11983 #. type: Plain text
11984 #: guix-git/doc/guix.texi:5891
11985 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."
11989 #: guix-git/doc/guix.texi:5896
11990 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}."
11994 #: guix-git/doc/guix.texi:5898
12000 #: guix-git/doc/guix.texi:5899
12006 #: guix-git/doc/guix.texi:5900
12008 msgid "application bundle"
12012 #: guix-git/doc/guix.texi:5901
12014 msgid "software bundle"
12017 #. type: Plain text
12018 #: guix-git/doc/guix.texi:5910
12019 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."
12022 #. type: Plain text
12023 #: guix-git/doc/guix.texi:5913
12024 msgid "For example, to create a bundle containing Guile, Emacs, Geiser, and all their dependencies, you can run:"
12028 #: guix-git/doc/guix.texi:5918
12031 "$ guix pack guile emacs geiser\n"
12033 "/gnu/store/@dots{}-pack.tar.gz\n"
12036 #. type: Plain text
12037 #: guix-git/doc/guix.texi:5926
12038 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})."
12041 #. type: Plain text
12042 #: guix-git/doc/guix.texi:5931
12043 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:"
12047 #: guix-git/doc/guix.texi:5934
12049 msgid "guix pack -S /opt/gnu/bin=bin guile emacs geiser\n"
12052 #. type: Plain text
12053 #: guix-git/doc/guix.texi:5938
12054 msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy."
12058 #: guix-git/doc/guix.texi:5939
12060 msgid "relocatable binaries, with @command{guix pack}"
12063 #. type: Plain text
12064 #: guix-git/doc/guix.texi:5947
12065 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}."
12069 #: guix-git/doc/guix.texi:5948
12071 msgid "Docker, build an image with guix pack"
12074 #. type: Plain text
12075 #: guix-git/doc/guix.texi:5951
12076 msgid "Alternatively, you can produce a pack in the Docker image format using the following command:"
12080 #: guix-git/doc/guix.texi:5954
12082 msgid "guix pack -f docker -S /bin=bin guile guile-readline\n"
12085 #. type: Plain text
12086 #: guix-git/doc/guix.texi:5959
12087 msgid "The result is a tarball that can be passed to the @command{docker load} command, followed by @code{docker run}:"
12091 #: guix-git/doc/guix.texi:5963
12094 "docker load < @var{file}\n"
12095 "docker run -ti guile-guile-readline /bin/guile\n"
12098 #. type: Plain text
12099 #: guix-git/doc/guix.texi:5970
12100 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."
12104 #: guix-git/doc/guix.texi:5971
12106 msgid "Singularity, build an image with guix pack"
12110 #: guix-git/doc/guix.texi:5972
12112 msgid "SquashFS, build an image with guix pack"
12115 #. type: Plain text
12116 #: guix-git/doc/guix.texi:5975
12117 msgid "Yet another option is to produce a SquashFS image with the following command:"
12121 #: guix-git/doc/guix.texi:5978
12123 msgid "guix pack -f squashfs bash guile emacs geiser\n"
12126 #. type: Plain text
12127 #: guix-git/doc/guix.texi:5986
12128 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}."
12131 #. type: Plain text
12132 #: guix-git/doc/guix.texi:5988
12133 msgid "Several command-line options allow you to customize your pack:"
12137 #: guix-git/doc/guix.texi:5993
12138 msgid "Produce a pack in the given @var{format}."
12142 #: guix-git/doc/guix.texi:5995
12143 msgid "The available formats are:"
12147 #: guix-git/doc/guix.texi:5997
12153 #: guix-git/doc/guix.texi:6000
12154 msgid "This is the default format. It produces a tarball containing all the specified binaries and symlinks."
12158 #: guix-git/doc/guix.texi:6001
12164 #: guix-git/doc/guix.texi:6007
12165 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."
12169 #: guix-git/doc/guix.texi:6008
12175 #: guix-git/doc/guix.texi:6012
12176 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."
12180 #: guix-git/doc/guix.texi:6018
12181 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:"
12185 #: guix-git/doc/guix.texi:6021
12187 msgid "guix pack -f squashfs bash @dots{}\n"
12191 #: guix-git/doc/guix.texi:6026
12192 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."
12196 #: guix-git/doc/guix.texi:6029
12198 msgid "relocatable binaries"
12202 #: guix-git/doc/guix.texi:6030
12204 msgid "--relocatable"
12208 #: guix-git/doc/guix.texi:6034
12209 msgid "Produce @dfn{relocatable binaries}---i.e., binaries that can be placed anywhere in the file system hierarchy and run from there."
12213 #: guix-git/doc/guix.texi:6042
12214 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."
12218 #: guix-git/doc/guix.texi:6044
12219 msgid "For example, if you create a pack containing Bash with:"
12223 #: guix-git/doc/guix.texi:6047
12225 msgid "guix pack -RR -S /mybin=bin bash\n"
12229 #: guix-git/doc/guix.texi:6052
12230 msgid "...@: you can copy that pack to a machine that lacks Guix, and from your home directory as a normal user, run:"
12234 #: guix-git/doc/guix.texi:6056
12237 "tar xf pack.tar.gz\n"
12242 #: guix-git/doc/guix.texi:6064
12243 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."
12247 #: guix-git/doc/guix.texi:6070
12248 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."
12252 #: guix-git/doc/guix.texi:6076
12253 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:"
12257 #: guix-git/doc/guix.texi:6078 guix-git/doc/guix.texi:16223
12263 #: guix-git/doc/guix.texi:6081
12264 msgid "Try user namespaces and fall back to PRoot if user namespaces are not supported (see below)."
12268 #: guix-git/doc/guix.texi:6082
12270 msgid "performance"
12274 #: guix-git/doc/guix.texi:6085
12275 msgid "Try user namespaces and fall back to Fakechroot if user namespaces are not supported (see below)."
12279 #: guix-git/doc/guix.texi:6086
12285 #: guix-git/doc/guix.texi:6089
12286 msgid "Run the program through user namespaces and abort if they are not supported."
12290 #: guix-git/doc/guix.texi:6090
12296 #: guix-git/doc/guix.texi:6097
12297 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."
12301 #: guix-git/doc/guix.texi:6098
12307 #: guix-git/doc/guix.texi:6106
12308 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."
12312 #: guix-git/doc/guix.texi:6108
12314 msgid "GUIX_EXECUTION_ENGINE"
12318 #: guix-git/doc/guix.texi:6112
12319 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."
12323 #: guix-git/doc/guix.texi:6114
12325 msgid "entry point, for Docker images"
12329 #: guix-git/doc/guix.texi:6115
12331 msgid "--entry-point=@var{command}"
12335 #: guix-git/doc/guix.texi:6120
12336 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."
12340 #: guix-git/doc/guix.texi:6124
12341 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:"
12345 #: guix-git/doc/guix.texi:6127
12347 msgid "guix pack -f docker --entry-point=bin/guile guile\n"
12351 #: guix-git/doc/guix.texi:6131
12352 msgid "The resulting pack can easily be loaded and @code{docker run} with no extra arguments will spawn @code{bin/guile}:"
12356 #: guix-git/doc/guix.texi:6135
12359 "docker load -i pack.tar.gz\n"
12360 "docker run @var{image-id}\n"
12364 #: guix-git/doc/guix.texi:6140 guix-git/doc/guix.texi:11687
12365 #: guix-git/doc/guix.texi:12482
12366 msgid "Consider the package @var{expr} evaluates to."
12370 #: guix-git/doc/guix.texi:6144
12371 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}})."
12375 #: guix-git/doc/guix.texi:6150
12376 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."
12380 #: guix-git/doc/guix.texi:6158
12381 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."
12385 #: guix-git/doc/guix.texi:6164 guix-git/doc/guix.texi:10827
12387 msgid "--target=@var{triplet}"
12391 #: guix-git/doc/guix.texi:6165 guix-git/doc/guix.texi:6616
12392 #: guix-git/doc/guix.texi:10828
12394 msgid "cross-compilation"
12398 #: guix-git/doc/guix.texi:6169
12399 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})."
12403 #: guix-git/doc/guix.texi:6170
12405 msgid "--compression=@var{tool}"
12409 #: guix-git/doc/guix.texi:6171
12411 msgid "-C @var{tool}"
12415 #: guix-git/doc/guix.texi:6175
12416 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."
12420 #: guix-git/doc/guix.texi:6176
12422 msgid "--symlink=@var{spec}"
12426 #: guix-git/doc/guix.texi:6177
12428 msgid "-S @var{spec}"
12432 #: guix-git/doc/guix.texi:6180
12433 msgid "Add the symlinks specified by @var{spec} to the pack. This option can appear several times."
12437 #: guix-git/doc/guix.texi:6184
12438 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."
12442 #: guix-git/doc/guix.texi:6187
12443 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."
12447 #: guix-git/doc/guix.texi:6188 guix-git/doc/guix.texi:33119
12449 msgid "--save-provenance"
12453 #: guix-git/doc/guix.texi:6192
12454 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})."
12458 #: guix-git/doc/guix.texi:6198
12459 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."
12463 #: guix-git/doc/guix.texi:6204
12464 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."
12468 #: guix-git/doc/guix.texi:6207
12470 msgid "garbage collector root, for packs"
12474 #: guix-git/doc/guix.texi:6210
12475 msgid "Make @var{file} a symlink to the resulting pack, and register it as a garbage collector root."
12479 #: guix-git/doc/guix.texi:6211
12481 msgid "--localstatedir"
12485 #: guix-git/doc/guix.texi:6212
12487 msgid "--profile-name=@var{name}"
12491 #: guix-git/doc/guix.texi:6217
12492 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}."
12496 #: guix-git/doc/guix.texi:6223
12497 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."
12501 #: guix-git/doc/guix.texi:6226
12502 msgid "One use case for this is the Guix self-contained binary tarball (@pxref{Binary Installation})."
12506 #: guix-git/doc/guix.texi:6227 guix-git/doc/guix.texi:33113
12508 msgid "--derivation"
12512 #: guix-git/doc/guix.texi:6228 guix-git/doc/guix.texi:10859
12513 #: guix-git/doc/guix.texi:33114
12519 #: guix-git/doc/guix.texi:6230
12520 msgid "Print the name of the derivation that builds the pack."
12524 #: guix-git/doc/guix.texi:6234
12525 msgid "Use the bootstrap binaries to build the pack. This option is only useful to Guix developers."
12528 #. type: Plain text
12529 #: guix-git/doc/guix.texi:6239
12530 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})."
12534 #: guix-git/doc/guix.texi:6244
12540 #: guix-git/doc/guix.texi:6245
12546 #: guix-git/doc/guix.texi:6246
12548 msgid "linker wrapper"
12552 #: guix-git/doc/guix.texi:6247
12554 msgid "toolchain, for C development"
12558 #: guix-git/doc/guix.texi:6248
12560 msgid "toolchain, for Fortran development"
12563 #. type: Plain text
12564 #: guix-git/doc/guix.texi:6255
12565 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."
12568 #. type: Plain text
12569 #: guix-git/doc/guix.texi:6261
12570 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}."
12573 #. type: Plain text
12574 #: guix-git/doc/guix.texi:6265
12575 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})."
12579 #: guix-git/doc/guix.texi:6268
12581 msgid "Invoking @command{guix git authenticate}"
12584 #. type: Plain text
12585 #: guix-git/doc/guix.texi:6276
12586 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)."
12589 #. type: Plain text
12590 #: guix-git/doc/guix.texi:6281
12591 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."
12595 #: guix-git/doc/guix.texi:6286
12597 msgid "guix git authenticate @var{commit} @var{signer} [@var{options}@dots{}]\n"
12600 #. type: Plain text
12601 #: guix-git/doc/guix.texi:6295
12602 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."
12606 #: guix-git/doc/guix.texi:6297
12608 msgid "--repository=@var{directory}"
12612 #: guix-git/doc/guix.texi:6298
12614 msgid "-r @var{directory}"
12618 #: guix-git/doc/guix.texi:6301
12619 msgid "Open the Git repository in @var{directory} instead of the current directory."
12623 #: guix-git/doc/guix.texi:6302
12625 msgid "--keyring=@var{reference}"
12629 #: guix-git/doc/guix.texi:6303
12631 msgid "-k @var{reference}"
12635 #: guix-git/doc/guix.texi:6309
12636 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}."
12640 #: guix-git/doc/guix.texi:6310
12646 #: guix-git/doc/guix.texi:6312
12647 msgid "Display commit signing statistics upon completion."
12651 #: guix-git/doc/guix.texi:6313
12653 msgid "--cache-key=@var{key}"
12657 #: guix-git/doc/guix.texi:6317
12658 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."
12662 #: guix-git/doc/guix.texi:6318
12664 msgid "--historical-authorizations=@var{file}"
12668 #: guix-git/doc/guix.texi:6325
12669 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})."
12672 #. type: Plain text
12673 #: guix-git/doc/guix.texi:6338
12674 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."
12677 #. type: Plain text
12678 #: guix-git/doc/guix.texi:6344
12679 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."
12682 #. type: Plain text
12683 #: guix-git/doc/guix.texi:6353
12684 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."
12687 #. type: Plain text
12688 #: guix-git/doc/guix.texi:6356
12689 msgid "This chapter describes all these APIs in turn, starting from high-level package definitions."
12693 #: guix-git/doc/guix.texi:6369
12694 msgid "Programming Guix in Guile"
12697 #. type: Plain text
12698 #: guix-git/doc/guix.texi:6385
12699 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})."
12702 #. type: Plain text
12703 #: guix-git/doc/guix.texi:6392
12704 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."
12708 #: guix-git/doc/guix.texi:6394
12710 msgid "package module search path"
12713 #. type: Plain text
12714 #: guix-git/doc/guix.texi:6403
12715 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:"
12719 #: guix-git/doc/guix.texi:6410
12720 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."
12724 #: guix-git/doc/guix.texi:6416
12725 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."
12728 #. type: Plain text
12729 #: guix-git/doc/guix.texi:6419
12730 msgid "@env{GUIX_PACKAGE_PATH} works similarly to other search path variables:"
12734 #: guix-git/doc/guix.texi:6420
12736 msgid "{Environment Variable} GUIX_PACKAGE_PATH"
12740 #: guix-git/doc/guix.texi:6424
12741 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."
12744 #. type: Plain text
12745 #: guix-git/doc/guix.texi:6432
12746 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}."
12749 #. type: Plain text
12750 #: guix-git/doc/guix.texi:6440
12751 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:"
12755 #: guix-git/doc/guix.texi:6448
12758 "(define-module (gnu packages hello)\n"
12759 " #:use-module (guix packages)\n"
12760 " #:use-module (guix download)\n"
12761 " #:use-module (guix build-system gnu)\n"
12762 " #:use-module (guix licenses)\n"
12763 " #:use-module (gnu packages gawk))\n"
12768 #: guix-git/doc/guix.texi:6467
12771 "(define-public hello\n"
12773 " (name \"hello\")\n"
12774 " (version \"2.10\")\n"
12775 " (source (origin\n"
12776 " (method url-fetch)\n"
12777 " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
12781 " \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"))))\n"
12782 " (build-system gnu-build-system)\n"
12783 " (arguments '(#:configure-flags '(\"--enable-silent-rules\")))\n"
12784 " (inputs `((\"gawk\" ,gawk)))\n"
12785 " (synopsis \"Hello, GNU world: An example GNU package\")\n"
12786 " (description \"Guess what GNU Hello prints!\")\n"
12787 " (home-page \"https://www.gnu.org/software/hello/\")\n"
12788 " (license gpl3+)))\n"
12791 #. type: Plain text
12792 #: guix-git/doc/guix.texi:6477
12793 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\"}."
12796 #. type: Plain text
12797 #: guix-git/doc/guix.texi:6481
12798 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})."
12801 #. type: Plain text
12802 #: guix-git/doc/guix.texi:6487
12803 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})."
12806 #. type: Plain text
12807 #: guix-git/doc/guix.texi:6489
12808 msgid "There are a few points worth noting in the above package definition:"
12812 #: guix-git/doc/guix.texi:6496
12813 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."
12817 #: guix-git/doc/guix.texi:6499
12818 msgid "The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the GNU mirrors defined in @code{(guix download)}."
12822 #: guix-git/doc/guix.texi:6506
12823 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})."
12827 #: guix-git/doc/guix.texi:6507
12833 #: guix-git/doc/guix.texi:6511
12834 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."
12838 #: guix-git/doc/guix.texi:6513
12840 msgid "GNU Build System"
12844 #: guix-git/doc/guix.texi:6519
12845 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."
12849 #: guix-git/doc/guix.texi:6523
12850 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."
12854 #: guix-git/doc/guix.texi:6529
12855 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."
12859 #: guix-git/doc/guix.texi:6530 guix-git/doc/guix.texi:6533
12865 #: guix-git/doc/guix.texi:6531
12871 #: guix-git/doc/guix.texi:6532
12877 #: guix-git/doc/guix.texi:6541
12878 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})."
12882 #: guix-git/doc/guix.texi:6547
12883 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})."
12887 #: guix-git/doc/guix.texi:6553
12888 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."
12892 #: guix-git/doc/guix.texi:6554
12894 msgid "backquote (quasiquote)"
12898 #: guix-git/doc/guix.texi:6555
12904 #: guix-git/doc/guix.texi:6556
12910 #: guix-git/doc/guix.texi:6557
12912 msgid "comma (unquote)"
12916 #: guix-git/doc/guix.texi:6558
12922 #: guix-git/doc/guix.texi:6559
12928 #: guix-git/doc/guix.texi:6560
12934 #: guix-git/doc/guix.texi:6561
12936 msgid "unquote-splicing"
12940 #: guix-git/doc/guix.texi:6567
12941 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})."
12945 #: guix-git/doc/guix.texi:6571
12946 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})."
12950 #: guix-git/doc/guix.texi:6575
12951 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."
12954 #. type: Plain text
12955 #: guix-git/doc/guix.texi:6578
12956 msgid "@xref{package Reference}, for a full description of possible fields."
12959 #. type: Plain text
12960 #: guix-git/doc/guix.texi:6589
12961 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."
12965 #: guix-git/doc/guix.texi:6589
12967 msgid "GUIX_PACKAGE_PATH"
12970 #. type: Plain text
12971 #: guix-git/doc/guix.texi:6593
12972 msgid "Lastly, @pxref{Channels}, for information on how to extend the distribution by adding your own package definitions in a ``channel''."
12975 #. type: Plain text
12976 #: guix-git/doc/guix.texi:6597
12977 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})."
12980 #. type: Plain text
12981 #: guix-git/doc/guix.texi:6603
12982 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})."
12986 #: guix-git/doc/guix.texi:6604
12988 msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]"
12992 #: guix-git/doc/guix.texi:6607
12993 msgid "Return the @code{<derivation>} object of @var{package} for @var{system} (@pxref{Derivations})."
12997 #: guix-git/doc/guix.texi:6613
12998 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})."
13001 #. type: Plain text
13002 #: guix-git/doc/guix.texi:6619
13003 msgid "Similarly, it is possible to compute a derivation that cross-builds a package for some other system:"
13007 #: guix-git/doc/guix.texi:6620
13009 msgid "{Scheme Procedure} package-cross-derivation @var{store} @"
13013 #: guix-git/doc/guix.texi:6624
13014 msgid "@var{package} @var{target} [@var{system}] Return the @code{<derivation>} object of @var{package} cross-built from @var{system} to @var{target}."
13018 #: guix-git/doc/guix.texi:6628
13019 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})."
13022 #. type: Plain text
13023 #: guix-git/doc/guix.texi:6632
13024 msgid "Once you have package definitions, you can easily define @emph{variants} of those packages. @xref{Defining Package Variants}, for more on that."
13027 #. type: subsection
13028 #: guix-git/doc/guix.texi:6640
13030 msgid "@code{package} Reference"
13033 #. type: Plain text
13034 #: guix-git/doc/guix.texi:6644
13035 msgid "This section summarizes all the options available in @code{package} declarations (@pxref{Defining Packages})."
13039 #: guix-git/doc/guix.texi:6645
13041 msgid "{Data Type} package"
13045 #: guix-git/doc/guix.texi:6647
13046 msgid "This is the data type representing a package recipe."
13050 #: guix-git/doc/guix.texi:6651
13051 msgid "The name of the package, as a string."
13055 #: guix-git/doc/guix.texi:6652
13061 #: guix-git/doc/guix.texi:6654
13062 msgid "The version of the package, as a string."
13066 #: guix-git/doc/guix.texi:6655 guix-git/doc/guix.texi:11958
13067 #: guix-git/doc/guix.texi:14203 guix-git/doc/guix.texi:14706
13073 #: guix-git/doc/guix.texi:6662
13074 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}})."
13078 #: guix-git/doc/guix.texi:6663
13080 msgid "build-system"
13084 #: guix-git/doc/guix.texi:6666
13085 msgid "The build system that should be used to build the package (@pxref{Build Systems})."
13089 #: guix-git/doc/guix.texi:6667 guix-git/doc/guix.texi:16669
13091 msgid "@code{arguments} (default: @code{'()})"
13095 #: guix-git/doc/guix.texi:6670
13096 msgid "The arguments that should be passed to the build system. This is a list, typically containing sequential keyword-value pairs."
13100 #: guix-git/doc/guix.texi:6671
13102 msgid "@code{inputs} (default: @code{'()})"
13106 #: guix-git/doc/guix.texi:6672
13108 msgid "@code{native-inputs} (default: @code{'()})"
13112 #: guix-git/doc/guix.texi:6673
13114 msgid "@code{propagated-inputs} (default: @code{'()})"
13118 #: guix-git/doc/guix.texi:6674
13120 msgid "inputs, of packages"
13124 #: guix-git/doc/guix.texi:6682
13125 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:"
13129 #: guix-git/doc/guix.texi:6687
13132 "`((\"libffi\" ,libffi)\n"
13133 " (\"libunistring\" ,libunistring)\n"
13134 " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of Glib\n"
13138 #: guix-git/doc/guix.texi:6689
13140 msgid "cross compilation, package dependencies"
13144 #: guix-git/doc/guix.texi:6695
13145 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."
13149 #: guix-git/doc/guix.texi:6700
13150 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})."
13153 #. type: anchor{#1}
13154 #: guix-git/doc/guix.texi:6708
13155 msgid "package-propagated-inputs"
13159 #: guix-git/doc/guix.texi:6708
13160 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)."
13164 #: guix-git/doc/guix.texi:6712
13165 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."
13169 #: guix-git/doc/guix.texi:6719
13170 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}."
13174 #: guix-git/doc/guix.texi:6720
13176 msgid "@code{outputs} (default: @code{'(\"out\")})"
13180 #: guix-git/doc/guix.texi:6723
13181 msgid "The list of output names of the package. @xref{Packages with Multiple Outputs}, for typical uses of additional outputs."
13185 #: guix-git/doc/guix.texi:6724
13187 msgid "@code{native-search-paths} (default: @code{'()})"
13191 #: guix-git/doc/guix.texi:6725
13193 msgid "@code{search-paths} (default: @code{'()})"
13197 #: guix-git/doc/guix.texi:6728
13198 msgid "A list of @code{search-path-specification} objects describing search-path environment variables honored by the package."
13202 #: guix-git/doc/guix.texi:6729
13204 msgid "@code{replacement} (default: @code{#f})"
13208 #: guix-git/doc/guix.texi:6733
13209 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."
13213 #: guix-git/doc/guix.texi:6734 guix-git/doc/guix.texi:11950
13219 #: guix-git/doc/guix.texi:6736
13220 msgid "A one-line description of the package."
13224 #: guix-git/doc/guix.texi:6737 guix-git/doc/guix.texi:11951
13225 #: guix-git/doc/guix.texi:33811 guix-git/doc/guix.texi:33962
13227 msgid "description"
13231 #: guix-git/doc/guix.texi:6739
13232 msgid "A more elaborate description of the package."
13236 #: guix-git/doc/guix.texi:6740
13242 #: guix-git/doc/guix.texi:6741
13244 msgid "license, of packages"
13248 #: guix-git/doc/guix.texi:6744
13249 msgid "The license of the package; a value from @code{(guix licenses)}, or a list of such values."
13253 #: guix-git/doc/guix.texi:6745 guix-git/doc/guix.texi:11959
13259 #: guix-git/doc/guix.texi:6747
13260 msgid "The URL to the home-page of the package, as a string."
13264 #: guix-git/doc/guix.texi:6748
13266 msgid "@code{supported-systems} (default: @code{%supported-systems})"
13270 #: guix-git/doc/guix.texi:6751
13271 msgid "The list of systems supported by the package, as strings of the form @code{architecture-kernel}, for example @code{\"x86_64-linux\"}."
13275 #: guix-git/doc/guix.texi:6752
13277 msgid "@code{location} (default: source location of the @code{package} form)"
13281 #: guix-git/doc/guix.texi:6756
13282 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."
13286 #: guix-git/doc/guix.texi:6759
13288 msgid "{Scheme Syntax} this-package"
13292 #: guix-git/doc/guix.texi:6762
13293 msgid "When used in the @emph{lexical scope} of a package field definition, this identifier resolves to the package being defined."
13297 #: guix-git/doc/guix.texi:6765
13298 msgid "The example below shows how to add a package as a native input of itself when cross-compiling:"
13302 #: guix-git/doc/guix.texi:6770
13306 " (name \"guile\")\n"
13312 #: guix-git/doc/guix.texi:6776
13315 " ;; When cross-compiled, Guile, for example, depends on\n"
13316 " ;; a native version of itself. Add it here.\n"
13317 " (native-inputs (if (%current-target-system)\n"
13318 " `((\"self\" ,this-package))\n"
13323 #: guix-git/doc/guix.texi:6779
13324 msgid "It is an error to refer to @code{this-package} outside a package definition."
13327 #. type: Plain text
13328 #: guix-git/doc/guix.texi:6785
13329 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."
13333 #: guix-git/doc/guix.texi:6786
13335 msgid "tool chain, choosing a package's tool chain"
13339 #: guix-git/doc/guix.texi:6787
13341 msgid "{Scheme Procedure} package-with-c-toolchain @var{package} @var{toolchain}"
13345 #: guix-git/doc/guix.texi:6792
13346 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."
13350 #: guix-git/doc/guix.texi:6796
13351 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:"
13355 #: guix-git/doc/guix.texi:6800
13358 "(let ((toolchain (specification->package \"gcc-toolchain@@10\")))\n"
13359 " (package-with-c-toolchain hello `((\"toolchain\" ,toolchain))))\n"
13363 #: guix-git/doc/guix.texi:6808
13364 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."
13367 #. type: subsection
13368 #: guix-git/doc/guix.texi:6811
13370 msgid "@code{origin} Reference"
13373 #. type: Plain text
13374 #: guix-git/doc/guix.texi:6819
13375 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."
13379 #: guix-git/doc/guix.texi:6820
13381 msgid "{Data Type} origin"
13385 #: guix-git/doc/guix.texi:6822
13386 msgid "This is the data type representing a source code origin."
13390 #: guix-git/doc/guix.texi:6824 guix-git/doc/guix.texi:24843
13396 #: guix-git/doc/guix.texi:6829
13397 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."
13401 #: guix-git/doc/guix.texi:6830
13403 msgid "fixed-output derivations, for download"
13407 #: guix-git/doc/guix.texi:6831
13413 #: guix-git/doc/guix.texi:6838
13414 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})."
13418 #: guix-git/doc/guix.texi:6842
13419 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)."
13423 #: guix-git/doc/guix.texi:6843
13429 #: guix-git/doc/guix.texi:6847
13430 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."
13434 #: guix-git/doc/guix.texi:6848
13440 #: guix-git/doc/guix.texi:6851
13441 msgid "The @code{content-hash} object of the source---see below for how to use @code{content-hash}."
13445 #: guix-git/doc/guix.texi:6855
13446 msgid "You can obtain this information using @code{guix download} (@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking guix hash})."
13450 #: guix-git/doc/guix.texi:6856
13452 msgid "@code{file-name} (default: @code{#f})"
13456 #: guix-git/doc/guix.texi:6862
13457 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."
13461 #: guix-git/doc/guix.texi:6863
13463 msgid "@code{patches} (default: @code{'()})"
13467 #: guix-git/doc/guix.texi:6866
13468 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."
13472 #: guix-git/doc/guix.texi:6870
13473 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}."
13477 #: guix-git/doc/guix.texi:6871
13479 msgid "@code{snippet} (default: @code{#f})"
13483 #: guix-git/doc/guix.texi:6875
13484 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."
13488 #: guix-git/doc/guix.texi:6876
13490 msgid "@code{patch-flags} (default: @code{'(\"-p1\")})"
13494 #: guix-git/doc/guix.texi:6879
13495 msgid "A list of command-line flags that should be passed to the @code{patch} command."
13499 #: guix-git/doc/guix.texi:6880
13501 msgid "@code{patch-inputs} (default: @code{#f})"
13505 #: guix-git/doc/guix.texi:6884
13506 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."
13510 #: guix-git/doc/guix.texi:6885 guix-git/doc/guix.texi:24716
13512 msgid "@code{modules} (default: @code{'()})"
13516 #: guix-git/doc/guix.texi:6888
13517 msgid "A list of Guile modules that should be loaded during the patching process and while running the code in the @code{snippet} field."
13521 #: guix-git/doc/guix.texi:6889
13523 msgid "@code{patch-guile} (default: @code{#f})"
13527 #: guix-git/doc/guix.texi:6892
13528 msgid "The Guile package that should be used in the patching process. When this is @code{#f}, a sensible default is used."
13532 #: guix-git/doc/guix.texi:6895
13534 msgid "{Data Type} content-hash @var{value} [@var{algorithm}]"
13538 #: guix-git/doc/guix.texi:6899
13539 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}."
13543 #: guix-git/doc/guix.texi:6902
13544 msgid "@var{value} can be a literal string, in which case it is base32-decoded, or it can be a bytevector."
13548 #: guix-git/doc/guix.texi:6904
13549 msgid "The following forms are all equivalent:"
13553 #: guix-git/doc/guix.texi:6913
13556 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\")\n"
13557 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"\n"
13559 "(content-hash (base32\n"
13560 " \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"))\n"
13561 "(content-hash (base64 \"kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=\")\n"
13566 #: guix-git/doc/guix.texi:6918
13567 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}."
13570 #. type: Plain text
13571 #: guix-git/doc/guix.texi:6924
13572 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."
13576 #: guix-git/doc/guix.texi:6925
13578 msgid "{Scheme Procedure} url-fetch @var{url} @var{hash-algo} @var{hash} @"
13582 #: guix-git/doc/guix.texi:6933
13583 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."
13587 #: guix-git/doc/guix.texi:6936
13588 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}."
13592 #: guix-git/doc/guix.texi:6939
13593 msgid "Alternatively, when URL starts with @code{file://}, return the corresponding file name in the store."
13596 #. type: Plain text
13597 #: guix-git/doc/guix.texi:6945
13598 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."
13602 #: guix-git/doc/guix.texi:6946
13604 msgid "{Scheme Procedure} git-fetch @var{ref} @var{hash-algo} @var{hash}"
13608 #: guix-git/doc/guix.texi:6951
13609 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}."
13613 #: guix-git/doc/guix.texi:6953
13615 msgid "{Data Type} git-reference"
13619 #: guix-git/doc/guix.texi:6956
13620 msgid "This data type represents a Git reference for @code{git-fetch} to retrieve."
13624 #: guix-git/doc/guix.texi:6958 guix-git/doc/guix.texi:22478
13630 #: guix-git/doc/guix.texi:6960
13631 msgid "The URL of the Git repository to clone."
13635 #: guix-git/doc/guix.texi:6961
13641 #: guix-git/doc/guix.texi:6965
13642 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."
13646 #: guix-git/doc/guix.texi:6966
13648 msgid "@code{recursive?} (default: @code{#f})"
13652 #: guix-git/doc/guix.texi:6968
13653 msgid "This Boolean indicates whether to recursively fetch Git sub-modules."
13657 #: guix-git/doc/guix.texi:6972
13658 msgid "The example below denotes the @code{v2.10} tag of the GNU@tie{}Hello repository:"
13662 #: guix-git/doc/guix.texi:6977
13666 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13667 " (commit \"v2.10\"))\n"
13671 #: guix-git/doc/guix.texi:6981
13672 msgid "This is equivalent to the reference below, which explicitly names the commit:"
13676 #: guix-git/doc/guix.texi:6986
13680 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13681 " (commit \"dc7dc56a00e48fe6f231a58f6537139fe2908fb9\"))\n"
13684 #. type: Plain text
13685 #: guix-git/doc/guix.texi:6992
13686 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."
13690 #: guix-git/doc/guix.texi:6993
13692 msgid "{Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @"
13696 #: guix-git/doc/guix.texi:6999
13697 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}."
13701 #: guix-git/doc/guix.texi:7004
13703 msgid "customizing packages"
13707 #: guix-git/doc/guix.texi:7005
13709 msgid "variants, of packages"
13712 #. type: Plain text
13713 #: guix-git/doc/guix.texi:7015
13714 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!"
13718 #: guix-git/doc/guix.texi:7016
13720 msgid "inherit, for package definitions"
13723 #. type: Plain text
13724 #: guix-git/doc/guix.texi:7023
13725 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."
13728 #. type: Plain text
13729 #: guix-git/doc/guix.texi:7028
13730 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!):"
13734 #: guix-git/doc/guix.texi:7031
13737 "(use-modules (gnu packages base)) ;for 'hello'\n"
13742 #: guix-git/doc/guix.texi:7043
13745 "(define hello-2.2\n"
13747 " (inherit hello)\n"
13748 " (version \"2.2\")\n"
13749 " (source (origin\n"
13750 " (method url-fetch)\n"
13751 " (uri (string-append \"mirror://gnu/hello/hello-\" version\n"
13755 " \"0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9\"))))))\n"
13758 #. type: Plain text
13759 #: guix-git/doc/guix.texi:7052
13760 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."
13763 #. type: Plain text
13764 #: guix-git/doc/guix.texi:7058
13765 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:"
13769 #: guix-git/doc/guix.texi:7062
13772 "(use-modules (gnu packages gdb) ;for 'gdb'\n"
13773 " (srfi srfi-1)) ;for 'alist-delete'\n"
13778 #: guix-git/doc/guix.texi:7068
13781 "(define gdb-sans-guile\n"
13784 " (inputs (alist-delete \"guile\"\n"
13785 " (package-inputs gdb)))))\n"
13788 #. type: Plain text
13789 #: guix-git/doc/guix.texi:7074
13790 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})."
13793 #. type: Plain text
13794 #: guix-git/doc/guix.texi:7082
13795 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:"
13799 #: guix-git/doc/guix.texi:7093
13802 "(define (make-lua-socket name lua)\n"
13803 " ;; Return a luasocket package built with LUA.\n"
13806 " (version \"3.0\")\n"
13807 " ;; several fields omitted\n"
13809 " `((\"lua\" ,lua)))\n"
13810 " (synopsis \"Socket library for Lua\")))\n"
13815 #: guix-git/doc/guix.texi:7096
13818 "(define-public lua5.1-socket\n"
13819 " (make-lua-socket \"lua5.1-socket\" lua-5.1))\n"
13824 #: guix-git/doc/guix.texi:7099
13827 "(define-public lua5.2-socket\n"
13828 " (make-lua-socket \"lua5.2-socket\" lua-5.2))\n"
13831 #. type: Plain text
13832 #: guix-git/doc/guix.texi:7107
13833 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})."
13837 #: guix-git/doc/guix.texi:7108
13839 msgid "package transformations"
13842 #. type: Plain text
13843 #: guix-git/doc/guix.texi:7113
13844 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}):"
13848 #: guix-git/doc/guix.texi:7114
13850 msgid "{Scheme Procedure} options->transformation @var{opts}"
13854 #: guix-git/doc/guix.texi:7118
13855 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:"
13859 #: guix-git/doc/guix.texi:7122
13862 "((with-branch . \"guile-gcrypt=master\")\n"
13863 " (without-tests . \"libgcrypt\"))\n"
13867 #: guix-git/doc/guix.texi:7126
13868 msgid "Each symbol names a transformation and the corresponding string is an argument to that transformation."
13871 #. type: Plain text
13872 #: guix-git/doc/guix.texi:7129
13873 msgid "For instance, a manifest equivalent to this command:"
13877 #: guix-git/doc/guix.texi:7134
13880 "guix build guix \\\n"
13881 " --with-branch=guile-gcrypt=master \\\n"
13882 " --with-debug-info=zlib\n"
13885 #. type: Plain text
13886 #: guix-git/doc/guix.texi:7138
13887 msgid "... would look like this:"
13891 #: guix-git/doc/guix.texi:7141
13894 "(use-modules (guix transformations))\n"
13899 #: guix-git/doc/guix.texi:7147
13902 "(define transform\n"
13903 " ;; The package transformation procedure.\n"
13904 " (options->transformation\n"
13905 " '((with-branch . \"guile-gcrypt=master\")\n"
13906 " (with-debug-info . \"zlib\"))))\n"
13911 #: guix-git/doc/guix.texi:7150
13914 "(packages->manifest\n"
13915 " (list (transform (specification->package \"guix\"))))\n"
13919 #: guix-git/doc/guix.texi:7152
13921 msgid "input rewriting"
13925 #: guix-git/doc/guix.texi:7153
13927 msgid "dependency graph rewriting"
13930 #. type: Plain text
13931 #: guix-git/doc/guix.texi:7160
13932 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."
13935 #. type: Plain text
13936 #: guix-git/doc/guix.texi:7164
13937 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."
13941 #: guix-git/doc/guix.texi:7165
13943 msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @"
13947 #: guix-git/doc/guix.texi:7172
13948 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."
13952 #: guix-git/doc/guix.texi:7175
13953 msgid "Optionally, @var{rewrite-name} is a one-argument procedure that takes the name of a package and returns its new name after rewrite."
13957 #: guix-git/doc/guix.texi:7179 guix-git/doc/guix.texi:10505
13958 msgid "Consider this example:"
13962 #: guix-git/doc/guix.texi:7185
13965 "(define libressl-instead-of-openssl\n"
13966 " ;; This is a procedure to replace OPENSSL by LIBRESSL,\n"
13967 " ;; recursively.\n"
13968 " (package-input-rewriting `((,openssl . ,libressl))))\n"
13973 #: guix-git/doc/guix.texi:7188
13976 "(define git-with-libressl\n"
13977 " (libressl-instead-of-openssl git))\n"
13980 #. type: Plain text
13981 #: guix-git/doc/guix.texi:7196
13982 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}})."
13985 #. type: Plain text
13986 #: guix-git/doc/guix.texi:7199
13987 msgid "The following variant of @code{package-input-rewriting} can match packages to be replaced by name rather than by identity."
13991 #: guix-git/doc/guix.texi:7200
13993 msgid "{Scheme Procedure} package-input-rewriting/spec @var{replacements} [#:deep? #t]"
13997 #: guix-git/doc/guix.texi:7207
13998 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."
14001 #. type: Plain text
14002 #: guix-git/doc/guix.texi:7210
14003 msgid "The example above could be rewritten this way:"
14007 #: guix-git/doc/guix.texi:7215
14010 "(define libressl-instead-of-openssl\n"
14011 " ;; Replace all the packages called \"openssl\" with LibreSSL.\n"
14012 " (package-input-rewriting/spec `((\"openssl\" . ,(const libressl)))))\n"
14015 #. type: Plain text
14016 #: guix-git/doc/guix.texi:7220
14017 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."
14020 #. type: Plain text
14021 #: guix-git/doc/guix.texi:7224
14022 msgid "A more generic procedure to rewrite a package dependency graph is @code{package-mapping}: it supports arbitrary changes to nodes in the graph."
14026 #: guix-git/doc/guix.texi:7225
14028 msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}] [#:deep? #f]"
14032 #: guix-git/doc/guix.texi:7230
14033 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."
14037 #: guix-git/doc/guix.texi:7236
14039 msgid "build system"
14042 #. type: Plain text
14043 #: guix-git/doc/guix.texi:7241
14044 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."
14047 #. type: Plain text
14048 #: guix-git/doc/guix.texi:7245
14049 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."
14053 #: guix-git/doc/guix.texi:7246
14055 msgid "bag (low-level package representation)"
14058 #. type: Plain text
14059 #: guix-git/doc/guix.texi:7256
14060 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}})."
14063 #. type: Plain text
14064 #: guix-git/doc/guix.texi:7264
14065 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})."
14068 #. type: Plain text
14069 #: guix-git/doc/guix.texi:7268
14070 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."
14074 #: guix-git/doc/guix.texi:7269
14076 msgid "{Scheme Variable} gnu-build-system"
14080 #: guix-git/doc/guix.texi:7273
14081 msgid "@code{gnu-build-system} represents the GNU Build System, and variants thereof (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards})."
14085 #: guix-git/doc/guix.texi:7274 guix-git/doc/guix.texi:8200
14086 #: guix-git/doc/guix.texi:8655
14088 msgid "build phases"
14092 #: guix-git/doc/guix.texi:7281
14093 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."
14097 #: guix-git/doc/guix.texi:7288
14098 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."
14102 #: guix-git/doc/guix.texi:7292
14103 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:"
14107 #: guix-git/doc/guix.texi:7294
14113 #: guix-git/doc/guix.texi:7297
14114 msgid "This argument specifies build-side code that evaluates to an alist of build phases. @xref{Build Phases}, for more information."
14118 #: guix-git/doc/guix.texi:7298
14120 msgid "#:configure-flags"
14124 #: guix-git/doc/guix.texi:7301
14125 msgid "This is a list of flags (strings) passed to the @command{configure} script. @xref{Defining Packages}, for an example."
14129 #: guix-git/doc/guix.texi:7302
14131 msgid "#:make-flags"
14135 #: guix-git/doc/guix.texi:7306
14136 msgid "This list of strings contains flags passed as arguments to @command{make} invocations in the @code{build}, @code{check}, and @code{install} phases."
14140 #: guix-git/doc/guix.texi:7307
14142 msgid "#:out-of-source?"
14146 #: guix-git/doc/guix.texi:7310
14147 msgid "This Boolean, @code{#f} by default, indicates whether to run builds in a build directory separate from the source tree."
14151 #: guix-git/doc/guix.texi:7315
14152 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}."
14156 #: guix-git/doc/guix.texi:7316
14162 #: guix-git/doc/guix.texi:7319
14163 msgid "This Boolean, @code{#t} by default, indicates whether the @code{check} phase should run the package's test suite."
14167 #: guix-git/doc/guix.texi:7320
14169 msgid "#:test-target"
14173 #: guix-git/doc/guix.texi:7323
14174 msgid "This string, @code{\"check\"} by default, gives the name of the makefile target used by the @code{check} phase."
14178 #: guix-git/doc/guix.texi:7324
14180 msgid "#:parallel-build?"
14184 #: guix-git/doc/guix.texi:7325
14186 msgid "#:parallel-tests?"
14190 #: guix-git/doc/guix.texi:7332
14191 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}})."
14195 #: guix-git/doc/guix.texi:7333
14197 msgid "RUNPATH, validation"
14201 #: guix-git/doc/guix.texi:7334
14203 msgid "#:validate-runpath?"
14207 #: guix-git/doc/guix.texi:7338
14208 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."
14212 #: guix-git/doc/guix.texi:7346
14213 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}."
14217 #: guix-git/doc/guix.texi:7347
14219 msgid "#:substitutable?"
14223 #: guix-git/doc/guix.texi:7351
14224 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})."
14228 #: guix-git/doc/guix.texi:7352
14230 msgid "#:allowed-references"
14234 #: guix-git/doc/guix.texi:7353
14236 msgid "#:disallowed-references"
14240 #: guix-git/doc/guix.texi:7358
14241 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."
14245 #: guix-git/doc/guix.texi:7363
14246 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})."
14250 #: guix-git/doc/guix.texi:7366
14251 msgid "Most other build systems support these keyword arguments."
14254 #. type: Plain text
14255 #: guix-git/doc/guix.texi:7373
14256 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."
14260 #: guix-git/doc/guix.texi:7374
14262 msgid "{Scheme Variable} ant-build-system"
14266 #: guix-git/doc/guix.texi:7378
14267 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}."
14271 #: guix-git/doc/guix.texi:7383
14272 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."
14276 #: guix-git/doc/guix.texi:7389
14277 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''."
14281 #: guix-git/doc/guix.texi:7397
14282 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."
14286 #: guix-git/doc/guix.texi:7401
14287 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."
14291 #: guix-git/doc/guix.texi:7404
14293 msgid "{Scheme Variable} android-ndk-build-system"
14297 #: guix-git/doc/guix.texi:7405
14299 msgid "Android distribution"
14303 #: guix-git/doc/guix.texi:7406
14305 msgid "Android NDK build system"
14309 #: guix-git/doc/guix.texi:7410
14310 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."
14314 #: guix-git/doc/guix.texi:7414
14315 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."
14319 #: guix-git/doc/guix.texi:7417
14320 msgid "It's also assumed that the union of all the dependencies of a package has no conflicting files."
14324 #: guix-git/doc/guix.texi:7420
14325 msgid "For the time being, cross-compilation is not supported - so right now the libraries and header files are assumed to be host tools."
14329 #: guix-git/doc/guix.texi:7423
14331 msgid "{Scheme Variable} asdf-build-system/source"
14335 #: guix-git/doc/guix.texi:7424
14337 msgid "{Scheme Variable} asdf-build-system/sbcl"
14341 #: guix-git/doc/guix.texi:7425
14343 msgid "{Scheme Variable} asdf-build-system/ecl"
14347 #: guix-git/doc/guix.texi:7431
14348 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."
14352 #: guix-git/doc/guix.texi:7438
14353 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."
14357 #: guix-git/doc/guix.texi:7442
14358 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}."
14362 #: guix-git/doc/guix.texi:7446
14363 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."
14367 #: guix-git/doc/guix.texi:7454
14368 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."
14372 #: guix-git/doc/guix.texi:7463
14373 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."
14377 #: guix-git/doc/guix.texi:7468
14378 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."
14382 #: guix-git/doc/guix.texi:7471
14384 msgid "{Scheme Variable} cargo-build-system"
14388 #: guix-git/doc/guix.texi:7472
14390 msgid "Rust programming language"
14394 #: guix-git/doc/guix.texi:7473
14396 msgid "Cargo (Rust build system)"
14400 #: guix-git/doc/guix.texi:7477
14401 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}."
14405 #: guix-git/doc/guix.texi:7480
14406 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."
14410 #: guix-git/doc/guix.texi:7490
14411 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."
14415 #: guix-git/doc/guix.texi:7500
14416 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."
14420 #: guix-git/doc/guix.texi:7502
14422 msgid "{Scheme Variable} chicken-build-system"
14426 #: guix-git/doc/guix.texi:7507
14427 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."
14431 #: guix-git/doc/guix.texi:7510
14432 msgid "This build system adds @code{chicken} to the package inputs, as well as the packages of @code{gnu-build-system}."
14436 #: guix-git/doc/guix.texi:7514
14437 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."
14441 #: guix-git/doc/guix.texi:7516
14442 msgid "For example, if you are packaging the @code{srfi-1} egg:"
14446 #: guix-git/doc/guix.texi:7519
14448 msgid "(arguments '(#:egg-name \"srfi-1\"))\n"
14452 #: guix-git/doc/guix.texi:7524
14453 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."
14457 #: guix-git/doc/guix.texi:7526
14459 msgid "{Scheme Variable} copy-build-system"
14463 #: guix-git/doc/guix.texi:7530
14464 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."
14468 #: guix-git/doc/guix.texi:7535
14469 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}."
14473 #: guix-git/doc/guix.texi:7540
14474 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."
14478 #: guix-git/doc/guix.texi:7542
14480 msgid "When @var{source} matches a file or directory without trailing slash, install it to @var{target}."
14484 #: guix-git/doc/guix.texi:7544
14486 msgid "If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}."
14490 #: guix-git/doc/guix.texi:7545
14492 msgid "Otherwise install @var{source} as @var{target}."
14496 #: guix-git/doc/guix.texi:7548
14498 msgid "When @var{source} is a directory with a trailing slash, or when @var{filters} are used,"
14502 #: guix-git/doc/guix.texi:7551
14503 msgid "the trailing slash of @var{target} is implied with the same meaning as above."
14507 #: guix-git/doc/guix.texi:7552
14509 msgid "Without @var{filters}, install the full @var{source} @emph{content} to @var{target}."
14513 #: guix-git/doc/guix.texi:7553
14515 msgid "With @var{filters} among @code{#:include}, @code{#:include-regexp}, @code{#:exclude},"
14519 #: guix-git/doc/guix.texi:7556
14520 msgid "@code{#:exclude-regexp}, only select files are installed depending on the filters. Each filters is specified by a list of strings."
14524 #: guix-git/doc/guix.texi:7557
14526 msgid "With @code{#:include}, install all the files which the path suffix matches"
14530 #: guix-git/doc/guix.texi:7559
14531 msgid "at least one of the elements in the given list."
14535 #: guix-git/doc/guix.texi:7559
14537 msgid "With @code{#:include-regexp}, install all the files which the"
14541 #: guix-git/doc/guix.texi:7562
14542 msgid "subpaths match at least one of the regular expressions in the given list."
14546 #: guix-git/doc/guix.texi:7562
14548 msgid "The @code{#:exclude} and @code{#:exclude-regexp} filters"
14552 #: guix-git/doc/guix.texi:7567
14553 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."
14557 #: guix-git/doc/guix.texi:7571
14558 msgid "In all cases, the paths relative to @var{source} are preserved within @var{target}."
14562 #: guix-git/doc/guix.texi:7574
14567 #: guix-git/doc/guix.texi:7576
14569 msgid "@code{(\"foo/bar\" \"share/my-app/\")}: Install @file{bar} to @file{share/my-app/bar}."
14573 #: guix-git/doc/guix.texi:7577
14575 msgid "@code{(\"foo/bar\" \"share/my-app/baz\")}: Install @file{bar} to @file{share/my-app/baz}."
14579 #: guix-git/doc/guix.texi:7578
14581 msgid "@code{(\"foo/\" \"share/my-app\")}: Install the content of @file{foo} inside @file{share/my-app},"
14585 #: guix-git/doc/guix.texi:7580
14586 msgid "e.g., install @file{foo/sub/file} to @file{share/my-app/sub/file}."
14590 #: guix-git/doc/guix.texi:7580
14592 msgid "@code{(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))}: Install only @file{foo/sub/file} to"
14596 #: guix-git/doc/guix.texi:7582
14597 msgid "@file{share/my-app/sub/file}."
14601 #: guix-git/doc/guix.texi:7582
14603 msgid "@code{(\"foo/sub\" \"share/my-app\" #:include (\"file\"))}: Install @file{foo/sub/file} to"
14607 #: guix-git/doc/guix.texi:7584
14608 msgid "@file{share/my-app/file}."
14612 #: guix-git/doc/guix.texi:7588
14614 msgid "Clojure (programming language)"
14618 #: guix-git/doc/guix.texi:7589
14620 msgid "simple Clojure build system"
14624 #: guix-git/doc/guix.texi:7590
14626 msgid "{Scheme Variable} clojure-build-system"
14630 #: guix-git/doc/guix.texi:7595
14631 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."
14635 #: guix-git/doc/guix.texi:7599
14636 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."
14640 #: guix-git/doc/guix.texi:7605
14641 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."
14645 #: guix-git/doc/guix.texi:7608
14646 msgid "This build system is an extension of @code{ant-build-system}, but with the following phases changed:"
14650 #: guix-git/doc/guix.texi:7611 guix-git/doc/guix.texi:8163
14651 #: guix-git/doc/guix.texi:8210 guix-git/doc/guix.texi:8279
14652 #: guix-git/doc/guix.texi:32905
14658 #: guix-git/doc/guix.texi:7620
14659 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."
14663 #: guix-git/doc/guix.texi:7621 guix-git/doc/guix.texi:8167
14664 #: guix-git/doc/guix.texi:8284
14670 #: guix-git/doc/guix.texi:7628
14671 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."
14675 #: guix-git/doc/guix.texi:7629 guix-git/doc/guix.texi:8171
14676 #: guix-git/doc/guix.texi:8214 guix-git/doc/guix.texi:8290
14682 #: guix-git/doc/guix.texi:7631
14683 msgid "This phase installs all jars built previously."
14687 #: guix-git/doc/guix.texi:7634
14688 msgid "Apart from the above, this build system also contains an additional phase:"
14692 #: guix-git/doc/guix.texi:7637
14694 msgid "install-doc"
14698 #: guix-git/doc/guix.texi:7642
14699 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."
14703 #: guix-git/doc/guix.texi:7645
14705 msgid "{Scheme Variable} cmake-build-system"
14709 #: guix-git/doc/guix.texi:7649
14710 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}."
14714 #: guix-git/doc/guix.texi:7653
14715 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."
14719 #: guix-git/doc/guix.texi:7660
14720 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."
14724 #: guix-git/doc/guix.texi:7662
14726 msgid "{Scheme Variable} dune-build-system"
14730 #: guix-git/doc/guix.texi:7669
14731 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."
14735 #: guix-git/doc/guix.texi:7673
14736 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."
14740 #: guix-git/doc/guix.texi:7677
14741 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."
14745 #: guix-git/doc/guix.texi:7681
14746 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}."
14750 #: guix-git/doc/guix.texi:7686
14751 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}."
14755 #: guix-git/doc/guix.texi:7688
14757 msgid "{Scheme Variable} go-build-system"
14761 #: guix-git/doc/guix.texi:7693
14762 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}."
14766 #: guix-git/doc/guix.texi:7704
14767 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."
14771 #: guix-git/doc/guix.texi:7709
14772 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."
14776 #: guix-git/doc/guix.texi:7711
14778 msgid "{Scheme Variable} glib-or-gtk-build-system"
14782 #: guix-git/doc/guix.texi:7714
14783 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+."
14787 #: guix-git/doc/guix.texi:7717
14788 msgid "This build system adds the following two phases to the ones defined by @code{gnu-build-system}:"
14792 #: guix-git/doc/guix.texi:7719 guix-git/doc/guix.texi:8187
14794 msgid "glib-or-gtk-wrap"
14798 #: guix-git/doc/guix.texi:7726
14799 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."
14803 #: guix-git/doc/guix.texi:7733
14804 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+."
14808 #: guix-git/doc/guix.texi:7734 guix-git/doc/guix.texi:8191
14810 msgid "glib-or-gtk-compile-schemas"
14814 #: guix-git/doc/guix.texi:7742
14815 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."
14819 #: guix-git/doc/guix.texi:7745
14820 msgid "Both phases are executed after the @code{install} phase."
14824 #: guix-git/doc/guix.texi:7747
14826 msgid "{Scheme Variable} guile-build-system"
14830 #: guix-git/doc/guix.texi:7754
14831 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."
14835 #: guix-git/doc/guix.texi:7757
14836 msgid "This build system supports cross-compilation by using the @option{--target} option of @samp{guild compile}."
14840 #: guix-git/doc/guix.texi:7760
14841 msgid "Packages built with @code{guile-build-system} must provide a Guile package in their @code{native-inputs} field."
14845 #: guix-git/doc/guix.texi:7762
14847 msgid "{Scheme Variable} julia-build-system"
14851 #: guix-git/doc/guix.texi:7769
14852 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}."
14856 #: guix-git/doc/guix.texi:7773
14857 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)."
14861 #: guix-git/doc/guix.texi:7777
14862 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}."
14866 #: guix-git/doc/guix.texi:7782
14867 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."
14871 #: guix-git/doc/guix.texi:7786
14872 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:"
14876 #: guix-git/doc/guix.texi:7798
14879 "(add-after 'unpack 'override-binary-path\n"
14880 " (lambda* (#:key inputs #:allow-other-keys)\n"
14881 " (for-each (lambda (wrapper)\n"
14882 " (substitute* wrapper\n"
14883 " ((\"generate_wrapper_header.*\")\n"
14884 " (string-append\n"
14885 " \"generate_wrapper_header(\\\"MbedTLS\\\", \\\"\"\n"
14886 " (assoc-ref inputs \"mbedtls-apache\") \"\\\")\\n\"))))\n"
14887 " ;; There's a Julia file for each platform, override them all.\n"
14888 " (find-files \"src/wrappers/\" \"\\\\.jl$\"))))\n"
14892 #: guix-git/doc/guix.texi:7806
14893 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."
14897 #: guix-git/doc/guix.texi:7808
14899 msgid "{Scheme Variable} maven-build-system"
14903 #: guix-git/doc/guix.texi:7815
14904 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."
14908 #: guix-git/doc/guix.texi:7825
14909 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."
14913 #: guix-git/doc/guix.texi:7828
14914 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."
14918 #: guix-git/doc/guix.texi:7834
14919 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}."
14923 #: guix-git/doc/guix.texi:7840
14924 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."
14928 #: guix-git/doc/guix.texi:7843
14929 msgid "You can override the default @code{jdk} and @code{maven} packages with the corresponding argument, @code{#:jdk} and @code{#:maven}."
14933 #: guix-git/doc/guix.texi:7848
14934 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."
14938 #: guix-git/doc/guix.texi:7850
14940 msgid "{Scheme Variable} minify-build-system"
14944 #: guix-git/doc/guix.texi:7853
14945 msgid "This variable is exported by @code{(guix build-system minify)}. It implements a minification procedure for simple JavaScript packages."
14949 #: guix-git/doc/guix.texi:7859
14950 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."
14954 #: guix-git/doc/guix.texi:7863
14955 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."
14959 #: guix-git/doc/guix.texi:7865
14961 msgid "{Scheme Variable} ocaml-build-system"
14965 #: guix-git/doc/guix.texi:7871
14966 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."
14970 #: guix-git/doc/guix.texi:7881
14971 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."
14975 #: guix-git/doc/guix.texi:7886
14976 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."
14980 #: guix-git/doc/guix.texi:7890
14981 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."
14985 #: guix-git/doc/guix.texi:7898
14986 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."
14990 #: guix-git/doc/guix.texi:7906
14991 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."
14995 #: guix-git/doc/guix.texi:7908
14997 msgid "{Scheme Variable} python-build-system"
15001 #: guix-git/doc/guix.texi:7913
15002 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{}}."
15006 #: guix-git/doc/guix.texi:7917
15007 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."
15011 #: guix-git/doc/guix.texi:7923
15012 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."
15016 #: guix-git/doc/guix.texi:7928
15017 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}."
15021 #: guix-git/doc/guix.texi:7930
15023 msgid "{Scheme Variable} perl-build-system"
15027 #: guix-git/doc/guix.texi:7942
15028 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."
15032 #: guix-git/doc/guix.texi:7946
15033 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."
15037 #: guix-git/doc/guix.texi:7948
15038 msgid "Which Perl package is used can be specified with @code{#:perl}."
15042 #: guix-git/doc/guix.texi:7950
15044 msgid "{Scheme Variable} renpy-build-system"
15048 #: guix-git/doc/guix.texi:7954
15049 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."
15053 #: guix-git/doc/guix.texi:7957
15054 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."
15058 #: guix-git/doc/guix.texi:7961
15059 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}."
15063 #: guix-git/doc/guix.texi:7963
15065 msgid "{Scheme Variable} qt-build-system"
15069 #: guix-git/doc/guix.texi:7966
15070 msgid "This variable is exported by @code{(guix build-system qt)}. It is intended for use with applications using Qt or KDE."
15074 #: guix-git/doc/guix.texi:7969
15075 msgid "This build system adds the following two phases to the ones defined by @code{cmake-build-system}:"
15079 #: guix-git/doc/guix.texi:7971
15081 msgid "check-setup"
15085 #: guix-git/doc/guix.texi:7978
15086 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}."
15090 #: guix-git/doc/guix.texi:7981
15091 msgid "This phase is added before the @code{check} phase. It's a separate phase to ease adjusting if necessary."
15095 #: guix-git/doc/guix.texi:7982
15101 #: guix-git/doc/guix.texi:7988
15102 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."
15106 #: guix-git/doc/guix.texi:7994
15107 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."
15111 #: guix-git/doc/guix.texi:7996
15112 msgid "This phase is added after the @code{install} phase."
15116 #: guix-git/doc/guix.texi:7999
15118 msgid "{Scheme Variable} r-build-system"
15122 #: guix-git/doc/guix.texi:8007
15123 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}."
15127 #: guix-git/doc/guix.texi:8009
15129 msgid "{Scheme Variable} rakudo-build-system"
15133 #: guix-git/doc/guix.texi:8017
15134 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."
15138 #: guix-git/doc/guix.texi:8025
15139 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."
15143 #: guix-git/doc/guix.texi:8027
15145 msgid "{Scheme Variable} texlive-build-system"
15149 #: guix-git/doc/guix.texi:8032
15150 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."
15154 #: guix-git/doc/guix.texi:8041
15155 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."
15159 #: guix-git/doc/guix.texi:8044
15160 msgid "The @code{#:tex-directory} parameter tells the build system where to install the built files under the texmf tree."
15164 #: guix-git/doc/guix.texi:8046
15166 msgid "{Scheme Variable} ruby-build-system"
15170 #: guix-git/doc/guix.texi:8050
15171 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}."
15175 #: guix-git/doc/guix.texi:8058
15176 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."
15180 #: guix-git/doc/guix.texi:8062
15181 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."
15185 #: guix-git/doc/guix.texi:8064
15187 msgid "{Scheme Variable} waf-build-system"
15191 #: guix-git/doc/guix.texi:8070
15192 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."
15196 #: guix-git/doc/guix.texi:8074
15197 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."
15201 #: guix-git/doc/guix.texi:8076
15203 msgid "{Scheme Variable} scons-build-system"
15207 #: guix-git/doc/guix.texi:8082
15208 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."
15212 #: guix-git/doc/guix.texi:8089
15213 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."
15217 #: guix-git/doc/guix.texi:8091
15219 msgid "{Scheme Variable} haskell-build-system"
15223 #: guix-git/doc/guix.texi:8105
15224 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."
15228 #: guix-git/doc/guix.texi:8108
15229 msgid "Which Haskell compiler is used can be specified with the @code{#:haskell} parameter which defaults to @code{ghc}."
15233 #: guix-git/doc/guix.texi:8110
15235 msgid "{Scheme Variable} dub-build-system"
15239 #: guix-git/doc/guix.texi:8115
15240 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."
15244 #: guix-git/doc/guix.texi:8118
15245 msgid "Which D compiler is used can be specified with the @code{#:ldc} parameter which defaults to @code{ldc}."
15248 #. type: anchor{#1}
15249 #: guix-git/doc/guix.texi:8121
15250 msgid "emacs-build-system"
15254 #: guix-git/doc/guix.texi:8121
15256 msgid "{Scheme Variable} emacs-build-system"
15260 #: guix-git/doc/guix.texi:8125
15261 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})."
15265 #: guix-git/doc/guix.texi:8131
15266 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}."
15270 #: guix-git/doc/guix.texi:8133
15272 msgid "{Scheme Variable} font-build-system"
15276 #: guix-git/doc/guix.texi:8139
15277 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."
15281 #: guix-git/doc/guix.texi:8141
15283 msgid "{Scheme Variable} meson-build-system"
15287 #: guix-git/doc/guix.texi:8145
15288 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."
15292 #: guix-git/doc/guix.texi:8151
15293 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."
15297 #: guix-git/doc/guix.texi:8154
15298 msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed to some specific for Meson:"
15302 #: guix-git/doc/guix.texi:8157 guix-git/doc/guix.texi:8206
15303 #: guix-git/doc/guix.texi:8274
15309 #: guix-git/doc/guix.texi:8162
15310 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}."
15314 #: guix-git/doc/guix.texi:8166
15315 msgid "The phase runs @code{ninja} to build the package in parallel by default, but this can be changed with @code{#:parallel-build?}."
15319 #: guix-git/doc/guix.texi:8170
15320 msgid "The phase runs @code{ninja} with the target specified in @code{#:test-target}, which is @code{\"test\"} by default."
15324 #: guix-git/doc/guix.texi:8173
15325 msgid "The phase runs @code{ninja install} and can not be changed."
15329 #: guix-git/doc/guix.texi:8176
15330 msgid "Apart from that, the build system also adds the following phases:"
15334 #: guix-git/doc/guix.texi:8179
15336 msgid "fix-runpath"
15340 #: guix-git/doc/guix.texi:8186
15341 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."
15345 #: guix-git/doc/guix.texi:8190 guix-git/doc/guix.texi:8194
15346 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?}."
15350 #: guix-git/doc/guix.texi:8197
15352 msgid "{Scheme Variable} linux-module-build-system"
15356 #: guix-git/doc/guix.texi:8199
15357 msgid "@code{linux-module-build-system} allows building Linux kernel modules."
15361 #: guix-git/doc/guix.texi:8203
15362 msgid "This build system is an extension of @code{gnu-build-system}, but with the following phases changed:"
15366 #: guix-git/doc/guix.texi:8209
15367 msgid "This phase configures the environment so that the Linux kernel's Makefile can be used to build the external kernel module."
15371 #: guix-git/doc/guix.texi:8213
15372 msgid "This phase uses the Linux kernel's Makefile in order to build the external kernel module."
15376 #: guix-git/doc/guix.texi:8217
15377 msgid "This phase uses the Linux kernel's Makefile in order to install the external kernel module."
15381 #: guix-git/doc/guix.texi:8222
15382 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)."
15386 #: guix-git/doc/guix.texi:8224
15388 msgid "{Scheme Variable} node-build-system"
15392 #: guix-git/doc/guix.texi:8229
15393 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."
15397 #: guix-git/doc/guix.texi:8233
15398 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}."
15401 #. type: Plain text
15402 #: guix-git/doc/guix.texi:8239
15403 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."
15407 #: guix-git/doc/guix.texi:8240
15409 msgid "{Scheme Variable} trivial-build-system"
15413 #: guix-git/doc/guix.texi:8242
15414 msgid "This variable is exported by @code{(guix build-system trivial)}."
15418 #: guix-git/doc/guix.texi:8247
15419 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}})."
15423 #: guix-git/doc/guix.texi:8252
15425 msgid "build phases, for packages"
15428 #. type: Plain text
15429 #: guix-git/doc/guix.texi:8258
15430 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})."
15433 #. type: Plain text
15434 #: guix-git/doc/guix.texi:8262
15435 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:"
15439 #: guix-git/doc/guix.texi:8264
15445 #: guix-git/doc/guix.texi:8268
15446 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."
15450 #: guix-git/doc/guix.texi:8269
15452 msgid "patch-source-shebangs"
15456 #: guix-git/doc/guix.texi:8273
15457 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}."
15461 #: guix-git/doc/guix.texi:8278
15462 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."
15466 #: guix-git/doc/guix.texi:8283
15467 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}."
15471 #: guix-git/doc/guix.texi:8289
15472 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}."
15476 #: guix-git/doc/guix.texi:8292
15477 msgid "Run @code{make install} with the flags listed in @code{#:make-flags}."
15481 #: guix-git/doc/guix.texi:8293
15483 msgid "patch-shebangs"
15487 #: guix-git/doc/guix.texi:8295
15488 msgid "Patch shebangs on the installed executable files."
15492 #: guix-git/doc/guix.texi:8296
15498 #: guix-git/doc/guix.texi:8300
15499 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})."
15502 #. type: Plain text
15503 #: guix-git/doc/guix.texi:8309
15504 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})."
15507 #. type: Plain text
15508 #: guix-git/doc/guix.texi:8316
15509 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."
15513 #: guix-git/doc/guix.texi:8317
15515 msgid "%standard-phases"
15518 #. type: Plain text
15519 #: guix-git/doc/guix.texi:8323
15520 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!}:"
15524 #: guix-git/doc/guix.texi:8326
15527 ";; The build phases of 'gnu-build-system'.\n"
15532 #: guix-git/doc/guix.texi:8330
15535 "(define* (unpack #:key source #:allow-other-keys)\n"
15536 " ;; Extract the source tarball.\n"
15537 " (invoke \"tar\" \"xvf\" source))\n"
15542 #: guix-git/doc/guix.texi:8336
15545 "(define* (configure #:key outputs #:allow-other-keys)\n"
15546 " ;; Run the 'configure' script. Install to output \"out\".\n"
15547 " (let ((out (assoc-ref outputs \"out\")))\n"
15548 " (invoke \"./configure\"\n"
15549 " (string-append \"--prefix=\" out))))\n"
15554 #: guix-git/doc/guix.texi:8340
15557 "(define* (build #:allow-other-keys)\n"
15559 " (invoke \"make\"))\n"
15564 #: guix-git/doc/guix.texi:8347
15567 "(define* (check #:key (test-target \"check\") (tests? #true)\n"
15568 " #:allow-other-keys)\n"
15569 " ;; Run the test suite.\n"
15571 " (invoke \"make\" test-target)\n"
15572 " (display \"test suite not run\\n\")))\n"
15577 #: guix-git/doc/guix.texi:8351
15580 "(define* (install #:allow-other-keys)\n"
15581 " ;; Install files to the prefix 'configure' specified.\n"
15582 " (invoke \"make\" \"install\"))\n"
15587 #: guix-git/doc/guix.texi:8360
15590 "(define %standard-phases\n"
15591 " ;; The list of standard phases (quite a few are omitted\n"
15592 " ;; for brevity). Each element is a symbol/procedure pair.\n"
15593 " (list (cons 'unpack unpack)\n"
15594 " (cons 'configure configure)\n"
15595 " (cons 'build build)\n"
15596 " (cons 'check check)\n"
15597 " (cons 'install install)))\n"
15600 #. type: Plain text
15601 #: guix-git/doc/guix.texi:8370
15602 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."
15605 #. type: Plain text
15606 #: guix-git/doc/guix.texi:8376
15607 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})."
15610 #. type: Plain text
15611 #: guix-git/doc/guix.texi:8392
15612 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."
15616 #: guix-git/doc/guix.texi:8393
15618 msgid "build phases, customizing"
15621 #. type: Plain text
15622 #: guix-git/doc/guix.texi:8402
15623 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}})."
15626 #. type: Plain text
15627 #: guix-git/doc/guix.texi:8407
15628 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}:"
15632 #: guix-git/doc/guix.texi:8427
15635 "(define-public example\n"
15637 " (name \"example\")\n"
15638 " ;; other fields omitted\n"
15639 " (build-system gnu-build-system)\n"
15641 " '(#:phases (modify-phases %standard-phases\n"
15642 " (delete 'configure)\n"
15643 " (add-before 'build 'set-prefix-in-makefile\n"
15644 " (lambda* (#:key outputs #:allow-other-keys)\n"
15645 " ;; Modify the makefile so that its\n"
15646 " ;; 'PREFIX' variable points to \"out\".\n"
15647 " (let ((out (assoc-ref outputs \"out\")))\n"
15648 " (substitute* \"Makefile\"\n"
15649 " ((\"PREFIX =.*\")\n"
15650 " (string-append \"PREFIX = \"\n"
15651 " out \"\\n\")))\n"
15655 #. type: Plain text
15656 #: guix-git/doc/guix.texi:8433
15657 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}."
15661 #: guix-git/doc/guix.texi:8434 guix-git/doc/guix.texi:9407
15663 msgid "code staging"
15667 #: guix-git/doc/guix.texi:8435 guix-git/doc/guix.texi:9408
15669 msgid "staging, of code"
15672 #. type: Plain text
15673 #: guix-git/doc/guix.texi:8442
15674 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."
15677 #. type: Plain text
15678 #: guix-git/doc/guix.texi:8452
15679 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."
15682 #. type: Plain text
15683 #: guix-git/doc/guix.texi:8456
15684 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."
15687 #. type: Plain text
15688 #: guix-git/doc/guix.texi:8461
15689 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}):"
15693 #: guix-git/doc/guix.texi:8468
15696 "(with-imported-modules '((guix build utils)) ;import it\n"
15697 " (computed-file \"empty-tree\"\n"
15699 " ;; Put it in scope.\n"
15700 " (use-modules (guix build utils))\n"
15705 #: guix-git/doc/guix.texi:8471
15708 " ;; Happily use its 'mkdir-p' procedure.\n"
15709 " (mkdir-p (string-append #$output \"/a/b/c\")))))\n"
15712 #. type: Plain text
15713 #: guix-git/doc/guix.texi:8475
15714 msgid "The remainder of this section is the reference for most of the utility procedures provided by @code{(guix build utils)}."
15717 #. type: subsection
15718 #: guix-git/doc/guix.texi:8478
15720 msgid "Dealing with Store File Names"
15723 #. type: Plain text
15724 #: guix-git/doc/guix.texi:8481
15725 msgid "This section documents procedures that deal with store file names."
15729 #: guix-git/doc/guix.texi:8482
15731 msgid "{Scheme Procedure} %store-directory"
15735 #: guix-git/doc/guix.texi:8484
15736 msgid "Return the directory name of the store."
15740 #: guix-git/doc/guix.texi:8486
15742 msgid "{Scheme Procedure} store-file-name? @var{file}"
15746 #: guix-git/doc/guix.texi:8488
15747 msgid "Return true if @var{file} is in the store."
15751 #: guix-git/doc/guix.texi:8490
15753 msgid "{Scheme Procedure} strip-store-file-name @var{file}"
15757 #: guix-git/doc/guix.texi:8493
15758 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."
15762 #: guix-git/doc/guix.texi:8495
15764 msgid "{Scheme Procedure} package-name->name+version @var{name}"
15768 #: guix-git/doc/guix.texi:8500
15769 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."
15772 #. type: subsection
15773 #: guix-git/doc/guix.texi:8502
15778 #. type: Plain text
15779 #: guix-git/doc/guix.texi:8505
15780 msgid "The procedures below deal with files and file types."
15784 #: guix-git/doc/guix.texi:8506
15786 msgid "{Scheme Procedure} directory-exists? @var{dir}"
15790 #: guix-git/doc/guix.texi:8508
15791 msgid "Return @code{#t} if @var{dir} exists and is a directory."
15795 #: guix-git/doc/guix.texi:8510
15797 msgid "{Scheme Procedure} executable-file? @var{file}"
15801 #: guix-git/doc/guix.texi:8512
15802 msgid "Return @code{#t} if @var{file} exists and is executable."
15806 #: guix-git/doc/guix.texi:8514
15808 msgid "{Scheme Procedure} symbolic-link? @var{file}"
15812 #: guix-git/doc/guix.texi:8516
15813 msgid "Return @code{#t} if @var{file} is a symbolic link (aka. a ``symlink'')."
15817 #: guix-git/doc/guix.texi:8518
15819 msgid "{Scheme Procedure} elf-file? @var{file}"
15823 #: guix-git/doc/guix.texi:8519
15825 msgid "{Scheme Procedure} ar-file? @var{file}"
15829 #: guix-git/doc/guix.texi:8520
15831 msgid "{Scheme Procedure} gzip-file? @var{file}"
15835 #: guix-git/doc/guix.texi:8523
15836 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."
15840 #: guix-git/doc/guix.texi:8525
15842 msgid "{Scheme Procedure} reset-gzip-timestamp @var{file} [#:keep-mtime? #t]"
15846 #: guix-git/doc/guix.texi:8529
15847 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."
15850 #. type: subsection
15851 #: guix-git/doc/guix.texi:8531
15853 msgid "File Manipulation"
15856 #. type: Plain text
15857 #: guix-git/doc/guix.texi:8538
15858 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})."
15862 #: guix-git/doc/guix.texi:8539
15864 msgid "{Scheme Syntax} with-directory-excursion @var{directory} @var{body}@dots{}"
15868 #: guix-git/doc/guix.texi:8541
15869 msgid "Run @var{body} with @var{directory} as the process's current directory."
15873 #: guix-git/doc/guix.texi:8548
15874 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."
15878 #: guix-git/doc/guix.texi:8550
15880 msgid "{Scheme Procedure} mkdir-p @var{dir}"
15884 #: guix-git/doc/guix.texi:8552
15885 msgid "Create directory @var{dir} and all its ancestors."
15889 #: guix-git/doc/guix.texi:8554
15891 msgid "{Scheme Procedure} install-file @var{file} @var{directory}"
15895 #: guix-git/doc/guix.texi:8557
15896 msgid "Create @var{directory} if it does not exist and copy @var{file} in there under the same name."
15900 #: guix-git/doc/guix.texi:8559
15902 msgid "{Scheme Procedure} make-file-writable @var{file}"
15906 #: guix-git/doc/guix.texi:8561
15907 msgid "Make @var{file} writable for its owner."
15911 #: guix-git/doc/guix.texi:8563
15913 msgid "{Scheme Procedure} copy-recursively @var{source} @var{destination} @"
15917 #: guix-git/doc/guix.texi:8570
15918 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."
15922 #: guix-git/doc/guix.texi:8572
15924 msgid "{Scheme Procedure} delete-file-recursively @var{dir} @"
15928 #: guix-git/doc/guix.texi:8577
15929 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."
15933 #: guix-git/doc/guix.texi:8579
15935 msgid "{Scheme Syntax} substitute* @var{file} @"
15939 #: guix-git/doc/guix.texi:8584
15940 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:"
15944 #: guix-git/doc/guix.texi:8591
15947 "(substitute* file\n"
15949 " \"good morning\\n\")\n"
15950 " ((\"foo([a-z]+)bar(.*)$\" all letters end)\n"
15951 " (string-append \"baz\" letter end)))\n"
15955 #: guix-git/doc/guix.texi:8597
15956 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."
15960 #: guix-git/doc/guix.texi:8600
15961 msgid "When one of the @var{match-var} is @code{_}, no variable is bound to the corresponding match substring."
15965 #: guix-git/doc/guix.texi:8603
15966 msgid "Alternatively, @var{file} may be a list of file names, in which case they are all subject to the substitutions."
15970 #: guix-git/doc/guix.texi:8606
15971 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."
15974 #. type: subsection
15975 #: guix-git/doc/guix.texi:8608
15977 msgid "File Search"
15981 #: guix-git/doc/guix.texi:8610
15983 msgid "file, searching"
15986 #. type: Plain text
15987 #: guix-git/doc/guix.texi:8612
15988 msgid "This section documents procedures to search and filter files."
15992 #: guix-git/doc/guix.texi:8613
15994 msgid "{Scheme Procedure} file-name-predicate @var{regexp}"
15998 #: guix-git/doc/guix.texi:8616
15999 msgid "Return a predicate that returns true when passed a file name whose base name matches @var{regexp}."
16003 #: guix-git/doc/guix.texi:8618
16005 msgid "{Scheme Procedure} find-files @var{dir} [@var{pred}] @"
16009 #: guix-git/doc/guix.texi:8629
16010 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."
16013 #. type: Plain text
16014 #: guix-git/doc/guix.texi:8633
16015 msgid "Here are a few examples where we assume that the current directory is the root of the Guix source tree:"
16019 #: guix-git/doc/guix.texi:8638
16022 ";; List all the regular files in the current directory.\n"
16023 "(find-files \".\")\n"
16024 "@result{} (\"./.dir-locals.el\" \"./.gitignore\" @dots{})\n"
16029 #: guix-git/doc/guix.texi:8642
16032 ";; List all the .scm files under gnu/services.\n"
16033 "(find-files \"gnu/services\" \"\\\\.scm$\")\n"
16034 "@result{} (\"gnu/services/admin.scm\" \"gnu/services/audio.scm\" @dots{})\n"
16039 #: guix-git/doc/guix.texi:8646
16042 ";; List ar files in the current directory.\n"
16043 "(find-files \".\" (lambda (file stat) (ar-file? file)))\n"
16044 "@result{} (\"./libformat.a\" \"./libstore.a\" @dots{})\n"
16048 #: guix-git/doc/guix.texi:8648
16050 msgid "{Scheme Procedure} which @var{program}"
16054 #: guix-git/doc/guix.texi:8651
16055 msgid "Return the complete file name for @var{program} as found in @code{$PATH}, or @code{#f} if @var{program} could not be found."
16058 #. type: Plain text
16059 #: guix-git/doc/guix.texi:8662
16060 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})."
16063 #. type: Plain text
16064 #: guix-git/doc/guix.texi:8666
16065 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."
16069 #: guix-git/doc/guix.texi:8667
16071 msgid "build phases, modifying"
16075 #: guix-git/doc/guix.texi:8668
16077 msgid "{Scheme Syntax} modify-phases @var{phases} @var{clause}@dots{}"
16081 #: guix-git/doc/guix.texi:8671
16082 msgid "Modify @var{phases} sequentially as per each @var{clause}, which may have one of the following forms:"
16086 #: guix-git/doc/guix.texi:8677
16089 "(delete @var{old-phase-name})\n"
16090 "(replace @var{old-phase-name} @var{new-phase})\n"
16091 "(add-before @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
16092 "(add-after @var{old-phase-name} @var{new-phase-name} @var{new-phase})\n"
16096 #: guix-git/doc/guix.texi:8681
16097 msgid "Where every @var{phase-name} above is an expression evaluating to a symbol, and @var{new-phase} an expression evaluating to a procedure."
16100 #. type: Plain text
16101 #: guix-git/doc/guix.texi:8692
16102 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:"
16106 #: guix-git/doc/guix.texi:8706
16109 "(modify-phases %standard-phases\n"
16110 " (add-after 'install 'fix-egrep-and-fgrep\n"
16111 " ;; Patch 'egrep' and 'fgrep' to execute 'grep' via its\n"
16112 " ;; absolute file name instead of searching for it in $PATH.\n"
16113 " (lambda* (#:key outputs #:allow-other-keys)\n"
16114 " (let* ((out (assoc-ref outputs \"out\"))\n"
16115 " (bin (string-append out \"/bin\")))\n"
16116 " (substitute* (list (string-append bin \"/egrep\")\n"
16117 " (string-append bin \"/fgrep\"))\n"
16118 " ((\"^exec grep\")\n"
16119 " (string-append \"exec \" bin \"/grep\")))\n"
16123 #. type: Plain text
16124 #: guix-git/doc/guix.texi:8713
16125 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:"
16129 #: guix-git/doc/guix.texi:8726
16132 "(modify-phases %standard-phases\n"
16133 " (delete 'configure) ;no 'configure' script\n"
16134 " (replace 'install\n"
16135 " (lambda* (#:key outputs #:allow-other-keys)\n"
16136 " ;; The package's Makefile doesn't provide an \"install\"\n"
16137 " ;; rule so do it by ourselves.\n"
16138 " (let ((bin (string-append (assoc-ref outputs \"out\")\n"
16140 " (install-file \"footswitch\" bin)\n"
16141 " (install-file \"scythe\" bin)\n"
16146 #: guix-git/doc/guix.texi:8734
16148 msgid "store items"
16152 #: guix-git/doc/guix.texi:8735
16154 msgid "store paths"
16157 #. type: Plain text
16158 #: guix-git/doc/guix.texi:8746
16159 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}."
16162 #. type: Plain text
16163 #: guix-git/doc/guix.texi:8751
16164 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."
16168 #: guix-git/doc/guix.texi:8756
16169 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})."
16173 #: guix-git/doc/guix.texi:8760
16174 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."
16177 #. type: Plain text
16178 #: guix-git/doc/guix.texi:8767
16179 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."
16183 #: guix-git/doc/guix.texi:8768
16185 msgid "{Environment Variable} GUIX_DAEMON_SOCKET"
16189 #: guix-git/doc/guix.texi:8773
16190 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:"
16194 #: guix-git/doc/guix.texi:8775 guix-git/doc/guix.texi:24475
16200 #: guix-git/doc/guix.texi:8776
16206 #: guix-git/doc/guix.texi:8780
16207 msgid "These are for Unix-domain sockets. @code{file:///var/guix/daemon-socket/socket} is equivalent to @file{/var/guix/daemon-socket/socket}."
16211 #: guix-git/doc/guix.texi:8781
16217 #: guix-git/doc/guix.texi:8789
16218 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):"
16222 #: guix-git/doc/guix.texi:8792
16224 msgid "guix://master.guix.example.org:1234\n"
16228 #: guix-git/doc/guix.texi:8797
16229 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}."
16233 #: guix-git/doc/guix.texi:8801
16234 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}})."
16238 #: guix-git/doc/guix.texi:8802
16244 #: guix-git/doc/guix.texi:8803
16246 msgid "SSH access to build daemons"
16250 #: guix-git/doc/guix.texi:8809
16251 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:"
16255 #: guix-git/doc/guix.texi:8812
16257 msgid "ssh://charlie@@guix.example.org:22\n"
16261 #: guix-git/doc/guix.texi:8816
16262 msgid "As for @command{guix copy}, the usual OpenSSH client configuration files are honored (@pxref{Invoking guix copy})."
16266 #: guix-git/doc/guix.texi:8819
16267 msgid "Additional URI schemes may be supported in the future."
16271 #: guix-git/doc/guix.texi:8826
16272 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})."
16276 #: guix-git/doc/guix.texi:8829
16278 msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]"
16282 #: guix-git/doc/guix.texi:8834
16283 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."
16287 #: guix-git/doc/guix.texi:8837
16288 msgid "@var{file} defaults to @code{%default-socket-path}, which is the normal location given the options that were passed to @command{configure}."
16292 #: guix-git/doc/guix.texi:8839
16294 msgid "{Scheme Procedure} close-connection @var{server}"
16298 #: guix-git/doc/guix.texi:8841
16299 msgid "Close the connection to @var{server}."
16303 #: guix-git/doc/guix.texi:8843
16305 msgid "{Scheme Variable} current-build-output-port"
16309 #: guix-git/doc/guix.texi:8846
16310 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."
16313 #. type: Plain text
16314 #: guix-git/doc/guix.texi:8850
16315 msgid "Procedures that make RPCs all take a server object as their first argument."
16319 #: guix-git/doc/guix.texi:8851
16321 msgid "{Scheme Procedure} valid-path? @var{server} @var{path}"
16325 #: guix-git/doc/guix.texi:8852
16327 msgid "invalid store items"
16331 #: guix-git/doc/guix.texi:8857
16332 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)."
16336 #: guix-git/doc/guix.texi:8860
16337 msgid "A @code{&store-protocol-error} condition is raised if @var{path} is not prefixed by the store directory (@file{/gnu/store})."
16341 #: guix-git/doc/guix.texi:8862
16343 msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]"
16347 #: guix-git/doc/guix.texi:8866
16348 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."
16352 #: guix-git/doc/guix.texi:8868
16354 msgid "{Scheme Procedure} build-derivations @var{store} @var{derivations} @"
16358 #: guix-git/doc/guix.texi:8873
16359 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."
16362 #. type: Plain text
16363 #: guix-git/doc/guix.texi:8879
16364 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})."
16368 #: guix-git/doc/guix.texi:8882
16369 msgid "This section is currently incomplete."
16373 #: guix-git/doc/guix.texi:8886
16375 msgid "derivations"
16378 #. type: Plain text
16379 #: guix-git/doc/guix.texi:8890
16380 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:"
16384 #: guix-git/doc/guix.texi:8895
16385 msgid "The outputs of the derivation---derivations produce at least one file or directory in the store, but may produce more."
16389 #: guix-git/doc/guix.texi:8897
16391 msgid "build-time dependencies"
16395 #: guix-git/doc/guix.texi:8898
16397 msgid "dependencies, build-time"
16401 #: guix-git/doc/guix.texi:8902
16402 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.)."
16406 #: guix-git/doc/guix.texi:8905
16407 msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}."
16411 #: guix-git/doc/guix.texi:8909
16412 msgid "The file name of a build script in the store, along with the arguments to be passed."
16416 #: guix-git/doc/guix.texi:8912
16417 msgid "A list of environment variables to be defined."
16421 #: guix-git/doc/guix.texi:8915
16423 msgid "derivation path"
16426 #. type: Plain text
16427 #: guix-git/doc/guix.texi:8923
16428 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})."
16432 #: guix-git/doc/guix.texi:8924
16434 msgid "fixed-output derivations"
16437 #. type: Plain text
16438 #: guix-git/doc/guix.texi:8931
16439 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."
16443 #: guix-git/doc/guix.texi:8932 guix-git/doc/guix.texi:12392
16449 #: guix-git/doc/guix.texi:8933
16451 msgid "run-time dependencies"
16455 #: guix-git/doc/guix.texi:8934
16457 msgid "dependencies, run-time"
16460 #. type: Plain text
16461 #: guix-git/doc/guix.texi:8941
16462 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."
16465 #. type: Plain text
16466 #: guix-git/doc/guix.texi:8946
16467 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:"
16471 #: guix-git/doc/guix.texi:8947
16473 msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
16477 #: guix-git/doc/guix.texi:8956
16478 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."
16482 #: guix-git/doc/guix.texi:8963
16483 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."
16487 #: guix-git/doc/guix.texi:8968
16488 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."
16492 #: guix-git/doc/guix.texi:8973
16493 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."
16497 #: guix-git/doc/guix.texi:8980
16498 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."
16502 #: guix-git/doc/guix.texi:8985
16503 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."
16507 #: guix-git/doc/guix.texi:8990
16508 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."
16512 #: guix-git/doc/guix.texi:8993
16513 msgid "@var{properties} must be an association list describing ``properties'' of the derivation. It is kept as-is, uninterpreted, in the derivation."
16516 #. type: Plain text
16517 #: guix-git/doc/guix.texi:8999
16518 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:"
16522 #: guix-git/doc/guix.texi:9004
16525 "(use-modules (guix utils)\n"
16527 " (guix derivations))\n"
16532 #: guix-git/doc/guix.texi:9013
16535 "(let ((builder ; add the Bash script to the store\n"
16536 " (add-text-to-store store \"my-builder.sh\"\n"
16537 " \"echo hello world > $out\\n\" '())))\n"
16538 " (derivation store \"foo\"\n"
16539 " bash `(\"-e\" ,builder)\n"
16540 " #:inputs `((,bash) (,builder))\n"
16541 " #:env-vars '((\"HOME\" . \"/homeless\"))))\n"
16542 "@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo>\n"
16545 #. type: Plain text
16546 #: guix-git/doc/guix.texi:9020
16547 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}."
16550 #. type: Plain text
16551 #: guix-git/doc/guix.texi:9025
16552 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}."
16556 #: guix-git/doc/guix.texi:9026
16558 msgid "{Scheme Procedure} build-expression->derivation @var{store} @"
16562 #: guix-git/doc/guix.texi:9042
16563 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))}."
16567 #: guix-git/doc/guix.texi:9050
16568 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."
16572 #: guix-git/doc/guix.texi:9054
16573 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."
16577 #: guix-git/doc/guix.texi:9059
16578 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?}."
16581 #. type: Plain text
16582 #: guix-git/doc/guix.texi:9064
16583 msgid "Here's an example of a single-output derivation that creates a directory containing one file:"
16587 #: guix-git/doc/guix.texi:9072
16590 "(let ((builder '(let ((out (assoc-ref %outputs \"out\")))\n"
16591 " (mkdir out) ; create /gnu/store/@dots{}-goo\n"
16592 " (call-with-output-file (string-append out \"/test\")\n"
16594 " (display '(hello guix) p))))))\n"
16595 " (build-expression->derivation store \"goo\" builder))\n"
16600 #: guix-git/doc/guix.texi:9074
16602 msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n"
16606 #: guix-git/doc/guix.texi:9080
16611 #. type: Plain text
16612 #: guix-git/doc/guix.texi:9086
16613 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."
16616 #. type: Plain text
16617 #: guix-git/doc/guix.texi:9092
16618 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."
16622 #: guix-git/doc/guix.texi:9093
16624 msgid "monadic values"
16628 #: guix-git/doc/guix.texi:9094
16630 msgid "monadic functions"
16633 #. type: Plain text
16634 #: guix-git/doc/guix.texi:9104
16635 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}."
16638 #. type: Plain text
16639 #: guix-git/doc/guix.texi:9106
16640 msgid "Consider this ``normal'' procedure:"
16644 #: guix-git/doc/guix.texi:9115
16647 "(define (sh-symlink store)\n"
16648 " ;; Return a derivation that symlinks the 'bash' executable.\n"
16649 " (let* ((drv (package-derivation store bash))\n"
16650 " (out (derivation->output-path drv))\n"
16651 " (sh (string-append out \"/bin/bash\")))\n"
16652 " (build-expression->derivation store \"sh\"\n"
16653 " `(symlink ,sh %output))))\n"
16656 #. type: Plain text
16657 #: guix-git/doc/guix.texi:9119
16658 msgid "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a monadic function:"
16662 #: guix-git/doc/guix.texi:9127
16665 "(define (sh-symlink)\n"
16666 " ;; Same, but return a monadic value.\n"
16667 " (mlet %store-monad ((drv (package->derivation bash)))\n"
16668 " (gexp->derivation \"sh\"\n"
16669 " #~(symlink (string-append #$drv \"/bin/bash\")\n"
16673 #. type: Plain text
16674 #: guix-git/doc/guix.texi:9134
16675 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}."
16678 #. type: Plain text
16679 #: guix-git/doc/guix.texi:9138
16680 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}):"
16684 #: guix-git/doc/guix.texi:9144
16687 "(define (sh-symlink)\n"
16688 " (gexp->derivation \"sh\"\n"
16689 " #~(symlink (string-append #$bash \"/bin/bash\")\n"
16693 #. type: Plain text
16694 #: guix-git/doc/guix.texi:9153
16695 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}:"
16699 #: guix-git/doc/guix.texi:9157
16702 "(run-with-store (open-connection) (sh-symlink))\n"
16703 "@result{} /gnu/store/...-sh-symlink\n"
16706 #. type: Plain text
16707 #: guix-git/doc/guix.texi:9163
16708 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:"
16712 #: guix-git/doc/guix.texi:9167
16715 "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n"
16716 "$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
16719 #. type: Plain text
16720 #: guix-git/doc/guix.texi:9171
16721 msgid "The latter enters a recursive REPL, where all the return values are automatically run through the store:"
16725 #: guix-git/doc/guix.texi:9180
16728 "scheme@@(guile-user)> ,enter-store-monad\n"
16729 "store-monad@@(guile-user) [1]> (package->derivation hello)\n"
16730 "$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
16731 "store-monad@@(guile-user) [1]> (text-file \"foo\" \"Hello!\")\n"
16732 "$3 = \"/gnu/store/@dots{}-foo\"\n"
16733 "store-monad@@(guile-user) [1]> ,q\n"
16734 "scheme@@(guile-user)>\n"
16737 #. type: Plain text
16738 #: guix-git/doc/guix.texi:9185
16739 msgid "Note that non-monadic values cannot be returned in the @code{store-monad} REPL."
16742 #. type: Plain text
16743 #: guix-git/doc/guix.texi:9188
16744 msgid "The main syntactic forms to deal with monads in general are provided by the @code{(guix monads)} module and are described below."
16748 #: guix-git/doc/guix.texi:9189
16750 msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..."
16754 #: guix-git/doc/guix.texi:9192
16755 msgid "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in @var{monad}."
16759 #: guix-git/doc/guix.texi:9194
16761 msgid "{Scheme Syntax} return @var{val}"
16765 #: guix-git/doc/guix.texi:9196
16766 msgid "Return a monadic value that encapsulates @var{val}."
16770 #: guix-git/doc/guix.texi:9198
16772 msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..."
16776 #: guix-git/doc/guix.texi:9205
16777 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:"
16781 #: guix-git/doc/guix.texi:9213
16784 "(run-with-state\n"
16785 " (with-monad %state-monad\n"
16786 " (>>= (return 1)\n"
16787 " (lambda (x) (return (+ 1 x)))\n"
16788 " (lambda (x) (return (* 2 x)))))\n"
16794 #: guix-git/doc/guix.texi:9216
16798 "@result{} some-state\n"
16802 #: guix-git/doc/guix.texi:9219
16804 msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @"
16808 #: guix-git/doc/guix.texi:9221
16809 msgid "@var{body} ..."
16813 #: guix-git/doc/guix.texi:9221
16815 msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @"
16819 #: guix-git/doc/guix.texi:9233
16820 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}."
16824 #: guix-git/doc/guix.texi:9236
16825 msgid "@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual})."
16829 #: guix-git/doc/guix.texi:9238
16831 msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..."
16835 #: guix-git/doc/guix.texi:9242
16836 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."
16840 #: guix-git/doc/guix.texi:9246
16841 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."
16845 #: guix-git/doc/guix.texi:9248
16847 msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..."
16851 #: guix-git/doc/guix.texi:9253
16852 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."
16856 #: guix-git/doc/guix.texi:9255
16858 msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..."
16862 #: guix-git/doc/guix.texi:9260
16863 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."
16867 #: guix-git/doc/guix.texi:9262
16869 msgid "state monad"
16872 #. type: Plain text
16873 #: guix-git/doc/guix.texi:9266
16874 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."
16878 #: guix-git/doc/guix.texi:9267
16880 msgid "{Scheme Variable} %state-monad"
16884 #: guix-git/doc/guix.texi:9270
16885 msgid "The state monad. Procedures in the state monad can access and change the state that is threaded."
16889 #: guix-git/doc/guix.texi:9274
16890 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:"
16894 #: guix-git/doc/guix.texi:9281
16897 "(define (square x)\n"
16898 " (mlet %state-monad ((count (current-state)))\n"
16899 " (mbegin %state-monad\n"
16900 " (set-current-state (+ 1 count))\n"
16901 " (return (* x x)))))\n"
16906 #: guix-git/doc/guix.texi:9285
16909 "(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n"
16910 "@result{} (0 1 4)\n"
16915 #: guix-git/doc/guix.texi:9289
16916 msgid "When ``run'' through @code{%state-monad}, we obtain that additional state value, which is the number of @code{square} calls."
16920 #: guix-git/doc/guix.texi:9291
16922 msgid "{Monadic Procedure} current-state"
16926 #: guix-git/doc/guix.texi:9293
16927 msgid "Return the current state as a monadic value."
16931 #: guix-git/doc/guix.texi:9295
16933 msgid "{Monadic Procedure} set-current-state @var{value}"
16937 #: guix-git/doc/guix.texi:9298
16938 msgid "Set the current state to @var{value} and return the previous state as a monadic value."
16942 #: guix-git/doc/guix.texi:9300
16944 msgid "{Monadic Procedure} state-push @var{value}"
16948 #: guix-git/doc/guix.texi:9303
16949 msgid "Push @var{value} to the current state, which is assumed to be a list, and return the previous state as a monadic value."
16953 #: guix-git/doc/guix.texi:9305
16955 msgid "{Monadic Procedure} state-pop"
16959 #: guix-git/doc/guix.texi:9308
16960 msgid "Pop a value from the current state and return it as a monadic value. The state is assumed to be a list."
16964 #: guix-git/doc/guix.texi:9310
16966 msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]"
16970 #: guix-git/doc/guix.texi:9313
16971 msgid "Run monadic value @var{mval} starting with @var{state} as the initial state. Return two values: the resulting value, and the resulting state."
16974 #. type: Plain text
16975 #: guix-git/doc/guix.texi:9317
16976 msgid "The main interface to the store monad, provided by the @code{(guix store)} module, is as follows."
16980 #: guix-git/doc/guix.texi:9318
16982 msgid "{Scheme Variable} %store-monad"
16986 #: guix-git/doc/guix.texi:9320
16987 msgid "The store monad---an alias for @code{%state-monad}."
16991 #: guix-git/doc/guix.texi:9324
16992 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)."
16996 #: guix-git/doc/guix.texi:9326
16998 msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]"
17002 #: guix-git/doc/guix.texi:9329
17003 msgid "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open store connection."
17007 #: guix-git/doc/guix.texi:9331
17009 msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]"
17013 #: guix-git/doc/guix.texi:9335
17014 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."
17018 #: guix-git/doc/guix.texi:9337
17020 msgid "{Monadic Procedure} binary-file @var{name} @var{data} [@var{references}]"
17024 #: guix-git/doc/guix.texi:9341
17025 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."
17029 #: guix-git/doc/guix.texi:9343
17031 msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @"
17035 #: guix-git/doc/guix.texi:9348
17036 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."
17040 #: guix-git/doc/guix.texi:9352 guix-git/doc/guix.texi:9775
17041 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."
17045 #: guix-git/doc/guix.texi:9357 guix-git/doc/guix.texi:9780
17046 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."
17050 #: guix-git/doc/guix.texi:9359
17051 msgid "The example below adds a file to the store, under two different names:"
17055 #: guix-git/doc/guix.texi:9365
17058 "(run-with-store (open-connection)\n"
17059 " (mlet %store-monad ((a (interned-file \"README\"))\n"
17060 " (b (interned-file \"README\" \"LEGU-MIN\")))\n"
17061 " (return (list a b))))\n"
17066 #: guix-git/doc/guix.texi:9367
17068 msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n"
17071 #. type: Plain text
17072 #: guix-git/doc/guix.texi:9373
17073 msgid "The @code{(guix packages)} module exports the following package-related monadic procedures:"
17077 #: guix-git/doc/guix.texi:9374
17079 msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @"
17083 #: guix-git/doc/guix.texi:9382
17084 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."
17088 #: guix-git/doc/guix.texi:9386
17089 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."
17093 #: guix-git/doc/guix.texi:9388
17095 msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]"
17099 #: guix-git/doc/guix.texi:9389
17101 msgid "{Monadic Procedure} package->cross-derivation @var{package} @"
17105 #: guix-git/doc/guix.texi:9393
17106 msgid "@var{target} [@var{system}] Monadic version of @code{package-derivation} and @code{package-cross-derivation} (@pxref{Defining Packages})."
17110 #: guix-git/doc/guix.texi:9399
17112 msgid "G-expression"
17116 #: guix-git/doc/guix.texi:9400
17118 msgid "build code quoting"
17121 #. type: Plain text
17122 #: guix-git/doc/guix.texi:9406
17123 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})."
17127 #: guix-git/doc/guix.texi:9409
17129 msgid "strata of code"
17132 #. type: Plain text
17133 #: guix-git/doc/guix.texi:9421
17134 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})."
17137 #. type: Plain text
17138 #: guix-git/doc/guix.texi:9428
17139 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."
17142 #. type: Plain text
17143 #: guix-git/doc/guix.texi:9437
17144 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:"
17148 #: guix-git/doc/guix.texi:9442
17149 msgid "Gexps are meant to be written to a file and run or manipulated by other processes."
17153 #: guix-git/doc/guix.texi:9447
17154 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."
17158 #: guix-git/doc/guix.texi:9452
17159 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."
17163 #: guix-git/doc/guix.texi:9454 guix-git/doc/guix.texi:10011
17165 msgid "lowering, of high-level objects in gexps"
17168 #. type: Plain text
17169 #: guix-git/doc/guix.texi:9464
17170 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)."
17173 #. type: Plain text
17174 #: guix-git/doc/guix.texi:9466
17175 msgid "To illustrate the idea, here is an example of a gexp:"
17179 #: guix-git/doc/guix.texi:9474
17182 "(define build-exp\n"
17184 " (mkdir #$output)\n"
17185 " (chdir #$output)\n"
17186 " (symlink (string-append #$coreutils \"/bin/ls\")\n"
17187 " \"list-files\")))\n"
17190 #. type: Plain text
17191 #: guix-git/doc/guix.texi:9479
17192 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}:"
17196 #: guix-git/doc/guix.texi:9482
17198 msgid "(gexp->derivation \"the-thing\" build-exp)\n"
17201 #. type: Plain text
17202 #: guix-git/doc/guix.texi:9490
17203 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."
17207 #: guix-git/doc/guix.texi:9491
17209 msgid "cross compilation"
17212 #. type: Plain text
17213 #: guix-git/doc/guix.texi:9497
17214 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:"
17218 #: guix-git/doc/guix.texi:9508
17221 "(gexp->derivation \"vi\"\n"
17223 " (mkdir #$output)\n"
17224 " (mkdir (string-append #$output \"/bin\"))\n"
17225 " (system* (string-append #+coreutils \"/bin/ln\")\n"
17227 " (string-append #$emacs \"/bin/emacs\")\n"
17228 " (string-append #$output \"/bin/vi\")))\n"
17229 " #:target \"aarch64-linux-gnu\")\n"
17232 #. type: Plain text
17233 #: guix-git/doc/guix.texi:9514
17234 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."
17238 #: guix-git/doc/guix.texi:9515
17240 msgid "imported modules, for gexps"
17244 #: guix-git/doc/guix.texi:9516
17246 msgid "with-imported-modules"
17249 #. type: Plain text
17250 #: guix-git/doc/guix.texi:9521
17251 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:"
17255 #: guix-git/doc/guix.texi:9532
17258 "(let ((build (with-imported-modules '((guix build utils))\n"
17260 " (use-modules (guix build utils))\n"
17261 " (mkdir-p (string-append #$output \"/bin\"))))))\n"
17262 " (gexp->derivation \"empty-dir\"\n"
17265 " (display \"success!\\n\")\n"
17269 #. type: Plain text
17270 #: guix-git/doc/guix.texi:9538
17271 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."
17275 #: guix-git/doc/guix.texi:9539
17277 msgid "module closure"
17281 #: guix-git/doc/guix.texi:9540
17283 msgid "source-module-closure"
17286 #. type: Plain text
17287 #: guix-git/doc/guix.texi:9547
17288 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:"
17292 #: guix-git/doc/guix.texi:9550
17295 "(use-modules (guix modules)) ;for 'source-module-closure'\n"
17300 #: guix-git/doc/guix.texi:9559
17303 "(with-imported-modules (source-module-closure\n"
17304 " '((guix build utils)\n"
17305 " (gnu build vm)))\n"
17306 " (gexp->derivation \"something-with-vms\"\n"
17308 " (use-modules (guix build utils)\n"
17309 " (gnu build vm))\n"
17314 #: guix-git/doc/guix.texi:9561
17316 msgid "extensions, for gexps"
17320 #: guix-git/doc/guix.texi:9562
17322 msgid "with-extensions"
17325 #. type: Plain text
17326 #: guix-git/doc/guix.texi:9567
17327 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:"
17331 #: guix-git/doc/guix.texi:9570
17334 "(use-modules (gnu packages guile)) ;for 'guile-json'\n"
17339 #: guix-git/doc/guix.texi:9576
17342 "(with-extensions (list guile-json)\n"
17343 " (gexp->derivation \"something-with-json\"\n"
17345 " (use-modules (json))\n"
17349 #. type: Plain text
17350 #: guix-git/doc/guix.texi:9579
17351 msgid "The syntactic form to construct gexps is summarized below."
17355 #: guix-git/doc/guix.texi:9580
17357 msgid "{Scheme Syntax} #~@var{exp}"
17361 #: guix-git/doc/guix.texi:9581
17363 msgid "{Scheme Syntax} (gexp @var{exp})"
17367 #: guix-git/doc/guix.texi:9584
17368 msgid "Return a G-expression containing @var{exp}. @var{exp} may contain one or more of the following forms:"
17372 #: guix-git/doc/guix.texi:9586
17374 msgid "#$@var{obj}"
17378 #: guix-git/doc/guix.texi:9587
17380 msgid "(ungexp @var{obj})"
17384 #: guix-git/doc/guix.texi:9592
17385 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}."
17389 #: guix-git/doc/guix.texi:9595
17390 msgid "If @var{obj} is a list, it is traversed and references to supported objects are substituted similarly."
17394 #: guix-git/doc/guix.texi:9598
17395 msgid "If @var{obj} is another gexp, its contents are inserted and its dependencies are added to those of the containing gexp."
17399 #: guix-git/doc/guix.texi:9600
17400 msgid "If @var{obj} is another kind of object, it is inserted as is."
17404 #: guix-git/doc/guix.texi:9601
17406 msgid "#$@var{obj}:@var{output}"
17410 #: guix-git/doc/guix.texi:9602
17412 msgid "(ungexp @var{obj} @var{output})"
17416 #: guix-git/doc/guix.texi:9606
17417 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})."
17421 #: guix-git/doc/guix.texi:9607
17423 msgid "#+@var{obj}"
17427 #: guix-git/doc/guix.texi:9608
17429 msgid "#+@var{obj}:output"
17433 #: guix-git/doc/guix.texi:9609
17435 msgid "(ungexp-native @var{obj})"
17439 #: guix-git/doc/guix.texi:9610
17441 msgid "(ungexp-native @var{obj} @var{output})"
17445 #: guix-git/doc/guix.texi:9613
17446 msgid "Same as @code{ungexp}, but produces a reference to the @emph{native} build of @var{obj} when used in a cross compilation context."
17450 #: guix-git/doc/guix.texi:9614
17452 msgid "#$output[:@var{output}]"
17456 #: guix-git/doc/guix.texi:9615
17458 msgid "(ungexp output [@var{output}])"
17462 #: guix-git/doc/guix.texi:9618
17463 msgid "Insert a reference to derivation output @var{output}, or to the main output when @var{output} is omitted."
17467 #: guix-git/doc/guix.texi:9620
17468 msgid "This only makes sense for gexps passed to @code{gexp->derivation}."
17472 #: guix-git/doc/guix.texi:9621
17474 msgid "#$@@@var{lst}"
17478 #: guix-git/doc/guix.texi:9622
17480 msgid "(ungexp-splicing @var{lst})"
17484 #: guix-git/doc/guix.texi:9625
17485 msgid "Like the above, but splices the contents of @var{lst} inside the containing list."
17489 #: guix-git/doc/guix.texi:9626
17491 msgid "#+@@@var{lst}"
17495 #: guix-git/doc/guix.texi:9627
17497 msgid "(ungexp-native-splicing @var{lst})"
17501 #: guix-git/doc/guix.texi:9630
17502 msgid "Like the above, but refers to native builds of the objects listed in @var{lst}."
17506 #: guix-git/doc/guix.texi:9635
17507 msgid "G-expressions created by @code{gexp} or @code{#~} are run-time objects of the @code{gexp?} type (see below)."
17511 #: guix-git/doc/guix.texi:9637
17513 msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}"
17517 #: guix-git/doc/guix.texi:9640
17518 msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in their execution environment."
17522 #: guix-git/doc/guix.texi:9644
17523 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:"
17527 #: guix-git/doc/guix.texi:9650
17530 "`((guix build utils)\n"
17532 " ((guix config) => ,(scheme-file \"config.scm\"\n"
17533 " #~(define-module @dots{}))))\n"
17537 #: guix-git/doc/guix.texi:9655
17538 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."
17542 #: guix-git/doc/guix.texi:9659
17543 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{}."
17547 #: guix-git/doc/guix.texi:9661
17549 msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}"
17553 #: guix-git/doc/guix.texi:9666
17554 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."
17558 #: guix-git/doc/guix.texi:9671
17559 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{}."
17563 #: guix-git/doc/guix.texi:9673
17565 msgid "{Scheme Procedure} gexp? @var{obj}"
17569 #: guix-git/doc/guix.texi:9675
17570 msgid "Return @code{#t} if @var{obj} is a G-expression."
17573 #. type: Plain text
17574 #: guix-git/doc/guix.texi:9681
17575 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)."
17579 #: guix-git/doc/guix.texi:9682
17581 msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @"
17585 #: guix-git/doc/guix.texi:9700
17586 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}."
17590 #: guix-git/doc/guix.texi:9708
17591 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))}."
17595 #: guix-git/doc/guix.texi:9711
17596 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\"}."
17600 #: guix-git/doc/guix.texi:9714
17601 msgid "@var{graft?} determines whether packages referred to by @var{exp} should be grafted when applicable."
17605 #: guix-git/doc/guix.texi:9717
17606 msgid "When @var{references-graphs} is true, it must be a list of tuples of one of the following forms:"
17610 #: guix-git/doc/guix.texi:9724
17613 "(@var{file-name} @var{package})\n"
17614 "(@var{file-name} @var{package} @var{output})\n"
17615 "(@var{file-name} @var{derivation})\n"
17616 "(@var{file-name} @var{derivation} @var{output})\n"
17617 "(@var{file-name} @var{store-item})\n"
17621 #: guix-git/doc/guix.texi:9730
17622 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."
17626 #: guix-git/doc/guix.texi:9736
17627 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."
17631 #: guix-git/doc/guix.texi:9739
17632 msgid "@var{deprecation-warnings} determines whether to show deprecation warnings while compiling modules. It can be @code{#f}, @code{#t}, or @code{'detailed}."
17636 #: guix-git/doc/guix.texi:9741
17637 msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})."
17641 #: guix-git/doc/guix.texi:9743
17643 msgid "file-like objects"
17646 #. type: Plain text
17647 #: guix-git/doc/guix.texi:9748
17648 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:"
17652 #: guix-git/doc/guix.texi:9752
17655 "#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n"
17656 " #$(local-file \"/tmp/my-nscd.conf\"))\n"
17659 #. type: Plain text
17660 #: guix-git/doc/guix.texi:9761
17661 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."
17665 #: guix-git/doc/guix.texi:9762
17667 msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @"
17671 #: guix-git/doc/guix.texi:9771
17672 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}."
17676 #: guix-git/doc/guix.texi:9783
17677 msgid "This is the declarative counterpart of the @code{interned-file} monadic procedure (@pxref{The Store Monad, @code{interned-file}})."
17681 #: guix-git/doc/guix.texi:9785
17683 msgid "{Scheme Procedure} plain-file @var{name} @var{content}"
17687 #: guix-git/doc/guix.texi:9788
17688 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."
17692 #: guix-git/doc/guix.texi:9790
17693 msgid "This is the declarative counterpart of @code{text-file}."
17697 #: guix-git/doc/guix.texi:9792
17699 msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @"
17703 #: guix-git/doc/guix.texi:9799
17704 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}."
17708 #: guix-git/doc/guix.texi:9801
17709 msgid "This is the declarative counterpart of @code{gexp->derivation}."
17713 #: guix-git/doc/guix.texi:9803
17715 msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @"
17719 #: guix-git/doc/guix.texi:9809
17720 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}."
17724 #: guix-git/doc/guix.texi:9812
17725 msgid "The example below builds a script that simply invokes the @command{ls} command:"
17729 #: guix-git/doc/guix.texi:9815
17732 "(use-modules (guix gexp) (gnu packages base))\n"
17737 #: guix-git/doc/guix.texi:9819
17740 "(gexp->script \"list-files\"\n"
17741 " #~(execl #$(file-append coreutils \"/bin/ls\")\n"
17746 #: guix-git/doc/guix.texi:9824
17747 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:"
17751 #: guix-git/doc/guix.texi:9829
17754 "#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n"
17756 "(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n"
17760 #: guix-git/doc/guix.texi:9832
17762 msgid "{Scheme Procedure} program-file @var{name} @var{exp} @"
17766 #: guix-git/doc/guix.texi:9837
17767 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}."
17771 #: guix-git/doc/guix.texi:9839
17772 msgid "This is the declarative counterpart of @code{gexp->script}."
17776 #: guix-git/doc/guix.texi:9841
17778 msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @"
17782 #: guix-git/doc/guix.texi:9848
17783 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."
17787 #: guix-git/doc/guix.texi:9853
17788 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}."
17792 #: guix-git/doc/guix.texi:9856
17793 msgid "The resulting file holds references to all the dependencies of @var{exp} or a subset thereof."
17797 #: guix-git/doc/guix.texi:9858
17799 msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} @"
17803 #: guix-git/doc/guix.texi:9862
17804 msgid "[#:splice? #f] [#:set-load-path? #t] Return an object representing the Scheme file @var{name} that contains @var{exp}."
17808 #: guix-git/doc/guix.texi:9864
17809 msgid "This is the declarative counterpart of @code{gexp->file}."
17813 #: guix-git/doc/guix.texi:9866
17815 msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}"
17819 #: guix-git/doc/guix.texi:9872
17820 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."
17824 #: guix-git/doc/guix.texi:9877
17825 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:"
17829 #: guix-git/doc/guix.texi:9885
17832 "(define (profile.sh)\n"
17833 " ;; Return the name of a shell script in the store that\n"
17834 " ;; initializes the 'PATH' environment variable.\n"
17835 " (text-file* \"profile.sh\"\n"
17836 " \"export PATH=\" coreutils \"/bin:\"\n"
17837 " grep \"/bin:\" sed \"/bin\\n\"))\n"
17841 #: guix-git/doc/guix.texi:9890
17842 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."
17846 #: guix-git/doc/guix.texi:9892
17848 msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}"
17852 #: guix-git/doc/guix.texi:9896
17853 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:"
17857 #: guix-git/doc/guix.texi:9900
17860 "(mixed-text-file \"profile\"\n"
17861 " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n"
17865 #: guix-git/doc/guix.texi:9903
17866 msgid "This is the declarative counterpart of @code{text-file*}."
17870 #: guix-git/doc/guix.texi:9905
17872 msgid "{Scheme Procedure} file-union @var{name} @var{files}"
17876 #: guix-git/doc/guix.texi:9910
17877 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:"
17881 #: guix-git/doc/guix.texi:9917
17884 "(file-union \"etc\"\n"
17885 " `((\"hosts\" ,(plain-file \"hosts\"\n"
17886 " \"127.0.0.1 localhost\"))\n"
17887 " (\"bashrc\" ,(plain-file \"bashrc\"\n"
17888 " \"alias ls='ls --color=auto'\"))))\n"
17892 #: guix-git/doc/guix.texi:9920
17893 msgid "This yields an @code{etc} directory containing these two files."
17897 #: guix-git/doc/guix.texi:9922
17899 msgid "{Scheme Procedure} directory-union @var{name} @var{things}"
17903 #: guix-git/doc/guix.texi:9925
17904 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:"
17908 #: guix-git/doc/guix.texi:9928
17910 msgid "(directory-union \"guile+emacs\" (list guile emacs))\n"
17914 #: guix-git/doc/guix.texi:9931
17915 msgid "yields a directory that is the union of the @code{guile} and @code{emacs} packages."
17919 #: guix-git/doc/guix.texi:9933
17921 msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}"
17925 #: guix-git/doc/guix.texi:9937
17926 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."
17930 #: guix-git/doc/guix.texi:9939
17931 msgid "As an example, consider this gexp:"
17935 #: guix-git/doc/guix.texi:9944
17938 "(gexp->script \"run-uname\"\n"
17939 " #~(system* #$(file-append coreutils\n"
17940 " \"/bin/uname\")))\n"
17944 #: guix-git/doc/guix.texi:9947
17945 msgid "The same effect could be achieved with:"
17949 #: guix-git/doc/guix.texi:9952
17952 "(gexp->script \"run-uname\"\n"
17953 " #~(system* (string-append #$coreutils\n"
17954 " \"/bin/uname\")))\n"
17958 #: guix-git/doc/guix.texi:9958
17959 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}."
17963 #: guix-git/doc/guix.texi:9960
17965 msgid "{Scheme Syntax} let-system @var{system} @var{body}@dots{}"
17969 #: guix-git/doc/guix.texi:9961
17971 msgid "{Scheme Syntax} let-system (@var{system} @var{target}) @var{body}@dots{}"
17975 #: guix-git/doc/guix.texi:9964
17976 msgid "Bind @var{system} to the currently targeted system---e.g., @code{\"x86_64-linux\"}---within @var{body}."
17980 #: guix-git/doc/guix.texi:9969
17981 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."
17985 #: guix-git/doc/guix.texi:9972
17986 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:"
17990 #: guix-git/doc/guix.texi:9983
17994 " #+(let-system system\n"
17995 " (cond ((string-prefix? \"armhf-\" system)\n"
17996 " (file-append qemu \"/bin/qemu-system-arm\"))\n"
17997 " ((string-prefix? \"x86_64-\" system)\n"
17998 " (file-append qemu \"/bin/qemu-system-x86_64\"))\n"
18000 " (error \"dunno!\"))))\n"
18001 " \"-net\" \"user\" #$image)\n"
18005 #: guix-git/doc/guix.texi:9986
18007 msgid "{Scheme Syntax} with-parameters ((@var{parameter} @var{value}) @dots{}) @var{exp}"
18011 #: guix-git/doc/guix.texi:9992
18012 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."
18016 #: guix-git/doc/guix.texi:9995
18017 msgid "A typical use of @code{with-parameters} is to force the system in effect for a given object:"
18021 #: guix-git/doc/guix.texi:9999
18024 "(with-parameters ((%current-system \"i686-linux\"))\n"
18029 #: guix-git/doc/guix.texi:10003
18030 msgid "The example above returns an object that corresponds to the i686 build of Coreutils, regardless of the current value of @code{%current-system}."
18033 #. type: Plain text
18034 #: guix-git/doc/guix.texi:10010
18035 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."
18038 #. type: Plain text
18039 #: guix-git/doc/guix.texi:10016
18040 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."
18044 #: guix-git/doc/guix.texi:10017
18046 msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @"
18050 #: guix-git/doc/guix.texi:10023
18051 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>}."
18055 #: guix-git/doc/guix.texi:10026
18057 msgid "Invoking @command{guix repl}"
18061 #: guix-git/doc/guix.texi:10028
18063 msgid "REPL, read-eval-print loop, script"
18066 #. type: Plain text
18067 #: guix-git/doc/guix.texi:10038
18068 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."
18072 #: guix-git/doc/guix.texi:10043
18074 msgid "guix repl @var{options} [@var{file} @var{args}]\n"
18077 #. type: Plain text
18078 #: guix-git/doc/guix.texi:10047
18079 msgid "When a @var{file} argument is provided, @var{file} is executed as a Guile scripts:"
18083 #: guix-git/doc/guix.texi:10050
18085 msgid "guix repl my-script.scm\n"
18088 #. type: Plain text
18089 #: guix-git/doc/guix.texi:10054
18090 msgid "To pass arguments to the script, use @code{--} to prevent them from being interpreted as arguments to @command{guix repl} itself:"
18094 #: guix-git/doc/guix.texi:10057
18096 msgid "guix repl -- my-script.scm --input=foo.txt\n"
18099 #. type: Plain text
18100 #: guix-git/doc/guix.texi:10062
18101 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:"
18105 #: guix-git/doc/guix.texi:10066
18108 "@code{#!/usr/bin/env -S guix repl --}\n"
18112 #. type: Plain text
18113 #: guix-git/doc/guix.texi:10069
18114 msgid "Without a file name argument, a Guile REPL is started:"
18118 #: guix-git/doc/guix.texi:10075
18122 "scheme@@(guile-user)> ,use (gnu packages base)\n"
18123 "scheme@@(guile-user)> coreutils\n"
18124 "$1 = #<package coreutils@@8.29 gnu/packages/base.scm:327 3e28300>\n"
18127 #. type: Plain text
18128 #: guix-git/doc/guix.texi:10082
18129 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."
18132 #. type: Plain text
18133 #: guix-git/doc/guix.texi:10084
18134 msgid "The available options are as follows:"
18138 #: guix-git/doc/guix.texi:10086 guix-git/doc/guix.texi:12448
18140 msgid "--type=@var{type}"
18144 #: guix-git/doc/guix.texi:10087 guix-git/doc/guix.texi:12449
18145 #: guix-git/doc/guix.texi:33138
18147 msgid "-t @var{type}"
18151 #: guix-git/doc/guix.texi:10089
18152 msgid "Start a REPL of the given @var{TYPE}, which can be one of the following:"
18156 #: guix-git/doc/guix.texi:10091
18162 #: guix-git/doc/guix.texi:10093
18163 msgid "This is default, and it spawns a standard full-featured Guile REPL."
18167 #: guix-git/doc/guix.texi:10093
18173 #: guix-git/doc/guix.texi:10096
18174 msgid "Spawn a REPL that uses the machine-readable protocol. This is the protocol that the @code{(guix inferior)} module speaks."
18178 #: guix-git/doc/guix.texi:10102
18179 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:"
18183 #: guix-git/doc/guix.texi:10104
18185 msgid "--listen=tcp:37146"
18189 #: guix-git/doc/guix.texi:10106
18190 msgid "Accept connections on localhost on port 37146."
18194 #: guix-git/doc/guix.texi:10107
18196 msgid "--listen=unix:/tmp/socket"
18200 #: guix-git/doc/guix.texi:10109
18201 msgid "Accept connections on the Unix-domain socket @file{/tmp/socket}."
18205 #: guix-git/doc/guix.texi:10111 guix-git/doc/guix.texi:10215
18206 #: guix-git/doc/guix.texi:11917 guix-git/doc/guix.texi:12097
18207 #: guix-git/doc/guix.texi:12242 guix-git/doc/guix.texi:12496
18209 msgid "--load-path=@var{directory}"
18213 #: guix-git/doc/guix.texi:10112 guix-git/doc/guix.texi:10216
18214 #: guix-git/doc/guix.texi:12098 guix-git/doc/guix.texi:12243
18215 #: guix-git/doc/guix.texi:12497
18217 msgid "-L @var{directory}"
18221 #: guix-git/doc/guix.texi:10115 guix-git/doc/guix.texi:10219
18222 #: guix-git/doc/guix.texi:11920 guix-git/doc/guix.texi:12101
18223 #: guix-git/doc/guix.texi:12246 guix-git/doc/guix.texi:12500
18224 msgid "Add @var{directory} to the front of the package module search path (@pxref{Package Modules})."
18228 #: guix-git/doc/guix.texi:10118
18229 msgid "This allows users to define their own packages and make them visible to the script or REPL."
18233 #: guix-git/doc/guix.texi:10119 guix-git/doc/guix.texi:10678
18239 #: guix-git/doc/guix.texi:10122
18240 msgid "Inhibit loading of the @file{~/.guile} file. By default, that configuration file is loaded when spawning a @code{guile} REPL."
18243 #. type: Plain text
18244 #: guix-git/doc/guix.texi:10132
18245 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."
18249 #: guix-git/doc/guix.texi:10154
18251 msgid "package building"
18254 #. type: command{#1}
18255 #: guix-git/doc/guix.texi:10155
18260 #. type: Plain text
18261 #: guix-git/doc/guix.texi:10161
18262 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."
18266 #: guix-git/doc/guix.texi:10166
18268 msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n"
18271 #. type: Plain text
18272 #: guix-git/doc/guix.texi:10171
18273 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:"
18277 #: guix-git/doc/guix.texi:10174
18279 msgid "guix build emacs guile\n"
18282 #. type: Plain text
18283 #: guix-git/doc/guix.texi:10177
18284 msgid "Similarly, the following command builds all the available packages:"
18288 #: guix-git/doc/guix.texi:10181
18291 "guix build --quiet --keep-going \\\n"
18292 " $(guix package -A | cut -f1,2 --output-delimiter=@@)\n"
18295 #. type: Plain text
18296 #: guix-git/doc/guix.texi:10189
18297 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})."
18300 #. type: Plain text
18301 #: guix-git/doc/guix.texi:10194
18302 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."
18305 #. type: Plain text
18306 #: guix-git/doc/guix.texi:10197
18307 msgid "There may be zero or more @var{options}. The available options are described in the subsections below."
18310 #. type: Plain text
18311 #: guix-git/doc/guix.texi:10212
18312 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:"
18316 #: guix-git/doc/guix.texi:10222 guix-git/doc/guix.texi:11923
18317 #: guix-git/doc/guix.texi:12104 guix-git/doc/guix.texi:12249
18318 #: guix-git/doc/guix.texi:12503
18319 msgid "This allows users to define their own packages and make them visible to the command-line tools."
18323 #: guix-git/doc/guix.texi:10223
18325 msgid "--keep-failed"
18329 #: guix-git/doc/guix.texi:10224
18335 #: guix-git/doc/guix.texi:10230
18336 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."
18340 #: guix-git/doc/guix.texi:10234
18341 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})."
18345 #: guix-git/doc/guix.texi:10235
18347 msgid "--keep-going"
18351 #: guix-git/doc/guix.texi:10236
18357 #: guix-git/doc/guix.texi:10239
18358 msgid "Keep going when some of the derivations fail to build; return only once all the builds have either completed or failed."
18362 #: guix-git/doc/guix.texi:10242
18363 msgid "The default behavior is to stop as soon as one of the specified derivations has failed."
18367 #: guix-git/doc/guix.texi:10246
18368 msgid "Do not build the derivations."
18371 #. type: anchor{#1}
18372 #: guix-git/doc/guix.texi:10248
18373 msgid "fallback-option"
18377 #: guix-git/doc/guix.texi:10248
18383 #: guix-git/doc/guix.texi:10251
18384 msgid "When substituting a pre-built binary fails, fall back to building packages locally (@pxref{Substitution Failure})."
18387 #. type: anchor{#1}
18388 #: guix-git/doc/guix.texi:10257
18389 msgid "client-substitute-urls"
18393 #: guix-git/doc/guix.texi:10257
18394 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})."
18398 #: guix-git/doc/guix.texi:10261
18399 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})."
18403 #: guix-git/doc/guix.texi:10264
18404 msgid "When @var{urls} is the empty string, substitutes are effectively disabled."
18408 #: guix-git/doc/guix.texi:10270
18410 msgid "--no-grafts"
18414 #: guix-git/doc/guix.texi:10274
18415 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."
18419 #: guix-git/doc/guix.texi:10275
18421 msgid "--rounds=@var{n}"
18425 #: guix-git/doc/guix.texi:10278
18426 msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical."
18430 #: guix-git/doc/guix.texi:10283
18431 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."
18435 #: guix-git/doc/guix.texi:10299
18436 msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--max-silent-time}})."
18440 #: guix-git/doc/guix.texi:10306
18441 msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--timeout}})."
18445 #: guix-git/doc/guix.texi:10309
18447 msgid "verbosity, of the command-line tools"
18451 #: guix-git/doc/guix.texi:10310
18453 msgid "build logs, verbosity"
18457 #: guix-git/doc/guix.texi:10311
18459 msgid "-v @var{level}"
18463 #: guix-git/doc/guix.texi:10312
18465 msgid "--verbosity=@var{level}"
18469 #: guix-git/doc/guix.texi:10317
18470 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."
18474 #: guix-git/doc/guix.texi:10322
18475 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."
18479 #: guix-git/doc/guix.texi:10328
18480 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."
18484 #: guix-git/doc/guix.texi:10329
18486 msgid "--debug=@var{level}"
18490 #: guix-git/doc/guix.texi:10333
18491 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."
18494 #. type: Plain text
18495 #: guix-git/doc/guix.texi:10340
18496 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."
18499 #. type: Plain text
18500 #: guix-git/doc/guix.texi:10344
18501 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."
18505 #: guix-git/doc/guix.texi:10345
18507 msgid "{Environment Variable} GUIX_BUILD_OPTIONS"
18511 #: guix-git/doc/guix.texi:10350
18512 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:"
18516 #: guix-git/doc/guix.texi:10353
18518 msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n"
18522 #: guix-git/doc/guix.texi:10357
18523 msgid "These options are parsed independently, and the result is appended to the parsed command-line options."
18527 #: guix-git/doc/guix.texi:10363
18529 msgid "package variants"
18532 #. type: Plain text
18533 #: guix-git/doc/guix.texi:10371
18534 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})."
18537 #. type: Plain text
18538 #: guix-git/doc/guix.texi:10375
18539 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."
18542 #. type: Plain text
18543 #: guix-git/doc/guix.texi:10380
18544 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)."
18548 #: guix-git/doc/guix.texi:10383
18550 msgid "--with-source=@var{source}"
18554 #: guix-git/doc/guix.texi:10384
18556 msgid "--with-source=@var{package}=@var{source}"
18560 #: guix-git/doc/guix.texi:10385
18562 msgid "--with-source=@var{package}@@@var{version}=@var{source}"
18566 #: guix-git/doc/guix.texi:10390
18567 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})."
18571 #: guix-git/doc/guix.texi:10396
18572 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}."
18576 #: guix-git/doc/guix.texi:10399
18577 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}."
18581 #: guix-git/doc/guix.texi:10404
18582 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:"
18586 #: guix-git/doc/guix.texi:10407
18588 msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n"
18592 #: guix-git/doc/guix.texi:10411
18593 msgid "As a developer, @option{--with-source} makes it easy to test release candidates:"
18597 #: guix-git/doc/guix.texi:10414
18599 msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n"
18603 #: guix-git/doc/guix.texi:10417
18604 msgid "@dots{} or to build from a checkout in a pristine environment:"
18608 #: guix-git/doc/guix.texi:10421
18611 "$ git clone git://git.sv.gnu.org/guix.git\n"
18612 "$ guix build guix --with-source=guix@@1.0=./guix\n"
18616 #: guix-git/doc/guix.texi:10423
18618 msgid "--with-input=@var{package}=@var{replacement}"
18622 #: guix-git/doc/guix.texi:10428
18623 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}."
18627 #: guix-git/doc/guix.texi:10432
18628 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}:"
18632 #: guix-git/doc/guix.texi:10435
18634 msgid "guix build --with-input=guile=guile@@2.0 guix\n"
18638 #: guix-git/doc/guix.texi:10440
18639 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}."
18643 #: guix-git/doc/guix.texi:10443
18644 msgid "This is implemented using the @code{package-input-rewriting} Scheme procedure (@pxref{Defining Packages, @code{package-input-rewriting}})."
18648 #: guix-git/doc/guix.texi:10444
18650 msgid "--with-graft=@var{package}=@var{replacement}"
18654 #: guix-git/doc/guix.texi:10450
18655 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."
18659 #: guix-git/doc/guix.texi:10454
18660 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:"
18664 #: guix-git/doc/guix.texi:10457
18666 msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n"
18670 #: guix-git/doc/guix.texi:10466
18671 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!"
18675 #: guix-git/doc/guix.texi:10467 guix-git/doc/guix.texi:34481
18677 msgid "debugging info, rebuilding"
18681 #: guix-git/doc/guix.texi:10468
18683 msgid "--with-debug-info=@var{package}"
18687 #: guix-git/doc/guix.texi:10473
18688 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})."
18692 #: guix-git/doc/guix.texi:10479
18693 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:"
18697 #: guix-git/doc/guix.texi:10482 guix-git/doc/guix.texi:34512
18699 msgid "guix install inkscape --with-debug-info=glib\n"
18703 #: guix-git/doc/guix.texi:10486
18704 msgid "Only GLib needs to be recompiled so this takes a reasonable amount of time. @xref{Installing Debugging Files}, for more info."
18708 #: guix-git/doc/guix.texi:10492
18709 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."
18713 #: guix-git/doc/guix.texi:10496
18714 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."
18718 #: guix-git/doc/guix.texi:10498
18720 msgid "tool chain, changing the build tool chain of a package"
18724 #: guix-git/doc/guix.texi:10499
18726 msgid "--with-c-toolchain=@var{package}=@var{toolchain}"
18730 #: guix-git/doc/guix.texi:10503
18731 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++."
18735 #: guix-git/doc/guix.texi:10510
18738 "guix build octave-cli \\\n"
18739 " --with-c-toolchain=fftw=gcc-toolchain@@10 \\\n"
18740 " --with-c-toolchain=fftwf=gcc-toolchain@@10\n"
18744 #: guix-git/doc/guix.texi:10517
18745 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}."
18749 #: guix-git/doc/guix.texi:10521
18750 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:"
18754 #: guix-git/doc/guix.texi:10525
18757 "guix build --with-c-toolchain=hwloc=clang-toolchain \\\n"
18758 " intel-mpi-benchmarks\n"
18762 #: guix-git/doc/guix.texi:10534
18763 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."
18767 #: guix-git/doc/guix.texi:10536
18769 msgid "--with-git-url=@var{package}=@var{url}"
18773 #: guix-git/doc/guix.texi:10537
18775 msgid "Git, using the latest commit"
18779 #: guix-git/doc/guix.texi:10538
18781 msgid "latest commit, building"
18785 #: guix-git/doc/guix.texi:10542
18786 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."
18790 #: guix-git/doc/guix.texi:10545
18791 msgid "For example, the following command builds the NumPy Python library against the latest commit of the master branch of Python itself:"
18795 #: guix-git/doc/guix.texi:10549
18798 "guix build python-numpy \\\n"
18799 " --with-git-url=python=https://github.com/python/cpython\n"
18803 #: guix-git/doc/guix.texi:10553
18804 msgid "This option can also be combined with @option{--with-branch} or @option{--with-commit} (see below)."
18808 #: guix-git/doc/guix.texi:10554 guix-git/doc/guix.texi:27180
18810 msgid "continuous integration"
18814 #: guix-git/doc/guix.texi:10560
18815 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)."
18819 #: guix-git/doc/guix.texi:10564
18820 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."
18824 #: guix-git/doc/guix.texi:10565
18826 msgid "--with-branch=@var{package}=@var{branch}"
18830 #: guix-git/doc/guix.texi:10571
18831 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."
18835 #: guix-git/doc/guix.texi:10576
18836 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:"
18840 #: guix-git/doc/guix.texi:10579
18842 msgid "guix build --with-branch=guile-sqlite3=master cuirass\n"
18846 #: guix-git/doc/guix.texi:10581
18848 msgid "--with-commit=@var{package}=@var{commit}"
18852 #: guix-git/doc/guix.texi:10585
18853 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."
18857 #: guix-git/doc/guix.texi:10586
18859 msgid "--with-patch=@var{package}=@var{file}"
18863 #: guix-git/doc/guix.texi:10593
18864 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})."
18868 #: guix-git/doc/guix.texi:10596
18869 msgid "As an example, the command below rebuilds Coreutils with the GNU C Library (glibc) patched with the given patch:"
18873 #: guix-git/doc/guix.texi:10599
18875 msgid "guix build coreutils --with-patch=glibc=./glibc-frob.patch\n"
18879 #: guix-git/doc/guix.texi:10603
18880 msgid "In this example, glibc itself as well as everything that leads to Coreutils in the dependency graph is rebuilt."
18884 #: guix-git/doc/guix.texi:10604
18886 msgid "upstream, latest version"
18890 #: guix-git/doc/guix.texi:10605
18892 msgid "--with-latest=@var{package}"
18896 #: guix-git/doc/guix.texi:10610
18897 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})."
18901 #: guix-git/doc/guix.texi:10614
18902 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."
18906 #: guix-git/doc/guix.texi:10617
18907 msgid "As an example, the command below builds Guix against the latest version of Guile-JSON:"
18911 #: guix-git/doc/guix.texi:10620
18913 msgid "guix build guix --with-latest=guile-json\n"
18917 #: guix-git/doc/guix.texi:10629
18918 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."
18922 #: guix-git/doc/guix.texi:10634
18923 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})."
18927 #: guix-git/doc/guix.texi:10635
18929 msgid "test suite, skipping"
18933 #: guix-git/doc/guix.texi:10636
18935 msgid "--without-tests=@var{package}"
18939 #: guix-git/doc/guix.texi:10642
18940 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."
18944 #: guix-git/doc/guix.texi:10646
18945 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:"
18949 #: guix-git/doc/guix.texi:10649
18951 msgid "guix install --without-tests=python python-notebook\n"
18955 #: guix-git/doc/guix.texi:10655
18956 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."
18960 #: guix-git/doc/guix.texi:10661
18961 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."
18964 #. type: Plain text
18965 #: guix-git/doc/guix.texi:10668
18966 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."
18969 #. type: Plain text
18970 #: guix-git/doc/guix.texi:10674
18971 msgid "The command-line options presented below are specific to @command{guix build}."
18975 #: guix-git/doc/guix.texi:10677
18981 #: guix-git/doc/guix.texi:10682
18982 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."
18986 #: guix-git/doc/guix.texi:10683
18988 msgid "--file=@var{file}"
18992 #: guix-git/doc/guix.texi:10687
18993 msgid "Build the package, derivation, or other file-like object that the code within @var{file} evaluates to (@pxref{G-Expressions, file-like objects})."
18997 #: guix-git/doc/guix.texi:10690
18998 msgid "As an example, @var{file} might contain a package definition like this (@pxref{Defining Packages}):"
19002 #: guix-git/doc/guix.texi:10699
19003 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}:"
19007 #: guix-git/doc/guix.texi:10704
19009 msgid "--manifest=@var{manifest}"
19013 #: guix-git/doc/guix.texi:10705
19015 msgid "-m @var{manifest}"
19019 #: guix-git/doc/guix.texi:10708
19020 msgid "Build all packages listed in the given @var{manifest} (@pxref{profile-manifest, @option{--manifest}})."
19024 #: guix-git/doc/guix.texi:10712
19025 msgid "Build the package or derivation @var{expr} evaluates to."
19029 #: guix-git/doc/guix.texi:10716
19030 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."
19034 #: guix-git/doc/guix.texi:10720
19035 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})."
19039 #: guix-git/doc/guix.texi:10724
19040 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}."
19044 #: guix-git/doc/guix.texi:10725
19050 #: guix-git/doc/guix.texi:10726
19056 #: guix-git/doc/guix.texi:10729
19057 msgid "Build the source derivations of the packages, rather than the packages themselves."
19061 #: guix-git/doc/guix.texi:10733
19062 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."
19066 #: guix-git/doc/guix.texi:10737
19067 msgid "The returned source tarball is the result of applying any patches and code snippets specified in the package @code{origin} (@pxref{Defining Packages})."
19071 #: guix-git/doc/guix.texi:10738
19073 msgid "source, verification"
19077 #: guix-git/doc/guix.texi:10744
19078 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."
19082 #: guix-git/doc/guix.texi:10749
19083 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."
19087 #: guix-git/doc/guix.texi:10750
19093 #: guix-git/doc/guix.texi:10757
19094 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:"
19098 #: guix-git/doc/guix.texi:10759 guix-git/doc/guix.texi:12303
19104 #: guix-git/doc/guix.texi:10762
19105 msgid "This value causes the @option{--sources} option to behave in the same way as the @option{--source} option."
19109 #: guix-git/doc/guix.texi:10763 guix-git/doc/guix.texi:18249
19115 #: guix-git/doc/guix.texi:10766
19116 msgid "Build the source derivations of all packages, including any source that might be listed as @code{inputs}. This is the default value."
19120 #: guix-git/doc/guix.texi:10772
19123 "$ guix build --sources tzdata\n"
19124 "The following derivations will be built:\n"
19125 " /gnu/store/@dots{}-tzdata2015b.tar.gz.drv\n"
19126 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
19130 #: guix-git/doc/guix.texi:10774
19136 #: guix-git/doc/guix.texi:10778
19137 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."
19141 #: guix-git/doc/guix.texi:10789
19144 "$ guix build --sources=transitive tzdata\n"
19145 "The following derivations will be built:\n"
19146 " /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n"
19147 " /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv\n"
19148 " /gnu/store/@dots{}-grep-2.21.tar.xz.drv\n"
19149 " /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv\n"
19150 " /gnu/store/@dots{}-make-4.1.tar.xz.drv\n"
19151 " /gnu/store/@dots{}-bash-4.3.tar.xz.drv\n"
19156 #: guix-git/doc/guix.texi:10799
19157 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."
19161 #: guix-git/doc/guix.texi:10804
19162 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."
19166 #: guix-git/doc/guix.texi:10811
19167 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."
19171 #: guix-git/doc/guix.texi:10816
19172 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."
19176 #: guix-git/doc/guix.texi:10822
19177 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."
19181 #: guix-git/doc/guix.texi:10826
19182 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."
19186 #: guix-git/doc/guix.texi:10832
19187 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})."
19190 #. type: anchor{#1}
19191 #: guix-git/doc/guix.texi:10834
19192 msgid "build-check"
19196 #: guix-git/doc/guix.texi:10834
19202 #: guix-git/doc/guix.texi:10835
19204 msgid "determinism, checking"
19208 #: guix-git/doc/guix.texi:10836
19210 msgid "reproducibility, checking"
19214 #: guix-git/doc/guix.texi:10840
19215 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."
19219 #: guix-git/doc/guix.texi:10845
19220 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."
19224 #: guix-git/doc/guix.texi:10850
19230 #: guix-git/doc/guix.texi:10851
19232 msgid "repairing store items"
19236 #: guix-git/doc/guix.texi:10855
19237 msgid "Attempt to repair the specified store items, if they are corrupt, by re-downloading or rebuilding them."
19241 #: guix-git/doc/guix.texi:10857
19242 msgid "This operation is not atomic and thus restricted to @code{root}."
19246 #: guix-git/doc/guix.texi:10858
19248 msgid "--derivations"
19252 #: guix-git/doc/guix.texi:10862
19253 msgid "Return the derivation paths, not the output paths, of the given packages."
19257 #: guix-git/doc/guix.texi:10865
19259 msgid "GC roots, adding"
19263 #: guix-git/doc/guix.texi:10866
19265 msgid "garbage collector roots, adding"
19269 #: guix-git/doc/guix.texi:10869 guix-git/doc/guix.texi:33169
19270 msgid "Make @var{file} a symlink to the result, and register it as a garbage collector root."
19274 #: guix-git/doc/guix.texi:10875
19275 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."
19279 #: guix-git/doc/guix.texi:10876
19285 #: guix-git/doc/guix.texi:10877
19287 msgid "build logs, access"
19291 #: guix-git/doc/guix.texi:10881
19292 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."
19296 #: guix-git/doc/guix.texi:10884
19297 msgid "This works regardless of how packages or derivations are specified. For instance, the following invocations are equivalent:"
19301 #: guix-git/doc/guix.texi:10890
19304 "guix build --log-file $(guix build -d guile)\n"
19305 "guix build --log-file $(guix build guile)\n"
19306 "guix build --log-file guile\n"
19307 "guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)'\n"
19311 #: guix-git/doc/guix.texi:10895
19312 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})."
19316 #: guix-git/doc/guix.texi:10898
19317 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:"
19321 #: guix-git/doc/guix.texi:10902
19324 "$ guix build --log-file gdb -s aarch64-linux\n"
19325 "https://@value{SUBSTITUTE-SERVER}/log/@dots{}-gdb-7.10\n"
19329 #: guix-git/doc/guix.texi:10905
19330 msgid "You can freely access a huge library of build logs!"
19334 #: guix-git/doc/guix.texi:10910
19336 msgid "build failures, debugging"
19339 #. type: Plain text
19340 #: guix-git/doc/guix.texi:10916
19341 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."
19344 #. type: Plain text
19345 #: guix-git/doc/guix.texi:10921
19346 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}})."
19349 #. type: Plain text
19350 #: guix-git/doc/guix.texi:10927
19351 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:"
19355 #: guix-git/doc/guix.texi:10934
19358 "$ guix build foo -K\n"
19359 "@dots{} @i{build fails}\n"
19360 "$ cd /tmp/guix-build-foo.drv-0\n"
19361 "$ source ./environment-variables\n"
19365 #. type: Plain text
19366 #: guix-git/doc/guix.texi:10938
19367 msgid "Now, you can invoke commands as if you were the daemon (almost) and troubleshoot your build process."
19370 #. type: Plain text
19371 #: guix-git/doc/guix.texi:10944
19372 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})."
19375 #. type: Plain text
19376 #: guix-git/doc/guix.texi:10947
19377 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:"
19381 #: guix-git/doc/guix.texi:10955
19384 "$ guix build -K foo\n"
19386 "$ cd /tmp/guix-build-foo.drv-0\n"
19387 "$ guix environment --no-grafts -C foo --ad-hoc strace gdb\n"
19388 "[env]# source ./environment-variables\n"
19389 "[env]# cd foo-1.2\n"
19392 #. type: Plain text
19393 #: guix-git/doc/guix.texi:10964
19394 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)."
19397 #. type: Plain text
19398 #: guix-git/doc/guix.texi:10967
19399 msgid "To get closer to a container like that used by the build daemon, we can remove @file{/bin/sh}:"
19403 #: guix-git/doc/guix.texi:10970
19405 msgid "[env]# rm /bin/sh\n"
19408 #. type: Plain text
19409 #: guix-git/doc/guix.texi:10974
19410 msgid "(Don't worry, this is harmless: this is all happening in the throw-away container created by @command{guix environment}.)"
19413 #. type: Plain text
19414 #: guix-git/doc/guix.texi:10977
19415 msgid "The @command{strace} command is probably not in the search path, but we can run:"
19419 #: guix-git/doc/guix.texi:10980
19421 msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n"
19424 #. type: Plain text
19425 #: guix-git/doc/guix.texi:10985
19426 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."
19430 #: guix-git/doc/guix.texi:10988
19432 msgid "Invoking @command{guix edit}"
19435 #. type: command{#1}
19436 #: guix-git/doc/guix.texi:10990
19442 #: guix-git/doc/guix.texi:10991
19444 msgid "package definition, editing"
19447 #. type: Plain text
19448 #: guix-git/doc/guix.texi:10996
19449 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:"
19453 #: guix-git/doc/guix.texi:10999
19455 msgid "guix edit gcc@@4.9 vim\n"
19458 #. type: Plain text
19459 #: guix-git/doc/guix.texi:11005
19460 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."
19463 #. type: Plain text
19464 #: guix-git/doc/guix.texi:11011
19465 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."
19468 #. type: Plain text
19469 #: guix-git/doc/guix.texi:11016
19470 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."
19474 #: guix-git/doc/guix.texi:11018
19476 msgid "Invoking @command{guix download}"
19479 #. type: command{#1}
19480 #: guix-git/doc/guix.texi:11020
19482 msgid "guix download"
19486 #: guix-git/doc/guix.texi:11021
19488 msgid "downloading package sources"
19491 #. type: Plain text
19492 #: guix-git/doc/guix.texi:11028
19493 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."
19496 #. type: Plain text
19497 #: guix-git/doc/guix.texi:11035
19498 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})."
19501 #. type: Plain text
19502 #: guix-git/doc/guix.texi:11043
19503 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."
19506 #. type: Plain text
19507 #: guix-git/doc/guix.texi:11048
19508 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."
19511 #. type: Plain text
19512 #: guix-git/doc/guix.texi:11050 guix-git/doc/guix.texi:12602
19513 msgid "The following options are available:"
19517 #: guix-git/doc/guix.texi:11052 guix-git/doc/guix.texi:11096
19519 msgid "--hash=@var{algorithm}"
19523 #: guix-git/doc/guix.texi:11053 guix-git/doc/guix.texi:11097
19525 msgid "-H @var{algorithm}"
19529 #: guix-git/doc/guix.texi:11056
19530 msgid "Compute a hash using the specified @var{algorithm}. @xref{Invoking guix hash}, for more information."
19534 #: guix-git/doc/guix.texi:11057 guix-git/doc/guix.texi:11106
19536 msgid "--format=@var{fmt}"
19540 #: guix-git/doc/guix.texi:11058 guix-git/doc/guix.texi:11107
19542 msgid "-f @var{fmt}"
19546 #: guix-git/doc/guix.texi:11061
19547 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}."
19551 #: guix-git/doc/guix.texi:11062
19553 msgid "--no-check-certificate"
19557 #: guix-git/doc/guix.texi:11064
19558 msgid "Do not validate the X.509 certificates of HTTPS servers."
19562 #: guix-git/doc/guix.texi:11068
19563 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."
19567 #: guix-git/doc/guix.texi:11069
19569 msgid "--output=@var{file}"
19573 #: guix-git/doc/guix.texi:11070
19575 msgid "-o @var{file}"
19579 #: guix-git/doc/guix.texi:11073
19580 msgid "Save the downloaded file to @var{file} instead of adding it to the store."
19584 #: guix-git/doc/guix.texi:11076
19586 msgid "Invoking @command{guix hash}"
19589 #. type: command{#1}
19590 #: guix-git/doc/guix.texi:11078
19595 #. type: Plain text
19596 #: guix-git/doc/guix.texi:11083
19597 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})."
19601 #: guix-git/doc/guix.texi:11088
19603 msgid "guix hash @var{option} @var{file}\n"
19606 #. type: Plain text
19607 #: guix-git/doc/guix.texi:11093
19608 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:"
19612 #: guix-git/doc/guix.texi:11100
19613 msgid "Compute a hash using the specified @var{algorithm}, @code{sha256} by default."
19617 #: guix-git/doc/guix.texi:11105
19618 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})."
19622 #: guix-git/doc/guix.texi:11109
19623 msgid "Write the hash in the format specified by @var{fmt}."
19627 #: guix-git/doc/guix.texi:11112
19628 msgid "Supported formats: @code{base64}, @code{nix-base32}, @code{base32}, @code{base16} (@code{hex} and @code{hexadecimal} can be used as well)."
19632 #: guix-git/doc/guix.texi:11116
19633 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."
19637 #: guix-git/doc/guix.texi:11120
19638 msgid "Compute the hash on @var{file} recursively."
19642 #: guix-git/doc/guix.texi:11129
19643 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})."
19647 #: guix-git/doc/guix.texi:11130
19649 msgid "--exclude-vcs"
19653 #: guix-git/doc/guix.texi:11131 guix-git/doc/guix.texi:12089
19659 #: guix-git/doc/guix.texi:11134
19660 msgid "When combined with @option{--recursive}, exclude version control system directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)."
19664 #: guix-git/doc/guix.texi:11135
19670 #: guix-git/doc/guix.texi:11139
19671 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}):"
19675 #: guix-git/doc/guix.texi:11144
19678 "$ git clone http://example.org/foo.git\n"
19680 "$ guix hash -rx .\n"
19684 #: guix-git/doc/guix.texi:11148 guix-git/doc/guix.texi:11153
19686 msgid "Invoking @command{guix import}"
19690 #: guix-git/doc/guix.texi:11150
19692 msgid "importing packages"
19696 #: guix-git/doc/guix.texi:11151
19698 msgid "package import"
19702 #: guix-git/doc/guix.texi:11152
19704 msgid "package conversion"
19707 #. type: Plain text
19708 #: guix-git/doc/guix.texi:11160
19709 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})."
19713 #: guix-git/doc/guix.texi:11165
19715 msgid "guix import @var{importer} @var{options}@dots{}\n"
19718 #. type: Plain text
19719 #: guix-git/doc/guix.texi:11170
19720 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}."
19723 #. type: Plain text
19724 #: guix-git/doc/guix.texi:11174
19725 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."
19728 #. type: Plain text
19729 #: guix-git/doc/guix.texi:11176
19730 msgid "Currently, the available ``importers'' are:"
19734 #: guix-git/doc/guix.texi:11178 guix-git/doc/guix.texi:11736
19740 #: guix-git/doc/guix.texi:11182
19741 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."
19745 #: guix-git/doc/guix.texi:11185
19746 msgid "Additional information such as the package dependencies and its license needs to be figured out manually."
19750 #: guix-git/doc/guix.texi:11188
19751 msgid "For example, the following command returns a package definition for GNU@tie{}Hello:"
19755 #: guix-git/doc/guix.texi:11191
19757 msgid "guix import gnu hello\n"
19761 #: guix-git/doc/guix.texi:11194 guix-git/doc/guix.texi:11404
19762 #: guix-git/doc/guix.texi:11454 guix-git/doc/guix.texi:11483
19763 msgid "Specific command-line options are:"
19767 #: guix-git/doc/guix.texi:11196 guix-git/doc/guix.texi:11897
19769 msgid "--key-download=@var{policy}"
19773 #: guix-git/doc/guix.texi:11200
19774 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}}."
19778 #: guix-git/doc/guix.texi:11202 guix-git/doc/guix.texi:11203
19779 #: guix-git/doc/guix.texi:11758
19785 #: guix-git/doc/guix.texi:11210
19786 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."
19790 #: guix-git/doc/guix.texi:11213
19791 msgid "The command below imports metadata for the @code{itsdangerous} Python package:"
19795 #: guix-git/doc/guix.texi:11216
19797 msgid "guix import pypi itsdangerous\n"
19801 #: guix-git/doc/guix.texi:11224 guix-git/doc/guix.texi:11249
19802 #: guix-git/doc/guix.texi:11427 guix-git/doc/guix.texi:11468
19803 #: guix-git/doc/guix.texi:11515 guix-git/doc/guix.texi:11540
19804 #: guix-git/doc/guix.texi:11556 guix-git/doc/guix.texi:11587
19805 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."
19809 #: guix-git/doc/guix.texi:11226 guix-git/doc/guix.texi:11227
19810 #: guix-git/doc/guix.texi:11760
19816 #: guix-git/doc/guix.texi:11236
19817 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."
19821 #: guix-git/doc/guix.texi:11238
19822 msgid "The command below imports metadata for the @code{rails} Ruby package:"
19826 #: guix-git/doc/guix.texi:11241
19828 msgid "guix import gem rails\n"
19832 #: guix-git/doc/guix.texi:11251 guix-git/doc/guix.texi:11756
19838 #: guix-git/doc/guix.texi:11252
19844 #: guix-git/doc/guix.texi:11260
19845 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."
19849 #: guix-git/doc/guix.texi:11263
19850 msgid "The command command below imports metadata for the Acme::Boolean Perl module:"
19854 #: guix-git/doc/guix.texi:11266
19856 msgid "guix import cpan Acme::Boolean\n"
19860 #: guix-git/doc/guix.texi:11268 guix-git/doc/guix.texi:11752
19866 #: guix-git/doc/guix.texi:11269
19872 #: guix-git/doc/guix.texi:11270
19874 msgid "Bioconductor"
19878 #: guix-git/doc/guix.texi:11274
19879 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}."
19883 #: guix-git/doc/guix.texi:11276
19884 msgid "Information is extracted from the @file{DESCRIPTION} file of the package."
19888 #: guix-git/doc/guix.texi:11278
19889 msgid "The command command below imports metadata for the Cairo R package:"
19893 #: guix-git/doc/guix.texi:11281
19895 msgid "guix import cran Cairo\n"
19899 #: guix-git/doc/guix.texi:11286
19900 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."
19904 #: guix-git/doc/guix.texi:11293
19905 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}."
19909 #: guix-git/doc/guix.texi:11298
19910 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."
19914 #: guix-git/doc/guix.texi:11301
19915 msgid "Information is extracted from the @file{DESCRIPTION} file contained in the package archive."
19919 #: guix-git/doc/guix.texi:11303
19920 msgid "The command below imports metadata for the GenomicRanges R package:"
19924 #: guix-git/doc/guix.texi:11306
19926 msgid "guix import cran --archive=bioconductor GenomicRanges\n"
19930 #: guix-git/doc/guix.texi:11311
19931 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:"
19935 #: guix-git/doc/guix.texi:11314
19937 msgid "guix import cran --archive=git https://github.com/immunogenomics/harmony\n"
19941 #: guix-git/doc/guix.texi:11316
19947 #: guix-git/doc/guix.texi:11317
19953 #: guix-git/doc/guix.texi:11318
19959 #: guix-git/doc/guix.texi:11322
19960 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}."
19964 #: guix-git/doc/guix.texi:11327
19965 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."
19969 #: guix-git/doc/guix.texi:11330
19970 msgid "The command command below imports metadata for the @code{fontspec} TeX package:"
19974 #: guix-git/doc/guix.texi:11333
19976 msgid "guix import texlive fontspec\n"
19980 #: guix-git/doc/guix.texi:11339
19981 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."
19985 #: guix-git/doc/guix.texi:11343
19986 msgid "The command below imports metadata for the @code{ifxetex} package from CTAN while fetching the sources from the directory @file{texmf/source/generic}:"
19990 #: guix-git/doc/guix.texi:11346
19992 msgid "guix import texlive --archive=generic ifxetex\n"
19996 #: guix-git/doc/guix.texi:11349
19998 msgid "JSON, import"
20002 #: guix-git/doc/guix.texi:11352
20003 msgid "Import package metadata from a local JSON file. Consider the following example package definition in JSON format:"
20007 #: guix-git/doc/guix.texi:11365
20011 " \"name\": \"hello\",\n"
20012 " \"version\": \"2.10\",\n"
20013 " \"source\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
20014 " \"build-system\": \"gnu\",\n"
20015 " \"home-page\": \"https://www.gnu.org/software/hello/\",\n"
20016 " \"synopsis\": \"Hello, GNU world: An example GNU package\",\n"
20017 " \"description\": \"GNU Hello prints a greeting.\",\n"
20018 " \"license\": \"GPL-3.0+\",\n"
20019 " \"native-inputs\": [\"gettext\"]\n"
20024 #: guix-git/doc/guix.texi:11371
20025 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}."
20029 #: guix-git/doc/guix.texi:11374
20030 msgid "The importer also supports a more explicit source definition using the common fields for @code{<origin>} records:"
20034 #: guix-git/doc/guix.texi:11387
20039 " \"source\": @{\n"
20040 " \"method\": \"url-fetch\",\n"
20041 " \"uri\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n"
20042 " \"sha256\": @{\n"
20043 " \"base32\": \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"\n"
20051 #: guix-git/doc/guix.texi:11391
20052 msgid "The command below reads metadata from the JSON file @code{hello.json} and outputs a package expression:"
20056 #: guix-git/doc/guix.texi:11394
20058 msgid "guix import json hello.json\n"
20062 #: guix-git/doc/guix.texi:11396 guix-git/doc/guix.texi:11397
20063 #: guix-git/doc/guix.texi:11764
20069 #: guix-git/doc/guix.texi:11402
20070 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."
20074 #: guix-git/doc/guix.texi:11406
20080 #: guix-git/doc/guix.texi:11407
20086 #: guix-git/doc/guix.texi:11409
20087 msgid "Read a Cabal file from standard input."
20091 #: guix-git/doc/guix.texi:11409 guix-git/doc/guix.texi:11456
20093 msgid "--no-test-dependencies"
20097 #: guix-git/doc/guix.texi:11412 guix-git/doc/guix.texi:11459
20098 msgid "Do not include dependencies required only by the test suites."
20102 #: guix-git/doc/guix.texi:11412
20104 msgid "--cabal-environment=@var{alist}"
20108 #: guix-git/doc/guix.texi:11413
20110 msgid "-e @var{alist}"
20114 #: guix-git/doc/guix.texi:11422
20115 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."
20119 #: guix-git/doc/guix.texi:11432
20120 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}:"
20124 #: guix-git/doc/guix.texi:11435
20126 msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n"
20130 #: guix-git/doc/guix.texi:11439
20131 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:"
20135 #: guix-git/doc/guix.texi:11442
20137 msgid "guix import hackage mtl@@2.1.3.1\n"
20141 #: guix-git/doc/guix.texi:11444 guix-git/doc/guix.texi:11445
20142 #: guix-git/doc/guix.texi:11766
20148 #: guix-git/doc/guix.texi:11452
20149 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."
20153 #: guix-git/doc/guix.texi:11459
20155 msgid "--lts-version=@var{version}"
20159 #: guix-git/doc/guix.texi:11460
20161 msgid "-l @var{version}"
20165 #: guix-git/doc/guix.texi:11463
20166 msgid "@var{version} is the desired LTS release version. If omitted the latest release is used."
20170 #: guix-git/doc/guix.texi:11472
20171 msgid "The command below imports metadata for the HTTP Haskell package included in the LTS Stackage release version 7.18:"
20175 #: guix-git/doc/guix.texi:11475
20177 msgid "guix import stackage --lts-version=7.18 HTTP\n"
20181 #: guix-git/doc/guix.texi:11477 guix-git/doc/guix.texi:11478
20182 #: guix-git/doc/guix.texi:11750
20188 #: guix-git/doc/guix.texi:11481
20189 msgid "Import metadata from an Emacs Lisp Package Archive (ELPA) package repository (@pxref{Packages,,, emacs, The GNU Emacs Manual})."
20193 #: guix-git/doc/guix.texi:11485
20195 msgid "--archive=@var{repo}"
20199 #: guix-git/doc/guix.texi:11486
20201 msgid "-a @var{repo}"
20205 #: guix-git/doc/guix.texi:11490
20206 msgid "@var{repo} identifies the archive repository from which to retrieve the information. Currently the supported repositories and their identifiers are:"
20210 #: guix-git/doc/guix.texi:11494
20211 msgid "@uref{https://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} identifier. This is the default."
20215 #: guix-git/doc/guix.texi:11500
20216 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})."
20220 #: guix-git/doc/guix.texi:11504
20221 msgid "@uref{https://stable.melpa.org/packages, MELPA-Stable}, selected by the @code{melpa-stable} identifier."
20225 #: guix-git/doc/guix.texi:11508
20226 msgid "@uref{https://melpa.org/packages, MELPA}, selected by the @code{melpa} identifier."
20230 #: guix-git/doc/guix.texi:11517 guix-git/doc/guix.texi:11518
20231 #: guix-git/doc/guix.texi:11768
20237 #: guix-git/doc/guix.texi:11521
20238 msgid "Import metadata from the crates.io Rust package repository @uref{https://crates.io, crates.io}, as in this example:"
20242 #: guix-git/doc/guix.texi:11524
20244 msgid "guix import crate blake2-rfc\n"
20248 #: guix-git/doc/guix.texi:11527
20249 msgid "The crate importer also allows you to specify a version string:"
20253 #: guix-git/doc/guix.texi:11530
20255 msgid "guix import crate constant-time-eq@@0.1.0\n"
20259 #: guix-git/doc/guix.texi:11533 guix-git/doc/guix.texi:11549
20260 #: guix-git/doc/guix.texi:11580
20261 msgid "Additional options include:"
20265 #: guix-git/doc/guix.texi:11542
20271 #: guix-git/doc/guix.texi:11543
20277 #: guix-git/doc/guix.texi:11544
20283 #: guix-git/doc/guix.texi:11547
20284 msgid "Import metadata from the @uref{https://opam.ocaml.org/, OPAM} package repository used by the OCaml community."
20288 #: guix-git/doc/guix.texi:11556
20294 #: guix-git/doc/guix.texi:11558
20295 msgid "Select the given repository (a repository name). Possible values include:"
20299 #: guix-git/doc/guix.texi:11559
20301 msgid "@code{opam}, the default opam repository,"
20305 #: guix-git/doc/guix.texi:11560
20307 msgid "@code{coq} or @code{coq-released}, the stable repository for coq packages,"
20311 #: guix-git/doc/guix.texi:11561
20313 msgid "@code{coq-core-dev}, the repository that contains development versions of coq,"
20317 #: guix-git/doc/guix.texi:11562
20319 msgid "@code{coq-extra-dev}, the repository that contains development versions"
20323 #: guix-git/doc/guix.texi:11564
20324 msgid "of coq packages."
20328 #: guix-git/doc/guix.texi:11567 guix-git/doc/guix.texi:11568
20334 #: guix-git/doc/guix.texi:11571
20335 msgid "Import metadata for a Go module using @uref{https://proxy.golang.org, proxy.golang.org}."
20339 #: guix-git/doc/guix.texi:11574
20341 msgid "guix import go gopkg.in/yaml.v2\n"
20345 #: guix-git/doc/guix.texi:11578
20346 msgid "It is possible to use a package specification with a @code{@@VERSION} suffix to import a specific version."
20350 #: guix-git/doc/guix.texi:11587
20352 msgid "--pin-versions"
20356 #: guix-git/doc/guix.texi:11595
20357 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."
20360 #. type: Plain text
20361 #: guix-git/doc/guix.texi:11601
20362 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})."
20366 #: guix-git/doc/guix.texi:11603
20368 msgid "Invoking @command{guix refresh}"
20371 #. type: command{#1}
20372 #: guix-git/doc/guix.texi:11605
20374 msgid "guix refresh"
20377 #. type: Plain text
20378 #: guix-git/doc/guix.texi:11613
20379 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:"
20383 #: guix-git/doc/guix.texi:11618
20387 "gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1\n"
20388 "gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0\n"
20391 #. type: Plain text
20392 #: guix-git/doc/guix.texi:11622
20393 msgid "Alternatively, one can specify packages to consider, in which case a warning is emitted for packages that lack an updater:"
20397 #: guix-git/doc/guix.texi:11627
20400 "$ guix refresh coreutils guile guile-ssh\n"
20401 "gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh\n"
20402 "gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13\n"
20405 #. type: Plain text
20406 #: guix-git/doc/guix.texi:11636
20407 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!"
20411 #: guix-git/doc/guix.texi:11641
20412 msgid "Consider the packages specified, and all the packages upon which they depend."
20416 #: guix-git/doc/guix.texi:11649
20419 "$ guix refresh --recursive coreutils\n"
20420 "gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1\n"
20421 "gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4\n"
20422 "gnu/packages/xml.scm:68:2: warning: no updater for expat\n"
20423 "gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp\n"
20427 #. type: Plain text
20428 #: guix-git/doc/guix.texi:11657
20429 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:"
20433 #: guix-git/doc/guix.texi:11664
20436 "(define-public network-manager\n"
20438 " (name \"network-manager\")\n"
20440 " (properties '((upstream-name . \"NetworkManager\")))))\n"
20443 #. type: Plain text
20444 #: guix-git/doc/guix.texi:11673
20445 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."
20448 #. type: Plain text
20449 #: guix-git/doc/guix.texi:11679
20450 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."
20453 #. type: Plain text
20454 #: guix-git/doc/guix.texi:11681
20455 msgid "The following options are supported:"
20459 #: guix-git/doc/guix.texi:11689 guix-git/doc/guix.texi:12484
20460 msgid "This is useful to precisely refer to a package, as in this example:"
20464 #: guix-git/doc/guix.texi:11692
20466 msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n"
20470 #: guix-git/doc/guix.texi:11696
20471 msgid "This command lists the dependents of the ``final'' libc (essentially all the packages)."
20475 #: guix-git/doc/guix.texi:11697
20481 #: guix-git/doc/guix.texi:11698
20487 #: guix-git/doc/guix.texi:11702
20488 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}):"
20492 #: guix-git/doc/guix.texi:11705
20494 msgid "$ ./pre-inst-env guix refresh -s non-core -u\n"
20498 #: guix-git/doc/guix.texi:11708
20499 msgid "@xref{Defining Packages}, for more information on package definitions."
20503 #: guix-git/doc/guix.texi:11709
20505 msgid "--select=[@var{subset}]"
20509 #: guix-git/doc/guix.texi:11710
20511 msgid "-s @var{subset}"
20515 #: guix-git/doc/guix.texi:11713
20516 msgid "Select all the packages in @var{subset}, one of @code{core} or @code{non-core}."
20520 #: guix-git/doc/guix.texi:11720
20521 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."
20525 #: guix-git/doc/guix.texi:11724
20526 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."
20530 #: guix-git/doc/guix.texi:11729
20531 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."
20535 #: guix-git/doc/guix.texi:11730
20537 msgid "--type=@var{updater}"
20541 #: guix-git/doc/guix.texi:11731
20543 msgid "-t @var{updater}"
20547 #: guix-git/doc/guix.texi:11734
20548 msgid "Select only packages handled by @var{updater} (may be a comma-separated list of updaters). Currently, @var{updater} may be one of:"
20552 #: guix-git/doc/guix.texi:11738
20553 msgid "the updater for GNU packages;"
20557 #: guix-git/doc/guix.texi:11738
20563 #: guix-git/doc/guix.texi:11740
20564 msgid "the updater for packages hosted at @uref{https://savannah.gnu.org, Savannah};"
20568 #: guix-git/doc/guix.texi:11740
20570 msgid "sourceforge"
20574 #: guix-git/doc/guix.texi:11742
20575 msgid "the updater for packages hosted at @uref{https://sourceforge.net, SourceForge};"
20579 #: guix-git/doc/guix.texi:11742
20585 #: guix-git/doc/guix.texi:11744
20586 msgid "the updater for GNOME packages;"
20590 #: guix-git/doc/guix.texi:11744
20596 #: guix-git/doc/guix.texi:11746
20597 msgid "the updater for KDE packages;"
20601 #: guix-git/doc/guix.texi:11746
20607 #: guix-git/doc/guix.texi:11748
20608 msgid "the updater for X.org packages;"
20612 #: guix-git/doc/guix.texi:11748
20618 #: guix-git/doc/guix.texi:11750
20619 msgid "the updater for packages hosted on kernel.org;"
20623 #: guix-git/doc/guix.texi:11752
20624 msgid "the updater for @uref{https://elpa.gnu.org/, ELPA} packages;"
20628 #: guix-git/doc/guix.texi:11754
20629 msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;"
20633 #: guix-git/doc/guix.texi:11754
20635 msgid "bioconductor"
20639 #: guix-git/doc/guix.texi:11756
20640 msgid "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R packages;"
20644 #: guix-git/doc/guix.texi:11758
20645 msgid "the updater for @uref{https://www.cpan.org/, CPAN} packages;"
20649 #: guix-git/doc/guix.texi:11760
20650 msgid "the updater for @uref{https://pypi.python.org, PyPI} packages."
20654 #: guix-git/doc/guix.texi:11762
20655 msgid "the updater for @uref{https://rubygems.org, RubyGems} packages."
20659 #: guix-git/doc/guix.texi:11762
20665 #: guix-git/doc/guix.texi:11764
20666 msgid "the updater for @uref{https://github.com, GitHub} packages."
20670 #: guix-git/doc/guix.texi:11766
20671 msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages."
20675 #: guix-git/doc/guix.texi:11768
20676 msgid "the updater for @uref{https://www.stackage.org, Stackage} packages."
20680 #: guix-git/doc/guix.texi:11770
20681 msgid "the updater for @uref{https://crates.io, Crates} packages."
20685 #: guix-git/doc/guix.texi:11770
20691 #: guix-git/doc/guix.texi:11772
20692 msgid "the updater for @uref{https://launchpad.net, Launchpad} packages."
20696 #: guix-git/doc/guix.texi:11772
20698 msgid "generic-html"
20702 #: guix-git/doc/guix.texi:11775
20703 msgid "a generic updater that crawls the HTML page where the source tarball of the package is hosted, when applicable."
20707 #: guix-git/doc/guix.texi:11779
20708 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:"
20712 #: guix-git/doc/guix.texi:11784
20715 "$ guix refresh --type=elpa,cran\n"
20716 "gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0\n"
20717 "gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9\n"
20721 #: guix-git/doc/guix.texi:11786
20723 msgid "--list-updaters"
20727 #: guix-git/doc/guix.texi:11787
20733 #: guix-git/doc/guix.texi:11789
20734 msgid "List available updaters and exit (see @option{--type} above)."
20738 #: guix-git/doc/guix.texi:11792
20739 msgid "For each updater, display the fraction of packages it covers; at the end, display the fraction of packages covered by all these updaters."
20742 #. type: Plain text
20743 #: guix-git/doc/guix.texi:11796
20744 msgid "In addition, @command{guix refresh} can be passed one or more package names, as in this example:"
20748 #: guix-git/doc/guix.texi:11799
20750 msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n"
20753 #. type: Plain text
20754 #: guix-git/doc/guix.texi:11806
20755 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:"
20759 #: guix-git/doc/guix.texi:11810
20762 "$ ./pre-inst-env guix refresh -u \\\n"
20763 " $(guix package --list-installed | cut -f1)\n"
20766 #. type: Plain text
20767 #: guix-git/doc/guix.texi:11816
20768 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:"
20772 #: guix-git/doc/guix.texi:11819
20774 msgid "--list-dependent"
20778 #: guix-git/doc/guix.texi:11820 guix-git/doc/guix.texi:12079
20784 #: guix-git/doc/guix.texi:11823
20785 msgid "List top-level dependent packages that would need to be rebuilt as a result of upgrading one or more packages."
20789 #: guix-git/doc/guix.texi:11827
20790 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."
20793 #. type: Plain text
20794 #: guix-git/doc/guix.texi:11833
20795 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."
20799 #: guix-git/doc/guix.texi:11838
20802 "$ guix refresh --list-dependent flex\n"
20803 "Building the following 120 packages would ensure 213 dependent packages are rebuilt:\n"
20804 "hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n"
20807 #. type: Plain text
20808 #: guix-git/doc/guix.texi:11842
20809 msgid "The command above lists a set of packages that could be built to check for compatibility with an upgraded @code{flex} package."
20813 #: guix-git/doc/guix.texi:11845
20815 msgid "--list-transitive"
20819 #: guix-git/doc/guix.texi:11847
20820 msgid "List all the packages which one or more packages depend upon."
20824 #: guix-git/doc/guix.texi:11852
20827 "$ guix refresh --list-transitive flex\n"
20828 "flex@@2.6.4 depends on the following 25 packages: perl@@5.28.0 help2man@@1.47.6\n"
20829 "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"
20832 #. type: Plain text
20833 #: guix-git/doc/guix.texi:11858
20834 msgid "The command above lists a set of packages which, when changed, would cause @code{flex} to be rebuilt."
20837 #. type: Plain text
20838 #: guix-git/doc/guix.texi:11860
20839 msgid "The following options can be used to customize GnuPG operation:"
20843 #: guix-git/doc/guix.texi:11863
20845 msgid "--gpg=@var{command}"
20849 #: guix-git/doc/guix.texi:11866
20850 msgid "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for in @code{$PATH}."
20854 #: guix-git/doc/guix.texi:11867
20856 msgid "--keyring=@var{file}"
20860 #: guix-git/doc/guix.texi:11873
20861 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)."
20865 #: guix-git/doc/guix.texi:11879
20866 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)."
20870 #: guix-git/doc/guix.texi:11882
20871 msgid "You can export keys from your default GPG keyring into a keybox file using commands like this one:"
20875 #: guix-git/doc/guix.texi:11885
20877 msgid "gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx\n"
20881 #: guix-git/doc/guix.texi:11888
20882 msgid "Likewise, you can fetch keys to a specific keybox file like this:"
20886 #: guix-git/doc/guix.texi:11892
20889 "gpg --no-default-keyring --keyring mykeyring.kbx \\\n"
20890 " --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n"
20894 #: guix-git/doc/guix.texi:11896
20895 msgid "@xref{GPG Configuration Options, @option{--keyring},, gnupg, Using the GNU Privacy Guard}, for more information on GPG's @option{--keyring} option."
20899 #: guix-git/doc/guix.texi:11900
20900 msgid "Handle missing OpenPGP keys according to @var{policy}, which may be one of:"
20904 #: guix-git/doc/guix.texi:11902 guix-git/doc/guix.texi:20769
20910 #: guix-git/doc/guix.texi:11905
20911 msgid "Always download missing OpenPGP keys from the key server, and add them to the user's GnuPG keyring."
20915 #: guix-git/doc/guix.texi:11906 guix-git/doc/guix.texi:20771
20921 #: guix-git/doc/guix.texi:11908
20922 msgid "Never try to download missing OpenPGP keys. Instead just bail out."
20926 #: guix-git/doc/guix.texi:11909
20928 msgid "interactive"
20932 #: guix-git/doc/guix.texi:11912
20933 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."
20937 #: guix-git/doc/guix.texi:11914
20939 msgid "--key-server=@var{host}"
20943 #: guix-git/doc/guix.texi:11916
20944 msgid "Use @var{host} as the OpenPGP key server when importing a public key."
20947 #. type: Plain text
20948 #: guix-git/doc/guix.texi:11936
20949 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."
20953 #: guix-git/doc/guix.texi:11939
20955 msgid "Invoking @command{guix lint}"
20958 #. type: command{#1}
20959 #: guix-git/doc/guix.texi:11941
20965 #: guix-git/doc/guix.texi:11942
20967 msgid "package, checking for errors"
20970 #. type: Plain text
20971 #: guix-git/doc/guix.texi:11948
20972 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):"
20976 #: guix-git/doc/guix.texi:11954
20977 msgid "Validate certain typographical and stylistic rules about package descriptions and synopses."
20981 #: guix-git/doc/guix.texi:11955
20983 msgid "inputs-should-be-native"
20987 #: guix-git/doc/guix.texi:11957
20988 msgid "Identify inputs that should most likely be native inputs."
20992 #: guix-git/doc/guix.texi:11960
20998 #: guix-git/doc/guix.texi:11961
21004 #: guix-git/doc/guix.texi:11962
21006 msgid "source-file-name"
21010 #: guix-git/doc/guix.texi:11969
21011 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})."
21015 #: guix-git/doc/guix.texi:11970
21017 msgid "source-unstable-tarball"
21021 #: guix-git/doc/guix.texi:11974
21022 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."
21026 #: guix-git/doc/guix.texi:11978
21027 msgid "Check that the derivation of the given packages can be successfully computed for all the supported systems (@pxref{Derivations})."
21031 #: guix-git/doc/guix.texi:11979
21033 msgid "profile-collisions"
21037 #: guix-git/doc/guix.texi:11985
21038 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."
21042 #: guix-git/doc/guix.texi:11986
21048 #: guix-git/doc/guix.texi:11987
21050 msgid "Software Heritage, source code archive"
21054 #: guix-git/doc/guix.texi:11988
21056 msgid "archival of source code, Software Heritage"
21060 #: guix-git/doc/guix.texi:11991
21061 msgid "Checks whether the package's source code is archived at @uref{https://www.softwareheritage.org, Software Heritage}."
21065 #: guix-git/doc/guix.texi:11999
21066 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}."
21070 #: guix-git/doc/guix.texi:12004
21071 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."
21075 #: guix-git/doc/guix.texi:12010
21076 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."
21080 #: guix-git/doc/guix.texi:12011
21086 #: guix-git/doc/guix.texi:12012 guix-git/doc/guix.texi:34545
21088 msgid "security vulnerabilities"
21092 #: guix-git/doc/guix.texi:12013
21094 msgid "CVE, Common Vulnerabilities and Exposures"
21098 #: guix-git/doc/guix.texi:12018
21099 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}."
21103 #: guix-git/doc/guix.texi:12020
21104 msgid "To view information about a particular vulnerability, visit pages such as:"
21107 #. type: indicateurl{#1}
21108 #: guix-git/doc/guix.texi:12024
21109 msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD"
21112 #. type: indicateurl{#1}
21113 #: guix-git/doc/guix.texi:12026
21114 msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD"
21118 #: guix-git/doc/guix.texi:12031
21119 msgid "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., @code{CVE-2015-7554}."
21123 #: guix-git/doc/guix.texi:12036
21124 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:"
21128 #: guix-git/doc/guix.texi:12044
21132 " (name \"grub\")\n"
21134 " ;; CPE calls this package \"grub2\".\n"
21135 " (properties '((cpe-name . \"grub2\")\n"
21136 " (cpe-version . \"2.3\"))))\n"
21140 #: guix-git/doc/guix.texi:12051
21141 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:"
21145 #: guix-git/doc/guix.texi:12061
21149 " (name \"t1lib\")\n"
21151 " ;; These CVEs no longer apply and can be safely ignored.\n"
21152 " (properties `((lint-hidden-cve . (\"CVE-2011-0433\"\n"
21153 " \"CVE-2011-1553\"\n"
21154 " \"CVE-2011-1554\"\n"
21155 " \"CVE-2011-5244\")))))\n"
21159 #: guix-git/doc/guix.texi:12063
21165 #: guix-git/doc/guix.texi:12066
21166 msgid "Warn about obvious source code formatting issues: trailing white space, use of tabulations, etc."
21170 #: guix-git/doc/guix.texi:12072
21172 msgid "guix lint @var{options} @var{package}@dots{}\n"
21175 #. type: Plain text
21176 #: guix-git/doc/guix.texi:12076
21177 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:"
21181 #: guix-git/doc/guix.texi:12078
21183 msgid "--list-checkers"
21187 #: guix-git/doc/guix.texi:12082
21188 msgid "List and describe all the available checkers that will be run on packages and exit."
21192 #: guix-git/doc/guix.texi:12083
21198 #: guix-git/doc/guix.texi:12084
21204 #: guix-git/doc/guix.texi:12087
21205 msgid "Only enable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
21209 #: guix-git/doc/guix.texi:12088
21215 #: guix-git/doc/guix.texi:12092
21216 msgid "Only disable the checkers specified in a comma-separated list using the names returned by @option{--list-checkers}."
21220 #: guix-git/doc/guix.texi:12093
21222 msgid "--no-network"
21226 #: guix-git/doc/guix.texi:12096
21227 msgid "Only enable the checkers that do not depend on Internet access."
21231 #: guix-git/doc/guix.texi:12108
21233 msgid "Invoking @command{guix size}"
21237 #: guix-git/doc/guix.texi:12110 guix-git/doc/guix.texi:33481
21243 #: guix-git/doc/guix.texi:12111
21245 msgid "package size"
21248 #. type: command{#1}
21249 #: guix-git/doc/guix.texi:12113
21254 #. type: Plain text
21255 #: guix-git/doc/guix.texi:12120
21256 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."
21259 #. type: Plain text
21260 #: guix-git/doc/guix.texi:12125
21261 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:"
21265 #: guix-git/doc/guix.texi:12138
21268 "$ guix size coreutils\n"
21269 "store item total self\n"
21270 "/gnu/store/@dots{}-gcc-5.5.0-lib 60.4 30.1 38.1%\n"
21271 "/gnu/store/@dots{}-glibc-2.27 30.3 28.8 36.6%\n"
21272 "/gnu/store/@dots{}-coreutils-8.28 78.9 15.0 19.0%\n"
21273 "/gnu/store/@dots{}-gmp-6.1.2 63.1 2.7 3.4%\n"
21274 "/gnu/store/@dots{}-bash-static-4.4.12 1.5 1.5 1.9%\n"
21275 "/gnu/store/@dots{}-acl-2.2.52 61.1 0.4 0.5%\n"
21276 "/gnu/store/@dots{}-attr-2.4.47 60.6 0.2 0.3%\n"
21277 "/gnu/store/@dots{}-libcap-2.25 60.5 0.2 0.2%\n"
21278 "total: 78.9 MiB\n"
21281 #. type: Plain text
21282 #: guix-git/doc/guix.texi:12144
21283 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:"
21287 #: guix-git/doc/guix.texi:12147
21289 msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n"
21292 #. type: Plain text
21293 #: guix-git/doc/guix.texi:12155
21294 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."
21297 #. type: Plain text
21298 #: guix-git/doc/guix.texi:12161
21299 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.)"
21302 #. type: Plain text
21303 #: guix-git/doc/guix.texi:12164
21304 msgid "Since the command also accepts store file names, assessing the size of a build result is straightforward:"
21308 #: guix-git/doc/guix.texi:12167
21310 msgid "guix size $(guix system build config.scm)\n"
21313 #. type: Plain text
21314 #: guix-git/doc/guix.texi:12177
21315 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})."
21318 #. type: Plain text
21319 #: guix-git/doc/guix.texi:12182
21320 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."
21323 #. type: Plain text
21324 #: guix-git/doc/guix.texi:12184
21325 msgid "You can also specify several package names:"
21329 #: guix-git/doc/guix.texi:12194
21332 "$ guix size coreutils grep sed bash\n"
21333 "store item total self\n"
21334 "/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4%\n"
21335 "/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8%\n"
21336 "/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6%\n"
21337 "/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2%\n"
21339 "total: 102.3 MiB\n"
21342 #. type: Plain text
21343 #: guix-git/doc/guix.texi:12200
21344 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."
21347 #. type: Plain text
21348 #: guix-git/doc/guix.texi:12206
21349 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})."
21352 #. type: Plain text
21353 #: guix-git/doc/guix.texi:12208
21354 msgid "The available options are:"
21358 #: guix-git/doc/guix.texi:12214
21359 msgid "Use substitute information from @var{urls}. @xref{client-substitute-urls, the same option for @code{guix build}}."
21363 #: guix-git/doc/guix.texi:12215
21365 msgid "--sort=@var{key}"
21369 #: guix-git/doc/guix.texi:12217
21370 msgid "Sort lines according to @var{key}, one of the following options:"
21374 #: guix-git/doc/guix.texi:12219
21380 #: guix-git/doc/guix.texi:12221
21381 msgid "the size of each item (the default);"
21385 #: guix-git/doc/guix.texi:12223
21386 msgid "the total size of the item's closure."
21390 #: guix-git/doc/guix.texi:12225
21392 msgid "--map-file=@var{file}"
21396 #: guix-git/doc/guix.texi:12227
21397 msgid "Write a graphical map of disk usage in PNG format to @var{file}."
21401 #: guix-git/doc/guix.texi:12229
21402 msgid "For the example above, the map looks like this:"
21406 #: guix-git/doc/guix.texi:12232
21407 msgid "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced by @command{guix size}}"
21411 #: guix-git/doc/guix.texi:12237
21412 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."
21416 #: guix-git/doc/guix.texi:12241
21417 msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}."
21421 #: guix-git/doc/guix.texi:12252
21423 msgid "Invoking @command{guix graph}"
21427 #: guix-git/doc/guix.texi:12254
21432 #. type: command{#1}
21433 #: guix-git/doc/guix.texi:12255
21438 #. type: Plain text
21439 #: guix-git/doc/guix.texi:12270
21440 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:"
21444 #: guix-git/doc/guix.texi:12273
21446 msgid "guix graph @var{options} @var{package}@dots{}\n"
21449 #. type: Plain text
21450 #: guix-git/doc/guix.texi:12278
21451 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:"
21455 #: guix-git/doc/guix.texi:12281
21457 msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n"
21460 #. type: Plain text
21461 #: guix-git/doc/guix.texi:12284
21462 msgid "The output looks like this:"
21465 #. type: Plain text
21466 #: guix-git/doc/guix.texi:12286
21467 msgid "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}"
21470 #. type: Plain text
21471 #: guix-git/doc/guix.texi:12288
21472 msgid "Nice little graph, no?"
21475 #. type: Plain text
21476 #: guix-git/doc/guix.texi:12291
21477 msgid "You may find it more pleasant to navigate the graph interactively with @command{xdot} (from the @code{xdot} package):"
21481 #: guix-git/doc/guix.texi:12294
21483 msgid "guix graph coreutils | xdot -\n"
21486 #. type: Plain text
21487 #: guix-git/doc/guix.texi:12301
21488 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:"
21492 #: guix-git/doc/guix.texi:12307
21493 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."
21497 #: guix-git/doc/guix.texi:12308
21499 msgid "reverse-package"
21503 #: guix-git/doc/guix.texi:12310
21504 msgid "This shows the @emph{reverse} DAG of packages. For example:"
21508 #: guix-git/doc/guix.texi:12313
21510 msgid "guix graph --type=reverse-package ocaml\n"
21514 #: guix-git/doc/guix.texi:12318
21515 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)."
21519 #: guix-git/doc/guix.texi:12323
21520 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}})."
21524 #: guix-git/doc/guix.texi:12324
21526 msgid "bag-emerged"
21530 #: guix-git/doc/guix.texi:12326
21531 msgid "This is the package DAG, @emph{including} implicit inputs."
21535 #: guix-git/doc/guix.texi:12328
21536 msgid "For instance, the following command:"
21540 #: guix-git/doc/guix.texi:12331
21542 msgid "guix graph --type=bag-emerged coreutils\n"
21546 #: guix-git/doc/guix.texi:12334
21547 msgid "...@: yields this bigger graph:"
21551 #: guix-git/doc/guix.texi:12336
21552 msgid "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils}"
21556 #: guix-git/doc/guix.texi:12339
21557 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}})."
21561 #: guix-git/doc/guix.texi:12343
21562 msgid "Now, note that the dependencies of these implicit inputs---that is, the @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, for conciseness."
21566 #: guix-git/doc/guix.texi:12344
21572 #: guix-git/doc/guix.texi:12347
21573 msgid "Similar to @code{bag-emerged}, but this time including all the bootstrap dependencies."
21577 #: guix-git/doc/guix.texi:12348
21579 msgid "bag-with-origins"
21583 #: guix-git/doc/guix.texi:12350
21584 msgid "Similar to @code{bag}, but also showing origins and their dependencies."
21588 #: guix-git/doc/guix.texi:12351
21590 msgid "reverse-bag"
21594 #: guix-git/doc/guix.texi:12354
21595 msgid "This shows the @emph{reverse} DAG of packages. Unlike @code{reverse-package}, it also takes implicit dependencies into account. For example:"
21599 #: guix-git/doc/guix.texi:12357
21601 msgid "guix graph -t reverse-bag dune\n"
21605 #: guix-git/doc/guix.texi:12364
21606 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."
21610 #: guix-git/doc/guix.texi:12370
21611 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."
21615 #: guix-git/doc/guix.texi:12373
21616 msgid "For this type of graph, it is also possible to pass a @file{.drv} file name instead of a package name, as in:"
21620 #: guix-git/doc/guix.texi:12376
21622 msgid "guix graph -t derivation $(guix system build -d my-config.scm)\n"
21626 #: guix-git/doc/guix.texi:12378
21632 #: guix-git/doc/guix.texi:12382
21633 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:"
21637 #: guix-git/doc/guix.texi:12385
21639 msgid "guix graph -t module guile | xdot -\n"
21642 #. type: Plain text
21643 #: guix-git/doc/guix.texi:12390
21644 msgid "All the types above correspond to @emph{build-time dependencies}. The following graph type represents the @emph{run-time dependencies}:"
21648 #: guix-git/doc/guix.texi:12395
21649 msgid "This is the graph of @dfn{references} of a package output, as returned by @command{guix gc --references} (@pxref{Invoking guix gc})."
21653 #: guix-git/doc/guix.texi:12398
21654 msgid "If the given package output is not available in the store, @command{guix graph} attempts to obtain dependency information from substitutes."
21658 #: guix-git/doc/guix.texi:12402
21659 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!):"
21663 #: guix-git/doc/guix.texi:12405
21665 msgid "guix graph -t references $(readlink -f ~/.guix-profile)\n"
21669 #: guix-git/doc/guix.texi:12407
21675 #: guix-git/doc/guix.texi:12410
21676 msgid "This is the graph of the @dfn{referrers} of a store item, as returned by @command{guix gc --referrers} (@pxref{Invoking guix gc})."
21680 #: guix-git/doc/guix.texi:12416
21681 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."
21685 #: guix-git/doc/guix.texi:12419
21686 msgid "It can help determine what is preventing a store item from being garbage collected."
21690 #: guix-git/doc/guix.texi:12422
21692 msgid "shortest path, between packages"
21695 #. type: Plain text
21696 #: guix-git/doc/guix.texi:12429
21697 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.):"
21701 #: guix-git/doc/guix.texi:12443
21704 "$ guix graph --path emacs libunistring\n"
21707 "libunistring@@0.9.10\n"
21708 "$ guix graph --path -t derivation emacs libunistring\n"
21709 "/gnu/store/@dots{}-emacs-26.3.drv\n"
21710 "/gnu/store/@dots{}-mailutils-3.9.drv\n"
21711 "/gnu/store/@dots{}-libunistring-0.9.10.drv\n"
21712 "$ guix graph --path -t references emacs libunistring\n"
21713 "/gnu/store/@dots{}-emacs-26.3\n"
21714 "/gnu/store/@dots{}-libidn2-2.2.0\n"
21715 "/gnu/store/@dots{}-libunistring-0.9.10\n"
21718 #. type: Plain text
21719 #: guix-git/doc/guix.texi:12446
21720 msgid "The available options are the following:"
21724 #: guix-git/doc/guix.texi:12452
21725 msgid "Produce a graph output of @var{type}, where @var{type} must be one of the values listed above."
21729 #: guix-git/doc/guix.texi:12453
21731 msgid "--list-types"
21735 #: guix-git/doc/guix.texi:12455
21736 msgid "List the supported graph types."
21740 #: guix-git/doc/guix.texi:12456
21742 msgid "--backend=@var{backend}"
21746 #: guix-git/doc/guix.texi:12457
21748 msgid "-b @var{backend}"
21752 #: guix-git/doc/guix.texi:12459
21753 msgid "Produce a graph using the selected @var{backend}."
21757 #: guix-git/doc/guix.texi:12460
21759 msgid "--list-backends"
21763 #: guix-git/doc/guix.texi:12462
21764 msgid "List the supported graph backends."
21768 #: guix-git/doc/guix.texi:12464
21769 msgid "Currently, the available backends are Graphviz and d3.js."
21773 #: guix-git/doc/guix.texi:12465
21779 #: guix-git/doc/guix.texi:12470
21780 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}:"
21784 #: guix-git/doc/guix.texi:12477
21787 "$ guix graph --path -t references libreoffice llvm\n"
21788 "/gnu/store/@dots{}-libreoffice-6.4.2.2\n"
21789 "/gnu/store/@dots{}-libepoxy-1.5.4\n"
21790 "/gnu/store/@dots{}-mesa-19.3.4\n"
21791 "/gnu/store/@dots{}-llvm-9.0.1\n"
21795 #: guix-git/doc/guix.texi:12487
21797 msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n"
21801 #: guix-git/doc/guix.texi:12492
21802 msgid "Display the graph for @var{system}---e.g., @code{i686-linux}."
21806 #: guix-git/doc/guix.texi:12495
21807 msgid "The package dependency graph is largely architecture-independent, but there are some architecture-dependent bits that this option allows you to visualize."
21810 #. type: Plain text
21811 #: guix-git/doc/guix.texi:12511
21812 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:"
21816 #: guix-git/doc/guix.texi:12514
21818 msgid "guix graph git --with-input=openssl=libressl\n"
21821 #. type: Plain text
21822 #: guix-git/doc/guix.texi:12517
21823 msgid "So many possibilities, so much fun!"
21827 #: guix-git/doc/guix.texi:12519
21829 msgid "Invoking @command{guix publish}"
21832 #. type: command{#1}
21833 #: guix-git/doc/guix.texi:12521
21835 msgid "guix publish"
21838 #. type: Plain text
21839 #: guix-git/doc/guix.texi:12525
21840 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})."
21843 #. type: Plain text
21844 #: guix-git/doc/guix.texi:12531
21845 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."
21848 #. type: Plain text
21849 #: guix-git/doc/guix.texi:12537
21850 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."
21853 #. type: Plain text
21854 #: guix-git/doc/guix.texi:12541
21855 msgid "The signing key pair must be generated before @command{guix publish} is launched, using @command{guix archive --generate-key} (@pxref{Invoking guix archive})."
21858 #. type: Plain text
21859 #: guix-git/doc/guix.texi:12546
21860 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})."
21864 #: guix-git/doc/guix.texi:12551
21866 msgid "guix publish @var{options}@dots{}\n"
21869 #. type: Plain text
21870 #: guix-git/doc/guix.texi:12555
21871 msgid "Running @command{guix publish} without any additional arguments will spawn an HTTP server on port 8080:"
21875 #: guix-git/doc/guix.texi:12558
21877 msgid "guix publish\n"
21880 #. type: Plain text
21881 #: guix-git/doc/guix.texi:12562
21882 msgid "Once a publishing server has been authorized, the daemon may download substitutes from it. @xref{Getting Substitutes from Other Servers}."
21885 #. type: Plain text
21886 #: guix-git/doc/guix.texi:12570
21887 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})."
21890 #. type: Plain text
21891 #: guix-git/doc/guix.texi:12577
21892 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}):"
21896 #: guix-git/doc/guix.texi:12580
21898 msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n"
21901 #. type: Plain text
21902 #: guix-git/doc/guix.texi:12584
21903 msgid "Obviously, these URLs only work for files that are in the store; in other cases, they return 404 (``Not Found'')."
21907 #: guix-git/doc/guix.texi:12585
21909 msgid "build logs, publication"
21912 #. type: Plain text
21913 #: guix-git/doc/guix.texi:12587
21914 msgid "Build logs are available from @code{/log} URLs like:"
21918 #: guix-git/doc/guix.texi:12590
21920 msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n"
21923 #. type: Plain text
21924 #: guix-git/doc/guix.texi:12600
21925 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."
21929 #: guix-git/doc/guix.texi:12604
21931 msgid "--port=@var{port}"
21935 #: guix-git/doc/guix.texi:12605
21937 msgid "-p @var{port}"
21941 #: guix-git/doc/guix.texi:12607
21942 msgid "Listen for HTTP requests on @var{port}."
21946 #: guix-git/doc/guix.texi:12608
21948 msgid "--listen=@var{host}"
21952 #: guix-git/doc/guix.texi:12611
21953 msgid "Listen on the network interface for @var{host}. The default is to accept connections from any interface."
21957 #: guix-git/doc/guix.texi:12616
21958 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."
21962 #: guix-git/doc/guix.texi:12617
21964 msgid "--compression[=@var{method}[:@var{level}]]"
21968 #: guix-git/doc/guix.texi:12618
21970 msgid "-C [@var{method}[:@var{level}]]"
21974 #: guix-git/doc/guix.texi:12622
21975 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."
21979 #: guix-git/doc/guix.texi:12626
21980 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."
21984 #: guix-git/doc/guix.texi:12633
21985 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."
21989 #: guix-git/doc/guix.texi:12637
21990 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}."
21994 #: guix-git/doc/guix.texi:12646
21995 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."
21999 #: guix-git/doc/guix.texi:12651
22000 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."
22004 #: guix-git/doc/guix.texi:12652
22006 msgid "--cache=@var{directory}"
22010 #: guix-git/doc/guix.texi:12653
22012 msgid "-c @var{directory}"
22016 #: guix-git/doc/guix.texi:12656
22017 msgid "Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and only serve archives that are in cache."
22021 #: guix-git/doc/guix.texi:12664
22022 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."
22026 #: guix-git/doc/guix.texi:12672
22027 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."
22031 #: guix-git/doc/guix.texi:12679
22032 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."
22036 #: guix-git/doc/guix.texi:12683
22037 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."
22041 #: guix-git/doc/guix.texi:12686
22042 msgid "When @option{--ttl} is used, cached entries are automatically deleted when they have expired."
22046 #: guix-git/doc/guix.texi:12687
22048 msgid "--workers=@var{N}"
22052 #: guix-git/doc/guix.texi:12690
22053 msgid "When @option{--cache} is used, request the allocation of @var{N} worker threads to ``bake'' archives."
22057 #: guix-git/doc/guix.texi:12691
22059 msgid "--ttl=@var{ttl}"
22063 #: guix-git/doc/guix.texi:12695
22064 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."
22068 #: guix-git/doc/guix.texi:12700
22069 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}."
22073 #: guix-git/doc/guix.texi:12704
22074 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."
22078 #: guix-git/doc/guix.texi:12705
22080 msgid "--cache-bypass-threshold=@var{size}"
22084 #: guix-git/doc/guix.texi:12710
22085 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}."
22089 #: guix-git/doc/guix.texi:12715
22090 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."
22094 #: guix-git/doc/guix.texi:12719
22095 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."
22099 #: guix-git/doc/guix.texi:12720
22101 msgid "--nar-path=@var{path}"
22105 #: guix-git/doc/guix.texi:12723
22106 msgid "Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Invoking guix archive, normalized archives})."
22110 #: guix-git/doc/guix.texi:12727
22111 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}."
22115 #: guix-git/doc/guix.texi:12728
22117 msgid "--public-key=@var{file}"
22121 #: guix-git/doc/guix.texi:12729
22123 msgid "--private-key=@var{file}"
22127 #: guix-git/doc/guix.texi:12732 guix-git/doc/guix.texi:27359
22128 #: guix-git/doc/guix.texi:27393
22129 msgid "Use the specific @var{file}s as the public/private key pair used to sign the store items being published."
22133 #: guix-git/doc/guix.texi:12739
22134 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."
22138 #: guix-git/doc/guix.texi:12740
22140 msgid "--repl[=@var{port}]"
22144 #: guix-git/doc/guix.texi:12741
22146 msgid "-r [@var{port}]"
22150 #: guix-git/doc/guix.texi:12745
22151 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."
22154 #. type: Plain text
22155 #: guix-git/doc/guix.texi:12751
22156 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}})."
22159 #. type: Plain text
22160 #: guix-git/doc/guix.texi:12754
22161 msgid "If you are instead running Guix on a ``foreign distro'', follow these instructions:"
22165 #: guix-git/doc/guix.texi:12758
22166 msgid "If your host distro uses the systemd init system:"
22170 #: guix-git/doc/guix.texi:12763
22173 "# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \\\n"
22174 " /etc/systemd/system/\n"
22175 "# systemctl start guix-publish && systemctl enable guix-publish\n"
22179 #: guix-git/doc/guix.texi:12771
22182 "# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n"
22183 "# start guix-publish\n"
22187 #: guix-git/doc/guix.texi:12775
22188 msgid "Otherwise, proceed similarly with your distro's init system."
22192 #: guix-git/doc/guix.texi:12778
22194 msgid "Invoking @command{guix challenge}"
22198 #: guix-git/doc/guix.texi:12781
22200 msgid "verifiable builds"
22203 #. type: command{#1}
22204 #: guix-git/doc/guix.texi:12782
22206 msgid "guix challenge"
22210 #: guix-git/doc/guix.texi:12783
22215 #. type: Plain text
22216 #: guix-git/doc/guix.texi:12788
22217 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."
22220 #. type: Plain text
22221 #: guix-git/doc/guix.texi:12796
22222 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."
22225 #. type: Plain text
22226 #: guix-git/doc/guix.texi:12805
22227 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."
22230 #. type: Plain text
22231 #: guix-git/doc/guix.texi:12807
22232 msgid "The command output looks like this:"
22235 #. type: smallexample
22236 #: guix-git/doc/guix.texi:12819
22239 "$ guix challenge --substitute-urls=\"https://@value{SUBSTITUTE-SERVER} https://guix.example.org\"\n"
22240 "updating list of substitutes from 'https://@value{SUBSTITUTE-SERVER}'... 100.0%\n"
22241 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
22242 "/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n"
22243 " local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
22244 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n"
22245 " https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n"
22246 " differing files:\n"
22247 " /lib/libcrypto.so.1.1\n"
22248 " /lib/libssl.so.1.1\n"
22252 #. type: smallexample
22253 #: guix-git/doc/guix.texi:12826
22256 "/gnu/store/@dots{}-git-2.5.0 contents differ:\n"
22257 " local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n"
22258 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n"
22259 " https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n"
22260 " differing file:\n"
22261 " /libexec/git-core/git-fsck\n"
22265 #. type: smallexample
22266 #: guix-git/doc/guix.texi:12833
22269 "/gnu/store/@dots{}-pius-2.1.1 contents differ:\n"
22270 " local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
22271 " https://@value{SUBSTITUTE-SERVER}/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n"
22272 " https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n"
22273 " differing file:\n"
22274 " /share/man/man1/pius.1.gz\n"
22278 #. type: smallexample
22279 #: guix-git/doc/guix.texi:12835
22286 #. type: smallexample
22287 #: guix-git/doc/guix.texi:12840
22290 "6,406 store items were analyzed:\n"
22291 " - 4,749 (74.1%) were identical\n"
22292 " - 525 (8.2%) differed\n"
22293 " - 1,132 (17.7%) were inconclusive\n"
22296 #. type: Plain text
22297 #: guix-git/doc/guix.texi:12848
22298 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."
22302 #: guix-git/doc/guix.texi:12849
22304 msgid "non-determinism, in package builds"
22307 #. type: Plain text
22308 #: guix-git/doc/guix.texi:12860
22309 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."
22312 #. type: Plain text
22313 #: guix-git/doc/guix.texi:12863
22314 msgid "To find out what is wrong with this Git binary, the easiest approach is to run:"
22318 #: guix-git/doc/guix.texi:12868
22321 "guix challenge git \\\n"
22322 " --diff=diffoscope \\\n"
22323 " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER} https://guix.example.org\"\n"
22326 #. type: Plain text
22327 #: guix-git/doc/guix.texi:12872
22328 msgid "This automatically invokes @command{diffoscope}, which displays detailed information about files that differ."
22331 #. type: Plain text
22332 #: guix-git/doc/guix.texi:12875
22333 msgid "Alternatively, we can do something along these lines (@pxref{Invoking guix archive}):"
22337 #: guix-git/doc/guix.texi:12880
22340 "$ wget -q -O - https://@value{SUBSTITUTE-SERVER}/nar/lzip/@dots{}-git-2.5.0 \\\n"
22341 " | lzip -d | guix archive -x /tmp/git\n"
22342 "$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git\n"
22345 #. type: Plain text
22346 #: guix-git/doc/guix.texi:12889
22347 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."
22350 #. type: Plain text
22351 #: guix-git/doc/guix.texi:12897
22352 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."
22355 #. type: Plain text
22356 #: guix-git/doc/guix.texi:12901
22357 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:"
22361 #: guix-git/doc/guix.texi:12904
22363 msgid "$ guix challenge @var{package}\n"
22366 #. type: Plain text
22367 #: guix-git/doc/guix.texi:12909
22368 msgid "where @var{package} is a package specification such as @code{guile@@2.0} or @code{glibc:debug}."
22372 #: guix-git/doc/guix.texi:12914
22374 msgid "guix challenge @var{options} [@var{packages}@dots{}]\n"
22377 #. type: Plain text
22378 #: guix-git/doc/guix.texi:12921
22379 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)."
22382 #. type: Plain text
22383 #: guix-git/doc/guix.texi:12923
22384 msgid "The one option that matters is:"
22388 #: guix-git/doc/guix.texi:12929
22389 msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs to compare to."
22393 #: guix-git/doc/guix.texi:12930
22395 msgid "--diff=@var{mode}"
22399 #: guix-git/doc/guix.texi:12932
22400 msgid "Upon mismatches, show differences according to @var{mode}, one of:"
22404 #: guix-git/doc/guix.texi:12934
22406 msgid "@code{simple} (the default)"
22410 #: guix-git/doc/guix.texi:12936
22411 msgid "Show the list of files that differ."
22415 #: guix-git/doc/guix.texi:12937
22421 #: guix-git/doc/guix.texi:12938
22427 #: guix-git/doc/guix.texi:12941
22428 msgid "Invoke @uref{https://diffoscope.org/, Diffoscope}, passing it two directories whose contents do not match."
22432 #: guix-git/doc/guix.texi:12944
22433 msgid "When @var{command} is an absolute file name, run @var{command} instead of Diffoscope."
22437 #: guix-git/doc/guix.texi:12945 guix-git/doc/guix.texi:16257
22438 #: guix-git/doc/guix.texi:18246
22444 #: guix-git/doc/guix.texi:12947
22445 msgid "Do not show further details about the differences."
22449 #: guix-git/doc/guix.texi:12952
22450 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."
22454 #: guix-git/doc/guix.texi:12953
22460 #: guix-git/doc/guix.texi:12954
22466 #: guix-git/doc/guix.texi:12957
22467 msgid "Show details about matches (identical contents) in addition to information about mismatches."
22471 #: guix-git/doc/guix.texi:12961
22473 msgid "Invoking @command{guix copy}"
22477 #: guix-git/doc/guix.texi:12963
22479 msgid "copy, of store items, over SSH"
22483 #: guix-git/doc/guix.texi:12964
22485 msgid "SSH, copy of store items"
22489 #: guix-git/doc/guix.texi:12965
22491 msgid "sharing store items across machines"
22495 #: guix-git/doc/guix.texi:12966
22497 msgid "transferring store items across machines"
22500 #. type: Plain text
22501 #: guix-git/doc/guix.texi:12973
22502 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}:"
22506 #: guix-git/doc/guix.texi:12977
22509 "guix copy --to=@var{user}@@@var{host} \\\n"
22510 " coreutils $(readlink -f ~/.guix-profile)\n"
22513 #. type: Plain text
22514 #: guix-git/doc/guix.texi:12981
22515 msgid "If some of the items to be copied are already present on @var{host}, they are not actually sent."
22518 #. type: Plain text
22519 #: guix-git/doc/guix.texi:12984
22520 msgid "The command below retrieves @code{libreoffice} and @code{gimp} from @var{host}, assuming they are available there:"
22524 #: guix-git/doc/guix.texi:12987
22526 msgid "guix copy --from=@var{host} libreoffice gimp\n"
22529 #. type: Plain text
22530 #: guix-git/doc/guix.texi:12992
22531 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."
22534 #. type: Plain text
22535 #: guix-git/doc/guix.texi:12998
22536 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."
22540 #: guix-git/doc/guix.texi:13003
22542 msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n"
22545 #. type: Plain text
22546 #: guix-git/doc/guix.texi:13006
22547 msgid "You must always specify one of the following options:"
22551 #: guix-git/doc/guix.texi:13008
22553 msgid "--to=@var{spec}"
22557 #: guix-git/doc/guix.texi:13009
22559 msgid "--from=@var{spec}"
22563 #: guix-git/doc/guix.texi:13013
22564 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}."
22567 #. type: Plain text
22568 #: guix-git/doc/guix.texi:13017
22569 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}."
22572 #. type: Plain text
22573 #: guix-git/doc/guix.texi:13021
22574 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})."
22578 #: guix-git/doc/guix.texi:13024
22580 msgid "Invoking @command{guix container}"
22583 #. type: command{#1}
22584 #: guix-git/doc/guix.texi:13026
22586 msgid "guix container"
22590 #: guix-git/doc/guix.texi:13030
22591 msgid "As of version @value{VERSION}, this tool is experimental. The interface is subject to radical change in the future."
22594 #. type: Plain text
22595 #: guix-git/doc/guix.texi:13037
22596 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."
22600 #: guix-git/doc/guix.texi:13042
22602 msgid "guix container @var{action} @var{options}@dots{}\n"
22605 #. type: Plain text
22606 #: guix-git/doc/guix.texi:13046
22607 msgid "@var{action} specifies the operation to perform with a container, and @var{options} specifies the context-specific arguments for the action."
22610 #. type: Plain text
22611 #: guix-git/doc/guix.texi:13048
22612 msgid "The following actions are available:"
22616 #: guix-git/doc/guix.texi:13050
22622 #: guix-git/doc/guix.texi:13052
22623 msgid "Execute a command within the context of a running container."
22627 #: guix-git/doc/guix.texi:13054
22628 msgid "The syntax is:"
22632 #: guix-git/doc/guix.texi:13057
22634 msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n"
22638 #: guix-git/doc/guix.texi:13063
22639 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}."
22643 #: guix-git/doc/guix.texi:13067
22644 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:"
22648 #: guix-git/doc/guix.texi:13070
22650 msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n"
22654 #: guix-git/doc/guix.texi:13074
22655 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."
22659 #: guix-git/doc/guix.texi:13078
22661 msgid "Invoking @command{guix weather}"
22664 #. type: Plain text
22665 #: guix-git/doc/guix.texi:13087
22666 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})."
22670 #: guix-git/doc/guix.texi:13088
22672 msgid "statistics, for substitutes"
22676 #: guix-git/doc/guix.texi:13089
22678 msgid "availability of substitutes"
22682 #: guix-git/doc/guix.texi:13090
22684 msgid "substitute availability"
22688 #: guix-git/doc/guix.texi:13091
22690 msgid "weather, substitute availability"
22693 #. type: Plain text
22694 #: guix-git/doc/guix.texi:13093
22695 msgid "Here's a sample run:"
22699 #: guix-git/doc/guix.texi:13105
22702 "$ guix weather --substitute-urls=https://guix.example.org\n"
22703 "computing 5,872 package derivations for x86_64-linux...\n"
22704 "looking for 6,128 store items on https://guix.example.org..\n"
22705 "updating list of substitutes from 'https://guix.example.org'... 100.0%\n"
22706 "https://guix.example.org\n"
22707 " 43.4% substitutes available (2,658 out of 6,128)\n"
22708 " 7,032.5 MiB of nars (compressed)\n"
22709 " 19,824.2 MiB on disk (uncompressed)\n"
22710 " 0.030 seconds per request (182.9 seconds in total)\n"
22711 " 33.5 requests per second\n"
22716 #: guix-git/doc/guix.texi:13115
22719 " 9.8% (342 out of 3,470) of the missing items are queued\n"
22720 " 867 queued builds\n"
22721 " x86_64-linux: 518 (59.7%)\n"
22722 " i686-linux: 221 (25.5%)\n"
22723 " aarch64-linux: 128 (14.8%)\n"
22724 " build rate: 23.41 builds per hour\n"
22725 " x86_64-linux: 11.16 builds per hour\n"
22726 " i686-linux: 6.03 builds per hour\n"
22727 " aarch64-linux: 6.41 builds per hour\n"
22731 #: guix-git/doc/guix.texi:13117
22733 msgid "continuous integration, statistics"
22736 #. type: Plain text
22737 #: guix-git/doc/guix.texi:13128
22738 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)."
22741 #. type: Plain text
22742 #: guix-git/doc/guix.texi:13134
22743 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."
22747 #: guix-git/doc/guix.texi:13139
22749 msgid "guix weather @var{options}@dots{} [@var{packages}@dots{}]\n"
22752 #. type: Plain text
22753 #: guix-git/doc/guix.texi:13147
22754 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%."
22757 #. type: Plain text
22758 #: guix-git/doc/guix.texi:13149
22759 msgid "The available options are listed below."
22763 #: guix-git/doc/guix.texi:13155
22764 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."
22768 #: guix-git/doc/guix.texi:13161
22769 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."
22773 #: guix-git/doc/guix.texi:13167
22774 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})."
22778 #: guix-git/doc/guix.texi:13170
22779 msgid "This option can be repeated several times, in which case the manifests are concatenated."
22783 #: guix-git/doc/guix.texi:13171
22785 msgid "--coverage[=@var{count}]"
22789 #: guix-git/doc/guix.texi:13172
22791 msgid "-c [@var{count}]"
22795 #: guix-git/doc/guix.texi:13178
22796 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:"
22800 #: guix-git/doc/guix.texi:13192
22803 "$ guix weather --substitute-urls=@value{SUBSTITUTE-URL} -c 10\n"
22804 "computing 8,983 package derivations for x86_64-linux...\n"
22805 "looking for 9,343 store items on @value{SUBSTITUTE-URL}...\n"
22806 "updating substitutes from '@value{SUBSTITUTE-URL}'... 100.0%\n"
22807 "@value{SUBSTITUTE-URL}\n"
22808 " 64.7% substitutes available (6,047 out of 9,343)\n"
22810 "2502 packages are missing from '@value{SUBSTITUTE-URL}' for 'x86_64-linux', among which:\n"
22811 " 58 kcoreaddons@@5.49.0 /gnu/store/@dots{}-kcoreaddons-5.49.0\n"
22812 " 46 qgpgme@@1.11.1 /gnu/store/@dots{}-qgpgme-1.11.1\n"
22813 " 37 perl-http-cookiejar@@0.008 /gnu/store/@dots{}-perl-http-cookiejar-0.008\n"
22818 #: guix-git/doc/guix.texi:13198
22819 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."
22823 #: guix-git/doc/guix.texi:13202
22824 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."
22828 #: guix-git/doc/guix.texi:13203
22830 msgid "--display-missing"
22834 #: guix-git/doc/guix.texi:13205
22835 msgid "Display the list of store items for which substitutes are missing."
22839 #: guix-git/doc/guix.texi:13208
22841 msgid "Invoking @command{guix processes}"
22844 #. type: Plain text
22845 #: guix-git/doc/guix.texi:13216
22846 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:"
22850 #: guix-git/doc/guix.texi:13222
22853 "$ sudo guix processes\n"
22854 "SessionPID: 19002\n"
22855 "ClientPID: 19090\n"
22856 "ClientCommand: guix environment --ad-hoc python\n"
22861 #: guix-git/doc/guix.texi:13226
22864 "SessionPID: 19402\n"
22865 "ClientPID: 19367\n"
22866 "ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{}\n"
22871 #: guix-git/doc/guix.texi:13239
22874 "SessionPID: 19444\n"
22875 "ClientPID: 19419\n"
22876 "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
22877 "LockHeld: /gnu/store/@dots{}-perl-ipc-cmd-0.96.lock\n"
22878 "LockHeld: /gnu/store/@dots{}-python-six-bootstrap-1.11.0.lock\n"
22879 "LockHeld: /gnu/store/@dots{}-libjpeg-turbo-2.0.0.lock\n"
22880 "ChildPID: 20495\n"
22881 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22882 "ChildPID: 27733\n"
22883 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22884 "ChildPID: 27793\n"
22885 "ChildCommand: guix offload x86_64-linux 7200 1 28800\n"
22888 #. type: Plain text
22889 #: guix-git/doc/guix.texi:13246
22890 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."
22893 #. type: Plain text
22894 #: guix-git/doc/guix.texi:13253
22895 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})."
22898 #. type: Plain text
22899 #: guix-git/doc/guix.texi:13258
22900 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:"
22904 #: guix-git/doc/guix.texi:13264
22907 "$ sudo guix processes | \\\n"
22908 " recsel -p ClientPID,ClientCommand -e 'LockHeld ~ \"perl\"'\n"
22909 "ClientPID: 19419\n"
22910 "ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{}\n"
22913 #. type: Plain text
22914 #: guix-git/doc/guix.texi:13267
22915 msgid "Additional options are listed below."
22919 #: guix-git/doc/guix.texi:13277
22920 msgid "The default option. It outputs a set of Session recutils records that include each @code{ChildProcess} as a field."
22924 #: guix-git/doc/guix.texi:13278
22930 #: guix-git/doc/guix.texi:13285
22931 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}."
22935 #: guix-git/doc/guix.texi:13295
22938 "$ guix processes --format=normalized | \\\n"
22941 " -t ChildProcess \\\n"
22942 " -p Session.PID,PID \\\n"
22943 " -e 'Session.ClientCommand ~ \"guix build\"'\n"
22945 "Session_PID: 4278\n"
22950 #: guix-git/doc/guix.texi:13298
22954 "Session_PID: 4278\n"
22959 #: guix-git/doc/guix.texi:13301
22963 "Session_PID: 4278\n"
22967 #: guix-git/doc/guix.texi:13308
22969 msgid "system configuration"
22972 #. type: Plain text
22973 #: guix-git/doc/guix.texi:13314
22974 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."
22977 #. type: Plain text
22978 #: guix-git/doc/guix.texi:13324
22979 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."
22982 #. type: Plain text
22983 #: guix-git/doc/guix.texi:13329
22984 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."
22987 #. type: Plain text
22988 #: guix-git/doc/guix.texi:13358
22989 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:"
22993 #: guix-git/doc/guix.texi:13359 guix-git/doc/guix.texi:33410
22995 msgid "operating-system"
22999 #: guix-git/doc/guix.texi:13361
23001 msgid "os-config-bare-bones.texi"
23004 #. type: Plain text
23005 #: guix-git/doc/guix.texi:13368
23006 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."
23009 #. type: Plain text
23010 #: guix-git/doc/guix.texi:13373
23011 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}."
23014 #. type: unnumberedsubsec
23015 #: guix-git/doc/guix.texi:13374
23021 #: guix-git/doc/guix.texi:13376
23023 msgid "legacy boot, on Intel machines"
23027 #: guix-git/doc/guix.texi:13377
23029 msgid "BIOS boot, on Intel machines"
23033 #: guix-git/doc/guix.texi:13378
23039 #: guix-git/doc/guix.texi:13379
23044 #. type: Plain text
23045 #: guix-git/doc/guix.texi:13385
23046 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:"
23050 #: guix-git/doc/guix.texi:13390
23053 "(bootloader-configuration\n"
23054 " (bootloader grub-efi-bootloader)\n"
23055 " (target \"/boot/efi\"))\n"
23058 #. type: Plain text
23059 #: guix-git/doc/guix.texi:13394
23060 msgid "@xref{Bootloader Configuration}, for more information on the available configuration options."
23063 #. type: unnumberedsubsec
23064 #: guix-git/doc/guix.texi:13395
23066 msgid "Globally-Visible Packages"
23070 #: guix-git/doc/guix.texi:13397
23072 msgid "%base-packages"
23075 #. type: Plain text
23076 #: guix-git/doc/guix.texi:13410
23077 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:"
23081 #: guix-git/doc/guix.texi:13414
23084 "(use-modules (gnu packages))\n"
23085 "(use-modules (gnu packages dns))\n"
23090 #: guix-git/doc/guix.texi:13419
23093 "(operating-system\n"
23095 " (packages (cons (list bind \"utils\")\n"
23096 " %base-packages)))\n"
23100 #: guix-git/doc/guix.texi:13421
23102 msgid "specification->package"
23105 #. type: Plain text
23106 #: guix-git/doc/guix.texi:13430
23107 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:"
23111 #: guix-git/doc/guix.texi:13433
23114 "(use-modules (gnu packages))\n"
23119 #: guix-git/doc/guix.texi:13439
23122 "(operating-system\n"
23124 " (packages (append (map specification->package\n"
23125 " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n"
23126 " %base-packages)))\n"
23129 #. type: unnumberedsubsec
23130 #: guix-git/doc/guix.texi:13441
23132 msgid "System Services"
23136 #: guix-git/doc/guix.texi:13443 guix-git/doc/guix.texi:32193
23137 #: guix-git/doc/guix.texi:33635
23143 #: guix-git/doc/guix.texi:13444
23145 msgid "%base-services"
23148 #. type: Plain text
23149 #: guix-git/doc/guix.texi:13454
23150 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})."
23154 #: guix-git/doc/guix.texi:13455
23156 msgid "customization, of services"
23160 #: guix-git/doc/guix.texi:13456
23162 msgid "modify-services"
23165 #. type: Plain text
23166 #: guix-git/doc/guix.texi:13460
23167 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."
23170 #. type: Plain text
23171 #: guix-git/doc/guix.texi:13465
23172 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:"
23176 #: guix-git/doc/guix.texi:13482
23179 "(define %my-services\n"
23180 " ;; My very own list of services.\n"
23181 " (modify-services %base-services\n"
23182 " (guix-service-type config =>\n"
23183 " (guix-configuration\n"
23184 " (inherit config)\n"
23185 " ;; Fetch substitutes from example.org.\n"
23186 " (substitute-urls\n"
23187 " (list \"https://example.org/guix\"\n"
23188 " \"https://ci.guix.gnu.org\"))))\n"
23189 " (mingetty-service-type config =>\n"
23190 " (mingetty-configuration\n"
23191 " (inherit config)\n"
23192 " ;; Automatially log in as \"guest\".\n"
23193 " (auto-login \"guest\")))))\n"
23198 #: guix-git/doc/guix.texi:13486
23201 "(operating-system\n"
23203 " (services %my-services))\n"
23206 #. type: Plain text
23207 #: guix-git/doc/guix.texi:13497
23208 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."
23211 #. type: Plain text
23212 #: guix-git/doc/guix.texi:13504
23213 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:"
23217 #: guix-git/doc/guix.texi:13506
23219 msgid "os-config-desktop.texi"
23222 #. type: Plain text
23223 #: guix-git/doc/guix.texi:13511
23224 msgid "A graphical system with a choice of lightweight window managers instead of full-blown desktop environments would look like this:"
23228 #: guix-git/doc/guix.texi:13513
23230 msgid "os-config-lightweight-desktop.texi"
23233 #. type: Plain text
23234 #: guix-git/doc/guix.texi:13519
23235 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."
23238 #. type: Plain text
23239 #: guix-git/doc/guix.texi:13523
23240 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."
23243 #. type: Plain text
23244 #: guix-git/doc/guix.texi:13530
23245 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:"
23249 #: guix-git/doc/guix.texi:13535
23252 "(remove (lambda (service)\n"
23253 " (eq? (service-kind service) avahi-service-type))\n"
23254 " %desktop-services)\n"
23257 #. type: Plain text
23258 #: guix-git/doc/guix.texi:13538
23259 msgid "Alternatively, the @code{modify-services} macro can be used:"
23263 #: guix-git/doc/guix.texi:13542
23266 "(modify-services %desktop-services\n"
23267 " (delete avahi-service-type))\n"
23270 #. type: unnumberedsubsec
23271 #: guix-git/doc/guix.texi:13545
23273 msgid "Instantiating the System"
23276 #. type: Plain text
23277 #: guix-git/doc/guix.texi:13552
23278 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})."
23281 #. type: Plain text
23282 #: guix-git/doc/guix.texi:13560
23283 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."
23287 #: guix-git/doc/guix.texi:13561
23289 msgid "roll-back, of the operating system"
23292 #. type: Plain text
23293 #: guix-git/doc/guix.texi:13571
23294 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}."
23297 #. type: Plain text
23298 #: guix-git/doc/guix.texi:13577
23299 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})."
23302 #. type: unnumberedsubsec
23303 #: guix-git/doc/guix.texi:13578
23305 msgid "The Programming Interface"
23308 #. type: Plain text
23309 #: guix-git/doc/guix.texi:13583
23310 msgid "At the Scheme level, the bulk of an @code{operating-system} declaration is instantiated with the following monadic procedure (@pxref{The Store Monad}):"
23314 #: guix-git/doc/guix.texi:13584
23316 msgid "{Monadic Procedure} operating-system-derivation os"
23320 #: guix-git/doc/guix.texi:13587
23321 msgid "Return a derivation that builds @var{os}, an @code{operating-system} object (@pxref{Derivations})."
23325 #: guix-git/doc/guix.texi:13591
23326 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}."
23329 #. type: Plain text
23330 #: guix-git/doc/guix.texi:13596
23331 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!"
23335 #: guix-git/doc/guix.texi:13599
23337 msgid "@code{operating-system} Reference"
23340 #. type: Plain text
23341 #: guix-git/doc/guix.texi:13604
23342 msgid "This section summarizes all the options available in @code{operating-system} declarations (@pxref{Using the Configuration System})."
23346 #: guix-git/doc/guix.texi:13605
23348 msgid "{Data Type} operating-system"
23352 #: guix-git/doc/guix.texi:13609
23353 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})."
23357 #: guix-git/doc/guix.texi:13611
23359 msgid "@code{kernel} (default: @code{linux-libre})"
23363 #: guix-git/doc/guix.texi:13616
23364 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.}."
23368 #: guix-git/doc/guix.texi:13617 guix-git/doc/guix.texi:28901
23374 #: guix-git/doc/guix.texi:13618
23376 msgid "@code{hurd} (default: @code{#f})"
23380 #: guix-git/doc/guix.texi:13623
23381 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."
23385 #: guix-git/doc/guix.texi:13626
23386 msgid "This feature is experimental and only supported for disk images."
23390 #: guix-git/doc/guix.texi:13628
23392 msgid "@code{kernel-loadable-modules} (default: '())"
23396 #: guix-git/doc/guix.texi:13631
23397 msgid "A list of objects (usually packages) to collect loadable kernel modules from--e.g. @code{(list ddcci-driver-linux)}."
23401 #: guix-git/doc/guix.texi:13632
23403 msgid "@code{kernel-arguments} (default: @code{%default-kernel-arguments})"
23407 #: guix-git/doc/guix.texi:13635
23408 msgid "List of strings or gexps representing additional arguments to pass on the command-line of the kernel---e.g., @code{(\"console=ttyS0\")}."
23412 #: guix-git/doc/guix.texi:13636 guix-git/doc/guix.texi:32406
23413 #: guix-git/doc/guix.texi:32425
23419 #: guix-git/doc/guix.texi:13638
23420 msgid "The system bootloader configuration object. @xref{Bootloader Configuration}."
23424 #: guix-git/doc/guix.texi:13639 guix-git/doc/guix.texi:32595
23430 #: guix-git/doc/guix.texi:13642
23431 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."
23435 #: guix-git/doc/guix.texi:13643 guix-git/doc/guix.texi:18070
23436 #: guix-git/doc/guix.texi:32525
23438 msgid "@code{keyboard-layout} (default: @code{#f})"
23442 #: guix-git/doc/guix.texi:13648
23443 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."
23447 #: guix-git/doc/guix.texi:13653
23448 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})."
23452 #: guix-git/doc/guix.texi:13660
23453 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."
23457 #: guix-git/doc/guix.texi:13662
23459 msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})"
23463 #: guix-git/doc/guix.texi:13663 guix-git/doc/guix.texi:32230
23464 #: guix-git/doc/guix.texi:32334
23470 #: guix-git/doc/guix.texi:13664 guix-git/doc/guix.texi:32231
23471 #: guix-git/doc/guix.texi:32335
23473 msgid "initial RAM disk"
23477 #: guix-git/doc/guix.texi:13667
23478 msgid "The list of Linux kernel modules that need to be available in the initial RAM disk. @xref{Initial RAM Disk}."
23482 #: guix-git/doc/guix.texi:13668
23484 msgid "@code{initrd} (default: @code{base-initrd})"
23488 #: guix-git/doc/guix.texi:13672
23489 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}."
23493 #: guix-git/doc/guix.texi:13673
23495 msgid "@code{firmware} (default: @code{%base-firmware})"
23499 #: guix-git/doc/guix.texi:13674
23505 #: guix-git/doc/guix.texi:13676
23506 msgid "List of firmware packages loadable by the operating system kernel."
23510 #: guix-git/doc/guix.texi:13681
23511 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."
23515 #: guix-git/doc/guix.texi:13682 guix-git/doc/guix.texi:33429
23521 #: guix-git/doc/guix.texi:13684
23522 msgid "The host name."
23526 #: guix-git/doc/guix.texi:13685
23532 #: guix-git/doc/guix.texi:13686
23538 #: guix-git/doc/guix.texi:13691
23539 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}."
23543 #: guix-git/doc/guix.texi:13692
23545 msgid "@code{mapped-devices} (default: @code{'()})"
23549 #: guix-git/doc/guix.texi:13694
23550 msgid "A list of mapped devices. @xref{Mapped Devices}."
23554 #: guix-git/doc/guix.texi:13695
23556 msgid "file-systems"
23560 #: guix-git/doc/guix.texi:13697
23561 msgid "A list of file systems. @xref{File Systems}."
23565 #: guix-git/doc/guix.texi:13698
23567 msgid "swap devices"
23571 #: guix-git/doc/guix.texi:13699
23577 #: guix-git/doc/guix.texi:13700
23579 msgid "@code{swap-devices} (default: @code{'()})"
23583 #: guix-git/doc/guix.texi:13705
23584 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:"
23588 #: guix-git/doc/guix.texi:13707
23590 msgid "(list (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\"))"
23594 #: guix-git/doc/guix.texi:13711
23595 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."
23599 #: guix-git/doc/guix.texi:13712
23601 msgid "(list (file-system-label \"swap\"))"
23605 #: guix-git/doc/guix.texi:13716
23606 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."
23610 #: guix-git/doc/guix.texi:13717
23612 msgid "(list \"/swapfile\")"
23616 #: guix-git/doc/guix.texi:13719
23617 msgid "Use the file @file{/swapfile} as swap space."
23621 #: guix-git/doc/guix.texi:13720
23623 msgid "(list \"/dev/sda3\" \"/dev/sdb2\")"
23627 #: guix-git/doc/guix.texi:13724
23628 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."
23632 #: guix-git/doc/guix.texi:13730
23633 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}."
23637 #: guix-git/doc/guix.texi:13731
23639 msgid "@code{users} (default: @code{%base-user-accounts})"
23643 #: guix-git/doc/guix.texi:13732
23645 msgid "@code{groups} (default: @code{%base-groups})"
23649 #: guix-git/doc/guix.texi:13734
23650 msgid "List of user accounts and groups. @xref{User Accounts}."
23654 #: guix-git/doc/guix.texi:13737
23655 msgid "If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' account with UID@tie{}0 is automatically added."
23659 #: guix-git/doc/guix.texi:13738
23661 msgid "@code{skeletons} (default: @code{(default-skeletons)})"
23665 #: guix-git/doc/guix.texi:13742
23666 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."
23670 #: guix-git/doc/guix.texi:13744
23671 msgid "For instance, a valid value may look like this:"
23675 #: guix-git/doc/guix.texi:13750
23678 "`((\".bashrc\" ,(plain-file \"bashrc\" \"echo Hello\\n\"))\n"
23679 " (\".guile\" ,(plain-file \"guile\"\n"
23680 " \"(use-modules (ice-9 readline))\n"
23681 " (activate-readline)\")))\n"
23685 #: guix-git/doc/guix.texi:13752
23687 msgid "@code{issue} (default: @code{%default-issue})"
23691 #: guix-git/doc/guix.texi:13755
23692 msgid "A string denoting the contents of the @file{/etc/issue} file, which is displayed when users log in on a text console."
23696 #: guix-git/doc/guix.texi:13756
23698 msgid "@code{packages} (default: @code{%base-packages})"
23702 #: guix-git/doc/guix.texi:13760
23703 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:"
23707 #: guix-git/doc/guix.texi:13765
23710 "(cons* git ; the default \"out\" output\n"
23711 " (list git \"send-email\") ; another output of git\n"
23712 " %base-packages) ; the default set\n"
23716 #: guix-git/doc/guix.texi:13770
23717 msgid "The default set includes core utilities and it is good practice to install non-core utilities in user profiles (@pxref{Invoking guix package})."
23721 #: guix-git/doc/guix.texi:13771
23727 #: guix-git/doc/guix.texi:13773
23728 msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}."
23732 #: guix-git/doc/guix.texi:13777
23733 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."
23737 #: guix-git/doc/guix.texi:13778 guix-git/doc/guix.texi:19681
23739 msgid "@code{locale} (default: @code{\"en_US.utf8\"})"
23743 #: guix-git/doc/guix.texi:13781
23744 msgid "The name of the default locale (@pxref{Locale Names,,, libc, The GNU C Library Reference Manual}). @xref{Locales}, for more information."
23748 #: guix-git/doc/guix.texi:13782
23750 msgid "@code{locale-definitions} (default: @code{%default-locale-definitions})"
23754 #: guix-git/doc/guix.texi:13785
23755 msgid "The list of locale definitions to be compiled and that may be used at run time. @xref{Locales}."
23759 #: guix-git/doc/guix.texi:13786
23761 msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})"
23765 #: guix-git/doc/guix.texi:13790
23766 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."
23770 #: guix-git/doc/guix.texi:13791
23772 msgid "@code{name-service-switch} (default: @code{%default-nss})"
23776 #: guix-git/doc/guix.texi:13795
23777 msgid "Configuration of the libc name service switch (NSS)---a @code{<name-service-switch>} object. @xref{Name Service Switch}, for details."
23781 #: guix-git/doc/guix.texi:13796
23783 msgid "@code{services} (default: @code{%base-services})"
23787 #: guix-git/doc/guix.texi:13798
23788 msgid "A list of service objects denoting system services. @xref{Services}."
23792 #: guix-git/doc/guix.texi:13799
23794 msgid "essential services"
23798 #: guix-git/doc/guix.texi:13800
23800 msgid "@code{essential-services} (default: ...)"
23804 #: guix-git/doc/guix.texi:13805
23805 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."
23809 #: guix-git/doc/guix.texi:13806
23811 msgid "@code{pam-services} (default: @code{(base-pam-services)})"
23815 #: guix-git/doc/guix.texi:13807
23821 #: guix-git/doc/guix.texi:13808
23823 msgid "pluggable authentication modules"
23827 #: guix-git/doc/guix.texi:13811
23828 msgid "Linux @dfn{pluggable authentication module} (PAM) services."
23832 #: guix-git/doc/guix.texi:13812
23834 msgid "@code{setuid-programs} (default: @code{%setuid-programs})"
23838 #: guix-git/doc/guix.texi:13815
23839 msgid "List of string-valued G-expressions denoting setuid programs. @xref{Setuid Programs}."
23843 #: guix-git/doc/guix.texi:13816
23845 msgid "@code{sudoers-file} (default: @code{%sudoers-specification})"
23849 #: guix-git/doc/guix.texi:13817
23851 msgid "sudoers file"
23855 #: guix-git/doc/guix.texi:13820
23856 msgid "The contents of the @file{/etc/sudoers} file as a file-like object (@pxref{G-Expressions, @code{local-file} and @code{plain-file}})."
23860 #: guix-git/doc/guix.texi:13825
23861 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}."
23865 #: guix-git/doc/guix.texi:13828
23867 msgid "{Scheme Syntax} this-operating-system"
23871 #: guix-git/doc/guix.texi:13831
23872 msgid "When used in the @emph{lexical scope} of an operating system field definition, this identifier resolves to the operating system being defined."
23876 #: guix-git/doc/guix.texi:13834
23877 msgid "The example below shows how to refer to the operating system being defined in the definition of the @code{label} field:"
23881 #: guix-git/doc/guix.texi:13837 guix-git/doc/guix.texi:17299
23884 "(use-modules (gnu) (guix))\n"
23889 #: guix-git/doc/guix.texi:13842
23892 "(operating-system\n"
23894 " (label (package-full-name\n"
23895 " (operating-system-kernel this-operating-system))))\n"
23899 #: guix-git/doc/guix.texi:13846
23900 msgid "It is an error to refer to @code{this-operating-system} outside an operating system definition."
23903 #. type: Plain text
23904 #: guix-git/doc/guix.texi:13857
23905 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:"
23909 #: guix-git/doc/guix.texi:13863
23913 " (mount-point \"/home\")\n"
23914 " (device \"/dev/sda3\")\n"
23915 " (type \"ext4\"))\n"
23918 #. type: Plain text
23919 #: guix-git/doc/guix.texi:13867
23920 msgid "As usual, some of the fields are mandatory---those shown in the example above---while others can be omitted. These are described below."
23924 #: guix-git/doc/guix.texi:13868
23926 msgid "{Data Type} file-system"
23930 #: guix-git/doc/guix.texi:13871
23931 msgid "Objects of this type represent file systems to be mounted. They contain the following members:"
23935 #: guix-git/doc/guix.texi:13873 guix-git/doc/guix.texi:14223
23941 #: guix-git/doc/guix.texi:13876
23942 msgid "This is a string specifying the type of the file system---e.g., @code{\"ext4\"}."
23946 #: guix-git/doc/guix.texi:13877
23948 msgid "mount-point"
23952 #: guix-git/doc/guix.texi:13879
23953 msgid "This designates the place where the file system is to be mounted."
23957 #: guix-git/doc/guix.texi:13880
23963 #: guix-git/doc/guix.texi:13890
23964 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.}."
23968 #: guix-git/doc/guix.texi:13891
23970 msgid "file-system-label"
23974 #: guix-git/doc/guix.texi:13896
23975 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:"
23979 #: guix-git/doc/guix.texi:13902
23983 " (mount-point \"/home\")\n"
23984 " (type \"ext4\")\n"
23985 " (device (file-system-label \"my-home\")))\n"
23989 #: guix-git/doc/guix.texi:13904 guix-git/doc/guix.texi:31144
23990 #: guix-git/doc/guix.texi:31160
23996 #: guix-git/doc/guix.texi:13912
23997 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:"
24001 #: guix-git/doc/guix.texi:13918
24005 " (mount-point \"/home\")\n"
24006 " (type \"ext4\")\n"
24007 " (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
24011 #: guix-git/doc/guix.texi:13926
24012 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."
24016 #: guix-git/doc/guix.texi:13927
24018 msgid "@code{flags} (default: @code{'()})"
24022 #: guix-git/doc/guix.texi:13937
24023 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."
24027 #: guix-git/doc/guix.texi:13938
24029 msgid "@code{options} (default: @code{#f})"
24033 #: guix-git/doc/guix.texi:13947
24034 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."
24038 #: guix-git/doc/guix.texi:13948
24040 msgid "@code{mount?} (default: @code{#t})"
24044 #: guix-git/doc/guix.texi:13953
24045 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."
24049 #: guix-git/doc/guix.texi:13954
24051 msgid "@code{needed-for-boot?} (default: @code{#f})"
24055 #: guix-git/doc/guix.texi:13959
24056 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."
24060 #: guix-git/doc/guix.texi:13960
24062 msgid "@code{check?} (default: @code{#t})"
24066 #: guix-git/doc/guix.texi:13963
24067 msgid "This Boolean indicates whether the file system needs to be checked for errors before being mounted."
24071 #: guix-git/doc/guix.texi:13964
24073 msgid "@code{create-mount-point?} (default: @code{#f})"
24077 #: guix-git/doc/guix.texi:13966
24078 msgid "When true, the mount point is created if it does not exist yet."
24082 #: guix-git/doc/guix.texi:13967
24084 msgid "@code{mount-may-fail?} (default: @code{#f})"
24088 #: guix-git/doc/guix.texi:13972
24089 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."
24093 #: guix-git/doc/guix.texi:13973
24095 msgid "@code{dependencies} (default: @code{'()})"
24099 #: guix-git/doc/guix.texi:13977
24100 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."
24104 #: guix-git/doc/guix.texi:13981
24105 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}."
24109 #: guix-git/doc/guix.texi:13984
24110 msgid "Another example is a file system that depends on a mapped device, for example for an encrypted partition (@pxref{Mapped Devices})."
24114 #: guix-git/doc/guix.texi:13987
24116 msgid "{Scheme Procedure} file-system-label @var{str}"
24120 #: guix-git/doc/guix.texi:13990
24121 msgid "This procedure returns an opaque file system label from @var{str}, a string:"
24125 #: guix-git/doc/guix.texi:13994
24128 "(file-system-label \"home\")\n"
24129 "@result{} #<file-system-label \"home\">\n"
24133 #: guix-git/doc/guix.texi:13998
24134 msgid "File system labels are used to refer to file systems by label rather than by device name. See above for examples."
24137 #. type: Plain text
24138 #: guix-git/doc/guix.texi:14002
24139 msgid "The @code{(gnu system file-systems)} exports the following useful variables."
24143 #: guix-git/doc/guix.texi:14003
24145 msgid "{Scheme Variable} %base-file-systems"
24149 #: guix-git/doc/guix.texi:14008
24150 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."
24154 #: guix-git/doc/guix.texi:14010
24156 msgid "{Scheme Variable} %pseudo-terminal-file-system"
24160 #: guix-git/doc/guix.texi:14016
24161 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}."
24165 #: guix-git/doc/guix.texi:14018
24167 msgid "{Scheme Variable} %shared-memory-file-system"
24171 #: guix-git/doc/guix.texi:14022
24172 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})."
24176 #: guix-git/doc/guix.texi:14024
24178 msgid "{Scheme Variable} %immutable-store"
24182 #: guix-git/doc/guix.texi:14029
24183 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."
24187 #: guix-git/doc/guix.texi:14032
24188 msgid "The daemon itself is still able to write to the store: it remounts it read-write in its own ``name space.''"
24192 #: guix-git/doc/guix.texi:14034
24194 msgid "{Scheme Variable} %binary-format-file-system"
24198 #: guix-git/doc/guix.texi:14038
24199 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."
24203 #: guix-git/doc/guix.texi:14040
24205 msgid "{Scheme Variable} %fuse-control-file-system"
24209 #: guix-git/doc/guix.texi:14044
24210 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."
24213 #. type: Plain text
24214 #: guix-git/doc/guix.texi:14048
24215 msgid "The @code{(gnu system uuid)} module provides tools to deal with file system ``unique identifiers'' (UUIDs)."
24219 #: guix-git/doc/guix.texi:14049
24221 msgid "{Scheme Procedure} uuid @var{str} [@var{type}]"
24225 #: guix-git/doc/guix.texi:14052
24226 msgid "Return an opaque UUID (unique identifier) object of the given @var{type} (a symbol) by parsing @var{str} (a string):"
24230 #: guix-git/doc/guix.texi:14056
24233 "(uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")\n"
24234 "@result{} #<<uuid> type: dce bv: @dots{}>\n"
24239 #: guix-git/doc/guix.texi:14059
24242 "(uuid \"1234-ABCD\" 'fat)\n"
24243 "@result{} #<<uuid> type: fat bv: @dots{}>\n"
24247 #: guix-git/doc/guix.texi:14063
24248 msgid "@var{type} may be one of @code{dce}, @code{iso9660}, @code{fat}, @code{ntfs}, or one of the commonly found synonyms for these."
24252 #: guix-git/doc/guix.texi:14066
24253 msgid "UUIDs are another way to unambiguously refer to file systems in operating system configuration. See the examples above."
24256 #. type: subsection
24257 #: guix-git/doc/guix.texi:14069 guix-git/doc/guix.texi:14070
24259 msgid "Btrfs file system"
24262 #. type: Plain text
24263 #: guix-git/doc/guix.texi:14076
24264 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."
24267 #. type: Plain text
24268 #: guix-git/doc/guix.texi:14079
24269 msgid "In its simplest usage, a Btrfs file system can be described, for example, by:"
24273 #: guix-git/doc/guix.texi:14085
24277 " (mount-point \"/home\")\n"
24278 " (type \"btrfs\")\n"
24279 " (device (file-system-label \"my-home\")))\n"
24282 #. type: Plain text
24283 #: guix-git/doc/guix.texi:14091
24284 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}):"
24288 #: guix-git/doc/guix.texi:14099
24292 " (device (file-system-label \"my-btrfs-pool\"))\n"
24293 " (mount-point \"/\")\n"
24294 " (type \"btrfs\")\n"
24295 " (options \"subvol=rootfs\")\n"
24296 " (dependencies mapped-devices))\n"
24299 #. type: Plain text
24300 #: guix-git/doc/guix.texi:14110
24301 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."
24304 #. type: Plain text
24305 #: guix-git/doc/guix.texi:14118
24306 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.:"
24310 #: guix-git/doc/guix.texi:14125
24314 "├── rootfs (subvolume directory)\n"
24315 " ├── gnu (normal directory)\n"
24316 " ├── store (normal directory)\n"
24320 #. type: Plain text
24321 #: guix-git/doc/guix.texi:14130
24322 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."
24325 #. type: Plain text
24326 #: guix-git/doc/guix.texi:14133
24327 msgid "The next example shows a nested hierarchy of subvolumes and directories:"
24331 #: guix-git/doc/guix.texi:14140
24335 "├── rootfs (subvolume)\n"
24336 " ├── gnu (normal directory)\n"
24337 " ├── store (subvolume)\n"
24341 #. type: Plain text
24342 #: guix-git/doc/guix.texi:14147
24343 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}."
24346 #. type: Plain text
24347 #: guix-git/doc/guix.texi:14149
24348 msgid "Finally, a more contrived example of nested subvolumes:"
24352 #: guix-git/doc/guix.texi:14156
24356 "├── root-snapshots (subvolume)\n"
24357 " ├── root-current (subvolume)\n"
24358 " ├── guix-store (subvolume)\n"
24362 #. type: Plain text
24363 #: guix-git/doc/guix.texi:14163
24364 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:"
24368 #: guix-git/doc/guix.texi:14171
24372 " (device (file-system-label \"btrfs-pool-1\"))\n"
24373 " (mount-point \"/gnu/store\")\n"
24374 " (type \"btrfs\")\n"
24375 " (options \"subvol=root-snapshots/root-current/guix-store,\\\n"
24376 "compress-force=zstd,space_cache=v2\"))\n"
24380 #: guix-git/doc/guix.texi:14176
24382 msgid "device mapping"
24386 #: guix-git/doc/guix.texi:14177
24388 msgid "mapped devices"
24391 #. type: Plain text
24392 #: guix-git/doc/guix.texi:14194
24393 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."
24396 #. type: Plain text
24397 #: guix-git/doc/guix.texi:14197
24398 msgid "Mapped devices are declared using the @code{mapped-device} form, defined as follows; for examples, see below."
24402 #: guix-git/doc/guix.texi:14198
24404 msgid "{Data Type} mapped-device"
24408 #: guix-git/doc/guix.texi:14201
24409 msgid "Objects of this type represent device mappings that will be made when the system boots up."
24413 #: guix-git/doc/guix.texi:14208
24414 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."
24418 #: guix-git/doc/guix.texi:14209 guix-git/doc/guix.texi:32498
24424 #: guix-git/doc/guix.texi:14218
24425 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\"}."
24429 #: guix-git/doc/guix.texi:14219
24435 #: guix-git/doc/guix.texi:14222
24436 msgid "This list of strings specifies names of the resulting mapped devices in case there are several. The format is identical to @var{target}."
24440 #: guix-git/doc/guix.texi:14226
24441 msgid "This must be a @code{mapped-device-kind} object, which specifies how @var{source} is mapped to @var{target}."
24445 #: guix-git/doc/guix.texi:14229
24447 msgid "{Scheme Variable} luks-device-mapping"
24451 #: guix-git/doc/guix.texi:14233
24452 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."
24456 #: guix-git/doc/guix.texi:14235
24458 msgid "{Scheme Variable} raid-device-mapping"
24462 #: guix-git/doc/guix.texi:14240
24463 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."
24467 #: guix-git/doc/guix.texi:14242
24469 msgid "LVM, logical volume manager"
24473 #: guix-git/doc/guix.texi:14243
24475 msgid "{Scheme Variable} lvm-device-mapping"
24479 #: guix-git/doc/guix.texi:14248
24480 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."
24484 #: guix-git/doc/guix.texi:14250
24486 msgid "disk encryption"
24490 #: guix-git/doc/guix.texi:14251
24495 #. type: Plain text
24496 #: guix-git/doc/guix.texi:14259
24497 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})."
24501 #: guix-git/doc/guix.texi:14265
24505 " (source \"/dev/sda3\")\n"
24506 " (target \"home\")\n"
24507 " (type luks-device-mapping))\n"
24510 #. type: Plain text
24511 #: guix-git/doc/guix.texi:14270
24512 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:"
24516 #: guix-git/doc/guix.texi:14273
24518 msgid "cryptsetup luksUUID /dev/sda3\n"
24521 #. type: Plain text
24522 #: guix-git/doc/guix.texi:14276
24523 msgid "and use it as follows:"
24527 #: guix-git/doc/guix.texi:14282
24531 " (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n"
24532 " (target \"home\")\n"
24533 " (type luks-device-mapping))\n"
24537 #: guix-git/doc/guix.texi:14284
24539 msgid "swap encryption"
24542 #. type: Plain text
24543 #: guix-git/doc/guix.texi:14290
24544 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."
24547 #. type: Plain text
24548 #: guix-git/doc/guix.texi:14293
24549 msgid "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} may be declared as follows:"
24553 #: guix-git/doc/guix.texi:14299
24557 " (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n"
24558 " (target \"/dev/md0\")\n"
24559 " (type raid-device-mapping))\n"
24562 #. type: Plain text
24563 #: guix-git/doc/guix.texi:14306
24564 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."
24567 #. type: Plain text
24568 #: guix-git/doc/guix.texi:14309
24569 msgid "LVM logical volumes ``alpha'' and ``beta'' from volume group ``vg0'' can be declared as follows:"
24573 #: guix-git/doc/guix.texi:14315
24577 " (source \"vg0\")\n"
24578 " (targets (list \"vg0-alpha\" \"vg0-beta\"))\n"
24579 " (type lvm-device-mapping))\n"
24582 #. type: Plain text
24583 #: guix-git/doc/guix.texi:14320
24584 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})."
24588 #: guix-git/doc/guix.texi:14324
24594 #: guix-git/doc/guix.texi:14325
24600 #: guix-git/doc/guix.texi:14326
24602 msgid "user accounts"
24605 #. type: Plain text
24606 #: guix-git/doc/guix.texi:14330
24607 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:"
24611 #: guix-git/doc/guix.texi:14340
24615 " (name \"alice\")\n"
24616 " (group \"users\")\n"
24617 " (supplementary-groups '(\"wheel\" ;allow use of sudo, etc.\n"
24618 " \"audio\" ;sound card\n"
24619 " \"video\" ;video devices such as webcams\n"
24620 " \"cdrom\")) ;the good ol' CD-ROM\n"
24621 " (comment \"Bob's sister\"))\n"
24624 #. type: Plain text
24625 #: guix-git/doc/guix.texi:14344
24626 msgid "Here's a user account that uses a different shell and a custom home directory (the default would be @file{\"/home/bob\"}):"
24630 #: guix-git/doc/guix.texi:14352
24634 " (name \"bob\")\n"
24635 " (group \"users\")\n"
24636 " (comment \"Alice's bro\")\n"
24637 " (shell (file-append zsh \"/bin/zsh\"))\n"
24638 " (home-directory \"/home/robert\"))\n"
24641 #. type: Plain text
24642 #: guix-git/doc/guix.texi:14361
24643 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."
24647 #: guix-git/doc/guix.texi:14362
24649 msgid "{Data Type} user-account"
24653 #: guix-git/doc/guix.texi:14365
24654 msgid "Objects of this type represent user accounts. The following members may be specified:"
24658 #: guix-git/doc/guix.texi:14369
24659 msgid "The name of the user account."
24663 #: guix-git/doc/guix.texi:14370 guix-git/doc/guix.texi:32184
24669 #: guix-git/doc/guix.texi:14371 guix-git/doc/guix.texi:14450
24675 #: guix-git/doc/guix.texi:14374
24676 msgid "This is the name (a string) or identifier (a number) of the user group this account belongs to."
24680 #: guix-git/doc/guix.texi:14375
24682 msgid "@code{supplementary-groups} (default: @code{'()})"
24686 #: guix-git/doc/guix.texi:14378
24687 msgid "Optionally, this can be defined as a list of group names that this account belongs to."
24691 #: guix-git/doc/guix.texi:14379
24693 msgid "@code{uid} (default: @code{#f})"
24697 #: guix-git/doc/guix.texi:14383
24698 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."
24702 #: guix-git/doc/guix.texi:14384
24704 msgid "@code{comment} (default: @code{\"\"})"
24708 #: guix-git/doc/guix.texi:14386
24709 msgid "A comment about the account, such as the account owner's full name."
24713 #: guix-git/doc/guix.texi:14387
24715 msgid "home-directory"
24719 #: guix-git/doc/guix.texi:14389
24720 msgid "This is the name of the home directory for the account."
24724 #: guix-git/doc/guix.texi:14390
24726 msgid "@code{create-home-directory?} (default: @code{#t})"
24730 #: guix-git/doc/guix.texi:14393
24731 msgid "Indicates whether the home directory of this account should be created if it does not exist yet."
24735 #: guix-git/doc/guix.texi:14394
24737 msgid "@code{shell} (default: Bash)"
24741 #: guix-git/doc/guix.texi:14398
24742 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:"
24746 #: guix-git/doc/guix.texi:14401
24748 msgid "(file-append bash \"/bin/bash\")\n"
24752 #: guix-git/doc/guix.texi:14405
24753 msgid "... and to the Zsh executable like that:"
24757 #: guix-git/doc/guix.texi:14408
24759 msgid "(file-append zsh \"/bin/zsh\")\n"
24763 #: guix-git/doc/guix.texi:14410 guix-git/doc/guix.texi:14468
24765 msgid "@code{system?} (default: @code{#f})"
24769 #: guix-git/doc/guix.texi:14414
24770 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."
24773 #. type: anchor{#1}
24774 #: guix-git/doc/guix.texi:14416
24775 msgid "user-account-password"
24779 #: guix-git/doc/guix.texi:14416
24781 msgid "password, for user accounts"
24785 #: guix-git/doc/guix.texi:14417 guix-git/doc/guix.texi:14472
24787 msgid "@code{password} (default: @code{#f})"
24791 #: guix-git/doc/guix.texi:14423
24792 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."
24796 #: guix-git/doc/guix.texi:14427
24797 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:"
24801 #: guix-git/doc/guix.texi:14432
24805 " (name \"charlie\")\n"
24806 " (group \"users\")\n"
24811 #: guix-git/doc/guix.texi:14435
24814 " ;; Specify a SHA-512-hashed initial password.\n"
24815 " (password (crypt \"InitialPassword!\" \"$6$abc\")))\n"
24819 #: guix-git/doc/guix.texi:14441
24820 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."
24824 #: guix-git/doc/guix.texi:14446
24825 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."
24828 #. type: Plain text
24829 #: guix-git/doc/guix.texi:14452
24830 msgid "User group declarations are even simpler:"
24834 #: guix-git/doc/guix.texi:14455
24836 msgid "(user-group (name \"students\"))\n"
24840 #: guix-git/doc/guix.texi:14457
24842 msgid "{Data Type} user-group"
24846 #: guix-git/doc/guix.texi:14459
24847 msgid "This type is for, well, user groups. There are just a few fields:"
24851 #: guix-git/doc/guix.texi:14463
24852 msgid "The name of the group."
24856 #: guix-git/doc/guix.texi:14464 guix-git/doc/guix.texi:28988
24858 msgid "@code{id} (default: @code{#f})"
24862 #: guix-git/doc/guix.texi:14467
24863 msgid "The group identifier (a number). If @code{#f}, a new number is automatically allocated when the group is created."
24867 #: guix-git/doc/guix.texi:14471
24868 msgid "This Boolean value indicates whether the group is a ``system'' group. System groups have low numerical IDs."
24872 #: guix-git/doc/guix.texi:14475
24873 msgid "What, user groups can have a password? Well, apparently yes. Unless @code{#f}, this field specifies the password of the group."
24876 #. type: Plain text
24877 #: guix-git/doc/guix.texi:14481
24878 msgid "For convenience, a variable lists all the basic user groups one may expect:"
24882 #: guix-git/doc/guix.texi:14482
24884 msgid "{Scheme Variable} %base-groups"
24888 #: guix-git/doc/guix.texi:14487
24889 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''."
24893 #: guix-git/doc/guix.texi:14489
24895 msgid "{Scheme Variable} %base-user-accounts"
24899 #: guix-git/doc/guix.texi:14492
24900 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."
24904 #: guix-git/doc/guix.texi:14495
24905 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."
24909 #: guix-git/doc/guix.texi:14501
24914 #. type: Plain text
24915 #: guix-git/doc/guix.texi:14509
24916 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."
24920 #: guix-git/doc/guix.texi:14510
24922 msgid "keyboard layout, definition"
24925 #. type: Plain text
24926 #: guix-git/doc/guix.texi:14512
24927 msgid "There are three components that will want to know about your keyboard layout:"
24931 #: guix-git/doc/guix.texi:14519
24932 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."
24936 #: guix-git/doc/guix.texi:14524
24937 msgid "The @emph{operating system kernel}, Linux, will need that so that the console is properly configured (@pxref{operating-system Reference, @code{keyboard-layout}})."
24941 #: guix-git/doc/guix.texi:14528
24942 msgid "The @emph{graphical display server}, usually Xorg, also has its own idea of the keyboard layout (@pxref{X Window, @code{keyboard-layout}})."
24945 #. type: Plain text
24946 #: guix-git/doc/guix.texi:14532
24947 msgid "Guix allows you to configure all three separately but, fortunately, it allows you to share the same keyboard layout for all three components."
24951 #: guix-git/doc/guix.texi:14533
24953 msgid "XKB, keyboard layouts"
24956 #. type: Plain text
24957 #: guix-git/doc/guix.texi:14541
24958 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."
24962 #: guix-git/doc/guix.texi:14542
24964 msgid "{Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @"
24968 #: guix-git/doc/guix.texi:14545
24969 msgid "[#:model] [#:options '()] Return a new keyboard layout with the given @var{name} and @var{variant}."
24973 #: guix-git/doc/guix.texi:14549
24974 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."
24977 #. type: Plain text
24978 #: guix-git/doc/guix.texi:14552
24979 msgid "Here are a few examples:"
24983 #: guix-git/doc/guix.texi:14557
24986 ";; The German QWERTZ layout. Here we assume a standard\n"
24987 ";; \"pc105\" keyboard model.\n"
24988 "(keyboard-layout \"de\")\n"
24993 #: guix-git/doc/guix.texi:14560
24996 ";; The bépo variant of the French layout.\n"
24997 "(keyboard-layout \"fr\" \"bepo\")\n"
25002 #: guix-git/doc/guix.texi:14563
25005 ";; The Catalan layout.\n"
25006 "(keyboard-layout \"es\" \"cat\")\n"
25011 #: guix-git/doc/guix.texi:14566
25014 ";; Arabic layout with \"Alt-Shift\" to switch to US layout.\n"
25015 "(keyboard-layout \"ar,us\" #:options '(\"grp:alt_shift_toggle\"))\n"
25020 #: guix-git/doc/guix.texi:14573
25023 ";; The Latin American Spanish layout. In addition, the\n"
25024 ";; \"Caps Lock\" key is used as an additional \"Ctrl\" key,\n"
25025 ";; and the \"Menu\" key is used as a \"Compose\" key to enter\n"
25026 ";; accented letters.\n"
25027 "(keyboard-layout \"latam\"\n"
25028 " #:options '(\"ctrl:nocaps\" \"compose:menu\"))\n"
25033 #: guix-git/doc/guix.texi:14576
25036 ";; The Russian layout for a ThinkPad keyboard.\n"
25037 "(keyboard-layout \"ru\" #:model \"thinkpad\")\n"
25042 #: guix-git/doc/guix.texi:14581
25045 ";; The \"US international\" layout, which is the US layout plus\n"
25046 ";; dead keys to enter accented characters. This is for an\n"
25047 ";; Apple MacBook keyboard.\n"
25048 "(keyboard-layout \"us\" \"intl\" #:model \"macbook78\")\n"
25051 #. type: Plain text
25052 #: guix-git/doc/guix.texi:14585
25053 msgid "See the @file{share/X11/xkb} directory of the @code{xkeyboard-config} package for a complete list of supported layouts, variants, and models."
25057 #: guix-git/doc/guix.texi:14586
25059 msgid "keyboard layout, configuration"
25062 #. type: Plain text
25063 #: guix-git/doc/guix.texi:14590
25064 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:"
25068 #: guix-git/doc/guix.texi:14591
25070 msgid "set-xorg-configuration"
25074 #: guix-git/doc/guix.texi:14595
25077 ";; Using the Turkish layout for the bootloader, the console,\n"
25078 ";; and for Xorg.\n"
25083 #: guix-git/doc/guix.texi:14607
25086 "(operating-system\n"
25088 " (keyboard-layout (keyboard-layout \"tr\")) ;for the console\n"
25089 " (bootloader (bootloader-configuration\n"
25090 " (bootloader grub-efi-bootloader)\n"
25091 " (target \"/boot/efi\")\n"
25092 " (keyboard-layout keyboard-layout))) ;for GRUB\n"
25093 " (services (cons (set-xorg-configuration\n"
25094 " (xorg-configuration ;for Xorg\n"
25095 " (keyboard-layout keyboard-layout)))\n"
25096 " %desktop-services)))\n"
25099 #. type: Plain text
25100 #: guix-git/doc/guix.texi:14614
25101 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."
25104 #. type: Plain text
25105 #: guix-git/doc/guix.texi:14617
25106 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:"
25110 #: guix-git/doc/guix.texi:14622
25111 msgid "If you're using GNOME, its settings panel has a ``Region & Language'' entry where you can select one or more keyboard layouts."
25115 #: guix-git/doc/guix.texi:14627
25116 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:"
25120 #: guix-git/doc/guix.texi:14630
25122 msgid "setxkbmap us dvorak\n"
25126 #: guix-git/doc/guix.texi:14637
25127 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:"
25131 #: guix-git/doc/guix.texi:14640
25133 msgid "loadkeys fr-bepo\n"
25137 #: guix-git/doc/guix.texi:14646
25142 #. type: Plain text
25143 #: guix-git/doc/guix.texi:14653
25144 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."
25148 #: guix-git/doc/guix.texi:14654
25150 msgid "locale definition"
25153 #. type: Plain text
25154 #: guix-git/doc/guix.texi:14658
25155 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}})."
25158 #. type: Plain text
25159 #: guix-git/doc/guix.texi:14667
25160 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."
25163 #. type: Plain text
25164 #: guix-git/doc/guix.texi:14670
25165 msgid "For instance, to add the North Frisian locale for Germany, the value of that field may be:"
25169 #: guix-git/doc/guix.texi:14675
25172 "(cons (locale-definition\n"
25173 " (name \"fy_DE.utf8\") (source \"fy_DE\"))\n"
25174 " %default-locale-definitions)\n"
25177 #. type: Plain text
25178 #: guix-git/doc/guix.texi:14679
25179 msgid "Likewise, to save space, one might want @code{locale-definitions} to list only the locales that are actually used, as in:"
25183 #: guix-git/doc/guix.texi:14684
25186 "(list (locale-definition\n"
25187 " (name \"ja_JP.eucjp\") (source \"ja_JP\")\n"
25188 " (charset \"EUC-JP\")))\n"
25191 #. type: Plain text
25192 #: guix-git/doc/guix.texi:14693
25193 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})."
25196 #. type: Plain text
25197 #: guix-git/doc/guix.texi:14696
25198 msgid "The @code{locale-definition} form is provided by the @code{(gnu system locale)} module. Details are given below."
25202 #: guix-git/doc/guix.texi:14697
25204 msgid "{Data Type} locale-definition"
25208 #: guix-git/doc/guix.texi:14699
25209 msgid "This is the data type of a locale definition."
25213 #: guix-git/doc/guix.texi:14705
25214 msgid "The name of the locale. @xref{Locale Names,,, libc, The GNU C Library Reference Manual}, for more information on locale names."
25218 #: guix-git/doc/guix.texi:14709
25219 msgid "The name of the source for that locale. This is typically the @code{@var{language}_@var{territory}} part of the locale name."
25223 #: guix-git/doc/guix.texi:14710
25225 msgid "@code{charset} (default: @code{\"UTF-8\"})"
25229 #: guix-git/doc/guix.texi:14714
25230 msgid "The ``character set'' or ``code set'' for that locale, @uref{https://www.iana.org/assignments/character-sets, as defined by IANA}."
25234 #: guix-git/doc/guix.texi:14718
25236 msgid "{Scheme Variable} %default-locale-definitions"
25240 #: guix-git/doc/guix.texi:14722
25241 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."
25245 #: guix-git/doc/guix.texi:14723
25247 msgid "locale name"
25251 #: guix-git/doc/guix.texi:14724
25253 msgid "normalized codeset in locale names"
25257 #: guix-git/doc/guix.texi:14730
25258 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}."
25261 #. type: subsection
25262 #: guix-git/doc/guix.texi:14732
25264 msgid "Locale Data Compatibility Considerations"
25268 #: guix-git/doc/guix.texi:14734
25270 msgid "incompatibility, of locale data"
25273 #. type: Plain text
25274 #: guix-git/doc/guix.texi:14741
25275 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."
25278 #. type: Plain text
25279 #: guix-git/doc/guix.texi:14753
25280 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."
25283 #. type: Plain text
25284 #: guix-git/doc/guix.texi:14758
25285 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."
25288 #. type: Plain text
25289 #: guix-git/doc/guix.texi:14762
25290 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})."
25293 #. type: Plain text
25294 #: guix-git/doc/guix.texi:14769
25295 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}:"
25299 #: guix-git/doc/guix.texi:14772
25302 "(use-package-modules base)\n"
25307 #: guix-git/doc/guix.texi:14776
25310 "(operating-system\n"
25312 " (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n"
25315 #. type: Plain text
25316 #: guix-git/doc/guix.texi:14781
25317 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}."
25321 #: guix-git/doc/guix.texi:14786
25323 msgid "system services"
25326 #. type: Plain text
25327 #: guix-git/doc/guix.texi:14792
25328 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."
25331 #. type: Plain text
25332 #: guix-git/doc/guix.texi:14799
25333 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:"
25337 #: guix-git/doc/guix.texi:14802
25339 msgid "# herd status\n"
25342 #. type: Plain text
25343 #: guix-git/doc/guix.texi:14807
25344 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:"
25348 #: guix-git/doc/guix.texi:14811
25351 "# herd doc nscd\n"
25352 "Run libc's name service cache daemon (nscd).\n"
25357 #: guix-git/doc/guix.texi:14814
25360 "# herd doc nscd action invalidate\n"
25361 "invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.\n"
25364 #. type: Plain text
25365 #: guix-git/doc/guix.texi:14819
25366 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:"
25370 #: guix-git/doc/guix.texi:14826
25373 "# herd stop nscd\n"
25374 "Service nscd has been stopped.\n"
25375 "# herd restart xorg-server\n"
25376 "Service xorg-server has been stopped.\n"
25377 "Service xorg-server has been started.\n"
25380 #. type: Plain text
25381 #: guix-git/doc/guix.texi:14831
25382 msgid "The following sections document the available services, starting with the core services, that may be used in an @code{operating-system} declaration."
25385 #. type: subsection
25386 #: guix-git/doc/guix.texi:14866 guix-git/doc/guix.texi:22490
25387 #: guix-git/doc/guix.texi:22491
25389 msgid "File-Sharing Services"
25393 #: guix-git/doc/guix.texi:14866
25394 msgid "File-sharing services."
25397 #. type: Plain text
25398 #: guix-git/doc/guix.texi:14874
25399 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."
25403 #: guix-git/doc/guix.texi:14875
25405 msgid "{Scheme Variable} %base-services"
25409 #: guix-git/doc/guix.texi:14881
25410 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."
25414 #: guix-git/doc/guix.texi:14886
25415 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:"
25419 #: guix-git/doc/guix.texi:14891
25422 "(append (list (service avahi-service-type)\n"
25423 " (service openssh-service-type))\n"
25424 " %base-services)\n"
25428 #: guix-git/doc/guix.texi:14894
25430 msgid "{Scheme Variable} special-files-service-type"
25434 #: guix-git/doc/guix.texi:14897
25435 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}."
25439 #: guix-git/doc/guix.texi:14901
25440 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:"
25444 #: guix-git/doc/guix.texi:14902
25450 #: guix-git/doc/guix.texi:14903
25452 msgid "@file{sh}, in @file{/bin}"
25456 #: guix-git/doc/guix.texi:14906
25458 msgid "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\")))\n"
25462 #: guix-git/doc/guix.texi:14908
25464 msgid "/usr/bin/env"
25468 #: guix-git/doc/guix.texi:14909
25470 msgid "@file{env}, in @file{/usr/bin}"
25474 #: guix-git/doc/guix.texi:14912
25475 msgid "If you want to add, say, @code{/usr/bin/env} to your system, you can change it to:"
25479 #: guix-git/doc/guix.texi:14916
25482 "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n"
25483 " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\")))\n"
25487 #: guix-git/doc/guix.texi:14923
25488 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)."
25492 #: guix-git/doc/guix.texi:14925
25494 msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}"
25498 #: guix-git/doc/guix.texi:14927
25499 msgid "Use @var{target} as the ``special file'' @var{file}."
25503 #: guix-git/doc/guix.texi:14931
25504 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:"
25508 #: guix-git/doc/guix.texi:14935
25511 "(extra-special-file \"/usr/bin/env\"\n"
25512 " (file-append coreutils \"/bin/env\"))\n"
25516 #: guix-git/doc/guix.texi:14938
25518 msgid "{Scheme Procedure} host-name-service @var{name}"
25522 #: guix-git/doc/guix.texi:14940
25523 msgid "Return a service that sets the host name to @var{name}."
25527 #: guix-git/doc/guix.texi:14942
25529 msgid "{Scheme Variable} console-font-service-type"
25533 #: guix-git/doc/guix.texi:14947
25534 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:"
25538 #: guix-git/doc/guix.texi:14956
25541 "`((\"tty1\" . \"LatGrkCyr-8x16\")\n"
25542 " (\"tty2\" . ,(file-append\n"
25544 " \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
25545 " (\"tty3\" . ,(file-append\n"
25547 " \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
25551 #: guix-git/doc/guix.texi:14959
25553 msgid "{Scheme Procedure} login-service @var{config}"
25557 #: guix-git/doc/guix.texi:14963
25558 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."
25562 #: guix-git/doc/guix.texi:14965
25564 msgid "{Data Type} login-configuration"
25568 #: guix-git/doc/guix.texi:14967
25569 msgid "This is the data type representing the configuration of login."
25573 #: guix-git/doc/guix.texi:14970
25579 #: guix-git/doc/guix.texi:14971
25581 msgid "message of the day"
25585 #: guix-git/doc/guix.texi:14973
25586 msgid "A file-like object containing the ``message of the day''."
25590 #: guix-git/doc/guix.texi:14974 guix-git/doc/guix.texi:17855
25592 msgid "@code{allow-empty-passwords?} (default: @code{#t})"
25596 #: guix-git/doc/guix.texi:14977
25597 msgid "Allow empty passwords by default so that first-time users can log in when the 'root' account has just been created."
25601 #: guix-git/doc/guix.texi:14981
25603 msgid "{Scheme Procedure} mingetty-service @var{config}"
25607 #: guix-git/doc/guix.texi:14985
25608 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."
25612 #: guix-git/doc/guix.texi:14987
25614 msgid "{Data Type} mingetty-configuration"
25618 #: guix-git/doc/guix.texi:14990
25619 msgid "This is the data type representing the configuration of Mingetty, which provides the default implementation of virtual console log-in."
25623 #: guix-git/doc/guix.texi:14993 guix-git/doc/guix.texi:15032
25624 #: guix-git/doc/guix.texi:31484
25630 #: guix-git/doc/guix.texi:14995
25631 msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}."
25635 #: guix-git/doc/guix.texi:14996 guix-git/doc/guix.texi:15061
25636 #: guix-git/doc/guix.texi:15220
25638 msgid "@code{auto-login} (default: @code{#f})"
25642 #: guix-git/doc/guix.texi:15000
25643 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."
25647 #: guix-git/doc/guix.texi:15001
25649 msgid "@code{login-program} (default: @code{#f})"
25653 #: guix-git/doc/guix.texi:15005
25654 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."
25658 #: guix-git/doc/guix.texi:15006
25660 msgid "@code{login-pause?} (default: @code{#f})"
25664 #: guix-git/doc/guix.texi:15009
25665 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."
25669 #: guix-git/doc/guix.texi:15010
25671 msgid "@code{clear-on-logout?} (default: @code{#t})"
25675 #: guix-git/doc/guix.texi:15012
25676 msgid "When set to @code{#t}, the screen will be cleared after logout."
25680 #: guix-git/doc/guix.texi:15013
25682 msgid "@code{mingetty} (default: @var{mingetty})"
25686 #: guix-git/doc/guix.texi:15015
25687 msgid "The Mingetty package to use."
25691 #: guix-git/doc/guix.texi:15019
25693 msgid "{Scheme Procedure} agetty-service @var{config}"
25697 #: guix-git/doc/guix.texi:15023
25698 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."
25702 #: guix-git/doc/guix.texi:15025
25704 msgid "{Data Type} agetty-configuration"
25708 #: guix-git/doc/guix.texi:15029
25709 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."
25713 #: guix-git/doc/guix.texi:15036
25714 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."
25718 #: guix-git/doc/guix.texi:15040
25719 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."
25723 #: guix-git/doc/guix.texi:15044
25724 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."
25728 #: guix-git/doc/guix.texi:15048
25729 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."
25733 #: guix-git/doc/guix.texi:15049 guix-git/doc/guix.texi:31645
25735 msgid "@code{baud-rate} (default: @code{#f})"
25739 #: guix-git/doc/guix.texi:15052
25740 msgid "A string containing a comma-separated list of one or more baud rates, in descending order."
25744 #: guix-git/doc/guix.texi:15053
25746 msgid "@code{term} (default: @code{#f})"
25750 #: guix-git/doc/guix.texi:15056
25751 msgid "A string containing the value used for the @env{TERM} environment variable."
25755 #: guix-git/doc/guix.texi:15057
25757 msgid "@code{eight-bits?} (default: @code{#f})"
25761 #: guix-git/doc/guix.texi:15060
25762 msgid "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection is disabled."
25766 #: guix-git/doc/guix.texi:15064 guix-git/doc/guix.texi:15223
25767 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."
25771 #: guix-git/doc/guix.texi:15065
25773 msgid "@code{no-reset?} (default: @code{#f})"
25777 #: guix-git/doc/guix.texi:15067
25778 msgid "When @code{#t}, don't reset terminal cflags (control modes)."
25782 #: guix-git/doc/guix.texi:15068
25784 msgid "@code{host} (default: @code{#f})"
25788 #: guix-git/doc/guix.texi:15071
25789 msgid "This accepts a string containing the ``login_host'', which will be written into the @file{/var/run/utmpx} file."
25793 #: guix-git/doc/guix.texi:15072
25795 msgid "@code{remote?} (default: @code{#f})"
25799 #: guix-git/doc/guix.texi:15076
25800 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}."
25804 #: guix-git/doc/guix.texi:15077
25806 msgid "@code{flow-control?} (default: @code{#f})"
25810 #: guix-git/doc/guix.texi:15079
25811 msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control."
25815 #: guix-git/doc/guix.texi:15080
25817 msgid "@code{no-issue?} (default: @code{#f})"
25821 #: guix-git/doc/guix.texi:15083
25822 msgid "When set to @code{#t}, the contents of the @file{/etc/issue} file will not be displayed before presenting the login prompt."
25826 #: guix-git/doc/guix.texi:15084
25828 msgid "@code{init-string} (default: @code{#f})"
25832 #: guix-git/doc/guix.texi:15087
25833 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."
25837 #: guix-git/doc/guix.texi:15088
25839 msgid "@code{no-clear?} (default: @code{#f})"
25843 #: guix-git/doc/guix.texi:15091
25844 msgid "When set to @code{#t}, agetty will not clear the screen before showing the login prompt."
25848 #: guix-git/doc/guix.texi:15092
25850 msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))"
25854 #: guix-git/doc/guix.texi:15096
25855 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."
25859 #: guix-git/doc/guix.texi:15097
25861 msgid "@code{local-line} (default: @code{#f})"
25865 #: guix-git/doc/guix.texi:15101
25866 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}."
25870 #: guix-git/doc/guix.texi:15102
25872 msgid "@code{extract-baud?} (default: @code{#f})"
25876 #: guix-git/doc/guix.texi:15105
25877 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."
25881 #: guix-git/doc/guix.texi:15106
25883 msgid "@code{skip-login?} (default: @code{#f})"
25887 #: guix-git/doc/guix.texi:15110
25888 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."
25892 #: guix-git/doc/guix.texi:15111
25894 msgid "@code{no-newline?} (default: @code{#f})"
25898 #: guix-git/doc/guix.texi:15114
25899 msgid "When set to @code{#t}, do not print a newline before printing the @file{/etc/issue} file."
25903 #: guix-git/doc/guix.texi:15116
25905 msgid "@code{login-options} (default: @code{#f})"
25909 #: guix-git/doc/guix.texi:15121
25910 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."
25914 #: guix-git/doc/guix.texi:15122
25916 msgid "@code{login-pause} (default: @code{#f})"
25920 #: guix-git/doc/guix.texi:15126
25921 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."
25925 #: guix-git/doc/guix.texi:15127
25927 msgid "@code{chroot} (default: @code{#f})"
25931 #: guix-git/doc/guix.texi:15130
25932 msgid "Change root to the specified directory. This option accepts a directory path as a string."
25936 #: guix-git/doc/guix.texi:15131
25938 msgid "@code{hangup?} (default: @code{#f})"
25942 #: guix-git/doc/guix.texi:15134
25943 msgid "Use the Linux system call @code{vhangup} to do a virtual hangup of the specified terminal."
25947 #: guix-git/doc/guix.texi:15135
25949 msgid "@code{keep-baud?} (default: @code{#f})"
25953 #: guix-git/doc/guix.texi:15139
25954 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."
25958 #: guix-git/doc/guix.texi:15140
25960 msgid "@code{timeout} (default: @code{#f})"
25964 #: guix-git/doc/guix.texi:15143
25965 msgid "When set to an integer value, terminate if no user name could be read within @var{timeout} seconds."
25969 #: guix-git/doc/guix.texi:15144
25971 msgid "@code{detect-case?} (default: @code{#f})"
25975 #: guix-git/doc/guix.texi:15150
25976 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."
25980 #: guix-git/doc/guix.texi:15151
25982 msgid "@code{wait-cr?} (default: @code{#f})"
25986 #: guix-git/doc/guix.texi:15156
25987 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."
25991 #: guix-git/doc/guix.texi:15157
25993 msgid "@code{no-hints?} (default: @code{#f})"
25997 #: guix-git/doc/guix.texi:15160
25998 msgid "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks."
26002 #: guix-git/doc/guix.texi:15161
26004 msgid "@code{no-hostname?} (default: @code{#f})"
26008 #: guix-git/doc/guix.texi:15164
26009 msgid "By default, the hostname is printed. When this option is set to @code{#t}, no hostname will be shown at all."
26013 #: guix-git/doc/guix.texi:15165
26015 msgid "@code{long-hostname?} (default: @code{#f})"
26019 #: guix-git/doc/guix.texi:15169
26020 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."
26024 #: guix-git/doc/guix.texi:15170
26026 msgid "@code{erase-characters} (default: @code{#f})"
26030 #: guix-git/doc/guix.texi:15173
26031 msgid "This option accepts a string of additional characters that should be interpreted as backspace when the user types their login name."
26035 #: guix-git/doc/guix.texi:15174
26037 msgid "@code{kill-characters} (default: @code{#f})"
26041 #: guix-git/doc/guix.texi:15178
26042 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."
26046 #: guix-git/doc/guix.texi:15179
26048 msgid "@code{chdir} (default: @code{#f})"
26052 #: guix-git/doc/guix.texi:15182
26053 msgid "This option accepts, as a string, a directory path that will be changed to before login."
26057 #: guix-git/doc/guix.texi:15183
26059 msgid "@code{delay} (default: @code{#f})"
26063 #: guix-git/doc/guix.texi:15186
26064 msgid "This options accepts, as an integer, the number of seconds to sleep before opening the tty and displaying the login prompt."
26068 #: guix-git/doc/guix.texi:15187
26070 msgid "@code{nice} (default: @code{#f})"
26074 #: guix-git/doc/guix.texi:15190
26075 msgid "This option accepts, as an integer, the nice value with which to run the @command{login} program."
26079 #: guix-git/doc/guix.texi:15191 guix-git/doc/guix.texi:15468
26080 #: guix-git/doc/guix.texi:16330 guix-git/doc/guix.texi:23473
26081 #: guix-git/doc/guix.texi:24949 guix-git/doc/guix.texi:27297
26082 #: guix-git/doc/guix.texi:28084 guix-git/doc/guix.texi:29783
26083 #: guix-git/doc/guix.texi:31975
26085 msgid "@code{extra-options} (default: @code{'()})"
26089 #: guix-git/doc/guix.texi:15194
26090 msgid "This option provides an ``escape hatch'' for the user to provide arbitrary command-line arguments to @command{agetty} as a list of strings."
26094 #: guix-git/doc/guix.texi:15198
26096 msgid "{Scheme Procedure} kmscon-service-type @var{config}"
26100 #: guix-git/doc/guix.texi:15202
26101 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."
26105 #: guix-git/doc/guix.texi:15204
26107 msgid "{Data Type} kmscon-configuration"
26111 #: guix-git/doc/guix.texi:15207
26112 msgid "This is the data type representing the configuration of Kmscon, which implements virtual console log-in."
26116 #: guix-git/doc/guix.texi:15210
26118 msgid "virtual-terminal"
26122 #: guix-git/doc/guix.texi:15212
26123 msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}."
26127 #: guix-git/doc/guix.texi:15213
26129 msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})"
26133 #: guix-git/doc/guix.texi:15216
26134 msgid "A gexp denoting the name of the log-in program. The default log-in program is @command{login} from the Shadow tool suite."
26138 #: guix-git/doc/guix.texi:15217
26140 msgid "@code{login-arguments} (default: @code{'(\"-p\")})"
26144 #: guix-git/doc/guix.texi:15219
26145 msgid "A list of arguments to pass to @command{login}."
26149 #: guix-git/doc/guix.texi:15224
26151 msgid "@code{hardware-acceleration?} (default: #f)"
26155 #: guix-git/doc/guix.texi:15226
26156 msgid "Whether to use hardware acceleration."
26160 #: guix-git/doc/guix.texi:15227
26162 msgid "@code{font-engine} (default: @code{\"pango\"})"
26166 #: guix-git/doc/guix.texi:15229
26167 msgid "Font engine used in Kmscon."
26171 #: guix-git/doc/guix.texi:15230
26173 msgid "@code{font-size} (default: @code{12})"
26177 #: guix-git/doc/guix.texi:15232
26178 msgid "Font size used in Kmscon."
26182 #: guix-git/doc/guix.texi:15233
26184 msgid "@code{kmscon} (default: @var{kmscon})"
26188 #: guix-git/doc/guix.texi:15235
26189 msgid "The Kmscon package to use."
26193 #: guix-git/doc/guix.texi:15239
26195 msgid "name service cache daemon"
26199 #: guix-git/doc/guix.texi:15240
26205 #: guix-git/doc/guix.texi:15241
26207 msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @"
26211 #: guix-git/doc/guix.texi:15246
26212 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."
26216 #: guix-git/doc/guix.texi:15248
26217 msgid "For convenience, the Shepherd service for nscd provides the following actions:"
26221 #: guix-git/doc/guix.texi:15250
26227 #: guix-git/doc/guix.texi:15251
26229 msgid "cache invalidation, nscd"
26233 #: guix-git/doc/guix.texi:15252
26235 msgid "nscd, cache invalidation"
26239 #: guix-git/doc/guix.texi:15254
26240 msgid "This invalidate the given cache. For instance, running:"
26244 #: guix-git/doc/guix.texi:15257
26246 msgid "herd invalidate nscd hosts\n"
26250 #: guix-git/doc/guix.texi:15261
26251 msgid "invalidates the host name lookup cache of nscd."
26255 #: guix-git/doc/guix.texi:15262
26261 #: guix-git/doc/guix.texi:15265
26262 msgid "Running @command{herd statistics nscd} displays information about nscd usage and caches."
26266 #: guix-git/doc/guix.texi:15269
26268 msgid "{Scheme Variable} %nscd-default-configuration"
26272 #: guix-git/doc/guix.texi:15273
26273 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."
26277 #: guix-git/doc/guix.texi:15275
26279 msgid "{Data Type} nscd-configuration"
26283 #: guix-git/doc/guix.texi:15278
26284 msgid "This is the data type representing the name service cache daemon (nscd) configuration."
26288 #: guix-git/doc/guix.texi:15281
26290 msgid "@code{name-services} (default: @code{'()})"
26294 #: guix-git/doc/guix.texi:15284
26295 msgid "List of packages denoting @dfn{name services} that must be visible to the nscd---e.g., @code{(list @var{nss-mdns})}."
26299 #: guix-git/doc/guix.texi:15285
26301 msgid "@code{glibc} (default: @var{glibc})"
26305 #: guix-git/doc/guix.texi:15288
26306 msgid "Package object denoting the GNU C Library providing the @command{nscd} command."
26310 #: guix-git/doc/guix.texi:15289
26312 msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})"
26316 #: guix-git/doc/guix.texi:15292
26317 msgid "Name of the nscd log file. This is where debugging output goes when @code{debug-level} is strictly positive."
26321 #: guix-git/doc/guix.texi:15293
26323 msgid "@code{debug-level} (default: @code{0})"
26327 #: guix-git/doc/guix.texi:15296
26328 msgid "Integer denoting the debugging levels. Higher numbers mean that more debugging output is logged."
26332 #: guix-git/doc/guix.texi:15297
26334 msgid "@code{caches} (default: @code{%nscd-default-caches})"
26338 #: guix-git/doc/guix.texi:15300
26339 msgid "List of @code{<nscd-cache>} objects denoting things to be cached; see below."
26343 #: guix-git/doc/guix.texi:15304
26345 msgid "{Data Type} nscd-cache"
26349 #: guix-git/doc/guix.texi:15306
26350 msgid "Data type representing a cache database of nscd and its parameters."
26354 #: guix-git/doc/guix.texi:15309 guix-git/doc/guix.texi:19637
26360 #: guix-git/doc/guix.texi:15314
26361 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})."
26365 #: guix-git/doc/guix.texi:15315
26367 msgid "positive-time-to-live"
26371 #: guix-git/doc/guix.texi:15316
26373 msgid "@code{negative-time-to-live} (default: @code{20})"
26377 #: guix-git/doc/guix.texi:15319
26378 msgid "A number representing the number of seconds during which a positive or negative lookup result remains in cache."
26382 #: guix-git/doc/guix.texi:15320
26384 msgid "@code{check-files?} (default: @code{#t})"
26388 #: guix-git/doc/guix.texi:15323
26389 msgid "Whether to check for updates of the files corresponding to @var{database}."
26393 #: guix-git/doc/guix.texi:15327
26394 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."
26398 #: guix-git/doc/guix.texi:15328
26400 msgid "@code{persistent?} (default: @code{#t})"
26404 #: guix-git/doc/guix.texi:15330
26405 msgid "Whether the cache should be stored persistently on disk."
26409 #: guix-git/doc/guix.texi:15331
26411 msgid "@code{shared?} (default: @code{#t})"
26415 #: guix-git/doc/guix.texi:15333
26416 msgid "Whether the cache should be shared among users."
26420 #: guix-git/doc/guix.texi:15334
26422 msgid "@code{max-database-size} (default: 32@tie{}MiB)"
26426 #: guix-git/doc/guix.texi:15336
26427 msgid "Maximum size in bytes of the database cache."
26431 #: guix-git/doc/guix.texi:15343
26433 msgid "{Scheme Variable} %nscd-default-caches"
26437 #: guix-git/doc/guix.texi:15346
26438 msgid "List of @code{<nscd-cache>} objects used by default by @code{nscd-configuration} (see above)."
26442 #: guix-git/doc/guix.texi:15352
26443 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."
26446 #. type: anchor{#1}
26447 #: guix-git/doc/guix.texi:15355
26448 msgid "syslog-configuration-type"
26452 #: guix-git/doc/guix.texi:15355 guix-git/doc/guix.texi:15371
26458 #: guix-git/doc/guix.texi:15356 guix-git/doc/guix.texi:15930
26464 #: guix-git/doc/guix.texi:15357
26466 msgid "{Data Type} syslog-configuration"
26470 #: guix-git/doc/guix.texi:15359
26471 msgid "This data type represents the configuration of the syslog daemon."
26475 #: guix-git/doc/guix.texi:15361
26477 msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})"
26481 #: guix-git/doc/guix.texi:15363
26482 msgid "The syslog daemon to use."
26486 #: guix-git/doc/guix.texi:15364
26488 msgid "@code{config-file} (default: @code{%default-syslog.conf})"
26492 #: guix-git/doc/guix.texi:15366
26493 msgid "The syslog configuration file to use."
26496 #. type: anchor{#1}
26497 #: guix-git/doc/guix.texi:15371
26498 msgid "syslog-service"
26502 #: guix-git/doc/guix.texi:15372
26504 msgid "{Scheme Procedure} syslog-service @var{config}"
26508 #: guix-git/doc/guix.texi:15374
26509 msgid "Return a service that runs a syslog daemon according to @var{config}."
26513 #: guix-git/doc/guix.texi:15377
26514 msgid "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax."
26518 #: guix-git/doc/guix.texi:15379
26520 msgid "{Scheme Variable} guix-service-type"
26524 #: guix-git/doc/guix.texi:15383
26525 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."
26528 #. type: anchor{#1}
26529 #: guix-git/doc/guix.texi:15386
26530 msgid "guix-configuration-type"
26534 #: guix-git/doc/guix.texi:15386
26536 msgid "{Data Type} guix-configuration"
26540 #: guix-git/doc/guix.texi:15389
26541 msgid "This data type represents the configuration of the Guix build daemon. @xref{Invoking guix-daemon}, for more information."
26545 #: guix-git/doc/guix.texi:15391
26547 msgid "@code{guix} (default: @var{guix})"
26551 #: guix-git/doc/guix.texi:15393 guix-git/doc/guix.texi:15667
26552 msgid "The Guix package to use."
26556 #: guix-git/doc/guix.texi:15394
26558 msgid "@code{build-group} (default: @code{\"guixbuild\"})"
26562 #: guix-git/doc/guix.texi:15396
26563 msgid "Name of the group for build user accounts."
26567 #: guix-git/doc/guix.texi:15397
26569 msgid "@code{build-accounts} (default: @code{10})"
26573 #: guix-git/doc/guix.texi:15399
26574 msgid "Number of build user accounts to create."
26578 #: guix-git/doc/guix.texi:15400
26580 msgid "@code{authorize-key?} (default: @code{#t})"
26584 #: guix-git/doc/guix.texi:15405
26585 msgid "Whether to authorize the substitute keys listed in @code{authorized-keys}---by default that of @code{@value{SUBSTITUTE-SERVER}} (@pxref{Substitutes})."
26589 #: guix-git/doc/guix.texi:15411
26590 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."
26594 #: guix-git/doc/guix.texi:15418
26595 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}."
26599 #: guix-git/doc/guix.texi:15420
26601 msgid "%default-authorized-guix-keys"
26605 #: guix-git/doc/guix.texi:15421
26607 msgid "@code{authorized-keys} (default: @code{%default-authorized-guix-keys})"
26611 #: guix-git/doc/guix.texi:15426
26612 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."
26616 #: guix-git/doc/guix.texi:15427
26618 msgid "@code{use-substitutes?} (default: @code{#t})"
26622 #: guix-git/doc/guix.texi:15429
26623 msgid "Whether to use substitutes."
26627 #: guix-git/doc/guix.texi:15430
26629 msgid "@code{substitute-urls} (default: @code{%default-substitute-urls})"
26633 #: guix-git/doc/guix.texi:15432
26634 msgid "The list of URLs where to look for substitutes by default."
26638 #: guix-git/doc/guix.texi:15439
26639 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:"
26643 #: guix-git/doc/guix.texi:15448
26646 "(guix-configuration\n"
26647 " (substitute-urls\n"
26648 " (append (list \"https://guix.example.org\")\n"
26649 " %default-substitute-urls))\n"
26650 " (authorized-keys\n"
26651 " (append (list (local-file \"./guix.example.org-key.pub\"))\n"
26652 " %default-authorized-guix-keys)))\n"
26656 #: guix-git/doc/guix.texi:15453
26657 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."
26661 #: guix-git/doc/guix.texi:15454
26663 msgid "@code{max-silent-time} (default: @code{0})"
26667 #: guix-git/doc/guix.texi:15455
26669 msgid "@code{timeout} (default: @code{0})"
26673 #: guix-git/doc/guix.texi:15459
26674 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."
26678 #: guix-git/doc/guix.texi:15460
26680 msgid "@code{log-compression} (default: @code{'bzip2})"
26684 #: guix-git/doc/guix.texi:15463
26685 msgid "The type of compression used for build logs---one of @code{gzip}, @code{bzip2}, or @code{none}."
26689 #: guix-git/doc/guix.texi:15464
26691 msgid "@code{discover?} (default: @code{#f})"
26695 #: guix-git/doc/guix.texi:15470
26696 msgid "List of extra command-line options for @command{guix-daemon}."
26700 #: guix-git/doc/guix.texi:15471
26702 msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})"
26706 #: guix-git/doc/guix.texi:15474
26707 msgid "File where @command{guix-daemon}'s standard output and standard error are written."
26711 #: guix-git/doc/guix.texi:15475
26713 msgid "HTTP proxy, for @code{guix-daemon}"
26717 #: guix-git/doc/guix.texi:15476
26719 msgid "proxy, for @code{guix-daemon} HTTP access"
26723 #: guix-git/doc/guix.texi:15477
26725 msgid "@code{http-proxy} (default: @code{#f})"
26729 #: guix-git/doc/guix.texi:15480
26730 msgid "The URL of the HTTP and HTTPS proxy used for downloading fixed-output derivations and substitutes."
26734 #: guix-git/doc/guix.texi:15483
26735 msgid "It is also possible to change the daemon's proxy at run time through the @code{set-http-proxy} action, which restarts it:"
26739 #: guix-git/doc/guix.texi:15486
26741 msgid "herd set-http-proxy guix-daemon http://localhost:8118\n"
26745 #: guix-git/doc/guix.texi:15489
26746 msgid "To clear the proxy settings, run:"
26750 #: guix-git/doc/guix.texi:15492
26752 msgid "herd set-http-proxy guix-daemon\n"
26756 #: guix-git/doc/guix.texi:15494
26758 msgid "@code{tmpdir} (default: @code{#f})"
26762 #: guix-git/doc/guix.texi:15496
26763 msgid "A directory path where the @command{guix-daemon} will perform builds."
26767 #: guix-git/doc/guix.texi:15500
26769 msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]"
26773 #: guix-git/doc/guix.texi:15506
26774 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."
26778 #: guix-git/doc/guix.texi:15509
26779 msgid "The @command{herd rules udev} command, as root, returns the name of the directory containing all the active udev rules."
26783 #: guix-git/doc/guix.texi:15511
26785 msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]"
26789 #: guix-git/doc/guix.texi:15514
26790 msgid "Return a udev-rule file named @var{file-name} containing the rules defined by the @var{contents} literal."
26794 #: guix-git/doc/guix.texi:15518
26795 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."
26799 #: guix-git/doc/guix.texi:15526
26802 "(define %example-udev-rule\n"
26804 " \"90-usb-thing.rules\"\n"
26805 " (string-append \"ACTION==\\\"add\\\", SUBSYSTEM==\\\"usb\\\", \"\n"
26806 " \"ATTR@{product@}==\\\"Example\\\", \"\n"
26807 " \"RUN+=\\\"/path/to/script\\\"\")))\n"
26811 #: guix-git/doc/guix.texi:15529
26813 msgid "{Scheme Procedure} udev-rules-service [@var{name} @var{rules}] @"
26817 #: guix-git/doc/guix.texi:15536
26818 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."
26822 #: guix-git/doc/guix.texi:15539
26823 msgid "Here we show how it can be used to extend @code{udev-service-type} with the previously defined rule @code{%example-udev-rule}."
26827 #: guix-git/doc/guix.texi:15546
26830 "(operating-system\n"
26833 " (cons (udev-rules-service 'usb-thing %example-udev-rule)\n"
26834 " %desktop-services)))\n"
26838 #: guix-git/doc/guix.texi:15549
26840 msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]"
26844 #: guix-git/doc/guix.texi:15552
26845 msgid "Return a udev file named @var{file-name} containing the rules defined within @var{file}, a file-like object."
26849 #: guix-git/doc/guix.texi:15554
26850 msgid "The following example showcases how we can use an existing rule file."
26854 #: guix-git/doc/guix.texi:15559
26857 "(use-modules (guix download) ;for url-fetch\n"
26858 " (guix packages) ;for origin\n"
26864 #: guix-git/doc/guix.texi:15570
26867 "(define %android-udev-rules\n"
26868 " (file->udev-rule\n"
26869 " \"51-android-udev.rules\"\n"
26870 " (let ((version \"20170910\"))\n"
26872 " (method url-fetch)\n"
26873 " (uri (string-append \"https://raw.githubusercontent.com/M0Rf30/\"\n"
26874 " \"android-udev-rules/\" version \"/51-android.rules\"))\n"
26876 " (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n"
26879 #. type: Plain text
26880 #: guix-git/doc/guix.texi:15579
26881 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."
26884 #. type: Plain text
26885 #: guix-git/doc/guix.texi:15588
26886 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."
26890 #: guix-git/doc/guix.texi:15593
26893 "(use-modules (gnu packages android) ;for android-udev-rules\n"
26894 " (gnu system shadow) ;for user-group\n"
26900 #: guix-git/doc/guix.texi:15606
26903 "(operating-system\n"
26905 " (users (cons (user-account\n"
26907 " (supplementary-groups\n"
26908 " '(\"adbusers\" ;for adb\n"
26909 " \"wheel\" \"netdev\" \"audio\" \"video\")))))\n"
26912 " (cons (udev-rules-service 'android android-udev-rules\n"
26913 " #:groups '(\"adbusers\"))\n"
26914 " %desktop-services)))\n"
26918 #: guix-git/doc/guix.texi:15608
26920 msgid "{Scheme Variable} urandom-seed-service-type"
26924 #: guix-git/doc/guix.texi:15613
26925 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."
26929 #: guix-git/doc/guix.texi:15615
26931 msgid "{Scheme Variable} %random-seed-file"
26935 #: guix-git/doc/guix.texi:15619
26936 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}."
26940 #: guix-git/doc/guix.texi:15621
26946 #: guix-git/doc/guix.texi:15622
26952 #: guix-git/doc/guix.texi:15623
26954 msgid "{Scheme Variable} gpm-service-type"
26958 #: guix-git/doc/guix.texi:15628
26959 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."
26963 #: guix-git/doc/guix.texi:15631
26964 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}."
26968 #: guix-git/doc/guix.texi:15633
26970 msgid "{Data Type} gpm-configuration"
26974 #: guix-git/doc/guix.texi:15635
26975 msgid "Data type representing the configuration of GPM."
26979 #: guix-git/doc/guix.texi:15637
26981 msgid "@code{options} (default: @code{%default-gpm-options})"
26985 #: guix-git/doc/guix.texi:15642
26986 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."
26990 #: guix-git/doc/guix.texi:15643
26992 msgid "@code{gpm} (default: @code{gpm})"
26996 #: guix-git/doc/guix.texi:15645
26997 msgid "The GPM package to use."
27000 #. type: anchor{#1}
27001 #: guix-git/doc/guix.texi:15650
27002 msgid "guix-publish-service-type"
27006 #: guix-git/doc/guix.texi:15650
27008 msgid "{Scheme Variable} guix-publish-service-type"
27012 #: guix-git/doc/guix.texi:15654
27013 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."
27017 #: guix-git/doc/guix.texi:15658
27018 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."
27022 #: guix-git/doc/guix.texi:15660
27024 msgid "{Data Type} guix-publish-configuration"
27028 #: guix-git/doc/guix.texi:15663
27029 msgid "Data type representing the configuration of the @code{guix publish} service."
27033 #: guix-git/doc/guix.texi:15665
27035 msgid "@code{guix} (default: @code{guix})"
27039 #: guix-git/doc/guix.texi:15668 guix-git/doc/guix.texi:29638
27041 msgid "@code{port} (default: @code{80})"
27045 #: guix-git/doc/guix.texi:15670
27046 msgid "The TCP port to listen for connections."
27050 #: guix-git/doc/guix.texi:15671 guix-git/doc/guix.texi:27277
27052 msgid "@code{host} (default: @code{\"localhost\"})"
27056 #: guix-git/doc/guix.texi:15674
27057 msgid "The host (and thus, network interface) to listen to. Use @code{\"0.0.0.0\"} to listen on all the network interfaces."
27061 #: guix-git/doc/guix.texi:15675
27063 msgid "@code{advertise?} (default: @code{#f})"
27067 #: guix-git/doc/guix.texi:15678
27068 msgid "When true, advertise the service on the local network @i{via} the DNS-SD protocol, using Avahi."
27072 #: guix-git/doc/guix.texi:15682
27073 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."
27077 #: guix-git/doc/guix.texi:15683
27079 msgid "@code{compression} (default: @code{'((\"gzip\" 3) (\"zstd\" 3))})"
27083 #: guix-git/doc/guix.texi:15687
27084 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:"
27088 #: guix-git/doc/guix.texi:15690
27090 msgid "'((\"lzip\" 7) (\"gzip\" 9))\n"
27094 #: guix-git/doc/guix.texi:15696
27095 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."
27099 #: guix-git/doc/guix.texi:15698
27100 msgid "An empty list disables compression altogether."
27104 #: guix-git/doc/guix.texi:15699
27106 msgid "@code{nar-path} (default: @code{\"nar\"})"
27110 #: guix-git/doc/guix.texi:15702
27111 msgid "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, @option{--nar-path}}, for details."
27115 #: guix-git/doc/guix.texi:15703
27117 msgid "@code{cache} (default: @code{#f})"
27121 #: guix-git/doc/guix.texi:15709
27122 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."
27126 #: guix-git/doc/guix.texi:15710
27128 msgid "@code{workers} (default: @code{#f})"
27132 #: guix-git/doc/guix.texi:15714
27133 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."
27137 #: guix-git/doc/guix.texi:15715
27139 msgid "@code{cache-bypass-threshold} (default: 10 MiB)"
27143 #: guix-git/doc/guix.texi:15720
27144 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."
27148 #: guix-git/doc/guix.texi:15721
27150 msgid "@code{ttl} (default: @code{#f})"
27154 #: guix-git/doc/guix.texi:15725
27155 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."
27158 #. type: anchor{#1}
27159 #: guix-git/doc/guix.texi:15729
27160 msgid "rngd-service"
27164 #: guix-git/doc/guix.texi:15729
27166 msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @"
27170 #: guix-git/doc/guix.texi:15734
27171 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."
27174 #. type: anchor{#1}
27175 #: guix-git/doc/guix.texi:15737
27176 msgid "pam-limits-service"
27180 #: guix-git/doc/guix.texi:15737
27182 msgid "session limits"
27186 #: guix-git/doc/guix.texi:15738
27192 #: guix-git/doc/guix.texi:15739
27198 #: guix-git/doc/guix.texi:15740
27204 #: guix-git/doc/guix.texi:15741
27210 #: guix-git/doc/guix.texi:15742
27216 #: guix-git/doc/guix.texi:15743
27218 msgid "open file descriptors"
27222 #: guix-git/doc/guix.texi:15744
27224 msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]"
27228 #: guix-git/doc/guix.texi:15751
27229 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."
27233 #: guix-git/doc/guix.texi:15754
27234 msgid "The following limits definition sets two hard and soft limits for all login sessions of users in the @code{realtime} group:"
27238 #: guix-git/doc/guix.texi:15760
27241 "(pam-limits-service\n"
27243 " (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n"
27244 " (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n"
27248 #: guix-git/doc/guix.texi:15766
27249 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."
27253 #: guix-git/doc/guix.texi:15769
27254 msgid "Another useful example is raising the maximum number of open file descriptors that can be used:"
27258 #: guix-git/doc/guix.texi:15774
27261 "(pam-limits-service\n"
27263 " (pam-limits-entry \"*\" 'both 'nofile 100000)))\n"
27267 #: guix-git/doc/guix.texi:15782
27268 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."
27272 #: guix-git/doc/guix.texi:15787
27278 #: guix-git/doc/guix.texi:15788
27284 #: guix-git/doc/guix.texi:15789
27286 msgid "scheduling jobs"
27289 #. type: Plain text
27290 #: guix-git/doc/guix.texi:15796
27291 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."
27294 #. type: Plain text
27295 #: guix-git/doc/guix.texi:15804
27296 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})."
27300 #: guix-git/doc/guix.texi:15808
27303 "(use-modules (guix) (gnu) (gnu services mcron))\n"
27304 "(use-package-modules base idutils)\n"
27309 #: guix-git/doc/guix.texi:15817
27312 "(define updatedb-job\n"
27313 " ;; Run 'updatedb' at 3AM every day. Here we write the\n"
27314 " ;; job's action as a Scheme procedure.\n"
27315 " #~(job '(next-hour '(3))\n"
27317 " (execl (string-append #$findutils \"/bin/updatedb\")\n"
27319 " \"--prunepaths=/tmp /var/tmp /gnu/store\"))))\n"
27324 #: guix-git/doc/guix.texi:15823
27327 "(define garbage-collector-job\n"
27328 " ;; Collect garbage 5 minutes after midnight every day.\n"
27329 " ;; The job's action is a shell command.\n"
27330 " #~(job \"5 0 * * *\" ;Vixie cron syntax\n"
27331 " \"guix gc -F 1G\"))\n"
27336 #: guix-git/doc/guix.texi:15830
27339 "(define idutils-job\n"
27340 " ;; Update the index database as user \"charlie\" at 12:15PM\n"
27341 " ;; and 19:15PM. This runs from the user's home directory.\n"
27342 " #~(job '(next-minute-from (next-hour '(12 19)) '(15))\n"
27343 " (string-append #$idutils \"/bin/mkid src\")\n"
27344 " #:user \"charlie\"))\n"
27349 #: guix-git/doc/guix.texi:15833
27352 "(operating-system\n"
27358 #: guix-git/doc/guix.texi:15843
27361 " ;; %BASE-SERVICES already includes an instance of\n"
27362 " ;; 'mcron-service-type', which we extend with additional\n"
27363 " ;; jobs using 'simple-service'.\n"
27364 " (services (cons (simple-service 'my-cron-jobs\n"
27365 " mcron-service-type\n"
27366 " (list garbage-collector-job\n"
27369 " %base-services)))\n"
27372 #. type: Plain text
27373 #: guix-git/doc/guix.texi:15850
27374 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."
27378 #: guix-git/doc/guix.texi:15866
27381 "(define %battery-alert-job\n"
27382 " ;; Beep when the battery percentage falls below %MIN-LEVEL.\n"
27384 " '(next-minute (range 0 60 1))\n"
27385 " #$(program-file\n"
27386 " \"battery-alert.scm\"\n"
27387 " (with-imported-modules (source-module-closure\n"
27388 " '((guix build utils)))\n"
27390 " (use-modules (guix build utils)\n"
27393 " (ice-9 textual-ports)\n"
27394 " (srfi srfi-2))\n"
27399 #: guix-git/doc/guix.texi:15868
27402 " (define %min-level 20)\n"
27407 #: guix-git/doc/guix.texi:15879
27410 " (setenv \"LC_ALL\" \"C\") ;ensure English output\n"
27411 " (and-let* ((input-pipe (open-pipe*\n"
27413 " #$(file-append acpi \"/bin/acpi\")))\n"
27414 " (output (get-string-all input-pipe))\n"
27415 " (m (string-match \"Discharging, ([0-9]+)%\" output))\n"
27416 " (level (string->number (match:substring m 1)))\n"
27417 " ((< level %min-level)))\n"
27418 " (format #t \"warning: Battery level is low (~a%)~%\" level)\n"
27419 " (invoke #$(file-append beep \"/bin/beep\") \"-r5\")))))))\n"
27422 #. type: Plain text
27423 #: guix-git/doc/guix.texi:15884
27424 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."
27427 #. type: Plain text
27428 #: guix-git/doc/guix.texi:15887
27429 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:"
27433 #: guix-git/doc/guix.texi:15890
27435 msgid "# herd schedule mcron\n"
27438 #. type: Plain text
27439 #: guix-git/doc/guix.texi:15895
27440 msgid "The example above lists the next five tasks that will be executed, but you can also specify the number of tasks to display:"
27444 #: guix-git/doc/guix.texi:15898
27446 msgid "# herd schedule mcron 10\n"
27450 #: guix-git/doc/guix.texi:15900
27452 msgid "{Scheme Variable} mcron-service-type"
27456 #: guix-git/doc/guix.texi:15903
27457 msgid "This is the type of the @code{mcron} service, whose value is an @code{mcron-configuration} object."
27461 #: guix-git/doc/guix.texi:15908
27462 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."
27466 #: guix-git/doc/guix.texi:15910
27468 msgid "{Data Type} mcron-configuration"
27472 #: guix-git/doc/guix.texi:15912
27473 msgid "Data type representing the configuration of mcron."
27477 #: guix-git/doc/guix.texi:15914
27479 msgid "@code{mcron} (default: @var{mcron})"
27483 #: guix-git/doc/guix.texi:15916
27484 msgid "The mcron package to use."
27488 #: guix-git/doc/guix.texi:15917 guix-git/doc/guix.texi:15986
27494 #: guix-git/doc/guix.texi:15921
27495 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})."
27499 #: guix-git/doc/guix.texi:15928
27505 #: guix-git/doc/guix.texi:15929
27507 msgid "log rotation"
27510 #. type: Plain text
27511 #: guix-git/doc/guix.texi:15936
27512 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})."
27515 #. type: Plain text
27516 #: guix-git/doc/guix.texi:15942
27517 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):"
27521 #: guix-git/doc/guix.texi:15946
27524 "(use-modules (guix) (gnu))\n"
27525 "(use-service-modules admin)\n"
27530 #: guix-git/doc/guix.texi:15950
27533 "(define my-log-files\n"
27534 " ;; Log files that I want to rotate.\n"
27535 " '(\"/var/log/something.log\" \"/var/log/another.log\"))\n"
27540 #: guix-git/doc/guix.texi:15959
27543 "(operating-system\n"
27545 " (services (cons (simple-service 'rotate-my-stuff\n"
27546 " rottlog-service-type\n"
27547 " (list (log-rotation\n"
27548 " (frequency 'daily)\n"
27549 " (files my-log-files))))\n"
27550 " %base-services)))\n"
27554 #: guix-git/doc/guix.texi:15961
27556 msgid "{Scheme Variable} rottlog-service-type"
27560 #: guix-git/doc/guix.texi:15964
27561 msgid "This is the type of the Rottlog service, whose value is a @code{rottlog-configuration} object."
27565 #: guix-git/doc/guix.texi:15967
27566 msgid "Other services can extend this one with new @code{log-rotation} objects (see below), thereby augmenting the set of files to be rotated."
27570 #: guix-git/doc/guix.texi:15970
27571 msgid "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to run the rottlog service."
27575 #: guix-git/doc/guix.texi:15972
27577 msgid "{Data Type} rottlog-configuration"
27581 #: guix-git/doc/guix.texi:15974
27582 msgid "Data type representing the configuration of rottlog."
27586 #: guix-git/doc/guix.texi:15976
27588 msgid "@code{rottlog} (default: @code{rottlog})"
27592 #: guix-git/doc/guix.texi:15978
27593 msgid "The Rottlog package to use."
27597 #: guix-git/doc/guix.texi:15979
27599 msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})"
27603 #: guix-git/doc/guix.texi:15982
27604 msgid "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, rottlog, GNU Rot[t]log Manual})."
27608 #: guix-git/doc/guix.texi:15983
27610 msgid "@code{rotations} (default: @code{%default-rotations})"
27614 #: guix-git/doc/guix.texi:15985
27615 msgid "A list of @code{log-rotation} objects as defined below."
27619 #: guix-git/doc/guix.texi:15989
27620 msgid "This is a list of gexps where each gexp corresponds to an mcron job specification (@pxref{Scheduled Job Execution})."
27624 #: guix-git/doc/guix.texi:15992
27626 msgid "{Data Type} log-rotation"
27630 #: guix-git/doc/guix.texi:15994
27631 msgid "Data type representing the rotation of a group of log files."
27635 #: guix-git/doc/guix.texi:15998
27636 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:"
27640 #: guix-git/doc/guix.texi:16007
27644 " (frequency 'daily)\n"
27645 " (files '(\"/var/log/apache/*\"))\n"
27646 " (options '(\"storedir apache-archives\"\n"
27648 " \"notifempty\"\n"
27649 " \"nocompress\")))\n"
27653 #: guix-git/doc/guix.texi:16010
27654 msgid "The list of fields is as follows:"
27658 #: guix-git/doc/guix.texi:16012
27660 msgid "@code{frequency} (default: @code{'weekly})"
27664 #: guix-git/doc/guix.texi:16014
27665 msgid "The log rotation frequency, a symbol."
27669 #: guix-git/doc/guix.texi:16015
27675 #: guix-git/doc/guix.texi:16017
27676 msgid "The list of files or file glob patterns to rotate."
27680 #: guix-git/doc/guix.texi:16018
27682 msgid "@code{options} (default: @code{'()})"
27686 #: guix-git/doc/guix.texi:16021
27687 msgid "The list of rottlog options for this rotation (@pxref{Configuration parameters,,, rottlog, GNU Rot[t]lg Manual})."
27691 #: guix-git/doc/guix.texi:16022
27693 msgid "@code{post-rotate} (default: @code{#f})"
27697 #: guix-git/doc/guix.texi:16024
27698 msgid "Either @code{#f} or a gexp to execute once the rotation has completed."
27702 #: guix-git/doc/guix.texi:16027
27704 msgid "{Scheme Variable} %default-rotations"
27708 #: guix-git/doc/guix.texi:16030
27709 msgid "Specifies weekly rotation of @code{%rotated-files} and of @file{/var/log/guix-daemon.log}."
27713 #: guix-git/doc/guix.texi:16032
27715 msgid "{Scheme Variable} %rotated-files"
27719 #: guix-git/doc/guix.texi:16036
27720 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\")}."
27723 #. type: Plain text
27724 #: guix-git/doc/guix.texi:16043
27725 msgid "The @code{(gnu services networking)} module provides services to configure the network interface."
27729 #: guix-git/doc/guix.texi:16044
27731 msgid "DHCP, networking service"
27735 #: guix-git/doc/guix.texi:16045
27737 msgid "{Scheme Variable} dhcp-client-service-type"
27741 #: guix-git/doc/guix.texi:16049
27742 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."
27746 #: guix-git/doc/guix.texi:16051
27748 msgid "{Scheme Procedure} dhcpd-service-type"
27752 #: guix-git/doc/guix.texi:16055
27753 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:"
27757 #: guix-git/doc/guix.texi:16061
27760 "(service dhcpd-service-type\n"
27761 " (dhcpd-configuration\n"
27762 " (config-file (local-file \"my-dhcpd.conf\"))\n"
27763 " (interfaces '(\"enp0s25\"))))\n"
27767 #: guix-git/doc/guix.texi:16064
27769 msgid "{Data Type} dhcpd-configuration"
27773 #: guix-git/doc/guix.texi:16066
27775 msgid "@code{package} (default: @code{isc-dhcp})"
27779 #: guix-git/doc/guix.texi:16071
27780 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}."
27784 #: guix-git/doc/guix.texi:16071 guix-git/doc/guix.texi:16327
27785 #: guix-git/doc/guix.texi:21399
27787 msgid "@code{config-file} (default: @code{#f})"
27791 #: guix-git/doc/guix.texi:16076
27792 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."
27796 #: guix-git/doc/guix.texi:16076
27798 msgid "@code{version} (default: @code{\"4\"})"
27802 #: guix-git/doc/guix.texi:16081
27803 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."
27807 #: guix-git/doc/guix.texi:16081
27809 msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})"
27813 #: guix-git/doc/guix.texi:16084
27814 msgid "The run directory to use. At service activation time, this directory will be created if it does not exist."
27818 #: guix-git/doc/guix.texi:16084
27820 msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})"
27824 #: guix-git/doc/guix.texi:16087
27825 msgid "The PID file to use. This corresponds to the @code{-pf} option of @code{dhcpd}. See @code{man dhcpd} for details."
27829 #: guix-git/doc/guix.texi:16087
27831 msgid "@code{interfaces} (default: @code{'()})"
27835 #: guix-git/doc/guix.texi:16093
27836 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."
27840 #: guix-git/doc/guix.texi:16096
27842 msgid "{Scheme Variable} static-networking-service-type"
27846 #: guix-git/doc/guix.texi:16099
27847 msgid "This is the type for statically-configured network interfaces."
27851 #: guix-git/doc/guix.texi:16101
27853 msgid "{Scheme Procedure} static-networking-service @var{interface} @var{ip} @"
27857 #: guix-git/doc/guix.texi:16109
27858 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."
27862 #: guix-git/doc/guix.texi:16114
27863 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."
27867 #: guix-git/doc/guix.texi:16116 guix-git/doc/guix.texi:28950
27868 msgid "For example:"
27872 #: guix-git/doc/guix.texi:16121
27875 "(static-networking-service \"eno1\" \"192.168.1.82\"\n"
27876 " #:gateway \"192.168.1.2\"\n"
27877 " #:name-servers '(\"192.168.1.2\"))\n"
27881 #: guix-git/doc/guix.texi:16124
27887 #: guix-git/doc/guix.texi:16127
27889 msgid "network management"
27893 #: guix-git/doc/guix.texi:16128
27895 msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]"
27899 #: guix-git/doc/guix.texi:16131
27900 msgid "Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network management daemon that aims to simplify wired and wireless networking."
27904 #: guix-git/doc/guix.texi:16136
27905 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."
27909 #: guix-git/doc/guix.texi:16138
27911 msgid "ModemManager"
27915 #: guix-git/doc/guix.texi:16140
27917 msgid "{Scheme Variable} modem-manager-service-type"
27921 #: guix-git/doc/guix.texi:16145
27922 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."
27926 #: guix-git/doc/guix.texi:16148 guix-git/doc/guix.texi:16177
27927 #: guix-git/doc/guix.texi:16209
27928 msgid "This service is part of @code{%desktop-services} (@pxref{Desktop Services})."
27932 #: guix-git/doc/guix.texi:16150
27934 msgid "{Data Type} modem-manager-configuration"
27938 #: guix-git/doc/guix.texi:16152
27939 msgid "Data type representing the configuration of ModemManager."
27943 #: guix-git/doc/guix.texi:16154
27945 msgid "@code{modem-manager} (default: @code{modem-manager})"
27949 #: guix-git/doc/guix.texi:16156
27950 msgid "The ModemManager package to use."
27954 #: guix-git/doc/guix.texi:16160
27956 msgid "USB_ModeSwitch"
27960 #: guix-git/doc/guix.texi:16161
27962 msgid "Modeswitching"
27966 #: guix-git/doc/guix.texi:16163
27968 msgid "{Scheme Variable} usb-modeswitch-service-type"
27972 #: guix-git/doc/guix.texi:16168
27973 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."
27977 #: guix-git/doc/guix.texi:16174
27978 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."
27982 #: guix-git/doc/guix.texi:16179
27984 msgid "{Data Type} usb-modeswitch-configuration"
27988 #: guix-git/doc/guix.texi:16181
27989 msgid "Data type representing the configuration of USB_ModeSwitch."
27993 #: guix-git/doc/guix.texi:16183
27995 msgid "@code{usb-modeswitch} (default: @code{usb-modeswitch})"
27999 #: guix-git/doc/guix.texi:16185
28000 msgid "The USB_ModeSwitch package providing the binaries for modeswitching."
28004 #: guix-git/doc/guix.texi:16186
28006 msgid "@code{usb-modeswitch-data} (default: @code{usb-modeswitch-data})"
28010 #: guix-git/doc/guix.texi:16189
28011 msgid "The package providing the device data and udev rules file used by USB_ModeSwitch."
28015 #: guix-git/doc/guix.texi:16190
28017 msgid "@code{config-file} (default: @code{#~(string-append #$usb-modeswitch:dispatcher \"/etc/usb_modeswitch.conf\")})"
28021 #: guix-git/doc/guix.texi:16195
28022 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."
28026 #: guix-git/doc/guix.texi:16199
28028 msgid "NetworkManager"
28032 #: guix-git/doc/guix.texi:16201
28034 msgid "{Scheme Variable} network-manager-service-type"
28038 #: guix-git/doc/guix.texi:16206
28039 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."
28043 #: guix-git/doc/guix.texi:16211
28045 msgid "{Data Type} network-manager-configuration"
28049 #: guix-git/doc/guix.texi:16213
28050 msgid "Data type representing the configuration of NetworkManager."
28054 #: guix-git/doc/guix.texi:16215
28056 msgid "@code{network-manager} (default: @code{network-manager})"
28060 #: guix-git/doc/guix.texi:16217
28061 msgid "The NetworkManager package to use."
28065 #: guix-git/doc/guix.texi:16218
28067 msgid "@code{dns} (default: @code{\"default\"})"
28071 #: guix-git/doc/guix.texi:16221
28072 msgid "Processing mode for DNS, which affects how NetworkManager uses the @code{resolv.conf} configuration file."
28076 #: guix-git/doc/guix.texi:16226
28077 msgid "NetworkManager will update @code{resolv.conf} to reflect the nameservers provided by currently active connections."
28081 #: guix-git/doc/guix.texi:16227
28087 #: guix-git/doc/guix.texi:16231
28088 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."
28092 #: guix-git/doc/guix.texi:16237
28093 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)."
28097 #: guix-git/doc/guix.texi:16244
28098 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:"
28102 #: guix-git/doc/guix.texi:16251
28105 "nmcli connection add type tun \\\n"
28106 " connection.interface-name tap0 \\\n"
28107 " tun.mode tap tun.owner $(id -u) \\\n"
28108 " ipv4.method shared \\\n"
28109 " ipv4.addresses 172.28.112.1/24\n"
28113 #: guix-git/doc/guix.texi:16256
28114 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-...}."
28118 #: guix-git/doc/guix.texi:16259
28119 msgid "NetworkManager will not modify @code{resolv.conf}."
28123 #: guix-git/doc/guix.texi:16261
28125 msgid "@code{vpn-plugins} (default: @code{'()})"
28129 #: guix-git/doc/guix.texi:16265
28130 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."
28134 #: guix-git/doc/guix.texi:16269
28140 #: guix-git/doc/guix.texi:16270
28142 msgid "{Scheme Variable} connman-service-type"
28146 #: guix-git/doc/guix.texi:16273
28147 msgid "This is the service type to run @url{https://01.org/connman,Connman}, a network connection manager."
28151 #: guix-git/doc/guix.texi:16276
28152 msgid "Its value must be an @code{connman-configuration} record as in this example:"
28156 #: guix-git/doc/guix.texi:16281
28159 "(service connman-service-type\n"
28160 " (connman-configuration\n"
28161 " (disable-vpn? #t)))\n"
28165 #: guix-git/doc/guix.texi:16284
28166 msgid "See below for details about @code{connman-configuration}."
28170 #: guix-git/doc/guix.texi:16286
28172 msgid "{Data Type} connman-configuration"
28176 #: guix-git/doc/guix.texi:16288
28177 msgid "Data Type representing the configuration of connman."
28181 #: guix-git/doc/guix.texi:16290
28183 msgid "@code{connman} (default: @var{connman})"
28187 #: guix-git/doc/guix.texi:16292
28188 msgid "The connman package to use."
28192 #: guix-git/doc/guix.texi:16293
28194 msgid "@code{disable-vpn?} (default: @code{#f})"
28198 #: guix-git/doc/guix.texi:16295
28199 msgid "When true, disable connman's vpn plugin."
28203 #: guix-git/doc/guix.texi:16298
28205 msgid "WPA Supplicant"
28209 #: guix-git/doc/guix.texi:16299
28211 msgid "{Scheme Variable} wpa-supplicant-service-type"
28215 #: guix-git/doc/guix.texi:16303
28216 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."
28220 #: guix-git/doc/guix.texi:16305
28222 msgid "{Data Type} wpa-supplicant-configuration"
28226 #: guix-git/doc/guix.texi:16307
28227 msgid "Data type representing the configuration of WPA Supplicant."
28231 #: guix-git/doc/guix.texi:16309 guix-git/doc/guix.texi:30962
28232 msgid "It takes the following parameters:"
28236 #: guix-git/doc/guix.texi:16311
28238 msgid "@code{wpa-supplicant} (default: @code{wpa-supplicant})"
28242 #: guix-git/doc/guix.texi:16313
28243 msgid "The WPA Supplicant package to use."
28247 #: guix-git/doc/guix.texi:16314
28249 msgid "@code{requirement} (default: @code{'(user-processes loopback syslogd)}"
28253 #: guix-git/doc/guix.texi:16316
28254 msgid "List of services that should be started before WPA Supplicant starts."
28258 #: guix-git/doc/guix.texi:16317
28260 msgid "@code{dbus?} (default: @code{#t})"
28264 #: guix-git/doc/guix.texi:16319
28265 msgid "Whether to listen for requests on D-Bus."
28269 #: guix-git/doc/guix.texi:16320
28271 msgid "@code{pid-file} (default: @code{\"/var/run/wpa_supplicant.pid\"})"
28275 #: guix-git/doc/guix.texi:16322
28276 msgid "Where to store the PID file."
28280 #: guix-git/doc/guix.texi:16323 guix-git/doc/guix.texi:29407
28281 #: guix-git/doc/guix.texi:29549
28283 msgid "@code{interface} (default: @code{#f})"
28287 #: guix-git/doc/guix.texi:16326
28288 msgid "If this is set, it must specify the name of a network interface that WPA supplicant will control."
28292 #: guix-git/doc/guix.texi:16329
28293 msgid "Optional configuration file to use."
28297 #: guix-git/doc/guix.texi:16332
28298 msgid "List of additional command-line arguments to pass to the daemon."
28302 #: guix-git/doc/guix.texi:16335
28304 msgid "hostapd service, for Wi-Fi access points"
28308 #: guix-git/doc/guix.texi:16336
28310 msgid "Wi-Fi access points, hostapd service"
28314 #: guix-git/doc/guix.texi:16337
28316 msgid "{Scheme Variable} hostapd-service-type"
28320 #: guix-git/doc/guix.texi:16342
28321 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:"
28325 #: guix-git/doc/guix.texi:16350
28328 ";; Use wlan1 to run the access point for \"My Network\".\n"
28329 "(service hostapd-service-type\n"
28330 " (hostapd-configuration\n"
28331 " (interface \"wlan1\")\n"
28332 " (ssid \"My Network\")\n"
28333 " (channel 12)))\n"
28337 #: guix-git/doc/guix.texi:16353
28339 msgid "{Data Type} hostapd-configuration"
28343 #: guix-git/doc/guix.texi:16356
28344 msgid "This data type represents the configuration of the hostapd service, with the following fields:"
28348 #: guix-git/doc/guix.texi:16358
28350 msgid "@code{package} (default: @code{hostapd})"
28354 #: guix-git/doc/guix.texi:16360
28355 msgid "The hostapd package to use."
28359 #: guix-git/doc/guix.texi:16361
28361 msgid "@code{interface} (default: @code{\"wlan0\"})"
28365 #: guix-git/doc/guix.texi:16363
28366 msgid "The network interface to run the WiFi access point."
28370 #: guix-git/doc/guix.texi:16364
28376 #: guix-git/doc/guix.texi:16367
28377 msgid "The SSID (@dfn{service set identifier}), a string that identifies this network."
28381 #: guix-git/doc/guix.texi:16368
28383 msgid "@code{broadcast-ssid?} (default: @code{#t})"
28387 #: guix-git/doc/guix.texi:16370
28388 msgid "Whether to broadcast this SSID."
28392 #: guix-git/doc/guix.texi:16371
28394 msgid "@code{channel} (default: @code{1})"
28398 #: guix-git/doc/guix.texi:16373
28399 msgid "The WiFi channel to use."
28403 #: guix-git/doc/guix.texi:16374
28405 msgid "@code{driver} (default: @code{\"nl80211\"})"
28409 #: guix-git/doc/guix.texi:16378
28410 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."
28414 #: guix-git/doc/guix.texi:16379 guix-git/doc/guix.texi:22248
28415 #: guix-git/doc/guix.texi:25098
28417 msgid "@code{extra-settings} (default: @code{\"\"})"
28421 #: guix-git/doc/guix.texi:16383
28422 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."
28426 #: guix-git/doc/guix.texi:16386
28428 msgid "{Scheme Variable} simulated-wifi-service-type"
28432 #: guix-git/doc/guix.texi:16393
28433 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."
28437 #: guix-git/doc/guix.texi:16395
28438 msgid "The service's value is a @code{hostapd-configuration} record."
28442 #: guix-git/doc/guix.texi:16397
28448 #: guix-git/doc/guix.texi:16398
28450 msgid "{Scheme Variable} iptables-service-type"
28454 #: guix-git/doc/guix.texi:16404
28455 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."
28459 #: guix-git/doc/guix.texi:16424
28462 "(service iptables-service-type\n"
28463 " (iptables-configuration\n"
28464 " (ipv4-rules (plain-file \"iptables.rules\" \"*filter\n"
28466 ":FORWARD ACCEPT\n"
28468 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28469 "-A INPUT -j REJECT --reject-with icmp-port-unreachable\n"
28472 " (ipv6-rules (plain-file \"ip6tables.rules\" \"*filter\n"
28474 ":FORWARD ACCEPT\n"
28476 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28477 "-A INPUT -j REJECT --reject-with icmp6-port-unreachable\n"
28483 #: guix-git/doc/guix.texi:16427
28485 msgid "{Data Type} iptables-configuration"
28489 #: guix-git/doc/guix.texi:16429
28490 msgid "The data type representing the configuration of iptables."
28494 #: guix-git/doc/guix.texi:16431
28496 msgid "@code{iptables} (default: @code{iptables})"
28500 #: guix-git/doc/guix.texi:16434
28501 msgid "The iptables package that provides @code{iptables-restore} and @code{ip6tables-restore}."
28505 #: guix-git/doc/guix.texi:16434
28507 msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})"
28511 #: guix-git/doc/guix.texi:16438
28512 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})."
28516 #: guix-git/doc/guix.texi:16438
28518 msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})"
28522 #: guix-git/doc/guix.texi:16442
28523 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})."
28527 #: guix-git/doc/guix.texi:16445
28533 #: guix-git/doc/guix.texi:16446
28535 msgid "{Scheme Variable} nftables-service-type"
28539 #: guix-git/doc/guix.texi:16454
28540 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:"
28544 #: guix-git/doc/guix.texi:16457
28546 msgid "(service nftables-service-type)\n"
28550 #: guix-git/doc/guix.texi:16460
28552 msgid "{Data Type} nftables-configuration"
28556 #: guix-git/doc/guix.texi:16462
28557 msgid "The data type representing the configuration of nftables."
28561 #: guix-git/doc/guix.texi:16464
28563 msgid "@code{package} (default: @code{nftables})"
28567 #: guix-git/doc/guix.texi:16466
28568 msgid "The nftables package that provides @command{nft}."
28572 #: guix-git/doc/guix.texi:16466
28574 msgid "@code{ruleset} (default: @code{%default-nftables-ruleset})"
28578 #: guix-git/doc/guix.texi:16469
28579 msgid "The nftables ruleset to use. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects})."
28583 #: guix-git/doc/guix.texi:16472
28585 msgid "NTP (Network Time Protocol), service"
28589 #: guix-git/doc/guix.texi:16473
28591 msgid "ntpd, service for the Network Time Protocol daemon"
28595 #: guix-git/doc/guix.texi:16474
28597 msgid "real time clock"
28601 #: guix-git/doc/guix.texi:16475
28603 msgid "{Scheme Variable} ntp-service-type"
28607 #: guix-git/doc/guix.texi:16479
28608 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."
28612 #: guix-git/doc/guix.texi:16482
28613 msgid "The value of this service is an @code{ntpd-configuration} object, as described below."
28617 #: guix-git/doc/guix.texi:16484
28619 msgid "{Data Type} ntp-configuration"
28623 #: guix-git/doc/guix.texi:16486
28624 msgid "This is the data type for the NTP service configuration."
28628 #: guix-git/doc/guix.texi:16488
28630 msgid "@code{servers} (default: @code{%ntp-servers})"
28634 #: guix-git/doc/guix.texi:16492
28635 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."
28639 #: guix-git/doc/guix.texi:16493
28641 msgid "@code{allow-large-adjustment?} (default: @code{#t})"
28645 #: guix-git/doc/guix.texi:16496
28646 msgid "This determines whether @command{ntpd} is allowed to make an initial adjustment of more than 1,000 seconds."
28650 #: guix-git/doc/guix.texi:16497
28652 msgid "@code{ntp} (default: @code{ntp})"
28656 #: guix-git/doc/guix.texi:16499
28657 msgid "The NTP package to use."
28661 #: guix-git/doc/guix.texi:16502
28663 msgid "{Scheme Variable} %ntp-servers"
28667 #: guix-git/doc/guix.texi:16505
28668 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}."
28672 #: guix-git/doc/guix.texi:16507
28674 msgid "{Data Type} ntp-server"
28678 #: guix-git/doc/guix.texi:16509
28679 msgid "The data type representing the configuration of a NTP server."
28683 #: guix-git/doc/guix.texi:16511
28685 msgid "@code{type} (default: @code{'server})"
28689 #: guix-git/doc/guix.texi:16514
28690 msgid "The type of the NTP server, given as a symbol. One of @code{'pool}, @code{'server}, @code{'peer}, @code{'broadcast} or @code{'manycastclient}."
28694 #: guix-git/doc/guix.texi:16515
28700 #: guix-git/doc/guix.texi:16517
28701 msgid "The address of the server, as a string."
28705 #: guix-git/doc/guix.texi:16518 guix-git/doc/guix.texi:31708
28706 #: guix-git/doc/guix.texi:31728
28712 #: guix-git/doc/guix.texi:16523
28713 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."
28717 #: guix-git/doc/guix.texi:16529
28721 " (type 'server)\n"
28722 " (address \"some.ntp.server.org\")\n"
28723 " (options `(iburst (version 3) (maxpoll 16) prefer))))\n"
28727 #: guix-git/doc/guix.texi:16533
28733 #: guix-git/doc/guix.texi:16534
28735 msgid "{Scheme Procedure} openntpd-service-type"
28739 #: guix-git/doc/guix.texi:16538
28740 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."
28744 #: guix-git/doc/guix.texi:16547
28748 " openntpd-service-type\n"
28749 " (openntpd-configuration\n"
28750 " (listen-on '(\"127.0.0.1\" \"::1\"))\n"
28751 " (sensor '(\"udcf0 correction 70000\"))\n"
28752 " (constraint-from '(\"www.gnu.org\"))\n"
28753 " (constraints-from '(\"https://www.google.com/\"))))\n"
28758 #: guix-git/doc/guix.texi:16551
28760 msgid "{Scheme Variable} %openntpd-servers"
28764 #: guix-git/doc/guix.texi:16554
28765 msgid "This variable is a list of the server addresses defined in @code{%ntp-servers}."
28769 #: guix-git/doc/guix.texi:16556
28771 msgid "{Data Type} openntpd-configuration"
28775 #: guix-git/doc/guix.texi:16558
28777 msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})"
28781 #: guix-git/doc/guix.texi:16560
28782 msgid "The openntpd executable to use."
28786 #: guix-git/doc/guix.texi:16560
28788 msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})"
28792 #: guix-git/doc/guix.texi:16562
28793 msgid "A list of local IP addresses or hostnames the ntpd daemon should listen on."
28797 #: guix-git/doc/guix.texi:16562
28799 msgid "@code{query-from} (default: @code{'()})"
28803 #: guix-git/doc/guix.texi:16564
28804 msgid "A list of local IP address the ntpd daemon should use for outgoing queries."
28808 #: guix-git/doc/guix.texi:16564
28810 msgid "@code{sensor} (default: @code{'()})"
28814 #: guix-git/doc/guix.texi:16569
28815 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."
28819 #: guix-git/doc/guix.texi:16569
28821 msgid "@code{server} (default: @code{'()})"
28825 #: guix-git/doc/guix.texi:16571
28826 msgid "Specify a list of IP addresses or hostnames of NTP servers to synchronize to."
28830 #: guix-git/doc/guix.texi:16571
28832 msgid "@code{servers} (default: @code{%openntp-servers})"
28836 #: guix-git/doc/guix.texi:16573
28837 msgid "Specify a list of IP addresses or hostnames of NTP pools to synchronize to."
28841 #: guix-git/doc/guix.texi:16573
28843 msgid "@code{constraint-from} (default: @code{'()})"
28847 #: guix-git/doc/guix.texi:16580
28848 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."
28852 #: guix-git/doc/guix.texi:16580
28854 msgid "@code{constraints-from} (default: @code{'()})"
28858 #: guix-git/doc/guix.texi:16584
28859 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."
28863 #: guix-git/doc/guix.texi:16587
28869 #: guix-git/doc/guix.texi:16588
28871 msgid "{Scheme variable} inetd-service-type"
28875 #: guix-git/doc/guix.texi:16593
28876 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."
28880 #: guix-git/doc/guix.texi:16599
28881 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}:"
28885 #: guix-git/doc/guix.texi:16622
28889 " inetd-service-type\n"
28890 " (inetd-configuration\n"
28891 " (entries (list\n"
28893 " (name \"echo\")\n"
28894 " (socket-type 'stream)\n"
28895 " (protocol \"tcp\")\n"
28897 " (user \"root\"))\n"
28899 " (node \"127.0.0.1\")\n"
28900 " (name \"smtp\")\n"
28901 " (socket-type 'stream)\n"
28902 " (protocol \"tcp\")\n"
28904 " (user \"root\")\n"
28905 " (program (file-append openssh \"/bin/ssh\"))\n"
28907 " '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n"
28908 " \"-W\" \"smtp-server:25\" \"user@@hostname\")))))))\n"
28912 #: guix-git/doc/guix.texi:16625
28913 msgid "See below for more details about @code{inetd-configuration}."
28917 #: guix-git/doc/guix.texi:16627
28919 msgid "{Data Type} inetd-configuration"
28923 #: guix-git/doc/guix.texi:16629
28924 msgid "Data type representing the configuration of @command{inetd}."
28928 #: guix-git/doc/guix.texi:16631
28930 msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})"
28934 #: guix-git/doc/guix.texi:16633
28935 msgid "The @command{inetd} executable to use."
28939 #: guix-git/doc/guix.texi:16634 guix-git/doc/guix.texi:25932
28941 msgid "@code{entries} (default: @code{'()})"
28945 #: guix-git/doc/guix.texi:16637
28946 msgid "A list of @command{inetd} service entries. Each entry should be created by the @code{inetd-entry} constructor."
28950 #: guix-git/doc/guix.texi:16640
28952 msgid "{Data Type} inetd-entry"
28956 #: guix-git/doc/guix.texi:16644
28957 msgid "Data type representing an entry in the @command{inetd} configuration. Each entry corresponds to a socket where @command{inetd} will listen for requests."
28961 #: guix-git/doc/guix.texi:16646
28963 msgid "@code{node} (default: @code{#f})"
28967 #: guix-git/doc/guix.texi:16651
28968 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."
28972 #: guix-git/doc/guix.texi:16653
28973 msgid "A string, the name must correspond to an entry in @code{/etc/services}."
28977 #: guix-git/doc/guix.texi:16653
28979 msgid "socket-type"
28983 #: guix-git/doc/guix.texi:16656
28984 msgid "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or @code{'seqpacket}."
28988 #: guix-git/doc/guix.texi:16656
28994 #: guix-git/doc/guix.texi:16658
28995 msgid "A string, must correspond to an entry in @code{/etc/protocols}."
28999 #: guix-git/doc/guix.texi:16658
29001 msgid "@code{wait?} (default: @code{#t})"
29005 #: guix-git/doc/guix.texi:16661
29006 msgid "Whether @command{inetd} should wait for the server to exit before listening to new service requests."
29010 #: guix-git/doc/guix.texi:16666
29011 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\"}."
29015 #: guix-git/doc/guix.texi:16666
29017 msgid "@code{program} (default: @code{\"internal\"})"
29021 #: guix-git/doc/guix.texi:16669
29022 msgid "The server program which will serve the requests, or @code{\"internal\"} if @command{inetd} should use a built-in service."
29026 #: guix-git/doc/guix.texi:16674
29027 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\")}."
29031 #: guix-git/doc/guix.texi:16678
29032 msgid "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed discussion of each configuration field."
29036 #: guix-git/doc/guix.texi:16680
29042 #: guix-git/doc/guix.texi:16681
29044 msgid "{Scheme Variable} tor-service-type"
29048 #: guix-git/doc/guix.texi:16686
29049 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."
29053 #: guix-git/doc/guix.texi:16689
29055 msgid "{Data Type} tor-configuration"
29059 #: guix-git/doc/guix.texi:16691
29061 msgid "@code{tor} (default: @code{tor})"
29065 #: guix-git/doc/guix.texi:16696
29066 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."
29070 #: guix-git/doc/guix.texi:16697
29072 msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})"
29076 #: guix-git/doc/guix.texi:16703
29077 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."
29081 #: guix-git/doc/guix.texi:16704
29083 msgid "@code{hidden-services} (default: @code{'()})"
29087 #: guix-git/doc/guix.texi:16710
29088 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."
29092 #: guix-git/doc/guix.texi:16711
29094 msgid "@code{socks-socket-type} (default: @code{'tcp})"
29098 #: guix-git/doc/guix.texi:16718
29099 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."
29103 #: guix-git/doc/guix.texi:16723
29104 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."
29108 #: guix-git/doc/guix.texi:16724
29110 msgid "@code{control-socket?} (default: @code{#f})"
29114 #: guix-git/doc/guix.texi:16730
29115 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."
29119 #: guix-git/doc/guix.texi:16734
29121 msgid "hidden service"
29125 #: guix-git/doc/guix.texi:16735
29127 msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}"
29131 #: guix-git/doc/guix.texi:16738
29132 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:"
29136 #: guix-git/doc/guix.texi:16742
29139 " '((22 \"127.0.0.1:22\")\n"
29140 " (80 \"127.0.0.1:8080\"))\n"
29144 #: guix-git/doc/guix.texi:16746
29145 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."
29149 #: guix-git/doc/guix.texi:16750
29150 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."
29154 #: guix-git/doc/guix.texi:16753
29155 msgid "See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information."
29158 #. type: Plain text
29159 #: guix-git/doc/guix.texi:16756
29160 msgid "The @code{(gnu services rsync)} module provides the following services:"
29163 #. type: Plain text
29164 #: guix-git/doc/guix.texi:16760
29165 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."
29169 #: guix-git/doc/guix.texi:16761
29171 msgid "{Scheme Variable} rsync-service-type"
29175 #: guix-git/doc/guix.texi:16765
29176 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:"
29180 #: guix-git/doc/guix.texi:16768
29182 msgid "(service rsync-service-type)\n"
29186 #: guix-git/doc/guix.texi:16771
29187 msgid "See below for details about @code{rsync-configuration}."
29191 #: guix-git/doc/guix.texi:16773
29193 msgid "{Data Type} rsync-configuration"
29197 #: guix-git/doc/guix.texi:16775
29198 msgid "Data type representing the configuration for @code{rsync-service}."
29202 #: guix-git/doc/guix.texi:16777
29204 msgid "@code{package} (default: @var{rsync})"
29208 #: guix-git/doc/guix.texi:16779
29209 msgid "@code{rsync} package to use."
29213 #: guix-git/doc/guix.texi:16780
29215 msgid "@code{port-number} (default: @code{873})"
29219 #: guix-git/doc/guix.texi:16784
29220 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."
29224 #: guix-git/doc/guix.texi:16785
29226 msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})"
29230 #: guix-git/doc/guix.texi:16787
29231 msgid "Name of the file where @command{rsync} writes its PID."
29235 #: guix-git/doc/guix.texi:16788
29237 msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})"
29241 #: guix-git/doc/guix.texi:16790
29242 msgid "Name of the file where @command{rsync} writes its lock file."
29246 #: guix-git/doc/guix.texi:16791
29248 msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})"
29252 #: guix-git/doc/guix.texi:16793
29253 msgid "Name of the file where @command{rsync} writes its log file."
29257 #: guix-git/doc/guix.texi:16794
29259 msgid "@code{use-chroot?} (default: @var{#t})"
29263 #: guix-git/doc/guix.texi:16796
29264 msgid "Whether to use chroot for @command{rsync} shared directory."
29268 #: guix-git/doc/guix.texi:16797
29270 msgid "@code{share-path} (default: @file{/srv/rsync})"
29274 #: guix-git/doc/guix.texi:16799
29275 msgid "Location of the @command{rsync} shared directory."
29279 #: guix-git/doc/guix.texi:16800
29281 msgid "@code{share-comment} (default: @code{\"Rsync share\"})"
29285 #: guix-git/doc/guix.texi:16802
29286 msgid "Comment of the @command{rsync} shared directory."
29290 #: guix-git/doc/guix.texi:16803
29292 msgid "@code{read-only?} (default: @var{#f})"
29296 #: guix-git/doc/guix.texi:16805
29297 msgid "Read-write permissions to shared directory."
29301 #: guix-git/doc/guix.texi:16806
29303 msgid "@code{timeout} (default: @code{300})"
29307 #: guix-git/doc/guix.texi:16808
29308 msgid "I/O timeout in seconds."
29312 #: guix-git/doc/guix.texi:16809
29314 msgid "@code{user} (default: @var{\"root\"})"
29318 #: guix-git/doc/guix.texi:16811
29319 msgid "Owner of the @code{rsync} process."
29323 #: guix-git/doc/guix.texi:16812
29325 msgid "@code{group} (default: @var{\"root\"})"
29329 #: guix-git/doc/guix.texi:16814
29330 msgid "Group of the @code{rsync} process."
29334 #: guix-git/doc/guix.texi:16815
29336 msgid "@code{uid} (default: @var{\"rsyncd\"})"
29340 #: guix-git/doc/guix.texi:16818
29341 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}."
29345 #: guix-git/doc/guix.texi:16819
29347 msgid "@code{gid} (default: @var{\"rsyncd\"})"
29351 #: guix-git/doc/guix.texi:16821 guix-git/doc/guix.texi:17264
29352 msgid "Group name or group ID that will be used when accessing the module."
29355 #. type: Plain text
29356 #: guix-git/doc/guix.texi:16826
29357 msgid "The @code{(gnu services syncthing)} module provides the following services:"
29361 #: guix-git/doc/guix.texi:16826
29366 #. type: Plain text
29367 #: guix-git/doc/guix.texi:16831
29368 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."
29372 #: guix-git/doc/guix.texi:16832
29374 msgid "{Scheme Variable} syncthing-service-type"
29378 #: guix-git/doc/guix.texi:16836
29379 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:"
29383 #: guix-git/doc/guix.texi:16840
29386 "(service syncthing-service-type\n"
29387 " (syncthing-configuration (user \"alice\")))\n"
29391 #: guix-git/doc/guix.texi:16843
29392 msgid "See below for details about @code{syncthing-configuration}."
29396 #: guix-git/doc/guix.texi:16844
29398 msgid "{Data Type} syncthing-configuration"
29402 #: guix-git/doc/guix.texi:16846
29403 msgid "Data type representing the configuration for @code{syncthing-service-type}."
29407 #: guix-git/doc/guix.texi:16848
29409 msgid "@code{syncthing} (default: @var{syncthing})"
29413 #: guix-git/doc/guix.texi:16850
29414 msgid "@code{syncthing} package to use."
29418 #: guix-git/doc/guix.texi:16851
29420 msgid "@code{arguments} (default: @var{'()})"
29424 #: guix-git/doc/guix.texi:16853
29425 msgid "List of command-line arguments passing to @code{syncthing} binary."
29429 #: guix-git/doc/guix.texi:16854
29431 msgid "@code{logflags} (default: @var{0})"
29435 #: guix-git/doc/guix.texi:16857
29436 msgid "Sum of logging flags, see @uref{https://docs.syncthing.net/users/syncthing.html#cmdoption-logflags, Syncthing documentation logflags}."
29440 #: guix-git/doc/guix.texi:16858
29442 msgid "@code{user} (default: @var{#f})"
29446 #: guix-git/doc/guix.texi:16861
29447 msgid "The user as which the Syncthing service is to be run. This assumes that the specified user exists."
29451 #: guix-git/doc/guix.texi:16862
29453 msgid "@code{group} (default: @var{\"users\"})"
29457 #: guix-git/doc/guix.texi:16865
29458 msgid "The group as which the Syncthing service is to be run. This assumes that the specified group exists."
29462 #: guix-git/doc/guix.texi:16866
29464 msgid "@code{home} (default: @var{#f})"
29468 #: guix-git/doc/guix.texi:16869
29469 msgid "Common configuration and data directory. The default configuration directory is @file{$HOME} of the specified Syncthing @code{user}."
29472 #. type: Plain text
29473 #: guix-git/doc/guix.texi:16875
29474 msgid "Furthermore, @code{(gnu services ssh)} provides the following services."
29478 #: guix-git/doc/guix.texi:16875 guix-git/doc/guix.texi:16914
29479 #: guix-git/doc/guix.texi:33575
29485 #: guix-git/doc/guix.texi:16876 guix-git/doc/guix.texi:16915
29486 #: guix-git/doc/guix.texi:33576
29492 #: guix-git/doc/guix.texi:16878
29494 msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @"
29498 #: guix-git/doc/guix.texi:16887
29499 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."
29503 #: guix-git/doc/guix.texi:16893
29504 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}."
29508 #: guix-git/doc/guix.texi:16897
29509 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."
29513 #: guix-git/doc/guix.texi:16902
29514 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})."
29518 #: guix-git/doc/guix.texi:16906
29519 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."
29523 #: guix-git/doc/guix.texi:16910
29524 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."
29528 #: guix-git/doc/guix.texi:16912
29529 msgid "The other options should be self-descriptive."
29533 #: guix-git/doc/guix.texi:16916
29535 msgid "{Scheme Variable} openssh-service-type"
29539 #: guix-git/doc/guix.texi:16920
29540 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:"
29544 #: guix-git/doc/guix.texi:16929
29547 "(service openssh-service-type\n"
29548 " (openssh-configuration\n"
29549 " (x11-forwarding? #t)\n"
29550 " (permit-root-login 'without-password)\n"
29551 " (authorized-keys\n"
29552 " `((\"alice\" ,(local-file \"alice.pub\"))\n"
29553 " (\"bob\" ,(local-file \"bob.pub\"))))))\n"
29557 #: guix-git/doc/guix.texi:16932
29558 msgid "See below for details about @code{openssh-configuration}."
29562 #: guix-git/doc/guix.texi:16935
29563 msgid "This service can be extended with extra authorized keys, as in this example:"
29567 #: guix-git/doc/guix.texi:16940
29570 "(service-extension openssh-service-type\n"
29571 " (const `((\"charlie\"\n"
29572 " ,(local-file \"charlie.pub\")))))\n"
29576 #: guix-git/doc/guix.texi:16943
29578 msgid "{Data Type} openssh-configuration"
29582 #: guix-git/doc/guix.texi:16945
29583 msgid "This is the configuration record for OpenSSH's @command{sshd}."
29587 #: guix-git/doc/guix.texi:16947
29589 msgid "@code{openssh} (default @var{openssh})"
29593 #: guix-git/doc/guix.texi:16949
29594 msgid "The Openssh package to use."
29598 #: guix-git/doc/guix.texi:16950
29600 msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})"
29604 #: guix-git/doc/guix.texi:16952
29605 msgid "Name of the file where @command{sshd} writes its PID."
29609 #: guix-git/doc/guix.texi:16953
29611 msgid "@code{port-number} (default: @code{22})"
29615 #: guix-git/doc/guix.texi:16955
29616 msgid "TCP port on which @command{sshd} listens for incoming connections."
29620 #: guix-git/doc/guix.texi:16956
29622 msgid "@code{permit-root-login} (default: @code{#f})"
29626 #: guix-git/doc/guix.texi:16961
29627 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."
29631 #: guix-git/doc/guix.texi:16962 guix-git/doc/guix.texi:17123
29633 msgid "@code{allow-empty-passwords?} (default: @code{#f})"
29637 #: guix-git/doc/guix.texi:16965
29638 msgid "When true, users with empty passwords may log in. When false, they may not."
29642 #: guix-git/doc/guix.texi:16966 guix-git/doc/guix.texi:17126
29644 msgid "@code{password-authentication?} (default: @code{#t})"
29648 #: guix-git/doc/guix.texi:16969
29649 msgid "When true, users may log in with their password. When false, they have other authentication methods."
29653 #: guix-git/doc/guix.texi:16970
29655 msgid "@code{public-key-authentication?} (default: @code{#t})"
29659 #: guix-git/doc/guix.texi:16973
29660 msgid "When true, users may log in using public key authentication. When false, users have to use other authentication method."
29664 #: guix-git/doc/guix.texi:16976
29665 msgid "Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is used only by protocol version 2."
29669 #: guix-git/doc/guix.texi:16977
29671 msgid "@code{x11-forwarding?} (default: @code{#f})"
29675 #: guix-git/doc/guix.texi:16981
29676 msgid "When true, forwarding of X11 graphical client connections is enabled---in other words, @command{ssh} options @option{-X} and @option{-Y} will work."
29680 #: guix-git/doc/guix.texi:16982
29682 msgid "@code{allow-agent-forwarding?} (default: @code{#t})"
29686 #: guix-git/doc/guix.texi:16984
29687 msgid "Whether to allow agent forwarding."
29691 #: guix-git/doc/guix.texi:16985
29693 msgid "@code{allow-tcp-forwarding?} (default: @code{#t})"
29697 #: guix-git/doc/guix.texi:16987
29698 msgid "Whether to allow TCP forwarding."
29702 #: guix-git/doc/guix.texi:16988
29704 msgid "@code{gateway-ports?} (default: @code{#f})"
29708 #: guix-git/doc/guix.texi:16990
29709 msgid "Whether to allow gateway ports."
29713 #: guix-git/doc/guix.texi:16991
29715 msgid "@code{challenge-response-authentication?} (default: @code{#f})"
29719 #: guix-git/doc/guix.texi:16994
29720 msgid "Specifies whether challenge response authentication is allowed (e.g.@: via PAM)."
29724 #: guix-git/doc/guix.texi:16995
29726 msgid "@code{use-pam?} (default: @code{#t})"
29730 #: guix-git/doc/guix.texi:17001
29731 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."
29735 #: guix-git/doc/guix.texi:17006
29736 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?}."
29740 #: guix-git/doc/guix.texi:17007
29742 msgid "@code{print-last-log?} (default: @code{#t})"
29746 #: guix-git/doc/guix.texi:17010
29747 msgid "Specifies whether @command{sshd} should print the date and time of the last user login when a user logs in interactively."
29751 #: guix-git/doc/guix.texi:17011
29753 msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})"
29757 #: guix-git/doc/guix.texi:17013
29758 msgid "Configures external subsystems (e.g.@: file transfer daemon)."
29762 #: guix-git/doc/guix.texi:17017
29763 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."
29767 #: guix-git/doc/guix.texi:17020
29768 msgid "The command @command{internal-sftp} implements an in-process SFTP server. Alternatively, one can specify the @command{sftp-server} command:"
29772 #: guix-git/doc/guix.texi:17025
29775 "(service openssh-service-type\n"
29776 " (openssh-configuration\n"
29778 " `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n"
29782 #: guix-git/doc/guix.texi:17027
29784 msgid "@code{accepted-environment} (default: @code{'()})"
29788 #: guix-git/doc/guix.texi:17029
29789 msgid "List of strings describing which environment variables may be exported."
29793 #: guix-git/doc/guix.texi:17032
29794 msgid "Each string gets on its own line. See the @code{AcceptEnv} option in @code{man sshd_config}."
29798 #: guix-git/doc/guix.texi:17037
29799 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."
29803 #: guix-git/doc/guix.texi:17042
29806 "(service openssh-service-type\n"
29807 " (openssh-configuration\n"
29808 " (accepted-environment '(\"COLORTERM\"))))\n"
29812 #: guix-git/doc/guix.texi:17044
29814 msgid "@code{authorized-keys} (default: @code{'()})"
29818 #: guix-git/doc/guix.texi:17045
29820 msgid "authorized keys, SSH"
29824 #: guix-git/doc/guix.texi:17046
29826 msgid "SSH authorized keys"
29830 #: guix-git/doc/guix.texi:17050
29831 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:"
29835 #: guix-git/doc/guix.texi:17057
29838 "(openssh-configuration\n"
29839 " (authorized-keys\n"
29840 " `((\"rekado\" ,(local-file \"rekado.pub\"))\n"
29841 " (\"chris\" ,(local-file \"chris.pub\"))\n"
29842 " (\"root\" ,(local-file \"rekado.pub\") ,(local-file \"chris.pub\")))))\n"
29846 #: guix-git/doc/guix.texi:17062
29847 msgid "registers the specified public keys for user accounts @code{rekado}, @code{chris}, and @code{root}."
29851 #: guix-git/doc/guix.texi:17065
29852 msgid "Additional authorized keys can be specified @i{via} @code{service-extension}."
29856 #: guix-git/doc/guix.texi:17068
29857 msgid "Note that this does @emph{not} interfere with the use of @file{~/.ssh/authorized_keys}."
29861 #: guix-git/doc/guix.texi:17069 guix-git/doc/guix.texi:17500
29863 msgid "@code{log-level} (default: @code{'info})"
29867 #: guix-git/doc/guix.texi:17073
29868 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."
29872 #: guix-git/doc/guix.texi:17074 guix-git/doc/guix.texi:19894
29873 #: guix-git/doc/guix.texi:24760
29875 msgid "@code{extra-content} (default: @code{\"\"})"
29879 #: guix-git/doc/guix.texi:17079
29880 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:"
29884 #: guix-git/doc/guix.texi:17085
29887 "(openssh-configuration\n"
29888 " (extra-content \"\\\n"
29889 "Match Address 192.168.0.1\n"
29890 " PermitRootLogin yes\"))\n"
29894 #: guix-git/doc/guix.texi:17090
29896 msgid "{Scheme Procedure} dropbear-service [@var{config}]"
29900 #: guix-git/doc/guix.texi:17094
29901 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."
29905 #: guix-git/doc/guix.texi:17097
29906 msgid "For example, to specify a Dropbear service listening on port 1234, add this call to the operating system's @code{services} field:"
29910 #: guix-git/doc/guix.texi:17101
29913 "(dropbear-service (dropbear-configuration\n"
29914 " (port-number 1234)))\n"
29918 #: guix-git/doc/guix.texi:17104
29920 msgid "{Data Type} dropbear-configuration"
29924 #: guix-git/doc/guix.texi:17106
29925 msgid "This data type represents the configuration of a Dropbear SSH daemon."
29929 #: guix-git/doc/guix.texi:17108
29931 msgid "@code{dropbear} (default: @var{dropbear})"
29935 #: guix-git/doc/guix.texi:17110
29936 msgid "The Dropbear package to use."
29940 #: guix-git/doc/guix.texi:17111
29942 msgid "@code{port-number} (default: 22)"
29946 #: guix-git/doc/guix.texi:17113
29947 msgid "The TCP port where the daemon waits for incoming connections."
29951 #: guix-git/doc/guix.texi:17114
29953 msgid "@code{syslog-output?} (default: @code{#t})"
29957 #: guix-git/doc/guix.texi:17116
29958 msgid "Whether to enable syslog output."
29962 #: guix-git/doc/guix.texi:17117
29964 msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})"
29968 #: guix-git/doc/guix.texi:17119
29969 msgid "File name of the daemon's PID file."
29973 #: guix-git/doc/guix.texi:17120
29975 msgid "@code{root-login?} (default: @code{#f})"
29979 #: guix-git/doc/guix.texi:17122
29980 msgid "Whether to allow @code{root} logins."
29984 #: guix-git/doc/guix.texi:17125
29985 msgid "Whether to allow empty passwords."
29989 #: guix-git/doc/guix.texi:17128
29990 msgid "Whether to enable password-based authentication."
29994 #: guix-git/doc/guix.texi:17131
30000 #: guix-git/doc/guix.texi:17132
30002 msgid "{Scheme Variable} autossh-service-type"
30006 #: guix-git/doc/guix.texi:17140
30007 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."
30011 #: guix-git/doc/guix.texi:17144
30012 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."
30016 #: guix-git/doc/guix.texi:17149
30017 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:"
30021 #: guix-git/doc/guix.texi:17155
30024 "(service autossh-service-type\n"
30025 " (autossh-configuration\n"
30026 " (user \"pino\")\n"
30027 " (ssh-options (list \"-T\" \"-N\" \"-L\" \"8081:localhost:8081\" \"remote.net\"))))\n"
30031 #: guix-git/doc/guix.texi:17158
30033 msgid "{Data Type} autossh-configuration"
30037 #: guix-git/doc/guix.texi:17160
30038 msgid "This data type represents the configuration of an AutoSSH service."
30042 #: guix-git/doc/guix.texi:17163
30044 msgid "@code{user} (default @code{\"autossh\"})"
30048 #: guix-git/doc/guix.texi:17166
30049 msgid "The user as which the AutoSSH service is to be run. This assumes that the specified user exists."
30053 #: guix-git/doc/guix.texi:17167
30055 msgid "@code{poll} (default @code{600})"
30059 #: guix-git/doc/guix.texi:17169
30060 msgid "Specifies the connection poll time in seconds."
30064 #: guix-git/doc/guix.texi:17170
30066 msgid "@code{first-poll} (default @code{#f})"
30070 #: guix-git/doc/guix.texi:17176
30071 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}."
30075 #: guix-git/doc/guix.texi:17177
30077 msgid "@code{gate-time} (default @code{30})"
30081 #: guix-git/doc/guix.texi:17180
30082 msgid "Specifies how many seconds an SSH connection must be active before it is considered successful."
30086 #: guix-git/doc/guix.texi:17181
30088 msgid "@code{log-level} (default @code{1})"
30092 #: guix-git/doc/guix.texi:17184
30093 msgid "The log level, corresponding to the levels used by syslog---so @code{0} is the most silent while @code{7} is the chattiest."
30097 #: guix-git/doc/guix.texi:17185
30099 msgid "@code{max-start} (default @code{#f})"
30103 #: guix-git/doc/guix.texi:17188
30104 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."
30108 #: guix-git/doc/guix.texi:17189
30110 msgid "@code{message} (default @code{\"\"})"
30114 #: guix-git/doc/guix.texi:17191
30115 msgid "The message to append to the echo message sent when testing connections."
30119 #: guix-git/doc/guix.texi:17192
30121 msgid "@code{port} (default @code{\"0\"})"
30125 #: guix-git/doc/guix.texi:17202
30126 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."
30130 #: guix-git/doc/guix.texi:17203
30132 msgid "@code{ssh-options} (default @code{'()})"
30136 #: guix-git/doc/guix.texi:17207
30137 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."
30141 #: guix-git/doc/guix.texi:17211
30147 #: guix-git/doc/guix.texi:17212
30149 msgid "{Scheme Variable} webssh-service-type"
30153 #: guix-git/doc/guix.texi:17218
30154 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."
30158 #: guix-git/doc/guix.texi:17224
30159 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:"
30163 #: guix-git/doc/guix.texi:17232
30166 "(service webssh-service-type\n"
30167 " (webssh-configuration (address \"127.0.0.1\")\n"
30169 " (policy 'reject)\n"
30170 " (known-hosts '(\"localhost ecdsa-sha2-nistp256 AAAA…\"\n"
30171 " \"127.0.0.1 ecdsa-sha2-nistp256 AAAA…\"))))\n"
30176 #: guix-git/doc/guix.texi:17248
30179 "(service nginx-service-type\n"
30180 " (nginx-configuration\n"
30181 " (server-blocks\n"
30183 " (nginx-server-configuration\n"
30184 " (inherit %webssh-configuration-nginx)\n"
30185 " (server-name '(\"webssh.example.com\"))\n"
30186 " (listen '(\"443 ssl\"))\n"
30187 " (ssl-certificate (letsencrypt-certificate \"webssh.example.com\"))\n"
30188 " (ssl-certificate-key (letsencrypt-key \"webssh.example.com\"))\n"
30190 " (cons (nginx-location-configuration\n"
30191 " (uri \"/.well-known\")\n"
30192 " (body '(\"root /var/www;\")))\n"
30193 " (nginx-server-configuration-locations %webssh-configuration-nginx))))))))\n"
30197 #: guix-git/doc/guix.texi:17251
30199 msgid "{Data Type} webssh-configuration"
30203 #: guix-git/doc/guix.texi:17253
30204 msgid "Data type representing the configuration for @code{webssh-service}."
30208 #: guix-git/doc/guix.texi:17255
30210 msgid "@code{package} (default: @var{webssh})"
30214 #: guix-git/doc/guix.texi:17257
30215 msgid "@code{webssh} package to use."
30219 #: guix-git/doc/guix.texi:17258
30221 msgid "@code{user-name} (default: @var{\"webssh\"})"
30225 #: guix-git/doc/guix.texi:17261
30226 msgid "User name or user ID that file transfers to and from that module should take place."
30230 #: guix-git/doc/guix.texi:17262
30232 msgid "@code{group-name} (default: @var{\"webssh\"})"
30236 #: guix-git/doc/guix.texi:17265
30238 msgid "@code{address} (default: @var{#f})"
30242 #: guix-git/doc/guix.texi:17267
30243 msgid "IP address on which @command{webssh} listens for incoming connections."
30247 #: guix-git/doc/guix.texi:17268
30249 msgid "@code{port} (default: @var{8888})"
30253 #: guix-git/doc/guix.texi:17270
30254 msgid "TCP port on which @command{webssh} listens for incoming connections."
30258 #: guix-git/doc/guix.texi:17271
30260 msgid "@code{policy} (default: @var{#f})"
30264 #: guix-git/doc/guix.texi:17273
30265 msgid "Connection policy. @var{reject} policy requires to specify @var{known-hosts}."
30269 #: guix-git/doc/guix.texi:17274
30271 msgid "@code{known-hosts} (default: @var{'()})"
30275 #: guix-git/doc/guix.texi:17276
30276 msgid "List of hosts which allowed for SSH connection from @command{webssh}."
30280 #: guix-git/doc/guix.texi:17277
30282 msgid "@code{log-file} (default: @file{\"/var/log/webssh.log\"})"
30286 #: guix-git/doc/guix.texi:17279
30287 msgid "Name of the file where @command{webssh} writes its log file."
30291 #: guix-git/doc/guix.texi:17280
30293 msgid "@code{log-level} (default: @var{#f})"
30297 #: guix-git/doc/guix.texi:17282
30298 msgid "Logging level."
30302 #: guix-git/doc/guix.texi:17286
30304 msgid "{Scheme Variable} %facebook-host-aliases"
30308 #: guix-git/doc/guix.texi:17292
30309 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}."
30313 #: guix-git/doc/guix.texi:17296
30314 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}}):"
30318 #: guix-git/doc/guix.texi:17309
30321 "(operating-system\n"
30322 " (host-name \"mymachine\")\n"
30325 " ;; Create a /etc/hosts file with aliases for \"localhost\"\n"
30326 " ;; and \"mymachine\", as well as for Facebook servers.\n"
30327 " (plain-file \"hosts\"\n"
30328 " (string-append (local-host-aliases host-name)\n"
30329 " %facebook-host-aliases))))\n"
30333 #: guix-git/doc/guix.texi:17313
30334 msgid "This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook."
30337 #. type: Plain text
30338 #: guix-git/doc/guix.texi:17316
30339 msgid "The @code{(gnu services avahi)} provides the following definition."
30343 #: guix-git/doc/guix.texi:17317
30345 msgid "{Scheme Variable} avahi-service-type"
30349 #: guix-git/doc/guix.texi:17322
30350 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."
30354 #: guix-git/doc/guix.texi:17327
30355 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."
30359 #: guix-git/doc/guix.texi:17330
30360 msgid "Additionally, add the @var{avahi} package to the system profile so that commands such as @command{avahi-browse} are directly usable."
30364 #: guix-git/doc/guix.texi:17332
30366 msgid "{Data Type} avahi-configuration"
30370 #: guix-git/doc/guix.texi:17334
30371 msgid "Data type representation the configuration for Avahi."
30375 #: guix-git/doc/guix.texi:17337
30377 msgid "@code{host-name} (default: @code{#f})"
30381 #: guix-git/doc/guix.texi:17340
30382 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."
30386 #: guix-git/doc/guix.texi:17341
30388 msgid "@code{publish?} (default: @code{#t})"
30392 #: guix-git/doc/guix.texi:17344
30393 msgid "When true, allow host names and services to be published (broadcast) over the network."
30397 #: guix-git/doc/guix.texi:17345
30399 msgid "@code{publish-workstation?} (default: @code{#t})"
30403 #: guix-git/doc/guix.texi:17349
30404 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:"
30408 #: guix-git/doc/guix.texi:17352
30410 msgid "avahi-browse _workstation._tcp\n"
30414 #: guix-git/doc/guix.texi:17354
30416 msgid "@code{wide-area?} (default: @code{#f})"
30420 #: guix-git/doc/guix.texi:17356
30421 msgid "When true, DNS-SD over unicast DNS is enabled."
30425 #: guix-git/doc/guix.texi:17357
30427 msgid "@code{ipv4?} (default: @code{#t})"
30431 #: guix-git/doc/guix.texi:17358
30433 msgid "@code{ipv6?} (default: @code{#t})"
30437 #: guix-git/doc/guix.texi:17360
30438 msgid "These fields determine whether to use IPv4/IPv6 sockets."
30442 #: guix-git/doc/guix.texi:17361
30444 msgid "@code{domains-to-browse} (default: @code{'()})"
30448 #: guix-git/doc/guix.texi:17363
30449 msgid "This is a list of domains to browse."
30453 #: guix-git/doc/guix.texi:17366
30455 msgid "{Scheme Variable} openvswitch-service-type"
30459 #: guix-git/doc/guix.texi:17370
30460 msgid "This is the type of the @uref{https://www.openvswitch.org, Open vSwitch} service, whose value should be an @code{openvswitch-configuration} object."
30464 #: guix-git/doc/guix.texi:17372
30466 msgid "{Data Type} openvswitch-configuration"
30470 #: guix-git/doc/guix.texi:17376
30471 msgid "Data type representing the configuration of Open vSwitch, a multilayer virtual switch which is designed to enable massive network automation through programmatic extension."
30475 #: guix-git/doc/guix.texi:17378
30477 msgid "@code{package} (default: @var{openvswitch})"
30481 #: guix-git/doc/guix.texi:17380
30482 msgid "Package object of the Open vSwitch."
30486 #: guix-git/doc/guix.texi:17384
30488 msgid "{Scheme Variable} pagekite-service-type"
30492 #: guix-git/doc/guix.texi:17389
30493 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."
30497 #: guix-git/doc/guix.texi:17391
30498 msgid "Here's an example exposing the local HTTP and SSH daemons:"
30502 #: guix-git/doc/guix.texi:17398
30505 "(service pagekite-service-type\n"
30506 " (pagekite-configuration\n"
30507 " (kites '(\"http:@@kitename:localhost:80:@@kitesecret\"\n"
30508 " \"raw/22:@@kitename:localhost:22:@@kitesecret\"))\n"
30509 " (extra-file \"/etc/pagekite.rc\")))\n"
30513 #: guix-git/doc/guix.texi:17401
30515 msgid "{Data Type} pagekite-configuration"
30519 #: guix-git/doc/guix.texi:17403
30520 msgid "Data type representing the configuration of PageKite."
30524 #: guix-git/doc/guix.texi:17405
30526 msgid "@code{package} (default: @var{pagekite})"
30530 #: guix-git/doc/guix.texi:17407
30531 msgid "Package object of PageKite."
30535 #: guix-git/doc/guix.texi:17408
30537 msgid "@code{kitename} (default: @code{#f})"
30541 #: guix-git/doc/guix.texi:17410
30542 msgid "PageKite name for authenticating to the frontend server."
30546 #: guix-git/doc/guix.texi:17411
30548 msgid "@code{kitesecret} (default: @code{#f})"
30552 #: guix-git/doc/guix.texi:17414
30553 msgid "Shared secret for authenticating to the frontend server. You should probably put this inside @code{extra-file} instead."
30557 #: guix-git/doc/guix.texi:17415
30559 msgid "@code{frontend} (default: @code{#f})"
30563 #: guix-git/doc/guix.texi:17418
30564 msgid "Connect to the named PageKite frontend server instead of the @uref{https://pagekite.net,,pagekite.net} service."
30568 #: guix-git/doc/guix.texi:17419
30570 msgid "@code{kites} (default: @code{'(\"http:@@kitename:localhost:80:@@kitesecret\")})"
30574 #: guix-git/doc/guix.texi:17422
30575 msgid "List of service kites to use. Exposes HTTP on port 80 by default. The format is @code{proto:kitename:host:port:secret}."
30579 #: guix-git/doc/guix.texi:17423
30581 msgid "@code{extra-file} (default: @code{#f})"
30585 #: guix-git/doc/guix.texi:17426
30586 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."
30590 #: guix-git/doc/guix.texi:17430
30592 msgid "{Scheme Variable} yggdrasil-service-type"
30596 #: guix-git/doc/guix.texi:17434
30597 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."
30601 #: guix-git/doc/guix.texi:17441
30602 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}"
30606 #: guix-git/doc/guix.texi:17445
30607 msgid "Pass it a value of @code{yggdrasil-configuration} to connect it to public peers and/or local peers."
30611 #: guix-git/doc/guix.texi:17449
30612 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})."
30616 #: guix-git/doc/guix.texi:17461
30619 ";; part of the operating-system declaration\n"
30620 "(service yggdrasil-service-type\n"
30621 " (yggdrasil-configuration\n"
30622 " (autoconf? #f) ;; use only the public peers\n"
30624 " ;; choose one from\n"
30625 " ;; https://github.com/yggdrasil-network/public-peers\n"
30626 " '((peers . #(\"tcp://1.2.3.4:1337\"))))\n"
30627 " ;; /etc/yggdrasil-private.conf is the default value for config-file\n"
30632 #: guix-git/doc/guix.texi:17468
30635 "# sample content for /etc/yggdrasil-private.conf\n"
30637 " # Your public encryption key. Your peers may ask you for this to put\n"
30638 " # into their AllowedEncryptionPublicKeys configuration.\n"
30639 " EncryptionPublicKey: 378dc5...\n"
30644 #: guix-git/doc/guix.texi:17471
30647 " # Your private encryption key. DO NOT share this with anyone!\n"
30648 " EncryptionPrivateKey: 0777...\n"
30653 #: guix-git/doc/guix.texi:17475
30656 " # Your public signing key. You should not ordinarily need to share\n"
30657 " # this with anyone.\n"
30658 " SigningPublicKey: e1664...\n"
30663 #: guix-git/doc/guix.texi:17479
30666 " # Your private signing key. DO NOT share this with anyone!\n"
30667 " SigningPrivateKey: 0589d...\n"
30672 #: guix-git/doc/guix.texi:17482
30674 msgid "{Data Type} yggdrasil-configuration"
30678 #: guix-git/doc/guix.texi:17484
30679 msgid "Data type representing the configuration of Yggdrasil."
30683 #: guix-git/doc/guix.texi:17486
30685 msgid "@code{package} (default: @code{yggdrasil})"
30689 #: guix-git/doc/guix.texi:17488
30690 msgid "Package object of Yggdrasil."
30694 #: guix-git/doc/guix.texi:17489
30696 msgid "@code{json-config} (default: @code{'()})"
30700 #: guix-git/doc/guix.texi:17495
30701 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."
30705 #: guix-git/doc/guix.texi:17496
30707 msgid "@code{autoconf?} (default: @code{#f})"
30711 #: guix-git/doc/guix.texi:17499
30712 msgid "Whether to use automatic mode. Enabling it makes Yggdrasil use adynamic IP and peer with IPv6 neighbors."
30716 #: guix-git/doc/guix.texi:17502
30717 msgid "How much detail to include in logs. Use @code{'debug} for more detail."
30721 #: guix-git/doc/guix.texi:17503
30723 msgid "@code{log-to} (default: @code{'stdout})"
30727 #: guix-git/doc/guix.texi:17507
30728 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."
30732 #: guix-git/doc/guix.texi:17508
30734 msgid "@code{config-file} (default: @code{\"/etc/yggdrasil-private.conf\"})"
30738 #: guix-git/doc/guix.texi:17515
30739 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:"
30743 #: guix-git/doc/guix.texi:17517
30745 msgid "EncryptionPublicKey"
30749 #: guix-git/doc/guix.texi:17518
30751 msgid "EncryptionPrivateKey"
30755 #: guix-git/doc/guix.texi:17519
30757 msgid "SigningPublicKey"
30761 #: guix-git/doc/guix.texi:17520
30763 msgid "SigningPrivateKey"
30767 #: guix-git/doc/guix.texi:17525
30773 #: guix-git/doc/guix.texi:17526
30775 msgid "{Scheme Variable} ipfs-service-type"
30779 #: guix-git/doc/guix.texi:17530
30780 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."
30784 #: guix-git/doc/guix.texi:17532
30785 msgid "Here's an example configuration, using some non-standard ports:"
30789 #: guix-git/doc/guix.texi:17538
30792 "(service ipfs-service-type\n"
30793 " (ipfs-configuration\n"
30794 " (gateway \"/ip4/127.0.0.1/tcp/8880\")\n"
30795 " (api \"/ip4/127.0.0.1/tcp/8881\")))\n"
30799 #: guix-git/doc/guix.texi:17541
30801 msgid "{Data Type} ipfs-configuration"
30805 #: guix-git/doc/guix.texi:17543
30806 msgid "Data type representing the configuration of IPFS."
30810 #: guix-git/doc/guix.texi:17545
30812 msgid "@code{package} (default: @code{go-ipfs})"
30816 #: guix-git/doc/guix.texi:17547
30817 msgid "Package object of IPFS."
30821 #: guix-git/doc/guix.texi:17548
30823 msgid "@code{gateway} (default: @code{\"/ip4/127.0.0.1/tcp/8082\"})"
30827 #: guix-git/doc/guix.texi:17550
30828 msgid "Address of the gateway, in ‘multiaddress’ format."
30832 #: guix-git/doc/guix.texi:17551
30834 msgid "@code{api} (default: @code{\"/ip4/127.0.0.1/tcp/5001\"})"
30838 #: guix-git/doc/guix.texi:17553
30839 msgid "Address of the API endpoint, in ‘multiaddress’ format."
30843 #: guix-git/doc/guix.texi:17556
30849 #: guix-git/doc/guix.texi:17557
30851 msgid "{Scheme Variable} keepalived-service-type"
30855 #: guix-git/doc/guix.texi:17562
30856 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:"
30860 #: guix-git/doc/guix.texi:17567
30863 "(service keepalived-service-type\n"
30864 " (keepalived-configuration\n"
30865 " (config-file (local-file \"keepalived-master.conf\"))))\n"
30869 #: guix-git/doc/guix.texi:17570
30870 msgid "where @file{keepalived-master.conf}:"
30874 #: guix-git/doc/guix.texi:17582
30877 "vrrp_instance my-group @{\n"
30879 " interface enp9s0\n"
30880 " virtual_router_id 100\n"
30882 " unicast_peer @{ 10.0.0.2 @}\n"
30883 " virtual_ipaddress @{\n"
30890 #: guix-git/doc/guix.texi:17585
30891 msgid "and for backup machine:"
30895 #: guix-git/doc/guix.texi:17590
30898 "(service keepalived-service-type\n"
30899 " (keepalived-configuration\n"
30900 " (config-file (local-file \"keepalived-backup.conf\"))))\n"
30904 #: guix-git/doc/guix.texi:17593
30905 msgid "where @file{keepalived-backup.conf}:"
30909 #: guix-git/doc/guix.texi:17605
30912 "vrrp_instance my-group @{\n"
30914 " interface enp9s0\n"
30915 " virtual_router_id 100\n"
30917 " unicast_peer @{ 10.0.0.3 @}\n"
30918 " virtual_ipaddress @{\n"
30925 #: guix-git/doc/guix.texi:17611
30927 msgid "unattended upgrades"
30931 #: guix-git/doc/guix.texi:17612
30933 msgid "upgrades, unattended"
30936 #. type: Plain text
30937 #: guix-git/doc/guix.texi:17617
30938 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:"
30942 #: guix-git/doc/guix.texi:17622
30943 msgid "upgrades are transactional (either the upgrade succeeds or it fails, but you cannot end up with an ``in-between'' system state);"
30947 #: guix-git/doc/guix.texi:17626
30948 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;"
30952 #: guix-git/doc/guix.texi:17629
30953 msgid "channel code is authenticated so you know you can only run genuine code (@pxref{Channels});"
30957 #: guix-git/doc/guix.texi:17632
30958 msgid "@command{guix system reconfigure} prevents downgrades, which makes it immune to @dfn{downgrade attacks}."
30961 #. type: Plain text
30962 #: guix-git/doc/guix.texi:17637
30963 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:"
30967 #: guix-git/doc/guix.texi:17640
30969 msgid "(service unattended-upgrade-service-type)\n"
30972 #. type: Plain text
30973 #: guix-git/doc/guix.texi:17647
30974 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."
30977 #. type: Plain text
30978 #: guix-git/doc/guix.texi:17653
30979 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."
30982 #. type: Plain text
30983 #: guix-git/doc/guix.texi:17657
30984 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)."
30988 #: guix-git/doc/guix.texi:17658
30990 msgid "{Scheme Variable} unattended-upgrade-service-type"
30994 #: guix-git/doc/guix.texi:17662
30995 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."
30999 #: guix-git/doc/guix.texi:17665
31000 msgid "Its value must be a @code{unattended-upgrade-configuration} record (see below)."
31004 #: guix-git/doc/guix.texi:17667
31006 msgid "{Data Type} unattended-upgrade-configuration"
31010 #: guix-git/doc/guix.texi:17670
31011 msgid "This data type represents the configuration of the unattended upgrade service. The following fields are available:"
31015 #: guix-git/doc/guix.texi:17672
31017 msgid "@code{schedule} (default: @code{\"30 01 * * 0\"})"
31021 #: guix-git/doc/guix.texi:17676
31022 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})."
31026 #: guix-git/doc/guix.texi:17677
31028 msgid "@code{channels} (default: @code{#~%default-channels})"
31032 #: guix-git/doc/guix.texi:17681
31033 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."
31037 #: guix-git/doc/guix.texi:17682
31039 msgid "@code{operating-system-file} (default: @code{\"/run/current-system/configuration.scm\"})"
31043 #: guix-git/doc/guix.texi:17685
31044 msgid "This field specifies the operating system configuration file to use. The default is to reuse the config file of the current configuration."
31048 #: guix-git/doc/guix.texi:17691
31049 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:"
31053 #: guix-git/doc/guix.texi:17697
31056 "(unattended-upgrade-configuration\n"
31057 " (operating-system-file\n"
31058 " (file-append (local-file \".\" \"config-dir\" #:recursive? #t)\n"
31059 " \"/config.scm\")))\n"
31063 #: guix-git/doc/guix.texi:17704
31064 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}."
31068 #: guix-git/doc/guix.texi:17705
31070 msgid "@code{services-to-restart} (default: @code{'(mcron)})"
31074 #: guix-git/doc/guix.texi:17708
31075 msgid "This field specifies the Shepherd services to restart when the upgrade completes."
31079 #: guix-git/doc/guix.texi:17715
31080 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."
31084 #: guix-git/doc/guix.texi:17719
31085 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}."
31089 #: guix-git/doc/guix.texi:17722
31090 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."
31094 #: guix-git/doc/guix.texi:17723
31096 msgid "@code{system-expiration} (default: @code{(* 3 30 24 3600)})"
31100 #: guix-git/doc/guix.texi:17727
31101 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."
31105 #: guix-git/doc/guix.texi:17732
31106 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."
31110 #: guix-git/doc/guix.texi:17734
31112 msgid "@code{maximum-duration} (default: @code{3600})"
31116 #: guix-git/doc/guix.texi:17737
31117 msgid "Maximum duration in seconds for the upgrade; past that time, the upgrade aborts."
31121 #: guix-git/doc/guix.texi:17740
31122 msgid "This is primarily useful to ensure the upgrade does not end up rebuilding or re-downloading ``the world''."
31126 #: guix-git/doc/guix.texi:17741
31128 msgid "@code{log-file} (default: @code{\"/var/log/unattended-upgrade.log\"})"
31132 #: guix-git/doc/guix.texi:17743
31133 msgid "File where unattended upgrades are logged."
31137 #: guix-git/doc/guix.texi:17749
31143 #: guix-git/doc/guix.texi:17750
31145 msgid "X Window System"
31149 #: guix-git/doc/guix.texi:17751 guix-git/doc/guix.texi:18003
31151 msgid "login manager"
31154 #. type: Plain text
31155 #: guix-git/doc/guix.texi:17756
31156 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)."
31160 #: guix-git/doc/guix.texi:17757
31166 #: guix-git/doc/guix.texi:17758
31168 msgid "GNOME, login manager"
31171 #. type: Plain text
31172 #: guix-git/doc/guix.texi:17762
31173 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."
31177 #: guix-git/doc/guix.texi:17763
31179 msgid "window manager"
31182 #. type: Plain text
31183 #: guix-git/doc/guix.texi:17768
31184 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})."
31188 #: guix-git/doc/guix.texi:17769
31190 msgid "{Scheme Variable} gdm-service-type"
31194 #: guix-git/doc/guix.texi:17774
31195 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)."
31199 #: guix-git/doc/guix.texi:17775
31201 msgid "session types (X11)"
31205 #: guix-git/doc/guix.texi:17776
31207 msgid "X11 session types"
31211 #: guix-git/doc/guix.texi:17782
31212 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."
31216 #: guix-git/doc/guix.texi:17786
31217 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."
31221 #: guix-git/doc/guix.texi:17788
31223 msgid "{Data Type} gdm-configuration"
31227 #: guix-git/doc/guix.texi:17790 guix-git/doc/guix.texi:17858
31229 msgid "@code{auto-login?} (default: @code{#f})"
31233 #: guix-git/doc/guix.texi:17791
31235 msgid "@code{default-user} (default: @code{#f})"
31239 #: guix-git/doc/guix.texi:17793
31240 msgid "When @code{auto-login?} is false, GDM presents a log-in screen."
31244 #: guix-git/doc/guix.texi:17796
31245 msgid "When @code{auto-login?} is true, GDM logs in directly as @code{default-user}."
31249 #: guix-git/doc/guix.texi:17797 guix-git/doc/guix.texi:23369
31250 #: guix-git/doc/guix.texi:25077 guix-git/doc/guix.texi:29427
31251 #: guix-git/doc/guix.texi:29456 guix-git/doc/guix.texi:29485
31252 #: guix-git/doc/guix.texi:29512 guix-git/doc/guix.texi:29567
31253 #: guix-git/doc/guix.texi:29592 guix-git/doc/guix.texi:29619
31254 #: guix-git/doc/guix.texi:29645 guix-git/doc/guix.texi:29687
31256 msgid "@code{debug?} (default: @code{#f})"
31260 #: guix-git/doc/guix.texi:17799
31261 msgid "When true, GDM writes debug messages to its log."
31265 #: guix-git/doc/guix.texi:17800
31267 msgid "@code{gnome-shell-assets} (default: ...)"
31271 #: guix-git/doc/guix.texi:17802
31272 msgid "List of GNOME Shell assets needed by GDM: icon theme, fonts, etc."
31276 #: guix-git/doc/guix.texi:17803
31278 msgid "@code{xorg-configuration} (default: @code{(xorg-configuration)})"
31282 #: guix-git/doc/guix.texi:17805 guix-git/doc/guix.texi:17885
31283 #: guix-git/doc/guix.texi:17969
31284 msgid "Configuration of the Xorg graphical server."
31288 #: guix-git/doc/guix.texi:17806
31290 msgid "@code{xsession} (default: @code{(xinitrc)})"
31294 #: guix-git/doc/guix.texi:17808 guix-git/doc/guix.texi:17984
31295 msgid "Script to run before starting a X session."
31299 #: guix-git/doc/guix.texi:17809
31301 msgid "@code{dbus-daemon} (default: @code{dbus-daemon-wrapper})"
31305 #: guix-git/doc/guix.texi:17811
31306 msgid "File name of the @code{dbus-daemon} executable."
31310 #: guix-git/doc/guix.texi:17812
31312 msgid "@code{gdm} (default: @code{gdm})"
31316 #: guix-git/doc/guix.texi:17814
31317 msgid "The GDM package to use."
31321 #: guix-git/doc/guix.texi:17817
31323 msgid "{Scheme Variable} slim-service-type"
31327 #: guix-git/doc/guix.texi:17819
31328 msgid "This is the type for the SLiM graphical login manager for X11."
31332 #: guix-git/doc/guix.texi:17823
31333 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."
31337 #: guix-git/doc/guix.texi:17830
31338 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."
31342 #: guix-git/doc/guix.texi:17836
31345 "(use-modules (gnu services)\n"
31346 " (gnu services desktop)\n"
31347 " (gnu services xorg)\n"
31348 " (srfi srfi-1)) ;for 'remove'\n"
31353 #: guix-git/doc/guix.texi:17847
31356 "(operating-system\n"
31358 " (services (cons* (service slim-service-type (slim-configuration\n"
31359 " (display \":0\")\n"
31360 " (vt \"vt7\")))\n"
31361 " (service slim-service-type (slim-configuration\n"
31362 " (display \":1\")\n"
31363 " (vt \"vt8\")))\n"
31364 " (modify-services %desktop-services\n"
31365 " (delete gdm-service-type)))))\n"
31369 #: guix-git/doc/guix.texi:17851
31371 msgid "{Data Type} slim-configuration"
31375 #: guix-git/doc/guix.texi:17853
31376 msgid "Data type representing the configuration of @code{slim-service-type}."
31380 #: guix-git/doc/guix.texi:17857
31381 msgid "Whether to allow logins with empty passwords."
31385 #: guix-git/doc/guix.texi:17859
31387 msgid "@code{default-user} (default: @code{\"\"})"
31391 #: guix-git/doc/guix.texi:17861
31392 msgid "When @code{auto-login?} is false, SLiM presents a log-in screen."
31396 #: guix-git/doc/guix.texi:17864
31397 msgid "When @code{auto-login?} is true, SLiM logs in directly as @code{default-user}."
31401 #: guix-git/doc/guix.texi:17865
31403 msgid "@code{theme} (default: @code{%default-slim-theme})"
31407 #: guix-git/doc/guix.texi:17866
31409 msgid "@code{theme-name} (default: @code{%default-slim-theme-name})"
31413 #: guix-git/doc/guix.texi:17868
31414 msgid "The graphical theme to use and its name."
31418 #: guix-git/doc/guix.texi:17869
31420 msgid "@code{auto-login-session} (default: @code{#f})"
31424 #: guix-git/doc/guix.texi:17872
31425 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\")}."
31429 #: guix-git/doc/guix.texi:17876
31430 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."
31434 #: guix-git/doc/guix.texi:17881
31435 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."
31439 #: guix-git/doc/guix.texi:17883 guix-git/doc/guix.texi:17967
31441 msgid "@code{xorg-configuration} (default @code{(xorg-configuration)})"
31445 #: guix-git/doc/guix.texi:17886
31447 msgid "@code{display} (default @code{\":0\"})"
31451 #: guix-git/doc/guix.texi:17888
31452 msgid "The display on which to start the Xorg graphical server."
31456 #: guix-git/doc/guix.texi:17889
31458 msgid "@code{vt} (default @code{\"vt7\"})"
31462 #: guix-git/doc/guix.texi:17891
31463 msgid "The VT on which to start the Xorg graphical server."
31467 #: guix-git/doc/guix.texi:17892
31469 msgid "@code{xauth} (default: @code{xauth})"
31473 #: guix-git/doc/guix.texi:17894
31474 msgid "The XAuth package to use."
31478 #: guix-git/doc/guix.texi:17895
31480 msgid "@code{shepherd} (default: @code{shepherd})"
31484 #: guix-git/doc/guix.texi:17898
31485 msgid "The Shepherd package used when invoking @command{halt} and @command{reboot}."
31489 #: guix-git/doc/guix.texi:17899
31491 msgid "@code{sessreg} (default: @code{sessreg})"
31495 #: guix-git/doc/guix.texi:17901
31496 msgid "The sessreg package used in order to register the session."
31500 #: guix-git/doc/guix.texi:17902
31502 msgid "@code{slim} (default: @code{slim})"
31506 #: guix-git/doc/guix.texi:17904
31507 msgid "The SLiM package to use."
31511 #: guix-git/doc/guix.texi:17907
31513 msgid "{Scheme Variable} %default-theme"
31517 #: guix-git/doc/guix.texi:17908
31519 msgid "{Scheme Variable} %default-theme-name"
31523 #: guix-git/doc/guix.texi:17910
31524 msgid "The default SLiM theme and its name."
31528 #: guix-git/doc/guix.texi:17913 guix-git/doc/guix.texi:18020
31530 msgid "{Data Type} sddm-configuration"
31534 #: guix-git/doc/guix.texi:17915
31535 msgid "This is the data type representing the SDDM service configuration."
31539 #: guix-git/doc/guix.texi:17917
31541 msgid "@code{display-server} (default: \"x11\")"
31545 #: guix-git/doc/guix.texi:17920
31546 msgid "Select display server to use for the greeter. Valid values are @samp{\"x11\"} or @samp{\"wayland\"}."
31550 #: guix-git/doc/guix.texi:17921
31552 msgid "@code{numlock} (default: \"on\")"
31556 #: guix-git/doc/guix.texi:17923
31557 msgid "Valid values are @samp{\"on\"}, @samp{\"off\"} or @samp{\"none\"}."
31561 #: guix-git/doc/guix.texi:17924
31563 msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})"
31567 #: guix-git/doc/guix.texi:17926
31568 msgid "Command to run when halting."
31572 #: guix-git/doc/guix.texi:17927
31574 msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})"
31578 #: guix-git/doc/guix.texi:17929
31579 msgid "Command to run when rebooting."
31583 #: guix-git/doc/guix.texi:17930
31585 msgid "@code{theme} (default \"maldives\")"
31589 #: guix-git/doc/guix.texi:17933
31590 msgid "Theme to use. Default themes provided by SDDM are @samp{\"elarun\"}, @samp{\"maldives\"} or @samp{\"maya\"}."
31594 #: guix-git/doc/guix.texi:17934
31596 msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")"
31600 #: guix-git/doc/guix.texi:17936
31601 msgid "Directory to look for themes."
31605 #: guix-git/doc/guix.texi:17937
31607 msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")"
31611 #: guix-git/doc/guix.texi:17939
31612 msgid "Directory to look for faces."
31616 #: guix-git/doc/guix.texi:17940
31618 msgid "@code{default-path} (default \"/run/current-system/profile/bin\")"
31622 #: guix-git/doc/guix.texi:17942
31623 msgid "Default PATH to use."
31627 #: guix-git/doc/guix.texi:17943
31629 msgid "@code{minimum-uid} (default: 1000)"
31633 #: guix-git/doc/guix.texi:17945
31634 msgid "Minimum UID displayed in SDDM and allowed for log-in."
31638 #: guix-git/doc/guix.texi:17946
31640 msgid "@code{maximum-uid} (default: 2000)"
31644 #: guix-git/doc/guix.texi:17948
31645 msgid "Maximum UID to display in SDDM."
31649 #: guix-git/doc/guix.texi:17949
31651 msgid "@code{remember-last-user?} (default #t)"
31655 #: guix-git/doc/guix.texi:17951
31656 msgid "Remember last user."
31660 #: guix-git/doc/guix.texi:17952
31662 msgid "@code{remember-last-session?} (default #t)"
31666 #: guix-git/doc/guix.texi:17954
31667 msgid "Remember last session."
31671 #: guix-git/doc/guix.texi:17955
31673 msgid "@code{hide-users} (default \"\")"
31677 #: guix-git/doc/guix.texi:17957
31678 msgid "Usernames to hide from SDDM greeter."
31682 #: guix-git/doc/guix.texi:17958
31684 msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})"
31688 #: guix-git/doc/guix.texi:17960
31689 msgid "Users with shells listed will be hidden from the SDDM greeter."
31693 #: guix-git/doc/guix.texi:17961
31695 msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})"
31699 #: guix-git/doc/guix.texi:17963
31700 msgid "Script to run before starting a wayland session."
31704 #: guix-git/doc/guix.texi:17964
31706 msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")"
31710 #: guix-git/doc/guix.texi:17966
31711 msgid "Directory to look for desktop files starting wayland sessions."
31715 #: guix-git/doc/guix.texi:17970
31717 msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})"
31721 #: guix-git/doc/guix.texi:17972
31722 msgid "Path to xauth."
31726 #: guix-git/doc/guix.texi:17973
31728 msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})"
31732 #: guix-git/doc/guix.texi:17975
31733 msgid "Path to Xephyr."
31737 #: guix-git/doc/guix.texi:17976
31739 msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})"
31743 #: guix-git/doc/guix.texi:17978
31744 msgid "Script to run after starting xorg-server."
31748 #: guix-git/doc/guix.texi:17979
31750 msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})"
31754 #: guix-git/doc/guix.texi:17981
31755 msgid "Script to run before stopping xorg-server."
31759 #: guix-git/doc/guix.texi:17982
31761 msgid "@code{xsession-command} (default: @code{xinitrc})"
31765 #: guix-git/doc/guix.texi:17985
31767 msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")"
31771 #: guix-git/doc/guix.texi:17987
31772 msgid "Directory to look for desktop files starting X sessions."
31776 #: guix-git/doc/guix.texi:17988
31778 msgid "@code{minimum-vt} (default: 7)"
31782 #: guix-git/doc/guix.texi:17990
31783 msgid "Minimum VT to use."
31787 #: guix-git/doc/guix.texi:17991
31789 msgid "@code{auto-login-user} (default \"\")"
31793 #: guix-git/doc/guix.texi:17993
31794 msgid "User to use for auto-login."
31798 #: guix-git/doc/guix.texi:17994
31800 msgid "@code{auto-login-session} (default \"\")"
31804 #: guix-git/doc/guix.texi:17996
31805 msgid "Desktop file to use for auto-login."
31809 #: guix-git/doc/guix.texi:17997
31811 msgid "@code{relogin?} (default #f)"
31815 #: guix-git/doc/guix.texi:17999
31816 msgid "Relogin after logout."
31820 #: guix-git/doc/guix.texi:18004
31826 #: guix-git/doc/guix.texi:18005
31828 msgid "{Scheme Variable} sddm-service-type"
31832 #: guix-git/doc/guix.texi:18009
31833 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)."
31837 #: guix-git/doc/guix.texi:18011
31838 msgid "Here's an example use:"
31842 #: guix-git/doc/guix.texi:18017
31845 "(service sddm-service-type\n"
31846 " (sddm-configuration\n"
31847 " (auto-login-user \"alice\")\n"
31848 " (auto-login-session \"xfce.desktop\")))\n"
31852 #: guix-git/doc/guix.texi:18023
31853 msgid "This data type represents the configuration of the SDDM login manager. The available fields are:"
31857 #: guix-git/doc/guix.texi:18025
31859 msgid "@code{sddm} (default: @code{sddm})"
31863 #: guix-git/doc/guix.texi:18027
31864 msgid "The SDDM package to use."
31868 #: guix-git/doc/guix.texi:18028
31870 msgid "@code{display-server} (default: @code{\"x11\"})"
31874 #: guix-git/doc/guix.texi:18030
31875 msgid "This must be either @code{\"x11\"} or @code{\"wayland\"}."
31879 #: guix-git/doc/guix.texi:18033
31881 msgid "@code{auto-login-user} (default: @code{\"\"})"
31885 #: guix-git/doc/guix.texi:18036
31886 msgid "If non-empty, this is the user account under which to log in automatically."
31890 #: guix-git/doc/guix.texi:18037
31892 msgid "@code{auto-login-session} (default: @code{\"\"})"
31896 #: guix-git/doc/guix.texi:18040
31897 msgid "If non-empty, this is the @file{.desktop} file name to use as the auto-login session."
31901 #: guix-git/doc/guix.texi:18043
31903 msgid "Xorg, configuration"
31907 #: guix-git/doc/guix.texi:18044
31909 msgid "{Data Type} xorg-configuration"
31913 #: guix-git/doc/guix.texi:18049
31914 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."
31918 #: guix-git/doc/guix.texi:18051
31920 msgid "@code{modules} (default: @code{%default-xorg-modules})"
31924 #: guix-git/doc/guix.texi:18054
31925 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."
31929 #: guix-git/doc/guix.texi:18055
31931 msgid "@code{fonts} (default: @code{%default-xorg-fonts})"
31935 #: guix-git/doc/guix.texi:18057
31936 msgid "This is a list of font directories to add to the server's @dfn{font path}."
31940 #: guix-git/doc/guix.texi:18058
31942 msgid "@code{drivers} (default: @code{'()})"
31946 #: guix-git/doc/guix.texi:18062
31947 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\")}."
31951 #: guix-git/doc/guix.texi:18063
31953 msgid "@code{resolutions} (default: @code{'()})"
31957 #: guix-git/doc/guix.texi:18067
31958 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))}."
31962 #: guix-git/doc/guix.texi:18068
31964 msgid "keyboard layout, for Xorg"
31968 #: guix-git/doc/guix.texi:18069
31970 msgid "keymap, for Xorg"
31974 #: guix-git/doc/guix.texi:18073
31975 msgid "If this is @code{#f}, Xorg uses the default keyboard layout---usually US English (``qwerty'') for a 105-key PC keyboard."
31979 #: guix-git/doc/guix.texi:18077
31980 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."
31984 #: guix-git/doc/guix.texi:18078 guix-git/doc/guix.texi:19789
31985 #: guix-git/doc/guix.texi:31970
31987 msgid "@code{extra-config} (default: @code{'()})"
31991 #: guix-git/doc/guix.texi:18081 guix-git/doc/guix.texi:31974
31992 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."
31996 #: guix-git/doc/guix.texi:18082
31998 msgid "@code{server} (default: @code{xorg-server})"
32002 #: guix-git/doc/guix.texi:18084
32003 msgid "This is the package providing the Xorg server."
32007 #: guix-git/doc/guix.texi:18085
32009 msgid "@code{server-arguments} (default: @code{%default-xorg-server-arguments})"
32013 #: guix-git/doc/guix.texi:18088
32014 msgid "This is the list of command-line arguments to pass to the X server. The default is @code{-nolisten tcp}."
32018 #: guix-git/doc/guix.texi:18091
32020 msgid "{Scheme Procedure} set-xorg-configuration @var{config} @"
32024 #: guix-git/doc/guix.texi:18095
32025 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."
32029 #: guix-git/doc/guix.texi:18099
32030 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."
32034 #: guix-git/doc/guix.texi:18101
32036 msgid "{Scheme Procedure} xorg-start-command [@var{config}]"
32040 #: guix-git/doc/guix.texi:18105
32041 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}."
32045 #: guix-git/doc/guix.texi:18107
32046 msgid "Usually the X server is started by a login manager."
32050 #: guix-git/doc/guix.texi:18110
32052 msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]"
32056 #: guix-git/doc/guix.texi:18114
32057 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:"
32061 #: guix-git/doc/guix.texi:18117
32063 msgid "(screen-locker-service xlockmore \"xlock\")\n"
32067 #: guix-git/doc/guix.texi:18120
32068 msgid "makes the good ol' XlockMore usable."
32072 #: guix-git/doc/guix.texi:18126
32074 msgid "printer support with CUPS"
32077 #. type: Plain text
32078 #: guix-git/doc/guix.texi:18130
32079 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:"
32083 #: guix-git/doc/guix.texi:18131
32085 msgid "{Scheme Variable} cups-service-type"
32089 #: guix-git/doc/guix.texi:18135
32090 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:"
32094 #: guix-git/doc/guix.texi:18137
32096 msgid "(service cups-service-type)\n"
32099 #. type: Plain text
32100 #: guix-git/doc/guix.texi:18147
32101 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."
32104 #. type: Plain text
32105 #: guix-git/doc/guix.texi:18153
32106 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):"
32110 #: guix-git/doc/guix.texi:18160
32113 "(service cups-service-type\n"
32114 " (cups-configuration\n"
32115 " (web-interface? #t)\n"
32117 " (list cups-filters epson-inkjet-printer-escpr hplip-minimal))))\n"
32120 #. type: Plain text
32121 #: guix-git/doc/guix.texi:18165
32122 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."
32125 #. type: Plain text
32126 #: guix-git/doc/guix.texi:18172
32127 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."
32130 #. type: Plain text
32131 #: guix-git/doc/guix.texi:18183
32132 msgid "Available @code{cups-configuration} fields are:"
32136 #: guix-git/doc/guix.texi:18184
32138 msgid "{@code{cups-configuration} parameter} package cups"
32142 #: guix-git/doc/guix.texi:18186 guix-git/doc/guix.texi:18954
32143 msgid "The CUPS package."
32147 #: guix-git/doc/guix.texi:18188
32149 msgid "{@code{cups-configuration} parameter} package-list extensions (default: @code{(list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)})"
32153 #: guix-git/doc/guix.texi:18190
32154 msgid "Drivers and other extensions to the CUPS package."
32158 #: guix-git/doc/guix.texi:18192
32160 msgid "{@code{cups-configuration} parameter} files-configuration files-configuration"
32164 #: guix-git/doc/guix.texi:18195
32165 msgid "Configuration of where to write logs, what directories to use for print spools, and related privileged configuration parameters."
32169 #: guix-git/doc/guix.texi:18197
32170 msgid "Available @code{files-configuration} fields are:"
32174 #: guix-git/doc/guix.texi:18198
32176 msgid "{@code{files-configuration} parameter} log-location access-log"
32180 #: guix-git/doc/guix.texi:18206
32181 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}."
32185 #: guix-git/doc/guix.texi:18208
32186 msgid "Defaults to @samp{\"/var/log/cups/access_log\"}."
32190 #: guix-git/doc/guix.texi:18210
32192 msgid "{@code{files-configuration} parameter} file-name cache-dir"
32196 #: guix-git/doc/guix.texi:18212
32197 msgid "Where CUPS should cache data."
32201 #: guix-git/doc/guix.texi:18214
32202 msgid "Defaults to @samp{\"/var/cache/cups\"}."
32206 #: guix-git/doc/guix.texi:18216
32208 msgid "{@code{files-configuration} parameter} string config-file-perm"
32212 #: guix-git/doc/guix.texi:18219
32213 msgid "Specifies the permissions for all configuration files that the scheduler writes."
32217 #: guix-git/doc/guix.texi:18225
32218 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."
32222 #: guix-git/doc/guix.texi:18227
32223 msgid "Defaults to @samp{\"0640\"}."
32227 #: guix-git/doc/guix.texi:18229
32229 msgid "{@code{files-configuration} parameter} log-location error-log"
32233 #: guix-git/doc/guix.texi:18237
32234 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}."
32238 #: guix-git/doc/guix.texi:18239
32239 msgid "Defaults to @samp{\"/var/log/cups/error_log\"}."
32243 #: guix-git/doc/guix.texi:18241
32245 msgid "{@code{files-configuration} parameter} string fatal-errors"
32249 #: guix-git/doc/guix.texi:18244
32250 msgid "Specifies which errors are fatal, causing the scheduler to exit. The kind strings are:"
32254 #: guix-git/doc/guix.texi:18248
32255 msgid "No errors are fatal."
32259 #: guix-git/doc/guix.texi:18251
32260 msgid "All of the errors below are fatal."
32264 #: guix-git/doc/guix.texi:18252
32270 #: guix-git/doc/guix.texi:18255
32271 msgid "Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon."
32275 #: guix-git/doc/guix.texi:18256
32281 #: guix-git/doc/guix.texi:18258
32282 msgid "Configuration file syntax errors are fatal."
32286 #: guix-git/doc/guix.texi:18259
32292 #: guix-git/doc/guix.texi:18262
32293 msgid "Listen or Port errors are fatal, except for IPv6 failures on the loopback or @code{any} addresses."
32297 #: guix-git/doc/guix.texi:18263
32303 #: guix-git/doc/guix.texi:18265
32304 msgid "Log file creation or write errors are fatal."
32308 #: guix-git/doc/guix.texi:18266
32310 msgid "permissions"
32314 #: guix-git/doc/guix.texi:18269
32315 msgid "Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions."
32319 #: guix-git/doc/guix.texi:18272
32320 msgid "Defaults to @samp{\"all -browse\"}."
32324 #: guix-git/doc/guix.texi:18274
32326 msgid "{@code{files-configuration} parameter} boolean file-device?"
32330 #: guix-git/doc/guix.texi:18277
32331 msgid "Specifies whether the file pseudo-device can be used for new printer queues. The URI @uref{file:///dev/null} is always allowed."
32335 #: guix-git/doc/guix.texi:18279 guix-git/doc/guix.texi:18349
32336 #: guix-git/doc/guix.texi:18391 guix-git/doc/guix.texi:18411
32337 #: guix-git/doc/guix.texi:18417 guix-git/doc/guix.texi:18433
32338 #: guix-git/doc/guix.texi:18521 guix-git/doc/guix.texi:18615
32339 #: guix-git/doc/guix.texi:18928 guix-git/doc/guix.texi:18941
32340 #: guix-git/doc/guix.texi:21490 guix-git/doc/guix.texi:21596
32341 #: guix-git/doc/guix.texi:21661 guix-git/doc/guix.texi:21670
32342 #: guix-git/doc/guix.texi:22675 guix-git/doc/guix.texi:22719
32343 #: guix-git/doc/guix.texi:22736 guix-git/doc/guix.texi:22744
32344 #: guix-git/doc/guix.texi:22759 guix-git/doc/guix.texi:22777
32345 #: guix-git/doc/guix.texi:22801 guix-git/doc/guix.texi:22854
32346 #: guix-git/doc/guix.texi:22987 guix-git/doc/guix.texi:23021
32347 #: guix-git/doc/guix.texi:23057 guix-git/doc/guix.texi:23073
32348 #: guix-git/doc/guix.texi:23101 guix-git/doc/guix.texi:23162
32349 #: guix-git/doc/guix.texi:23245 guix-git/doc/guix.texi:26638
32350 #: guix-git/doc/guix.texi:26652 guix-git/doc/guix.texi:26674
32351 #: guix-git/doc/guix.texi:26793 guix-git/doc/guix.texi:26807
32352 #: guix-git/doc/guix.texi:26828 guix-git/doc/guix.texi:26849
32353 #: guix-git/doc/guix.texi:26856 guix-git/doc/guix.texi:26901
32354 #: guix-git/doc/guix.texi:26908 guix-git/doc/guix.texi:27641
32355 #: guix-git/doc/guix.texi:27655 guix-git/doc/guix.texi:27827
32356 #: guix-git/doc/guix.texi:27872 guix-git/doc/guix.texi:27959
32357 #: guix-git/doc/guix.texi:28161 guix-git/doc/guix.texi:28194
32358 #: guix-git/doc/guix.texi:28334 guix-git/doc/guix.texi:28345
32359 #: guix-git/doc/guix.texi:28596 guix-git/doc/guix.texi:30061
32360 #: guix-git/doc/guix.texi:30070 guix-git/doc/guix.texi:30078
32361 #: guix-git/doc/guix.texi:30086 guix-git/doc/guix.texi:30102
32362 #: guix-git/doc/guix.texi:30118 guix-git/doc/guix.texi:30126
32363 #: guix-git/doc/guix.texi:30134 guix-git/doc/guix.texi:30143
32364 #: guix-git/doc/guix.texi:30152 guix-git/doc/guix.texi:30168
32365 #: guix-git/doc/guix.texi:30232 guix-git/doc/guix.texi:30338
32366 #: guix-git/doc/guix.texi:30346 guix-git/doc/guix.texi:30354
32367 #: guix-git/doc/guix.texi:30379 guix-git/doc/guix.texi:30433
32368 #: guix-git/doc/guix.texi:30481 guix-git/doc/guix.texi:30682
32369 #: guix-git/doc/guix.texi:30689
32370 msgid "Defaults to @samp{#f}."
32374 #: guix-git/doc/guix.texi:18281
32376 msgid "{@code{files-configuration} parameter} string group"
32380 #: guix-git/doc/guix.texi:18284
32381 msgid "Specifies the group name or ID that will be used when executing external programs."
32385 #: guix-git/doc/guix.texi:18286 guix-git/doc/guix.texi:18366
32386 msgid "Defaults to @samp{\"lp\"}."
32390 #: guix-git/doc/guix.texi:18288
32392 msgid "{@code{files-configuration} parameter} string log-file-perm"
32396 #: guix-git/doc/guix.texi:18290
32397 msgid "Specifies the permissions for all log files that the scheduler writes."
32401 #: guix-git/doc/guix.texi:18292
32402 msgid "Defaults to @samp{\"0644\"}."
32406 #: guix-git/doc/guix.texi:18294
32408 msgid "{@code{files-configuration} parameter} log-location page-log"
32412 #: guix-git/doc/guix.texi:18302
32413 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}."
32417 #: guix-git/doc/guix.texi:18304
32418 msgid "Defaults to @samp{\"/var/log/cups/page_log\"}."
32422 #: guix-git/doc/guix.texi:18306
32424 msgid "{@code{files-configuration} parameter} string remote-root"
32428 #: guix-git/doc/guix.texi:18309
32429 msgid "Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. The default is @code{remroot}."
32433 #: guix-git/doc/guix.texi:18311
32434 msgid "Defaults to @samp{\"remroot\"}."
32438 #: guix-git/doc/guix.texi:18313
32440 msgid "{@code{files-configuration} parameter} file-name request-root"
32444 #: guix-git/doc/guix.texi:18316
32445 msgid "Specifies the directory that contains print jobs and other HTTP request data."
32449 #: guix-git/doc/guix.texi:18318
32450 msgid "Defaults to @samp{\"/var/spool/cups\"}."
32454 #: guix-git/doc/guix.texi:18320
32456 msgid "{@code{files-configuration} parameter} sandboxing sandboxing"
32460 #: guix-git/doc/guix.texi:18325
32461 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."
32465 #: guix-git/doc/guix.texi:18327
32466 msgid "Defaults to @samp{strict}."
32470 #: guix-git/doc/guix.texi:18329
32472 msgid "{@code{files-configuration} parameter} file-name server-keychain"
32476 #: guix-git/doc/guix.texi:18334
32477 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."
32481 #: guix-git/doc/guix.texi:18336
32482 msgid "Defaults to @samp{\"/etc/cups/ssl\"}."
32486 #: guix-git/doc/guix.texi:18338
32488 msgid "{@code{files-configuration} parameter} file-name server-root"
32492 #: guix-git/doc/guix.texi:18340
32493 msgid "Specifies the directory containing the server configuration files."
32497 #: guix-git/doc/guix.texi:18342
32498 msgid "Defaults to @samp{\"/etc/cups\"}."
32502 #: guix-git/doc/guix.texi:18344
32504 msgid "{@code{files-configuration} parameter} boolean sync-on-close?"
32508 #: guix-git/doc/guix.texi:18347
32509 msgid "Specifies whether the scheduler calls fsync(2) after writing configuration or state files."
32513 #: guix-git/doc/guix.texi:18351
32515 msgid "{@code{files-configuration} parameter} space-separated-string-list system-group"
32519 #: guix-git/doc/guix.texi:18353
32520 msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication."
32524 #: guix-git/doc/guix.texi:18355
32526 msgid "{@code{files-configuration} parameter} file-name temp-dir"
32530 #: guix-git/doc/guix.texi:18357
32531 msgid "Specifies the directory where temporary files are stored."
32535 #: guix-git/doc/guix.texi:18359
32536 msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}."
32540 #: guix-git/doc/guix.texi:18361
32542 msgid "{@code{files-configuration} parameter} string user"
32546 #: guix-git/doc/guix.texi:18364
32547 msgid "Specifies the user name or ID that is used when running external programs."
32551 #: guix-git/doc/guix.texi:18368
32553 msgid "{@code{files-configuration} parameter} string set-env"
32557 #: guix-git/doc/guix.texi:18370
32558 msgid "Set the specified environment variable to be passed to child processes."
32562 #: guix-git/doc/guix.texi:18372
32563 msgid "Defaults to @samp{\"variable value\"}."
32567 #: guix-git/doc/guix.texi:18375
32569 msgid "{@code{cups-configuration} parameter} access-log-level access-log-level"
32573 #: guix-git/doc/guix.texi:18382
32574 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."
32578 #: guix-git/doc/guix.texi:18384
32579 msgid "Defaults to @samp{actions}."
32583 #: guix-git/doc/guix.texi:18386
32585 msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?"
32589 #: guix-git/doc/guix.texi:18389
32590 msgid "Specifies whether to purge job history data automatically when it is no longer required for quotas."
32594 #: guix-git/doc/guix.texi:18393
32596 msgid "{@code{cups-configuration} parameter} comma-separated-string-list browse-dns-sd-sub-types"
32600 #: guix-git/doc/guix.texi:18397
32601 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."
32605 #: guix-git/doc/guix.texi:18399
32606 msgid "Defaults to @samp{\"_cups\"}."
32610 #: guix-git/doc/guix.texi:18401
32612 msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols"
32616 #: guix-git/doc/guix.texi:18403
32617 msgid "Specifies which protocols to use for local printer sharing."
32621 #: guix-git/doc/guix.texi:18405
32622 msgid "Defaults to @samp{dnssd}."
32626 #: guix-git/doc/guix.texi:18407
32628 msgid "{@code{cups-configuration} parameter} boolean browse-web-if?"
32632 #: guix-git/doc/guix.texi:18409
32633 msgid "Specifies whether the CUPS web interface is advertised."
32637 #: guix-git/doc/guix.texi:18413
32639 msgid "{@code{cups-configuration} parameter} boolean browsing?"
32643 #: guix-git/doc/guix.texi:18415
32644 msgid "Specifies whether shared printers are advertised."
32648 #: guix-git/doc/guix.texi:18419
32650 msgid "{@code{cups-configuration} parameter} string classification"
32654 #: guix-git/doc/guix.texi:18424
32655 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."
32659 #: guix-git/doc/guix.texi:18426 guix-git/doc/guix.texi:18763
32660 #: guix-git/doc/guix.texi:20711 guix-git/doc/guix.texi:20723
32661 #: guix-git/doc/guix.texi:21497 guix-git/doc/guix.texi:21511
32662 #: guix-git/doc/guix.texi:21518 guix-git/doc/guix.texi:21525
32663 #: guix-git/doc/guix.texi:21555 guix-git/doc/guix.texi:21653
32664 #: guix-git/doc/guix.texi:23544 guix-git/doc/guix.texi:23570
32665 #: guix-git/doc/guix.texi:23606 guix-git/doc/guix.texi:23652
32666 #: guix-git/doc/guix.texi:23671 guix-git/doc/guix.texi:23710
32667 #: guix-git/doc/guix.texi:23769 guix-git/doc/guix.texi:23779
32668 #: guix-git/doc/guix.texi:28300 guix-git/doc/guix.texi:28308
32669 #: guix-git/doc/guix.texi:28316 guix-git/doc/guix.texi:28324
32670 #: guix-git/doc/guix.texi:28603 guix-git/doc/guix.texi:29904
32671 #: guix-git/doc/guix.texi:29912 guix-git/doc/guix.texi:29920
32672 #: guix-git/doc/guix.texi:30028 guix-git/doc/guix.texi:30053
32673 #: guix-git/doc/guix.texi:30184 guix-git/doc/guix.texi:30192
32674 #: guix-git/doc/guix.texi:30200 guix-git/doc/guix.texi:30208
32675 #: guix-git/doc/guix.texi:30216 guix-git/doc/guix.texi:30224
32676 #: guix-git/doc/guix.texi:30247 guix-git/doc/guix.texi:30255
32677 #: guix-git/doc/guix.texi:30307 guix-git/doc/guix.texi:30323
32678 #: guix-git/doc/guix.texi:30331 guix-git/doc/guix.texi:30370
32679 #: guix-git/doc/guix.texi:30393 guix-git/doc/guix.texi:30415
32680 #: guix-git/doc/guix.texi:30422 guix-git/doc/guix.texi:30457
32681 #: guix-git/doc/guix.texi:30465 guix-git/doc/guix.texi:30489
32682 #: guix-git/doc/guix.texi:30521 guix-git/doc/guix.texi:30550
32683 #: guix-git/doc/guix.texi:30557 guix-git/doc/guix.texi:30564
32684 #: guix-git/doc/guix.texi:30572 guix-git/doc/guix.texi:30586
32685 #: guix-git/doc/guix.texi:30595 guix-git/doc/guix.texi:30605
32686 #: guix-git/doc/guix.texi:30612 guix-git/doc/guix.texi:30619
32687 #: guix-git/doc/guix.texi:30626 guix-git/doc/guix.texi:30697
32688 #: guix-git/doc/guix.texi:30704 guix-git/doc/guix.texi:30711
32689 #: guix-git/doc/guix.texi:30720 guix-git/doc/guix.texi:30736
32690 #: guix-git/doc/guix.texi:30743 guix-git/doc/guix.texi:30750
32691 #: guix-git/doc/guix.texi:30757 guix-git/doc/guix.texi:30765
32692 #: guix-git/doc/guix.texi:30773
32693 msgid "Defaults to @samp{\"\"}."
32697 #: guix-git/doc/guix.texi:18428
32699 msgid "{@code{cups-configuration} parameter} boolean classify-override?"
32703 #: guix-git/doc/guix.texi:18431
32704 msgid "Specifies whether users may override the classification (cover page) of individual print jobs using the @code{job-sheets} option."
32708 #: guix-git/doc/guix.texi:18435
32710 msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type"
32714 #: guix-git/doc/guix.texi:18437
32715 msgid "Specifies the default type of authentication to use."
32719 #: guix-git/doc/guix.texi:18439
32720 msgid "Defaults to @samp{Basic}."
32724 #: guix-git/doc/guix.texi:18441
32726 msgid "{@code{cups-configuration} parameter} default-encryption default-encryption"
32730 #: guix-git/doc/guix.texi:18443
32731 msgid "Specifies whether encryption will be used for authenticated requests."
32735 #: guix-git/doc/guix.texi:18445
32736 msgid "Defaults to @samp{Required}."
32740 #: guix-git/doc/guix.texi:18447
32742 msgid "{@code{cups-configuration} parameter} string default-language"
32746 #: guix-git/doc/guix.texi:18449
32747 msgid "Specifies the default language to use for text and web content."
32751 #: guix-git/doc/guix.texi:18451
32752 msgid "Defaults to @samp{\"en\"}."
32756 #: guix-git/doc/guix.texi:18453
32758 msgid "{@code{cups-configuration} parameter} string default-paper-size"
32762 #: guix-git/doc/guix.texi:18458
32763 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\"}."
32767 #: guix-git/doc/guix.texi:18460
32768 msgid "Defaults to @samp{\"Auto\"}."
32772 #: guix-git/doc/guix.texi:18462
32774 msgid "{@code{cups-configuration} parameter} string default-policy"
32778 #: guix-git/doc/guix.texi:18464
32779 msgid "Specifies the default access policy to use."
32783 #: guix-git/doc/guix.texi:18466
32784 msgid "Defaults to @samp{\"default\"}."
32788 #: guix-git/doc/guix.texi:18468
32790 msgid "{@code{cups-configuration} parameter} boolean default-shared?"
32794 #: guix-git/doc/guix.texi:18470
32795 msgid "Specifies whether local printers are shared by default."
32799 #: guix-git/doc/guix.texi:18472 guix-git/doc/guix.texi:18552
32800 #: guix-git/doc/guix.texi:18848 guix-git/doc/guix.texi:21587
32801 #: guix-git/doc/guix.texi:21638 guix-git/doc/guix.texi:21645
32802 #: guix-git/doc/guix.texi:22699 guix-git/doc/guix.texi:22887
32803 #: guix-git/doc/guix.texi:23004 guix-git/doc/guix.texi:23040
32804 #: guix-git/doc/guix.texi:23091 guix-git/doc/guix.texi:23110
32805 #: guix-git/doc/guix.texi:23120 guix-git/doc/guix.texi:23130
32806 #: guix-git/doc/guix.texi:23189 guix-git/doc/guix.texi:23211
32807 #: guix-git/doc/guix.texi:23236 guix-git/doc/guix.texi:23262
32808 #: guix-git/doc/guix.texi:23280 guix-git/doc/guix.texi:26460
32809 #: guix-git/doc/guix.texi:26488 guix-git/doc/guix.texi:26615
32810 #: guix-git/doc/guix.texi:26622 guix-git/doc/guix.texi:26630
32811 #: guix-git/doc/guix.texi:26667 guix-git/doc/guix.texi:26681
32812 #: guix-git/doc/guix.texi:26770 guix-git/doc/guix.texi:26777
32813 #: guix-git/doc/guix.texi:26785 guix-git/doc/guix.texi:27508
32814 #: guix-git/doc/guix.texi:27648 guix-git/doc/guix.texi:27834
32815 #: guix-git/doc/guix.texi:27841 guix-git/doc/guix.texi:27863
32816 #: guix-git/doc/guix.texi:27902 guix-git/doc/guix.texi:27922
32817 #: guix-git/doc/guix.texi:27936 guix-git/doc/guix.texi:28149
32818 #: guix-git/doc/guix.texi:30006 guix-git/doc/guix.texi:30094
32819 #: guix-git/doc/guix.texi:30110 guix-git/doc/guix.texi:30160
32820 msgid "Defaults to @samp{#t}."
32824 #: guix-git/doc/guix.texi:18474
32826 msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval"
32830 #: guix-git/doc/guix.texi:18478
32831 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."
32835 #: guix-git/doc/guix.texi:18480 guix-git/doc/guix.texi:18528
32836 #: guix-git/doc/guix.texi:18537 guix-git/doc/guix.texi:18558
32837 #: guix-git/doc/guix.texi:18855 guix-git/doc/guix.texi:23049
32838 #: guix-git/doc/guix.texi:23082
32839 msgid "Defaults to @samp{30}."
32843 #: guix-git/doc/guix.texi:18482
32845 msgid "{@code{cups-configuration} parameter} error-policy error-policy"
32849 #: guix-git/doc/guix.texi:18488
32850 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."
32854 #: guix-git/doc/guix.texi:18490
32855 msgid "Defaults to @samp{stop-printer}."
32859 #: guix-git/doc/guix.texi:18492
32861 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit"
32865 #: guix-git/doc/guix.texi:18500
32866 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."
32870 #: guix-git/doc/guix.texi:18502 guix-git/doc/guix.texi:18510
32871 #: guix-git/doc/guix.texi:18565 guix-git/doc/guix.texi:18681
32872 #: guix-git/doc/guix.texi:18695 guix-git/doc/guix.texi:18702
32873 #: guix-git/doc/guix.texi:20153 guix-git/doc/guix.texi:20169
32874 #: guix-git/doc/guix.texi:20815 guix-git/doc/guix.texi:20827
32875 #: guix-git/doc/guix.texi:21606 guix-git/doc/guix.texi:21615
32876 #: guix-git/doc/guix.texi:21623 guix-git/doc/guix.texi:21631
32877 #: guix-git/doc/guix.texi:27524 guix-git/doc/guix.texi:27849
32878 #: guix-git/doc/guix.texi:29999 guix-git/doc/guix.texi:30299
32879 #: guix-git/doc/guix.texi:30473
32880 msgid "Defaults to @samp{0}."
32884 #: guix-git/doc/guix.texi:18504
32886 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice"
32890 #: guix-git/doc/guix.texi:18508
32891 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."
32895 #: guix-git/doc/guix.texi:18512
32897 msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups"
32901 #: guix-git/doc/guix.texi:18519
32902 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."
32906 #: guix-git/doc/guix.texi:18523
32908 msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay"
32912 #: guix-git/doc/guix.texi:18526
32913 msgid "Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job."
32917 #: guix-git/doc/guix.texi:18530
32919 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval"
32923 #: guix-git/doc/guix.texi:18535
32924 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}."
32928 #: guix-git/doc/guix.texi:18539
32930 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit"
32934 #: guix-git/doc/guix.texi:18544
32935 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}."
32939 #: guix-git/doc/guix.texi:18546 guix-git/doc/guix.texi:23013
32940 #: guix-git/doc/guix.texi:28401 guix-git/doc/guix.texi:28421
32941 #: guix-git/doc/guix.texi:28437 guix-git/doc/guix.texi:28451
32942 #: guix-git/doc/guix.texi:28458 guix-git/doc/guix.texi:28465
32943 #: guix-git/doc/guix.texi:28472 guix-git/doc/guix.texi:28632
32944 #: guix-git/doc/guix.texi:28648 guix-git/doc/guix.texi:28655
32945 #: guix-git/doc/guix.texi:28662 guix-git/doc/guix.texi:28673
32946 #: guix-git/doc/guix.texi:29951 guix-git/doc/guix.texi:29959
32947 #: guix-git/doc/guix.texi:29967 guix-git/doc/guix.texi:29991
32948 msgid "Defaults to @samp{5}."
32952 #: guix-git/doc/guix.texi:18548
32954 msgid "{@code{cups-configuration} parameter} boolean keep-alive?"
32958 #: guix-git/doc/guix.texi:18550
32959 msgid "Specifies whether to support HTTP keep-alive connections."
32963 #: guix-git/doc/guix.texi:18554
32965 msgid "{@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout"
32969 #: guix-git/doc/guix.texi:18556
32970 msgid "Specifies how long an idle client connection remains open, in seconds."
32974 #: guix-git/doc/guix.texi:18560
32976 msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body"
32980 #: guix-git/doc/guix.texi:18563
32981 msgid "Specifies the maximum size of print files, IPP requests, and HTML form data. A limit of 0 disables the limit check."
32985 #: guix-git/doc/guix.texi:18567
32987 msgid "{@code{cups-configuration} parameter} multiline-string-list listen"
32991 #: guix-git/doc/guix.texi:18574
32992 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."
32996 #: guix-git/doc/guix.texi:18576
32998 msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log"
33002 #: guix-git/doc/guix.texi:18583
33003 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."
33007 #: guix-git/doc/guix.texi:18585
33008 msgid "Defaults to @samp{128}."
33012 #: guix-git/doc/guix.texi:18587
33014 msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls"
33018 #: guix-git/doc/guix.texi:18589
33019 msgid "Specifies a set of additional access controls."
33023 #: guix-git/doc/guix.texi:18591
33024 msgid "Available @code{location-access-controls} fields are:"
33028 #: guix-git/doc/guix.texi:18592
33030 msgid "{@code{location-access-controls} parameter} file-name path"
33034 #: guix-git/doc/guix.texi:18594
33035 msgid "Specifies the URI path to which the access control applies."
33039 #: guix-git/doc/guix.texi:18596
33041 msgid "{@code{location-access-controls} parameter} access-control-list access-controls"
33045 #: guix-git/doc/guix.texi:18599
33046 msgid "Access controls for all access to this path, in the same format as the @code{access-controls} of @code{operation-access-control}."
33050 #: guix-git/doc/guix.texi:18601 guix-git/doc/guix.texi:18607
33051 #: guix-git/doc/guix.texi:18621 guix-git/doc/guix.texi:18628
33052 #: guix-git/doc/guix.texi:18770 guix-git/doc/guix.texi:18829
33053 #: guix-git/doc/guix.texi:18907 guix-git/doc/guix.texi:18921
33054 #: guix-git/doc/guix.texi:21301 guix-git/doc/guix.texi:21504
33055 #: guix-git/doc/guix.texi:21532 guix-git/doc/guix.texi:21562
33056 #: guix-git/doc/guix.texi:21677 guix-git/doc/guix.texi:21690
33057 #: guix-git/doc/guix.texi:21697 guix-git/doc/guix.texi:23219
33058 #: guix-git/doc/guix.texi:23614 guix-git/doc/guix.texi:23718
33059 #: guix-git/doc/guix.texi:24145 guix-git/doc/guix.texi:24153
33060 #: guix-git/doc/guix.texi:24398 guix-git/doc/guix.texi:26519
33061 #: guix-git/doc/guix.texi:26688 guix-git/doc/guix.texi:26887
33062 #: guix-git/doc/guix.texi:28292 guix-git/doc/guix.texi:28352
33063 #: guix-git/doc/guix.texi:28360 guix-git/doc/guix.texi:30014
33064 #: guix-git/doc/guix.texi:30021 guix-git/doc/guix.texi:30363
33065 #: guix-git/doc/guix.texi:30441 guix-git/doc/guix.texi:30535
33066 #: guix-git/doc/guix.texi:30543 guix-git/doc/guix.texi:30579
33067 #: guix-git/doc/guix.texi:30729 guix-git/doc/guix.texi:30780
33068 #: guix-git/doc/guix.texi:30789
33069 msgid "Defaults to @samp{()}."
33073 #: guix-git/doc/guix.texi:18603
33075 msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls"
33079 #: guix-git/doc/guix.texi:18605
33080 msgid "Access controls for method-specific access to this path."
33084 #: guix-git/doc/guix.texi:18609
33085 msgid "Available @code{method-access-controls} fields are:"
33089 #: guix-git/doc/guix.texi:18610
33091 msgid "{@code{method-access-controls} parameter} boolean reverse?"
33095 #: guix-git/doc/guix.texi:18613
33096 msgid "If @code{#t}, apply access controls to all methods except the listed methods. Otherwise apply to only the listed methods."
33100 #: guix-git/doc/guix.texi:18617
33102 msgid "{@code{method-access-controls} parameter} method-list methods"
33106 #: guix-git/doc/guix.texi:18619
33107 msgid "Methods to which this access control applies."
33111 #: guix-git/doc/guix.texi:18623
33113 msgid "{@code{method-access-controls} parameter} access-control-list access-controls"
33117 #: guix-git/doc/guix.texi:18626
33118 msgid "Access control directives, as a list of strings. Each string should be one directive, such as @samp{\"Order allow,deny\"}."
33122 #: guix-git/doc/guix.texi:18632
33124 msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history"
33128 #: guix-git/doc/guix.texi:18636
33129 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."
33133 #: guix-git/doc/guix.texi:18638 guix-git/doc/guix.texi:18659
33134 #: guix-git/doc/guix.texi:18666 guix-git/doc/guix.texi:21061
33135 #: guix-git/doc/guix.texi:22751 guix-git/doc/guix.texi:22766
33136 #: guix-git/doc/guix.texi:26872
33137 msgid "Defaults to @samp{100}."
33141 #: guix-git/doc/guix.texi:18640
33143 msgid "{@code{cups-configuration} parameter} log-level log-level"
33147 #: guix-git/doc/guix.texi:18643
33148 msgid "Specifies the level of logging for the ErrorLog file. The value @code{none} stops all logging while @code{debug2} logs everything."
33152 #: guix-git/doc/guix.texi:18645 guix-git/doc/guix.texi:23228
33153 msgid "Defaults to @samp{info}."
33157 #: guix-git/doc/guix.texi:18647
33159 msgid "{@code{cups-configuration} parameter} log-time-format log-time-format"
33163 #: guix-git/doc/guix.texi:18650
33164 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."
33168 #: guix-git/doc/guix.texi:18652
33169 msgid "Defaults to @samp{standard}."
33173 #: guix-git/doc/guix.texi:18654
33175 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients"
33179 #: guix-git/doc/guix.texi:18657
33180 msgid "Specifies the maximum number of simultaneous clients that are allowed by the scheduler."
33184 #: guix-git/doc/guix.texi:18661
33186 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host"
33190 #: guix-git/doc/guix.texi:18664
33191 msgid "Specifies the maximum number of simultaneous clients that are allowed from a single address."
33195 #: guix-git/doc/guix.texi:18668
33197 msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies"
33201 #: guix-git/doc/guix.texi:18671
33202 msgid "Specifies the maximum number of copies that a user can print of each job."
33206 #: guix-git/doc/guix.texi:18673
33207 msgid "Defaults to @samp{9999}."
33211 #: guix-git/doc/guix.texi:18675
33213 msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time"
33217 #: guix-git/doc/guix.texi:18679
33218 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."
33222 #: guix-git/doc/guix.texi:18683
33224 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs"
33228 #: guix-git/doc/guix.texi:18686
33229 msgid "Specifies the maximum number of simultaneous jobs that are allowed. Set to 0 to allow an unlimited number of jobs."
33233 #: guix-git/doc/guix.texi:18688
33234 msgid "Defaults to @samp{500}."
33238 #: guix-git/doc/guix.texi:18690
33240 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer"
33244 #: guix-git/doc/guix.texi:18693
33245 msgid "Specifies the maximum number of simultaneous jobs that are allowed per printer. A value of 0 allows up to MaxJobs jobs per printer."
33249 #: guix-git/doc/guix.texi:18697
33251 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user"
33255 #: guix-git/doc/guix.texi:18700
33256 msgid "Specifies the maximum number of simultaneous jobs that are allowed per user. A value of 0 allows up to MaxJobs jobs per user."
33260 #: guix-git/doc/guix.texi:18704
33262 msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time"
33266 #: guix-git/doc/guix.texi:18707
33267 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."
33271 #: guix-git/doc/guix.texi:18709
33272 msgid "Defaults to @samp{10800}."
33276 #: guix-git/doc/guix.texi:18711
33278 msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size"
33282 #: guix-git/doc/guix.texi:18714
33283 msgid "Specifies the maximum size of the log files before they are rotated, in bytes. The value 0 disables log rotation."
33287 #: guix-git/doc/guix.texi:18716
33288 msgid "Defaults to @samp{1048576}."
33292 #: guix-git/doc/guix.texi:18718
33294 msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout"
33298 #: guix-git/doc/guix.texi:18721
33299 msgid "Specifies the maximum amount of time to allow between files in a multiple file print job, in seconds."
33303 #: guix-git/doc/guix.texi:18723 guix-git/doc/guix.texi:18934
33304 #: guix-git/doc/guix.texi:26453
33305 msgid "Defaults to @samp{300}."
33309 #: guix-git/doc/guix.texi:18725
33311 msgid "{@code{cups-configuration} parameter} string page-log-format"
33315 #: guix-git/doc/guix.texi:18730
33316 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:"
33320 #: guix-git/doc/guix.texi:18732
33326 #: guix-git/doc/guix.texi:18734
33327 msgid "insert a single percent character"
33331 #: guix-git/doc/guix.texi:18735
33337 #: guix-git/doc/guix.texi:18737
33338 msgid "insert the value of the specified IPP attribute"
33342 #: guix-git/doc/guix.texi:18738
33348 #: guix-git/doc/guix.texi:18740
33349 msgid "insert the number of copies for the current page"
33353 #: guix-git/doc/guix.texi:18741
33359 #: guix-git/doc/guix.texi:18743
33360 msgid "insert the current page number"
33364 #: guix-git/doc/guix.texi:18744
33370 #: guix-git/doc/guix.texi:18746
33371 msgid "insert the current date and time in common log format"
33375 #: guix-git/doc/guix.texi:18747
33381 #: guix-git/doc/guix.texi:18749
33382 msgid "insert the job ID"
33386 #: guix-git/doc/guix.texi:18750 guix-git/doc/guix.texi:20671
33392 #: guix-git/doc/guix.texi:18752
33393 msgid "insert the printer name"
33397 #: guix-git/doc/guix.texi:18753 guix-git/doc/guix.texi:20694
33403 #: guix-git/doc/guix.texi:18755
33404 msgid "insert the username"
33408 #: guix-git/doc/guix.texi:18761
33409 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."
33413 #: guix-git/doc/guix.texi:18765
33415 msgid "{@code{cups-configuration} parameter} environment-variables environment-variables"
33419 #: guix-git/doc/guix.texi:18768
33420 msgid "Passes the specified environment variable(s) to child processes; a list of strings."
33424 #: guix-git/doc/guix.texi:18772
33426 msgid "{@code{cups-configuration} parameter} policy-configuration-list policies"
33430 #: guix-git/doc/guix.texi:18774
33431 msgid "Specifies named access control policies."
33435 #: guix-git/doc/guix.texi:18776
33436 msgid "Available @code{policy-configuration} fields are:"
33440 #: guix-git/doc/guix.texi:18777
33442 msgid "{@code{policy-configuration} parameter} string name"
33446 #: guix-git/doc/guix.texi:18779
33447 msgid "Name of the policy."
33451 #: guix-git/doc/guix.texi:18781
33453 msgid "{@code{policy-configuration} parameter} string job-private-access"
33457 #: guix-git/doc/guix.texi:18791
33458 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}."
33462 #: guix-git/doc/guix.texi:18793 guix-git/doc/guix.texi:18815
33463 msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}."
33467 #: guix-git/doc/guix.texi:18795
33469 msgid "{@code{policy-configuration} parameter} string job-private-values"
33473 #: guix-git/doc/guix.texi:18798 guix-git/doc/guix.texi:18820
33474 msgid "Specifies the list of job values to make private, or @code{all}, @code{default}, or @code{none}."
33478 #: guix-git/doc/guix.texi:18801
33479 msgid "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-name phone\"}."
33483 #: guix-git/doc/guix.texi:18803
33485 msgid "{@code{policy-configuration} parameter} string subscription-private-access"
33489 #: guix-git/doc/guix.texi:18813
33490 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}."
33494 #: guix-git/doc/guix.texi:18817
33496 msgid "{@code{policy-configuration} parameter} string subscription-private-values"
33500 #: guix-git/doc/guix.texi:18823
33501 msgid "Defaults to @samp{\"notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data\"}."
33505 #: guix-git/doc/guix.texi:18825
33507 msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls"
33511 #: guix-git/doc/guix.texi:18827
33512 msgid "Access control by IPP operation."
33516 #: guix-git/doc/guix.texi:18832
33518 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files"
33522 #: guix-git/doc/guix.texi:18837
33523 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."
33527 #: guix-git/doc/guix.texi:18839
33528 msgid "Defaults to @samp{86400}."
33532 #: guix-git/doc/guix.texi:18841
33534 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history"
33538 #: guix-git/doc/guix.texi:18846
33539 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."
33543 #: guix-git/doc/guix.texi:18850
33545 msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout"
33549 #: guix-git/doc/guix.texi:18853
33550 msgid "Specifies the amount of time to wait for job completion before restarting the scheduler."
33554 #: guix-git/doc/guix.texi:18857
33556 msgid "{@code{cups-configuration} parameter} string rip-cache"
33560 #: guix-git/doc/guix.texi:18860
33561 msgid "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer."
33565 #: guix-git/doc/guix.texi:18862
33566 msgid "Defaults to @samp{\"128m\"}."
33570 #: guix-git/doc/guix.texi:18864
33572 msgid "{@code{cups-configuration} parameter} string server-admin"
33576 #: guix-git/doc/guix.texi:18866
33577 msgid "Specifies the email address of the server administrator."
33581 #: guix-git/doc/guix.texi:18868
33582 msgid "Defaults to @samp{\"root@@localhost.localdomain\"}."
33586 #: guix-git/doc/guix.texi:18870
33588 msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias"
33592 #: guix-git/doc/guix.texi:18878
33593 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{*}."
33597 #: guix-git/doc/guix.texi:18880
33598 msgid "Defaults to @samp{*}."
33602 #: guix-git/doc/guix.texi:18882
33604 msgid "{@code{cups-configuration} parameter} string server-name"
33608 #: guix-git/doc/guix.texi:18884
33609 msgid "Specifies the fully-qualified host name of the server."
33613 #: guix-git/doc/guix.texi:18886 guix-git/doc/guix.texi:23741
33614 #: guix-git/doc/guix.texi:23786
33615 msgid "Defaults to @samp{\"localhost\"}."
33619 #: guix-git/doc/guix.texi:18888
33621 msgid "{@code{cups-configuration} parameter} server-tokens server-tokens"
33625 #: guix-git/doc/guix.texi:18896
33626 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}."
33630 #: guix-git/doc/guix.texi:18898
33631 msgid "Defaults to @samp{Minimal}."
33635 #: guix-git/doc/guix.texi:18900
33637 msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen"
33641 #: guix-git/doc/guix.texi:18905
33642 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."
33646 #: guix-git/doc/guix.texi:18909
33648 msgid "{@code{cups-configuration} parameter} ssl-options ssl-options"
33652 #: guix-git/doc/guix.texi:18919
33653 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."
33657 #: guix-git/doc/guix.texi:18923
33659 msgid "{@code{cups-configuration} parameter} boolean strict-conformance?"
33663 #: guix-git/doc/guix.texi:18926
33664 msgid "Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications."
33668 #: guix-git/doc/guix.texi:18930
33670 msgid "{@code{cups-configuration} parameter} non-negative-integer timeout"
33674 #: guix-git/doc/guix.texi:18932
33675 msgid "Specifies the HTTP request timeout, in seconds."
33679 #: guix-git/doc/guix.texi:18937
33681 msgid "{@code{cups-configuration} parameter} boolean web-interface?"
33685 #: guix-git/doc/guix.texi:18939
33686 msgid "Specifies whether the web interface is enabled."
33689 #. type: Plain text
33690 #: guix-git/doc/guix.texi:18949
33691 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}."
33694 #. type: Plain text
33695 #: guix-git/doc/guix.texi:18951
33696 msgid "Available @code{opaque-cups-configuration} fields are:"
33700 #: guix-git/doc/guix.texi:18952
33702 msgid "{@code{opaque-cups-configuration} parameter} package cups"
33706 #: guix-git/doc/guix.texi:18956
33708 msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf"
33712 #: guix-git/doc/guix.texi:18958
33713 msgid "The contents of the @code{cupsd.conf}, as a string."
33717 #: guix-git/doc/guix.texi:18960
33719 msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf"
33723 #: guix-git/doc/guix.texi:18962
33724 msgid "The contents of the @code{cups-files.conf} file, as a string."
33727 #. type: Plain text
33728 #: guix-git/doc/guix.texi:18967
33729 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:"
33733 #: guix-git/doc/guix.texi:18973
33736 "(service cups-service-type\n"
33737 " (opaque-cups-configuration\n"
33738 " (cupsd.conf cupsd.conf)\n"
33739 " (cups-files.conf cups-files.conf)))\n"
33742 #. type: Plain text
33743 #: guix-git/doc/guix.texi:18984
33744 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."
33747 #. type: Plain text
33748 #: guix-git/doc/guix.texi:18988
33749 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:"
33753 #: guix-git/doc/guix.texi:18989
33755 msgid "{Scheme Variable} %desktop-services"
33759 #: guix-git/doc/guix.texi:18992
33760 msgid "This is a list of services that builds upon @code{%base-services} and adds or adjusts services for a typical ``desktop'' setup."
33764 #: guix-git/doc/guix.texi:19003
33765 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})."
33768 #. type: Plain text
33769 #: guix-git/doc/guix.texi:19008
33770 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}})."
33773 #. type: Plain text
33774 #: guix-git/doc/guix.texi:19031
33775 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."
33778 #. type: Plain text
33779 #: guix-git/doc/guix.texi:19040
33780 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."
33784 #: guix-git/doc/guix.texi:19041
33786 msgid "{Scheme Variable} gnome-desktop-service-type"
33790 #: guix-git/doc/guix.texi:19045
33791 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)."
33795 #: guix-git/doc/guix.texi:19048
33796 msgid "This service adds the @code{gnome} package to the system profile, and extends polkit with the actions from @code{gnome-settings-daemon}."
33800 #: guix-git/doc/guix.texi:19050
33802 msgid "{Data Type} gnome-desktop-configuration"
33806 #: guix-git/doc/guix.texi:19052
33807 msgid "Configuration record for the GNOME desktop environment."
33811 #: guix-git/doc/guix.texi:19054
33813 msgid "@code{gnome} (default: @code{gnome})"
33817 #: guix-git/doc/guix.texi:19056
33818 msgid "The GNOME package to use."
33822 #: guix-git/doc/guix.texi:19059
33824 msgid "{Scheme Variable} xfce-desktop-service-type"
33828 #: guix-git/doc/guix.texi:19063
33829 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)."
33833 #: guix-git/doc/guix.texi:19068
33834 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."
33838 #: guix-git/doc/guix.texi:19074
33839 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}."
33843 #: guix-git/doc/guix.texi:19076
33845 msgid "{Data Type} xfce-desktop-configuration"
33849 #: guix-git/doc/guix.texi:19078
33850 msgid "Configuration record for the Xfce desktop environment."
33854 #: guix-git/doc/guix.texi:19080
33856 msgid "@code{xfce} (default: @code{xfce})"
33860 #: guix-git/doc/guix.texi:19082
33861 msgid "The Xfce package to use."
33865 #: guix-git/doc/guix.texi:19085
33867 msgid "{Scheme Variable} mate-desktop-service-type"
33871 #: guix-git/doc/guix.texi:19089
33872 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)."
33876 #: guix-git/doc/guix.texi:19093
33877 msgid "This service adds the @code{mate} package to the system profile, and extends polkit with the actions from @code{mate-settings-daemon}."
33881 #: guix-git/doc/guix.texi:19095
33883 msgid "{Data Type} mate-desktop-configuration"
33887 #: guix-git/doc/guix.texi:19097
33888 msgid "Configuration record for the MATE desktop environment."
33892 #: guix-git/doc/guix.texi:19099
33894 msgid "@code{mate} (default: @code{mate})"
33898 #: guix-git/doc/guix.texi:19101
33899 msgid "The MATE package to use."
33903 #: guix-git/doc/guix.texi:19104
33905 msgid "{Scheme Variable} lxqt-desktop-service-type"
33909 #: guix-git/doc/guix.texi:19108
33910 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)."
33914 #: guix-git/doc/guix.texi:19111
33915 msgid "This service adds the @code{lxqt} package to the system profile."
33919 #: guix-git/doc/guix.texi:19113
33921 msgid "{Data Type} lxqt-desktop-configuration"
33925 #: guix-git/doc/guix.texi:19115
33926 msgid "Configuration record for the LXQt desktop environment."
33930 #: guix-git/doc/guix.texi:19117
33932 msgid "@code{lxqt} (default: @code{lxqt})"
33936 #: guix-git/doc/guix.texi:19119
33937 msgid "The LXQT package to use."
33941 #: guix-git/doc/guix.texi:19122
33943 msgid "{Scheme Variable} enlightenment-desktop-service-type"
33947 #: guix-git/doc/guix.texi:19125
33948 msgid "Return a service that adds the @code{enlightenment} package to the system profile, and extends dbus with actions from @code{efl}."
33952 #: guix-git/doc/guix.texi:19127
33954 msgid "{Data Type} enlightenment-desktop-service-configuration"
33958 #: guix-git/doc/guix.texi:19129
33960 msgid "@code{enlightenment} (default: @code{enlightenment})"
33964 #: guix-git/doc/guix.texi:19131
33965 msgid "The enlightenment package to use."
33968 #. type: Plain text
33969 #: guix-git/doc/guix.texi:19139
33970 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}:"
33974 #: guix-git/doc/guix.texi:19150
33977 "(use-modules (gnu))\n"
33978 "(use-service-modules desktop)\n"
33979 "(operating-system\n"
33981 " ;; cons* adds items to the list given as its last argument.\n"
33982 " (services (cons* (service gnome-desktop-service-type)\n"
33983 " (service xfce-desktop-service)\n"
33984 " %desktop-services))\n"
33988 #. type: Plain text
33989 #: guix-git/doc/guix.texi:19154
33990 msgid "These desktop environments will then be available as options in the graphical login window."
33993 #. type: Plain text
33994 #: guix-git/doc/guix.texi:19158
33995 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."
33999 #: guix-git/doc/guix.texi:19159
34001 msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]"
34005 #: guix-git/doc/guix.texi:19162
34006 msgid "Return a service that runs the ``system bus'', using @var{dbus}, with support for @var{services}."
34010 #: guix-git/doc/guix.texi:19166
34011 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."
34015 #: guix-git/doc/guix.texi:19171
34016 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)}."
34020 #: guix-git/doc/guix.texi:19173
34022 msgid "{Scheme Procedure} elogind-service [#:config @var{config}]"
34026 #: guix-git/doc/guix.texi:19179
34027 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."
34031 #: guix-git/doc/guix.texi:19183
34032 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."
34036 #: guix-git/doc/guix.texi:19188
34037 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:"
34041 #: guix-git/doc/guix.texi:19190
34043 msgid "kill-user-processes?"
34047 #: guix-git/doc/guix.texi:19192 guix-git/doc/guix.texi:19212
34048 #: guix-git/doc/guix.texi:19214 guix-git/doc/guix.texi:19216
34049 #: guix-git/doc/guix.texi:19228
34054 #: guix-git/doc/guix.texi:19192
34056 msgid "kill-only-users"
34060 #: guix-git/doc/guix.texi:19194 guix-git/doc/guix.texi:19234
34065 #: guix-git/doc/guix.texi:19194
34067 msgid "kill-exclude-users"
34071 #: guix-git/doc/guix.texi:19196
34076 #: guix-git/doc/guix.texi:19196
34078 msgid "inhibit-delay-max-seconds"
34082 #: guix-git/doc/guix.texi:19198
34087 #: guix-git/doc/guix.texi:19198
34089 msgid "handle-power-key"
34093 #: guix-git/doc/guix.texi:19200
34098 #: guix-git/doc/guix.texi:19200
34100 msgid "handle-suspend-key"
34104 #: guix-git/doc/guix.texi:19202 guix-git/doc/guix.texi:19206
34109 #: guix-git/doc/guix.texi:19202
34111 msgid "handle-hibernate-key"
34115 #: guix-git/doc/guix.texi:19204
34120 #: guix-git/doc/guix.texi:19204
34122 msgid "handle-lid-switch"
34126 #: guix-git/doc/guix.texi:19206
34128 msgid "handle-lid-switch-docked"
34132 #: guix-git/doc/guix.texi:19208 guix-git/doc/guix.texi:19210
34133 #: guix-git/doc/guix.texi:19222
34138 #: guix-git/doc/guix.texi:19208
34140 msgid "handle-lid-switch-external-power"
34144 #: guix-git/doc/guix.texi:19210
34146 msgid "power-key-ignore-inhibited?"
34150 #: guix-git/doc/guix.texi:19212
34152 msgid "suspend-key-ignore-inhibited?"
34156 #: guix-git/doc/guix.texi:19214
34158 msgid "hibernate-key-ignore-inhibited?"
34162 #: guix-git/doc/guix.texi:19216
34164 msgid "lid-switch-ignore-inhibited?"
34168 #: guix-git/doc/guix.texi:19218 guix-git/doc/guix.texi:19230
34173 #: guix-git/doc/guix.texi:19218
34175 msgid "holdoff-timeout-seconds"
34179 #: guix-git/doc/guix.texi:19220
34184 #: guix-git/doc/guix.texi:19220
34186 msgid "idle-action"
34190 #: guix-git/doc/guix.texi:19222
34192 msgid "idle-action-seconds"
34196 #: guix-git/doc/guix.texi:19224
34201 #: guix-git/doc/guix.texi:19224
34203 msgid "runtime-directory-size-percent"
34207 #: guix-git/doc/guix.texi:19226
34212 #: guix-git/doc/guix.texi:19226
34214 msgid "runtime-directory-size"
34218 #: guix-git/doc/guix.texi:19228
34220 msgid "remove-ipc?"
34224 #: guix-git/doc/guix.texi:19230
34226 msgid "suspend-state"
34230 #: guix-git/doc/guix.texi:19232
34231 msgid "(\"mem\" \"standby\" \"freeze\")"
34235 #: guix-git/doc/guix.texi:19232
34237 msgid "suspend-mode"
34241 #: guix-git/doc/guix.texi:19234
34243 msgid "hibernate-state"
34247 #: guix-git/doc/guix.texi:19236 guix-git/doc/guix.texi:19240
34252 #: guix-git/doc/guix.texi:19236
34254 msgid "hibernate-mode"
34258 #: guix-git/doc/guix.texi:19238
34259 msgid "(\"platform\" \"shutdown\")"
34263 #: guix-git/doc/guix.texi:19238
34265 msgid "hybrid-sleep-state"
34269 #: guix-git/doc/guix.texi:19240
34271 msgid "hybrid-sleep-mode"
34275 #: guix-git/doc/guix.texi:19242
34276 msgid "(\"suspend\" \"platform\" \"shutdown\")"
34280 #: guix-git/doc/guix.texi:19245
34282 msgid "{Scheme Procedure} accountsservice-service @"
34286 #: guix-git/doc/guix.texi:19253
34287 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."
34291 #: guix-git/doc/guix.texi:19256
34292 msgid "The @var{accountsservice} keyword argument is the @code{accountsservice} package to expose as a service."
34296 #: guix-git/doc/guix.texi:19258
34298 msgid "{Scheme Procedure} polkit-service @"
34302 #: guix-git/doc/guix.texi:19267
34303 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."
34307 #: guix-git/doc/guix.texi:19269
34309 msgid "{Scheme Variable} polkit-wheel-service"
34313 #: guix-git/doc/guix.texi:19274
34314 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}."
34318 #: guix-git/doc/guix.texi:19276
34320 msgid "{Scheme Variable} upower-service-type"
34324 #: guix-git/doc/guix.texi:19280
34325 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."
34329 #: guix-git/doc/guix.texi:19283
34330 msgid "It implements the @code{org.freedesktop.UPower} D-Bus interface, and is notably used by GNOME."
34334 #: guix-git/doc/guix.texi:19285
34336 msgid "{Data Type} upower-configuration"
34340 #: guix-git/doc/guix.texi:19287
34341 msgid "Data type representation the configuration for UPower."
34345 #: guix-git/doc/guix.texi:19290
34347 msgid "@code{upower} (default: @var{upower})"
34351 #: guix-git/doc/guix.texi:19292
34352 msgid "Package to use for @code{upower}."
34356 #: guix-git/doc/guix.texi:19293
34358 msgid "@code{watts-up-pro?} (default: @code{#f})"
34362 #: guix-git/doc/guix.texi:19295
34363 msgid "Enable the Watts Up Pro device."
34367 #: guix-git/doc/guix.texi:19296
34369 msgid "@code{poll-batteries?} (default: @code{#t})"
34373 #: guix-git/doc/guix.texi:19298
34374 msgid "Enable polling the kernel for battery level changes."
34378 #: guix-git/doc/guix.texi:19299
34380 msgid "@code{ignore-lid?} (default: @code{#f})"
34384 #: guix-git/doc/guix.texi:19301
34385 msgid "Ignore the lid state, this can be useful if it's incorrect on a device."
34389 #: guix-git/doc/guix.texi:19302
34391 msgid "@code{use-percentage-for-policy?} (default: @code{#f})"
34395 #: guix-git/doc/guix.texi:19305
34396 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."
34400 #: guix-git/doc/guix.texi:19306
34402 msgid "@code{percentage-low} (default: @code{10})"
34406 #: guix-git/doc/guix.texi:19309
34407 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered low."
34411 #: guix-git/doc/guix.texi:19310
34413 msgid "@code{percentage-critical} (default: @code{3})"
34417 #: guix-git/doc/guix.texi:19313
34418 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which the battery is considered critical."
34422 #: guix-git/doc/guix.texi:19314
34424 msgid "@code{percentage-action} (default: @code{2})"
34428 #: guix-git/doc/guix.texi:19317
34429 msgid "When @code{use-percentage-for-policy?} is @code{#t}, this sets the percentage at which action will be taken."
34433 #: guix-git/doc/guix.texi:19318
34435 msgid "@code{time-low} (default: @code{1200})"
34439 #: guix-git/doc/guix.texi:19321
34440 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered low."
34444 #: guix-git/doc/guix.texi:19322
34446 msgid "@code{time-critical} (default: @code{300})"
34450 #: guix-git/doc/guix.texi:19325
34451 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which the battery is considered critical."
34455 #: guix-git/doc/guix.texi:19326
34457 msgid "@code{time-action} (default: @code{120})"
34461 #: guix-git/doc/guix.texi:19329
34462 msgid "When @code{use-time-for-policy?} is @code{#f}, this sets the time remaining in seconds at which action will be taken."
34466 #: guix-git/doc/guix.texi:19330
34468 msgid "@code{critical-power-action} (default: @code{'hybrid-sleep})"
34472 #: guix-git/doc/guix.texi:19333
34473 msgid "The action taken when @code{percentage-action} or @code{time-action} is reached (depending on the configuration of @code{use-percentage-for-policy?})."
34477 #: guix-git/doc/guix.texi:19335
34478 msgid "Possible values are:"
34482 #: guix-git/doc/guix.texi:19339
34487 #: guix-git/doc/guix.texi:19342
34492 #: guix-git/doc/guix.texi:19345
34493 msgid "@code{'hybrid-sleep}."
34497 #: guix-git/doc/guix.texi:19350
34499 msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]"
34503 #: guix-git/doc/guix.texi:19360
34504 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."
34508 #: guix-git/doc/guix.texi:19362
34510 msgid "{Scheme Variable} colord-service-type"
34514 #: guix-git/doc/guix.texi:19369
34515 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."
34519 #: guix-git/doc/guix.texi:19371
34521 msgid "scanner access"
34525 #: guix-git/doc/guix.texi:19372
34527 msgid "{Scheme Variable} sane-service-type"
34531 #: guix-git/doc/guix.texi:19378
34532 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."
34536 #: guix-git/doc/guix.texi:19380
34538 msgid "{Scheme Variable} sane-backends-minimal"
34542 #: guix-git/doc/guix.texi:19383
34543 msgid "The default package which the @code{sane-service-type} installs. It supports many recent scanners."
34547 #: guix-git/doc/guix.texi:19385
34549 msgid "{Scheme Variable} sane-backends"
34553 #: guix-git/doc/guix.texi:19392
34554 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:"
34558 #: guix-git/doc/guix.texi:19401
34561 "(use-modules (gnu))\n"
34562 "(use-service-modules\n"
34565 "(use-package-modules\n"
34572 #: guix-git/doc/guix.texi:19406
34575 "(define %my-desktop-services\n"
34576 " ;; List of desktop services that supports a broader range of scanners.\n"
34577 " (modify-services %desktop-services\n"
34578 " (sane-service-type _ => sane-backends)))\n"
34583 #: guix-git/doc/guix.texi:19410
34586 "(operating-system\n"
34588 " (services %my-desktop-services)\n"
34592 #: guix-git/doc/guix.texi:19413
34594 msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]"
34598 #: guix-git/doc/guix.texi:19422
34599 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."
34603 #: guix-git/doc/guix.texi:19424
34605 msgid "{Scheme Variable} %standard-geoclue-applications"
34609 #: guix-git/doc/guix.texi:19431
34610 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."
34614 #: guix-git/doc/guix.texi:19433
34616 msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @"
34620 #: guix-git/doc/guix.texi:19446
34621 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."
34625 #: guix-git/doc/guix.texi:19448
34627 msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @"
34631 #: guix-git/doc/guix.texi:19455
34632 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."
34636 #: guix-git/doc/guix.texi:19457
34637 msgid "Users need to be in the @code{lp} group to access the D-Bus service."
34641 #: guix-git/doc/guix.texi:19459
34643 msgid "{Scheme Variable} gnome-keyring-service-type"
34647 #: guix-git/doc/guix.texi:19463
34648 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)."
34652 #: guix-git/doc/guix.texi:19467
34653 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."
34657 #: guix-git/doc/guix.texi:19469
34659 msgid "{Data Type} gnome-keyring-configuration"
34663 #: guix-git/doc/guix.texi:19471
34664 msgid "Configuration record for the GNOME Keyring service."
34668 #: guix-git/doc/guix.texi:19473
34670 msgid "@code{keyring} (default: @code{gnome-keyring})"
34674 #: guix-git/doc/guix.texi:19475
34675 msgid "The GNOME keyring package to use."
34679 #: guix-git/doc/guix.texi:19476
34681 msgid "pam-services"
34685 #: guix-git/doc/guix.texi:19481
34686 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}."
34690 #: guix-git/doc/guix.texi:19487
34691 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."
34695 #: guix-git/doc/guix.texi:19490
34696 msgid "By default, this field contains ``gdm-password'' with the value @code{login} and ``passwd'' is with the value @code{passwd}."
34700 #: guix-git/doc/guix.texi:19497
34702 msgid "sound support"
34706 #: guix-git/doc/guix.texi:19498
34712 #: guix-git/doc/guix.texi:19499
34714 msgid "PulseAudio, sound support"
34717 #. type: Plain text
34718 #: guix-git/doc/guix.texi:19504
34719 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."
34723 #: guix-git/doc/guix.texi:19505
34725 msgid "{Scheme Variable} alsa-service-type"
34729 #: guix-git/doc/guix.texi:19510
34730 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:"
34734 #: guix-git/doc/guix.texi:19513
34736 msgid "(service alsa-service-type)\n"
34740 #: guix-git/doc/guix.texi:19516
34741 msgid "See below for details about @code{alsa-configuration}."
34745 #: guix-git/doc/guix.texi:19518
34747 msgid "{Data Type} alsa-configuration"
34751 #: guix-git/doc/guix.texi:19520
34752 msgid "Data type representing the configuration for @code{alsa-service}."
34756 #: guix-git/doc/guix.texi:19522
34758 msgid "@code{alsa-plugins} (default: @var{alsa-plugins})"
34762 #: guix-git/doc/guix.texi:19524
34763 msgid "@code{alsa-plugins} package to use."
34767 #: guix-git/doc/guix.texi:19525
34769 msgid "@code{pulseaudio?} (default: @var{#t})"
34773 #: guix-git/doc/guix.texi:19528
34774 msgid "Whether ALSA applications should transparently be made to use the @uref{https://www.pulseaudio.org/, PulseAudio} sound server."
34778 #: guix-git/doc/guix.texi:19532
34779 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."
34783 #: guix-git/doc/guix.texi:19533
34785 msgid "@code{extra-options} (default: @var{\"\"})"
34789 #: guix-git/doc/guix.texi:19535
34790 msgid "String to append to the @file{/etc/asound.conf} file."
34793 #. type: Plain text
34794 #: guix-git/doc/guix.texi:19541
34795 msgid "Individual users who want to override the system configuration of ALSA can do it with the @file{~/.asoundrc} file:"
34799 #: guix-git/doc/guix.texi:19547
34802 "# In guix, we have to specify the absolute path for plugins.\n"
34803 "pcm_type.jack @{\n"
34804 " lib \"/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so\"\n"
34810 #: guix-git/doc/guix.texi:19556
34813 "# Routing ALSA to jack:\n"
34814 "# <http://jackaudio.org/faq/routing_alsa.html>.\n"
34817 " playback_ports @{\n"
34818 " 0 system:playback_1\n"
34819 " 1 system:playback_2\n"
34825 #: guix-git/doc/guix.texi:19562
34828 " capture_ports @{\n"
34829 " 0 system:capture_1\n"
34830 " 1 system:capture_2\n"
34837 #: guix-git/doc/guix.texi:19569
34840 "pcm.!default @{\n"
34843 " pcm \"rawjack\"\n"
34848 #. type: Plain text
34849 #: guix-git/doc/guix.texi:19573
34850 msgid "See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the details."
34854 #: guix-git/doc/guix.texi:19574
34856 msgid "{Scheme Variable} pulseaudio-service-type"
34860 #: guix-git/doc/guix.texi:19578
34861 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."
34865 #: guix-git/doc/guix.texi:19584
34866 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}."
34870 #: guix-git/doc/guix.texi:19592
34871 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."
34875 #: guix-git/doc/guix.texi:19595
34877 msgid "{Data Type} pulseaudio-configuration"
34881 #: guix-git/doc/guix.texi:19597
34882 msgid "Data type representing the configuration for @code{pulseaudio-service}."
34886 #: guix-git/doc/guix.texi:19599
34888 msgid "@code{client-conf} (default: @code{'()})"
34892 #: guix-git/doc/guix.texi:19604
34893 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."
34897 #: guix-git/doc/guix.texi:19605
34899 msgid "@code{daemon-conf} (default: @code{'((flat-volumes . no))})"
34903 #: guix-git/doc/guix.texi:19608
34904 msgid "List of settings to set in @file{daemon.conf}, formatted just like @var{client-conf}."
34908 #: guix-git/doc/guix.texi:19609
34910 msgid "@code{script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/default.pa\")})"
34914 #: guix-git/doc/guix.texi:19611
34915 msgid "Script file to use as @file{default.pa}."
34919 #: guix-git/doc/guix.texi:19612
34921 msgid "@code{system-script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/system.pa\")})"
34925 #: guix-git/doc/guix.texi:19614
34926 msgid "Script file to use as @file{system.pa}."
34930 #: guix-git/doc/guix.texi:19617
34932 msgid "{Scheme Variable} ladspa-service-type"
34936 #: guix-git/doc/guix.texi:19620
34937 msgid "This service sets the @var{LADSPA_PATH} variable, so that programs, which respect it, e.g. PulseAudio, can load LADSPA plugins."
34941 #: guix-git/doc/guix.texi:19623
34942 msgid "The following example will setup the service to enable modules from the @code{swh-plugins} package:"
34946 #: guix-git/doc/guix.texi:19627
34949 "(service ladspa-service-type\n"
34950 " (ladspa-configuration (plugins (list swh-plugins))))\n"
34954 #: guix-git/doc/guix.texi:19631
34955 msgid "See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the details."
34959 #: guix-git/doc/guix.texi:19638
34964 #. type: Plain text
34965 #: guix-git/doc/guix.texi:19640
34966 msgid "The @code{(gnu services databases)} module provides the following services."
34969 #. type: subsubheading
34970 #: guix-git/doc/guix.texi:19641
34975 #. type: Plain text
34976 #: guix-git/doc/guix.texi:19645
34977 msgid "The following example describes a PostgreSQL service with the default configuration."
34981 #: guix-git/doc/guix.texi:19650
34984 "(service postgresql-service-type\n"
34985 " (postgresql-configuration\n"
34986 " (postgresql postgresql-10)))\n"
34989 #. type: Plain text
34990 #: guix-git/doc/guix.texi:19656
34991 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."
34994 #. type: Plain text
34995 #: guix-git/doc/guix.texi:19663
34996 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."
35000 #: guix-git/doc/guix.texi:19668
35003 "sudo -u postgres -s /bin/sh\n"
35004 "createuser --interactive\n"
35005 "createdb $MY_USER_LOGIN # Replace appropriately.\n"
35009 #: guix-git/doc/guix.texi:19670
35011 msgid "{Data Type} postgresql-configuration"
35015 #: guix-git/doc/guix.texi:19673
35016 msgid "Data type representing the configuration for the @code{postgresql-service-type}."
35020 #: guix-git/doc/guix.texi:19675
35026 #: guix-git/doc/guix.texi:19677
35027 msgid "PostgreSQL package to use for the service."
35031 #: guix-git/doc/guix.texi:19678
35033 msgid "@code{port} (default: @code{5432})"
35037 #: guix-git/doc/guix.texi:19680
35038 msgid "Port on which PostgreSQL should listen."
35042 #: guix-git/doc/guix.texi:19683
35043 msgid "Locale to use as the default when creating the database cluster."
35047 #: guix-git/doc/guix.texi:19684
35049 msgid "@code{config-file} (default: @code{(postgresql-config-file)})"
35053 #: guix-git/doc/guix.texi:19688
35054 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."
35058 #: guix-git/doc/guix.texi:19689
35060 msgid "@code{log-directory} (default: @code{\"/var/log/postgresql\"})"
35064 #: guix-git/doc/guix.texi:19693
35065 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."
35069 #: guix-git/doc/guix.texi:19694
35071 msgid "@code{data-directory} (default: @code{\"/var/lib/postgresql/data\"})"
35075 #: guix-git/doc/guix.texi:19696
35076 msgid "Directory in which to store the data."
35080 #: guix-git/doc/guix.texi:19697
35082 msgid "@code{extension-packages} (default: @code{'()})"
35086 #: guix-git/doc/guix.texi:19698
35088 msgid "postgresql extension-packages"
35092 #: guix-git/doc/guix.texi:19703
35093 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:"
35097 #: guix-git/doc/guix.texi:19704
35103 #: guix-git/doc/guix.texi:19707
35106 "(use-package-modules databases geo)\n"
35111 #: guix-git/doc/guix.texi:19720
35114 "(operating-system\n"
35116 " ;; postgresql is required to run `psql' but postgis is not required for\n"
35117 " ;; proper operation.\n"
35118 " (packages (cons* postgresql %base-packages))\n"
35121 " (service postgresql-service-type\n"
35122 " (postgresql-configuration\n"
35123 " (postgresql postgresql-10)\n"
35124 " (extension-packages (list postgis))))\n"
35125 " %base-services)))\n"
35129 #: guix-git/doc/guix.texi:19724
35130 msgid "Then the extension becomes visible and you can initialise an empty geographic database in this way:"
35134 #: guix-git/doc/guix.texi:19731
35137 "psql -U postgres\n"
35138 "> create database postgistest;\n"
35139 "> \\connect postgistest;\n"
35140 "> create extension postgis;\n"
35141 "> create extension postgis_topology;\n"
35145 #: guix-git/doc/guix.texi:19736
35146 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."
35150 #: guix-git/doc/guix.texi:19740
35152 msgid "{Data Type} postgresql-config-file"
35156 #: guix-git/doc/guix.texi:19746
35157 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."
35161 #: guix-git/doc/guix.texi:19766
35164 "(service postgresql-service-type\n"
35165 " (postgresql-configuration\n"
35167 " (postgresql-config-file\n"
35168 " (log-destination \"stderr\")\n"
35170 " (plain-file \"pg_hba.conf\"\n"
35172 "local\tall\tall\t\t\ttrust\n"
35173 "host\tall\tall\t127.0.0.1/32 \tmd5\n"
35174 "host\tall\tall\t::1/128 \tmd5\"))\n"
35176 " '((\"session_preload_libraries\" \"auto_explain\")\n"
35177 " (\"random_page_cost\" 2)\n"
35178 " (\"auto_explain.log_min_duration\" \"100 ms\")\n"
35179 " (\"work_mem\" \"500 MB\")\n"
35180 " (\"logging_collector\" #t)\n"
35181 " (\"log_directory\" \"/var/log/postgresql\")))))))\n"
35185 #: guix-git/doc/guix.texi:19769
35187 msgid "@code{log-destination} (default: @code{\"syslog\"})"
35191 #: guix-git/doc/guix.texi:19772
35192 msgid "The logging method to use for PostgreSQL@. Multiple values are accepted, separated by commas."
35196 #: guix-git/doc/guix.texi:19773
35198 msgid "@code{hba-file} (default: @code{%default-postgres-hba})"
35202 #: guix-git/doc/guix.texi:19776
35203 msgid "Filename or G-expression for the host-based authentication configuration."
35207 #: guix-git/doc/guix.texi:19777
35209 msgid "@code{ident-file} (default: @code{%default-postgres-ident})"
35213 #: guix-git/doc/guix.texi:19779
35214 msgid "Filename or G-expression for the user name mapping configuration."
35218 #: guix-git/doc/guix.texi:19780
35220 msgid "@code{socket-directory} (default: @code{#false})"
35224 #: guix-git/doc/guix.texi:19785
35225 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."
35229 #: guix-git/doc/guix.texi:19788
35230 msgid "By default, the @code{#false} value means the PostgreSQL default value will be used, which is currently @samp{/tmp}."
35234 #: guix-git/doc/guix.texi:19793
35235 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."
35239 #: guix-git/doc/guix.texi:19799
35240 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}."
35244 #: guix-git/doc/guix.texi:19803
35246 msgid "{Scheme Variable} postgresql-role-service-type"
35250 #: guix-git/doc/guix.texi:19806
35251 msgid "This service allows to create PostgreSQL roles and databases after PostgreSQL service start. Here is an example of its use."
35255 #: guix-git/doc/guix.texi:19814
35258 "(service postgresql-role-service-type\n"
35259 " (postgresql-role-configuration\n"
35261 " (list (postgresql-role\n"
35262 " (name \"test\")\n"
35263 " (create-database? #t))))))\n"
35267 #: guix-git/doc/guix.texi:19818
35268 msgid "This service can be extended with extra roles, as in this example:"
35272 #: guix-git/doc/guix.texi:19824
35275 "(service-extension postgresql-role-service-type\n"
35276 " (const (postgresql-role\n"
35277 " (name \"alice\")\n"
35278 " (create-database? #t))))\n"
35282 #: guix-git/doc/guix.texi:19827
35284 msgid "{Data Type} postgresql-role"
35288 #: guix-git/doc/guix.texi:19833
35289 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."
35293 #: guix-git/doc/guix.texi:19837
35294 msgid "The role name."
35298 #: guix-git/doc/guix.texi:19838
35300 msgid "@code{permissions} (default: @code{'(createdb login)})"
35304 #: guix-git/doc/guix.texi:19842
35305 msgid "The role permissions list. Supported permissions are @code{bypassrls}, @code{createdb}, @code{createrole}, @code{login}, @code{replication} and @code{superuser}."
35309 #: guix-git/doc/guix.texi:19843
35311 msgid "@code{create-database?} (default: @code{#f})"
35315 #: guix-git/doc/guix.texi:19845
35316 msgid "Whether to create a database with the same name as the role."
35320 #: guix-git/doc/guix.texi:19849
35322 msgid "{Data Type} postgresql-role-configuration"
35326 #: guix-git/doc/guix.texi:19852
35327 msgid "Data type representing the configuration of @var{postgresql-role-service-type}."
35331 #: guix-git/doc/guix.texi:19854
35333 msgid "@code{host} (default: @code{\"/var/run/postgresql\"})"
35337 #: guix-git/doc/guix.texi:19856
35338 msgid "The PostgreSQL host to connect to."
35342 #: guix-git/doc/guix.texi:19857
35344 msgid "@code{log} (default: @code{\"/var/log/postgresql_roles.log\"})"
35348 #: guix-git/doc/guix.texi:19859
35349 msgid "File name of the log file."
35353 #: guix-git/doc/guix.texi:19860
35355 msgid "@code{roles} (default: @code{'()})"
35359 #: guix-git/doc/guix.texi:19862
35360 msgid "The initial PostgreSQL roles to create."
35363 #. type: subsubheading
35364 #: guix-git/doc/guix.texi:19865
35366 msgid "MariaDB/MySQL"
35370 #: guix-git/doc/guix.texi:19867
35372 msgid "{Scheme Variable} mysql-service-type"
35376 #: guix-git/doc/guix.texi:19871
35377 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."
35381 #: guix-git/doc/guix.texi:19873
35383 msgid "{Data Type} mysql-configuration"
35387 #: guix-git/doc/guix.texi:19875
35388 msgid "Data type representing the configuration of @var{mysql-service-type}."
35392 #: guix-git/doc/guix.texi:19877
35394 msgid "@code{mysql} (default: @var{mariadb})"
35398 #: guix-git/doc/guix.texi:19880
35399 msgid "Package object of the MySQL database server, can be either @var{mariadb} or @var{mysql}."
35403 #: guix-git/doc/guix.texi:19883
35404 msgid "For MySQL, a temporary root password will be displayed at activation time. For MariaDB, the root password is empty."
35408 #: guix-git/doc/guix.texi:19884 guix-git/doc/guix.texi:23430
35410 msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})"
35414 #: guix-git/doc/guix.texi:19887
35415 msgid "The IP on which to listen for network connections. Use @code{\"0.0.0.0\"} to bind to all available network interfaces."
35419 #: guix-git/doc/guix.texi:19888
35421 msgid "@code{port} (default: @code{3306})"
35425 #: guix-git/doc/guix.texi:19890
35426 msgid "TCP port on which the database server listens for incoming connections."
35430 #: guix-git/doc/guix.texi:19891
35432 msgid "@code{socket} (default: @code{\"/run/mysqld/mysqld.sock\"})"
35436 #: guix-git/doc/guix.texi:19893
35437 msgid "Socket file to use for local (non-network) connections."
35441 #: guix-git/doc/guix.texi:19896
35442 msgid "Additional settings for the @file{my.cnf} configuration file."
35446 #: guix-git/doc/guix.texi:19897
35448 msgid "@code{auto-upgrade?} (default: @code{#t})"
35452 #: guix-git/doc/guix.texi:19902
35453 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."
35456 #. type: subsubheading
35457 #: guix-git/doc/guix.texi:19906
35463 #: guix-git/doc/guix.texi:19908
35465 msgid "{Scheme Variable} memcached-service-type"
35469 #: guix-git/doc/guix.texi:19912
35470 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."
35474 #: guix-git/doc/guix.texi:19916
35476 msgid "(service memcached-service-type)\n"
35480 #: guix-git/doc/guix.texi:19918
35482 msgid "{Data Type} memcached-configuration"
35486 #: guix-git/doc/guix.texi:19920
35487 msgid "Data type representing the configuration of memcached."
35491 #: guix-git/doc/guix.texi:19922
35493 msgid "@code{memcached} (default: @code{memcached})"
35497 #: guix-git/doc/guix.texi:19924
35498 msgid "The Memcached package to use."
35502 #: guix-git/doc/guix.texi:19925
35504 msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})"
35508 #: guix-git/doc/guix.texi:19927
35509 msgid "Network interfaces on which to listen."
35513 #: guix-git/doc/guix.texi:19928
35515 msgid "@code{tcp-port} (default: @code{11211})"
35519 #: guix-git/doc/guix.texi:19930
35520 msgid "Port on which to accept connections."
35524 #: guix-git/doc/guix.texi:19931
35526 msgid "@code{udp-port} (default: @code{11211})"
35530 #: guix-git/doc/guix.texi:19934
35531 msgid "Port on which to accept UDP connections on, a value of 0 will disable listening on a UDP socket."
35535 #: guix-git/doc/guix.texi:19935
35537 msgid "@code{additional-options} (default: @code{'()})"
35541 #: guix-git/doc/guix.texi:19937
35542 msgid "Additional command line options to pass to @code{memcached}."
35545 #. type: subsubheading
35546 #: guix-git/doc/guix.texi:19940
35552 #: guix-git/doc/guix.texi:19942
35554 msgid "{Scheme Variable} redis-service-type"
35558 #: guix-git/doc/guix.texi:19945
35559 msgid "This is the service type for the @uref{https://redis.io/, Redis} key/value store, whose value is a @code{redis-configuration} object."
35563 #: guix-git/doc/guix.texi:19947
35565 msgid "{Data Type} redis-configuration"
35569 #: guix-git/doc/guix.texi:19949
35570 msgid "Data type representing the configuration of redis."
35574 #: guix-git/doc/guix.texi:19951
35576 msgid "@code{redis} (default: @code{redis})"
35580 #: guix-git/doc/guix.texi:19953
35581 msgid "The Redis package to use."
35585 #: guix-git/doc/guix.texi:19954
35587 msgid "@code{bind} (default: @code{\"127.0.0.1\"})"
35591 #: guix-git/doc/guix.texi:19956
35592 msgid "Network interface on which to listen."
35596 #: guix-git/doc/guix.texi:19957
35598 msgid "@code{port} (default: @code{6379})"
35602 #: guix-git/doc/guix.texi:19960
35603 msgid "Port on which to accept connections on, a value of 0 will disable listening on a TCP socket."
35607 #: guix-git/doc/guix.texi:19961
35609 msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})"
35613 #: guix-git/doc/guix.texi:19963
35614 msgid "Directory in which to store the database and related files."
35618 #: guix-git/doc/guix.texi:19969
35624 #: guix-git/doc/guix.texi:19970
35629 #. type: Plain text
35630 #: guix-git/doc/guix.texi:19975
35631 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."
35634 #. type: subsubheading
35635 #: guix-git/doc/guix.texi:19976
35637 msgid "Dovecot Service"
35641 #: guix-git/doc/guix.texi:19978
35643 msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]"
35647 #: guix-git/doc/guix.texi:19980
35648 msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server."
35651 #. type: Plain text
35652 #: guix-git/doc/guix.texi:19990
35653 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."
35656 #. type: Plain text
35657 #: guix-git/doc/guix.texi:19993
35658 msgid "For example, to specify that mail is located at @code{maildir~/.mail}, one would instantiate the Dovecot service like this:"
35662 #: guix-git/doc/guix.texi:19998
35665 "(dovecot-service #:config\n"
35666 " (dovecot-configuration\n"
35667 " (mail-location \"maildir:~/.mail\")))\n"
35670 #. type: Plain text
35671 #: guix-git/doc/guix.texi:20006
35672 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."
35675 #. type: Plain text
35676 #: guix-git/doc/guix.texi:20016
35677 msgid "Available @code{dovecot-configuration} fields are:"
35681 #: guix-git/doc/guix.texi:20017
35683 msgid "{@code{dovecot-configuration} parameter} package dovecot"
35687 #: guix-git/doc/guix.texi:20019 guix-git/doc/guix.texi:21325
35688 msgid "The dovecot package."
35692 #: guix-git/doc/guix.texi:20021
35694 msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen"
35698 #: guix-git/doc/guix.texi:20027
35699 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."
35703 #: guix-git/doc/guix.texi:20029
35705 msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols"
35709 #: guix-git/doc/guix.texi:20032
35710 msgid "List of protocols we want to serve. Available protocols include @samp{imap}, @samp{pop3}, and @samp{lmtp}."
35714 #: guix-git/doc/guix.texi:20034
35715 msgid "Available @code{protocol-configuration} fields are:"
35719 #: guix-git/doc/guix.texi:20035
35721 msgid "{@code{protocol-configuration} parameter} string name"
35725 #: guix-git/doc/guix.texi:20037
35726 msgid "The name of the protocol."
35730 #: guix-git/doc/guix.texi:20039
35732 msgid "{@code{protocol-configuration} parameter} string auth-socket-path"
35736 #: guix-git/doc/guix.texi:20043
35737 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\"}."
35741 #: guix-git/doc/guix.texi:20045
35743 msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins"
35747 #: guix-git/doc/guix.texi:20047
35748 msgid "Space separated list of plugins to load."
35752 #: guix-git/doc/guix.texi:20049
35754 msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections"
35758 #: guix-git/doc/guix.texi:20053
35759 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}."
35763 #: guix-git/doc/guix.texi:20057
35765 msgid "{@code{dovecot-configuration} parameter} service-configuration-list services"
35769 #: guix-git/doc/guix.texi:20061
35770 msgid "List of services to enable. Available services include @samp{imap}, @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and @samp{lmtp}."
35774 #: guix-git/doc/guix.texi:20063
35775 msgid "Available @code{service-configuration} fields are:"
35779 #: guix-git/doc/guix.texi:20064
35781 msgid "{@code{service-configuration} parameter} string kind"
35785 #: guix-git/doc/guix.texi:20069
35786 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."
35790 #: guix-git/doc/guix.texi:20071
35792 msgid "{@code{service-configuration} parameter} listener-configuration-list listeners"
35796 #: guix-git/doc/guix.texi:20076
35797 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{()}."
35801 #: guix-git/doc/guix.texi:20078
35802 msgid "Available @code{unix-listener-configuration} fields are:"
35806 #: guix-git/doc/guix.texi:20079
35808 msgid "{@code{unix-listener-configuration} parameter} string path"
35812 #: guix-git/doc/guix.texi:20082 guix-git/doc/guix.texi:20105
35813 msgid "Path to the file, relative to @code{base-dir} field. This is also used as the section name."
35817 #: guix-git/doc/guix.texi:20084
35819 msgid "{@code{unix-listener-configuration} parameter} string mode"
35823 #: guix-git/doc/guix.texi:20087 guix-git/doc/guix.texi:20110
35824 msgid "The access mode for the socket. Defaults to @samp{\"0600\"}."
35828 #: guix-git/doc/guix.texi:20089
35830 msgid "{@code{unix-listener-configuration} parameter} string user"
35834 #: guix-git/doc/guix.texi:20092 guix-git/doc/guix.texi:20115
35835 msgid "The user to own the socket. Defaults to @samp{\"\"}."
35839 #: guix-git/doc/guix.texi:20094
35841 msgid "{@code{unix-listener-configuration} parameter} string group"
35845 #: guix-git/doc/guix.texi:20097 guix-git/doc/guix.texi:20120
35846 msgid "The group to own the socket. Defaults to @samp{\"\"}."
35850 #: guix-git/doc/guix.texi:20101
35851 msgid "Available @code{fifo-listener-configuration} fields are:"
35855 #: guix-git/doc/guix.texi:20102
35857 msgid "{@code{fifo-listener-configuration} parameter} string path"
35861 #: guix-git/doc/guix.texi:20107
35863 msgid "{@code{fifo-listener-configuration} parameter} string mode"
35867 #: guix-git/doc/guix.texi:20112
35869 msgid "{@code{fifo-listener-configuration} parameter} string user"
35873 #: guix-git/doc/guix.texi:20117
35875 msgid "{@code{fifo-listener-configuration} parameter} string group"
35879 #: guix-git/doc/guix.texi:20124
35880 msgid "Available @code{inet-listener-configuration} fields are:"
35884 #: guix-git/doc/guix.texi:20125
35886 msgid "{@code{inet-listener-configuration} parameter} string protocol"
35890 #: guix-git/doc/guix.texi:20127
35891 msgid "The protocol to listen for."
35895 #: guix-git/doc/guix.texi:20129
35897 msgid "{@code{inet-listener-configuration} parameter} string address"
35901 #: guix-git/doc/guix.texi:20132
35902 msgid "The address on which to listen, or empty for all addresses. Defaults to @samp{\"\"}."
35906 #: guix-git/doc/guix.texi:20134
35908 msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port"
35912 #: guix-git/doc/guix.texi:20136
35913 msgid "The port on which to listen."
35917 #: guix-git/doc/guix.texi:20138
35919 msgid "{@code{inet-listener-configuration} parameter} boolean ssl?"
35923 #: guix-git/doc/guix.texi:20142
35924 msgid "Whether to use SSL for this service; @samp{yes}, @samp{no}, or @samp{required}. Defaults to @samp{#t}."
35928 #: guix-git/doc/guix.texi:20146
35930 msgid "{@code{service-configuration} parameter} non-negative-integer client-limit"
35934 #: guix-git/doc/guix.texi:20151
35935 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."
35939 #: guix-git/doc/guix.texi:20156
35941 msgid "{@code{service-configuration} parameter} non-negative-integer service-count"
35945 #: guix-git/doc/guix.texi:20161
35946 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}."
35950 #: guix-git/doc/guix.texi:20164
35952 msgid "{@code{service-configuration} parameter} non-negative-integer process-limit"
35956 #: guix-git/doc/guix.texi:20167
35957 msgid "Maximum number of processes that can exist for this service. If set to 0, @code{default-process-limit} is used instead."
35961 #: guix-git/doc/guix.texi:20172
35963 msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail"
35967 #: guix-git/doc/guix.texi:20175
35968 msgid "Number of processes to always keep waiting for more connections. Defaults to @samp{0}."
35972 #: guix-git/doc/guix.texi:20177
35974 msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit"
35978 #: guix-git/doc/guix.texi:20181
35979 msgid "If you set @samp{service-count 0}, you probably need to grow this. Defaults to @samp{256000000}."
35983 #: guix-git/doc/guix.texi:20185
35985 msgid "{@code{dovecot-configuration} parameter} dict-configuration dict"
35989 #: guix-git/doc/guix.texi:20188
35990 msgid "Dict configuration, as created by the @code{dict-configuration} constructor."
35994 #: guix-git/doc/guix.texi:20190
35995 msgid "Available @code{dict-configuration} fields are:"
35999 #: guix-git/doc/guix.texi:20191
36001 msgid "{@code{dict-configuration} parameter} free-form-fields entries"
36005 #: guix-git/doc/guix.texi:20194
36006 msgid "A list of key-value pairs that this dict should hold. Defaults to @samp{()}."
36010 #: guix-git/doc/guix.texi:20198
36012 msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs"
36016 #: guix-git/doc/guix.texi:20201
36017 msgid "A list of passdb configurations, each one created by the @code{passdb-configuration} constructor."
36021 #: guix-git/doc/guix.texi:20203
36022 msgid "Available @code{passdb-configuration} fields are:"
36026 #: guix-git/doc/guix.texi:20204
36028 msgid "{@code{passdb-configuration} parameter} string driver"
36032 #: guix-git/doc/guix.texi:20209
36033 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\"}."
36037 #: guix-git/doc/guix.texi:20211
36039 msgid "{@code{passdb-configuration} parameter} space-separated-string-list args"
36043 #: guix-git/doc/guix.texi:20214
36044 msgid "Space separated list of arguments to the passdb driver. Defaults to @samp{\"\"}."
36048 #: guix-git/doc/guix.texi:20218
36050 msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs"
36054 #: guix-git/doc/guix.texi:20221
36055 msgid "List of userdb configurations, each one created by the @code{userdb-configuration} constructor."
36059 #: guix-git/doc/guix.texi:20223
36060 msgid "Available @code{userdb-configuration} fields are:"
36064 #: guix-git/doc/guix.texi:20224
36066 msgid "{@code{userdb-configuration} parameter} string driver"
36070 #: guix-git/doc/guix.texi:20228
36071 msgid "The driver that the userdb should use. Valid values include @samp{passwd} and @samp{static}. Defaults to @samp{\"passwd\"}."
36075 #: guix-git/doc/guix.texi:20230
36077 msgid "{@code{userdb-configuration} parameter} space-separated-string-list args"
36081 #: guix-git/doc/guix.texi:20233
36082 msgid "Space separated list of arguments to the userdb driver. Defaults to @samp{\"\"}."
36086 #: guix-git/doc/guix.texi:20235
36088 msgid "{@code{userdb-configuration} parameter} free-form-args override-fields"
36092 #: guix-git/doc/guix.texi:20238
36093 msgid "Override fields from passwd. Defaults to @samp{()}."
36097 #: guix-git/doc/guix.texi:20242
36099 msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration"
36103 #: guix-git/doc/guix.texi:20245
36104 msgid "Plug-in configuration, created by the @code{plugin-configuration} constructor."
36108 #: guix-git/doc/guix.texi:20247
36110 msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces"
36114 #: guix-git/doc/guix.texi:20250
36115 msgid "List of namespaces. Each item in the list is created by the @code{namespace-configuration} constructor."
36119 #: guix-git/doc/guix.texi:20252
36120 msgid "Available @code{namespace-configuration} fields are:"
36124 #: guix-git/doc/guix.texi:20253
36126 msgid "{@code{namespace-configuration} parameter} string name"
36130 #: guix-git/doc/guix.texi:20255
36131 msgid "Name for this namespace."
36135 #: guix-git/doc/guix.texi:20257
36137 msgid "{@code{namespace-configuration} parameter} string type"
36141 #: guix-git/doc/guix.texi:20260
36142 msgid "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to @samp{\"private\"}."
36146 #: guix-git/doc/guix.texi:20262
36148 msgid "{@code{namespace-configuration} parameter} string separator"
36152 #: guix-git/doc/guix.texi:20268
36153 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{\"\"}."
36157 #: guix-git/doc/guix.texi:20270
36159 msgid "{@code{namespace-configuration} parameter} string prefix"
36163 #: guix-git/doc/guix.texi:20274
36164 msgid "Prefix required to access this namespace. This needs to be different for all namespaces. For example @samp{Public/}. Defaults to @samp{\"\"}."
36168 #: guix-git/doc/guix.texi:20276
36170 msgid "{@code{namespace-configuration} parameter} string location"
36174 #: guix-git/doc/guix.texi:20280
36175 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{\"\"}."
36179 #: guix-git/doc/guix.texi:20282
36181 msgid "{@code{namespace-configuration} parameter} boolean inbox?"
36185 #: guix-git/doc/guix.texi:20286
36186 msgid "There can be only one INBOX, and this setting defines which namespace has it. Defaults to @samp{#f}."
36190 #: guix-git/doc/guix.texi:20288
36192 msgid "{@code{namespace-configuration} parameter} boolean hidden?"
36196 #: guix-git/doc/guix.texi:20296
36197 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}."
36201 #: guix-git/doc/guix.texi:20298
36203 msgid "{@code{namespace-configuration} parameter} boolean list?"
36207 #: guix-git/doc/guix.texi:20304
36208 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}."
36212 #: guix-git/doc/guix.texi:20306
36214 msgid "{@code{namespace-configuration} parameter} boolean subscriptions?"
36218 #: guix-git/doc/guix.texi:20311
36219 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}."
36223 #: guix-git/doc/guix.texi:20313
36225 msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes"
36229 #: guix-git/doc/guix.texi:20316
36230 msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}."
36234 #: guix-git/doc/guix.texi:20318
36235 msgid "Available @code{mailbox-configuration} fields are:"
36239 #: guix-git/doc/guix.texi:20319
36241 msgid "{@code{mailbox-configuration} parameter} string name"
36245 #: guix-git/doc/guix.texi:20321
36246 msgid "Name for this mailbox."
36250 #: guix-git/doc/guix.texi:20323
36252 msgid "{@code{mailbox-configuration} parameter} string auto"
36256 #: guix-git/doc/guix.texi:20327
36257 msgid "@samp{create} will automatically create this mailbox. @samp{subscribe} will both create and subscribe to the mailbox. Defaults to @samp{\"no\"}."
36261 #: guix-git/doc/guix.texi:20329
36263 msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use"
36267 #: guix-git/doc/guix.texi:20334
36268 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{()}."
36272 #: guix-git/doc/guix.texi:20340
36274 msgid "{@code{dovecot-configuration} parameter} file-name base-dir"
36278 #: guix-git/doc/guix.texi:20343
36279 msgid "Base directory where to store runtime data. Defaults to @samp{\"/var/run/dovecot/\"}."
36283 #: guix-git/doc/guix.texi:20345
36285 msgid "{@code{dovecot-configuration} parameter} string login-greeting"
36289 #: guix-git/doc/guix.texi:20348
36290 msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}."
36294 #: guix-git/doc/guix.texi:20350
36296 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks"
36300 #: guix-git/doc/guix.texi:20357
36301 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{()}."
36305 #: guix-git/doc/guix.texi:20359
36307 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets"
36311 #: guix-git/doc/guix.texi:20362
36312 msgid "List of login access check sockets (e.g.@: tcpwrap). Defaults to @samp{()}."
36316 #: guix-git/doc/guix.texi:20364
36318 msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?"
36322 #: guix-git/doc/guix.texi:20370
36323 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}."
36327 #: guix-git/doc/guix.texi:20372
36329 msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?"
36333 #: guix-git/doc/guix.texi:20378
36334 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}."
36338 #: guix-git/doc/guix.texi:20380
36340 msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count"
36344 #: guix-git/doc/guix.texi:20384
36345 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}."
36349 #: guix-git/doc/guix.texi:20386
36351 msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path"
36355 #: guix-git/doc/guix.texi:20389
36356 msgid "UNIX socket or host:port used for connecting to doveadm server. Defaults to @samp{\"doveadm-server\"}."
36360 #: guix-git/doc/guix.texi:20391
36362 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment"
36366 #: guix-git/doc/guix.texi:20395
36367 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."
36371 #: guix-git/doc/guix.texi:20397
36373 msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?"
36377 #: guix-git/doc/guix.texi:20404
36378 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}."
36382 #: guix-git/doc/guix.texi:20406
36384 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size"
36388 #: guix-git/doc/guix.texi:20411
36389 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}."
36393 #: guix-git/doc/guix.texi:20413
36395 msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl"
36399 #: guix-git/doc/guix.texi:20421
36400 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\"}."
36404 #: guix-git/doc/guix.texi:20423
36406 msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl"
36410 #: guix-git/doc/guix.texi:20427
36411 msgid "TTL for negative hits (user not found, password mismatch). 0 disables caching them completely. Defaults to @samp{\"1 hour\"}."
36415 #: guix-git/doc/guix.texi:20429
36417 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms"
36421 #: guix-git/doc/guix.texi:20435
36422 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{()}."
36426 #: guix-git/doc/guix.texi:20437
36428 msgid "{@code{dovecot-configuration} parameter} string auth-default-realm"
36432 #: guix-git/doc/guix.texi:20442
36433 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{\"\"}."
36437 #: guix-git/doc/guix.texi:20444
36439 msgid "{@code{dovecot-configuration} parameter} string auth-username-chars"
36443 #: guix-git/doc/guix.texi:20451
36444 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.-_@@\"}."
36448 #: guix-git/doc/guix.texi:20453
36450 msgid "{@code{dovecot-configuration} parameter} string auth-username-translation"
36454 #: guix-git/doc/guix.texi:20459
36455 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{\"\"}."
36459 #: guix-git/doc/guix.texi:20461
36461 msgid "{@code{dovecot-configuration} parameter} string auth-username-format"
36465 #: guix-git/doc/guix.texi:20468
36466 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\"}."
36470 #: guix-git/doc/guix.texi:20470
36472 msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator"
36476 #: guix-git/doc/guix.texi:20478
36477 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{\"\"}."
36481 #: guix-git/doc/guix.texi:20480
36483 msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username"
36487 #: guix-git/doc/guix.texi:20484
36488 msgid "Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to @samp{\"anonymous\"}."
36492 #: guix-git/doc/guix.texi:20486
36494 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count"
36498 #: guix-git/doc/guix.texi:20491
36499 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}."
36503 #: guix-git/doc/guix.texi:20493
36505 msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname"
36509 #: guix-git/doc/guix.texi:20498
36510 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{\"\"}."
36514 #: guix-git/doc/guix.texi:20500
36516 msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab"
36520 #: guix-git/doc/guix.texi:20506
36521 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{\"\"}."
36525 #: guix-git/doc/guix.texi:20508
36527 msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?"
36531 #: guix-git/doc/guix.texi:20513
36532 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}."
36536 #: guix-git/doc/guix.texi:20515
36538 msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path"
36542 #: guix-git/doc/guix.texi:20518
36543 msgid "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/bin/ntlm_auth\"}."
36547 #: guix-git/doc/guix.texi:20520
36549 msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay"
36553 #: guix-git/doc/guix.texi:20523
36554 msgid "Time to delay before replying to failed authentications. Defaults to @samp{\"2 secs\"}."
36558 #: guix-git/doc/guix.texi:20525
36560 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?"
36564 #: guix-git/doc/guix.texi:20529
36565 msgid "Require a valid SSL client certificate or the authentication fails. Defaults to @samp{#f}."
36569 #: guix-git/doc/guix.texi:20531
36571 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?"
36575 #: guix-git/doc/guix.texi:20536
36576 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}."
36580 #: guix-git/doc/guix.texi:20538
36582 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms"
36586 #: guix-git/doc/guix.texi:20544
36587 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."
36591 #: guix-git/doc/guix.texi:20546
36593 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers"
36597 #: guix-git/doc/guix.texi:20551
36598 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{()}."
36602 #: guix-git/doc/guix.texi:20553
36604 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers"
36608 #: guix-git/doc/guix.texi:20557
36609 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{()}."
36613 #: guix-git/doc/guix.texi:20559
36615 msgid "{@code{dovecot-configuration} parameter} string director-user-expire"
36619 #: guix-git/doc/guix.texi:20563
36620 msgid "How long to redirect users to a specific server after it no longer has any connections. Defaults to @samp{\"15 min\"}."
36624 #: guix-git/doc/guix.texi:20565
36626 msgid "{@code{dovecot-configuration} parameter} string director-username-hash"
36630 #: guix-git/doc/guix.texi:20570
36631 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\"}."
36635 #: guix-git/doc/guix.texi:20572
36637 msgid "{@code{dovecot-configuration} parameter} string log-path"
36641 #: guix-git/doc/guix.texi:20576
36642 msgid "Log file to use for error messages. @samp{syslog} logs to syslog, @samp{/dev/stderr} logs to stderr. Defaults to @samp{\"syslog\"}."
36646 #: guix-git/doc/guix.texi:20578
36648 msgid "{@code{dovecot-configuration} parameter} string info-log-path"
36652 #: guix-git/doc/guix.texi:20582
36653 msgid "Log file to use for informational messages. Defaults to @samp{log-path}. Defaults to @samp{\"\"}."
36657 #: guix-git/doc/guix.texi:20584
36659 msgid "{@code{dovecot-configuration} parameter} string debug-log-path"
36663 #: guix-git/doc/guix.texi:20588
36664 msgid "Log file to use for debug messages. Defaults to @samp{info-log-path}. Defaults to @samp{\"\"}."
36668 #: guix-git/doc/guix.texi:20590
36670 msgid "{@code{dovecot-configuration} parameter} string syslog-facility"
36674 #: guix-git/doc/guix.texi:20595
36675 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\"}."
36679 #: guix-git/doc/guix.texi:20597
36681 msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?"
36685 #: guix-git/doc/guix.texi:20601
36686 msgid "Log unsuccessful authentication attempts and the reasons why they failed. Defaults to @samp{#f}."
36690 #: guix-git/doc/guix.texi:20603
36692 msgid "{@code{dovecot-configuration} parameter} string auth-verbose-passwords"
36696 #: guix-git/doc/guix.texi:20610
36697 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\"}."
36701 #: guix-git/doc/guix.texi:20612
36703 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?"
36707 #: guix-git/doc/guix.texi:20616
36708 msgid "Even more verbose logging for debugging purposes. Shows for example SQL queries. Defaults to @samp{#f}."
36712 #: guix-git/doc/guix.texi:20618
36714 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?"
36718 #: guix-git/doc/guix.texi:20623
36719 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}."
36723 #: guix-git/doc/guix.texi:20625
36725 msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?"
36729 #: guix-git/doc/guix.texi:20629
36730 msgid "Enable mail process debugging. This can help you figure out why Dovecot isn't finding your mails. Defaults to @samp{#f}."
36734 #: guix-git/doc/guix.texi:20631
36736 msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?"
36740 #: guix-git/doc/guix.texi:20634
36741 msgid "Show protocol level SSL errors. Defaults to @samp{#f}."
36745 #: guix-git/doc/guix.texi:20636
36747 msgid "{@code{dovecot-configuration} parameter} string log-timestamp"
36751 #: guix-git/doc/guix.texi:20640
36752 msgid "Prefix for each line written to log file. % codes are in strftime(3) format. Defaults to @samp{\"\\\"%b %d %H:%M:%S \\\"\"}."
36756 #: guix-git/doc/guix.texi:20642
36758 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements"
36762 #: guix-git/doc/guix.texi:20646
36763 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."
36767 #: guix-git/doc/guix.texi:20648
36769 msgid "{@code{dovecot-configuration} parameter} string login-log-format"
36773 #: guix-git/doc/guix.texi:20652
36774 msgid "Login log format. %s contains @samp{login-log-format-elements} string, %$ contains the data we want to log. Defaults to @samp{\"%$: %s\"}."
36778 #: guix-git/doc/guix.texi:20654
36780 msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix"
36784 #: guix-git/doc/guix.texi:20658
36785 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@}>: \\\"\"}."
36789 #: guix-git/doc/guix.texi:20660
36791 msgid "{@code{dovecot-configuration} parameter} string deliver-log-format"
36795 #: guix-git/doc/guix.texi:20662
36796 msgid "Format to use for logging mail deliveries. You can use variables:"
36800 #: guix-git/doc/guix.texi:20663
36806 #: guix-git/doc/guix.texi:20665
36807 msgid "Delivery status message (e.g.@: @samp{saved to INBOX})"
36811 #: guix-git/doc/guix.texi:20665
36817 #: guix-git/doc/guix.texi:20667
36822 #: guix-git/doc/guix.texi:20667 guix-git/doc/guix.texi:21199
36828 #: guix-git/doc/guix.texi:20669
36833 #: guix-git/doc/guix.texi:20669
36839 #: guix-git/doc/guix.texi:20671
36840 msgid "From address"
36844 #: guix-git/doc/guix.texi:20673
36845 msgid "Physical size"
36849 #: guix-git/doc/guix.texi:20673
36855 #: guix-git/doc/guix.texi:20675
36856 msgid "Virtual size."
36860 #: guix-git/doc/guix.texi:20677
36861 msgid "Defaults to @samp{\"msgid=%m: %$\"}."
36865 #: guix-git/doc/guix.texi:20679
36867 msgid "{@code{dovecot-configuration} parameter} string mail-location"
36871 #: guix-git/doc/guix.texi:20684
36872 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."
36876 #: guix-git/doc/guix.texi:20690
36877 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."
36881 #: guix-git/doc/guix.texi:20692
36882 msgid "There are a few special variables you can use, e.g.:"
36886 #: guix-git/doc/guix.texi:20696
36891 #: guix-git/doc/guix.texi:20696 guix-git/doc/guix.texi:21195
36897 #: guix-git/doc/guix.texi:20698
36898 msgid "user part in user@@domain, same as %u if there's no domain"
36902 #: guix-git/doc/guix.texi:20698
36908 #: guix-git/doc/guix.texi:20700
36909 msgid "domain part in user@@domain, empty if there's no domain"
36913 #: guix-git/doc/guix.texi:20700
36919 #: guix-git/doc/guix.texi:20702
36920 msgid "home director"
36924 #: guix-git/doc/guix.texi:20705
36925 msgid "See doc/wiki/Variables.txt for full list. Some examples:"
36929 #: guix-git/doc/guix.texi:20706
36931 msgid "maildir:~/Maildir"
36935 #: guix-git/doc/guix.texi:20707
36937 msgid "mbox:~/mail:INBOX=/var/mail/%u"
36941 #: guix-git/doc/guix.texi:20708
36943 msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%"
36947 #: guix-git/doc/guix.texi:20713
36949 msgid "{@code{dovecot-configuration} parameter} string mail-uid"
36953 #: guix-git/doc/guix.texi:20718
36954 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{\"\"}."
36958 #: guix-git/doc/guix.texi:20720
36960 msgid "{@code{dovecot-configuration} parameter} string mail-gid"
36964 #: guix-git/doc/guix.texi:20725
36966 msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group"
36970 #: guix-git/doc/guix.texi:20731
36971 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{\"\"}."
36975 #: guix-git/doc/guix.texi:20733
36977 msgid "{@code{dovecot-configuration} parameter} string mail-access-groups"
36981 #: guix-git/doc/guix.texi:20741
36982 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{\"\"}."
36986 #: guix-git/doc/guix.texi:20743
36988 msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?"
36992 #: guix-git/doc/guix.texi:20749
36993 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}."
36997 #: guix-git/doc/guix.texi:20751
36999 msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?"
37003 #: guix-git/doc/guix.texi:20755
37004 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}."
37008 #: guix-git/doc/guix.texi:20757
37010 msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?"
37014 #: guix-git/doc/guix.texi:20762
37015 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}."
37019 #: guix-git/doc/guix.texi:20764
37021 msgid "{@code{dovecot-configuration} parameter} string mail-fsync"
37025 #: guix-git/doc/guix.texi:20766
37026 msgid "When to use fsync() or fdatasync() calls:"
37030 #: guix-git/doc/guix.texi:20767
37036 #: guix-git/doc/guix.texi:20769
37037 msgid "Whenever necessary to avoid losing important data"
37041 #: guix-git/doc/guix.texi:20771
37042 msgid "Useful with e.g.@: NFS when @code{write()}s are delayed"
37046 #: guix-git/doc/guix.texi:20773
37047 msgid "Never use it (best performance, but crashes can lose data)."
37051 #: guix-git/doc/guix.texi:20775
37052 msgid "Defaults to @samp{\"optimized\"}."
37056 #: guix-git/doc/guix.texi:20777
37058 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?"
37062 #: guix-git/doc/guix.texi:20782
37063 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}."
37067 #: guix-git/doc/guix.texi:20784
37069 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?"
37073 #: guix-git/doc/guix.texi:20788
37074 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}."
37078 #: guix-git/doc/guix.texi:20790
37080 msgid "{@code{dovecot-configuration} parameter} string lock-method"
37084 #: guix-git/doc/guix.texi:20796
37085 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\"}."
37089 #: guix-git/doc/guix.texi:20798
37091 msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir"
37095 #: guix-git/doc/guix.texi:20802
37096 msgid "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to @samp{\"/tmp\"}."
37100 #: guix-git/doc/guix.texi:20804
37102 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid"
37106 #: guix-git/doc/guix.texi:20810
37107 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}."
37111 #: guix-git/doc/guix.texi:20812
37113 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid"
37117 #: guix-git/doc/guix.texi:20817
37119 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid"
37123 #: guix-git/doc/guix.texi:20822
37124 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}."
37128 #: guix-git/doc/guix.texi:20824
37130 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid"
37134 #: guix-git/doc/guix.texi:20829
37136 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length"
37140 #: guix-git/doc/guix.texi:20833
37141 msgid "Maximum allowed length for mail keyword name. It's only forced when trying to create new keywords. Defaults to @samp{50}."
37145 #: guix-git/doc/guix.texi:20835
37147 msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs"
37151 #: guix-git/doc/guix.texi:20845
37152 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{()}."
37156 #: guix-git/doc/guix.texi:20847
37158 msgid "{@code{dovecot-configuration} parameter} string mail-chroot"
37162 #: guix-git/doc/guix.texi:20856
37163 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{\"\"}."
37167 #: guix-git/doc/guix.texi:20858
37169 msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path"
37173 #: guix-git/doc/guix.texi:20862
37174 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\"}."
37178 #: guix-git/doc/guix.texi:20864
37180 msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir"
37184 #: guix-git/doc/guix.texi:20867
37185 msgid "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/dovecot\"}."
37189 #: guix-git/doc/guix.texi:20869
37191 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins"
37195 #: guix-git/doc/guix.texi:20873
37196 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{()}."
37200 #: guix-git/doc/guix.texi:20875
37202 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count"
37206 #: guix-git/doc/guix.texi:20880
37207 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}."
37211 #: guix-git/doc/guix.texi:20882
37213 msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval"
37217 #: guix-git/doc/guix.texi:20889
37218 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\"}."
37222 #: guix-git/doc/guix.texi:20891
37224 msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?"
37228 #: guix-git/doc/guix.texi:20898
37229 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}."
37233 #: guix-git/doc/guix.texi:20900
37235 msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?"
37239 #: guix-git/doc/guix.texi:20908
37240 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}."
37244 #: guix-git/doc/guix.texi:20910
37246 msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?"
37250 #: guix-git/doc/guix.texi:20915
37251 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}."
37255 #: guix-git/doc/guix.texi:20917
37257 msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?"
37261 #: guix-git/doc/guix.texi:20922
37262 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}."
37266 #: guix-git/doc/guix.texi:20924
37268 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks"
37272 #: guix-git/doc/guix.texi:20927
37273 msgid "Which locking methods to use for locking mbox. There are four available:"
37277 #: guix-git/doc/guix.texi:20929
37283 #: guix-git/doc/guix.texi:20933
37284 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."
37288 #: guix-git/doc/guix.texi:20933
37290 msgid "dotlock-try"
37294 #: guix-git/doc/guix.texi:20936
37295 msgid "Same as dotlock, but if it fails because of permissions or because there isn't enough disk space, just skip it."
37299 #: guix-git/doc/guix.texi:20936
37305 #: guix-git/doc/guix.texi:20938
37306 msgid "Use this if possible. Works with NFS too if lockd is used."
37310 #: guix-git/doc/guix.texi:20938
37316 #: guix-git/doc/guix.texi:20940 guix-git/doc/guix.texi:20942
37317 msgid "May not exist in all systems. Doesn't work with NFS."
37321 #: guix-git/doc/guix.texi:20940
37327 #: guix-git/doc/guix.texi:20948
37328 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."
37332 #: guix-git/doc/guix.texi:20950
37334 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks"
37338 #: guix-git/doc/guix.texi:20954
37340 msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout"
37344 #: guix-git/doc/guix.texi:20957
37345 msgid "Maximum time to wait for lock (all of them) before aborting. Defaults to @samp{\"5 mins\"}."
37349 #: guix-git/doc/guix.texi:20959
37351 msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout"
37355 #: guix-git/doc/guix.texi:20963
37356 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\"}."
37360 #: guix-git/doc/guix.texi:20965
37362 msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?"
37366 #: guix-git/doc/guix.texi:20976
37367 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}."
37371 #: guix-git/doc/guix.texi:20978
37373 msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?"
37377 #: guix-git/doc/guix.texi:20983
37378 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}."
37382 #: guix-git/doc/guix.texi:20985
37384 msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?"
37388 #: guix-git/doc/guix.texi:20991
37389 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}."
37393 #: guix-git/doc/guix.texi:20993
37395 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size"
37399 #: guix-git/doc/guix.texi:20998
37400 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}."
37404 #: guix-git/doc/guix.texi:21000
37406 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size"
37410 #: guix-git/doc/guix.texi:21003
37411 msgid "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}."
37415 #: guix-git/doc/guix.texi:21005
37417 msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval"
37421 #: guix-git/doc/guix.texi:21010
37422 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\"}."
37426 #: guix-git/doc/guix.texi:21012
37428 msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?"
37432 #: guix-git/doc/guix.texi:21017
37433 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}."
37437 #: guix-git/doc/guix.texi:21019
37439 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir"
37443 #: guix-git/doc/guix.texi:21023
37444 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."
37448 #: guix-git/doc/guix.texi:21025
37449 msgid "WARNING: This feature hasn't been tested much yet. Use at your own risk."
37453 #: guix-git/doc/guix.texi:21028
37454 msgid "Directory root where to store mail attachments. Disabled, if empty. Defaults to @samp{\"\"}."
37458 #: guix-git/doc/guix.texi:21030
37460 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size"
37464 #: guix-git/doc/guix.texi:21035
37465 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}."
37469 #: guix-git/doc/guix.texi:21037
37471 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs"
37475 #: guix-git/doc/guix.texi:21039
37476 msgid "File system backend to use for saving attachments:"
37480 #: guix-git/doc/guix.texi:21040
37486 #: guix-git/doc/guix.texi:21042
37487 msgid "No SiS done by Dovecot (but this might help FS's own deduplication)"
37491 #: guix-git/doc/guix.texi:21042
37497 #: guix-git/doc/guix.texi:21044
37498 msgid "SiS with immediate byte-by-byte comparison during saving"
37502 #: guix-git/doc/guix.texi:21044
37504 msgid "sis-queue posix"
37508 #: guix-git/doc/guix.texi:21046
37509 msgid "SiS with delayed comparison and deduplication."
37513 #: guix-git/doc/guix.texi:21048
37514 msgid "Defaults to @samp{\"sis posix\"}."
37518 #: guix-git/doc/guix.texi:21050
37520 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash"
37524 #: guix-git/doc/guix.texi:21056
37525 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@}\"}."
37529 #: guix-git/doc/guix.texi:21058
37531 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit"
37535 #: guix-git/doc/guix.texi:21063
37537 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit"
37541 #: guix-git/doc/guix.texi:21066 guix-git/doc/guix.texi:28386
37542 msgid "Defaults to @samp{1000}."
37546 #: guix-git/doc/guix.texi:21068
37548 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit"
37552 #: guix-git/doc/guix.texi:21073
37553 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}."
37557 #: guix-git/doc/guix.texi:21075
37559 msgid "{@code{dovecot-configuration} parameter} string default-login-user"
37563 #: guix-git/doc/guix.texi:21080
37564 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\"}."
37568 #: guix-git/doc/guix.texi:21082
37570 msgid "{@code{dovecot-configuration} parameter} string default-internal-user"
37574 #: guix-git/doc/guix.texi:21087
37575 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\"}."
37579 #: guix-git/doc/guix.texi:21089
37581 msgid "{@code{dovecot-configuration} parameter} string ssl?"
37585 #: guix-git/doc/guix.texi:21092
37586 msgid "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to @samp{\"required\"}."
37590 #: guix-git/doc/guix.texi:21094
37592 msgid "{@code{dovecot-configuration} parameter} string ssl-cert"
37596 #: guix-git/doc/guix.texi:21097
37597 msgid "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\"</etc/dovecot/default.pem\"}."
37601 #: guix-git/doc/guix.texi:21099
37603 msgid "{@code{dovecot-configuration} parameter} string ssl-key"
37607 #: guix-git/doc/guix.texi:21104
37608 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\"}."
37612 #: guix-git/doc/guix.texi:21106
37614 msgid "{@code{dovecot-configuration} parameter} string ssl-key-password"
37618 #: guix-git/doc/guix.texi:21112
37619 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{\"\"}."
37623 #: guix-git/doc/guix.texi:21114
37625 msgid "{@code{dovecot-configuration} parameter} string ssl-ca"
37629 #: guix-git/doc/guix.texi:21120
37630 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{\"\"}."
37634 #: guix-git/doc/guix.texi:21122
37636 msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?"
37640 #: guix-git/doc/guix.texi:21125
37641 msgid "Require that CRL check succeeds for client certificates. Defaults to @samp{#t}."
37645 #: guix-git/doc/guix.texi:21127
37647 msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?"
37651 #: guix-git/doc/guix.texi:21131
37652 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}."
37656 #: guix-git/doc/guix.texi:21133
37658 msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field"
37662 #: guix-git/doc/guix.texi:21138
37663 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\"}."
37667 #: guix-git/doc/guix.texi:21140
37669 msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol"
37673 #: guix-git/doc/guix.texi:21143
37674 msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}."
37678 #: guix-git/doc/guix.texi:21145
37680 msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list"
37684 #: guix-git/doc/guix.texi:21148
37685 msgid "SSL ciphers to use. Defaults to @samp{\"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH\"}."
37689 #: guix-git/doc/guix.texi:21150
37691 msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device"
37695 #: guix-git/doc/guix.texi:21153
37696 msgid "SSL crypto device to use, for valid values run \"openssl engine\". Defaults to @samp{\"\"}."
37700 #: guix-git/doc/guix.texi:21155
37702 msgid "{@code{dovecot-configuration} parameter} string postmaster-address"
37706 #: guix-git/doc/guix.texi:21159
37707 msgid "Address to use when sending rejection mails. %d expands to recipient domain. Defaults to @samp{\"postmaster@@%d\"}."
37711 #: guix-git/doc/guix.texi:21161
37713 msgid "{@code{dovecot-configuration} parameter} string hostname"
37717 #: guix-git/doc/guix.texi:21165
37718 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{\"\"}."
37722 #: guix-git/doc/guix.texi:21167
37724 msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?"
37728 #: guix-git/doc/guix.texi:21171
37729 msgid "If user is over quota, return with temporary failure instead of bouncing the mail. Defaults to @samp{#f}."
37733 #: guix-git/doc/guix.texi:21173
37735 msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path"
37739 #: guix-git/doc/guix.texi:21176
37740 msgid "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}."
37744 #: guix-git/doc/guix.texi:21178
37746 msgid "{@code{dovecot-configuration} parameter} string submission-host"
37750 #: guix-git/doc/guix.texi:21182
37751 msgid "If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to @samp{\"\"}."
37755 #: guix-git/doc/guix.texi:21184
37757 msgid "{@code{dovecot-configuration} parameter} string rejection-subject"
37761 #: guix-git/doc/guix.texi:21188
37762 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\"}."
37766 #: guix-git/doc/guix.texi:21190
37768 msgid "{@code{dovecot-configuration} parameter} string rejection-reason"
37772 #: guix-git/doc/guix.texi:21193
37773 msgid "Human readable error message for rejection mails. You can use variables:"
37777 #: guix-git/doc/guix.texi:21197
37782 #: guix-git/doc/guix.texi:21197
37788 #: guix-git/doc/guix.texi:21199
37793 #: guix-git/doc/guix.texi:21201
37794 msgid "original subject"
37798 #: guix-git/doc/guix.texi:21201
37804 #: guix-git/doc/guix.texi:21203
37809 #: guix-git/doc/guix.texi:21205
37810 msgid "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}."
37814 #: guix-git/doc/guix.texi:21207
37816 msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter"
37820 #: guix-git/doc/guix.texi:21211
37821 msgid "Delimiter character between local-part and detail in email address. Defaults to @samp{\"+\"}."
37825 #: guix-git/doc/guix.texi:21213
37827 msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header"
37831 #: guix-git/doc/guix.texi:21219
37832 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{\"\"}."
37836 #: guix-git/doc/guix.texi:21221
37838 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?"
37842 #: guix-git/doc/guix.texi:21225
37843 msgid "Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to @samp{#f}."
37847 #: guix-git/doc/guix.texi:21227
37849 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?"
37853 #: guix-git/doc/guix.texi:21231
37854 msgid "Should automatically created mailboxes be also automatically subscribed?. Defaults to @samp{#f}."
37858 #: guix-git/doc/guix.texi:21233
37860 msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length"
37864 #: guix-git/doc/guix.texi:21239
37865 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}."
37869 #: guix-git/doc/guix.texi:21241
37871 msgid "{@code{dovecot-configuration} parameter} string imap-logout-format"
37875 #: guix-git/doc/guix.texi:21243
37876 msgid "IMAP logout format string:"
37880 #: guix-git/doc/guix.texi:21244
37886 #: guix-git/doc/guix.texi:21246
37887 msgid "total number of bytes read from client"
37891 #: guix-git/doc/guix.texi:21246
37897 #: guix-git/doc/guix.texi:21248
37898 msgid "total number of bytes sent to client."
37902 #: guix-git/doc/guix.texi:21251
37903 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@}\"}."
37907 #: guix-git/doc/guix.texi:21253
37909 msgid "{@code{dovecot-configuration} parameter} string imap-capability"
37913 #: guix-git/doc/guix.texi:21257
37914 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{\"\"}."
37918 #: guix-git/doc/guix.texi:21259
37920 msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval"
37924 #: guix-git/doc/guix.texi:21263
37925 msgid "How long to wait between \"OK Still here\" notifications when client is IDLEing. Defaults to @samp{\"2 mins\"}."
37929 #: guix-git/doc/guix.texi:21265
37931 msgid "{@code{dovecot-configuration} parameter} string imap-id-send"
37935 #: guix-git/doc/guix.texi:21271
37936 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{\"\"}."
37940 #: guix-git/doc/guix.texi:21273
37942 msgid "{@code{dovecot-configuration} parameter} string imap-id-log"
37946 #: guix-git/doc/guix.texi:21276
37947 msgid "ID fields sent by client to log. * means everything. Defaults to @samp{\"\"}."
37951 #: guix-git/doc/guix.texi:21278
37953 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds"
37957 #: guix-git/doc/guix.texi:21280
37958 msgid "Workarounds for various client bugs:"
37962 #: guix-git/doc/guix.texi:21282
37964 msgid "delay-newmail"
37968 #: guix-git/doc/guix.texi:21289
37969 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\"."
37973 #: guix-git/doc/guix.texi:21290
37975 msgid "tb-extra-mailbox-sep"
37979 #: guix-git/doc/guix.texi:21294
37980 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."
37984 #: guix-git/doc/guix.texi:21295
37986 msgid "tb-lsub-flags"
37990 #: guix-git/doc/guix.texi:21299
37991 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."
37995 #: guix-git/doc/guix.texi:21303
37997 msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host"
38001 #: guix-git/doc/guix.texi:21306
38002 msgid "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to @samp{\"\"}."
38005 #. type: Plain text
38006 #: guix-git/doc/guix.texi:21314
38007 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."
38010 #. type: Plain text
38011 #: guix-git/doc/guix.texi:21320
38012 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."
38015 #. type: Plain text
38016 #: guix-git/doc/guix.texi:21322
38017 msgid "Available @code{opaque-dovecot-configuration} fields are:"
38021 #: guix-git/doc/guix.texi:21323
38023 msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot"
38027 #: guix-git/doc/guix.texi:21327
38029 msgid "{@code{opaque-dovecot-configuration} parameter} string string"
38033 #: guix-git/doc/guix.texi:21329
38034 msgid "The contents of the @code{dovecot.conf}, as a string."
38037 #. type: Plain text
38038 #: guix-git/doc/guix.texi:21333
38039 msgid "For example, if your @code{dovecot.conf} is just the empty string, you could instantiate a dovecot service like this:"
38043 #: guix-git/doc/guix.texi:21338
38046 "(dovecot-service #:config\n"
38047 " (opaque-dovecot-configuration\n"
38048 " (string \"\")))\n"
38051 #. type: subsubheading
38052 #: guix-git/doc/guix.texi:21340
38054 msgid "OpenSMTPD Service"
38058 #: guix-git/doc/guix.texi:21342
38060 msgid "{Scheme Variable} opensmtpd-service-type"
38064 #: guix-git/doc/guix.texi:21346
38065 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:"
38069 #: guix-git/doc/guix.texi:21351
38072 "(service opensmtpd-service-type\n"
38073 " (opensmtpd-configuration\n"
38074 " (config-file (local-file \"./my-smtpd.conf\"))))\n"
38078 #: guix-git/doc/guix.texi:21354
38080 msgid "{Data Type} opensmtpd-configuration"
38084 #: guix-git/doc/guix.texi:21356
38085 msgid "Data type representing the configuration of opensmtpd."
38089 #: guix-git/doc/guix.texi:21358
38091 msgid "@code{package} (default: @var{opensmtpd})"
38095 #: guix-git/doc/guix.texi:21360
38096 msgid "Package object of the OpenSMTPD SMTP server."
38100 #: guix-git/doc/guix.texi:21361
38102 msgid "@code{config-file} (default: @code{%default-opensmtpd-file})"
38106 #: guix-git/doc/guix.texi:21366
38107 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."
38110 #. type: subsubheading
38111 #: guix-git/doc/guix.texi:21370
38113 msgid "Exim Service"
38117 #: guix-git/doc/guix.texi:21372
38119 msgid "mail transfer agent (MTA)"
38123 #: guix-git/doc/guix.texi:21373
38125 msgid "MTA (mail transfer agent)"
38129 #: guix-git/doc/guix.texi:21374
38135 #: guix-git/doc/guix.texi:21376
38137 msgid "{Scheme Variable} exim-service-type"
38141 #: guix-git/doc/guix.texi:21380
38142 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:"
38146 #: guix-git/doc/guix.texi:21385
38149 "(service exim-service-type\n"
38150 " (exim-configuration\n"
38151 " (config-file (local-file \"./my-exim.conf\"))))\n"
38154 #. type: Plain text
38155 #: guix-git/doc/guix.texi:21391
38156 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)."
38160 #: guix-git/doc/guix.texi:21392
38162 msgid "{Data Type} exim-configuration"
38166 #: guix-git/doc/guix.texi:21394
38167 msgid "Data type representing the configuration of exim."
38171 #: guix-git/doc/guix.texi:21396
38173 msgid "@code{package} (default: @var{exim})"
38177 #: guix-git/doc/guix.texi:21398
38178 msgid "Package object of the Exim server."
38182 #: guix-git/doc/guix.texi:21405
38183 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."
38186 #. type: subsubheading
38187 #: guix-git/doc/guix.texi:21409
38189 msgid "Getmail service"
38193 #: guix-git/doc/guix.texi:21411
38199 #: guix-git/doc/guix.texi:21412
38205 #: guix-git/doc/guix.texi:21414
38207 msgid "{Scheme Variable} getmail-service-type"
38211 #: guix-git/doc/guix.texi:21417
38212 msgid "This is the type of the @uref{http://pyropus.ca/software/getmail/, Getmail} mail retriever, whose value should be an @code{getmail-configuration}."
38215 #. type: Plain text
38216 #: guix-git/doc/guix.texi:21420
38217 msgid "Available @code{getmail-configuration} fields are:"
38221 #: guix-git/doc/guix.texi:21421
38223 msgid "{@code{getmail-configuration} parameter} symbol name"
38227 #: guix-git/doc/guix.texi:21423
38228 msgid "A symbol to identify the getmail service."
38232 #: guix-git/doc/guix.texi:21425
38233 msgid "Defaults to @samp{\"unset\"}."
38237 #: guix-git/doc/guix.texi:21428
38239 msgid "{@code{getmail-configuration} parameter} package package"
38243 #: guix-git/doc/guix.texi:21430
38244 msgid "The getmail package to use."
38248 #: guix-git/doc/guix.texi:21433
38250 msgid "{@code{getmail-configuration} parameter} string user"
38254 #: guix-git/doc/guix.texi:21435
38255 msgid "The user to run getmail as."
38259 #: guix-git/doc/guix.texi:21437 guix-git/doc/guix.texi:21444
38260 msgid "Defaults to @samp{\"getmail\"}."
38264 #: guix-git/doc/guix.texi:21440
38266 msgid "{@code{getmail-configuration} parameter} string group"
38270 #: guix-git/doc/guix.texi:21442
38271 msgid "The group to run getmail as."
38275 #: guix-git/doc/guix.texi:21447
38277 msgid "{@code{getmail-configuration} parameter} string directory"
38281 #: guix-git/doc/guix.texi:21449
38282 msgid "The getmail directory to use."
38286 #: guix-git/doc/guix.texi:21451
38287 msgid "Defaults to @samp{\"/var/lib/getmail/default\"}."
38291 #: guix-git/doc/guix.texi:21454
38293 msgid "{@code{getmail-configuration} parameter} getmail-configuration-file rcfile"
38297 #: guix-git/doc/guix.texi:21456
38298 msgid "The getmail configuration file to use."
38302 #: guix-git/doc/guix.texi:21458
38303 msgid "Available @code{getmail-configuration-file} fields are:"
38307 #: guix-git/doc/guix.texi:21459
38309 msgid "{@code{getmail-configuration-file} parameter} getmail-retriever-configuration retriever"
38313 #: guix-git/doc/guix.texi:21461
38314 msgid "What mail account to retrieve mail from, and how to access that account."
38318 #: guix-git/doc/guix.texi:21463
38319 msgid "Available @code{getmail-retriever-configuration} fields are:"
38323 #: guix-git/doc/guix.texi:21464
38325 msgid "{@code{getmail-retriever-configuration} parameter} string type"
38329 #: guix-git/doc/guix.texi:21467
38330 msgid "The type of mail retriever to use. Valid values include @samp{passwd} and @samp{static}."
38334 #: guix-git/doc/guix.texi:21469
38335 msgid "Defaults to @samp{\"SimpleIMAPSSLRetriever\"}."
38339 #: guix-git/doc/guix.texi:21472
38341 msgid "{@code{getmail-retriever-configuration} parameter} string server"
38345 #: guix-git/doc/guix.texi:21474 guix-git/doc/guix.texi:21481
38346 msgid "Username to login to the mail server with."
38350 #: guix-git/doc/guix.texi:21476 guix-git/doc/guix.texi:21483
38351 #: guix-git/doc/guix.texi:21547
38352 msgid "Defaults to @samp{unset}."
38356 #: guix-git/doc/guix.texi:21479
38358 msgid "{@code{getmail-retriever-configuration} parameter} string username"
38362 #: guix-git/doc/guix.texi:21486
38364 msgid "{@code{getmail-retriever-configuration} parameter} non-negative-integer port"
38368 #: guix-git/doc/guix.texi:21488
38369 msgid "Port number to connect to."
38373 #: guix-git/doc/guix.texi:21493
38375 msgid "{@code{getmail-retriever-configuration} parameter} string password"
38379 #: guix-git/doc/guix.texi:21495 guix-git/doc/guix.texi:21502
38380 msgid "Override fields from passwd."
38384 #: guix-git/doc/guix.texi:21500
38386 msgid "{@code{getmail-retriever-configuration} parameter} list password-command"
38390 #: guix-git/doc/guix.texi:21507
38392 msgid "{@code{getmail-retriever-configuration} parameter} string keyfile"
38396 #: guix-git/doc/guix.texi:21509
38397 msgid "PEM-formatted key file to use for the TLS negotiation."
38401 #: guix-git/doc/guix.texi:21514
38403 msgid "{@code{getmail-retriever-configuration} parameter} string certfile"
38407 #: guix-git/doc/guix.texi:21516
38408 msgid "PEM-formatted certificate file to use for the TLS negotiation."
38412 #: guix-git/doc/guix.texi:21521
38414 msgid "{@code{getmail-retriever-configuration} parameter} string ca-certs"
38418 #: guix-git/doc/guix.texi:21523
38419 msgid "CA certificates to use."
38423 #: guix-git/doc/guix.texi:21528
38425 msgid "{@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters"
38429 #: guix-git/doc/guix.texi:21530
38430 msgid "Extra retriever parameters."
38434 #: guix-git/doc/guix.texi:21537
38436 msgid "{@code{getmail-configuration-file} parameter} getmail-destination-configuration destination"
38440 #: guix-git/doc/guix.texi:21539
38441 msgid "What to do with retrieved messages."
38445 #: guix-git/doc/guix.texi:21541
38446 msgid "Available @code{getmail-destination-configuration} fields are:"
38450 #: guix-git/doc/guix.texi:21542
38452 msgid "{@code{getmail-destination-configuration} parameter} string type"
38456 #: guix-git/doc/guix.texi:21545
38457 msgid "The type of mail destination. Valid values include @samp{Maildir}, @samp{Mboxrd} and @samp{MDA_external}."
38461 #: guix-git/doc/guix.texi:21550
38463 msgid "{@code{getmail-destination-configuration} parameter} string-or-filelike path"
38467 #: guix-git/doc/guix.texi:21553
38468 msgid "The path option for the mail destination. The behaviour depends on the chosen type."
38472 #: guix-git/doc/guix.texi:21558
38474 msgid "{@code{getmail-destination-configuration} parameter} parameter-alist extra-parameters"
38478 #: guix-git/doc/guix.texi:21560
38479 msgid "Extra destination parameters"
38483 #: guix-git/doc/guix.texi:21567
38485 msgid "{@code{getmail-configuration-file} parameter} getmail-options-configuration options"
38489 #: guix-git/doc/guix.texi:21569
38490 msgid "Configure getmail."
38494 #: guix-git/doc/guix.texi:21571
38495 msgid "Available @code{getmail-options-configuration} fields are:"
38499 #: guix-git/doc/guix.texi:21572
38501 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer verbose"
38505 #: guix-git/doc/guix.texi:21577
38506 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."
38510 #: guix-git/doc/guix.texi:21579 guix-git/doc/guix.texi:27856
38511 #: guix-git/doc/guix.texi:28444 guix-git/doc/guix.texi:28589
38512 msgid "Defaults to @samp{1}."
38516 #: guix-git/doc/guix.texi:21582
38518 msgid "{@code{getmail-options-configuration} parameter} boolean read-all"
38522 #: guix-git/doc/guix.texi:21585
38523 msgid "If true, getmail will retrieve all available messages. Otherwise it will only retrieve messages it hasn't seen previously."
38527 #: guix-git/doc/guix.texi:21590
38529 msgid "{@code{getmail-options-configuration} parameter} boolean delete"
38533 #: guix-git/doc/guix.texi:21594
38534 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."
38538 #: guix-git/doc/guix.texi:21599
38540 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-after"
38544 #: guix-git/doc/guix.texi:21604
38545 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."
38549 #: guix-git/doc/guix.texi:21609
38551 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-bigger-than"
38555 #: guix-git/doc/guix.texi:21613
38556 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."
38560 #: guix-git/doc/guix.texi:21618
38562 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-bytes-per-session"
38566 #: guix-git/doc/guix.texi:21621
38567 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."
38571 #: guix-git/doc/guix.texi:21626
38573 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-message-size"
38577 #: guix-git/doc/guix.texi:21629
38578 msgid "Don't retrieve messages larger than this number of bytes. A value of @samp{0} disables this feature."
38582 #: guix-git/doc/guix.texi:21634
38584 msgid "{@code{getmail-options-configuration} parameter} boolean delivered-to"
38588 #: guix-git/doc/guix.texi:21636
38589 msgid "If true, getmail will add a Delivered-To header to messages."
38593 #: guix-git/doc/guix.texi:21641
38595 msgid "{@code{getmail-options-configuration} parameter} boolean received"
38599 #: guix-git/doc/guix.texi:21643
38600 msgid "If set, getmail adds a Received header to the messages."
38604 #: guix-git/doc/guix.texi:21648
38606 msgid "{@code{getmail-options-configuration} parameter} string message-log"
38610 #: guix-git/doc/guix.texi:21651
38611 msgid "Getmail will record a log of its actions to the named file. A value of @samp{\"\"} disables this feature."
38615 #: guix-git/doc/guix.texi:21656
38617 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-syslog"
38621 #: guix-git/doc/guix.texi:21659
38622 msgid "If true, getmail will record a log of its actions using the system logger."
38626 #: guix-git/doc/guix.texi:21664
38628 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-verbose"
38632 #: guix-git/doc/guix.texi:21668
38633 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."
38637 #: guix-git/doc/guix.texi:21673
38639 msgid "{@code{getmail-options-configuration} parameter} parameter-alist extra-parameters"
38643 #: guix-git/doc/guix.texi:21675
38644 msgid "Extra options to include."
38648 #: guix-git/doc/guix.texi:21684
38650 msgid "{@code{getmail-configuration} parameter} list idle"
38654 #: guix-git/doc/guix.texi:21688
38655 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."
38659 #: guix-git/doc/guix.texi:21693
38661 msgid "{@code{getmail-configuration} parameter} list environment-variables"
38665 #: guix-git/doc/guix.texi:21695
38666 msgid "Environment variables to set for getmail."
38669 #. type: subsubheading
38670 #: guix-git/doc/guix.texi:21700
38672 msgid "Mail Aliases Service"
38676 #: guix-git/doc/guix.texi:21702
38678 msgid "email aliases"
38682 #: guix-git/doc/guix.texi:21703
38684 msgid "aliases, for email addresses"
38688 #: guix-git/doc/guix.texi:21705
38690 msgid "{Scheme Variable} mail-aliases-service-type"
38694 #: guix-git/doc/guix.texi:21708
38695 msgid "This is the type of the service which provides @code{/etc/aliases}, specifying how to deliver mail to users on this system."
38699 #: guix-git/doc/guix.texi:21713
38702 "(service mail-aliases-service-type\n"
38703 " '((\"postmaster\" \"bob\")\n"
38704 " (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n"
38707 #. type: Plain text
38708 #: guix-git/doc/guix.texi:21721
38709 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."
38712 #. type: Plain text
38713 #: guix-git/doc/guix.texi:21727
38714 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})."
38718 #: guix-git/doc/guix.texi:21728 guix-git/doc/guix.texi:21729
38720 msgid "GNU Mailutils IMAP4 Daemon"
38724 #: guix-git/doc/guix.texi:21731
38726 msgid "{Scheme Variable} imap4d-service-type"
38730 #: guix-git/doc/guix.texi:21735
38731 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:"
38735 #: guix-git/doc/guix.texi:21740
38738 "(service imap4d-service-type\n"
38739 " (imap4d-configuration\n"
38740 " (config-file (local-file \"imap4d.conf\"))))\n"
38744 #: guix-git/doc/guix.texi:21743
38746 msgid "{Data Type} imap4d-configuration"
38750 #: guix-git/doc/guix.texi:21745
38751 msgid "Data type representing the configuration of @command{imap4d}."
38755 #: guix-git/doc/guix.texi:21747
38757 msgid "@code{package} (default: @code{mailutils})"
38761 #: guix-git/doc/guix.texi:21749
38762 msgid "The package that provides @command{imap4d}."
38766 #: guix-git/doc/guix.texi:21750
38768 msgid "@code{config-file} (default: @code{%default-imap4d-config-file})"
38772 #: guix-git/doc/guix.texi:21754
38773 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."
38776 #. type: subsubheading
38777 #: guix-git/doc/guix.texi:21758
38779 msgid "Radicale Service"
38783 #: guix-git/doc/guix.texi:21759
38789 #: guix-git/doc/guix.texi:21760
38795 #: guix-git/doc/guix.texi:21762
38797 msgid "{Scheme Variable} radicale-service-type"
38801 #: guix-git/doc/guix.texi:21765
38802 msgid "This is the type of the @uref{https://radicale.org, Radicale} CalDAV/CardDAV server whose value should be a @code{radicale-configuration}."
38806 #: guix-git/doc/guix.texi:21767
38808 msgid "{Data Type} radicale-configuration"
38812 #: guix-git/doc/guix.texi:21769
38813 msgid "Data type representing the configuration of @command{radicale}."
38817 #: guix-git/doc/guix.texi:21771
38819 msgid "@code{package} (default: @code{radicale})"
38823 #: guix-git/doc/guix.texi:21773
38824 msgid "The package that provides @command{radicale}."
38828 #: guix-git/doc/guix.texi:21774
38830 msgid "@code{config-file} (default: @code{%default-radicale-config-file})"
38834 #: guix-git/doc/guix.texi:21778
38835 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."
38839 #: guix-git/doc/guix.texi:21785
38845 #: guix-git/doc/guix.texi:21786
38851 #: guix-git/doc/guix.texi:21787
38856 #. type: Plain text
38857 #: guix-git/doc/guix.texi:21791
38858 msgid "The @code{(gnu services messaging)} module provides Guix service definitions for messaging services. Currently it provides the following services:"
38861 #. type: subsubheading
38862 #: guix-git/doc/guix.texi:21792
38864 msgid "Prosody Service"
38868 #: guix-git/doc/guix.texi:21794
38870 msgid "{Scheme Variable} prosody-service-type"
38874 #: guix-git/doc/guix.texi:21798
38875 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:"
38879 #: guix-git/doc/guix.texi:21813
38882 "(service prosody-service-type\n"
38883 " (prosody-configuration\n"
38884 " (modules-enabled (cons* \"groups\" \"mam\" %default-modules-enabled))\n"
38885 " (int-components\n"
38887 " (int-component-configuration\n"
38888 " (hostname \"conference.example.net\")\n"
38889 " (plugin \"muc\")\n"
38890 " (mod-muc (mod-muc-configuration)))))\n"
38893 " (virtualhost-configuration\n"
38894 " (domain \"example.net\"))))))\n"
38898 #: guix-git/doc/guix.texi:21816
38899 msgid "See below for details about @code{prosody-configuration}."
38902 #. type: Plain text
38903 #: guix-git/doc/guix.texi:21822
38904 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."
38907 #. type: Plain text
38908 #: guix-git/doc/guix.texi:21825
38909 msgid "You can perform various sanity checks on the generated configuration with the @code{prosodyctl check} command."
38912 #. type: Plain text
38913 #: guix-git/doc/guix.texi:21829
38914 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}."
38918 #: guix-git/doc/guix.texi:21832
38920 msgid "prosodyctl --root cert import /etc/letsencrypt/live\n"
38923 #. type: Plain text
38924 #: guix-git/doc/guix.texi:21839
38925 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}."
38928 #. type: Plain text
38929 #: guix-git/doc/guix.texi:21843
38930 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."
38933 #. type: Plain text
38934 #: guix-git/doc/guix.texi:21846
38935 msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a file name."
38938 #. type: Plain text
38939 #: guix-git/doc/guix.texi:21856
38940 msgid "Available @code{prosody-configuration} fields are:"
38944 #: guix-git/doc/guix.texi:21857
38946 msgid "{@code{prosody-configuration} parameter} package prosody"
38950 #: guix-git/doc/guix.texi:21859
38951 msgid "The Prosody package."
38955 #: guix-git/doc/guix.texi:21861
38957 msgid "{@code{prosody-configuration} parameter} file-name data-path"
38961 #: guix-git/doc/guix.texi:21865
38962 msgid "Location of the Prosody data storage directory. See @url{https://prosody.im/doc/configure}. Defaults to @samp{\"/var/lib/prosody\"}."
38966 #: guix-git/doc/guix.texi:21867
38968 msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths"
38972 #: guix-git/doc/guix.texi:21871
38973 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{()}."
38977 #: guix-git/doc/guix.texi:21873
38979 msgid "{@code{prosody-configuration} parameter} file-name certificates"
38983 #: guix-git/doc/guix.texi:21878
38984 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\"}."
38988 #: guix-git/doc/guix.texi:21880
38990 msgid "{@code{prosody-configuration} parameter} string-list admins"
38994 #: guix-git/doc/guix.texi:21886
38995 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{()}."
38999 #: guix-git/doc/guix.texi:21888
39001 msgid "{@code{prosody-configuration} parameter} boolean use-libevent?"
39005 #: guix-git/doc/guix.texi:21892
39006 msgid "Enable use of libevent for better performance under high load. See @url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}."
39010 #: guix-git/doc/guix.texi:21894
39012 msgid "{@code{prosody-configuration} parameter} module-list modules-enabled"
39016 #: guix-git/doc/guix.texi:21900
39017 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\")}."
39021 #: guix-git/doc/guix.texi:21902
39023 msgid "{@code{prosody-configuration} parameter} string-list modules-disabled"
39027 #: guix-git/doc/guix.texi:21906
39028 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{()}."
39032 #: guix-git/doc/guix.texi:21908
39034 msgid "{@code{prosody-configuration} parameter} file-object groups-file"
39038 #: guix-git/doc/guix.texi:21913
39039 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\"}."
39043 #: guix-git/doc/guix.texi:21915
39045 msgid "{@code{prosody-configuration} parameter} boolean allow-registration?"
39049 #: guix-git/doc/guix.texi:21919
39050 msgid "Disable account creation by default, for security. See @url{https://prosody.im/doc/creating_accounts}. Defaults to @samp{#f}."
39054 #: guix-git/doc/guix.texi:21921
39056 msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl"
39060 #: guix-git/doc/guix.texi:21926
39061 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}."
39065 #: guix-git/doc/guix.texi:21928
39066 msgid "Available @code{ssl-configuration} fields are:"
39070 #: guix-git/doc/guix.texi:21929
39072 msgid "{@code{ssl-configuration} parameter} maybe-string protocol"
39076 #: guix-git/doc/guix.texi:21931
39077 msgid "This determines what handshake to use."
39081 #: guix-git/doc/guix.texi:21933
39083 msgid "{@code{ssl-configuration} parameter} maybe-file-name key"
39087 #: guix-git/doc/guix.texi:21935
39088 msgid "Path to your private key file."
39092 #: guix-git/doc/guix.texi:21937
39094 msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate"
39098 #: guix-git/doc/guix.texi:21939
39099 msgid "Path to your certificate file."
39103 #: guix-git/doc/guix.texi:21941
39105 msgid "{@code{ssl-configuration} parameter} file-object capath"
39109 #: guix-git/doc/guix.texi:21945
39110 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\"}."
39114 #: guix-git/doc/guix.texi:21947
39116 msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile"
39120 #: guix-git/doc/guix.texi:21950
39121 msgid "Path to a file containing root certificates that you wish Prosody to trust. Similar to @code{capath} but with all certificates concatenated together."
39125 #: guix-git/doc/guix.texi:21952
39127 msgid "{@code{ssl-configuration} parameter} maybe-string-list verify"
39131 #: guix-git/doc/guix.texi:21955
39132 msgid "A list of verification options (these mostly map to OpenSSL's @code{set_verify()} flags)."
39136 #: guix-git/doc/guix.texi:21957
39138 msgid "{@code{ssl-configuration} parameter} maybe-string-list options"
39142 #: guix-git/doc/guix.texi:21961
39143 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."
39147 #: guix-git/doc/guix.texi:21963
39149 msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth"
39153 #: guix-git/doc/guix.texi:21966
39154 msgid "How long a chain of certificate authorities to check when looking for a trusted root certificate."
39158 #: guix-git/doc/guix.texi:21968
39160 msgid "{@code{ssl-configuration} parameter} maybe-string ciphers"
39164 #: guix-git/doc/guix.texi:21971
39165 msgid "An OpenSSL cipher string. This selects what ciphers Prosody will offer to clients, and in what order."
39169 #: guix-git/doc/guix.texi:21973
39171 msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam"
39175 #: guix-git/doc/guix.texi:21977
39176 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}"
39180 #: guix-git/doc/guix.texi:21979
39182 msgid "{@code{ssl-configuration} parameter} maybe-string curve"
39186 #: guix-git/doc/guix.texi:21982
39187 msgid "Curve for Elliptic curve Diffie-Hellman. Prosody's default is @samp{\"secp384r1\"}."
39191 #: guix-git/doc/guix.texi:21984
39193 msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext"
39197 #: guix-git/doc/guix.texi:21986
39198 msgid "A list of ``extra'' verification options."
39202 #: guix-git/doc/guix.texi:21988
39204 msgid "{@code{ssl-configuration} parameter} maybe-string password"
39208 #: guix-git/doc/guix.texi:21990
39209 msgid "Password for encrypted private keys."
39213 #: guix-git/doc/guix.texi:21994
39215 msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?"
39219 #: guix-git/doc/guix.texi:21998
39220 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}."
39224 #: guix-git/doc/guix.texi:22000
39226 msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms"
39230 #: guix-git/doc/guix.texi:22004
39231 msgid "Set of mechanisms that will never be offered. See @url{https://prosody.im/doc/modules/mod_saslauth}. Defaults to @samp{(\"DIGEST-MD5\")}."
39235 #: guix-git/doc/guix.texi:22006
39237 msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?"
39241 #: guix-git/doc/guix.texi:22010
39242 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}."
39246 #: guix-git/doc/guix.texi:22012
39248 msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?"
39252 #: guix-git/doc/guix.texi:22018
39253 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}."
39257 #: guix-git/doc/guix.texi:22020
39259 msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains"
39263 #: guix-git/doc/guix.texi:22026
39264 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{()}."
39268 #: guix-git/doc/guix.texi:22028
39270 msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains"
39274 #: guix-git/doc/guix.texi:22033
39275 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{()}."
39279 #: guix-git/doc/guix.texi:22035
39281 msgid "{@code{prosody-configuration} parameter} string authentication"
39285 #: guix-git/doc/guix.texi:22043
39286 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\"}."
39290 #: guix-git/doc/guix.texi:22045
39292 msgid "{@code{prosody-configuration} parameter} maybe-string log"
39296 #: guix-git/doc/guix.texi:22049
39297 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\"}."
39301 #: guix-git/doc/guix.texi:22051
39303 msgid "{@code{prosody-configuration} parameter} file-name pidfile"
39307 #: guix-git/doc/guix.texi:22054
39308 msgid "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. Defaults to @samp{\"/var/run/prosody/prosody.pid\"}."
39312 #: guix-git/doc/guix.texi:22056
39314 msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size"
39318 #: guix-git/doc/guix.texi:22058
39319 msgid "Maximum allowed size of the HTTP body (in bytes)."
39323 #: guix-git/doc/guix.texi:22060
39325 msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url"
39329 #: guix-git/doc/guix.texi:22065
39330 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}."
39334 #: guix-git/doc/guix.texi:22067
39336 msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts"
39340 #: guix-git/doc/guix.texi:22072
39341 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."
39345 #: guix-git/doc/guix.texi:22078
39346 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."
39350 #: guix-git/doc/guix.texi:22080
39351 msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}."
39355 #: guix-git/doc/guix.texi:22082
39356 msgid "Available @code{virtualhost-configuration} fields are:"
39360 #: guix-git/doc/guix.texi:22084 guix-git/doc/guix.texi:22106
39361 #: guix-git/doc/guix.texi:22159
39362 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:"
39366 #: guix-git/doc/guix.texi:22084
39368 msgid "{@code{virtualhost-configuration} parameter} string domain"
39372 #: guix-git/doc/guix.texi:22086
39373 msgid "Domain you wish Prosody to serve."
39377 #: guix-git/doc/guix.texi:22090
39379 msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components"
39383 #: guix-git/doc/guix.texi:22095
39384 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."
39388 #: guix-git/doc/guix.texi:22099
39389 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."
39393 #: guix-git/doc/guix.texi:22102
39394 msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
39398 #: guix-git/doc/guix.texi:22104
39399 msgid "Available @code{int-component-configuration} fields are:"
39403 #: guix-git/doc/guix.texi:22106
39405 msgid "{@code{int-component-configuration} parameter} string hostname"
39409 #: guix-git/doc/guix.texi:22108 guix-git/doc/guix.texi:22165
39410 msgid "Hostname of the component."
39414 #: guix-git/doc/guix.texi:22110
39416 msgid "{@code{int-component-configuration} parameter} string plugin"
39420 #: guix-git/doc/guix.texi:22112
39421 msgid "Plugin you wish to use for the component."
39425 #: guix-git/doc/guix.texi:22114
39427 msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc"
39431 #: guix-git/doc/guix.texi:22117
39432 msgid "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users."
39436 #: guix-git/doc/guix.texi:22121
39437 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."
39441 #: guix-git/doc/guix.texi:22123
39442 msgid "See also @url{https://prosody.im/doc/modules/mod_muc}."
39446 #: guix-git/doc/guix.texi:22125
39447 msgid "Available @code{mod-muc-configuration} fields are:"
39451 #: guix-git/doc/guix.texi:22126
39453 msgid "{@code{mod-muc-configuration} parameter} string name"
39457 #: guix-git/doc/guix.texi:22129
39458 msgid "The name to return in service discovery responses. Defaults to @samp{\"Prosody Chatrooms\"}."
39462 #: guix-git/doc/guix.texi:22131
39464 msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation"
39468 #: guix-git/doc/guix.texi:22138
39469 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}."
39473 #: guix-git/doc/guix.texi:22140
39475 msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages"
39479 #: guix-git/doc/guix.texi:22144
39480 msgid "Maximum number of history messages that will be sent to the member that has just joined the room. Defaults to @samp{20}."
39484 #: guix-git/doc/guix.texi:22150
39486 msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components"
39490 #: guix-git/doc/guix.texi:22155
39491 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{()}."
39495 #: guix-git/doc/guix.texi:22157
39496 msgid "Available @code{ext-component-configuration} fields are:"
39500 #: guix-git/doc/guix.texi:22159
39502 msgid "{@code{ext-component-configuration} parameter} string component-secret"
39506 #: guix-git/doc/guix.texi:22161
39507 msgid "Password which the component will use to log in."
39511 #: guix-git/doc/guix.texi:22163
39513 msgid "{@code{ext-component-configuration} parameter} string hostname"
39517 #: guix-git/doc/guix.texi:22169
39519 msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports"
39523 #: guix-git/doc/guix.texi:22172
39524 msgid "Port(s) Prosody listens on for component connections. Defaults to @samp{(5347)}."
39528 #: guix-git/doc/guix.texi:22174
39530 msgid "{@code{prosody-configuration} parameter} string component-interface"
39534 #: guix-git/doc/guix.texi:22177
39535 msgid "Interface Prosody listens on for component connections. Defaults to @samp{\"127.0.0.1\"}."
39539 #: guix-git/doc/guix.texi:22179
39541 msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content"
39545 #: guix-git/doc/guix.texi:22181
39546 msgid "Raw content that will be added to the configuration file."
39549 #. type: Plain text
39550 #: guix-git/doc/guix.texi:22189
39551 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:"
39555 #: guix-git/doc/guix.texi:22190
39557 msgid "{@code{opaque-prosody-configuration} parameter} package prosody"
39561 #: guix-git/doc/guix.texi:22192
39562 msgid "The prosody package."
39566 #: guix-git/doc/guix.texi:22194
39568 msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua"
39572 #: guix-git/doc/guix.texi:22196
39573 msgid "The contents of the @code{prosody.cfg.lua} to use."
39576 #. type: Plain text
39577 #: guix-git/doc/guix.texi:22200
39578 msgid "For example, if your @code{prosody.cfg.lua} is just the empty string, you could instantiate a prosody service like this:"
39582 #: guix-git/doc/guix.texi:22205
39585 "(service prosody-service-type\n"
39586 " (opaque-prosody-configuration\n"
39587 " (prosody.cfg.lua \"\")))\n"
39590 #. type: subsubheading
39591 #: guix-git/doc/guix.texi:22209
39593 msgid "BitlBee Service"
39597 #: guix-git/doc/guix.texi:22211 guix-git/doc/guix.texi:22255
39599 msgid "IRC (Internet Relay Chat)"
39603 #: guix-git/doc/guix.texi:22212
39605 msgid "IRC gateway"
39608 #. type: Plain text
39609 #: guix-git/doc/guix.texi:22215
39610 msgid "@url{https://bitlbee.org,BitlBee} is a gateway that provides an IRC interface to a variety of messaging protocols such as XMPP."
39614 #: guix-git/doc/guix.texi:22216
39616 msgid "{Scheme Variable} bitlbee-service-type"
39620 #: guix-git/doc/guix.texi:22220
39621 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)."
39625 #: guix-git/doc/guix.texi:22223
39626 msgid "To have BitlBee listen on port 6667 on localhost, add this line to your services:"
39630 #: guix-git/doc/guix.texi:22226
39632 msgid "(service bitlbee-service-type)\n"
39636 #: guix-git/doc/guix.texi:22229
39638 msgid "{Data Type} bitlbee-configuration"
39642 #: guix-git/doc/guix.texi:22231
39643 msgid "This is the configuration for BitlBee, with the following fields:"
39647 #: guix-git/doc/guix.texi:22233
39649 msgid "@code{interface} (default: @code{\"127.0.0.1\"})"
39653 #: guix-git/doc/guix.texi:22234
39655 msgid "@code{port} (default: @code{6667})"
39659 #: guix-git/doc/guix.texi:22237
39660 msgid "Listen on the network interface corresponding to the IP address specified in @var{interface}, on @var{port}."
39664 #: guix-git/doc/guix.texi:22241
39665 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."
39669 #: guix-git/doc/guix.texi:22242
39671 msgid "@code{bitlbee} (default: @code{bitlbee})"
39675 #: guix-git/doc/guix.texi:22244
39676 msgid "The BitlBee package to use."
39680 #: guix-git/doc/guix.texi:22245
39682 msgid "@code{plugins} (default: @code{'()})"
39686 #: guix-git/doc/guix.texi:22247
39687 msgid "List of plugin packages to use---e.g., @code{bitlbee-discord}."
39691 #: guix-git/doc/guix.texi:22250
39692 msgid "Configuration snippet added as-is to the BitlBee configuration file."
39695 #. type: subsubheading
39696 #: guix-git/doc/guix.texi:22253
39698 msgid "Quassel Service"
39701 #. type: Plain text
39702 #: guix-git/doc/guix.texi:22259
39703 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."
39707 #: guix-git/doc/guix.texi:22260
39709 msgid "{Scheme Variable} quassel-service-type"
39713 #: guix-git/doc/guix.texi:22264
39714 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)."
39718 #: guix-git/doc/guix.texi:22266
39720 msgid "{Data Type} quassel-configuration"
39724 #: guix-git/doc/guix.texi:22268
39725 msgid "This is the configuration for Quassel, with the following fields:"
39729 #: guix-git/doc/guix.texi:22270
39731 msgid "@code{quassel} (default: @code{quassel})"
39735 #: guix-git/doc/guix.texi:22272
39736 msgid "The Quassel package to use."
39740 #: guix-git/doc/guix.texi:22273
39742 msgid "@code{interface} (default: @code{\"::,0.0.0.0\"})"
39746 #: guix-git/doc/guix.texi:22274
39748 msgid "@code{port} (default: @code{4242})"
39752 #: guix-git/doc/guix.texi:22278
39753 msgid "Listen on the network interface(s) corresponding to the IPv4 or IPv6 interfaces specified in the comma delimited @var{interface}, on @var{port}."
39757 #: guix-git/doc/guix.texi:22279
39759 msgid "@code{loglevel} (default: @code{\"Info\"})"
39763 #: guix-git/doc/guix.texi:22282
39764 msgid "The level of logging desired. Accepted values are Debug, Info, Warning and Error."
39768 #: guix-git/doc/guix.texi:22288
39770 msgid "Murmur (VoIP server)"
39774 #: guix-git/doc/guix.texi:22289
39776 msgid "VoIP server"
39779 #. type: Plain text
39780 #: guix-git/doc/guix.texi:22293
39781 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."
39785 #: guix-git/doc/guix.texi:22294
39787 msgid "{Data Type} murmur-configuration"
39791 #: guix-git/doc/guix.texi:22297
39792 msgid "The service type for the Murmur server. An example configuration can look like this:"
39796 #: guix-git/doc/guix.texi:22306
39799 "(service murmur-service-type\n"
39800 " (murmur-configuration\n"
39802 " \"Welcome to this Mumble server running on Guix!\")\n"
39803 " (cert-required? #t) ;disallow text password logins\n"
39804 " (ssl-cert \"/etc/letsencrypt/live/mumble.example.com/fullchain.pem\")\n"
39805 " (ssl-key \"/etc/letsencrypt/live/mumble.example.com/privkey.pem\")))\n"
39809 #: guix-git/doc/guix.texi:22310
39810 msgid "After reconfiguring your system, you can manually set the murmur @code{SuperUser} password with the command that is printed during the activation phase."
39814 #: guix-git/doc/guix.texi:22319
39815 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."
39819 #: guix-git/doc/guix.texi:22321
39820 msgid "Available @code{murmur-configuration} fields are:"
39824 #: guix-git/doc/guix.texi:22323
39826 msgid "@code{package} (default: @code{mumble})"
39830 #: guix-git/doc/guix.texi:22325
39831 msgid "Package that contains @code{bin/murmurd}."
39835 #: guix-git/doc/guix.texi:22326
39837 msgid "@code{user} (default: @code{\"murmur\"})"
39841 #: guix-git/doc/guix.texi:22328
39842 msgid "User who will run the Murmur server."
39846 #: guix-git/doc/guix.texi:22329
39848 msgid "@code{group} (default: @code{\"murmur\"})"
39852 #: guix-git/doc/guix.texi:22331
39853 msgid "Group of the user who will run the murmur server."
39857 #: guix-git/doc/guix.texi:22332
39859 msgid "@code{port} (default: @code{64738})"
39863 #: guix-git/doc/guix.texi:22334
39864 msgid "Port on which the server will listen."
39868 #: guix-git/doc/guix.texi:22335
39870 msgid "@code{welcome-text} (default: @code{\"\"})"
39874 #: guix-git/doc/guix.texi:22337
39875 msgid "Welcome text sent to clients when they connect."
39879 #: guix-git/doc/guix.texi:22338
39881 msgid "@code{server-password} (default: @code{\"\"})"
39885 #: guix-git/doc/guix.texi:22340
39886 msgid "Password the clients have to enter in order to connect."
39890 #: guix-git/doc/guix.texi:22341
39892 msgid "@code{max-users} (default: @code{100})"
39896 #: guix-git/doc/guix.texi:22343
39897 msgid "Maximum of users that can be connected to the server at once."
39901 #: guix-git/doc/guix.texi:22344
39903 msgid "@code{max-user-bandwidth} (default: @code{#f})"
39907 #: guix-git/doc/guix.texi:22346
39908 msgid "Maximum voice traffic a user can send per second."
39912 #: guix-git/doc/guix.texi:22347
39914 msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})"
39918 #: guix-git/doc/guix.texi:22350
39919 msgid "File name of the sqlite database. The service's user will become the owner of the directory."
39923 #: guix-git/doc/guix.texi:22351
39925 msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})"
39929 #: guix-git/doc/guix.texi:22354
39930 msgid "File name of the log file. The service's user will become the owner of the directory."
39934 #: guix-git/doc/guix.texi:22355
39936 msgid "@code{autoban-attempts} (default: @code{10})"
39940 #: guix-git/doc/guix.texi:22358
39941 msgid "Maximum number of logins a user can make in @code{autoban-timeframe} without getting auto banned for @code{autoban-time}."
39945 #: guix-git/doc/guix.texi:22359
39947 msgid "@code{autoban-timeframe} (default: @code{120})"
39951 #: guix-git/doc/guix.texi:22361
39952 msgid "Timeframe for autoban in seconds."
39956 #: guix-git/doc/guix.texi:22362
39958 msgid "@code{autoban-time} (default: @code{300})"
39962 #: guix-git/doc/guix.texi:22365
39963 msgid "Amount of time in seconds for which a client gets banned when violating the autoban limits."
39967 #: guix-git/doc/guix.texi:22366
39969 msgid "@code{opus-threshold} (default: @code{100})"
39973 #: guix-git/doc/guix.texi:22369
39974 msgid "Percentage of clients that need to support opus before switching over to opus audio codec."
39978 #: guix-git/doc/guix.texi:22370
39980 msgid "@code{channel-nesting-limit} (default: @code{10})"
39984 #: guix-git/doc/guix.texi:22372
39985 msgid "How deep channels can be nested at maximum."
39989 #: guix-git/doc/guix.texi:22373
39991 msgid "@code{channelname-regex} (default: @code{#f})"
39995 #: guix-git/doc/guix.texi:22375
39996 msgid "A string in form of a Qt regular expression that channel names must conform to."
40000 #: guix-git/doc/guix.texi:22376
40002 msgid "@code{username-regex} (default: @code{#f})"
40006 #: guix-git/doc/guix.texi:22378
40007 msgid "A string in form of a Qt regular expression that user names must conform to."
40011 #: guix-git/doc/guix.texi:22379
40013 msgid "@code{text-message-length} (default: @code{5000})"
40017 #: guix-git/doc/guix.texi:22381
40018 msgid "Maximum size in bytes that a user can send in one text chat message."
40022 #: guix-git/doc/guix.texi:22382
40024 msgid "@code{image-message-length} (default: @code{(* 128 1024)})"
40028 #: guix-git/doc/guix.texi:22384
40029 msgid "Maximum size in bytes that a user can send in one image message."
40033 #: guix-git/doc/guix.texi:22385
40035 msgid "@code{cert-required?} (default: @code{#f})"
40039 #: guix-git/doc/guix.texi:22388
40040 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."
40044 #: guix-git/doc/guix.texi:22389
40046 msgid "@code{remember-channel?} (default: @code{#f})"
40050 #: guix-git/doc/guix.texi:22392
40051 msgid "Should murmur remember the last channel each user was in when they disconnected and put them into the remembered channel when they rejoin."
40055 #: guix-git/doc/guix.texi:22393
40057 msgid "@code{allow-html?} (default: @code{#f})"
40061 #: guix-git/doc/guix.texi:22395
40062 msgid "Should html be allowed in text messages, user comments, and channel descriptions."
40066 #: guix-git/doc/guix.texi:22396
40068 msgid "@code{allow-ping?} (default: @code{#f})"
40072 #: guix-git/doc/guix.texi:22400
40073 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."
40077 #: guix-git/doc/guix.texi:22402
40078 msgid "Disabling this setting will prevent public listing of the server."
40082 #: guix-git/doc/guix.texi:22403
40084 msgid "@code{bonjour?} (default: @code{#f})"
40088 #: guix-git/doc/guix.texi:22405
40089 msgid "Should the server advertise itself in the local network through the bonjour protocol."
40093 #: guix-git/doc/guix.texi:22406
40095 msgid "@code{send-version?} (default: @code{#f})"
40099 #: guix-git/doc/guix.texi:22408
40100 msgid "Should the murmur server version be exposed in ping requests."
40104 #: guix-git/doc/guix.texi:22409
40106 msgid "@code{log-days} (default: @code{31})"
40110 #: guix-git/doc/guix.texi:22413
40111 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."
40115 #: guix-git/doc/guix.texi:22414
40117 msgid "@code{obfuscate-ips?} (default: @code{#t})"
40121 #: guix-git/doc/guix.texi:22416
40122 msgid "Should logged ips be obfuscated to protect the privacy of users."
40126 #: guix-git/doc/guix.texi:22417
40128 msgid "@code{ssl-cert} (default: @code{#f})"
40132 #: guix-git/doc/guix.texi:22419
40133 msgid "File name of the SSL/TLS certificate used for encrypted connections."
40137 #: guix-git/doc/guix.texi:22422
40139 msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n"
40143 #: guix-git/doc/guix.texi:22423
40145 msgid "@code{ssl-key} (default: @code{#f})"
40149 #: guix-git/doc/guix.texi:22425
40150 msgid "Filepath to the ssl private key used for encrypted connections."
40154 #: guix-git/doc/guix.texi:22427
40156 msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n"
40160 #: guix-git/doc/guix.texi:22429
40162 msgid "@code{ssl-dh-params} (default: @code{#f})"
40166 #: guix-git/doc/guix.texi:22434
40167 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."
40171 #: guix-git/doc/guix.texi:22435
40173 msgid "@code{ssl-ciphers} (default: @code{#f})"
40177 #: guix-git/doc/guix.texi:22438
40178 msgid "The @code{ssl-ciphers} option chooses the cipher suites to make available for use in SSL/TLS."
40182 #: guix-git/doc/guix.texi:22442
40183 msgid "This option is specified using @uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}."
40187 #: guix-git/doc/guix.texi:22447
40188 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."
40192 #: guix-git/doc/guix.texi:22451
40193 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."
40197 #: guix-git/doc/guix.texi:22452
40199 msgid "@code{public-registration} (default: @code{#f})"
40203 #: guix-git/doc/guix.texi:22454
40204 msgid "Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}."
40208 #: guix-git/doc/guix.texi:22459
40209 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}."
40213 #: guix-git/doc/guix.texi:22461
40214 msgid "It might take a few hours until it shows up in the public list."
40218 #: guix-git/doc/guix.texi:22462 guix-git/doc/guix.texi:24698
40220 msgid "@code{file} (default: @code{#f})"
40224 #: guix-git/doc/guix.texi:22464
40225 msgid "Optional alternative override for this configuration."
40229 #: guix-git/doc/guix.texi:22467
40231 msgid "{Data Type} murmur-public-registration-configuration"
40235 #: guix-git/doc/guix.texi:22469
40236 msgid "Configuration for public registration of a murmur service."
40240 #: guix-git/doc/guix.texi:22473
40241 msgid "This is a display name for your server. Not to be confused with the hostname."
40245 #: guix-git/doc/guix.texi:22474 guix-git/doc/guix.texi:31149
40246 #: guix-git/doc/guix.texi:32190
40252 #: guix-git/doc/guix.texi:22477
40253 msgid "A password to identify your registration. Subsequent updates will need the same password. Don't lose your password."
40257 #: guix-git/doc/guix.texi:22481
40258 msgid "This should be a @code{http://} or @code{https://} link to your web site."
40262 #: guix-git/doc/guix.texi:22482 guix-git/doc/guix.texi:25577
40264 msgid "@code{hostname} (default: @code{#f})"
40268 #: guix-git/doc/guix.texi:22485
40269 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."
40272 #. type: Plain text
40273 #: guix-git/doc/guix.texi:22495
40274 msgid "The @code{(gnu services file-sharing)} module provides services that assist with transferring files over peer-to-peer file-sharing networks."
40277 #. type: subsubheading
40278 #: guix-git/doc/guix.texi:22496
40280 msgid "Transmission Daemon Service"
40283 #. type: Plain text
40284 #: guix-git/doc/guix.texi:22504
40285 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."
40289 #: guix-git/doc/guix.texi:22505
40291 msgid "{Scheme Variable} transmission-daemon-service-type"
40295 #: guix-git/doc/guix.texi:22509
40296 msgid "The service type for the Transmission Daemon BitTorrent client. Its value must be a @code{transmission-daemon-configuration} object as in this example:"
40300 #: guix-git/doc/guix.texi:22520
40303 "(service transmission-daemon-service-type\n"
40304 " (transmission-daemon-configuration\n"
40305 " ;; Restrict access to the RPC (\"control\") interface\n"
40306 " (rpc-authentication-required? #t)\n"
40307 " (rpc-username \"transmission\")\n"
40309 " (transmission-password-hash\n"
40310 " \"transmission\" ; desired password\n"
40311 " \"uKd1uMs9\")) ; arbitrary salt value\n"
40316 #: guix-git/doc/guix.texi:22525
40319 " ;; Accept requests from this and other hosts on the\n"
40320 " ;; local network\n"
40321 " (rpc-whitelist-enabled? #t)\n"
40322 " (rpc-whitelist '(\"::1\" \"127.0.0.1\" \"192.168.0.*\"))\n"
40327 #: guix-git/doc/guix.texi:22529
40330 " ;; Limit bandwidth use during work hours\n"
40331 " (alt-speed-down (* 1024 2)) ; 2 MB/s\n"
40332 " (alt-speed-up 512) ; 512 kB/s\n"
40337 #: guix-git/doc/guix.texi:22536
40340 " (alt-speed-time-enabled? #t)\n"
40341 " (alt-speed-time-day 'weekdays)\n"
40342 " (alt-speed-time-begin\n"
40343 " (+ (* 60 8) 30)) ; 8:30 am\n"
40344 " (alt-speed-time-end\n"
40345 " (+ (* 60 (+ 12 5)) 30)))) ; 5:30 pm\n"
40348 #. type: Plain text
40349 #: guix-git/doc/guix.texi:22549
40350 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."
40353 #. type: Plain text
40354 #: guix-git/doc/guix.texi:22557
40355 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."
40359 #: guix-git/doc/guix.texi:22558
40361 msgid "{Scheme Procedure} transmission-password-hash @var{password} @var{salt}"
40365 #: guix-git/doc/guix.texi:22562
40366 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."
40370 #: guix-git/doc/guix.texi:22566
40371 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."
40375 #: guix-git/doc/guix.texi:22568
40377 msgid "{Scheme Procedure} transmission-random-salt"
40381 #: guix-git/doc/guix.texi:22572
40382 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."
40385 #. type: Plain text
40386 #: guix-git/doc/guix.texi:22578
40387 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:"
40391 #: guix-git/doc/guix.texi:22584
40395 "scheme@@(guix-user)> ,use (gnu services file-sharing)\n"
40396 "scheme@@(guix-user)> (transmission-random-salt)\n"
40397 "$1 = \"uKd1uMs9\"\n"
40400 #. type: Plain text
40401 #: guix-git/doc/guix.texi:22587
40402 msgid "Alternatively, a complete password hash can generated in a single step:"
40406 #: guix-git/doc/guix.texi:22592
40409 "scheme@@(guix-user)> (transmission-password-hash \"transmission\"\n"
40410 "(transmission-random-salt))\n"
40411 "$2 = \"@{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX\"\n"
40414 #. type: Plain text
40415 #: guix-git/doc/guix.texi:22597
40416 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."
40419 #. type: Plain text
40420 #: guix-git/doc/guix.texi:22606
40421 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."
40424 #. type: Plain text
40425 #: guix-git/doc/guix.texi:22613
40426 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.)"
40429 #. type: Plain text
40430 #: guix-git/doc/guix.texi:22618
40431 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:"
40435 #: guix-git/doc/guix.texi:22621
40437 msgid "# herd reload transmission-daemon\n"
40440 #. type: Plain text
40441 #: guix-git/doc/guix.texi:22625
40442 msgid "The full set of available configuration settings is defined by the @code{transmission-daemon-configuration} data type."
40446 #: guix-git/doc/guix.texi:22626
40448 msgid "{Data Type} transmission-daemon-configuration"
40452 #: guix-git/doc/guix.texi:22630
40453 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."
40456 #. type: Plain text
40457 #: guix-git/doc/guix.texi:22644
40458 msgid "Available @code{transmission-daemon-configuration} fields are:"
40462 #: guix-git/doc/guix.texi:22645
40464 msgid "{@code{transmission-daemon-configuration} parameter} package transmission"
40468 #: guix-git/doc/guix.texi:22647
40469 msgid "The Transmission package to use."
40473 #: guix-git/doc/guix.texi:22650
40475 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer stop-wait-period"
40479 #: guix-git/doc/guix.texi:22656
40480 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."
40484 #: guix-git/doc/guix.texi:22658 guix-git/doc/guix.texi:23030
40485 #: guix-git/doc/guix.texi:30262 guix-git/doc/guix.texi:30497
40486 #: guix-git/doc/guix.texi:30505 guix-git/doc/guix.texi:30513
40487 msgid "Defaults to @samp{10}."
40491 #: guix-git/doc/guix.texi:22661
40493 msgid "{@code{transmission-daemon-configuration} parameter} string download-dir"
40497 #: guix-git/doc/guix.texi:22663
40498 msgid "The directory to which torrent files are downloaded."
40502 #: guix-git/doc/guix.texi:22665
40503 msgid "Defaults to @samp{\"/var/lib/transmission-daemon/downloads\"}."
40507 #: guix-git/doc/guix.texi:22668
40509 msgid "{@code{transmission-daemon-configuration} parameter} boolean incomplete-dir-enabled?"
40513 #: guix-git/doc/guix.texi:22673
40514 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}."
40518 #: guix-git/doc/guix.texi:22678
40520 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string incomplete-dir"
40524 #: guix-git/doc/guix.texi:22681
40525 msgid "The directory in which files from incompletely downloaded torrents will be held when @code{incomplete-dir-enabled?} is @code{#t}."
40529 #: guix-git/doc/guix.texi:22683 guix-git/doc/guix.texi:22727
40530 #: guix-git/doc/guix.texi:22940 guix-git/doc/guix.texi:22996
40531 #: guix-git/doc/guix.texi:23170 guix-git/doc/guix.texi:23181
40532 #: guix-git/doc/guix.texi:23254 guix-git/doc/guix.texi:23979
40533 #: guix-git/doc/guix.texi:24022 guix-git/doc/guix.texi:24030
40534 #: guix-git/doc/guix.texi:24038 guix-git/doc/guix.texi:24046
40535 #: guix-git/doc/guix.texi:24055 guix-git/doc/guix.texi:24063
40536 #: guix-git/doc/guix.texi:24070 guix-git/doc/guix.texi:24078
40537 #: guix-git/doc/guix.texi:24086 guix-git/doc/guix.texi:24096
40538 #: guix-git/doc/guix.texi:24103 guix-git/doc/guix.texi:24127
40539 #: guix-git/doc/guix.texi:24135 guix-git/doc/guix.texi:24161
40540 #: guix-git/doc/guix.texi:24170 guix-git/doc/guix.texi:24179
40541 #: guix-git/doc/guix.texi:24188 guix-git/doc/guix.texi:24197
40542 #: guix-git/doc/guix.texi:24206 guix-git/doc/guix.texi:24214
40543 #: guix-git/doc/guix.texi:24222 guix-git/doc/guix.texi:24229
40544 #: guix-git/doc/guix.texi:24237 guix-git/doc/guix.texi:24244
40545 #: guix-git/doc/guix.texi:24252 guix-git/doc/guix.texi:24260
40546 #: guix-git/doc/guix.texi:24269 guix-git/doc/guix.texi:24278
40547 #: guix-git/doc/guix.texi:24286 guix-git/doc/guix.texi:24294
40548 #: guix-git/doc/guix.texi:24302 guix-git/doc/guix.texi:24313
40549 #: guix-git/doc/guix.texi:24323 guix-git/doc/guix.texi:24334
40550 #: guix-git/doc/guix.texi:24343 guix-git/doc/guix.texi:24353
40551 #: guix-git/doc/guix.texi:24361 guix-git/doc/guix.texi:24372
40552 #: guix-git/doc/guix.texi:24381 guix-git/doc/guix.texi:24391
40553 #: guix-git/doc/guix.texi:27554 guix-git/doc/guix.texi:27561
40554 #: guix-git/doc/guix.texi:27568 guix-git/doc/guix.texi:27575
40555 #: guix-git/doc/guix.texi:27582 guix-git/doc/guix.texi:27589
40556 #: guix-git/doc/guix.texi:27597 guix-git/doc/guix.texi:27605
40557 #: guix-git/doc/guix.texi:27612 guix-git/doc/guix.texi:27619
40558 #: guix-git/doc/guix.texi:27626 guix-git/doc/guix.texi:27633
40559 #: guix-git/doc/guix.texi:27663 guix-git/doc/guix.texi:27701
40560 #: guix-git/doc/guix.texi:27708 guix-git/doc/guix.texi:27717
40561 #: guix-git/doc/guix.texi:27739 guix-git/doc/guix.texi:27747
40562 #: guix-git/doc/guix.texi:27754 guix-git/doc/guix.texi:27909
40563 #: guix-git/doc/guix.texi:27929 guix-git/doc/guix.texi:27944
40564 #: guix-git/doc/guix.texi:27951 guix-git/doc/guix.texi:30634
40565 #: guix-git/doc/guix.texi:30642 guix-git/doc/guix.texi:30650
40566 #: guix-git/doc/guix.texi:30658 guix-git/doc/guix.texi:30666
40567 #: guix-git/doc/guix.texi:30674
40568 msgid "Defaults to @samp{disabled}."
40572 #: guix-git/doc/guix.texi:22686
40574 msgid "{@code{transmission-daemon-configuration} parameter} umask umask"
40578 #: guix-git/doc/guix.texi:22689
40579 msgid "The file mode creation mask used for downloaded files. (See the @command{umask} man page for more information.)"
40583 #: guix-git/doc/guix.texi:22691
40584 msgid "Defaults to @samp{18}."
40588 #: guix-git/doc/guix.texi:22694
40590 msgid "{@code{transmission-daemon-configuration} parameter} boolean rename-partial-files?"
40594 #: guix-git/doc/guix.texi:22697
40595 msgid "When @code{#t}, ``.part'' is appended to the name of partially downloaded files."
40599 #: guix-git/doc/guix.texi:22702
40601 msgid "{@code{transmission-daemon-configuration} parameter} preallocation-mode preallocation"
40605 #: guix-git/doc/guix.texi:22707
40606 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."
40610 #: guix-git/doc/guix.texi:22709
40611 msgid "Defaults to @samp{fast}."
40615 #: guix-git/doc/guix.texi:22712
40617 msgid "{@code{transmission-daemon-configuration} parameter} boolean watch-dir-enabled?"
40621 #: guix-git/doc/guix.texi:22717
40622 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})."
40626 #: guix-git/doc/guix.texi:22722
40628 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string watch-dir"
40632 #: guix-git/doc/guix.texi:22725
40633 msgid "The directory to be watched for @file{.torrent} files indicating new torrents to be added, when @code{watch-dir-enabled} is @code{#t}."
40637 #: guix-git/doc/guix.texi:22730
40639 msgid "{@code{transmission-daemon-configuration} parameter} boolean trash-original-torrent-files?"
40643 #: guix-git/doc/guix.texi:22734
40644 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?})."
40648 #: guix-git/doc/guix.texi:22739
40650 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-down-enabled?"
40654 #: guix-git/doc/guix.texi:22742
40655 msgid "When @code{#t}, the daemon's download speed will be limited to the rate specified by @code{speed-limit-down}."
40659 #: guix-git/doc/guix.texi:22747
40661 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-down"
40665 #: guix-git/doc/guix.texi:22749
40666 msgid "The default global-maximum download speed, in kilobytes per second."
40670 #: guix-git/doc/guix.texi:22754
40672 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-up-enabled?"
40676 #: guix-git/doc/guix.texi:22757
40677 msgid "When @code{#t}, the daemon's upload speed will be limited to the rate specified by @code{speed-limit-up}."
40681 #: guix-git/doc/guix.texi:22762
40683 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-up"
40687 #: guix-git/doc/guix.texi:22764
40688 msgid "The default global-maximum upload speed, in kilobytes per second."
40692 #: guix-git/doc/guix.texi:22769
40694 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-enabled?"
40698 #: guix-git/doc/guix.texi:22775
40699 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?}."
40703 #: guix-git/doc/guix.texi:22780
40705 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-down"
40709 #: guix-git/doc/guix.texi:22782
40710 msgid "The alternate global-maximum download speed, in kilobytes per second."
40714 #: guix-git/doc/guix.texi:22784 guix-git/doc/guix.texi:22791
40715 #: guix-git/doc/guix.texi:22963 guix-git/doc/guix.texi:30269
40716 #: guix-git/doc/guix.texi:30284
40717 msgid "Defaults to @samp{50}."
40721 #: guix-git/doc/guix.texi:22787
40723 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-up"
40727 #: guix-git/doc/guix.texi:22789
40728 msgid "The alternate global-maximum upload speed, in kilobytes per second."
40732 #: guix-git/doc/guix.texi:22794
40734 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-time-enabled?"
40738 #: guix-git/doc/guix.texi:22799
40739 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}."
40743 #: guix-git/doc/guix.texi:22804
40745 msgid "{@code{transmission-daemon-configuration} parameter} day-list alt-speed-time-day"
40749 #: guix-git/doc/guix.texi:22809
40750 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}."
40754 #: guix-git/doc/guix.texi:22811
40755 msgid "Defaults to @samp{all}."
40759 #: guix-git/doc/guix.texi:22814
40761 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-begin"
40765 #: guix-git/doc/guix.texi:22817
40766 msgid "The time of day at which to enable the alternate speed limits, expressed as a number of minutes since midnight."
40770 #: guix-git/doc/guix.texi:22819
40771 msgid "Defaults to @samp{540}."
40775 #: guix-git/doc/guix.texi:22822
40777 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-end"
40781 #: guix-git/doc/guix.texi:22825
40782 msgid "The time of day at which to disable the alternate speed limits, expressed as a number of minutes since midnight."
40786 #: guix-git/doc/guix.texi:22827
40787 msgid "Defaults to @samp{1020}."
40791 #: guix-git/doc/guix.texi:22830
40793 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv4"
40797 #: guix-git/doc/guix.texi:22833
40798 msgid "The IP address at which to listen for peer connections, or ``0.0.0.0'' to listen at all available IP addresses."
40802 #: guix-git/doc/guix.texi:22835 guix-git/doc/guix.texi:23138
40803 #: guix-git/doc/guix.texi:28184
40804 msgid "Defaults to @samp{\"0.0.0.0\"}."
40808 #: guix-git/doc/guix.texi:22838
40810 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv6"
40814 #: guix-git/doc/guix.texi:22841
40815 msgid "The IPv6 address at which to listen for peer connections, or ``::'' to listen at all available IPv6 addresses."
40819 #: guix-git/doc/guix.texi:22843
40820 msgid "Defaults to @samp{\"::\"}."
40824 #: guix-git/doc/guix.texi:22846
40826 msgid "{@code{transmission-daemon-configuration} parameter} boolean peer-port-random-on-start?"
40830 #: guix-git/doc/guix.texi:22852
40831 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}."
40835 #: guix-git/doc/guix.texi:22857
40837 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-low"
40841 #: guix-git/doc/guix.texi:22860
40842 msgid "The lowest selectable port number when @code{peer-port-random-on-start?} is @code{#t}."
40846 #: guix-git/doc/guix.texi:22862
40847 msgid "Defaults to @samp{49152}."
40851 #: guix-git/doc/guix.texi:22865
40853 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-high"
40857 #: guix-git/doc/guix.texi:22868
40858 msgid "The highest selectable port number when @code{peer-port-random-on-start} is @code{#t}."
40862 #: guix-git/doc/guix.texi:22870
40863 msgid "Defaults to @samp{65535}."
40867 #: guix-git/doc/guix.texi:22873
40869 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port"
40873 #: guix-git/doc/guix.texi:22876
40874 msgid "The port on which to listen for peer connections when @code{peer-port-random-on-start?} is @code{#f}."
40878 #: guix-git/doc/guix.texi:22878
40879 msgid "Defaults to @samp{51413}."
40883 #: guix-git/doc/guix.texi:22881
40885 msgid "{@code{transmission-daemon-configuration} parameter} boolean port-forwarding-enabled?"
40889 #: guix-git/doc/guix.texi:22885
40890 msgid "If @code{#t}, the daemon will attempt to configure port-forwarding on an upstream gateway automatically using @acronym{UPnP} and @acronym{NAT-PMP}."
40894 #: guix-git/doc/guix.texi:22890
40896 msgid "{@code{transmission-daemon-configuration} parameter} encryption-mode encryption"
40900 #: guix-git/doc/guix.texi:22895
40901 msgid "The encryption preference for peer connections, one of @code{prefer-unencrypted-connections}, @code{prefer-encrypted-connections} or @code{require-encrypted-connections}."
40905 #: guix-git/doc/guix.texi:22897
40906 msgid "Defaults to @samp{prefer-encrypted-connections}."
40910 #: guix-git/doc/guix.texi:22900
40912 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm"
40916 #: guix-git/doc/guix.texi:22905
40917 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)."
40921 #: guix-git/doc/guix.texi:22914
40922 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."
40926 #: guix-git/doc/guix.texi:22922
40927 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:"
40931 #: guix-git/doc/guix.texi:22929
40934 "(service sysctl-service-type\n"
40935 " (sysctl-configuration\n"
40937 " (\"net.ipv4.tcp_allowed_congestion_control\" .\n"
40938 " \"reno cubic lp\"))))\n"
40942 #: guix-git/doc/guix.texi:22932
40943 msgid "The Transmission Daemon configuration can then be updated with"
40947 #: guix-git/doc/guix.texi:22935
40949 msgid "(peer-congestion-algorithm \"lp\")\n"
40953 #: guix-git/doc/guix.texi:22938
40954 msgid "and the system reconfigured to have the changes take effect."
40958 #: guix-git/doc/guix.texi:22943
40960 msgid "{@code{transmission-daemon-configuration} parameter} tcp-type-of-service peer-socket-tos"
40964 #: guix-git/doc/guix.texi:22947
40965 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}."
40969 #: guix-git/doc/guix.texi:22949
40970 msgid "Defaults to @samp{default}."
40974 #: guix-git/doc/guix.texi:22952
40976 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-global"
40980 #: guix-git/doc/guix.texi:22954
40981 msgid "The global limit on the number of connected peers."
40985 #: guix-git/doc/guix.texi:22956
40986 msgid "Defaults to @samp{200}."
40990 #: guix-git/doc/guix.texi:22959
40992 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-per-torrent"
40996 #: guix-git/doc/guix.texi:22961
40997 msgid "The per-torrent limit on the number of connected peers."
41001 #: guix-git/doc/guix.texi:22966
41003 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer upload-slots-per-torrent"
41007 #: guix-git/doc/guix.texi:22969
41008 msgid "The maximum number of peers to which the daemon will upload data simultaneously for each torrent."
41012 #: guix-git/doc/guix.texi:22971
41013 msgid "Defaults to @samp{14}."
41017 #: guix-git/doc/guix.texi:22974
41019 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-id-ttl-hours"
41023 #: guix-git/doc/guix.texi:22977
41024 msgid "The maximum lifespan, in hours, of the peer ID associated with each public torrent before it is regenerated."
41028 #: guix-git/doc/guix.texi:22979
41029 msgid "Defaults to @samp{6}."
41033 #: guix-git/doc/guix.texi:22982
41035 msgid "{@code{transmission-daemon-configuration} parameter} boolean blocklist-enabled?"
41039 #: guix-git/doc/guix.texi:22985
41040 msgid "When @code{#t}, the daemon will ignore peers mentioned in the blocklist it has most recently downloaded from @code{blocklist-url}."
41044 #: guix-git/doc/guix.texi:22990
41046 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string blocklist-url"
41050 #: guix-git/doc/guix.texi:22994
41051 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}."
41055 #: guix-git/doc/guix.texi:22999
41057 msgid "{@code{transmission-daemon-configuration} parameter} boolean download-queue-enabled?"
41061 #: guix-git/doc/guix.texi:23002
41062 msgid "If @code{#t}, the daemon will be limited to downloading at most @code{download-queue-size} non-stalled torrents simultaneously."
41066 #: guix-git/doc/guix.texi:23007
41068 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer download-queue-size"
41072 #: guix-git/doc/guix.texi:23011
41073 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}."
41077 #: guix-git/doc/guix.texi:23016
41079 msgid "{@code{transmission-daemon-configuration} parameter} boolean seed-queue-enabled?"
41083 #: guix-git/doc/guix.texi:23019
41084 msgid "If @code{#t}, the daemon will be limited to seeding at most @code{seed-queue-size} non-stalled torrents simultaneously."
41088 #: guix-git/doc/guix.texi:23024
41090 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer seed-queue-size"
41094 #: guix-git/doc/guix.texi:23028
41095 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}."
41099 #: guix-git/doc/guix.texi:23033
41101 msgid "{@code{transmission-daemon-configuration} parameter} boolean queue-stalled-enabled?"
41105 #: guix-git/doc/guix.texi:23038
41106 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."
41110 #: guix-git/doc/guix.texi:23043
41112 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer queue-stalled-minutes"
41116 #: guix-git/doc/guix.texi:23047
41117 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}."
41121 #: guix-git/doc/guix.texi:23052
41123 msgid "{@code{transmission-daemon-configuration} parameter} boolean ratio-limit-enabled?"
41127 #: guix-git/doc/guix.texi:23055
41128 msgid "When @code{#t}, a torrent being seeded will automatically be paused once it reaches the ratio specified by @code{ratio-limit}."
41132 #: guix-git/doc/guix.texi:23060
41134 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-rational ratio-limit"
41138 #: guix-git/doc/guix.texi:23063
41139 msgid "The ratio at which a torrent being seeded will be paused, when @code{ratio-limit-enabled?} is @code{#t}."
41143 #: guix-git/doc/guix.texi:23065
41144 msgid "Defaults to @samp{2.0}."
41148 #: guix-git/doc/guix.texi:23068
41150 msgid "{@code{transmission-daemon-configuration} parameter} boolean idle-seeding-limit-enabled?"
41154 #: guix-git/doc/guix.texi:23071
41155 msgid "When @code{#t}, a torrent being seeded will automatically be paused once it has been idle for @code{idle-seeding-limit} minutes."
41159 #: guix-git/doc/guix.texi:23076
41161 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer idle-seeding-limit"
41165 #: guix-git/doc/guix.texi:23080
41166 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}."
41170 #: guix-git/doc/guix.texi:23085
41172 msgid "{@code{transmission-daemon-configuration} parameter} boolean dht-enabled?"
41176 #: guix-git/doc/guix.texi:23089
41177 msgid "Enable @uref{http://bittorrent.org/beps/bep_0005.html,the distributed hash table (@acronym{DHT}) protocol}, which supports the use of trackerless torrents."
41181 #: guix-git/doc/guix.texi:23094
41183 msgid "{@code{transmission-daemon-configuration} parameter} boolean lpd-enabled?"
41187 #: guix-git/doc/guix.texi:23099
41188 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."
41192 #: guix-git/doc/guix.texi:23104
41194 msgid "{@code{transmission-daemon-configuration} parameter} boolean pex-enabled?"
41198 #: guix-git/doc/guix.texi:23108
41199 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."
41203 #: guix-git/doc/guix.texi:23113
41205 msgid "{@code{transmission-daemon-configuration} parameter} boolean utp-enabled?"
41209 #: guix-git/doc/guix.texi:23118
41210 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."
41214 #: guix-git/doc/guix.texi:23123
41216 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-enabled?"
41220 #: guix-git/doc/guix.texi:23128
41221 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."
41225 #: guix-git/doc/guix.texi:23133
41227 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-bind-address"
41231 #: guix-git/doc/guix.texi:23136
41232 msgid "The IP address at which to listen for @acronym{RPC} connections, or ``0.0.0.0'' to listen at all available IP addresses."
41236 #: guix-git/doc/guix.texi:23141
41238 msgid "{@code{transmission-daemon-configuration} parameter} port-number rpc-port"
41242 #: guix-git/doc/guix.texi:23143
41243 msgid "The port on which to listen for @acronym{RPC} connections."
41247 #: guix-git/doc/guix.texi:23145
41248 msgid "Defaults to @samp{9091}."
41252 #: guix-git/doc/guix.texi:23148
41254 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-url"
41258 #: guix-git/doc/guix.texi:23150
41259 msgid "The path prefix to use in the @acronym{RPC}-endpoint @acronym{URL}."
41263 #: guix-git/doc/guix.texi:23152
41264 msgid "Defaults to @samp{\"/transmission/\"}."
41268 #: guix-git/doc/guix.texi:23155
41270 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-authentication-required?"
41274 #: guix-git/doc/guix.texi:23160
41275 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?}."
41279 #: guix-git/doc/guix.texi:23165
41281 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string rpc-username"
41285 #: guix-git/doc/guix.texi:23168
41286 msgid "The username required by clients to access the @acronym{RPC} interface when @code{rpc-authentication-required?} is @code{#t}."
41290 #: guix-git/doc/guix.texi:23173
41292 msgid "{@code{transmission-daemon-configuration} parameter} maybe-transmission-password-hash rpc-password"
41296 #: guix-git/doc/guix.texi:23179
41297 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."
41301 #: guix-git/doc/guix.texi:23184
41303 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-whitelist-enabled?"
41307 #: guix-git/doc/guix.texi:23187
41308 msgid "When @code{#t}, @acronym{RPC} requests will be accepted only when they originate from an address specified in @code{rpc-whitelist}."
41312 #: guix-git/doc/guix.texi:23192
41314 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-whitelist"
41318 #: guix-git/doc/guix.texi:23196
41319 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{*}."
41323 #: guix-git/doc/guix.texi:23198
41324 msgid "Defaults to @samp{(\"127.0.0.1\" \"::1\")}."
41328 #: guix-git/doc/guix.texi:23201
41330 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-host-whitelist-enabled?"
41334 #: guix-git/doc/guix.texi:23206
41335 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."
41339 #: guix-git/doc/guix.texi:23209
41340 msgid "Note also this functionality is disabled when @code{rpc-authentication-required?} is @code{#t}."
41344 #: guix-git/doc/guix.texi:23214
41346 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-host-whitelist"
41350 #: guix-git/doc/guix.texi:23217
41351 msgid "The list of host names recognized by the @acronym{RPC} server when @code{rpc-host-whitelist-enabled?} is @code{#t}."
41355 #: guix-git/doc/guix.texi:23222
41357 msgid "{@code{transmission-daemon-configuration} parameter} message-level message-level"
41361 #: guix-git/doc/guix.texi:23226
41362 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}."
41366 #: guix-git/doc/guix.texi:23231
41368 msgid "{@code{transmission-daemon-configuration} parameter} boolean start-added-torrents?"
41372 #: guix-git/doc/guix.texi:23234
41373 msgid "When @code{#t}, torrents are started as soon as they are added; otherwise, they are added in ``paused'' state."
41377 #: guix-git/doc/guix.texi:23239
41379 msgid "{@code{transmission-daemon-configuration} parameter} boolean script-torrent-done-enabled?"
41383 #: guix-git/doc/guix.texi:23243
41384 msgid "When @code{#t}, the script specified by @code{script-torrent-done-filename} will be invoked each time a torrent completes."
41388 #: guix-git/doc/guix.texi:23248
41390 msgid "{@code{transmission-daemon-configuration} parameter} maybe-file-object script-torrent-done-filename"
41394 #: guix-git/doc/guix.texi:23252
41395 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}."
41399 #: guix-git/doc/guix.texi:23257
41401 msgid "{@code{transmission-daemon-configuration} parameter} boolean scrape-paused-torrents-enabled?"
41405 #: guix-git/doc/guix.texi:23260
41406 msgid "When @code{#t}, the daemon will scrape trackers for a torrent even when the torrent is paused."
41410 #: guix-git/doc/guix.texi:23265
41412 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer cache-size-mb"
41416 #: guix-git/doc/guix.texi:23269
41417 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."
41421 #: guix-git/doc/guix.texi:23271
41422 msgid "Defaults to @samp{4}."
41426 #: guix-git/doc/guix.texi:23274
41428 msgid "{@code{transmission-daemon-configuration} parameter} boolean prefetch-enabled?"
41432 #: guix-git/doc/guix.texi:23278
41433 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."
41436 #. type: subsubheading
41437 #: guix-git/doc/guix.texi:23291
41439 msgid "Tailon Service"
41442 #. type: Plain text
41443 #: guix-git/doc/guix.texi:23295
41444 msgid "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for viewing and searching log files."
41447 #. type: Plain text
41448 #: guix-git/doc/guix.texi:23298
41449 msgid "The following example will configure the service with default values. By default, Tailon can be accessed on port 8080 (@code{http://localhost:8080})."
41453 #: guix-git/doc/guix.texi:23301
41455 msgid "(service tailon-service-type)\n"
41458 #. type: Plain text
41459 #: guix-git/doc/guix.texi:23305
41460 msgid "The following example customises more of the Tailon configuration, adding @command{sed} to the list of allowed commands."
41464 #: guix-git/doc/guix.texi:23312
41467 "(service tailon-service-type\n"
41468 " (tailon-configuration\n"
41470 " (tailon-configuration-file\n"
41471 " (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n"
41475 #: guix-git/doc/guix.texi:23315
41477 msgid "{Data Type} tailon-configuration"
41481 #: guix-git/doc/guix.texi:23318
41482 msgid "Data type representing the configuration of Tailon. This type has the following parameters:"
41486 #: guix-git/doc/guix.texi:23320
41488 msgid "@code{config-file} (default: @code{(tailon-configuration-file)})"
41492 #: guix-git/doc/guix.texi:23324
41493 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})."
41497 #: guix-git/doc/guix.texi:23327
41498 msgid "For example, to instead use a local file, the @code{local-file} function can be used:"
41502 #: guix-git/doc/guix.texi:23332
41505 "(service tailon-service-type\n"
41506 " (tailon-configuration\n"
41507 " (config-file (local-file \"./my-tailon.conf\"))))\n"
41511 #: guix-git/doc/guix.texi:23334
41513 msgid "@code{package} (default: @code{tailon})"
41517 #: guix-git/doc/guix.texi:23336
41518 msgid "The tailon package to use."
41522 #: guix-git/doc/guix.texi:23340
41524 msgid "{Data Type} tailon-configuration-file"
41528 #: guix-git/doc/guix.texi:23343
41529 msgid "Data type representing the configuration options for Tailon. This type has the following parameters:"
41533 #: guix-git/doc/guix.texi:23345
41535 msgid "@code{files} (default: @code{(list \"/var/log\")})"
41539 #: guix-git/doc/guix.texi:23350
41540 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."
41544 #: guix-git/doc/guix.texi:23351
41546 msgid "@code{bind} (default: @code{\"localhost:8080\"})"
41550 #: guix-git/doc/guix.texi:23353
41551 msgid "Address and port to which Tailon should bind on."
41555 #: guix-git/doc/guix.texi:23354
41557 msgid "@code{relative-root} (default: @code{#f})"
41561 #: guix-git/doc/guix.texi:23356
41562 msgid "URL path to use for Tailon, set to @code{#f} to not use a path."
41566 #: guix-git/doc/guix.texi:23357
41568 msgid "@code{allow-transfers?} (default: @code{#t})"
41572 #: guix-git/doc/guix.texi:23359
41573 msgid "Allow downloading the log files in the web interface."
41577 #: guix-git/doc/guix.texi:23360
41579 msgid "@code{follow-names?} (default: @code{#t})"
41583 #: guix-git/doc/guix.texi:23362
41584 msgid "Allow tailing of not-yet existent files."
41588 #: guix-git/doc/guix.texi:23363
41590 msgid "@code{tail-lines} (default: @code{200})"
41594 #: guix-git/doc/guix.texi:23365
41595 msgid "Number of lines to read initially from each file."
41599 #: guix-git/doc/guix.texi:23366
41601 msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})"
41605 #: guix-git/doc/guix.texi:23368
41606 msgid "Commands to allow running. By default, @code{sed} is disabled."
41610 #: guix-git/doc/guix.texi:23371
41611 msgid "Set @code{debug?} to @code{#t} to show debug messages."
41615 #: guix-git/doc/guix.texi:23372
41617 msgid "@code{wrap-lines} (default: @code{#t})"
41621 #: guix-git/doc/guix.texi:23376
41622 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."
41626 #: guix-git/doc/guix.texi:23377
41628 msgid "@code{http-auth} (default: @code{#f})"
41632 #: guix-git/doc/guix.texi:23381
41633 msgid "HTTP authentication type to use. Set to @code{#f} to disable authentication (the default). Supported values are @code{\"digest\"} or @code{\"basic\"}."
41637 #: guix-git/doc/guix.texi:23382
41639 msgid "@code{users} (default: @code{#f})"
41643 #: guix-git/doc/guix.texi:23387
41644 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."
41648 #: guix-git/doc/guix.texi:23393
41651 "(tailon-configuration-file\n"
41652 " (http-auth \"basic\")\n"
41653 " (users '((\"user1\" . \"password1\")\n"
41654 " (\"user2\" . \"password2\"))))\n"
41657 #. type: subsubheading
41658 #: guix-git/doc/guix.texi:23399
41660 msgid "Darkstat Service"
41664 #: guix-git/doc/guix.texi:23400
41669 #. type: Plain text
41670 #: guix-git/doc/guix.texi:23403
41671 msgid "Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP."
41675 #: guix-git/doc/guix.texi:23404
41677 msgid "{Scheme Variable} darkstat-service-type"
41681 #: guix-git/doc/guix.texi:23409
41682 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:"
41686 #: guix-git/doc/guix.texi:23414
41689 "(service darkstat-service-type\n"
41690 " (darkstat-configuration\n"
41691 " (interface \"eno1\")))\n"
41695 #: guix-git/doc/guix.texi:23417
41697 msgid "{Data Type} darkstat-configuration"
41701 #: guix-git/doc/guix.texi:23419
41702 msgid "Data type representing the configuration of @command{darkstat}."
41706 #: guix-git/doc/guix.texi:23421
41708 msgid "@code{package} (default: @code{darkstat})"
41712 #: guix-git/doc/guix.texi:23423
41713 msgid "The darkstat package to use."
41717 #: guix-git/doc/guix.texi:23424
41723 #: guix-git/doc/guix.texi:23426
41724 msgid "Capture traffic on the specified network interface."
41728 #: guix-git/doc/guix.texi:23427
41730 msgid "@code{port} (default: @code{\"667\"})"
41734 #: guix-git/doc/guix.texi:23429
41735 msgid "Bind the web interface to the specified port."
41739 #: guix-git/doc/guix.texi:23432 guix-git/doc/guix.texi:23467
41740 msgid "Bind the web interface to the specified address."
41744 #: guix-git/doc/guix.texi:23433
41746 msgid "@code{base} (default: @code{\"/\"})"
41750 #: guix-git/doc/guix.texi:23436
41751 msgid "Specify the path of the base URL@. This can be useful if @command{darkstat} is accessed via a reverse proxy."
41754 #. type: subsubheading
41755 #: guix-git/doc/guix.texi:23440
41757 msgid "Prometheus Node Exporter Service"
41761 #: guix-git/doc/guix.texi:23442
41763 msgid "prometheus-node-exporter"
41766 #. type: Plain text
41767 #: guix-git/doc/guix.texi:23447
41768 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."
41772 #: guix-git/doc/guix.texi:23448
41774 msgid "{Scheme variable} prometheus-node-exporter-service-type"
41778 #: guix-git/doc/guix.texi:23452
41779 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}."
41783 #: guix-git/doc/guix.texi:23455
41785 msgid "(service prometheus-node-exporter-service-type)\n"
41789 #: guix-git/doc/guix.texi:23458
41791 msgid "{Data Type} prometheus-node-exporter-configuration"
41795 #: guix-git/doc/guix.texi:23460
41796 msgid "Data type representing the configuration of @command{node_exporter}."
41800 #: guix-git/doc/guix.texi:23462
41802 msgid "@code{package} (default: @code{go-github-com-prometheus-node-exporter})"
41806 #: guix-git/doc/guix.texi:23464
41807 msgid "The prometheus-node-exporter package to use."
41811 #: guix-git/doc/guix.texi:23465
41813 msgid "@code{web-listen-address} (default: @code{\":9100\"})"
41817 #: guix-git/doc/guix.texi:23468
41819 msgid "@code{textfile-directory} (default: @code{\"/var/lib/prometheus/node-exporter\"})"
41823 #: guix-git/doc/guix.texi:23472
41824 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."
41828 #: guix-git/doc/guix.texi:23475
41829 msgid "Extra options to pass to the Prometheus node exporter."
41832 #. type: subsubheading
41833 #: guix-git/doc/guix.texi:23479
41835 msgid "Zabbix server"
41839 #: guix-git/doc/guix.texi:23480
41841 msgid "zabbix zabbix-server"
41844 #. type: Plain text
41845 #: guix-git/doc/guix.texi:23483
41846 msgid "Zabbix provides monitoring metrics, among others network utilization, CPU load and disk space consumption:"
41850 #: guix-git/doc/guix.texi:23485
41852 msgid "High performance, high capacity (able to monitor hundreds of thousands of devices)."
41856 #: guix-git/doc/guix.texi:23486
41858 msgid "Auto-discovery of servers and network devices and interfaces."
41862 #: guix-git/doc/guix.texi:23487
41864 msgid "Low-level discovery, allows to automatically start monitoring new items, file systems or network interfaces among others."
41868 #: guix-git/doc/guix.texi:23488
41870 msgid "Distributed monitoring with centralized web administration."
41874 #: guix-git/doc/guix.texi:23489
41876 msgid "Native high performance agents."
41880 #: guix-git/doc/guix.texi:23490
41882 msgid "SLA, and ITIL KPI metrics on reporting."
41886 #: guix-git/doc/guix.texi:23491
41888 msgid "High-level (business) view of monitored resources through user-defined visual console screens and dashboards."
41892 #: guix-git/doc/guix.texi:23492
41894 msgid "Remote command execution through Zabbix proxies."
41897 #. type: Plain text
41898 #: guix-git/doc/guix.texi:23498
41899 msgid "Available @code{zabbix-server-configuration} fields are:"
41903 #: guix-git/doc/guix.texi:23499
41905 msgid "{@code{zabbix-server-configuration} parameter} package zabbix-server"
41909 #: guix-git/doc/guix.texi:23501
41910 msgid "The zabbix-server package."
41914 #: guix-git/doc/guix.texi:23504
41916 msgid "{@code{zabbix-server-configuration} parameter} string user"
41920 #: guix-git/doc/guix.texi:23506
41921 msgid "User who will run the Zabbix server."
41925 #: guix-git/doc/guix.texi:23508 guix-git/doc/guix.texi:23515
41926 #: guix-git/doc/guix.texi:23529 guix-git/doc/guix.texi:23536
41927 #: guix-git/doc/guix.texi:23637 guix-git/doc/guix.texi:23644
41928 #: guix-git/doc/guix.texi:23755 guix-git/doc/guix.texi:23762
41929 msgid "Defaults to @samp{\"zabbix\"}."
41933 #: guix-git/doc/guix.texi:23511
41935 msgid "{@code{zabbix-server-configuration} parameter} group group"
41939 #: guix-git/doc/guix.texi:23513
41940 msgid "Group who will run the Zabbix server."
41944 #: guix-git/doc/guix.texi:23518
41946 msgid "{@code{zabbix-server-configuration} parameter} string db-host"
41950 #: guix-git/doc/guix.texi:23520 guix-git/doc/guix.texi:23739
41951 msgid "Database host name."
41955 #: guix-git/doc/guix.texi:23522
41956 msgid "Defaults to @samp{\"127.0.0.1\"}."
41960 #: guix-git/doc/guix.texi:23525
41962 msgid "{@code{zabbix-server-configuration} parameter} string db-name"
41966 #: guix-git/doc/guix.texi:23527 guix-git/doc/guix.texi:23753
41967 msgid "Database name."
41971 #: guix-git/doc/guix.texi:23532
41973 msgid "{@code{zabbix-server-configuration} parameter} string db-user"
41977 #: guix-git/doc/guix.texi:23534 guix-git/doc/guix.texi:23760
41978 msgid "Database user."
41982 #: guix-git/doc/guix.texi:23539
41984 msgid "{@code{zabbix-server-configuration} parameter} string db-password"
41988 #: guix-git/doc/guix.texi:23542
41989 msgid "Database password. Please, use @code{include-files} with @code{DBPassword=SECRET} inside a specified file instead."
41993 #: guix-git/doc/guix.texi:23547
41995 msgid "{@code{zabbix-server-configuration} parameter} number db-port"
41999 #: guix-git/doc/guix.texi:23549 guix-git/doc/guix.texi:23746
42000 msgid "Database port."
42004 #: guix-git/doc/guix.texi:23551 guix-git/doc/guix.texi:23748
42005 msgid "Defaults to @samp{5432}."
42009 #: guix-git/doc/guix.texi:23554
42011 msgid "{@code{zabbix-server-configuration} parameter} string log-type"
42015 #: guix-git/doc/guix.texi:23556 guix-git/doc/guix.texi:23657
42016 msgid "Specifies where log messages are written to:"
42020 #: guix-git/doc/guix.texi:23560 guix-git/doc/guix.texi:23661
42021 msgid "@code{system} - syslog."
42025 #: guix-git/doc/guix.texi:23563 guix-git/doc/guix.texi:23664
42026 msgid "@code{file} - file specified with @code{log-file} parameter."
42030 #: guix-git/doc/guix.texi:23566 guix-git/doc/guix.texi:23667
42031 msgid "@code{console} - standard output."
42035 #: guix-git/doc/guix.texi:23573
42037 msgid "{@code{zabbix-server-configuration} parameter} string log-file"
42041 #: guix-git/doc/guix.texi:23575 guix-git/doc/guix.texi:23676
42042 msgid "Log file name for @code{log-type} @code{file} parameter."
42046 #: guix-git/doc/guix.texi:23577
42047 msgid "Defaults to @samp{\"/var/log/zabbix/server.log\"}."
42051 #: guix-git/doc/guix.texi:23580
42053 msgid "{@code{zabbix-server-configuration} parameter} string pid-file"
42057 #: guix-git/doc/guix.texi:23582 guix-git/doc/guix.texi:23683
42058 msgid "Name of PID file."
42062 #: guix-git/doc/guix.texi:23584
42063 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_server.pid\"}."
42067 #: guix-git/doc/guix.texi:23587
42069 msgid "{@code{zabbix-server-configuration} parameter} string ssl-ca-location"
42073 #: guix-git/doc/guix.texi:23590
42074 msgid "The location of certificate authority (CA) files for SSL server certificate verification."
42078 #: guix-git/doc/guix.texi:23592
42079 msgid "Defaults to @samp{\"/etc/ssl/certs/ca-certificates.crt\"}."
42083 #: guix-git/doc/guix.texi:23595
42085 msgid "{@code{zabbix-server-configuration} parameter} string ssl-cert-location"
42089 #: guix-git/doc/guix.texi:23597
42090 msgid "Location of SSL client certificates."
42094 #: guix-git/doc/guix.texi:23599
42095 msgid "Defaults to @samp{\"/etc/ssl/certs\"}."
42099 #: guix-git/doc/guix.texi:23602
42101 msgid "{@code{zabbix-server-configuration} parameter} string extra-options"
42105 #: guix-git/doc/guix.texi:23604 guix-git/doc/guix.texi:23708
42106 msgid "Extra options will be appended to Zabbix server configuration file."
42110 #: guix-git/doc/guix.texi:23609
42112 msgid "{@code{zabbix-server-configuration} parameter} include-files include-files"
42116 #: guix-git/doc/guix.texi:23612 guix-git/doc/guix.texi:23716
42117 msgid "You may include individual files or all files in a directory in the configuration file."
42120 #. type: subsubheading
42121 #: guix-git/doc/guix.texi:23619
42123 msgid "Zabbix agent"
42127 #: guix-git/doc/guix.texi:23620
42129 msgid "zabbix zabbix-agent"
42132 #. type: Plain text
42133 #: guix-git/doc/guix.texi:23623
42134 msgid "Zabbix agent gathers information for Zabbix server."
42137 #. type: Plain text
42138 #: guix-git/doc/guix.texi:23627
42139 msgid "Available @code{zabbix-agent-configuration} fields are:"
42143 #: guix-git/doc/guix.texi:23628
42145 msgid "{@code{zabbix-agent-configuration} parameter} package zabbix-agent"
42149 #: guix-git/doc/guix.texi:23630
42150 msgid "The zabbix-agent package."
42154 #: guix-git/doc/guix.texi:23633
42156 msgid "{@code{zabbix-agent-configuration} parameter} string user"
42160 #: guix-git/doc/guix.texi:23635
42161 msgid "User who will run the Zabbix agent."
42165 #: guix-git/doc/guix.texi:23640
42167 msgid "{@code{zabbix-agent-configuration} parameter} group group"
42171 #: guix-git/doc/guix.texi:23642
42172 msgid "Group who will run the Zabbix agent."
42176 #: guix-git/doc/guix.texi:23647
42178 msgid "{@code{zabbix-agent-configuration} parameter} string hostname"
42182 #: guix-git/doc/guix.texi:23650
42183 msgid "Unique, case sensitive hostname which is required for active checks and must match hostname as configured on the server."
42187 #: guix-git/doc/guix.texi:23655
42189 msgid "{@code{zabbix-agent-configuration} parameter} string log-type"
42193 #: guix-git/doc/guix.texi:23674
42195 msgid "{@code{zabbix-agent-configuration} parameter} string log-file"
42199 #: guix-git/doc/guix.texi:23678
42200 msgid "Defaults to @samp{\"/var/log/zabbix/agent.log\"}."
42204 #: guix-git/doc/guix.texi:23681
42206 msgid "{@code{zabbix-agent-configuration} parameter} string pid-file"
42210 #: guix-git/doc/guix.texi:23685
42211 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_agent.pid\"}."
42215 #: guix-git/doc/guix.texi:23688
42217 msgid "{@code{zabbix-agent-configuration} parameter} list server"
42221 #: guix-git/doc/guix.texi:23692
42222 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."
42226 #: guix-git/doc/guix.texi:23694 guix-git/doc/guix.texi:23703
42227 msgid "Defaults to @samp{(\"127.0.0.1\")}."
42231 #: guix-git/doc/guix.texi:23697
42233 msgid "{@code{zabbix-agent-configuration} parameter} list server-active"
42237 #: guix-git/doc/guix.texi:23701
42238 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."
42242 #: guix-git/doc/guix.texi:23706
42244 msgid "{@code{zabbix-agent-configuration} parameter} string extra-options"
42248 #: guix-git/doc/guix.texi:23713
42250 msgid "{@code{zabbix-agent-configuration} parameter} include-files include-files"
42253 #. type: subsubheading
42254 #: guix-git/doc/guix.texi:23723
42256 msgid "Zabbix front-end"
42260 #: guix-git/doc/guix.texi:23724
42262 msgid "zabbix zabbix-front-end"
42265 #. type: Plain text
42266 #: guix-git/doc/guix.texi:23727
42267 msgid "This service provides a WEB interface to Zabbix server."
42270 #. type: Plain text
42271 #: guix-git/doc/guix.texi:23731
42272 msgid "Available @code{zabbix-front-end-configuration} fields are:"
42276 #: guix-git/doc/guix.texi:23732
42278 msgid "{@code{zabbix-front-end-configuration} parameter} nginx-server-configuration-list nginx"
42282 #: guix-git/doc/guix.texi:23734 guix-git/doc/guix.texi:29896
42283 msgid "NGINX configuration."
42287 #: guix-git/doc/guix.texi:23737
42289 msgid "{@code{zabbix-front-end-configuration} parameter} string db-host"
42293 #: guix-git/doc/guix.texi:23744
42295 msgid "{@code{zabbix-front-end-configuration} parameter} number db-port"
42299 #: guix-git/doc/guix.texi:23751
42301 msgid "{@code{zabbix-front-end-configuration} parameter} string db-name"
42305 #: guix-git/doc/guix.texi:23758
42307 msgid "{@code{zabbix-front-end-configuration} parameter} string db-user"
42311 #: guix-git/doc/guix.texi:23765
42313 msgid "{@code{zabbix-front-end-configuration} parameter} string db-password"
42317 #: guix-git/doc/guix.texi:23767
42318 msgid "Database password. Please, use @code{db-secret-file} instead."
42322 #: guix-git/doc/guix.texi:23772
42324 msgid "{@code{zabbix-front-end-configuration} parameter} string db-secret-file"
42328 #: guix-git/doc/guix.texi:23777
42329 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']}."
42333 #: guix-git/doc/guix.texi:23782
42335 msgid "{@code{zabbix-front-end-configuration} parameter} string zabbix-host"
42339 #: guix-git/doc/guix.texi:23784
42340 msgid "Zabbix server hostname."
42344 #: guix-git/doc/guix.texi:23789
42346 msgid "{@code{zabbix-front-end-configuration} parameter} number zabbix-port"
42350 #: guix-git/doc/guix.texi:23791
42351 msgid "Zabbix server port."
42355 #: guix-git/doc/guix.texi:23793
42356 msgid "Defaults to @samp{10051}."
42360 #: guix-git/doc/guix.texi:23801
42365 #. type: Plain text
42366 #: guix-git/doc/guix.texi:23805
42367 msgid "The @code{(gnu services kerberos)} module provides services relating to the authentication protocol @dfn{Kerberos}."
42370 #. type: subsubheading
42371 #: guix-git/doc/guix.texi:23806
42373 msgid "Krb5 Service"
42376 #. type: Plain text
42377 #: guix-git/doc/guix.texi:23813
42378 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."
42381 #. type: Plain text
42382 #: guix-git/doc/guix.texi:23817
42383 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."
42387 #: guix-git/doc/guix.texi:23818
42389 msgid "{Scheme Variable} krb5-service-type"
42393 #: guix-git/doc/guix.texi:23820
42394 msgid "A service type for Kerberos 5 clients."
42397 #. type: Plain text
42398 #: guix-git/doc/guix.texi:23824
42399 msgid "Here is an example of its use:"
42403 #: guix-git/doc/guix.texi:23838
42406 "(service krb5-service-type\n"
42407 " (krb5-configuration\n"
42408 " (default-realm \"EXAMPLE.COM\")\n"
42409 " (allow-weak-crypto? #t)\n"
42412 " (name \"EXAMPLE.COM\")\n"
42413 " (admin-server \"groucho.example.com\")\n"
42414 " (kdc \"karl.example.com\"))\n"
42416 " (name \"ARGRX.EDU\")\n"
42417 " (admin-server \"kerb-admin.argrx.edu\")\n"
42418 " (kdc \"keys.argrx.edu\"))))))\n"
42421 #. type: Plain text
42422 #: guix-git/doc/guix.texi:23842
42423 msgid "This example provides a Kerberos@tie{}5 client configuration which:"
42427 #: guix-git/doc/guix.texi:23843
42429 msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both"
42433 #: guix-git/doc/guix.texi:23845
42434 msgid "of which have distinct administration servers and key distribution centers;"
42438 #: guix-git/doc/guix.texi:23845
42440 msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly"
42444 #: guix-git/doc/guix.texi:23847
42445 msgid "specified by clients;"
42449 #: guix-git/doc/guix.texi:23847
42451 msgid "Accepts services which only support encryption types known to be weak."
42454 #. type: Plain text
42455 #: guix-git/doc/guix.texi:23855
42456 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."
42460 #: guix-git/doc/guix.texi:23857
42462 msgid "{Data Type} krb5-realm"
42466 #: guix-git/doc/guix.texi:23858
42468 msgid "realm, kerberos"
42472 #: guix-git/doc/guix.texi:23864
42473 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."
42477 #: guix-git/doc/guix.texi:23865
42479 msgid "admin-server"
42483 #: guix-git/doc/guix.texi:23868
42484 msgid "This field is a string identifying the host where the administration server is running."
42488 #: guix-git/doc/guix.texi:23869
42494 #: guix-git/doc/guix.texi:23872
42495 msgid "This field is a string identifying the key distribution center for the realm."
42499 #: guix-git/doc/guix.texi:23875
42501 msgid "{Data Type} krb5-configuration"
42505 #: guix-git/doc/guix.texi:23878
42507 msgid "@code{allow-weak-crypto?} (default: @code{#f})"
42511 #: guix-git/doc/guix.texi:23881
42512 msgid "If this flag is @code{#t} then services which only offer encryption algorithms known to be weak will be accepted."
42516 #: guix-git/doc/guix.texi:23882
42518 msgid "@code{default-realm} (default: @code{#f})"
42522 #: guix-git/doc/guix.texi:23889
42523 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}."
42527 #: guix-git/doc/guix.texi:23890
42533 #: guix-git/doc/guix.texi:23895
42534 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."
42537 #. type: subsubheading
42538 #: guix-git/doc/guix.texi:23899
42540 msgid "PAM krb5 Service"
42544 #: guix-git/doc/guix.texi:23900
42549 #. type: Plain text
42550 #: guix-git/doc/guix.texi:23906
42551 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."
42555 #: guix-git/doc/guix.texi:23907
42557 msgid "{Scheme Variable} pam-krb5-service-type"
42561 #: guix-git/doc/guix.texi:23909
42562 msgid "A service type for the Kerberos 5 PAM module."
42566 #: guix-git/doc/guix.texi:23911
42568 msgid "{Data Type} pam-krb5-configuration"
42572 #: guix-git/doc/guix.texi:23914
42573 msgid "Data type representing the configuration of the Kerberos 5 PAM module. This type has the following parameters:"
42577 #: guix-git/doc/guix.texi:23915
42579 msgid "@code{pam-krb5} (default: @code{pam-krb5})"
42583 #: guix-git/doc/guix.texi:23917
42584 msgid "The pam-krb5 package to use."
42588 #: guix-git/doc/guix.texi:23918
42590 msgid "@code{minimum-uid} (default: @code{1000})"
42594 #: guix-git/doc/guix.texi:23921
42595 msgid "The smallest user ID for which Kerberos authentications should be attempted. Local accounts with lower values will silently fail to authenticate."
42599 #: guix-git/doc/guix.texi:23927
42605 #: guix-git/doc/guix.texi:23928
42607 msgid "nslcd, LDAP service"
42610 #. type: Plain text
42611 #: guix-git/doc/guix.texi:23935
42612 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."
42615 #. type: Plain text
42616 #: guix-git/doc/guix.texi:23939
42617 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:"
42621 #: guix-git/doc/guix.texi:23962
42624 "(use-service-modules authentication)\n"
42625 "(use-modules (gnu system nss))\n"
42627 "(operating-system\n"
42631 " (service nslcd-service-type)\n"
42632 " (service dhcp-client-service-type)\n"
42633 " %base-services))\n"
42634 " (name-service-switch\n"
42635 " (let ((services (list (name-service (name \"db\"))\n"
42636 " (name-service (name \"files\"))\n"
42637 " (name-service (name \"ldap\")))))\n"
42638 " (name-service-switch\n"
42639 " (inherit %mdns-host-lookup-nss)\n"
42640 " (password services)\n"
42641 " (shadow services)\n"
42642 " (group services)\n"
42643 " (netgroup services)\n"
42644 " (gshadow services)))))\n"
42647 #. type: Plain text
42648 #: guix-git/doc/guix.texi:23967
42649 msgid "Available @code{nslcd-configuration} fields are:"
42653 #: guix-git/doc/guix.texi:23968
42655 msgid "{@code{nslcd-configuration} parameter} package nss-pam-ldapd"
42659 #: guix-git/doc/guix.texi:23970
42660 msgid "The @code{nss-pam-ldapd} package to use."
42664 #: guix-git/doc/guix.texi:23973
42666 msgid "{@code{nslcd-configuration} parameter} maybe-number threads"
42670 #: guix-git/doc/guix.texi:23977
42671 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."
42675 #: guix-git/doc/guix.texi:23982
42677 msgid "{@code{nslcd-configuration} parameter} string uid"
42681 #: guix-git/doc/guix.texi:23984
42682 msgid "This specifies the user id with which the daemon should be run."
42686 #: guix-git/doc/guix.texi:23986 guix-git/doc/guix.texi:23993
42687 msgid "Defaults to @samp{\"nslcd\"}."
42691 #: guix-git/doc/guix.texi:23989
42693 msgid "{@code{nslcd-configuration} parameter} string gid"
42697 #: guix-git/doc/guix.texi:23991
42698 msgid "This specifies the group id with which the daemon should be run."
42702 #: guix-git/doc/guix.texi:23996
42704 msgid "{@code{nslcd-configuration} parameter} log-option log"
42708 #: guix-git/doc/guix.texi:24004
42709 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."
42713 #: guix-git/doc/guix.texi:24006
42714 msgid "Defaults to @samp{(\"/var/log/nslcd\" info)}."
42718 #: guix-git/doc/guix.texi:24009
42720 msgid "{@code{nslcd-configuration} parameter} list uri"
42724 #: guix-git/doc/guix.texi:24012
42725 msgid "The list of LDAP server URIs. Normally, only the first server will be used with the following servers as fall-back."
42729 #: guix-git/doc/guix.texi:24014
42730 msgid "Defaults to @samp{(\"ldap://localhost:389/\")}."
42734 #: guix-git/doc/guix.texi:24017
42736 msgid "{@code{nslcd-configuration} parameter} maybe-string ldap-version"
42740 #: guix-git/doc/guix.texi:24020
42741 msgid "The version of the LDAP protocol to use. The default is to use the maximum version supported by the LDAP library."
42745 #: guix-git/doc/guix.texi:24025
42747 msgid "{@code{nslcd-configuration} parameter} maybe-string binddn"
42751 #: guix-git/doc/guix.texi:24028
42752 msgid "Specifies the distinguished name with which to bind to the directory server for lookups. The default is to bind anonymously."
42756 #: guix-git/doc/guix.texi:24033
42758 msgid "{@code{nslcd-configuration} parameter} maybe-string bindpw"
42762 #: guix-git/doc/guix.texi:24036
42763 msgid "Specifies the credentials with which to bind. This option is only applicable when used with binddn."
42767 #: guix-git/doc/guix.texi:24041
42769 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmoddn"
42773 #: guix-git/doc/guix.texi:24044
42774 msgid "Specifies the distinguished name to use when the root user tries to modify a user's password using the PAM module."
42778 #: guix-git/doc/guix.texi:24049
42780 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmodpw"
42784 #: guix-git/doc/guix.texi:24053
42785 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"
42789 #: guix-git/doc/guix.texi:24058
42791 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-mech"
42795 #: guix-git/doc/guix.texi:24061
42796 msgid "Specifies the SASL mechanism to be used when performing SASL authentication."
42800 #: guix-git/doc/guix.texi:24066
42802 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-realm"
42806 #: guix-git/doc/guix.texi:24068
42807 msgid "Specifies the SASL realm to be used when performing SASL authentication."
42811 #: guix-git/doc/guix.texi:24073
42813 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authcid"
42817 #: guix-git/doc/guix.texi:24076
42818 msgid "Specifies the authentication identity to be used when performing SASL authentication."
42822 #: guix-git/doc/guix.texi:24081
42824 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authzid"
42828 #: guix-git/doc/guix.texi:24084
42829 msgid "Specifies the authorization identity to be used when performing SASL authentication."
42833 #: guix-git/doc/guix.texi:24089
42835 msgid "{@code{nslcd-configuration} parameter} maybe-boolean sasl-canonicalize?"
42839 #: guix-git/doc/guix.texi:24094
42840 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."
42844 #: guix-git/doc/guix.texi:24099
42846 msgid "{@code{nslcd-configuration} parameter} maybe-string krb5-ccname"
42850 #: guix-git/doc/guix.texi:24101
42851 msgid "Set the name for the GSS-API Kerberos credentials cache."
42855 #: guix-git/doc/guix.texi:24106
42857 msgid "{@code{nslcd-configuration} parameter} string base"
42861 #: guix-git/doc/guix.texi:24108
42862 msgid "The directory search base."
42866 #: guix-git/doc/guix.texi:24110
42867 msgid "Defaults to @samp{\"dc=example,dc=com\"}."
42871 #: guix-git/doc/guix.texi:24113
42873 msgid "{@code{nslcd-configuration} parameter} scope-option scope"
42877 #: guix-git/doc/guix.texi:24117
42878 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."
42882 #: guix-git/doc/guix.texi:24119
42883 msgid "Defaults to @samp{(subtree)}."
42887 #: guix-git/doc/guix.texi:24122
42889 msgid "{@code{nslcd-configuration} parameter} maybe-deref-option deref"
42893 #: guix-git/doc/guix.texi:24125
42894 msgid "Specifies the policy for dereferencing aliases. The default policy is to never dereference aliases."
42898 #: guix-git/doc/guix.texi:24130
42900 msgid "{@code{nslcd-configuration} parameter} maybe-boolean referrals"
42904 #: guix-git/doc/guix.texi:24133
42905 msgid "Specifies whether automatic referral chasing should be enabled. The default behaviour is to chase referrals."
42909 #: guix-git/doc/guix.texi:24138
42911 msgid "{@code{nslcd-configuration} parameter} list-of-map-entries maps"
42915 #: guix-git/doc/guix.texi:24143
42916 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."
42920 #: guix-git/doc/guix.texi:24148
42922 msgid "{@code{nslcd-configuration} parameter} list-of-filter-entries filters"
42926 #: guix-git/doc/guix.texi:24151
42927 msgid "A list of filters consisting of the name of a map to which the filter applies and an LDAP search filter expression."
42931 #: guix-git/doc/guix.texi:24156
42933 msgid "{@code{nslcd-configuration} parameter} maybe-number bind-timelimit"
42937 #: guix-git/doc/guix.texi:24159
42938 msgid "Specifies the time limit in seconds to use when connecting to the directory server. The default value is 10 seconds."
42942 #: guix-git/doc/guix.texi:24164
42944 msgid "{@code{nslcd-configuration} parameter} maybe-number timelimit"
42948 #: guix-git/doc/guix.texi:24168
42949 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."
42953 #: guix-git/doc/guix.texi:24173
42955 msgid "{@code{nslcd-configuration} parameter} maybe-number idle-timelimit"
42959 #: guix-git/doc/guix.texi:24177
42960 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."
42964 #: guix-git/doc/guix.texi:24182
42966 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-sleeptime"
42970 #: guix-git/doc/guix.texi:24186
42971 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."
42975 #: guix-git/doc/guix.texi:24191
42977 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-retrytime"
42981 #: guix-git/doc/guix.texi:24195
42982 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."
42986 #: guix-git/doc/guix.texi:24200
42988 msgid "{@code{nslcd-configuration} parameter} maybe-ssl-option ssl"
42992 #: guix-git/doc/guix.texi:24204
42993 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."
42997 #: guix-git/doc/guix.texi:24209
42999 msgid "{@code{nslcd-configuration} parameter} maybe-tls-reqcert-option tls-reqcert"
43003 #: guix-git/doc/guix.texi:24212
43004 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."
43008 #: guix-git/doc/guix.texi:24217
43010 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertdir"
43014 #: guix-git/doc/guix.texi:24220
43015 msgid "Specifies the directory containing X.509 certificates for peer authen‐ tication. This parameter is ignored when using GnuTLS."
43019 #: guix-git/doc/guix.texi:24225
43021 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertfile"
43025 #: guix-git/doc/guix.texi:24227
43026 msgid "Specifies the path to the X.509 certificate for peer authentication."
43030 #: guix-git/doc/guix.texi:24232
43032 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-randfile"
43036 #: guix-git/doc/guix.texi:24235
43037 msgid "Specifies the path to an entropy source. This parameter is ignored when using GnuTLS."
43041 #: guix-git/doc/guix.texi:24240
43043 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-ciphers"
43047 #: guix-git/doc/guix.texi:24242
43048 msgid "Specifies the ciphers to use for TLS as a string."
43052 #: guix-git/doc/guix.texi:24247
43054 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cert"
43058 #: guix-git/doc/guix.texi:24250
43059 msgid "Specifies the path to the file containing the local certificate for client TLS authentication."
43063 #: guix-git/doc/guix.texi:24255
43065 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-key"
43069 #: guix-git/doc/guix.texi:24258
43070 msgid "Specifies the path to the file containing the private key for client TLS authentication."
43074 #: guix-git/doc/guix.texi:24263
43076 msgid "{@code{nslcd-configuration} parameter} maybe-number pagesize"
43080 #: guix-git/doc/guix.texi:24267
43081 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."
43085 #: guix-git/doc/guix.texi:24272
43087 msgid "{@code{nslcd-configuration} parameter} maybe-ignore-users-option nss-initgroups-ignoreusers"
43091 #: guix-git/doc/guix.texi:24276
43092 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."
43096 #: guix-git/doc/guix.texi:24281
43098 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-min-uid"
43102 #: guix-git/doc/guix.texi:24284
43103 msgid "This option ensures that LDAP users with a numeric user id lower than the specified value are ignored."
43107 #: guix-git/doc/guix.texi:24289
43109 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-uid-offset"
43113 #: guix-git/doc/guix.texi:24292
43114 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."
43118 #: guix-git/doc/guix.texi:24297
43120 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-gid-offset"
43124 #: guix-git/doc/guix.texi:24300
43125 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."
43129 #: guix-git/doc/guix.texi:24305
43131 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-nested-groups"
43135 #: guix-git/doc/guix.texi:24311
43136 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."
43140 #: guix-git/doc/guix.texi:24316
43142 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-getgrent-skipmembers"
43146 #: guix-git/doc/guix.texi:24321
43147 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."
43151 #: guix-git/doc/guix.texi:24326
43153 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-disable-enumeration"
43157 #: guix-git/doc/guix.texi:24332
43158 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."
43162 #: guix-git/doc/guix.texi:24337
43164 msgid "{@code{nslcd-configuration} parameter} maybe-string validnames"
43168 #: guix-git/doc/guix.texi:24341
43169 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."
43173 #: guix-git/doc/guix.texi:24346
43175 msgid "{@code{nslcd-configuration} parameter} maybe-boolean ignorecase"
43179 #: guix-git/doc/guix.texi:24351
43180 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."
43184 #: guix-git/doc/guix.texi:24356
43186 msgid "{@code{nslcd-configuration} parameter} maybe-boolean pam-authc-ppolicy"
43190 #: guix-git/doc/guix.texi:24359
43191 msgid "This option specifies whether password policy controls are requested and handled from the LDAP server when performing user authentication."
43195 #: guix-git/doc/guix.texi:24364
43197 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authc-search"
43201 #: guix-git/doc/guix.texi:24370
43202 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."
43206 #: guix-git/doc/guix.texi:24375
43208 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authz-search"
43212 #: guix-git/doc/guix.texi:24379
43213 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."
43217 #: guix-git/doc/guix.texi:24384
43219 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-password-prohibit-message"
43223 #: guix-git/doc/guix.texi:24389
43224 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."
43228 #: guix-git/doc/guix.texi:24394
43230 msgid "{@code{nslcd-configuration} parameter} list pam-services"
43234 #: guix-git/doc/guix.texi:24396
43235 msgid "List of pam service names for which LDAP authentication should suffice."
43239 #: guix-git/doc/guix.texi:24407
43245 #: guix-git/doc/guix.texi:24408
43251 #: guix-git/doc/guix.texi:24409
43256 #. type: Plain text
43257 #: guix-git/doc/guix.texi:24412
43258 msgid "The @code{(gnu services web)} module provides the Apache HTTP Server, the nginx web server, and also a fastcgi wrapper daemon."
43261 #. type: subsubheading
43262 #: guix-git/doc/guix.texi:24413
43264 msgid "Apache HTTP Server"
43268 #: guix-git/doc/guix.texi:24415
43270 msgid "{Scheme Variable} httpd-service-type"
43274 #: guix-git/doc/guix.texi:24419
43275 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."
43279 #: guix-git/doc/guix.texi:24421 guix-git/doc/guix.texi:24602
43280 msgid "A simple example configuration is given below."
43284 #: guix-git/doc/guix.texi:24429
43287 "(service httpd-service-type\n"
43288 " (httpd-configuration\n"
43290 " (httpd-config-file\n"
43291 " (server-name \"www.example.com\")\n"
43292 " (document-root \"/srv/http/www.example.com\")))))\n"
43296 #: guix-git/doc/guix.texi:24433
43297 msgid "Other services can also extend the @code{httpd-service-type} to add to the configuration."
43301 #: guix-git/doc/guix.texi:24442 guix-git/doc/guix.texi:24582
43304 "(simple-service 'www.example.com-server httpd-service-type\n"
43306 " (httpd-virtualhost\n"
43308 " (list (string-join '(\"ServerName www.example.com\"\n"
43309 " \"DocumentRoot /srv/http/www.example.com\")\n"
43313 #. type: Plain text
43314 #: guix-git/doc/guix.texi:24448
43315 msgid "The details for the @code{httpd-configuration}, @code{httpd-module}, @code{httpd-config-file} and @code{httpd-virtualhost} record types are given below."
43319 #: guix-git/doc/guix.texi:24449
43321 msgid "{Data Type} httpd-configuration"
43325 #: guix-git/doc/guix.texi:24451
43326 msgid "This data type represents the configuration for the httpd service."
43330 #: guix-git/doc/guix.texi:24453
43332 msgid "@code{package} (default: @code{httpd})"
43336 #: guix-git/doc/guix.texi:24455
43337 msgid "The httpd package to use."
43341 #: guix-git/doc/guix.texi:24456 guix-git/doc/guix.texi:24545
43343 msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})"
43347 #: guix-git/doc/guix.texi:24458
43348 msgid "The pid file used by the shepherd-service."
43352 #: guix-git/doc/guix.texi:24459
43354 msgid "@code{config} (default: @code{(httpd-config-file)})"
43358 #: guix-git/doc/guix.texi:24464
43359 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."
43363 #: guix-git/doc/guix.texi:24468
43365 msgid "{Data Type} httpd-module"
43369 #: guix-git/doc/guix.texi:24470
43370 msgid "This data type represents a module for the httpd service."
43374 #: guix-git/doc/guix.texi:24474
43375 msgid "The name of the module."
43379 #: guix-git/doc/guix.texi:24480
43380 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\")}."
43384 #: guix-git/doc/guix.texi:24484
43386 msgid "{Scheme Variable} %default-httpd-modules"
43390 #: guix-git/doc/guix.texi:24486
43391 msgid "A default list of @code{httpd-module} objects."
43395 #: guix-git/doc/guix.texi:24488
43397 msgid "{Data Type} httpd-config-file"
43401 #: guix-git/doc/guix.texi:24490
43402 msgid "This data type represents a configuration file for the httpd service."
43406 #: guix-git/doc/guix.texi:24492
43408 msgid "@code{modules} (default: @code{%default-httpd-modules})"
43412 #: guix-git/doc/guix.texi:24495
43413 msgid "The modules to load. Additional modules can be added here, or loaded by additional configuration."
43417 #: guix-git/doc/guix.texi:24498
43418 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}:"
43422 #: guix-git/doc/guix.texi:24520
43425 "(service httpd-service-type\n"
43426 " (httpd-configuration\n"
43428 " (httpd-config-file\n"
43429 " (modules (cons*\n"
43431 " (name \"proxy_module\")\n"
43432 " (file \"modules/mod_proxy.so\"))\n"
43434 " (name \"proxy_fcgi_module\")\n"
43435 " (file \"modules/mod_proxy_fcgi.so\"))\n"
43436 " %default-httpd-modules))\n"
43437 " (extra-config (list \"\\\n"
43438 "<FilesMatch \\\\.php$>\n"
43439 " SetHandler \\\"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\\\"\n"
43440 "</FilesMatch>\"))))))\n"
43441 "(service php-fpm-service-type\n"
43442 " (php-fpm-configuration\n"
43443 " (socket \"/var/run/php-fpm.sock\")\n"
43444 " (socket-group \"httpd\")))\n"
43448 #: guix-git/doc/guix.texi:24522
43450 msgid "@code{server-root} (default: @code{httpd})"
43454 #: guix-git/doc/guix.texi:24526
43455 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."
43459 #: guix-git/doc/guix.texi:24527
43461 msgid "@code{server-name} (default: @code{#f})"
43465 #: guix-git/doc/guix.texi:24531
43466 msgid "The @code{ServerName} in the configuration file, used to specify the request scheme, hostname and port that the server uses to identify itself."
43470 #: guix-git/doc/guix.texi:24535
43471 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}."
43475 #: guix-git/doc/guix.texi:24536
43477 msgid "@code{document-root} (default: @code{\"/srv/http\"})"
43481 #: guix-git/doc/guix.texi:24538
43482 msgid "The @code{DocumentRoot} from which files will be served."
43486 #: guix-git/doc/guix.texi:24539
43488 msgid "@code{listen} (default: @code{'(\"80\")})"
43492 #: guix-git/doc/guix.texi:24544
43493 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."
43497 #: guix-git/doc/guix.texi:24549
43498 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."
43502 #: guix-git/doc/guix.texi:24550
43504 msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})"
43508 #: guix-git/doc/guix.texi:24552
43509 msgid "The @code{ErrorLog} to which the server will log errors."
43513 #: guix-git/doc/guix.texi:24553 guix-git/doc/guix.texi:25114
43515 msgid "@code{user} (default: @code{\"httpd\"})"
43519 #: guix-git/doc/guix.texi:24555
43520 msgid "The @code{User} which the server will answer requests as."
43524 #: guix-git/doc/guix.texi:24556
43526 msgid "@code{group} (default: @code{\"httpd\"})"
43530 #: guix-git/doc/guix.texi:24558
43531 msgid "The @code{Group} which the server will answer requests as."
43535 #: guix-git/doc/guix.texi:24559
43537 msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})"
43541 #: guix-git/doc/guix.texi:24562
43542 msgid "A flat list of strings and G-expressions which will be added to the end of the configuration file."
43546 #: guix-git/doc/guix.texi:24565
43547 msgid "Any values which the service is extended with will be appended to this list."
43551 #: guix-git/doc/guix.texi:24569
43553 msgid "{Data Type} httpd-virtualhost"
43557 #: guix-git/doc/guix.texi:24571
43558 msgid "This data type represents a virtualhost configuration block for the httpd service."
43562 #: guix-git/doc/guix.texi:24573
43563 msgid "These should be added to the extra-config for the httpd-service."
43567 #: guix-git/doc/guix.texi:24585
43569 msgid "addresses-and-ports"
43573 #: guix-git/doc/guix.texi:24587
43574 msgid "The addresses and ports for the @code{VirtualHost} directive."
43578 #: guix-git/doc/guix.texi:24588
43584 #: guix-git/doc/guix.texi:24591
43585 msgid "The contents of the @code{VirtualHost} directive, this should be a list of strings and G-expressions."
43588 #. type: subsubheading
43589 #: guix-git/doc/guix.texi:24595
43595 #: guix-git/doc/guix.texi:24597
43597 msgid "{Scheme Variable} nginx-service-type"
43601 #: guix-git/doc/guix.texi:24600
43602 msgid "Service type for the @uref{https://nginx.org/,NGinx} web server. The value for this service type is a @code{<nginx-configuration>} record."
43606 #: guix-git/doc/guix.texi:24610 guix-git/doc/guix.texi:24664
43609 "(service nginx-service-type\n"
43610 " (nginx-configuration\n"
43611 " (server-blocks\n"
43612 " (list (nginx-server-configuration\n"
43613 " (server-name '(\"www.example.com\"))\n"
43614 " (root \"/srv/http/www.example.com\"))))))\n"
43618 #: guix-git/doc/guix.texi:24615
43619 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:"
43623 #: guix-git/doc/guix.texi:24621
43626 "(simple-service 'my-extra-server nginx-service-type\n"
43627 " (list (nginx-server-configuration\n"
43628 " (root \"/srv/http/extra-website\")\n"
43629 " (try-files (list \"$uri\" \"$uri/index.html\")))))\n"
43632 #. type: Plain text
43633 #: guix-git/doc/guix.texi:24632
43634 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."
43638 #: guix-git/doc/guix.texi:24633
43640 msgid "{Data Type} nginx-configuration"
43644 #: guix-git/doc/guix.texi:24637
43645 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."
43649 #: guix-git/doc/guix.texi:24639
43651 msgid "@code{nginx} (default: @code{nginx})"
43655 #: guix-git/doc/guix.texi:24641
43656 msgid "The nginx package to use."
43660 #: guix-git/doc/guix.texi:24642
43662 msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})"
43666 #: guix-git/doc/guix.texi:24644
43667 msgid "The directory to which NGinx will write log files."
43671 #: guix-git/doc/guix.texi:24645
43673 msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})"
43677 #: guix-git/doc/guix.texi:24648
43678 msgid "The directory in which NGinx will create a pid file, and write temporary files."
43682 #: guix-git/doc/guix.texi:24649
43684 msgid "@code{server-blocks} (default: @code{'()})"
43688 #: guix-git/doc/guix.texi:24653
43689 msgid "A list of @dfn{server blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-server-configuration>}."
43693 #: guix-git/doc/guix.texi:24657
43694 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."
43698 #: guix-git/doc/guix.texi:24666
43700 msgid "@code{upstream-blocks} (default: @code{'()})"
43704 #: guix-git/doc/guix.texi:24670
43705 msgid "A list of @dfn{upstream blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-upstream-configuration>}."
43709 #: guix-git/doc/guix.texi:24677
43710 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."
43714 #: guix-git/doc/guix.texi:24696
43718 " nginx-service-type\n"
43719 " (nginx-configuration\n"
43720 " (server-blocks\n"
43721 " (list (nginx-server-configuration\n"
43722 " (server-name '(\"www.example.com\"))\n"
43723 " (root \"/srv/http/www.example.com\")\n"
43726 " (nginx-location-configuration\n"
43727 " (uri \"/path1\")\n"
43728 " (body '(\"proxy_pass http://server-proxy;\"))))))))\n"
43729 " (upstream-blocks\n"
43730 " (list (nginx-upstream-configuration\n"
43731 " (name \"server-proxy\")\n"
43732 " (servers (list \"server1.example.com\"\n"
43733 " \"server2.example.com\")))))))\n"
43737 #: guix-git/doc/guix.texi:24704
43738 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."
43742 #: guix-git/doc/guix.texi:24708
43743 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."
43747 #: guix-git/doc/guix.texi:24709
43749 msgid "@code{server-names-hash-bucket-size} (default: @code{#f})"
43753 #: guix-git/doc/guix.texi:24712
43754 msgid "Bucket size for the server names hash tables, defaults to @code{#f} to use the size of the processors cache line."
43758 #: guix-git/doc/guix.texi:24713
43760 msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})"
43764 #: guix-git/doc/guix.texi:24715
43765 msgid "Maximum bucket size for the server names hash tables."
43769 #: guix-git/doc/guix.texi:24719
43770 msgid "List of nginx dynamic modules to load. This should be a list of file names of loadable modules, as in this example:"
43774 #: guix-git/doc/guix.texi:24727
43779 " (file-append nginx-accept-language-module \"\\\n"
43780 "/etc/nginx/modules/ngx_http_accept_language_module.so\")\n"
43781 " (file-append nginx-lua-module \"\\\n"
43782 "/etc/nginx/modules/ngx_http_lua_module.so\")))\n"
43786 #: guix-git/doc/guix.texi:24729
43788 msgid "@code{lua-package-path} (default: @code{'()})"
43792 #: guix-git/doc/guix.texi:24732
43793 msgid "List of nginx lua packages to load. This should be a list of package names of loadable lua modules, as in this example:"
43797 #: guix-git/doc/guix.texi:24739
43800 "(lua-package-path (list lua-resty-core\n"
43801 " lua-resty-lrucache\n"
43802 " lua-resty-signal\n"
43804 " lua-resty-shell))\n"
43808 #: guix-git/doc/guix.texi:24741
43810 msgid "@code{lua-package-cpath} (default: @code{'()})"
43814 #: guix-git/doc/guix.texi:24744
43815 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:"
43819 #: guix-git/doc/guix.texi:24747
43821 msgid "(lua-package-cpath (list lua-resty-signal))\n"
43825 #: guix-git/doc/guix.texi:24749
43827 msgid "@code{global-directives} (default: @code{'((events . ()))})"
43831 #: guix-git/doc/guix.texi:24752
43832 msgid "Association list of global directives for the top level of the nginx configuration. Values may themselves be association lists."
43836 #: guix-git/doc/guix.texi:24758
43839 "(global-directives\n"
43840 " `((worker_processes . 16)\n"
43841 " (pcre_jit . on)\n"
43842 " (events . ((worker_connections . 1024)))))\n"
43846 #: guix-git/doc/guix.texi:24763
43847 msgid "Extra content for the @code{http} block. Should be string or a string valued G-expression."
43851 #: guix-git/doc/guix.texi:24767
43853 msgid "{Data Type} nginx-server-configuration"
43857 #: guix-git/doc/guix.texi:24770
43858 msgid "Data type representing the configuration of an nginx server block. This type has the following parameters:"
43862 #: guix-git/doc/guix.texi:24772
43864 msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})"
43868 #: guix-git/doc/guix.texi:24777
43869 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:"
43873 #: guix-git/doc/guix.texi:24780
43875 msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n"
43879 #: guix-git/doc/guix.texi:24782
43881 msgid "@code{server-name} (default: @code{(list 'default)})"
43885 #: guix-git/doc/guix.texi:24785
43886 msgid "A list of server names this server represents. @code{'default} represents the default server for connections matching no other server."
43890 #: guix-git/doc/guix.texi:24786
43892 msgid "@code{root} (default: @code{\"/srv/http\"})"
43896 #: guix-git/doc/guix.texi:24788
43897 msgid "Root of the website nginx will serve."
43901 #: guix-git/doc/guix.texi:24789
43903 msgid "@code{locations} (default: @code{'()})"
43907 #: guix-git/doc/guix.texi:24793
43908 msgid "A list of @dfn{nginx-location-configuration} or @dfn{nginx-named-location-configuration} records to use within this server block."
43912 #: guix-git/doc/guix.texi:24794
43914 msgid "@code{index} (default: @code{(list \"index.html\")})"
43918 #: guix-git/doc/guix.texi:24797
43919 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."
43923 #: guix-git/doc/guix.texi:24798
43925 msgid "@code{try-files} (default: @code{'()})"
43929 #: guix-git/doc/guix.texi:24801
43930 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."
43934 #: guix-git/doc/guix.texi:24802
43936 msgid "@code{ssl-certificate} (default: @code{#f})"
43940 #: guix-git/doc/guix.texi:24805
43941 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."
43945 #: guix-git/doc/guix.texi:24806
43947 msgid "@code{ssl-certificate-key} (default: @code{#f})"
43951 #: guix-git/doc/guix.texi:24809
43952 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."
43956 #: guix-git/doc/guix.texi:24810
43958 msgid "@code{server-tokens?} (default: @code{#f})"
43962 #: guix-git/doc/guix.texi:24812
43963 msgid "Whether the server should add its configuration to response."
43967 #: guix-git/doc/guix.texi:24813
43969 msgid "@code{raw-content} (default: @code{'()})"
43973 #: guix-git/doc/guix.texi:24815
43974 msgid "A list of raw lines added to the server block."
43978 #: guix-git/doc/guix.texi:24819
43980 msgid "{Data Type} nginx-upstream-configuration"
43984 #: guix-git/doc/guix.texi:24822
43985 msgid "Data type representing the configuration of an nginx @code{upstream} block. This type has the following parameters:"
43989 #: guix-git/doc/guix.texi:24826
43990 msgid "Name for this group of servers."
43994 #: guix-git/doc/guix.texi:24827
44000 #: guix-git/doc/guix.texi:24834
44001 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."
44005 #: guix-git/doc/guix.texi:24838
44007 msgid "{Data Type} nginx-location-configuration"
44011 #: guix-git/doc/guix.texi:24841
44012 msgid "Data type representing the configuration of an nginx @code{location} block. This type has the following parameters:"
44016 #: guix-git/doc/guix.texi:24845
44017 msgid "URI which this location block matches."
44020 #. type: anchor{#1}
44021 #: guix-git/doc/guix.texi:24847
44022 msgid "nginx-location-configuration body"
44026 #: guix-git/doc/guix.texi:24847 guix-git/doc/guix.texi:24868
44032 #: guix-git/doc/guix.texi:24854
44033 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;\")}."
44037 #: guix-git/doc/guix.texi:24858
44039 msgid "{Data Type} nginx-named-location-configuration"
44043 #: guix-git/doc/guix.texi:24863
44044 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:"
44048 #: guix-git/doc/guix.texi:24867
44049 msgid "Name to identify this location block."
44053 #: guix-git/doc/guix.texi:24873
44054 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."
44057 #. type: subsubheading
44058 #: guix-git/doc/guix.texi:24877
44060 msgid "Varnish Cache"
44064 #: guix-git/doc/guix.texi:24878
44069 #. type: Plain text
44070 #: guix-git/doc/guix.texi:24883
44071 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."
44075 #: guix-git/doc/guix.texi:24884
44077 msgid "{Scheme Variable} varnish-service-type"
44081 #: guix-git/doc/guix.texi:24886
44082 msgid "Service type for the Varnish daemon."
44086 #: guix-git/doc/guix.texi:24888
44088 msgid "{Data Type} varnish-configuration"
44092 #: guix-git/doc/guix.texi:24891
44093 msgid "Data type representing the @code{varnish} service configuration. This type has the following parameters:"
44097 #: guix-git/doc/guix.texi:24893
44099 msgid "@code{package} (default: @code{varnish})"
44103 #: guix-git/doc/guix.texi:24895
44104 msgid "The Varnish package to use."
44108 #: guix-git/doc/guix.texi:24896
44110 msgid "@code{name} (default: @code{\"default\"})"
44114 #: guix-git/doc/guix.texi:24901
44115 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."
44119 #: guix-git/doc/guix.texi:24904
44120 msgid "Pass the @code{-n} argument to other Varnish programs to connect to the named instance, e.g.@: @command{varnishncsa -n default}."
44124 #: guix-git/doc/guix.texi:24905
44126 msgid "@code{backend} (default: @code{\"localhost:8080\"})"
44130 #: guix-git/doc/guix.texi:24907
44131 msgid "The backend to use. This option has no effect if @code{vcl} is set."
44135 #: guix-git/doc/guix.texi:24908
44137 msgid "@code{vcl} (default: #f)"
44141 #: guix-git/doc/guix.texi:24913
44142 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."
44146 #: guix-git/doc/guix.texi:24917
44147 msgid "For example, to mirror @url{https://www.gnu.org,www.gnu.org} with VCL you can do something along these lines:"
44151 #: guix-git/doc/guix.texi:24923
44154 "(define %gnu-mirror\n"
44155 " (plain-file \"gnu.vcl\"\n"
44157 "backend gnu @{ .host = \\\"www.gnu.org\\\"; @}\"))\n"
44162 #: guix-git/doc/guix.texi:24931
44165 "(operating-system\n"
44167 " (services (cons (service varnish-service-type\n"
44168 " (varnish-configuration\n"
44169 " (listen '(\":80\"))\n"
44170 " (vcl %gnu-mirror)))\n"
44171 " %base-services)))\n"
44175 #: guix-git/doc/guix.texi:24935
44176 msgid "The configuration of an already running Varnish instance can be inspected and changed using the @command{varnishadm} program."
44180 #: guix-git/doc/guix.texi:24939
44181 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."
44185 #: guix-git/doc/guix.texi:24940
44187 msgid "@code{listen} (default: @code{'(\"localhost:80\")})"
44191 #: guix-git/doc/guix.texi:24942
44192 msgid "List of addresses Varnish will listen on."
44196 #: guix-git/doc/guix.texi:24943
44198 msgid "@code{storage} (default: @code{'(\"malloc,128m\")})"
44202 #: guix-git/doc/guix.texi:24945
44203 msgid "List of storage backends that will be available in VCL."
44207 #: guix-git/doc/guix.texi:24946
44209 msgid "@code{parameters} (default: @code{'()})"
44213 #: guix-git/doc/guix.texi:24948
44214 msgid "List of run-time parameters in the form @code{'((\"parameter\" . \"value\"))}."
44218 #: guix-git/doc/guix.texi:24951
44219 msgid "Additional arguments to pass to the @command{varnishd} process."
44223 #: guix-git/doc/guix.texi:24955 guix-git/doc/guix.texi:24956
44228 #. type: Plain text
44229 #: guix-git/doc/guix.texi:24959
44230 msgid "Patchwork is a patch tracking system. It can collect patches sent to a mailing list, and display them in a web interface."
44234 #: guix-git/doc/guix.texi:24960
44236 msgid "{Scheme Variable} patchwork-service-type"
44240 #: guix-git/doc/guix.texi:24962
44241 msgid "Service type for Patchwork."
44244 #. type: Plain text
44245 #: guix-git/doc/guix.texi:24966
44246 msgid "The following example is an example of a minimal service for Patchwork, for the @code{patchwork.example.com} domain."
44250 #: guix-git/doc/guix.texi:24986
44253 "(service patchwork-service-type\n"
44254 " (patchwork-configuration\n"
44255 " (domain \"patchwork.example.com\")\n"
44256 " (settings-module\n"
44257 " (patchwork-settings-module\n"
44258 " (allowed-hosts (list domain))\n"
44259 " (default-from-email \"patchwork@@patchwork.example.com\")))\n"
44260 " (getmail-retriever-config\n"
44261 " (getmail-retriever-configuration\n"
44262 " (type \"SimpleIMAPSSLRetriever\")\n"
44263 " (server \"imap.example.com\")\n"
44265 " (username \"patchwork\")\n"
44266 " (password-command\n"
44267 " (list (file-append coreutils \"/bin/cat\")\n"
44268 " \"/etc/getmail-patchwork-imap-password\"))\n"
44269 " (extra-parameters\n"
44270 " '((mailboxes . (\"Patches\"))))))))\n"
44274 #. type: Plain text
44275 #: guix-git/doc/guix.texi:24992
44276 msgid "There are three records for configuring the Patchwork service. The @code{<patchwork-configuration>} relates to the configuration for Patchwork within the HTTPD service."
44279 #. type: Plain text
44280 #: guix-git/doc/guix.texi:24996
44281 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."
44284 #. type: Plain text
44285 #: guix-git/doc/guix.texi:25000
44286 msgid "For the @code{database-configuration} field within the @code{<patchwork-settings-module>}, the @code{<patchwork-database-configuration>} must be used."
44290 #: guix-git/doc/guix.texi:25001
44292 msgid "{Data Type} patchwork-configuration"
44296 #: guix-git/doc/guix.texi:25004
44297 msgid "Data type representing the Patchwork service configuration. This type has the following parameters:"
44301 #: guix-git/doc/guix.texi:25006
44303 msgid "@code{patchwork} (default: @code{patchwork})"
44307 #: guix-git/doc/guix.texi:25008
44308 msgid "The Patchwork package to use."
44312 #: guix-git/doc/guix.texi:25009
44318 #: guix-git/doc/guix.texi:25012
44319 msgid "The domain to use for Patchwork, this is used in the HTTPD service virtual host."
44323 #: guix-git/doc/guix.texi:25013
44325 msgid "settings-module"
44329 #: guix-git/doc/guix.texi:25019
44330 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."
44334 #: guix-git/doc/guix.texi:25020
44336 msgid "@code{static-path} (default: @code{\"/static/\"})"
44340 #: guix-git/doc/guix.texi:25022
44341 msgid "The path under which the HTTPD service should serve the static files."
44345 #: guix-git/doc/guix.texi:25023
44347 msgid "getmail-retriever-config"
44351 #: guix-git/doc/guix.texi:25027
44352 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."
44356 #: guix-git/doc/guix.texi:25031
44358 msgid "{Data Type} patchwork-settings-module"
44362 #: guix-git/doc/guix.texi:25036
44363 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:"
44367 #: guix-git/doc/guix.texi:25038
44369 msgid "@code{database-configuration} (default: @code{(patchwork-database-configuration)})"
44373 #: guix-git/doc/guix.texi:25041
44374 msgid "The database connection settings used for Patchwork. See the @code{<patchwork-database-configuration>} record type for more information."
44378 #: guix-git/doc/guix.texi:25042
44380 msgid "@code{secret-key-file} (default: @code{\"/etc/patchwork/django-secret-key\"})"
44384 #: guix-git/doc/guix.texi:25045
44385 msgid "Patchwork, as a Django web application uses a secret key for cryptographically signing values. This file should contain a unique unpredictable value."
44389 #: guix-git/doc/guix.texi:25048
44390 msgid "If this file does not exist, it will be created and populated with a random value by the patchwork-setup shepherd service."
44394 #: guix-git/doc/guix.texi:25050
44395 msgid "This setting relates to Django."
44399 #: guix-git/doc/guix.texi:25051
44401 msgid "allowed-hosts"
44405 #: guix-git/doc/guix.texi:25054
44406 msgid "A list of valid hosts for this Patchwork service. This should at least include the domain specified in the @code{<patchwork-configuration>} record."
44410 #: guix-git/doc/guix.texi:25056 guix-git/doc/guix.texi:25070
44411 #: guix-git/doc/guix.texi:25076 guix-git/doc/guix.texi:25082
44412 msgid "This is a Django setting."
44416 #: guix-git/doc/guix.texi:25057
44418 msgid "default-from-email"
44422 #: guix-git/doc/guix.texi:25059
44423 msgid "The email address from which Patchwork should send email by default."
44427 #: guix-git/doc/guix.texi:25061 guix-git/doc/guix.texi:25087
44428 #: guix-git/doc/guix.texi:25092 guix-git/doc/guix.texi:25097
44429 msgid "This is a Patchwork setting."
44433 #: guix-git/doc/guix.texi:25062
44435 msgid "@code{static-url} (default: @code{#f})"
44439 #: guix-git/doc/guix.texi:25065
44440 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{/}."
44444 #: guix-git/doc/guix.texi:25068
44445 msgid "If the default value is used, the @code{static-path} value from the @code{<patchwork-configuration>} record will be used."
44449 #: guix-git/doc/guix.texi:25071
44451 msgid "@code{admins} (default: @code{'()})"
44455 #: guix-git/doc/guix.texi:25074
44456 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."
44460 #: guix-git/doc/guix.texi:25080
44461 msgid "Whether to run Patchwork in debug mode. If set to @code{#t}, detailed error messages will be shown."
44465 #: guix-git/doc/guix.texi:25083
44467 msgid "@code{enable-rest-api?} (default: @code{#t})"
44471 #: guix-git/doc/guix.texi:25085
44472 msgid "Whether to enable the Patchwork REST API."
44476 #: guix-git/doc/guix.texi:25088
44478 msgid "@code{enable-xmlrpc?} (default: @code{#t})"
44482 #: guix-git/doc/guix.texi:25090
44483 msgid "Whether to enable the XML RPC API."
44487 #: guix-git/doc/guix.texi:25093
44489 msgid "@code{force-https-links?} (default: @code{#t})"
44493 #: guix-git/doc/guix.texi:25095
44494 msgid "Whether to use HTTPS links on Patchwork pages."
44498 #: guix-git/doc/guix.texi:25100
44499 msgid "Extra code to place at the end of the Patchwork settings module."
44503 #: guix-git/doc/guix.texi:25104
44505 msgid "{Data Type} patchwork-database-configuration"
44509 #: guix-git/doc/guix.texi:25106
44510 msgid "Data type representing the database configuration for Patchwork."
44514 #: guix-git/doc/guix.texi:25108
44516 msgid "@code{engine} (default: @code{\"django.db.backends.postgresql_psycopg2\"})"
44520 #: guix-git/doc/guix.texi:25110
44521 msgid "The database engine to use."
44525 #: guix-git/doc/guix.texi:25111
44527 msgid "@code{name} (default: @code{\"patchwork\"})"
44531 #: guix-git/doc/guix.texi:25113
44532 msgid "The name of the database to use."
44536 #: guix-git/doc/guix.texi:25116
44537 msgid "The user to connect to the database as."
44541 #: guix-git/doc/guix.texi:25117
44543 msgid "@code{password} (default: @code{\"\"})"
44547 #: guix-git/doc/guix.texi:25119
44548 msgid "The password to use when connecting to the database."
44552 #: guix-git/doc/guix.texi:25120
44554 msgid "@code{host} (default: @code{\"\"})"
44558 #: guix-git/doc/guix.texi:25122
44559 msgid "The host to make the database connection to."
44563 #: guix-git/doc/guix.texi:25123
44565 msgid "@code{port} (default: @code{\"\"})"
44569 #: guix-git/doc/guix.texi:25125
44570 msgid "The port on which to connect to the database."
44573 #. type: subsubheading
44574 #: guix-git/doc/guix.texi:25129
44580 #: guix-git/doc/guix.texi:25131
44582 msgid "Mumi, Debbugs Web interface"
44586 #: guix-git/doc/guix.texi:25132
44588 msgid "Debbugs, Mumi Web interface"
44591 #. type: Plain text
44592 #: guix-git/doc/guix.texi:25137
44593 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."
44597 #: guix-git/doc/guix.texi:25138
44599 msgid "{Scheme Variable} mumi-service-type"
44603 #: guix-git/doc/guix.texi:25140
44604 msgid "This is the service type for Mumi."
44608 #: guix-git/doc/guix.texi:25142
44610 msgid "{Data Type} mumi-configuration"
44614 #: guix-git/doc/guix.texi:25145
44615 msgid "Data type representing the Mumi service configuration. This type has the following fields:"
44619 #: guix-git/doc/guix.texi:25147
44621 msgid "@code{mumi} (default: @code{mumi})"
44625 #: guix-git/doc/guix.texi:25149
44626 msgid "The Mumi package to use."
44630 #: guix-git/doc/guix.texi:25150
44632 msgid "@code{mailer?} (default: @code{#true})"
44636 #: guix-git/doc/guix.texi:25152
44637 msgid "Whether to enable or disable the mailer component."
44641 #: guix-git/doc/guix.texi:25153
44643 msgid "mumi-configuration-sender"
44647 #: guix-git/doc/guix.texi:25155
44648 msgid "The email address used as the sender for comments."
44652 #: guix-git/doc/guix.texi:25156
44654 msgid "mumi-configuration-smtp"
44658 #: guix-git/doc/guix.texi:25161
44659 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}."
44662 #. type: subsubheading
44663 #: guix-git/doc/guix.texi:25166
44669 #: guix-git/doc/guix.texi:25167
44675 #: guix-git/doc/guix.texi:25168
44680 #. type: Plain text
44681 #: guix-git/doc/guix.texi:25175
44682 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."
44685 #. type: Plain text
44686 #: guix-git/doc/guix.texi:25182
44687 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."
44691 #: guix-git/doc/guix.texi:25183
44693 msgid "{Scheme Variable} fcgiwrap-service-type"
44697 #: guix-git/doc/guix.texi:25185
44698 msgid "A service type for the @code{fcgiwrap} FastCGI proxy."
44702 #: guix-git/doc/guix.texi:25187
44704 msgid "{Data Type} fcgiwrap-configuration"
44708 #: guix-git/doc/guix.texi:25190
44709 msgid "Data type representing the configuration of the @code{fcgiwrap} service. This type has the following parameters:"
44713 #: guix-git/doc/guix.texi:25191
44715 msgid "@code{package} (default: @code{fcgiwrap})"
44719 #: guix-git/doc/guix.texi:25193
44720 msgid "The fcgiwrap package to use."
44724 #: guix-git/doc/guix.texi:25194
44726 msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})"
44730 #: guix-git/doc/guix.texi:25200
44731 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}."
44735 #: guix-git/doc/guix.texi:25201
44737 msgid "@code{user} (default: @code{fcgiwrap})"
44741 #: guix-git/doc/guix.texi:25202
44743 msgid "@code{group} (default: @code{fcgiwrap})"
44747 #: guix-git/doc/guix.texi:25207
44748 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."
44752 #: guix-git/doc/guix.texi:25214
44753 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."
44757 #: guix-git/doc/guix.texi:25217
44762 #. type: Plain text
44763 #: guix-git/doc/guix.texi:25220
44764 msgid "PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size."
44767 #. type: Plain text
44768 #: guix-git/doc/guix.texi:25222
44769 msgid "These features include:"
44773 #: guix-git/doc/guix.texi:25223
44775 msgid "Adaptive process spawning"
44779 #: guix-git/doc/guix.texi:25224
44781 msgid "Basic statistics (similar to Apache's mod_status)"
44785 #: guix-git/doc/guix.texi:25225
44787 msgid "Advanced process management with graceful stop/start"
44791 #: guix-git/doc/guix.texi:25226
44793 msgid "Ability to start workers with different uid/gid/chroot/environment"
44797 #: guix-git/doc/guix.texi:25228
44798 msgid "and different php.ini (replaces safe_mode)"
44802 #: guix-git/doc/guix.texi:25228
44804 msgid "Stdout & stderr logging"
44808 #: guix-git/doc/guix.texi:25229
44810 msgid "Emergency restart in case of accidental opcode cache destruction"
44814 #: guix-git/doc/guix.texi:25230
44816 msgid "Accelerated upload support"
44820 #: guix-git/doc/guix.texi:25231
44822 msgid "Support for a \"slowlog\""
44826 #: guix-git/doc/guix.texi:25232
44828 msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -"
44832 #: guix-git/doc/guix.texi:25235
44833 msgid "a special function to finish request & flush all data while continuing to do something time-consuming (video converting, stats processing, etc.)"
44836 #. type: Plain text
44837 #: guix-git/doc/guix.texi:25237
44838 msgid "...@: and much more."
44842 #: guix-git/doc/guix.texi:25238
44844 msgid "{Scheme Variable} php-fpm-service-type"
44848 #: guix-git/doc/guix.texi:25240
44849 msgid "A Service type for @code{php-fpm}."
44853 #: guix-git/doc/guix.texi:25242
44855 msgid "{Data Type} php-fpm-configuration"
44859 #: guix-git/doc/guix.texi:25244
44860 msgid "Data Type for php-fpm service configuration."
44864 #: guix-git/doc/guix.texi:25245
44866 msgid "@code{php} (default: @code{php})"
44870 #: guix-git/doc/guix.texi:25247
44871 msgid "The php package to use."
44875 #: guix-git/doc/guix.texi:25247
44877 msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})"
44881 #: guix-git/doc/guix.texi:25249
44882 msgid "The address on which to accept FastCGI requests. Valid syntaxes are:"
44886 #: guix-git/doc/guix.texi:25250
44888 msgid "\"ip.add.re.ss:port\""
44892 #: guix-git/doc/guix.texi:25252
44893 msgid "Listen on a TCP socket to a specific address on a specific port."
44897 #: guix-git/doc/guix.texi:25252
44903 #: guix-git/doc/guix.texi:25254
44904 msgid "Listen on a TCP socket to all addresses on a specific port."
44908 #: guix-git/doc/guix.texi:25254
44910 msgid "\"/path/to/unix/socket\""
44914 #: guix-git/doc/guix.texi:25256
44915 msgid "Listen on a unix socket."
44919 #: guix-git/doc/guix.texi:25258
44921 msgid "@code{user} (default: @code{php-fpm})"
44925 #: guix-git/doc/guix.texi:25260
44926 msgid "User who will own the php worker processes."
44930 #: guix-git/doc/guix.texi:25260
44932 msgid "@code{group} (default: @code{php-fpm})"
44936 #: guix-git/doc/guix.texi:25262
44937 msgid "Group of the worker processes."
44941 #: guix-git/doc/guix.texi:25262
44943 msgid "@code{socket-user} (default: @code{php-fpm})"
44947 #: guix-git/doc/guix.texi:25264
44948 msgid "User who can speak to the php-fpm socket."
44952 #: guix-git/doc/guix.texi:25264
44954 msgid "@code{socket-group} (default: @code{nginx})"
44958 #: guix-git/doc/guix.texi:25266
44959 msgid "Group that can speak to the php-fpm socket."
44963 #: guix-git/doc/guix.texi:25266
44965 msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})"
44969 #: guix-git/doc/guix.texi:25269
44970 msgid "The process id of the php-fpm process is written to this file once the service has started."
44974 #: guix-git/doc/guix.texi:25269
44976 msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})"
44980 #: guix-git/doc/guix.texi:25271
44981 msgid "Log for the php-fpm master process."
44985 #: guix-git/doc/guix.texi:25271
44987 msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})"
44991 #: guix-git/doc/guix.texi:25274
44992 msgid "Detailed settings for the php-fpm process manager. Must be one of:"
44996 #: guix-git/doc/guix.texi:25275
44998 msgid "<php-fpm-dynamic-process-manager-configuration>"
45002 #: guix-git/doc/guix.texi:25276
45004 msgid "<php-fpm-static-process-manager-configuration>"
45008 #: guix-git/doc/guix.texi:25277
45010 msgid "<php-fpm-on-demand-process-manager-configuration>"
45014 #: guix-git/doc/guix.texi:25279
45016 msgid "@code{display-errors} (default @code{#f})"
45020 #: guix-git/doc/guix.texi:25284
45021 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."
45025 #: guix-git/doc/guix.texi:25284
45027 msgid "@code{timezone} (default @code{#f})"
45031 #: guix-git/doc/guix.texi:25286
45032 msgid "Specifies @code{php_admin_value[date.timezone]} parameter."
45036 #: guix-git/doc/guix.texi:25286
45038 msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})"
45042 #: guix-git/doc/guix.texi:25289
45043 msgid "This file will log the @code{stderr} outputs of php worker processes. Can be set to @code{#f} to disable logging."
45047 #: guix-git/doc/guix.texi:25289
45049 msgid "@code{file} (default @code{#f})"
45053 #: guix-git/doc/guix.texi:25292
45054 msgid "An optional override of the whole configuration. You can use the @code{mixed-text-file} function or an absolute filepath for it."
45058 #: guix-git/doc/guix.texi:25292
45060 msgid "@code{php-ini-file} (default @code{#f})"
45064 #: guix-git/doc/guix.texi:25296
45065 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."
45069 #: guix-git/doc/guix.texi:25300
45070 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:"
45074 #: guix-git/doc/guix.texi:25305
45077 "(define %local-php-ini\n"
45078 " (plain-file \"php.ini\"\n"
45079 " \"memory_limit = 2G\n"
45080 "max_execution_time = 1800\"))\n"
45085 #: guix-git/doc/guix.texi:25312
45088 "(operating-system\n"
45090 " (services (cons (service php-fpm-service-type\n"
45091 " (php-fpm-configuration\n"
45092 " (php-ini-file %local-php-ini)))\n"
45093 " %base-services)))\n"
45097 #: guix-git/doc/guix.texi:25317
45098 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."
45102 #: guix-git/doc/guix.texi:25320
45104 msgid "{Data type} php-fpm-dynamic-process-manager-configuration"
45108 #: guix-git/doc/guix.texi:25324
45109 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."
45113 #: guix-git/doc/guix.texi:25325 guix-git/doc/guix.texi:25341
45114 #: guix-git/doc/guix.texi:25351
45116 msgid "@code{max-children} (default: @code{5})"
45120 #: guix-git/doc/guix.texi:25327 guix-git/doc/guix.texi:25343
45121 #: guix-git/doc/guix.texi:25353
45122 msgid "Maximum of worker processes."
45126 #: guix-git/doc/guix.texi:25327
45128 msgid "@code{start-servers} (default: @code{2})"
45132 #: guix-git/doc/guix.texi:25329
45133 msgid "How many worker processes should be started on start-up."
45137 #: guix-git/doc/guix.texi:25329
45139 msgid "@code{min-spare-servers} (default: @code{1})"
45143 #: guix-git/doc/guix.texi:25331
45144 msgid "How many spare worker processes should be kept around at minimum."
45148 #: guix-git/doc/guix.texi:25331
45150 msgid "@code{max-spare-servers} (default: @code{3})"
45154 #: guix-git/doc/guix.texi:25333
45155 msgid "How many spare worker processes should be kept around at maximum."
45159 #: guix-git/doc/guix.texi:25336
45161 msgid "{Data type} php-fpm-static-process-manager-configuration"
45165 #: guix-git/doc/guix.texi:25340
45166 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."
45170 #: guix-git/doc/guix.texi:25346
45172 msgid "{Data type} php-fpm-on-demand-process-manager-configuration"
45176 #: guix-git/doc/guix.texi:25350
45177 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."
45181 #: guix-git/doc/guix.texi:25353
45183 msgid "@code{process-idle-timeout} (default: @code{10})"
45187 #: guix-git/doc/guix.texi:25355
45188 msgid "The time in seconds after which a process with no requests is killed."
45192 #: guix-git/doc/guix.texi:25359
45194 msgid "{Scheme Procedure} nginx-php-location @"
45198 #: guix-git/doc/guix.texi:25365
45199 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}."
45202 #. type: Plain text
45203 #: guix-git/doc/guix.texi:25368
45204 msgid "A simple services setup for nginx with php can look like this:"
45208 #: guix-git/doc/guix.texi:25381
45211 "(services (cons* (service dhcp-client-service-type)\n"
45212 " (service php-fpm-service-type)\n"
45213 " (service nginx-service-type\n"
45214 " (nginx-server-configuration\n"
45215 " (server-name '(\"example.com\"))\n"
45216 " (root \"/srv/http/\")\n"
45218 " (list (nginx-php-location)))\n"
45219 " (listen '(\"80\"))\n"
45220 " (ssl-certificate #f)\n"
45221 " (ssl-certificate-key #f)))\n"
45222 " %base-services))\n"
45226 #: guix-git/doc/guix.texi:25383
45228 msgid "cat-avatar-generator"
45231 #. type: Plain text
45232 #: guix-git/doc/guix.texi:25387
45233 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."
45237 #: guix-git/doc/guix.texi:25388
45239 msgid "{Scheme Procedure} cat-avatar-generator-service @"
45243 #: guix-git/doc/guix.texi:25396
45244 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."
45247 #. type: Plain text
45248 #: guix-git/doc/guix.texi:25399
45249 msgid "A simple setup for cat-avatar-generator can look like this:"
45253 #: guix-git/doc/guix.texi:25406
45256 "(services (cons* (cat-avatar-generator-service\n"
45257 " #:configuration\n"
45258 " (nginx-server-configuration\n"
45259 " (server-name '(\"example.com\"))))\n"
45261 " %base-services))\n"
45264 #. type: subsubheading
45265 #: guix-git/doc/guix.texi:25408
45267 msgid "Hpcguix-web"
45271 #: guix-git/doc/guix.texi:25410
45273 msgid "hpcguix-web"
45276 #. type: Plain text
45277 #: guix-git/doc/guix.texi:25415
45278 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."
45282 #: guix-git/doc/guix.texi:25416
45284 msgid "{Scheme Variable} hpcguix-web-service-type"
45288 #: guix-git/doc/guix.texi:25418
45289 msgid "The service type for @code{hpcguix-web}."
45293 #: guix-git/doc/guix.texi:25420
45295 msgid "{Data Type} hpcguix-web-configuration"
45299 #: guix-git/doc/guix.texi:25422
45300 msgid "Data type for the hpcguix-web service configuration."
45304 #: guix-git/doc/guix.texi:25424
45310 #: guix-git/doc/guix.texi:25427
45311 msgid "A gexp (@pxref{G-Expressions}) specifying the hpcguix-web service configuration. The main items available in this spec are:"
45315 #: guix-git/doc/guix.texi:25429
45317 msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})"
45321 #: guix-git/doc/guix.texi:25431
45322 msgid "The page title prefix."
45326 #: guix-git/doc/guix.texi:25432
45328 msgid "@code{guix-command} (default: @code{\"guix\"})"
45332 #: guix-git/doc/guix.texi:25434
45333 msgid "The @command{guix} command."
45337 #: guix-git/doc/guix.texi:25435
45339 msgid "@code{package-filter-proc} (default: @code{(const #t)})"
45343 #: guix-git/doc/guix.texi:25437
45344 msgid "A procedure specifying how to filter packages that are displayed."
45348 #: guix-git/doc/guix.texi:25438
45350 msgid "@code{package-page-extension-proc} (default: @code{(const '())})"
45354 #: guix-git/doc/guix.texi:25440
45355 msgid "Extension package for @code{hpcguix-web}."
45359 #: guix-git/doc/guix.texi:25441
45361 msgid "@code{menu} (default: @code{'()})"
45365 #: guix-git/doc/guix.texi:25443
45366 msgid "Additional entry in page @code{menu}."
45370 #: guix-git/doc/guix.texi:25444
45372 msgid "@code{channels} (default: @code{%default-channels})"
45376 #: guix-git/doc/guix.texi:25446
45377 msgid "List of channels from which the package list is built (@pxref{Channels})."
45381 #: guix-git/doc/guix.texi:25447
45383 msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})"
45387 #: guix-git/doc/guix.texi:25450
45388 msgid "The expiration time, in seconds, after which the package list is rebuilt from the latest instances of the given channels."
45392 #: guix-git/doc/guix.texi:25455
45393 msgid "See the hpcguix-web repository for a @uref{https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm, complete example}."
45397 #: guix-git/doc/guix.texi:25456
45399 msgid "@code{package} (default: @code{hpcguix-web})"
45403 #: guix-git/doc/guix.texi:25458
45404 msgid "The hpcguix-web package to use."
45407 #. type: Plain text
45408 #: guix-git/doc/guix.texi:25462
45409 msgid "A typical hpcguix-web service declaration looks like this:"
45413 #: guix-git/doc/guix.texi:25471
45416 "(service hpcguix-web-service-type\n"
45417 " (hpcguix-web-configuration\n"
45419 " #~(define site-config\n"
45420 " (hpcweb-configuration\n"
45421 " (title-prefix \"Guix-HPC - \")\n"
45422 " (menu '((\"/about\" \"ABOUT\"))))))))\n"
45426 #: guix-git/doc/guix.texi:25478
45427 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."
45431 #: guix-git/doc/guix.texi:25482
45432 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."
45436 #: guix-git/doc/guix.texi:25484 guix-git/doc/guix.texi:25486
45441 #. type: Plain text
45442 #: guix-git/doc/guix.texi:25489
45443 msgid "The @uref{https://git.sr.ht/~sircmpwn/gmnisrv, gmnisrv} program is a simple @uref{https://gemini.circumlunar.space/, Gemini} protocol server."
45447 #: guix-git/doc/guix.texi:25490
45449 msgid "{Scheme Variable} gmnisrv-service-type"
45453 #: guix-git/doc/guix.texi:25493
45454 msgid "This is the type of the gmnisrv service, whose value should be a @code{gmnisrv-configuration} object, as in this example:"
45458 #: guix-git/doc/guix.texi:25498
45461 "(service gmnisrv-service-type\n"
45462 " (gmnisrv-configuration\n"
45463 " (config-file (local-file \"./my-gmnisrv.ini\"))))\n"
45467 #: guix-git/doc/guix.texi:25501
45469 msgid "{Data Type} gmnisrv-configuration"
45473 #: guix-git/doc/guix.texi:25503
45474 msgid "Data type representing the configuration of gmnisrv."
45478 #: guix-git/doc/guix.texi:25505
45480 msgid "@code{package} (default: @var{gmnisrv})"
45484 #: guix-git/doc/guix.texi:25507
45485 msgid "Package object of the gmnisrv server."
45489 #: guix-git/doc/guix.texi:25508
45491 msgid "@code{config-file} (default: @code{%default-gmnisrv-config-file})"
45495 #: guix-git/doc/guix.texi:25514
45496 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}."
45499 #. type: subsubheading
45500 #: guix-git/doc/guix.texi:25518
45506 #: guix-git/doc/guix.texi:25520
45511 #. type: Plain text
45512 #: guix-git/doc/guix.texi:25525
45513 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."
45517 #: guix-git/doc/guix.texi:25526
45519 msgid "{Scheme Variable} agate-service-type"
45523 #: guix-git/doc/guix.texi:25529
45524 msgid "This is the type of the agate service, whose value should be an @code{agate-service-type} object, as in this example:"
45528 #: guix-git/doc/guix.texi:25536
45531 "(service agate-service-type\n"
45532 "\t (agate-configuration\n"
45533 "\t (content \"/srv/gemini\")\n"
45534 "\t (cert \"/srv/cert.pem\")\n"
45535 "\t (key \"/srv/key.rsa\")))\n"
45539 #: guix-git/doc/guix.texi:25541
45540 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."
45544 #: guix-git/doc/guix.texi:25544
45545 msgid "To obtain a certificate and a key, you could, for example, use OpenSSL, running a command similar to the following example:"
45549 #: guix-git/doc/guix.texi:25548
45552 "openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \\\n"
45553 " -days 3650 -nodes -subj \"/CN=example.com\"\n"
45557 #: guix-git/doc/guix.texi:25553
45558 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."
45562 #: guix-git/doc/guix.texi:25556
45564 msgid "{Data Type} agate-configuration"
45568 #: guix-git/doc/guix.texi:25558
45569 msgid "Data type representing the configuration of Agate."
45573 #: guix-git/doc/guix.texi:25560
45575 msgid "@code{package} (default: @code{agate})"
45579 #: guix-git/doc/guix.texi:25562
45580 msgid "The package object of the Agate server."
45584 #: guix-git/doc/guix.texi:25563
45586 msgid "@code{content} (default: @file{\"/srv/gemini\"})"
45590 #: guix-git/doc/guix.texi:25565
45591 msgid "The directory from which Agate will serve files."
45595 #: guix-git/doc/guix.texi:25566
45597 msgid "@code{cert} (default: @code{#f})"
45601 #: guix-git/doc/guix.texi:25569
45602 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."
45606 #: guix-git/doc/guix.texi:25570 guix-git/doc/guix.texi:25998
45608 msgid "@code{key} (default: @code{#f})"
45612 #: guix-git/doc/guix.texi:25573
45613 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."
45617 #: guix-git/doc/guix.texi:25574
45619 msgid "@code{addr} (default: @code{'(\"0.0.0.0:1965\" \"[::]:1965\")})"
45623 #: guix-git/doc/guix.texi:25576
45624 msgid "A list of the addresses to listen on."
45628 #: guix-git/doc/guix.texi:25579
45629 msgid "The domain name of this Gemini server. Optional."
45633 #: guix-git/doc/guix.texi:25580
45635 msgid "@code{lang} (default: @code{#f})"
45639 #: guix-git/doc/guix.texi:25582
45640 msgid "RFC 4646 language code(s) for text/gemini documents. Optional."
45644 #: guix-git/doc/guix.texi:25583
45646 msgid "@code{silent?} (default: @code{#f})"
45650 #: guix-git/doc/guix.texi:25585
45651 msgid "Set to @code{#t} to disable logging output."
45655 #: guix-git/doc/guix.texi:25586
45657 msgid "@code{serve-secret?} (default: @code{#f})"
45661 #: guix-git/doc/guix.texi:25589
45662 msgid "Set to @code{#t} to serve secret files (files/directories starting with a dot)."
45666 #: guix-git/doc/guix.texi:25590
45668 msgid "@code{log-ip?} (default: @code{#t})"
45672 #: guix-git/doc/guix.texi:25592
45673 msgid "Whether or not to output IP addresses when logging."
45677 #: guix-git/doc/guix.texi:25593
45679 msgid "@code{user} (default: @code{\"agate\"})"
45683 #: guix-git/doc/guix.texi:25595
45684 msgid "Owner of the @code{agate} process."
45688 #: guix-git/doc/guix.texi:25596
45690 msgid "@code{group} (default: @code{\"agate\"})"
45694 #: guix-git/doc/guix.texi:25598
45695 msgid "Owner's group of the @code{agate} process."
45699 #: guix-git/doc/guix.texi:25599
45701 msgid "@code{log-file} (default: @file{\"/var/log/agate.log\"})"
45705 #: guix-git/doc/guix.texi:25601
45706 msgid "The file which should store the logging output of Agate."
45710 #: guix-git/doc/guix.texi:25608
45716 #: guix-git/doc/guix.texi:25609
45718 msgid "HTTP, HTTPS"
45722 #: guix-git/doc/guix.texi:25610
45724 msgid "Let's Encrypt"
45728 #: guix-git/doc/guix.texi:25611
45730 msgid "TLS certificates"
45733 #. type: Plain text
45734 #: guix-git/doc/guix.texi:25618
45735 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."
45738 #. type: Plain text
45739 #: guix-git/doc/guix.texi:25630
45740 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."
45743 #. type: Plain text
45744 #: guix-git/doc/guix.texi:25637
45745 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)."
45748 #. type: Plain text
45749 #: guix-git/doc/guix.texi:25643
45750 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."
45753 #. type: Plain text
45754 #: guix-git/doc/guix.texi:25647
45755 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}."
45759 #: guix-git/doc/guix.texi:25648
45761 msgid "{Scheme Variable} certbot-service-type"
45765 #: guix-git/doc/guix.texi:25651
45766 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:"
45770 #: guix-git/doc/guix.texi:25658
45773 "(define %nginx-deploy-hook\n"
45775 " \"nginx-deploy-hook\"\n"
45776 " #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n"
45777 " (kill pid SIGHUP))))\n"
45782 #: guix-git/doc/guix.texi:25669
45785 "(service certbot-service-type\n"
45786 " (certbot-configuration\n"
45787 " (email \"foo@@example.net\")\n"
45790 " (certificate-configuration\n"
45791 " (domains '(\"example.net\" \"www.example.net\"))\n"
45792 " (deploy-hook %nginx-deploy-hook))\n"
45793 " (certificate-configuration\n"
45794 " (domains '(\"bar.example.net\")))))))\n"
45798 #: guix-git/doc/guix.texi:25672
45799 msgid "See below for details about @code{certbot-configuration}."
45803 #: guix-git/doc/guix.texi:25674
45805 msgid "{Data Type} certbot-configuration"
45809 #: guix-git/doc/guix.texi:25677
45810 msgid "Data type representing the configuration of the @code{certbot} service. This type has the following parameters:"
45814 #: guix-git/doc/guix.texi:25679
45816 msgid "@code{package} (default: @code{certbot})"
45820 #: guix-git/doc/guix.texi:25681
45821 msgid "The certbot package to use."
45825 #: guix-git/doc/guix.texi:25682
45827 msgid "@code{webroot} (default: @code{/var/www})"
45831 #: guix-git/doc/guix.texi:25685
45832 msgid "The directory from which to serve the Let's Encrypt challenge/response files."
45836 #: guix-git/doc/guix.texi:25686
45838 msgid "@code{certificates} (default: @code{()})"
45842 #: guix-git/doc/guix.texi:25690
45843 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}."
45847 #: guix-git/doc/guix.texi:25691
45849 msgid "@code{email} (default: @code{#f})"
45853 #: guix-git/doc/guix.texi:25695
45854 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."
45858 #: guix-git/doc/guix.texi:25696 guix-git/doc/guix.texi:27376
45860 msgid "@code{server} (default: @code{#f})"
45864 #: guix-git/doc/guix.texi:25699
45865 msgid "Optional URL of ACME server. Setting this overrides certbot's default, which is the Let's Encrypt server."
45869 #: guix-git/doc/guix.texi:25700
45871 msgid "@code{rsa-key-size} (default: @code{2048})"
45875 #: guix-git/doc/guix.texi:25702
45876 msgid "Size of the RSA key."
45880 #: guix-git/doc/guix.texi:25703
45882 msgid "@code{default-location} (default: @i{see below})"
45886 #: guix-git/doc/guix.texi:25712
45887 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."
45891 #: guix-git/doc/guix.texi:25716
45892 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."
45896 #: guix-git/doc/guix.texi:25720
45897 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}."
45901 #: guix-git/doc/guix.texi:25722
45902 msgid "Pass @code{#f} to not issue a default location."
45906 #: guix-git/doc/guix.texi:25725
45908 msgid "{Data Type} certificate-configuration"
45912 #: guix-git/doc/guix.texi:25728
45913 msgid "Data type representing the configuration of a certificate. This type has the following parameters:"
45917 #: guix-git/doc/guix.texi:25730
45919 msgid "@code{name} (default: @i{see below})"
45923 #: guix-git/doc/guix.texi:25734
45924 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}."
45928 #: guix-git/doc/guix.texi:25736
45929 msgid "Its default is the first provided domain."
45933 #: guix-git/doc/guix.texi:25737
45935 msgid "@code{domains} (default: @code{()})"
45939 #: guix-git/doc/guix.texi:25740
45940 msgid "The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate."
45944 #: guix-git/doc/guix.texi:25741
45946 msgid "@code{challenge} (default: @code{#f})"
45950 #: guix-git/doc/guix.texi:25748
45951 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."
45955 #: guix-git/doc/guix.texi:25749
45957 msgid "@code{authentication-hook} (default: @code{#f})"
45961 #: guix-git/doc/guix.texi:25755
45962 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."
45966 #: guix-git/doc/guix.texi:25756
45968 msgid "@code{cleanup-hook} (default: @code{#f})"
45972 #: guix-git/doc/guix.texi:25762
45973 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."
45977 #: guix-git/doc/guix.texi:25763
45979 msgid "@code{deploy-hook} (default: @code{#f})"
45983 #: guix-git/doc/guix.texi:25771
45984 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\"}."
45987 #. type: Plain text
45988 #: guix-git/doc/guix.texi:25778
45989 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}."
45993 #: guix-git/doc/guix.texi:25780
45995 msgid "DNS (domain name system)"
45999 #: guix-git/doc/guix.texi:25781
46001 msgid "domain name system (DNS)"
46004 #. type: Plain text
46005 #: guix-git/doc/guix.texi:25789
46006 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}."
46009 #. type: subsubheading
46010 #: guix-git/doc/guix.texi:25790
46012 msgid "Knot Service"
46015 #. type: Plain text
46016 #: guix-git/doc/guix.texi:25794
46017 msgid "An example configuration of an authoritative server for two zones, one master and one slave, is:"
46021 #: guix-git/doc/guix.texi:25801
46024 "(define-zone-entries example.org.zone\n"
46025 ";; Name TTL Class Type Data\n"
46026 " (\"@@\" \"\" \"IN\" \"A\" \"127.0.0.1\")\n"
46027 " (\"@@\" \"\" \"IN\" \"NS\" \"ns\")\n"
46028 " (\"ns\" \"\" \"IN\" \"A\" \"127.0.0.1\"))\n"
46033 #: guix-git/doc/guix.texi:25808
46036 "(define master-zone\n"
46037 " (knot-zone-configuration\n"
46038 " (domain \"example.org\")\n"
46039 " (zone (zone-file\n"
46040 " (origin \"example.org\")\n"
46041 " (entries example.org.zone)))))\n"
46046 #: guix-git/doc/guix.texi:25814
46049 "(define slave-zone\n"
46050 " (knot-zone-configuration\n"
46051 " (domain \"plop.org\")\n"
46052 " (dnssec-policy \"default\")\n"
46053 " (master (list \"plop-master\"))))\n"
46058 #: guix-git/doc/guix.texi:25819
46061 "(define plop-master\n"
46062 " (knot-remote-configuration\n"
46063 " (id \"plop-master\")\n"
46064 " (address (list \"208.76.58.171\"))))\n"
46069 #: guix-git/doc/guix.texi:25828
46072 "(operating-system\n"
46074 " (services (cons* (service knot-service-type\n"
46075 " (knot-configuration\n"
46076 " (remotes (list plop-master))\n"
46077 " (zones (list master-zone slave-zone))))\n"
46079 " %base-services)))\n"
46083 #: guix-git/doc/guix.texi:25830
46085 msgid "{Scheme Variable} knot-service-type"
46089 #: guix-git/doc/guix.texi:25832
46090 msgid "This is the type for the Knot DNS server."
46094 #: guix-git/doc/guix.texi:25840
46095 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."
46099 #: guix-git/doc/guix.texi:25842
46100 msgid "The following data types are used to configure the Knot DNS server:"
46104 #: guix-git/doc/guix.texi:25844
46106 msgid "{Data Type} knot-key-configuration"
46110 #: guix-git/doc/guix.texi:25847
46111 msgid "Data type representing a key. This type has the following parameters:"
46115 #: guix-git/doc/guix.texi:25849 guix-git/doc/guix.texi:25869
46116 #: guix-git/doc/guix.texi:25984 guix-git/doc/guix.texi:26010
46117 #: guix-git/doc/guix.texi:26045
46119 msgid "@code{id} (default: @code{\"\"})"
46123 #: guix-git/doc/guix.texi:25852 guix-git/doc/guix.texi:25872
46124 msgid "An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty."
46128 #: guix-git/doc/guix.texi:25853
46130 msgid "@code{algorithm} (default: @code{#f})"
46134 #: guix-git/doc/guix.texi:25857
46135 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}."
46139 #: guix-git/doc/guix.texi:25858
46141 msgid "@code{secret} (default: @code{\"\"})"
46145 #: guix-git/doc/guix.texi:25860
46146 msgid "The secret key itself."
46150 #: guix-git/doc/guix.texi:25864
46152 msgid "{Data Type} knot-acl-configuration"
46156 #: guix-git/doc/guix.texi:25867
46157 msgid "Data type representing an Access Control List (ACL) configuration. This type has the following parameters:"
46161 #: guix-git/doc/guix.texi:25873 guix-git/doc/guix.texi:25988
46163 msgid "@code{address} (default: @code{'()})"
46167 #: guix-git/doc/guix.texi:25877
46168 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."
46172 #: guix-git/doc/guix.texi:25878
46174 msgid "@code{key} (default: @code{'()})"
46178 #: guix-git/doc/guix.texi:25882
46179 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."
46183 #: guix-git/doc/guix.texi:25883
46185 msgid "@code{action} (default: @code{'()})"
46189 #: guix-git/doc/guix.texi:25887
46190 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}."
46194 #: guix-git/doc/guix.texi:25888
46196 msgid "@code{deny?} (default: @code{#f})"
46200 #: guix-git/doc/guix.texi:25891
46201 msgid "When true, the ACL defines restrictions. Listed actions are forbidden. When false, listed actions are allowed."
46205 #: guix-git/doc/guix.texi:25895
46207 msgid "{Data Type} zone-entry"
46211 #: guix-git/doc/guix.texi:25898
46212 msgid "Data type representing a record entry in a zone file. This type has the following parameters:"
46216 #: guix-git/doc/guix.texi:25900
46218 msgid "@code{name} (default: @code{\"@@\"})"
46222 #: guix-git/doc/guix.texi:25906
46223 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}."
46227 #: guix-git/doc/guix.texi:25907
46229 msgid "@code{ttl} (default: @code{\"\"})"
46233 #: guix-git/doc/guix.texi:25909
46234 msgid "The Time-To-Live (TTL) of this record. If not set, the default TTL is used."
46238 #: guix-git/doc/guix.texi:25910
46240 msgid "@code{class} (default: @code{\"IN\"})"
46244 #: guix-git/doc/guix.texi:25913
46245 msgid "The class of the record. Knot currently supports only @code{\"IN\"} and partially @code{\"CH\"}."
46249 #: guix-git/doc/guix.texi:25914
46251 msgid "@code{type} (default: @code{\"A\"})"
46255 #: guix-git/doc/guix.texi:25918
46256 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."
46260 #: guix-git/doc/guix.texi:25919
46262 msgid "@code{data} (default: @code{\"\"})"
46266 #: guix-git/doc/guix.texi:25923
46267 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."
46271 #: guix-git/doc/guix.texi:25927
46273 msgid "{Data Type} zone-file"
46277 #: guix-git/doc/guix.texi:25930
46278 msgid "Data type representing the content of a zone file. This type has the following parameters:"
46282 #: guix-git/doc/guix.texi:25939
46283 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}."
46287 #: guix-git/doc/guix.texi:25940
46289 msgid "@code{origin} (default: @code{\"\"})"
46293 #: guix-git/doc/guix.texi:25942
46294 msgid "The name of your zone. This parameter cannot be empty."
46298 #: guix-git/doc/guix.texi:25943
46300 msgid "@code{ns} (default: @code{\"ns\"})"
46304 #: guix-git/doc/guix.texi:25948
46305 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."
46309 #: guix-git/doc/guix.texi:25949
46311 msgid "@code{mail} (default: @code{\"hostmaster\"})"
46315 #: guix-git/doc/guix.texi:25952
46316 msgid "An email address people can contact you at, as the owner of the zone. This is translated as @code{<mail>@@<origin>}."
46320 #: guix-git/doc/guix.texi:25953
46322 msgid "@code{serial} (default: @code{1})"
46326 #: guix-git/doc/guix.texi:25957
46327 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."
46331 #: guix-git/doc/guix.texi:25958
46333 msgid "@code{refresh} (default: @code{(* 2 24 3600)})"
46337 #: guix-git/doc/guix.texi:25962
46338 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)}."
46342 #: guix-git/doc/guix.texi:25963
46344 msgid "@code{retry} (default: @code{(* 15 60)})"
46348 #: guix-git/doc/guix.texi:25966
46349 msgid "The period after which a slave will retry to contact its master when it fails to do so a first time."
46353 #: guix-git/doc/guix.texi:25967
46355 msgid "@code{expiry} (default: @code{(* 14 24 3600)})"
46359 #: guix-git/doc/guix.texi:25971
46360 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."
46364 #: guix-git/doc/guix.texi:25972
46366 msgid "@code{nx} (default: @code{3600})"
46370 #: guix-git/doc/guix.texi:25975
46371 msgid "Default TTL of inexistent records. This delay is usually short because you want your new domains to reach everyone quickly."
46375 #: guix-git/doc/guix.texi:25979
46377 msgid "{Data Type} knot-remote-configuration"
46381 #: guix-git/doc/guix.texi:25982
46382 msgid "Data type representing a remote configuration. This type has the following parameters:"
46386 #: guix-git/doc/guix.texi:25987
46387 msgid "An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty."
46391 #: guix-git/doc/guix.texi:25992
46392 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."
46396 #: guix-git/doc/guix.texi:25993
46398 msgid "@code{via} (default: @code{'()})"
46402 #: guix-git/doc/guix.texi:25997
46403 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."
46407 #: guix-git/doc/guix.texi:26001
46408 msgid "A reference to a key, that is a string containing the identifier of a key defined in a @code{knot-key-configuration} field."
46412 #: guix-git/doc/guix.texi:26005
46414 msgid "{Data Type} knot-keystore-configuration"
46418 #: guix-git/doc/guix.texi:26008
46419 msgid "Data type representing a keystore to hold dnssec keys. This type has the following parameters:"
46423 #: guix-git/doc/guix.texi:26012
46424 msgid "The id of the keystore. It must not be empty."
46428 #: guix-git/doc/guix.texi:26013
46430 msgid "@code{backend} (default: @code{'pem})"
46434 #: guix-git/doc/guix.texi:26015
46435 msgid "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}."
46439 #: guix-git/doc/guix.texi:26016
46441 msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})"
46445 #: guix-git/doc/guix.texi:26020
46446 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."
46450 #: guix-git/doc/guix.texi:26024
46452 msgid "{Data Type} knot-policy-configuration"
46456 #: guix-git/doc/guix.texi:26028
46457 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."
46461 #: guix-git/doc/guix.texi:26035
46462 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."
46466 #: guix-git/doc/guix.texi:26041
46467 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."
46471 #: guix-git/doc/guix.texi:26043
46472 msgid "This type has the following parameters:"
46476 #: guix-git/doc/guix.texi:26047
46477 msgid "The id of the policy. It must not be empty."
46481 #: guix-git/doc/guix.texi:26048
46483 msgid "@code{keystore} (default: @code{\"default\"})"
46487 #: guix-git/doc/guix.texi:26053
46488 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)."
46492 #: guix-git/doc/guix.texi:26054
46494 msgid "@code{manual?} (default: @code{#f})"
46498 #: guix-git/doc/guix.texi:26056
46499 msgid "Whether the key management is manual or automatic."
46503 #: guix-git/doc/guix.texi:26057
46505 msgid "@code{single-type-signing?} (default: @code{#f})"
46509 #: guix-git/doc/guix.texi:26059
46510 msgid "When @code{#t}, use the Single-Type Signing Scheme."
46514 #: guix-git/doc/guix.texi:26060
46516 msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})"
46520 #: guix-git/doc/guix.texi:26062
46521 msgid "An algorithm of signing keys and issued signatures."
46525 #: guix-git/doc/guix.texi:26063
46527 msgid "@code{ksk-size} (default: @code{256})"
46531 #: guix-git/doc/guix.texi:26066
46532 msgid "The length of the KSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
46536 #: guix-git/doc/guix.texi:26067
46538 msgid "@code{zsk-size} (default: @code{256})"
46542 #: guix-git/doc/guix.texi:26070
46543 msgid "The length of the ZSK@. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms."
46547 #: guix-git/doc/guix.texi:26071
46549 msgid "@code{dnskey-ttl} (default: @code{'default})"
46553 #: guix-git/doc/guix.texi:26074
46554 msgid "The TTL value for DNSKEY records added into zone apex. The special @code{'default} value means same as the zone SOA TTL."
46558 #: guix-git/doc/guix.texi:26075
46560 msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})"
46564 #: guix-git/doc/guix.texi:26077
46565 msgid "The period between ZSK publication and the next rollover initiation."
46569 #: guix-git/doc/guix.texi:26078
46571 msgid "@code{propagation-delay} (default: @code{(* 24 3600)})"
46575 #: guix-git/doc/guix.texi:26081
46576 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."
46580 #: guix-git/doc/guix.texi:26082
46582 msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})"
46586 #: guix-git/doc/guix.texi:26084
46587 msgid "A validity period of newly issued signatures."
46591 #: guix-git/doc/guix.texi:26085
46593 msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})"
46597 #: guix-git/doc/guix.texi:26087
46598 msgid "A period how long before a signature expiration the signature will be refreshed."
46602 #: guix-git/doc/guix.texi:26088
46604 msgid "@code{nsec3?} (default: @code{#f})"
46608 #: guix-git/doc/guix.texi:26090
46609 msgid "When @code{#t}, NSEC3 will be used instead of NSEC."
46613 #: guix-git/doc/guix.texi:26091
46615 msgid "@code{nsec3-iterations} (default: @code{5})"
46619 #: guix-git/doc/guix.texi:26093
46620 msgid "The number of additional times the hashing is performed."
46624 #: guix-git/doc/guix.texi:26094
46626 msgid "@code{nsec3-salt-length} (default: @code{8})"
46630 #: guix-git/doc/guix.texi:26097
46631 msgid "The length of a salt field in octets, which is appended to the original owner name before hashing."
46635 #: guix-git/doc/guix.texi:26098
46637 msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})"
46641 #: guix-git/doc/guix.texi:26100
46642 msgid "The validity period of newly issued salt field."
46646 #: guix-git/doc/guix.texi:26104
46648 msgid "{Data Type} knot-zone-configuration"
46652 #: guix-git/doc/guix.texi:26107
46653 msgid "Data type representing a zone served by Knot. This type has the following parameters:"
46657 #: guix-git/doc/guix.texi:26109
46659 msgid "@code{domain} (default: @code{\"\"})"
46663 #: guix-git/doc/guix.texi:26111
46664 msgid "The domain served by this configuration. It must not be empty."
46668 #: guix-git/doc/guix.texi:26112
46670 msgid "@code{file} (default: @code{\"\"})"
46674 #: guix-git/doc/guix.texi:26115
46675 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."
46679 #: guix-git/doc/guix.texi:26116
46681 msgid "@code{zone} (default: @code{(zone-file)})"
46685 #: guix-git/doc/guix.texi:26119
46686 msgid "The content of the zone file. This parameter is ignored by slave zones. It must contain a zone-file record."
46690 #: guix-git/doc/guix.texi:26120
46692 msgid "@code{master} (default: @code{'()})"
46696 #: guix-git/doc/guix.texi:26123
46697 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."
46701 #: guix-git/doc/guix.texi:26124
46703 msgid "@code{ddns-master} (default: @code{#f})"
46707 #: guix-git/doc/guix.texi:26127
46708 msgid "The main master. When empty, it defaults to the first master in the list of masters."
46712 #: guix-git/doc/guix.texi:26128
46714 msgid "@code{notify} (default: @code{'()})"
46718 #: guix-git/doc/guix.texi:26130
46719 msgid "A list of slave remote identifiers."
46723 #: guix-git/doc/guix.texi:26131
46725 msgid "@code{acl} (default: @code{'()})"
46729 #: guix-git/doc/guix.texi:26133
46730 msgid "A list of acl identifiers."
46734 #: guix-git/doc/guix.texi:26134
46736 msgid "@code{semantic-checks?} (default: @code{#f})"
46740 #: guix-git/doc/guix.texi:26136
46741 msgid "When set, this adds more semantic checks to the zone."
46745 #: guix-git/doc/guix.texi:26137
46747 msgid "@code{disable-any?} (default: @code{#f})"
46751 #: guix-git/doc/guix.texi:26139
46752 msgid "When set, this forbids queries of the ANY type."
46756 #: guix-git/doc/guix.texi:26140
46758 msgid "@code{zonefile-sync} (default: @code{0})"
46762 #: guix-git/doc/guix.texi:26143
46763 msgid "The delay between a modification in memory and on disk. 0 means immediate synchronization."
46767 #: guix-git/doc/guix.texi:26144
46769 msgid "@code{zonefile-load} (default: @code{#f})"
46773 #: guix-git/doc/guix.texi:26147
46774 msgid "The way the zone file contents are applied during zone load. Possible values are:"
46778 #: guix-git/doc/guix.texi:26149
46780 msgid "@code{#f} for using the default value from Knot,"
46784 #: guix-git/doc/guix.texi:26150
46786 msgid "@code{'none} for not using the zone file at all,"
46790 #: guix-git/doc/guix.texi:26151
46792 msgid "@code{'difference} for computing the difference between already available"
46796 #: guix-git/doc/guix.texi:26153
46797 msgid "contents and zone contents and applying it to the current zone contents,"
46801 #: guix-git/doc/guix.texi:26153
46803 msgid "@code{'difference-no-serial} for the same as @code{'difference}, but"
46807 #: guix-git/doc/guix.texi:26156
46808 msgid "ignoring the SOA serial in the zone file, while the server takes care of it automatically."
46812 #: guix-git/doc/guix.texi:26156
46814 msgid "@code{'whole} for loading zone contents from the zone file."
46818 #: guix-git/doc/guix.texi:26159
46820 msgid "@code{journal-content} (default: @code{#f})"
46824 #: guix-git/doc/guix.texi:26164
46825 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."
46829 #: guix-git/doc/guix.texi:26165
46831 msgid "@code{max-journal-usage} (default: @code{#f})"
46835 #: guix-git/doc/guix.texi:26168
46836 msgid "The maximum size for the journal on disk. @code{#f} does not set this option, so the default value from Knot is used."
46840 #: guix-git/doc/guix.texi:26169
46842 msgid "@code{max-journal-depth} (default: @code{#f})"
46846 #: guix-git/doc/guix.texi:26172
46847 msgid "The maximum size of the history. @code{#f} does not set this option, so the default value from Knot is used."
46851 #: guix-git/doc/guix.texi:26173
46853 msgid "@code{max-zone-size} (default: @code{#f})"
46857 #: guix-git/doc/guix.texi:26177
46858 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."
46862 #: guix-git/doc/guix.texi:26178
46864 msgid "@code{dnssec-policy} (default: @code{#f})"
46868 #: guix-git/doc/guix.texi:26182
46869 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."
46873 #: guix-git/doc/guix.texi:26183
46875 msgid "@code{serial-policy} (default: @code{'increment})"
46879 #: guix-git/doc/guix.texi:26185
46880 msgid "A policy between @code{'increment} and @code{'unixtime}."
46884 #: guix-git/doc/guix.texi:26189
46886 msgid "{Data Type} knot-configuration"
46890 #: guix-git/doc/guix.texi:26192
46891 msgid "Data type representing the Knot configuration. This type has the following parameters:"
46895 #: guix-git/doc/guix.texi:26194
46897 msgid "@code{knot} (default: @code{knot})"
46901 #: guix-git/doc/guix.texi:26196
46902 msgid "The Knot package."
46906 #: guix-git/doc/guix.texi:26197
46908 msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})"
46912 #: guix-git/doc/guix.texi:26199
46913 msgid "The run directory. This directory will be used for pid file and sockets."
46917 #: guix-git/doc/guix.texi:26200
46919 msgid "@code{includes} (default: @code{'()})"
46923 #: guix-git/doc/guix.texi:26203
46924 msgid "A list of strings or file-like objects denoting other files that must be included at the top of the configuration file."
46928 #: guix-git/doc/guix.texi:26204
46930 msgid "secrets, Knot service"
46934 #: guix-git/doc/guix.texi:26210
46935 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."
46939 #: guix-git/doc/guix.texi:26215
46940 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:"
46944 #: guix-git/doc/guix.texi:26219
46947 "keymgr -t mysecret > /etc/knot/secrets.conf\n"
46948 "chmod 600 /etc/knot/secrets.conf\n"
46952 #: guix-git/doc/guix.texi:26225
46953 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."
46957 #: guix-git/doc/guix.texi:26227
46958 msgid "It can also be used to add configuration not supported by this interface."
46962 #: guix-git/doc/guix.texi:26228
46964 msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})"
46968 #: guix-git/doc/guix.texi:26230 guix-git/doc/guix.texi:26233
46969 msgid "An ip address on which to listen."
46973 #: guix-git/doc/guix.texi:26231
46975 msgid "@code{listen-v6} (default: @code{\"::\"})"
46979 #: guix-git/doc/guix.texi:26234
46981 msgid "@code{listen-port} (default: @code{53})"
46985 #: guix-git/doc/guix.texi:26236
46986 msgid "A port on which to listen."
46990 #: guix-git/doc/guix.texi:26237
46992 msgid "@code{keys} (default: @code{'()})"
46996 #: guix-git/doc/guix.texi:26239
46997 msgid "The list of knot-key-configuration used by this configuration."
47001 #: guix-git/doc/guix.texi:26240
47003 msgid "@code{acls} (default: @code{'()})"
47007 #: guix-git/doc/guix.texi:26242
47008 msgid "The list of knot-acl-configuration used by this configuration."
47012 #: guix-git/doc/guix.texi:26243
47014 msgid "@code{remotes} (default: @code{'()})"
47018 #: guix-git/doc/guix.texi:26245
47019 msgid "The list of knot-remote-configuration used by this configuration."
47023 #: guix-git/doc/guix.texi:26246
47025 msgid "@code{zones} (default: @code{'()})"
47029 #: guix-git/doc/guix.texi:26248
47030 msgid "The list of knot-zone-configuration used by this configuration."
47033 #. type: subsubheading
47034 #: guix-git/doc/guix.texi:26252
47036 msgid "Knot Resolver Service"
47040 #: guix-git/doc/guix.texi:26254
47042 msgid "{Scheme Variable} knot-resolver-service-type"
47046 #: guix-git/doc/guix.texi:26257
47047 msgid "This is the type of the knot resolver service, whose value should be an @code{knot-resolver-configuration} object as in this example:"
47051 #: guix-git/doc/guix.texi:26267
47054 "(service knot-resolver-service-type\n"
47055 " (knot-resolver-configuration\n"
47056 " (kresd-config-file (plain-file \"kresd.conf\" \"\n"
47057 "net.listen('192.168.0.1', 5353)\n"
47058 "user('knot-resolver', 'knot-resolver')\n"
47059 "modules = @{ 'hints > iterate', 'stats', 'predict' @}\n"
47060 "cache.size = 100 * MB\n"
47065 #: guix-git/doc/guix.texi:26270
47066 msgid "For more information, refer its @url{https://knot-resolver.readthedocs.org/en/stable/daemon.html#configuration, manual}."
47070 #: guix-git/doc/guix.texi:26272
47072 msgid "{Data Type} knot-resolver-configuration"
47076 #: guix-git/doc/guix.texi:26274
47077 msgid "Data type representing the configuration of knot-resolver."
47081 #: guix-git/doc/guix.texi:26276
47083 msgid "@code{package} (default: @var{knot-resolver})"
47087 #: guix-git/doc/guix.texi:26278
47088 msgid "Package object of the knot DNS resolver."
47092 #: guix-git/doc/guix.texi:26279
47094 msgid "@code{kresd-config-file} (default: %kresd.conf)"
47098 #: guix-git/doc/guix.texi:26282
47099 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}."
47103 #: guix-git/doc/guix.texi:26283
47105 msgid "@code{garbage-collection-interval} (default: 1000)"
47109 #: guix-git/doc/guix.texi:26285
47110 msgid "Number of milliseconds for @code{kres-cache-gc} to periodically trim the cache."
47113 #. type: subsubheading
47114 #: guix-git/doc/guix.texi:26290
47116 msgid "Dnsmasq Service"
47120 #: guix-git/doc/guix.texi:26292
47122 msgid "{Scheme Variable} dnsmasq-service-type"
47126 #: guix-git/doc/guix.texi:26295
47127 msgid "This is the type of the dnsmasq service, whose value should be an @code{dnsmasq-configuration} object as in this example:"
47131 #: guix-git/doc/guix.texi:26301
47134 "(service dnsmasq-service-type\n"
47135 " (dnsmasq-configuration\n"
47136 " (no-resolv? #t)\n"
47137 " (servers '(\"192.168.1.1\"))))\n"
47141 #: guix-git/doc/guix.texi:26304
47143 msgid "{Data Type} dnsmasq-configuration"
47147 #: guix-git/doc/guix.texi:26306
47148 msgid "Data type representing the configuration of dnsmasq."
47152 #: guix-git/doc/guix.texi:26308
47154 msgid "@code{package} (default: @var{dnsmasq})"
47158 #: guix-git/doc/guix.texi:26310
47159 msgid "Package object of the dnsmasq server."
47163 #: guix-git/doc/guix.texi:26311
47165 msgid "@code{no-hosts?} (default: @code{#f})"
47169 #: guix-git/doc/guix.texi:26313
47170 msgid "When true, don't read the hostnames in /etc/hosts."
47174 #: guix-git/doc/guix.texi:26314
47176 msgid "@code{port} (default: @code{53})"
47180 #: guix-git/doc/guix.texi:26317
47181 msgid "The port to listen on. Setting this to zero completely disables DNS responses, leaving only DHCP and/or TFTP functions."
47185 #: guix-git/doc/guix.texi:26318
47187 msgid "@code{local-service?} (default: @code{#t})"
47191 #: guix-git/doc/guix.texi:26321
47192 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."
47196 #: guix-git/doc/guix.texi:26322
47198 msgid "@code{listen-addresses} (default: @code{'()})"
47202 #: guix-git/doc/guix.texi:26324
47203 msgid "Listen on the given IP addresses."
47207 #: guix-git/doc/guix.texi:26325
47209 msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})"
47213 #: guix-git/doc/guix.texi:26327
47214 msgid "The file to read the IP address of the upstream nameservers from."
47218 #: guix-git/doc/guix.texi:26328
47220 msgid "@code{no-resolv?} (default: @code{#f})"
47224 #: guix-git/doc/guix.texi:26330
47225 msgid "When true, don't read @var{resolv-file}."
47229 #: guix-git/doc/guix.texi:26331
47231 msgid "@code{servers} (default: @code{'()})"
47235 #: guix-git/doc/guix.texi:26333
47236 msgid "Specify IP address of upstream servers directly."
47240 #: guix-git/doc/guix.texi:26334
47242 msgid "@code{addresses} (default: @code{'()})"
47246 #: guix-git/doc/guix.texi:26338
47247 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."
47251 #: guix-git/doc/guix.texi:26340
47252 msgid "This is useful for redirecting hosts locally, for example:"
47256 #: guix-git/doc/guix.texi:26349
47259 "(service dnsmasq-service-type\n"
47260 " (dnsmasq-configuration\n"
47262 " '(; Redirect to a local web-server.\n"
47263 " \"/example.org/127.0.0.1\"\n"
47264 " ; Redirect subdomain to a specific IP.\n"
47265 " \"/subdomain.example.org/192.168.1.42\"))))\n"
47269 #: guix-git/doc/guix.texi:26352
47270 msgid "Note that rules in @file{/etc/hosts} take precedence over this."
47274 #: guix-git/doc/guix.texi:26353
47276 msgid "@code{cache-size} (default: @code{150})"
47280 #: guix-git/doc/guix.texi:26356
47281 msgid "Set the size of dnsmasq's cache. Setting the cache size to zero disables caching."
47285 #: guix-git/doc/guix.texi:26357
47287 msgid "@code{negative-cache?} (default: @code{#t})"
47291 #: guix-git/doc/guix.texi:26359
47292 msgid "When false, disable negative caching."
47296 #: guix-git/doc/guix.texi:26360
47298 msgid "@code{tftp-enable?} (default: @code{#f})"
47302 #: guix-git/doc/guix.texi:26362
47303 msgid "Whether to enable the built-in TFTP server."
47307 #: guix-git/doc/guix.texi:26363
47309 msgid "@code{tftp-no-fail?} (default: @code{#f})"
47313 #: guix-git/doc/guix.texi:26365
47314 msgid "If true, does not fail dnsmasq if the TFTP server could not start up."
47318 #: guix-git/doc/guix.texi:26366
47320 msgid "@code{tftp-single-port?} (default: @code{#f})"
47324 #: guix-git/doc/guix.texi:26368
47325 msgid "Whether to use only one single port for TFTP."
47329 #: guix-git/doc/guix.texi:26369
47331 msgid "@code{tftp-secure?} (default: @code{#f})"
47335 #: guix-git/doc/guix.texi:26371
47336 msgid "If true, only files owned by the user running the dnsmasq process are accessible."
47340 #: guix-git/doc/guix.texi:26375
47341 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."
47345 #: guix-git/doc/guix.texi:26376
47347 msgid "@code{tftp-max} (default: @code{#f})"
47351 #: guix-git/doc/guix.texi:26378
47352 msgid "If set, sets the maximal number of concurrent connections allowed."
47356 #: guix-git/doc/guix.texi:26379
47358 msgid "@code{tftp-mtu} (default: @code{#f})"
47362 #: guix-git/doc/guix.texi:26381
47363 msgid "If set, sets the MTU for TFTP packets to that value."
47367 #: guix-git/doc/guix.texi:26382
47369 msgid "@code{tftp-no-blocksize?} (default: @code{#f})"
47373 #: guix-git/doc/guix.texi:26384
47374 msgid "If true, stops the TFTP server from negotiating the blocksize with a client."
47378 #: guix-git/doc/guix.texi:26385
47380 msgid "@code{tftp-lowercase?} (default: @code{#f})"
47384 #: guix-git/doc/guix.texi:26387
47385 msgid "Whether to convert all filenames in TFTP requests to lowercase."
47389 #: guix-git/doc/guix.texi:26388
47391 msgid "@code{tftp-port-range} (default: @code{#f})"
47395 #: guix-git/doc/guix.texi:26391
47396 msgid "If set, fixes the dynamical ports (one per client) to the given range (@code{\"<start>,<end>\"})."
47400 #: guix-git/doc/guix.texi:26392
47402 msgid "@code{tftp-root} (default: @code{/var/empty,lo})"
47406 #: guix-git/doc/guix.texi:26399
47407 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."
47411 #: guix-git/doc/guix.texi:26400
47413 msgid "@code{tftp-unique-root} (default: @code{#f})"
47417 #: guix-git/doc/guix.texi:26405
47418 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)."
47422 #: guix-git/doc/guix.texi:26414
47423 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."
47426 #. type: subsubheading
47427 #: guix-git/doc/guix.texi:26418
47429 msgid "ddclient Service"
47433 #: guix-git/doc/guix.texi:26420
47438 #. type: Plain text
47439 #: guix-git/doc/guix.texi:26424
47440 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}."
47443 #. type: Plain text
47444 #: guix-git/doc/guix.texi:26427
47445 msgid "The following example show instantiates the service with its default configuration:"
47449 #: guix-git/doc/guix.texi:26430
47451 msgid "(service ddclient-service-type)\n"
47454 #. type: Plain text
47455 #: guix-git/doc/guix.texi:26439
47456 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."
47459 #. type: Plain text
47460 #: guix-git/doc/guix.texi:26443
47461 msgid "Available @code{ddclient-configuration} fields are:"
47465 #: guix-git/doc/guix.texi:26444
47467 msgid "{@code{ddclient-configuration} parameter} package ddclient"
47471 #: guix-git/doc/guix.texi:26446
47472 msgid "The ddclient package."
47476 #: guix-git/doc/guix.texi:26449
47478 msgid "{@code{ddclient-configuration} parameter} integer daemon"
47482 #: guix-git/doc/guix.texi:26451
47483 msgid "The period after which ddclient will retry to check IP and domain name."
47487 #: guix-git/doc/guix.texi:26456
47489 msgid "{@code{ddclient-configuration} parameter} boolean syslog"
47493 #: guix-git/doc/guix.texi:26458
47494 msgid "Use syslog for the output."
47498 #: guix-git/doc/guix.texi:26463
47500 msgid "{@code{ddclient-configuration} parameter} string mail"
47504 #: guix-git/doc/guix.texi:26465
47505 msgid "Mail to user."
47509 #: guix-git/doc/guix.texi:26467 guix-git/doc/guix.texi:26474
47510 #: guix-git/doc/guix.texi:28211
47511 msgid "Defaults to @samp{\"root\"}."
47515 #: guix-git/doc/guix.texi:26470
47517 msgid "{@code{ddclient-configuration} parameter} string mail-failure"
47521 #: guix-git/doc/guix.texi:26472
47522 msgid "Mail failed update to user."
47526 #: guix-git/doc/guix.texi:26477
47528 msgid "{@code{ddclient-configuration} parameter} string pid"
47532 #: guix-git/doc/guix.texi:26479
47533 msgid "The ddclient PID file."
47537 #: guix-git/doc/guix.texi:26481
47538 msgid "Defaults to @samp{\"/var/run/ddclient/ddclient.pid\"}."
47542 #: guix-git/doc/guix.texi:26484
47544 msgid "{@code{ddclient-configuration} parameter} boolean ssl"
47548 #: guix-git/doc/guix.texi:26486
47549 msgid "Enable SSL support."
47553 #: guix-git/doc/guix.texi:26491
47555 msgid "{@code{ddclient-configuration} parameter} string user"
47559 #: guix-git/doc/guix.texi:26494
47560 msgid "Specifies the user name or ID that is used when running ddclient program."
47564 #: guix-git/doc/guix.texi:26496 guix-git/doc/guix.texi:26503
47565 msgid "Defaults to @samp{\"ddclient\"}."
47569 #: guix-git/doc/guix.texi:26499
47571 msgid "{@code{ddclient-configuration} parameter} string group"
47575 #: guix-git/doc/guix.texi:26501
47576 msgid "Group of the user who will run the ddclient program."
47580 #: guix-git/doc/guix.texi:26506
47582 msgid "{@code{ddclient-configuration} parameter} string secret-file"
47586 #: guix-git/doc/guix.texi:26510
47587 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."
47591 #: guix-git/doc/guix.texi:26512
47592 msgid "Defaults to @samp{\"/etc/ddclient/secrets.conf\"}."
47596 #: guix-git/doc/guix.texi:26515
47598 msgid "{@code{ddclient-configuration} parameter} list extra-options"
47602 #: guix-git/doc/guix.texi:26517
47603 msgid "Extra options will be appended to @file{ddclient.conf} file."
47607 #: guix-git/doc/guix.texi:26528
47609 msgid "VPN (virtual private network)"
47613 #: guix-git/doc/guix.texi:26529
47615 msgid "virtual private network (VPN)"
47618 #. type: Plain text
47619 #: guix-git/doc/guix.texi:26533
47620 msgid "The @code{(gnu services vpn)} module provides services related to @dfn{virtual private networks} (VPNs)."
47623 #. type: subsubheading
47624 #: guix-git/doc/guix.texi:26534
47629 #. type: Plain text
47630 #: guix-git/doc/guix.texi:26538
47631 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@."
47635 #: guix-git/doc/guix.texi:26539
47637 msgid "{Scheme Procedure} openvpn-client-service @"
47641 #: guix-git/doc/guix.texi:26541
47642 msgid "[#:config (openvpn-client-configuration)]"
47646 #: guix-git/doc/guix.texi:26543
47647 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a client."
47651 #: guix-git/doc/guix.texi:26545
47653 msgid "{Scheme Procedure} openvpn-server-service @"
47657 #: guix-git/doc/guix.texi:26547
47658 msgid "[#:config (openvpn-server-configuration)]"
47662 #: guix-git/doc/guix.texi:26549
47663 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a server."
47667 #: guix-git/doc/guix.texi:26551
47668 msgid "Both can be run simultaneously."
47671 #. type: Plain text
47672 #: guix-git/doc/guix.texi:26556
47673 msgid "Available @code{openvpn-client-configuration} fields are:"
47677 #: guix-git/doc/guix.texi:26557
47679 msgid "{@code{openvpn-client-configuration} parameter} package openvpn"
47683 #: guix-git/doc/guix.texi:26559 guix-git/doc/guix.texi:26714
47684 msgid "The OpenVPN package."
47688 #: guix-git/doc/guix.texi:26562
47690 msgid "{@code{openvpn-client-configuration} parameter} string pid-file"
47694 #: guix-git/doc/guix.texi:26564 guix-git/doc/guix.texi:26719
47695 msgid "The OpenVPN pid file."
47699 #: guix-git/doc/guix.texi:26566 guix-git/doc/guix.texi:26721
47700 msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}."
47704 #: guix-git/doc/guix.texi:26569
47706 msgid "{@code{openvpn-client-configuration} parameter} proto proto"
47710 #: guix-git/doc/guix.texi:26572 guix-git/doc/guix.texi:26727
47711 msgid "The protocol (UDP or TCP) used to open a channel between clients and servers."
47715 #: guix-git/doc/guix.texi:26574 guix-git/doc/guix.texi:26729
47716 msgid "Defaults to @samp{udp}."
47720 #: guix-git/doc/guix.texi:26577
47722 msgid "{@code{openvpn-client-configuration} parameter} dev dev"
47726 #: guix-git/doc/guix.texi:26579 guix-git/doc/guix.texi:26734
47727 msgid "The device type used to represent the VPN connection."
47731 #: guix-git/doc/guix.texi:26581 guix-git/doc/guix.texi:26736
47732 msgid "Defaults to @samp{tun}."
47735 #. type: Plain text
47736 #: guix-git/doc/guix.texi:26587 guix-git/doc/guix.texi:26742
47737 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}."
47741 #: guix-git/doc/guix.texi:26588
47743 msgid "{@code{openvpn-client-configuration} parameter} maybe-string ca"
47747 #: guix-git/doc/guix.texi:26590 guix-git/doc/guix.texi:26745
47748 msgid "The certificate authority to check connections against."
47752 #: guix-git/doc/guix.texi:26592 guix-git/doc/guix.texi:26747
47753 msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}."
47757 #: guix-git/doc/guix.texi:26595
47759 msgid "{@code{openvpn-client-configuration} parameter} maybe-string cert"
47763 #: guix-git/doc/guix.texi:26598 guix-git/doc/guix.texi:26753
47764 msgid "The certificate of the machine the daemon is running on. It should be signed by the authority given in @code{ca}."
47768 #: guix-git/doc/guix.texi:26600 guix-git/doc/guix.texi:26755
47769 msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}."
47773 #: guix-git/doc/guix.texi:26603
47775 msgid "{@code{openvpn-client-configuration} parameter} maybe-string key"
47779 #: guix-git/doc/guix.texi:26606 guix-git/doc/guix.texi:26761
47780 msgid "The key of the machine the daemon is running on. It must be the key whose certificate is @code{cert}."
47784 #: guix-git/doc/guix.texi:26608 guix-git/doc/guix.texi:26763
47785 msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}."
47789 #: guix-git/doc/guix.texi:26611
47791 msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?"
47795 #: guix-git/doc/guix.texi:26613 guix-git/doc/guix.texi:26768
47796 msgid "Whether to use the lzo compression algorithm."
47800 #: guix-git/doc/guix.texi:26618
47802 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?"
47806 #: guix-git/doc/guix.texi:26620 guix-git/doc/guix.texi:26775
47807 msgid "Don't re-read key files across SIGUSR1 or --ping-restart."
47811 #: guix-git/doc/guix.texi:26625
47813 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?"
47817 #: guix-git/doc/guix.texi:26628 guix-git/doc/guix.texi:26783
47818 msgid "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts."
47822 #: guix-git/doc/guix.texi:26633
47824 msgid "{@code{openvpn-client-configuration} parameter} boolean fast-io?"
47828 #: guix-git/doc/guix.texi:26636 guix-git/doc/guix.texi:26791
47829 msgid "(Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/epoll/select prior to the write operation."
47833 #: guix-git/doc/guix.texi:26640
47835 msgid "{@code{openvpn-client-configuration} parameter} number verbosity"
47839 #: guix-git/doc/guix.texi:26642 guix-git/doc/guix.texi:26797
47840 msgid "Verbosity level."
47844 #: guix-git/doc/guix.texi:26644 guix-git/doc/guix.texi:26799
47845 #: guix-git/doc/guix.texi:28479 guix-git/doc/guix.texi:28703
47846 msgid "Defaults to @samp{3}."
47850 #: guix-git/doc/guix.texi:26647
47852 msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth"
47856 #: guix-git/doc/guix.texi:26650 guix-git/doc/guix.texi:26805
47857 msgid "Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks."
47861 #: guix-git/doc/guix.texi:26655
47863 msgid "{@code{openvpn-client-configuration} parameter} maybe-string auth-user-pass"
47867 #: guix-git/doc/guix.texi:26659
47868 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."
47872 #: guix-git/doc/guix.texi:26661
47873 msgid "Defaults to @samp{'disabled}."
47877 #: guix-git/doc/guix.texi:26663
47879 msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?"
47883 #: guix-git/doc/guix.texi:26665
47884 msgid "Whether to check the server certificate has server usage extension."
47888 #: guix-git/doc/guix.texi:26670
47890 msgid "{@code{openvpn-client-configuration} parameter} bind bind?"
47894 #: guix-git/doc/guix.texi:26672
47895 msgid "Bind to a specific local port number."
47899 #: guix-git/doc/guix.texi:26677
47901 msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?"
47905 #: guix-git/doc/guix.texi:26679
47906 msgid "Retry resolving server address."
47910 #: guix-git/doc/guix.texi:26684
47912 msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote"
47916 #: guix-git/doc/guix.texi:26686
47917 msgid "A list of remote servers to connect to."
47921 #: guix-git/doc/guix.texi:26690
47922 msgid "Available @code{openvpn-remote-configuration} fields are:"
47926 #: guix-git/doc/guix.texi:26691
47928 msgid "{@code{openvpn-remote-configuration} parameter} string name"
47932 #: guix-git/doc/guix.texi:26693
47933 msgid "Server name."
47937 #: guix-git/doc/guix.texi:26695
47938 msgid "Defaults to @samp{\"my-server\"}."
47942 #: guix-git/doc/guix.texi:26698
47944 msgid "{@code{openvpn-remote-configuration} parameter} number port"
47948 #: guix-git/doc/guix.texi:26700
47949 msgid "Port number the server listens to."
47953 #: guix-git/doc/guix.texi:26702 guix-git/doc/guix.texi:26814
47954 msgid "Defaults to @samp{1194}."
47957 #. type: Plain text
47958 #: guix-git/doc/guix.texi:26711
47959 msgid "Available @code{openvpn-server-configuration} fields are:"
47963 #: guix-git/doc/guix.texi:26712
47965 msgid "{@code{openvpn-server-configuration} parameter} package openvpn"
47969 #: guix-git/doc/guix.texi:26717
47971 msgid "{@code{openvpn-server-configuration} parameter} string pid-file"
47975 #: guix-git/doc/guix.texi:26724
47977 msgid "{@code{openvpn-server-configuration} parameter} proto proto"
47981 #: guix-git/doc/guix.texi:26732
47983 msgid "{@code{openvpn-server-configuration} parameter} dev dev"
47987 #: guix-git/doc/guix.texi:26743
47989 msgid "{@code{openvpn-server-configuration} parameter} maybe-string ca"
47993 #: guix-git/doc/guix.texi:26750
47995 msgid "{@code{openvpn-server-configuration} parameter} maybe-string cert"
47999 #: guix-git/doc/guix.texi:26758
48001 msgid "{@code{openvpn-server-configuration} parameter} maybe-string key"
48005 #: guix-git/doc/guix.texi:26766
48007 msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?"
48011 #: guix-git/doc/guix.texi:26773
48013 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?"
48017 #: guix-git/doc/guix.texi:26780
48019 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?"
48023 #: guix-git/doc/guix.texi:26788
48025 msgid "{@code{openvpn-server-configuration} parameter} boolean fast-io?"
48029 #: guix-git/doc/guix.texi:26795
48031 msgid "{@code{openvpn-server-configuration} parameter} number verbosity"
48035 #: guix-git/doc/guix.texi:26802
48037 msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth"
48041 #: guix-git/doc/guix.texi:26810
48043 msgid "{@code{openvpn-server-configuration} parameter} number port"
48047 #: guix-git/doc/guix.texi:26812
48048 msgid "Specifies the port number on which the server listens."
48052 #: guix-git/doc/guix.texi:26817
48054 msgid "{@code{openvpn-server-configuration} parameter} ip-mask server"
48058 #: guix-git/doc/guix.texi:26819
48059 msgid "An ip and mask specifying the subnet inside the virtual network."
48063 #: guix-git/doc/guix.texi:26821
48064 msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}."
48068 #: guix-git/doc/guix.texi:26824
48070 msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6"
48074 #: guix-git/doc/guix.texi:26826
48075 msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network."
48079 #: guix-git/doc/guix.texi:26831
48081 msgid "{@code{openvpn-server-configuration} parameter} string dh"
48085 #: guix-git/doc/guix.texi:26833
48086 msgid "The Diffie-Hellman parameters file."
48090 #: guix-git/doc/guix.texi:26835
48091 msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}."
48095 #: guix-git/doc/guix.texi:26838
48097 msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist"
48101 #: guix-git/doc/guix.texi:26840
48102 msgid "The file that records client IPs."
48106 #: guix-git/doc/guix.texi:26842
48107 msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}."
48111 #: guix-git/doc/guix.texi:26845
48113 msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?"
48117 #: guix-git/doc/guix.texi:26847
48118 msgid "When true, the server will act as a gateway for its clients."
48122 #: guix-git/doc/guix.texi:26852
48124 msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?"
48128 #: guix-git/doc/guix.texi:26854
48129 msgid "When true, clients are allowed to talk to each other inside the VPN."
48133 #: guix-git/doc/guix.texi:26859
48135 msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive"
48139 #: guix-git/doc/guix.texi:26865
48140 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."
48144 #: guix-git/doc/guix.texi:26868
48146 msgid "{@code{openvpn-server-configuration} parameter} number max-clients"
48150 #: guix-git/doc/guix.texi:26870
48151 msgid "The maximum number of clients."
48155 #: guix-git/doc/guix.texi:26875
48157 msgid "{@code{openvpn-server-configuration} parameter} string status"
48161 #: guix-git/doc/guix.texi:26878
48162 msgid "The status file. This file shows a small report on current connection. It is truncated and rewritten every minute."
48166 #: guix-git/doc/guix.texi:26880
48167 msgid "Defaults to @samp{\"/var/run/openvpn/status\"}."
48171 #: guix-git/doc/guix.texi:26883
48173 msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir"
48177 #: guix-git/doc/guix.texi:26885
48178 msgid "The list of configuration for some clients."
48182 #: guix-git/doc/guix.texi:26889
48183 msgid "Available @code{openvpn-ccd-configuration} fields are:"
48187 #: guix-git/doc/guix.texi:26890
48189 msgid "{@code{openvpn-ccd-configuration} parameter} string name"
48193 #: guix-git/doc/guix.texi:26892
48194 msgid "Client name."
48198 #: guix-git/doc/guix.texi:26894
48199 msgid "Defaults to @samp{\"client\"}."
48203 #: guix-git/doc/guix.texi:26897
48205 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute"
48209 #: guix-git/doc/guix.texi:26899
48210 msgid "Client own network"
48214 #: guix-git/doc/guix.texi:26904
48216 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push"
48220 #: guix-git/doc/guix.texi:26906
48221 msgid "Client VPN IP."
48224 #. type: subsubheading
48225 #: guix-git/doc/guix.texi:26916
48231 #: guix-git/doc/guix.texi:26918
48233 msgid "{Scheme Variable} wireguard-service-type"
48237 #: guix-git/doc/guix.texi:26921
48238 msgid "A service type for a Wireguard tunnel interface. Its value must be a @code{wireguard-configuration} record as in this example:"
48242 #: guix-git/doc/guix.texi:26932
48245 "(service wireguard-service-type\n"
48246 " (wireguard-configuration\n"
48249 " (wireguard-peer\n"
48250 " (name \"my-peer\")\n"
48251 " (endpoint \"my.wireguard.com:51820\")\n"
48252 " (public-key \"hzpKg9X1yqu1axN6iJp0mWf6BZGo8m1wteKwtTmDGF4=\")\n"
48253 " (allowed-ips '(\"10.0.0.2/32\")))))))\n"
48257 #: guix-git/doc/guix.texi:26936
48259 msgid "{Data Type} wireguard-configuration"
48263 #: guix-git/doc/guix.texi:26938
48264 msgid "Data type representing the configuration of the Wireguard service."
48268 #: guix-git/doc/guix.texi:26940
48274 #: guix-git/doc/guix.texi:26942
48275 msgid "The wireguard package to use for this service."
48279 #: guix-git/doc/guix.texi:26943
48281 msgid "@code{interface} (default: @code{\"wg0\"})"
48285 #: guix-git/doc/guix.texi:26945
48286 msgid "The interface name for the VPN."
48290 #: guix-git/doc/guix.texi:26946
48292 msgid "@code{addresses} (default: @code{'(\"10.0.0.1/32\")})"
48296 #: guix-git/doc/guix.texi:26948
48297 msgid "The IP addresses to be assigned to the above interface."
48301 #: guix-git/doc/guix.texi:26949
48303 msgid "@code{private-key} (default: @code{\"/etc/wireguard/private.key\"})"
48307 #: guix-git/doc/guix.texi:26952
48308 msgid "The private key file for the interface. It is automatically generated if the file does not exist."
48312 #: guix-git/doc/guix.texi:26953
48314 msgid "@code{peers} (default: @code{'()})"
48318 #: guix-git/doc/guix.texi:26956
48319 msgid "The authorized peers on this interface. This is a list of @var{wireguard-peer} records."
48323 #: guix-git/doc/guix.texi:26960
48325 msgid "{Data Type} wireguard-peer"
48329 #: guix-git/doc/guix.texi:26962
48330 msgid "Data type representing a Wireguard peer attached to a given interface."
48334 #: guix-git/doc/guix.texi:26966
48335 msgid "The peer name."
48339 #: guix-git/doc/guix.texi:26967
48341 msgid "@code{endpoint} (default: @code{#f})"
48345 #: guix-git/doc/guix.texi:26970
48346 msgid "The optional endpoint for the peer, such as @code{\"demo.wireguard.com:51820\"}."
48350 #: guix-git/doc/guix.texi:26971 guix-git/doc/guix.texi:27355
48351 #: guix-git/doc/guix.texi:27389 guix-git/doc/guix.texi:32191
48357 #: guix-git/doc/guix.texi:26973
48358 msgid "The peer public-key represented as a base64 string."
48362 #: guix-git/doc/guix.texi:26974
48364 msgid "allowed-ips"
48368 #: guix-git/doc/guix.texi:26977
48369 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."
48373 #: guix-git/doc/guix.texi:26983
48378 #. type: Plain text
48379 #: guix-git/doc/guix.texi:26988
48380 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)."
48383 #. type: Plain text
48384 #: guix-git/doc/guix.texi:26992
48385 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}."
48388 #. type: subsubheading
48389 #: guix-git/doc/guix.texi:26993
48391 msgid "NFS Service"
48395 #: guix-git/doc/guix.texi:26994
48397 msgid "NFS, server"
48400 #. type: Plain text
48401 #: guix-git/doc/guix.texi:26999
48402 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."
48406 #: guix-git/doc/guix.texi:27000
48408 msgid "{Scheme Variable} nfs-service-type"
48412 #: guix-git/doc/guix.texi:27002
48413 msgid "A service type for a complete NFS server."
48417 #: guix-git/doc/guix.texi:27004
48419 msgid "{Data Type} nfs-configuration"
48423 #: guix-git/doc/guix.texi:27007
48424 msgid "This data type represents the configuration of the NFS service and all of its subsystems."
48428 #: guix-git/doc/guix.texi:27009
48429 msgid "It has the following parameters:"
48433 #: guix-git/doc/guix.texi:27010 guix-git/doc/guix.texi:27135
48434 #: guix-git/doc/guix.texi:27160
48436 msgid "@code{nfs-utils} (default: @code{nfs-utils})"
48440 #: guix-git/doc/guix.texi:27012
48441 msgid "The nfs-utils package to use."
48445 #: guix-git/doc/guix.texi:27013
48447 msgid "@code{nfs-versions} (default: @code{'(\"4.2\" \"4.1\" \"4.0\")})"
48451 #: guix-git/doc/guix.texi:27016
48452 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."
48456 #: guix-git/doc/guix.texi:27017
48458 msgid "@code{exports} (default: @code{'()})"
48462 #: guix-git/doc/guix.texi:27022
48463 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:"
48467 #: guix-git/doc/guix.texi:27028
48470 "(nfs-configuration\n"
48472 " '((\"/export\"\n"
48473 " \"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)\"))))\n"
48477 #: guix-git/doc/guix.texi:27030
48479 msgid "@code{rpcmountd-port} (default: @code{#f})"
48483 #: guix-git/doc/guix.texi:27032
48484 msgid "The network port that the @command{rpc.mountd} daemon should use."
48488 #: guix-git/doc/guix.texi:27033
48490 msgid "@code{rpcstatd-port} (default: @code{#f})"
48494 #: guix-git/doc/guix.texi:27035
48495 msgid "The network port that the @command{rpc.statd} daemon should use."
48499 #: guix-git/doc/guix.texi:27036 guix-git/doc/guix.texi:27084
48501 msgid "@code{rpcbind} (default: @code{rpcbind})"
48505 #: guix-git/doc/guix.texi:27038 guix-git/doc/guix.texi:27086
48506 msgid "The rpcbind package to use."
48510 #: guix-git/doc/guix.texi:27039
48512 msgid "@code{idmap-domain} (default: @code{\"localdomain\"})"
48516 #: guix-git/doc/guix.texi:27041
48517 msgid "The local NFSv4 domain name."
48521 #: guix-git/doc/guix.texi:27042
48523 msgid "@code{nfsd-port} (default: @code{2049})"
48527 #: guix-git/doc/guix.texi:27044
48528 msgid "The network port that the @command{nfsd} daemon should use."
48532 #: guix-git/doc/guix.texi:27045
48534 msgid "@code{nfsd-threads} (default: @code{8})"
48538 #: guix-git/doc/guix.texi:27047
48539 msgid "The number of threads used by the @command{nfsd} daemon."
48543 #: guix-git/doc/guix.texi:27048
48545 msgid "@code{nfsd-tcp?} (default: @code{#t})"
48549 #: guix-git/doc/guix.texi:27050
48550 msgid "Whether the @command{nfsd} daemon should listen on a TCP socket."
48554 #: guix-git/doc/guix.texi:27051
48556 msgid "@code{nfsd-udp?} (default: @code{#f})"
48560 #: guix-git/doc/guix.texi:27053
48561 msgid "Whether the @command{nfsd} daemon should listen on a UDP socket."
48565 #: guix-git/doc/guix.texi:27054 guix-git/doc/guix.texi:27138
48566 #: guix-git/doc/guix.texi:27163
48568 msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48572 #: guix-git/doc/guix.texi:27056 guix-git/doc/guix.texi:27140
48573 #: guix-git/doc/guix.texi:27165
48574 msgid "The directory where the pipefs file system is mounted."
48578 #: guix-git/doc/guix.texi:27057
48580 msgid "@code{debug} (default: @code{'()\"})"
48584 #: guix-git/doc/guix.texi:27061
48585 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}."
48588 #. type: Plain text
48589 #: guix-git/doc/guix.texi:27066
48590 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."
48593 #. type: subsubheading
48594 #: guix-git/doc/guix.texi:27067
48596 msgid "RPC Bind Service"
48600 #: guix-git/doc/guix.texi:27068
48605 #. type: Plain text
48606 #: guix-git/doc/guix.texi:27074
48607 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."
48611 #: guix-git/doc/guix.texi:27075
48613 msgid "{Scheme Variable} rpcbind-service-type"
48617 #: guix-git/doc/guix.texi:27077
48618 msgid "A service type for the RPC portmapper daemon."
48622 #: guix-git/doc/guix.texi:27080
48624 msgid "{Data Type} rpcbind-configuration"
48628 #: guix-git/doc/guix.texi:27083
48629 msgid "Data type representing the configuration of the RPC Bind Service. This type has the following parameters:"
48633 #: guix-git/doc/guix.texi:27087
48635 msgid "@code{warm-start?} (default: @code{#t})"
48639 #: guix-git/doc/guix.texi:27091
48640 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."
48643 #. type: subsubheading
48644 #: guix-git/doc/guix.texi:27095
48646 msgid "Pipefs Pseudo File System"
48650 #: guix-git/doc/guix.texi:27096
48656 #: guix-git/doc/guix.texi:27097
48661 #. type: Plain text
48662 #: guix-git/doc/guix.texi:27101
48663 msgid "The pipefs file system is used to transfer NFS related data between the kernel and user space programs."
48667 #: guix-git/doc/guix.texi:27102
48669 msgid "{Scheme Variable} pipefs-service-type"
48673 #: guix-git/doc/guix.texi:27104
48674 msgid "A service type for the pipefs pseudo file system."
48678 #: guix-git/doc/guix.texi:27106
48680 msgid "{Data Type} pipefs-configuration"
48684 #: guix-git/doc/guix.texi:27109
48685 msgid "Data type representing the configuration of the pipefs pseudo file system service. This type has the following parameters:"
48689 #: guix-git/doc/guix.texi:27110
48691 msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48695 #: guix-git/doc/guix.texi:27112
48696 msgid "The directory to which the file system is to be attached."
48699 #. type: subsubheading
48700 #: guix-git/doc/guix.texi:27116
48702 msgid "GSS Daemon Service"
48706 #: guix-git/doc/guix.texi:27117
48712 #: guix-git/doc/guix.texi:27118
48718 #: guix-git/doc/guix.texi:27119
48720 msgid "global security system"
48723 #. type: Plain text
48724 #: guix-git/doc/guix.texi:27126
48725 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})."
48729 #: guix-git/doc/guix.texi:27127
48731 msgid "{Scheme Variable} gss-service-type"
48735 #: guix-git/doc/guix.texi:27129
48736 msgid "A service type for the Global Security System (GSS) daemon."
48740 #: guix-git/doc/guix.texi:27131
48742 msgid "{Data Type} gss-configuration"
48746 #: guix-git/doc/guix.texi:27134
48747 msgid "Data type representing the configuration of the GSS daemon service. This type has the following parameters:"
48751 #: guix-git/doc/guix.texi:27137
48752 msgid "The package in which the @command{rpc.gssd} command is to be found."
48755 #. type: subsubheading
48756 #: guix-git/doc/guix.texi:27145
48758 msgid "IDMAP Daemon Service"
48762 #: guix-git/doc/guix.texi:27146
48768 #: guix-git/doc/guix.texi:27147
48770 msgid "name mapper"
48773 #. type: Plain text
48774 #: guix-git/doc/guix.texi:27151
48775 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."
48779 #: guix-git/doc/guix.texi:27152
48781 msgid "{Scheme Variable} idmap-service-type"
48785 #: guix-git/doc/guix.texi:27154
48786 msgid "A service type for the Identity Mapper (IDMAP) daemon."
48790 #: guix-git/doc/guix.texi:27156
48792 msgid "{Data Type} idmap-configuration"
48796 #: guix-git/doc/guix.texi:27159
48797 msgid "Data type representing the configuration of the IDMAP daemon service. This type has the following parameters:"
48801 #: guix-git/doc/guix.texi:27162
48802 msgid "The package in which the @command{rpc.idmapd} command is to be found."
48806 #: guix-git/doc/guix.texi:27166
48808 msgid "@code{domain} (default: @code{#f})"
48812 #: guix-git/doc/guix.texi:27170
48813 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."
48817 #: guix-git/doc/guix.texi:27171
48819 msgid "@code{verbosity} (default: @code{0})"
48823 #: guix-git/doc/guix.texi:27173
48824 msgid "The verbosity level of the daemon."
48827 #. type: Plain text
48828 #: guix-git/doc/guix.texi:27184
48829 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})."
48832 #. type: Plain text
48833 #: guix-git/doc/guix.texi:27186
48834 msgid "The @code{(gnu services cuirass)} module provides the following service."
48838 #: guix-git/doc/guix.texi:27187
48840 msgid "{Scheme Procedure} cuirass-service-type"
48844 #: guix-git/doc/guix.texi:27190
48845 msgid "The type of the Cuirass service. Its value must be a @code{cuirass-configuration} object, as described below."
48848 #. type: Plain text
48849 #: guix-git/doc/guix.texi:27195
48850 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."
48854 #: guix-git/doc/guix.texi:27206
48857 "(define %cuirass-specs\n"
48858 " #~(list (specification\n"
48859 " (name \"my-channel\")\n"
48860 " (build '(channels my-channel))\n"
48862 " (cons (channel\n"
48863 " (name 'my-channel)\n"
48864 " (url \"https://my-channel.git\"))\n"
48865 " %default-channels)))))\n"
48870 #: guix-git/doc/guix.texi:27210 guix-git/doc/guix.texi:27224
48873 "(service cuirass-service-type\n"
48874 " (cuirass-configuration\n"
48875 " (specifications %cuirass-specs)))\n"
48878 #. type: Plain text
48879 #: guix-git/doc/guix.texi:27214
48880 msgid "To build the @code{linux-libre} package defined by the default Guix channel, one can use the following configuration."
48884 #: guix-git/doc/guix.texi:27220
48887 "(define %cuirass-specs\n"
48888 " #~(list (specification\n"
48889 " (name \"my-linux\")\n"
48890 " (build '(packages \"linux-libre\")))))\n"
48894 #. type: Plain text
48895 #: guix-git/doc/guix.texi:27229
48896 msgid "The other configuration possibilities, as well as the specification record itself are described in the Cuirass manual (@pxref{Specifications,,, cuirass, Cuirass})."
48899 #. type: Plain text
48900 #: guix-git/doc/guix.texi:27233
48901 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."
48905 #: guix-git/doc/guix.texi:27234
48907 msgid "{Data Type} cuirass-configuration"
48911 #: guix-git/doc/guix.texi:27236
48912 msgid "Data type representing the configuration of Cuirass."
48916 #: guix-git/doc/guix.texi:27238 guix-git/doc/guix.texi:27370
48918 msgid "@code{cuirass} (default: @code{cuirass})"
48922 #: guix-git/doc/guix.texi:27240 guix-git/doc/guix.texi:27372
48923 msgid "The Cuirass package to use."
48927 #: guix-git/doc/guix.texi:27241
48929 msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})"
48933 #: guix-git/doc/guix.texi:27243 guix-git/doc/guix.texi:27347
48934 #: guix-git/doc/guix.texi:27385
48935 msgid "Location of the log file."
48939 #: guix-git/doc/guix.texi:27244
48941 msgid "@code{web-log-file} (default: @code{\"/var/log/cuirass-web.log\"})"
48945 #: guix-git/doc/guix.texi:27246
48946 msgid "Location of the log file used by the web interface."
48950 #: guix-git/doc/guix.texi:27247
48952 msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})"
48956 #: guix-git/doc/guix.texi:27249
48957 msgid "Location of the repository cache."
48961 #: guix-git/doc/guix.texi:27250
48963 msgid "@code{user} (default: @code{\"cuirass\"})"
48967 #: guix-git/doc/guix.texi:27252
48968 msgid "Owner of the @code{cuirass} process."
48972 #: guix-git/doc/guix.texi:27253
48974 msgid "@code{group} (default: @code{\"cuirass\"})"
48978 #: guix-git/doc/guix.texi:27255
48979 msgid "Owner's group of the @code{cuirass} process."
48983 #: guix-git/doc/guix.texi:27256
48985 msgid "@code{interval} (default: @code{60})"
48989 #: guix-git/doc/guix.texi:27259
48990 msgid "Number of seconds between the poll of the repositories followed by the Cuirass jobs."
48994 #: guix-git/doc/guix.texi:27260
48996 msgid "@code{parameters} (default: @code{#f})"
49000 #: guix-git/doc/guix.texi:27263
49001 msgid "Read parameters from the given @var{parameters} file. The supported parameters are described here (@pxref{Parameters,,, cuirass, Cuirass})."
49005 #: guix-git/doc/guix.texi:27264
49007 msgid "@code{remote-server} (default: @code{#f})"
49011 #: guix-git/doc/guix.texi:27267
49012 msgid "A @code{cuirass-remote-server-configuration} record to use the build remote mechanism or @code{#f} to use the default build mechanism."
49016 #: guix-git/doc/guix.texi:27268
49018 msgid "@code{database} (default: @code{\"dbname=cuirass host=/var/run/postgresql\"})"
49022 #: guix-git/doc/guix.texi:27273
49023 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\"}."
49027 #: guix-git/doc/guix.texi:27274
49029 msgid "@code{port} (default: @code{8081})"
49033 #: guix-git/doc/guix.texi:27276
49034 msgid "Port number used by the HTTP server."
49038 #: guix-git/doc/guix.texi:27280
49039 msgid "Listen on the network interface for @var{host}. The default is to accept connections from localhost."
49043 #: guix-git/doc/guix.texi:27281
49045 msgid "@code{specifications} (default: @code{#~'()})"
49049 #: guix-git/doc/guix.texi:27285
49050 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})."
49054 #: guix-git/doc/guix.texi:27286
49056 msgid "@code{use-substitutes?} (default: @code{#f})"
49060 #: guix-git/doc/guix.texi:27289
49061 msgid "This allows using substitutes to avoid building every dependencies of a job from source."
49065 #: guix-git/doc/guix.texi:27290 guix-git/doc/guix.texi:34160
49067 msgid "@code{one-shot?} (default: @code{#f})"
49071 #: guix-git/doc/guix.texi:27292
49072 msgid "Only evaluate specifications and build derivations once."
49076 #: guix-git/doc/guix.texi:27293
49078 msgid "@code{fallback?} (default: @code{#f})"
49082 #: guix-git/doc/guix.texi:27296
49083 msgid "When substituting a pre-built binary fails, fall back to building packages locally."
49087 #: guix-git/doc/guix.texi:27299
49088 msgid "Extra options to pass when running the Cuirass processes."
49092 #: guix-git/doc/guix.texi:27303
49094 msgid "remote build"
49097 #. type: subsubheading
49098 #: guix-git/doc/guix.texi:27304
49100 msgid "Cuirass remote building"
49103 #. type: Plain text
49104 #: guix-git/doc/guix.texi:27307
49105 msgid "Cuirass supports two mechanisms to build derivations."
49109 #: guix-git/doc/guix.texi:27309
49111 msgid "Using the local Guix daemon."
49115 #: guix-git/doc/guix.texi:27313
49116 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."
49120 #: guix-git/doc/guix.texi:27314
49122 msgid "Using the remote build mechanism."
49126 #: guix-git/doc/guix.texi:27318
49127 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."
49130 #. type: Plain text
49131 #: guix-git/doc/guix.texi:27325
49132 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."
49135 #. type: Plain text
49136 #: guix-git/doc/guix.texi:27330
49137 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."
49141 #: guix-git/doc/guix.texi:27331
49143 msgid "{Data Type} cuirass-remote-server-configuration"
49147 #: guix-git/doc/guix.texi:27333
49148 msgid "Data type representing the configuration of the Cuirass remote-server."
49152 #: guix-git/doc/guix.texi:27335
49154 msgid "@code{backend-port} (default: @code{5555})"
49158 #: guix-git/doc/guix.texi:27338
49159 msgid "The TCP port for communicating with @code{remote-worker} processes using ZMQ. It defaults to @code{5555}."
49163 #: guix-git/doc/guix.texi:27339
49165 msgid "@code{log-port} (default: @code{5556})"
49169 #: guix-git/doc/guix.texi:27341
49170 msgid "The TCP port of the log server. It defaults to @code{5556}."
49174 #: guix-git/doc/guix.texi:27342
49176 msgid "@code{publish-port} (default: @code{5557})"
49180 #: guix-git/doc/guix.texi:27344
49181 msgid "The TCP port of the publish server. It defaults to @code{5557}."
49185 #: guix-git/doc/guix.texi:27345
49187 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-server.log\"})"
49191 #: guix-git/doc/guix.texi:27348
49193 msgid "@code{cache} (default: @code{\"/var/cache/cuirass/remote\"})"
49197 #: guix-git/doc/guix.texi:27350
49198 msgid "Use @var{cache} directory to cache build log files."
49202 #: guix-git/doc/guix.texi:27351
49204 msgid "@code{trigger-url} (default: @code{#f})"
49208 #: guix-git/doc/guix.texi:27354
49209 msgid "Once a substitute is successfully fetched, trigger substitute baking at @var{trigger-url}."
49213 #: guix-git/doc/guix.texi:27356 guix-git/doc/guix.texi:27390
49215 msgid "private-key"
49218 #. type: Plain text
49219 #: guix-git/doc/guix.texi:27365
49220 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."
49224 #: guix-git/doc/guix.texi:27366
49226 msgid "{Data Type} cuirass-remote-worker-configuration"
49230 #: guix-git/doc/guix.texi:27368
49231 msgid "Data type representing the configuration of the Cuirass remote-worker."
49235 #: guix-git/doc/guix.texi:27373
49237 msgid "@code{workers} (default: @code{1})"
49241 #: guix-git/doc/guix.texi:27375
49242 msgid "Start @var{workers} parallel workers."
49246 #: guix-git/doc/guix.texi:27379
49247 msgid "Do not use Avahi discovery and connect to the given @code{server} IP address instead."
49251 #: guix-git/doc/guix.texi:27380
49253 msgid "@code{systems} (default: @code{(list (%current-system))})"
49257 #: guix-git/doc/guix.texi:27382
49258 msgid "Only request builds for the given @var{systems}."
49262 #: guix-git/doc/guix.texi:27383
49264 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-worker.log\"})"
49268 #: guix-git/doc/guix.texi:27386
49270 msgid "@code{publish-port} (default: @code{5558})"
49274 #: guix-git/doc/guix.texi:27388
49275 msgid "The TCP port of the publish server. It defaults to @code{5558}."
49278 #. type: subsubheading
49279 #: guix-git/doc/guix.texi:27397
49284 #. type: Plain text
49285 #: guix-git/doc/guix.texi:27402
49286 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."
49289 #. type: Plain text
49290 #: guix-git/doc/guix.texi:27405
49291 msgid "Laminar encourages the use of existing tools such as bash and cron instead of reinventing them."
49295 #: guix-git/doc/guix.texi:27406
49297 msgid "{Scheme Procedure} laminar-service-type"
49301 #: guix-git/doc/guix.texi:27409
49302 msgid "The type of the Laminar service. Its value must be a @code{laminar-configuration} object, as described below."
49306 #: guix-git/doc/guix.texi:27413
49307 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."
49311 #: guix-git/doc/guix.texi:27416
49313 msgid "(service laminar-service-type)\n"
49317 #: guix-git/doc/guix.texi:27419
49319 msgid "{Data Type} laminar-configuration"
49323 #: guix-git/doc/guix.texi:27421
49324 msgid "Data type representing the configuration of Laminar."
49328 #: guix-git/doc/guix.texi:27423
49330 msgid "@code{laminar} (default: @code{laminar})"
49334 #: guix-git/doc/guix.texi:27425
49335 msgid "The Laminar package to use."
49339 #: guix-git/doc/guix.texi:27426
49341 msgid "@code{home-directory} (default: @code{\"/var/lib/laminar\"})"
49345 #: guix-git/doc/guix.texi:27428
49346 msgid "The directory for job configurations and run directories."
49350 #: guix-git/doc/guix.texi:27429
49352 msgid "@code{bind-http} (default: @code{\"*:8080\"})"
49356 #: guix-git/doc/guix.texi:27432
49357 msgid "The interface/port or unix socket on which laminard should listen for incoming connections to the web frontend."
49361 #: guix-git/doc/guix.texi:27433
49363 msgid "@code{bind-rpc} (default: @code{\"unix-abstract:laminar\"})"
49367 #: guix-git/doc/guix.texi:27436
49368 msgid "The interface/port or unix socket on which laminard should listen for incoming commands such as build triggers."
49372 #: guix-git/doc/guix.texi:27437
49374 msgid "@code{title} (default: @code{\"Laminar\"})"
49378 #: guix-git/doc/guix.texi:27439
49379 msgid "The page title to show in the web frontend."
49383 #: guix-git/doc/guix.texi:27440
49385 msgid "@code{keep-rundirs} (default: @code{0})"
49389 #: guix-git/doc/guix.texi:27444
49390 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."
49394 #: guix-git/doc/guix.texi:27445
49396 msgid "@code{archive-url} (default: @code{#f})"
49400 #: guix-git/doc/guix.texi:27448
49401 msgid "The web frontend served by laminard will use this URL to form links to artefacts archived jobs."
49405 #: guix-git/doc/guix.texi:27449
49407 msgid "@code{base-url} (default: @code{#f})"
49411 #: guix-git/doc/guix.texi:27451
49412 msgid "Base URL to use for links to laminar itself."
49416 #: guix-git/doc/guix.texi:27458
49422 #: guix-git/doc/guix.texi:27459
49424 msgid "power management with TLP"
49427 #. type: subsubheading
49428 #: guix-git/doc/guix.texi:27460
49433 #. type: Plain text
49434 #: guix-git/doc/guix.texi:27464
49435 msgid "The @code{(gnu services pm)} module provides a Guix service definition for the Linux power management tool TLP."
49438 #. type: Plain text
49439 #: guix-git/doc/guix.texi:27470
49440 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}."
49444 #: guix-git/doc/guix.texi:27471
49446 msgid "{Scheme Variable} tlp-service-type"
49450 #: guix-git/doc/guix.texi:27475
49451 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}:"
49455 #: guix-git/doc/guix.texi:27480
49458 "(service tlp-service-type\n"
49459 " (tlp-configuration\n"
49460 " (cpu-scaling-governor-on-ac (list \"performance\"))\n"
49461 " (sched-powersave-on-bat? #t)))\n"
49464 #. type: Plain text
49465 #: guix-git/doc/guix.texi:27488
49466 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}."
49469 #. type: Plain text
49470 #: guix-git/doc/guix.texi:27498
49471 msgid "Available @code{tlp-configuration} fields are:"
49475 #: guix-git/doc/guix.texi:27499
49477 msgid "{@code{tlp-configuration} parameter} package tlp"
49481 #: guix-git/doc/guix.texi:27501
49482 msgid "The TLP package."
49486 #: guix-git/doc/guix.texi:27504
49488 msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?"
49492 #: guix-git/doc/guix.texi:27506
49493 msgid "Set to true if you wish to enable TLP."
49497 #: guix-git/doc/guix.texi:27511
49499 msgid "{@code{tlp-configuration} parameter} string tlp-default-mode"
49503 #: guix-git/doc/guix.texi:27514
49504 msgid "Default mode when no power supply can be detected. Alternatives are AC and BAT."
49508 #: guix-git/doc/guix.texi:27516
49509 msgid "Defaults to @samp{\"AC\"}."
49513 #: guix-git/doc/guix.texi:27519
49515 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac"
49519 #: guix-git/doc/guix.texi:27522
49520 msgid "Number of seconds Linux kernel has to wait after the disk goes idle, before syncing on AC."
49524 #: guix-git/doc/guix.texi:27527
49526 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat"
49530 #: guix-git/doc/guix.texi:27529
49531 msgid "Same as @code{disk-idle-ac} but on BAT mode."
49535 #: guix-git/doc/guix.texi:27531
49536 msgid "Defaults to @samp{2}."
49540 #: guix-git/doc/guix.texi:27534
49542 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac"
49546 #: guix-git/doc/guix.texi:27536
49547 msgid "Dirty pages flushing periodicity, expressed in seconds."
49551 #: guix-git/doc/guix.texi:27538 guix-git/doc/guix.texi:27761
49552 #: guix-git/doc/guix.texi:29975 guix-git/doc/guix.texi:29983
49553 msgid "Defaults to @samp{15}."
49557 #: guix-git/doc/guix.texi:27541
49559 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat"
49563 #: guix-git/doc/guix.texi:27543
49564 msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode."
49568 #: guix-git/doc/guix.texi:27545
49569 msgid "Defaults to @samp{60}."
49573 #: guix-git/doc/guix.texi:27548
49575 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac"
49579 #: guix-git/doc/guix.texi:27552
49580 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."
49584 #: guix-git/doc/guix.texi:27557
49586 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat"
49590 #: guix-git/doc/guix.texi:27559
49591 msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode."
49595 #: guix-git/doc/guix.texi:27564
49597 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac"
49601 #: guix-git/doc/guix.texi:27566
49602 msgid "Set the min available frequency for the scaling governor on AC."
49606 #: guix-git/doc/guix.texi:27571
49608 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac"
49612 #: guix-git/doc/guix.texi:27573
49613 msgid "Set the max available frequency for the scaling governor on AC."
49617 #: guix-git/doc/guix.texi:27578
49619 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat"
49623 #: guix-git/doc/guix.texi:27580
49624 msgid "Set the min available frequency for the scaling governor on BAT."
49628 #: guix-git/doc/guix.texi:27585
49630 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat"
49634 #: guix-git/doc/guix.texi:27587
49635 msgid "Set the max available frequency for the scaling governor on BAT."
49639 #: guix-git/doc/guix.texi:27592
49641 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac"
49645 #: guix-git/doc/guix.texi:27595
49646 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."
49650 #: guix-git/doc/guix.texi:27600
49652 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac"
49656 #: guix-git/doc/guix.texi:27603
49657 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."
49661 #: guix-git/doc/guix.texi:27608
49663 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat"
49667 #: guix-git/doc/guix.texi:27610
49668 msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode."
49672 #: guix-git/doc/guix.texi:27615
49674 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat"
49678 #: guix-git/doc/guix.texi:27617
49679 msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode."
49683 #: guix-git/doc/guix.texi:27622
49685 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?"
49689 #: guix-git/doc/guix.texi:27624
49690 msgid "Enable CPU turbo boost feature on AC mode."
49694 #: guix-git/doc/guix.texi:27629
49696 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?"
49700 #: guix-git/doc/guix.texi:27631
49701 msgid "Same as @code{cpu-boost-on-ac?} on BAT mode."
49705 #: guix-git/doc/guix.texi:27636
49707 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?"
49711 #: guix-git/doc/guix.texi:27639
49712 msgid "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions."
49716 #: guix-git/doc/guix.texi:27644
49718 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?"
49722 #: guix-git/doc/guix.texi:27646
49723 msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode."
49727 #: guix-git/doc/guix.texi:27651
49729 msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?"
49733 #: guix-git/doc/guix.texi:27653
49734 msgid "Enable Linux kernel NMI watchdog."
49738 #: guix-git/doc/guix.texi:27658
49740 msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls"
49744 #: guix-git/doc/guix.texi:27661
49745 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\"}."
49749 #: guix-git/doc/guix.texi:27666
49751 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac"
49755 #: guix-git/doc/guix.texi:27669
49756 msgid "Set CPU performance versus energy saving policy on AC@. Alternatives are performance, normal, powersave."
49760 #: guix-git/doc/guix.texi:27671 guix-git/doc/guix.texi:27769
49761 #: guix-git/doc/guix.texi:27799
49762 msgid "Defaults to @samp{\"performance\"}."
49766 #: guix-git/doc/guix.texi:27674
49768 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat"
49772 #: guix-git/doc/guix.texi:27676
49773 msgid "Same as @code{energy-perf-policy-ac} but on BAT mode."
49777 #: guix-git/doc/guix.texi:27678 guix-git/doc/guix.texi:27776
49778 msgid "Defaults to @samp{\"powersave\"}."
49782 #: guix-git/doc/guix.texi:27681
49784 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices"
49788 #: guix-git/doc/guix.texi:27683
49789 msgid "Hard disk devices."
49793 #: guix-git/doc/guix.texi:27686
49795 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac"
49799 #: guix-git/doc/guix.texi:27688
49800 msgid "Hard disk advanced power management level."
49804 #: guix-git/doc/guix.texi:27691
49806 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat"
49810 #: guix-git/doc/guix.texi:27693
49811 msgid "Same as @code{disk-apm-bat} but on BAT mode."
49815 #: guix-git/doc/guix.texi:27696
49817 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac"
49821 #: guix-git/doc/guix.texi:27699
49822 msgid "Hard disk spin down timeout. One value has to be specified for each declared hard disk."
49826 #: guix-git/doc/guix.texi:27704
49828 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat"
49832 #: guix-git/doc/guix.texi:27706
49833 msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode."
49837 #: guix-git/doc/guix.texi:27711
49839 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched"
49843 #: guix-git/doc/guix.texi:27715
49844 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."
49848 #: guix-git/doc/guix.texi:27720
49850 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac"
49854 #: guix-git/doc/guix.texi:27723
49855 msgid "SATA aggressive link power management (ALPM) level. Alternatives are min_power, medium_power, max_performance."
49859 #: guix-git/doc/guix.texi:27725
49860 msgid "Defaults to @samp{\"max_performance\"}."
49864 #: guix-git/doc/guix.texi:27728
49866 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat"
49870 #: guix-git/doc/guix.texi:27730
49871 msgid "Same as @code{sata-linkpwr-ac} but on BAT mode."
49875 #: guix-git/doc/guix.texi:27732
49876 msgid "Defaults to @samp{\"min_power\"}."
49880 #: guix-git/doc/guix.texi:27735
49882 msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist"
49886 #: guix-git/doc/guix.texi:27737
49887 msgid "Exclude specified SATA host devices for link power management."
49891 #: guix-git/doc/guix.texi:27742
49893 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?"
49897 #: guix-git/doc/guix.texi:27745
49898 msgid "Enable Runtime Power Management for AHCI controller and disks on AC mode."
49902 #: guix-git/doc/guix.texi:27750
49904 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?"
49908 #: guix-git/doc/guix.texi:27752
49909 msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode."
49913 #: guix-git/doc/guix.texi:27757
49915 msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout"
49919 #: guix-git/doc/guix.texi:27759
49920 msgid "Seconds of inactivity before disk is suspended."
49924 #: guix-git/doc/guix.texi:27764
49926 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac"
49930 #: guix-git/doc/guix.texi:27767
49931 msgid "PCI Express Active State Power Management level. Alternatives are default, performance, powersave."
49935 #: guix-git/doc/guix.texi:27772
49937 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat"
49941 #: guix-git/doc/guix.texi:27774
49942 msgid "Same as @code{pcie-aspm-ac} but on BAT mode."
49946 #: guix-git/doc/guix.texi:27779
49948 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac"
49952 #: guix-git/doc/guix.texi:27782
49953 msgid "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, default."
49957 #: guix-git/doc/guix.texi:27784
49958 msgid "Defaults to @samp{\"high\"}."
49962 #: guix-git/doc/guix.texi:27787
49964 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat"
49968 #: guix-git/doc/guix.texi:27789
49969 msgid "Same as @code{radeon-power-ac} but on BAT mode."
49973 #: guix-git/doc/guix.texi:27791
49974 msgid "Defaults to @samp{\"low\"}."
49978 #: guix-git/doc/guix.texi:27794
49980 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac"
49984 #: guix-git/doc/guix.texi:27797
49985 msgid "Radeon dynamic power management method (DPM). Alternatives are battery, performance."
49989 #: guix-git/doc/guix.texi:27802
49991 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat"
49995 #: guix-git/doc/guix.texi:27804
49996 msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode."
50000 #: guix-git/doc/guix.texi:27806
50001 msgid "Defaults to @samp{\"battery\"}."
50005 #: guix-git/doc/guix.texi:27809
50007 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac"
50011 #: guix-git/doc/guix.texi:27811
50012 msgid "Radeon DPM performance level. Alternatives are auto, low, high."
50016 #: guix-git/doc/guix.texi:27813 guix-git/doc/guix.texi:27820
50017 #: guix-git/doc/guix.texi:27894
50018 msgid "Defaults to @samp{\"auto\"}."
50022 #: guix-git/doc/guix.texi:27816
50024 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat"
50028 #: guix-git/doc/guix.texi:27818
50029 msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode."
50033 #: guix-git/doc/guix.texi:27823
50035 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?"
50039 #: guix-git/doc/guix.texi:27825
50040 msgid "Wifi power saving mode."
50044 #: guix-git/doc/guix.texi:27830
50046 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?"
50050 #: guix-git/doc/guix.texi:27832
50051 msgid "Same as @code{wifi-power-ac?} but on BAT mode."
50055 #: guix-git/doc/guix.texi:27837
50057 msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?"
50061 #: guix-git/doc/guix.texi:27839
50062 msgid "Disable wake on LAN."
50066 #: guix-git/doc/guix.texi:27844
50068 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac"
50072 #: guix-git/doc/guix.texi:27847
50073 msgid "Timeout duration in seconds before activating audio power saving on Intel HDA and AC97 devices. A value of 0 disables power saving."
50077 #: guix-git/doc/guix.texi:27852
50079 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat"
50083 #: guix-git/doc/guix.texi:27854
50084 msgid "Same as @code{sound-powersave-ac} but on BAT mode."
50088 #: guix-git/doc/guix.texi:27859
50090 msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?"
50094 #: guix-git/doc/guix.texi:27861
50095 msgid "Disable controller in powersaving mode on Intel HDA devices."
50099 #: guix-git/doc/guix.texi:27866
50101 msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?"
50105 #: guix-git/doc/guix.texi:27870
50106 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."
50110 #: guix-git/doc/guix.texi:27875
50112 msgid "{@code{tlp-configuration} parameter} string bay-device"
50116 #: guix-git/doc/guix.texi:27877
50117 msgid "Name of the optical drive device to power off."
50121 #: guix-git/doc/guix.texi:27879
50122 msgid "Defaults to @samp{\"sr0\"}."
50126 #: guix-git/doc/guix.texi:27882
50128 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac"
50132 #: guix-git/doc/guix.texi:27885
50133 msgid "Runtime Power Management for PCI(e) bus devices. Alternatives are on and auto."
50137 #: guix-git/doc/guix.texi:27887
50138 msgid "Defaults to @samp{\"on\"}."
50142 #: guix-git/doc/guix.texi:27890
50144 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat"
50148 #: guix-git/doc/guix.texi:27892
50149 msgid "Same as @code{runtime-pm-ac} but on BAT mode."
50153 #: guix-git/doc/guix.texi:27897
50155 msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?"
50159 #: guix-git/doc/guix.texi:27900
50160 msgid "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones."
50164 #: guix-git/doc/guix.texi:27905
50166 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist"
50170 #: guix-git/doc/guix.texi:27907
50171 msgid "Exclude specified PCI(e) device addresses from Runtime Power Management."
50175 #: guix-git/doc/guix.texi:27912
50177 msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist"
50181 #: guix-git/doc/guix.texi:27915
50182 msgid "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management."
50186 #: guix-git/doc/guix.texi:27918
50188 msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?"
50192 #: guix-git/doc/guix.texi:27920
50193 msgid "Enable USB autosuspend feature."
50197 #: guix-git/doc/guix.texi:27925
50199 msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist"
50203 #: guix-git/doc/guix.texi:27927
50204 msgid "Exclude specified devices from USB autosuspend."
50208 #: guix-git/doc/guix.texi:27932
50210 msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?"
50214 #: guix-git/doc/guix.texi:27934
50215 msgid "Exclude WWAN devices from USB autosuspend."
50219 #: guix-git/doc/guix.texi:27939
50221 msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist"
50225 #: guix-git/doc/guix.texi:27942
50226 msgid "Include specified devices into USB autosuspend, even if they are already excluded by the driver or via @code{usb-blacklist-wwan?}."
50230 #: guix-git/doc/guix.texi:27947
50232 msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?"
50236 #: guix-git/doc/guix.texi:27949
50237 msgid "Enable USB autosuspend before shutdown."
50241 #: guix-git/doc/guix.texi:27954
50243 msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?"
50247 #: guix-git/doc/guix.texi:27957
50248 msgid "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup."
50252 #: guix-git/doc/guix.texi:27962
50258 #: guix-git/doc/guix.texi:27963
50260 msgid "CPU frequency scaling with thermald"
50263 #. type: subsubheading
50264 #: guix-git/doc/guix.texi:27964
50266 msgid "Thermald daemon"
50269 #. type: Plain text
50270 #: guix-git/doc/guix.texi:27968
50271 msgid "The @code{(gnu services pm)} module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating."
50275 #: guix-git/doc/guix.texi:27969
50277 msgid "{Scheme Variable} thermald-service-type"
50281 #: guix-git/doc/guix.texi:27974
50282 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."
50286 #: guix-git/doc/guix.texi:27976
50288 msgid "{Data Type} thermald-configuration"
50292 #: guix-git/doc/guix.texi:27978
50293 msgid "Data type representing the configuration of @code{thermald-service-type}."
50297 #: guix-git/doc/guix.texi:27980
50299 msgid "@code{ignore-cpuid-check?} (default: @code{#f})"
50303 #: guix-git/doc/guix.texi:27982
50304 msgid "Ignore cpuid check for supported CPU models."
50308 #: guix-git/doc/guix.texi:27983
50310 msgid "@code{thermald} (default: @var{thermald})"
50314 #: guix-git/doc/guix.texi:27985
50315 msgid "Package object of thermald."
50318 #. type: Plain text
50319 #: guix-git/doc/guix.texi:27994
50320 msgid "The @code{(gnu services audio)} module provides a service to start MPD (the Music Player Daemon)."
50324 #: guix-git/doc/guix.texi:27995
50329 #. type: subsubheading
50330 #: guix-git/doc/guix.texi:27996
50332 msgid "Music Player Daemon"
50335 #. type: Plain text
50336 #: guix-git/doc/guix.texi:28001
50337 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."
50340 #. type: Plain text
50341 #: guix-git/doc/guix.texi:28004
50342 msgid "The following example shows how one might run @code{mpd} as user @code{\"bob\"} on port @code{6666}. It uses pulseaudio for output."
50346 #: guix-git/doc/guix.texi:28010
50349 "(service mpd-service-type\n"
50350 " (mpd-configuration\n"
50351 " (user \"bob\")\n"
50352 " (port \"6666\")))\n"
50356 #: guix-git/doc/guix.texi:28012
50358 msgid "{Scheme Variable} mpd-service-type"
50362 #: guix-git/doc/guix.texi:28014
50363 msgid "The service type for @command{mpd}"
50367 #: guix-git/doc/guix.texi:28016
50369 msgid "{Data Type} mpd-configuration"
50373 #: guix-git/doc/guix.texi:28018
50374 msgid "Data type representing the configuration of @command{mpd}."
50378 #: guix-git/doc/guix.texi:28020
50380 msgid "@code{user} (default: @code{\"mpd\"})"
50384 #: guix-git/doc/guix.texi:28022
50385 msgid "The user to run mpd as."
50389 #: guix-git/doc/guix.texi:28023
50391 msgid "@code{music-dir} (default: @code{\"~/Music\"})"
50395 #: guix-git/doc/guix.texi:28025
50396 msgid "The directory to scan for music files."
50400 #: guix-git/doc/guix.texi:28026
50402 msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})"
50406 #: guix-git/doc/guix.texi:28028
50407 msgid "The directory to store playlists."
50411 #: guix-git/doc/guix.texi:28029
50413 msgid "@code{db-file} (default: @code{\"~/.mpd/tag_cache\"})"
50417 #: guix-git/doc/guix.texi:28031
50418 msgid "The location of the music database."
50422 #: guix-git/doc/guix.texi:28032
50424 msgid "@code{state-file} (default: @code{\"~/.mpd/state\"})"
50428 #: guix-git/doc/guix.texi:28034
50429 msgid "The location of the file that stores current MPD's state."
50433 #: guix-git/doc/guix.texi:28035
50435 msgid "@code{sticker-file} (default: @code{\"~/.mpd/sticker.sql\"})"
50439 #: guix-git/doc/guix.texi:28037
50440 msgid "The location of the sticker database."
50444 #: guix-git/doc/guix.texi:28038
50446 msgid "@code{port} (default: @code{\"6600\"})"
50450 #: guix-git/doc/guix.texi:28040
50451 msgid "The port to run mpd on."
50455 #: guix-git/doc/guix.texi:28041
50457 msgid "@code{address} (default: @code{\"any\"})"
50461 #: guix-git/doc/guix.texi:28044
50462 msgid "The address that mpd will bind to. To use a Unix domain socket, an absolute path can be specified here."
50466 #: guix-git/doc/guix.texi:28045
50468 msgid "@code{outputs} (default: @code{\"(list (mpd-output))\"})"
50472 #: guix-git/doc/guix.texi:28047
50473 msgid "The audio outputs that MPD can use. By default this is a single output using pulseaudio."
50477 #: guix-git/doc/guix.texi:28051
50479 msgid "{Data Type} mpd-output"
50483 #: guix-git/doc/guix.texi:28053
50484 msgid "Data type representing an @command{mpd} audio output."
50488 #: guix-git/doc/guix.texi:28055
50490 msgid "@code{name} (default: @code{\"MPD\"})"
50494 #: guix-git/doc/guix.texi:28057
50495 msgid "The name of the audio output."
50499 #: guix-git/doc/guix.texi:28058
50501 msgid "@code{type} (default: @code{\"pulse\"})"
50505 #: guix-git/doc/guix.texi:28060
50506 msgid "The type of audio output."
50510 #: guix-git/doc/guix.texi:28061
50512 msgid "@code{enabled?} (default: @code{#t})"
50516 #: guix-git/doc/guix.texi:28066
50517 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."
50521 #: guix-git/doc/guix.texi:28067
50523 msgid "@code{tags?} (default: @code{#t})"
50527 #: guix-git/doc/guix.texi:28071
50528 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."
50532 #: guix-git/doc/guix.texi:28072
50534 msgid "@code{always-on?} (default: @code{#f})"
50538 #: guix-git/doc/guix.texi:28076
50539 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."
50543 #: guix-git/doc/guix.texi:28077
50549 #: guix-git/doc/guix.texi:28083
50550 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})."
50554 #: guix-git/doc/guix.texi:28087
50555 msgid "An association list of option symbols to string values to be appended to the audio output configuration."
50558 #. type: Plain text
50559 #: guix-git/doc/guix.texi:28093
50560 msgid "The following example shows a configuration of @code{mpd} that provides an HTTP audio streaming output."
50564 #: guix-git/doc/guix.texi:28105
50567 "(service mpd-service-type\n"
50568 " (mpd-configuration\n"
50570 " (list (mpd-output\n"
50571 " (name \"streaming\")\n"
50572 " (type \"httpd\")\n"
50573 " (mixer-type 'null)\n"
50574 " (extra-options\n"
50575 " `((encoder . \"vorbis\")\n"
50576 " (port . \"8080\"))))))))\n"
50579 #. type: Plain text
50580 #: guix-git/doc/guix.texi:28114
50581 msgid "The @code{(gnu services virtualization)} module provides services for the libvirt and virtlog daemons, as well as other virtualization-related services."
50584 #. type: subsubheading
50585 #: guix-git/doc/guix.texi:28115
50587 msgid "Libvirt daemon"
50590 #. type: Plain text
50591 #: guix-git/doc/guix.texi:28120
50592 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."
50596 #: guix-git/doc/guix.texi:28121
50598 msgid "{Scheme Variable} libvirt-service-type"
50602 #: guix-git/doc/guix.texi:28124
50603 msgid "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its value must be a @code{libvirt-configuration}."
50607 #: guix-git/doc/guix.texi:28130
50610 "(service libvirt-service-type\n"
50611 " (libvirt-configuration\n"
50612 " (unix-sock-group \"libvirt\")\n"
50613 " (tls-port \"16555\")))\n"
50616 #. type: Plain text
50617 #: guix-git/doc/guix.texi:28135
50618 msgid "Available @code{libvirt-configuration} fields are:"
50622 #: guix-git/doc/guix.texi:28136
50624 msgid "{@code{libvirt-configuration} parameter} package libvirt"
50628 #: guix-git/doc/guix.texi:28138
50629 msgid "Libvirt package."
50633 #: guix-git/doc/guix.texi:28141
50635 msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?"
50639 #: guix-git/doc/guix.texi:28144
50640 msgid "Flag listening for secure TLS connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
50644 #: guix-git/doc/guix.texi:28147
50645 msgid "It is necessary to setup a CA and issue server certificates before using this capability."
50649 #: guix-git/doc/guix.texi:28152
50651 msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?"
50655 #: guix-git/doc/guix.texi:28155
50656 msgid "Listen for unencrypted TCP connections on the public TCP/IP port. You must set @code{listen} for this to have any effect."
50660 #: guix-git/doc/guix.texi:28159
50661 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)."
50665 #: guix-git/doc/guix.texi:28164
50667 msgid "{@code{libvirt-configuration} parameter} string tls-port"
50671 #: guix-git/doc/guix.texi:28167
50672 msgid "Port for accepting secure TLS connections. This can be a port number, or service name."
50676 #: guix-git/doc/guix.texi:28169
50677 msgid "Defaults to @samp{\"16514\"}."
50681 #: guix-git/doc/guix.texi:28172
50683 msgid "{@code{libvirt-configuration} parameter} string tcp-port"
50687 #: guix-git/doc/guix.texi:28175
50688 msgid "Port for accepting insecure TCP connections. This can be a port number, or service name."
50692 #: guix-git/doc/guix.texi:28177
50693 msgid "Defaults to @samp{\"16509\"}."
50697 #: guix-git/doc/guix.texi:28180
50699 msgid "{@code{libvirt-configuration} parameter} string listen-addr"
50703 #: guix-git/doc/guix.texi:28182
50704 msgid "IP address or hostname used for client connections."
50708 #: guix-git/doc/guix.texi:28187
50710 msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?"
50714 #: guix-git/doc/guix.texi:28189
50715 msgid "Flag toggling mDNS advertisement of the libvirt service."
50719 #: guix-git/doc/guix.texi:28192
50720 msgid "Alternatively can disable for all services on a host by stopping the Avahi daemon."
50724 #: guix-git/doc/guix.texi:28197
50726 msgid "{@code{libvirt-configuration} parameter} string mdns-name"
50730 #: guix-git/doc/guix.texi:28200
50731 msgid "Default mDNS advertisement name. This must be unique on the immediate broadcast network."
50735 #: guix-git/doc/guix.texi:28202
50736 msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}."
50740 #: guix-git/doc/guix.texi:28205
50742 msgid "{@code{libvirt-configuration} parameter} string unix-sock-group"
50746 #: guix-git/doc/guix.texi:28209
50747 msgid "UNIX domain socket group ownership. This can be used to allow a 'trusted' set of users access to management capabilities without becoming root."
50751 #: guix-git/doc/guix.texi:28214
50753 msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms"
50757 #: guix-git/doc/guix.texi:28217
50758 msgid "UNIX socket permissions for the R/O socket. This is used for monitoring VM status only."
50762 #: guix-git/doc/guix.texi:28219 guix-git/doc/guix.texi:28237
50763 msgid "Defaults to @samp{\"0777\"}."
50767 #: guix-git/doc/guix.texi:28222
50769 msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms"
50773 #: guix-git/doc/guix.texi:28226
50774 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)"
50778 #: guix-git/doc/guix.texi:28228
50779 msgid "Defaults to @samp{\"0770\"}."
50783 #: guix-git/doc/guix.texi:28231
50785 msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms"
50789 #: guix-git/doc/guix.texi:28235
50790 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."
50794 #: guix-git/doc/guix.texi:28240
50796 msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir"
50800 #: guix-git/doc/guix.texi:28242
50801 msgid "The directory in which sockets will be found/created."
50805 #: guix-git/doc/guix.texi:28244
50806 msgid "Defaults to @samp{\"/var/run/libvirt\"}."
50810 #: guix-git/doc/guix.texi:28247
50812 msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro"
50816 #: guix-git/doc/guix.texi:28250
50817 msgid "Authentication scheme for UNIX read-only sockets. By default socket permissions allow anyone to connect"
50821 #: guix-git/doc/guix.texi:28252 guix-git/doc/guix.texi:28261
50822 msgid "Defaults to @samp{\"polkit\"}."
50826 #: guix-git/doc/guix.texi:28255
50828 msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw"
50832 #: guix-git/doc/guix.texi:28259
50833 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."
50837 #: guix-git/doc/guix.texi:28264
50839 msgid "{@code{libvirt-configuration} parameter} string auth-tcp"
50843 #: guix-git/doc/guix.texi:28268
50844 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."
50848 #: guix-git/doc/guix.texi:28270
50849 msgid "Defaults to @samp{\"sasl\"}."
50853 #: guix-git/doc/guix.texi:28273
50855 msgid "{@code{libvirt-configuration} parameter} string auth-tls"
50859 #: guix-git/doc/guix.texi:28277
50860 msgid "Authentication scheme for TLS sockets. TLS sockets already have encryption provided by the TLS layer, and limited authentication is done by certificates."
50864 #: guix-git/doc/guix.texi:28280
50865 msgid "It is possible to make use of any SASL authentication mechanism as well, by using 'sasl' for this option"
50869 #: guix-git/doc/guix.texi:28282
50870 msgid "Defaults to @samp{\"none\"}."
50874 #: guix-git/doc/guix.texi:28285
50876 msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers"
50880 #: guix-git/doc/guix.texi:28287
50881 msgid "API access control scheme."
50885 #: guix-git/doc/guix.texi:28290
50886 msgid "By default an authenticated user is allowed access to all APIs. Access drivers can place restrictions on this."
50890 #: guix-git/doc/guix.texi:28295
50892 msgid "{@code{libvirt-configuration} parameter} string key-file"
50896 #: guix-git/doc/guix.texi:28298
50897 msgid "Server key file path. If set to an empty string, then no private key is loaded."
50901 #: guix-git/doc/guix.texi:28303
50903 msgid "{@code{libvirt-configuration} parameter} string cert-file"
50907 #: guix-git/doc/guix.texi:28306
50908 msgid "Server key file path. If set to an empty string, then no certificate is loaded."
50912 #: guix-git/doc/guix.texi:28311
50914 msgid "{@code{libvirt-configuration} parameter} string ca-file"
50918 #: guix-git/doc/guix.texi:28314
50919 msgid "Server key file path. If set to an empty string, then no CA certificate is loaded."
50923 #: guix-git/doc/guix.texi:28319
50925 msgid "{@code{libvirt-configuration} parameter} string crl-file"
50929 #: guix-git/doc/guix.texi:28322
50930 msgid "Certificate revocation list path. If set to an empty string, then no CRL is loaded."
50934 #: guix-git/doc/guix.texi:28327
50936 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert"
50940 #: guix-git/doc/guix.texi:28329
50941 msgid "Disable verification of our own server certificates."
50945 #: guix-git/doc/guix.texi:28332
50946 msgid "When libvirtd starts it performs some sanity checks against its own certificates."
50950 #: guix-git/doc/guix.texi:28337
50952 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert"
50956 #: guix-git/doc/guix.texi:28339
50957 msgid "Disable verification of client certificates."
50961 #: guix-git/doc/guix.texi:28343
50962 msgid "Client certificate verification is the primary authentication mechanism. Any client which does not present a certificate signed by the CA will be rejected."
50966 #: guix-git/doc/guix.texi:28348
50968 msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list"
50972 #: guix-git/doc/guix.texi:28350
50973 msgid "Whitelist of allowed x509 Distinguished Name."
50977 #: guix-git/doc/guix.texi:28355
50979 msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames"
50983 #: guix-git/doc/guix.texi:28358
50984 msgid "Whitelist of allowed SASL usernames. The format for username depends on the SASL authentication mechanism."
50988 #: guix-git/doc/guix.texi:28363
50990 msgid "{@code{libvirt-configuration} parameter} string tls-priority"
50994 #: guix-git/doc/guix.texi:28367
50995 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."
50999 #: guix-git/doc/guix.texi:28369
51000 msgid "Defaults to @samp{\"NORMAL\"}."
51004 #: guix-git/doc/guix.texi:28372
51006 msgid "{@code{libvirt-configuration} parameter} integer max-clients"
51010 #: guix-git/doc/guix.texi:28375 guix-git/doc/guix.texi:28799
51011 msgid "Maximum number of concurrent client connections to allow over all sockets combined."
51015 #: guix-git/doc/guix.texi:28377
51016 msgid "Defaults to @samp{5000}."
51020 #: guix-git/doc/guix.texi:28380
51022 msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients"
51026 #: guix-git/doc/guix.texi:28384
51027 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."
51031 #: guix-git/doc/guix.texi:28389
51033 msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients"
51037 #: guix-git/doc/guix.texi:28392
51038 msgid "Maximum length of queue of accepted but not yet authenticated clients. Set this to zero to turn this feature off"
51042 #: guix-git/doc/guix.texi:28394 guix-git/doc/guix.texi:28412
51043 #: guix-git/doc/guix.texi:28428
51044 msgid "Defaults to @samp{20}."
51048 #: guix-git/doc/guix.texi:28397
51050 msgid "{@code{libvirt-configuration} parameter} integer min-workers"
51054 #: guix-git/doc/guix.texi:28399
51055 msgid "Number of workers to start up initially."
51059 #: guix-git/doc/guix.texi:28404
51061 msgid "{@code{libvirt-configuration} parameter} integer max-workers"
51065 #: guix-git/doc/guix.texi:28406
51066 msgid "Maximum number of worker threads."
51070 #: guix-git/doc/guix.texi:28410
51071 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."
51075 #: guix-git/doc/guix.texi:28415
51077 msgid "{@code{libvirt-configuration} parameter} integer prio-workers"
51081 #: guix-git/doc/guix.texi:28419
51082 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."
51086 #: guix-git/doc/guix.texi:28424
51088 msgid "{@code{libvirt-configuration} parameter} integer max-requests"
51092 #: guix-git/doc/guix.texi:28426
51093 msgid "Total global limit on concurrent RPC calls."
51097 #: guix-git/doc/guix.texi:28431
51099 msgid "{@code{libvirt-configuration} parameter} integer max-client-requests"
51103 #: guix-git/doc/guix.texi:28435
51104 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."
51108 #: guix-git/doc/guix.texi:28440
51110 msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers"
51114 #: guix-git/doc/guix.texi:28442
51115 msgid "Same as @code{min-workers} but for the admin interface."
51119 #: guix-git/doc/guix.texi:28447
51121 msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers"
51125 #: guix-git/doc/guix.texi:28449
51126 msgid "Same as @code{max-workers} but for the admin interface."
51130 #: guix-git/doc/guix.texi:28454
51132 msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients"
51136 #: guix-git/doc/guix.texi:28456
51137 msgid "Same as @code{max-clients} but for the admin interface."
51141 #: guix-git/doc/guix.texi:28461
51143 msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients"
51147 #: guix-git/doc/guix.texi:28463
51148 msgid "Same as @code{max-queued-clients} but for the admin interface."
51152 #: guix-git/doc/guix.texi:28468
51154 msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests"
51158 #: guix-git/doc/guix.texi:28470
51159 msgid "Same as @code{max-client-requests} but for the admin interface."
51163 #: guix-git/doc/guix.texi:28475
51165 msgid "{@code{libvirt-configuration} parameter} integer log-level"
51169 #: guix-git/doc/guix.texi:28477 guix-git/doc/guix.texi:28701
51170 msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug."
51174 #: guix-git/doc/guix.texi:28482
51176 msgid "{@code{libvirt-configuration} parameter} string log-filters"
51180 #: guix-git/doc/guix.texi:28484 guix-git/doc/guix.texi:28708
51181 msgid "Logging filters."
51185 #: guix-git/doc/guix.texi:28487
51186 msgid "A filter allows to select a different logging level for a given category of logs. The format for a filter is one of:"
51190 #: guix-git/doc/guix.texi:28491 guix-git/doc/guix.texi:28715
51195 #: guix-git/doc/guix.texi:28494 guix-git/doc/guix.texi:28718
51200 #: guix-git/doc/guix.texi:28505
51201 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:"
51205 #: guix-git/doc/guix.texi:28509 guix-git/doc/guix.texi:28554
51206 #: guix-git/doc/guix.texi:28732 guix-git/doc/guix.texi:28777
51211 #: guix-git/doc/guix.texi:28512 guix-git/doc/guix.texi:28557
51212 #: guix-git/doc/guix.texi:28735 guix-git/doc/guix.texi:28780
51217 #: guix-git/doc/guix.texi:28515 guix-git/doc/guix.texi:28560
51218 #: guix-git/doc/guix.texi:28738 guix-git/doc/guix.texi:28783
51223 #: guix-git/doc/guix.texi:28518 guix-git/doc/guix.texi:28563
51224 #: guix-git/doc/guix.texi:28741 guix-git/doc/guix.texi:28786
51229 #: guix-git/doc/guix.texi:28523 guix-git/doc/guix.texi:28746
51230 msgid "Multiple filters can be defined in a single filters statement, they just need to be separated by spaces."
51234 #: guix-git/doc/guix.texi:28525 guix-git/doc/guix.texi:28748
51235 msgid "Defaults to @samp{\"3:remote 4:event\"}."
51239 #: guix-git/doc/guix.texi:28528
51241 msgid "{@code{libvirt-configuration} parameter} string log-outputs"
51245 #: guix-git/doc/guix.texi:28530 guix-git/doc/guix.texi:28753
51246 msgid "Logging outputs."
51250 #: guix-git/doc/guix.texi:28533
51251 msgid "An output is one of the places to save logging information. The format for an output can be:"
51255 #: guix-git/doc/guix.texi:28535 guix-git/doc/guix.texi:28758
51261 #: guix-git/doc/guix.texi:28537 guix-git/doc/guix.texi:28760
51262 msgid "output goes to stderr"
51266 #: guix-git/doc/guix.texi:28538 guix-git/doc/guix.texi:28761
51268 msgid "x:syslog:name"
51272 #: guix-git/doc/guix.texi:28540 guix-git/doc/guix.texi:28763
51273 msgid "use syslog for the output and use the given name as the ident"
51277 #: guix-git/doc/guix.texi:28541 guix-git/doc/guix.texi:28764
51279 msgid "x:file:file_path"
51283 #: guix-git/doc/guix.texi:28543 guix-git/doc/guix.texi:28766
51284 msgid "output to a file, with the given filepath"
51288 #: guix-git/doc/guix.texi:28544 guix-git/doc/guix.texi:28767
51294 #: guix-git/doc/guix.texi:28546 guix-git/doc/guix.texi:28769
51295 msgid "output to journald logging system"
51299 #: guix-git/doc/guix.texi:28550 guix-git/doc/guix.texi:28773
51300 msgid "In all case the x prefix is the minimal level, acting as a filter"
51304 #: guix-git/doc/guix.texi:28568 guix-git/doc/guix.texi:28791
51305 msgid "Multiple outputs can be defined, they just need to be separated by spaces."
51309 #: guix-git/doc/guix.texi:28570 guix-git/doc/guix.texi:28793
51310 msgid "Defaults to @samp{\"3:stderr\"}."
51314 #: guix-git/doc/guix.texi:28573
51316 msgid "{@code{libvirt-configuration} parameter} integer audit-level"
51320 #: guix-git/doc/guix.texi:28575
51321 msgid "Allows usage of the auditing subsystem to be altered"
51325 #: guix-git/doc/guix.texi:28579
51326 msgid "0: disable all auditing"
51330 #: guix-git/doc/guix.texi:28582
51331 msgid "1: enable auditing, only if enabled on host"
51335 #: guix-git/doc/guix.texi:28585
51336 msgid "2: enable auditing, and exit if disabled on host."
51340 #: guix-git/doc/guix.texi:28592
51342 msgid "{@code{libvirt-configuration} parameter} boolean audit-logging"
51346 #: guix-git/doc/guix.texi:28594
51347 msgid "Send audit messages via libvirt logging infrastructure."
51351 #: guix-git/doc/guix.texi:28599
51353 msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid"
51357 #: guix-git/doc/guix.texi:28601
51358 msgid "Host UUID@. UUID must not have all digits be the same."
51362 #: guix-git/doc/guix.texi:28606
51364 msgid "{@code{libvirt-configuration} parameter} string host-uuid-source"
51368 #: guix-git/doc/guix.texi:28608
51369 msgid "Source to read host UUID."
51373 #: guix-git/doc/guix.texi:28612
51374 msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}"
51378 #: guix-git/doc/guix.texi:28615
51379 msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}"
51383 #: guix-git/doc/guix.texi:28620
51384 msgid "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be generated."
51388 #: guix-git/doc/guix.texi:28622
51389 msgid "Defaults to @samp{\"smbios\"}."
51393 #: guix-git/doc/guix.texi:28625
51395 msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval"
51399 #: guix-git/doc/guix.texi:28630
51400 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."
51404 #: guix-git/doc/guix.texi:28635
51406 msgid "{@code{libvirt-configuration} parameter} integer keepalive-count"
51410 #: guix-git/doc/guix.texi:28639
51411 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."
51415 #: guix-git/doc/guix.texi:28646
51416 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."
51420 #: guix-git/doc/guix.texi:28651
51422 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval"
51426 #: guix-git/doc/guix.texi:28653 guix-git/doc/guix.texi:28660
51427 msgid "Same as above but for admin interface."
51431 #: guix-git/doc/guix.texi:28658
51433 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count"
51437 #: guix-git/doc/guix.texi:28665
51439 msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout"
51443 #: guix-git/doc/guix.texi:28667
51444 msgid "Timeout for Open vSwitch calls."
51448 #: guix-git/doc/guix.texi:28671
51449 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."
51452 #. type: subsubheading
51453 #: guix-git/doc/guix.texi:28678
51455 msgid "Virtlog daemon"
51458 #. type: Plain text
51459 #: guix-git/doc/guix.texi:28681
51460 msgid "The virtlogd service is a server side daemon component of libvirt that is used to manage logs from virtual machine consoles."
51463 #. type: Plain text
51464 #: guix-git/doc/guix.texi:28687
51465 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."
51469 #: guix-git/doc/guix.texi:28688
51471 msgid "{Scheme Variable} virtlog-service-type"
51475 #: guix-git/doc/guix.texi:28691
51476 msgid "This is the type of the virtlog daemon. Its value must be a @code{virtlog-configuration}."
51480 #: guix-git/doc/guix.texi:28696
51483 "(service virtlog-service-type\n"
51484 " (virtlog-configuration\n"
51485 " (max-clients 1000)))\n"
51489 #: guix-git/doc/guix.texi:28699
51491 msgid "{@code{virtlog-configuration} parameter} integer log-level"
51495 #: guix-git/doc/guix.texi:28706
51497 msgid "{@code{virtlog-configuration} parameter} string log-filters"
51501 #: guix-git/doc/guix.texi:28711
51502 msgid "A filter allows to select a different logging level for a given category of logs The format for a filter is one of:"
51506 #: guix-git/doc/guix.texi:28728
51507 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:"
51511 #: guix-git/doc/guix.texi:28751
51513 msgid "{@code{virtlog-configuration} parameter} string log-outputs"
51517 #: guix-git/doc/guix.texi:28756
51518 msgid "An output is one of the places to save logging information The format for an output can be:"
51522 #: guix-git/doc/guix.texi:28796
51524 msgid "{@code{virtlog-configuration} parameter} integer max-clients"
51528 #: guix-git/doc/guix.texi:28801
51529 msgid "Defaults to @samp{1024}."
51533 #: guix-git/doc/guix.texi:28804
51535 msgid "{@code{virtlog-configuration} parameter} integer max-size"
51539 #: guix-git/doc/guix.texi:28806
51540 msgid "Maximum file size before rolling over."
51544 #: guix-git/doc/guix.texi:28808
51545 msgid "Defaults to @samp{2MB}"
51549 #: guix-git/doc/guix.texi:28811
51551 msgid "{@code{virtlog-configuration} parameter} integer max-backups"
51555 #: guix-git/doc/guix.texi:28813
51556 msgid "Maximum number of backup files to keep."
51560 #: guix-git/doc/guix.texi:28815
51561 msgid "Defaults to @samp{3}"
51564 #. type: anchor{#1}
51565 #: guix-git/doc/guix.texi:28819
51566 msgid "transparent-emulation-qemu"
51569 #. type: subsubheading
51570 #: guix-git/doc/guix.texi:28819
51572 msgid "Transparent Emulation with QEMU"
51576 #: guix-git/doc/guix.texi:28821
51582 #: guix-git/doc/guix.texi:28822
51584 msgid "binfmt_misc"
51587 #. type: Plain text
51588 #: guix-git/doc/guix.texi:28830
51589 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."
51593 #: guix-git/doc/guix.texi:28831
51595 msgid "{Scheme Variable} qemu-binfmt-service-type"
51599 #: guix-git/doc/guix.texi:28836
51600 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:"
51604 #: guix-git/doc/guix.texi:28841
51607 "(service qemu-binfmt-service-type\n"
51608 " (qemu-binfmt-configuration\n"
51609 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n"
51613 #: guix-git/doc/guix.texi:28847
51614 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})."
51618 #: guix-git/doc/guix.texi:28849
51620 msgid "{Data Type} qemu-binfmt-configuration"
51624 #: guix-git/doc/guix.texi:28851
51625 msgid "This is the configuration for the @code{qemu-binfmt} service."
51629 #: guix-git/doc/guix.texi:28853
51631 msgid "@code{platforms} (default: @code{'()})"
51635 #: guix-git/doc/guix.texi:28856
51636 msgid "The list of emulated QEMU platforms. Each item must be a @dfn{platform object} as returned by @code{lookup-qemu-platforms} (see below)."
51640 #: guix-git/doc/guix.texi:28859
51641 msgid "For example, let's suppose you're on an x86_64 machine and you have this service:"
51645 #: guix-git/doc/guix.texi:28864
51648 "(service qemu-binfmt-service-type\n"
51649 " (qemu-binfmt-configuration\n"
51650 " (platforms (lookup-qemu-platforms \"arm\"))))\n"
51654 #: guix-git/doc/guix.texi:28867
51655 msgid "You can run:"
51659 #: guix-git/doc/guix.texi:28870
51661 msgid "guix build -s armhf-linux inkscape\n"
51665 #: guix-git/doc/guix.texi:28877
51666 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!"
51670 #: guix-git/doc/guix.texi:28878
51672 msgid "@code{qemu} (default: @code{qemu})"
51676 #: guix-git/doc/guix.texi:28880 guix-git/doc/guix.texi:28974
51677 msgid "The QEMU package to use."
51681 #: guix-git/doc/guix.texi:28883
51683 msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}"
51687 #: guix-git/doc/guix.texi:28888
51688 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."
51692 #: guix-git/doc/guix.texi:28890
51694 msgid "{Scheme Procedure} qemu-platform? @var{obj}"
51698 #: guix-git/doc/guix.texi:28892
51699 msgid "Return true if @var{obj} is a platform object."
51703 #: guix-git/doc/guix.texi:28894
51705 msgid "{Scheme Procedure} qemu-platform-name @var{platform}"
51709 #: guix-git/doc/guix.texi:28896
51710 msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}."
51713 #. type: subsubheading
51714 #: guix-git/doc/guix.texi:28899
51716 msgid "The Hurd in a Virtual Machine"
51720 #: guix-git/doc/guix.texi:28902
51726 #: guix-git/doc/guix.texi:28903
51731 #. type: Plain text
51732 #: guix-git/doc/guix.texi:28911
51733 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:"
51737 #: guix-git/doc/guix.texi:28915
51740 "herd start hurd-vm\n"
51741 "herd stop childhurd\n"
51744 #. type: Plain text
51745 #: guix-git/doc/guix.texi:28919
51746 msgid "When the service is running, you can view its console by connecting to it with a VNC client, for example with:"
51750 #: guix-git/doc/guix.texi:28923
51753 "guix environment --ad-hoc tigervnc-client -- \\\n"
51754 " vncviewer localhost:5900\n"
51757 #. type: Plain text
51758 #: guix-git/doc/guix.texi:28929
51759 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:"
51763 #: guix-git/doc/guix.texi:28932
51765 msgid "ssh root@@localhost -p 10022\n"
51768 #. type: Plain text
51769 #: guix-git/doc/guix.texi:28941
51770 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."
51774 #: guix-git/doc/guix.texi:28942
51776 msgid "{Scheme Variable} hurd-vm-service-type"
51780 #: guix-git/doc/guix.texi:28948
51781 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."
51785 #: guix-git/doc/guix.texi:28956
51788 "(service hurd-vm-service-type\n"
51789 " (hurd-vm-configuration\n"
51790 " (disk-size (* 5000 (expt 2 20))) ;5G\n"
51791 " (memory-size 1024))) ;1024MiB\n"
51795 #: guix-git/doc/guix.texi:28960
51796 msgid "would create a disk image big enough to build GNU@tie{}Hello, with some extra memory."
51800 #: guix-git/doc/guix.texi:28962
51802 msgid "{Data Type} hurd-vm-configuration"
51806 #: guix-git/doc/guix.texi:28965
51807 msgid "The data type representing the configuration for @code{hurd-vm-service-type}."
51811 #: guix-git/doc/guix.texi:28967
51813 msgid "@code{os} (default: @var{%hurd-vm-operating-system})"
51817 #: guix-git/doc/guix.texi:28971
51818 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}})."
51822 #: guix-git/doc/guix.texi:28972
51824 msgid "@code{qemu} (default: @code{qemu-minimal})"
51828 #: guix-git/doc/guix.texi:28975
51830 msgid "@code{image} (default: @var{hurd-vm-disk-image})"
51834 #: guix-git/doc/guix.texi:28978
51835 msgid "The procedure used to build the disk-image built from this configuration."
51839 #: guix-git/doc/guix.texi:28979
51841 msgid "@code{disk-size} (default: @code{'guess})"
51845 #: guix-git/doc/guix.texi:28981
51846 msgid "The size of the disk image."
51850 #: guix-git/doc/guix.texi:28982
51852 msgid "@code{memory-size} (default: @code{512})"
51856 #: guix-git/doc/guix.texi:28984
51857 msgid "The memory size of the Virtual Machine in mebibytes."
51861 #: guix-git/doc/guix.texi:28985
51863 msgid "@code{options} (default: @code{'(\"--snapshot\")})"
51867 #: guix-git/doc/guix.texi:28987
51868 msgid "The extra options for running QEMU."
51872 #: guix-git/doc/guix.texi:28992
51873 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}."
51877 #: guix-git/doc/guix.texi:28993
51879 msgid "@code{net-options} (default: @var{hurd-vm-net-options})"
51883 #: guix-git/doc/guix.texi:28995
51884 msgid "The procedure used to produce the list of QEMU networking options."
51888 #: guix-git/doc/guix.texi:28997
51889 msgid "By default, it produces"
51893 #: guix-git/doc/guix.texi:29004
51896 "'(\"--device\" \"rtl8139,netdev=net0\"\n"
51897 " \"--netdev\" \"user,id=net0\\\n"
51898 " ,hostfwd=tcp:127.0.0.1:@var{secrets-port}-:1004\\\n"
51899 " ,hostfwd=tcp:127.0.0.1:@var{ssh-port}-:2222\\\n"
51900 " ,hostfwd=tcp:127.0.0.1:@var{vnc-port}-:5900\")\n"
51904 #: guix-git/doc/guix.texi:29007
51905 msgid "with forwarded ports:"
51909 #: guix-git/doc/guix.texi:29012
51912 "@var{secrets-port}: @code{(+ 11004 (* 1000 @var{ID}))}\n"
51913 "@var{ssh-port}: @code{(+ 10022 (* 1000 @var{ID}))}\n"
51914 "@var{vnc-port}: @code{(+ 15900 (* 1000 @var{ID}))}\n"
51918 #: guix-git/doc/guix.texi:29014
51920 msgid "@code{secret-root} (default: @file{/etc/childhurd})"
51924 #: guix-git/doc/guix.texi:29019
51925 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."
51929 #: guix-git/doc/guix.texi:29023
51930 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."
51934 #: guix-git/doc/guix.texi:29026
51935 msgid "By default, the service automatically populates @file{/etc/childhurd} with the following non-volatile secrets, unless they already exist:"
51939 #: guix-git/doc/guix.texi:29035
51942 "/etc/childhurd/etc/guix/acl\n"
51943 "/etc/childhurd/etc/guix/signing-key.pub\n"
51944 "/etc/childhurd/etc/guix/signing-key.sec\n"
51945 "/etc/childhurd/etc/ssh/ssh_host_ed25519_key\n"
51946 "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key\n"
51947 "/etc/childhurd/etc/ssh/ssh_host_ed25519_key.pub\n"
51948 "/etc/childhurd/etc/ssh/ssh_host_ecdsa_key.pub\n"
51952 #: guix-git/doc/guix.texi:29039
51953 msgid "These files are automatically sent to the guest Hurd VM when it boots, including permissions."
51957 #: guix-git/doc/guix.texi:29040
51959 msgid "childhurd, offloading"
51963 #: guix-git/doc/guix.texi:29041
51965 msgid "Hurd, offloading"
51969 #: guix-git/doc/guix.texi:29045
51970 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:"
51974 #: guix-git/doc/guix.texi:29050
51975 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:"
51979 #: guix-git/doc/guix.texi:29054
51982 "guix archive --authorize < \\\n"
51983 " /etc/childhurd/etc/guix/signing-key.pub\n"
51987 #: guix-git/doc/guix.texi:29059
51988 msgid "Adding the childhurd to @file{/etc/guix/machines.scm} (@pxref{Daemon Offload Setup})."
51992 #: guix-git/doc/guix.texi:29063
51993 msgid "We're working towards making that happen automatically---get in touch with us at @email{guix-devel@@gnu.org} to discuss it!"
51996 #. type: Plain text
51997 #: guix-git/doc/guix.texi:29070
51998 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:"
52002 #: guix-git/doc/guix.texi:29076
52005 "(service hurd-vm-service-type\n"
52006 " (hurd-vm-configuration\n"
52007 " (image (const \"/out/of/store/writable/hurd.img\"))\n"
52008 " (options '())))\n"
52011 #. type: subsubheading
52012 #: guix-git/doc/guix.texi:29078
52018 #: guix-git/doc/guix.texi:29080
52024 #: guix-git/doc/guix.texi:29087
52025 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}."
52028 #. type: Plain text
52029 #: guix-git/doc/guix.texi:29097
52030 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)."
52033 #. type: Plain text
52034 #: guix-git/doc/guix.texi:29102
52035 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}:"
52039 #: guix-git/doc/guix.texi:29112
52042 "(use-package-modules virtualization)\n"
52043 "(use-service-modules base ganeti networking ssh)\n"
52044 "(operating-system\n"
52046 " (host-name \"node1\")\n"
52047 " (hosts-file (plain-file \"hosts\" (format #f \"\n"
52048 "127.0.0.1 localhost\n"
52054 #: guix-git/doc/guix.texi:29117
52057 "192.168.1.200 ganeti.example.com\n"
52058 "192.168.1.201 node1.example.com node1\n"
52059 "192.168.1.202 node2.example.com node2\n"
52065 #: guix-git/doc/guix.texi:29131
52068 " ;; Install QEMU so we can use KVM-based instances, and LVM, DRBD and Ceph\n"
52069 " ;; in order to use the \"plain\", \"drbd\" and \"rbd\" storage backends.\n"
52070 " (packages (append (map specification->package\n"
52071 " '(\"qemu\" \"lvm2\" \"drbd-utils\" \"ceph\"\n"
52072 " ;; Add the debootstrap and guix OS providers.\n"
52073 " \"ganeti-instance-guix\" \"ganeti-instance-debootstrap\"))\n"
52074 " %base-packages))\n"
52076 " (append (list (static-networking-service \"eth0\" \"192.168.1.201\"\n"
52077 " #:netmask \"255.255.255.0\"\n"
52078 " #:gateway \"192.168.1.254\"\n"
52079 " #:name-servers '(\"192.168.1.252\"\n"
52080 " \"192.168.1.253\"))\n"
52085 #: guix-git/doc/guix.texi:29136
52088 " ;; Ganeti uses SSH to communicate between nodes.\n"
52089 " (service openssh-service-type\n"
52090 " (openssh-configuration\n"
52091 " (permit-root-login 'without-password)))\n"
52096 #: guix-git/doc/guix.texi:29146
52099 " (service ganeti-service-type\n"
52100 " (ganeti-configuration\n"
52101 " ;; This list specifies allowed file system paths\n"
52102 " ;; for storing virtual machine images.\n"
52103 " (file-storage-paths '(\"/srv/ganeti/file-storage\"))\n"
52104 " ;; This variable configures a single \"variant\" for\n"
52105 " ;; both Debootstrap and Guix that works with KVM.\n"
52106 " (os %default-ganeti-os))))\n"
52107 " %base-services)))\n"
52110 #. type: Plain text
52111 #: guix-git/doc/guix.texi:29154
52112 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."
52116 #: guix-git/doc/guix.texi:29155
52118 msgid "{Scheme Variable} ganeti-service-type"
52122 #: guix-git/doc/guix.texi:29158
52123 msgid "This is a service type that includes all the various services that Ganeti nodes should run."
52127 #: guix-git/doc/guix.texi:29163
52128 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."
52132 #: guix-git/doc/guix.texi:29165
52134 msgid "{Data Type} ganeti-configuration"
52138 #: guix-git/doc/guix.texi:29167
52139 msgid "The @code{ganeti} service takes the following configuration options:"
52143 #: guix-git/doc/guix.texi:29169 guix-git/doc/guix.texi:29397
52144 #: guix-git/doc/guix.texi:29447 guix-git/doc/guix.texi:29477
52145 #: guix-git/doc/guix.texi:29504 guix-git/doc/guix.texi:29536
52146 #: guix-git/doc/guix.texi:29589 guix-git/doc/guix.texi:29609
52147 #: guix-git/doc/guix.texi:29635 guix-git/doc/guix.texi:29668
52148 #: guix-git/doc/guix.texi:29708
52150 msgid "@code{ganeti} (default: @code{ganeti})"
52154 #: guix-git/doc/guix.texi:29174
52155 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)."
52159 #: guix-git/doc/guix.texi:29175
52161 msgid "@code{noded-configuration} (default: @code{(ganeti-noded-configuration)})"
52165 #: guix-git/doc/guix.texi:29176
52167 msgid "@code{confd-configuration} (default: @code{(ganeti-confd-configuration)})"
52171 #: guix-git/doc/guix.texi:29177
52173 msgid "@code{wconfd-configuration} (default: @code{(ganeti-wconfd-configuration)})"
52177 #: guix-git/doc/guix.texi:29178
52179 msgid "@code{luxid-configuration} (default: @code{(ganeti-luxid-configuration)})"
52183 #: guix-git/doc/guix.texi:29179
52185 msgid "@code{rapi-configuration} (default: @code{(ganeti-rapi-configuration)})"
52189 #: guix-git/doc/guix.texi:29180
52191 msgid "@code{kvmd-configuration} (default: @code{(ganeti-kvmd-configuration)})"
52195 #: guix-git/doc/guix.texi:29181
52197 msgid "@code{mond-configuration} (default: @code{(ganeti-mond-configuration)})"
52201 #: guix-git/doc/guix.texi:29182
52203 msgid "@code{metad-configuration} (default: @code{(ganeti-metad-configuration)})"
52207 #: guix-git/doc/guix.texi:29183
52209 msgid "@code{watcher-configuration} (default: @code{(ganeti-watcher-configuration)})"
52213 #: guix-git/doc/guix.texi:29184
52215 msgid "@code{cleaner-configuration} (default: @code{(ganeti-cleaner-configuration)})"
52219 #: guix-git/doc/guix.texi:29189
52220 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:"
52224 #: guix-git/doc/guix.texi:29199
52227 "(service ganeti-service-type\n"
52228 " (ganeti-configuration\n"
52229 " (rapi-configuration\n"
52230 " (ganeti-rapi-configuration\n"
52231 " (interface \"eth1\"))))\n"
52232 " (watcher-configuration\n"
52233 " (ganeti-watcher-configuration\n"
52234 " (rapi-ip \"10.0.0.1\"))))\n"
52238 #: guix-git/doc/guix.texi:29201
52240 msgid "@code{file-storage-paths} (default: @code{'()})"
52244 #: guix-git/doc/guix.texi:29203
52245 msgid "List of allowed directories for file storage backend."
52249 #: guix-git/doc/guix.texi:29204
52251 msgid "@code{os} (default: @code{%default-ganeti-os})"
52255 #: guix-git/doc/guix.texi:29206
52256 msgid "List of @code{<ganeti-os>} records."
52260 #: guix-git/doc/guix.texi:29210
52261 msgid "In essence @code{ganeti-service-type} is shorthand for declaring each service individually:"
52265 #: guix-git/doc/guix.texi:29221
52268 "(service ganeti-noded-service-type)\n"
52269 "(service ganeti-confd-service-type)\n"
52270 "(service ganeti-wconfd-service-type)\n"
52271 "(service ganeti-luxid-service-type)\n"
52272 "(service ganeti-kvmd-service-type)\n"
52273 "(service ganeti-mond-service-type)\n"
52274 "(service ganeti-metad-service-type)\n"
52275 "(service ganeti-watcher-service-type)\n"
52276 "(service ganeti-cleaner-service-type)\n"
52280 #: guix-git/doc/guix.texi:29225
52281 msgid "Plus a service extension for @code{etc-service-type} that configures the file storage backend and OS variants."
52285 #: guix-git/doc/guix.texi:29228
52287 msgid "{Data Type} ganeti-os"
52291 #: guix-git/doc/guix.texi:29231
52292 msgid "This data type is suitable for passing to the @code{os} parameter of @code{ganeti-configuration}. It takes the following parameters:"
52296 #: guix-git/doc/guix.texi:29237
52297 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}."
52301 #: guix-git/doc/guix.texi:29238
52307 #: guix-git/doc/guix.texi:29241
52308 msgid "The file extension for variants of this OS type. For example @file{.conf} or @file{.scm}."
52312 #: guix-git/doc/guix.texi:29242
52314 msgid "@code{variants} (default: @code{'()})"
52318 #: guix-git/doc/guix.texi:29244
52319 msgid "List of @code{ganeti-os-variant} objects for this OS."
52323 #: guix-git/doc/guix.texi:29248
52325 msgid "{Data Type} ganeti-os-variant"
52329 #: guix-git/doc/guix.texi:29251
52330 msgid "This is the data type for a Ganeti OS variant. It takes the following parameters:"
52334 #: guix-git/doc/guix.texi:29255
52335 msgid "The name of this variant."
52339 #: guix-git/doc/guix.texi:29256
52341 msgid "configuration"
52345 #: guix-git/doc/guix.texi:29258
52346 msgid "A configuration file for this variant."
52350 #: guix-git/doc/guix.texi:29261
52352 msgid "{Scheme Variable} %default-debootstrap-hooks"
52356 #: guix-git/doc/guix.texi:29263
52357 msgid "This variable contains hooks to configure networking and the GRUB bootloader."
52361 #: guix-git/doc/guix.texi:29265
52363 msgid "{Scheme Variable} %default-debootstrap-extra-pkgs"
52367 #: guix-git/doc/guix.texi:29267
52368 msgid "This variable contains a list of packages suitable for a fully-virtualized guest."
52372 #: guix-git/doc/guix.texi:29269
52374 msgid "{Data Type} debootstrap-configuration"
52378 #: guix-git/doc/guix.texi:29272
52379 msgid "This data type creates configuration files suitable for the debootstrap OS provider."
52383 #: guix-git/doc/guix.texi:29274
52385 msgid "@code{hooks} (default: @code{%default-debootstrap-hooks})"
52389 #: guix-git/doc/guix.texi:29278
52390 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:"
52394 #: guix-git/doc/guix.texi:29281
52396 msgid "`((99-hello-world . ,(plain-file \"#!/bin/sh\\necho Hello, World\")))\n"
52400 #: guix-git/doc/guix.texi:29286
52401 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."
52405 #: guix-git/doc/guix.texi:29286
52407 msgid "@code{proxy} (default: @code{#f})"
52411 #: guix-git/doc/guix.texi:29288
52412 msgid "Optional HTTP proxy to use."
52416 #: guix-git/doc/guix.texi:29288
52418 msgid "@code{mirror} (default: @code{#f})"
52422 #: guix-git/doc/guix.texi:29291
52423 msgid "The Debian mirror. Typically something like @code{http://ftp.no.debian.org/debian}. The default varies depending on the distribution."
52427 #: guix-git/doc/guix.texi:29291
52429 msgid "@code{arch} (default: @code{#f})"
52433 #: guix-git/doc/guix.texi:29294
52434 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."
52438 #: guix-git/doc/guix.texi:29294
52440 msgid "@code{suite} (default: @code{\"stable\"})"
52444 #: guix-git/doc/guix.texi:29297
52445 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."
52449 #: guix-git/doc/guix.texi:29297
52451 msgid "@code{extra-pkgs} (default: @code{%default-debootstrap-extra-pkgs})"
52455 #: guix-git/doc/guix.texi:29300
52456 msgid "List of extra packages that will get installed by dpkg in addition to the minimal system."
52460 #: guix-git/doc/guix.texi:29300
52462 msgid "@code{components} (default: @code{#f})"
52466 #: guix-git/doc/guix.texi:29303
52467 msgid "When set, must be a list of Debian repository ``components''. For example @code{'(\"main\" \"contrib\")}."
52471 #: guix-git/doc/guix.texi:29303
52473 msgid "@code{generate-cache?} (default: @code{#t})"
52477 #: guix-git/doc/guix.texi:29305
52478 msgid "Whether to automatically cache the generated debootstrap archive."
52482 #: guix-git/doc/guix.texi:29305
52484 msgid "@code{clean-cache} (default: @code{14})"
52488 #: guix-git/doc/guix.texi:29308
52489 msgid "Discard the cache after this amount of days. Use @code{#f} to never clear the cache."
52493 #: guix-git/doc/guix.texi:29308
52495 msgid "@code{partition-style} (default: @code{'msdos})"
52499 #: guix-git/doc/guix.texi:29311
52500 msgid "The type of partition to create. When set, it must be one of @code{'msdos}, @code{'none} or a string."
52504 #: guix-git/doc/guix.texi:29311
52506 msgid "@code{partition-alignment} (default: @code{2048})"
52510 #: guix-git/doc/guix.texi:29313
52511 msgid "Alignment of the partition in sectors."
52515 #: guix-git/doc/guix.texi:29316
52517 msgid "{Scheme Procedure} debootstrap-variant @var{name} @var{configuration}"
52521 #: guix-git/doc/guix.texi:29319
52522 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."
52526 #: guix-git/doc/guix.texi:29321
52528 msgid "{Scheme Procedure} debootstrap-os @var{variants}@dots{}"
52532 #: guix-git/doc/guix.texi:29324
52533 msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants created with @code{debootstrap-variant}."
52537 #: guix-git/doc/guix.texi:29326
52539 msgid "{Scheme Procedure} guix-variant @var{name} @var{configuration}"
52543 #: guix-git/doc/guix.texi:29331
52544 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."
52548 #: guix-git/doc/guix.texi:29333
52550 msgid "{Scheme Procedure} guix-os @var{variants}@dots{}"
52554 #: guix-git/doc/guix.texi:29336
52555 msgid "This is a helper procedure that creates a @code{ganeti-os} record. It takes a list of variants produced by @code{guix-variant}."
52559 #: guix-git/doc/guix.texi:29338
52561 msgid "{Scheme Variable} %default-debootstrap-variants"
52565 #: guix-git/doc/guix.texi:29342
52566 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:"
52570 #: guix-git/doc/guix.texi:29347
52573 "(list (debootstrap-variant\n"
52575 " (debootstrap-configuration)))\n"
52579 #: guix-git/doc/guix.texi:29350
52581 msgid "{Scheme Variable} %default-guix-variants"
52585 #: guix-git/doc/guix.texi:29354
52586 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."
52590 #: guix-git/doc/guix.texi:29360
52593 "(list (guix-variant\n"
52595 " (file-append ganeti-instance-guix\n"
52596 " \"/share/doc/ganeti-instance-guix/examples/dynamic.scm\")))\n"
52599 #. type: Plain text
52600 #: guix-git/doc/guix.texi:29366
52601 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:"
52605 #: guix-git/doc/guix.texi:29375
52609 " (name \"custom\")\n"
52610 " (extension \".conf\")\n"
52612 " (list (ganeti-os-variant\n"
52613 " (name \"foo\")\n"
52614 " (configuration (plain-file \"bar\" \"this is fine\"))))))\n"
52617 #. type: Plain text
52618 #: guix-git/doc/guix.texi:29380
52619 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}."
52622 #. type: Plain text
52623 #: guix-git/doc/guix.texi:29383
52624 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}."
52627 #. type: Plain text
52628 #: guix-git/doc/guix.texi:29386
52629 msgid "The rest of this section documents the various services that are included by @code{ganeti-service-type}."
52633 #: guix-git/doc/guix.texi:29387
52635 msgid "{Scheme Variable} ganeti-noded-service-type"
52639 #: guix-git/doc/guix.texi:29391
52640 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."
52644 #: guix-git/doc/guix.texi:29393
52646 msgid "{Data Type} ganeti-noded-configuration"
52650 #: guix-git/doc/guix.texi:29395
52651 msgid "This is the configuration for the @code{ganeti-noded} service."
52655 #: guix-git/doc/guix.texi:29399 guix-git/doc/guix.texi:29449
52656 #: guix-git/doc/guix.texi:29479 guix-git/doc/guix.texi:29506
52657 #: guix-git/doc/guix.texi:29538 guix-git/doc/guix.texi:29591
52658 #: guix-git/doc/guix.texi:29611 guix-git/doc/guix.texi:29637
52659 #: guix-git/doc/guix.texi:29670
52660 msgid "The @code{ganeti} package to use for this service."
52664 #: guix-git/doc/guix.texi:29400
52666 msgid "@code{port} (default: @code{1811})"
52670 #: guix-git/doc/guix.texi:29402
52671 msgid "The TCP port on which the node daemon listens for network requests."
52675 #: guix-git/doc/guix.texi:29403 guix-git/doc/guix.texi:29453
52676 #: guix-git/doc/guix.texi:29545 guix-git/doc/guix.texi:29615
52678 msgid "@code{address} (default: @code{\"0.0.0.0\"})"
52682 #: guix-git/doc/guix.texi:29406
52683 msgid "The network address that the daemon will bind to. The default address means bind to all available addresses."
52687 #: guix-git/doc/guix.texi:29410
52688 msgid "When this is set, it must be a specific network interface (e.g.@: @code{eth0}) that the daemon will bind to."
52692 #: guix-git/doc/guix.texi:29411 guix-git/doc/guix.texi:29553
52694 msgid "@code{max-clients} (default: @code{20})"
52698 #: guix-git/doc/guix.texi:29415
52699 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."
52703 #: guix-git/doc/guix.texi:29416 guix-git/doc/guix.texi:29558
52705 msgid "@code{ssl?} (default: @code{#t})"
52709 #: guix-git/doc/guix.texi:29420
52710 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}."
52714 #: guix-git/doc/guix.texi:29421 guix-git/doc/guix.texi:29561
52716 msgid "@code{ssl-key} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52720 #: guix-git/doc/guix.texi:29423 guix-git/doc/guix.texi:29563
52721 msgid "This can be used to provide a specific encryption key for TLS communications."
52725 #: guix-git/doc/guix.texi:29424 guix-git/doc/guix.texi:29564
52727 msgid "@code{ssl-cert} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52731 #: guix-git/doc/guix.texi:29426 guix-git/doc/guix.texi:29566
52732 msgid "This can be used to provide a specific certificate for TLS communications."
52736 #: guix-git/doc/guix.texi:29430 guix-git/doc/guix.texi:29570
52737 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."
52741 #: guix-git/doc/guix.texi:29434
52743 msgid "{Scheme Variable} ganeti-confd-service-type"
52747 #: guix-git/doc/guix.texi:29440
52748 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."
52752 #: guix-git/doc/guix.texi:29443
52754 msgid "{Data Type} ganeti-confd-configuration"
52758 #: guix-git/doc/guix.texi:29445
52759 msgid "This is the configuration for the @code{ganeti-confd} service."
52763 #: guix-git/doc/guix.texi:29450
52765 msgid "@code{port} (default: @code{1814})"
52769 #: guix-git/doc/guix.texi:29452
52770 msgid "The UDP port on which to listen for network requests."
52774 #: guix-git/doc/guix.texi:29455
52775 msgid "Network address that the daemon will bind to."
52779 #: guix-git/doc/guix.texi:29458 guix-git/doc/guix.texi:29487
52780 #: guix-git/doc/guix.texi:29514 guix-git/doc/guix.texi:29594
52781 #: guix-git/doc/guix.texi:29621 guix-git/doc/guix.texi:29647
52782 msgid "When true, the daemon performs additional logging for debugging purposes."
52786 #: guix-git/doc/guix.texi:29462
52788 msgid "{Scheme Variable} ganeti-wconfd-service-type"
52792 #: guix-git/doc/guix.texi:29468
52793 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."
52797 #: guix-git/doc/guix.texi:29471
52798 msgid "The value of this service must be a @code{ganeti-wconfd-configuration} object."
52802 #: guix-git/doc/guix.texi:29473
52804 msgid "{Data Type} ganeti-wconfd-configuration"
52808 #: guix-git/doc/guix.texi:29475 guix-git/doc/guix.texi:29502
52809 msgid "This is the configuration for the @code{ganeti-wconfd} service."
52813 #: guix-git/doc/guix.texi:29480 guix-git/doc/guix.texi:29507
52815 msgid "@code{no-voting?} (default: @code{#f})"
52819 #: guix-git/doc/guix.texi:29484
52820 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)."
52824 #: guix-git/doc/guix.texi:29491
52826 msgid "{Scheme Variable} ganeti-luxid-service-type"
52830 #: guix-git/doc/guix.texi:29496
52831 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."
52835 #: guix-git/doc/guix.texi:29498
52836 msgid "It takes a @code{ganeti-luxid-configuration} object."
52840 #: guix-git/doc/guix.texi:29500
52842 msgid "{Data Type} ganeti-luxid-configuration"
52846 #: guix-git/doc/guix.texi:29511
52847 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)."
52851 #: guix-git/doc/guix.texi:29518
52853 msgid "{Scheme Variable} ganeti-rapi-service-type"
52857 #: guix-git/doc/guix.texi:29522
52858 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."
52862 #: guix-git/doc/guix.texi:29528
52863 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."
52867 #: guix-git/doc/guix.texi:29530
52868 msgid "The value of this service must be a @code{ganeti-rapi-configuration} object."
52872 #: guix-git/doc/guix.texi:29532
52874 msgid "{Data Type} ganeti-rapi-configuration"
52878 #: guix-git/doc/guix.texi:29534
52879 msgid "This is the configuration for the @code{ganeti-rapi} service."
52883 #: guix-git/doc/guix.texi:29539
52885 msgid "@code{require-authentication?} (default: @code{#f})"
52889 #: guix-git/doc/guix.texi:29541
52890 msgid "Whether to require authentication even for read-only operations."
52894 #: guix-git/doc/guix.texi:29542
52896 msgid "@code{port} (default: @code{5080})"
52900 #: guix-git/doc/guix.texi:29544
52901 msgid "The TCP port on which to listen to API requests."
52905 #: guix-git/doc/guix.texi:29548
52906 msgid "The network address that the service will bind to. By default it listens on all configured addresses."
52910 #: guix-git/doc/guix.texi:29552
52911 msgid "When set, it must specify a specific network interface such as @code{eth0} that the daemon will bind to."
52915 #: guix-git/doc/guix.texi:29557
52916 msgid "The maximum number of simultaneous client requests to handle. Further connections are allowed, but no responses are sent until enough connections have closed."
52920 #: guix-git/doc/guix.texi:29560
52921 msgid "Whether to use SSL/TLS encryption on the RAPI port."
52925 #: guix-git/doc/guix.texi:29574
52927 msgid "{Scheme Variable} ganeti-kvmd-service-type"
52931 #: guix-git/doc/guix.texi:29582
52932 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."
52936 #: guix-git/doc/guix.texi:29584
52937 msgid "It takes a @code{ganeti-kvmd-configuration} object."
52941 #: guix-git/doc/guix.texi:29586
52943 msgid "{Data Type} ganeti-kvmd-configuration"
52947 #: guix-git/doc/guix.texi:29598
52949 msgid "{Scheme Variable} ganeti-mond-service-type"
52953 #: guix-git/doc/guix.texi:29602
52954 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."
52958 #: guix-git/doc/guix.texi:29604
52959 msgid "It takes a @code{ganeti-mond-configuration} object."
52963 #: guix-git/doc/guix.texi:29606
52965 msgid "{Data Type} ganeti-mond-configuration"
52969 #: guix-git/doc/guix.texi:29612
52971 msgid "@code{port} (default: @code{1815})"
52975 #: guix-git/doc/guix.texi:29614 guix-git/doc/guix.texi:29640
52976 msgid "The port on which the daemon will listen."
52980 #: guix-git/doc/guix.texi:29618
52981 msgid "The network address that the daemon will bind to. By default it binds to all available interfaces."
52985 #: guix-git/doc/guix.texi:29625
52987 msgid "{Scheme Variable} ganeti-metad-service-type"
52991 #: guix-git/doc/guix.texi:29628
52992 msgid "@command{ganeti-metad} is an optional daemon that can be used to provide information about the cluster to instances or OS install scripts."
52996 #: guix-git/doc/guix.texi:29630
52997 msgid "It takes a @code{ganeti-metad-configuration} object."
53001 #: guix-git/doc/guix.texi:29632
53003 msgid "{Data Type} ganeti-metad-configuration"
53007 #: guix-git/doc/guix.texi:29641
53009 msgid "@code{address} (default: @code{#f})"
53013 #: guix-git/doc/guix.texi:29644
53014 msgid "If set, the daemon will bind to this address only. If left unset, the behavior depends on the cluster configuration."
53018 #: guix-git/doc/guix.texi:29651
53020 msgid "{Scheme Variable} ganeti-watcher-service-type"
53024 #: guix-git/doc/guix.texi:29659
53025 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."
53029 #: guix-git/doc/guix.texi:29661
53030 msgid "It can be paused on all nodes with @command{gnt-cluster watcher pause}."
53034 #: guix-git/doc/guix.texi:29663
53035 msgid "The service takes a @code{ganeti-watcher-configuration} object."
53039 #: guix-git/doc/guix.texi:29665
53041 msgid "{Data Type} ganeti-watcher-configuration"
53045 #: guix-git/doc/guix.texi:29671
53047 msgid "@code{schedule} (default: @code{'(next-second-from (next-minute (range 0 60 5)))})"
53051 #: guix-git/doc/guix.texi:29673
53052 msgid "How often to run the script. The default is every five minutes."
53056 #: guix-git/doc/guix.texi:29674
53058 msgid "@code{rapi-ip} (default: @code{#f})"
53062 #: guix-git/doc/guix.texi:29677
53063 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."
53067 #: guix-git/doc/guix.texi:29678
53069 msgid "@code{job-age} (default: @code{(* 6 3600)})"
53073 #: guix-git/doc/guix.texi:29681
53074 msgid "Archive cluster jobs older than this age, specified in seconds. The default is 6 hours. This keeps @command{gnt-job list} manageable."
53078 #: guix-git/doc/guix.texi:29682
53080 msgid "@code{verify-disks?} (default: @code{#t})"
53084 #: guix-git/doc/guix.texi:29686
53085 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."
53089 #: guix-git/doc/guix.texi:29689
53090 msgid "When @code{#t}, the script performs additional logging for debugging purposes."
53094 #: guix-git/doc/guix.texi:29693
53096 msgid "{Scheme Variable} ganeti-cleaner-service-type"
53100 #: guix-git/doc/guix.texi:29701
53101 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."
53105 #: guix-git/doc/guix.texi:29703
53106 msgid "It takes a @code{ganeti-cleaner-configuration} object."
53110 #: guix-git/doc/guix.texi:29705
53112 msgid "{Data Type} ganeti-cleaner-configuration"
53116 #: guix-git/doc/guix.texi:29710
53117 msgid "The @code{ganeti} package to use for the @command{gnt-cleaner} command."
53121 #: guix-git/doc/guix.texi:29711
53123 msgid "@code{master-schedule} (default: @code{\"45 1 * * *\"})"
53127 #: guix-git/doc/guix.texi:29714
53128 msgid "How often to run the master cleaning job. The default is once per day, at 01:45:00."
53132 #: guix-git/doc/guix.texi:29715
53134 msgid "@code{node-schedule} (default: @code{\"45 2 * * *\"})"
53138 #: guix-git/doc/guix.texi:29718
53139 msgid "How often to run the node cleaning job. The default is once per day, at 02:45:00."
53142 #. type: Plain text
53143 #: guix-git/doc/guix.texi:29732
53144 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}."
53148 #: guix-git/doc/guix.texi:29733
53150 msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]"
53154 #: guix-git/doc/guix.texi:29737
53155 msgid "Return a service that runs @command{git daemon}, a simple TCP server to expose repositories over the Git protocol for anonymous access."
53159 #: guix-git/doc/guix.texi:29743
53160 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}."
53164 #: guix-git/doc/guix.texi:29746
53166 msgid "{Data Type} git-daemon-configuration"
53170 #: guix-git/doc/guix.texi:29748
53171 msgid "Data type representing the configuration for @code{git-daemon-service}."
53175 #: guix-git/doc/guix.texi:29750
53177 msgid "@code{package} (default: @code{git})"
53181 #: guix-git/doc/guix.texi:29752 guix-git/doc/guix.texi:29812
53182 msgid "Package object of the Git distributed version control system."
53186 #: guix-git/doc/guix.texi:29753 guix-git/doc/guix.texi:29816
53188 msgid "@code{export-all?} (default: @code{#f})"
53192 #: guix-git/doc/guix.texi:29756
53193 msgid "Whether to allow access for all Git repositories, even if they do not have the @file{git-daemon-export-ok} file."
53197 #: guix-git/doc/guix.texi:29757
53199 msgid "@code{base-path} (default: @file{/srv/git})"
53203 #: guix-git/doc/guix.texi:29763
53204 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}."
53208 #: guix-git/doc/guix.texi:29764
53210 msgid "@code{user-path} (default: @code{#f})"
53214 #: guix-git/doc/guix.texi:29772
53215 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}."
53219 #: guix-git/doc/guix.texi:29773
53221 msgid "@code{listen} (default: @code{'()})"
53225 #: guix-git/doc/guix.texi:29776
53226 msgid "Whether to listen on specific IP addresses or hostnames, defaults to all."
53230 #: guix-git/doc/guix.texi:29777
53232 msgid "@code{port} (default: @code{#f})"
53236 #: guix-git/doc/guix.texi:29779
53237 msgid "Whether to listen on an alternative port, which defaults to 9418."
53241 #: guix-git/doc/guix.texi:29780
53243 msgid "@code{whitelist} (default: @code{'()})"
53247 #: guix-git/doc/guix.texi:29782
53248 msgid "If not empty, only allow access to this list of directories."
53252 #: guix-git/doc/guix.texi:29786
53253 msgid "Extra options will be passed to @command{git daemon}, please run @command{man git-daemon} for more information."
53256 #. type: Plain text
53257 #: guix-git/doc/guix.texi:29800
53258 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."
53261 #. type: Plain text
53262 #: guix-git/doc/guix.texi:29803
53263 msgid "Guix has a separate configuration data type for serving Git repositories over HTTP."
53267 #: guix-git/doc/guix.texi:29804
53269 msgid "{Data Type} git-http-configuration"
53273 #: guix-git/doc/guix.texi:29808
53274 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}."
53278 #: guix-git/doc/guix.texi:29810
53280 msgid "@code{package} (default: @var{git})"
53284 #: guix-git/doc/guix.texi:29813
53286 msgid "@code{git-root} (default: @file{/srv/git})"
53290 #: guix-git/doc/guix.texi:29815
53291 msgid "Directory containing the Git repositories to expose to the world."
53295 #: guix-git/doc/guix.texi:29819
53296 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."
53300 #: guix-git/doc/guix.texi:29820
53302 msgid "@code{uri-path} (default: @samp{/git/})"
53306 #: guix-git/doc/guix.texi:29825
53307 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."
53311 #: guix-git/doc/guix.texi:29826
53313 msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})"
53317 #: guix-git/doc/guix.texi:29829
53318 msgid "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web Services}."
53321 #. type: Plain text
53322 #: guix-git/doc/guix.texi:29836
53323 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."
53327 #: guix-git/doc/guix.texi:29837
53329 msgid "{Scheme Procedure} git-http-nginx-location-configuration @"
53333 #: guix-git/doc/guix.texi:29842
53334 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:"
53338 #: guix-git/doc/guix.texi:29859
53341 "(service nginx-service-type\n"
53342 " (nginx-configuration\n"
53343 " (server-blocks\n"
53345 " (nginx-server-configuration\n"
53346 " (listen '(\"443 ssl\"))\n"
53347 " (server-name \"git.my-host.org\")\n"
53348 " (ssl-certificate\n"
53349 " \"/etc/letsencrypt/live/git.my-host.org/fullchain.pem\")\n"
53350 " (ssl-certificate-key\n"
53351 " \"/etc/letsencrypt/live/git.my-host.org/privkey.pem\")\n"
53354 " (git-http-nginx-location-configuration\n"
53355 " (git-http-configuration (uri-path \"/\"))))))))))\n"
53359 #: guix-git/doc/guix.texi:29866
53360 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}."
53363 #. type: subsubheading
53364 #: guix-git/doc/guix.texi:29868
53366 msgid "Cgit Service"
53370 #: guix-git/doc/guix.texi:29870
53372 msgid "Cgit service"
53376 #: guix-git/doc/guix.texi:29871
53378 msgid "Git, web interface"
53381 #. type: Plain text
53382 #: guix-git/doc/guix.texi:29874
53383 msgid "@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git repositories written in C."
53386 #. type: Plain text
53387 #: guix-git/doc/guix.texi:29877
53388 msgid "The following example will configure the service with default values. By default, Cgit can be accessed on port 80 (@code{http://localhost:80})."
53392 #: guix-git/doc/guix.texi:29880
53394 msgid "(service cgit-service-type)\n"
53397 #. type: Plain text
53398 #: guix-git/doc/guix.texi:29884
53399 msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a string."
53402 #. type: Plain text
53403 #: guix-git/doc/guix.texi:29888
53404 msgid "Available @code{cgit-configuration} fields are:"
53408 #: guix-git/doc/guix.texi:29889
53410 msgid "{@code{cgit-configuration} parameter} package package"
53414 #: guix-git/doc/guix.texi:29891
53415 msgid "The CGIT package."
53419 #: guix-git/doc/guix.texi:29894
53421 msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx"
53425 #: guix-git/doc/guix.texi:29899
53427 msgid "{@code{cgit-configuration} parameter} file-object about-filter"
53431 #: guix-git/doc/guix.texi:29902
53432 msgid "Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository)."
53436 #: guix-git/doc/guix.texi:29907
53438 msgid "{@code{cgit-configuration} parameter} string agefile"
53442 #: guix-git/doc/guix.texi:29910
53443 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."
53447 #: guix-git/doc/guix.texi:29915
53449 msgid "{@code{cgit-configuration} parameter} file-object auth-filter"
53453 #: guix-git/doc/guix.texi:29918
53454 msgid "Specifies a command that will be invoked for authenticating repository access."
53458 #: guix-git/doc/guix.texi:29923
53460 msgid "{@code{cgit-configuration} parameter} string branch-sort"
53464 #: guix-git/doc/guix.texi:29926
53465 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."
53469 #: guix-git/doc/guix.texi:29928
53470 msgid "Defaults to @samp{\"name\"}."
53474 #: guix-git/doc/guix.texi:29931
53476 msgid "{@code{cgit-configuration} parameter} string cache-root"
53480 #: guix-git/doc/guix.texi:29933
53481 msgid "Path used to store the cgit cache entries."
53485 #: guix-git/doc/guix.texi:29935
53486 msgid "Defaults to @samp{\"/var/cache/cgit\"}."
53490 #: guix-git/doc/guix.texi:29938
53492 msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl"
53496 #: guix-git/doc/guix.texi:29941
53497 msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1."
53501 #: guix-git/doc/guix.texi:29943 guix-git/doc/guix.texi:30386
53502 msgid "Defaults to @samp{-1}."
53506 #: guix-git/doc/guix.texi:29946
53508 msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl"
53512 #: guix-git/doc/guix.texi:29949
53513 msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1."
53517 #: guix-git/doc/guix.texi:29954
53519 msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl"
53523 #: guix-git/doc/guix.texi:29957
53524 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page."
53528 #: guix-git/doc/guix.texi:29962
53530 msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl"
53534 #: guix-git/doc/guix.texi:29965
53535 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository index page."
53539 #: guix-git/doc/guix.texi:29970
53541 msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl"
53545 #: guix-git/doc/guix.texi:29973
53546 msgid "Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories."
53550 #: guix-git/doc/guix.texi:29978
53552 msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl"
53556 #: guix-git/doc/guix.texi:29981
53557 msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository about page."
53561 #: guix-git/doc/guix.texi:29986
53563 msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl"
53567 #: guix-git/doc/guix.texi:29989
53568 msgid "Number which specifies the time-to-live, in minutes, for the cached version of snapshots."
53572 #: guix-git/doc/guix.texi:29994
53574 msgid "{@code{cgit-configuration} parameter} integer cache-size"
53578 #: guix-git/doc/guix.texi:29997
53579 msgid "The maximum number of entries in the cgit cache. When set to @samp{0}, caching is disabled."
53583 #: guix-git/doc/guix.texi:30002
53585 msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?"
53589 #: guix-git/doc/guix.texi:30004
53590 msgid "Sort items in the repo list case sensitively."
53594 #: guix-git/doc/guix.texi:30009
53596 msgid "{@code{cgit-configuration} parameter} list clone-prefix"
53600 #: guix-git/doc/guix.texi:30012
53601 msgid "List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository."
53605 #: guix-git/doc/guix.texi:30017
53607 msgid "{@code{cgit-configuration} parameter} list clone-url"
53611 #: guix-git/doc/guix.texi:30019
53612 msgid "List of @code{clone-url} templates."
53616 #: guix-git/doc/guix.texi:30024
53618 msgid "{@code{cgit-configuration} parameter} file-object commit-filter"
53622 #: guix-git/doc/guix.texi:30026
53623 msgid "Command which will be invoked to format commit messages."
53627 #: guix-git/doc/guix.texi:30031
53629 msgid "{@code{cgit-configuration} parameter} string commit-sort"
53633 #: guix-git/doc/guix.texi:30035 guix-git/doc/guix.texi:30593
53634 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."
53638 #: guix-git/doc/guix.texi:30037
53639 msgid "Defaults to @samp{\"git log\"}."
53643 #: guix-git/doc/guix.texi:30040
53645 msgid "{@code{cgit-configuration} parameter} file-object css"
53649 #: guix-git/doc/guix.texi:30042
53650 msgid "URL which specifies the css document to include in all cgit pages."
53654 #: guix-git/doc/guix.texi:30044
53655 msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}."
53659 #: guix-git/doc/guix.texi:30047
53661 msgid "{@code{cgit-configuration} parameter} file-object email-filter"
53665 #: guix-git/doc/guix.texi:30051
53666 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."
53670 #: guix-git/doc/guix.texi:30056
53672 msgid "{@code{cgit-configuration} parameter} boolean embedded?"
53676 #: guix-git/doc/guix.texi:30059
53677 msgid "Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment suitable for embedding in other HTML pages."
53681 #: guix-git/doc/guix.texi:30064
53683 msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?"
53687 #: guix-git/doc/guix.texi:30068
53688 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."
53692 #: guix-git/doc/guix.texi:30073
53694 msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?"
53698 #: guix-git/doc/guix.texi:30076
53699 msgid "Flag which, when set to @samp{#t}, allows all filter settings to be overridden in repository-specific cgitrc files."
53703 #: guix-git/doc/guix.texi:30081
53705 msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?"
53709 #: guix-git/doc/guix.texi:30084
53710 msgid "Flag which, when set to @samp{#t}, allows users to follow a file in the log view."
53714 #: guix-git/doc/guix.texi:30089
53716 msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?"
53720 #: guix-git/doc/guix.texi:30092
53721 msgid "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones."
53725 #: guix-git/doc/guix.texi:30097
53727 msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?"
53731 #: guix-git/doc/guix.texi:30100
53732 msgid "Flag which, when set to @samp{#t}, will make cgit generate extra links \"summary\", \"commit\", \"tree\" for each repo in the repository index."
53736 #: guix-git/doc/guix.texi:30105
53738 msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?"
53742 #: guix-git/doc/guix.texi:30108
53743 msgid "Flag which, when set to @samp{#t}, will make cgit display the owner of each repo in the repository index."
53747 #: guix-git/doc/guix.texi:30113
53749 msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?"
53753 #: guix-git/doc/guix.texi:30116
53754 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."
53758 #: guix-git/doc/guix.texi:30121
53760 msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?"
53764 #: guix-git/doc/guix.texi:30124
53765 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."
53769 #: guix-git/doc/guix.texi:30129
53771 msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?"
53775 #: guix-git/doc/guix.texi:30132 guix-git/doc/guix.texi:30656
53776 msgid "Flag which, when set to @code{#t}, will make cgit display remote branches in the summary and refs views."
53780 #: guix-git/doc/guix.texi:30137
53782 msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?"
53786 #: guix-git/doc/guix.texi:30141
53787 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."
53791 #: guix-git/doc/guix.texi:30146
53793 msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?"
53797 #: guix-git/doc/guix.texi:30150
53798 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."
53802 #: guix-git/doc/guix.texi:30155
53804 msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?"
53808 #: guix-git/doc/guix.texi:30158
53809 msgid "Flag which, when set to @samp{#t}, will make cgit generate linenumber links for plaintext blobs printed in the tree view."
53813 #: guix-git/doc/guix.texi:30163
53815 msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?"
53819 #: guix-git/doc/guix.texi:30166
53820 msgid "Flag which, when set to @samp{#f}, will allow cgit to use Git config to set any repo specific settings."
53824 #: guix-git/doc/guix.texi:30171
53826 msgid "{@code{cgit-configuration} parameter} file-object favicon"
53830 #: guix-git/doc/guix.texi:30173
53831 msgid "URL used as link to a shortcut icon for cgit."
53835 #: guix-git/doc/guix.texi:30175
53836 msgid "Defaults to @samp{\"/favicon.ico\"}."
53840 #: guix-git/doc/guix.texi:30178
53842 msgid "{@code{cgit-configuration} parameter} string footer"
53846 #: guix-git/doc/guix.texi:30182
53847 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)."
53851 #: guix-git/doc/guix.texi:30187
53853 msgid "{@code{cgit-configuration} parameter} string head-include"
53857 #: guix-git/doc/guix.texi:30190
53858 msgid "The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages."
53862 #: guix-git/doc/guix.texi:30195
53864 msgid "{@code{cgit-configuration} parameter} string header"
53868 #: guix-git/doc/guix.texi:30198
53869 msgid "The content of the file specified with this option will be included verbatim at the top of all pages."
53873 #: guix-git/doc/guix.texi:30203
53875 msgid "{@code{cgit-configuration} parameter} file-object include"
53879 #: guix-git/doc/guix.texi:30206
53880 msgid "Name of a configfile to include before the rest of the current config- file is parsed."
53884 #: guix-git/doc/guix.texi:30211
53886 msgid "{@code{cgit-configuration} parameter} string index-header"
53890 #: guix-git/doc/guix.texi:30214
53891 msgid "The content of the file specified with this option will be included verbatim above the repository index."
53895 #: guix-git/doc/guix.texi:30219
53897 msgid "{@code{cgit-configuration} parameter} string index-info"
53901 #: guix-git/doc/guix.texi:30222
53902 msgid "The content of the file specified with this option will be included verbatim below the heading on the repository index page."
53906 #: guix-git/doc/guix.texi:30227
53908 msgid "{@code{cgit-configuration} parameter} boolean local-time?"
53912 #: guix-git/doc/guix.texi:30230
53913 msgid "Flag which, if set to @samp{#t}, makes cgit print commit and tag times in the servers timezone."
53917 #: guix-git/doc/guix.texi:30235
53919 msgid "{@code{cgit-configuration} parameter} file-object logo"
53923 #: guix-git/doc/guix.texi:30238
53924 msgid "URL which specifies the source of an image which will be used as a logo on all cgit pages."
53928 #: guix-git/doc/guix.texi:30240
53929 msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}."
53933 #: guix-git/doc/guix.texi:30243
53935 msgid "{@code{cgit-configuration} parameter} string logo-link"
53939 #: guix-git/doc/guix.texi:30245 guix-git/doc/guix.texi:30702
53940 msgid "URL loaded when clicking on the cgit logo image."
53944 #: guix-git/doc/guix.texi:30250
53946 msgid "{@code{cgit-configuration} parameter} file-object owner-filter"
53950 #: guix-git/doc/guix.texi:30253
53951 msgid "Command which will be invoked to format the Owner column of the main page."
53955 #: guix-git/doc/guix.texi:30258
53957 msgid "{@code{cgit-configuration} parameter} integer max-atom-items"
53961 #: guix-git/doc/guix.texi:30260
53962 msgid "Number of items to display in atom feeds view."
53966 #: guix-git/doc/guix.texi:30265
53968 msgid "{@code{cgit-configuration} parameter} integer max-commit-count"
53972 #: guix-git/doc/guix.texi:30267
53973 msgid "Number of entries to list per page in \"log\" view."
53977 #: guix-git/doc/guix.texi:30272
53979 msgid "{@code{cgit-configuration} parameter} integer max-message-length"
53983 #: guix-git/doc/guix.texi:30274
53984 msgid "Number of commit message characters to display in \"log\" view."
53988 #: guix-git/doc/guix.texi:30276 guix-git/doc/guix.texi:30292
53989 msgid "Defaults to @samp{80}."
53993 #: guix-git/doc/guix.texi:30279
53995 msgid "{@code{cgit-configuration} parameter} integer max-repo-count"
53999 #: guix-git/doc/guix.texi:30282
54000 msgid "Specifies the number of entries to list per page on the repository index page."
54004 #: guix-git/doc/guix.texi:30287
54006 msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length"
54010 #: guix-git/doc/guix.texi:30290
54011 msgid "Specifies the maximum number of repo description characters to display on the repository index page."
54015 #: guix-git/doc/guix.texi:30295
54017 msgid "{@code{cgit-configuration} parameter} integer max-blob-size"
54021 #: guix-git/doc/guix.texi:30297
54022 msgid "Specifies the maximum size of a blob to display HTML for in KBytes."
54026 #: guix-git/doc/guix.texi:30302
54028 msgid "{@code{cgit-configuration} parameter} string max-stats"
54032 #: guix-git/doc/guix.texi:30305
54033 msgid "Maximum statistics period. Valid values are @samp{week},@samp{month}, @samp{quarter} and @samp{year}."
54037 #: guix-git/doc/guix.texi:30310
54039 msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype"
54043 #: guix-git/doc/guix.texi:30312
54044 msgid "Mimetype for the specified filename extension."
54048 #: guix-git/doc/guix.texi:30316
54049 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\"))}."
54053 #: guix-git/doc/guix.texi:30319
54055 msgid "{@code{cgit-configuration} parameter} file-object mimetype-file"
54059 #: guix-git/doc/guix.texi:30321
54060 msgid "Specifies the file to use for automatic mimetype lookup."
54064 #: guix-git/doc/guix.texi:30326
54066 msgid "{@code{cgit-configuration} parameter} string module-link"
54070 #: guix-git/doc/guix.texi:30329
54071 msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing."
54075 #: guix-git/doc/guix.texi:30334
54077 msgid "{@code{cgit-configuration} parameter} boolean nocache?"
54081 #: guix-git/doc/guix.texi:30336
54082 msgid "If set to the value @samp{#t} caching will be disabled."
54086 #: guix-git/doc/guix.texi:30341
54088 msgid "{@code{cgit-configuration} parameter} boolean noplainemail?"
54092 #: guix-git/doc/guix.texi:30344
54093 msgid "If set to @samp{#t} showing full author email addresses will be disabled."
54097 #: guix-git/doc/guix.texi:30349
54099 msgid "{@code{cgit-configuration} parameter} boolean noheader?"
54103 #: guix-git/doc/guix.texi:30352
54104 msgid "Flag which, when set to @samp{#t}, will make cgit omit the standard header on all pages."
54108 #: guix-git/doc/guix.texi:30357
54110 msgid "{@code{cgit-configuration} parameter} project-list project-list"
54114 #: guix-git/doc/guix.texi:30361
54115 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."
54119 #: guix-git/doc/guix.texi:30366
54121 msgid "{@code{cgit-configuration} parameter} file-object readme"
54125 #: guix-git/doc/guix.texi:30368
54126 msgid "Text which will be used as default value for @code{cgit-repo-readme}."
54130 #: guix-git/doc/guix.texi:30373
54132 msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?"
54136 #: guix-git/doc/guix.texi:30377
54137 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."
54141 #: guix-git/doc/guix.texi:30382
54143 msgid "{@code{cgit-configuration} parameter} integer renamelimit"
54147 #: guix-git/doc/guix.texi:30384
54148 msgid "Maximum number of files to consider when detecting renames."
54152 #: guix-git/doc/guix.texi:30389
54154 msgid "{@code{cgit-configuration} parameter} string repository-sort"
54158 #: guix-git/doc/guix.texi:30391
54159 msgid "The way in which repositories in each section are sorted."
54163 #: guix-git/doc/guix.texi:30396
54165 msgid "{@code{cgit-configuration} parameter} robots-list robots"
54169 #: guix-git/doc/guix.texi:30398
54170 msgid "Text used as content for the @code{robots} meta-tag."
54174 #: guix-git/doc/guix.texi:30400
54175 msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}."
54179 #: guix-git/doc/guix.texi:30403
54181 msgid "{@code{cgit-configuration} parameter} string root-desc"
54185 #: guix-git/doc/guix.texi:30405
54186 msgid "Text printed below the heading on the repository index page."
54190 #: guix-git/doc/guix.texi:30407
54191 msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}."
54195 #: guix-git/doc/guix.texi:30410
54197 msgid "{@code{cgit-configuration} parameter} string root-readme"
54201 #: guix-git/doc/guix.texi:30413
54202 msgid "The content of the file specified with this option will be included verbatim below the ``about'' link on the repository index page."
54206 #: guix-git/doc/guix.texi:30418
54208 msgid "{@code{cgit-configuration} parameter} string root-title"
54212 #: guix-git/doc/guix.texi:30420
54213 msgid "Text printed as heading on the repository index page."
54217 #: guix-git/doc/guix.texi:30425
54219 msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path"
54223 #: guix-git/doc/guix.texi:30431
54224 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."
54228 #: guix-git/doc/guix.texi:30436
54230 msgid "{@code{cgit-configuration} parameter} list snapshots"
54234 #: guix-git/doc/guix.texi:30439
54235 msgid "Text which specifies the default set of snapshot formats that cgit generates links for."
54239 #: guix-git/doc/guix.texi:30444
54241 msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory"
54245 #: guix-git/doc/guix.texi:30447
54246 msgid "Name of the directory to scan for repositories (represents @code{scan-path})."
54250 #: guix-git/doc/guix.texi:30449
54251 msgid "Defaults to @samp{\"/srv/git\"}."
54255 #: guix-git/doc/guix.texi:30452
54257 msgid "{@code{cgit-configuration} parameter} string section"
54261 #: guix-git/doc/guix.texi:30455 guix-git/doc/guix.texi:30771
54262 msgid "The name of the current repository section - all repositories defined after this option will inherit the current section name."
54266 #: guix-git/doc/guix.texi:30460
54268 msgid "{@code{cgit-configuration} parameter} string section-sort"
54272 #: guix-git/doc/guix.texi:30463
54273 msgid "Flag which, when set to @samp{1}, will sort the sections on the repository listing by name."
54277 #: guix-git/doc/guix.texi:30468
54279 msgid "{@code{cgit-configuration} parameter} integer section-from-path"
54283 #: guix-git/doc/guix.texi:30471
54284 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."
54288 #: guix-git/doc/guix.texi:30476
54290 msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?"
54294 #: guix-git/doc/guix.texi:30479
54295 msgid "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default."
54299 #: guix-git/doc/guix.texi:30484
54301 msgid "{@code{cgit-configuration} parameter} file-object source-filter"
54305 #: guix-git/doc/guix.texi:30487
54306 msgid "Specifies a command which will be invoked to format plaintext blobs in the tree view."
54310 #: guix-git/doc/guix.texi:30492
54312 msgid "{@code{cgit-configuration} parameter} integer summary-branches"
54316 #: guix-git/doc/guix.texi:30495
54317 msgid "Specifies the number of branches to display in the repository ``summary'' view."
54321 #: guix-git/doc/guix.texi:30500
54323 msgid "{@code{cgit-configuration} parameter} integer summary-log"
54327 #: guix-git/doc/guix.texi:30503
54328 msgid "Specifies the number of log entries to display in the repository ``summary'' view."
54332 #: guix-git/doc/guix.texi:30508
54334 msgid "{@code{cgit-configuration} parameter} integer summary-tags"
54338 #: guix-git/doc/guix.texi:30511
54339 msgid "Specifies the number of tags to display in the repository ``summary'' view."
54343 #: guix-git/doc/guix.texi:30516
54345 msgid "{@code{cgit-configuration} parameter} string strict-export"
54349 #: guix-git/doc/guix.texi:30519
54350 msgid "Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository."
54354 #: guix-git/doc/guix.texi:30524
54356 msgid "{@code{cgit-configuration} parameter} string virtual-root"
54360 #: guix-git/doc/guix.texi:30526
54361 msgid "URL which, if specified, will be used as root for all cgit links."
54365 #: guix-git/doc/guix.texi:30528
54366 msgid "Defaults to @samp{\"/\"}."
54370 #: guix-git/doc/guix.texi:30531
54372 msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories"
54376 #: guix-git/doc/guix.texi:30533
54377 msgid "A list of @dfn{cgit-repo} records to use with config."
54381 #: guix-git/doc/guix.texi:30537
54382 msgid "Available @code{repository-cgit-configuration} fields are:"
54386 #: guix-git/doc/guix.texi:30538
54388 msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots"
54392 #: guix-git/doc/guix.texi:30541
54393 msgid "A mask of snapshot formats for this repo that cgit generates links for, restricted by the global @code{snapshots} setting."
54397 #: guix-git/doc/guix.texi:30546
54399 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter"
54403 #: guix-git/doc/guix.texi:30548
54404 msgid "Override the default @code{source-filter}."
54408 #: guix-git/doc/guix.texi:30553
54410 msgid "{@code{repository-cgit-configuration} parameter} repo-string url"
54414 #: guix-git/doc/guix.texi:30555
54415 msgid "The relative URL used to access the repository."
54419 #: guix-git/doc/guix.texi:30560
54421 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter"
54425 #: guix-git/doc/guix.texi:30562
54426 msgid "Override the default @code{about-filter}."
54430 #: guix-git/doc/guix.texi:30567
54432 msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort"
54436 #: guix-git/doc/guix.texi:30570
54437 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."
54441 #: guix-git/doc/guix.texi:30575
54443 msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url"
54447 #: guix-git/doc/guix.texi:30577
54448 msgid "A list of URLs which can be used to clone repo."
54452 #: guix-git/doc/guix.texi:30582
54454 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter"
54458 #: guix-git/doc/guix.texi:30584
54459 msgid "Override the default @code{commit-filter}."
54463 #: guix-git/doc/guix.texi:30589
54465 msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort"
54469 #: guix-git/doc/guix.texi:30598
54471 msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch"
54475 #: guix-git/doc/guix.texi:30603
54476 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."
54480 #: guix-git/doc/guix.texi:30608
54482 msgid "{@code{repository-cgit-configuration} parameter} repo-string desc"
54486 #: guix-git/doc/guix.texi:30610
54487 msgid "The value to show as repository description."
54491 #: guix-git/doc/guix.texi:30615
54493 msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage"
54497 #: guix-git/doc/guix.texi:30617
54498 msgid "The value to show as repository homepage."
54502 #: guix-git/doc/guix.texi:30622
54504 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter"
54508 #: guix-git/doc/guix.texi:30624
54509 msgid "Override the default @code{email-filter}."
54513 #: guix-git/doc/guix.texi:30629
54515 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph?"
54519 #: guix-git/doc/guix.texi:30632
54520 msgid "A flag which can be used to disable the global setting @code{enable-commit-graph?}."
54524 #: guix-git/doc/guix.texi:30637
54526 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount?"
54530 #: guix-git/doc/guix.texi:30640
54531 msgid "A flag which can be used to disable the global setting @code{enable-log-filecount?}."
54535 #: guix-git/doc/guix.texi:30645
54537 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount?"
54541 #: guix-git/doc/guix.texi:30648
54542 msgid "A flag which can be used to disable the global setting @code{enable-log-linecount?}."
54546 #: guix-git/doc/guix.texi:30653
54548 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches?"
54552 #: guix-git/doc/guix.texi:30661
54554 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links?"
54558 #: guix-git/doc/guix.texi:30664
54559 msgid "A flag which can be used to override the global setting @code{enable-subject-links?}."
54563 #: guix-git/doc/guix.texi:30669
54565 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving?"
54569 #: guix-git/doc/guix.texi:30672
54570 msgid "A flag which can be used to override the global setting @code{enable-html-serving?}."
54574 #: guix-git/doc/guix.texi:30677
54576 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?"
54580 #: guix-git/doc/guix.texi:30680
54581 msgid "Flag which, when set to @code{#t}, hides the repository from the repository index."
54585 #: guix-git/doc/guix.texi:30685
54587 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?"
54591 #: guix-git/doc/guix.texi:30687
54592 msgid "Flag which, when set to @samp{#t}, ignores the repository."
54596 #: guix-git/doc/guix.texi:30692
54598 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo"
54602 #: guix-git/doc/guix.texi:30695
54603 msgid "URL which specifies the source of an image which will be used as a logo on this repo’s pages."
54607 #: guix-git/doc/guix.texi:30700
54609 msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link"
54613 #: guix-git/doc/guix.texi:30707
54615 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter"
54619 #: guix-git/doc/guix.texi:30709
54620 msgid "Override the default @code{owner-filter}."
54624 #: guix-git/doc/guix.texi:30714
54626 msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link"
54630 #: guix-git/doc/guix.texi:30718
54631 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."
54635 #: guix-git/doc/guix.texi:30723
54637 msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path"
54641 #: guix-git/doc/guix.texi:30727
54642 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."
54646 #: guix-git/doc/guix.texi:30732
54648 msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats"
54652 #: guix-git/doc/guix.texi:30734
54653 msgid "Override the default maximum statistics period."
54657 #: guix-git/doc/guix.texi:30739
54659 msgid "{@code{repository-cgit-configuration} parameter} repo-string name"
54663 #: guix-git/doc/guix.texi:30741
54664 msgid "The value to show as repository name."
54668 #: guix-git/doc/guix.texi:30746
54670 msgid "{@code{repository-cgit-configuration} parameter} repo-string owner"
54674 #: guix-git/doc/guix.texi:30748
54675 msgid "A value used to identify the owner of the repository."
54679 #: guix-git/doc/guix.texi:30753
54681 msgid "{@code{repository-cgit-configuration} parameter} repo-string path"
54685 #: guix-git/doc/guix.texi:30755
54686 msgid "An absolute path to the repository directory."
54690 #: guix-git/doc/guix.texi:30760
54692 msgid "{@code{repository-cgit-configuration} parameter} repo-string readme"
54696 #: guix-git/doc/guix.texi:30763
54697 msgid "A path (relative to repo) which specifies a file to include verbatim as the ``About'' page for this repo."
54701 #: guix-git/doc/guix.texi:30768
54703 msgid "{@code{repository-cgit-configuration} parameter} repo-string section"
54707 #: guix-git/doc/guix.texi:30776
54709 msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options"
54713 #: guix-git/doc/guix.texi:30778 guix-git/doc/guix.texi:30787
54714 msgid "Extra options will be appended to cgitrc file."
54718 #: guix-git/doc/guix.texi:30785
54720 msgid "{@code{cgit-configuration} parameter} list extra-options"
54723 #. type: Plain text
54724 #: guix-git/doc/guix.texi:30799
54725 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."
54728 #. type: Plain text
54729 #: guix-git/doc/guix.texi:30801
54730 msgid "Available @code{opaque-cgit-configuration} fields are:"
54734 #: guix-git/doc/guix.texi:30802
54736 msgid "{@code{opaque-cgit-configuration} parameter} package cgit"
54740 #: guix-git/doc/guix.texi:30804
54741 msgid "The cgit package."
54745 #: guix-git/doc/guix.texi:30806
54747 msgid "{@code{opaque-cgit-configuration} parameter} string string"
54751 #: guix-git/doc/guix.texi:30808
54752 msgid "The contents of the @code{cgitrc}, as a string."
54755 #. type: Plain text
54756 #: guix-git/doc/guix.texi:30812
54757 msgid "For example, if your @code{cgitrc} is just the empty string, you could instantiate a cgit service like this:"
54761 #: guix-git/doc/guix.texi:30817
54764 "(service cgit-service-type\n"
54765 " (opaque-cgit-configuration\n"
54766 " (cgitrc \"\")))\n"
54769 #. type: subsubheading
54770 #: guix-git/doc/guix.texi:30819
54772 msgid "Gitolite Service"
54776 #: guix-git/doc/guix.texi:30821
54778 msgid "Gitolite service"
54782 #: guix-git/doc/guix.texi:30822
54784 msgid "Git, hosting"
54787 #. type: Plain text
54788 #: guix-git/doc/guix.texi:30825
54789 msgid "@uref{https://gitolite.com/gitolite/, Gitolite} is a tool for hosting Git repositories on a central server."
54792 #. type: Plain text
54793 #: guix-git/doc/guix.texi:30828
54794 msgid "Gitolite can handle multiple repositories and users, and supports flexible configuration of the permissions for the users on the repositories."
54797 #. type: Plain text
54798 #: guix-git/doc/guix.texi:30831
54799 msgid "The following example will configure Gitolite using the default @code{git} user, and the provided SSH public key."
54803 #: guix-git/doc/guix.texi:30838
54806 "(service gitolite-service-type\n"
54807 " (gitolite-configuration\n"
54808 " (admin-pubkey (plain-file\n"
54809 " \"yourname.pub\"\n"
54810 " \"ssh-rsa AAAA... guix@@example.com\"))))\n"
54813 #. type: Plain text
54814 #: guix-git/doc/guix.texi:30843
54815 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."
54819 #: guix-git/doc/guix.texi:30846
54821 msgid "git clone git@@example.com:gitolite-admin\n"
54824 #. type: Plain text
54825 #: guix-git/doc/guix.texi:30852
54826 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''."
54830 #: guix-git/doc/guix.texi:30853
54832 msgid "{Data Type} gitolite-configuration"
54836 #: guix-git/doc/guix.texi:30855
54837 msgid "Data type representing the configuration for @code{gitolite-service-type}."
54841 #: guix-git/doc/guix.texi:30857
54843 msgid "@code{package} (default: @var{gitolite})"
54847 #: guix-git/doc/guix.texi:30859
54848 msgid "Gitolite package to use."
54852 #: guix-git/doc/guix.texi:30860
54854 msgid "@code{user} (default: @var{git})"
54858 #: guix-git/doc/guix.texi:30863
54859 msgid "User to use for Gitolite. This will be user that you use when accessing Gitolite over SSH."
54863 #: guix-git/doc/guix.texi:30864
54865 msgid "@code{group} (default: @var{git})"
54869 #: guix-git/doc/guix.texi:30866
54870 msgid "Group to use for Gitolite."
54874 #: guix-git/doc/guix.texi:30867
54876 msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})"
54880 #: guix-git/doc/guix.texi:30869
54881 msgid "Directory in which to store the Gitolite configuration and repositories."
54885 #: guix-git/doc/guix.texi:30870
54887 msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})"
54891 #: guix-git/doc/guix.texi:30873
54892 msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}), representing the configuration for Gitolite."
54896 #: guix-git/doc/guix.texi:30874
54898 msgid "@code{admin-pubkey} (default: @var{#f})"
54902 #: guix-git/doc/guix.texi:30878
54903 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."
54907 #: guix-git/doc/guix.texi:30880
54908 msgid "To specify the SSH key as a string, use the @code{plain-file} function."
54912 #: guix-git/doc/guix.texi:30883
54914 msgid "(plain-file \"yourname.pub\" \"ssh-rsa AAAA... guix@@example.com\")\n"
54918 #: guix-git/doc/guix.texi:30888
54920 msgid "{Data Type} gitolite-rc-file"
54924 #: guix-git/doc/guix.texi:30890
54925 msgid "Data type representing the Gitolite RC file."
54929 #: guix-git/doc/guix.texi:30892
54931 msgid "@code{umask} (default: @code{#o0077})"
54935 #: guix-git/doc/guix.texi:30895
54936 msgid "This controls the permissions Gitolite sets on the repositories and their contents."
54940 #: guix-git/doc/guix.texi:30899
54941 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."
54945 #: guix-git/doc/guix.texi:30900
54947 msgid "@code{git-config-keys} (default: @code{\"\"})"
54951 #: guix-git/doc/guix.texi:30903
54952 msgid "Gitolite allows you to set git config values using the @samp{config} keyword. This setting allows control over the config keys to accept."
54956 #: guix-git/doc/guix.texi:30904
54958 msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})"
54962 #: guix-git/doc/guix.texi:30906
54963 msgid "Set the role names allowed to be used by users running the perms command."
54967 #: guix-git/doc/guix.texi:30907
54969 msgid "@code{enable} (default: @code{'(\"help\" \"desc\" \"info\" \"perms\" \"writable\" \"ssh-authkeys\" \"git-config\" \"daemon\" \"gitweb\")})"
54973 #: guix-git/doc/guix.texi:30909
54974 msgid "This setting controls the commands and features to enable within Gitolite."
54977 #. type: subsubheading
54978 #: guix-git/doc/guix.texi:30917
54980 msgid "The Battle for Wesnoth Service"
54984 #: guix-git/doc/guix.texi:30918
54989 #. type: Plain text
54990 #: guix-git/doc/guix.texi:30922
54991 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)."
54995 #: guix-git/doc/guix.texi:30923
54997 msgid "{Scheme Variable} wesnothd-service-type"
55001 #: guix-git/doc/guix.texi:30927
55002 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:"
55006 #: guix-git/doc/guix.texi:30930
55008 msgid "(service wesnothd-service-type)\n"
55012 #: guix-git/doc/guix.texi:30933
55014 msgid "{Data Type} wesnothd-configuration"
55018 #: guix-git/doc/guix.texi:30935
55019 msgid "Data type representing the configuration of @command{wesnothd}."
55023 #: guix-git/doc/guix.texi:30937
55025 msgid "@code{package} (default: @code{wesnoth-server})"
55029 #: guix-git/doc/guix.texi:30939
55030 msgid "The wesnoth server package to use."
55034 #: guix-git/doc/guix.texi:30940
55036 msgid "@code{port} (default: @code{15000})"
55040 #: guix-git/doc/guix.texi:30942
55041 msgid "The port to bind the server to."
55045 #: guix-git/doc/guix.texi:30948
55050 #. type: Plain text
55051 #: guix-git/doc/guix.texi:30953
55052 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."
55056 #: guix-git/doc/guix.texi:30954
55058 msgid "{Scheme Variable} pam-mount-service-type"
55062 #: guix-git/doc/guix.texi:30956
55063 msgid "Service type for PAM Mount support."
55067 #: guix-git/doc/guix.texi:30958
55069 msgid "{Data Type} pam-mount-configuration"
55073 #: guix-git/doc/guix.texi:30960
55074 msgid "Data type representing the configuration of PAM Mount."
55078 #: guix-git/doc/guix.texi:30964
55084 #: guix-git/doc/guix.texi:30967
55085 msgid "The configuration rules that will be used to generate @file{/etc/security/pam_mount.conf.xml}."
55089 #: guix-git/doc/guix.texi:30971
55090 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:"
55094 #: guix-git/doc/guix.texi:30986
55097 "`((debug (@@ (enable \"0\")))\n"
55098 " (mntoptions (@@ (allow ,(string-join\n"
55099 " '(\"nosuid\" \"nodev\" \"loop\"\n"
55100 " \"encryption\" \"fsck\" \"nonempty\"\n"
55101 " \"allow_root\" \"allow_other\")\n"
55103 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55104 " (logout (@@ (wait \"0\")\n"
55107 " (kill \"no\")))\n"
55108 " (mkmountpoint (@@ (enable \"1\")\n"
55109 " (remove \"true\"))))\n"
55113 #: guix-git/doc/guix.texi:30992
55114 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:"
55118 #: guix-git/doc/guix.texi:31017
55121 "(define pam-mount-rules\n"
55122 "`((debug (@@ (enable \"0\")))\n"
55123 " (volume (@@ (user \"alice\")\n"
55124 " (fstype \"crypt\")\n"
55125 " (path \"/dev/sda2\")\n"
55126 " (mountpoint \"/home/alice\")))\n"
55127 " (volume (@@ (user \"bob\")\n"
55128 " (fstype \"auto\")\n"
55129 " (path \"/dev/sdb3\")\n"
55130 " (mountpoint \"/home/bob/data\")\n"
55131 " (options \"defaults,autodefrag,compress\")))\n"
55132 " (mntoptions (@@ (allow ,(string-join\n"
55133 " '(\"nosuid\" \"nodev\" \"loop\"\n"
55134 " \"encryption\" \"fsck\" \"nonempty\"\n"
55135 " \"allow_root\" \"allow_other\")\n"
55137 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55138 " (logout (@@ (wait \"0\")\n"
55141 " (kill \"no\")))\n"
55142 " (mkmountpoint (@@ (enable \"1\")\n"
55143 " (remove \"true\")))))\n"
55148 #: guix-git/doc/guix.texi:31021
55151 "(service pam-mount-service-type\n"
55152 " (pam-mount-configuration\n"
55153 " (rules pam-mount-rules)))\n"
55157 #: guix-git/doc/guix.texi:31025
55158 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}."
55161 #. type: subsubheading
55162 #: guix-git/doc/guix.texi:31032
55164 msgid "Guix Build Coordinator"
55167 #. type: Plain text
55168 #: guix-git/doc/guix.texi:31038
55169 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."
55173 #: guix-git/doc/guix.texi:31043
55174 msgid "This service is considered experimental. Configuration options may be changed in a backwards-incompatible manner, and not all features have been thorougly tested."
55177 #. type: Plain text
55178 #: guix-git/doc/guix.texi:31050
55179 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."
55182 #. type: Plain text
55183 #: guix-git/doc/guix.texi:31054
55184 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."
55188 #: guix-git/doc/guix.texi:31055
55190 msgid "{Scheme Variable} guix-build-coordinator-service-type"
55194 #: guix-git/doc/guix.texi:31058
55195 msgid "Service type for the Guix Build Coordinator. Its value must be a @code{guix-build-coordinator-configuration} object."
55199 #: guix-git/doc/guix.texi:31060
55201 msgid "{Data Type} guix-build-coordinator-configuration"
55205 #: guix-git/doc/guix.texi:31062
55206 msgid "Data type representing the configuration of the Guix Build Coordinator."
55210 #: guix-git/doc/guix.texi:31064 guix-git/doc/guix.texi:31108
55211 #: guix-git/doc/guix.texi:31225
55213 msgid "@code{package} (default: @code{guix-build-coordinator})"
55217 #: guix-git/doc/guix.texi:31066 guix-git/doc/guix.texi:31110
55218 #: guix-git/doc/guix.texi:31227
55219 msgid "The Guix Build Coordinator package to use."
55223 #: guix-git/doc/guix.texi:31067
55225 msgid "@code{user} (default: @code{\"guix-build-coordinator\"})"
55229 #: guix-git/doc/guix.texi:31069 guix-git/doc/guix.texi:31113
55230 #: guix-git/doc/guix.texi:31230 guix-git/doc/guix.texi:31276
55231 msgid "The system user to run the service as."
55235 #: guix-git/doc/guix.texi:31070
55237 msgid "@code{group} (default: @code{\"guix-build-coordinator\"})"
55241 #: guix-git/doc/guix.texi:31072 guix-git/doc/guix.texi:31279
55242 msgid "The system group to run the service as."
55246 #: guix-git/doc/guix.texi:31073
55248 msgid "@code{database-uri-string} (default: @code{\"sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db\"})"
55252 #: guix-git/doc/guix.texi:31075
55253 msgid "The URI to use for the database."
55257 #: guix-git/doc/guix.texi:31076
55259 msgid "@code{agent-communication-uri} (default: @code{\"http://0.0.0.0:8745\"})"
55263 #: guix-git/doc/guix.texi:31078
55264 msgid "The URI describing how to listen to requests from agent processes."
55268 #: guix-git/doc/guix.texi:31079
55270 msgid "@code{client-communication-uri} (default: @code{\"http://127.0.0.1:8746\"})"
55274 #: guix-git/doc/guix.texi:31083
55275 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."
55279 #: guix-git/doc/guix.texi:31084
55281 msgid "@code{allocation-strategy} (default: @code{#~basic-build-allocation-strategy})"
55285 #: guix-git/doc/guix.texi:31088
55286 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."
55290 #: guix-git/doc/guix.texi:31089
55292 msgid "@code{hooks} (default: @var{'()})"
55296 #: guix-git/doc/guix.texi:31092
55297 msgid "An association list of hooks. These provide a way to execute arbitrary code upon certain events, like a build result being processed."
55301 #: guix-git/doc/guix.texi:31093
55303 msgid "@code{guile} (default: @code{guile-3.0-latest})"
55307 #: guix-git/doc/guix.texi:31095
55308 msgid "The Guile package with which to run the Guix Build Coordinator."
55312 #: guix-git/doc/guix.texi:31099
55314 msgid "{Scheme Variable} guix-build-coordinator-agent-service-type"
55318 #: guix-git/doc/guix.texi:31102
55319 msgid "Service type for a Guix Build Coordinator agent. Its value must be a @code{guix-build-coordinator-agent-configuration} object."
55323 #: guix-git/doc/guix.texi:31104
55325 msgid "{Data Type} guix-build-coordinator-agent-configuration"
55329 #: guix-git/doc/guix.texi:31106
55330 msgid "Data type representing the configuration a Guix Build Coordinator agent."
55334 #: guix-git/doc/guix.texi:31111
55336 msgid "@code{user} (default: @code{\"guix-build-coordinator-agent\"})"
55340 #: guix-git/doc/guix.texi:31114 guix-git/doc/guix.texi:31231
55342 msgid "@code{coordinator} (default: @code{\"http://localhost:8745\"})"
55346 #: guix-git/doc/guix.texi:31116 guix-git/doc/guix.texi:31233
55347 msgid "The URI to use when connecting to the coordinator."
55351 #: guix-git/doc/guix.texi:31117
55353 msgid "authentication"
55357 #: guix-git/doc/guix.texi:31120
55358 msgid "Record describing how this agent should authenticate with the coordinator. Possible record types are described below."
55362 #: guix-git/doc/guix.texi:31121 guix-git/doc/guix.texi:31234
55364 msgid "@code{systems} (default: @code{#f})"
55368 #: guix-git/doc/guix.texi:31124
55369 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."
55373 #: guix-git/doc/guix.texi:31125
55375 msgid "@code{max-parallel-builds} (default: @code{1})"
55379 #: guix-git/doc/guix.texi:31127
55380 msgid "The number of builds to perform in parallel."
55384 #: guix-git/doc/guix.texi:31128
55386 msgid "@code{derivation-substitute-urls} (default: @code{#f})"
55390 #: guix-git/doc/guix.texi:31131
55391 msgid "URLs from which to attempt to fetch substitutes for derivations, if the derivations aren't already available."
55395 #: guix-git/doc/guix.texi:31132
55397 msgid "@code{non-derivation-substitute-urls} (default: @code{#f})"
55401 #: guix-git/doc/guix.texi:31135
55402 msgid "URLs from which to attempt to fetch substitutes for build inputs, if the input store items aren't already available."
55406 #: guix-git/doc/guix.texi:31139
55408 msgid "{Data Type} guix-build-coordinator-agent-password-auth"
55412 #: guix-git/doc/guix.texi:31142
55413 msgid "Data type representing an agent authenticating with a coordinator via a UUID and password."
55417 #: guix-git/doc/guix.texi:31148 guix-git/doc/guix.texi:31164
55418 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."
55422 #: guix-git/doc/guix.texi:31151
55423 msgid "The password to use when connecting to the coordinator."
55427 #: guix-git/doc/guix.texi:31155
55429 msgid "{Data Type} guix-build-coordinator-agent-password-file-auth"
55433 #: guix-git/doc/guix.texi:31158
55434 msgid "Data type representing an agent authenticating with a coordinator via a UUID and password read from a file."
55438 #: guix-git/doc/guix.texi:31165
55440 msgid "password-file"
55444 #: guix-git/doc/guix.texi:31168
55445 msgid "A file containing the password to use when connecting to the coordinator."
55449 #: guix-git/doc/guix.texi:31172
55451 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth"
55455 #: guix-git/doc/guix.texi:31175
55456 msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token and agent name."
55460 #: guix-git/doc/guix.texi:31177 guix-git/doc/guix.texi:31194
55466 #: guix-git/doc/guix.texi:31181 guix-git/doc/guix.texi:31198
55467 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."
55471 #: guix-git/doc/guix.texi:31182
55477 #: guix-git/doc/guix.texi:31185
55478 msgid "Dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
55482 #: guix-git/doc/guix.texi:31189
55484 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth-with-file"
55488 #: guix-git/doc/guix.texi:31192
55489 msgid "Data type representing an agent authenticating with a coordinator via a dynamic auth token read from a file and agent name."
55493 #: guix-git/doc/guix.texi:31199
55499 #: guix-git/doc/guix.texi:31202
55500 msgid "File containing the dynamic auth token, this is created and stored in the coordinator database, and is used by the agent to authenticate."
55503 #. type: Plain text
55504 #: guix-git/doc/guix.texi:31212
55505 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."
55509 #: guix-git/doc/guix.texi:31213
55511 msgid "{Scheme Variable} guix-build-coordinator-queue-builds-service-type"
55515 #: guix-git/doc/guix.texi:31218
55516 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."
55520 #: guix-git/doc/guix.texi:31220
55522 msgid "{Data Type} guix-build-coordinator-queue-builds-configuration"
55526 #: guix-git/doc/guix.texi:31223
55527 msgid "Data type representing the options to the queue builds from guix data service script."
55531 #: guix-git/doc/guix.texi:31228
55533 msgid "@code{user} (default: @code{\"guix-build-coordinator-queue-builds\"})"
55537 #: guix-git/doc/guix.texi:31236
55538 msgid "The systems for which to fetch derivations to build."
55542 #: guix-git/doc/guix.texi:31237
55544 msgid "@code{systems-and-targets} (default: @code{#f})"
55548 #: guix-git/doc/guix.texi:31240
55549 msgid "An association list of system and target pairs for which to fetch derivations to build."
55553 #: guix-git/doc/guix.texi:31241
55555 msgid "@code{guix-data-service} (default: @code{\"https://data.guix.gnu.org\"})"
55559 #: guix-git/doc/guix.texi:31244
55560 msgid "The Guix Data Service instance from which to query to find out about derivations to build."
55564 #: guix-git/doc/guix.texi:31245
55566 msgid "@code{processed-commits-file} (default: @code{\"/var/cache/guix-build-coordinator-queue-builds/processed-commits\"})"
55570 #: guix-git/doc/guix.texi:31248
55571 msgid "A file to record which commits have been processed, to avoid needlessly processing them again if the service is restarted."
55574 #. type: subsubheading
55575 #: guix-git/doc/guix.texi:31252
55577 msgid "Guix Data Service"
55580 #. type: Plain text
55581 #: guix-git/doc/guix.texi:31256
55582 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."
55585 #. type: Plain text
55586 #: guix-git/doc/guix.texi:31259
55587 msgid "The data is stored in a PostgreSQL database, and available through a web interface."
55591 #: guix-git/doc/guix.texi:31260
55593 msgid "{Scheme Variable} guix-data-service-type"
55597 #: guix-git/doc/guix.texi:31265
55598 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."
55602 #: guix-git/doc/guix.texi:31267
55604 msgid "{Data Type} guix-data-service-configuration"
55608 #: guix-git/doc/guix.texi:31269
55609 msgid "Data type representing the configuration of the Guix Data Service."
55613 #: guix-git/doc/guix.texi:31271
55615 msgid "@code{package} (default: @code{guix-data-service})"
55619 #: guix-git/doc/guix.texi:31273
55620 msgid "The Guix Data Service package to use."
55624 #: guix-git/doc/guix.texi:31274
55626 msgid "@code{user} (default: @code{\"guix-data-service\"})"
55630 #: guix-git/doc/guix.texi:31277
55632 msgid "@code{group} (default: @code{\"guix-data-service\"})"
55636 #: guix-git/doc/guix.texi:31280
55638 msgid "@code{port} (default: @code{8765})"
55642 #: guix-git/doc/guix.texi:31282
55643 msgid "The port to bind the web service to."
55647 #: guix-git/doc/guix.texi:31283
55649 msgid "@code{host} (default: @code{\"127.0.0.1\"})"
55653 #: guix-git/doc/guix.texi:31285
55654 msgid "The host to bind the web service to."
55658 #: guix-git/doc/guix.texi:31286
55660 msgid "@code{getmail-idle-mailboxes} (default: @code{#f})"
55664 #: guix-git/doc/guix.texi:31289
55665 msgid "If set, this is the list of mailboxes that the getmail service will be configured to listen to."
55669 #: guix-git/doc/guix.texi:31290
55671 msgid "@code{commits-getmail-retriever-configuration} (default: @code{#f})"
55675 #: guix-git/doc/guix.texi:31294
55676 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."
55680 #: guix-git/doc/guix.texi:31295
55682 msgid "@code{extra-options} (default: @var{'()})"
55686 #: guix-git/doc/guix.texi:31297
55687 msgid "Extra command line options for @code{guix-data-service}."
55691 #: guix-git/doc/guix.texi:31298
55693 msgid "@code{extra-process-jobs-options} (default: @var{'()})"
55697 #: guix-git/doc/guix.texi:31300
55698 msgid "Extra command line options for @code{guix-data-service-process-jobs}."
55702 #: guix-git/doc/guix.texi:31307
55708 #: guix-git/doc/guix.texi:31308
55710 msgid "out of memory killer"
55714 #: guix-git/doc/guix.texi:31309
55720 #: guix-git/doc/guix.texi:31310
55722 msgid "early out of memory daemon"
55725 #. type: subsubheading
55726 #: guix-git/doc/guix.texi:31311
55728 msgid "Early OOM Service"
55731 #. type: Plain text
55732 #: guix-git/doc/guix.texi:31318
55733 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."
55737 #: guix-git/doc/guix.texi:31319
55739 msgid "{Scheme Variable} earlyoom-service-type"
55743 #: guix-git/doc/guix.texi:31324
55744 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:"
55748 #: guix-git/doc/guix.texi:31327
55750 msgid "(service earlyoom-service-type)\n"
55754 #: guix-git/doc/guix.texi:31330
55756 msgid "{Data Type} earlyoom-configuration"
55760 #: guix-git/doc/guix.texi:31332
55761 msgid "This is the configuration record for the @code{earlyoom-service-type}."
55765 #: guix-git/doc/guix.texi:31334
55767 msgid "@code{earlyoom} (default: @var{earlyoom})"
55771 #: guix-git/doc/guix.texi:31336
55772 msgid "The Earlyoom package to use."
55776 #: guix-git/doc/guix.texi:31337
55778 msgid "@code{minimum-available-memory} (default: @code{10})"
55782 #: guix-git/doc/guix.texi:31339
55783 msgid "The threshold for the minimum @emph{available} memory, in percentages."
55787 #: guix-git/doc/guix.texi:31340
55789 msgid "@code{minimum-free-swap} (default: @code{10})"
55793 #: guix-git/doc/guix.texi:31342
55794 msgid "The threshold for the minimum free swap memory, in percentages."
55798 #: guix-git/doc/guix.texi:31343
55800 msgid "@code{prefer-regexp} (default: @code{#f})"
55804 #: guix-git/doc/guix.texi:31346
55805 msgid "A regular expression (as a string) to match the names of the processes that should be preferably killed."
55809 #: guix-git/doc/guix.texi:31347
55811 msgid "@code{avoid-regexp} (default: @code{#f})"
55815 #: guix-git/doc/guix.texi:31350
55816 msgid "A regular expression (as a string) to match the names of the processes that should @emph{not} be killed."
55820 #: guix-git/doc/guix.texi:31351
55822 msgid "@code{memory-report-interval} (default: @code{0})"
55826 #: guix-git/doc/guix.texi:31354
55827 msgid "The interval in seconds at which a memory report is printed. It is disabled by default."
55831 #: guix-git/doc/guix.texi:31355
55833 msgid "@code{ignore-positive-oom-score-adj?} (default: @code{#f})"
55837 #: guix-git/doc/guix.texi:31358
55838 msgid "A boolean indicating whether the positive adjustments set in @file{/proc/*/oom_score_adj} should be ignored."
55842 #: guix-git/doc/guix.texi:31359
55844 msgid "@code{show-debug-messages?} (default: @code{#f})"
55848 #: guix-git/doc/guix.texi:31362
55849 msgid "A boolean indicating whether debug messages should be printed. The logs are saved at @file{/var/log/earlyoom.log}."
55853 #: guix-git/doc/guix.texi:31363
55855 msgid "@code{send-notification-command} (default: @code{#f})"
55859 #: guix-git/doc/guix.texi:31366
55860 msgid "This can be used to provide a custom command used for sending notifications."
55864 #: guix-git/doc/guix.texi:31369
55870 #: guix-git/doc/guix.texi:31370
55872 msgid "kernel module loader"
55875 #. type: subsubheading
55876 #: guix-git/doc/guix.texi:31371
55878 msgid "Kernel Module Loader Service"
55881 #. type: Plain text
55882 #: guix-git/doc/guix.texi:31377
55883 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}."
55887 #: guix-git/doc/guix.texi:31378
55889 msgid "{Scheme Variable} kernel-module-loader-service-type"
55893 #: guix-git/doc/guix.texi:31384
55894 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:"
55898 #: guix-git/doc/guix.texi:31389
55901 "(use-modules (gnu) (gnu services))\n"
55902 "(use-package-modules linux)\n"
55903 "(use-service-modules linux)\n"
55908 #: guix-git/doc/guix.texi:31393
55911 "(define ddcci-config\n"
55912 " (plain-file \"ddcci.conf\"\n"
55913 " \"options ddcci dyndbg delay=120\"))\n"
55918 #: guix-git/doc/guix.texi:31403
55921 "(operating-system\n"
55923 " (services (cons* (service kernel-module-loader-service-type\n"
55924 " '(\"ddcci\" \"ddcci_backlight\"))\n"
55925 " (simple-service 'ddcci-config etc-service-type\n"
55926 " (list `(\"modprobe.d/ddcci.conf\"\n"
55927 " ,ddcci-config)))\n"
55928 " %base-services))\n"
55929 " (kernel-loadable-modules (list ddcci-driver-linux)))\n"
55933 #: guix-git/doc/guix.texi:31406
55939 #: guix-git/doc/guix.texi:31407
55941 msgid "compressed swap"
55945 #: guix-git/doc/guix.texi:31408
55947 msgid "Compressed RAM-based block devices"
55950 #. type: subsubheading
55951 #: guix-git/doc/guix.texi:31409
55953 msgid "Zram Device Service"
55956 #. type: Plain text
55957 #: guix-git/doc/guix.texi:31415
55958 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."
55962 #: guix-git/doc/guix.texi:31416
55964 msgid "{Scheme Variable} zram-device-service-type"
55968 #: guix-git/doc/guix.texi:31420
55969 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."
55973 #: guix-git/doc/guix.texi:31421
55975 msgid "{Data Type} zram-device-configuration"
55979 #: guix-git/doc/guix.texi:31424
55980 msgid "This is the data type representing the configuration for the zram-device service."
55984 #: guix-git/doc/guix.texi:31426
55986 msgid "@code{size} (default @code{\"1G\"})"
55990 #: guix-git/doc/guix.texi:31430
55991 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}."
55995 #: guix-git/doc/guix.texi:31430
55997 msgid "@code{compression-algorithm} (default @code{'lzo})"
56001 #: guix-git/doc/guix.texi:31434
56002 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}."
56006 #: guix-git/doc/guix.texi:31434
56008 msgid "@code{memory-limit} (default @code{0})"
56012 #: guix-git/doc/guix.texi:31441
56013 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\"}."
56017 #: guix-git/doc/guix.texi:31441
56019 msgid "@code{priority} (default @code{-1})"
56023 #: guix-git/doc/guix.texi:31446
56024 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."
56028 #: guix-git/doc/guix.texi:31454
56030 msgid "{Scheme Variable} hurd-console-service-type"
56034 #: guix-git/doc/guix.texi:31456
56035 msgid "This service starts the fancy @code{VGA} console client on the Hurd."
56039 #: guix-git/doc/guix.texi:31458
56040 msgid "The service's value is a @code{hurd-console-configuration} record."
56044 #: guix-git/doc/guix.texi:31460
56046 msgid "{Data Type} hurd-console-configuration"
56050 #: guix-git/doc/guix.texi:31463
56051 msgid "This is the data type representing the configuration for the hurd-console-service."
56055 #: guix-git/doc/guix.texi:31465 guix-git/doc/guix.texi:31481
56057 msgid "@code{hurd} (default: @var{hurd})"
56061 #: guix-git/doc/guix.texi:31467 guix-git/doc/guix.texi:31483
56062 msgid "The Hurd package to use."
56066 #: guix-git/doc/guix.texi:31470
56068 msgid "{Scheme Variable} hurd-getty-service-type"
56072 #: guix-git/doc/guix.texi:31472
56073 msgid "This service starts a tty using the Hurd @code{getty} program."
56077 #: guix-git/doc/guix.texi:31474
56078 msgid "The service's value is a @code{hurd-getty-configuration} record."
56082 #: guix-git/doc/guix.texi:31476
56084 msgid "{Data Type} hurd-getty-configuration"
56088 #: guix-git/doc/guix.texi:31479
56089 msgid "This is the data type representing the configuration for the hurd-getty-service."
56093 #: guix-git/doc/guix.texi:31486
56094 msgid "The name of the console this Getty runs on---e.g., @code{\"tty1\"}."
56098 #: guix-git/doc/guix.texi:31487
56100 msgid "@code{baud-rate} (default: @code{38400})"
56104 #: guix-git/doc/guix.texi:31489
56105 msgid "An integer specifying the baud rate of the tty."
56109 #: guix-git/doc/guix.texi:31496
56111 msgid "fingerprint"
56114 #. type: subsubheading
56115 #: guix-git/doc/guix.texi:31497
56117 msgid "Fingerprint Service"
56120 #. type: Plain text
56121 #: guix-git/doc/guix.texi:31501
56122 msgid "The @code{(gnu services authentication)} module provides a DBus service to read and identify fingerprints via a fingerprint sensor."
56126 #: guix-git/doc/guix.texi:31502
56128 msgid "{Scheme Variable} fprintd-service-type"
56132 #: guix-git/doc/guix.texi:31505
56133 msgid "The service type for @command{fprintd}, which provides the fingerprint reading capability."
56137 #: guix-git/doc/guix.texi:31508
56139 msgid "(service fprintd-service-type)\n"
56143 #: guix-git/doc/guix.texi:31511
56148 #. type: subsubheading
56149 #: guix-git/doc/guix.texi:31512
56151 msgid "System Control Service"
56154 #. type: Plain text
56155 #: guix-git/doc/guix.texi:31516
56156 msgid "The @code{(gnu services sysctl)} provides a service to configure kernel parameters at boot."
56160 #: guix-git/doc/guix.texi:31517
56162 msgid "{Scheme Variable} sysctl-service-type"
56166 #: guix-git/doc/guix.texi:31521
56167 msgid "The service type for @command{sysctl}, which modifies kernel parameters under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated as:"
56171 #: guix-git/doc/guix.texi:31526
56174 "(service sysctl-service-type\n"
56175 " (sysctl-configuration\n"
56176 " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n"
56180 #: guix-git/doc/guix.texi:31533
56181 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}})."
56185 #: guix-git/doc/guix.texi:31540
56188 "(modify-services %base-services\n"
56189 " (sysctl-service-type config =>\n"
56190 " (sysctl-configuration\n"
56191 " (settings (append '((\"net.ipv4.ip_forward\" . \"1\"))\n"
56192 " %default-sysctl-settings)))))\n"
56196 #: guix-git/doc/guix.texi:31544
56198 msgid "{Data Type} sysctl-configuration"
56202 #: guix-git/doc/guix.texi:31546
56203 msgid "The data type representing the configuration of @command{sysctl}."
56207 #: guix-git/doc/guix.texi:31548
56209 msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})"
56213 #: guix-git/doc/guix.texi:31550
56214 msgid "The @command{sysctl} executable to use."
56218 #: guix-git/doc/guix.texi:31551
56220 msgid "@code{settings} (default: @code{%default-sysctl-settings})"
56224 #: guix-git/doc/guix.texi:31553
56225 msgid "An association list specifies kernel parameters and their values."
56229 #: guix-git/doc/guix.texi:31556
56231 msgid "{Scheme Variable} %default-sysctl-settings"
56235 #: guix-git/doc/guix.texi:31559
56236 msgid "An association list specifying the default @command{sysctl} parameters on Guix System."
56240 #: guix-git/doc/guix.texi:31561
56245 #. type: subsubheading
56246 #: guix-git/doc/guix.texi:31562
56248 msgid "PC/SC Smart Card Daemon Service"
56251 #. type: Plain text
56252 #: guix-git/doc/guix.texi:31569
56253 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."
56257 #: guix-git/doc/guix.texi:31570
56259 msgid "{Scheme Variable} pcscd-service-type"
56263 #: guix-git/doc/guix.texi:31574
56264 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:"
56268 #: guix-git/doc/guix.texi:31577
56270 msgid "(service pcscd-service-type)\n"
56274 #: guix-git/doc/guix.texi:31580
56276 msgid "{Data Type} pcscd-configuration"
56280 #: guix-git/doc/guix.texi:31582
56281 msgid "The data type representing the configuration of @command{pcscd}."
56285 #: guix-git/doc/guix.texi:31584
56287 msgid "@code{pcsc-lite} (default: @code{pcsc-lite})"
56291 #: guix-git/doc/guix.texi:31586
56292 msgid "The pcsc-lite package that provides pcscd."
56296 #: guix-git/doc/guix.texi:31586
56298 msgid "@code{usb-drivers} (default: @code{(list ccid)})"
56302 #: guix-git/doc/guix.texi:31589
56303 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."
56307 #: guix-git/doc/guix.texi:31592
56312 #. type: subsubheading
56313 #: guix-git/doc/guix.texi:31593
56315 msgid "Lirc Service"
56318 #. type: Plain text
56319 #: guix-git/doc/guix.texi:31596
56320 msgid "The @code{(gnu services lirc)} module provides the following service."
56324 #: guix-git/doc/guix.texi:31597
56326 msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @"
56330 #: guix-git/doc/guix.texi:31602
56331 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."
56335 #: guix-git/doc/guix.texi:31606
56336 msgid "Optionally, @var{device}, @var{driver} and @var{config-file} (configuration file name) may be specified. See @command{lircd} manual for details."
56340 #: guix-git/doc/guix.texi:31609
56341 msgid "Finally, @var{extra-options} is a list of additional command-line options passed to @command{lircd}."
56345 #: guix-git/doc/guix.texi:31611
56350 #. type: subsubheading
56351 #: guix-git/doc/guix.texi:31612
56353 msgid "Spice Service"
56356 #. type: Plain text
56357 #: guix-git/doc/guix.texi:31615
56358 msgid "The @code{(gnu services spice)} module provides the following service."
56362 #: guix-git/doc/guix.texi:31616
56364 msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]"
56368 #: guix-git/doc/guix.texi:31620
56369 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."
56373 #: guix-git/doc/guix.texi:31622
56375 msgid "inputattach"
56378 #. type: subsubheading
56379 #: guix-git/doc/guix.texi:31623
56381 msgid "inputattach Service"
56385 #: guix-git/doc/guix.texi:31625
56387 msgid "tablet input, for Xorg"
56391 #: guix-git/doc/guix.texi:31626
56393 msgid "touchscreen input, for Xorg"
56396 #. type: Plain text
56397 #: guix-git/doc/guix.texi:31630
56398 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."
56402 #: guix-git/doc/guix.texi:31631
56404 msgid "{Scheme Variable} inputattach-service-type"
56408 #: guix-git/doc/guix.texi:31634
56409 msgid "Type of a service that runs @command{inputattach} on a device and dispatches events from it."
56413 #: guix-git/doc/guix.texi:31636
56415 msgid "{Data Type} inputattach-configuration"
56419 #: guix-git/doc/guix.texi:31638
56421 msgid "@code{device-type} (default: @code{\"wacom\"})"
56425 #: guix-git/doc/guix.texi:31641
56426 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."
56430 #: guix-git/doc/guix.texi:31642
56432 msgid "@code{device} (default: @code{\"/dev/ttyS0\"})"
56436 #: guix-git/doc/guix.texi:31644
56437 msgid "The device file to connect to the device."
56441 #: guix-git/doc/guix.texi:31648
56442 msgid "Baud rate to use for the serial connection. Should be a number or @code{#f}."
56446 #: guix-git/doc/guix.texi:31649
56448 msgid "@code{log-file} (default: @code{#f})"
56452 #: guix-git/doc/guix.texi:31651
56453 msgid "If true, this must be the name of a file to log messages to."
56456 #. type: subsubheading
56457 #: guix-git/doc/guix.texi:31654
56459 msgid "Dictionary Service"
56463 #: guix-git/doc/guix.texi:31655
56468 #. type: Plain text
56469 #: guix-git/doc/guix.texi:31657
56470 msgid "The @code{(gnu services dict)} module provides the following service:"
56474 #: guix-git/doc/guix.texi:31658
56476 msgid "{Scheme Variable} dicod-service-type"
56480 #: guix-git/doc/guix.texi:31661
56481 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})."
56485 #: guix-git/doc/guix.texi:31663
56487 msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]"
56491 #: guix-git/doc/guix.texi:31666
56492 msgid "Return a service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})."
56496 #: guix-git/doc/guix.texi:31670
56497 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."
56501 #: guix-git/doc/guix.texi:31674
56502 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})."
56506 #: guix-git/doc/guix.texi:31676
56508 msgid "{Data Type} dicod-configuration"
56512 #: guix-git/doc/guix.texi:31678
56513 msgid "Data type representing the configuration of dicod."
56517 #: guix-git/doc/guix.texi:31680
56519 msgid "@code{dico} (default: @var{dico})"
56523 #: guix-git/doc/guix.texi:31682
56524 msgid "Package object of the GNU Dico dictionary server."
56528 #: guix-git/doc/guix.texi:31683
56530 msgid "@code{interfaces} (default: @var{'(\"localhost\")})"
56534 #: guix-git/doc/guix.texi:31687
56535 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})."
56539 #: guix-git/doc/guix.texi:31688
56541 msgid "@code{handlers} (default: @var{'()})"
56545 #: guix-git/doc/guix.texi:31690
56546 msgid "List of @code{<dicod-handler>} objects denoting handlers (module instances)."
56550 #: guix-git/doc/guix.texi:31691
56552 msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})"
56556 #: guix-git/doc/guix.texi:31693
56557 msgid "List of @code{<dicod-database>} objects denoting dictionaries to be served."
56561 #: guix-git/doc/guix.texi:31696
56563 msgid "{Data Type} dicod-handler"
56567 #: guix-git/doc/guix.texi:31698
56568 msgid "Data type representing a dictionary handler (module instance)."
56572 #: guix-git/doc/guix.texi:31702
56573 msgid "Name of the handler (module instance)."
56577 #: guix-git/doc/guix.texi:31703
56579 msgid "@code{module} (default: @var{#f})"
56583 #: guix-git/doc/guix.texi:31707
56584 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})."
56588 #: guix-git/doc/guix.texi:31710
56589 msgid "List of strings or gexps representing the arguments for the module handler"
56593 #: guix-git/doc/guix.texi:31713
56595 msgid "{Data Type} dicod-database"
56599 #: guix-git/doc/guix.texi:31715
56600 msgid "Data type representing a dictionary database."
56604 #: guix-git/doc/guix.texi:31719
56605 msgid "Name of the database, will be used in DICT commands."
56609 #: guix-git/doc/guix.texi:31720
56615 #: guix-git/doc/guix.texi:31723
56616 msgid "Name of the dicod handler (module instance) used by this database (@pxref{Handlers,,, dico, GNU Dico Manual})."
56620 #: guix-git/doc/guix.texi:31724
56622 msgid "@code{complex?} (default: @var{#f})"
56626 #: guix-git/doc/guix.texi:31727
56627 msgid "Whether the database configuration complex. The complex configuration will need a corresponding @code{<dicod-handler>} object, otherwise not."
56631 #: guix-git/doc/guix.texi:31731
56632 msgid "List of strings or gexps representing the arguments for the database (@pxref{Databases,,, dico, GNU Dico Manual})."
56636 #: guix-git/doc/guix.texi:31734
56638 msgid "{Scheme Variable} %dicod-database:gcide"
56642 #: guix-git/doc/guix.texi:31737
56643 msgid "A @code{<dicod-database>} object serving the GNU Collaborative International Dictionary of English using the @code{gcide} package."
56646 #. type: Plain text
56647 #: guix-git/doc/guix.texi:31740
56648 msgid "The following is an example @code{dicod-service} configuration."
56652 #: guix-git/doc/guix.texi:31755
56655 "(dicod-service #:config\n"
56656 " (dicod-configuration\n"
56657 " (handlers (list (dicod-handler\n"
56658 " (name \"wordnet\")\n"
56659 " (module \"dictorg\")\n"
56661 " (list #~(string-append \"dbdir=\" #$wordnet))))))\n"
56662 " (databases (list (dicod-database\n"
56663 " (name \"wordnet\")\n"
56665 " (handler \"wordnet\")\n"
56666 " (options '(\"database=wn\")))\n"
56667 " %dicod-database:gcide))))\n"
56671 #: guix-git/doc/guix.texi:31757
56676 #. type: subsubheading
56677 #: guix-git/doc/guix.texi:31758
56679 msgid "Docker Service"
56682 #. type: Plain text
56683 #: guix-git/doc/guix.texi:31761
56684 msgid "The @code{(gnu services docker)} module provides the following services."
56688 #: guix-git/doc/guix.texi:31762
56690 msgid "{Scheme Variable} docker-service-type"
56694 #: guix-git/doc/guix.texi:31767
56695 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."
56699 #: guix-git/doc/guix.texi:31770
56701 msgid "{Data Type} docker-configuration"
56705 #: guix-git/doc/guix.texi:31772
56706 msgid "This is the data type representing the configuration of Docker and Containerd."
56710 #: guix-git/doc/guix.texi:31775
56712 msgid "@code{package} (default: @code{docker})"
56716 #: guix-git/doc/guix.texi:31777
56717 msgid "The Docker daemon package to use."
56721 #: guix-git/doc/guix.texi:31778
56723 msgid "@code{package} (default: @code{docker-cli})"
56727 #: guix-git/doc/guix.texi:31780
56728 msgid "The Docker client package to use."
56732 #: guix-git/doc/guix.texi:31781
56734 msgid "@code{containerd} (default: @var{containerd})"
56738 #: guix-git/doc/guix.texi:31783
56739 msgid "The Containerd package to use."
56743 #: guix-git/doc/guix.texi:31784
56745 msgid "@code{proxy} (default @var{docker-libnetwork-cmd-proxy})"
56749 #: guix-git/doc/guix.texi:31786
56750 msgid "The Docker user-land networking proxy package to use."
56754 #: guix-git/doc/guix.texi:31787
56756 msgid "@code{enable-proxy?} (default @code{#t})"
56760 #: guix-git/doc/guix.texi:31789
56761 msgid "Enable or disable the use of the Docker user-land networking proxy."
56765 #: guix-git/doc/guix.texi:31790
56767 msgid "@code{debug?} (default @code{#f})"
56771 #: guix-git/doc/guix.texi:31792
56772 msgid "Enable or disable debug output."
56776 #: guix-git/doc/guix.texi:31793
56778 msgid "@code{enable-iptables?} (default @code{#t})"
56782 #: guix-git/doc/guix.texi:31795
56783 msgid "Enable or disable the addition of iptables rules."
56787 #: guix-git/doc/guix.texi:31799
56789 msgid "Singularity, container service"
56793 #: guix-git/doc/guix.texi:31800
56795 msgid "{Scheme Variable} singularity-service-type"
56799 #: guix-git/doc/guix.texi:31805
56800 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."
56804 #: guix-git/doc/guix.texi:31809
56805 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."
56809 #: guix-git/doc/guix.texi:31811
56814 #. type: subsubheading
56815 #: guix-git/doc/guix.texi:31812
56817 msgid "Auditd Service"
56820 #. type: Plain text
56821 #: guix-git/doc/guix.texi:31815
56822 msgid "The @code{(gnu services auditd)} module provides the following service."
56826 #: guix-git/doc/guix.texi:31816
56828 msgid "{Scheme Variable} auditd-service-type"
56832 #: guix-git/doc/guix.texi:31821
56833 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."
56837 #: guix-git/doc/guix.texi:31823
56838 msgid "Examples of things that can be tracked:"
56842 #: guix-git/doc/guix.texi:31827
56843 msgid "File accesses"
56847 #: guix-git/doc/guix.texi:31829
56848 msgid "System calls"
56852 #: guix-git/doc/guix.texi:31831
56853 msgid "Invoked commands"
56857 #: guix-git/doc/guix.texi:31833
56858 msgid "Failed login attempts"
56862 #: guix-git/doc/guix.texi:31835
56863 msgid "Firewall filtering"
56867 #: guix-git/doc/guix.texi:31837
56868 msgid "Network access"
56872 #: guix-git/doc/guix.texi:31848
56873 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}."
56877 #: guix-git/doc/guix.texi:31851
56879 msgid "{Data Type} auditd-configuration"
56883 #: guix-git/doc/guix.texi:31853
56884 msgid "This is the data type representing the configuration of auditd."
56888 #: guix-git/doc/guix.texi:31856
56890 msgid "@code{audit} (default: @code{audit})"
56894 #: guix-git/doc/guix.texi:31858
56895 msgid "The audit package to use."
56899 #: guix-git/doc/guix.texi:31859
56901 msgid "@code{configuration-directory} (default: @code{%default-auditd-configuration-directory})"
56905 #: guix-git/doc/guix.texi:31863
56906 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."
56910 #: guix-git/doc/guix.texi:31867
56915 #. type: subsubheading
56916 #: guix-git/doc/guix.texi:31868
56918 msgid "R-Shiny service"
56921 #. type: Plain text
56922 #: guix-git/doc/guix.texi:31871
56923 msgid "The @code{(gnu services science)} module provides the following service."
56927 #: guix-git/doc/guix.texi:31872
56929 msgid "{Scheme Variable} rshiny-service-type"
56933 #: guix-git/doc/guix.texi:31877
56934 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}."
56938 #: guix-git/doc/guix.texi:31878
56940 msgid "{Data Type} rshiny-configuration"
56944 #: guix-git/doc/guix.texi:31880
56945 msgid "This is the data type representing the configuration of rshiny."
56949 #: guix-git/doc/guix.texi:31883
56951 msgid "@code{package} (default: @code{r-shiny})"
56955 #: guix-git/doc/guix.texi:31885
56956 msgid "The package to use."
56960 #: guix-git/doc/guix.texi:31886
56962 msgid "@code{binary} (defaunlt @code{\"rshiny\"})"
56966 #: guix-git/doc/guix.texi:31889
56967 msgid "The name of the binary or shell script located at @code{package/bin/} to run when the service is run."
56971 #: guix-git/doc/guix.texi:31891
56972 msgid "The common way to create this file is as follows:"
56976 #: guix-git/doc/guix.texi:31909
56980 "(let* ((out (assoc-ref %outputs \"out\"))\n"
56981 " (targetdir (string-append out \"/share/\" ,name))\n"
56982 " (app (string-append out \"/bin/\" ,name))\n"
56983 " (Rbin (string-append (assoc-ref %build-inputs \"r-min\")\n"
56984 " \"/bin/Rscript\")))\n"
56986 " (mkdir-p (string-append out \"/bin\"))\n"
56987 " (call-with-output-file app\n"
56988 " (lambda (port)\n"
56992 "setwd(\\\"~a\\\")\n"
56993 "runApp(launch.browser=0, port=4202)~%\\n\"\n"
56994 " Rbin targetdir))))\n"
56998 #: guix-git/doc/guix.texi:31915
57003 #. type: subsubheading
57004 #: guix-git/doc/guix.texi:31916
57006 msgid "Nix service"
57009 #. type: Plain text
57010 #: guix-git/doc/guix.texi:31919
57011 msgid "The @code{(gnu services nix)} module provides the following service."
57015 #: guix-git/doc/guix.texi:31920
57017 msgid "{Scheme Variable} nix-service-type"
57021 #: guix-git/doc/guix.texi:31925
57022 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:"
57026 #: guix-git/doc/guix.texi:31930
57029 "(use-modules (gnu))\n"
57030 "(use-service-modules nix)\n"
57031 "(use-package-modules package-management)\n"
57036 #: guix-git/doc/guix.texi:31935
57039 "(operating-system\n"
57041 " (packages (append (list nix)\n"
57042 " %base-packages))\n"
57047 #: guix-git/doc/guix.texi:31938
57050 " (services (append (list (service nix-service-type))\n"
57051 " %base-services)))\n"
57055 #: guix-git/doc/guix.texi:31941
57056 msgid "After @command{guix system reconfigure} configure Nix for your user:"
57060 #: guix-git/doc/guix.texi:31943
57062 msgid "Add a Nix channel and update it. See"
57066 #: guix-git/doc/guix.texi:31945
57067 msgid "@url{https://nixos.org/nix/manual/, Nix Package Manager Guide}."
57071 #: guix-git/doc/guix.texi:31946
57073 msgid "Create a symlink to your profile and activate Nix profile:"
57077 #: guix-git/doc/guix.texi:31952
57080 "$ ln -s \"/nix/var/nix/profiles/per-user/$USER/profile\" ~/.nix-profile\n"
57081 "$ source /run/current-system/profile/etc/profile.d/nix.sh\n"
57085 #: guix-git/doc/guix.texi:31956
57087 msgid "{Data Type} nix-configuration"
57091 #: guix-git/doc/guix.texi:31958
57092 msgid "This data type represents the configuration of the Nix daemon."
57096 #: guix-git/doc/guix.texi:31960
57098 msgid "@code{nix} (default: @code{nix})"
57102 #: guix-git/doc/guix.texi:31962
57103 msgid "The Nix package to use."
57107 #: guix-git/doc/guix.texi:31963
57109 msgid "@code{sandbox} (default: @code{#t})"
57113 #: guix-git/doc/guix.texi:31965
57114 msgid "Specifies whether builds are sandboxed by default."
57118 #: guix-git/doc/guix.texi:31966
57120 msgid "@code{build-sandbox-items} (default: @code{'()})"
57124 #: guix-git/doc/guix.texi:31969
57125 msgid "This is a list of strings or objects appended to the @code{build-sandbox-items} field of the configuration file."
57129 #: guix-git/doc/guix.texi:31977
57130 msgid "Extra command line options for @code{nix-service-type}."
57134 #: guix-git/doc/guix.texi:31983
57136 msgid "setuid programs"
57139 #. type: Plain text
57140 #: guix-git/doc/guix.texi:31993
57141 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)."
57144 #. type: Plain text
57145 #: guix-git/doc/guix.texi:32000
57146 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."
57149 #. type: Plain text
57150 #: guix-git/doc/guix.texi:32006
57151 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}):"
57155 #: guix-git/doc/guix.texi:32009
57157 msgid "#~(string-append #$shadow \"/bin/passwd\")\n"
57160 #. type: Plain text
57161 #: guix-git/doc/guix.texi:32013
57162 msgid "A default set of setuid programs is defined by the @code{%setuid-programs} variable of the @code{(gnu system)} module."
57166 #: guix-git/doc/guix.texi:32014
57168 msgid "{Scheme Variable} %setuid-programs"
57172 #: guix-git/doc/guix.texi:32016
57173 msgid "A list of G-expressions denoting common programs that are setuid-root."
57177 #: guix-git/doc/guix.texi:32019
57178 msgid "The list includes commands such as @command{passwd}, @command{ping}, @command{su}, and @command{sudo}."
57181 #. type: Plain text
57182 #: guix-git/doc/guix.texi:32025
57183 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."
57187 #: guix-git/doc/guix.texi:32029
57189 msgid "HTTPS, certificates"
57193 #: guix-git/doc/guix.texi:32030
57195 msgid "X.509 certificates"
57199 #: guix-git/doc/guix.texi:32031
57204 #. type: Plain text
57205 #: guix-git/doc/guix.texi:32038
57206 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."
57209 #. type: Plain text
57210 #: guix-git/doc/guix.texi:32042
57211 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."
57214 #. type: Plain text
57215 #: guix-git/doc/guix.texi:32046
57216 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."
57219 #. type: Plain text
57220 #: guix-git/doc/guix.texi:32053
57221 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."
57224 #. type: Plain text
57225 #: guix-git/doc/guix.texi:32058
57226 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."
57229 #. type: Plain text
57230 #: guix-git/doc/guix.texi:32068
57231 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:"
57235 #: guix-git/doc/guix.texi:32074
57238 "guix install nss-certs\n"
57239 "export SSL_CERT_DIR=\"$HOME/.guix-profile/etc/ssl/certs\"\n"
57240 "export SSL_CERT_FILE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
57241 "export GIT_SSL_CAINFO=\"$SSL_CERT_FILE\"\n"
57244 #. type: Plain text
57245 #: guix-git/doc/guix.texi:32079
57246 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:"
57250 #: guix-git/doc/guix.texi:32083
57253 "guix install nss-certs\n"
57254 "export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
57257 #. type: Plain text
57258 #: guix-git/doc/guix.texi:32087
57259 msgid "For other applications you may want to look up the required environment variable in the relevant documentation."
57263 #: guix-git/doc/guix.texi:32092
57265 msgid "name service switch"
57269 #: guix-git/doc/guix.texi:32093
57274 #. type: Plain text
57275 #: guix-git/doc/guix.texi:32102
57276 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})."
57279 #. type: Plain text
57280 #: guix-git/doc/guix.texi:32109
57281 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}})."
57285 #: guix-git/doc/guix.texi:32110
57291 #: guix-git/doc/guix.texi:32111
57293 msgid ".local, host name lookup"
57296 #. type: Plain text
57297 #: guix-git/doc/guix.texi:32116
57298 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}:"
57302 #: guix-git/doc/guix.texi:32120
57305 "(name-service-switch\n"
57306 " (hosts (list %files ;first, check /etc/hosts\n"
57311 #: guix-git/doc/guix.texi:32125
57314 " ;; If the above did not succeed, try\n"
57315 " ;; with 'mdns_minimal'.\n"
57317 " (name \"mdns_minimal\")\n"
57322 #: guix-git/doc/guix.texi:32131
57325 " ;; 'mdns_minimal' is authoritative for\n"
57326 " ;; '.local'. When it returns \"not found\",\n"
57327 " ;; no need to try the next methods.\n"
57328 " (reaction (lookup-specification\n"
57329 " (not-found => return))))\n"
57334 #: guix-git/doc/guix.texi:32135
57337 " ;; Then fall back to DNS.\n"
57339 " (name \"dns\"))\n"
57344 #: guix-git/doc/guix.texi:32139
57347 " ;; Finally, try with the \"full\" 'mdns'.\n"
57349 " (name \"mdns\")))))\n"
57352 #. type: Plain text
57353 #: guix-git/doc/guix.texi:32144
57354 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."
57357 #. type: Plain text
57358 #: guix-git/doc/guix.texi:32152
57359 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}})."
57362 #. type: Plain text
57363 #: guix-git/doc/guix.texi:32155
57364 msgid "For convenience, the following variables provide typical NSS configurations."
57368 #: guix-git/doc/guix.texi:32156
57370 msgid "{Scheme Variable} %default-nss"
57374 #: guix-git/doc/guix.texi:32159
57375 msgid "This is the default name service switch configuration, a @code{name-service-switch} object."
57379 #: guix-git/doc/guix.texi:32161
57381 msgid "{Scheme Variable} %mdns-host-lookup-nss"
57385 #: guix-git/doc/guix.texi:32164
57386 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}."
57389 #. type: Plain text
57390 #: guix-git/doc/guix.texi:32174
57391 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}."
57395 #: guix-git/doc/guix.texi:32175
57397 msgid "{Data Type} name-service-switch"
57401 #: guix-git/doc/guix.texi:32180
57402 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."
57406 #: guix-git/doc/guix.texi:32182
57412 #: guix-git/doc/guix.texi:32183
57418 #: guix-git/doc/guix.texi:32185
57424 #: guix-git/doc/guix.texi:32186
57430 #: guix-git/doc/guix.texi:32187
57436 #: guix-git/doc/guix.texi:32188
57442 #: guix-git/doc/guix.texi:32189
57448 #: guix-git/doc/guix.texi:32192
57454 #: guix-git/doc/guix.texi:32194
57460 #: guix-git/doc/guix.texi:32197
57461 msgid "The system databases handled by the NSS@. Each of these fields must be a list of @code{<name-service>} objects (see below)."
57465 #: guix-git/doc/guix.texi:32200
57467 msgid "{Data Type} name-service"
57471 #: guix-git/doc/guix.texi:32204
57472 msgid "This is the data type representing an actual name service and the associated lookup action."
57476 #: guix-git/doc/guix.texi:32209
57477 msgid "A string denoting the name service (@pxref{Services in the NSS configuration,,, libc, The GNU C Library Reference Manual})."
57481 #: guix-git/doc/guix.texi:32214
57482 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}})."
57486 #: guix-git/doc/guix.texi:32215
57492 #: guix-git/doc/guix.texi:32219
57493 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:"
57497 #: guix-git/doc/guix.texi:32223
57500 "(lookup-specification (unavailable => continue)\n"
57501 " (success => return))\n"
57504 #. type: Plain text
57505 #: guix-git/doc/guix.texi:32237
57506 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."
57509 #. type: Plain text
57510 #: guix-git/doc/guix.texi:32246
57511 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:"
57515 #: guix-git/doc/guix.texi:32251
57518 "(operating-system\n"
57520 " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n"
57524 #: guix-git/doc/guix.texi:32253
57526 msgid "{Scheme Variable} %base-initrd-modules"
57530 #: guix-git/doc/guix.texi:32255
57531 msgid "This is the list of kernel modules included in the initrd by default."
57534 #. type: Plain text
57535 #: guix-git/doc/guix.texi:32263
57536 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."
57539 #. type: Plain text
57540 #: guix-git/doc/guix.texi:32268
57541 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:"
57545 #: guix-git/doc/guix.texi:32276
57548 "(initrd (lambda (file-systems . rest)\n"
57549 " ;; Create a standard initrd but set up networking\n"
57550 " ;; with the parameters QEMU expects by default.\n"
57551 " (apply base-initrd file-systems\n"
57552 " #:qemu-networking? #t\n"
57556 #. type: Plain text
57557 #: guix-git/doc/guix.texi:32281
57558 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."
57561 #. type: Plain text
57562 #: guix-git/doc/guix.texi:32288
57563 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."
57566 #. type: Plain text
57567 #: guix-git/doc/guix.texi:32293
57568 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:"
57572 #: guix-git/doc/guix.texi:32295
57574 msgid "--load=@var{boot}"
57578 #: guix-git/doc/guix.texi:32298
57579 msgid "Tell the initial RAM disk to load @var{boot}, a file containing a Scheme program, once it has mounted the root file system."
57583 #: guix-git/doc/guix.texi:32302
57584 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."
57588 #: guix-git/doc/guix.texi:32303
57590 msgid "--root=@var{root}"
57594 #: guix-git/doc/guix.texi:32308
57595 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."
57599 #: guix-git/doc/guix.texi:32312
57600 msgid "Have @file{/run/booted-system} and @file{/run/current-system} point to @var{system}."
57604 #: guix-git/doc/guix.texi:32313
57606 msgid "modprobe.blacklist=@var{modules}@dots{}"
57610 #: guix-git/doc/guix.texi:32314
57612 msgid "module, black-listing"
57616 #: guix-git/doc/guix.texi:32315
57618 msgid "black list, of kernel modules"
57622 #: guix-git/doc/guix.texi:32320
57623 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}."
57627 #: guix-git/doc/guix.texi:32321
57633 #: guix-git/doc/guix.texi:32327
57634 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."
57637 #. type: Plain text
57638 #: guix-git/doc/guix.texi:32333
57639 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."
57643 #: guix-git/doc/guix.texi:32336
57645 msgid "{Scheme Procedure} raw-initrd @var{file-systems} @"
57649 #: guix-git/doc/guix.texi:32350
57650 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."
57654 #: guix-git/doc/guix.texi:32356 guix-git/doc/guix.texi:32380
57655 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."
57659 #: guix-git/doc/guix.texi:32360
57660 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."
57664 #: guix-git/doc/guix.texi:32363
57665 msgid "When @var{volatile-root?} is true, the root file system is writable but any changes to it are lost."
57669 #: guix-git/doc/guix.texi:32365
57671 msgid "{Scheme Procedure} base-initrd @var{file-systems} @"
57675 #: guix-git/doc/guix.texi:32374
57676 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."
57680 #: guix-git/doc/guix.texi:32382
57681 msgid "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-initrd}."
57685 #: guix-git/doc/guix.texi:32387
57686 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."
57689 #. type: Plain text
57690 #: guix-git/doc/guix.texi:32394
57691 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."
57695 #: guix-git/doc/guix.texi:32395
57697 msgid "{Scheme Procedure} expression->initrd @var{exp} @"
57701 #: guix-git/doc/guix.texi:32401
57702 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."
57706 #: guix-git/doc/guix.texi:32407
57708 msgid "boot loader"
57711 #. type: Plain text
57712 #: guix-git/doc/guix.texi:32414
57713 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."
57716 #. type: Plain text
57717 #: guix-git/doc/guix.texi:32419
57718 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."
57722 #: guix-git/doc/guix.texi:32420
57724 msgid "{Data Type} bootloader-configuration"
57728 #: guix-git/doc/guix.texi:32422
57729 msgid "The type of a bootloader configuration declaration."
57733 #: guix-git/doc/guix.texi:32426
57735 msgid "EFI, bootloader"
57739 #: guix-git/doc/guix.texi:32427
57741 msgid "UEFI, bootloader"
57745 #: guix-git/doc/guix.texi:32428
57747 msgid "BIOS, bootloader"
57751 #: guix-git/doc/guix.texi:32433
57752 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."
57756 #: guix-git/doc/guix.texi:32434
57758 msgid "ARM, bootloaders"
57762 #: guix-git/doc/guix.texi:32435
57764 msgid "AArch64, bootloaders"
57768 #: guix-git/doc/guix.texi:32440
57769 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}."
57773 #: guix-git/doc/guix.texi:32446
57774 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."
57778 #: guix-git/doc/guix.texi:32450
57779 msgid "@code{grub-bootloader} allows you to boot in particular Intel-based machines in ``legacy'' BIOS mode."
57783 #: guix-git/doc/guix.texi:32451
57785 msgid "grub-efi-netboot-bootloader"
57789 #: guix-git/doc/guix.texi:32455
57790 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."
57794 #: guix-git/doc/guix.texi:32461
57795 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."
57799 #: guix-git/doc/guix.texi:32470
57800 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}."
57804 #: guix-git/doc/guix.texi:32478
57805 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."
57809 #: guix-git/doc/guix.texi:32483
57810 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."
57814 #: guix-git/doc/guix.texi:32487
57815 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}."
57819 #: guix-git/doc/guix.texi:32492
57820 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."
57824 #: guix-git/doc/guix.texi:32497
57825 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}."
57829 #: guix-git/doc/guix.texi:32501
57830 msgid "This is a string denoting the target onto which to install the bootloader."
57834 #: guix-git/doc/guix.texi:32510
57835 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."
57839 #: guix-git/doc/guix.texi:32511
57841 msgid "@code{menu-entries} (default: @code{()})"
57845 #: guix-git/doc/guix.texi:32515
57846 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."
57850 #: guix-git/doc/guix.texi:32516
57852 msgid "@code{default-entry} (default: @code{0})"
57856 #: guix-git/doc/guix.texi:32519
57857 msgid "The index of the default boot menu entry. Index 0 is for the entry of the current system."
57861 #: guix-git/doc/guix.texi:32520
57863 msgid "@code{timeout} (default: @code{5})"
57867 #: guix-git/doc/guix.texi:32523
57868 msgid "The number of seconds to wait for keyboard input before booting. Set to 0 to boot immediately, and to -1 to wait indefinitely."
57872 #: guix-git/doc/guix.texi:32524
57874 msgid "keyboard layout, for the bootloader"
57878 #: guix-git/doc/guix.texi:32528
57879 msgid "If this is @code{#f}, the bootloader's menu (if any) uses the default keyboard layout, usually US@tie{}English (``qwerty'')."
57883 #: guix-git/doc/guix.texi:32531
57884 msgid "Otherwise, this must be a @code{keyboard-layout} object (@pxref{Keyboard Layout})."
57888 #: guix-git/doc/guix.texi:32535
57889 msgid "This option is currently ignored by bootloaders other than @code{grub} and @code{grub-efi}."
57893 #: guix-git/doc/guix.texi:32537
57895 msgid "@code{theme} (default: @var{#f})"
57899 #: guix-git/doc/guix.texi:32541
57900 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."
57904 #: guix-git/doc/guix.texi:32542
57906 msgid "@code{terminal-outputs} (default: @code{'(gfxterm)})"
57910 #: guix-git/doc/guix.texi:32549
57911 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})."
57915 #: guix-git/doc/guix.texi:32550
57917 msgid "@code{terminal-inputs} (default: @code{'()})"
57921 #: guix-git/doc/guix.texi:32558
57922 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})."
57926 #: guix-git/doc/guix.texi:32559
57928 msgid "@code{serial-unit} (default: @code{#f})"
57932 #: guix-git/doc/guix.texi:32563
57933 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})."
57937 #: guix-git/doc/guix.texi:32564
57939 msgid "@code{serial-speed} (default: @code{#f})"
57943 #: guix-git/doc/guix.texi:32568
57944 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})."
57948 #: guix-git/doc/guix.texi:32572
57954 #: guix-git/doc/guix.texi:32573
57959 #. type: Plain text
57960 #: guix-git/doc/guix.texi:32579
57961 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:"
57965 #: guix-git/doc/guix.texi:32586
57969 " (label \"The Other Distro\")\n"
57970 " (linux \"/boot/old/vmlinux-2.6.32\")\n"
57971 " (linux-arguments '(\"root=/dev/sda2\"))\n"
57972 " (initrd \"/boot/old/initrd\"))\n"
57975 #. type: Plain text
57976 #: guix-git/doc/guix.texi:32589
57977 msgid "Details below."
57981 #: guix-git/doc/guix.texi:32590
57983 msgid "{Data Type} menu-entry"
57987 #: guix-git/doc/guix.texi:32592
57988 msgid "The type of an entry in the bootloader menu."
57992 #: guix-git/doc/guix.texi:32597
57993 msgid "The label to show in the menu---e.g., @code{\"GNU\"}."
57997 #: guix-git/doc/guix.texi:32598
57999 msgid "@code{linux} (default: @code{#f})"
58003 #: guix-git/doc/guix.texi:32600
58004 msgid "The Linux kernel image to boot, for example:"
58008 #: guix-git/doc/guix.texi:32603
58010 msgid "(file-append linux-libre \"/bzImage\")\n"
58014 #: guix-git/doc/guix.texi:32608
58015 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:"
58019 #: guix-git/doc/guix.texi:32611
58021 msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n"
58025 #: guix-git/doc/guix.texi:32615
58026 msgid "If the device is specified explicitly as above, then the @code{device} field is ignored entirely."
58030 #: guix-git/doc/guix.texi:32616
58032 msgid "@code{linux-arguments} (default: @code{()})"
58036 #: guix-git/doc/guix.texi:32619
58037 msgid "The list of extra Linux kernel command-line arguments---e.g., @code{(\"console=ttyS0\")}."
58041 #: guix-git/doc/guix.texi:32620
58043 msgid "@code{initrd} (default: @code{#f})"
58047 #: guix-git/doc/guix.texi:32623
58048 msgid "A G-Expression or string denoting the file name of the initial RAM disk to use (@pxref{G-Expressions})."
58052 #: guix-git/doc/guix.texi:32624
58054 msgid "@code{device} (default: @code{#f})"
58058 #: guix-git/doc/guix.texi:32627
58059 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})."
58063 #: guix-git/doc/guix.texi:32633
58064 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}."
58068 #: guix-git/doc/guix.texi:32634
58070 msgid "@code{multiboot-kernel} (default: @code{#f})"
58074 #: guix-git/doc/guix.texi:32638
58075 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:"
58079 #: guix-git/doc/guix.texi:32641
58081 msgid "(file-append mach \"/boot/gnumach\")\n"
58085 #: guix-git/doc/guix.texi:32643
58087 msgid "@code{multiboot-arguments} (default: @code{()})"
58091 #: guix-git/doc/guix.texi:32645
58092 msgid "The list of extra command-line arguments for the multiboot-kernel."
58096 #: guix-git/doc/guix.texi:32646
58098 msgid "@code{multiboot-modules} (default: @code{()})"
58102 #: guix-git/doc/guix.texi:32648
58103 msgid "The list of commands for loading Multiboot modules. For example:"
58107 #: guix-git/doc/guix.texi:32654
58110 "(list (list (file-append hurd \"/hurd/ext2fs.static\") \"ext2fs\"\n"
58112 " (list (file-append libc \"/lib/ld.so.1\") \"exec\"\n"
58117 #: guix-git/doc/guix.texi:32659 guix-git/doc/guix.texi:32718
58123 #: guix-git/doc/guix.texi:32660 guix-git/doc/guix.texi:32719
58129 #: guix-git/doc/guix.texi:32661 guix-git/doc/guix.texi:32720
58134 #. type: Plain text
58135 #: guix-git/doc/guix.texi:32665
58136 msgid "For now only GRUB has theme support. GRUB themes are created using the @code{grub-theme} form, which is not fully documented yet."
58140 #: guix-git/doc/guix.texi:32666
58142 msgid "{Data Type} grub-theme"
58146 #: guix-git/doc/guix.texi:32668
58147 msgid "Data type representing the configuration of the GRUB theme."
58151 #: guix-git/doc/guix.texi:32670
58153 msgid "@code{gfxmode} (default: @code{'(\"auto\")})"
58157 #: guix-git/doc/guix.texi:32673
58158 msgid "The GRUB @code{gfxmode} to set (a list of screen resolution strings, @pxref{gfxmode,,, grub, GNU GRUB manual})."
58162 #: guix-git/doc/guix.texi:32676
58164 msgid "{Scheme Procedure} grub-theme"
58168 #: guix-git/doc/guix.texi:32680
58169 msgid "Return the default GRUB theme used by the operating system if no @code{theme} field is specified in @code{bootloader-configuration} record."
58173 #: guix-git/doc/guix.texi:32683
58174 msgid "It comes with a fancy background image displaying the GNU and Guix logos."
58177 #. type: Plain text
58178 #: guix-git/doc/guix.texi:32687
58179 msgid "For example, to override the default resolution, you may use something like"
58183 #: guix-git/doc/guix.texi:32695
58187 " (bootloader-configuration\n"
58189 " (theme (grub-theme\n"
58190 " (inherit (grub-theme))\n"
58191 " (gfxmode '(\"1024x786x32\" \"auto\"))))))\n"
58195 #: guix-git/doc/guix.texi:32698
58197 msgid "Invoking @code{guix system}"
58200 #. type: Plain text
58201 #: guix-git/doc/guix.texi:32703
58202 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:"
58206 #: guix-git/doc/guix.texi:32706
58208 msgid "guix system @var{options}@dots{} @var{action} @var{file}\n"
58211 #. type: Plain text
58212 #: guix-git/doc/guix.texi:32712
58213 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:"
58217 #: guix-git/doc/guix.texi:32714
58223 #: guix-git/doc/guix.texi:32717
58224 msgid "Display available service type definitions that match the given regular expressions, sorted by relevance:"
58228 #: guix-git/doc/guix.texi:32739
58231 "$ guix system search console\n"
58232 "name: console-fonts\n"
58233 "location: gnu/services/base.scm:806:2\n"
58234 "extends: shepherd-root\n"
58235 "description: Install the given fonts on the specified ttys (fonts are per\n"
58236 "+ virtual console on GNU/Linux). The value of this service is a list of\n"
58237 "+ tty/font pairs. The font can be the name of a font provided by the `kbd'\n"
58238 "+ package or any valid argument to `setfont', as in this example:\n"
58240 "+ '((\"tty1\" . \"LatGrkCyr-8x16\")\n"
58241 "+ (\"tty2\" . (file-append\n"
58243 "+ \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
58244 "+ (\"tty3\" . (file-append\n"
58245 "+ font-terminus\n"
58246 "+ \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
58252 #: guix-git/doc/guix.texi:32745
58256 "location: gnu/services/base.scm:1190:2\n"
58257 "extends: shepherd-root\n"
58258 "description: Provide console login using the `mingetty' program.\n"
58264 #: guix-git/doc/guix.texi:32752
58268 "location: gnu/services/base.scm:860:2\n"
58270 "description: Provide a console log-in service as specified by its\n"
58271 "+ configuration value, a `login-configuration' object.\n"
58277 #: guix-git/doc/guix.texi:32754
58283 #: guix-git/doc/guix.texi:32759
58284 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})."
58288 #: guix-git/doc/guix.texi:32760
58290 msgid "reconfigure"
58294 #: guix-git/doc/guix.texi:32765
58295 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.}."
58299 #: guix-git/doc/guix.texi:32773
58300 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."
58304 #: guix-git/doc/guix.texi:32781
58305 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})."
58309 #: guix-git/doc/guix.texi:32787
58310 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})."
58314 #: guix-git/doc/guix.texi:32792
58315 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."
58319 #: guix-git/doc/guix.texi:32793 guix-git/doc/guix.texi:33118
58320 #: guix-git/doc/guix.texi:34066
58322 msgid "provenance tracking, of the operating system"
58326 #: guix-git/doc/guix.texi:32798
58327 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:"
58331 #: guix-git/doc/guix.texi:32801
58333 msgid "guix system describe\n"
58337 #: guix-git/doc/guix.texi:32807
58338 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:"
58342 #: guix-git/doc/guix.texi:32813
58345 "guix time-machine \\\n"
58346 " -C /var/guix/profiles/system-@var{n}-link/channels.scm -- \\\n"
58347 " system reconfigure \\\n"
58348 " /var/guix/profiles/system-@var{n}-link/configuration.scm\n"
58352 #: guix-git/doc/guix.texi:32819
58353 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."
58357 #: guix-git/doc/guix.texi:32825
58358 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}."
58362 #: guix-git/doc/guix.texi:32826
58364 msgid "switch-generation"
58368 #: guix-git/doc/guix.texi:32835
58369 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."
58373 #: guix-git/doc/guix.texi:32839
58374 msgid "The bootloader itself is not being reinstalled when using this command. Thus, the installed bootloader is used with an updated configuration file."
58378 #: guix-git/doc/guix.texi:32843
58379 msgid "The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to system generation 7:"
58383 #: guix-git/doc/guix.texi:32846
58385 msgid "guix system switch-generation 7\n"
58389 #: guix-git/doc/guix.texi:32854
58390 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:"
58394 #: guix-git/doc/guix.texi:32857
58396 msgid "guix system switch-generation -- -1\n"
58400 #: guix-git/doc/guix.texi:32865
58401 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."
58405 #: guix-git/doc/guix.texi:32867
58406 msgid "This action will fail if the specified generation does not exist."
58410 #: guix-git/doc/guix.texi:32868
58416 #: guix-git/doc/guix.texi:32874
58417 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}."
58421 #: guix-git/doc/guix.texi:32878
58422 msgid "Currently, as with @command{switch-generation}, you must reboot after running this action to actually start using the preceding system generation."
58426 #: guix-git/doc/guix.texi:32879
58428 msgid "delete-generations"
58432 #: guix-git/doc/guix.texi:32880
58434 msgid "deleting system generations"
58438 #: guix-git/doc/guix.texi:32881
58440 msgid "saving space"
58444 #: guix-git/doc/guix.texi:32885
58445 msgid "Delete system generations, making them candidates for garbage collection (@pxref{Invoking guix gc}, for information on how to run the ``garbage collector'')."
58449 #: guix-git/doc/guix.texi:32889
58450 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:"
58454 #: guix-git/doc/guix.texi:32892
58456 msgid "guix system delete-generations\n"
58460 #: guix-git/doc/guix.texi:32896
58461 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:"
58465 #: guix-git/doc/guix.texi:32899
58467 msgid "guix system delete-generations 2m\n"
58471 #: guix-git/doc/guix.texi:32904
58472 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."
58476 #: guix-git/doc/guix.texi:32909
58477 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."
58481 #: guix-git/doc/guix.texi:32910
58487 #: guix-git/doc/guix.texi:32914
58488 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:"
58492 #: guix-git/doc/guix.texi:32917
58494 msgid "guix system init my-os-config.scm /mnt\n"
58498 #: guix-git/doc/guix.texi:32924
58499 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."
58503 #: guix-git/doc/guix.texi:32928
58504 msgid "This command also installs bootloader on the target specified in @file{my-os-config}, unless the @option{--no-bootloader} option was passed."
58508 #: guix-git/doc/guix.texi:32929
58514 #: guix-git/doc/guix.texi:32930 guix-git/doc/guix.texi:33491
58516 msgid "virtual machine"
58520 #: guix-git/doc/guix.texi:32931
58525 #. type: anchor{#1}
58526 #: guix-git/doc/guix.texi:32935
58527 msgid "guix system vm"
58531 #: guix-git/doc/guix.texi:32935
58532 msgid "Build a virtual machine that contains the operating system declared in @var{file}, and return a script to run that virtual machine (VM)."
58536 #: guix-git/doc/guix.texi:32943
58537 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})."
58541 #: guix-git/doc/guix.texi:32948
58542 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:"
58546 #: guix-git/doc/guix.texi:32951
58548 msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -smp 2 -net user,model=virtio-net-pci\n"
58552 #: guix-git/doc/guix.texi:32954
58553 msgid "The VM shares its store with the host system."
58557 #: guix-git/doc/guix.texi:32959
58558 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."
58562 #: guix-git/doc/guix.texi:32963
58563 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:"
58567 #: guix-git/doc/guix.texi:32967
58570 "guix system vm my-config.scm \\\n"
58571 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58575 #: guix-git/doc/guix.texi:32972
58576 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."
58580 #: guix-git/doc/guix.texi:32978
58581 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."
58585 #: guix-git/doc/guix.texi:32979
58587 msgid "System images, creation in various formats"
58591 #: guix-git/doc/guix.texi:32980
58593 msgid "Creating system images in various formats"
58597 #: guix-git/doc/guix.texi:32981
58603 #: guix-git/doc/guix.texi:32982
58605 msgid "docker-image"
58609 #: guix-git/doc/guix.texi:32990
58610 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}."
58614 #: guix-git/doc/guix.texi:32991
58616 msgid "image, creating disk images"
58620 #: guix-git/doc/guix.texi:33003
58621 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:"
58625 #: guix-git/doc/guix.texi:33011
58628 "image=$(guix system image --image-type=qcow2 \\\n"
58629 " gnu/system/examples/lightweight-desktop.tmpl)\n"
58630 "cp $image /tmp/my-image.qcow2\n"
58631 "chmod +w /tmp/my-image.qcow2\n"
58632 "qemu-system-x86_64 -enable-kvm -hda /tmp/my-image.qcow2 -m 1000 \\\n"
58633 " -bios $(guix build ovmf)/share/firmware/ovmf_x64.bin\n"
58637 #: guix-git/doc/guix.texi:33017
58638 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:"
58642 #: guix-git/doc/guix.texi:33020
58644 msgid "# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress\n"
58648 #: guix-git/doc/guix.texi:33024
58649 msgid "The @code{--list-image-types} command lists all the available image types."
58653 #: guix-git/doc/guix.texi:33025
58655 msgid "creating virtual machine images"
58659 #: guix-git/doc/guix.texi:33034
58660 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)."
58664 #: guix-git/doc/guix.texi:33035
58666 msgid "docker-image, creating docker images"
58670 #: guix-git/doc/guix.texi:33041
58671 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:"
58675 #: guix-git/doc/guix.texi:33046
58678 "image_id=\"$(docker load < guix-system-docker-image.tar.gz)\"\n"
58679 "container_id=\"$(docker create $image_id)\"\n"
58680 "docker start $container_id\n"
58684 #: guix-git/doc/guix.texi:33053
58685 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}:"
58689 #: guix-git/doc/guix.texi:33056
58691 msgid "docker exec -ti $container_id /run/current-system/profile/bin/bash --login\n"
58695 #: guix-git/doc/guix.texi:33063
58696 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}."
58700 #: guix-git/doc/guix.texi:33067
58701 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."
58705 #: guix-git/doc/guix.texi:33075
58706 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."
58710 #: guix-git/doc/guix.texi:33079
58711 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."
58715 #: guix-git/doc/guix.texi:33083
58716 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:"
58720 #: guix-git/doc/guix.texi:33087
58723 "guix system container my-config.scm \\\n"
58724 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58728 #: guix-git/doc/guix.texi:33091
58729 msgid "This option requires Linux-libre 3.19 or newer."
58732 #. type: Plain text
58733 #: guix-git/doc/guix.texi:33098
58734 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:"
58738 #: guix-git/doc/guix.texi:33107
58739 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})."
58743 #: guix-git/doc/guix.texi:33112
58744 msgid "Attempt to build for @var{system} instead of the host system type. This works as per @command{guix build} (@pxref{Invoking guix build})."
58748 #: guix-git/doc/guix.texi:33117
58749 msgid "Return the derivation file name of the given operating system without building anything."
58753 #: guix-git/doc/guix.texi:33126
58754 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:"
58758 #: guix-git/doc/guix.texi:33129
58760 msgid "guix system image -t qcow2 --save-provenance config.scm\n"
58764 #: guix-git/doc/guix.texi:33136
58765 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."
58769 #: guix-git/doc/guix.texi:33137
58771 msgid "--image-type=@var{type}"
58775 #: guix-git/doc/guix.texi:33140
58776 msgid "For the @code{image} action, create an image with given @var{type}."
58780 #: guix-git/doc/guix.texi:33143
58781 msgid "When this option is omitted, @command{guix system} uses the @code{efi-raw} image type."
58785 #: guix-git/doc/guix.texi:33144
58787 msgid "ISO-9660 format"
58791 #: guix-git/doc/guix.texi:33145
58793 msgid "CD image format"
58797 #: guix-git/doc/guix.texi:33146
58799 msgid "DVD image format"
58803 #: guix-git/doc/guix.texi:33149
58804 msgid "@option{--image-type=iso9660} produces an ISO-9660 image, suitable for burning on CDs and DVDs."
58808 #: guix-git/doc/guix.texi:33150
58810 msgid "--image-size=@var{size}"
58814 #: guix-git/doc/guix.texi:33155
58815 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})."
58819 #: guix-git/doc/guix.texi:33159
58820 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}."
58824 #: guix-git/doc/guix.texi:33164
58825 msgid "For the @code{container} action, allow containers to access the host network, that is, do not create a network namespace."
58829 #: guix-git/doc/guix.texi:33170
58831 msgid "--skip-checks"
58835 #: guix-git/doc/guix.texi:33172
58836 msgid "Skip pre-installation safety checks."
58840 #: guix-git/doc/guix.texi:33179
58841 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."
58845 #: guix-git/doc/guix.texi:33182
58846 msgid "Instruct @command{guix system reconfigure} to allow system downgrades."
58850 #: guix-git/doc/guix.texi:33190
58851 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."
58855 #: guix-git/doc/guix.texi:33196
58861 #: guix-git/doc/guix.texi:33197
58863 msgid "on-error strategy"
58867 #: guix-git/doc/guix.texi:33198
58869 msgid "error strategy"
58873 #: guix-git/doc/guix.texi:33199
58875 msgid "--on-error=@var{strategy}"
58879 #: guix-git/doc/guix.texi:33202
58880 msgid "Apply @var{strategy} when an error occurs when reading @var{file}. @var{strategy} may be one of the following:"
58884 #: guix-git/doc/guix.texi:33204
58886 msgid "nothing-special"
58890 #: guix-git/doc/guix.texi:33206
58891 msgid "Report the error concisely and exit. This is the default strategy."
58895 #: guix-git/doc/guix.texi:33207
58901 #: guix-git/doc/guix.texi:33209
58902 msgid "Likewise, but also display a backtrace."
58906 #: guix-git/doc/guix.texi:33210
58912 #: guix-git/doc/guix.texi:33216
58913 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."
58916 #. type: Plain text
58917 #: guix-git/doc/guix.texi:33223
58918 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:"
58922 #: guix-git/doc/guix.texi:33226
58928 #: guix-git/doc/guix.texi:33229
58929 msgid "Describe the current system generation: its file name, the kernel and bootloader used, etc., as well as provenance information when available."
58933 #: guix-git/doc/guix.texi:33230
58935 msgid "list-generations"
58939 #: guix-git/doc/guix.texi:33235
58940 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})."
58944 #: guix-git/doc/guix.texi:33240
58945 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:"
58949 #: guix-git/doc/guix.texi:33243
58951 msgid "$ guix system list-generations 10d\n"
58954 #. type: Plain text
58955 #: guix-git/doc/guix.texi:33250
58956 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:"
58959 #. type: anchor{#1}
58960 #: guix-git/doc/guix.texi:33252
58961 msgid "system-extension-graph"
58965 #: guix-git/doc/guix.texi:33254
58967 msgid "extension-graph"
58971 #: guix-git/doc/guix.texi:33261
58972 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}}):"
58976 #: guix-git/doc/guix.texi:33263
58977 msgid "The command:"
58981 #: guix-git/doc/guix.texi:33266
58983 msgid "$ guix system extension-graph @var{file} | xdot -\n"
58987 #: guix-git/doc/guix.texi:33269
58988 msgid "shows the extension relations among services."
58991 #. type: anchor{#1}
58992 #: guix-git/doc/guix.texi:33271
58993 msgid "system-shepherd-graph"
58997 #: guix-git/doc/guix.texi:33271
58999 msgid "shepherd-graph"
59003 #: guix-git/doc/guix.texi:33276
59004 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."
59008 #: guix-git/doc/guix.texi:33279
59009 msgid "Again, the default output format is Dot/Graphviz, but you can pass @option{--graph-backend} to select a different one."
59013 #: guix-git/doc/guix.texi:33283
59015 msgid "Invoking @code{guix deploy}"
59018 #. type: Plain text
59019 #: guix-git/doc/guix.texi:33291
59020 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''."
59024 #: guix-git/doc/guix.texi:33296
59025 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}!"
59029 #: guix-git/doc/guix.texi:33300
59031 msgid "guix deploy @var{file}\n"
59034 #. type: Plain text
59035 #: guix-git/doc/guix.texi:33304
59036 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:"
59040 #: guix-git/doc/guix.texi:33311
59043 ";; This is a Guix deployment of a \"bare bones\" setup, with\n"
59044 ";; no X11 display server, to a machine with an SSH daemon\n"
59045 ";; listening on localhost:2222. A configuration such as this\n"
59046 ";; may be appropriate for virtual machine with ports\n"
59047 ";; forwarded to the host's loopback interface.\n"
59052 #: guix-git/doc/guix.texi:33314
59055 "(use-service-modules networking ssh)\n"
59056 "(use-package-modules bootloaders)\n"
59061 #: guix-git/doc/guix.texi:33335
59064 "(define %system\n"
59065 " (operating-system\n"
59066 " (host-name \"gnu-deployed\")\n"
59067 " (timezone \"Etc/UTC\")\n"
59068 " (bootloader (bootloader-configuration\n"
59069 " (bootloader grub-bootloader)\n"
59070 " (target \"/dev/vda\")\n"
59071 " (terminal-outputs '(console))))\n"
59072 " (file-systems (cons (file-system\n"
59073 " (mount-point \"/\")\n"
59074 " (device \"/dev/vda1\")\n"
59075 " (type \"ext4\"))\n"
59076 " %base-file-systems))\n"
59078 " (append (list (service dhcp-client-service-type)\n"
59079 " (service openssh-service-type\n"
59080 " (openssh-configuration\n"
59081 " (permit-root-login #t)\n"
59082 " (allow-empty-passwords? #t))))\n"
59083 " %base-services))))\n"
59088 #: guix-git/doc/guix.texi:33345
59092 " (operating-system %system)\n"
59093 " (environment managed-host-environment-type)\n"
59094 " (configuration (machine-ssh-configuration\n"
59095 " (host-name \"localhost\")\n"
59096 " (system \"x86_64-linux\")\n"
59097 " (user \"alice\")\n"
59098 " (identity \"./id_rsa\")\n"
59099 " (port 2222)))))\n"
59102 #. type: Plain text
59103 #: guix-git/doc/guix.texi:33358
59104 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."
59107 #. type: Plain text
59108 #: guix-git/doc/guix.texi:33363
59109 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:"
59112 #. type: Plain text
59113 #: guix-git/doc/guix.texi:33371
59114 msgid "Each target machine must authorize the key of the master machine so that it accepts store items it receives from the coordinator:"
59118 #: guix-git/doc/guix.texi:33374
59120 msgid "# guix archive --authorize < coordinator-public-key.txt\n"
59123 #. type: Plain text
59124 #: guix-git/doc/guix.texi:33385
59125 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:"
59129 #: guix-git/doc/guix.texi:33389
59132 "(use-modules ...\n"
59133 " (gnu system)) ;for %sudoers-specification\n"
59138 #: guix-git/doc/guix.texi:33391
59141 "(define %user \"username\")\n"
59146 #: guix-git/doc/guix.texi:33399
59149 "(operating-system\n"
59152 " (plain-file \"sudoers\"\n"
59153 " (string-append (plain-file-content %sudoers-specification)\n"
59154 " (format #f \"~a ALL = NOPASSWD: ALL~%\"\n"
59159 #. type: Plain text
59160 #: guix-git/doc/guix.texi:33404
59161 msgid "For more information regarding the format of the @file{sudoers} file, consult @command{man sudoers}."
59165 #: guix-git/doc/guix.texi:33405
59167 msgid "{Data Type} machine"
59171 #: guix-git/doc/guix.texi:33408
59172 msgid "This is the data type representing a single machine in a heterogeneous Guix deployment."
59176 #: guix-git/doc/guix.texi:33412
59177 msgid "The object of the operating system configuration to deploy."
59181 #: guix-git/doc/guix.texi:33413
59183 msgid "environment"
59187 #: guix-git/doc/guix.texi:33415
59188 msgid "An @code{environment-type} describing how the machine should be provisioned."
59192 #: guix-git/doc/guix.texi:33416
59194 msgid "@code{configuration} (default: @code{#f})"
59198 #: guix-git/doc/guix.texi:33421
59199 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."
59203 #: guix-git/doc/guix.texi:33424
59205 msgid "{Data Type} machine-ssh-configuration"
59209 #: guix-git/doc/guix.texi:33427
59210 msgid "This is the data type representing the SSH client parameters for a machine with an @code{environment} of @code{managed-host-environment-type}."
59214 #: guix-git/doc/guix.texi:33430
59216 msgid "@code{build-locally?} (default: @code{#t})"
59220 #: guix-git/doc/guix.texi:33432
59221 msgid "If false, system derivations will be built on the machine being deployed to."
59225 #: guix-git/doc/guix.texi:33432
59231 #: guix-git/doc/guix.texi:33435
59232 msgid "The system type describing the architecture of the machine being deployed to---e.g., @code{\"x86_64-linux\"}."
59236 #: guix-git/doc/guix.texi:33435
59238 msgid "@code{authorize?} (default: @code{#t})"
59242 #: guix-git/doc/guix.texi:33438
59243 msgid "If true, the coordinator's signing key will be added to the remote's ACL keyring."
59247 #: guix-git/doc/guix.texi:33439
59249 msgid "@code{user} (default: @code{\"root\"})"
59253 #: guix-git/doc/guix.texi:33440
59255 msgid "@code{identity} (default: @code{#f})"
59259 #: guix-git/doc/guix.texi:33443
59260 msgid "If specified, the path to the SSH private key to use to authenticate with the remote host."
59264 #: guix-git/doc/guix.texi:33444
59266 msgid "@code{host-key} (default: @code{#f})"
59270 #: guix-git/doc/guix.texi:33446
59271 msgid "This should be the SSH host key of the machine, which looks like this:"
59275 #: guix-git/doc/guix.texi:33449
59277 msgid "ssh-ed25519 AAAAC3Nz@dots{} root@@example.org\n"
59281 #: guix-git/doc/guix.texi:33454
59282 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."
59286 #: guix-git/doc/guix.texi:33455
59288 msgid "@code{allow-downgrades?} (default: @code{#f})"
59292 #: guix-git/doc/guix.texi:33457
59293 msgid "Whether to allow potential downgrades."
59297 #: guix-git/doc/guix.texi:33465
59298 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."
59302 #: guix-git/doc/guix.texi:33468
59304 msgid "{Data Type} digital-ocean-configuration"
59308 #: guix-git/doc/guix.texi:33471
59309 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}."
59313 #: guix-git/doc/guix.texi:33473
59319 #: guix-git/doc/guix.texi:33476
59320 msgid "The path to the SSH private key to use to authenticate with the remote host. In the future, this field may not exist."
59324 #: guix-git/doc/guix.texi:33476
59330 #: guix-git/doc/guix.texi:33479
59331 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."
59335 #: guix-git/doc/guix.texi:33479
59341 #: guix-git/doc/guix.texi:33481
59342 msgid "A Digital Ocean region slug, such as @code{\"nyc3\"}."
59346 #: guix-git/doc/guix.texi:33483
59347 msgid "A Digital Ocean size slug, such as @code{\"s-1vcpu-1gb\"}"
59351 #: guix-git/doc/guix.texi:33483
59353 msgid "enable-ipv6?"
59357 #: guix-git/doc/guix.texi:33485
59358 msgid "Whether or not the droplet should be created with IPv6 networking."
59362 #: guix-git/doc/guix.texi:33489
59364 msgid "Running Guix in a Virtual Machine"
59367 #. type: Plain text
59368 #: guix-git/doc/guix.texi:33498
59369 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.qcow2}. 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)."
59372 #. type: Plain text
59373 #: guix-git/doc/guix.texi:33505
59374 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})."
59377 #. type: Plain text
59378 #: guix-git/doc/guix.texi:33510
59379 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."
59383 #: guix-git/doc/guix.texi:33511
59388 #. type: Plain text
59389 #: guix-git/doc/guix.texi:33518
59390 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:"
59394 #: guix-git/doc/guix.texi:33525
59397 "$ qemu-system-x86_64 \\\n"
59398 " -nic user,model=virtio-net-pci \\\n"
59399 " -enable-kvm -m 1024 \\\n"
59400 " -device virtio-blk,drive=myhd \\\n"
59401 " -drive if=none,file=/tmp/qemu-image,id=myhd\n"
59404 #. type: Plain text
59405 #: guix-git/doc/guix.texi:33528
59406 msgid "Here is what each of these options means:"
59410 #: guix-git/doc/guix.texi:33530
59412 msgid "qemu-system-x86_64"
59416 #: guix-git/doc/guix.texi:33533
59417 msgid "This specifies the hardware platform to emulate. This should match the host."
59421 #: guix-git/doc/guix.texi:33534
59423 msgid "-nic user,model=virtio-net-pci"
59427 #: guix-git/doc/guix.texi:33542
59428 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}."
59432 #: guix-git/doc/guix.texi:33543
59434 msgid "-enable-kvm"
59438 #: guix-git/doc/guix.texi:33547
59439 msgid "If your system has hardware virtualization extensions, enabling the virtual machine support (KVM) of the Linux kernel will make things run faster."
59443 #: guix-git/doc/guix.texi:33549
59449 #: guix-git/doc/guix.texi:33552
59450 msgid "RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, which may be insufficient for some operations."
59454 #: guix-git/doc/guix.texi:33553
59456 msgid "-device virtio-blk,drive=myhd"
59460 #: guix-git/doc/guix.texi:33558
59461 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."
59465 #: guix-git/doc/guix.texi:33559
59467 msgid "-drive if=none,file=/tmp/qemu-image,id=myhd"
59471 #: guix-git/doc/guix.texi:33562
59472 msgid "Use our QCOW image, the @file{/tmp/qemu-image} file, as the backing store of the ``myhd'' drive."
59475 #. type: Plain text
59476 #: guix-git/doc/guix.texi:33572
59477 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}."
59480 #. type: subsection
59481 #: guix-git/doc/guix.texi:33573
59483 msgid "Connecting Through SSH"
59486 #. type: Plain text
59487 #: guix-git/doc/guix.texi:33581
59488 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"
59492 #: guix-git/doc/guix.texi:33584
59494 msgid "$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22\n"
59497 #. type: Plain text
59498 #: guix-git/doc/guix.texi:33587
59499 msgid "To connect to the VM you can run"
59503 #: guix-git/doc/guix.texi:33590
59505 msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost\n"
59508 #. type: Plain text
59509 #: guix-git/doc/guix.texi:33597
59510 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."
59513 #. type: subsection
59514 #: guix-git/doc/guix.texi:33598
59516 msgid "Using @command{virt-viewer} with Spice"
59519 #. type: Plain text
59520 #: guix-git/doc/guix.texi:33604
59521 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."
59524 #. type: Plain text
59525 #: guix-git/doc/guix.texi:33607
59526 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}:"
59530 #: guix-git/doc/guix.texi:33613
59533 "-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5\n"
59534 "-chardev spicevmc,name=vdagent,id=vdagent\n"
59535 "-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\n"
59536 "name=com.redhat.spice.0\n"
59539 #. type: Plain text
59540 #: guix-git/doc/guix.texi:33617
59541 msgid "You'll also need to add the @code{(spice-vdagent-service)} to your system definition (@pxref{Miscellaneous Services, Spice service})."
59544 #. type: Plain text
59545 #: guix-git/doc/guix.texi:33624
59546 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?"
59550 #: guix-git/doc/guix.texi:33636
59555 #. type: Plain text
59556 #: guix-git/doc/guix.texi:33649
59557 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."
59561 #: guix-git/doc/guix.texi:33650
59563 msgid "service extensions"
59566 #. type: Plain text
59567 #: guix-git/doc/guix.texi:33662
59568 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})."
59571 #. type: Plain text
59572 #: guix-git/doc/guix.texi:33666
59573 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:"
59576 #. type: Plain text
59577 #: guix-git/doc/guix.texi:33668
59578 msgid "@image{images/service-graph,,5in,Typical service extension graph.}"
59582 #: guix-git/doc/guix.texi:33669
59584 msgid "system service"
59587 #. type: Plain text
59588 #: guix-git/doc/guix.texi:33677
59589 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."
59593 #: guix-git/doc/guix.texi:33678
59595 msgid "service types"
59598 #. type: Plain text
59599 #: guix-git/doc/guix.texi:33684
59600 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."
59603 #. type: Plain text
59604 #: guix-git/doc/guix.texi:33687
59605 msgid "The following section describes the programming interface for service types and services."
59608 #. type: Plain text
59609 #: guix-git/doc/guix.texi:33694
59610 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}):"
59614 #: guix-git/doc/guix.texi:33704
59617 "(define guix-service-type\n"
59621 " (list (service-extension shepherd-root-service-type guix-shepherd-service)\n"
59622 " (service-extension account-service-type guix-accounts)\n"
59623 " (service-extension activation-service-type guix-activation)))\n"
59624 " (default-value (guix-configuration))))\n"
59627 #. type: Plain text
59628 #: guix-git/doc/guix.texi:33708
59629 msgid "It defines three things:"
59633 #: guix-git/doc/guix.texi:33712
59634 msgid "A name, whose sole purpose is to make inspection and debugging easier."
59638 #: guix-git/doc/guix.texi:33717
59639 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."
59643 #: guix-git/doc/guix.texi:33720
59644 msgid "Every service type has at least one service extension. The only exception is the @dfn{boot service type}, which is the ultimate service."
59648 #: guix-git/doc/guix.texi:33723
59649 msgid "Optionally, a default value for instances of this type."
59652 #. type: Plain text
59653 #: guix-git/doc/guix.texi:33726
59654 msgid "In this example, @code{guix-service-type} extends three services:"
59658 #: guix-git/doc/guix.texi:33728
59660 msgid "shepherd-root-service-type"
59664 #: guix-git/doc/guix.texi:33733
59665 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})."
59669 #: guix-git/doc/guix.texi:33734
59671 msgid "account-service-type"
59675 #: guix-git/doc/guix.texi:33739
59676 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})."
59680 #: guix-git/doc/guix.texi:33740
59682 msgid "activation-service-type"
59686 #: guix-git/doc/guix.texi:33744
59687 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."
59690 #. type: Plain text
59691 #: guix-git/doc/guix.texi:33747
59692 msgid "A service of this type is instantiated like this:"
59696 #: guix-git/doc/guix.texi:33753
59699 "(service guix-service-type\n"
59700 " (guix-configuration\n"
59701 " (build-accounts 5)\n"
59702 " (extra-options '(\"--gc-keep-derivations\"))))\n"
59705 #. type: Plain text
59706 #: guix-git/doc/guix.texi:33761
59707 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:"
59711 #: guix-git/doc/guix.texi:33764
59713 msgid "(service guix-service-type)\n"
59716 #. type: Plain text
59717 #: guix-git/doc/guix.texi:33768
59718 msgid "@code{guix-service-type} is quite simple because it extends other services but is not extensible itself."
59721 #. type: Plain text
59722 #: guix-git/doc/guix.texi:33772
59723 msgid "The service type for an @emph{extensible} service looks like this:"
59727 #: guix-git/doc/guix.texi:33779
59730 "(define udev-service-type\n"
59731 " (service-type (name 'udev)\n"
59733 " (list (service-extension shepherd-root-service-type\n"
59734 " udev-shepherd-service)))\n"
59739 #: guix-git/doc/guix.texi:33787
59742 " (compose concatenate) ;concatenate the list of rules\n"
59743 " (extend (lambda (config rules)\n"
59745 " (($ <udev-configuration> udev initial-rules)\n"
59746 " (udev-configuration\n"
59747 " (udev udev) ;the udev package to use\n"
59748 " (rules (append initial-rules rules)))))))))\n"
59751 #. type: Plain text
59752 #: guix-git/doc/guix.texi:33793
59753 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:"
59757 #: guix-git/doc/guix.texi:33795
59763 #: guix-git/doc/guix.texi:33798
59764 msgid "This is the procedure to @dfn{compose} the list of extensions to services of this type."
59768 #: guix-git/doc/guix.texi:33801
59769 msgid "Services can extend the udev service by passing it lists of rules; we compose those extensions simply by concatenating them."
59773 #: guix-git/doc/guix.texi:33802
59779 #: guix-git/doc/guix.texi:33805
59780 msgid "This procedure defines how the value of the service is @dfn{extended} with the composition of the extensions."
59784 #: guix-git/doc/guix.texi:33810
59785 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."
59789 #: guix-git/doc/guix.texi:33816
59790 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})."
59793 #. type: Plain text
59794 #: guix-git/doc/guix.texi:33821
59795 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."
59798 #. type: Plain text
59799 #: guix-git/doc/guix.texi:33824
59800 msgid "Still here? The next section provides a reference of the programming interface for services."
59803 #. type: Plain text
59804 #: guix-git/doc/guix.texi:33832
59805 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."
59809 #: guix-git/doc/guix.texi:33833
59811 msgid "{Scheme Procedure} service @var{type} [@var{value}]"
59815 #: guix-git/doc/guix.texi:33837
59816 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."
59820 #: guix-git/doc/guix.texi:33841
59821 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."
59825 #: guix-git/doc/guix.texi:33843
59826 msgid "For instance, this:"
59830 #: guix-git/doc/guix.texi:33846
59832 msgid "(service openssh-service-type)\n"
59836 #: guix-git/doc/guix.texi:33850
59837 msgid "is equivalent to this:"
59841 #: guix-git/doc/guix.texi:33854
59844 "(service openssh-service-type\n"
59845 " (openssh-configuration))\n"
59849 #: guix-git/doc/guix.texi:33858
59850 msgid "In both cases the result is an instance of @code{openssh-service-type} with the default configuration."
59854 #: guix-git/doc/guix.texi:33860
59856 msgid "{Scheme Procedure} service? @var{obj}"
59860 #: guix-git/doc/guix.texi:33862
59861 msgid "Return true if @var{obj} is a service."
59865 #: guix-git/doc/guix.texi:33864
59867 msgid "{Scheme Procedure} service-kind @var{service}"
59871 #: guix-git/doc/guix.texi:33866
59872 msgid "Return the type of @var{service}---i.e., a @code{<service-type>} object."
59876 #: guix-git/doc/guix.texi:33868
59878 msgid "{Scheme Procedure} service-value @var{service}"
59882 #: guix-git/doc/guix.texi:33871
59883 msgid "Return the value associated with @var{service}. It represents its parameters."
59886 #. type: Plain text
59887 #: guix-git/doc/guix.texi:33874
59888 msgid "Here is an example of how a service is created and manipulated:"
59892 #: guix-git/doc/guix.texi:33883
59896 " (service nginx-service-type\n"
59897 " (nginx-configuration\n"
59899 " (log-directory log-directory)\n"
59900 " (run-directory run-directory)\n"
59901 " (file config-file))))\n"
59906 #: guix-git/doc/guix.texi:33886
59915 #: guix-git/doc/guix.texi:33889
59918 "(eq? (service-kind s) nginx-service-type)\n"
59922 #. type: Plain text
59923 #: guix-git/doc/guix.texi:33899
59924 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."
59928 #: guix-git/doc/guix.texi:33900
59930 msgid "{Scheme Syntax} modify-services @var{services} @"
59934 #: guix-git/doc/guix.texi:33902
59935 msgid "(@var{type} @var{variable} => @var{body}) @dots{}"
59939 #: guix-git/doc/guix.texi:33905
59940 msgid "Modify the services listed in @var{services} according to the given clauses. Each clause has the form:"
59944 #: guix-git/doc/guix.texi:33908
59946 msgid "(@var{type} @var{variable} => @var{body})\n"
59950 #: guix-git/doc/guix.texi:33915
59951 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}."
59955 #: guix-git/doc/guix.texi:33922
59956 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."
59960 #: guix-git/doc/guix.texi:33924
59961 msgid "@xref{Using the Configuration System}, for example usage."
59964 #. type: Plain text
59965 #: guix-git/doc/guix.texi:33931
59966 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."
59970 #: guix-git/doc/guix.texi:33932
59972 msgid "{Data Type} service-type"
59976 #: guix-git/doc/guix.texi:33933
59978 msgid "service type"
59982 #: guix-git/doc/guix.texi:33936
59983 msgid "This is the representation of a @dfn{service type} (@pxref{Service Types and Services})."
59987 #: guix-git/doc/guix.texi:33940
59988 msgid "This is a symbol, used only to simplify inspection and debugging."
59992 #: guix-git/doc/guix.texi:33941
59998 #: guix-git/doc/guix.texi:33943
59999 msgid "A non-empty list of @code{<service-extension>} objects (see below)."
60003 #: guix-git/doc/guix.texi:33944
60005 msgid "@code{compose} (default: @code{#f})"
60009 #: guix-git/doc/guix.texi:33948
60010 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."
60014 #: guix-git/doc/guix.texi:33952
60015 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."
60019 #: guix-git/doc/guix.texi:33953
60021 msgid "@code{extend} (default: @code{#f})"
60025 #: guix-git/doc/guix.texi:33955
60026 msgid "If this is @code{#f}, services of this type cannot be extended."
60030 #: guix-git/doc/guix.texi:33961
60031 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."
60035 #: guix-git/doc/guix.texi:33967
60036 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})."
60040 #: guix-git/doc/guix.texi:33968
60042 msgid "@code{default-value} (default: @code{&no-default-value})"
60046 #: guix-git/doc/guix.texi:33971
60047 msgid "The default value associated for instances of this service type. This allows users to use the @code{service} form without its second argument:"
60051 #: guix-git/doc/guix.texi:33974
60053 msgid "(service @var{type})\n"
60057 #: guix-git/doc/guix.texi:33978
60058 msgid "The returned service in this case has the default value specified by @var{type}."
60062 #: guix-git/doc/guix.texi:33981
60063 msgid "@xref{Service Types and Services}, for examples."
60067 #: guix-git/doc/guix.texi:33983
60069 msgid "{Scheme Procedure} service-extension @var{target-type} @"
60073 #: guix-git/doc/guix.texi:33989
60074 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."
60078 #: guix-git/doc/guix.texi:33991
60080 msgid "{Scheme Procedure} service-extension? @var{obj}"
60084 #: guix-git/doc/guix.texi:33993
60085 msgid "Return true if @var{obj} is a service extension."
60088 #. type: Plain text
60089 #: guix-git/doc/guix.texi:33999
60090 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."
60094 #: guix-git/doc/guix.texi:34000
60096 msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}"
60100 #: guix-git/doc/guix.texi:34004
60101 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."
60105 #: guix-git/doc/guix.texi:34007
60106 msgid "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an additional job:"
60110 #: guix-git/doc/guix.texi:34011
60113 "(simple-service 'my-mcron-job mcron-service-type\n"
60114 " #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n"
60117 #. type: Plain text
60118 #: guix-git/doc/guix.texi:34021
60119 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."
60123 #: guix-git/doc/guix.texi:34022
60125 msgid "{Scheme Procedure} fold-services @var{services} @"
60129 #: guix-git/doc/guix.texi:34026
60130 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."
60133 #. type: Plain text
60134 #: guix-git/doc/guix.texi:34030
60135 msgid "Lastly, the @code{(gnu services)} module also defines several essential service types, some of which are listed below."
60139 #: guix-git/doc/guix.texi:34031
60141 msgid "{Scheme Variable} system-service-type"
60145 #: guix-git/doc/guix.texi:34034
60146 msgid "This is the root of the service graph. It produces the system directory as returned by the @command{guix system build} command."
60150 #: guix-git/doc/guix.texi:34036
60152 msgid "{Scheme Variable} boot-service-type"
60156 #: guix-git/doc/guix.texi:34039
60157 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."
60161 #: guix-git/doc/guix.texi:34041
60163 msgid "{Scheme Variable} etc-service-type"
60167 #: guix-git/doc/guix.texi:34045
60168 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:"
60172 #: guix-git/doc/guix.texi:34048
60174 msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n"
60178 #: guix-git/doc/guix.texi:34052
60179 msgid "In this example, the effect would be to add an @file{/etc/issue} file pointing to the given file."
60183 #: guix-git/doc/guix.texi:34054
60185 msgid "{Scheme Variable} setuid-program-service-type"
60189 #: guix-git/doc/guix.texi:34058
60190 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})."
60194 #: guix-git/doc/guix.texi:34060
60196 msgid "{Scheme Variable} profile-service-type"
60200 #: guix-git/doc/guix.texi:34064
60201 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."
60204 #. type: anchor{#1}
60205 #: guix-git/doc/guix.texi:34068
60206 msgid "provenance-service-type"
60210 #: guix-git/doc/guix.texi:34068
60212 msgid "{Scheme Variable} provenance-service-type"
60216 #: guix-git/doc/guix.texi:34072
60217 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}:"
60221 #: guix-git/doc/guix.texi:34074
60223 msgid "channels.scm"
60227 #: guix-git/doc/guix.texi:34079
60228 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})."
60232 #: guix-git/doc/guix.texi:34080
60234 msgid "configuration.scm"
60238 #: guix-git/doc/guix.texi:34085
60239 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."
60243 #: guix-git/doc/guix.texi:34086
60249 #: guix-git/doc/guix.texi:34089
60250 msgid "This contains the same information as the two other files but in a format that is more readily processable."
60254 #: guix-git/doc/guix.texi:34093
60255 msgid "In general, these two pieces of information (channels and configuration file) are enough to reproduce the operating system ``from source''."
60259 #: guix-git/doc/guix.texi:34094
60265 #: guix-git/doc/guix.texi:34101
60266 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."
60270 #: guix-git/doc/guix.texi:34109
60271 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."
60275 #: guix-git/doc/guix.texi:34114
60276 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}."
60280 #: guix-git/doc/guix.texi:34119
60282 msgid "shepherd services"
60286 #: guix-git/doc/guix.texi:34120
60292 #: guix-git/doc/guix.texi:34121
60294 msgid "init system"
60297 #. type: Plain text
60298 #: guix-git/doc/guix.texi:34127
60299 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})."
60302 #. type: Plain text
60303 #: guix-git/doc/guix.texi:34133
60304 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:"
60307 #. type: Plain text
60308 #: guix-git/doc/guix.texi:34135
60309 msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}"
60312 #. type: Plain text
60313 #: guix-git/doc/guix.texi:34139
60314 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}})."
60317 #. type: Plain text
60318 #: guix-git/doc/guix.texi:34143
60319 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."
60323 #: guix-git/doc/guix.texi:34144
60325 msgid "{Data Type} shepherd-service"
60329 #: guix-git/doc/guix.texi:34146
60330 msgid "The data type representing a service managed by the Shepherd."
60334 #: guix-git/doc/guix.texi:34148
60340 #: guix-git/doc/guix.texi:34150
60341 msgid "This is a list of symbols denoting what the service provides."
60345 #: guix-git/doc/guix.texi:34155
60346 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."
60350 #: guix-git/doc/guix.texi:34156
60352 msgid "@code{requirement} (default: @code{'()})"
60356 #: guix-git/doc/guix.texi:34158
60357 msgid "List of symbols denoting the Shepherd services this one depends on."
60361 #: guix-git/doc/guix.texi:34159
60363 msgid "one-shot services, for the Shepherd"
60367 #: guix-git/doc/guix.texi:34164
60368 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."
60372 #: guix-git/doc/guix.texi:34165
60374 msgid "@code{respawn?} (default: @code{#t})"
60378 #: guix-git/doc/guix.texi:34168
60379 msgid "Whether to restart the service when it stops, for instance when the underlying process dies."
60383 #: guix-git/doc/guix.texi:34169
60389 #: guix-git/doc/guix.texi:34170
60391 msgid "@code{stop} (default: @code{#~(const #f)})"
60395 #: guix-git/doc/guix.texi:34176
60396 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})."
60400 #: guix-git/doc/guix.texi:34177
60402 msgid "@code{actions} (default: @code{'()})"
60406 #: guix-git/doc/guix.texi:34178
60408 msgid "actions, of Shepherd services"
60412 #: guix-git/doc/guix.texi:34183
60413 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:"
60417 #: guix-git/doc/guix.texi:34186
60419 msgid "herd @var{action} @var{service} [@var{arguments}@dots{}]\n"
60423 #: guix-git/doc/guix.texi:34188
60425 msgid "@code{auto-start?} (default: @code{#t})"
60429 #: guix-git/doc/guix.texi:34191
60430 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}."
60434 #: guix-git/doc/guix.texi:34194
60435 msgid "A documentation string, as shown when running:"
60439 #: guix-git/doc/guix.texi:34197
60441 msgid "herd doc @var{service-name}\n"
60445 #: guix-git/doc/guix.texi:34201
60446 msgid "where @var{service-name} is one of the symbols in @code{provision} (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})."
60450 #: guix-git/doc/guix.texi:34202
60452 msgid "@code{modules} (default: @code{%default-modules})"
60456 #: guix-git/doc/guix.texi:34205
60457 msgid "This is the list of modules that must be in scope when @code{start} and @code{stop} are evaluated."
60460 #. type: Plain text
60461 #: guix-git/doc/guix.texi:34213
60462 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}):"
60466 #: guix-git/doc/guix.texi:34225
60469 "(let ((config (plain-file \"syslogd.conf\" \"@dots{}\")))\n"
60470 " (shepherd-service\n"
60471 " (documentation \"Run the syslog daemon (syslogd).\")\n"
60472 " (provision '(syslogd))\n"
60473 " (requirement '(user-processes))\n"
60474 " (start #~(make-forkexec-constructor\n"
60475 " (list #$(file-append inetutils \"/libexec/syslogd\")\n"
60476 " \"--rcfile\" #$config)\n"
60477 " #:pid-file \"/var/run/syslog.pid\"))\n"
60478 " (stop #~(make-kill-destructor))))\n"
60481 #. type: Plain text
60482 #: guix-git/doc/guix.texi:34240
60483 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})."
60487 #: guix-git/doc/guix.texi:34241
60489 msgid "{Data Type} shepherd-action"
60493 #: guix-git/doc/guix.texi:34244
60494 msgid "This is the data type that defines additional actions implemented by a Shepherd service (see above)."
60498 #: guix-git/doc/guix.texi:34248
60499 msgid "Symbol naming the action."
60503 #: guix-git/doc/guix.texi:34251
60504 msgid "This is a documentation string for the action. It can be viewed by running:"
60508 #: guix-git/doc/guix.texi:34254
60510 msgid "herd doc @var{service} action @var{action}\n"
60514 #: guix-git/doc/guix.texi:34256
60520 #: guix-git/doc/guix.texi:34260
60521 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})."
60525 #: guix-git/doc/guix.texi:34264
60526 msgid "The following example defines an action called @code{say-hello} that kindly greets the user:"
60530 #: guix-git/doc/guix.texi:34273
60533 "(shepherd-action\n"
60534 " (name 'say-hello)\n"
60535 " (documentation \"Say hi!\")\n"
60536 " (procedure #~(lambda (running . args)\n"
60537 " (format #t \"Hello, friend! arguments: ~s\\n\"\n"
60543 #: guix-git/doc/guix.texi:34276
60544 msgid "Assuming this action is added to the @code{example} service, then you can do:"
60548 #: guix-git/doc/guix.texi:34282
60551 "# herd say-hello example\n"
60552 "Hello, friend! arguments: ()\n"
60553 "# herd say-hello example a b c\n"
60554 "Hello, friend! arguments: (\"a\" \"b\" \"c\")\n"
60558 #: guix-git/doc/guix.texi:34287
60559 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."
60563 #: guix-git/doc/guix.texi:34289
60565 msgid "{Scheme Variable} shepherd-root-service-type"
60569 #: guix-git/doc/guix.texi:34291
60570 msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1."
60574 #: guix-git/doc/guix.texi:34296
60575 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."
60579 #: guix-git/doc/guix.texi:34298
60581 msgid "{Data Type} shepherd-configuration"
60585 #: guix-git/doc/guix.texi:34300
60586 msgid "This data type represents the Shepherd's configuration."
60590 #: guix-git/doc/guix.texi:34302
60592 msgid "shepherd (default: @code{shepherd})"
60596 #: guix-git/doc/guix.texi:34304
60597 msgid "The Shepherd package to use."
60601 #: guix-git/doc/guix.texi:34305
60603 msgid "services (default: @code{'()})"
60607 #: guix-git/doc/guix.texi:34309
60608 msgid "A list of @code{<shepherd-service>} to start. You should probably use the service extension mechanism instead (@pxref{Shepherd Services})."
60611 #. type: Plain text
60612 #: guix-git/doc/guix.texi:34314
60613 msgid "The following example specifies the Shepherd package for the operating system:"
60617 #: guix-git/doc/guix.texi:34329
60620 "(operating-system\n"
60622 " (services (append (list openssh-service-type))\n"
60624 " %desktop-services)\n"
60626 " ;; Use own Shepherd package.\n"
60627 " (essential-services\n"
60628 " (modify-services (operating-system-default-essential-services\n"
60629 " this-operating-system)\n"
60630 " (shepherd-root-service-type config => (shepherd-configuration\n"
60631 " (inherit config)\n"
60632 " (shepherd my-shepherd))))))\n"
60636 #: guix-git/doc/guix.texi:34331
60638 msgid "{Scheme Variable} %shepherd-root-service"
60642 #: guix-git/doc/guix.texi:34333
60643 msgid "This service represents PID@tie{}1."
60647 #: guix-git/doc/guix.texi:34339
60649 msgid "documentation, searching for"
60653 #: guix-git/doc/guix.texi:34340
60655 msgid "searching for documentation"
60659 #: guix-git/doc/guix.texi:34341
60661 msgid "Info, documentation format"
60665 #: guix-git/doc/guix.texi:34342
60671 #: guix-git/doc/guix.texi:34343
60673 msgid "manual pages"
60676 #. type: Plain text
60677 #: guix-git/doc/guix.texi:34350
60678 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}."
60681 #. type: Plain text
60682 #: guix-git/doc/guix.texi:34354
60683 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:"
60687 #: guix-git/doc/guix.texi:34362
60691 "\"(emacs)Network Security\" -- STARTTLS\n"
60692 "\"(emacs)Network Security\" -- TLS\n"
60693 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_flags\n"
60694 "\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_function\n"
60698 #. type: Plain text
60699 #: guix-git/doc/guix.texi:34366
60700 msgid "The command below searches for the same keyword in man pages:"
60704 #: guix-git/doc/guix.texi:34372
60708 "SSL (7) - OpenSSL SSL/TLS library\n"
60709 "certtool (1) - GnuTLS certificate tool\n"
60713 #. type: Plain text
60714 #: guix-git/doc/guix.texi:34378
60715 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."
60718 #. type: Plain text
60719 #: guix-git/doc/guix.texi:34381
60720 msgid "Once you have these results, you can view the relevant documentation by running, say:"
60724 #: guix-git/doc/guix.texi:34384
60726 msgid "$ info \"(gnutls)Core TLS API\"\n"
60729 #. type: Plain text
60730 #: guix-git/doc/guix.texi:34388
60735 #: guix-git/doc/guix.texi:34391
60737 msgid "$ man certtool\n"
60740 #. type: Plain text
60741 #: guix-git/doc/guix.texi:34399
60742 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."
60746 #: guix-git/doc/guix.texi:34403
60748 msgid "debugging files"
60751 #. type: Plain text
60752 #: guix-git/doc/guix.texi:34409
60753 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."
60756 #. type: Plain text
60757 #: guix-git/doc/guix.texi:34413
60758 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."
60761 #. type: Plain text
60762 #: guix-git/doc/guix.texi:34429
60763 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})."
60766 #. type: Plain text
60767 #: guix-git/doc/guix.texi:34436
60768 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})."
60771 #. type: Plain text
60772 #: guix-git/doc/guix.texi:34444
60773 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:"
60777 #: guix-git/doc/guix.texi:34447
60779 msgid "guix install glibc:debug guile:debug\n"
60782 #. type: Plain text
60783 #: guix-git/doc/guix.texi:34453
60784 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}):"
60788 #: guix-git/doc/guix.texi:34456
60790 msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n"
60793 #. type: Plain text
60794 #: guix-git/doc/guix.texi:34460
60795 msgid "From there on, GDB will pick up debugging information from the @file{.debug} files under @file{~/.guix-profile/lib/debug}."
60798 #. type: Plain text
60799 #: guix-git/doc/guix.texi:34467
60800 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})."
60803 #. type: Plain text
60804 #: guix-git/doc/guix.texi:34475
60805 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})."
60808 #. type: Plain text
60809 #: guix-git/doc/guix.texi:34477
60810 msgid "Read on for how to deal with packages lacking a @code{debug} output."
60813 #. type: Plain text
60814 #: guix-git/doc/guix.texi:34489
60815 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."
60818 #. type: Plain text
60819 #: guix-git/doc/guix.texi:34494
60820 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:"
60824 #: guix-git/doc/guix.texi:34505
60828 "#0 0x00007ffff5f92190 in g_getenv ()\n"
60829 " from /gnu/store/@dots{}-glib-2.62.6/lib/libglib-2.0.so.0\n"
60830 "#1 0x00007ffff608a7d6 in gobject_init_ctor ()\n"
60831 " from /gnu/store/@dots{}-glib-2.62.6/lib/libgobject-2.0.so.0\n"
60832 "#2 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=1, argv=argv@@entry=0x7fffffffcfd8, \n"
60833 " env=env@@entry=0x7fffffffcfe8) at dl-init.c:72\n"
60834 "#3 0x00007ffff7fe2866 in call_init (env=0x7fffffffcfe8, argv=0x7fffffffcfd8, argc=1, l=<optimized out>)\n"
60835 " at dl-init.c:118\n"
60838 #. type: Plain text
60839 #: guix-git/doc/guix.texi:34509
60840 msgid "To address that, you install Inkscape linked against a variant GLib that contains debug info:"
60843 #. type: Plain text
60844 #: guix-git/doc/guix.texi:34515
60845 msgid "This time, debugging will be a whole lot nicer:"
60849 #: guix-git/doc/guix.texi:34533
60852 "$ gdb --args sh -c 'exec inkscape'\n"
60854 "(gdb) b g_getenv\n"
60855 "Function \"g_getenv\" not defined.\n"
60856 "Make breakpoint pending on future shared library load? (y or [n]) y\n"
60857 "Breakpoint 1 (g_getenv) pending.\n"
60859 "Starting program: /gnu/store/@dots{}-profile/bin/sh -c exec\\ inkscape\n"
60862 "#0 g_getenv (variable=variable@@entry=0x7ffff60c7a2e \"GOBJECT_DEBUG\") at ../glib-2.62.6/glib/genviron.c:252\n"
60863 "#1 0x00007ffff608a7d6 in gobject_init () at ../glib-2.62.6/gobject/gtype.c:4380\n"
60864 "#2 gobject_init_ctor () at ../glib-2.62.6/gobject/gtype.c:4493\n"
60865 "#3 0x00007ffff7fe275a in call_init (l=<optimized out>, argc=argc@@entry=3, argv=argv@@entry=0x7fffffffd088, \n"
60866 " env=env@@entry=0x7fffffffd0a8) at dl-init.c:72\n"
60870 #. type: Plain text
60871 #: guix-git/doc/guix.texi:34536
60872 msgid "Much better!"
60875 #. type: Plain text
60876 #: guix-git/doc/guix.texi:34540
60877 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."
60881 #: guix-git/doc/guix.texi:34544
60883 msgid "security updates"
60886 #. type: Plain text
60887 #: guix-git/doc/guix.texi:34553
60888 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:"
60891 #. type: smallexample
60892 #: guix-git/doc/guix.texi:34560
60895 "$ guix lint -c cve\n"
60896 "gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547\n"
60897 "gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276\n"
60898 "gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924\n"
60902 #. type: Plain text
60903 #: guix-git/doc/guix.texi:34563
60904 msgid "@xref{Invoking guix lint}, for more information."
60907 #. type: Plain text
60908 #: guix-git/doc/guix.texi:34572
60909 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."
60913 #: guix-git/doc/guix.texi:34573
60918 #. type: Plain text
60919 #: guix-git/doc/guix.texi:34581
60920 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."
60924 #: guix-git/doc/guix.texi:34582
60926 msgid "replacements of packages, for grafts"
60929 #. type: Plain text
60930 #: guix-git/doc/guix.texi:34588
60931 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:"
60935 #: guix-git/doc/guix.texi:34595
60940 " (name \"bash\")\n"
60942 " (replacement bash-fixed)))\n"
60945 #. type: Plain text
60946 #: guix-git/doc/guix.texi:34605
60947 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."
60950 #. type: Plain text
60951 #: guix-git/doc/guix.texi:34613
60952 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."
60955 #. type: Plain text
60956 #: guix-git/doc/guix.texi:34617
60957 msgid "The @option{--no-grafts} command-line option allows you to forcefully avoid grafting (@pxref{Common Build Options, @option{--no-grafts}}). Thus, the command:"
60961 #: guix-git/doc/guix.texi:34620
60963 msgid "guix build bash --no-grafts\n"
60966 #. type: Plain text
60967 #: guix-git/doc/guix.texi:34624
60968 msgid "returns the store file name of the original Bash, whereas:"
60972 #: guix-git/doc/guix.texi:34627
60974 msgid "guix build bash\n"
60977 #. type: Plain text
60978 #: guix-git/doc/guix.texi:34632
60979 msgid "returns the store file name of the ``fixed'', replacement Bash. This allows you to distinguish between the two variants of Bash."
60982 #. type: Plain text
60983 #: guix-git/doc/guix.texi:34635
60984 msgid "To verify which Bash your whole profile refers to, you can run (@pxref{Invoking guix gc}):"
60988 #: guix-git/doc/guix.texi:34638
60990 msgid "guix gc -R $(readlink -f ~/.guix-profile) | grep bash\n"
60993 #. type: Plain text
60994 #: guix-git/doc/guix.texi:34643
60995 msgid "@dots{} and compare the store file names that you get with those above. Likewise for a complete Guix system generation:"
60999 #: guix-git/doc/guix.texi:34646
61001 msgid "guix gc -R $(guix system build my-config.scm) | grep bash\n"
61004 #. type: Plain text
61005 #: guix-git/doc/guix.texi:34650
61006 msgid "Lastly, to check which Bash running processes are using, you can use the @command{lsof} command:"
61010 #: guix-git/doc/guix.texi:34653
61012 msgid "lsof | grep /gnu/store/.*bash\n"
61016 #: guix-git/doc/guix.texi:34661
61018 msgid "bootstrapping"
61021 #. type: Plain text
61022 #: guix-git/doc/guix.texi:34668
61023 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?"
61026 #. type: Plain text
61027 #: guix-git/doc/guix.texi:34676
61028 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."
61032 #: guix-git/doc/guix.texi:34677 guix-git/doc/guix.texi:34889
61034 msgid "bootstrap binaries"
61037 #. type: Plain text
61038 #: guix-git/doc/guix.texi:34687
61039 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}."
61042 #. type: Plain text
61043 #: guix-git/doc/guix.texi:34691
61044 msgid "These bootstrap binaries are ``taken for granted'', though we can also re-create them if needed (@pxref{Preparing to Use the Bootstrap Binaries})."
61048 #: guix-git/doc/guix.texi:34698
61050 msgid "The Reduced Binary Seed Bootstrap"
61053 #. type: Plain text
61054 #: guix-git/doc/guix.texi:34705
61055 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.''"
61058 #. type: Plain text
61059 #: guix-git/doc/guix.texi:34711
61060 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."
61063 #. type: Plain text
61064 #: guix-git/doc/guix.texi:34716
61065 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.}."
61068 #. type: Plain text
61069 #: guix-git/doc/guix.texi:34722
61070 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)."
61073 #. type: Plain text
61074 #: guix-git/doc/guix.texi:34727
61075 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."
61078 #. type: Plain text
61079 #: guix-git/doc/guix.texi:34735
61080 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."
61083 #. type: Plain text
61084 #: guix-git/doc/guix.texi:34745
61085 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."
61088 #. type: Plain text
61089 #: guix-git/doc/guix.texi:34749
61090 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."
61093 #. type: Plain text
61094 #: guix-git/doc/guix.texi:34752
61095 msgid "@image{images/gcc-core-mesboot0-graph,6in,,Dependency graph of gcc-core-mesboot0}"
61098 #. type: Plain text
61099 #: guix-git/doc/guix.texi:34759
61100 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.}."
61103 #. type: Plain text
61104 #: guix-git/doc/guix.texi:34762
61105 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}."
61108 #. type: Plain text
61109 #: guix-git/doc/guix.texi:34767
61110 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."
61113 #. type: Plain text
61114 #: guix-git/doc/guix.texi:34771
61115 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}."
61118 #. type: Plain text
61119 #: guix-git/doc/guix.texi:34778
61120 msgid "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations}"
61123 #. type: Plain text
61124 #: guix-git/doc/guix.texi:34783
61125 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:"
61129 #: guix-git/doc/guix.texi:34788
61132 "guix graph -t derivation \\\n"
61133 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n"
61134 " | dot -Tps > gcc.ps\n"
61137 #. type: Plain text
61138 #: guix-git/doc/guix.texi:34791
61139 msgid "or, for the further Reduced Binary Seed bootstrap"
61143 #: guix-git/doc/guix.texi:34796
61146 "guix graph -t derivation \\\n"
61147 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-mes)' \\\n"
61148 " | dot -Tps > mes.ps\n"
61151 #. type: Plain text
61152 #: guix-git/doc/guix.texi:34805
61153 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})."
61156 #. type: Plain text
61157 #: guix-git/doc/guix.texi:34814
61158 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."
61161 #. type: Plain text
61162 #: guix-git/doc/guix.texi:34826
61163 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})."
61166 #. type: Plain text
61167 #: guix-git/doc/guix.texi:34831
61168 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."
61171 #. type: unnumberedsec
61172 #: guix-git/doc/guix.texi:34832
61174 msgid "Building the Build Tools"
61177 #. type: Plain text
61178 #: guix-git/doc/guix.texi:34841
61179 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."
61182 #. type: Plain text
61183 #: guix-git/doc/guix.texi:34848
61184 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:"
61188 #: guix-git/doc/guix.texi:34853
61191 "guix graph -t bag \\\n"
61192 " -e '(@@@@ (gnu packages commencement)\n"
61193 " glibc-final-with-bootstrap-bash)' | xdot -\n"
61196 #. type: Plain text
61197 #: guix-git/doc/guix.texi:34860
61198 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."
61201 #. type: Plain text
61202 #: guix-git/doc/guix.texi:34862
61203 msgid "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}"
61206 #. type: Plain text
61207 #: guix-git/doc/guix.texi:34868
61208 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."
61211 #. type: Plain text
61212 #: guix-git/doc/guix.texi:34873
61213 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."
61216 #. type: Plain text
61217 #: guix-git/doc/guix.texi:34879
61218 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."
61221 #. type: Plain text
61222 #: guix-git/doc/guix.texi:34885
61223 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}})."
61226 #. type: unnumberedsec
61227 #: guix-git/doc/guix.texi:34887
61229 msgid "Building the Bootstrap Binaries"
61232 #. type: Plain text
61233 #: guix-git/doc/guix.texi:34894
61234 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."
61237 #. type: Plain text
61238 #: guix-git/doc/guix.texi:34900
61239 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):"
61243 #: guix-git/doc/guix.texi:34903
61245 msgid "guix build bootstrap-tarballs\n"
61248 #. type: Plain text
61249 #: guix-git/doc/guix.texi:34908
61250 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."
61253 #. type: Plain text
61254 #: guix-git/doc/guix.texi:34914
61255 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."
61258 #. type: unnumberedsec
61259 #: guix-git/doc/guix.texi:34915
61261 msgid "Reducing the Set of Bootstrap Binaries"
61264 #. type: Plain text
61265 #: guix-git/doc/guix.texi:34923
61266 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}."
61269 #. type: Plain text
61270 #: guix-git/doc/guix.texi:34929
61271 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."
61274 #. type: Plain text
61275 #: guix-git/doc/guix.texi:34935
61276 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."
61279 #. type: Plain text
61280 #: guix-git/doc/guix.texi:34944
61281 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."
61284 #. type: Plain text
61285 #: guix-git/doc/guix.texi:34947
61286 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!"
61290 #: guix-git/doc/guix.texi:34949
61292 msgid "Porting to a New Platform"
61295 #. type: Plain text
61296 #: guix-git/doc/guix.texi:34958
61297 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."
61300 #. type: Plain text
61301 #: guix-git/doc/guix.texi:34963
61302 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:"
61306 #: guix-git/doc/guix.texi:34966
61308 msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n"
61311 #. type: Plain text
61312 #: guix-git/doc/guix.texi:34973
61313 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."
61316 #. type: Plain text
61317 #: guix-git/doc/guix.texi:34982
61318 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."
61321 #. type: Plain text
61322 #: guix-git/doc/guix.texi:34991
61323 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."
61327 #: guix-git/doc/guix.texi:34993
61329 msgid "contributing.texi"
61330 msgstr "contributing.sk.texi"
61332 #. type: Plain text
61333 #: guix-git/doc/guix.texi:35006
61334 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."
61337 #. type: Plain text
61338 #: guix-git/doc/guix.texi:35009
61339 msgid "The Nix-based software distributions, Nixpkgs and NixOS, have also been an inspiration for Guix."
61342 #. type: Plain text
61343 #: guix-git/doc/guix.texi:35015
61344 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!"
61348 #: guix-git/doc/guix.texi:35020
61350 msgid "license, GNU Free Documentation License"
61354 #: guix-git/doc/guix.texi:35021
61356 msgid "fdl-1.3.texi"