Merge branch 'version-1.3.0'
[jackhill/guix/guix.git] / po / doc / guix-manual.sk.po
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.
5 msgid ""
6 msgstr ""
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"
13 "Language: sk\n"
14 "MIME-Version: 1.0\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"
19
20 #. #-#-#-#-# contributing.pot (guix manual checkout) #-#-#-#-#
21 #. type: chapter
22 #. #-#-#-#-# guix.pot (guix manual checkout) #-#-#-#-#
23 #. type: menuentry
24 #: guix-git/doc/contributing.texi:1 guix-git/doc/contributing.texi:2
25 #: guix-git/doc/guix.texi:168
26 #, no-wrap
27 msgid "Contributing"
28 msgstr "Zapojiť sa"
29
30 #. type: Plain text
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})."
34
35 #. type: cindex
36 #: guix-git/doc/contributing.texi:10
37 #, no-wrap
38 msgid "code of conduct, of contributors"
39 msgstr "zásady správania, prispievateľov"
40
41 #. type: cindex
42 #: guix-git/doc/contributing.texi:11
43 #, no-wrap
44 msgid "contributor covenant"
45 msgstr "záväzok prispievateľa"
46
47 #. type: Plain text
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."
51
52 #. type: Plain text
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."
56
57 #. type: section
58 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:34
59 #: guix-git/doc/contributing.texi:35
60 #, no-wrap
61 msgid "Building from Git"
62 msgstr "Zostavenie z Gitu"
63
64 #. type: menuentry
65 #: guix-git/doc/contributing.texi:32
66 msgid "The latest and greatest."
67 msgstr "Vždy ten najnovší."
68
69 #. type: section
70 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:160
71 #: guix-git/doc/contributing.texi:161
72 #, no-wrap
73 msgid "Running Guix Before It Is Installed"
74 msgstr "Spúšťanie Guixu ešte pred inštaláciou"
75
76 #. type: menuentry
77 #: guix-git/doc/contributing.texi:32
78 msgid "Hacker tricks."
79 msgstr "Finty pre hackerov."
80
81 #. type: section
82 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:234
83 #: guix-git/doc/contributing.texi:235
84 #, no-wrap
85 msgid "The Perfect Setup"
86 msgstr "Dokonalé nastavenie"
87
88 #. type: menuentry
89 #: guix-git/doc/contributing.texi:32
90 msgid "The right tools."
91 msgstr "Správne nástroje."
92
93 #. type: section
94 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:325
95 #: guix-git/doc/contributing.texi:326
96 #, no-wrap
97 msgid "Packaging Guidelines"
98 msgstr "Zásady pridávania balíkov"
99
100 #. type: menuentry
101 #: guix-git/doc/contributing.texi:32
102 msgid "Growing the distribution."
103 msgstr "Rast distribúcie."
104
105 #. type: section
106 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:873
107 #: guix-git/doc/contributing.texi:874
108 #, no-wrap
109 msgid "Coding Style"
110 msgstr "Štýl kódovania"
111
112 #. type: menuentry
113 #: guix-git/doc/contributing.texi:32
114 msgid "Hygiene of the contributor."
115 msgstr "Návyky prispievateľa."
116
117 #. type: section
118 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:972
119 #: guix-git/doc/contributing.texi:973
120 #, no-wrap
121 msgid "Submitting Patches"
122 msgstr "Odovzdávanie záplat"
123
124 #. type: menuentry
125 #: guix-git/doc/contributing.texi:32
126 msgid "Share your work."
127 msgstr "Zdieľajte vašu prácu."
128
129 #. type: section
130 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1198
131 #: guix-git/doc/contributing.texi:1199
132 #, no-wrap
133 msgid "Tracking Bugs and Patches"
134 msgstr "Sledovanie chýb a záplat"
135
136 #. type: menuentry
137 #: guix-git/doc/contributing.texi:32
138 msgid "Using Debbugs."
139 msgstr "Používanie Debbugs."
140
141 #. type: section
142 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1249
143 #: guix-git/doc/contributing.texi:1250
144 #, no-wrap
145 msgid "Commit Access"
146 msgstr "Právo na úpravu"
147
148 #. type: menuentry
149 #: guix-git/doc/contributing.texi:32
150 msgid "Pushing to the official repository."
151 msgstr "Odosielanie úprav do oficiálneho repozitára."
152
153 #. type: section
154 #: guix-git/doc/contributing.texi:32 guix-git/doc/contributing.texi:1396
155 #: guix-git/doc/contributing.texi:1397
156 #, no-wrap
157 msgid "Updating the Guix Package"
158 msgstr "Aktualizácia balíka Guix"
159
160 #. type: menuentry
161 #: guix-git/doc/contributing.texi:32
162 msgid "Updating the Guix package definition."
163 msgstr "Aktualizovať zadanie balíka Guix."
164
165 #. type: Plain text
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:"
169
170 #. type: example
171 #: guix-git/doc/contributing.texi:42
172 #, no-wrap
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"
175
176 #. type: cindex
177 #: guix-git/doc/contributing.texi:44
178 #, no-wrap
179 msgid "authentication, of a Guix checkout"
180 msgstr "overenie, miestneho Git repozitára Guixu"
181
182 #. type: Plain text
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}):"
186
187 #. type: example
188 #: guix-git/doc/contributing.texi:56
189 #, no-wrap
190 msgid ""
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"
194 msgstr ""
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"
198
199 #. type: Plain text
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."
203
204 #. type: Plain text
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."
208
209 #. type: Plain text
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:"
213
214 #. type: example
215 #: guix-git/doc/contributing.texi:76
216 #, no-wrap
217 msgid "guix environment guix --pure\n"
218 msgstr "guix environment guix --pure\n"
219
220 #. type: Plain text
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."
224
225 #. type: Plain text
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."
229
230 #. type: item
231 #: guix-git/doc/contributing.texi:85
232 #, no-wrap
233 msgid "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
234 msgstr "@url{https://gnu.org/software/autoconf/, GNU Autoconf};"
235
236 #. type: item
237 #: guix-git/doc/contributing.texi:86
238 #, no-wrap
239 msgid "@url{https://gnu.org/software/automake/, GNU Automake};"
240 msgstr "@url{https://gnu.org/software/automake/, GNU Automake};"
241
242 #. type: item
243 #: guix-git/doc/contributing.texi:87
244 #, no-wrap
245 msgid "@url{https://gnu.org/software/gettext/, GNU Gettext};"
246 msgstr "@url{https://gnu.org/software/gettext/, GNU Gettext};"
247
248 #. type: item
249 #: guix-git/doc/contributing.texi:88
250 #, no-wrap
251 msgid "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
252 msgstr "@url{https://gnu.org/software/texinfo/, GNU Texinfo};"
253
254 #. type: item
255 #: guix-git/doc/contributing.texi:89
256 #, no-wrap
257 msgid "@url{https://www.graphviz.org/, Graphviz};"
258 msgstr "@url{https://www.graphviz.org/, Graphviz};"
259
260 #. type: item
261 #: guix-git/doc/contributing.texi:90
262 #, no-wrap
263 msgid "@url{https://www.gnu.org/software/help2man/, GNU Help2man (optional)}."
264 msgstr "@url{https://www.gnu.org/software/help2man/, GNU Help2man (nepovinné)}."
265
266 #. type: Plain text
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}:"
270
271 #. type: example
272 #: guix-git/doc/contributing.texi:98
273 #, no-wrap
274 msgid "guix environment guix --pure --ad-hoc help2man git strace\n"
275 msgstr "guix environment guix --pure --ad-hoc help2man git strace\n"
276
277 #. type: Plain text
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:"
281
282 #. type: example
283 #: guix-git/doc/contributing.texi:105
284 #, no-wrap
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"
287
288 #. type: Plain text
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:"
291 msgstr ""
292
293 #. type: example
294 #: guix-git/doc/contributing.texi:117
295 #, no-wrap
296 msgid "export ACLOCAL_PATH=/usr/share/aclocal\n"
297 msgstr ""
298
299 #. type: Plain text
300 #: guix-git/doc/contributing.texi:121
301 msgid "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more information."
302 msgstr ""
303
304 #. type: Plain text
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}."
307 msgstr ""
308
309 #. type: Plain text
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}."
312 msgstr ""
313
314 #. type: Plain text
315 #: guix-git/doc/contributing.texi:136
316 msgid "From there on, you can authenticate all the commits included in your checkout by running:"
317 msgstr ""
318
319 #. type: example
320 #: guix-git/doc/contributing.texi:139
321 #, no-wrap
322 msgid "make authenticate\n"
323 msgstr ""
324
325 #. type: Plain text
326 #: guix-git/doc/contributing.texi:142
327 msgid "The first run takes a couple of minutes, but subsequent runs are faster."
328 msgstr ""
329
330 #. type: Plain text
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:"
333 msgstr ""
334
335 #. type: example
336 #: guix-git/doc/contributing.texi:151
337 #, no-wrap
338 msgid "make authenticate GUIX_GIT_KEYRING=myremote/keyring\n"
339 msgstr ""
340
341 #. type: quotation
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
362 #, no-wrap
363 msgid "Note"
364 msgstr ""
365
366 #. type: quotation
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."
369 msgstr ""
370
371 #. type: Plain text
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."
374 msgstr ""
375
376 #. type: Plain text
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):"
379 msgstr ""
380
381 #. type: example
382 #: guix-git/doc/contributing.texi:181
383 #, no-wrap
384 msgid "$ ./pre-inst-env guix build hello\n"
385 msgstr ""
386
387 #. type: Plain text
388 #: guix-git/doc/contributing.texi:185
389 msgid "Similarly, an example for a Guile session using the Guix modules:"
390 msgstr ""
391
392 #. type: example
393 #: guix-git/doc/contributing.texi:188
394 #, no-wrap
395 msgid ""
396 "$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n"
397 "\n"
398 msgstr ""
399
400 #. type: example
401 #: guix-git/doc/contributing.texi:190
402 #, no-wrap
403 msgid ";;; (\"x86_64-linux\")\n"
404 msgstr ""
405
406 #. type: cindex
407 #: guix-git/doc/contributing.texi:193
408 #, no-wrap
409 msgid "REPL"
410 msgstr ""
411
412 #. type: cindex
413 #: guix-git/doc/contributing.texi:194
414 #, no-wrap
415 msgid "read-eval-print loop"
416 msgstr ""
417
418 #. type: Plain text
419 #: guix-git/doc/contributing.texi:197
420 msgid "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):"
421 msgstr ""
422
423 #. type: example
424 #: guix-git/doc/contributing.texi:212
425 #, no-wrap
426 msgid ""
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"
431 " (fold-packages\n"
432 " (lambda (package lst)\n"
433 " (if (string-prefix? \"python\"\n"
434 " (package-name package))\n"
435 " (cons package lst)\n"
436 " lst))\n"
437 " '()))\n"
438 "scheme@@(guile-user)> (length snakes)\n"
439 "$1 = 361\n"
440 msgstr ""
441
442 #. type: Plain text
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.}:"
445 msgstr ""
446
447 #. type: example
448 #: guix-git/doc/contributing.texi:223
449 #, no-wrap
450 msgid "$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n"
451 msgstr ""
452
453 #. type: Plain text
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}."
456 msgstr ""
457
458 #. type: Plain text
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."
461 msgstr ""
462
463 #. type: Plain text
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:"
466 msgstr ""
467
468 #. type: example
469 #: guix-git/doc/contributing.texi:245
470 #, no-wrap
471 msgid "guix package -i emacs guile emacs-geiser\n"
472 msgstr ""
473
474 #. type: Plain text
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:"
477 msgstr ""
478
479 #. type: lisp
480 #: guix-git/doc/contributing.texi:259
481 #, no-wrap
482 msgid ""
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"
486 msgstr ""
487
488 #. type: Plain text
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."
491 msgstr ""
492
493 #. type: cindex
494 #: guix-git/doc/contributing.texi:268
495 #, no-wrap
496 msgid "code snippets"
497 msgstr ""
498
499 #. type: cindex
500 #: guix-git/doc/contributing.texi:269
501 #, no-wrap
502 msgid "templates"
503 msgstr ""
504
505 #. type: cindex
506 #: guix-git/doc/contributing.texi:270
507 #, no-wrap
508 msgid "reducing boilerplate"
509 msgstr ""
510
511 #. type: Plain text
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."
514 msgstr ""
515
516 #. type: lisp
517 #: guix-git/doc/contributing.texi:282
518 #, no-wrap
519 msgid ""
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"
523 msgstr ""
524
525 #. type: Plain text
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."
528 msgstr ""
529
530 #. type: Plain text
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."
533 msgstr ""
534
535 #. type: cindex
536 #: guix-git/doc/contributing.texi:297
537 #, no-wrap
538 msgid "insert or update copyright"
539 msgstr ""
540
541 #. type: code{#1}
542 #: guix-git/doc/contributing.texi:298
543 #, no-wrap
544 msgid "M-x guix-copyright"
545 msgstr ""
546
547 #. type: code{#1}
548 #: guix-git/doc/contributing.texi:299
549 #, no-wrap
550 msgid "M-x copyright-update"
551 msgstr ""
552
553 #. type: Plain text
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."
556 msgstr ""
557
558 #. type: lisp
559 #: guix-git/doc/contributing.texi:309
560 #, no-wrap
561 msgid ""
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"
566 msgstr ""
567
568 #. type: Plain text
569 #: guix-git/doc/contributing.texi:312
570 msgid "To insert a copyright at the current line invoke @code{M-x guix-copyright}."
571 msgstr ""
572
573 #. type: Plain text
574 #: guix-git/doc/contributing.texi:314
575 msgid "To update a copyright you need to specify a @code{copyright-names-regexp}."
576 msgstr ""
577
578 #. type: lisp
579 #: guix-git/doc/contributing.texi:318
580 #, no-wrap
581 msgid ""
582 "(setq copyright-names-regexp\n"
583 " (format \"%s <%s>\" user-full-name user-mail-address))\n"
584 msgstr ""
585
586 #. type: Plain text
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."
589 msgstr ""
590
591 #. type: cindex
592 #: guix-git/doc/contributing.texi:328
593 #, no-wrap
594 msgid "packages, creating"
595 msgstr ""
596
597 #. type: Plain text
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."
600 msgstr ""
601
602 #. type: Plain text
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."
605 msgstr ""
606
607 #. type: Plain text
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}."
610 msgstr ""
611
612 #. type: Plain text
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}):"
615 msgstr ""
616
617 #. type: example
618 #: guix-git/doc/contributing.texi:358
619 #, no-wrap
620 msgid "./pre-inst-env guix build gnew --keep-failed\n"
621 msgstr ""
622
623 #. type: Plain text
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."
626 msgstr ""
627
628 #. type: Plain text
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:"
631 msgstr ""
632
633 #. type: example
634 #: guix-git/doc/contributing.texi:372
635 #, no-wrap
636 msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n"
637 msgstr ""
638
639 #. type: Plain text
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}."
642 msgstr ""
643
644 #. type: cindex
645 #: guix-git/doc/contributing.texi:380
646 #, no-wrap
647 msgid "substituter"
648 msgstr ""
649
650 #. type: Plain text
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."
653 msgstr ""
654
655 #. type: subsection
656 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:403
657 #: guix-git/doc/contributing.texi:404
658 #, no-wrap
659 msgid "Software Freedom"
660 msgstr ""
661
662 #. type: menuentry
663 #: guix-git/doc/contributing.texi:401
664 msgid "What may go into the distribution."
665 msgstr ""
666
667 #. type: subsection
668 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:431
669 #: guix-git/doc/contributing.texi:432
670 #, no-wrap
671 msgid "Package Naming"
672 msgstr ""
673
674 #. type: menuentry
675 #: guix-git/doc/contributing.texi:401
676 msgid "What's in a name?"
677 msgstr ""
678
679 #. type: subsection
680 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:464
681 #: guix-git/doc/contributing.texi:465
682 #, no-wrap
683 msgid "Version Numbers"
684 msgstr ""
685
686 #. type: menuentry
687 #: guix-git/doc/contributing.texi:401
688 msgid "When the name is not enough."
689 msgstr ""
690
691 #. type: subsection
692 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:555
693 #: guix-git/doc/contributing.texi:556
694 #, no-wrap
695 msgid "Synopses and Descriptions"
696 msgstr ""
697
698 #. type: menuentry
699 #: guix-git/doc/contributing.texi:401
700 msgid "Helping users find the right package."
701 msgstr ""
702
703 #. type: subsection
704 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:634
705 #: guix-git/doc/contributing.texi:635
706 #, no-wrap
707 msgid "Snippets versus Phases"
708 msgstr ""
709
710 #. type: menuentry
711 #: guix-git/doc/contributing.texi:401
712 msgid "Whether to use a snippet, or a build phase."
713 msgstr ""
714
715 #. type: subsection
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
718 #, no-wrap
719 msgid "Emacs Packages"
720 msgstr ""
721
722 #. type: menuentry
723 #: guix-git/doc/contributing.texi:401
724 msgid "Your Elisp fix."
725 msgstr ""
726
727 #. type: subsection
728 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:689
729 #: guix-git/doc/contributing.texi:690
730 #, no-wrap
731 msgid "Python Modules"
732 msgstr ""
733
734 #. type: menuentry
735 #: guix-git/doc/contributing.texi:401
736 msgid "A touch of British comedy."
737 msgstr ""
738
739 #. type: subsection
740 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:765
741 #: guix-git/doc/contributing.texi:766
742 #, no-wrap
743 msgid "Perl Modules"
744 msgstr ""
745
746 #. type: menuentry
747 #: guix-git/doc/contributing.texi:401
748 msgid "Little pearls."
749 msgstr ""
750
751 #. type: subsection
752 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:781
753 #: guix-git/doc/contributing.texi:782
754 #, no-wrap
755 msgid "Java Packages"
756 msgstr ""
757
758 #. type: menuentry
759 #: guix-git/doc/contributing.texi:401
760 msgid "Coffee break."
761 msgstr ""
762
763 #. type: subsection
764 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:801
765 #: guix-git/doc/contributing.texi:802
766 #, no-wrap
767 msgid "Rust Crates"
768 msgstr ""
769
770 #. type: menuentry
771 #: guix-git/doc/contributing.texi:401
772 msgid "Beware of oxidation."
773 msgstr ""
774
775 #. type: subsection
776 #: guix-git/doc/contributing.texi:401 guix-git/doc/contributing.texi:835
777 #: guix-git/doc/contributing.texi:836
778 #, no-wrap
779 msgid "Fonts"
780 msgstr ""
781
782 #. type: menuentry
783 #: guix-git/doc/contributing.texi:401
784 msgid "Fond of fonts."
785 msgstr ""
786
787 #. type: cindex
788 #: guix-git/doc/contributing.texi:407
789 #, no-wrap
790 msgid "free software"
791 msgstr ""
792
793 #. type: Plain text
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."
796 msgstr ""
797
798 #. type: Plain text
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."
801 msgstr ""
802
803 #. type: Plain text
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."
806 msgstr ""
807
808 #. type: cindex
809 #: guix-git/doc/contributing.texi:434
810 #, no-wrap
811 msgid "package name"
812 msgstr ""
813
814 #. type: Plain text
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}."
817 msgstr ""
818
819 #. type: Plain text
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}."
822 msgstr ""
823
824 #. type: Plain text
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."
827 msgstr ""
828
829 #. type: Plain text
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."
832 msgstr ""
833
834 #. type: Plain text
835 #: guix-git/doc/contributing.texi:462
836 msgid "Font package names are handled differently, @pxref{Fonts}."
837 msgstr ""
838
839 #. type: cindex
840 #: guix-git/doc/contributing.texi:467
841 #, no-wrap
842 msgid "package version"
843 msgstr ""
844
845 #. type: Plain text
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."
848 msgstr ""
849
850 #. type: Plain text
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."
853 msgstr ""
854
855 #. type: Plain text
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:"
858 msgstr ""
859
860 #. type: lisp
861 #: guix-git/doc/contributing.texi:493
862 #, no-wrap
863 msgid ""
864 "(define-public gtk+\n"
865 " (package\n"
866 " (name \"gtk+\")\n"
867 " (version \"3.9.12\")\n"
868 " ...))\n"
869 "(define-public gtk+-2\n"
870 " (package\n"
871 " (name \"gtk+\")\n"
872 " (version \"2.24.20\")\n"
873 " ...))\n"
874 msgstr ""
875
876 #. type: Plain text
877 #: guix-git/doc/contributing.texi:495
878 msgid "If we also wanted GTK+ 3.8.2, this would be packaged as"
879 msgstr ""
880
881 #. type: lisp
882 #: guix-git/doc/contributing.texi:501
883 #, no-wrap
884 msgid ""
885 "(define-public gtk+-3.8\n"
886 " (package\n"
887 " (name \"gtk+\")\n"
888 " (version \"3.8.2\")\n"
889 " ...))\n"
890 msgstr ""
891
892 #. type: cindex
893 #: guix-git/doc/contributing.texi:505
894 #, no-wrap
895 msgid "version number, for VCS snapshots"
896 msgstr ""
897
898 #. type: Plain text
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?"
901 msgstr ""
902
903 #. type: Plain text
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:"
906 msgstr ""
907
908 #. type: example
909 #: guix-git/doc/contributing.texi:528
910 #, no-wrap
911 msgid ""
912 "2.0.11-3.cabba9e\n"
913 " ^ ^ ^\n"
914 " | | `-- upstream commit ID\n"
915 " | |\n"
916 " | `--- Guix package revision\n"
917 " |\n"
918 "latest upstream version\n"
919 msgstr ""
920
921 #. type: Plain text
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:"
924 msgstr ""
925
926 #. type: lisp
927 #: guix-git/doc/contributing.texi:553
928 #, no-wrap
929 msgid ""
930 "(define my-package\n"
931 " (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n"
932 " (revision \"1\")) ;Guix package revision\n"
933 " (package\n"
934 " (version (git-version \"0.9\" revision commit))\n"
935 " (source (origin\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"
942 " ;; @dots{}\n"
943 " )))\n"
944 msgstr ""
945
946 #. type: cindex
947 #: guix-git/doc/contributing.texi:558
948 #, no-wrap
949 msgid "package description"
950 msgstr ""
951
952 #. type: cindex
953 #: guix-git/doc/contributing.texi:559
954 #, no-wrap
955 msgid "package synopsis"
956 msgstr ""
957
958 #. type: Plain text
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."
961 msgstr ""
962
963 #. type: Plain text
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''."
966 msgstr ""
967
968 #. type: Plain text
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."
971 msgstr ""
972
973 #. type: Plain text
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."
976 msgstr ""
977
978 #. type: cindex
979 #: guix-git/doc/contributing.texi:593
980 #, no-wrap
981 msgid "Texinfo markup, in package descriptions"
982 msgstr ""
983
984 #. type: Plain text
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."
987 msgstr ""
988
989 #. type: Plain text
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."
992 msgstr ""
993
994 #. type: Plain text
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:"
997 msgstr ""
998
999 #. type: lisp
1000 #: guix-git/doc/contributing.texi:619
1001 #, no-wrap
1002 msgid ""
1003 "(package\n"
1004 " ;; @dots{}\n"
1005 " (synopsis \"This is translatable\")\n"
1006 " (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n"
1007 msgstr ""
1008
1009 #. type: Plain text
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}):"
1012 msgstr ""
1013
1014 #. type: lisp
1015 #: guix-git/doc/contributing.texi:632
1016 #, no-wrap
1017 msgid ""
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"
1021 msgstr ""
1022
1023 #. type: cindex
1024 #: guix-git/doc/contributing.texi:637
1025 #, no-wrap
1026 msgid "snippets, when to use"
1027 msgstr ""
1028
1029 #. type: Plain text
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})."
1032 msgstr ""
1033
1034 #. type: cindex
1035 #: guix-git/doc/contributing.texi:652
1036 #, no-wrap
1037 msgid "emacs, packaging"
1038 msgstr ""
1039
1040 #. type: cindex
1041 #: guix-git/doc/contributing.texi:653
1042 #, no-wrap
1043 msgid "elisp, packaging"
1044 msgstr ""
1045
1046 #. type: Plain text
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."
1049 msgstr ""
1050
1051 #. type: Plain text
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}."
1054 msgstr ""
1055
1056 #. type: Plain text
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:"
1059 msgstr ""
1060
1061 #. type: lisp
1062 #: guix-git/doc/contributing.texi:682
1063 #, no-wrap
1064 msgid "#:include (cons \"^snippets/\" %default-include))\n"
1065 msgstr ""
1066
1067 #. type: Plain text
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."
1070 msgstr ""
1071
1072 #. type: cindex
1073 #: guix-git/doc/contributing.texi:692
1074 #, no-wrap
1075 msgid "python"
1076 msgstr ""
1077
1078 #. type: Plain text
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}."
1081 msgstr ""
1082
1083 #. type: Plain text
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."
1086 msgstr ""
1087
1088 #. type: Plain text
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."
1091 msgstr ""
1092
1093 #. type: subsubsection
1094 #: guix-git/doc/contributing.texi:712
1095 #, no-wrap
1096 msgid "Specifying Dependencies"
1097 msgstr ""
1098
1099 #. type: cindex
1100 #: guix-git/doc/contributing.texi:713
1101 #, no-wrap
1102 msgid "inputs, for Python packages"
1103 msgstr ""
1104
1105 #. type: Plain text
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}."
1108 msgstr ""
1109
1110 #. type: Plain text
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."
1113 msgstr ""
1114
1115 #. type: itemize
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."
1118 msgstr ""
1119
1120 #. type: itemize
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."
1123 msgstr ""
1124
1125 #. type: itemize
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."
1128 msgstr ""
1129
1130 #. type: itemize
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}."
1133 msgstr ""
1134
1135 #. type: itemize
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."
1138 msgstr ""
1139
1140 #. type: itemize
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}})."
1143 msgstr ""
1144
1145 #. type: cindex
1146 #: guix-git/doc/contributing.texi:768
1147 #, no-wrap
1148 msgid "perl"
1149 msgstr ""
1150
1151 #. type: Plain text
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}."
1154 msgstr ""
1155
1156 #. type: cindex
1157 #: guix-git/doc/contributing.texi:784
1158 #, no-wrap
1159 msgid "java"
1160 msgstr ""
1161
1162 #. type: Plain text
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."
1165 msgstr ""
1166
1167 #. type: Plain text
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}."
1170 msgstr ""
1171
1172 #. type: Plain text
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}."
1175 msgstr ""
1176
1177 #. type: cindex
1178 #: guix-git/doc/contributing.texi:804
1179 #, no-wrap
1180 msgid "rust"
1181 msgstr ""
1182
1183 #. type: Plain text
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."
1186 msgstr ""
1187
1188 #. type: Plain text
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."
1191 msgstr ""
1192
1193 #. type: Plain text
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}."
1196 msgstr ""
1197
1198 #. type: Plain text
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."
1201 msgstr ""
1202
1203 #. type: Plain text
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."
1206 msgstr ""
1207
1208 #. type: cindex
1209 #: guix-git/doc/contributing.texi:838 guix-git/doc/guix.texi:1881
1210 #, no-wrap
1211 msgid "fonts"
1212 msgstr ""
1213
1214 #. type: Plain text
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."
1217 msgstr ""
1218
1219 #. type: Plain text
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."
1222 msgstr ""
1223
1224 #. type: Plain text
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}."
1227 msgstr ""
1228
1229 #. type: Plain text
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}."
1232 msgstr ""
1233
1234 #. type: Plain text
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."
1237 msgstr ""
1238
1239 #. type: Plain text
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."
1242 msgstr ""
1243
1244 #. type: subsection
1245 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:887
1246 #: guix-git/doc/contributing.texi:888
1247 #, no-wrap
1248 msgid "Programming Paradigm"
1249 msgstr ""
1250
1251 #. type: menuentry
1252 #: guix-git/doc/contributing.texi:885
1253 msgid "How to compose your elements."
1254 msgstr ""
1255
1256 #. type: subsection
1257 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:894
1258 #: guix-git/doc/contributing.texi:895
1259 #, no-wrap
1260 msgid "Modules"
1261 msgstr ""
1262
1263 #. type: menuentry
1264 #: guix-git/doc/contributing.texi:885
1265 msgid "Where to store your code?"
1266 msgstr ""
1267
1268 #. type: subsection
1269 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:905
1270 #: guix-git/doc/contributing.texi:906
1271 #, no-wrap
1272 msgid "Data Types and Pattern Matching"
1273 msgstr ""
1274
1275 #. type: menuentry
1276 #: guix-git/doc/contributing.texi:885
1277 msgid "Implementing data structures."
1278 msgstr ""
1279
1280 #. type: subsection
1281 #: guix-git/doc/contributing.texi:885 guix-git/doc/contributing.texi:920
1282 #: guix-git/doc/contributing.texi:921
1283 #, no-wrap
1284 msgid "Formatting Code"
1285 msgstr ""
1286
1287 #. type: menuentry
1288 #: guix-git/doc/contributing.texi:885
1289 msgid "Writing conventions."
1290 msgstr ""
1291
1292 #. type: Plain text
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."
1295 msgstr ""
1296
1297 #. type: Plain text
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."
1300 msgstr ""
1301
1302 #. type: Plain text
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{})}."
1305 msgstr ""
1306
1307 #. type: Plain text
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."
1310 msgstr ""
1311
1312 #. type: Plain text
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})."
1315 msgstr ""
1316
1317 #. type: cindex
1318 #: guix-git/doc/contributing.texi:923
1319 #, no-wrap
1320 msgid "formatting code"
1321 msgstr ""
1322
1323 #. type: cindex
1324 #: guix-git/doc/contributing.texi:924
1325 #, no-wrap
1326 msgid "coding style"
1327 msgstr ""
1328
1329 #. type: Plain text
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."
1332 msgstr ""
1333
1334 #. type: Plain text
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})."
1337 msgstr ""
1338
1339 #. type: cindex
1340 #: guix-git/doc/contributing.texi:939
1341 #, no-wrap
1342 msgid "indentation, of code"
1343 msgstr ""
1344
1345 #. type: cindex
1346 #: guix-git/doc/contributing.texi:940
1347 #, no-wrap
1348 msgid "formatting, of code"
1349 msgstr ""
1350
1351 #. type: Plain text
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:"
1354 msgstr ""
1355
1356 #. type: example
1357 #: guix-git/doc/contributing.texi:946
1358 #, no-wrap
1359 msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n"
1360 msgstr ""
1361
1362 #. type: Plain text
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:"
1365 msgstr ""
1366
1367 #. type: example
1368 #: guix-git/doc/contributing.texi:955
1369 #, no-wrap
1370 msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n"
1371 msgstr ""
1372
1373 #. type: cindex
1374 #: guix-git/doc/contributing.texi:957
1375 #, no-wrap
1376 msgid "Vim, Scheme code editing"
1377 msgstr ""
1378
1379 #. type: Plain text
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."
1382 msgstr ""
1383
1384 #. type: Plain text
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."
1387 msgstr ""
1388
1389 #. type: Plain text
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."
1392 msgstr ""
1393
1394 #. type: Plain text
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})."
1397 msgstr ""
1398
1399 #. type: Plain text
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})."
1402 msgstr ""
1403
1404 #. type: Plain text
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."
1407 msgstr ""
1408
1409 #. type: Plain text
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:"
1412 msgstr ""
1413
1414 #. type: enumerate
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."
1417 msgstr ""
1418
1419 #. type: enumerate
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."
1422 msgstr ""
1423
1424 #. type: enumerate
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})."
1427 msgstr ""
1428
1429 #. type: enumerate
1430 #: guix-git/doc/contributing.texi:1015
1431 msgid "Make sure the package builds on your platform, using @code{guix build @var{package}}."
1432 msgstr ""
1433
1434 #. type: enumerate
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:"
1437 msgstr ""
1438
1439 #. type: lisp
1440 #: guix-git/doc/contributing.texi:1027
1441 #, no-wrap
1442 msgid ""
1443 "(service qemu-binfmt-service-type\n"
1444 " (qemu-binfmt-configuration\n"
1445 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))\n"
1446 msgstr ""
1447
1448 #. type: enumerate
1449 #: guix-git/doc/contributing.texi:1030
1450 msgid "Then reconfigure your system."
1451 msgstr ""
1452
1453 #. type: enumerate
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:"
1456 msgstr ""
1457
1458 #. type: example
1459 #: guix-git/doc/contributing.texi:1038
1460 #, no-wrap
1461 msgid ""
1462 "guix build --system=armhf-linux --rounds=2 hello\n"
1463 "guix build --system=aarch64-linux --rounds=2 hello\n"
1464 msgstr ""
1465
1466 #. type: cindex
1467 #: guix-git/doc/contributing.texi:1041
1468 #, no-wrap
1469 msgid "bundling"
1470 msgstr ""
1471
1472 #. type: enumerate
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."
1475 msgstr ""
1476
1477 #. type: enumerate
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."
1480 msgstr ""
1481
1482 #. type: enumerate
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."
1485 msgstr ""
1486
1487 #. type: enumerate
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})."
1490 msgstr ""
1491
1492 #. type: cindex
1493 #: guix-git/doc/contributing.texi:1069
1494 #, no-wrap
1495 msgid "branching strategy"
1496 msgstr ""
1497
1498 #. type: cindex
1499 #: guix-git/doc/contributing.texi:1070
1500 #, no-wrap
1501 msgid "rebuild scheduling strategy"
1502 msgstr ""
1503
1504 #. type: enumerate
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:"
1507 msgstr ""
1508
1509 #. type: item
1510 #: guix-git/doc/contributing.texi:1075
1511 #, no-wrap
1512 msgid "300 dependent packages or less"
1513 msgstr ""
1514
1515 #. type: table
1516 #: guix-git/doc/contributing.texi:1077
1517 msgid "@code{master} branch (non-disruptive changes)."
1518 msgstr ""
1519
1520 #. type: item
1521 #: guix-git/doc/contributing.texi:1078
1522 #, no-wrap
1523 msgid "between 300 and 1,800 dependent packages"
1524 msgstr ""
1525
1526 #. type: table
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})."
1529 msgstr ""
1530
1531 #. type: item
1532 #: guix-git/doc/contributing.texi:1084
1533 #, no-wrap
1534 msgid "more than 1,800 dependent packages"
1535 msgstr ""
1536
1537 #. type: table
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."
1540 msgstr ""
1541
1542 #. type: enumerate
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."
1545 msgstr ""
1546
1547 #. type: enumerate
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."
1550 msgstr ""
1551
1552 #. type: cindex
1553 #: guix-git/doc/contributing.texi:1106
1554 #, no-wrap
1555 msgid "determinism, of build processes"
1556 msgstr ""
1557
1558 #. type: cindex
1559 #: guix-git/doc/contributing.texi:1107
1560 #, no-wrap
1561 msgid "reproducible builds, checking"
1562 msgstr ""
1563
1564 #. type: enumerate
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."
1567 msgstr ""
1568
1569 #. type: enumerate
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}):"
1572 msgstr ""
1573
1574 #. type: example
1575 #: guix-git/doc/contributing.texi:1117
1576 #, no-wrap
1577 msgid "guix build --rounds=2 my-package\n"
1578 msgstr ""
1579
1580 #. type: enumerate
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."
1583 msgstr ""
1584
1585 #. type: enumerate
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."
1588 msgstr ""
1589
1590 #. type: enumerate
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."
1593 msgstr ""
1594
1595 #. type: enumerate
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."
1598 msgstr ""
1599
1600 #. type: enumerate
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."
1603 msgstr ""
1604
1605 #. type: enumerate
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})."
1608 msgstr ""
1609
1610 #. type: enumerate
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."
1613 msgstr ""
1614
1615 #. type: enumerate
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."
1618 msgstr ""
1619
1620 #. type: enumerate
1621 #: guix-git/doc/contributing.texi:1164
1622 msgid "Make sure your changes do not break Guix and simulate a @code{guix pull} with:"
1623 msgstr ""
1624
1625 #. type: example
1626 #: guix-git/doc/contributing.texi:1166
1627 #, no-wrap
1628 msgid "guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master\n"
1629 msgstr ""
1630
1631 #. type: Plain text
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."
1634 msgstr ""
1635
1636 #. type: Plain text
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}."
1639 msgstr ""
1640
1641 #. type: anchor{#1}
1642 #: guix-git/doc/contributing.texi:1183 guix-git/doc/contributing.texi:1185
1643 #, no-wrap
1644 msgid "Sending a Patch Series"
1645 msgstr ""
1646
1647 #. type: cindex
1648 #: guix-git/doc/contributing.texi:1185
1649 #, no-wrap
1650 msgid "patch series"
1651 msgstr ""
1652
1653 #. type: code{#1}
1654 #: guix-git/doc/contributing.texi:1186
1655 #, no-wrap
1656 msgid "git send-email"
1657 msgstr ""
1658
1659 #. type: code{#1}
1660 #: guix-git/doc/contributing.texi:1187
1661 #, no-wrap
1662 msgid "git-send-email"
1663 msgstr ""
1664
1665 #. type: Plain text
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}."
1668 msgstr ""
1669
1670 #. type: cindex
1671 #: guix-git/doc/contributing.texi:1201
1672 #, no-wrap
1673 msgid "bug reports, tracking"
1674 msgstr ""
1675
1676 #. type: cindex
1677 #: guix-git/doc/contributing.texi:1202
1678 #, no-wrap
1679 msgid "patch submissions, tracking"
1680 msgstr ""
1681
1682 #. type: cindex
1683 #: guix-git/doc/contributing.texi:1203
1684 #, no-wrap
1685 msgid "issue tracking"
1686 msgstr ""
1687
1688 #. type: cindex
1689 #: guix-git/doc/contributing.texi:1204
1690 #, no-wrap
1691 msgid "Debbugs, issue tracking system"
1692 msgstr ""
1693
1694 #. type: Plain text
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})."
1697 msgstr ""
1698
1699 #. type: Plain text
1700 #: guix-git/doc/contributing.texi:1214
1701 msgid "A web interface (actually @emph{two} web interfaces!) are available to browse issues:"
1702 msgstr ""
1703
1704 #. type: itemize
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;"
1707 msgstr ""
1708
1709 #. type: itemize
1710 #: guix-git/doc/contributing.texi:1225
1711 msgid "@url{https://bugs.gnu.org/guix} lists bug reports;"
1712 msgstr ""
1713
1714 #. type: itemize
1715 #: guix-git/doc/contributing.texi:1227
1716 msgid "@url{https://bugs.gnu.org/guix-patches} lists patch submissions."
1717 msgstr ""
1718
1719 #. type: Plain text
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}}."
1722 msgstr ""
1723
1724 #. type: Plain text
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:"
1727 msgstr ""
1728
1729 #. type: example
1730 #: guix-git/doc/contributing.texi:1238
1731 #, no-wrap
1732 msgid "guix install emacs-debbugs\n"
1733 msgstr ""
1734
1735 #. type: Plain text
1736 #: guix-git/doc/contributing.texi:1241
1737 msgid "For example, to list all open issues on @code{guix-patches}, hit:"
1738 msgstr ""
1739
1740 #. type: example
1741 #: guix-git/doc/contributing.texi:1244
1742 #, no-wrap
1743 msgid "@kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y\n"
1744 msgstr ""
1745
1746 #. type: Plain text
1747 #: guix-git/doc/contributing.texi:1248
1748 msgid "@xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on this nifty tool!"
1749 msgstr ""
1750
1751 #. type: cindex
1752 #: guix-git/doc/contributing.texi:1252
1753 #, no-wrap
1754 msgid "commit access, for developers"
1755 msgstr ""
1756
1757 #. type: Plain text
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:"
1760 msgstr ""
1761
1762 #. type: enumerate
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."
1765 msgstr ""
1766
1767 #. type: enumerate
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''."
1770 msgstr ""
1771
1772 #. type: enumerate
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."
1775 msgstr ""
1776
1777 #. type: enumerate
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}):"
1780 msgstr ""
1781
1782 #. type: example
1783 #: guix-git/doc/contributing.texi:1287
1784 #, no-wrap
1785 msgid "digest-algo sha512\n"
1786 msgstr ""
1787
1788 #. type: enumerate
1789 #: guix-git/doc/contributing.texi:1292
1790 msgid "Maintainers ultimately decide whether to grant you commit access, usually following your referrals' recommendation."
1791 msgstr ""
1792
1793 #. type: cindex
1794 #: guix-git/doc/contributing.texi:1294
1795 #, no-wrap
1796 msgid "OpenPGP, signed commits"
1797 msgstr ""
1798
1799 #. type: enumerate
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."
1802 msgstr ""
1803
1804 #. type: quotation
1805 #: guix-git/doc/contributing.texi:1300
1806 #, no-wrap
1807 msgid "Important"
1808 msgstr ""
1809
1810 #. type: quotation
1811 #: guix-git/doc/contributing.texi:1302
1812 msgid "Before you can push for the first time, maintainers must:"
1813 msgstr ""
1814
1815 #. type: enumerate
1816 #: guix-git/doc/contributing.texi:1306
1817 msgid "add your OpenPGP key to the @code{keyring} branch;"
1818 msgstr ""
1819
1820 #. type: enumerate
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."
1823 msgstr ""
1824
1825 #. type: enumerate
1826 #: guix-git/doc/contributing.texi:1314
1827 msgid "Make sure to read the rest of this section and... profit!"
1828 msgstr ""
1829
1830 #. type: quotation
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!"
1833 msgstr ""
1834
1835 #. type: quotation
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!"
1838 msgstr ""
1839
1840 #. type: Plain text
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})."
1843 msgstr ""
1844
1845 #. type: Plain text
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})."
1848 msgstr ""
1849
1850 #. type: Plain text
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}."
1853 msgstr ""
1854
1855 #. type: Plain text
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:"
1858 msgstr ""
1859
1860 #. type: example
1861 #: guix-git/doc/contributing.texi:1353
1862 #, no-wrap
1863 msgid ""
1864 "git config commit.gpgsign true\n"
1865 "git config user.signingkey CABBA6EA1DC0FF33\n"
1866 msgstr ""
1867
1868 #. type: Plain text
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}:"
1871 msgstr ""
1872
1873 #. type: example
1874 #: guix-git/doc/contributing.texi:1361
1875 #, no-wrap
1876 msgid "cp etc/git/pre-push .git/hooks/pre-push\n"
1877 msgstr ""
1878
1879 #. type: Plain text
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."
1882 msgstr ""
1883
1884 #. type: Plain text
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:"
1887 msgstr ""
1888
1889 #. type: example
1890 #: guix-git/doc/contributing.texi:1374
1891 #, no-wrap
1892 msgid "make check-channel-news\n"
1893 msgstr ""
1894
1895 #. type: Plain text
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."
1898 msgstr ""
1899
1900 #. type: Plain text
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."
1903 msgstr ""
1904
1905 #. type: Plain text
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."
1908 msgstr ""
1909
1910 #. type: Plain text
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!"
1913 msgstr ""
1914
1915 #. type: cindex
1916 #: guix-git/doc/contributing.texi:1399
1917 #, no-wrap
1918 msgid "update-guix-package, updating the guix package"
1919 msgstr ""
1920
1921 #. type: Plain text
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:"
1924 msgstr ""
1925
1926 #. type: example
1927 #: guix-git/doc/contributing.texi:1408
1928 #, no-wrap
1929 msgid "make update-guix-package\n"
1930 msgstr ""
1931
1932 #. type: Plain text
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."
1935 msgstr ""
1936
1937 #. type: Plain text
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:"
1940 msgstr ""
1941
1942 #. type: example
1943 #: guix-git/doc/contributing.texi:1422
1944 #, no-wrap
1945 msgid "./pre-inst-env guix build guix\n"
1946 msgstr ""
1947
1948 #. type: Plain text
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."
1951 msgstr ""
1952
1953 #. type: Plain text
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."
1956 msgstr ""
1957
1958 #. type: Plain text
1959 #: guix-git/doc/guix.texi:7
1960 msgid "@documentencoding UTF-8"
1961 msgstr ""
1962
1963 #. type: title
1964 #: guix-git/doc/guix.texi:7 guix-git/doc/guix.texi:118
1965 #, no-wrap
1966 msgid "GNU Guix Reference Manual"
1967 msgstr ""
1968
1969 #. type: include
1970 #: guix-git/doc/guix.texi:10
1971 #, no-wrap
1972 msgid "version.texi"
1973 msgstr "version-sk.texi"
1974
1975 #. type: copying
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@*"
1978 msgstr ""
1979
1980 #. type: copying
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''."
1983 msgstr ""
1984
1985 #. type: dircategory
1986 #: guix-git/doc/guix.texi:100
1987 #, no-wrap
1988 msgid "System administration"
1989 msgstr ""
1990
1991 #. type: menuentry
1992 #: guix-git/doc/guix.texi:108
1993 msgid "Guix: (guix)"
1994 msgstr ""
1995
1996 #. type: menuentry
1997 #: guix-git/doc/guix.texi:108
1998 msgid "Manage installed software and system configuration."
1999 msgstr ""
2000
2001 #. type: menuentry
2002 #: guix-git/doc/guix.texi:108
2003 msgid "guix package: (guix)Invoking guix package"
2004 msgstr ""
2005
2006 #. type: menuentry
2007 #: guix-git/doc/guix.texi:108
2008 msgid "Installing, removing, and upgrading packages."
2009 msgstr ""
2010
2011 #. type: menuentry
2012 #: guix-git/doc/guix.texi:108
2013 msgid "guix gc: (guix)Invoking guix gc"
2014 msgstr ""
2015
2016 #. type: menuentry
2017 #: guix-git/doc/guix.texi:108
2018 msgid "Reclaiming unused disk space."
2019 msgstr ""
2020
2021 #. type: menuentry
2022 #: guix-git/doc/guix.texi:108
2023 msgid "guix pull: (guix)Invoking guix pull"
2024 msgstr ""
2025
2026 #. type: menuentry
2027 #: guix-git/doc/guix.texi:108
2028 msgid "Update the list of available packages."
2029 msgstr ""
2030
2031 #. type: menuentry
2032 #: guix-git/doc/guix.texi:108
2033 msgid "guix system: (guix)Invoking guix system"
2034 msgstr ""
2035
2036 #. type: menuentry
2037 #: guix-git/doc/guix.texi:108
2038 msgid "Manage the operating system configuration."
2039 msgstr ""
2040
2041 #. type: menuentry
2042 #: guix-git/doc/guix.texi:108
2043 msgid "guix deploy: (guix)Invoking guix deploy"
2044 msgstr ""
2045
2046 #. type: menuentry
2047 #: guix-git/doc/guix.texi:108
2048 msgid "Manage operating system configurations for remote hosts."
2049 msgstr ""
2050
2051 #. type: dircategory
2052 #: guix-git/doc/guix.texi:110
2053 #, no-wrap
2054 msgid "Software development"
2055 msgstr ""
2056
2057 #. type: menuentry
2058 #: guix-git/doc/guix.texi:115
2059 msgid "guix environment: (guix)Invoking guix environment"
2060 msgstr ""
2061
2062 #. type: menuentry
2063 #: guix-git/doc/guix.texi:115
2064 msgid "Building development environments with Guix."
2065 msgstr ""
2066
2067 #. type: menuentry
2068 #: guix-git/doc/guix.texi:115
2069 msgid "guix build: (guix)Invoking guix build"
2070 msgstr ""
2071
2072 #. type: menuentry
2073 #: guix-git/doc/guix.texi:115
2074 msgid "Building packages."
2075 msgstr ""
2076
2077 #. type: menuentry
2078 #: guix-git/doc/guix.texi:115
2079 msgid "guix pack: (guix)Invoking guix pack"
2080 msgstr ""
2081
2082 #. type: menuentry
2083 #: guix-git/doc/guix.texi:115
2084 msgid "Creating binary bundles."
2085 msgstr ""
2086
2087 #. type: subtitle
2088 #: guix-git/doc/guix.texi:119
2089 #, no-wrap
2090 msgid "Using the GNU Guix Functional Package Manager"
2091 msgstr ""
2092
2093 #. type: author
2094 #: guix-git/doc/guix.texi:120
2095 #, no-wrap
2096 msgid "The GNU Guix Developers"
2097 msgstr ""
2098
2099 #. type: titlepage
2100 #: guix-git/doc/guix.texi:126
2101 msgid "Edition @value{EDITION} @* @value{UPDATED} @*"
2102 msgstr ""
2103
2104 #. type: node
2105 #: guix-git/doc/guix.texi:133
2106 #, no-wrap
2107 msgid "Top"
2108 msgstr ""
2109
2110 #. type: top
2111 #: guix-git/doc/guix.texi:134
2112 #, no-wrap
2113 msgid "GNU Guix"
2114 msgstr ""
2115
2116 #. type: Plain text
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."
2119 msgstr ""
2120
2121 #. You can replace the following paragraph with information on
2122 #. type: Plain text
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}."
2125 msgstr ""
2126
2127 #. type: chapter
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
2130 #, no-wrap
2131 msgid "Introduction"
2132 msgstr ""
2133
2134 #. type: menuentry
2135 #: guix-git/doc/guix.texi:168
2136 msgid "What is Guix about?"
2137 msgstr ""
2138
2139 #. type: chapter
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
2142 #, no-wrap
2143 msgid "Installation"
2144 msgstr ""
2145
2146 #. type: menuentry
2147 #: guix-git/doc/guix.texi:168
2148 msgid "Installing Guix."
2149 msgstr ""
2150
2151 #. type: chapter
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
2154 #, no-wrap
2155 msgid "System Installation"
2156 msgstr ""
2157
2158 #. type: menuentry
2159 #: guix-git/doc/guix.texi:168
2160 msgid "Installing the whole operating system."
2161 msgstr ""
2162
2163 #. type: chapter
2164 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:2717
2165 #: guix-git/doc/guix.texi:2718
2166 #, no-wrap
2167 msgid "Getting Started"
2168 msgstr ""
2169
2170 #. type: menuentry
2171 #: guix-git/doc/guix.texi:168
2172 msgid "Your first steps."
2173 msgstr ""
2174
2175 #. type: chapter
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
2178 #, no-wrap
2179 msgid "Package Management"
2180 msgstr ""
2181
2182 #. type: menuentry
2183 #: guix-git/doc/guix.texi:168
2184 msgid "Package installation, upgrade, etc."
2185 msgstr ""
2186
2187 #. type: chapter
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
2190 #, no-wrap
2191 msgid "Channels"
2192 msgstr ""
2193
2194 #. type: menuentry
2195 #: guix-git/doc/guix.texi:168
2196 msgid "Customizing the package collection."
2197 msgstr ""
2198
2199 #. type: chapter
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
2202 #, no-wrap
2203 msgid "Development"
2204 msgstr ""
2205
2206 #. type: menuentry
2207 #: guix-git/doc/guix.texi:168
2208 msgid "Guix-aided software development."
2209 msgstr ""
2210
2211 #. type: chapter
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
2214 #, no-wrap
2215 msgid "Programming Interface"
2216 msgstr ""
2217
2218 #. type: menuentry
2219 #: guix-git/doc/guix.texi:168
2220 msgid "Using Guix in Scheme."
2221 msgstr ""
2222
2223 #. type: chapter
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
2226 #, no-wrap
2227 msgid "Utilities"
2228 msgstr ""
2229
2230 #. type: menuentry
2231 #: guix-git/doc/guix.texi:168
2232 msgid "Package management commands."
2233 msgstr ""
2234
2235 #. type: chapter
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
2238 #, no-wrap
2239 msgid "System Configuration"
2240 msgstr ""
2241
2242 #. type: menuentry
2243 #: guix-git/doc/guix.texi:168
2244 msgid "Configuring the operating system."
2245 msgstr ""
2246
2247 #. type: chapter
2248 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34336
2249 #: guix-git/doc/guix.texi:34337
2250 #, no-wrap
2251 msgid "Documentation"
2252 msgstr "Dokumentácia"
2253
2254 #. type: menuentry
2255 #: guix-git/doc/guix.texi:168
2256 msgid "Browsing software user manuals."
2257 msgstr ""
2258
2259 #. type: chapter
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
2262 #, no-wrap
2263 msgid "Installing Debugging Files"
2264 msgstr ""
2265
2266 #. type: menuentry
2267 #: guix-git/doc/guix.texi:168
2268 msgid "Feeding the debugger."
2269 msgstr ""
2270
2271 #. type: chapter
2272 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34541
2273 #: guix-git/doc/guix.texi:34542
2274 #, no-wrap
2275 msgid "Security Updates"
2276 msgstr ""
2277
2278 #. type: menuentry
2279 #: guix-git/doc/guix.texi:168
2280 msgid "Deploying security fixes quickly."
2281 msgstr ""
2282
2283 #. type: chapter
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
2286 #, no-wrap
2287 msgid "Bootstrapping"
2288 msgstr ""
2289
2290 #. type: menuentry
2291 #: guix-git/doc/guix.texi:168
2292 msgid "GNU/Linux built from scratch."
2293 msgstr ""
2294
2295 #. type: node
2296 #: guix-git/doc/guix.texi:168 guix-git/doc/guix.texi:34948
2297 #, no-wrap
2298 msgid "Porting"
2299 msgstr ""
2300
2301 #. type: menuentry
2302 #: guix-git/doc/guix.texi:168
2303 msgid "Targeting another platform or kernel."
2304 msgstr ""
2305
2306 #. type: menuentry
2307 #: guix-git/doc/guix.texi:168
2308 msgid "Your help needed!"
2309 msgstr ""
2310
2311 #. type: chapter
2312 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:34996
2313 #: guix-git/doc/guix.texi:34997
2314 #, no-wrap
2315 msgid "Acknowledgments"
2316 msgstr ""
2317
2318 #. type: menuentry
2319 #: guix-git/doc/guix.texi:173
2320 msgid "Thanks!"
2321 msgstr ""
2322
2323 #. type: appendix
2324 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35018
2325 #: guix-git/doc/guix.texi:35019
2326 #, no-wrap
2327 msgid "GNU Free Documentation License"
2328 msgstr ""
2329
2330 #. type: menuentry
2331 #: guix-git/doc/guix.texi:173
2332 msgid "The license of this manual."
2333 msgstr ""
2334
2335 #. type: unnumbered
2336 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35024
2337 #: guix-git/doc/guix.texi:35025
2338 #, no-wrap
2339 msgid "Concept Index"
2340 msgstr ""
2341
2342 #. type: menuentry
2343 #: guix-git/doc/guix.texi:173
2344 msgid "Concepts."
2345 msgstr ""
2346
2347 #. type: unnumbered
2348 #: guix-git/doc/guix.texi:173 guix-git/doc/guix.texi:35028
2349 #: guix-git/doc/guix.texi:35029
2350 #, no-wrap
2351 msgid "Programming Index"
2352 msgstr ""
2353
2354 #. type: menuentry
2355 #: guix-git/doc/guix.texi:173
2356 msgid "Data types, functions, and variables."
2357 msgstr ""
2358
2359 #. type: menuentry
2360 #: guix-git/doc/guix.texi:176
2361 msgid "--- The Detailed Node Listing ---"
2362 msgstr ""
2363
2364 #. type: section
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
2367 #, no-wrap
2368 msgid "Managing Software the Guix Way"
2369 msgstr ""
2370
2371 #. type: menuentry
2372 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2373 msgid "What's special."
2374 msgstr ""
2375
2376 #. type: section
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
2379 #, no-wrap
2380 msgid "GNU Distribution"
2381 msgstr ""
2382
2383 #. type: menuentry
2384 #: guix-git/doc/guix.texi:181 guix-git/doc/guix.texi:406
2385 msgid "The packages and tools."
2386 msgstr ""
2387
2388 #. type: section
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
2391 #, no-wrap
2392 msgid "Binary Installation"
2393 msgstr ""
2394
2395 #. type: menuentry
2396 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2397 msgid "Getting Guix running in no time!"
2398 msgstr ""
2399
2400 #. type: section
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
2403 #, no-wrap
2404 msgid "Requirements"
2405 msgstr ""
2406
2407 #. type: menuentry
2408 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2409 msgid "Software needed to build and run Guix."
2410 msgstr ""
2411
2412 #. type: section
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
2415 #, no-wrap
2416 msgid "Running the Test Suite"
2417 msgstr ""
2418
2419 #. type: menuentry
2420 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2421 msgid "Testing Guix."
2422 msgstr ""
2423
2424 #. type: section
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
2428 #, no-wrap
2429 msgid "Setting Up the Daemon"
2430 msgstr ""
2431
2432 #. type: menuentry
2433 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2434 msgid "Preparing the build daemon's environment."
2435 msgstr ""
2436
2437 #. type: node
2438 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2439 #: guix-git/doc/guix.texi:1476
2440 #, no-wrap
2441 msgid "Invoking guix-daemon"
2442 msgstr ""
2443
2444 #. type: menuentry
2445 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2446 msgid "Running the build daemon."
2447 msgstr ""
2448
2449 #. type: section
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
2452 #, no-wrap
2453 msgid "Application Setup"
2454 msgstr ""
2455
2456 #. type: menuentry
2457 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2458 msgid "Application-specific setup."
2459 msgstr ""
2460
2461 #. type: section
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
2464 #, no-wrap
2465 msgid "Upgrading Guix"
2466 msgstr ""
2467
2468 #. type: menuentry
2469 #: guix-git/doc/guix.texi:191 guix-git/doc/guix.texi:600
2470 msgid "Upgrading Guix and its build daemon."
2471 msgstr ""
2472
2473 #. type: subsection
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
2476 #, no-wrap
2477 msgid "Build Environment Setup"
2478 msgstr ""
2479
2480 #. type: menuentry
2481 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2482 msgid "Preparing the isolated build environment."
2483 msgstr ""
2484
2485 #. type: node
2486 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2487 #: guix-git/doc/guix.texi:1147
2488 #, no-wrap
2489 msgid "Daemon Offload Setup"
2490 msgstr ""
2491
2492 #. type: menuentry
2493 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2494 msgid "Offloading builds to remote machines."
2495 msgstr ""
2496
2497 #. type: subsection
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
2500 #, no-wrap
2501 msgid "SELinux Support"
2502 msgstr ""
2503
2504 #. type: menuentry
2505 #: guix-git/doc/guix.texi:197 guix-git/doc/guix.texi:1026
2506 msgid "Using an SELinux policy for the daemon."
2507 msgstr ""
2508
2509 #. type: section
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
2513 #, no-wrap
2514 msgid "Limitations"
2515 msgstr ""
2516
2517 #. type: menuentry
2518 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2519 msgid "What you can expect."
2520 msgstr ""
2521
2522 #. type: section
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
2525 #, no-wrap
2526 msgid "Hardware Considerations"
2527 msgstr ""
2528
2529 #. type: menuentry
2530 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2531 msgid "Supported hardware."
2532 msgstr ""
2533
2534 #. type: section
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
2537 #, no-wrap
2538 msgid "USB Stick and DVD Installation"
2539 msgstr ""
2540
2541 #. type: menuentry
2542 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2543 msgid "Preparing the installation medium."
2544 msgstr ""
2545
2546 #. type: section
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
2549 #, no-wrap
2550 msgid "Preparing for Installation"
2551 msgstr ""
2552
2553 #. type: menuentry
2554 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2555 msgid "Networking, partitioning, etc."
2556 msgstr ""
2557
2558 #. type: section
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
2561 #, no-wrap
2562 msgid "Guided Graphical Installation"
2563 msgstr ""
2564
2565 #. type: menuentry
2566 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2567 msgid "Easy graphical installation."
2568 msgstr ""
2569
2570 #. type: section
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
2574 #, no-wrap
2575 msgid "Manual Installation"
2576 msgstr ""
2577
2578 #. type: menuentry
2579 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2580 msgid "Manual installation for wizards."
2581 msgstr ""
2582
2583 #. type: section
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
2586 #, no-wrap
2587 msgid "After System Installation"
2588 msgstr ""
2589
2590 #. type: menuentry
2591 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2592 msgid "When installation succeeded."
2593 msgstr ""
2594
2595 #. type: node
2596 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2597 #: guix-git/doc/guix.texi:2634
2598 #, no-wrap
2599 msgid "Installing Guix in a VM"
2600 msgstr ""
2601
2602 #. type: menuentry
2603 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2604 msgid "Guix System playground."
2605 msgstr ""
2606
2607 #. type: section
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
2610 #, no-wrap
2611 msgid "Building the Installation Image"
2612 msgstr ""
2613
2614 #. type: menuentry
2615 #: guix-git/doc/guix.texi:209 guix-git/doc/guix.texi:2034
2616 msgid "How this comes to be."
2617 msgstr ""
2618
2619 #. type: node
2620 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2621 #: guix-git/doc/guix.texi:2252
2622 #, no-wrap
2623 msgid "Keyboard Layout and Networking and Partitioning"
2624 msgstr ""
2625
2626 #. type: menuentry
2627 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2628 msgid "Initial setup."
2629 msgstr ""
2630
2631 #. type: subsection
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
2634 #, no-wrap
2635 msgid "Proceeding with the Installation"
2636 msgstr ""
2637
2638 #. type: menuentry
2639 #: guix-git/doc/guix.texi:214 guix-git/doc/guix.texi:2250
2640 msgid "Installing."
2641 msgstr ""
2642
2643 #. type: section
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
2646 #, no-wrap
2647 msgid "Features"
2648 msgstr "Možnosti"
2649
2650 #. type: menuentry
2651 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2652 msgid "How Guix will make your life brighter."
2653 msgstr ""
2654
2655 #. type: node
2656 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2657 #: guix-git/doc/guix.texi:3049
2658 #, no-wrap
2659 msgid "Invoking guix package"
2660 msgstr ""
2661
2662 #. type: menuentry
2663 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2664 msgid "Package installation, removal, etc."
2665 msgstr ""
2666
2667 #. type: section
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
2671 #, no-wrap
2672 msgid "Substitutes"
2673 msgstr ""
2674
2675 #. type: menuentry
2676 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2677 msgid "Downloading pre-built binaries."
2678 msgstr ""
2679
2680 #. type: section
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
2683 #, no-wrap
2684 msgid "Packages with Multiple Outputs"
2685 msgstr ""
2686
2687 #. type: menuentry
2688 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2689 msgid "Single source package, multiple outputs."
2690 msgstr ""
2691
2692 #. type: node
2693 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2694 #: guix-git/doc/guix.texi:4050
2695 #, no-wrap
2696 msgid "Invoking guix gc"
2697 msgstr ""
2698
2699 #. type: menuentry
2700 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2701 msgid "Running the garbage collector."
2702 msgstr ""
2703
2704 #. type: node
2705 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2706 #: guix-git/doc/guix.texi:4260
2707 #, no-wrap
2708 msgid "Invoking guix pull"
2709 msgstr ""
2710
2711 #. type: menuentry
2712 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2713 msgid "Fetching the latest Guix and distribution."
2714 msgstr ""
2715
2716 #. type: node
2717 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2718 #: guix-git/doc/guix.texi:4507
2719 #, no-wrap
2720 msgid "Invoking guix time-machine"
2721 msgstr ""
2722
2723 #. type: menuentry
2724 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2725 msgid "Running an older revision of Guix."
2726 msgstr ""
2727
2728 #. type: section
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
2731 #, no-wrap
2732 msgid "Inferiors"
2733 msgstr ""
2734
2735 #. type: menuentry
2736 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2737 msgid "Interacting with another revision of Guix."
2738 msgstr ""
2739
2740 #. type: node
2741 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2742 #: guix-git/doc/guix.texi:4690
2743 #, no-wrap
2744 msgid "Invoking guix describe"
2745 msgstr ""
2746
2747 #. type: menuentry
2748 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2749 msgid "Display information about your Guix revision."
2750 msgstr ""
2751
2752 #. type: node
2753 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2754 #: guix-git/doc/guix.texi:4785
2755 #, no-wrap
2756 msgid "Invoking guix archive"
2757 msgstr ""
2758
2759 #. type: menuentry
2760 #: guix-git/doc/guix.texi:227 guix-git/doc/guix.texi:2957
2761 msgid "Exporting and importing store files."
2762 msgstr ""
2763
2764 #. type: subsection
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
2767 #, no-wrap
2768 msgid "Official Substitute Server"
2769 msgstr ""
2770
2771 #. type: menuentry
2772 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2773 msgid "One particular source of substitutes."
2774 msgstr ""
2775
2776 #. type: subsection
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
2779 #, no-wrap
2780 msgid "Substitute Server Authorization"
2781 msgstr ""
2782
2783 #. type: menuentry
2784 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2785 msgid "How to enable or disable substitutes."
2786 msgstr ""
2787
2788 #. type: subsection
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
2791 #, no-wrap
2792 msgid "Getting Substitutes from Other Servers"
2793 msgstr ""
2794
2795 #. type: menuentry
2796 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2797 msgid "Substitute diversity."
2798 msgstr ""
2799
2800 #. type: subsection
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
2803 #, no-wrap
2804 msgid "Substitute Authentication"
2805 msgstr ""
2806
2807 #. type: menuentry
2808 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2809 msgid "How Guix verifies substitutes."
2810 msgstr ""
2811
2812 #. type: subsection
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
2815 #, no-wrap
2816 msgid "Proxy Settings"
2817 msgstr ""
2818
2819 #. type: menuentry
2820 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2821 msgid "How to get substitutes via proxy."
2822 msgstr ""
2823
2824 #. type: subsection
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
2827 #, no-wrap
2828 msgid "Substitution Failure"
2829 msgstr ""
2830
2831 #. type: menuentry
2832 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2833 msgid "What happens when substitution fails."
2834 msgstr ""
2835
2836 #. type: subsection
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
2839 #, no-wrap
2840 msgid "On Trusting Binaries"
2841 msgstr ""
2842
2843 #. type: menuentry
2844 #: guix-git/doc/guix.texi:237 guix-git/doc/guix.texi:3689
2845 msgid "How can you trust that binary blob?"
2846 msgstr ""
2847
2848 #. type: section
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
2851 #, no-wrap
2852 msgid "Specifying Additional Channels"
2853 msgstr ""
2854
2855 #. type: menuentry
2856 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2857 msgid "Extending the package collection."
2858 msgstr ""
2859
2860 #. type: section
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
2863 #, no-wrap
2864 msgid "Using a Custom Guix Channel"
2865 msgstr ""
2866
2867 #. type: menuentry
2868 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2869 msgid "Using a customized Guix."
2870 msgstr ""
2871
2872 #. type: section
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
2875 #, no-wrap
2876 msgid "Replicating Guix"
2877 msgstr ""
2878
2879 #. type: menuentry
2880 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2881 msgid "Running the @emph{exact same} Guix."
2882 msgstr ""
2883
2884 #. type: section
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
2887 #, no-wrap
2888 msgid "Channel Authentication"
2889 msgstr ""
2890
2891 #. type: menuentry
2892 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2893 msgid "How Guix verifies what it fetches."
2894 msgstr ""
2895
2896 #. type: section
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
2899 #, no-wrap
2900 msgid "Channels with Substitutes"
2901 msgstr ""
2902
2903 #. type: menuentry
2904 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2905 msgid "Using channels with available substitutes."
2906 msgstr ""
2907
2908 #. type: section
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
2911 #, no-wrap
2912 msgid "Creating a Channel"
2913 msgstr ""
2914
2915 #. type: menuentry
2916 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2917 msgid "How to write your custom channel."
2918 msgstr ""
2919
2920 #. type: section
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
2923 #, no-wrap
2924 msgid "Package Modules in a Sub-directory"
2925 msgstr ""
2926
2927 #. type: menuentry
2928 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2929 msgid "Specifying the channel's package modules location."
2930 msgstr ""
2931
2932 #. type: section
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
2935 #, no-wrap
2936 msgid "Declaring Channel Dependencies"
2937 msgstr ""
2938
2939 #. type: menuentry
2940 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2941 msgid "How to depend on other channels."
2942 msgstr ""
2943
2944 #. type: section
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
2947 #, no-wrap
2948 msgid "Specifying Channel Authorizations"
2949 msgstr ""
2950
2951 #. type: menuentry
2952 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2953 msgid "Defining channel authors authorizations."
2954 msgstr ""
2955
2956 #. type: section
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
2959 #, no-wrap
2960 msgid "Primary URL"
2961 msgstr ""
2962
2963 #. type: menuentry
2964 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2965 msgid "Distinguishing mirror to original."
2966 msgstr ""
2967
2968 #. type: section
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
2971 #, no-wrap
2972 msgid "Writing Channel News"
2973 msgstr ""
2974
2975 #. type: menuentry
2976 #: guix-git/doc/guix.texi:251 guix-git/doc/guix.texi:5006
2977 msgid "Communicating information to channel's users."
2978 msgstr ""
2979
2980 #. type: node
2981 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2982 #: guix-git/doc/guix.texi:5524
2983 #, no-wrap
2984 msgid "Invoking guix environment"
2985 msgstr ""
2986
2987 #. type: menuentry
2988 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2989 msgid "Setting up development environments."
2990 msgstr ""
2991
2992 #. type: node
2993 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
2994 #: guix-git/doc/guix.texi:5884
2995 #, no-wrap
2996 msgid "Invoking guix pack"
2997 msgstr ""
2998
2999 #. type: menuentry
3000 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3001 msgid "Creating software bundles."
3002 msgstr ""
3003
3004 #. type: section
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
3007 #, no-wrap
3008 msgid "The GCC toolchain"
3009 msgstr ""
3010
3011 #. type: menuentry
3012 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3013 msgid "Working with languages supported by GCC."
3014 msgstr ""
3015
3016 #. type: node
3017 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3018 #: guix-git/doc/guix.texi:6267
3019 #, no-wrap
3020 msgid "Invoking guix git authenticate"
3021 msgstr ""
3022
3023 #. type: menuentry
3024 #: guix-git/doc/guix.texi:258 guix-git/doc/guix.texi:5522
3025 msgid "Authenticating Git repositories."
3026 msgstr ""
3027
3028 #. type: section
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
3031 #, no-wrap
3032 msgid "Package Modules"
3033 msgstr ""
3034
3035 #. type: menuentry
3036 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3037 msgid "Packages from the programmer's viewpoint."
3038 msgstr ""
3039
3040 #. type: section
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
3044 #, no-wrap
3045 msgid "Defining Packages"
3046 msgstr ""
3047
3048 #. type: menuentry
3049 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3050 msgid "Defining new packages."
3051 msgstr ""
3052
3053 #. type: section
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
3056 #, no-wrap
3057 msgid "Defining Package Variants"
3058 msgstr ""
3059
3060 #. type: menuentry
3061 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3062 msgid "Customizing packages."
3063 msgstr ""
3064
3065 #. type: section
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
3068 #, no-wrap
3069 msgid "Build Systems"
3070 msgstr ""
3071
3072 #. type: menuentry
3073 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3074 msgid "Specifying how packages are built."
3075 msgstr ""
3076
3077 #. type: subsection
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
3081 #, no-wrap
3082 msgid "Build Phases"
3083 msgstr ""
3084
3085 #. type: menuentry
3086 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3087 msgid "Phases of the build process of a package."
3088 msgstr ""
3089
3090 #. type: section
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
3093 #, no-wrap
3094 msgid "Build Utilities"
3095 msgstr ""
3096
3097 #. type: menuentry
3098 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3099 msgid "Helpers for your package definitions and more."
3100 msgstr ""
3101
3102 #. type: section
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
3105 #, no-wrap
3106 msgid "The Store"
3107 msgstr ""
3108
3109 #. type: menuentry
3110 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3111 msgid "Manipulating the package store."
3112 msgstr ""
3113
3114 #. type: section
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
3117 #, no-wrap
3118 msgid "Derivations"
3119 msgstr ""
3120
3121 #. type: menuentry
3122 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3123 msgid "Low-level interface to package derivations."
3124 msgstr ""
3125
3126 #. type: section
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
3129 #, no-wrap
3130 msgid "The Store Monad"
3131 msgstr ""
3132
3133 #. type: menuentry
3134 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3135 msgid "Purely functional interface to the store."
3136 msgstr ""
3137
3138 #. type: section
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
3141 #, no-wrap
3142 msgid "G-Expressions"
3143 msgstr ""
3144
3145 #. type: menuentry
3146 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3147 msgid "Manipulating build expressions."
3148 msgstr ""
3149
3150 #. type: node
3151 #: guix-git/doc/guix.texi:272 guix-git/doc/guix.texi:6369
3152 #: guix-git/doc/guix.texi:10025
3153 #, no-wrap
3154 msgid "Invoking guix repl"
3155 msgstr ""
3156
3157 #. type: menuentry
3158 #: guix-git/doc/guix.texi:272
3159 msgid "Programming Guix in Guile."
3160 msgstr ""
3161
3162 #. type: node
3163 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3164 #: guix-git/doc/guix.texi:6639
3165 #, no-wrap
3166 msgid "package Reference"
3167 msgstr ""
3168
3169 #. type: menuentry
3170 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3171 msgid "The package data type."
3172 msgstr ""
3173
3174 #. type: node
3175 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3176 #: guix-git/doc/guix.texi:6810
3177 #, no-wrap
3178 msgid "origin Reference"
3179 msgstr ""
3180
3181 #. type: menuentry
3182 #: guix-git/doc/guix.texi:277 guix-git/doc/guix.texi:6636
3183 msgid "The origin data type."
3184 msgstr ""
3185
3186 #. type: node
3187 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3188 #: guix-git/doc/guix.texi:10151
3189 #, no-wrap
3190 msgid "Invoking guix build"
3191 msgstr ""
3192
3193 #. type: menuentry
3194 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3195 msgid "Building packages from the command line."
3196 msgstr ""
3197
3198 #. type: node
3199 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3200 #: guix-git/doc/guix.texi:10987
3201 #, no-wrap
3202 msgid "Invoking guix edit"
3203 msgstr ""
3204
3205 #. type: menuentry
3206 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3207 msgid "Editing package definitions."
3208 msgstr ""
3209
3210 #. type: node
3211 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3212 #: guix-git/doc/guix.texi:11017
3213 #, no-wrap
3214 msgid "Invoking guix download"
3215 msgstr ""
3216
3217 #. type: menuentry
3218 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3219 msgid "Downloading a file and printing its hash."
3220 msgstr ""
3221
3222 #. type: node
3223 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3224 #: guix-git/doc/guix.texi:11075
3225 #, no-wrap
3226 msgid "Invoking guix hash"
3227 msgstr ""
3228
3229 #. type: menuentry
3230 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3231 msgid "Computing the cryptographic hash of a file."
3232 msgstr ""
3233
3234 #. type: node
3235 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3236 #: guix-git/doc/guix.texi:11147
3237 #, no-wrap
3238 msgid "Invoking guix import"
3239 msgstr ""
3240
3241 #. type: menuentry
3242 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3243 msgid "Importing package definitions."
3244 msgstr ""
3245
3246 #. type: node
3247 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3248 #: guix-git/doc/guix.texi:11602
3249 #, no-wrap
3250 msgid "Invoking guix refresh"
3251 msgstr ""
3252
3253 #. type: menuentry
3254 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3255 msgid "Updating package definitions."
3256 msgstr ""
3257
3258 #. type: node
3259 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3260 #: guix-git/doc/guix.texi:11938
3261 #, no-wrap
3262 msgid "Invoking guix lint"
3263 msgstr ""
3264
3265 #. type: menuentry
3266 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3267 msgid "Finding errors in package definitions."
3268 msgstr ""
3269
3270 #. type: node
3271 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3272 #: guix-git/doc/guix.texi:12107
3273 #, no-wrap
3274 msgid "Invoking guix size"
3275 msgstr ""
3276
3277 #. type: menuentry
3278 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3279 msgid "Profiling disk usage."
3280 msgstr ""
3281
3282 #. type: node
3283 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3284 #: guix-git/doc/guix.texi:12251
3285 #, no-wrap
3286 msgid "Invoking guix graph"
3287 msgstr ""
3288
3289 #. type: menuentry
3290 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3291 msgid "Visualizing the graph of packages."
3292 msgstr ""
3293
3294 #. type: node
3295 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3296 #: guix-git/doc/guix.texi:12518
3297 #, no-wrap
3298 msgid "Invoking guix publish"
3299 msgstr ""
3300
3301 #. type: menuentry
3302 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3303 msgid "Sharing substitutes."
3304 msgstr ""
3305
3306 #. type: node
3307 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3308 #: guix-git/doc/guix.texi:12777
3309 #, no-wrap
3310 msgid "Invoking guix challenge"
3311 msgstr ""
3312
3313 #. type: menuentry
3314 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3315 msgid "Challenging substitute servers."
3316 msgstr ""
3317
3318 #. type: node
3319 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3320 #: guix-git/doc/guix.texi:12960
3321 #, no-wrap
3322 msgid "Invoking guix copy"
3323 msgstr ""
3324
3325 #. type: menuentry
3326 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3327 msgid "Copying to and from a remote store."
3328 msgstr ""
3329
3330 #. type: node
3331 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3332 #: guix-git/doc/guix.texi:13023
3333 #, no-wrap
3334 msgid "Invoking guix container"
3335 msgstr ""
3336
3337 #. type: menuentry
3338 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3339 msgid "Process isolation."
3340 msgstr ""
3341
3342 #. type: node
3343 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3344 #: guix-git/doc/guix.texi:13077
3345 #, no-wrap
3346 msgid "Invoking guix weather"
3347 msgstr ""
3348
3349 #. type: menuentry
3350 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3351 msgid "Assessing substitute availability."
3352 msgstr ""
3353
3354 #. type: node
3355 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3356 #: guix-git/doc/guix.texi:13207
3357 #, no-wrap
3358 msgid "Invoking guix processes"
3359 msgstr ""
3360
3361 #. type: menuentry
3362 #: guix-git/doc/guix.texi:295 guix-git/doc/guix.texi:10149
3363 msgid "Listing client processes."
3364 msgstr ""
3365
3366 #. type: section
3367 #: guix-git/doc/guix.texi:297 guix-git/doc/guix.texi:10152
3368 #, no-wrap
3369 msgid "Invoking @command{guix build}"
3370 msgstr ""
3371
3372 #. type: subsection
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
3375 #, no-wrap
3376 msgid "Common Build Options"
3377 msgstr ""
3378
3379 #. type: menuentry
3380 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3381 msgid "Build options for most commands."
3382 msgstr ""
3383
3384 #. type: subsection
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
3387 #, no-wrap
3388 msgid "Package Transformation Options"
3389 msgstr ""
3390
3391 #. type: menuentry
3392 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3393 msgid "Creating variants of packages."
3394 msgstr ""
3395
3396 #. type: subsection
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
3399 #, no-wrap
3400 msgid "Additional Build Options"
3401 msgstr ""
3402
3403 #. type: menuentry
3404 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3405 msgid "Options specific to 'guix build'."
3406 msgstr ""
3407
3408 #. type: subsection
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
3411 #, no-wrap
3412 msgid "Debugging Build Failures"
3413 msgstr ""
3414
3415 #. type: menuentry
3416 #: guix-git/doc/guix.texi:302 guix-git/doc/guix.texi:10203
3417 msgid "Real life packaging experience."
3418 msgstr ""
3419
3420 #. type: section
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
3423 #, no-wrap
3424 msgid "Using the Configuration System"
3425 msgstr ""
3426
3427 #. type: menuentry
3428 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3429 msgid "Customizing your GNU system."
3430 msgstr ""
3431
3432 #. type: node
3433 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3434 #: guix-git/doc/guix.texi:13598
3435 #, no-wrap
3436 msgid "operating-system Reference"
3437 msgstr ""
3438
3439 #. type: menuentry
3440 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3441 msgid "Detail of operating-system declarations."
3442 msgstr ""
3443
3444 #. type: section
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
3447 #, no-wrap
3448 msgid "File Systems"
3449 msgstr ""
3450
3451 #. type: menuentry
3452 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3453 msgid "Configuring file system mounts."
3454 msgstr ""
3455
3456 #. type: section
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
3459 #, no-wrap
3460 msgid "Mapped Devices"
3461 msgstr ""
3462
3463 #. type: menuentry
3464 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3465 msgid "Block device extra processing."
3466 msgstr ""
3467
3468 #. type: section
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
3471 #, no-wrap
3472 msgid "User Accounts"
3473 msgstr ""
3474
3475 #. type: menuentry
3476 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3477 msgid "Specifying user accounts."
3478 msgstr ""
3479
3480 #. type: section
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
3484 #, no-wrap
3485 msgid "Keyboard Layout"
3486 msgstr ""
3487
3488 #. type: menuentry
3489 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3490 msgid "How the system interprets key strokes."
3491 msgstr ""
3492
3493 #. type: section
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
3497 #, no-wrap
3498 msgid "Locales"
3499 msgstr ""
3500
3501 #. type: menuentry
3502 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3503 msgid "Language and cultural convention settings."
3504 msgstr ""
3505
3506 #. type: section
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
3510 #, no-wrap
3511 msgid "Services"
3512 msgstr "Služby"
3513
3514 #. type: menuentry
3515 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3516 msgid "Specifying system services."
3517 msgstr ""
3518
3519 #. type: section
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
3522 #, no-wrap
3523 msgid "Setuid Programs"
3524 msgstr ""
3525
3526 #. type: menuentry
3527 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3528 msgid "Programs running with root privileges."
3529 msgstr ""
3530
3531 #. type: section
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
3535 #, no-wrap
3536 msgid "X.509 Certificates"
3537 msgstr ""
3538
3539 #. type: menuentry
3540 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3541 msgid "Authenticating HTTPS servers."
3542 msgstr ""
3543
3544 #. type: section
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
3548 #, no-wrap
3549 msgid "Name Service Switch"
3550 msgstr ""
3551
3552 #. type: menuentry
3553 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3554 msgid "Configuring libc's name service switch."
3555 msgstr ""
3556
3557 #. type: section
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
3560 #, no-wrap
3561 msgid "Initial RAM Disk"
3562 msgstr ""
3563
3564 #. type: menuentry
3565 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3566 msgid "Linux-Libre bootstrapping."
3567 msgstr ""
3568
3569 #. type: section
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
3572 #, no-wrap
3573 msgid "Bootloader Configuration"
3574 msgstr ""
3575
3576 #. type: menuentry
3577 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3578 msgid "Configuring the boot loader."
3579 msgstr ""
3580
3581 #. type: node
3582 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3583 #: guix-git/doc/guix.texi:32697
3584 #, no-wrap
3585 msgid "Invoking guix system"
3586 msgstr ""
3587
3588 #. type: menuentry
3589 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3590 msgid "Instantiating a system configuration."
3591 msgstr ""
3592
3593 #. type: node
3594 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3595 #: guix-git/doc/guix.texi:33282
3596 #, no-wrap
3597 msgid "Invoking guix deploy"
3598 msgstr ""
3599
3600 #. type: menuentry
3601 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3602 msgid "Deploying a system configuration to a remote host."
3603 msgstr ""
3604
3605 #. type: node
3606 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3607 #: guix-git/doc/guix.texi:33488
3608 #, no-wrap
3609 msgid "Running Guix in a VM"
3610 msgstr ""
3611
3612 #. type: menuentry
3613 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3614 msgid "How to run Guix System in a virtual machine."
3615 msgstr ""
3616
3617 #. type: section
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
3621 #, no-wrap
3622 msgid "Defining Services"
3623 msgstr ""
3624
3625 #. type: menuentry
3626 #: guix-git/doc/guix.texi:322 guix-git/doc/guix.texi:13348
3627 msgid "Adding new service definitions."
3628 msgstr ""
3629
3630 #. type: subsection
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
3633 #, no-wrap
3634 msgid "Base Services"
3635 msgstr ""
3636
3637 #. type: menuentry
3638 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3639 msgid "Essential system services."
3640 msgstr ""
3641
3642 #. type: subsection
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
3645 #, no-wrap
3646 msgid "Scheduled Job Execution"
3647 msgstr ""
3648
3649 #. type: menuentry
3650 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3651 msgid "The mcron service."
3652 msgstr ""
3653
3654 #. type: subsection
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
3657 #, no-wrap
3658 msgid "Log Rotation"
3659 msgstr ""
3660
3661 #. type: menuentry
3662 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3663 msgid "The rottlog service."
3664 msgstr ""
3665
3666 #. type: subsection
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
3669 #, no-wrap
3670 msgid "Networking Services"
3671 msgstr ""
3672
3673 #. type: menuentry
3674 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3675 msgid "Network setup, SSH daemon, etc."
3676 msgstr ""
3677
3678 #. type: subsection
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
3681 #, no-wrap
3682 msgid "Unattended Upgrades"
3683 msgstr ""
3684
3685 #. type: menuentry
3686 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3687 msgid "Automated system upgrades."
3688 msgstr ""
3689
3690 #. type: subsection
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
3693 #, no-wrap
3694 msgid "X Window"
3695 msgstr ""
3696
3697 #. type: menuentry
3698 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3699 msgid "Graphical display."
3700 msgstr ""
3701
3702 #. type: subsection
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
3705 #, no-wrap
3706 msgid "Printing Services"
3707 msgstr ""
3708
3709 #. type: menuentry
3710 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3711 msgid "Local and remote printer support."
3712 msgstr ""
3713
3714 #. type: subsection
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
3717 #, no-wrap
3718 msgid "Desktop Services"
3719 msgstr ""
3720
3721 #. type: menuentry
3722 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3723 msgid "D-Bus and desktop services."
3724 msgstr ""
3725
3726 #. type: subsection
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
3729 #, no-wrap
3730 msgid "Sound Services"
3731 msgstr ""
3732
3733 #. type: menuentry
3734 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3735 msgid "ALSA and Pulseaudio services."
3736 msgstr ""
3737
3738 #. type: subsection
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
3741 #, no-wrap
3742 msgid "Database Services"
3743 msgstr ""
3744
3745 #. type: menuentry
3746 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3747 msgid "SQL databases, key-value stores, etc."
3748 msgstr ""
3749
3750 #. type: subsection
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
3753 #, no-wrap
3754 msgid "Mail Services"
3755 msgstr ""
3756
3757 #. type: menuentry
3758 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3759 msgid "IMAP, POP3, SMTP, and all that."
3760 msgstr ""
3761
3762 #. type: subsection
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
3765 #, no-wrap
3766 msgid "Messaging Services"
3767 msgstr ""
3768
3769 #. type: menuentry
3770 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3771 msgid "Messaging services."
3772 msgstr ""
3773
3774 #. type: subsection
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
3777 #, no-wrap
3778 msgid "Telephony Services"
3779 msgstr ""
3780
3781 #. type: menuentry
3782 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3783 msgid "Telephony services."
3784 msgstr ""
3785
3786 #. type: subsection
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
3789 #, no-wrap
3790 msgid "Monitoring Services"
3791 msgstr ""
3792
3793 #. type: menuentry
3794 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3795 msgid "Monitoring services."
3796 msgstr ""
3797
3798 #. type: subsection
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
3801 #, no-wrap
3802 msgid "Kerberos Services"
3803 msgstr ""
3804
3805 #. type: menuentry
3806 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3807 msgid "Kerberos services."
3808 msgstr ""
3809
3810 #. type: subsection
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
3813 #, no-wrap
3814 msgid "LDAP Services"
3815 msgstr ""
3816
3817 #. type: menuentry
3818 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3819 msgid "LDAP services."
3820 msgstr ""
3821
3822 #. type: subsection
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
3825 #, no-wrap
3826 msgid "Web Services"
3827 msgstr ""
3828
3829 #. type: menuentry
3830 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3831 msgid "Web servers."
3832 msgstr ""
3833
3834 #. type: subsection
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
3837 #, no-wrap
3838 msgid "Certificate Services"
3839 msgstr ""
3840
3841 #. type: menuentry
3842 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3843 msgid "TLS certificates via Let's Encrypt."
3844 msgstr ""
3845
3846 #. type: subsection
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
3849 #, no-wrap
3850 msgid "DNS Services"
3851 msgstr ""
3852
3853 #. type: menuentry
3854 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3855 msgid "DNS daemons."
3856 msgstr ""
3857
3858 #. type: subsection
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
3861 #, no-wrap
3862 msgid "VPN Services"
3863 msgstr ""
3864
3865 #. type: menuentry
3866 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3867 msgid "VPN daemons."
3868 msgstr ""
3869
3870 #. type: subsection
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
3873 #, no-wrap
3874 msgid "Network File System"
3875 msgstr ""
3876
3877 #. type: menuentry
3878 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3879 msgid "NFS related services."
3880 msgstr ""
3881
3882 #. type: subsection
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
3885 #, no-wrap
3886 msgid "Continuous Integration"
3887 msgstr ""
3888
3889 #. type: menuentry
3890 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3891 msgid "Cuirass and Laminar services."
3892 msgstr ""
3893
3894 #. type: subsection
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
3897 #, no-wrap
3898 msgid "Power Management Services"
3899 msgstr ""
3900
3901 #. type: menuentry
3902 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3903 msgid "Extending battery life."
3904 msgstr ""
3905
3906 #. type: subsection
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
3909 #, no-wrap
3910 msgid "Audio Services"
3911 msgstr ""
3912
3913 #. type: menuentry
3914 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3915 msgid "The MPD."
3916 msgstr ""
3917
3918 #. type: subsection
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
3921 #, no-wrap
3922 msgid "Virtualization Services"
3923 msgstr ""
3924
3925 #. type: menuentry
3926 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3927 msgid "Virtualization services."
3928 msgstr ""
3929
3930 #. type: subsection
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
3933 #, no-wrap
3934 msgid "Version Control Services"
3935 msgstr ""
3936
3937 #. type: menuentry
3938 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3939 msgid "Providing remote access to Git repositories."
3940 msgstr ""
3941
3942 #. type: subsection
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
3945 #, no-wrap
3946 msgid "Game Services"
3947 msgstr ""
3948
3949 #. type: menuentry
3950 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3951 msgid "Game servers."
3952 msgstr ""
3953
3954 #. type: subsection
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
3957 #, no-wrap
3958 msgid "PAM Mount Service"
3959 msgstr ""
3960
3961 #. type: menuentry
3962 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3963 msgid "Service to mount volumes when logging in."
3964 msgstr ""
3965
3966 #. type: subsection
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
3969 #, no-wrap
3970 msgid "Guix Services"
3971 msgstr ""
3972
3973 #. type: menuentry
3974 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3975 msgid "Services relating specifically to Guix."
3976 msgstr ""
3977
3978 #. type: subsection
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
3981 #, no-wrap
3982 msgid "Linux Services"
3983 msgstr ""
3984
3985 #. type: menuentry
3986 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3987 msgid "Services tied to the Linux kernel."
3988 msgstr ""
3989
3990 #. type: subsection
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
3993 #, no-wrap
3994 msgid "Hurd Services"
3995 msgstr ""
3996
3997 #. type: menuentry
3998 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
3999 msgid "Services specific for a Hurd System."
4000 msgstr ""
4001
4002 #. type: subsection
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
4005 #, no-wrap
4006 msgid "Miscellaneous Services"
4007 msgstr ""
4008
4009 #. type: menuentry
4010 #: guix-git/doc/guix.texi:357 guix-git/doc/guix.texi:14866
4011 msgid "Other services."
4012 msgstr ""
4013
4014 #. type: subsection
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
4017 #, no-wrap
4018 msgid "Service Composition"
4019 msgstr ""
4020
4021 #. type: menuentry
4022 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4023 msgid "The model for composing services."
4024 msgstr ""
4025
4026 #. type: subsection
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
4029 #, no-wrap
4030 msgid "Service Types and Services"
4031 msgstr ""
4032
4033 #. type: menuentry
4034 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4035 msgid "Types and services."
4036 msgstr ""
4037
4038 #. type: subsection
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
4041 #, no-wrap
4042 msgid "Service Reference"
4043 msgstr ""
4044
4045 #. type: menuentry
4046 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4047 msgid "API reference."
4048 msgstr ""
4049
4050 #. type: subsection
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
4053 #, no-wrap
4054 msgid "Shepherd Services"
4055 msgstr ""
4056
4057 #. type: menuentry
4058 #: guix-git/doc/guix.texi:364 guix-git/doc/guix.texi:33630
4059 msgid "A particular type of service."
4060 msgstr ""
4061
4062 #. type: section
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
4065 #, no-wrap
4066 msgid "Separate Debug Info"
4067 msgstr ""
4068
4069 #. type: menuentry
4070 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4071 msgid "Installing 'debug' outputs."
4072 msgstr ""
4073
4074 #. type: section
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
4077 #, no-wrap
4078 msgid "Rebuilding Debug Info"
4079 msgstr ""
4080
4081 #. type: menuentry
4082 #: guix-git/doc/guix.texi:369 guix-git/doc/guix.texi:34417
4083 msgid "Building missing debug info."
4084 msgstr ""
4085
4086 #. type: node
4087 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4088 #: guix-git/doc/guix.texi:34697
4089 #, no-wrap
4090 msgid "Reduced Binary Seed Bootstrap"
4091 msgstr ""
4092
4093 #. type: menuentry
4094 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4095 msgid "A Bootstrap worthy of GNU."
4096 msgstr ""
4097
4098 #. type: section
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
4101 #, no-wrap
4102 msgid "Preparing to Use the Bootstrap Binaries"
4103 msgstr ""
4104
4105 #. type: menuentry
4106 #: guix-git/doc/guix.texi:374 guix-git/doc/guix.texi:34695
4107 msgid "Building that what matters most."
4108 msgstr ""
4109
4110 #. type: cindex
4111 #: guix-git/doc/guix.texi:382
4112 #, no-wrap
4113 msgid "purpose"
4114 msgstr ""
4115
4116 #. type: Plain text
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."
4119 msgstr ""
4120
4121 #. type: cindex
4122 #: guix-git/doc/guix.texi:391 guix-git/doc/guix.texi:466
4123 #, no-wrap
4124 msgid "Guix System"
4125 msgstr ""
4126
4127 #. type: cindex
4128 #: guix-git/doc/guix.texi:392
4129 #, no-wrap
4130 msgid "GuixSD, now Guix System"
4131 msgstr ""
4132
4133 #. type: cindex
4134 #: guix-git/doc/guix.texi:393
4135 #, no-wrap
4136 msgid "Guix System Distribution, now Guix System"
4137 msgstr ""
4138
4139 #. type: Plain text
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}."
4142 msgstr ""
4143
4144 #. type: cindex
4145 #: guix-git/doc/guix.texi:411
4146 #, no-wrap
4147 msgid "user interfaces"
4148 msgstr ""
4149
4150 #. type: Plain text
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})."
4153 msgstr ""
4154
4155 #. type: cindex
4156 #: guix-git/doc/guix.texi:417
4157 #, no-wrap
4158 msgid "build daemon"
4159 msgstr ""
4160
4161 #. type: Plain text
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})."
4164 msgstr ""
4165
4166 #. type: cindex
4167 #: guix-git/doc/guix.texi:422
4168 #, no-wrap
4169 msgid "extensibility of the distribution"
4170 msgstr ""
4171
4172 #. type: cindex
4173 #: guix-git/doc/guix.texi:423 guix-git/doc/guix.texi:6393
4174 #, no-wrap
4175 msgid "customization, of packages"
4176 msgstr ""
4177
4178 #. type: Plain text
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})."
4181 msgstr ""
4182
4183 #. type: cindex
4184 #: guix-git/doc/guix.texi:433
4185 #, no-wrap
4186 msgid "functional package management"
4187 msgstr ""
4188
4189 #. type: cindex
4190 #: guix-git/doc/guix.texi:434
4191 #, no-wrap
4192 msgid "isolation"
4193 msgstr ""
4194
4195 #. type: Plain text
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."
4198 msgstr ""
4199
4200 #. type: cindex
4201 #: guix-git/doc/guix.texi:450 guix-git/doc/guix.texi:8733
4202 #, no-wrap
4203 msgid "store"
4204 msgstr ""
4205
4206 #. type: Plain text
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."
4209 msgstr ""
4210
4211 #. type: Plain text
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})."
4214 msgstr ""
4215
4216 #. type: Plain text
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."
4219 msgstr ""
4220
4221 #. type: Plain text
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}):"
4224 msgstr ""
4225
4226 #. type: example
4227 #: guix-git/doc/guix.texi:485
4228 #, no-wrap
4229 msgid "guix package --list-available\n"
4230 msgstr ""
4231
4232 #. type: Plain text
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."
4235 msgstr ""
4236
4237 #. type: Plain text
4238 #: guix-git/doc/guix.texi:493
4239 msgid "Packages are currently available on the following platforms:"
4240 msgstr ""
4241
4242 #. type: item
4243 #: guix-git/doc/guix.texi:496 guix-git/doc/guix.texi:2106
4244 #, no-wrap
4245 msgid "x86_64-linux"
4246 msgstr ""
4247
4248 #. type: table
4249 #: guix-git/doc/guix.texi:498
4250 msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel."
4251 msgstr ""
4252
4253 #. type: item
4254 #: guix-git/doc/guix.texi:499 guix-git/doc/guix.texi:2109
4255 #, no-wrap
4256 msgid "i686-linux"
4257 msgstr ""
4258
4259 #. type: table
4260 #: guix-git/doc/guix.texi:501
4261 msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel."
4262 msgstr ""
4263
4264 #. type: item
4265 #: guix-git/doc/guix.texi:502
4266 #, no-wrap
4267 msgid "armhf-linux"
4268 msgstr ""
4269
4270 #. type: table
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."
4273 msgstr ""
4274
4275 #. type: item
4276 #: guix-git/doc/guix.texi:507
4277 #, no-wrap
4278 msgid "aarch64-linux"
4279 msgstr ""
4280
4281 #. type: table
4282 #: guix-git/doc/guix.texi:509
4283 msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel."
4284 msgstr ""
4285
4286 #. type: item
4287 #: guix-git/doc/guix.texi:510
4288 #, no-wrap
4289 msgid "i586-gnu"
4290 msgstr ""
4291
4292 #. type: table
4293 #: guix-git/doc/guix.texi:513
4294 msgid "@uref{https://hurd.gnu.org, GNU/Hurd} on the Intel 32-bit architecture (IA32)."
4295 msgstr ""
4296
4297 #. type: table
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!"
4300 msgstr ""
4301
4302 #. type: item
4303 #: guix-git/doc/guix.texi:520
4304 #, no-wrap
4305 msgid "mips64el-linux (deprecated)"
4306 msgstr ""
4307
4308 #. type: table
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."
4311 msgstr ""
4312
4313 #. type: item
4314 #: guix-git/doc/guix.texi:527
4315 #, no-wrap
4316 msgid "powerpc64le-linux"
4317 msgstr ""
4318
4319 #. type: table
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!"
4322 msgstr ""
4323
4324 #. type: Plain text
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."
4327 msgstr ""
4328
4329 #. type: Plain text
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}."
4332 msgstr ""
4333
4334 #. type: Plain text
4335 #: guix-git/doc/guix.texi:554
4336 msgid "For information on porting to other architectures or kernels, @pxref{Porting}."
4337 msgstr ""
4338
4339 #. type: Plain text
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."
4342 msgstr ""
4343
4344 #. type: cindex
4345 #: guix-git/doc/guix.texi:563
4346 #, no-wrap
4347 msgid "installing Guix"
4348 msgstr ""
4349
4350 #. type: quotation
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."
4353 msgstr ""
4354
4355 #. type: cindex
4356 #: guix-git/doc/guix.texi:577 guix-git/doc/guix.texi:1781
4357 #, no-wrap
4358 msgid "foreign distro"
4359 msgstr ""
4360
4361 #. type: cindex
4362 #: guix-git/doc/guix.texi:578
4363 #, no-wrap
4364 msgid "directories related to foreign distro"
4365 msgstr ""
4366
4367 #. type: Plain text
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."
4370 msgstr ""
4371
4372 #. type: Plain text
4373 #: guix-git/doc/guix.texi:586
4374 msgid "Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull})."
4375 msgstr ""
4376
4377 #. type: Plain text
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."
4380 msgstr ""
4381
4382 #. type: cindex
4383 #: guix-git/doc/guix.texi:605
4384 #, no-wrap
4385 msgid "installing Guix from binaries"
4386 msgstr ""
4387
4388 #. type: cindex
4389 #: guix-git/doc/guix.texi:606
4390 #, no-wrap
4391 msgid "installer script"
4392 msgstr ""
4393
4394 #. type: Plain text
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."
4397 msgstr ""
4398
4399 #. type: quotation
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:"
4402 msgstr ""
4403
4404 #. type: example
4405 #: guix-git/doc/guix.texi:626
4406 #, no-wrap
4407 msgid ""
4408 "cd /tmp\n"
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"
4412 msgstr ""
4413
4414 #. type: quotation
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!"
4417 msgstr ""
4418
4419 #. type: Plain text
4420 #: guix-git/doc/guix.texi:633
4421 msgid "Installing goes along these lines:"
4422 msgstr ""
4423
4424 #. type: cindex
4425 #: guix-git/doc/guix.texi:636
4426 #, no-wrap
4427 msgid "downloading Guix binary"
4428 msgstr ""
4429
4430 #. type: enumerate
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})."
4433 msgstr ""
4434
4435 #. type: enumerate
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:"
4438 msgstr ""
4439
4440 #. type: example
4441 #: guix-git/doc/guix.texi:650
4442 #, no-wrap
4443 msgid ""
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"
4446 msgstr ""
4447
4448 #. type: Plain text
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:"
4451 msgstr ""
4452
4453 #. type: example
4454 #: guix-git/doc/guix.texi:658
4455 #, no-wrap
4456 msgid ""
4457 "$ wget '@value{OPENPGP-SIGNING-KEY-URL}' \\\n"
4458 " -qO - | gpg --import -\n"
4459 msgstr ""
4460
4461 #. type: Plain text
4462 #: guix-git/doc/guix.texi:662 guix-git/doc/guix.texi:2132
4463 msgid "and rerun the @code{gpg --verify} command."
4464 msgstr ""
4465
4466 #. type: Plain text
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."
4469 msgstr ""
4470
4471 #. type: enumerate
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:"
4474 msgstr ""
4475
4476 #. type: example
4477 #: guix-git/doc/guix.texi:677
4478 #, no-wrap
4479 msgid ""
4480 "# cd /tmp\n"
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"
4484 msgstr ""
4485
4486 #. type: enumerate
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)."
4489 msgstr ""
4490
4491 #. type: enumerate
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."
4494 msgstr ""
4495
4496 #. type: enumerate
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."
4499 msgstr ""
4500
4501 #. type: enumerate
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}):"
4504 msgstr ""
4505
4506 #. type: example
4507 #: guix-git/doc/guix.texi:704
4508 #, no-wrap
4509 msgid ""
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"
4513 msgstr ""
4514
4515 #. type: enumerate
4516 #: guix-git/doc/guix.texi:708
4517 msgid "Source @file{etc/profile} to augment @env{PATH} and other relevant environment variables:"
4518 msgstr ""
4519
4520 #. type: example
4521 #: guix-git/doc/guix.texi:712
4522 #, no-wrap
4523 msgid ""
4524 "# GUIX_PROFILE=\"`echo ~root`/.config/guix/current\" ; \\\n"
4525 " source $GUIX_PROFILE/etc/profile\n"
4526 msgstr ""
4527
4528 #. type: enumerate
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})."
4531 msgstr ""
4532
4533 #. type: enumerate
4534 #: guix-git/doc/guix.texi:720
4535 msgid "Run the daemon, and set it to automatically start on boot."
4536 msgstr ""
4537
4538 #. type: enumerate
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:"
4541 msgstr ""
4542
4543 #. type: example
4544 #: guix-git/doc/guix.texi:736
4545 #, no-wrap
4546 msgid ""
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"
4551 msgstr ""
4552
4553 #. type: itemize
4554 #: guix-git/doc/guix.texi:739 guix-git/doc/guix.texi:12767
4555 msgid "If your host distro uses the Upstart init system:"
4556 msgstr ""
4557
4558 #. type: example
4559 #: guix-git/doc/guix.texi:745
4560 #, no-wrap
4561 msgid ""
4562 "# initctl reload-configuration\n"
4563 "# cp ~root/.config/guix/current/lib/upstart/system/guix-daemon.conf \\\n"
4564 " /etc/init/\n"
4565 "# start guix-daemon\n"
4566 msgstr ""
4567
4568 #. type: enumerate
4569 #: guix-git/doc/guix.texi:748
4570 msgid "Otherwise, you can still start the daemon manually with:"
4571 msgstr ""
4572
4573 #. type: example
4574 #: guix-git/doc/guix.texi:752
4575 #, no-wrap
4576 msgid ""
4577 "# ~root/.config/guix/current/bin/guix-daemon \\\n"
4578 " --build-users-group=guixbuild\n"
4579 msgstr ""
4580
4581 #. type: enumerate
4582 #: guix-git/doc/guix.texi:757
4583 msgid "Make the @command{guix} command available to other users on the machine, for instance with:"
4584 msgstr ""
4585
4586 #. type: example
4587 #: guix-git/doc/guix.texi:762
4588 #, no-wrap
4589 msgid ""
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"
4593 msgstr ""
4594
4595 #. type: enumerate
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:"
4598 msgstr ""
4599
4600 #. type: example
4601 #: guix-git/doc/guix.texi:772
4602 #, no-wrap
4603 msgid ""
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"
4608 msgstr ""
4609
4610 #. type: enumerate
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)."
4613 msgstr ""
4614
4615 #. type: cindex
4616 #: guix-git/doc/guix.texi:780 guix-git/doc/guix.texi:3724
4617 #: guix-git/doc/guix.texi:15401
4618 #, no-wrap
4619 msgid "substitutes, authorization thereof"
4620 msgstr ""
4621
4622 #. type: enumerate
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:"
4625 msgstr ""
4626
4627 #. type: example
4628 #: guix-git/doc/guix.texi:787
4629 #, no-wrap
4630 msgid ""
4631 "# guix archive --authorize < \\\n"
4632 " ~root/.config/guix/current/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
4633 msgstr ""
4634
4635 #. type: enumerate
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}."
4638 msgstr ""
4639
4640 #. type: Plain text
4641 #: guix-git/doc/guix.texi:795
4642 msgid "Voilà, the installation is complete!"
4643 msgstr ""
4644
4645 #. type: Plain text
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:"
4648 msgstr ""
4649
4650 #. type: example
4651 #: guix-git/doc/guix.texi:801
4652 #, no-wrap
4653 msgid "# guix install hello\n"
4654 msgstr ""
4655
4656 #. type: Plain text
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:"
4659 msgstr ""
4660
4661 #. type: example
4662 #: guix-git/doc/guix.texi:808
4663 #, no-wrap
4664 msgid "make guix-binary.@var{system}.tar.xz\n"
4665 msgstr ""
4666
4667 #. type: Plain text
4668 #: guix-git/doc/guix.texi:812
4669 msgid "...@: which, in turn, runs:"
4670 msgstr ""
4671
4672 #. type: example
4673 #: guix-git/doc/guix.texi:816
4674 #, no-wrap
4675 msgid ""
4676 "guix pack -s @var{system} --localstatedir \\\n"
4677 " --profile-name=current-guix guix\n"
4678 msgstr ""
4679
4680 #. type: Plain text
4681 #: guix-git/doc/guix.texi:819
4682 msgid "@xref{Invoking guix pack}, for more info on this handy tool."
4683 msgstr ""
4684
4685 #. type: Plain text
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."
4688 msgstr ""
4689
4690 #. type: cindex
4691 #: guix-git/doc/guix.texi:828
4692 #, no-wrap
4693 msgid "official website"
4694 msgstr ""
4695
4696 #. type: Plain text
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/}."
4699 msgstr ""
4700
4701 #. type: Plain text
4702 #: guix-git/doc/guix.texi:833
4703 msgid "GNU Guix depends on the following packages:"
4704 msgstr ""
4705
4706 #. type: item
4707 #: guix-git/doc/guix.texi:835
4708 #, no-wrap
4709 msgid "@url{https://gnu.org/software/guile/, GNU Guile}, version 3.0.x or"
4710 msgstr ""
4711
4712 #. type: itemize
4713 #: guix-git/doc/guix.texi:837
4714 msgid "2.2.x;"
4715 msgstr ""
4716
4717 #. type: item
4718 #: guix-git/doc/guix.texi:837
4719 #, no-wrap
4720 msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version"
4721 msgstr ""
4722
4723 #. type: itemize
4724 #: guix-git/doc/guix.texi:839
4725 msgid "0.1.0 or later;"
4726 msgstr ""
4727
4728 #. type: itemize
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});"
4731 msgstr ""
4732
4733 #. type: itemize
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;"
4736 msgstr ""
4737
4738 #. type: item
4739 #: guix-git/doc/guix.texi:846
4740 #, no-wrap
4741 msgid "@uref{https://notabug.org/guile-zlib/guile-zlib, Guile-zlib},"
4742 msgstr ""
4743
4744 #. type: itemize
4745 #: guix-git/doc/guix.texi:848
4746 msgid "version 0.1.0 or later;"
4747 msgstr ""
4748
4749 #. type: item
4750 #: guix-git/doc/guix.texi:848
4751 #, no-wrap
4752 msgid "@uref{https://notabug.org/guile-lzlib/guile-lzlib, Guile-lzlib};"
4753 msgstr ""
4754
4755 #. type: item
4756 #: guix-git/doc/guix.texi:849
4757 #, no-wrap
4758 msgid "@uref{https://www.nongnu.org/guile-avahi/, Guile-Avahi};"
4759 msgstr ""
4760
4761 #. type: itemize
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;"
4764 msgstr ""
4765
4766 #. type: item
4767 #: guix-git/doc/guix.texi:855
4768 #, no-wrap
4769 msgid "@uref{https://savannah.nongnu.org/projects/guile-json/, Guile-JSON}"
4770 msgstr ""
4771
4772 #. type: itemize
4773 #: guix-git/doc/guix.texi:857
4774 msgid "4.3.0 or later;"
4775 msgstr ""
4776
4777 #. type: item
4778 #: guix-git/doc/guix.texi:857
4779 #, no-wrap
4780 msgid "@url{https://www.gnu.org/software/make/, GNU Make}."
4781 msgstr ""
4782
4783 #. type: Plain text
4784 #: guix-git/doc/guix.texi:861
4785 msgid "The following dependencies are optional:"
4786 msgstr ""
4787
4788 #. type: itemize
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."
4791 msgstr ""
4792
4793 #. type: itemize
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})."
4796 msgstr ""
4797
4798 #. type: itemize
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})."
4801 msgstr ""
4802
4803 #. type: itemize
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})."
4806 msgstr ""
4807
4808 #. type: itemize
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."
4811 msgstr ""
4812
4813 #. type: Plain text
4814 #: guix-git/doc/guix.texi:891
4815 msgid "Unless @option{--disable-daemon} was passed to @command{configure}, the following packages are also needed:"
4816 msgstr ""
4817
4818 #. type: item
4819 #: guix-git/doc/guix.texi:893
4820 #, no-wrap
4821 msgid "@url{https://gnupg.org/, GNU libgcrypt};"
4822 msgstr ""
4823
4824 #. type: item
4825 #: guix-git/doc/guix.texi:894
4826 #, no-wrap
4827 msgid "@url{https://sqlite.org, SQLite 3};"
4828 msgstr ""
4829
4830 #. type: item
4831 #: guix-git/doc/guix.texi:895
4832 #, no-wrap
4833 msgid "@url{https://gcc.gnu.org, GCC's g++}, with support for the"
4834 msgstr ""
4835
4836 #. type: itemize
4837 #: guix-git/doc/guix.texi:897
4838 msgid "C++11 standard."
4839 msgstr ""
4840
4841 #. type: cindex
4842 #: guix-git/doc/guix.texi:899
4843 #, no-wrap
4844 msgid "state directory"
4845 msgstr ""
4846
4847 #. type: Plain text
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})."
4850 msgstr ""
4851
4852 #. type: cindex
4853 #: guix-git/doc/guix.texi:912
4854 #, no-wrap
4855 msgid "test suite"
4856 msgstr ""
4857
4858 #. type: Plain text
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:"
4861 msgstr ""
4862
4863 #. type: example
4864 #: guix-git/doc/guix.texi:921
4865 #, no-wrap
4866 msgid "make check\n"
4867 msgstr ""
4868
4869 #. type: Plain text
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."
4872 msgstr ""
4873
4874 #. type: Plain text
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:"
4877 msgstr ""
4878
4879 #. type: example
4880 #: guix-git/doc/guix.texi:934
4881 #, no-wrap
4882 msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n"
4883 msgstr ""
4884
4885 #. type: Plain text
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:"
4888 msgstr ""
4889
4890 #. type: example
4891 #: guix-git/doc/guix.texi:942
4892 #, no-wrap
4893 msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n"
4894 msgstr ""
4895
4896 #. type: Plain text
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'':"
4899 msgstr ""
4900
4901 #. type: example
4902 #: guix-git/doc/guix.texi:954
4903 #, no-wrap
4904 msgid ""
4905 "export SCM_LOG_DRIVER_FLAGS=\"--select=^transaction-upgrade-entry\"\n"
4906 "make check TESTS=\"tests/packages.scm\"\n"
4907 msgstr ""
4908
4909 #. type: Plain text
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:"
4912 msgstr ""
4913
4914 #. type: example
4915 #: guix-git/doc/guix.texi:963
4916 #, no-wrap
4917 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --errors-only=yes\" VERBOSE=1\n"
4918 msgstr ""
4919
4920 #. type: Plain text
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}:"
4923 msgstr ""
4924
4925 #. type: example
4926 #: guix-git/doc/guix.texi:971
4927 #, no-wrap
4928 msgid "make check SCM_LOG_DRIVER_FLAGS=\"--brief=no --show-duration=yes\"\n"
4929 msgstr ""
4930
4931 #. type: Plain text
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."
4934 msgstr ""
4935
4936 #. type: Plain text
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."
4939 msgstr ""
4940
4941 #. type: Plain text
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:"
4944 msgstr ""
4945
4946 #. type: example
4947 #: guix-git/doc/guix.texi:987
4948 #, no-wrap
4949 msgid "make check-system\n"
4950 msgstr ""
4951
4952 #. type: Plain text
4953 #: guix-git/doc/guix.texi:991
4954 msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:"
4955 msgstr ""
4956
4957 #. type: example
4958 #: guix-git/doc/guix.texi:994
4959 #, no-wrap
4960 msgid "make check-system TESTS=\"basic mcron\"\n"
4961 msgstr ""
4962
4963 #. type: Plain text
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."
4966 msgstr ""
4967
4968 #. type: Plain text
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."
4971 msgstr ""
4972
4973 #. type: cindex
4974 #: guix-git/doc/guix.texi:1009
4975 #, no-wrap
4976 msgid "daemon"
4977 msgstr ""
4978
4979 #. type: Plain text
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."
4982 msgstr ""
4983
4984 #. type: Plain text
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."
4987 msgstr ""
4988
4989 #. type: cindex
4990 #: guix-git/doc/guix.texi:1031 guix-git/doc/guix.texi:1493
4991 #, no-wrap
4992 msgid "build environment"
4993 msgstr ""
4994
4995 #. type: Plain text
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."
4998 msgstr ""
4999
5000 #. type: cindex
5001 #: guix-git/doc/guix.texi:1040
5002 #, no-wrap
5003 msgid "build users"
5004 msgstr ""
5005
5006 #. type: Plain text
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})."
5009 msgstr ""
5010
5011 #. type: Plain text
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):"
5014 msgstr ""
5015
5016 #. type: example
5017 #: guix-git/doc/guix.texi:1066
5018 #, no-wrap
5019 msgid ""
5020 "# groupadd --system guixbuild\n"
5021 "# for i in $(seq -w 1 10);\n"
5022 " do\n"
5023 " useradd -g guixbuild -G guixbuild \\\n"
5024 " -d /var/empty -s $(which nologin) \\\n"
5025 " -c \"Guix build user $i\" --system \\\n"
5026 " guixbuilder$i;\n"
5027 " done\n"
5028 msgstr ""
5029
5030 #. type: Plain text
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})."
5033 msgstr ""
5034
5035 #. type: Plain text
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}.}:"
5038 msgstr ""
5039
5040 #. type: example
5041 #: guix-git/doc/guix.texi:1088 guix-git/doc/guix.texi:1486
5042 #, no-wrap
5043 msgid "# guix-daemon --build-users-group=guixbuild\n"
5044 msgstr ""
5045
5046 #. type: cindex
5047 #: guix-git/doc/guix.texi:1090 guix-git/doc/guix.texi:1491
5048 #, no-wrap
5049 msgid "chroot"
5050 msgstr ""
5051
5052 #. type: Plain text
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:"
5055 msgstr ""
5056
5057 #. type: itemize
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.};"
5060 msgstr ""
5061
5062 #. type: itemize
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;"
5065 msgstr ""
5066
5067 #. type: itemize
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};"
5070 msgstr ""
5071
5072 #. type: itemize
5073 #: guix-git/doc/guix.texi:1114
5074 msgid "@file{/etc/group} with an entry for the user's group;"
5075 msgstr ""
5076
5077 #. type: itemize
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};"
5080 msgstr ""
5081
5082 #. type: itemize
5083 #: guix-git/doc/guix.texi:1121
5084 msgid "a writable @file{/tmp} directory."
5085 msgstr ""
5086
5087 #. type: Plain text
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."
5090 msgstr ""
5091
5092 #. type: vindex
5093 #: guix-git/doc/guix.texi:1131 guix-git/doc/guix.texi:3929
5094 #, no-wrap
5095 msgid "http_proxy"
5096 msgstr ""
5097
5098 #. type: vindex
5099 #: guix-git/doc/guix.texi:1132 guix-git/doc/guix.texi:3930
5100 #, no-wrap
5101 msgid "https_proxy"
5102 msgstr ""
5103
5104 #. type: Plain text
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})."
5107 msgstr ""
5108
5109 #. type: Plain text
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."
5112 msgstr ""
5113
5114 #. type: subsection
5115 #: guix-git/doc/guix.texi:1148
5116 #, no-wrap
5117 msgid "Using the Offload Facility"
5118 msgstr ""
5119
5120 #. type: cindex
5121 #: guix-git/doc/guix.texi:1150 guix-git/doc/guix.texi:1552
5122 #, no-wrap
5123 msgid "offloading"
5124 msgstr ""
5125
5126 #. type: cindex
5127 #: guix-git/doc/guix.texi:1151
5128 #, no-wrap
5129 msgid "build hook"
5130 msgstr ""
5131
5132 #. type: Plain text
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:"
5135 msgstr ""
5136
5137 #. type: enumerate
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."
5140 msgstr ""
5141
5142 #. type: enumerate
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."
5145 msgstr ""
5146
5147 #. type: enumerate
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."
5150 msgstr ""
5151
5152 #. type: enumerate
5153 #: guix-git/doc/guix.texi:1188
5154 msgid "Disk space availability. More than a 100 MiB must be available."
5155 msgstr ""
5156
5157 #. type: Plain text
5158 #: guix-git/doc/guix.texi:1191
5159 msgid "The @file{/etc/guix/machines.scm} file typically looks like this:"
5160 msgstr ""
5161
5162 #. type: lisp
5163 #: guix-git/doc/guix.texi:1199
5164 #, no-wrap
5165 msgid ""
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"
5170 " (user \"bob\")\n"
5171 " (speed 2.)) ;incredibly fast!\n"
5172 "\n"
5173 msgstr ""
5174
5175 #. type: lisp
5176 #: guix-git/doc/guix.texi:1208
5177 #, no-wrap
5178 msgid ""
5179 " (build-machine\n"
5180 " (name \"armeight.example.org\")\n"
5181 " (systems (list \"aarch64-linux\"))\n"
5182 " (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n"
5183 " (user \"alice\")\n"
5184 " (private-key\n"
5185 " (string-append (getenv \"HOME\")\n"
5186 " \"/.ssh/identity-for-guix\"))))\n"
5187 msgstr ""
5188
5189 #. type: Plain text
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."
5192 msgstr ""
5193
5194 #. type: Plain text
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."
5197 msgstr ""
5198
5199 #. type: deftp
5200 #: guix-git/doc/guix.texi:1224
5201 #, no-wrap
5202 msgid "{Data Type} build-machine"
5203 msgstr ""
5204
5205 #. type: deftp
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:"
5208 msgstr ""
5209
5210 #. type: item
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
5221 #, no-wrap
5222 msgid "name"
5223 msgstr ""
5224
5225 #. type: table
5226 #: guix-git/doc/guix.texi:1232
5227 msgid "The host name of the remote machine."
5228 msgstr ""
5229
5230 #. type: item
5231 #: guix-git/doc/guix.texi:1233
5232 #, no-wrap
5233 msgid "systems"
5234 msgstr ""
5235
5236 #. type: table
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\")}."
5239 msgstr ""
5240
5241 #. type: code{#1}
5242 #: guix-git/doc/guix.texi:1237 guix-git/doc/guix.texi:16661
5243 #, no-wrap
5244 msgid "user"
5245 msgstr ""
5246
5247 #. type: table
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."
5250 msgstr ""
5251
5252 #. type: item
5253 #: guix-git/doc/guix.texi:1242
5254 #, no-wrap
5255 msgid "host-key"
5256 msgstr ""
5257
5258 #. type: table
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:"
5261 msgstr ""
5262
5263 #. type: example
5264 #: guix-git/doc/guix.texi:1249
5265 #, no-wrap
5266 msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n"
5267 msgstr ""
5268
5269 #. type: table
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}."
5272 msgstr ""
5273
5274 #. type: table
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}):"
5277 msgstr ""
5278
5279 #. type: example
5280 #: guix-git/doc/guix.texi:1263
5281 #, no-wrap
5282 msgid ""
5283 "$ lsh-export-key --openssh < /etc/lsh/host-key.pub\n"
5284 "ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n"
5285 msgstr ""
5286
5287 #. type: deftp
5288 #: guix-git/doc/guix.texi:1268
5289 msgid "A number of optional fields may be specified:"
5290 msgstr ""
5291
5292 #. type: item
5293 #: guix-git/doc/guix.texi:1271 guix-git/doc/guix.texi:33438
5294 #, no-wrap
5295 msgid "@code{port} (default: @code{22})"
5296 msgstr ""
5297
5298 #. type: table
5299 #: guix-git/doc/guix.texi:1273
5300 msgid "Port number of SSH server on the machine."
5301 msgstr ""
5302
5303 #. type: item
5304 #: guix-git/doc/guix.texi:1274
5305 #, no-wrap
5306 msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})"
5307 msgstr ""
5308
5309 #. type: table
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."
5312 msgstr ""
5313
5314 #. type: table
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."
5317 msgstr ""
5318
5319 #. type: item
5320 #: guix-git/doc/guix.texi:1281
5321 #, no-wrap
5322 msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})"
5323 msgstr ""
5324
5325 #. type: itemx
5326 #: guix-git/doc/guix.texi:1282
5327 #, no-wrap
5328 msgid "@code{compression-level} (default: @code{3})"
5329 msgstr ""
5330
5331 #. type: table
5332 #: guix-git/doc/guix.texi:1284
5333 msgid "The SSH-level compression methods and compression level requested."
5334 msgstr ""
5335
5336 #. type: table
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."
5339 msgstr ""
5340
5341 #. type: item
5342 #: guix-git/doc/guix.texi:1288
5343 #, no-wrap
5344 msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})"
5345 msgstr ""
5346
5347 #. type: table
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."
5350 msgstr ""
5351
5352 #. type: item
5353 #: guix-git/doc/guix.texi:1292
5354 #, no-wrap
5355 msgid "@code{overload-threshold} (default: @code{0.6})"
5356 msgstr ""
5357
5358 #. type: table
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}."
5361 msgstr ""
5362
5363 #. type: item
5364 #: guix-git/doc/guix.texi:1299
5365 #, no-wrap
5366 msgid "@code{parallel-builds} (default: @code{1})"
5367 msgstr ""
5368
5369 #. type: table
5370 #: guix-git/doc/guix.texi:1301
5371 msgid "The number of builds that may run in parallel on the machine."
5372 msgstr ""
5373
5374 #. type: item
5375 #: guix-git/doc/guix.texi:1302
5376 #, no-wrap
5377 msgid "@code{speed} (default: @code{1.0})"
5378 msgstr ""
5379
5380 #. type: table
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."
5383 msgstr ""
5384
5385 #. type: item
5386 #: guix-git/doc/guix.texi:1306
5387 #, no-wrap
5388 msgid "@code{features} (default: @code{'()})"
5389 msgstr ""
5390
5391 #. type: table
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."
5394 msgstr ""
5395
5396 #. type: Plain text
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:"
5399 msgstr ""
5400
5401 #. type: example
5402 #: guix-git/doc/guix.texi:1320
5403 #, no-wrap
5404 msgid "ssh build-machine guix repl --version\n"
5405 msgstr ""
5406
5407 #. type: Plain text
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}):"
5410 msgstr ""
5411
5412 #. type: example
5413 #: guix-git/doc/guix.texi:1330 guix-git/doc/guix.texi:33366
5414 #, no-wrap
5415 msgid "# guix archive --generate-key\n"
5416 msgstr ""
5417
5418 #. type: Plain text
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:"
5421 msgstr ""
5422
5423 #. type: example
5424 #: guix-git/doc/guix.texi:1338
5425 #, no-wrap
5426 msgid "# guix archive --authorize < master-public-key.txt\n"
5427 msgstr ""
5428
5429 #. type: Plain text
5430 #: guix-git/doc/guix.texi:1342
5431 msgid "Likewise, the master machine must authorize the key of each build machine."
5432 msgstr ""
5433
5434 #. type: Plain text
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."
5437 msgstr ""
5438
5439 #. type: cindex
5440 #: guix-git/doc/guix.texi:1349
5441 #, no-wrap
5442 msgid "offload test"
5443 msgstr ""
5444
5445 #. type: Plain text
5446 #: guix-git/doc/guix.texi:1352
5447 msgid "To test whether your setup is operational, run this command on the master node:"
5448 msgstr ""
5449
5450 #. type: example
5451 #: guix-git/doc/guix.texi:1355
5452 #, no-wrap
5453 msgid "# guix offload test\n"
5454 msgstr ""
5455
5456 #. type: Plain text
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."
5459 msgstr ""
5460
5461 #. type: Plain text
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:"
5464 msgstr ""
5465
5466 #. type: example
5467 #: guix-git/doc/guix.texi:1367
5468 #, no-wrap
5469 msgid "# guix offload test machines-qualif.scm\n"
5470 msgstr ""
5471
5472 #. type: Plain text
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:"
5475 msgstr ""
5476
5477 #. type: example
5478 #: guix-git/doc/guix.texi:1374
5479 #, no-wrap
5480 msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n"
5481 msgstr ""
5482
5483 #. type: cindex
5484 #: guix-git/doc/guix.texi:1376
5485 #, no-wrap
5486 msgid "offload status"
5487 msgstr ""
5488
5489 #. type: Plain text
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:"
5492 msgstr ""
5493
5494 #. type: example
5495 #: guix-git/doc/guix.texi:1382
5496 #, no-wrap
5497 msgid "# guix offload status\n"
5498 msgstr ""
5499
5500 #. type: cindex
5501 #: guix-git/doc/guix.texi:1388
5502 #, no-wrap
5503 msgid "SELinux, daemon policy"
5504 msgstr ""
5505
5506 #. type: cindex
5507 #: guix-git/doc/guix.texi:1389
5508 #, no-wrap
5509 msgid "mandatory access control, SELinux"
5510 msgstr ""
5511
5512 #. type: cindex
5513 #: guix-git/doc/guix.texi:1390
5514 #, no-wrap
5515 msgid "security, guix-daemon"
5516 msgstr ""
5517
5518 #. type: Plain text
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."
5521 msgstr ""
5522
5523 #. type: subsubsection
5524 #: guix-git/doc/guix.texi:1397
5525 #, no-wrap
5526 msgid "Installing the SELinux policy"
5527 msgstr ""
5528
5529 #. type: cindex
5530 #: guix-git/doc/guix.texi:1398
5531 #, no-wrap
5532 msgid "SELinux, policy installation"
5533 msgstr ""
5534
5535 #. type: Plain text
5536 #: guix-git/doc/guix.texi:1400
5537 msgid "To install the policy run this command as root:"
5538 msgstr ""
5539
5540 #. type: example
5541 #: guix-git/doc/guix.texi:1403
5542 #, no-wrap
5543 msgid "semodule -i etc/guix-daemon.cil\n"
5544 msgstr ""
5545
5546 #. type: Plain text
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."
5549 msgstr ""
5550
5551 #. type: Plain text
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:"
5554 msgstr ""
5555
5556 #. type: example
5557 #: guix-git/doc/guix.texi:1415
5558 #, no-wrap
5559 msgid "ps -Zax | grep guix-daemon\n"
5560 msgstr ""
5561
5562 #. type: Plain text
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."
5565 msgstr ""
5566
5567 #. type: cindex
5568 #: guix-git/doc/guix.texi:1422
5569 #, no-wrap
5570 msgid "SELinux, limitations"
5571 msgstr ""
5572
5573 #. type: Plain text
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."
5576 msgstr ""
5577
5578 #. type: enumerate
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."
5581 msgstr ""
5582
5583 #. type: enumerate
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."
5586 msgstr ""
5587
5588 #. type: enumerate
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."
5591 msgstr ""
5592
5593 #. type: enumerate
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."
5596 msgstr ""
5597
5598 #. type: enumerate
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."
5601 msgstr ""
5602
5603 #. type: enumerate
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."
5606 msgstr ""
5607
5608 #. type: section
5609 #: guix-git/doc/guix.texi:1477
5610 #, no-wrap
5611 msgid "Invoking @command{guix-daemon}"
5612 msgstr ""
5613
5614 #. type: Plain text
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:"
5617 msgstr ""
5618
5619 #. type: Plain text
5620 #: guix-git/doc/guix.texi:1490
5621 msgid "For details on how to set it up, @pxref{Setting Up the Daemon}."
5622 msgstr ""
5623
5624 #. type: cindex
5625 #: guix-git/doc/guix.texi:1492
5626 #, no-wrap
5627 msgid "container, build environment"
5628 msgstr ""
5629
5630 #. type: cindex
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
5633 #, no-wrap
5634 msgid "reproducible builds"
5635 msgstr ""
5636
5637 #. type: Plain text
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})."
5640 msgstr ""
5641
5642 #. type: Plain text
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}."
5645 msgstr ""
5646
5647 #. type: Plain text
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}})."
5650 msgstr ""
5651
5652 #. type: Plain text
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."
5655 msgstr ""
5656
5657 #. type: Plain text
5658 #: guix-git/doc/guix.texi:1524
5659 msgid "The following command-line options are supported:"
5660 msgstr ""
5661
5662 #. type: item
5663 #: guix-git/doc/guix.texi:1526
5664 #, no-wrap
5665 msgid "--build-users-group=@var{group}"
5666 msgstr ""
5667
5668 #. type: table
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})."
5671 msgstr ""
5672
5673 #. type: item
5674 #: guix-git/doc/guix.texi:1530 guix-git/doc/guix.texi:10265
5675 #, no-wrap
5676 msgid "--no-substitutes"
5677 msgstr ""
5678
5679 #. type: cindex
5680 #: guix-git/doc/guix.texi:1531 guix-git/doc/guix.texi:3023
5681 #: guix-git/doc/guix.texi:3668
5682 #, no-wrap
5683 msgid "substitutes"
5684 msgstr ""
5685
5686 #. type: table
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})."
5689 msgstr ""
5690
5691 #. type: table
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})."
5694 msgstr ""
5695
5696 #. type: anchor{#1}
5697 #: guix-git/doc/guix.texi:1541
5698 msgid "daemon-substitute-urls"
5699 msgstr ""
5700
5701 #. type: item
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
5705 #, no-wrap
5706 msgid "--substitute-urls=@var{urls}"
5707 msgstr ""
5708
5709 #. type: table
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."
5712 msgstr ""
5713
5714 #. type: table
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})."
5717 msgstr ""
5718
5719 #. type: table
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."
5722 msgstr ""
5723
5724 #. type: item
5725 #: guix-git/doc/guix.texi:1553 guix-git/doc/guix.texi:10288
5726 #, no-wrap
5727 msgid "--no-offload"
5728 msgstr ""
5729
5730 #. type: table
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."
5733 msgstr ""
5734
5735 #. type: item
5736 #: guix-git/doc/guix.texi:1558
5737 #, no-wrap
5738 msgid "--cache-failures"
5739 msgstr ""
5740
5741 #. type: table
5742 #: guix-git/doc/guix.texi:1560
5743 msgid "Cache build failures. By default, only successful builds are cached."
5744 msgstr ""
5745
5746 #. type: table
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}."
5749 msgstr ""
5750
5751 #. type: item
5752 #: guix-git/doc/guix.texi:1566 guix-git/doc/guix.texi:10318
5753 #, no-wrap
5754 msgid "--cores=@var{n}"
5755 msgstr ""
5756
5757 #. type: itemx
5758 #: guix-git/doc/guix.texi:1567 guix-git/doc/guix.texi:10319
5759 #, no-wrap
5760 msgid "-c @var{n}"
5761 msgstr ""
5762
5763 #. type: table
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."
5766 msgstr ""
5767
5768 #. type: table
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})."
5771 msgstr ""
5772
5773 #. type: table
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}."
5776 msgstr ""
5777
5778 #. type: item
5779 #: guix-git/doc/guix.texi:1579 guix-git/doc/guix.texi:10323
5780 #, no-wrap
5781 msgid "--max-jobs=@var{n}"
5782 msgstr ""
5783
5784 #. type: itemx
5785 #: guix-git/doc/guix.texi:1580 guix-git/doc/guix.texi:10324
5786 #, no-wrap
5787 msgid "-M @var{n}"
5788 msgstr ""
5789
5790 #. type: table
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."
5793 msgstr ""
5794
5795 #. type: item
5796 #: guix-git/doc/guix.texi:1586 guix-git/doc/guix.texi:10293
5797 #, no-wrap
5798 msgid "--max-silent-time=@var{seconds}"
5799 msgstr ""
5800
5801 #. type: table
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."
5804 msgstr ""
5805
5806 #. type: table
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."
5809 msgstr ""
5810
5811 #. type: table
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}})."
5814 msgstr ""
5815
5816 #. type: item
5817 #: guix-git/doc/guix.texi:1595 guix-git/doc/guix.texi:10300
5818 #, no-wrap
5819 msgid "--timeout=@var{seconds}"
5820 msgstr ""
5821
5822 #. type: table
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."
5825 msgstr ""
5826
5827 #. type: table
5828 #: guix-git/doc/guix.texi:1603
5829 msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @option{--timeout}})."
5830 msgstr ""
5831
5832 #. type: item
5833 #: guix-git/doc/guix.texi:1604
5834 #, no-wrap
5835 msgid "--rounds=@var{N}"
5836 msgstr ""
5837
5838 #. type: table
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})."
5841 msgstr ""
5842
5843 #. type: table
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."
5847 msgstr ""
5848
5849 #. type: item
5850 #: guix-git/doc/guix.texi:1614
5851 #, no-wrap
5852 msgid "--debug"
5853 msgstr ""
5854
5855 #. type: table
5856 #: guix-git/doc/guix.texi:1616
5857 msgid "Produce debugging output."
5858 msgstr ""
5859
5860 #. type: table
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})."
5863 msgstr ""
5864
5865 #. type: item
5866 #: guix-git/doc/guix.texi:1621
5867 #, no-wrap
5868 msgid "--chroot-directory=@var{dir}"
5869 msgstr ""
5870
5871 #. type: table
5872 #: guix-git/doc/guix.texi:1623
5873 msgid "Add @var{dir} to the build chroot."
5874 msgstr ""
5875
5876 #. type: table
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."
5879 msgstr ""
5880
5881 #. type: item
5882 #: guix-git/doc/guix.texi:1630
5883 #, no-wrap
5884 msgid "--disable-chroot"
5885 msgstr ""
5886
5887 #. type: table
5888 #: guix-git/doc/guix.texi:1632
5889 msgid "Disable chroot builds."
5890 msgstr ""
5891
5892 #. type: table
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."
5895 msgstr ""
5896
5897 #. type: item
5898 #: guix-git/doc/guix.texi:1638
5899 #, no-wrap
5900 msgid "--log-compression=@var{type}"
5901 msgstr ""
5902
5903 #. type: table
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}."
5906 msgstr ""
5907
5908 #. type: table
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."
5911 msgstr ""
5912
5913 #. type: item
5914 #: guix-git/doc/guix.texi:1646
5915 #, no-wrap
5916 msgid "--discover[=yes|no]"
5917 msgstr ""
5918
5919 #. type: table
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."
5922 msgstr ""
5923
5924 #. type: table
5925 #: guix-git/doc/guix.texi:1652
5926 msgid "This feature is still experimental. However, here are a few considerations."
5927 msgstr ""
5928
5929 #. type: enumerate
5930 #: guix-git/doc/guix.texi:1656
5931 msgid "It might be faster/less expensive than fetching from remote servers;"
5932 msgstr ""
5933
5934 #. type: enumerate
5935 #: guix-git/doc/guix.texi:1659
5936 msgid "There are no security risks, only genuine substitutes will be used (@pxref{Substitute Authentication});"
5937 msgstr ""
5938
5939 #. type: enumerate
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;"
5942 msgstr ""
5943
5944 #. type: enumerate
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."
5947 msgstr ""
5948
5949 #. type: table
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:"
5952 msgstr ""
5953
5954 #. type: example
5955 #: guix-git/doc/guix.texi:1674
5956 #, no-wrap
5957 msgid ""
5958 "herd discover guix-daemon on\n"
5959 "herd discover guix-daemon off\n"
5960 msgstr ""
5961
5962 #. type: item
5963 #: guix-git/doc/guix.texi:1676
5964 #, no-wrap
5965 msgid "--disable-deduplication"
5966 msgstr ""
5967
5968 #. type: cindex
5969 #: guix-git/doc/guix.texi:1677 guix-git/doc/guix.texi:4248
5970 #, no-wrap
5971 msgid "deduplication"
5972 msgstr ""
5973
5974 #. type: table
5975 #: guix-git/doc/guix.texi:1679
5976 msgid "Disable automatic file ``deduplication'' in the store."
5977 msgstr ""
5978
5979 #. type: table
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."
5982 msgstr ""
5983
5984 #. type: item
5985 #: guix-git/doc/guix.texi:1687
5986 #, no-wrap
5987 msgid "--gc-keep-outputs[=yes|no]"
5988 msgstr ""
5989
5990 #. type: table
5991 #: guix-git/doc/guix.texi:1690
5992 msgid "Tell whether the garbage collector (GC) must keep outputs of live derivations."
5993 msgstr ""
5994
5995 #. type: cindex
5996 #: guix-git/doc/guix.texi:1691 guix-git/doc/guix.texi:4061
5997 #, no-wrap
5998 msgid "GC roots"
5999 msgstr ""
6000
6001 #. type: cindex
6002 #: guix-git/doc/guix.texi:1692 guix-git/doc/guix.texi:4062
6003 #, no-wrap
6004 msgid "garbage collector roots"
6005 msgstr ""
6006
6007 #. type: table
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."
6010 msgstr ""
6011
6012 #. type: item
6013 #: guix-git/doc/guix.texi:1699
6014 #, no-wrap
6015 msgid "--gc-keep-derivations[=yes|no]"
6016 msgstr ""
6017
6018 #. type: table
6019 #: guix-git/doc/guix.texi:1702
6020 msgid "Tell whether the garbage collector (GC) must keep derivations corresponding to live outputs."
6021 msgstr ""
6022
6023 #. type: table
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."
6026 msgstr ""
6027
6028 #. type: table
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."
6031 msgstr ""
6032
6033 #. type: item
6034 #: guix-git/doc/guix.texi:1718
6035 #, no-wrap
6036 msgid "--impersonate-linux-2.6"
6037 msgstr ""
6038
6039 #. type: table
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."
6042 msgstr ""
6043
6044 #. type: table
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."
6047 msgstr ""
6048
6049 #. type: item
6050 #: guix-git/doc/guix.texi:1725
6051 #, no-wrap
6052 msgid "--lose-logs"
6053 msgstr ""
6054
6055 #. type: table
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}."
6058 msgstr ""
6059
6060 #. type: item
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
6066 #, no-wrap
6067 msgid "--system=@var{system}"
6068 msgstr ""
6069
6070 #. type: table
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}."
6073 msgstr ""
6074
6075 #. type: item
6076 #: guix-git/doc/guix.texi:1734 guix-git/doc/guix.texi:10098
6077 #, no-wrap
6078 msgid "--listen=@var{endpoint}"
6079 msgstr ""
6080
6081 #. type: table
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:"
6084 msgstr ""
6085
6086 #. type: item
6087 #: guix-git/doc/guix.texi:1741
6088 #, no-wrap
6089 msgid "--listen=/gnu/var/daemon"
6090 msgstr ""
6091
6092 #. type: table
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."
6095 msgstr ""
6096
6097 #. type: item
6098 #: guix-git/doc/guix.texi:1745
6099 #, no-wrap
6100 msgid "--listen=localhost"
6101 msgstr ""
6102
6103 #. type: cindex
6104 #: guix-git/doc/guix.texi:1746 guix-git/doc/guix.texi:8782
6105 #, no-wrap
6106 msgid "daemon, remote access"
6107 msgstr ""
6108
6109 #. type: cindex
6110 #: guix-git/doc/guix.texi:1747 guix-git/doc/guix.texi:8783
6111 #, no-wrap
6112 msgid "remote access to the daemon"
6113 msgstr ""
6114
6115 #. type: cindex
6116 #: guix-git/doc/guix.texi:1748 guix-git/doc/guix.texi:8784
6117 #, no-wrap
6118 msgid "daemon, cluster setup"
6119 msgstr ""
6120
6121 #. type: cindex
6122 #: guix-git/doc/guix.texi:1749 guix-git/doc/guix.texi:8785
6123 #, no-wrap
6124 msgid "clusters, daemon setup"
6125 msgstr ""
6126
6127 #. type: table
6128 #: guix-git/doc/guix.texi:1752
6129 msgid "Listen for TCP connections on the network interface corresponding to @code{localhost}, on port 44146."
6130 msgstr ""
6131
6132 #. type: item
6133 #: guix-git/doc/guix.texi:1753
6134 #, no-wrap
6135 msgid "--listen=128.0.0.42:1234"
6136 msgstr ""
6137
6138 #. type: table
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."
6141 msgstr ""
6142
6143 #. type: table
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}})."
6146 msgstr ""
6147
6148 #. type: quotation
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."
6151 msgstr ""
6152
6153 #. type: table
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}."
6156 msgstr ""
6157
6158 #. type: Plain text
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."
6161 msgstr ""
6162
6163 #. type: anchor{#1}
6164 #: guix-git/doc/guix.texi:1789
6165 msgid "locales-and-locpath"
6166 msgstr ""
6167
6168 #. type: cindex
6169 #: guix-git/doc/guix.texi:1789
6170 #, no-wrap
6171 msgid "locales, when not on Guix System"
6172 msgstr ""
6173
6174 #. type: vindex
6175 #: guix-git/doc/guix.texi:1790 guix-git/doc/guix.texi:14686
6176 #, no-wrap
6177 msgid "LOCPATH"
6178 msgstr ""
6179
6180 #. type: vindex
6181 #: guix-git/doc/guix.texi:1791
6182 #, no-wrap
6183 msgid "GUIX_LOCPATH"
6184 msgstr ""
6185
6186 #. type: Plain text
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:"
6189 msgstr ""
6190
6191 #. type: example
6192 #: guix-git/doc/guix.texi:1800
6193 #, no-wrap
6194 msgid ""
6195 "$ guix install glibc-locales\n"
6196 "$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n"
6197 msgstr ""
6198
6199 #. type: Plain text
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."
6202 msgstr ""
6203
6204 #. type: Plain text
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:"
6207 msgstr ""
6208
6209 #. type: enumerate
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."
6212 msgstr ""
6213
6214 #. type: enumerate
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."
6217 msgstr ""
6218
6219 #. type: Plain text
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."
6222 msgstr ""
6223
6224 #. type: cindex
6225 #: guix-git/doc/guix.texi:1831
6226 #, no-wrap
6227 msgid "name service switch, glibc"
6228 msgstr ""
6229
6230 #. type: cindex
6231 #: guix-git/doc/guix.texi:1832
6232 #, no-wrap
6233 msgid "NSS (name service switch), glibc"
6234 msgstr ""
6235
6236 #. type: cindex
6237 #: guix-git/doc/guix.texi:1833
6238 #, no-wrap
6239 msgid "nscd (name service caching daemon)"
6240 msgstr ""
6241
6242 #. type: cindex
6243 #: guix-git/doc/guix.texi:1834
6244 #, no-wrap
6245 msgid "name service caching daemon (nscd)"
6246 msgstr ""
6247
6248 #. type: Plain text
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."
6251 msgstr ""
6252
6253 #. type: file{#1}
6254 #: guix-git/doc/guix.texi:1842
6255 #, no-wrap
6256 msgid "nsswitch.conf"
6257 msgstr ""
6258
6259 #. type: Plain text
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})."
6262 msgstr ""
6263
6264 #. type: cindex
6265 #: guix-git/doc/guix.texi:1848
6266 #, no-wrap
6267 msgid "Network information service (NIS)"
6268 msgstr ""
6269
6270 #. type: cindex
6271 #: guix-git/doc/guix.texi:1849
6272 #, no-wrap
6273 msgid "NIS (Network information service)"
6274 msgstr ""
6275
6276 #. type: Plain text
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})."
6279 msgstr ""
6280
6281 #. type: Plain text
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)."
6284 msgstr ""
6285
6286 #. type: Plain text
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."
6289 msgstr ""
6290
6291 #. type: Plain text
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."
6294 msgstr ""
6295
6296 #. type: subsection
6297 #: guix-git/doc/guix.texi:1879
6298 #, no-wrap
6299 msgid "X11 Fonts"
6300 msgstr ""
6301
6302 #. type: Plain text
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}."
6305 msgstr ""
6306
6307 #. type: code{#1}
6308 #: guix-git/doc/guix.texi:1890
6309 #, no-wrap
6310 msgid "fc-cache"
6311 msgstr ""
6312
6313 #. type: cindex
6314 #: guix-git/doc/guix.texi:1891
6315 #, no-wrap
6316 msgid "font cache"
6317 msgstr ""
6318
6319 #. type: Plain text
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:"
6322 msgstr ""
6323
6324 #. type: example
6325 #: guix-git/doc/guix.texi:1899
6326 #, no-wrap
6327 msgid ""
6328 "guix install fontconfig\n"
6329 "fc-cache -rv\n"
6330 msgstr ""
6331
6332 #. type: Plain text
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:"
6335 msgstr ""
6336
6337 #. type: example
6338 #: guix-git/doc/guix.texi:1910
6339 #, no-wrap
6340 msgid "guix install font-adobe-source-han-sans:cn\n"
6341 msgstr ""
6342
6343 #. type: code{#1}
6344 #: guix-git/doc/guix.texi:1912
6345 #, no-wrap
6346 msgid "xterm"
6347 msgstr ""
6348
6349 #. type: Plain text
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:"
6352 msgstr ""
6353
6354 #. type: example
6355 #: guix-git/doc/guix.texi:1919
6356 #, no-wrap
6357 msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n"
6358 msgstr ""
6359
6360 #. type: Plain text
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:"
6363 msgstr ""
6364
6365 #. type: example
6366 #: guix-git/doc/guix.texi:1928
6367 #, no-wrap
6368 msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n"
6369 msgstr ""
6370
6371 #. type: code{#1}
6372 #: guix-git/doc/guix.texi:1930
6373 #, no-wrap
6374 msgid "xlsfonts"
6375 msgstr ""
6376
6377 #. type: Plain text
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."
6380 msgstr ""
6381
6382 #. type: code{#1}
6383 #: guix-git/doc/guix.texi:1937 guix-git/doc/guix.texi:32047
6384 #, no-wrap
6385 msgid "nss-certs"
6386 msgstr ""
6387
6388 #. type: Plain text
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."
6391 msgstr ""
6392
6393 #. type: Plain text
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."
6396 msgstr ""
6397
6398 #. type: code{#1}
6399 #: guix-git/doc/guix.texi:1948
6400 #, no-wrap
6401 msgid "emacs"
6402 msgstr ""
6403
6404 #. type: Plain text
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."
6407 msgstr ""
6408
6409 #. type: Plain text
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})."
6412 msgstr ""
6413
6414 #. type: cindex
6415 #: guix-git/doc/guix.texi:1966
6416 #, no-wrap
6417 msgid "Upgrading Guix, on a foreign distro"
6418 msgstr ""
6419
6420 #. type: Plain text
6421 #: guix-git/doc/guix.texi:1969
6422 msgid "To upgrade Guix, run:"
6423 msgstr ""
6424
6425 #. type: example
6426 #: guix-git/doc/guix.texi:1972 guix-git/doc/guix.texi:2819
6427 #, no-wrap
6428 msgid "guix pull\n"
6429 msgstr ""
6430
6431 #. type: Plain text
6432 #: guix-git/doc/guix.texi:1975
6433 msgid "@xref{Invoking guix pull}, for more information."
6434 msgstr ""
6435
6436 #. type: cindex
6437 #: guix-git/doc/guix.texi:1976
6438 #, no-wrap
6439 msgid "upgrading Guix for the root user, on a foreign distro"
6440 msgstr ""
6441
6442 #. type: cindex
6443 #: guix-git/doc/guix.texi:1977
6444 #, no-wrap
6445 msgid "upgrading the Guix daemon, on a foreign distro"
6446 msgstr ""
6447
6448 #. type: cindex
6449 #: guix-git/doc/guix.texi:1978
6450 #, no-wrap
6451 msgid "@command{guix pull} for the root user, on a foreign distro"
6452 msgstr ""
6453
6454 #. type: Plain text
6455 #: guix-git/doc/guix.texi:1981
6456 msgid "On a foreign distro, you can upgrade the build daemon by running:"
6457 msgstr ""
6458
6459 #. type: example
6460 #: guix-git/doc/guix.texi:1984
6461 #, no-wrap
6462 msgid "sudo -i guix pull\n"
6463 msgstr ""
6464
6465 #. type: Plain text
6466 #: guix-git/doc/guix.texi:1989
6467 msgid "followed by (assuming your distro uses the systemd service management tool):"
6468 msgstr ""
6469
6470 #. type: example
6471 #: guix-git/doc/guix.texi:1992
6472 #, no-wrap
6473 msgid "systemctl restart guix-daemon.service\n"
6474 msgstr ""
6475
6476 #. type: Plain text
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}})."
6479 msgstr ""
6480
6481 #. type: cindex
6482 #: guix-git/doc/guix.texi:2003
6483 #, no-wrap
6484 msgid "installing Guix System"
6485 msgstr ""
6486
6487 #. type: cindex
6488 #: guix-git/doc/guix.texi:2004
6489 #, no-wrap
6490 msgid "Guix System, installation"
6491 msgstr ""
6492
6493 #. type: Plain text
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}."
6496 msgstr ""
6497
6498 #. type: quotation
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."
6501 msgstr ""
6502
6503 #. type: quotation
6504 #: guix-git/doc/guix.texi:2021
6505 msgid "Alternatively, run @command{info info} in another tty to keep the manual available."
6506 msgstr ""
6507
6508 #. type: Plain text
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."
6511 msgstr ""
6512
6513 #. type: Plain text
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}:"
6516 msgstr ""
6517
6518 #. type: itemize
6519 #: guix-git/doc/guix.texi:2050
6520 msgid "More and more system services are provided (@pxref{Services}), but some may be missing."
6521 msgstr ""
6522
6523 #. type: itemize
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."
6526 msgstr ""
6527
6528 #. type: Plain text
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."
6531 msgstr ""
6532
6533 #. type: cindex
6534 #: guix-git/doc/guix.texi:2065
6535 #, no-wrap
6536 msgid "hardware support on Guix System"
6537 msgstr ""
6538
6539 #. type: Plain text
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."
6542 msgstr ""
6543
6544 #. type: cindex
6545 #: guix-git/doc/guix.texi:2075
6546 #, no-wrap
6547 msgid "WiFi, hardware support"
6548 msgstr ""
6549
6550 #. type: Plain text
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}})."
6553 msgstr ""
6554
6555 #. type: cindex
6556 #: guix-git/doc/guix.texi:2085
6557 #, no-wrap
6558 msgid "RYF, Respects Your Freedom"
6559 msgstr ""
6560
6561 #. type: Plain text
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."
6564 msgstr ""
6565
6566 #. type: Plain text
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."
6569 msgstr ""
6570
6571 #. type: Plain text
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:"
6574 msgstr ""
6575
6576 #. type: table
6577 #: guix-git/doc/guix.texi:2108
6578 msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;"
6579 msgstr ""
6580
6581 #. type: table
6582 #: guix-git/doc/guix.texi:2111
6583 msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs."
6584 msgstr ""
6585
6586 #. type: Plain text
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:"
6589 msgstr ""
6590
6591 #. type: example
6592 #: guix-git/doc/guix.texi:2120
6593 #, no-wrap
6594 msgid ""
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"
6597 msgstr ""
6598
6599 #. type: example
6600 #: guix-git/doc/guix.texi:2128
6601 #, no-wrap
6602 msgid ""
6603 "$ wget @value{OPENPGP-SIGNING-KEY-URL} \\\n"
6604 " -qO - | gpg --import -\n"
6605 msgstr ""
6606
6607 #. type: Plain text
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."
6610 msgstr ""
6611
6612 #. type: unnumberedsubsec
6613 #: guix-git/doc/guix.texi:2141
6614 #, no-wrap
6615 msgid "Copying to a USB Stick"
6616 msgstr ""
6617
6618 #. type: Plain text
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:"
6621 msgstr ""
6622
6623 #. type: example
6624 #: guix-git/doc/guix.texi:2150
6625 #, no-wrap
6626 msgid ""
6627 "dd if=guix-system-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX status=progress\n"
6628 "sync\n"
6629 msgstr ""
6630
6631 #. type: Plain text
6632 #: guix-git/doc/guix.texi:2153
6633 msgid "Access to @file{/dev/sdX} usually requires root privileges."
6634 msgstr ""
6635
6636 #. type: unnumberedsubsec
6637 #: guix-git/doc/guix.texi:2154
6638 #, no-wrap
6639 msgid "Burning on a DVD"
6640 msgstr ""
6641
6642 #. type: Plain text
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:"
6645 msgstr ""
6646
6647 #. type: example
6648 #: guix-git/doc/guix.texi:2162
6649 #, no-wrap
6650 msgid "growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-linux.iso\n"
6651 msgstr ""
6652
6653 #. type: Plain text
6654 #: guix-git/doc/guix.texi:2165
6655 msgid "Access to @file{/dev/srX} usually requires root privileges."
6656 msgstr ""
6657
6658 #. type: unnumberedsubsec
6659 #: guix-git/doc/guix.texi:2166
6660 #, no-wrap
6661 msgid "Booting"
6662 msgstr ""
6663
6664 #. type: Plain text
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}."
6667 msgstr ""
6668
6669 #. type: Plain text
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)."
6672 msgstr ""
6673
6674 #. type: Plain text
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})."
6677 msgstr ""
6678
6679 #. type: Plain text
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."
6682 msgstr ""
6683
6684 #. type: quotation
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."
6687 msgstr ""
6688
6689 #. type: Plain text
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."
6692 msgstr ""
6693
6694 #. type: Plain text
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."
6697 msgstr ""
6698
6699 #. type: Plain text
6700 #: guix-git/doc/guix.texi:2213
6701 msgid "@image{images/installer-network,5in,, networking setup with the graphical installer}"
6702 msgstr ""
6703
6704 #. type: Plain text
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."
6707 msgstr ""
6708
6709 #. type: Plain text
6710 #: guix-git/doc/guix.texi:2220
6711 msgid "@image{images/installer-partitions,5in,, partitioning with the graphical installer}"
6712 msgstr ""
6713
6714 #. type: Plain text
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."
6717 msgstr ""
6718
6719 #. type: Plain text
6720 #: guix-git/doc/guix.texi:2225
6721 msgid "@image{images/installer-resume,5in,, resuming the installation process}"
6722 msgstr ""
6723
6724 #. type: Plain text
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!"
6727 msgstr ""
6728
6729 #. type: Plain text
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})."
6732 msgstr ""
6733
6734 #. type: Plain text
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})."
6737 msgstr ""
6738
6739 #. type: subsection
6740 #: guix-git/doc/guix.texi:2253
6741 #, no-wrap
6742 msgid "Keyboard Layout, Networking, and Partitioning"
6743 msgstr ""
6744
6745 #. type: Plain text
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."
6748 msgstr ""
6749
6750 #. type: cindex
6751 #: guix-git/doc/guix.texi:2261 guix-git/doc/guix.texi:14500
6752 #, no-wrap
6753 msgid "keyboard layout"
6754 msgstr ""
6755
6756 #. type: Plain text
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:"
6759 msgstr ""
6760
6761 #. type: example
6762 #: guix-git/doc/guix.texi:2268
6763 #, no-wrap
6764 msgid "loadkeys dvorak\n"
6765 msgstr ""
6766
6767 #. type: Plain text
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."
6770 msgstr ""
6771
6772 #. type: subsubsection
6773 #: guix-git/doc/guix.texi:2274
6774 #, no-wrap
6775 msgid "Networking"
6776 msgstr ""
6777
6778 #. type: Plain text
6779 #: guix-git/doc/guix.texi:2277
6780 msgid "Run the following command to see what your network interfaces are called:"
6781 msgstr ""
6782
6783 #. type: example
6784 #: guix-git/doc/guix.texi:2280
6785 #, no-wrap
6786 msgid "ifconfig -a\n"
6787 msgstr ""
6788
6789 #. type: table
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:"
6792 msgstr ""
6793
6794 #. type: example
6795 #: guix-git/doc/guix.texi:2287
6796 #, no-wrap
6797 msgid "ip address\n"
6798 msgstr ""
6799
6800 #. type: Plain text
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}."
6803 msgstr ""
6804
6805 #. type: item
6806 #: guix-git/doc/guix.texi:2296
6807 #, no-wrap
6808 msgid "Wired connection"
6809 msgstr ""
6810
6811 #. type: table
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."
6814 msgstr ""
6815
6816 #. type: example
6817 #: guix-git/doc/guix.texi:2302
6818 #, no-wrap
6819 msgid "ifconfig @var{interface} up\n"
6820 msgstr ""
6821
6822 #. type: example
6823 #: guix-git/doc/guix.texi:2309
6824 #, no-wrap
6825 msgid "ip link set @var{interface} up\n"
6826 msgstr ""
6827
6828 #. type: item
6829 #: guix-git/doc/guix.texi:2311
6830 #, no-wrap
6831 msgid "Wireless connection"
6832 msgstr ""
6833
6834 #. type: cindex
6835 #: guix-git/doc/guix.texi:2312 guix-git/doc/guix.texi:16125
6836 #, no-wrap
6837 msgid "wireless"
6838 msgstr ""
6839
6840 #. type: cindex
6841 #: guix-git/doc/guix.texi:2313 guix-git/doc/guix.texi:16126
6842 #, no-wrap
6843 msgid "WiFi"
6844 msgstr ""
6845
6846 #. type: table
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}:"
6849 msgstr ""
6850
6851 #. type: example
6852 #: guix-git/doc/guix.texi:2321
6853 #, no-wrap
6854 msgid "nano wpa_supplicant.conf\n"
6855 msgstr ""
6856
6857 #. type: table
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:"
6860 msgstr ""
6861
6862 #. type: example
6863 #: guix-git/doc/guix.texi:2333
6864 #, no-wrap
6865 msgid ""
6866 "network=@{\n"
6867 " ssid=\"@var{my-ssid}\"\n"
6868 " key_mgmt=WPA-PSK\n"
6869 " psk=\"the network's secret passphrase\"\n"
6870 "@}\n"
6871 msgstr ""
6872
6873 #. type: table
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):"
6876 msgstr ""
6877
6878 #. type: example
6879 #: guix-git/doc/guix.texi:2341
6880 #, no-wrap
6881 msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n"
6882 msgstr ""
6883
6884 #. type: table
6885 #: guix-git/doc/guix.texi:2344
6886 msgid "Run @command{man wpa_supplicant} for more information."
6887 msgstr ""
6888
6889 #. type: cindex
6890 #: guix-git/doc/guix.texi:2346
6891 #, no-wrap
6892 msgid "DHCP"
6893 msgstr ""
6894
6895 #. type: Plain text
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:"
6898 msgstr ""
6899
6900 #. type: example
6901 #: guix-git/doc/guix.texi:2352
6902 #, no-wrap
6903 msgid "dhclient -v @var{interface}\n"
6904 msgstr ""
6905
6906 #. type: Plain text
6907 #: guix-git/doc/guix.texi:2355
6908 msgid "Try to ping a server to see if networking is up and running:"
6909 msgstr ""
6910
6911 #. type: example
6912 #: guix-git/doc/guix.texi:2358
6913 #, no-wrap
6914 msgid "ping -c 3 gnu.org\n"
6915 msgstr ""
6916
6917 #. type: Plain text
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."
6920 msgstr ""
6921
6922 #. type: cindex
6923 #: guix-git/doc/guix.texi:2363
6924 #, no-wrap
6925 msgid "proxy, during system installation"
6926 msgstr ""
6927
6928 #. type: Plain text
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:"
6931 msgstr ""
6932
6933 #. type: example
6934 #: guix-git/doc/guix.texi:2369
6935 #, no-wrap
6936 msgid "herd set-http-proxy guix-daemon @var{URL}\n"
6937 msgstr ""
6938
6939 #. type: Plain text
6940 #: guix-git/doc/guix.texi:2374
6941 msgid "where @var{URL} is the proxy URL, for example @code{http://example.org:8118}."
6942 msgstr ""
6943
6944 #. type: cindex
6945 #: guix-git/doc/guix.texi:2375
6946 #, no-wrap
6947 msgid "installing over SSH"
6948 msgstr ""
6949
6950 #. type: Plain text
6951 #: guix-git/doc/guix.texi:2378
6952 msgid "If you want to, you can continue the installation remotely by starting an SSH server:"
6953 msgstr ""
6954
6955 #. type: example
6956 #: guix-git/doc/guix.texi:2381
6957 #, no-wrap
6958 msgid "herd start ssh-daemon\n"
6959 msgstr ""
6960
6961 #. type: Plain text
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."
6964 msgstr ""
6965
6966 #. type: subsubsection
6967 #: guix-git/doc/guix.texi:2386
6968 #, no-wrap
6969 msgid "Disk Partitioning"
6970 msgstr ""
6971
6972 #. type: Plain text
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)."
6975 msgstr ""
6976
6977 #. type: Plain text
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:"
6980 msgstr ""
6981
6982 #. type: example
6983 #: guix-git/doc/guix.texi:2398
6984 #, no-wrap
6985 msgid "cfdisk\n"
6986 msgstr ""
6987
6988 #. type: Plain text
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})."
6991 msgstr ""
6992
6993 #. type: cindex
6994 #: guix-git/doc/guix.texi:2405
6995 #, no-wrap
6996 msgid "EFI, installation"
6997 msgstr ""
6998
6999 #. type: cindex
7000 #: guix-git/doc/guix.texi:2406
7001 #, no-wrap
7002 msgid "UEFI, installation"
7003 msgstr ""
7004
7005 #. type: cindex
7006 #: guix-git/doc/guix.texi:2407
7007 #, no-wrap
7008 msgid "ESP, EFI system partition"
7009 msgstr ""
7010
7011 #. type: Plain text
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}:"
7014 msgstr ""
7015
7016 #. type: example
7017 #: guix-git/doc/guix.texi:2414
7018 #, no-wrap
7019 msgid "parted /dev/sda set 1 esp on\n"
7020 msgstr ""
7021
7022 #. type: vindex
7023 #: guix-git/doc/guix.texi:2417 guix-git/doc/guix.texi:32447
7024 #, no-wrap
7025 msgid "grub-bootloader"
7026 msgstr ""
7027
7028 #. type: vindex
7029 #: guix-git/doc/guix.texi:2418 guix-git/doc/guix.texi:32441
7030 #, no-wrap
7031 msgid "grub-efi-bootloader"
7032 msgstr ""
7033
7034 #. type: quotation
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."
7037 msgstr ""
7038
7039 #. type: Plain text
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:"
7042 msgstr ""
7043
7044 #. type: example
7045 #: guix-git/doc/guix.texi:2436
7046 #, no-wrap
7047 msgid "mkfs.fat -F32 /dev/sda1\n"
7048 msgstr ""
7049
7050 #. type: Plain text
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})."
7053 msgstr ""
7054
7055 #. type: Plain text
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:"
7058 msgstr ""
7059
7060 #. type: example
7061 #: guix-git/doc/guix.texi:2453
7062 #, no-wrap
7063 msgid "mkfs.ext4 -L my-root /dev/sda2\n"
7064 msgstr ""
7065
7066 #. type: cindex
7067 #: guix-git/doc/guix.texi:2455 guix-git/doc/guix.texi:13498
7068 #, no-wrap
7069 msgid "encrypted disk"
7070 msgstr ""
7071
7072 #. type: Plain text
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:"
7075 msgstr ""
7076
7077 #. type: example
7078 #: guix-git/doc/guix.texi:2467
7079 #, no-wrap
7080 msgid ""
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"
7084 msgstr ""
7085
7086 #. type: Plain text
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):"
7089 msgstr ""
7090
7091 #. type: example
7092 #: guix-git/doc/guix.texi:2475
7093 #, no-wrap
7094 msgid "mount LABEL=my-root /mnt\n"
7095 msgstr ""
7096
7097 #. type: Plain text
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."
7100 msgstr ""
7101
7102 #. type: Plain text
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:"
7105 msgstr ""
7106
7107 #. type: example
7108 #: guix-git/doc/guix.texi:2490
7109 #, no-wrap
7110 msgid ""
7111 "mkswap /dev/sda3\n"
7112 "swapon /dev/sda3\n"
7113 msgstr ""
7114
7115 #. type: Plain text
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}.}:"
7118 msgstr ""
7119
7120 #. type: example
7121 #: guix-git/doc/guix.texi:2506
7122 #, no-wrap
7123 msgid ""
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"
7130 msgstr ""
7131
7132 #. type: Plain text
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."
7135 msgstr ""
7136
7137 #. type: Plain text
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:"
7140 msgstr ""
7141
7142 #. type: example
7143 #: guix-git/doc/guix.texi:2520
7144 #, no-wrap
7145 msgid "herd start cow-store /mnt\n"
7146 msgstr ""
7147
7148 #. type: Plain text
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."
7151 msgstr ""
7152
7153 #. type: Plain text
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."
7156 msgstr ""
7157
7158 #. type: Plain text
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:"
7161 msgstr ""
7162
7163 #. type: example
7164 #: guix-git/doc/guix.texi:2550
7165 #, no-wrap
7166 msgid ""
7167 "# mkdir /mnt/etc\n"
7168 "# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n"
7169 "# nano /mnt/etc/config.scm\n"
7170 msgstr ""
7171
7172 #. type: Plain text
7173 #: guix-git/doc/guix.texi:2554
7174 msgid "You should pay attention to what your configuration file contains, and in particular:"
7175 msgstr ""
7176
7177 #. type: itemize
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."
7180 msgstr ""
7181
7182 #. type: itemize
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."
7185 msgstr ""
7186
7187 #. type: itemize
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})."
7190 msgstr ""
7191
7192 #. type: Plain text
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}):"
7195 msgstr ""
7196
7197 #. type: example
7198 #: guix-git/doc/guix.texi:2583
7199 #, no-wrap
7200 msgid "guix system init /mnt/etc/config.scm /mnt\n"
7201 msgstr ""
7202
7203 #. type: Plain text
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."
7206 msgstr ""
7207
7208 #. type: Plain text
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!"
7211 msgstr ""
7212
7213 #. type: Plain text
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:"
7216 msgstr ""
7217
7218 #. type: example
7219 #: guix-git/doc/guix.texi:2609
7220 #, no-wrap
7221 msgid ""
7222 "guix pull\n"
7223 "sudo guix system reconfigure /etc/config.scm\n"
7224 msgstr ""
7225
7226 #. type: Plain text
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})."
7229 msgstr ""
7230
7231 #. type: cindex
7232 #: guix-git/doc/guix.texi:2618
7233 #, no-wrap
7234 msgid "sudo vs. @command{guix pull}"
7235 msgstr ""
7236
7237 #. type: quotation
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{}}."
7240 msgstr ""
7241
7242 #. type: quotation
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."
7245 msgstr ""
7246
7247 #. type: Plain text
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!"
7250 msgstr ""
7251
7252 #. type: section
7253 #: guix-git/doc/guix.texi:2635
7254 #, no-wrap
7255 msgid "Installing Guix in a Virtual Machine"
7256 msgstr ""
7257
7258 #. type: cindex
7259 #: guix-git/doc/guix.texi:2637
7260 #, no-wrap
7261 msgid "virtual machine, Guix System installation"
7262 msgstr ""
7263
7264 #. type: cindex
7265 #: guix-git/doc/guix.texi:2638
7266 #, no-wrap
7267 msgid "virtual private server (VPS)"
7268 msgstr ""
7269
7270 #. type: cindex
7271 #: guix-git/doc/guix.texi:2639
7272 #, no-wrap
7273 msgid "VPS (virtual private server)"
7274 msgstr ""
7275
7276 #. type: Plain text
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."
7279 msgstr ""
7280
7281 #. type: Plain text
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:"
7284 msgstr ""
7285
7286 #. type: enumerate
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})."
7289 msgstr ""
7290
7291 #. type: enumerate
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:"
7294 msgstr ""
7295
7296 #. type: example
7297 #: guix-git/doc/guix.texi:2658
7298 #, no-wrap
7299 msgid "qemu-img create -f qcow2 guix-system.img 50G\n"
7300 msgstr ""
7301
7302 #. type: enumerate
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."
7305 msgstr ""
7306
7307 #. type: enumerate
7308 #: guix-git/doc/guix.texi:2665
7309 msgid "Boot the USB installation image in an VM:"
7310 msgstr ""
7311
7312 #. type: example
7313 #: guix-git/doc/guix.texi:2671
7314 #, no-wrap
7315 msgid ""
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"
7320 msgstr ""
7321
7322 #. type: enumerate
7323 #: guix-git/doc/guix.texi:2675
7324 msgid "@code{-enable-kvm} is optional, but significantly improves performance, @pxref{Running Guix in a VM}."
7325 msgstr ""
7326
7327 #. type: enumerate
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."
7330 msgstr ""
7331
7332 #. type: Plain text
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."
7335 msgstr ""
7336
7337 #. type: cindex
7338 #: guix-git/doc/guix.texi:2688
7339 #, no-wrap
7340 msgid "installation image"
7341 msgstr ""
7342
7343 #. type: Plain text
7344 #: guix-git/doc/guix.texi:2691
7345 msgid "The installation image described above was built using the @command{guix system} command, specifically:"
7346 msgstr ""
7347
7348 #. type: example
7349 #: guix-git/doc/guix.texi:2694
7350 #, no-wrap
7351 msgid "guix system image -t iso9660 gnu/system/install.scm\n"
7352 msgstr ""
7353
7354 #. type: Plain text
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."
7357 msgstr ""
7358
7359 #. type: section
7360 #: guix-git/doc/guix.texi:2700
7361 #, no-wrap
7362 msgid "Building the Installation Image for ARM Boards"
7363 msgstr ""
7364
7365 #. type: Plain text
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."
7368 msgstr ""
7369
7370 #. type: Plain text
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:"
7373 msgstr ""
7374
7375 #. type: example
7376 #: guix-git/doc/guix.texi:2711
7377 #, no-wrap
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"
7379 msgstr ""
7380
7381 #. type: Plain text
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."
7384 msgstr ""
7385
7386 #. type: Plain text
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."
7389 msgstr ""
7390
7391 #. type: Plain text
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:"
7394 msgstr ""
7395
7396 #. type: example
7397 #: guix-git/doc/guix.texi:2732
7398 #, no-wrap
7399 msgid "guix search text editor\n"
7400 msgstr ""
7401
7402 #. type: Plain text
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}!):"
7405 msgstr ""
7406
7407 #. type: example
7408 #: guix-git/doc/guix.texi:2742
7409 #, no-wrap
7410 msgid "guix install emacs\n"
7411 msgstr ""
7412
7413 #. type: cindex
7414 #: guix-git/doc/guix.texi:2744 guix-git/doc/guix.texi:3056
7415 #: guix-git/doc/guix.texi:3108
7416 #, no-wrap
7417 msgid "profile"
7418 msgstr ""
7419
7420 #. type: Plain text
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)."
7423 msgstr ""
7424
7425 #. type: Plain text
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:"
7428 msgstr ""
7429
7430 #. type: example
7431 #: guix-git/doc/guix.texi:2758
7432 #, no-wrap
7433 msgid ""
7434 "hint: Consider setting the necessary environment variables by running:\n"
7435 "\n"
7436 msgstr ""
7437
7438 #. type: example
7439 #: guix-git/doc/guix.texi:2761
7440 #, no-wrap
7441 msgid ""
7442 " GUIX_PROFILE=\"$HOME/.guix-profile\"\n"
7443 " . \"$GUIX_PROFILE/etc/profile\"\n"
7444 "\n"
7445 msgstr ""
7446
7447 #. type: example
7448 #: guix-git/doc/guix.texi:2763
7449 #, no-wrap
7450 msgid "Alternately, see `guix package --search-paths -p \"$HOME/.guix-profile\"'.\n"
7451 msgstr ""
7452
7453 #. type: Plain text
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."
7456 msgstr ""
7457
7458 #. type: Plain text
7459 #: guix-git/doc/guix.texi:2780
7460 msgid "You can go on installing packages at your will. To list installed packages, run:"
7461 msgstr ""
7462
7463 #. type: example
7464 #: guix-git/doc/guix.texi:2783
7465 #, no-wrap
7466 msgid "guix package --list-installed\n"
7467 msgstr ""
7468
7469 #. type: Plain text
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:"
7472 msgstr ""
7473
7474 #. type: example
7475 #: guix-git/doc/guix.texi:2791
7476 #, no-wrap
7477 msgid "guix package --roll-back\n"
7478 msgstr ""
7479
7480 #. type: Plain text
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:"
7483 msgstr ""
7484
7485 #. type: example
7486 #: guix-git/doc/guix.texi:2799
7487 #, no-wrap
7488 msgid "guix package --list-generations\n"
7489 msgstr ""
7490
7491 #. type: Plain text
7492 #: guix-git/doc/guix.texi:2802
7493 msgid "Now you know the basics of package management!"
7494 msgstr ""
7495
7496 #. type: quotation
7497 #: guix-git/doc/guix.texi:2803 guix-git/doc/guix.texi:2862
7498 #, no-wrap
7499 msgid "Going further"
7500 msgstr ""
7501
7502 #. type: quotation
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."
7505 msgstr ""
7506
7507 #. type: Plain text
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:"
7510 msgstr ""
7511
7512 #. type: Plain text
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}:"
7515 msgstr ""
7516
7517 #. type: example
7518 #: guix-git/doc/guix.texi:2830
7519 #, no-wrap
7520 msgid ""
7521 "GUIX_PROFILE=\"$HOME/.config/guix/current\"\n"
7522 ". \"$GUIX_PROFILE/etc/profile\"\n"
7523 msgstr ""
7524
7525 #. type: Plain text
7526 #: guix-git/doc/guix.texi:2834
7527 msgid "You must also instruct your shell to point to this new @command{guix}:"
7528 msgstr ""
7529
7530 #. type: example
7531 #: guix-git/doc/guix.texi:2837
7532 #, no-wrap
7533 msgid "hash guix\n"
7534 msgstr ""
7535
7536 #. type: Plain text
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:"
7539 msgstr ""
7540
7541 #. type: example
7542 #: guix-git/doc/guix.texi:2844
7543 #, no-wrap
7544 msgid "guix upgrade\n"
7545 msgstr ""
7546
7547 #. type: Plain text
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!"
7550 msgstr ""
7551
7552 #. type: Plain text
7553 #: guix-git/doc/guix.texi:2853
7554 msgid "You can display the exact revision of Guix you're currently using by running:"
7555 msgstr ""
7556
7557 #. type: example
7558 #: guix-git/doc/guix.texi:2856
7559 #, no-wrap
7560 msgid "guix describe\n"
7561 msgstr ""
7562
7563 #. type: Plain text
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."
7566 msgstr ""
7567
7568 #. type: quotation
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})."
7571 msgstr ""
7572
7573 #. type: Plain text
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:"
7576 msgstr ""
7577
7578 #. type: example
7579 #: guix-git/doc/guix.texi:2875
7580 #, no-wrap
7581 msgid "sudo guix system reconfigure /etc/config.scm\n"
7582 msgstr ""
7583
7584 #. type: Plain text
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}:"
7587 msgstr ""
7588
7589 #. type: example
7590 #: guix-git/doc/guix.texi:2887
7591 #, no-wrap
7592 msgid "sudo guix system roll-back\n"
7593 msgstr ""
7594
7595 #. type: Plain text
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."
7598 msgstr ""
7599
7600 #. type: Plain text
7601 #: guix-git/doc/guix.texi:2896
7602 msgid "Now you know enough to get started!"
7603 msgstr ""
7604
7605 #. type: quotation
7606 #: guix-git/doc/guix.texi:2897
7607 #, no-wrap
7608 msgid "Resources"
7609 msgstr ""
7610
7611 #. type: quotation
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:"
7614 msgstr ""
7615
7616 #. type: itemize
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."
7619 msgstr ""
7620
7621 #. type: itemize
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."
7624 msgstr ""
7625
7626 #. type: itemize
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."
7629 msgstr ""
7630
7631 #. type: itemize
7632 #: guix-git/doc/guix.texi:2919
7633 msgid "@xref{Documentation}, to learn how to access documentation on your computer."
7634 msgstr ""
7635
7636 #. type: quotation
7637 #: guix-git/doc/guix.texi:2922
7638 msgid "We hope you will enjoy Guix as much as the community enjoys building it!"
7639 msgstr ""
7640
7641 #. type: cindex
7642 #: guix-git/doc/guix.texi:2928
7643 #, no-wrap
7644 msgid "packages"
7645 msgstr ""
7646
7647 #. type: Plain text
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."
7650 msgstr ""
7651
7652 #. type: Plain text
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):"
7655 msgstr ""
7656
7657 #. type: example
7658 #: guix-git/doc/guix.texi:2944
7659 #, no-wrap
7660 msgid "guix install emacs-guix\n"
7661 msgstr ""
7662
7663 #. type: Plain text
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."
7666 msgstr ""
7667
7668 #. type: Plain text
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."
7671 msgstr ""
7672
7673 #. type: Plain text
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}."
7676 msgstr ""
7677
7678 #. type: Plain text
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."
7681 msgstr ""
7682
7683 #. type: Plain text
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}."
7686 msgstr ""
7687
7688 #. type: cindex
7689 #: guix-git/doc/guix.texi:2987 guix-git/doc/guix.texi:3070
7690 #, no-wrap
7691 msgid "transactions"
7692 msgstr ""
7693
7694 #. type: Plain text
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."
7697 msgstr ""
7698
7699 #. type: Plain text
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})."
7702 msgstr ""
7703
7704 #. type: Plain text
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."
7707 msgstr ""
7708
7709 #. type: cindex
7710 #: guix-git/doc/guix.texi:3010 guix-git/doc/guix.texi:4693
7711 #, no-wrap
7712 msgid "reproducibility"
7713 msgstr ""
7714
7715 #. type: Plain text
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})."
7718 msgstr ""
7719
7720 #. type: Plain text
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})."
7723 msgstr ""
7724
7725 #. type: Plain text
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})."
7728 msgstr ""
7729
7730 #. type: cindex
7731 #: guix-git/doc/guix.texi:3040
7732 #, no-wrap
7733 msgid "replication, of software environments"
7734 msgstr ""
7735
7736 #. type: cindex
7737 #: guix-git/doc/guix.texi:3041
7738 #, no-wrap
7739 msgid "provenance tracking, of software artifacts"
7740 msgstr ""
7741
7742 #. type: Plain text
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."
7745 msgstr ""
7746
7747 #. type: section
7748 #: guix-git/doc/guix.texi:3050
7749 #, no-wrap
7750 msgid "Invoking @command{guix package}"
7751 msgstr ""
7752
7753 #. type: cindex
7754 #: guix-git/doc/guix.texi:3052
7755 #, no-wrap
7756 msgid "installing packages"
7757 msgstr ""
7758
7759 #. type: cindex
7760 #: guix-git/doc/guix.texi:3053
7761 #, no-wrap
7762 msgid "removing packages"
7763 msgstr ""
7764
7765 #. type: cindex
7766 #: guix-git/doc/guix.texi:3054
7767 #, no-wrap
7768 msgid "package installation"
7769 msgstr ""
7770
7771 #. type: cindex
7772 #: guix-git/doc/guix.texi:3055
7773 #, no-wrap
7774 msgid "package removal"
7775 msgstr ""
7776
7777 #. type: Plain text
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:"
7780 msgstr ""
7781
7782 #. type: example
7783 #: guix-git/doc/guix.texi:3068
7784 #, no-wrap
7785 msgid "guix package @var{options}\n"
7786 msgstr ""
7787
7788 #. type: Plain text
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."
7791 msgstr ""
7792
7793 #. type: Plain text
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:"
7796 msgstr ""
7797
7798 #. type: example
7799 #: guix-git/doc/guix.texi:3081
7800 #, no-wrap
7801 msgid "guix package -r lua -i guile guile-cairo\n"
7802 msgstr ""
7803
7804 #. type: cindex
7805 #: guix-git/doc/guix.texi:3083
7806 #, no-wrap
7807 msgid "aliases, for @command{guix package}"
7808 msgstr ""
7809
7810 #. type: Plain text
7811 #: guix-git/doc/guix.texi:3085
7812 msgid "For your convenience, we also provide the following aliases:"
7813 msgstr ""
7814
7815 #. type: itemize
7816 #: guix-git/doc/guix.texi:3089
7817 msgid "@command{guix search} is an alias for @command{guix package -s},"
7818 msgstr ""
7819
7820 #. type: itemize
7821 #: guix-git/doc/guix.texi:3091
7822 msgid "@command{guix install} is an alias for @command{guix package -i},"
7823 msgstr ""
7824
7825 #. type: itemize
7826 #: guix-git/doc/guix.texi:3093
7827 msgid "@command{guix remove} is an alias for @command{guix package -r},"
7828 msgstr ""
7829
7830 #. type: itemize
7831 #: guix-git/doc/guix.texi:3095
7832 msgid "@command{guix upgrade} is an alias for @command{guix package -u},"
7833 msgstr ""
7834
7835 #. type: itemize
7836 #: guix-git/doc/guix.texi:3097
7837 msgid "and @command{guix show} is an alias for @command{guix package --show=}."
7838 msgstr ""
7839
7840 #. type: Plain text
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."
7843 msgstr ""
7844
7845 #. type: Plain text
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}})."
7848 msgstr ""
7849
7850 #. type: Plain text
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."
7853 msgstr ""
7854
7855 #. type: cindex
7856 #: guix-git/doc/guix.texi:3114 guix-git/doc/guix.texi:3347
7857 #, no-wrap
7858 msgid "search paths"
7859 msgstr ""
7860
7861 #. type: Plain text
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:"
7864 msgstr ""
7865
7866 #. type: example
7867 #: guix-git/doc/guix.texi:3123
7868 #, no-wrap
7869 msgid ""
7870 "GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n"
7871 "source \"$GUIX_PROFILE/etc/profile\"\n"
7872 msgstr ""
7873
7874 #. type: Plain text
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}."
7877 msgstr ""
7878
7879 #. type: Plain text
7880 #: guix-git/doc/guix.texi:3136
7881 msgid "The @var{options} can be among the following:"
7882 msgstr ""
7883
7884 #. type: item
7885 #: guix-git/doc/guix.texi:3139
7886 #, no-wrap
7887 msgid "--install=@var{package} @dots{}"
7888 msgstr ""
7889
7890 #. type: itemx
7891 #: guix-git/doc/guix.texi:3140
7892 #, no-wrap
7893 msgid "-i @var{package} @dots{}"
7894 msgstr ""
7895
7896 #. type: table
7897 #: guix-git/doc/guix.texi:3142
7898 msgid "Install the specified @var{package}s."
7899 msgstr ""
7900
7901 #. type: table
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)."
7904 msgstr ""
7905
7906 #. type: table
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})."
7909 msgstr ""
7910
7911 #. type: cindex
7912 #: guix-git/doc/guix.texi:3156
7913 #, no-wrap
7914 msgid "propagated inputs"
7915 msgstr ""
7916
7917 #. type: table
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)."
7920 msgstr ""
7921
7922 #. type: anchor{#1}
7923 #: guix-git/doc/guix.texi:3169
7924 msgid "package-cmd-propagated-inputs"
7925 msgstr ""
7926
7927 #. type: table
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."
7930 msgstr ""
7931
7932 #. type: table
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."
7935 msgstr ""
7936
7937 #. type: item
7938 #: guix-git/doc/guix.texi:3175
7939 #, no-wrap
7940 msgid "--install-from-expression=@var{exp}"
7941 msgstr ""
7942
7943 #. type: itemx
7944 #: guix-git/doc/guix.texi:3176
7945 #, no-wrap
7946 msgid "-e @var{exp}"
7947 msgstr ""
7948
7949 #. type: table
7950 #: guix-git/doc/guix.texi:3178
7951 msgid "Install the package @var{exp} evaluates to."
7952 msgstr ""
7953
7954 #. type: table
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)}."
7957 msgstr ""
7958
7959 #. type: table
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."
7962 msgstr ""
7963
7964 #. type: item
7965 #: guix-git/doc/guix.texi:3188
7966 #, no-wrap
7967 msgid "--install-from-file=@var{file}"
7968 msgstr ""
7969
7970 #. type: itemx
7971 #: guix-git/doc/guix.texi:3189 guix-git/doc/guix.texi:10684
7972 #, no-wrap
7973 msgid "-f @var{file}"
7974 msgstr ""
7975
7976 #. type: table
7977 #: guix-git/doc/guix.texi:3191
7978 msgid "Install the package that the code within @var{file} evaluates to."
7979 msgstr ""
7980
7981 #. type: table
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}):"
7984 msgstr ""
7985
7986 #. type: include
7987 #: guix-git/doc/guix.texi:3196 guix-git/doc/guix.texi:10692
7988 #, no-wrap
7989 msgid "package-hello.scm"
7990 msgstr ""
7991
7992 #. type: table
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})."
7995 msgstr ""
7996
7997 #. type: table
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}:"
8000 msgstr ""
8001
8002 #. type: example
8003 #: guix-git/doc/guix.texi:3211 guix-git/doc/guix.texi:10702
8004 #, no-wrap
8005 msgid "@verbatiminclude package-hello.json\n"
8006 msgstr ""
8007
8008 #. type: item
8009 #: guix-git/doc/guix.texi:3213
8010 #, no-wrap
8011 msgid "--remove=@var{package} @dots{}"
8012 msgstr ""
8013
8014 #. type: itemx
8015 #: guix-git/doc/guix.texi:3214
8016 #, no-wrap
8017 msgid "-r @var{package} @dots{}"
8018 msgstr ""
8019
8020 #. type: table
8021 #: guix-git/doc/guix.texi:3216
8022 msgid "Remove the specified @var{package}s."
8023 msgstr ""
8024
8025 #. type: table
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}."
8028 msgstr ""
8029
8030 #. type: item
8031 #: guix-git/doc/guix.texi:3222
8032 #, no-wrap
8033 msgid "--upgrade[=@var{regexp} @dots{}]"
8034 msgstr ""
8035
8036 #. type: itemx
8037 #: guix-git/doc/guix.texi:3223
8038 #, no-wrap
8039 msgid "-u [@var{regexp} @dots{}]"
8040 msgstr ""
8041
8042 #. type: cindex
8043 #: guix-git/doc/guix.texi:3224
8044 #, no-wrap
8045 msgid "upgrading packages"
8046 msgstr ""
8047
8048 #. type: table
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."
8051 msgstr ""
8052
8053 #. type: table
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})."
8056 msgstr ""
8057
8058 #. type: cindex
8059 #: guix-git/doc/guix.texi:3234
8060 #, no-wrap
8061 msgid "package transformations, upgrades"
8062 msgstr ""
8063
8064 #. type: table
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:"
8067 msgstr ""
8068
8069 #. type: example
8070 #: guix-git/doc/guix.texi:3242
8071 #, no-wrap
8072 msgid "guix install emacs-next --with-branch=emacs-next=master\n"
8073 msgstr ""
8074
8075 #. type: table
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."
8078 msgstr ""
8079
8080 #. type: table
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:"
8083 msgstr ""
8084
8085 #. type: example
8086 #: guix-git/doc/guix.texi:3255
8087 #, no-wrap
8088 msgid "guix install @var{package}\n"
8089 msgstr ""
8090
8091 #. type: item
8092 #: guix-git/doc/guix.texi:3257
8093 #, no-wrap
8094 msgid "--do-not-upgrade[=@var{regexp} @dots{}]"
8095 msgstr ""
8096
8097 #. type: table
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'':"
8100 msgstr ""
8101
8102 #. type: example
8103 #: guix-git/doc/guix.texi:3265
8104 #, no-wrap
8105 msgid "$ guix package --upgrade . --do-not-upgrade emacs\n"
8106 msgstr ""
8107
8108 #. type: anchor{#1}
8109 #: guix-git/doc/guix.texi:3267
8110 #, no-wrap
8111 msgid "profile-manifest"
8112 msgstr ""
8113
8114 #. type: item
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
8118 #, no-wrap
8119 msgid "--manifest=@var{file}"
8120 msgstr ""
8121
8122 #. type: itemx
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
8125 #, no-wrap
8126 msgid "-m @var{file}"
8127 msgstr ""
8128
8129 #. type: cindex
8130 #: guix-git/doc/guix.texi:3269
8131 #, no-wrap
8132 msgid "profile declaration"
8133 msgstr ""
8134
8135 #. type: cindex
8136 #: guix-git/doc/guix.texi:3270
8137 #, no-wrap
8138 msgid "profile manifest"
8139 msgstr ""
8140
8141 #. type: table
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."
8144 msgstr ""
8145
8146 #. type: table
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."
8149 msgstr ""
8150
8151 #. type: table
8152 #: guix-git/doc/guix.texi:3284
8153 msgid "@var{file} must return a @dfn{manifest} object, which is roughly a list of packages:"
8154 msgstr ""
8155
8156 #. type: findex
8157 #: guix-git/doc/guix.texi:3285
8158 #, no-wrap
8159 msgid "packages->manifest"
8160 msgstr ""
8161
8162 #. type: lisp
8163 #: guix-git/doc/guix.texi:3288
8164 #, no-wrap
8165 msgid ""
8166 "(use-package-modules guile emacs)\n"
8167 "\n"
8168 msgstr ""
8169
8170 #. type: lisp
8171 #: guix-git/doc/guix.texi:3294
8172 #, no-wrap
8173 msgid ""
8174 "(packages->manifest\n"
8175 " (list emacs\n"
8176 " guile-2.0\n"
8177 " ;; Use a specific package output.\n"
8178 " (list guile-2.0 \"debug\")))\n"
8179 msgstr ""
8180
8181 #. type: findex
8182 #: guix-git/doc/guix.texi:3296
8183 #, no-wrap
8184 msgid "specifications->manifest"
8185 msgstr ""
8186
8187 #. type: table
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:"
8190 msgstr ""
8191
8192 #. type: lisp
8193 #: guix-git/doc/guix.texi:3307
8194 #, no-wrap
8195 msgid ""
8196 "(specifications->manifest\n"
8197 " '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n"
8198 msgstr ""
8199
8200 #. type: table
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."
8203 msgstr ""
8204
8205 #. type: item
8206 #: guix-git/doc/guix.texi:3312 guix-git/doc/guix.texi:4414
8207 #, no-wrap
8208 msgid "--roll-back"
8209 msgstr ""
8210
8211 #. type: cindex
8212 #: guix-git/doc/guix.texi:3313 guix-git/doc/guix.texi:4415
8213 #: guix-git/doc/guix.texi:32869
8214 #, no-wrap
8215 msgid "rolling back"
8216 msgstr ""
8217
8218 #. type: cindex
8219 #: guix-git/doc/guix.texi:3314 guix-git/doc/guix.texi:4416
8220 #, no-wrap
8221 msgid "undoing transactions"
8222 msgstr ""
8223
8224 #. type: cindex
8225 #: guix-git/doc/guix.texi:3315 guix-git/doc/guix.texi:4417
8226 #, no-wrap
8227 msgid "transactions, undoing"
8228 msgstr ""
8229
8230 #. type: table
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."
8233 msgstr ""
8234
8235 #. type: table
8236 #: guix-git/doc/guix.texi:3321
8237 msgid "When combined with options such as @option{--install}, roll back occurs before any other actions."
8238 msgstr ""
8239
8240 #. type: table
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."
8243 msgstr ""
8244
8245 #. type: table
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."
8248 msgstr ""
8249
8250 #. type: item
8251 #: guix-git/doc/guix.texi:3330 guix-git/doc/guix.texi:4421
8252 #, no-wrap
8253 msgid "--switch-generation=@var{pattern}"
8254 msgstr ""
8255
8256 #. type: itemx
8257 #: guix-git/doc/guix.texi:3331 guix-git/doc/guix.texi:4422
8258 #, no-wrap
8259 msgid "-S @var{pattern}"
8260 msgstr ""
8261
8262 #. type: cindex
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
8265 #, no-wrap
8266 msgid "generations"
8267 msgstr ""
8268
8269 #. type: table
8270 #: guix-git/doc/guix.texi:3334 guix-git/doc/guix.texi:4425
8271 msgid "Switch to a particular generation defined by @var{pattern}."
8272 msgstr ""
8273
8274 #. type: table
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}."
8277 msgstr ""
8278
8279 #. type: table
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."
8282 msgstr ""
8283
8284 #. type: item
8285 #: guix-git/doc/guix.texi:3346
8286 #, no-wrap
8287 msgid "--search-paths[=@var{kind}]"
8288 msgstr ""
8289
8290 #. type: table
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."
8293 msgstr ""
8294
8295 #. type: table
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."
8298 msgstr ""
8299
8300 #. type: table
8301 #: guix-git/doc/guix.texi:3363
8302 msgid "The typical use case is to define these environment variables in the shell:"
8303 msgstr ""
8304
8305 #. type: example
8306 #: guix-git/doc/guix.texi:3366
8307 #, no-wrap
8308 msgid "$ eval `guix package --search-paths`\n"
8309 msgstr ""
8310
8311 #. type: table
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}."
8314 msgstr ""
8315
8316 #. type: table
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:"
8319 msgstr ""
8320
8321 #. type: example
8322 #: guix-git/doc/guix.texi:3380
8323 #, no-wrap
8324 msgid ""
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"
8328 msgstr ""
8329
8330 #. type: table
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."
8333 msgstr ""
8334
8335 #. type: cindex
8336 #: guix-git/doc/guix.texi:3387
8337 #, no-wrap
8338 msgid "profile, choosing"
8339 msgstr ""
8340
8341 #. type: item
8342 #: guix-git/doc/guix.texi:3388 guix-git/doc/guix.texi:4451
8343 #: guix-git/doc/guix.texi:4780
8344 #, no-wrap
8345 msgid "--profile=@var{profile}"
8346 msgstr ""
8347
8348 #. type: itemx
8349 #: guix-git/doc/guix.texi:3389 guix-git/doc/guix.texi:4452
8350 #: guix-git/doc/guix.texi:4781
8351 #, no-wrap
8352 msgid "-p @var{profile}"
8353 msgstr ""
8354
8355 #. type: table
8356 #: guix-git/doc/guix.texi:3391
8357 msgid "Use @var{profile} instead of the user's default profile."
8358 msgstr ""
8359
8360 #. type: table
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:"
8363 msgstr ""
8364
8365 #. type: example
8366 #: guix-git/doc/guix.texi:3402
8367 #, no-wrap
8368 msgid ""
8369 "$ guix install hello -p ~/code/my-profile\n"
8370 "@dots{}\n"
8371 "$ ~/code/my-profile/bin/hello\n"
8372 "Hello, world!\n"
8373 msgstr ""
8374
8375 #. type: table
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:"
8378 msgstr ""
8379
8380 #. type: example
8381 #: guix-git/doc/guix.texi:3409
8382 #, no-wrap
8383 msgid "$ rm ~/code/my-profile ~/code/my-profile-*-link\n"
8384 msgstr ""
8385
8386 #. type: item
8387 #: guix-git/doc/guix.texi:3411
8388 #, no-wrap
8389 msgid "--list-profiles"
8390 msgstr ""
8391
8392 #. type: table
8393 #: guix-git/doc/guix.texi:3413
8394 msgid "List all the user's profiles:"
8395 msgstr ""
8396
8397 #. type: example
8398 #: guix-git/doc/guix.texi:3420
8399 #, no-wrap
8400 msgid ""
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"
8406 msgstr ""
8407
8408 #. type: table
8409 #: guix-git/doc/guix.texi:3423
8410 msgid "When running as root, list all the profiles of all the users."
8411 msgstr ""
8412
8413 #. type: cindex
8414 #: guix-git/doc/guix.texi:3424
8415 #, no-wrap
8416 msgid "collisions, in a profile"
8417 msgstr ""
8418
8419 #. type: cindex
8420 #: guix-git/doc/guix.texi:3425
8421 #, no-wrap
8422 msgid "colliding packages in profiles"
8423 msgstr ""
8424
8425 #. type: cindex
8426 #: guix-git/doc/guix.texi:3426
8427 #, no-wrap
8428 msgid "profile collisions"
8429 msgstr ""
8430
8431 #. type: item
8432 #: guix-git/doc/guix.texi:3427
8433 #, no-wrap
8434 msgid "--allow-collisions"
8435 msgstr ""
8436
8437 #. type: table
8438 #: guix-git/doc/guix.texi:3429
8439 msgid "Allow colliding packages in the new profile. Use at your own risk!"
8440 msgstr ""
8441
8442 #. type: table
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."
8445 msgstr ""
8446
8447 #. type: item
8448 #: guix-git/doc/guix.texi:3434 guix-git/doc/guix.texi:4494
8449 #: guix-git/doc/guix.texi:6231
8450 #, no-wrap
8451 msgid "--bootstrap"
8452 msgstr ""
8453
8454 #. type: table
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."
8457 msgstr ""
8458
8459 #. type: Plain text
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:"
8462 msgstr ""
8463
8464 #. type: item
8465 #: guix-git/doc/guix.texi:3446
8466 #, no-wrap
8467 msgid "--search=@var{regexp}"
8468 msgstr ""
8469
8470 #. type: itemx
8471 #: guix-git/doc/guix.texi:3447
8472 #, no-wrap
8473 msgid "-s @var{regexp}"
8474 msgstr ""
8475
8476 #. type: anchor{#1}
8477 #: guix-git/doc/guix.texi:3449
8478 msgid "guix-search"
8479 msgstr ""
8480
8481 #. type: cindex
8482 #: guix-git/doc/guix.texi:3449
8483 #, no-wrap
8484 msgid "searching for packages"
8485 msgstr ""
8486
8487 #. type: table
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})."
8490 msgstr ""
8491
8492 #. type: table
8493 #: guix-git/doc/guix.texi:3458
8494 msgid "This allows specific fields to be extracted using the @command{recsel} command, for instance:"
8495 msgstr ""
8496
8497 #. type: example
8498 #: guix-git/doc/guix.texi:3464
8499 #, no-wrap
8500 msgid ""
8501 "$ guix package -s malloc | recsel -p name,version,relevance\n"
8502 "name: jemalloc\n"
8503 "version: 4.5.0\n"
8504 "relevance: 6\n"
8505 "\n"
8506 msgstr ""
8507
8508 #. type: example
8509 #: guix-git/doc/guix.texi:3468
8510 #, no-wrap
8511 msgid ""
8512 "name: glibc\n"
8513 "version: 2.25\n"
8514 "relevance: 1\n"
8515 "\n"
8516 msgstr ""
8517
8518 #. type: example
8519 #: guix-git/doc/guix.texi:3472
8520 #, no-wrap
8521 msgid ""
8522 "name: libgc\n"
8523 "version: 7.6.0\n"
8524 "relevance: 1\n"
8525 msgstr ""
8526
8527 #. type: table
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:"
8530 msgstr ""
8531
8532 #. type: example
8533 #: guix-git/doc/guix.texi:3480
8534 #, no-wrap
8535 msgid ""
8536 "$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n"
8537 "name: elfutils\n"
8538 "\n"
8539 msgstr ""
8540
8541 #. type: example
8542 #: guix-git/doc/guix.texi:3483
8543 #, no-wrap
8544 msgid ""
8545 "name: gmp\n"
8546 "@dots{}\n"
8547 msgstr ""
8548
8549 #. type: table
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):"
8552 msgstr ""
8553
8554 #. type: example
8555 #: guix-git/doc/guix.texi:3494
8556 #, no-wrap
8557 msgid ""
8558 "$ guix search '\\<board\\>' game | recsel -p name\n"
8559 "name: gnubg\n"
8560 "@dots{}\n"
8561 msgstr ""
8562
8563 #. type: table
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."
8566 msgstr ""
8567
8568 #. type: table
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:"
8571 msgstr ""
8572
8573 #. type: example
8574 #: guix-git/doc/guix.texi:3508
8575 #, no-wrap
8576 msgid ""
8577 "$ guix search crypto library | \\\n"
8578 " recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n"
8579 msgstr ""
8580
8581 #. type: table
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}."
8584 msgstr ""
8585
8586 #. type: item
8587 #: guix-git/doc/guix.texi:3514
8588 #, no-wrap
8589 msgid "--show=@var{package}"
8590 msgstr ""
8591
8592 #. type: table
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})."
8595 msgstr ""
8596
8597 #. type: example
8598 #: guix-git/doc/guix.texi:3523
8599 #, no-wrap
8600 msgid ""
8601 "$ guix package --show=python | recsel -p name,version\n"
8602 "name: python\n"
8603 "version: 2.7.6\n"
8604 "\n"
8605 msgstr ""
8606
8607 #. type: example
8608 #: guix-git/doc/guix.texi:3526
8609 #, no-wrap
8610 msgid ""
8611 "name: python\n"
8612 "version: 3.3.5\n"
8613 msgstr ""
8614
8615 #. type: table
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):"
8618 msgstr ""
8619
8620 #. type: example
8621 #: guix-git/doc/guix.texi:3534
8622 #, no-wrap
8623 msgid ""
8624 "$ guix show python@@3.4 | recsel -p name,version\n"
8625 "name: python\n"
8626 "version: 3.4.3\n"
8627 msgstr ""
8628
8629 #. type: item
8630 #: guix-git/doc/guix.texi:3538
8631 #, no-wrap
8632 msgid "--list-installed[=@var{regexp}]"
8633 msgstr ""
8634
8635 #. type: itemx
8636 #: guix-git/doc/guix.texi:3539
8637 #, no-wrap
8638 msgid "-I [@var{regexp}]"
8639 msgstr ""
8640
8641 #. type: table
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}."
8644 msgstr ""
8645
8646 #. type: table
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."
8649 msgstr ""
8650
8651 #. type: item
8652 #: guix-git/doc/guix.texi:3550
8653 #, no-wrap
8654 msgid "--list-available[=@var{regexp}]"
8655 msgstr ""
8656
8657 #. type: itemx
8658 #: guix-git/doc/guix.texi:3551
8659 #, no-wrap
8660 msgid "-A [@var{regexp}]"
8661 msgstr ""
8662
8663 #. type: table
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}."
8666 msgstr ""
8667
8668 #. type: table
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."
8671 msgstr ""
8672
8673 #. type: item
8674 #: guix-git/doc/guix.texi:3560 guix-git/doc/guix.texi:4407
8675 #, no-wrap
8676 msgid "--list-generations[=@var{pattern}]"
8677 msgstr ""
8678
8679 #. type: itemx
8680 #: guix-git/doc/guix.texi:3561 guix-git/doc/guix.texi:4408
8681 #, no-wrap
8682 msgid "-l [@var{pattern}]"
8683 msgstr ""
8684
8685 #. type: table
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."
8688 msgstr ""
8689
8690 #. type: table
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."
8693 msgstr ""
8694
8695 #. type: table
8696 #: guix-git/doc/guix.texi:3575
8697 msgid "When @var{pattern} is used, the command returns only matching generations. Valid patterns include:"
8698 msgstr ""
8699
8700 #. type: item
8701 #: guix-git/doc/guix.texi:3577
8702 #, no-wrap
8703 msgid "@emph{Integers and comma-separated integers}. Both patterns denote"
8704 msgstr ""
8705
8706 #. type: itemize
8707 #: guix-git/doc/guix.texi:3580
8708 msgid "generation numbers. For instance, @option{--list-generations=1} returns the first one."
8709 msgstr ""
8710
8711 #. type: itemize
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."
8714 msgstr ""
8715
8716 #. type: item
8717 #: guix-git/doc/guix.texi:3584
8718 #, no-wrap
8719 msgid "@emph{Ranges}. @option{--list-generations=2..9} prints the"
8720 msgstr ""
8721
8722 #. type: itemize
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."
8725 msgstr ""
8726
8727 #. type: itemize
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."
8730 msgstr ""
8731
8732 #. type: item
8733 #: guix-git/doc/guix.texi:3592
8734 #, no-wrap
8735 msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks,"
8736 msgstr ""
8737
8738 #. type: itemize
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."
8741 msgstr ""
8742
8743 #. type: item
8744 #: guix-git/doc/guix.texi:3598 guix-git/doc/guix.texi:4432
8745 #, no-wrap
8746 msgid "--delete-generations[=@var{pattern}]"
8747 msgstr ""
8748
8749 #. type: itemx
8750 #: guix-git/doc/guix.texi:3599 guix-git/doc/guix.texi:4433
8751 #, no-wrap
8752 msgid "-d [@var{pattern}]"
8753 msgstr ""
8754
8755 #. type: table
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."
8758 msgstr ""
8759
8760 #. type: table
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."
8763 msgstr ""
8764
8765 #. type: table
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."
8768 msgstr ""
8769
8770 #. type: table
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."
8773 msgstr ""
8774
8775 #. type: cindex
8776 #: guix-git/doc/guix.texi:3615
8777 #, no-wrap
8778 msgid "manifest, exporting"
8779 msgstr ""
8780
8781 #. type: anchor{#1}
8782 #: guix-git/doc/guix.texi:3617
8783 msgid "export-manifest"
8784 msgstr ""
8785
8786 #. type: item
8787 #: guix-git/doc/guix.texi:3617
8788 #, no-wrap
8789 msgid "--export-manifest"
8790 msgstr ""
8791
8792 #. type: table
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)."
8795 msgstr ""
8796
8797 #. type: table
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."
8800 msgstr ""
8801
8802 #. type: table
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."
8805 msgstr ""
8806
8807 #. type: table
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."
8810 msgstr ""
8811
8812 #. type: cindex
8813 #: guix-git/doc/guix.texi:3635
8814 #, no-wrap
8815 msgid "pinning, channel revisions of a profile"
8816 msgstr ""
8817
8818 #. type: item
8819 #: guix-git/doc/guix.texi:3636
8820 #, no-wrap
8821 msgid "--export-channels"
8822 msgstr ""
8823
8824 #. type: table
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})."
8827 msgstr ""
8828
8829 #. type: table
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})."
8832 msgstr ""
8833
8834 #. type: table
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})."
8837 msgstr ""
8838
8839 #. type: table
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."
8842 msgstr ""
8843
8844 #. type: Plain text
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})."
8847 msgstr ""
8848
8849 #. type: cindex
8850 #: guix-git/doc/guix.texi:3669
8851 #, no-wrap
8852 msgid "pre-built binaries"
8853 msgstr ""
8854
8855 #. type: Plain text
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."
8858 msgstr ""
8859
8860 #. type: Plain text
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."
8863 msgstr ""
8864
8865 #. type: cindex
8866 #: guix-git/doc/guix.texi:3694
8867 #, no-wrap
8868 msgid "build farm"
8869 msgstr ""
8870
8871 #. type: Plain text
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})."
8874 msgstr ""
8875
8876 #. type: Plain text
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."
8879 msgstr ""
8880
8881 #. type: Plain text
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."
8884 msgstr ""
8885
8886 #. type: cindex
8887 #: guix-git/doc/guix.texi:3723
8888 #, no-wrap
8889 msgid "security"
8890 msgstr ""
8891
8892 #. type: cindex
8893 #: guix-git/doc/guix.texi:3725
8894 #, no-wrap
8895 msgid "access control list (ACL), for substitutes"
8896 msgstr ""
8897
8898 #. type: cindex
8899 #: guix-git/doc/guix.texi:3726
8900 #, no-wrap
8901 msgid "ACL (access control list), for substitutes"
8902 msgstr ""
8903
8904 #. type: Plain text
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."
8907 msgstr ""
8908
8909 #. type: quotation
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."
8912 msgstr ""
8913
8914 #. type: Plain text
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:"
8917 msgstr ""
8918
8919 #. type: example
8920 #: guix-git/doc/guix.texi:3748
8921 #, no-wrap
8922 msgid "# guix archive --authorize < @var{prefix}/share/guix/@value{SUBSTITUTE-SERVER}.pub\n"
8923 msgstr ""
8924
8925 #. type: Plain text
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:"
8928 msgstr ""
8929
8930 #. type: example
8931 #: guix-git/doc/guix.texi:3761
8932 #, no-wrap
8933 msgid ""
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"
8940 "@dots{}\n"
8941 msgstr ""
8942
8943 #. type: Plain text
8944 #: guix-git/doc/guix.texi:3765
8945 msgid "to something like:"
8946 msgstr ""
8947
8948 #. type: example
8949 #: guix-git/doc/guix.texi:3774
8950 #, no-wrap
8951 msgid ""
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"
8958 "@dots{}\n"
8959 msgstr ""
8960
8961 #. type: Plain text
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."
8964 msgstr ""
8965
8966 #. type: cindex
8967 #: guix-git/doc/guix.texi:3782
8968 #, no-wrap
8969 msgid "substitutes, how to disable"
8970 msgstr ""
8971
8972 #. type: Plain text
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."
8975 msgstr ""
8976
8977 #. type: cindex
8978 #: guix-git/doc/guix.texi:3792
8979 #, no-wrap
8980 msgid "substitute servers, adding more"
8981 msgstr ""
8982
8983 #. type: Plain text
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."
8986 msgstr ""
8987
8988 #. type: Plain text
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."
8991 msgstr ""
8992
8993 #. type: Plain text
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}})."
8996 msgstr ""
8997
8998 #. type: Plain text
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:"
9001 msgstr ""
9002
9003 #. type: lisp
9004 #: guix-git/doc/guix.texi:3833
9005 #, no-wrap
9006 msgid ""
9007 "(operating-system\n"
9008 " ;; @dots{}\n"
9009 " (services\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"
9022 msgstr ""
9023
9024 #. type: Plain text
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:"
9027 msgstr ""
9028
9029 #. type: example
9030 #: guix-git/doc/guix.texi:3844
9031 #, no-wrap
9032 msgid ""
9033 "$ sudo guix system reconfigure /etc/config.scm\n"
9034 "$ sudo herd restart guix-daemon\n"
9035 msgstr ""
9036
9037 #. type: Plain text
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:"
9040 msgstr ""
9041
9042 #. type: enumerate
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}}):"
9045 msgstr ""
9046
9047 #. type: example
9048 #: guix-git/doc/guix.texi:3860
9049 #, no-wrap
9050 msgid "@dots{} --substitute-urls='https://guix.example.org https://@value{SUBSTITUTE-SERVER}'\n"
9051 msgstr ""
9052
9053 #. type: enumerate
9054 #: guix-git/doc/guix.texi:3864
9055 msgid "Restart the daemon. For systemd, it goes like this:"
9056 msgstr ""
9057
9058 #. type: example
9059 #: guix-git/doc/guix.texi:3868
9060 #, no-wrap
9061 msgid ""
9062 "systemctl daemon-reload\n"
9063 "systemctl restart guix-daemon.service\n"
9064 msgstr ""
9065
9066 #. type: enumerate
9067 #: guix-git/doc/guix.texi:3872
9068 msgid "Authorize the key of the new server (@pxref{Invoking guix archive}):"
9069 msgstr ""
9070
9071 #. type: example
9072 #: guix-git/doc/guix.texi:3875
9073 #, no-wrap
9074 msgid "guix archive --authorize < key.pub\n"
9075 msgstr ""
9076
9077 #. type: enumerate
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."
9080 msgstr ""
9081
9082 #. type: Plain text
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."
9085 msgstr ""
9086
9087 #. type: Plain text
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."
9090 msgstr ""
9091
9092 #. type: cindex
9093 #: guix-git/doc/guix.texi:3894
9094 #, no-wrap
9095 msgid "digital signatures"
9096 msgstr ""
9097
9098 #. type: Plain text
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."
9101 msgstr ""
9102
9103 #. type: Plain text
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:"
9106 msgstr ""
9107
9108 #. type: example
9109 #: guix-git/doc/guix.texi:3907
9110 #, no-wrap
9111 msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n"
9112 msgstr ""
9113
9114 #. type: Plain text
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)."
9117 msgstr ""
9118
9119 #. type: Plain text
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)."
9122 msgstr ""
9123
9124 #. type: Plain text
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}."
9127 msgstr ""
9128
9129 #. type: Plain text
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."
9132 msgstr ""
9133
9134 #. type: Plain text
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."
9137 msgstr ""
9138
9139 #. type: Plain text
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."
9142 msgstr ""
9143
9144 #. type: cindex
9145 #: guix-git/doc/guix.texi:3969
9146 #, no-wrap
9147 msgid "trust, of pre-built binaries"
9148 msgstr ""
9149
9150 #. type: Plain text
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})."
9153 msgstr ""
9154
9155 #. type: Plain text
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}})."
9158 msgstr ""
9159
9160 #. type: Plain text
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}."
9163 msgstr ""
9164
9165 #. type: cindex
9166 #: guix-git/doc/guix.texi:3999
9167 #, no-wrap
9168 msgid "multiple-output packages"
9169 msgstr ""
9170
9171 #. type: cindex
9172 #: guix-git/doc/guix.texi:4000
9173 #, no-wrap
9174 msgid "package outputs"
9175 msgstr ""
9176
9177 #. type: cindex
9178 #: guix-git/doc/guix.texi:4001
9179 #, no-wrap
9180 msgid "outputs"
9181 msgstr ""
9182
9183 #. type: Plain text
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."
9186 msgstr ""
9187
9188 #. type: Plain text
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:"
9191 msgstr ""
9192
9193 #. type: example
9194 #: guix-git/doc/guix.texi:4022
9195 #, no-wrap
9196 msgid "guix install glib\n"
9197 msgstr ""
9198
9199 #. type: item
9200 #: guix-git/doc/guix.texi:4024 guix-git/doc/guix.texi:34192
9201 #: guix-git/doc/guix.texi:34249
9202 #, no-wrap
9203 msgid "documentation"
9204 msgstr ""
9205
9206 #. type: Plain text
9207 #: guix-git/doc/guix.texi:4026
9208 msgid "The command to install its documentation is:"
9209 msgstr ""
9210
9211 #. type: example
9212 #: guix-git/doc/guix.texi:4029
9213 #, no-wrap
9214 msgid "guix install glib:doc\n"
9215 msgstr ""
9216
9217 #. type: Plain text
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})."
9220 msgstr ""
9221
9222 #. type: Plain text
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})."
9225 msgstr ""
9226
9227 #. type: section
9228 #: guix-git/doc/guix.texi:4051
9229 #, no-wrap
9230 msgid "Invoking @command{guix gc}"
9231 msgstr ""
9232
9233 #. type: cindex
9234 #: guix-git/doc/guix.texi:4053
9235 #, no-wrap
9236 msgid "garbage collector"
9237 msgstr ""
9238
9239 #. type: cindex
9240 #: guix-git/doc/guix.texi:4054
9241 #, no-wrap
9242 msgid "disk space"
9243 msgstr ""
9244
9245 #. type: Plain text
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!"
9248 msgstr ""
9249
9250 #. type: Plain text
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."
9253 msgstr ""
9254
9255 #. type: Plain text
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})."
9258 msgstr ""
9259
9260 #. type: Plain text
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:"
9263 msgstr ""
9264
9265 #. type: example
9266 #: guix-git/doc/guix.texi:4084
9267 #, no-wrap
9268 msgid "guix gc -F 5G\n"
9269 msgstr ""
9270
9271 #. type: Plain text
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."
9274 msgstr ""
9275
9276 #. type: Plain text
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:"
9279 msgstr ""
9280
9281 #. type: item
9282 #: guix-git/doc/guix.texi:4101
9283 #, no-wrap
9284 msgid "--collect-garbage[=@var{min}]"
9285 msgstr ""
9286
9287 #. type: itemx
9288 #: guix-git/doc/guix.texi:4102
9289 #, no-wrap
9290 msgid "-C [@var{min}]"
9291 msgstr ""
9292
9293 #. type: table
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."
9296 msgstr ""
9297
9298 #. type: table
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})."
9301 msgstr ""
9302
9303 #. type: table
9304 #: guix-git/doc/guix.texi:4113
9305 msgid "When @var{min} is omitted, collect all the garbage."
9306 msgstr ""
9307
9308 #. type: item
9309 #: guix-git/doc/guix.texi:4114
9310 #, no-wrap
9311 msgid "--free-space=@var{free}"
9312 msgstr ""
9313
9314 #. type: itemx
9315 #: guix-git/doc/guix.texi:4115
9316 #, no-wrap
9317 msgid "-F @var{free}"
9318 msgstr ""
9319
9320 #. type: table
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."
9323 msgstr ""
9324
9325 #. type: table
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."
9328 msgstr ""
9329
9330 #. type: item
9331 #: guix-git/doc/guix.texi:4123
9332 #, no-wrap
9333 msgid "--delete-generations[=@var{duration}]"
9334 msgstr ""
9335
9336 #. type: itemx
9337 #: guix-git/doc/guix.texi:4124
9338 #, no-wrap
9339 msgid "-d [@var{duration}]"
9340 msgstr ""
9341
9342 #. type: table
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}."
9345 msgstr ""
9346
9347 #. type: table
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:"
9350 msgstr ""
9351
9352 #. type: example
9353 #: guix-git/doc/guix.texi:4135
9354 #, no-wrap
9355 msgid "guix gc -d 2m -F 10G\n"
9356 msgstr ""
9357
9358 #. type: item
9359 #: guix-git/doc/guix.texi:4137
9360 #, no-wrap
9361 msgid "--delete"
9362 msgstr ""
9363
9364 #. type: itemx
9365 #: guix-git/doc/guix.texi:4138
9366 #, no-wrap
9367 msgid "-D"
9368 msgstr ""
9369
9370 #. type: table
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."
9373 msgstr ""
9374
9375 #. type: item
9376 #: guix-git/doc/guix.texi:4143
9377 #, no-wrap
9378 msgid "--list-failures"
9379 msgstr ""
9380
9381 #. type: table
9382 #: guix-git/doc/guix.texi:4145
9383 msgid "List store items corresponding to cached build failures."
9384 msgstr ""
9385
9386 #. type: table
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}})."
9389 msgstr ""
9390
9391 #. type: item
9392 #: guix-git/doc/guix.texi:4150
9393 #, no-wrap
9394 msgid "--list-roots"
9395 msgstr ""
9396
9397 #. type: table
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."
9400 msgstr ""
9401
9402 #. type: item
9403 #: guix-git/doc/guix.texi:4154
9404 #, no-wrap
9405 msgid "--list-busy"
9406 msgstr ""
9407
9408 #. type: table
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."
9411 msgstr ""
9412
9413 #. type: item
9414 #: guix-git/doc/guix.texi:4158
9415 #, no-wrap
9416 msgid "--clear-failures"
9417 msgstr ""
9418
9419 #. type: table
9420 #: guix-git/doc/guix.texi:4160
9421 msgid "Remove the specified store items from the failed-build cache."
9422 msgstr ""
9423
9424 #. type: table
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."
9427 msgstr ""
9428
9429 #. type: item
9430 #: guix-git/doc/guix.texi:4164
9431 #, no-wrap
9432 msgid "--list-dead"
9433 msgstr ""
9434
9435 #. type: table
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."
9438 msgstr ""
9439
9440 #. type: item
9441 #: guix-git/doc/guix.texi:4168
9442 #, no-wrap
9443 msgid "--list-live"
9444 msgstr ""
9445
9446 #. type: table
9447 #: guix-git/doc/guix.texi:4170
9448 msgid "Show the list of live store files and directories."
9449 msgstr ""
9450
9451 #. type: Plain text
9452 #: guix-git/doc/guix.texi:4174
9453 msgid "In addition, the references among existing store files can be queried:"
9454 msgstr ""
9455
9456 #. type: item
9457 #: guix-git/doc/guix.texi:4177
9458 #, no-wrap
9459 msgid "--references"
9460 msgstr ""
9461
9462 #. type: itemx
9463 #: guix-git/doc/guix.texi:4178
9464 #, no-wrap
9465 msgid "--referrers"
9466 msgstr ""
9467
9468 #. type: cindex
9469 #: guix-git/doc/guix.texi:4179 guix-git/doc/guix.texi:12256
9470 #, no-wrap
9471 msgid "package dependencies"
9472 msgstr ""
9473
9474 #. type: table
9475 #: guix-git/doc/guix.texi:4182
9476 msgid "List the references (respectively, the referrers) of store files given as arguments."
9477 msgstr ""
9478
9479 #. type: item
9480 #: guix-git/doc/guix.texi:4183
9481 #, no-wrap
9482 msgid "--requisites"
9483 msgstr ""
9484
9485 #. type: itemx
9486 #: guix-git/doc/guix.texi:4184 guix-git/doc/guix.texi:6031
9487 #, no-wrap
9488 msgid "-R"
9489 msgstr ""
9490
9491 #. type: item
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
9494 #, no-wrap
9495 msgid "closure"
9496 msgstr ""
9497
9498 #. type: table
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."
9501 msgstr ""
9502
9503 #. type: table
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."
9506 msgstr ""
9507
9508 #. type: item
9509 #: guix-git/doc/guix.texi:4195
9510 #, no-wrap
9511 msgid "--derivers"
9512 msgstr ""
9513
9514 #. type: item
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
9517 #, no-wrap
9518 msgid "derivation"
9519 msgstr ""
9520
9521 #. type: table
9522 #: guix-git/doc/guix.texi:4199
9523 msgid "Return the derivation(s) leading to the given store items (@pxref{Derivations})."
9524 msgstr ""
9525
9526 #. type: table
9527 #: guix-git/doc/guix.texi:4201
9528 msgid "For example, this command:"
9529 msgstr ""
9530
9531 #. type: example
9532 #: guix-git/doc/guix.texi:4204
9533 #, no-wrap
9534 msgid "guix gc --derivers $(guix package -I ^emacs$ | cut -f4)\n"
9535 msgstr ""
9536
9537 #. type: table
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."
9540 msgstr ""
9541
9542 #. type: table
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."
9545 msgstr ""
9546
9547 #. type: Plain text
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."
9550 msgstr ""
9551
9552 #. type: item
9553 #: guix-git/doc/guix.texi:4220
9554 #, no-wrap
9555 msgid "--verify[=@var{options}]"
9556 msgstr ""
9557
9558 #. type: cindex
9559 #: guix-git/doc/guix.texi:4221
9560 #, no-wrap
9561 msgid "integrity, of the store"
9562 msgstr ""
9563
9564 #. type: cindex
9565 #: guix-git/doc/guix.texi:4222
9566 #, no-wrap
9567 msgid "integrity checking"
9568 msgstr ""
9569
9570 #. type: table
9571 #: guix-git/doc/guix.texi:4224
9572 msgid "Verify the integrity of the store."
9573 msgstr ""
9574
9575 #. type: table
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}."
9578 msgstr ""
9579
9580 #. type: table
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}."
9583 msgstr ""
9584
9585 #. type: table
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."
9588 msgstr ""
9589
9590 #. type: cindex
9591 #: guix-git/doc/guix.texi:4237
9592 #, no-wrap
9593 msgid "repairing the store"
9594 msgstr ""
9595
9596 #. type: cindex
9597 #: guix-git/doc/guix.texi:4238 guix-git/doc/guix.texi:10852
9598 #, no-wrap
9599 msgid "corruption, recovering from"
9600 msgstr ""
9601
9602 #. type: table
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})."
9605 msgstr ""
9606
9607 #. type: item
9608 #: guix-git/doc/guix.texi:4247
9609 #, no-wrap
9610 msgid "--optimize"
9611 msgstr ""
9612
9613 #. type: table
9614 #: guix-git/doc/guix.texi:4251
9615 msgid "Optimize the store by hard-linking identical files---this is @dfn{deduplication}."
9616 msgstr ""
9617
9618 #. type: table
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}."
9621 msgstr ""
9622
9623 #. type: section
9624 #: guix-git/doc/guix.texi:4261
9625 #, no-wrap
9626 msgid "Invoking @command{guix pull}"
9627 msgstr ""
9628
9629 #. type: cindex
9630 #: guix-git/doc/guix.texi:4263
9631 #, no-wrap
9632 msgid "upgrading Guix"
9633 msgstr ""
9634
9635 #. type: cindex
9636 #: guix-git/doc/guix.texi:4264
9637 #, no-wrap
9638 msgid "updating Guix"
9639 msgstr ""
9640
9641 #. type: command{#1}
9642 #: guix-git/doc/guix.texi:4265
9643 #, no-wrap
9644 msgid "guix pull"
9645 msgstr ""
9646
9647 #. type: cindex
9648 #: guix-git/doc/guix.texi:4266
9649 #, no-wrap
9650 msgid "pull"
9651 msgstr ""
9652
9653 #. type: cindex
9654 #: guix-git/doc/guix.texi:4267
9655 #, no-wrap
9656 msgid "security, @command{guix pull}"
9657 msgstr ""
9658
9659 #. type: cindex
9660 #: guix-git/doc/guix.texi:4268
9661 #, no-wrap
9662 msgid "authenticity, of code obtained with @command{guix pull}"
9663 msgstr ""
9664
9665 #. type: Plain text
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."
9668 msgstr ""
9669
9670 #. type: Plain text
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:"
9673 msgstr ""
9674
9675 #. type: enumerate
9676 #: guix-git/doc/guix.texi:4285
9677 msgid "the @option{--channels} option;"
9678 msgstr ""
9679
9680 #. type: enumerate
9681 #: guix-git/doc/guix.texi:4287
9682 msgid "the user's @file{~/.config/guix/channels.scm} file;"
9683 msgstr ""
9684
9685 #. type: enumerate
9686 #: guix-git/doc/guix.texi:4289
9687 msgid "the system-wide @file{/etc/guix/channels.scm} file;"
9688 msgstr ""
9689
9690 #. type: enumerate
9691 #: guix-git/doc/guix.texi:4292
9692 msgid "the built-in default channels specified in the @code{%default-channels} variable."
9693 msgstr ""
9694
9695 #. type: Plain text
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."
9698 msgstr ""
9699
9700 #. type: Plain text
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."
9703 msgstr ""
9704
9705 #. type: Plain text
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}):"
9708 msgstr ""
9709
9710 #. type: example
9711 #: guix-git/doc/guix.texi:4315
9712 #, no-wrap
9713 msgid ""
9714 "export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n"
9715 "export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n"
9716 msgstr ""
9717
9718 #. type: Plain text
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:"
9721 msgstr ""
9722
9723 #. type: example
9724 #: guix-git/doc/guix.texi:4327
9725 #, no-wrap
9726 msgid ""
9727 "$ guix pull -l\n"
9728 "Generation 1\tJun 10 2018 00:18:18\n"
9729 " guix 65956ad\n"
9730 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
9731 " branch: origin/master\n"
9732 " commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n"
9733 "\n"
9734 msgstr ""
9735
9736 #. type: example
9737 #: guix-git/doc/guix.texi:4337
9738 #, no-wrap
9739 msgid ""
9740 "Generation 2\tJun 11 2018 11:02:49\n"
9741 " guix e0cc7f6\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"
9749 "\n"
9750 msgstr ""
9751
9752 #. type: example
9753 #: guix-git/doc/guix.texi:4345
9754 #, no-wrap
9755 msgid ""
9756 "Generation 3\tJun 13 2018 23:31:07\t(current)\n"
9757 " guix 844cc1c\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"
9763 msgstr ""
9764
9765 #. type: Plain text
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."
9768 msgstr ""
9769
9770 #. type: Plain text
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:"
9773 msgstr ""
9774
9775 #. type: example
9776 #: guix-git/doc/guix.texi:4360
9777 #, no-wrap
9778 msgid ""
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"
9783 msgstr ""
9784
9785 #. type: Plain text
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:"
9788 msgstr ""
9789
9790 #. type: example
9791 #: guix-git/doc/guix.texi:4369
9792 #, no-wrap
9793 msgid ""
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"
9798 msgstr ""
9799
9800 #. type: Plain text
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:"
9803 msgstr ""
9804
9805 #. type: item
9806 #: guix-git/doc/guix.texi:4375 guix-git/doc/guix.texi:4533
9807 #, no-wrap
9808 msgid "--url=@var{url}"
9809 msgstr ""
9810
9811 #. type: itemx
9812 #: guix-git/doc/guix.texi:4376 guix-git/doc/guix.texi:4534
9813 #, no-wrap
9814 msgid "--commit=@var{commit}"
9815 msgstr ""
9816
9817 #. type: itemx
9818 #: guix-git/doc/guix.texi:4377 guix-git/doc/guix.texi:4535
9819 #, no-wrap
9820 msgid "--branch=@var{branch}"
9821 msgstr ""
9822
9823 #. type: table
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}."
9826 msgstr ""
9827
9828 #. type: cindex
9829 #: guix-git/doc/guix.texi:4382 guix-git/doc/guix.texi:4979
9830 #, no-wrap
9831 msgid "@file{channels.scm}, configuration file"
9832 msgstr ""
9833
9834 #. type: cindex
9835 #: guix-git/doc/guix.texi:4383 guix-git/doc/guix.texi:4980
9836 #, no-wrap
9837 msgid "configuration file for channels"
9838 msgstr ""
9839
9840 #. type: table
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)."
9843 msgstr ""
9844
9845 #. type: item
9846 #: guix-git/doc/guix.texi:4388 guix-git/doc/guix.texi:4540
9847 #, no-wrap
9848 msgid "--channels=@var{file}"
9849 msgstr ""
9850
9851 #. type: itemx
9852 #: guix-git/doc/guix.texi:4389 guix-git/doc/guix.texi:4541
9853 #, no-wrap
9854 msgid "-C @var{file}"
9855 msgstr ""
9856
9857 #. type: table
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."
9860 msgstr ""
9861
9862 #. type: cindex
9863 #: guix-git/doc/guix.texi:4396
9864 #, no-wrap
9865 msgid "channel news"
9866 msgstr ""
9867
9868 #. type: item
9869 #: guix-git/doc/guix.texi:4397
9870 #, no-wrap
9871 msgid "--news"
9872 msgstr ""
9873
9874 #. type: itemx
9875 #: guix-git/doc/guix.texi:4398 guix-git/doc/guix.texi:5806
9876 #: guix-git/doc/guix.texi:33161
9877 #, no-wrap
9878 msgid "-N"
9879 msgstr ""
9880
9881 #. type: table
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})."
9884 msgstr ""
9885
9886 #. type: table
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)."
9889 msgstr ""
9890
9891 #. type: table
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})."
9894 msgstr ""
9895
9896 #. type: table
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."
9899 msgstr ""
9900
9901 #. type: table
9902 #: guix-git/doc/guix.texi:4444
9903 msgid "If the current generation matches, it is @emph{not} deleted."
9904 msgstr ""
9905
9906 #. type: table
9907 #: guix-git/doc/guix.texi:4450
9908 msgid "@xref{Invoking guix describe}, for a way to display information about the current generation only."
9909 msgstr ""
9910
9911 #. type: table
9912 #: guix-git/doc/guix.texi:4454
9913 msgid "Use @var{profile} instead of @file{~/.config/guix/current}."
9914 msgstr ""
9915
9916 #. type: item
9917 #: guix-git/doc/guix.texi:4455 guix-git/doc/guix.texi:10243
9918 #, no-wrap
9919 msgid "--dry-run"
9920 msgstr ""
9921
9922 #. type: itemx
9923 #: guix-git/doc/guix.texi:4456 guix-git/doc/guix.texi:10244
9924 #: guix-git/doc/guix.texi:12094
9925 #, no-wrap
9926 msgid "-n"
9927 msgstr ""
9928
9929 #. type: table
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."
9932 msgstr ""
9933
9934 #. type: item
9935 #: guix-git/doc/guix.texi:4460 guix-git/doc/guix.texi:33180
9936 #, no-wrap
9937 msgid "--allow-downgrades"
9938 msgstr ""
9939
9940 #. type: table
9941 #: guix-git/doc/guix.texi:4463
9942 msgid "Allow pulling older or unrelated revisions of channels than those currently in use."
9943 msgstr ""
9944
9945 #. type: cindex
9946 #: guix-git/doc/guix.texi:4464
9947 #, no-wrap
9948 msgid "downgrade attacks, protection against"
9949 msgstr ""
9950
9951 #. type: table
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."
9954 msgstr ""
9955
9956 #. type: quotation
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}."
9959 msgstr ""
9960
9961 #. type: item
9962 #: guix-git/doc/guix.texi:4475
9963 #, no-wrap
9964 msgid "--disable-authentication"
9965 msgstr ""
9966
9967 #. type: table
9968 #: guix-git/doc/guix.texi:4477
9969 msgid "Allow pulling channel code without authenticating it."
9970 msgstr ""
9971
9972 #. type: cindex
9973 #: guix-git/doc/guix.texi:4478 guix-git/doc/guix.texi:5125
9974 #, no-wrap
9975 msgid "authentication, of channel code"
9976 msgstr ""
9977
9978 #. type: table
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."
9981 msgstr ""
9982
9983 #. type: quotation
9984 #: guix-git/doc/guix.texi:4487
9985 msgid "Make sure you understand its security implications before using @option{--disable-authentication}."
9986 msgstr ""
9987
9988 #. type: itemx
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
9993 #, no-wrap
9994 msgid "-s @var{system}"
9995 msgstr ""
9996
9997 #. type: table
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."
10000 msgstr ""
10001
10002 #. type: table
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."
10005 msgstr ""
10006
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."
10010 msgstr ""
10011
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})."
10015 msgstr ""
10016
10017 #. type: section
10018 #: guix-git/doc/guix.texi:4508
10019 #, no-wrap
10020 msgid "Invoking @command{guix time-machine}"
10021 msgstr ""
10022
10023 #. type: command{#1}
10024 #: guix-git/doc/guix.texi:4510
10025 #, no-wrap
10026 msgid "guix time-machine"
10027 msgstr ""
10028
10029 #. type: cindex
10030 #: guix-git/doc/guix.texi:4511 guix-git/doc/guix.texi:5083
10031 #, no-wrap
10032 msgid "pinning, channels"
10033 msgstr ""
10034
10035 #. type: cindex
10036 #: guix-git/doc/guix.texi:4512 guix-git/doc/guix.texi:4694
10037 #: guix-git/doc/guix.texi:5084
10038 #, no-wrap
10039 msgid "replicating Guix"
10040 msgstr ""
10041
10042 #. type: cindex
10043 #: guix-git/doc/guix.texi:4513 guix-git/doc/guix.texi:5085
10044 #, no-wrap
10045 msgid "reproducibility, of Guix"
10046 msgstr ""
10047
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})."
10051 msgstr ""
10052
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:"
10062 msgstr ""
10063
10064 #. type: example
10065 #: guix-git/doc/guix.texi:4526
10066 #, no-wrap
10067 msgid "guix time-machine @var{options}@dots{} -- @var{command} @var {arg}@dots{}\n"
10068 msgstr ""
10069
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}):"
10073 msgstr ""
10074
10075 #. type: table
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}."
10078 msgstr ""
10079
10080 #. type: table
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."
10083 msgstr ""
10084
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"
10088 msgstr ""
10089
10090 #. type: example
10091 #: guix-git/doc/guix.texi:4552
10092 #, no-wrap
10093 msgid "guix time-machine -- build hello\n"
10094 msgstr ""
10095
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!"
10099 msgstr ""
10100
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})."
10104 msgstr ""
10105
10106 #. type: quotation
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."
10109 msgstr ""
10110
10111 #. type: cindex
10112 #: guix-git/doc/guix.texi:4571 guix-git/doc/guix.texi:10077
10113 #, no-wrap
10114 msgid "inferiors"
10115 msgstr ""
10116
10117 #. type: cindex
10118 #: guix-git/doc/guix.texi:4572
10119 #, no-wrap
10120 msgid "composition of Guix revisions"
10121 msgstr ""
10122
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."
10126 msgstr ""
10127
10128 #. type: cindex
10129 #: guix-git/doc/guix.texi:4578 guix-git/doc/guix.texi:4643
10130 #, no-wrap
10131 msgid "inferior packages"
10132 msgstr ""
10133
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}."
10137 msgstr ""
10138
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:"
10142 msgstr ""
10143
10144 #. type: lisp
10145 #: guix-git/doc/guix.texi:4598
10146 #, no-wrap
10147 msgid ""
10148 "(use-modules (guix inferior) (guix channels)\n"
10149 " (srfi srfi-1)) ;for 'first'\n"
10150 "\n"
10151 msgstr ""
10152
10153 #. type: lisp
10154 #: guix-git/doc/guix.texi:4607
10155 #, no-wrap
10156 msgid ""
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"
10161 " (name 'guix)\n"
10162 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10163 " (commit\n"
10164 " \"65956ad3526ba09e1f7a40722c96c6ef7c0936fe\"))))\n"
10165 "\n"
10166 msgstr ""
10167
10168 #. type: lisp
10169 #: guix-git/doc/guix.texi:4611
10170 #, no-wrap
10171 msgid ""
10172 "(define inferior\n"
10173 " ;; An inferior representing the above revision.\n"
10174 " (inferior-for-channels channels))\n"
10175 "\n"
10176 msgstr ""
10177
10178 #. type: lisp
10179 #: guix-git/doc/guix.texi:4617
10180 #, no-wrap
10181 msgid ""
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"
10187 msgstr ""
10188
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."
10192 msgstr ""
10193
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:"
10197 msgstr ""
10198
10199 #. type: deffn
10200 #: guix-git/doc/guix.texi:4626
10201 #, no-wrap
10202 msgid "{Scheme Procedure} inferior-for-channels @var{channels} @"
10203 msgstr ""
10204
10205 #. type: deffn
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."
10208 msgstr ""
10209
10210 #. type: deffn
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."
10213 msgstr ""
10214
10215 #. type: deffn
10216 #: guix-git/doc/guix.texi:4636
10217 #, no-wrap
10218 msgid "{Scheme Procedure} open-inferior @var{directory} @"
10219 msgstr ""
10220
10221 #. type: deffn
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."
10224 msgstr ""
10225
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."
10229 msgstr ""
10230
10231 #. type: deffn
10232 #: guix-git/doc/guix.texi:4647
10233 #, no-wrap
10234 msgid "{Scheme Procedure} inferior-packages @var{inferior}"
10235 msgstr ""
10236
10237 #. type: deffn
10238 #: guix-git/doc/guix.texi:4649
10239 msgid "Return the list of packages known to @var{inferior}."
10240 msgstr ""
10241
10242 #. type: deffn
10243 #: guix-git/doc/guix.texi:4651
10244 #, no-wrap
10245 msgid "{Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @"
10246 msgstr ""
10247
10248 #. type: deffn
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}."
10251 msgstr ""
10252
10253 #. type: deffn
10254 #: guix-git/doc/guix.texi:4658
10255 #, no-wrap
10256 msgid "{Scheme Procedure} inferior-package? @var{obj}"
10257 msgstr ""
10258
10259 #. type: deffn
10260 #: guix-git/doc/guix.texi:4660
10261 msgid "Return true if @var{obj} is an inferior package."
10262 msgstr ""
10263
10264 #. type: deffn
10265 #: guix-git/doc/guix.texi:4662
10266 #, no-wrap
10267 msgid "{Scheme Procedure} inferior-package-name @var{package}"
10268 msgstr ""
10269
10270 #. type: deffnx
10271 #: guix-git/doc/guix.texi:4663
10272 #, no-wrap
10273 msgid "{Scheme Procedure} inferior-package-version @var{package}"
10274 msgstr ""
10275
10276 #. type: deffnx
10277 #: guix-git/doc/guix.texi:4664
10278 #, no-wrap
10279 msgid "{Scheme Procedure} inferior-package-synopsis @var{package}"
10280 msgstr ""
10281
10282 #. type: deffnx
10283 #: guix-git/doc/guix.texi:4665
10284 #, no-wrap
10285 msgid "{Scheme Procedure} inferior-package-description @var{package}"
10286 msgstr ""
10287
10288 #. type: deffnx
10289 #: guix-git/doc/guix.texi:4666
10290 #, no-wrap
10291 msgid "{Scheme Procedure} inferior-package-home-page @var{package}"
10292 msgstr ""
10293
10294 #. type: deffnx
10295 #: guix-git/doc/guix.texi:4667
10296 #, no-wrap
10297 msgid "{Scheme Procedure} inferior-package-location @var{package}"
10298 msgstr ""
10299
10300 #. type: deffnx
10301 #: guix-git/doc/guix.texi:4668
10302 #, no-wrap
10303 msgid "{Scheme Procedure} inferior-package-inputs @var{package}"
10304 msgstr ""
10305
10306 #. type: deffnx
10307 #: guix-git/doc/guix.texi:4669
10308 #, no-wrap
10309 msgid "{Scheme Procedure} inferior-package-native-inputs @var{package}"
10310 msgstr ""
10311
10312 #. type: deffnx
10313 #: guix-git/doc/guix.texi:4670
10314 #, no-wrap
10315 msgid "{Scheme Procedure} inferior-package-propagated-inputs @var{package}"
10316 msgstr ""
10317
10318 #. type: deffnx
10319 #: guix-git/doc/guix.texi:4671
10320 #, no-wrap
10321 msgid "{Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package}"
10322 msgstr ""
10323
10324 #. type: deffnx
10325 #: guix-git/doc/guix.texi:4672
10326 #, no-wrap
10327 msgid "{Scheme Procedure} inferior-package-native-search-paths @var{package}"
10328 msgstr ""
10329
10330 #. type: deffnx
10331 #: guix-git/doc/guix.texi:4673
10332 #, no-wrap
10333 msgid "{Scheme Procedure} inferior-package-transitive-native-search-paths @var{package}"
10334 msgstr ""
10335
10336 #. type: deffnx
10337 #: guix-git/doc/guix.texi:4674
10338 #, no-wrap
10339 msgid "{Scheme Procedure} inferior-package-search-paths @var{package}"
10340 msgstr ""
10341
10342 #. type: deffn
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."
10345 msgstr ""
10346
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."
10350 msgstr ""
10351
10352 #. type: section
10353 #: guix-git/doc/guix.texi:4691
10354 #, no-wrap
10355 msgid "Invoking @command{guix describe}"
10356 msgstr ""
10357
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."
10361 msgstr ""
10362
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}):"
10366 msgstr ""
10367
10368 #. type: example
10369 #: guix-git/doc/guix.texi:4714
10370 #, no-wrap
10371 msgid ""
10372 "$ guix describe\n"
10373 "Generation 10\tSep 03 2018 17:32:44\t(current)\n"
10374 " guix e0fa68c\n"
10375 " repository URL: https://git.savannah.gnu.org/git/guix.git\n"
10376 " branch: master\n"
10377 " commit: e0fa68c7718fffd33d81af415279d6ddb518f727\n"
10378 msgstr ""
10379
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."
10383 msgstr ""
10384
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:"
10388 msgstr ""
10389
10390 #. type: example
10391 #: guix-git/doc/guix.texi:4739
10392 #, no-wrap
10393 msgid ""
10394 "$ guix describe -f channels\n"
10395 "(list (channel\n"
10396 " (name 'guix)\n"
10397 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10398 " (commit\n"
10399 " \"e0fa68c7718fffd33d81af415279d6ddb518f727\")\n"
10400 " (introduction\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"
10405 msgstr ""
10406
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!"
10410 msgstr ""
10411
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:"
10415 msgstr ""
10416
10417 #. type: item
10418 #: guix-git/doc/guix.texi:4753 guix-git/doc/guix.texi:5990
10419 #: guix-git/doc/guix.texi:13269
10420 #, no-wrap
10421 msgid "--format=@var{format}"
10422 msgstr ""
10423
10424 #. type: itemx
10425 #: guix-git/doc/guix.texi:4754 guix-git/doc/guix.texi:5991
10426 #: guix-git/doc/guix.texi:13270
10427 #, no-wrap
10428 msgid "-f @var{format}"
10429 msgstr ""
10430
10431 #. type: table
10432 #: guix-git/doc/guix.texi:4756 guix-git/doc/guix.texi:13272
10433 msgid "Produce output in the specified @var{format}, one of:"
10434 msgstr ""
10435
10436 #. type: item
10437 #: guix-git/doc/guix.texi:4758
10438 #, no-wrap
10439 msgid "human"
10440 msgstr ""
10441
10442 #. type: table
10443 #: guix-git/doc/guix.texi:4760
10444 msgid "produce human-readable output;"
10445 msgstr ""
10446
10447 #. type: cindex
10448 #: guix-git/doc/guix.texi:4760 guix-git/doc/guix.texi:4978
10449 #, no-wrap
10450 msgid "channels"
10451 msgstr ""
10452
10453 #. type: table
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});"
10456 msgstr ""
10457
10458 #. type: item
10459 #: guix-git/doc/guix.texi:4764
10460 #, no-wrap
10461 msgid "channels-sans-intro"
10462 msgstr ""
10463
10464 #. type: table
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;"
10467 msgstr ""
10468
10469 #. type: item
10470 #: guix-git/doc/guix.texi:4770 guix-git/doc/guix.texi:11348
10471 #, no-wrap
10472 msgid "json"
10473 msgstr ""
10474
10475 #. type: cindex
10476 #: guix-git/doc/guix.texi:4771
10477 #, no-wrap
10478 msgid "JSON"
10479 msgstr ""
10480
10481 #. type: table
10482 #: guix-git/doc/guix.texi:4773
10483 msgid "produce a list of channel specifications in JSON format;"
10484 msgstr ""
10485
10486 #. type: item
10487 #: guix-git/doc/guix.texi:4773 guix-git/doc/guix.texi:13274
10488 #, no-wrap
10489 msgid "recutils"
10490 msgstr ""
10491
10492 #. type: table
10493 #: guix-git/doc/guix.texi:4775
10494 msgid "produce a list of channel specifications in Recutils format."
10495 msgstr ""
10496
10497 #. type: item
10498 #: guix-git/doc/guix.texi:4777
10499 #, no-wrap
10500 msgid "--list-formats"
10501 msgstr ""
10502
10503 #. type: table
10504 #: guix-git/doc/guix.texi:4779
10505 msgid "Display available formats for @option{--format} option."
10506 msgstr ""
10507
10508 #. type: table
10509 #: guix-git/doc/guix.texi:4783
10510 msgid "Display information about @var{profile}."
10511 msgstr ""
10512
10513 #. type: section
10514 #: guix-git/doc/guix.texi:4786
10515 #, no-wrap
10516 msgid "Invoking @command{guix archive}"
10517 msgstr ""
10518
10519 #. type: command{#1}
10520 #: guix-git/doc/guix.texi:4788
10521 #, no-wrap
10522 msgid "guix archive"
10523 msgstr ""
10524
10525 #. type: cindex
10526 #: guix-git/doc/guix.texi:4789
10527 #, no-wrap
10528 msgid "archive"
10529 msgstr "archív"
10530
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."
10534 msgstr ""
10535
10536 #. type: quotation
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}."
10539 msgstr ""
10540
10541 #. type: cindex
10542 #: guix-git/doc/guix.texi:4801
10543 #, no-wrap
10544 msgid "exporting store items"
10545 msgstr ""
10546
10547 #. type: Plain text
10548 #: guix-git/doc/guix.texi:4803
10549 msgid "To export store files as an archive to standard output, run:"
10550 msgstr ""
10551
10552 #. type: example
10553 #: guix-git/doc/guix.texi:4806
10554 #, no-wrap
10555 msgid "guix archive --export @var{options} @var{specifications}...\n"
10556 msgstr ""
10557
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}:"
10561 msgstr ""
10562
10563 #. type: example
10564 #: guix-git/doc/guix.texi:4816
10565 #, no-wrap
10566 msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n"
10567 msgstr ""
10568
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})."
10572 msgstr ""
10573
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:"
10577 msgstr ""
10578
10579 #. type: example
10580 #: guix-git/doc/guix.texi:4827
10581 #, no-wrap
10582 msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n"
10583 msgstr ""
10584
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:"
10588 msgstr ""
10589
10590 #. type: example
10591 #: guix-git/doc/guix.texi:4836
10592 #, no-wrap
10593 msgid ""
10594 "guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n"
10595 " ssh the-machine guix archive --import\n"
10596 msgstr ""
10597
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})."
10601 msgstr ""
10602
10603 #. type: cindex
10604 #: guix-git/doc/guix.texi:4847
10605 #, no-wrap
10606 msgid "nar, archive format"
10607 msgstr ""
10608
10609 #. type: cindex
10610 #: guix-git/doc/guix.texi:4848
10611 #, no-wrap
10612 msgid "normalized archive (nar)"
10613 msgstr ""
10614
10615 #. type: cindex
10616 #: guix-git/doc/guix.texi:4849
10617 #, no-wrap
10618 msgid "nar bundle, archive format"
10619 msgstr ""
10620
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}."
10624 msgstr ""
10625
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."
10629 msgstr ""
10630
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."
10634 msgstr ""
10635
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."
10639 msgstr ""
10640
10641 #. type: Plain text
10642 #: guix-git/doc/guix.texi:4876
10643 msgid "The main options are:"
10644 msgstr ""
10645
10646 #. type: item
10647 #: guix-git/doc/guix.texi:4878
10648 #, no-wrap
10649 msgid "--export"
10650 msgstr ""
10651
10652 #. type: table
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."
10655 msgstr ""
10656
10657 #. type: table
10658 #: guix-git/doc/guix.texi:4884
10659 msgid "Dependencies are @emph{not} included in the output, unless @option{--recursive} is passed."
10660 msgstr ""
10661
10662 #. type: itemx
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
10668 #, no-wrap
10669 msgid "-r"
10670 msgstr ""
10671
10672 #. type: item
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
10679 #, no-wrap
10680 msgid "--recursive"
10681 msgstr ""
10682
10683 #. type: table
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."
10686 msgstr ""
10687
10688 #. type: item
10689 #: guix-git/doc/guix.texi:4892
10690 #, no-wrap
10691 msgid "--import"
10692 msgstr ""
10693
10694 #. type: table
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)."
10697 msgstr ""
10698
10699 #. type: item
10700 #: guix-git/doc/guix.texi:4898
10701 #, no-wrap
10702 msgid "--missing"
10703 msgstr ""
10704
10705 #. type: table
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."
10708 msgstr ""
10709
10710 #. type: item
10711 #: guix-git/doc/guix.texi:4903
10712 #, no-wrap
10713 msgid "--generate-key[=@var{parameters}]"
10714 msgstr ""
10715
10716 #. type: cindex
10717 #: guix-git/doc/guix.texi:4904
10718 #, no-wrap
10719 msgid "signing, archives"
10720 msgstr ""
10721
10722 #. type: table
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."
10725 msgstr ""
10726
10727 #. type: table
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})."
10730 msgstr ""
10731
10732 #. type: item
10733 #: guix-git/doc/guix.texi:4922
10734 #, no-wrap
10735 msgid "--authorize"
10736 msgstr ""
10737
10738 #. type: cindex
10739 #: guix-git/doc/guix.texi:4923
10740 #, no-wrap
10741 msgid "authorizing, archives"
10742 msgstr ""
10743
10744 #. type: table
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."
10747 msgstr ""
10748
10749 #. type: table
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)}."
10752 msgstr ""
10753
10754 #. type: item
10755 #: guix-git/doc/guix.texi:4935
10756 #, no-wrap
10757 msgid "--extract=@var{directory}"
10758 msgstr ""
10759
10760 #. type: itemx
10761 #: guix-git/doc/guix.texi:4936
10762 #, no-wrap
10763 msgid "-x @var{directory}"
10764 msgstr ""
10765
10766 #. type: table
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."
10769 msgstr ""
10770
10771 #. type: table
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}:"
10774 msgstr ""
10775
10776 #. type: example
10777 #: guix-git/doc/guix.texi:4948
10778 #, no-wrap
10779 msgid ""
10780 "$ wget -O - \\\n"
10781 " https://@value{SUBSTITUTE-SERVER}/nar/gzip/@dots{}-emacs-24.5 \\\n"
10782 " | gunzip | guix archive -x /tmp/emacs\n"
10783 msgstr ""
10784
10785 #. type: table
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."
10788 msgstr ""
10789
10790 #. type: table
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})."
10793 msgstr ""
10794
10795 #. type: item
10796 #: guix-git/doc/guix.texi:4960
10797 #, no-wrap
10798 msgid "--list"
10799 msgstr ""
10800
10801 #. type: itemx
10802 #: guix-git/doc/guix.texi:4961 guix-git/doc/guix.texi:11410
10803 #: guix-git/doc/guix.texi:11457
10804 #, no-wrap
10805 msgid "-t"
10806 msgstr ""
10807
10808 #. type: table
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:"
10811 msgstr ""
10812
10813 #. type: example
10814 #: guix-git/doc/guix.texi:4970
10815 #, no-wrap
10816 msgid ""
10817 "$ wget -O - \\\n"
10818 " https://@value{SUBSTITUTE-SERVER}/nar/lzip/@dots{}-emacs-26.3 \\\n"
10819 " | lzip -d | guix archive -t\n"
10820 msgstr ""
10821
10822 #. type: cindex
10823 #: guix-git/doc/guix.texi:4981
10824 #, no-wrap
10825 msgid "@command{guix pull}, configuration file"
10826 msgstr ""
10827
10828 #. type: cindex
10829 #: guix-git/doc/guix.texi:4982
10830 #, no-wrap
10831 msgid "configuration of @command{guix pull}"
10832 msgstr ""
10833
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."
10837 msgstr ""
10838
10839 #. type: cindex
10840 #: guix-git/doc/guix.texi:5011
10841 #, no-wrap
10842 msgid "extending the package collection (channels)"
10843 msgstr ""
10844
10845 #. type: cindex
10846 #: guix-git/doc/guix.texi:5012
10847 #, no-wrap
10848 msgid "variant packages (channels)"
10849 msgstr ""
10850
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):"
10854 msgstr ""
10855
10856 #. type: vindex
10857 #: guix-git/doc/guix.texi:5017
10858 #, no-wrap
10859 msgid "%default-channels"
10860 msgstr ""
10861
10862 #. type: lisp
10863 #: guix-git/doc/guix.texi:5024
10864 #, no-wrap
10865 msgid ""
10866 ";; Add variant packages to those Guix provides.\n"
10867 "(cons (channel\n"
10868 " (name 'variant-packages)\n"
10869 " (url \"https://example.org/variant-packages.git\"))\n"
10870 " %default-channels)\n"
10871 msgstr ""
10872
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:"
10876 msgstr ""
10877
10878 #. type: example
10879 #: guix-git/doc/guix.texi:5049
10880 #, no-wrap
10881 msgid ""
10882 "$ guix pull --list-generations\n"
10883 "@dots{}\n"
10884 "Generation 19\tAug 27 2018 16:20:48\n"
10885 " guix d894ab8\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"
10895 msgstr ""
10896
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."
10900 msgstr ""
10901
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:"
10905 msgstr ""
10906
10907 #. type: lisp
10908 #: guix-git/doc/guix.texi:5073
10909 #, no-wrap
10910 msgid ""
10911 ";; Tell 'guix pull' to use another repo.\n"
10912 "(list (channel\n"
10913 " (name 'guix)\n"
10914 " (url \"https://example.org/another-guix.git\")\n"
10915 " (branch \"super-hacks\")))\n"
10916 msgstr ""
10917
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})."
10921 msgstr ""
10922
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:"
10926 msgstr ""
10927
10928 #. type: lisp
10929 #: guix-git/doc/guix.texi:5101
10930 #, no-wrap
10931 msgid ""
10932 ";; Deploy specific commits of my channels of interest.\n"
10933 "(list (channel\n"
10934 " (name 'guix)\n"
10935 " (url \"https://git.savannah.gnu.org/git/guix.git\")\n"
10936 " (commit \"6298c3ffd9654d3231a6f25390b056483e8f407c\"))\n"
10937 " (channel\n"
10938 " (name 'variant-packages)\n"
10939 " (url \"https://example.org/variant-packages.git\")\n"
10940 " (commit \"dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb\")))\n"
10941 msgstr ""
10942
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})."
10946 msgstr ""
10947
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."
10951 msgstr ""
10952
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."
10956 msgstr ""
10957
10958 #. type: anchor{#1}
10959 #: guix-git/doc/guix.texi:5125
10960 msgid "channel-authentication"
10961 msgstr ""
10962
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."
10966 msgstr ""
10967
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:"
10971 msgstr ""
10972
10973 #. type: lisp
10974 #: guix-git/doc/guix.texi:5146
10975 #, no-wrap
10976 msgid ""
10977 "(channel\n"
10978 " (name 'some-channel)\n"
10979 " (url \"https://example.org/some-channel.git\")\n"
10980 " (introduction\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"
10985 msgstr ""
10986
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{}}."
10990 msgstr ""
10991
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."
10995 msgstr ""
10996
10997 #. type: Plain text
10998 #: guix-git/doc/guix.texi:5160
10999 msgid "If you're curious about the authentication mechanics, read on!"
11000 msgstr ""
11001
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}."
11005 msgstr ""
11006
11007 #. type: lisp
11008 #: guix-git/doc/guix.texi:5174
11009 #, no-wrap
11010 msgid ""
11011 "(use-modules (guix ci))\n"
11012 "\n"
11013 msgstr ""
11014
11015 #. type: lisp
11016 #: guix-git/doc/guix.texi:5178
11017 #, no-wrap
11018 msgid ""
11019 "(list (channel-with-substitutes-available\n"
11020 " %default-guix-channel\n"
11021 " \"https://ci.guix.gnu.org\"))\n"
11022 msgstr ""
11023
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."
11027 msgstr ""
11028
11029 #. type: cindex
11030 #: guix-git/doc/guix.texi:5189
11031 #, no-wrap
11032 msgid "personal packages (channels)"
11033 msgstr ""
11034
11035 #. type: cindex
11036 #: guix-git/doc/guix.texi:5190
11037 #, no-wrap
11038 msgid "channels, for personal packages"
11039 msgstr ""
11040
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?"
11044 msgstr ""
11045
11046 #. type: quotation
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
11049 #, no-wrap
11050 msgid "Warning"
11051 msgstr ""
11052
11053 #. type: quotation
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:"
11056 msgstr ""
11057
11058 #. type: itemize
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."
11061 msgstr ""
11062
11063 #. type: itemize
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."
11066 msgstr ""
11067
11068 #. type: itemize
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."
11071 msgstr ""
11072
11073 #. type: quotation
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."
11076 msgstr ""
11077
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})."
11081 msgstr ""
11082
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."
11086 msgstr ""
11087
11088 #. type: cindex
11089 #: guix-git/doc/guix.texi:5256
11090 #, no-wrap
11091 msgid "subdirectory, channels"
11092 msgstr ""
11093
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:"
11097 msgstr ""
11098
11099 #. type: lisp
11100 #: guix-git/doc/guix.texi:5265
11101 #, no-wrap
11102 msgid ""
11103 "(channel\n"
11104 " (version 0)\n"
11105 " (directory \"guix\"))\n"
11106 msgstr ""
11107
11108 #. type: cindex
11109 #: guix-git/doc/guix.texi:5270
11110 #, no-wrap
11111 msgid "dependencies, channels"
11112 msgstr ""
11113
11114 #. type: cindex
11115 #: guix-git/doc/guix.texi:5271
11116 #, no-wrap
11117 msgid "meta-data, channels"
11118 msgstr ""
11119
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."
11123 msgstr ""
11124
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:"
11128 msgstr ""
11129
11130 #. type: lisp
11131 #: guix-git/doc/guix.texi:5286
11132 #, no-wrap
11133 msgid ""
11134 "(channel\n"
11135 " (version 0)\n"
11136 " (dependencies\n"
11137 " (channel\n"
11138 " (name some-collection)\n"
11139 " (url \"https://example.org/first-collection.git\")\n"
11140 "\n"
11141 msgstr ""
11142
11143 #. type: lisp
11144 #: guix-git/doc/guix.texi:5298
11145 #, no-wrap
11146 msgid ""
11147 " ;; The 'introduction' bit below is optional: you would\n"
11148 " ;; provide it for dependencies that can be authenticated.\n"
11149 " (introduction\n"
11150 " (channel-introduction\n"
11151 " (version 0)\n"
11152 " (commit \"a8883b58dc82e167c96506cf05095f37c2c2c6cd\")\n"
11153 " (signer \"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5\"))))\n"
11154 " (channel\n"
11155 " (name some-other-collection)\n"
11156 " (url \"https://example.org/second-collection.git\")\n"
11157 " (branch \"testing\"))))\n"
11158 msgstr ""
11159
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."
11163 msgstr ""
11164
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."
11168 msgstr ""
11169
11170 #. type: cindex
11171 #: guix-git/doc/guix.texi:5312
11172 #, no-wrap
11173 msgid "channel authorizations"
11174 msgstr ""
11175
11176 #. type: anchor{#1}
11177 #: guix-git/doc/guix.texi:5326
11178 msgid "channel-authorizations"
11179 msgstr ""
11180
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:"
11184 msgstr ""
11185
11186 #. type: lisp
11187 #: guix-git/doc/guix.texi:5329
11188 #, no-wrap
11189 msgid ""
11190 ";; Example '.guix-authorizations' file.\n"
11191 "\n"
11192 msgstr ""
11193
11194 #. type: lisp
11195 #: guix-git/doc/guix.texi:5332
11196 #, no-wrap
11197 msgid ""
11198 "(authorizations\n"
11199 " (version 0) ;current file format version\n"
11200 "\n"
11201 msgstr ""
11202
11203 #. type: lisp
11204 #: guix-git/doc/guix.texi:5339
11205 #, no-wrap
11206 msgid ""
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"
11213 msgstr ""
11214
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."
11218 msgstr ""
11219
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?"
11223 msgstr ""
11224
11225 #. type: cindex
11226 #: guix-git/doc/guix.texi:5349
11227 #, no-wrap
11228 msgid "channel introduction"
11229 msgstr ""
11230
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."
11234 msgstr ""
11235
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:"
11239 msgstr ""
11240
11241 #. type: lisp
11242 #: guix-git/doc/guix.texi:5368
11243 #, no-wrap
11244 msgid ""
11245 "(channel\n"
11246 " (version 0)\n"
11247 " (keyring-reference \"my-keyring-branch\"))\n"
11248 msgstr ""
11249
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:"
11253 msgstr ""
11254
11255 #. type: enumerate
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})."
11258 msgstr ""
11259
11260 #. type: enumerate
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.)"
11263 msgstr ""
11264
11265 #. type: enumerate
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."
11268 msgstr ""
11269
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:"
11273 msgstr ""
11274
11275 #. type: example
11276 #: guix-git/doc/guix.texi:5397
11277 #, no-wrap
11278 msgid "guix git authenticate @var{commit} @var{signer}\n"
11279 msgstr ""
11280
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."
11284 msgstr ""
11285
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."
11289 msgstr ""
11290
11291 #. type: cindex
11292 #: guix-git/doc/guix.texi:5413
11293 #, no-wrap
11294 msgid "primary URL, channels"
11295 msgstr ""
11296
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:"
11300 msgstr ""
11301
11302 #. type: lisp
11303 #: guix-git/doc/guix.texi:5421
11304 #, no-wrap
11305 msgid ""
11306 "(channel\n"
11307 " (version 0)\n"
11308 " (url \"https://example.org/guix.git\"))\n"
11309 msgstr ""
11310
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."
11314 msgstr ""
11315
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."
11319 msgstr ""
11320
11321 #. type: cindex
11322 #: guix-git/doc/guix.texi:5436
11323 #, no-wrap
11324 msgid "news, for channels"
11325 msgstr ""
11326
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."
11330 msgstr ""
11331
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."
11335 msgstr ""
11336
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:"
11340 msgstr ""
11341
11342 #. type: lisp
11343 #: guix-git/doc/guix.texi:5453
11344 #, no-wrap
11345 msgid ""
11346 "(channel\n"
11347 " (version 0)\n"
11348 " (news-file \"etc/news.txt\"))\n"
11349 msgstr ""
11350
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:"
11354 msgstr ""
11355
11356 #. type: lisp
11357 #: guix-git/doc/guix.texi:5470
11358 #, no-wrap
11359 msgid ""
11360 "(channel-news\n"
11361 " (version 0)\n"
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"
11371 msgstr ""
11372
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."
11376 msgstr ""
11377
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."
11381 msgstr ""
11382
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."
11386 msgstr ""
11387
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:"
11391 msgstr ""
11392
11393 #. type: example
11394 #: guix-git/doc/guix.texi:5497
11395 #, no-wrap
11396 msgid "xgettext -o news.po -l scheme -ken etc/news.txt\n"
11397 msgstr ""
11398
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."
11402 msgstr ""
11403
11404 #. type: cindex
11405 #: guix-git/doc/guix.texi:5506
11406 #, no-wrap
11407 msgid "software development"
11408 msgstr ""
11409
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."
11413 msgstr ""
11414
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."
11418 msgstr ""
11419
11420 #. type: section
11421 #: guix-git/doc/guix.texi:5525
11422 #, no-wrap
11423 msgid "Invoking @command{guix environment}"
11424 msgstr ""
11425
11426 #. type: cindex
11427 #: guix-git/doc/guix.texi:5527
11428 #, no-wrap
11429 msgid "reproducible build environments"
11430 msgstr ""
11431
11432 #. type: cindex
11433 #: guix-git/doc/guix.texi:5528
11434 #, no-wrap
11435 msgid "development environments"
11436 msgstr ""
11437
11438 #. type: command{#1}
11439 #: guix-git/doc/guix.texi:5529
11440 #, no-wrap
11441 msgid "guix environment"
11442 msgstr ""
11443
11444 #. type: cindex
11445 #: guix-git/doc/guix.texi:5530
11446 #, no-wrap
11447 msgid "environment, package build environment"
11448 msgstr ""
11449
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."
11453 msgstr ""
11454
11455 #. type: example
11456 #: guix-git/doc/guix.texi:5541
11457 #, no-wrap
11458 msgid "guix environment @var{options} @var{package}@dots{}\n"
11459 msgstr ""
11460
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:"
11464 msgstr ""
11465
11466 #. type: example
11467 #: guix-git/doc/guix.texi:5548
11468 #, no-wrap
11469 msgid "guix environment guile\n"
11470 msgstr ""
11471
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.}."
11475 msgstr ""
11476
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."
11480 msgstr ""
11481
11482 #. type: vindex
11483 #: guix-git/doc/guix.texi:5572
11484 #, no-wrap
11485 msgid "GUIX_ENVIRONMENT"
11486 msgstr ""
11487
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}):"
11491 msgstr ""
11492
11493 #. type: example
11494 #: guix-git/doc/guix.texi:5584
11495 #, no-wrap
11496 msgid ""
11497 "if [ -n \"$GUIX_ENVIRONMENT\" ]\n"
11498 "then\n"
11499 " export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n"
11500 "fi\n"
11501 msgstr ""
11502
11503 #. type: Plain text
11504 #: guix-git/doc/guix.texi:5588
11505 msgid "...@: or to browse the profile:"
11506 msgstr ""
11507
11508 #. type: example
11509 #: guix-git/doc/guix.texi:5591
11510 #, no-wrap
11511 msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n"
11512 msgstr ""
11513
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:"
11517 msgstr ""
11518
11519 #. type: example
11520 #: guix-git/doc/guix.texi:5600
11521 #, no-wrap
11522 msgid "guix environment guile emacs\n"
11523 msgstr ""
11524
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:"
11528 msgstr ""
11529
11530 #. type: example
11531 #: guix-git/doc/guix.texi:5608
11532 #, no-wrap
11533 msgid "guix environment guile -- make -j4\n"
11534 msgstr ""
11535
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:"
11539 msgstr ""
11540
11541 #. type: example
11542 #: guix-git/doc/guix.texi:5617
11543 #, no-wrap
11544 msgid "guix environment --ad-hoc python2-numpy python-2.7 -- python\n"
11545 msgstr ""
11546
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:"
11550 msgstr ""
11551
11552 #. type: example
11553 #: guix-git/doc/guix.texi:5631
11554 #, no-wrap
11555 msgid "guix environment --pure guix --ad-hoc git strace\n"
11556 msgstr ""
11557
11558 #. type: item
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
11561 #, no-wrap
11562 msgid "container"
11563 msgstr ""
11564
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:"
11568 msgstr ""
11569
11570 #. type: example
11571 #: guix-git/doc/guix.texi:5644
11572 #, no-wrap
11573 msgid "guix environment --ad-hoc --container guile -- guile\n"
11574 msgstr ""
11575
11576 #. type: quotation
11577 #: guix-git/doc/guix.texi:5648
11578 msgid "The @option{--container} option requires Linux-libre 3.19 or newer."
11579 msgstr ""
11580
11581 #. type: cindex
11582 #: guix-git/doc/guix.texi:5650
11583 #, no-wrap
11584 msgid "certificates"
11585 msgstr ""
11586
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."
11590 msgstr ""
11591
11592 #. type: example
11593 #: guix-git/doc/guix.texi:5664
11594 #, no-wrap
11595 msgid ""
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"
11601 msgstr ""
11602
11603 #. type: Plain text
11604 #: guix-git/doc/guix.texi:5667
11605 msgid "The available options are summarized below."
11606 msgstr ""
11607
11608 #. type: item
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
11611 #, no-wrap
11612 msgid "--root=@var{file}"
11613 msgstr ""
11614
11615 #. type: itemx
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
11618 #, no-wrap
11619 msgid "-r @var{file}"
11620 msgstr ""
11621
11622 #. type: cindex
11623 #: guix-git/doc/guix.texi:5671
11624 #, no-wrap
11625 msgid "persistent environment"
11626 msgstr ""
11627
11628 #. type: cindex
11629 #: guix-git/doc/guix.texi:5672
11630 #, no-wrap
11631 msgid "garbage collector root, for environments"
11632 msgstr ""
11633
11634 #. type: table
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."
11637 msgstr ""
11638
11639 #. type: table
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''."
11642 msgstr ""
11643
11644 #. type: table
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."
11647 msgstr ""
11648
11649 #. type: item
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
11653 #, no-wrap
11654 msgid "--expression=@var{expr}"
11655 msgstr ""
11656
11657 #. type: itemx
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
11661 #, no-wrap
11662 msgid "-e @var{expr}"
11663 msgstr ""
11664
11665 #. type: table
11666 #: guix-git/doc/guix.texi:5689
11667 msgid "Create an environment for the package or list of packages that @var{expr} evaluates to."
11668 msgstr ""
11669
11670 #. type: table
11671 #: guix-git/doc/guix.texi:5691
11672 msgid "For example, running:"
11673 msgstr ""
11674
11675 #. type: example
11676 #: guix-git/doc/guix.texi:5694
11677 #, no-wrap
11678 msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n"
11679 msgstr ""
11680
11681 #. type: table
11682 #: guix-git/doc/guix.texi:5698
11683 msgid "starts a shell with the environment for this specific variant of the PETSc package."
11684 msgstr ""
11685
11686 #. type: table
11687 #: guix-git/doc/guix.texi:5700
11688 msgid "Running:"
11689 msgstr ""
11690
11691 #. type: example
11692 #: guix-git/doc/guix.texi:5703
11693 #, no-wrap
11694 msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n"
11695 msgstr ""
11696
11697 #. type: table
11698 #: guix-git/doc/guix.texi:5706
11699 msgid "starts a shell with all the base system packages available."
11700 msgstr ""
11701
11702 #. type: table
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:"
11705 msgstr ""
11706
11707 #. type: example
11708 #: guix-git/doc/guix.texi:5712
11709 #, no-wrap
11710 msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n"
11711 msgstr ""
11712
11713 #. type: item
11714 #: guix-git/doc/guix.texi:5714
11715 #, no-wrap
11716 msgid "--load=@var{file}"
11717 msgstr ""
11718
11719 #. type: itemx
11720 #: guix-git/doc/guix.texi:5715
11721 #, no-wrap
11722 msgid "-l @var{file}"
11723 msgstr ""
11724
11725 #. type: table
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."
11728 msgstr ""
11729
11730 #. type: lisp
11731 #: guix-git/doc/guix.texi:5724
11732 #, no-wrap
11733 msgid "@verbatiminclude environment-gdb.scm\n"
11734 msgstr ""
11735
11736 #. type: table
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."
11739 msgstr ""
11740
11741 #. type: table
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."
11744 msgstr ""
11745
11746 #. type: item
11747 #: guix-git/doc/guix.texi:5736
11748 #, no-wrap
11749 msgid "--ad-hoc"
11750 msgstr ""
11751
11752 #. type: table
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."
11755 msgstr ""
11756
11757 #. type: table
11758 #: guix-git/doc/guix.texi:5743
11759 msgid "For instance, the command:"
11760 msgstr ""
11761
11762 #. type: example
11763 #: guix-git/doc/guix.texi:5746
11764 #, no-wrap
11765 msgid "guix environment --ad-hoc guile guile-sdl -- guile\n"
11766 msgstr ""
11767
11768 #. type: table
11769 #: guix-git/doc/guix.texi:5750
11770 msgid "runs @command{guile} in an environment where Guile and Guile-SDL are available."
11771 msgstr ""
11772
11773 #. type: table
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})."
11776 msgstr ""
11777
11778 #. type: table
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."
11781 msgstr ""
11782
11783 #. type: item
11784 #: guix-git/doc/guix.texi:5762
11785 #, no-wrap
11786 msgid "--pure"
11787 msgstr ""
11788
11789 #. type: table
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."
11792 msgstr ""
11793
11794 #. type: item
11795 #: guix-git/doc/guix.texi:5767
11796 #, no-wrap
11797 msgid "--preserve=@var{regexp}"
11798 msgstr ""
11799
11800 #. type: itemx
11801 #: guix-git/doc/guix.texi:5768
11802 #, no-wrap
11803 msgid "-E @var{regexp}"
11804 msgstr ""
11805
11806 #. type: table
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."
11809 msgstr ""
11810
11811 #. type: example
11812 #: guix-git/doc/guix.texi:5777
11813 #, no-wrap
11814 msgid ""
11815 "guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \\\n"
11816 " -- mpirun @dots{}\n"
11817 msgstr ""
11818
11819 #. type: table
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.)."
11822 msgstr ""
11823
11824 #. type: item
11825 #: guix-git/doc/guix.texi:5784
11826 #, no-wrap
11827 msgid "--search-paths"
11828 msgstr ""
11829
11830 #. type: table
11831 #: guix-git/doc/guix.texi:5787
11832 msgid "Display the environment variable definitions that make up the environment."
11833 msgstr ""
11834
11835 #. type: table
11836 #: guix-git/doc/guix.texi:5791
11837 msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}."
11838 msgstr ""
11839
11840 #. type: item
11841 #: guix-git/doc/guix.texi:5792
11842 #, no-wrap
11843 msgid "--container"
11844 msgstr ""
11845
11846 #. type: itemx
11847 #: guix-git/doc/guix.texi:5793
11848 #, no-wrap
11849 msgid "-C"
11850 msgstr ""
11851
11852 #. type: table
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."
11855 msgstr ""
11856
11857 #. type: table
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)."
11860 msgstr ""
11861
11862 #. type: item
11863 #: guix-git/doc/guix.texi:5805 guix-git/doc/guix.texi:33160
11864 #, no-wrap
11865 msgid "--network"
11866 msgstr ""
11867
11868 #. type: table
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."
11871 msgstr ""
11872
11873 #. type: item
11874 #: guix-git/doc/guix.texi:5811
11875 #, no-wrap
11876 msgid "--link-profile"
11877 msgstr ""
11878
11879 #. type: itemx
11880 #: guix-git/doc/guix.texi:5812
11881 #, no-wrap
11882 msgid "-P"
11883 msgstr ""
11884
11885 #. type: table
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."
11888 msgstr ""
11889
11890 #. type: table
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."
11893 msgstr ""
11894
11895 #. type: item
11896 #: guix-git/doc/guix.texi:5827 guix-git/doc/guix.texi:12612
11897 #, no-wrap
11898 msgid "--user=@var{user}"
11899 msgstr ""
11900
11901 #. type: itemx
11902 #: guix-git/doc/guix.texi:5828 guix-git/doc/guix.texi:12613
11903 #, no-wrap
11904 msgid "-u @var{user}"
11905 msgstr ""
11906
11907 #. type: table
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."
11910 msgstr ""
11911
11912 #. type: table
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."
11915 msgstr ""
11916
11917 #. type: example
11918 #: guix-git/doc/guix.texi:5847
11919 #, no-wrap
11920 msgid ""
11921 "# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n"
11922 "cd $HOME/wd\n"
11923 "guix environment --container --user=foo \\\n"
11924 " --expose=$HOME/test \\\n"
11925 " --expose=/tmp/target=$HOME/target\n"
11926 msgstr ""
11927
11928 #. type: table
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."
11931 msgstr ""
11932
11933 #. type: item
11934 #: guix-git/doc/guix.texi:5853
11935 #, no-wrap
11936 msgid "--no-cwd"
11937 msgstr ""
11938
11939 #. type: table
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}."
11942 msgstr ""
11943
11944 #. type: item
11945 #: guix-git/doc/guix.texi:5861
11946 #, no-wrap
11947 msgid "--expose=@var{source}[=@var{target}]"
11948 msgstr ""
11949
11950 #. type: itemx
11951 #: guix-git/doc/guix.texi:5862
11952 #, no-wrap
11953 msgid "--share=@var{source}[=@var{target}]"
11954 msgstr ""
11955
11956 #. type: table
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."
11959 msgstr ""
11960
11961 #. type: table
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:"
11964 msgstr ""
11965
11966 #. type: example
11967 #: guix-git/doc/guix.texi:5875
11968 #, no-wrap
11969 msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n"
11970 msgstr ""
11971
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})."
11975 msgstr ""
11976
11977 #. type: section
11978 #: guix-git/doc/guix.texi:5885
11979 #, no-wrap
11980 msgid "Invoking @command{guix pack}"
11981 msgstr ""
11982
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."
11986 msgstr ""
11987
11988 #. type: quotation
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}."
11991 msgstr ""
11992
11993 #. type: cindex
11994 #: guix-git/doc/guix.texi:5898
11995 #, no-wrap
11996 msgid "pack"
11997 msgstr ""
11998
11999 #. type: cindex
12000 #: guix-git/doc/guix.texi:5899
12001 #, no-wrap
12002 msgid "bundle"
12003 msgstr ""
12004
12005 #. type: cindex
12006 #: guix-git/doc/guix.texi:5900
12007 #, no-wrap
12008 msgid "application bundle"
12009 msgstr ""
12010
12011 #. type: cindex
12012 #: guix-git/doc/guix.texi:5901
12013 #, no-wrap
12014 msgid "software bundle"
12015 msgstr ""
12016
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."
12020 msgstr ""
12021
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:"
12025 msgstr ""
12026
12027 #. type: example
12028 #: guix-git/doc/guix.texi:5918
12029 #, no-wrap
12030 msgid ""
12031 "$ guix pack guile emacs geiser\n"
12032 "@dots{}\n"
12033 "/gnu/store/@dots{}-pack.tar.gz\n"
12034 msgstr ""
12035
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})."
12039 msgstr ""
12040
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:"
12044 msgstr ""
12045
12046 #. type: example
12047 #: guix-git/doc/guix.texi:5934
12048 #, no-wrap
12049 msgid "guix pack -S /opt/gnu/bin=bin guile emacs geiser\n"
12050 msgstr ""
12051
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."
12055 msgstr ""
12056
12057 #. type: cindex
12058 #: guix-git/doc/guix.texi:5939
12059 #, no-wrap
12060 msgid "relocatable binaries, with @command{guix pack}"
12061 msgstr ""
12062
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}."
12066 msgstr ""
12067
12068 #. type: cindex
12069 #: guix-git/doc/guix.texi:5948
12070 #, no-wrap
12071 msgid "Docker, build an image with guix pack"
12072 msgstr ""
12073
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:"
12077 msgstr ""
12078
12079 #. type: example
12080 #: guix-git/doc/guix.texi:5954
12081 #, no-wrap
12082 msgid "guix pack -f docker -S /bin=bin guile guile-readline\n"
12083 msgstr ""
12084
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}:"
12088 msgstr ""
12089
12090 #. type: example
12091 #: guix-git/doc/guix.texi:5963
12092 #, no-wrap
12093 msgid ""
12094 "docker load < @var{file}\n"
12095 "docker run -ti guile-guile-readline /bin/guile\n"
12096 msgstr ""
12097
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."
12101 msgstr ""
12102
12103 #. type: cindex
12104 #: guix-git/doc/guix.texi:5971
12105 #, no-wrap
12106 msgid "Singularity, build an image with guix pack"
12107 msgstr ""
12108
12109 #. type: cindex
12110 #: guix-git/doc/guix.texi:5972
12111 #, no-wrap
12112 msgid "SquashFS, build an image with guix pack"
12113 msgstr ""
12114
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:"
12118 msgstr ""
12119
12120 #. type: example
12121 #: guix-git/doc/guix.texi:5978
12122 #, no-wrap
12123 msgid "guix pack -f squashfs bash guile emacs geiser\n"
12124 msgstr ""
12125
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}."
12129 msgstr ""
12130
12131 #. type: Plain text
12132 #: guix-git/doc/guix.texi:5988
12133 msgid "Several command-line options allow you to customize your pack:"
12134 msgstr ""
12135
12136 #. type: table
12137 #: guix-git/doc/guix.texi:5993
12138 msgid "Produce a pack in the given @var{format}."
12139 msgstr ""
12140
12141 #. type: table
12142 #: guix-git/doc/guix.texi:5995
12143 msgid "The available formats are:"
12144 msgstr ""
12145
12146 #. type: item
12147 #: guix-git/doc/guix.texi:5997
12148 #, no-wrap
12149 msgid "tarball"
12150 msgstr ""
12151
12152 #. type: table
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."
12155 msgstr ""
12156
12157 #. type: item
12158 #: guix-git/doc/guix.texi:6001
12159 #, no-wrap
12160 msgid "docker"
12161 msgstr ""
12162
12163 #. type: table
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."
12166 msgstr ""
12167
12168 #. type: item
12169 #: guix-git/doc/guix.texi:6008
12170 #, no-wrap
12171 msgid "squashfs"
12172 msgstr ""
12173
12174 #. type: table
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."
12177 msgstr ""
12178
12179 #. type: quotation
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:"
12182 msgstr ""
12183
12184 #. type: example
12185 #: guix-git/doc/guix.texi:6021
12186 #, no-wrap
12187 msgid "guix pack -f squashfs bash @dots{}\n"
12188 msgstr ""
12189
12190 #. type: quotation
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."
12193 msgstr ""
12194
12195 #. type: cindex
12196 #: guix-git/doc/guix.texi:6029
12197 #, no-wrap
12198 msgid "relocatable binaries"
12199 msgstr ""
12200
12201 #. type: item
12202 #: guix-git/doc/guix.texi:6030
12203 #, no-wrap
12204 msgid "--relocatable"
12205 msgstr ""
12206
12207 #. type: table
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."
12210 msgstr ""
12211
12212 #. type: table
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."
12215 msgstr ""
12216
12217 #. type: table
12218 #: guix-git/doc/guix.texi:6044
12219 msgid "For example, if you create a pack containing Bash with:"
12220 msgstr ""
12221
12222 #. type: example
12223 #: guix-git/doc/guix.texi:6047
12224 #, no-wrap
12225 msgid "guix pack -RR -S /mybin=bin bash\n"
12226 msgstr ""
12227
12228 #. type: table
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:"
12231 msgstr ""
12232
12233 #. type: example
12234 #: guix-git/doc/guix.texi:6056
12235 #, no-wrap
12236 msgid ""
12237 "tar xf pack.tar.gz\n"
12238 "./mybin/sh\n"
12239 msgstr ""
12240
12241 #. type: table
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."
12244 msgstr ""
12245
12246 #. type: quotation
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."
12249 msgstr ""
12250
12251 #. type: quotation
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:"
12254 msgstr ""
12255
12256 #. type: item
12257 #: guix-git/doc/guix.texi:6078 guix-git/doc/guix.texi:16223
12258 #, no-wrap
12259 msgid "default"
12260 msgstr ""
12261
12262 #. type: table
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)."
12265 msgstr ""
12266
12267 #. type: item
12268 #: guix-git/doc/guix.texi:6082
12269 #, no-wrap
12270 msgid "performance"
12271 msgstr ""
12272
12273 #. type: table
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)."
12276 msgstr ""
12277
12278 #. type: item
12279 #: guix-git/doc/guix.texi:6086
12280 #, no-wrap
12281 msgid "userns"
12282 msgstr ""
12283
12284 #. type: table
12285 #: guix-git/doc/guix.texi:6089
12286 msgid "Run the program through user namespaces and abort if they are not supported."
12287 msgstr ""
12288
12289 #. type: item
12290 #: guix-git/doc/guix.texi:6090
12291 #, no-wrap
12292 msgid "proot"
12293 msgstr ""
12294
12295 #. type: table
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."
12298 msgstr ""
12299
12300 #. type: item
12301 #: guix-git/doc/guix.texi:6098
12302 #, no-wrap
12303 msgid "fakechroot"
12304 msgstr ""
12305
12306 #. type: table
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."
12309 msgstr ""
12310
12311 #. type: vindex
12312 #: guix-git/doc/guix.texi:6108
12313 #, no-wrap
12314 msgid "GUIX_EXECUTION_ENGINE"
12315 msgstr ""
12316
12317 #. type: quotation
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."
12320 msgstr ""
12321
12322 #. type: cindex
12323 #: guix-git/doc/guix.texi:6114
12324 #, no-wrap
12325 msgid "entry point, for Docker images"
12326 msgstr ""
12327
12328 #. type: item
12329 #: guix-git/doc/guix.texi:6115
12330 #, no-wrap
12331 msgid "--entry-point=@var{command}"
12332 msgstr ""
12333
12334 #. type: table
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."
12337 msgstr ""
12338
12339 #. type: table
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:"
12342 msgstr ""
12343
12344 #. type: example
12345 #: guix-git/doc/guix.texi:6127
12346 #, no-wrap
12347 msgid "guix pack -f docker --entry-point=bin/guile guile\n"
12348 msgstr ""
12349
12350 #. type: table
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}:"
12353 msgstr ""
12354
12355 #. type: example
12356 #: guix-git/doc/guix.texi:6135
12357 #, no-wrap
12358 msgid ""
12359 "docker load -i pack.tar.gz\n"
12360 "docker run @var{image-id}\n"
12361 msgstr ""
12362
12363 #. type: table
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."
12367 msgstr ""
12368
12369 #. type: table
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}})."
12372 msgstr ""
12373
12374 #. type: table
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."
12377 msgstr ""
12378
12379 #. type: table
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."
12382 msgstr ""
12383
12384 #. type: item
12385 #: guix-git/doc/guix.texi:6164 guix-git/doc/guix.texi:10827
12386 #, no-wrap
12387 msgid "--target=@var{triplet}"
12388 msgstr ""
12389
12390 #. type: cindex
12391 #: guix-git/doc/guix.texi:6165 guix-git/doc/guix.texi:6616
12392 #: guix-git/doc/guix.texi:10828
12393 #, no-wrap
12394 msgid "cross-compilation"
12395 msgstr ""
12396
12397 #. type: table
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})."
12400 msgstr ""
12401
12402 #. type: item
12403 #: guix-git/doc/guix.texi:6170
12404 #, no-wrap
12405 msgid "--compression=@var{tool}"
12406 msgstr ""
12407
12408 #. type: itemx
12409 #: guix-git/doc/guix.texi:6171
12410 #, no-wrap
12411 msgid "-C @var{tool}"
12412 msgstr ""
12413
12414 #. type: table
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."
12417 msgstr ""
12418
12419 #. type: item
12420 #: guix-git/doc/guix.texi:6176
12421 #, no-wrap
12422 msgid "--symlink=@var{spec}"
12423 msgstr ""
12424
12425 #. type: itemx
12426 #: guix-git/doc/guix.texi:6177
12427 #, no-wrap
12428 msgid "-S @var{spec}"
12429 msgstr ""
12430
12431 #. type: table
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."
12434 msgstr ""
12435
12436 #. type: table
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."
12439 msgstr ""
12440
12441 #. type: table
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."
12444 msgstr ""
12445
12446 #. type: item
12447 #: guix-git/doc/guix.texi:6188 guix-git/doc/guix.texi:33119
12448 #, no-wrap
12449 msgid "--save-provenance"
12450 msgstr ""
12451
12452 #. type: table
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})."
12455 msgstr ""
12456
12457 #. type: table
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."
12460 msgstr ""
12461
12462 #. type: table
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."
12465 msgstr ""
12466
12467 #. type: cindex
12468 #: guix-git/doc/guix.texi:6207
12469 #, no-wrap
12470 msgid "garbage collector root, for packs"
12471 msgstr ""
12472
12473 #. type: table
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."
12476 msgstr ""
12477
12478 #. type: item
12479 #: guix-git/doc/guix.texi:6211
12480 #, no-wrap
12481 msgid "--localstatedir"
12482 msgstr ""
12483
12484 #. type: itemx
12485 #: guix-git/doc/guix.texi:6212
12486 #, no-wrap
12487 msgid "--profile-name=@var{name}"
12488 msgstr ""
12489
12490 #. type: table
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}."
12493 msgstr ""
12494
12495 #. type: table
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."
12498 msgstr ""
12499
12500 #. type: table
12501 #: guix-git/doc/guix.texi:6226
12502 msgid "One use case for this is the Guix self-contained binary tarball (@pxref{Binary Installation})."
12503 msgstr ""
12504
12505 #. type: item
12506 #: guix-git/doc/guix.texi:6227 guix-git/doc/guix.texi:33113
12507 #, no-wrap
12508 msgid "--derivation"
12509 msgstr ""
12510
12511 #. type: itemx
12512 #: guix-git/doc/guix.texi:6228 guix-git/doc/guix.texi:10859
12513 #: guix-git/doc/guix.texi:33114
12514 #, no-wrap
12515 msgid "-d"
12516 msgstr ""
12517
12518 #. type: table
12519 #: guix-git/doc/guix.texi:6230
12520 msgid "Print the name of the derivation that builds the pack."
12521 msgstr ""
12522
12523 #. type: table
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."
12526 msgstr ""
12527
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})."
12531 msgstr ""
12532
12533 #. type: cindex
12534 #: guix-git/doc/guix.texi:6244
12535 #, no-wrap
12536 msgid "GCC"
12537 msgstr ""
12538
12539 #. type: cindex
12540 #: guix-git/doc/guix.texi:6245
12541 #, no-wrap
12542 msgid "ld-wrapper"
12543 msgstr ""
12544
12545 #. type: cindex
12546 #: guix-git/doc/guix.texi:6246
12547 #, no-wrap
12548 msgid "linker wrapper"
12549 msgstr ""
12550
12551 #. type: cindex
12552 #: guix-git/doc/guix.texi:6247
12553 #, no-wrap
12554 msgid "toolchain, for C development"
12555 msgstr ""
12556
12557 #. type: cindex
12558 #: guix-git/doc/guix.texi:6248
12559 #, no-wrap
12560 msgid "toolchain, for Fortran development"
12561 msgstr ""
12562
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."
12566 msgstr ""
12567
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}."
12571 msgstr ""
12572
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})."
12576 msgstr ""
12577
12578 #. type: section
12579 #: guix-git/doc/guix.texi:6268
12580 #, no-wrap
12581 msgid "Invoking @command{guix git authenticate}"
12582 msgstr ""
12583
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)."
12587 msgstr ""
12588
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."
12592 msgstr ""
12593
12594 #. type: example
12595 #: guix-git/doc/guix.texi:6286
12596 #, no-wrap
12597 msgid "guix git authenticate @var{commit} @var{signer} [@var{options}@dots{}]\n"
12598 msgstr ""
12599
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."
12603 msgstr ""
12604
12605 #. type: item
12606 #: guix-git/doc/guix.texi:6297
12607 #, no-wrap
12608 msgid "--repository=@var{directory}"
12609 msgstr ""
12610
12611 #. type: itemx
12612 #: guix-git/doc/guix.texi:6298
12613 #, no-wrap
12614 msgid "-r @var{directory}"
12615 msgstr ""
12616
12617 #. type: table
12618 #: guix-git/doc/guix.texi:6301
12619 msgid "Open the Git repository in @var{directory} instead of the current directory."
12620 msgstr ""
12621
12622 #. type: item
12623 #: guix-git/doc/guix.texi:6302
12624 #, no-wrap
12625 msgid "--keyring=@var{reference}"
12626 msgstr ""
12627
12628 #. type: itemx
12629 #: guix-git/doc/guix.texi:6303
12630 #, no-wrap
12631 msgid "-k @var{reference}"
12632 msgstr ""
12633
12634 #. type: table
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}."
12637 msgstr ""
12638
12639 #. type: item
12640 #: guix-git/doc/guix.texi:6310
12641 #, no-wrap
12642 msgid "--stats"
12643 msgstr ""
12644
12645 #. type: table
12646 #: guix-git/doc/guix.texi:6312
12647 msgid "Display commit signing statistics upon completion."
12648 msgstr ""
12649
12650 #. type: item
12651 #: guix-git/doc/guix.texi:6313
12652 #, no-wrap
12653 msgid "--cache-key=@var{key}"
12654 msgstr ""
12655
12656 #. type: table
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."
12659 msgstr ""
12660
12661 #. type: item
12662 #: guix-git/doc/guix.texi:6318
12663 #, no-wrap
12664 msgid "--historical-authorizations=@var{file}"
12665 msgstr ""
12666
12667 #. type: table
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})."
12670 msgstr ""
12671
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."
12675 msgstr ""
12676
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."
12680 msgstr ""
12681
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."
12685 msgstr ""
12686
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."
12690 msgstr ""
12691
12692 #. type: menuentry
12693 #: guix-git/doc/guix.texi:6369
12694 msgid "Programming Guix in Guile"
12695 msgstr ""
12696
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})."
12700 msgstr ""
12701
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."
12705 msgstr ""
12706
12707 #. type: cindex
12708 #: guix-git/doc/guix.texi:6394
12709 #, no-wrap
12710 msgid "package module search path"
12711 msgstr ""
12712
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:"
12716 msgstr ""
12717
12718 #. type: enumerate
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."
12721 msgstr ""
12722
12723 #. type: enumerate
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."
12726 msgstr ""
12727
12728 #. type: Plain text
12729 #: guix-git/doc/guix.texi:6419
12730 msgid "@env{GUIX_PACKAGE_PATH} works similarly to other search path variables:"
12731 msgstr ""
12732
12733 #. type: defvr
12734 #: guix-git/doc/guix.texi:6420
12735 #, no-wrap
12736 msgid "{Environment Variable} GUIX_PACKAGE_PATH"
12737 msgstr ""
12738
12739 #. type: defvr
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."
12742 msgstr ""
12743
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}."
12747 msgstr ""
12748
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:"
12752 msgstr ""
12753
12754 #. type: lisp
12755 #: guix-git/doc/guix.texi:6448
12756 #, no-wrap
12757 msgid ""
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"
12764 "\n"
12765 msgstr ""
12766
12767 #. type: lisp
12768 #: guix-git/doc/guix.texi:6467
12769 #, no-wrap
12770 msgid ""
12771 "(define-public hello\n"
12772 " (package\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"
12778 " \".tar.gz\"))\n"
12779 " (sha256\n"
12780 " (base32\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"
12789 msgstr ""
12790
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\"}."
12794 msgstr ""
12795
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})."
12799 msgstr ""
12800
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})."
12804 msgstr ""
12805
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:"
12809 msgstr ""
12810
12811 #. type: itemize
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."
12814 msgstr ""
12815
12816 #. type: itemize
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)}."
12819 msgstr ""
12820
12821 #. type: itemize
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})."
12824 msgstr ""
12825
12826 #. type: cindex
12827 #: guix-git/doc/guix.texi:6507
12828 #, no-wrap
12829 msgid "patches"
12830 msgstr ""
12831
12832 #. type: itemize
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."
12835 msgstr ""
12836
12837 #. type: cindex
12838 #: guix-git/doc/guix.texi:6513
12839 #, no-wrap
12840 msgid "GNU Build System"
12841 msgstr ""
12842
12843 #. type: itemize
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."
12846 msgstr ""
12847
12848 #. type: itemize
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."
12851 msgstr ""
12852
12853 #. type: itemize
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."
12856 msgstr ""
12857
12858 #. type: findex
12859 #: guix-git/doc/guix.texi:6530 guix-git/doc/guix.texi:6533
12860 #, no-wrap
12861 msgid "quote"
12862 msgstr ""
12863
12864 #. type: cindex
12865 #: guix-git/doc/guix.texi:6531
12866 #, no-wrap
12867 msgid "quoting"
12868 msgstr ""
12869
12870 #. type: findex
12871 #: guix-git/doc/guix.texi:6532
12872 #, no-wrap
12873 msgid "'"
12874 msgstr ""
12875
12876 #. type: itemize
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})."
12879 msgstr ""
12880
12881 #. type: itemize
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})."
12884 msgstr ""
12885
12886 #. type: itemize
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."
12889 msgstr ""
12890
12891 #. type: cindex
12892 #: guix-git/doc/guix.texi:6554
12893 #, no-wrap
12894 msgid "backquote (quasiquote)"
12895 msgstr ""
12896
12897 #. type: findex
12898 #: guix-git/doc/guix.texi:6555
12899 #, no-wrap
12900 msgid "`"
12901 msgstr ""
12902
12903 #. type: findex
12904 #: guix-git/doc/guix.texi:6556
12905 #, no-wrap
12906 msgid "quasiquote"
12907 msgstr ""
12908
12909 #. type: cindex
12910 #: guix-git/doc/guix.texi:6557
12911 #, no-wrap
12912 msgid "comma (unquote)"
12913 msgstr ""
12914
12915 #. type: findex
12916 #: guix-git/doc/guix.texi:6558
12917 #, no-wrap
12918 msgid ","
12919 msgstr ""
12920
12921 #. type: findex
12922 #: guix-git/doc/guix.texi:6559
12923 #, no-wrap
12924 msgid "unquote"
12925 msgstr ""
12926
12927 #. type: findex
12928 #: guix-git/doc/guix.texi:6560
12929 #, no-wrap
12930 msgid ",@@"
12931 msgstr ""
12932
12933 #. type: findex
12934 #: guix-git/doc/guix.texi:6561
12935 #, no-wrap
12936 msgid "unquote-splicing"
12937 msgstr ""
12938
12939 #. type: itemize
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})."
12942 msgstr ""
12943
12944 #. type: itemize
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})."
12947 msgstr ""
12948
12949 #. type: itemize
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."
12952 msgstr ""
12953
12954 #. type: Plain text
12955 #: guix-git/doc/guix.texi:6578
12956 msgid "@xref{package Reference}, for a full description of possible fields."
12957 msgstr ""
12958
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."
12962 msgstr ""
12963
12964 #. type: vindex
12965 #: guix-git/doc/guix.texi:6589
12966 #, no-wrap
12967 msgid "GUIX_PACKAGE_PATH"
12968 msgstr ""
12969
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''."
12973 msgstr ""
12974
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})."
12978 msgstr ""
12979
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})."
12983 msgstr ""
12984
12985 #. type: deffn
12986 #: guix-git/doc/guix.texi:6604
12987 #, no-wrap
12988 msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]"
12989 msgstr ""
12990
12991 #. type: deffn
12992 #: guix-git/doc/guix.texi:6607
12993 msgid "Return the @code{<derivation>} object of @var{package} for @var{system} (@pxref{Derivations})."
12994 msgstr ""
12995
12996 #. type: deffn
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})."
12999 msgstr ""
13000
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:"
13004 msgstr ""
13005
13006 #. type: deffn
13007 #: guix-git/doc/guix.texi:6620
13008 #, no-wrap
13009 msgid "{Scheme Procedure} package-cross-derivation @var{store} @"
13010 msgstr ""
13011
13012 #. type: deffn
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}."
13015 msgstr ""
13016
13017 #. type: deffn
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})."
13020 msgstr ""
13021
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."
13025 msgstr ""
13026
13027 #. type: subsection
13028 #: guix-git/doc/guix.texi:6640
13029 #, no-wrap
13030 msgid "@code{package} Reference"
13031 msgstr ""
13032
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})."
13036 msgstr ""
13037
13038 #. type: deftp
13039 #: guix-git/doc/guix.texi:6645
13040 #, no-wrap
13041 msgid "{Data Type} package"
13042 msgstr ""
13043
13044 #. type: deftp
13045 #: guix-git/doc/guix.texi:6647
13046 msgid "This is the data type representing a package recipe."
13047 msgstr ""
13048
13049 #. type: table
13050 #: guix-git/doc/guix.texi:6651
13051 msgid "The name of the package, as a string."
13052 msgstr ""
13053
13054 #. type: code{#1}
13055 #: guix-git/doc/guix.texi:6652
13056 #, no-wrap
13057 msgid "version"
13058 msgstr ""
13059
13060 #. type: table
13061 #: guix-git/doc/guix.texi:6654
13062 msgid "The version of the package, as a string."
13063 msgstr ""
13064
13065 #. type: code{#1}
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
13068 #, no-wrap
13069 msgid "source"
13070 msgstr ""
13071
13072 #. type: table
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}})."
13075 msgstr ""
13076
13077 #. type: code{#1}
13078 #: guix-git/doc/guix.texi:6663
13079 #, no-wrap
13080 msgid "build-system"
13081 msgstr ""
13082
13083 #. type: table
13084 #: guix-git/doc/guix.texi:6666
13085 msgid "The build system that should be used to build the package (@pxref{Build Systems})."
13086 msgstr ""
13087
13088 #. type: item
13089 #: guix-git/doc/guix.texi:6667 guix-git/doc/guix.texi:16669
13090 #, no-wrap
13091 msgid "@code{arguments} (default: @code{'()})"
13092 msgstr ""
13093
13094 #. type: table
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."
13097 msgstr ""
13098
13099 #. type: item
13100 #: guix-git/doc/guix.texi:6671
13101 #, no-wrap
13102 msgid "@code{inputs} (default: @code{'()})"
13103 msgstr ""
13104
13105 #. type: itemx
13106 #: guix-git/doc/guix.texi:6672
13107 #, no-wrap
13108 msgid "@code{native-inputs} (default: @code{'()})"
13109 msgstr ""
13110
13111 #. type: itemx
13112 #: guix-git/doc/guix.texi:6673
13113 #, no-wrap
13114 msgid "@code{propagated-inputs} (default: @code{'()})"
13115 msgstr ""
13116
13117 #. type: cindex
13118 #: guix-git/doc/guix.texi:6674
13119 #, no-wrap
13120 msgid "inputs, of packages"
13121 msgstr ""
13122
13123 #. type: table
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:"
13126 msgstr ""
13127
13128 #. type: lisp
13129 #: guix-git/doc/guix.texi:6687
13130 #, no-wrap
13131 msgid ""
13132 "`((\"libffi\" ,libffi)\n"
13133 " (\"libunistring\" ,libunistring)\n"
13134 " (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of Glib\n"
13135 msgstr ""
13136
13137 #. type: cindex
13138 #: guix-git/doc/guix.texi:6689
13139 #, no-wrap
13140 msgid "cross compilation, package dependencies"
13141 msgstr ""
13142
13143 #. type: table
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."
13146 msgstr ""
13147
13148 #. type: table
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})."
13151 msgstr ""
13152
13153 #. type: anchor{#1}
13154 #: guix-git/doc/guix.texi:6708
13155 msgid "package-propagated-inputs"
13156 msgstr ""
13157
13158 #. type: table
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)."
13161 msgstr ""
13162
13163 #. type: table
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."
13166 msgstr ""
13167
13168 #. type: table
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}."
13171 msgstr ""
13172
13173 #. type: item
13174 #: guix-git/doc/guix.texi:6720
13175 #, no-wrap
13176 msgid "@code{outputs} (default: @code{'(\"out\")})"
13177 msgstr ""
13178
13179 #. type: table
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."
13182 msgstr ""
13183
13184 #. type: item
13185 #: guix-git/doc/guix.texi:6724
13186 #, no-wrap
13187 msgid "@code{native-search-paths} (default: @code{'()})"
13188 msgstr ""
13189
13190 #. type: itemx
13191 #: guix-git/doc/guix.texi:6725
13192 #, no-wrap
13193 msgid "@code{search-paths} (default: @code{'()})"
13194 msgstr ""
13195
13196 #. type: table
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."
13199 msgstr ""
13200
13201 #. type: item
13202 #: guix-git/doc/guix.texi:6729
13203 #, no-wrap
13204 msgid "@code{replacement} (default: @code{#f})"
13205 msgstr ""
13206
13207 #. type: table
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."
13210 msgstr ""
13211
13212 #. type: item
13213 #: guix-git/doc/guix.texi:6734 guix-git/doc/guix.texi:11950
13214 #, no-wrap
13215 msgid "synopsis"
13216 msgstr ""
13217
13218 #. type: table
13219 #: guix-git/doc/guix.texi:6736
13220 msgid "A one-line description of the package."
13221 msgstr ""
13222
13223 #. type: code{#1}
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
13226 #, no-wrap
13227 msgid "description"
13228 msgstr ""
13229
13230 #. type: table
13231 #: guix-git/doc/guix.texi:6739
13232 msgid "A more elaborate description of the package."
13233 msgstr ""
13234
13235 #. type: code{#1}
13236 #: guix-git/doc/guix.texi:6740
13237 #, no-wrap
13238 msgid "license"
13239 msgstr ""
13240
13241 #. type: cindex
13242 #: guix-git/doc/guix.texi:6741
13243 #, no-wrap
13244 msgid "license, of packages"
13245 msgstr ""
13246
13247 #. type: table
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."
13250 msgstr ""
13251
13252 #. type: itemx
13253 #: guix-git/doc/guix.texi:6745 guix-git/doc/guix.texi:11959
13254 #, no-wrap
13255 msgid "home-page"
13256 msgstr ""
13257
13258 #. type: table
13259 #: guix-git/doc/guix.texi:6747
13260 msgid "The URL to the home-page of the package, as a string."
13261 msgstr ""
13262
13263 #. type: item
13264 #: guix-git/doc/guix.texi:6748
13265 #, no-wrap
13266 msgid "@code{supported-systems} (default: @code{%supported-systems})"
13267 msgstr ""
13268
13269 #. type: table
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\"}."
13272 msgstr ""
13273
13274 #. type: item
13275 #: guix-git/doc/guix.texi:6752
13276 #, no-wrap
13277 msgid "@code{location} (default: source location of the @code{package} form)"
13278 msgstr ""
13279
13280 #. type: table
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."
13283 msgstr ""
13284
13285 #. type: deffn
13286 #: guix-git/doc/guix.texi:6759
13287 #, no-wrap
13288 msgid "{Scheme Syntax} this-package"
13289 msgstr ""
13290
13291 #. type: deffn
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."
13294 msgstr ""
13295
13296 #. type: deffn
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:"
13299 msgstr ""
13300
13301 #. type: lisp
13302 #: guix-git/doc/guix.texi:6770
13303 #, no-wrap
13304 msgid ""
13305 "(package\n"
13306 " (name \"guile\")\n"
13307 " ;; ...\n"
13308 "\n"
13309 msgstr ""
13310
13311 #. type: lisp
13312 #: guix-git/doc/guix.texi:6776
13313 #, no-wrap
13314 msgid ""
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"
13319 " '())))\n"
13320 msgstr ""
13321
13322 #. type: deffn
13323 #: guix-git/doc/guix.texi:6779
13324 msgid "It is an error to refer to @code{this-package} outside a package definition."
13325 msgstr ""
13326
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."
13330 msgstr ""
13331
13332 #. type: cindex
13333 #: guix-git/doc/guix.texi:6786
13334 #, no-wrap
13335 msgid "tool chain, choosing a package's tool chain"
13336 msgstr ""
13337
13338 #. type: deffn
13339 #: guix-git/doc/guix.texi:6787
13340 #, no-wrap
13341 msgid "{Scheme Procedure} package-with-c-toolchain @var{package} @var{toolchain}"
13342 msgstr ""
13343
13344 #. type: deffn
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."
13347 msgstr ""
13348
13349 #. type: deffn
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:"
13352 msgstr ""
13353
13354 #. type: lisp
13355 #: guix-git/doc/guix.texi:6800
13356 #, no-wrap
13357 msgid ""
13358 "(let ((toolchain (specification->package \"gcc-toolchain@@10\")))\n"
13359 " (package-with-c-toolchain hello `((\"toolchain\" ,toolchain))))\n"
13360 msgstr ""
13361
13362 #. type: deffn
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."
13365 msgstr ""
13366
13367 #. type: subsection
13368 #: guix-git/doc/guix.texi:6811
13369 #, no-wrap
13370 msgid "@code{origin} Reference"
13371 msgstr ""
13372
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."
13376 msgstr ""
13377
13378 #. type: deftp
13379 #: guix-git/doc/guix.texi:6820
13380 #, no-wrap
13381 msgid "{Data Type} origin"
13382 msgstr ""
13383
13384 #. type: deftp
13385 #: guix-git/doc/guix.texi:6822
13386 msgid "This is the data type representing a source code origin."
13387 msgstr ""
13388
13389 #. type: code{#1}
13390 #: guix-git/doc/guix.texi:6824 guix-git/doc/guix.texi:24843
13391 #, no-wrap
13392 msgid "uri"
13393 msgstr ""
13394
13395 #. type: table
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."
13398 msgstr ""
13399
13400 #. type: cindex
13401 #: guix-git/doc/guix.texi:6830
13402 #, no-wrap
13403 msgid "fixed-output derivations, for download"
13404 msgstr ""
13405
13406 #. type: code{#1}
13407 #: guix-git/doc/guix.texi:6831
13408 #, no-wrap
13409 msgid "method"
13410 msgstr ""
13411
13412 #. type: table
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})."
13415 msgstr ""
13416
13417 #. type: table
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)."
13420 msgstr ""
13421
13422 #. type: code{#1}
13423 #: guix-git/doc/guix.texi:6843
13424 #, no-wrap
13425 msgid "sha256"
13426 msgstr ""
13427
13428 #. type: table
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."
13431 msgstr ""
13432
13433 #. type: code{#1}
13434 #: guix-git/doc/guix.texi:6848
13435 #, no-wrap
13436 msgid "hash"
13437 msgstr ""
13438
13439 #. type: table
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}."
13442 msgstr ""
13443
13444 #. type: table
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})."
13447 msgstr ""
13448
13449 #. type: item
13450 #: guix-git/doc/guix.texi:6856
13451 #, no-wrap
13452 msgid "@code{file-name} (default: @code{#f})"
13453 msgstr ""
13454
13455 #. type: table
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."
13458 msgstr ""
13459
13460 #. type: item
13461 #: guix-git/doc/guix.texi:6863
13462 #, no-wrap
13463 msgid "@code{patches} (default: @code{'()})"
13464 msgstr ""
13465
13466 #. type: table
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."
13469 msgstr ""
13470
13471 #. type: table
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}."
13474 msgstr ""
13475
13476 #. type: item
13477 #: guix-git/doc/guix.texi:6871
13478 #, no-wrap
13479 msgid "@code{snippet} (default: @code{#f})"
13480 msgstr ""
13481
13482 #. type: table
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."
13485 msgstr ""
13486
13487 #. type: item
13488 #: guix-git/doc/guix.texi:6876
13489 #, no-wrap
13490 msgid "@code{patch-flags} (default: @code{'(\"-p1\")})"
13491 msgstr ""
13492
13493 #. type: table
13494 #: guix-git/doc/guix.texi:6879
13495 msgid "A list of command-line flags that should be passed to the @code{patch} command."
13496 msgstr ""
13497
13498 #. type: item
13499 #: guix-git/doc/guix.texi:6880
13500 #, no-wrap
13501 msgid "@code{patch-inputs} (default: @code{#f})"
13502 msgstr ""
13503
13504 #. type: table
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."
13507 msgstr ""
13508
13509 #. type: item
13510 #: guix-git/doc/guix.texi:6885 guix-git/doc/guix.texi:24716
13511 #, no-wrap
13512 msgid "@code{modules} (default: @code{'()})"
13513 msgstr ""
13514
13515 #. type: table
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."
13518 msgstr ""
13519
13520 #. type: item
13521 #: guix-git/doc/guix.texi:6889
13522 #, no-wrap
13523 msgid "@code{patch-guile} (default: @code{#f})"
13524 msgstr ""
13525
13526 #. type: table
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."
13529 msgstr ""
13530
13531 #. type: deftp
13532 #: guix-git/doc/guix.texi:6895
13533 #, no-wrap
13534 msgid "{Data Type} content-hash @var{value} [@var{algorithm}]"
13535 msgstr ""
13536
13537 #. type: deftp
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}."
13540 msgstr ""
13541
13542 #. type: deftp
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."
13545 msgstr ""
13546
13547 #. type: deftp
13548 #: guix-git/doc/guix.texi:6904
13549 msgid "The following forms are all equivalent:"
13550 msgstr ""
13551
13552 #. type: lisp
13553 #: guix-git/doc/guix.texi:6913
13554 #, no-wrap
13555 msgid ""
13556 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\")\n"
13557 "(content-hash \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"\n"
13558 " sha256)\n"
13559 "(content-hash (base32\n"
13560 " \"05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj\"))\n"
13561 "(content-hash (base64 \"kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=\")\n"
13562 " sha256)\n"
13563 msgstr ""
13564
13565 #. type: deftp
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}."
13568 msgstr ""
13569
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."
13573 msgstr ""
13574
13575 #. type: deffn
13576 #: guix-git/doc/guix.texi:6925
13577 #, no-wrap
13578 msgid "{Scheme Procedure} url-fetch @var{url} @var{hash-algo} @var{hash} @"
13579 msgstr ""
13580
13581 #. type: deffn
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."
13584 msgstr ""
13585
13586 #. type: deffn
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}."
13589 msgstr ""
13590
13591 #. type: deffn
13592 #: guix-git/doc/guix.texi:6939
13593 msgid "Alternatively, when URL starts with @code{file://}, return the corresponding file name in the store."
13594 msgstr ""
13595
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."
13599 msgstr ""
13600
13601 #. type: deffn
13602 #: guix-git/doc/guix.texi:6946
13603 #, no-wrap
13604 msgid "{Scheme Procedure} git-fetch @var{ref} @var{hash-algo} @var{hash}"
13605 msgstr ""
13606
13607 #. type: deffn
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}."
13610 msgstr ""
13611
13612 #. type: deftp
13613 #: guix-git/doc/guix.texi:6953
13614 #, no-wrap
13615 msgid "{Data Type} git-reference"
13616 msgstr ""
13617
13618 #. type: deftp
13619 #: guix-git/doc/guix.texi:6956
13620 msgid "This data type represents a Git reference for @code{git-fetch} to retrieve."
13621 msgstr ""
13622
13623 #. type: code{#1}
13624 #: guix-git/doc/guix.texi:6958 guix-git/doc/guix.texi:22478
13625 #, no-wrap
13626 msgid "url"
13627 msgstr ""
13628
13629 #. type: table
13630 #: guix-git/doc/guix.texi:6960
13631 msgid "The URL of the Git repository to clone."
13632 msgstr ""
13633
13634 #. type: code{#1}
13635 #: guix-git/doc/guix.texi:6961
13636 #, no-wrap
13637 msgid "commit"
13638 msgstr "úprava"
13639
13640 #. type: table
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."
13643 msgstr ""
13644
13645 #. type: item
13646 #: guix-git/doc/guix.texi:6966
13647 #, no-wrap
13648 msgid "@code{recursive?} (default: @code{#f})"
13649 msgstr ""
13650
13651 #. type: table
13652 #: guix-git/doc/guix.texi:6968
13653 msgid "This Boolean indicates whether to recursively fetch Git sub-modules."
13654 msgstr ""
13655
13656 #. type: deftp
13657 #: guix-git/doc/guix.texi:6972
13658 msgid "The example below denotes the @code{v2.10} tag of the GNU@tie{}Hello repository:"
13659 msgstr ""
13660
13661 #. type: lisp
13662 #: guix-git/doc/guix.texi:6977
13663 #, no-wrap
13664 msgid ""
13665 "(git-reference\n"
13666 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13667 " (commit \"v2.10\"))\n"
13668 msgstr ""
13669
13670 #. type: deftp
13671 #: guix-git/doc/guix.texi:6981
13672 msgid "This is equivalent to the reference below, which explicitly names the commit:"
13673 msgstr ""
13674
13675 #. type: lisp
13676 #: guix-git/doc/guix.texi:6986
13677 #, no-wrap
13678 msgid ""
13679 "(git-reference\n"
13680 " (url \"https://git.savannah.gnu.org/git/hello.git\")\n"
13681 " (commit \"dc7dc56a00e48fe6f231a58f6537139fe2908fb9\"))\n"
13682 msgstr ""
13683
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."
13687 msgstr ""
13688
13689 #. type: deffn
13690 #: guix-git/doc/guix.texi:6993
13691 #, no-wrap
13692 msgid "{Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @"
13693 msgstr ""
13694
13695 #. type: deffn
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}."
13698 msgstr ""
13699
13700 #. type: cindex
13701 #: guix-git/doc/guix.texi:7004
13702 #, no-wrap
13703 msgid "customizing packages"
13704 msgstr ""
13705
13706 #. type: cindex
13707 #: guix-git/doc/guix.texi:7005
13708 #, no-wrap
13709 msgid "variants, of packages"
13710 msgstr ""
13711
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!"
13715 msgstr ""
13716
13717 #. type: cindex
13718 #: guix-git/doc/guix.texi:7016
13719 #, no-wrap
13720 msgid "inherit, for package definitions"
13721 msgstr ""
13722
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."
13726 msgstr ""
13727
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!):"
13731 msgstr ""
13732
13733 #. type: lisp
13734 #: guix-git/doc/guix.texi:7031
13735 #, no-wrap
13736 msgid ""
13737 "(use-modules (gnu packages base)) ;for 'hello'\n"
13738 "\n"
13739 msgstr ""
13740
13741 #. type: lisp
13742 #: guix-git/doc/guix.texi:7043
13743 #, no-wrap
13744 msgid ""
13745 "(define hello-2.2\n"
13746 " (package\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"
13752 " \".tar.gz\"))\n"
13753 " (sha256\n"
13754 " (base32\n"
13755 " \"0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9\"))))))\n"
13756 msgstr ""
13757
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."
13761 msgstr ""
13762
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:"
13766 msgstr ""
13767
13768 #. type: lisp
13769 #: guix-git/doc/guix.texi:7062
13770 #, no-wrap
13771 msgid ""
13772 "(use-modules (gnu packages gdb) ;for 'gdb'\n"
13773 " (srfi srfi-1)) ;for 'alist-delete'\n"
13774 "\n"
13775 msgstr ""
13776
13777 #. type: lisp
13778 #: guix-git/doc/guix.texi:7068
13779 #, no-wrap
13780 msgid ""
13781 "(define gdb-sans-guile\n"
13782 " (package\n"
13783 " (inherit gdb)\n"
13784 " (inputs (alist-delete \"guile\"\n"
13785 " (package-inputs gdb)))))\n"
13786 msgstr ""
13787
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})."
13791 msgstr ""
13792
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:"
13796 msgstr ""
13797
13798 #. type: lisp
13799 #: guix-git/doc/guix.texi:7093
13800 #, no-wrap
13801 msgid ""
13802 "(define (make-lua-socket name lua)\n"
13803 " ;; Return a luasocket package built with LUA.\n"
13804 " (package\n"
13805 " (name name)\n"
13806 " (version \"3.0\")\n"
13807 " ;; several fields omitted\n"
13808 " (inputs\n"
13809 " `((\"lua\" ,lua)))\n"
13810 " (synopsis \"Socket library for Lua\")))\n"
13811 "\n"
13812 msgstr ""
13813
13814 #. type: lisp
13815 #: guix-git/doc/guix.texi:7096
13816 #, no-wrap
13817 msgid ""
13818 "(define-public lua5.1-socket\n"
13819 " (make-lua-socket \"lua5.1-socket\" lua-5.1))\n"
13820 "\n"
13821 msgstr ""
13822
13823 #. type: lisp
13824 #: guix-git/doc/guix.texi:7099
13825 #, no-wrap
13826 msgid ""
13827 "(define-public lua5.2-socket\n"
13828 " (make-lua-socket \"lua5.2-socket\" lua-5.2))\n"
13829 msgstr ""
13830
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})."
13834 msgstr ""
13835
13836 #. type: cindex
13837 #: guix-git/doc/guix.texi:7108
13838 #, no-wrap
13839 msgid "package transformations"
13840 msgstr ""
13841
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}):"
13845 msgstr ""
13846
13847 #. type: deffn
13848 #: guix-git/doc/guix.texi:7114
13849 #, no-wrap
13850 msgid "{Scheme Procedure} options->transformation @var{opts}"
13851 msgstr ""
13852
13853 #. type: deffn
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:"
13856 msgstr ""
13857
13858 #. type: lisp
13859 #: guix-git/doc/guix.texi:7122
13860 #, no-wrap
13861 msgid ""
13862 "((with-branch . \"guile-gcrypt=master\")\n"
13863 " (without-tests . \"libgcrypt\"))\n"
13864 msgstr ""
13865
13866 #. type: deffn
13867 #: guix-git/doc/guix.texi:7126
13868 msgid "Each symbol names a transformation and the corresponding string is an argument to that transformation."
13869 msgstr ""
13870
13871 #. type: Plain text
13872 #: guix-git/doc/guix.texi:7129
13873 msgid "For instance, a manifest equivalent to this command:"
13874 msgstr ""
13875
13876 #. type: example
13877 #: guix-git/doc/guix.texi:7134
13878 #, no-wrap
13879 msgid ""
13880 "guix build guix \\\n"
13881 " --with-branch=guile-gcrypt=master \\\n"
13882 " --with-debug-info=zlib\n"
13883 msgstr ""
13884
13885 #. type: Plain text
13886 #: guix-git/doc/guix.texi:7138
13887 msgid "... would look like this:"
13888 msgstr ""
13889
13890 #. type: lisp
13891 #: guix-git/doc/guix.texi:7141
13892 #, no-wrap
13893 msgid ""
13894 "(use-modules (guix transformations))\n"
13895 "\n"
13896 msgstr ""
13897
13898 #. type: lisp
13899 #: guix-git/doc/guix.texi:7147
13900 #, no-wrap
13901 msgid ""
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"
13907 "\n"
13908 msgstr ""
13909
13910 #. type: lisp
13911 #: guix-git/doc/guix.texi:7150
13912 #, no-wrap
13913 msgid ""
13914 "(packages->manifest\n"
13915 " (list (transform (specification->package \"guix\"))))\n"
13916 msgstr ""
13917
13918 #. type: cindex
13919 #: guix-git/doc/guix.texi:7152
13920 #, no-wrap
13921 msgid "input rewriting"
13922 msgstr ""
13923
13924 #. type: cindex
13925 #: guix-git/doc/guix.texi:7153
13926 #, no-wrap
13927 msgid "dependency graph rewriting"
13928 msgstr ""
13929
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."
13933 msgstr ""
13934
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."
13938 msgstr ""
13939
13940 #. type: deffn
13941 #: guix-git/doc/guix.texi:7165
13942 #, no-wrap
13943 msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @"
13944 msgstr ""
13945
13946 #. type: deffn
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."
13949 msgstr ""
13950
13951 #. type: deffn
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."
13954 msgstr ""
13955
13956 #. type: table
13957 #: guix-git/doc/guix.texi:7179 guix-git/doc/guix.texi:10505
13958 msgid "Consider this example:"
13959 msgstr ""
13960
13961 #. type: lisp
13962 #: guix-git/doc/guix.texi:7185
13963 #, no-wrap
13964 msgid ""
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"
13969 "\n"
13970 msgstr ""
13971
13972 #. type: lisp
13973 #: guix-git/doc/guix.texi:7188
13974 #, no-wrap
13975 msgid ""
13976 "(define git-with-libressl\n"
13977 " (libressl-instead-of-openssl git))\n"
13978 msgstr ""
13979
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}})."
13983 msgstr ""
13984
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."
13988 msgstr ""
13989
13990 #. type: deffn
13991 #: guix-git/doc/guix.texi:7200
13992 #, no-wrap
13993 msgid "{Scheme Procedure} package-input-rewriting/spec @var{replacements} [#:deep? #t]"
13994 msgstr ""
13995
13996 #. type: deffn
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."
13999 msgstr ""
14000
14001 #. type: Plain text
14002 #: guix-git/doc/guix.texi:7210
14003 msgid "The example above could be rewritten this way:"
14004 msgstr ""
14005
14006 #. type: lisp
14007 #: guix-git/doc/guix.texi:7215
14008 #, no-wrap
14009 msgid ""
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"
14013 msgstr ""
14014
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."
14018 msgstr ""
14019
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."
14023 msgstr ""
14024
14025 #. type: deffn
14026 #: guix-git/doc/guix.texi:7225
14027 #, no-wrap
14028 msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}] [#:deep? #f]"
14029 msgstr ""
14030
14031 #. type: deffn
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."
14034 msgstr ""
14035
14036 #. type: cindex
14037 #: guix-git/doc/guix.texi:7236
14038 #, no-wrap
14039 msgid "build system"
14040 msgstr ""
14041
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."
14045 msgstr ""
14046
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."
14050 msgstr ""
14051
14052 #. type: cindex
14053 #: guix-git/doc/guix.texi:7246
14054 #, no-wrap
14055 msgid "bag (low-level package representation)"
14056 msgstr ""
14057
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}})."
14061 msgstr ""
14062
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})."
14066 msgstr ""
14067
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."
14071 msgstr ""
14072
14073 #. type: defvr
14074 #: guix-git/doc/guix.texi:7269
14075 #, no-wrap
14076 msgid "{Scheme Variable} gnu-build-system"
14077 msgstr ""
14078
14079 #. type: defvr
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})."
14082 msgstr ""
14083
14084 #. type: cindex
14085 #: guix-git/doc/guix.texi:7274 guix-git/doc/guix.texi:8200
14086 #: guix-git/doc/guix.texi:8655
14087 #, no-wrap
14088 msgid "build phases"
14089 msgstr ""
14090
14091 #. type: defvr
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."
14094 msgstr ""
14095
14096 #. type: defvr
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."
14099 msgstr ""
14100
14101 #. type: defvr
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:"
14104 msgstr ""
14105
14106 #. type: item
14107 #: guix-git/doc/guix.texi:7294
14108 #, no-wrap
14109 msgid "#:phases"
14110 msgstr ""
14111
14112 #. type: table
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."
14115 msgstr ""
14116
14117 #. type: item
14118 #: guix-git/doc/guix.texi:7298
14119 #, no-wrap
14120 msgid "#:configure-flags"
14121 msgstr ""
14122
14123 #. type: table
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."
14126 msgstr ""
14127
14128 #. type: item
14129 #: guix-git/doc/guix.texi:7302
14130 #, no-wrap
14131 msgid "#:make-flags"
14132 msgstr ""
14133
14134 #. type: table
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."
14137 msgstr ""
14138
14139 #. type: item
14140 #: guix-git/doc/guix.texi:7307
14141 #, no-wrap
14142 msgid "#:out-of-source?"
14143 msgstr ""
14144
14145 #. type: table
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."
14148 msgstr ""
14149
14150 #. type: table
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}."
14153 msgstr ""
14154
14155 #. type: item
14156 #: guix-git/doc/guix.texi:7316
14157 #, no-wrap
14158 msgid "#:tests?"
14159 msgstr ""
14160
14161 #. type: table
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."
14164 msgstr ""
14165
14166 #. type: item
14167 #: guix-git/doc/guix.texi:7320
14168 #, no-wrap
14169 msgid "#:test-target"
14170 msgstr ""
14171
14172 #. type: table
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."
14175 msgstr ""
14176
14177 #. type: item
14178 #: guix-git/doc/guix.texi:7324
14179 #, no-wrap
14180 msgid "#:parallel-build?"
14181 msgstr ""
14182
14183 #. type: itemx
14184 #: guix-git/doc/guix.texi:7325
14185 #, no-wrap
14186 msgid "#:parallel-tests?"
14187 msgstr ""
14188
14189 #. type: table
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}})."
14192 msgstr ""
14193
14194 #. type: cindex
14195 #: guix-git/doc/guix.texi:7333
14196 #, no-wrap
14197 msgid "RUNPATH, validation"
14198 msgstr ""
14199
14200 #. type: item
14201 #: guix-git/doc/guix.texi:7334
14202 #, no-wrap
14203 msgid "#:validate-runpath?"
14204 msgstr ""
14205
14206 #. type: table
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."
14209 msgstr ""
14210
14211 #. type: table
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}."
14214 msgstr ""
14215
14216 #. type: item
14217 #: guix-git/doc/guix.texi:7347
14218 #, no-wrap
14219 msgid "#:substitutable?"
14220 msgstr ""
14221
14222 #. type: table
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})."
14225 msgstr ""
14226
14227 #. type: item
14228 #: guix-git/doc/guix.texi:7352
14229 #, no-wrap
14230 msgid "#:allowed-references"
14231 msgstr ""
14232
14233 #. type: itemx
14234 #: guix-git/doc/guix.texi:7353
14235 #, no-wrap
14236 msgid "#:disallowed-references"
14237 msgstr ""
14238
14239 #. type: table
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."
14242 msgstr ""
14243
14244 #. type: table
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})."
14247 msgstr ""
14248
14249 #. type: defvr
14250 #: guix-git/doc/guix.texi:7366
14251 msgid "Most other build systems support these keyword arguments."
14252 msgstr ""
14253
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."
14257 msgstr ""
14258
14259 #. type: defvr
14260 #: guix-git/doc/guix.texi:7374
14261 #, no-wrap
14262 msgid "{Scheme Variable} ant-build-system"
14263 msgstr ""
14264
14265 #. type: defvr
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}."
14268 msgstr ""
14269
14270 #. type: defvr
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."
14273 msgstr ""
14274
14275 #. type: defvr
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''."
14278 msgstr ""
14279
14280 #. type: defvr
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."
14283 msgstr ""
14284
14285 #. type: defvr
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."
14288 msgstr ""
14289
14290 #. type: defvr
14291 #: guix-git/doc/guix.texi:7404
14292 #, no-wrap
14293 msgid "{Scheme Variable} android-ndk-build-system"
14294 msgstr ""
14295
14296 #. type: cindex
14297 #: guix-git/doc/guix.texi:7405
14298 #, no-wrap
14299 msgid "Android distribution"
14300 msgstr ""
14301
14302 #. type: cindex
14303 #: guix-git/doc/guix.texi:7406
14304 #, no-wrap
14305 msgid "Android NDK build system"
14306 msgstr ""
14307
14308 #. type: defvr
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."
14311 msgstr ""
14312
14313 #. type: defvr
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."
14316 msgstr ""
14317
14318 #. type: defvr
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."
14321 msgstr ""
14322
14323 #. type: defvr
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."
14326 msgstr ""
14327
14328 #. type: defvr
14329 #: guix-git/doc/guix.texi:7423
14330 #, no-wrap
14331 msgid "{Scheme Variable} asdf-build-system/source"
14332 msgstr ""
14333
14334 #. type: defvrx
14335 #: guix-git/doc/guix.texi:7424
14336 #, no-wrap
14337 msgid "{Scheme Variable} asdf-build-system/sbcl"
14338 msgstr ""
14339
14340 #. type: defvrx
14341 #: guix-git/doc/guix.texi:7425
14342 #, no-wrap
14343 msgid "{Scheme Variable} asdf-build-system/ecl"
14344 msgstr ""
14345
14346 #. type: defvr
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."
14349 msgstr ""
14350
14351 #. type: defvr
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."
14354 msgstr ""
14355
14356 #. type: defvr
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}."
14359 msgstr ""
14360
14361 #. type: defvr
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."
14364 msgstr ""
14365
14366 #. type: defvr
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."
14369 msgstr ""
14370
14371 #. type: defvr
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."
14374 msgstr ""
14375
14376 #. type: defvr
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."
14379 msgstr ""
14380
14381 #. type: defvr
14382 #: guix-git/doc/guix.texi:7471
14383 #, no-wrap
14384 msgid "{Scheme Variable} cargo-build-system"
14385 msgstr ""
14386
14387 #. type: cindex
14388 #: guix-git/doc/guix.texi:7472
14389 #, no-wrap
14390 msgid "Rust programming language"
14391 msgstr ""
14392
14393 #. type: cindex
14394 #: guix-git/doc/guix.texi:7473
14395 #, no-wrap
14396 msgid "Cargo (Rust build system)"
14397 msgstr ""
14398
14399 #. type: defvr
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}."
14402 msgstr ""
14403
14404 #. type: defvr
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."
14407 msgstr ""
14408
14409 #. type: defvr
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."
14412 msgstr ""
14413
14414 #. type: defvr
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."
14417 msgstr ""
14418
14419 #. type: defvr
14420 #: guix-git/doc/guix.texi:7502
14421 #, no-wrap
14422 msgid "{Scheme Variable} chicken-build-system"
14423 msgstr ""
14424
14425 #. type: defvr
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."
14428 msgstr ""
14429
14430 #. type: defvr
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}."
14433 msgstr ""
14434
14435 #. type: defvr
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."
14438 msgstr ""
14439
14440 #. type: defvr
14441 #: guix-git/doc/guix.texi:7516
14442 msgid "For example, if you are packaging the @code{srfi-1} egg:"
14443 msgstr ""
14444
14445 #. type: lisp
14446 #: guix-git/doc/guix.texi:7519
14447 #, no-wrap
14448 msgid "(arguments '(#:egg-name \"srfi-1\"))\n"
14449 msgstr ""
14450
14451 #. type: defvr
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."
14454 msgstr ""
14455
14456 #. type: defvr
14457 #: guix-git/doc/guix.texi:7526
14458 #, no-wrap
14459 msgid "{Scheme Variable} copy-build-system"
14460 msgstr ""
14461
14462 #. type: defvr
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."
14465 msgstr ""
14466
14467 #. type: defvr
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}."
14470 msgstr ""
14471
14472 #. type: defvr
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."
14475 msgstr ""
14476
14477 #. type: item
14478 #: guix-git/doc/guix.texi:7542
14479 #, no-wrap
14480 msgid "When @var{source} matches a file or directory without trailing slash, install it to @var{target}."
14481 msgstr ""
14482
14483 #. type: item
14484 #: guix-git/doc/guix.texi:7544
14485 #, no-wrap
14486 msgid "If @var{target} has a trailing slash, install @var{source} basename beneath @var{target}."
14487 msgstr ""
14488
14489 #. type: item
14490 #: guix-git/doc/guix.texi:7545
14491 #, no-wrap
14492 msgid "Otherwise install @var{source} as @var{target}."
14493 msgstr ""
14494
14495 #. type: item
14496 #: guix-git/doc/guix.texi:7548
14497 #, no-wrap
14498 msgid "When @var{source} is a directory with a trailing slash, or when @var{filters} are used,"
14499 msgstr ""
14500
14501 #. type: itemize
14502 #: guix-git/doc/guix.texi:7551
14503 msgid "the trailing slash of @var{target} is implied with the same meaning as above."
14504 msgstr ""
14505
14506 #. type: item
14507 #: guix-git/doc/guix.texi:7552
14508 #, no-wrap
14509 msgid "Without @var{filters}, install the full @var{source} @emph{content} to @var{target}."
14510 msgstr ""
14511
14512 #. type: item
14513 #: guix-git/doc/guix.texi:7553
14514 #, no-wrap
14515 msgid "With @var{filters} among @code{#:include}, @code{#:include-regexp}, @code{#:exclude},"
14516 msgstr ""
14517
14518 #. type: itemize
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."
14521 msgstr ""
14522
14523 #. type: item
14524 #: guix-git/doc/guix.texi:7557
14525 #, no-wrap
14526 msgid "With @code{#:include}, install all the files which the path suffix matches"
14527 msgstr ""
14528
14529 #. type: itemize
14530 #: guix-git/doc/guix.texi:7559
14531 msgid "at least one of the elements in the given list."
14532 msgstr ""
14533
14534 #. type: item
14535 #: guix-git/doc/guix.texi:7559
14536 #, no-wrap
14537 msgid "With @code{#:include-regexp}, install all the files which the"
14538 msgstr ""
14539
14540 #. type: itemize
14541 #: guix-git/doc/guix.texi:7562
14542 msgid "subpaths match at least one of the regular expressions in the given list."
14543 msgstr ""
14544
14545 #. type: item
14546 #: guix-git/doc/guix.texi:7562
14547 #, no-wrap
14548 msgid "The @code{#:exclude} and @code{#:exclude-regexp} filters"
14549 msgstr ""
14550
14551 #. type: itemize
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."
14554 msgstr ""
14555
14556 #. type: itemize
14557 #: guix-git/doc/guix.texi:7571
14558 msgid "In all cases, the paths relative to @var{source} are preserved within @var{target}."
14559 msgstr ""
14560
14561 #. type: defvr
14562 #: guix-git/doc/guix.texi:7574
14563 msgid "Examples:"
14564 msgstr ""
14565
14566 #. type: item
14567 #: guix-git/doc/guix.texi:7576
14568 #, no-wrap
14569 msgid "@code{(\"foo/bar\" \"share/my-app/\")}: Install @file{bar} to @file{share/my-app/bar}."
14570 msgstr ""
14571
14572 #. type: item
14573 #: guix-git/doc/guix.texi:7577
14574 #, no-wrap
14575 msgid "@code{(\"foo/bar\" \"share/my-app/baz\")}: Install @file{bar} to @file{share/my-app/baz}."
14576 msgstr ""
14577
14578 #. type: item
14579 #: guix-git/doc/guix.texi:7578
14580 #, no-wrap
14581 msgid "@code{(\"foo/\" \"share/my-app\")}: Install the content of @file{foo} inside @file{share/my-app},"
14582 msgstr ""
14583
14584 #. type: itemize
14585 #: guix-git/doc/guix.texi:7580
14586 msgid "e.g., install @file{foo/sub/file} to @file{share/my-app/sub/file}."
14587 msgstr ""
14588
14589 #. type: item
14590 #: guix-git/doc/guix.texi:7580
14591 #, no-wrap
14592 msgid "@code{(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))}: Install only @file{foo/sub/file} to"
14593 msgstr ""
14594
14595 #. type: itemize
14596 #: guix-git/doc/guix.texi:7582
14597 msgid "@file{share/my-app/sub/file}."
14598 msgstr ""
14599
14600 #. type: item
14601 #: guix-git/doc/guix.texi:7582
14602 #, no-wrap
14603 msgid "@code{(\"foo/sub\" \"share/my-app\" #:include (\"file\"))}: Install @file{foo/sub/file} to"
14604 msgstr ""
14605
14606 #. type: itemize
14607 #: guix-git/doc/guix.texi:7584
14608 msgid "@file{share/my-app/file}."
14609 msgstr ""
14610
14611 #. type: cindex
14612 #: guix-git/doc/guix.texi:7588
14613 #, no-wrap
14614 msgid "Clojure (programming language)"
14615 msgstr ""
14616
14617 #. type: cindex
14618 #: guix-git/doc/guix.texi:7589
14619 #, no-wrap
14620 msgid "simple Clojure build system"
14621 msgstr ""
14622
14623 #. type: defvr
14624 #: guix-git/doc/guix.texi:7590
14625 #, no-wrap
14626 msgid "{Scheme Variable} clojure-build-system"
14627 msgstr ""
14628
14629 #. type: defvr
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."
14632 msgstr ""
14633
14634 #. type: defvr
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."
14637 msgstr ""
14638
14639 #. type: defvr
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."
14642 msgstr ""
14643
14644 #. type: defvr
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:"
14647 msgstr ""
14648
14649 #. type: item
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
14653 #, no-wrap
14654 msgid "build"
14655 msgstr ""
14656
14657 #. type: table
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."
14660 msgstr ""
14661
14662 #. type: item
14663 #: guix-git/doc/guix.texi:7621 guix-git/doc/guix.texi:8167
14664 #: guix-git/doc/guix.texi:8284
14665 #, no-wrap
14666 msgid "check"
14667 msgstr ""
14668
14669 #. type: table
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."
14672 msgstr ""
14673
14674 #. type: item
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
14677 #, no-wrap
14678 msgid "install"
14679 msgstr ""
14680
14681 #. type: table
14682 #: guix-git/doc/guix.texi:7631
14683 msgid "This phase installs all jars built previously."
14684 msgstr ""
14685
14686 #. type: defvr
14687 #: guix-git/doc/guix.texi:7634
14688 msgid "Apart from the above, this build system also contains an additional phase:"
14689 msgstr ""
14690
14691 #. type: item
14692 #: guix-git/doc/guix.texi:7637
14693 #, no-wrap
14694 msgid "install-doc"
14695 msgstr ""
14696
14697 #. type: table
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."
14700 msgstr ""
14701
14702 #. type: defvr
14703 #: guix-git/doc/guix.texi:7645
14704 #, no-wrap
14705 msgid "{Scheme Variable} cmake-build-system"
14706 msgstr ""
14707
14708 #. type: defvr
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}."
14711 msgstr ""
14712
14713 #. type: defvr
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."
14716 msgstr ""
14717
14718 #. type: defvr
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."
14721 msgstr ""
14722
14723 #. type: defvr
14724 #: guix-git/doc/guix.texi:7662
14725 #, no-wrap
14726 msgid "{Scheme Variable} dune-build-system"
14727 msgstr ""
14728
14729 #. type: defvr
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."
14732 msgstr ""
14733
14734 #. type: defvr
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."
14737 msgstr ""
14738
14739 #. type: defvr
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."
14742 msgstr ""
14743
14744 #. type: defvr
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}."
14747 msgstr ""
14748
14749 #. type: defvr
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}."
14752 msgstr ""
14753
14754 #. type: defvr
14755 #: guix-git/doc/guix.texi:7688
14756 #, no-wrap
14757 msgid "{Scheme Variable} go-build-system"
14758 msgstr ""
14759
14760 #. type: defvr
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}."
14763 msgstr ""
14764
14765 #. type: defvr
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."
14768 msgstr ""
14769
14770 #. type: defvr
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."
14773 msgstr ""
14774
14775 #. type: defvr
14776 #: guix-git/doc/guix.texi:7711
14777 #, no-wrap
14778 msgid "{Scheme Variable} glib-or-gtk-build-system"
14779 msgstr ""
14780
14781 #. type: defvr
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+."
14784 msgstr ""
14785
14786 #. type: defvr
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}:"
14789 msgstr ""
14790
14791 #. type: item
14792 #: guix-git/doc/guix.texi:7719 guix-git/doc/guix.texi:8187
14793 #, no-wrap
14794 msgid "glib-or-gtk-wrap"
14795 msgstr ""
14796
14797 #. type: table
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."
14800 msgstr ""
14801
14802 #. type: table
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+."
14805 msgstr ""
14806
14807 #. type: item
14808 #: guix-git/doc/guix.texi:7734 guix-git/doc/guix.texi:8191
14809 #, no-wrap
14810 msgid "glib-or-gtk-compile-schemas"
14811 msgstr ""
14812
14813 #. type: table
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."
14816 msgstr ""
14817
14818 #. type: defvr
14819 #: guix-git/doc/guix.texi:7745
14820 msgid "Both phases are executed after the @code{install} phase."
14821 msgstr ""
14822
14823 #. type: defvr
14824 #: guix-git/doc/guix.texi:7747
14825 #, no-wrap
14826 msgid "{Scheme Variable} guile-build-system"
14827 msgstr ""
14828
14829 #. type: defvr
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."
14832 msgstr ""
14833
14834 #. type: defvr
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}."
14837 msgstr ""
14838
14839 #. type: defvr
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."
14842 msgstr ""
14843
14844 #. type: defvr
14845 #: guix-git/doc/guix.texi:7762
14846 #, no-wrap
14847 msgid "{Scheme Variable} julia-build-system"
14848 msgstr ""
14849
14850 #. type: defvr
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}."
14853 msgstr ""
14854
14855 #. type: defvr
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)."
14858 msgstr ""
14859
14860 #. type: defvr
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}."
14863 msgstr ""
14864
14865 #. type: defvr
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."
14868 msgstr ""
14869
14870 #. type: defvr
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:"
14873 msgstr ""
14874
14875 #. type: lisp
14876 #: guix-git/doc/guix.texi:7798
14877 #, no-wrap
14878 msgid ""
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"
14889 msgstr ""
14890
14891 #. type: defvr
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."
14894 msgstr ""
14895
14896 #. type: defvr
14897 #: guix-git/doc/guix.texi:7808
14898 #, no-wrap
14899 msgid "{Scheme Variable} maven-build-system"
14900 msgstr ""
14901
14902 #. type: defvr
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."
14905 msgstr ""
14906
14907 #. type: defvr
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."
14910 msgstr ""
14911
14912 #. type: defvr
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."
14915 msgstr ""
14916
14917 #. type: defvr
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}."
14920 msgstr ""
14921
14922 #. type: defvr
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."
14925 msgstr ""
14926
14927 #. type: defvr
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}."
14930 msgstr ""
14931
14932 #. type: defvr
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."
14935 msgstr ""
14936
14937 #. type: defvr
14938 #: guix-git/doc/guix.texi:7850
14939 #, no-wrap
14940 msgid "{Scheme Variable} minify-build-system"
14941 msgstr ""
14942
14943 #. type: defvr
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."
14946 msgstr ""
14947
14948 #. type: defvr
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."
14951 msgstr ""
14952
14953 #. type: defvr
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."
14956 msgstr ""
14957
14958 #. type: defvr
14959 #: guix-git/doc/guix.texi:7865
14960 #, no-wrap
14961 msgid "{Scheme Variable} ocaml-build-system"
14962 msgstr ""
14963
14964 #. type: defvr
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."
14967 msgstr ""
14968
14969 #. type: defvr
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."
14972 msgstr ""
14973
14974 #. type: defvr
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."
14977 msgstr ""
14978
14979 #. type: defvr
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."
14982 msgstr ""
14983
14984 #. type: defvr
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."
14987 msgstr ""
14988
14989 #. type: defvr
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."
14992 msgstr ""
14993
14994 #. type: defvr
14995 #: guix-git/doc/guix.texi:7908
14996 #, no-wrap
14997 msgid "{Scheme Variable} python-build-system"
14998 msgstr ""
14999
15000 #. type: defvr
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{}}."
15003 msgstr ""
15004
15005 #. type: defvr
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."
15008 msgstr ""
15009
15010 #. type: defvr
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."
15013 msgstr ""
15014
15015 #. type: defvr
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}."
15018 msgstr ""
15019
15020 #. type: defvr
15021 #: guix-git/doc/guix.texi:7930
15022 #, no-wrap
15023 msgid "{Scheme Variable} perl-build-system"
15024 msgstr ""
15025
15026 #. type: defvr
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."
15029 msgstr ""
15030
15031 #. type: defvr
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."
15034 msgstr ""
15035
15036 #. type: defvr
15037 #: guix-git/doc/guix.texi:7948
15038 msgid "Which Perl package is used can be specified with @code{#:perl}."
15039 msgstr ""
15040
15041 #. type: defvr
15042 #: guix-git/doc/guix.texi:7950
15043 #, no-wrap
15044 msgid "{Scheme Variable} renpy-build-system"
15045 msgstr ""
15046
15047 #. type: defvr
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."
15050 msgstr ""
15051
15052 #. type: defvr
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."
15055 msgstr ""
15056
15057 #. type: defvr
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}."
15060 msgstr ""
15061
15062 #. type: defvr
15063 #: guix-git/doc/guix.texi:7963
15064 #, no-wrap
15065 msgid "{Scheme Variable} qt-build-system"
15066 msgstr ""
15067
15068 #. type: defvr
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."
15071 msgstr ""
15072
15073 #. type: defvr
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}:"
15076 msgstr ""
15077
15078 #. type: item
15079 #: guix-git/doc/guix.texi:7971
15080 #, no-wrap
15081 msgid "check-setup"
15082 msgstr ""
15083
15084 #. type: table
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}."
15087 msgstr ""
15088
15089 #. type: table
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."
15092 msgstr ""
15093
15094 #. type: item
15095 #: guix-git/doc/guix.texi:7982
15096 #, no-wrap
15097 msgid "qt-wrap"
15098 msgstr ""
15099
15100 #. type: table
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."
15103 msgstr ""
15104
15105 #. type: table
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."
15108 msgstr ""
15109
15110 #. type: table
15111 #: guix-git/doc/guix.texi:7996
15112 msgid "This phase is added after the @code{install} phase."
15113 msgstr ""
15114
15115 #. type: defvr
15116 #: guix-git/doc/guix.texi:7999
15117 #, no-wrap
15118 msgid "{Scheme Variable} r-build-system"
15119 msgstr ""
15120
15121 #. type: defvr
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}."
15124 msgstr ""
15125
15126 #. type: defvr
15127 #: guix-git/doc/guix.texi:8009
15128 #, no-wrap
15129 msgid "{Scheme Variable} rakudo-build-system"
15130 msgstr ""
15131
15132 #. type: defvr
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."
15135 msgstr ""
15136
15137 #. type: defvr
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."
15140 msgstr ""
15141
15142 #. type: defvr
15143 #: guix-git/doc/guix.texi:8027
15144 #, no-wrap
15145 msgid "{Scheme Variable} texlive-build-system"
15146 msgstr ""
15147
15148 #. type: defvr
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."
15151 msgstr ""
15152
15153 #. type: defvr
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."
15156 msgstr ""
15157
15158 #. type: defvr
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."
15161 msgstr ""
15162
15163 #. type: defvr
15164 #: guix-git/doc/guix.texi:8046
15165 #, no-wrap
15166 msgid "{Scheme Variable} ruby-build-system"
15167 msgstr ""
15168
15169 #. type: defvr
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}."
15172 msgstr ""
15173
15174 #. type: defvr
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."
15177 msgstr ""
15178
15179 #. type: defvr
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."
15182 msgstr ""
15183
15184 #. type: defvr
15185 #: guix-git/doc/guix.texi:8064
15186 #, no-wrap
15187 msgid "{Scheme Variable} waf-build-system"
15188 msgstr ""
15189
15190 #. type: defvr
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."
15193 msgstr ""
15194
15195 #. type: defvr
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."
15198 msgstr ""
15199
15200 #. type: defvr
15201 #: guix-git/doc/guix.texi:8076
15202 #, no-wrap
15203 msgid "{Scheme Variable} scons-build-system"
15204 msgstr ""
15205
15206 #. type: defvr
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."
15209 msgstr ""
15210
15211 #. type: defvr
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."
15214 msgstr ""
15215
15216 #. type: defvr
15217 #: guix-git/doc/guix.texi:8091
15218 #, no-wrap
15219 msgid "{Scheme Variable} haskell-build-system"
15220 msgstr ""
15221
15222 #. type: defvr
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."
15225 msgstr ""
15226
15227 #. type: defvr
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}."
15230 msgstr ""
15231
15232 #. type: defvr
15233 #: guix-git/doc/guix.texi:8110
15234 #, no-wrap
15235 msgid "{Scheme Variable} dub-build-system"
15236 msgstr ""
15237
15238 #. type: defvr
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."
15241 msgstr ""
15242
15243 #. type: defvr
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}."
15246 msgstr ""
15247
15248 #. type: anchor{#1}
15249 #: guix-git/doc/guix.texi:8121
15250 msgid "emacs-build-system"
15251 msgstr ""
15252
15253 #. type: defvr
15254 #: guix-git/doc/guix.texi:8121
15255 #, no-wrap
15256 msgid "{Scheme Variable} emacs-build-system"
15257 msgstr ""
15258
15259 #. type: defvr
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})."
15262 msgstr ""
15263
15264 #. type: defvr
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}."
15267 msgstr ""
15268
15269 #. type: defvr
15270 #: guix-git/doc/guix.texi:8133
15271 #, no-wrap
15272 msgid "{Scheme Variable} font-build-system"
15273 msgstr ""
15274
15275 #. type: defvr
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."
15278 msgstr ""
15279
15280 #. type: defvr
15281 #: guix-git/doc/guix.texi:8141
15282 #, no-wrap
15283 msgid "{Scheme Variable} meson-build-system"
15284 msgstr ""
15285
15286 #. type: defvr
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."
15289 msgstr ""
15290
15291 #. type: defvr
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."
15294 msgstr ""
15295
15296 #. type: defvr
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:"
15299 msgstr ""
15300
15301 #. type: item
15302 #: guix-git/doc/guix.texi:8157 guix-git/doc/guix.texi:8206
15303 #: guix-git/doc/guix.texi:8274
15304 #, no-wrap
15305 msgid "configure"
15306 msgstr ""
15307
15308 #. type: table
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}."
15311 msgstr ""
15312
15313 #. type: table
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?}."
15316 msgstr ""
15317
15318 #. type: table
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."
15321 msgstr ""
15322
15323 #. type: table
15324 #: guix-git/doc/guix.texi:8173
15325 msgid "The phase runs @code{ninja install} and can not be changed."
15326 msgstr ""
15327
15328 #. type: defvr
15329 #: guix-git/doc/guix.texi:8176
15330 msgid "Apart from that, the build system also adds the following phases:"
15331 msgstr ""
15332
15333 #. type: item
15334 #: guix-git/doc/guix.texi:8179
15335 #, no-wrap
15336 msgid "fix-runpath"
15337 msgstr ""
15338
15339 #. type: table
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."
15342 msgstr ""
15343
15344 #. type: table
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?}."
15347 msgstr ""
15348
15349 #. type: defvr
15350 #: guix-git/doc/guix.texi:8197
15351 #, no-wrap
15352 msgid "{Scheme Variable} linux-module-build-system"
15353 msgstr ""
15354
15355 #. type: defvr
15356 #: guix-git/doc/guix.texi:8199
15357 msgid "@code{linux-module-build-system} allows building Linux kernel modules."
15358 msgstr ""
15359
15360 #. type: defvr
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:"
15363 msgstr ""
15364
15365 #. type: table
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."
15368 msgstr ""
15369
15370 #. type: table
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."
15373 msgstr ""
15374
15375 #. type: table
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."
15378 msgstr ""
15379
15380 #. type: defvr
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)."
15383 msgstr ""
15384
15385 #. type: defvr
15386 #: guix-git/doc/guix.texi:8224
15387 #, no-wrap
15388 msgid "{Scheme Variable} node-build-system"
15389 msgstr ""
15390
15391 #. type: defvr
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."
15394 msgstr ""
15395
15396 #. type: defvr
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}."
15399 msgstr ""
15400
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."
15404 msgstr ""
15405
15406 #. type: defvr
15407 #: guix-git/doc/guix.texi:8240
15408 #, no-wrap
15409 msgid "{Scheme Variable} trivial-build-system"
15410 msgstr ""
15411
15412 #. type: defvr
15413 #: guix-git/doc/guix.texi:8242
15414 msgid "This variable is exported by @code{(guix build-system trivial)}."
15415 msgstr ""
15416
15417 #. type: defvr
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}})."
15420 msgstr ""
15421
15422 #. type: cindex
15423 #: guix-git/doc/guix.texi:8252
15424 #, no-wrap
15425 msgid "build phases, for packages"
15426 msgstr ""
15427
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})."
15431 msgstr ""
15432
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:"
15436 msgstr ""
15437
15438 #. type: item
15439 #: guix-git/doc/guix.texi:8264
15440 #, no-wrap
15441 msgid "unpack"
15442 msgstr ""
15443
15444 #. type: table
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."
15447 msgstr ""
15448
15449 #. type: item
15450 #: guix-git/doc/guix.texi:8269
15451 #, no-wrap
15452 msgid "patch-source-shebangs"
15453 msgstr ""
15454
15455 #. type: table
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}."
15458 msgstr ""
15459
15460 #. type: table
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."
15463 msgstr ""
15464
15465 #. type: table
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}."
15468 msgstr ""
15469
15470 #. type: table
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}."
15473 msgstr ""
15474
15475 #. type: table
15476 #: guix-git/doc/guix.texi:8292
15477 msgid "Run @code{make install} with the flags listed in @code{#:make-flags}."
15478 msgstr ""
15479
15480 #. type: item
15481 #: guix-git/doc/guix.texi:8293
15482 #, no-wrap
15483 msgid "patch-shebangs"
15484 msgstr ""
15485
15486 #. type: table
15487 #: guix-git/doc/guix.texi:8295
15488 msgid "Patch shebangs on the installed executable files."
15489 msgstr ""
15490
15491 #. type: item
15492 #: guix-git/doc/guix.texi:8296
15493 #, no-wrap
15494 msgid "strip"
15495 msgstr ""
15496
15497 #. type: table
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})."
15500 msgstr ""
15501
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})."
15505 msgstr ""
15506
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."
15510 msgstr ""
15511
15512 #. type: vindex
15513 #: guix-git/doc/guix.texi:8317
15514 #, no-wrap
15515 msgid "%standard-phases"
15516 msgstr ""
15517
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!}:"
15521 msgstr ""
15522
15523 #. type: lisp
15524 #: guix-git/doc/guix.texi:8326
15525 #, no-wrap
15526 msgid ""
15527 ";; The build phases of 'gnu-build-system'.\n"
15528 "\n"
15529 msgstr ""
15530
15531 #. type: lisp
15532 #: guix-git/doc/guix.texi:8330
15533 #, no-wrap
15534 msgid ""
15535 "(define* (unpack #:key source #:allow-other-keys)\n"
15536 " ;; Extract the source tarball.\n"
15537 " (invoke \"tar\" \"xvf\" source))\n"
15538 "\n"
15539 msgstr ""
15540
15541 #. type: lisp
15542 #: guix-git/doc/guix.texi:8336
15543 #, no-wrap
15544 msgid ""
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"
15550 "\n"
15551 msgstr ""
15552
15553 #. type: lisp
15554 #: guix-git/doc/guix.texi:8340
15555 #, no-wrap
15556 msgid ""
15557 "(define* (build #:allow-other-keys)\n"
15558 " ;; Compile.\n"
15559 " (invoke \"make\"))\n"
15560 "\n"
15561 msgstr ""
15562
15563 #. type: lisp
15564 #: guix-git/doc/guix.texi:8347
15565 #, no-wrap
15566 msgid ""
15567 "(define* (check #:key (test-target \"check\") (tests? #true)\n"
15568 " #:allow-other-keys)\n"
15569 " ;; Run the test suite.\n"
15570 " (if tests?\n"
15571 " (invoke \"make\" test-target)\n"
15572 " (display \"test suite not run\\n\")))\n"
15573 "\n"
15574 msgstr ""
15575
15576 #. type: lisp
15577 #: guix-git/doc/guix.texi:8351
15578 #, no-wrap
15579 msgid ""
15580 "(define* (install #:allow-other-keys)\n"
15581 " ;; Install files to the prefix 'configure' specified.\n"
15582 " (invoke \"make\" \"install\"))\n"
15583 "\n"
15584 msgstr ""
15585
15586 #. type: lisp
15587 #: guix-git/doc/guix.texi:8360
15588 #, no-wrap
15589 msgid ""
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"
15598 msgstr ""
15599
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."
15603 msgstr ""
15604
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})."
15608 msgstr ""
15609
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."
15613 msgstr ""
15614
15615 #. type: cindex
15616 #: guix-git/doc/guix.texi:8393
15617 #, no-wrap
15618 msgid "build phases, customizing"
15619 msgstr ""
15620
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}})."
15624 msgstr ""
15625
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}:"
15629 msgstr ""
15630
15631 #. type: lisp
15632 #: guix-git/doc/guix.texi:8427
15633 #, no-wrap
15634 msgid ""
15635 "(define-public example\n"
15636 " (package\n"
15637 " (name \"example\")\n"
15638 " ;; other fields omitted\n"
15639 " (build-system gnu-build-system)\n"
15640 " (arguments\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"
15652 " #true))))))))\n"
15653 msgstr ""
15654
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}."
15658 msgstr ""
15659
15660 #. type: cindex
15661 #: guix-git/doc/guix.texi:8434 guix-git/doc/guix.texi:9407
15662 #, no-wrap
15663 msgid "code staging"
15664 msgstr ""
15665
15666 #. type: cindex
15667 #: guix-git/doc/guix.texi:8435 guix-git/doc/guix.texi:9408
15668 #, no-wrap
15669 msgid "staging, of code"
15670 msgstr ""
15671
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."
15675 msgstr ""
15676
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."
15680 msgstr ""
15681
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."
15685 msgstr ""
15686
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}):"
15690 msgstr ""
15691
15692 #. type: lisp
15693 #: guix-git/doc/guix.texi:8468
15694 #, no-wrap
15695 msgid ""
15696 "(with-imported-modules '((guix build utils)) ;import it\n"
15697 " (computed-file \"empty-tree\"\n"
15698 " #~(begin\n"
15699 " ;; Put it in scope.\n"
15700 " (use-modules (guix build utils))\n"
15701 "\n"
15702 msgstr ""
15703
15704 #. type: lisp
15705 #: guix-git/doc/guix.texi:8471
15706 #, no-wrap
15707 msgid ""
15708 " ;; Happily use its 'mkdir-p' procedure.\n"
15709 " (mkdir-p (string-append #$output \"/a/b/c\")))))\n"
15710 msgstr ""
15711
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)}."
15715 msgstr ""
15716
15717 #. type: subsection
15718 #: guix-git/doc/guix.texi:8478
15719 #, no-wrap
15720 msgid "Dealing with Store File Names"
15721 msgstr ""
15722
15723 #. type: Plain text
15724 #: guix-git/doc/guix.texi:8481
15725 msgid "This section documents procedures that deal with store file names."
15726 msgstr ""
15727
15728 #. type: deffn
15729 #: guix-git/doc/guix.texi:8482
15730 #, no-wrap
15731 msgid "{Scheme Procedure} %store-directory"
15732 msgstr ""
15733
15734 #. type: deffn
15735 #: guix-git/doc/guix.texi:8484
15736 msgid "Return the directory name of the store."
15737 msgstr ""
15738
15739 #. type: deffn
15740 #: guix-git/doc/guix.texi:8486
15741 #, no-wrap
15742 msgid "{Scheme Procedure} store-file-name? @var{file}"
15743 msgstr ""
15744
15745 #. type: deffn
15746 #: guix-git/doc/guix.texi:8488
15747 msgid "Return true if @var{file} is in the store."
15748 msgstr ""
15749
15750 #. type: deffn
15751 #: guix-git/doc/guix.texi:8490
15752 #, no-wrap
15753 msgid "{Scheme Procedure} strip-store-file-name @var{file}"
15754 msgstr ""
15755
15756 #. type: deffn
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."
15759 msgstr ""
15760
15761 #. type: deffn
15762 #: guix-git/doc/guix.texi:8495
15763 #, no-wrap
15764 msgid "{Scheme Procedure} package-name->name+version @var{name}"
15765 msgstr ""
15766
15767 #. type: deffn
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."
15770 msgstr ""
15771
15772 #. type: subsection
15773 #: guix-git/doc/guix.texi:8502
15774 #, no-wrap
15775 msgid "File Types"
15776 msgstr ""
15777
15778 #. type: Plain text
15779 #: guix-git/doc/guix.texi:8505
15780 msgid "The procedures below deal with files and file types."
15781 msgstr ""
15782
15783 #. type: deffn
15784 #: guix-git/doc/guix.texi:8506
15785 #, no-wrap
15786 msgid "{Scheme Procedure} directory-exists? @var{dir}"
15787 msgstr ""
15788
15789 #. type: deffn
15790 #: guix-git/doc/guix.texi:8508
15791 msgid "Return @code{#t} if @var{dir} exists and is a directory."
15792 msgstr ""
15793
15794 #. type: deffn
15795 #: guix-git/doc/guix.texi:8510
15796 #, no-wrap
15797 msgid "{Scheme Procedure} executable-file? @var{file}"
15798 msgstr ""
15799
15800 #. type: deffn
15801 #: guix-git/doc/guix.texi:8512
15802 msgid "Return @code{#t} if @var{file} exists and is executable."
15803 msgstr ""
15804
15805 #. type: deffn
15806 #: guix-git/doc/guix.texi:8514
15807 #, no-wrap
15808 msgid "{Scheme Procedure} symbolic-link? @var{file}"
15809 msgstr ""
15810
15811 #. type: deffn
15812 #: guix-git/doc/guix.texi:8516
15813 msgid "Return @code{#t} if @var{file} is a symbolic link (aka. a ``symlink'')."
15814 msgstr ""
15815
15816 #. type: deffn
15817 #: guix-git/doc/guix.texi:8518
15818 #, no-wrap
15819 msgid "{Scheme Procedure} elf-file? @var{file}"
15820 msgstr ""
15821
15822 #. type: deffnx
15823 #: guix-git/doc/guix.texi:8519
15824 #, no-wrap
15825 msgid "{Scheme Procedure} ar-file? @var{file}"
15826 msgstr ""
15827
15828 #. type: deffnx
15829 #: guix-git/doc/guix.texi:8520
15830 #, no-wrap
15831 msgid "{Scheme Procedure} gzip-file? @var{file}"
15832 msgstr ""
15833
15834 #. type: deffn
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."
15837 msgstr ""
15838
15839 #. type: deffn
15840 #: guix-git/doc/guix.texi:8525
15841 #, no-wrap
15842 msgid "{Scheme Procedure} reset-gzip-timestamp @var{file} [#:keep-mtime? #t]"
15843 msgstr ""
15844
15845 #. type: deffn
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."
15848 msgstr ""
15849
15850 #. type: subsection
15851 #: guix-git/doc/guix.texi:8531
15852 #, no-wrap
15853 msgid "File Manipulation"
15854 msgstr ""
15855
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})."
15859 msgstr ""
15860
15861 #. type: deffn
15862 #: guix-git/doc/guix.texi:8539
15863 #, no-wrap
15864 msgid "{Scheme Syntax} with-directory-excursion @var{directory} @var{body}@dots{}"
15865 msgstr ""
15866
15867 #. type: deffn
15868 #: guix-git/doc/guix.texi:8541
15869 msgid "Run @var{body} with @var{directory} as the process's current directory."
15870 msgstr ""
15871
15872 #. type: deffn
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."
15875 msgstr ""
15876
15877 #. type: deffn
15878 #: guix-git/doc/guix.texi:8550
15879 #, no-wrap
15880 msgid "{Scheme Procedure} mkdir-p @var{dir}"
15881 msgstr ""
15882
15883 #. type: deffn
15884 #: guix-git/doc/guix.texi:8552
15885 msgid "Create directory @var{dir} and all its ancestors."
15886 msgstr ""
15887
15888 #. type: deffn
15889 #: guix-git/doc/guix.texi:8554
15890 #, no-wrap
15891 msgid "{Scheme Procedure} install-file @var{file} @var{directory}"
15892 msgstr ""
15893
15894 #. type: deffn
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."
15897 msgstr ""
15898
15899 #. type: deffn
15900 #: guix-git/doc/guix.texi:8559
15901 #, no-wrap
15902 msgid "{Scheme Procedure} make-file-writable @var{file}"
15903 msgstr ""
15904
15905 #. type: deffn
15906 #: guix-git/doc/guix.texi:8561
15907 msgid "Make @var{file} writable for its owner."
15908 msgstr ""
15909
15910 #. type: deffn
15911 #: guix-git/doc/guix.texi:8563
15912 #, no-wrap
15913 msgid "{Scheme Procedure} copy-recursively @var{source} @var{destination} @"
15914 msgstr ""
15915
15916 #. type: deffn
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."
15919 msgstr ""
15920
15921 #. type: deffn
15922 #: guix-git/doc/guix.texi:8572
15923 #, no-wrap
15924 msgid "{Scheme Procedure} delete-file-recursively @var{dir} @"
15925 msgstr ""
15926
15927 #. type: deffn
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."
15930 msgstr ""
15931
15932 #. type: deffn
15933 #: guix-git/doc/guix.texi:8579
15934 #, no-wrap
15935 msgid "{Scheme Syntax} substitute* @var{file} @"
15936 msgstr ""
15937
15938 #. type: deffn
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:"
15941 msgstr ""
15942
15943 #. type: lisp
15944 #: guix-git/doc/guix.texi:8591
15945 #, no-wrap
15946 msgid ""
15947 "(substitute* file\n"
15948 " ((\"hello\")\n"
15949 " \"good morning\\n\")\n"
15950 " ((\"foo([a-z]+)bar(.*)$\" all letters end)\n"
15951 " (string-append \"baz\" letter end)))\n"
15952 msgstr ""
15953
15954 #. type: deffn
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."
15957 msgstr ""
15958
15959 #. type: deffn
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."
15962 msgstr ""
15963
15964 #. type: deffn
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."
15967 msgstr ""
15968
15969 #. type: deffn
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."
15972 msgstr ""
15973
15974 #. type: subsection
15975 #: guix-git/doc/guix.texi:8608
15976 #, no-wrap
15977 msgid "File Search"
15978 msgstr ""
15979
15980 #. type: cindex
15981 #: guix-git/doc/guix.texi:8610
15982 #, no-wrap
15983 msgid "file, searching"
15984 msgstr ""
15985
15986 #. type: Plain text
15987 #: guix-git/doc/guix.texi:8612
15988 msgid "This section documents procedures to search and filter files."
15989 msgstr ""
15990
15991 #. type: deffn
15992 #: guix-git/doc/guix.texi:8613
15993 #, no-wrap
15994 msgid "{Scheme Procedure} file-name-predicate @var{regexp}"
15995 msgstr ""
15996
15997 #. type: deffn
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}."
16000 msgstr ""
16001
16002 #. type: deffn
16003 #: guix-git/doc/guix.texi:8618
16004 #, no-wrap
16005 msgid "{Scheme Procedure} find-files @var{dir} [@var{pred}] @"
16006 msgstr ""
16007
16008 #. type: deffn
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."
16011 msgstr ""
16012
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:"
16016 msgstr ""
16017
16018 #. type: lisp
16019 #: guix-git/doc/guix.texi:8638
16020 #, no-wrap
16021 msgid ""
16022 ";; List all the regular files in the current directory.\n"
16023 "(find-files \".\")\n"
16024 "@result{} (\"./.dir-locals.el\" \"./.gitignore\" @dots{})\n"
16025 "\n"
16026 msgstr ""
16027
16028 #. type: lisp
16029 #: guix-git/doc/guix.texi:8642
16030 #, no-wrap
16031 msgid ""
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"
16035 "\n"
16036 msgstr ""
16037
16038 #. type: lisp
16039 #: guix-git/doc/guix.texi:8646
16040 #, no-wrap
16041 msgid ""
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"
16045 msgstr ""
16046
16047 #. type: deffn
16048 #: guix-git/doc/guix.texi:8648
16049 #, no-wrap
16050 msgid "{Scheme Procedure} which @var{program}"
16051 msgstr ""
16052
16053 #. type: deffn
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."
16056 msgstr ""
16057
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})."
16061 msgstr ""
16062
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."
16066 msgstr ""
16067
16068 #. type: cindex
16069 #: guix-git/doc/guix.texi:8667
16070 #, no-wrap
16071 msgid "build phases, modifying"
16072 msgstr ""
16073
16074 #. type: deffn
16075 #: guix-git/doc/guix.texi:8668
16076 #, no-wrap
16077 msgid "{Scheme Syntax} modify-phases @var{phases} @var{clause}@dots{}"
16078 msgstr ""
16079
16080 #. type: deffn
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:"
16083 msgstr ""
16084
16085 #. type: lisp
16086 #: guix-git/doc/guix.texi:8677
16087 #, no-wrap
16088 msgid ""
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"
16093 msgstr ""
16094
16095 #. type: deffn
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."
16098 msgstr ""
16099
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:"
16103 msgstr ""
16104
16105 #. type: lisp
16106 #: guix-git/doc/guix.texi:8706
16107 #, no-wrap
16108 msgid ""
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"
16120 " #t))))\n"
16121 msgstr ""
16122
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:"
16126 msgstr ""
16127
16128 #. type: lisp
16129 #: guix-git/doc/guix.texi:8726
16130 #, no-wrap
16131 msgid ""
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"
16139 " \"/bin\")))\n"
16140 " (install-file \"footswitch\" bin)\n"
16141 " (install-file \"scythe\" bin)\n"
16142 " #t))))\n"
16143 msgstr ""
16144
16145 #. type: cindex
16146 #: guix-git/doc/guix.texi:8734
16147 #, no-wrap
16148 msgid "store items"
16149 msgstr ""
16150
16151 #. type: cindex
16152 #: guix-git/doc/guix.texi:8735
16153 #, no-wrap
16154 msgid "store paths"
16155 msgstr ""
16156
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}."
16160 msgstr ""
16161
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."
16165 msgstr ""
16166
16167 #. type: quotation
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})."
16170 msgstr ""
16171
16172 #. type: quotation
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."
16175 msgstr ""
16176
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."
16180 msgstr ""
16181
16182 #. type: defvr
16183 #: guix-git/doc/guix.texi:8768
16184 #, no-wrap
16185 msgid "{Environment Variable} GUIX_DAEMON_SOCKET"
16186 msgstr ""
16187
16188 #. type: defvr
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:"
16191 msgstr ""
16192
16193 #. type: code{#1}
16194 #: guix-git/doc/guix.texi:8775 guix-git/doc/guix.texi:24475
16195 #, no-wrap
16196 msgid "file"
16197 msgstr ""
16198
16199 #. type: itemx
16200 #: guix-git/doc/guix.texi:8776
16201 #, no-wrap
16202 msgid "unix"
16203 msgstr ""
16204
16205 #. type: table
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}."
16208 msgstr ""
16209
16210 #. type: item
16211 #: guix-git/doc/guix.texi:8781
16212 #, no-wrap
16213 msgid "guix"
16214 msgstr ""
16215
16216 #. type: table
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):"
16219 msgstr ""
16220
16221 #. type: example
16222 #: guix-git/doc/guix.texi:8792
16223 #, no-wrap
16224 msgid "guix://master.guix.example.org:1234\n"
16225 msgstr ""
16226
16227 #. type: table
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}."
16230 msgstr ""
16231
16232 #. type: table
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}})."
16235 msgstr ""
16236
16237 #. type: item
16238 #: guix-git/doc/guix.texi:8802
16239 #, no-wrap
16240 msgid "ssh"
16241 msgstr ""
16242
16243 #. type: cindex
16244 #: guix-git/doc/guix.texi:8803
16245 #, no-wrap
16246 msgid "SSH access to build daemons"
16247 msgstr ""
16248
16249 #. type: table
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:"
16252 msgstr ""
16253
16254 #. type: example
16255 #: guix-git/doc/guix.texi:8812
16256 #, no-wrap
16257 msgid "ssh://charlie@@guix.example.org:22\n"
16258 msgstr ""
16259
16260 #. type: table
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})."
16263 msgstr ""
16264
16265 #. type: defvr
16266 #: guix-git/doc/guix.texi:8819
16267 msgid "Additional URI schemes may be supported in the future."
16268 msgstr ""
16269
16270 #. type: quotation
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})."
16273 msgstr ""
16274
16275 #. type: deffn
16276 #: guix-git/doc/guix.texi:8829
16277 #, no-wrap
16278 msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]"
16279 msgstr ""
16280
16281 #. type: deffn
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."
16284 msgstr ""
16285
16286 #. type: deffn
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}."
16289 msgstr ""
16290
16291 #. type: deffn
16292 #: guix-git/doc/guix.texi:8839
16293 #, no-wrap
16294 msgid "{Scheme Procedure} close-connection @var{server}"
16295 msgstr ""
16296
16297 #. type: deffn
16298 #: guix-git/doc/guix.texi:8841
16299 msgid "Close the connection to @var{server}."
16300 msgstr ""
16301
16302 #. type: defvr
16303 #: guix-git/doc/guix.texi:8843
16304 #, no-wrap
16305 msgid "{Scheme Variable} current-build-output-port"
16306 msgstr ""
16307
16308 #. type: defvr
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."
16311 msgstr ""
16312
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."
16316 msgstr ""
16317
16318 #. type: deffn
16319 #: guix-git/doc/guix.texi:8851
16320 #, no-wrap
16321 msgid "{Scheme Procedure} valid-path? @var{server} @var{path}"
16322 msgstr ""
16323
16324 #. type: cindex
16325 #: guix-git/doc/guix.texi:8852
16326 #, no-wrap
16327 msgid "invalid store items"
16328 msgstr ""
16329
16330 #. type: deffn
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)."
16333 msgstr ""
16334
16335 #. type: deffn
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})."
16338 msgstr ""
16339
16340 #. type: deffn
16341 #: guix-git/doc/guix.texi:8862
16342 #, no-wrap
16343 msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]"
16344 msgstr ""
16345
16346 #. type: deffn
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."
16349 msgstr ""
16350
16351 #. type: deffn
16352 #: guix-git/doc/guix.texi:8868
16353 #, no-wrap
16354 msgid "{Scheme Procedure} build-derivations @var{store} @var{derivations} @"
16355 msgstr ""
16356
16357 #. type: deffn
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."
16360 msgstr ""
16361
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})."
16365 msgstr ""
16366
16367 #. type: i{#1}
16368 #: guix-git/doc/guix.texi:8882
16369 msgid "This section is currently incomplete."
16370 msgstr ""
16371
16372 #. type: cindex
16373 #: guix-git/doc/guix.texi:8886
16374 #, no-wrap
16375 msgid "derivations"
16376 msgstr ""
16377
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:"
16381 msgstr ""
16382
16383 #. type: itemize
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."
16386 msgstr ""
16387
16388 #. type: cindex
16389 #: guix-git/doc/guix.texi:8897
16390 #, no-wrap
16391 msgid "build-time dependencies"
16392 msgstr ""
16393
16394 #. type: cindex
16395 #: guix-git/doc/guix.texi:8898
16396 #, no-wrap
16397 msgid "dependencies, build-time"
16398 msgstr ""
16399
16400 #. type: itemize
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.)."
16403 msgstr ""
16404
16405 #. type: itemize
16406 #: guix-git/doc/guix.texi:8905
16407 msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}."
16408 msgstr ""
16409
16410 #. type: itemize
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."
16413 msgstr ""
16414
16415 #. type: itemize
16416 #: guix-git/doc/guix.texi:8912
16417 msgid "A list of environment variables to be defined."
16418 msgstr ""
16419
16420 #. type: cindex
16421 #: guix-git/doc/guix.texi:8915
16422 #, no-wrap
16423 msgid "derivation path"
16424 msgstr ""
16425
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})."
16429 msgstr ""
16430
16431 #. type: cindex
16432 #: guix-git/doc/guix.texi:8924
16433 #, no-wrap
16434 msgid "fixed-output derivations"
16435 msgstr ""
16436
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."
16440 msgstr ""
16441
16442 #. type: item
16443 #: guix-git/doc/guix.texi:8932 guix-git/doc/guix.texi:12392
16444 #, no-wrap
16445 msgid "references"
16446 msgstr ""
16447
16448 #. type: cindex
16449 #: guix-git/doc/guix.texi:8933
16450 #, no-wrap
16451 msgid "run-time dependencies"
16452 msgstr ""
16453
16454 #. type: cindex
16455 #: guix-git/doc/guix.texi:8934
16456 #, no-wrap
16457 msgid "dependencies, run-time"
16458 msgstr ""
16459
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."
16463 msgstr ""
16464
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:"
16468 msgstr ""
16469
16470 #. type: deffn
16471 #: guix-git/doc/guix.texi:8947
16472 #, no-wrap
16473 msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @"
16474 msgstr ""
16475
16476 #. type: deffn
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."
16479 msgstr ""
16480
16481 #. type: deffn
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."
16484 msgstr ""
16485
16486 #. type: deffn
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."
16489 msgstr ""
16490
16491 #. type: deffn
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."
16494 msgstr ""
16495
16496 #. type: deffn
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."
16499 msgstr ""
16500
16501 #. type: deffn
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."
16504 msgstr ""
16505
16506 #. type: deffn
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."
16509 msgstr ""
16510
16511 #. type: deffn
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."
16514 msgstr ""
16515
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:"
16519 msgstr ""
16520
16521 #. type: lisp
16522 #: guix-git/doc/guix.texi:9004
16523 #, no-wrap
16524 msgid ""
16525 "(use-modules (guix utils)\n"
16526 " (guix store)\n"
16527 " (guix derivations))\n"
16528 "\n"
16529 msgstr ""
16530
16531 #. type: lisp
16532 #: guix-git/doc/guix.texi:9013
16533 #, no-wrap
16534 msgid ""
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"
16543 msgstr ""
16544
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}."
16548 msgstr ""
16549
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}."
16553 msgstr ""
16554
16555 #. type: deffn
16556 #: guix-git/doc/guix.texi:9026
16557 #, no-wrap
16558 msgid "{Scheme Procedure} build-expression->derivation @var{store} @"
16559 msgstr ""
16560
16561 #. type: deffn
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))}."
16564 msgstr ""
16565
16566 #. type: deffn
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."
16569 msgstr ""
16570
16571 #. type: deffn
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."
16574 msgstr ""
16575
16576 #. type: deffn
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?}."
16579 msgstr ""
16580
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:"
16584 msgstr ""
16585
16586 #. type: lisp
16587 #: guix-git/doc/guix.texi:9072
16588 #, no-wrap
16589 msgid ""
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"
16593 " (lambda (p)\n"
16594 " (display '(hello guix) p))))))\n"
16595 " (build-expression->derivation store \"goo\" builder))\n"
16596 "\n"
16597 msgstr ""
16598
16599 #. type: lisp
16600 #: guix-git/doc/guix.texi:9074
16601 #, no-wrap
16602 msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n"
16603 msgstr ""
16604
16605 #. type: cindex
16606 #: guix-git/doc/guix.texi:9080
16607 #, no-wrap
16608 msgid "monad"
16609 msgstr ""
16610
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."
16614 msgstr ""
16615
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."
16619 msgstr ""
16620
16621 #. type: cindex
16622 #: guix-git/doc/guix.texi:9093
16623 #, no-wrap
16624 msgid "monadic values"
16625 msgstr ""
16626
16627 #. type: cindex
16628 #: guix-git/doc/guix.texi:9094
16629 #, no-wrap
16630 msgid "monadic functions"
16631 msgstr ""
16632
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}."
16636 msgstr ""
16637
16638 #. type: Plain text
16639 #: guix-git/doc/guix.texi:9106
16640 msgid "Consider this ``normal'' procedure:"
16641 msgstr ""
16642
16643 #. type: lisp
16644 #: guix-git/doc/guix.texi:9115
16645 #, no-wrap
16646 msgid ""
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"
16654 msgstr ""
16655
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:"
16659 msgstr ""
16660
16661 #. type: lisp
16662 #: guix-git/doc/guix.texi:9127
16663 #, no-wrap
16664 msgid ""
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"
16670 " #$output))))\n"
16671 msgstr ""
16672
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}."
16676 msgstr ""
16677
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}):"
16681 msgstr ""
16682
16683 #. type: lisp
16684 #: guix-git/doc/guix.texi:9144
16685 #, no-wrap
16686 msgid ""
16687 "(define (sh-symlink)\n"
16688 " (gexp->derivation \"sh\"\n"
16689 " #~(symlink (string-append #$bash \"/bin/bash\")\n"
16690 " #$output)))\n"
16691 msgstr ""
16692
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}:"
16696 msgstr ""
16697
16698 #. type: lisp
16699 #: guix-git/doc/guix.texi:9157
16700 #, no-wrap
16701 msgid ""
16702 "(run-with-store (open-connection) (sh-symlink))\n"
16703 "@result{} /gnu/store/...-sh-symlink\n"
16704 msgstr ""
16705
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:"
16709 msgstr ""
16710
16711 #. type: example
16712 #: guix-git/doc/guix.texi:9167
16713 #, no-wrap
16714 msgid ""
16715 "scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n"
16716 "$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n"
16717 msgstr ""
16718
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:"
16722 msgstr ""
16723
16724 #. type: example
16725 #: guix-git/doc/guix.texi:9180
16726 #, no-wrap
16727 msgid ""
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"
16735 msgstr ""
16736
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."
16740 msgstr ""
16741
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."
16745 msgstr ""
16746
16747 #. type: deffn
16748 #: guix-git/doc/guix.texi:9189
16749 #, no-wrap
16750 msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..."
16751 msgstr ""
16752
16753 #. type: deffn
16754 #: guix-git/doc/guix.texi:9192
16755 msgid "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in @var{monad}."
16756 msgstr ""
16757
16758 #. type: deffn
16759 #: guix-git/doc/guix.texi:9194
16760 #, no-wrap
16761 msgid "{Scheme Syntax} return @var{val}"
16762 msgstr ""
16763
16764 #. type: deffn
16765 #: guix-git/doc/guix.texi:9196
16766 msgid "Return a monadic value that encapsulates @var{val}."
16767 msgstr ""
16768
16769 #. type: deffn
16770 #: guix-git/doc/guix.texi:9198
16771 #, no-wrap
16772 msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..."
16773 msgstr ""
16774
16775 #. type: deffn
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:"
16778 msgstr ""
16779
16780 #. type: lisp
16781 #: guix-git/doc/guix.texi:9213
16782 #, no-wrap
16783 msgid ""
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"
16789 " 'some-state)\n"
16790 "\n"
16791 msgstr ""
16792
16793 #. type: lisp
16794 #: guix-git/doc/guix.texi:9216
16795 #, no-wrap
16796 msgid ""
16797 "@result{} 4\n"
16798 "@result{} some-state\n"
16799 msgstr ""
16800
16801 #. type: deffn
16802 #: guix-git/doc/guix.texi:9219
16803 #, no-wrap
16804 msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @"
16805 msgstr ""
16806
16807 #. type: deffn
16808 #: guix-git/doc/guix.texi:9221
16809 msgid "@var{body} ..."
16810 msgstr ""
16811
16812 #. type: deffnx
16813 #: guix-git/doc/guix.texi:9221
16814 #, no-wrap
16815 msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @"
16816 msgstr ""
16817
16818 #. type: deffn
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}."
16821 msgstr ""
16822
16823 #. type: deffn
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})."
16826 msgstr ""
16827
16828 #. type: deffn
16829 #: guix-git/doc/guix.texi:9238
16830 #, no-wrap
16831 msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..."
16832 msgstr ""
16833
16834 #. type: deffn
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."
16837 msgstr ""
16838
16839 #. type: deffn
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."
16842 msgstr ""
16843
16844 #. type: deffn
16845 #: guix-git/doc/guix.texi:9248
16846 #, no-wrap
16847 msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..."
16848 msgstr ""
16849
16850 #. type: deffn
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."
16853 msgstr ""
16854
16855 #. type: deffn
16856 #: guix-git/doc/guix.texi:9255
16857 #, no-wrap
16858 msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..."
16859 msgstr ""
16860
16861 #. type: deffn
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."
16864 msgstr ""
16865
16866 #. type: cindex
16867 #: guix-git/doc/guix.texi:9262
16868 #, no-wrap
16869 msgid "state monad"
16870 msgstr ""
16871
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."
16875 msgstr ""
16876
16877 #. type: defvr
16878 #: guix-git/doc/guix.texi:9267
16879 #, no-wrap
16880 msgid "{Scheme Variable} %state-monad"
16881 msgstr ""
16882
16883 #. type: defvr
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."
16886 msgstr ""
16887
16888 #. type: defvr
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:"
16891 msgstr ""
16892
16893 #. type: lisp
16894 #: guix-git/doc/guix.texi:9281
16895 #, no-wrap
16896 msgid ""
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"
16902 "\n"
16903 msgstr ""
16904
16905 #. type: lisp
16906 #: guix-git/doc/guix.texi:9285
16907 #, no-wrap
16908 msgid ""
16909 "(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n"
16910 "@result{} (0 1 4)\n"
16911 "@result{} 3\n"
16912 msgstr ""
16913
16914 #. type: defvr
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."
16917 msgstr ""
16918
16919 #. type: deffn
16920 #: guix-git/doc/guix.texi:9291
16921 #, no-wrap
16922 msgid "{Monadic Procedure} current-state"
16923 msgstr ""
16924
16925 #. type: deffn
16926 #: guix-git/doc/guix.texi:9293
16927 msgid "Return the current state as a monadic value."
16928 msgstr ""
16929
16930 #. type: deffn
16931 #: guix-git/doc/guix.texi:9295
16932 #, no-wrap
16933 msgid "{Monadic Procedure} set-current-state @var{value}"
16934 msgstr ""
16935
16936 #. type: deffn
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."
16939 msgstr ""
16940
16941 #. type: deffn
16942 #: guix-git/doc/guix.texi:9300
16943 #, no-wrap
16944 msgid "{Monadic Procedure} state-push @var{value}"
16945 msgstr ""
16946
16947 #. type: deffn
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."
16950 msgstr ""
16951
16952 #. type: deffn
16953 #: guix-git/doc/guix.texi:9305
16954 #, no-wrap
16955 msgid "{Monadic Procedure} state-pop"
16956 msgstr ""
16957
16958 #. type: deffn
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."
16961 msgstr ""
16962
16963 #. type: deffn
16964 #: guix-git/doc/guix.texi:9310
16965 #, no-wrap
16966 msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]"
16967 msgstr ""
16968
16969 #. type: deffn
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."
16972 msgstr ""
16973
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."
16977 msgstr ""
16978
16979 #. type: defvr
16980 #: guix-git/doc/guix.texi:9318
16981 #, no-wrap
16982 msgid "{Scheme Variable} %store-monad"
16983 msgstr ""
16984
16985 #. type: defvr
16986 #: guix-git/doc/guix.texi:9320
16987 msgid "The store monad---an alias for @code{%state-monad}."
16988 msgstr ""
16989
16990 #. type: defvr
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)."
16993 msgstr ""
16994
16995 #. type: deffn
16996 #: guix-git/doc/guix.texi:9326
16997 #, no-wrap
16998 msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]"
16999 msgstr ""
17000
17001 #. type: deffn
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."
17004 msgstr ""
17005
17006 #. type: deffn
17007 #: guix-git/doc/guix.texi:9331
17008 #, no-wrap
17009 msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]"
17010 msgstr ""
17011
17012 #. type: deffn
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."
17015 msgstr ""
17016
17017 #. type: deffn
17018 #: guix-git/doc/guix.texi:9337
17019 #, no-wrap
17020 msgid "{Monadic Procedure} binary-file @var{name} @var{data} [@var{references}]"
17021 msgstr ""
17022
17023 #. type: deffn
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."
17026 msgstr ""
17027
17028 #. type: deffn
17029 #: guix-git/doc/guix.texi:9343
17030 #, no-wrap
17031 msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @"
17032 msgstr ""
17033
17034 #. type: deffn
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."
17037 msgstr ""
17038
17039 #. type: deffn
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."
17042 msgstr ""
17043
17044 #. type: deffn
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."
17047 msgstr ""
17048
17049 #. type: deffn
17050 #: guix-git/doc/guix.texi:9359
17051 msgid "The example below adds a file to the store, under two different names:"
17052 msgstr ""
17053
17054 #. type: lisp
17055 #: guix-git/doc/guix.texi:9365
17056 #, no-wrap
17057 msgid ""
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"
17062 "\n"
17063 msgstr ""
17064
17065 #. type: lisp
17066 #: guix-git/doc/guix.texi:9367
17067 #, no-wrap
17068 msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n"
17069 msgstr ""
17070
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:"
17074 msgstr ""
17075
17076 #. type: deffn
17077 #: guix-git/doc/guix.texi:9374
17078 #, no-wrap
17079 msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @"
17080 msgstr ""
17081
17082 #. type: deffn
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."
17085 msgstr ""
17086
17087 #. type: deffn
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."
17090 msgstr ""
17091
17092 #. type: deffn
17093 #: guix-git/doc/guix.texi:9388
17094 #, no-wrap
17095 msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]"
17096 msgstr ""
17097
17098 #. type: deffnx
17099 #: guix-git/doc/guix.texi:9389
17100 #, no-wrap
17101 msgid "{Monadic Procedure} package->cross-derivation @var{package} @"
17102 msgstr ""
17103
17104 #. type: deffn
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})."
17107 msgstr ""
17108
17109 #. type: cindex
17110 #: guix-git/doc/guix.texi:9399
17111 #, no-wrap
17112 msgid "G-expression"
17113 msgstr ""
17114
17115 #. type: cindex
17116 #: guix-git/doc/guix.texi:9400
17117 #, no-wrap
17118 msgid "build code quoting"
17119 msgstr ""
17120
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})."
17124 msgstr ""
17125
17126 #. type: cindex
17127 #: guix-git/doc/guix.texi:9409
17128 #, no-wrap
17129 msgid "strata of code"
17130 msgstr ""
17131
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})."
17135 msgstr ""
17136
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."
17140 msgstr ""
17141
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:"
17145 msgstr ""
17146
17147 #. type: itemize
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."
17150 msgstr ""
17151
17152 #. type: itemize
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."
17155 msgstr ""
17156
17157 #. type: itemize
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."
17160 msgstr ""
17161
17162 #. type: cindex
17163 #: guix-git/doc/guix.texi:9454 guix-git/doc/guix.texi:10011
17164 #, no-wrap
17165 msgid "lowering, of high-level objects in gexps"
17166 msgstr ""
17167
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)."
17171 msgstr ""
17172
17173 #. type: Plain text
17174 #: guix-git/doc/guix.texi:9466
17175 msgid "To illustrate the idea, here is an example of a gexp:"
17176 msgstr ""
17177
17178 #. type: lisp
17179 #: guix-git/doc/guix.texi:9474
17180 #, no-wrap
17181 msgid ""
17182 "(define build-exp\n"
17183 " #~(begin\n"
17184 " (mkdir #$output)\n"
17185 " (chdir #$output)\n"
17186 " (symlink (string-append #$coreutils \"/bin/ls\")\n"
17187 " \"list-files\")))\n"
17188 msgstr ""
17189
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}:"
17193 msgstr ""
17194
17195 #. type: lisp
17196 #: guix-git/doc/guix.texi:9482
17197 #, no-wrap
17198 msgid "(gexp->derivation \"the-thing\" build-exp)\n"
17199 msgstr ""
17200
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."
17204 msgstr ""
17205
17206 #. type: cindex
17207 #: guix-git/doc/guix.texi:9491
17208 #, no-wrap
17209 msgid "cross compilation"
17210 msgstr ""
17211
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:"
17215 msgstr ""
17216
17217 #. type: lisp
17218 #: guix-git/doc/guix.texi:9508
17219 #, no-wrap
17220 msgid ""
17221 "(gexp->derivation \"vi\"\n"
17222 " #~(begin\n"
17223 " (mkdir #$output)\n"
17224 " (mkdir (string-append #$output \"/bin\"))\n"
17225 " (system* (string-append #+coreutils \"/bin/ln\")\n"
17226 " \"-s\"\n"
17227 " (string-append #$emacs \"/bin/emacs\")\n"
17228 " (string-append #$output \"/bin/vi\")))\n"
17229 " #:target \"aarch64-linux-gnu\")\n"
17230 msgstr ""
17231
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."
17235 msgstr ""
17236
17237 #. type: cindex
17238 #: guix-git/doc/guix.texi:9515
17239 #, no-wrap
17240 msgid "imported modules, for gexps"
17241 msgstr ""
17242
17243 #. type: findex
17244 #: guix-git/doc/guix.texi:9516
17245 #, no-wrap
17246 msgid "with-imported-modules"
17247 msgstr ""
17248
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:"
17252 msgstr ""
17253
17254 #. type: lisp
17255 #: guix-git/doc/guix.texi:9532
17256 #, no-wrap
17257 msgid ""
17258 "(let ((build (with-imported-modules '((guix build utils))\n"
17259 " #~(begin\n"
17260 " (use-modules (guix build utils))\n"
17261 " (mkdir-p (string-append #$output \"/bin\"))))))\n"
17262 " (gexp->derivation \"empty-dir\"\n"
17263 " #~(begin\n"
17264 " #$build\n"
17265 " (display \"success!\\n\")\n"
17266 " #t)))\n"
17267 msgstr ""
17268
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."
17272 msgstr ""
17273
17274 #. type: cindex
17275 #: guix-git/doc/guix.texi:9539
17276 #, no-wrap
17277 msgid "module closure"
17278 msgstr ""
17279
17280 #. type: findex
17281 #: guix-git/doc/guix.texi:9540
17282 #, no-wrap
17283 msgid "source-module-closure"
17284 msgstr ""
17285
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:"
17289 msgstr ""
17290
17291 #. type: lisp
17292 #: guix-git/doc/guix.texi:9550
17293 #, no-wrap
17294 msgid ""
17295 "(use-modules (guix modules)) ;for 'source-module-closure'\n"
17296 "\n"
17297 msgstr ""
17298
17299 #. type: lisp
17300 #: guix-git/doc/guix.texi:9559
17301 #, no-wrap
17302 msgid ""
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"
17307 " #~(begin\n"
17308 " (use-modules (guix build utils)\n"
17309 " (gnu build vm))\n"
17310 " @dots{})))\n"
17311 msgstr ""
17312
17313 #. type: cindex
17314 #: guix-git/doc/guix.texi:9561
17315 #, no-wrap
17316 msgid "extensions, for gexps"
17317 msgstr ""
17318
17319 #. type: findex
17320 #: guix-git/doc/guix.texi:9562
17321 #, no-wrap
17322 msgid "with-extensions"
17323 msgstr ""
17324
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:"
17328 msgstr ""
17329
17330 #. type: lisp
17331 #: guix-git/doc/guix.texi:9570
17332 #, no-wrap
17333 msgid ""
17334 "(use-modules (gnu packages guile)) ;for 'guile-json'\n"
17335 "\n"
17336 msgstr ""
17337
17338 #. type: lisp
17339 #: guix-git/doc/guix.texi:9576
17340 #, no-wrap
17341 msgid ""
17342 "(with-extensions (list guile-json)\n"
17343 " (gexp->derivation \"something-with-json\"\n"
17344 " #~(begin\n"
17345 " (use-modules (json))\n"
17346 " @dots{})))\n"
17347 msgstr ""
17348
17349 #. type: Plain text
17350 #: guix-git/doc/guix.texi:9579
17351 msgid "The syntactic form to construct gexps is summarized below."
17352 msgstr ""
17353
17354 #. type: deffn
17355 #: guix-git/doc/guix.texi:9580
17356 #, no-wrap
17357 msgid "{Scheme Syntax} #~@var{exp}"
17358 msgstr ""
17359
17360 #. type: deffnx
17361 #: guix-git/doc/guix.texi:9581
17362 #, no-wrap
17363 msgid "{Scheme Syntax} (gexp @var{exp})"
17364 msgstr ""
17365
17366 #. type: deffn
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:"
17369 msgstr ""
17370
17371 #. type: item
17372 #: guix-git/doc/guix.texi:9586
17373 #, no-wrap
17374 msgid "#$@var{obj}"
17375 msgstr ""
17376
17377 #. type: itemx
17378 #: guix-git/doc/guix.texi:9587
17379 #, no-wrap
17380 msgid "(ungexp @var{obj})"
17381 msgstr ""
17382
17383 #. type: table
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}."
17386 msgstr ""
17387
17388 #. type: table
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."
17391 msgstr ""
17392
17393 #. type: table
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."
17396 msgstr ""
17397
17398 #. type: table
17399 #: guix-git/doc/guix.texi:9600
17400 msgid "If @var{obj} is another kind of object, it is inserted as is."
17401 msgstr ""
17402
17403 #. type: item
17404 #: guix-git/doc/guix.texi:9601
17405 #, no-wrap
17406 msgid "#$@var{obj}:@var{output}"
17407 msgstr ""
17408
17409 #. type: itemx
17410 #: guix-git/doc/guix.texi:9602
17411 #, no-wrap
17412 msgid "(ungexp @var{obj} @var{output})"
17413 msgstr ""
17414
17415 #. type: table
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})."
17418 msgstr ""
17419
17420 #. type: item
17421 #: guix-git/doc/guix.texi:9607
17422 #, no-wrap
17423 msgid "#+@var{obj}"
17424 msgstr ""
17425
17426 #. type: itemx
17427 #: guix-git/doc/guix.texi:9608
17428 #, no-wrap
17429 msgid "#+@var{obj}:output"
17430 msgstr ""
17431
17432 #. type: itemx
17433 #: guix-git/doc/guix.texi:9609
17434 #, no-wrap
17435 msgid "(ungexp-native @var{obj})"
17436 msgstr ""
17437
17438 #. type: itemx
17439 #: guix-git/doc/guix.texi:9610
17440 #, no-wrap
17441 msgid "(ungexp-native @var{obj} @var{output})"
17442 msgstr ""
17443
17444 #. type: table
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."
17447 msgstr ""
17448
17449 #. type: item
17450 #: guix-git/doc/guix.texi:9614
17451 #, no-wrap
17452 msgid "#$output[:@var{output}]"
17453 msgstr ""
17454
17455 #. type: itemx
17456 #: guix-git/doc/guix.texi:9615
17457 #, no-wrap
17458 msgid "(ungexp output [@var{output}])"
17459 msgstr ""
17460
17461 #. type: table
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."
17464 msgstr ""
17465
17466 #. type: table
17467 #: guix-git/doc/guix.texi:9620
17468 msgid "This only makes sense for gexps passed to @code{gexp->derivation}."
17469 msgstr ""
17470
17471 #. type: item
17472 #: guix-git/doc/guix.texi:9621
17473 #, no-wrap
17474 msgid "#$@@@var{lst}"
17475 msgstr ""
17476
17477 #. type: itemx
17478 #: guix-git/doc/guix.texi:9622
17479 #, no-wrap
17480 msgid "(ungexp-splicing @var{lst})"
17481 msgstr ""
17482
17483 #. type: table
17484 #: guix-git/doc/guix.texi:9625
17485 msgid "Like the above, but splices the contents of @var{lst} inside the containing list."
17486 msgstr ""
17487
17488 #. type: item
17489 #: guix-git/doc/guix.texi:9626
17490 #, no-wrap
17491 msgid "#+@@@var{lst}"
17492 msgstr ""
17493
17494 #. type: itemx
17495 #: guix-git/doc/guix.texi:9627
17496 #, no-wrap
17497 msgid "(ungexp-native-splicing @var{lst})"
17498 msgstr ""
17499
17500 #. type: table
17501 #: guix-git/doc/guix.texi:9630
17502 msgid "Like the above, but refers to native builds of the objects listed in @var{lst}."
17503 msgstr ""
17504
17505 #. type: deffn
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)."
17508 msgstr ""
17509
17510 #. type: deffn
17511 #: guix-git/doc/guix.texi:9637
17512 #, no-wrap
17513 msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}"
17514 msgstr ""
17515
17516 #. type: deffn
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."
17519 msgstr ""
17520
17521 #. type: deffn
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:"
17524 msgstr ""
17525
17526 #. type: lisp
17527 #: guix-git/doc/guix.texi:9650
17528 #, no-wrap
17529 msgid ""
17530 "`((guix build utils)\n"
17531 " (guix gcrypt)\n"
17532 " ((guix config) => ,(scheme-file \"config.scm\"\n"
17533 " #~(define-module @dots{}))))\n"
17534 msgstr ""
17535
17536 #. type: deffn
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."
17539 msgstr ""
17540
17541 #. type: deffn
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{}."
17544 msgstr ""
17545
17546 #. type: deffn
17547 #: guix-git/doc/guix.texi:9661
17548 #, no-wrap
17549 msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}"
17550 msgstr ""
17551
17552 #. type: deffn
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."
17555 msgstr ""
17556
17557 #. type: deffn
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{}."
17560 msgstr ""
17561
17562 #. type: deffn
17563 #: guix-git/doc/guix.texi:9673
17564 #, no-wrap
17565 msgid "{Scheme Procedure} gexp? @var{obj}"
17566 msgstr ""
17567
17568 #. type: deffn
17569 #: guix-git/doc/guix.texi:9675
17570 msgid "Return @code{#t} if @var{obj} is a G-expression."
17571 msgstr ""
17572
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)."
17576 msgstr ""
17577
17578 #. type: deffn
17579 #: guix-git/doc/guix.texi:9682
17580 #, no-wrap
17581 msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @"
17582 msgstr ""
17583
17584 #. type: deffn
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}."
17587 msgstr ""
17588
17589 #. type: deffn
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))}."
17592 msgstr ""
17593
17594 #. type: deffn
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\"}."
17597 msgstr ""
17598
17599 #. type: deffn
17600 #: guix-git/doc/guix.texi:9714
17601 msgid "@var{graft?} determines whether packages referred to by @var{exp} should be grafted when applicable."
17602 msgstr ""
17603
17604 #. type: deffn
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:"
17607 msgstr ""
17608
17609 #. type: example
17610 #: guix-git/doc/guix.texi:9724
17611 #, no-wrap
17612 msgid ""
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"
17618 msgstr ""
17619
17620 #. type: deffn
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."
17623 msgstr ""
17624
17625 #. type: deffn
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."
17628 msgstr ""
17629
17630 #. type: deffn
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}."
17633 msgstr ""
17634
17635 #. type: deffn
17636 #: guix-git/doc/guix.texi:9741
17637 msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})."
17638 msgstr ""
17639
17640 #. type: cindex
17641 #: guix-git/doc/guix.texi:9743
17642 #, no-wrap
17643 msgid "file-like objects"
17644 msgstr ""
17645
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:"
17649 msgstr ""
17650
17651 #. type: lisp
17652 #: guix-git/doc/guix.texi:9752
17653 #, no-wrap
17654 msgid ""
17655 "#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n"
17656 " #$(local-file \"/tmp/my-nscd.conf\"))\n"
17657 msgstr ""
17658
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."
17662 msgstr ""
17663
17664 #. type: deffn
17665 #: guix-git/doc/guix.texi:9762
17666 #, no-wrap
17667 msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @"
17668 msgstr ""
17669
17670 #. type: deffn
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}."
17673 msgstr ""
17674
17675 #. type: deffn
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}})."
17678 msgstr ""
17679
17680 #. type: deffn
17681 #: guix-git/doc/guix.texi:9785
17682 #, no-wrap
17683 msgid "{Scheme Procedure} plain-file @var{name} @var{content}"
17684 msgstr ""
17685
17686 #. type: deffn
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."
17689 msgstr ""
17690
17691 #. type: deffn
17692 #: guix-git/doc/guix.texi:9790
17693 msgid "This is the declarative counterpart of @code{text-file}."
17694 msgstr ""
17695
17696 #. type: deffn
17697 #: guix-git/doc/guix.texi:9792
17698 #, no-wrap
17699 msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @"
17700 msgstr ""
17701
17702 #. type: deffn
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}."
17705 msgstr ""
17706
17707 #. type: deffn
17708 #: guix-git/doc/guix.texi:9801
17709 msgid "This is the declarative counterpart of @code{gexp->derivation}."
17710 msgstr ""
17711
17712 #. type: deffn
17713 #: guix-git/doc/guix.texi:9803
17714 #, no-wrap
17715 msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @"
17716 msgstr ""
17717
17718 #. type: deffn
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}."
17721 msgstr ""
17722
17723 #. type: deffn
17724 #: guix-git/doc/guix.texi:9812
17725 msgid "The example below builds a script that simply invokes the @command{ls} command:"
17726 msgstr ""
17727
17728 #. type: lisp
17729 #: guix-git/doc/guix.texi:9815
17730 #, no-wrap
17731 msgid ""
17732 "(use-modules (guix gexp) (gnu packages base))\n"
17733 "\n"
17734 msgstr ""
17735
17736 #. type: lisp
17737 #: guix-git/doc/guix.texi:9819
17738 #, no-wrap
17739 msgid ""
17740 "(gexp->script \"list-files\"\n"
17741 " #~(execl #$(file-append coreutils \"/bin/ls\")\n"
17742 " \"ls\"))\n"
17743 msgstr ""
17744
17745 #. type: deffn
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:"
17748 msgstr ""
17749
17750 #. type: example
17751 #: guix-git/doc/guix.texi:9829
17752 #, no-wrap
17753 msgid ""
17754 "#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n"
17755 "!#\n"
17756 "(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n"
17757 msgstr ""
17758
17759 #. type: deffn
17760 #: guix-git/doc/guix.texi:9832
17761 #, no-wrap
17762 msgid "{Scheme Procedure} program-file @var{name} @var{exp} @"
17763 msgstr ""
17764
17765 #. type: deffn
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}."
17768 msgstr ""
17769
17770 #. type: deffn
17771 #: guix-git/doc/guix.texi:9839
17772 msgid "This is the declarative counterpart of @code{gexp->script}."
17773 msgstr ""
17774
17775 #. type: deffn
17776 #: guix-git/doc/guix.texi:9841
17777 #, no-wrap
17778 msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @"
17779 msgstr ""
17780
17781 #. type: deffn
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."
17784 msgstr ""
17785
17786 #. type: deffn
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}."
17789 msgstr ""
17790
17791 #. type: deffn
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."
17794 msgstr ""
17795
17796 #. type: deffn
17797 #: guix-git/doc/guix.texi:9858
17798 #, no-wrap
17799 msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} @"
17800 msgstr ""
17801
17802 #. type: deffn
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}."
17805 msgstr ""
17806
17807 #. type: deffn
17808 #: guix-git/doc/guix.texi:9864
17809 msgid "This is the declarative counterpart of @code{gexp->file}."
17810 msgstr ""
17811
17812 #. type: deffn
17813 #: guix-git/doc/guix.texi:9866
17814 #, no-wrap
17815 msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}"
17816 msgstr ""
17817
17818 #. type: deffn
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."
17821 msgstr ""
17822
17823 #. type: deffn
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:"
17826 msgstr ""
17827
17828 #. type: lisp
17829 #: guix-git/doc/guix.texi:9885
17830 #, no-wrap
17831 msgid ""
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"
17838 msgstr ""
17839
17840 #. type: deffn
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."
17843 msgstr ""
17844
17845 #. type: deffn
17846 #: guix-git/doc/guix.texi:9892
17847 #, no-wrap
17848 msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}"
17849 msgstr ""
17850
17851 #. type: deffn
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:"
17854 msgstr ""
17855
17856 #. type: lisp
17857 #: guix-git/doc/guix.texi:9900
17858 #, no-wrap
17859 msgid ""
17860 "(mixed-text-file \"profile\"\n"
17861 " \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n"
17862 msgstr ""
17863
17864 #. type: deffn
17865 #: guix-git/doc/guix.texi:9903
17866 msgid "This is the declarative counterpart of @code{text-file*}."
17867 msgstr ""
17868
17869 #. type: deffn
17870 #: guix-git/doc/guix.texi:9905
17871 #, no-wrap
17872 msgid "{Scheme Procedure} file-union @var{name} @var{files}"
17873 msgstr ""
17874
17875 #. type: deffn
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:"
17878 msgstr ""
17879
17880 #. type: lisp
17881 #: guix-git/doc/guix.texi:9917
17882 #, no-wrap
17883 msgid ""
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"
17889 msgstr ""
17890
17891 #. type: deffn
17892 #: guix-git/doc/guix.texi:9920
17893 msgid "This yields an @code{etc} directory containing these two files."
17894 msgstr ""
17895
17896 #. type: deffn
17897 #: guix-git/doc/guix.texi:9922
17898 #, no-wrap
17899 msgid "{Scheme Procedure} directory-union @var{name} @var{things}"
17900 msgstr ""
17901
17902 #. type: deffn
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:"
17905 msgstr ""
17906
17907 #. type: lisp
17908 #: guix-git/doc/guix.texi:9928
17909 #, no-wrap
17910 msgid "(directory-union \"guile+emacs\" (list guile emacs))\n"
17911 msgstr ""
17912
17913 #. type: deffn
17914 #: guix-git/doc/guix.texi:9931
17915 msgid "yields a directory that is the union of the @code{guile} and @code{emacs} packages."
17916 msgstr ""
17917
17918 #. type: deffn
17919 #: guix-git/doc/guix.texi:9933
17920 #, no-wrap
17921 msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}"
17922 msgstr ""
17923
17924 #. type: deffn
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."
17927 msgstr ""
17928
17929 #. type: deffn
17930 #: guix-git/doc/guix.texi:9939
17931 msgid "As an example, consider this gexp:"
17932 msgstr ""
17933
17934 #. type: lisp
17935 #: guix-git/doc/guix.texi:9944
17936 #, no-wrap
17937 msgid ""
17938 "(gexp->script \"run-uname\"\n"
17939 " #~(system* #$(file-append coreutils\n"
17940 " \"/bin/uname\")))\n"
17941 msgstr ""
17942
17943 #. type: deffn
17944 #: guix-git/doc/guix.texi:9947
17945 msgid "The same effect could be achieved with:"
17946 msgstr ""
17947
17948 #. type: lisp
17949 #: guix-git/doc/guix.texi:9952
17950 #, no-wrap
17951 msgid ""
17952 "(gexp->script \"run-uname\"\n"
17953 " #~(system* (string-append #$coreutils\n"
17954 " \"/bin/uname\")))\n"
17955 msgstr ""
17956
17957 #. type: deffn
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}."
17960 msgstr ""
17961
17962 #. type: deffn
17963 #: guix-git/doc/guix.texi:9960
17964 #, no-wrap
17965 msgid "{Scheme Syntax} let-system @var{system} @var{body}@dots{}"
17966 msgstr ""
17967
17968 #. type: deffnx
17969 #: guix-git/doc/guix.texi:9961
17970 #, no-wrap
17971 msgid "{Scheme Syntax} let-system (@var{system} @var{target}) @var{body}@dots{}"
17972 msgstr ""
17973
17974 #. type: deffn
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}."
17977 msgstr ""
17978
17979 #. type: deffn
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."
17982 msgstr ""
17983
17984 #. type: deffn
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:"
17987 msgstr ""
17988
17989 #. type: lisp
17990 #: guix-git/doc/guix.texi:9983
17991 #, no-wrap
17992 msgid ""
17993 "#~(system*\n"
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"
17999 " (else\n"
18000 " (error \"dunno!\"))))\n"
18001 " \"-net\" \"user\" #$image)\n"
18002 msgstr ""
18003
18004 #. type: deffn
18005 #: guix-git/doc/guix.texi:9986
18006 #, no-wrap
18007 msgid "{Scheme Syntax} with-parameters ((@var{parameter} @var{value}) @dots{}) @var{exp}"
18008 msgstr ""
18009
18010 #. type: deffn
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."
18013 msgstr ""
18014
18015 #. type: deffn
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:"
18018 msgstr ""
18019
18020 #. type: lisp
18021 #: guix-git/doc/guix.texi:9999
18022 #, no-wrap
18023 msgid ""
18024 "(with-parameters ((%current-system \"i686-linux\"))\n"
18025 " coreutils)\n"
18026 msgstr ""
18027
18028 #. type: deffn
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}."
18031 msgstr ""
18032
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."
18036 msgstr ""
18037
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."
18041 msgstr ""
18042
18043 #. type: deffn
18044 #: guix-git/doc/guix.texi:10017
18045 #, no-wrap
18046 msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @"
18047 msgstr ""
18048
18049 #. type: deffn
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>}."
18052 msgstr ""
18053
18054 #. type: section
18055 #: guix-git/doc/guix.texi:10026
18056 #, no-wrap
18057 msgid "Invoking @command{guix repl}"
18058 msgstr ""
18059
18060 #. type: cindex
18061 #: guix-git/doc/guix.texi:10028
18062 #, no-wrap
18063 msgid "REPL, read-eval-print loop, script"
18064 msgstr ""
18065
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."
18069 msgstr ""
18070
18071 #. type: example
18072 #: guix-git/doc/guix.texi:10043
18073 #, no-wrap
18074 msgid "guix repl @var{options} [@var{file} @var{args}]\n"
18075 msgstr ""
18076
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:"
18080 msgstr ""
18081
18082 #. type: example
18083 #: guix-git/doc/guix.texi:10050
18084 #, no-wrap
18085 msgid "guix repl my-script.scm\n"
18086 msgstr ""
18087
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:"
18091 msgstr ""
18092
18093 #. type: example
18094 #: guix-git/doc/guix.texi:10057
18095 #, no-wrap
18096 msgid "guix repl -- my-script.scm --input=foo.txt\n"
18097 msgstr ""
18098
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:"
18102 msgstr ""
18103
18104 #. type: example
18105 #: guix-git/doc/guix.texi:10066
18106 #, no-wrap
18107 msgid ""
18108 "@code{#!/usr/bin/env -S guix repl --}\n"
18109 "@code{!#}\n"
18110 msgstr ""
18111
18112 #. type: Plain text
18113 #: guix-git/doc/guix.texi:10069
18114 msgid "Without a file name argument, a Guile REPL is started:"
18115 msgstr ""
18116
18117 #. type: example
18118 #: guix-git/doc/guix.texi:10075
18119 #, no-wrap
18120 msgid ""
18121 "$ guix repl\n"
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"
18125 msgstr ""
18126
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."
18130 msgstr ""
18131
18132 #. type: Plain text
18133 #: guix-git/doc/guix.texi:10084
18134 msgid "The available options are as follows:"
18135 msgstr ""
18136
18137 #. type: item
18138 #: guix-git/doc/guix.texi:10086 guix-git/doc/guix.texi:12448
18139 #, no-wrap
18140 msgid "--type=@var{type}"
18141 msgstr ""
18142
18143 #. type: itemx
18144 #: guix-git/doc/guix.texi:10087 guix-git/doc/guix.texi:12449
18145 #: guix-git/doc/guix.texi:33138
18146 #, no-wrap
18147 msgid "-t @var{type}"
18148 msgstr ""
18149
18150 #. type: table
18151 #: guix-git/doc/guix.texi:10089
18152 msgid "Start a REPL of the given @var{TYPE}, which can be one of the following:"
18153 msgstr ""
18154
18155 #. type: item
18156 #: guix-git/doc/guix.texi:10091
18157 #, no-wrap
18158 msgid "guile"
18159 msgstr ""
18160
18161 #. type: table
18162 #: guix-git/doc/guix.texi:10093
18163 msgid "This is default, and it spawns a standard full-featured Guile REPL."
18164 msgstr ""
18165
18166 #. type: item
18167 #: guix-git/doc/guix.texi:10093
18168 #, no-wrap
18169 msgid "machine"
18170 msgstr ""
18171
18172 #. type: table
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."
18175 msgstr ""
18176
18177 #. type: table
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:"
18180 msgstr ""
18181
18182 #. type: item
18183 #: guix-git/doc/guix.texi:10104
18184 #, no-wrap
18185 msgid "--listen=tcp:37146"
18186 msgstr ""
18187
18188 #. type: table
18189 #: guix-git/doc/guix.texi:10106
18190 msgid "Accept connections on localhost on port 37146."
18191 msgstr ""
18192
18193 #. type: item
18194 #: guix-git/doc/guix.texi:10107
18195 #, no-wrap
18196 msgid "--listen=unix:/tmp/socket"
18197 msgstr ""
18198
18199 #. type: table
18200 #: guix-git/doc/guix.texi:10109
18201 msgid "Accept connections on the Unix-domain socket @file{/tmp/socket}."
18202 msgstr ""
18203
18204 #. type: item
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
18208 #, no-wrap
18209 msgid "--load-path=@var{directory}"
18210 msgstr ""
18211
18212 #. type: itemx
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
18216 #, no-wrap
18217 msgid "-L @var{directory}"
18218 msgstr ""
18219
18220 #. type: table
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})."
18225 msgstr ""
18226
18227 #. type: table
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."
18230 msgstr ""
18231
18232 #. type: itemx
18233 #: guix-git/doc/guix.texi:10119 guix-git/doc/guix.texi:10678
18234 #, no-wrap
18235 msgid "-q"
18236 msgstr ""
18237
18238 #. type: table
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."
18241 msgstr ""
18242
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."
18246 msgstr ""
18247
18248 #. type: cindex
18249 #: guix-git/doc/guix.texi:10154
18250 #, no-wrap
18251 msgid "package building"
18252 msgstr ""
18253
18254 #. type: command{#1}
18255 #: guix-git/doc/guix.texi:10155
18256 #, no-wrap
18257 msgid "guix build"
18258 msgstr ""
18259
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."
18263 msgstr ""
18264
18265 #. type: example
18266 #: guix-git/doc/guix.texi:10166
18267 #, no-wrap
18268 msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n"
18269 msgstr ""
18270
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:"
18274 msgstr ""
18275
18276 #. type: example
18277 #: guix-git/doc/guix.texi:10174
18278 #, no-wrap
18279 msgid "guix build emacs guile\n"
18280 msgstr ""
18281
18282 #. type: Plain text
18283 #: guix-git/doc/guix.texi:10177
18284 msgid "Similarly, the following command builds all the available packages:"
18285 msgstr ""
18286
18287 #. type: example
18288 #: guix-git/doc/guix.texi:10181
18289 #, no-wrap
18290 msgid ""
18291 "guix build --quiet --keep-going \\\n"
18292 " $(guix package -A | cut -f1,2 --output-delimiter=@@)\n"
18293 msgstr ""
18294
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})."
18298 msgstr ""
18299
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."
18303 msgstr ""
18304
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."
18308 msgstr ""
18309
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:"
18313 msgstr ""
18314
18315 #. type: table
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."
18320 msgstr ""
18321
18322 #. type: item
18323 #: guix-git/doc/guix.texi:10223
18324 #, no-wrap
18325 msgid "--keep-failed"
18326 msgstr ""
18327
18328 #. type: itemx
18329 #: guix-git/doc/guix.texi:10224
18330 #, no-wrap
18331 msgid "-K"
18332 msgstr ""
18333
18334 #. type: table
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."
18337 msgstr ""
18338
18339 #. type: table
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})."
18342 msgstr ""
18343
18344 #. type: item
18345 #: guix-git/doc/guix.texi:10235
18346 #, no-wrap
18347 msgid "--keep-going"
18348 msgstr ""
18349
18350 #. type: itemx
18351 #: guix-git/doc/guix.texi:10236
18352 #, no-wrap
18353 msgid "-k"
18354 msgstr ""
18355
18356 #. type: table
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."
18359 msgstr ""
18360
18361 #. type: table
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."
18364 msgstr ""
18365
18366 #. type: table
18367 #: guix-git/doc/guix.texi:10246
18368 msgid "Do not build the derivations."
18369 msgstr ""
18370
18371 #. type: anchor{#1}
18372 #: guix-git/doc/guix.texi:10248
18373 msgid "fallback-option"
18374 msgstr ""
18375
18376 #. type: item
18377 #: guix-git/doc/guix.texi:10248
18378 #, no-wrap
18379 msgid "--fallback"
18380 msgstr ""
18381
18382 #. type: table
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})."
18385 msgstr ""
18386
18387 #. type: anchor{#1}
18388 #: guix-git/doc/guix.texi:10257
18389 msgid "client-substitute-urls"
18390 msgstr ""
18391
18392 #. type: table
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})."
18395 msgstr ""
18396
18397 #. type: table
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})."
18400 msgstr ""
18401
18402 #. type: table
18403 #: guix-git/doc/guix.texi:10264
18404 msgid "When @var{urls} is the empty string, substitutes are effectively disabled."
18405 msgstr ""
18406
18407 #. type: item
18408 #: guix-git/doc/guix.texi:10270
18409 #, no-wrap
18410 msgid "--no-grafts"
18411 msgstr ""
18412
18413 #. type: table
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."
18416 msgstr ""
18417
18418 #. type: item
18419 #: guix-git/doc/guix.texi:10275
18420 #, no-wrap
18421 msgid "--rounds=@var{n}"
18422 msgstr ""
18423
18424 #. type: table
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."
18427 msgstr ""
18428
18429 #. type: table
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."
18432 msgstr ""
18433
18434 #. type: table
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}})."
18437 msgstr ""
18438
18439 #. type: table
18440 #: guix-git/doc/guix.texi:10306
18441 msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @option{--timeout}})."
18442 msgstr ""
18443
18444 #. type: cindex
18445 #: guix-git/doc/guix.texi:10309
18446 #, no-wrap
18447 msgid "verbosity, of the command-line tools"
18448 msgstr ""
18449
18450 #. type: cindex
18451 #: guix-git/doc/guix.texi:10310
18452 #, no-wrap
18453 msgid "build logs, verbosity"
18454 msgstr ""
18455
18456 #. type: item
18457 #: guix-git/doc/guix.texi:10311
18458 #, no-wrap
18459 msgid "-v @var{level}"
18460 msgstr ""
18461
18462 #. type: itemx
18463 #: guix-git/doc/guix.texi:10312
18464 #, no-wrap
18465 msgid "--verbosity=@var{level}"
18466 msgstr ""
18467
18468 #. type: table
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."
18471 msgstr ""
18472
18473 #. type: table
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."
18476 msgstr ""
18477
18478 #. type: table
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."
18481 msgstr ""
18482
18483 #. type: item
18484 #: guix-git/doc/guix.texi:10329
18485 #, no-wrap
18486 msgid "--debug=@var{level}"
18487 msgstr ""
18488
18489 #. type: table
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."
18492 msgstr ""
18493
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."
18497 msgstr ""
18498
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."
18502 msgstr ""
18503
18504 #. type: defvr
18505 #: guix-git/doc/guix.texi:10345
18506 #, no-wrap
18507 msgid "{Environment Variable} GUIX_BUILD_OPTIONS"
18508 msgstr ""
18509
18510 #. type: defvr
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:"
18513 msgstr ""
18514
18515 #. type: example
18516 #: guix-git/doc/guix.texi:10353
18517 #, no-wrap
18518 msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n"
18519 msgstr ""
18520
18521 #. type: defvr
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."
18524 msgstr ""
18525
18526 #. type: cindex
18527 #: guix-git/doc/guix.texi:10363
18528 #, no-wrap
18529 msgid "package variants"
18530 msgstr ""
18531
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})."
18535 msgstr ""
18536
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."
18540 msgstr ""
18541
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)."
18545 msgstr ""
18546
18547 #. type: item
18548 #: guix-git/doc/guix.texi:10383
18549 #, no-wrap
18550 msgid "--with-source=@var{source}"
18551 msgstr ""
18552
18553 #. type: itemx
18554 #: guix-git/doc/guix.texi:10384
18555 #, no-wrap
18556 msgid "--with-source=@var{package}=@var{source}"
18557 msgstr ""
18558
18559 #. type: itemx
18560 #: guix-git/doc/guix.texi:10385
18561 #, no-wrap
18562 msgid "--with-source=@var{package}@@@var{version}=@var{source}"
18563 msgstr ""
18564
18565 #. type: table
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})."
18568 msgstr ""
18569
18570 #. type: table
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}."
18573 msgstr ""
18574
18575 #. type: table
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}."
18578 msgstr ""
18579
18580 #. type: table
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:"
18583 msgstr ""
18584
18585 #. type: example
18586 #: guix-git/doc/guix.texi:10407
18587 #, no-wrap
18588 msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n"
18589 msgstr ""
18590
18591 #. type: table
18592 #: guix-git/doc/guix.texi:10411
18593 msgid "As a developer, @option{--with-source} makes it easy to test release candidates:"
18594 msgstr ""
18595
18596 #. type: example
18597 #: guix-git/doc/guix.texi:10414
18598 #, no-wrap
18599 msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n"
18600 msgstr ""
18601
18602 #. type: table
18603 #: guix-git/doc/guix.texi:10417
18604 msgid "@dots{} or to build from a checkout in a pristine environment:"
18605 msgstr ""
18606
18607 #. type: example
18608 #: guix-git/doc/guix.texi:10421
18609 #, no-wrap
18610 msgid ""
18611 "$ git clone git://git.sv.gnu.org/guix.git\n"
18612 "$ guix build guix --with-source=guix@@1.0=./guix\n"
18613 msgstr ""
18614
18615 #. type: item
18616 #: guix-git/doc/guix.texi:10423
18617 #, no-wrap
18618 msgid "--with-input=@var{package}=@var{replacement}"
18619 msgstr ""
18620
18621 #. type: table
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}."
18624 msgstr ""
18625
18626 #. type: table
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}:"
18629 msgstr ""
18630
18631 #. type: example
18632 #: guix-git/doc/guix.texi:10435
18633 #, no-wrap
18634 msgid "guix build --with-input=guile=guile@@2.0 guix\n"
18635 msgstr ""
18636
18637 #. type: table
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}."
18640 msgstr ""
18641
18642 #. type: table
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}})."
18645 msgstr ""
18646
18647 #. type: item
18648 #: guix-git/doc/guix.texi:10444
18649 #, no-wrap
18650 msgid "--with-graft=@var{package}=@var{replacement}"
18651 msgstr ""
18652
18653 #. type: table
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."
18656 msgstr ""
18657
18658 #. type: table
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:"
18661 msgstr ""
18662
18663 #. type: example
18664 #: guix-git/doc/guix.texi:10457
18665 #, no-wrap
18666 msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n"
18667 msgstr ""
18668
18669 #. type: table
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!"
18672 msgstr ""
18673
18674 #. type: cindex
18675 #: guix-git/doc/guix.texi:10467 guix-git/doc/guix.texi:34481
18676 #, no-wrap
18677 msgid "debugging info, rebuilding"
18678 msgstr ""
18679
18680 #. type: item
18681 #: guix-git/doc/guix.texi:10468
18682 #, no-wrap
18683 msgid "--with-debug-info=@var{package}"
18684 msgstr ""
18685
18686 #. type: table
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})."
18689 msgstr ""
18690
18691 #. type: table
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:"
18694 msgstr ""
18695
18696 #. type: example
18697 #: guix-git/doc/guix.texi:10482 guix-git/doc/guix.texi:34512
18698 #, no-wrap
18699 msgid "guix install inkscape --with-debug-info=glib\n"
18700 msgstr ""
18701
18702 #. type: table
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."
18705 msgstr ""
18706
18707 #. type: quotation
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."
18710 msgstr ""
18711
18712 #. type: quotation
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."
18715 msgstr ""
18716
18717 #. type: cindex
18718 #: guix-git/doc/guix.texi:10498
18719 #, no-wrap
18720 msgid "tool chain, changing the build tool chain of a package"
18721 msgstr ""
18722
18723 #. type: item
18724 #: guix-git/doc/guix.texi:10499
18725 #, no-wrap
18726 msgid "--with-c-toolchain=@var{package}=@var{toolchain}"
18727 msgstr ""
18728
18729 #. type: table
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++."
18732 msgstr ""
18733
18734 #. type: example
18735 #: guix-git/doc/guix.texi:10510
18736 #, no-wrap
18737 msgid ""
18738 "guix build octave-cli \\\n"
18739 " --with-c-toolchain=fftw=gcc-toolchain@@10 \\\n"
18740 " --with-c-toolchain=fftwf=gcc-toolchain@@10\n"
18741 msgstr ""
18742
18743 #. type: table
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}."
18746 msgstr ""
18747
18748 #. type: table
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:"
18751 msgstr ""
18752
18753 #. type: example
18754 #: guix-git/doc/guix.texi:10525
18755 #, no-wrap
18756 msgid ""
18757 "guix build --with-c-toolchain=hwloc=clang-toolchain \\\n"
18758 " intel-mpi-benchmarks\n"
18759 msgstr ""
18760
18761 #. type: quotation
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."
18764 msgstr ""
18765
18766 #. type: item
18767 #: guix-git/doc/guix.texi:10536
18768 #, no-wrap
18769 msgid "--with-git-url=@var{package}=@var{url}"
18770 msgstr ""
18771
18772 #. type: cindex
18773 #: guix-git/doc/guix.texi:10537
18774 #, no-wrap
18775 msgid "Git, using the latest commit"
18776 msgstr ""
18777
18778 #. type: cindex
18779 #: guix-git/doc/guix.texi:10538
18780 #, no-wrap
18781 msgid "latest commit, building"
18782 msgstr ""
18783
18784 #. type: table
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."
18787 msgstr ""
18788
18789 #. type: table
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:"
18792 msgstr ""
18793
18794 #. type: example
18795 #: guix-git/doc/guix.texi:10549
18796 #, no-wrap
18797 msgid ""
18798 "guix build python-numpy \\\n"
18799 " --with-git-url=python=https://github.com/python/cpython\n"
18800 msgstr ""
18801
18802 #. type: table
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)."
18805 msgstr ""
18806
18807 #. type: cindex
18808 #: guix-git/doc/guix.texi:10554 guix-git/doc/guix.texi:27180
18809 #, no-wrap
18810 msgid "continuous integration"
18811 msgstr ""
18812
18813 #. type: table
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)."
18816 msgstr ""
18817
18818 #. type: table
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."
18821 msgstr ""
18822
18823 #. type: item
18824 #: guix-git/doc/guix.texi:10565
18825 #, no-wrap
18826 msgid "--with-branch=@var{package}=@var{branch}"
18827 msgstr ""
18828
18829 #. type: table
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."
18832 msgstr ""
18833
18834 #. type: table
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:"
18837 msgstr ""
18838
18839 #. type: example
18840 #: guix-git/doc/guix.texi:10579
18841 #, no-wrap
18842 msgid "guix build --with-branch=guile-sqlite3=master cuirass\n"
18843 msgstr ""
18844
18845 #. type: item
18846 #: guix-git/doc/guix.texi:10581
18847 #, no-wrap
18848 msgid "--with-commit=@var{package}=@var{commit}"
18849 msgstr ""
18850
18851 #. type: table
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."
18854 msgstr ""
18855
18856 #. type: item
18857 #: guix-git/doc/guix.texi:10586
18858 #, no-wrap
18859 msgid "--with-patch=@var{package}=@var{file}"
18860 msgstr ""
18861
18862 #. type: table
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})."
18865 msgstr ""
18866
18867 #. type: table
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:"
18870 msgstr ""
18871
18872 #. type: example
18873 #: guix-git/doc/guix.texi:10599
18874 #, no-wrap
18875 msgid "guix build coreutils --with-patch=glibc=./glibc-frob.patch\n"
18876 msgstr ""
18877
18878 #. type: table
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."
18881 msgstr ""
18882
18883 #. type: cindex
18884 #: guix-git/doc/guix.texi:10604
18885 #, no-wrap
18886 msgid "upstream, latest version"
18887 msgstr ""
18888
18889 #. type: item
18890 #: guix-git/doc/guix.texi:10605
18891 #, no-wrap
18892 msgid "--with-latest=@var{package}"
18893 msgstr ""
18894
18895 #. type: table
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})."
18898 msgstr ""
18899
18900 #. type: table
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."
18903 msgstr ""
18904
18905 #. type: table
18906 #: guix-git/doc/guix.texi:10617
18907 msgid "As an example, the command below builds Guix against the latest version of Guile-JSON:"
18908 msgstr ""
18909
18910 #. type: example
18911 #: guix-git/doc/guix.texi:10620
18912 #, no-wrap
18913 msgid "guix build guix --with-latest=guile-json\n"
18914 msgstr ""
18915
18916 #. type: table
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."
18919 msgstr ""
18920
18921 #. type: table
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})."
18924 msgstr ""
18925
18926 #. type: cindex
18927 #: guix-git/doc/guix.texi:10635
18928 #, no-wrap
18929 msgid "test suite, skipping"
18930 msgstr ""
18931
18932 #. type: item
18933 #: guix-git/doc/guix.texi:10636
18934 #, no-wrap
18935 msgid "--without-tests=@var{package}"
18936 msgstr ""
18937
18938 #. type: table
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."
18941 msgstr ""
18942
18943 #. type: table
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:"
18946 msgstr ""
18947
18948 #. type: example
18949 #: guix-git/doc/guix.texi:10649
18950 #, no-wrap
18951 msgid "guix install --without-tests=python python-notebook\n"
18952 msgstr ""
18953
18954 #. type: table
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."
18957 msgstr ""
18958
18959 #. type: table
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."
18962 msgstr ""
18963
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."
18967 msgstr ""
18968
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}."
18972 msgstr ""
18973
18974 #. type: item
18975 #: guix-git/doc/guix.texi:10677
18976 #, no-wrap
18977 msgid "--quiet"
18978 msgstr ""
18979
18980 #. type: table
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."
18983 msgstr ""
18984
18985 #. type: item
18986 #: guix-git/doc/guix.texi:10683
18987 #, no-wrap
18988 msgid "--file=@var{file}"
18989 msgstr ""
18990
18991 #. type: table
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})."
18994 msgstr ""
18995
18996 #. type: table
18997 #: guix-git/doc/guix.texi:10690
18998 msgid "As an example, @var{file} might contain a package definition like this (@pxref{Defining Packages}):"
18999 msgstr ""
19000
19001 #. type: table
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}:"
19004 msgstr ""
19005
19006 #. type: item
19007 #: guix-git/doc/guix.texi:10704
19008 #, no-wrap
19009 msgid "--manifest=@var{manifest}"
19010 msgstr ""
19011
19012 #. type: itemx
19013 #: guix-git/doc/guix.texi:10705
19014 #, no-wrap
19015 msgid "-m @var{manifest}"
19016 msgstr ""
19017
19018 #. type: table
19019 #: guix-git/doc/guix.texi:10708
19020 msgid "Build all packages listed in the given @var{manifest} (@pxref{profile-manifest, @option{--manifest}})."
19021 msgstr ""
19022
19023 #. type: table
19024 #: guix-git/doc/guix.texi:10712
19025 msgid "Build the package or derivation @var{expr} evaluates to."
19026 msgstr ""
19027
19028 #. type: table
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."
19031 msgstr ""
19032
19033 #. type: table
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})."
19036 msgstr ""
19037
19038 #. type: table
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}."
19041 msgstr ""
19042
19043 #. type: item
19044 #: guix-git/doc/guix.texi:10725
19045 #, no-wrap
19046 msgid "--source"
19047 msgstr ""
19048
19049 #. type: itemx
19050 #: guix-git/doc/guix.texi:10726
19051 #, no-wrap
19052 msgid "-S"
19053 msgstr ""
19054
19055 #. type: table
19056 #: guix-git/doc/guix.texi:10729
19057 msgid "Build the source derivations of the packages, rather than the packages themselves."
19058 msgstr ""
19059
19060 #. type: table
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."
19063 msgstr ""
19064
19065 #. type: table
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})."
19068 msgstr ""
19069
19070 #. type: cindex
19071 #: guix-git/doc/guix.texi:10738
19072 #, no-wrap
19073 msgid "source, verification"
19074 msgstr ""
19075
19076 #. type: table
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."
19079 msgstr ""
19080
19081 #. type: table
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."
19084 msgstr ""
19085
19086 #. type: item
19087 #: guix-git/doc/guix.texi:10750
19088 #, no-wrap
19089 msgid "--sources"
19090 msgstr ""
19091
19092 #. type: table
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:"
19095 msgstr ""
19096
19097 #. type: item
19098 #: guix-git/doc/guix.texi:10759 guix-git/doc/guix.texi:12303
19099 #, no-wrap
19100 msgid "package"
19101 msgstr ""
19102
19103 #. type: table
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."
19106 msgstr ""
19107
19108 #. type: item
19109 #: guix-git/doc/guix.texi:10763 guix-git/doc/guix.texi:18249
19110 #, no-wrap
19111 msgid "all"
19112 msgstr ""
19113
19114 #. type: table
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."
19117 msgstr ""
19118
19119 #. type: example
19120 #: guix-git/doc/guix.texi:10772
19121 #, no-wrap
19122 msgid ""
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"
19127 msgstr ""
19128
19129 #. type: item
19130 #: guix-git/doc/guix.texi:10774
19131 #, no-wrap
19132 msgid "transitive"
19133 msgstr ""
19134
19135 #. type: table
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."
19138 msgstr ""
19139
19140 #. type: example
19141 #: guix-git/doc/guix.texi:10789
19142 #, no-wrap
19143 msgid ""
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"
19152 "@dots{}\n"
19153 msgstr ""
19154
19155 #. type: table
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."
19158 msgstr ""
19159
19160 #. type: quotation
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."
19163 msgstr ""
19164
19165 #. type: table
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."
19168 msgstr ""
19169
19170 #. type: quotation
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."
19173 msgstr ""
19174
19175 #. type: table
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."
19178 msgstr ""
19179
19180 #. type: table
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."
19183 msgstr ""
19184
19185 #. type: table
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})."
19188 msgstr ""
19189
19190 #. type: anchor{#1}
19191 #: guix-git/doc/guix.texi:10834
19192 msgid "build-check"
19193 msgstr ""
19194
19195 #. type: item
19196 #: guix-git/doc/guix.texi:10834
19197 #, no-wrap
19198 msgid "--check"
19199 msgstr ""
19200
19201 #. type: cindex
19202 #: guix-git/doc/guix.texi:10835
19203 #, no-wrap
19204 msgid "determinism, checking"
19205 msgstr ""
19206
19207 #. type: cindex
19208 #: guix-git/doc/guix.texi:10836
19209 #, no-wrap
19210 msgid "reproducibility, checking"
19211 msgstr ""
19212
19213 #. type: table
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."
19216 msgstr ""
19217
19218 #. type: table
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."
19221 msgstr ""
19222
19223 #. type: item
19224 #: guix-git/doc/guix.texi:10850
19225 #, no-wrap
19226 msgid "--repair"
19227 msgstr ""
19228
19229 #. type: cindex
19230 #: guix-git/doc/guix.texi:10851
19231 #, no-wrap
19232 msgid "repairing store items"
19233 msgstr ""
19234
19235 #. type: table
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."
19238 msgstr ""
19239
19240 #. type: table
19241 #: guix-git/doc/guix.texi:10857
19242 msgid "This operation is not atomic and thus restricted to @code{root}."
19243 msgstr ""
19244
19245 #. type: item
19246 #: guix-git/doc/guix.texi:10858
19247 #, no-wrap
19248 msgid "--derivations"
19249 msgstr ""
19250
19251 #. type: table
19252 #: guix-git/doc/guix.texi:10862
19253 msgid "Return the derivation paths, not the output paths, of the given packages."
19254 msgstr ""
19255
19256 #. type: cindex
19257 #: guix-git/doc/guix.texi:10865
19258 #, no-wrap
19259 msgid "GC roots, adding"
19260 msgstr ""
19261
19262 #. type: cindex
19263 #: guix-git/doc/guix.texi:10866
19264 #, no-wrap
19265 msgid "garbage collector roots, adding"
19266 msgstr ""
19267
19268 #. type: table
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."
19271 msgstr ""
19272
19273 #. type: table
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."
19276 msgstr ""
19277
19278 #. type: item
19279 #: guix-git/doc/guix.texi:10876
19280 #, no-wrap
19281 msgid "--log-file"
19282 msgstr ""
19283
19284 #. type: cindex
19285 #: guix-git/doc/guix.texi:10877
19286 #, no-wrap
19287 msgid "build logs, access"
19288 msgstr ""
19289
19290 #. type: table
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."
19293 msgstr ""
19294
19295 #. type: table
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:"
19298 msgstr ""
19299
19300 #. type: example
19301 #: guix-git/doc/guix.texi:10890
19302 #, no-wrap
19303 msgid ""
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"
19308 msgstr ""
19309
19310 #. type: table
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})."
19313 msgstr ""
19314
19315 #. type: table
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:"
19318 msgstr ""
19319
19320 #. type: example
19321 #: guix-git/doc/guix.texi:10902
19322 #, no-wrap
19323 msgid ""
19324 "$ guix build --log-file gdb -s aarch64-linux\n"
19325 "https://@value{SUBSTITUTE-SERVER}/log/@dots{}-gdb-7.10\n"
19326 msgstr ""
19327
19328 #. type: table
19329 #: guix-git/doc/guix.texi:10905
19330 msgid "You can freely access a huge library of build logs!"
19331 msgstr ""
19332
19333 #. type: cindex
19334 #: guix-git/doc/guix.texi:10910
19335 #, no-wrap
19336 msgid "build failures, debugging"
19337 msgstr ""
19338
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."
19342 msgstr ""
19343
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}})."
19347 msgstr ""
19348
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:"
19352 msgstr ""
19353
19354 #. type: example
19355 #: guix-git/doc/guix.texi:10934
19356 #, no-wrap
19357 msgid ""
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"
19362 "$ cd foo-1.2\n"
19363 msgstr ""
19364
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."
19368 msgstr ""
19369
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})."
19373 msgstr ""
19374
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:"
19378 msgstr ""
19379
19380 #. type: example
19381 #: guix-git/doc/guix.texi:10955
19382 #, no-wrap
19383 msgid ""
19384 "$ guix build -K foo\n"
19385 "@dots{}\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"
19390 msgstr ""
19391
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)."
19395 msgstr ""
19396
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}:"
19400 msgstr ""
19401
19402 #. type: example
19403 #: guix-git/doc/guix.texi:10970
19404 #, no-wrap
19405 msgid "[env]# rm /bin/sh\n"
19406 msgstr ""
19407
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}.)"
19411 msgstr ""
19412
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:"
19416 msgstr ""
19417
19418 #. type: example
19419 #: guix-git/doc/guix.texi:10980
19420 #, no-wrap
19421 msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n"
19422 msgstr ""
19423
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."
19427 msgstr ""
19428
19429 #. type: section
19430 #: guix-git/doc/guix.texi:10988
19431 #, no-wrap
19432 msgid "Invoking @command{guix edit}"
19433 msgstr ""
19434
19435 #. type: command{#1}
19436 #: guix-git/doc/guix.texi:10990
19437 #, no-wrap
19438 msgid "guix edit"
19439 msgstr ""
19440
19441 #. type: cindex
19442 #: guix-git/doc/guix.texi:10991
19443 #, no-wrap
19444 msgid "package definition, editing"
19445 msgstr ""
19446
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:"
19450 msgstr ""
19451
19452 #. type: example
19453 #: guix-git/doc/guix.texi:10999
19454 #, no-wrap
19455 msgid "guix edit gcc@@4.9 vim\n"
19456 msgstr ""
19457
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."
19461 msgstr ""
19462
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."
19466 msgstr ""
19467
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."
19471 msgstr ""
19472
19473 #. type: section
19474 #: guix-git/doc/guix.texi:11018
19475 #, no-wrap
19476 msgid "Invoking @command{guix download}"
19477 msgstr ""
19478
19479 #. type: command{#1}
19480 #: guix-git/doc/guix.texi:11020
19481 #, no-wrap
19482 msgid "guix download"
19483 msgstr ""
19484
19485 #. type: cindex
19486 #: guix-git/doc/guix.texi:11021
19487 #, no-wrap
19488 msgid "downloading package sources"
19489 msgstr ""
19490
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."
19494 msgstr ""
19495
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})."
19499 msgstr ""
19500
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."
19504 msgstr ""
19505
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."
19509 msgstr ""
19510
19511 #. type: Plain text
19512 #: guix-git/doc/guix.texi:11050 guix-git/doc/guix.texi:12602
19513 msgid "The following options are available:"
19514 msgstr ""
19515
19516 #. type: item
19517 #: guix-git/doc/guix.texi:11052 guix-git/doc/guix.texi:11096
19518 #, no-wrap
19519 msgid "--hash=@var{algorithm}"
19520 msgstr ""
19521
19522 #. type: itemx
19523 #: guix-git/doc/guix.texi:11053 guix-git/doc/guix.texi:11097
19524 #, no-wrap
19525 msgid "-H @var{algorithm}"
19526 msgstr ""
19527
19528 #. type: table
19529 #: guix-git/doc/guix.texi:11056
19530 msgid "Compute a hash using the specified @var{algorithm}. @xref{Invoking guix hash}, for more information."
19531 msgstr ""
19532
19533 #. type: item
19534 #: guix-git/doc/guix.texi:11057 guix-git/doc/guix.texi:11106
19535 #, no-wrap
19536 msgid "--format=@var{fmt}"
19537 msgstr ""
19538
19539 #. type: itemx
19540 #: guix-git/doc/guix.texi:11058 guix-git/doc/guix.texi:11107
19541 #, no-wrap
19542 msgid "-f @var{fmt}"
19543 msgstr ""
19544
19545 #. type: table
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}."
19548 msgstr ""
19549
19550 #. type: item
19551 #: guix-git/doc/guix.texi:11062
19552 #, no-wrap
19553 msgid "--no-check-certificate"
19554 msgstr ""
19555
19556 #. type: table
19557 #: guix-git/doc/guix.texi:11064
19558 msgid "Do not validate the X.509 certificates of HTTPS servers."
19559 msgstr ""
19560
19561 #. type: table
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."
19564 msgstr ""
19565
19566 #. type: item
19567 #: guix-git/doc/guix.texi:11069
19568 #, no-wrap
19569 msgid "--output=@var{file}"
19570 msgstr ""
19571
19572 #. type: itemx
19573 #: guix-git/doc/guix.texi:11070
19574 #, no-wrap
19575 msgid "-o @var{file}"
19576 msgstr ""
19577
19578 #. type: table
19579 #: guix-git/doc/guix.texi:11073
19580 msgid "Save the downloaded file to @var{file} instead of adding it to the store."
19581 msgstr ""
19582
19583 #. type: section
19584 #: guix-git/doc/guix.texi:11076
19585 #, no-wrap
19586 msgid "Invoking @command{guix hash}"
19587 msgstr ""
19588
19589 #. type: command{#1}
19590 #: guix-git/doc/guix.texi:11078
19591 #, no-wrap
19592 msgid "guix hash"
19593 msgstr ""
19594
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})."
19598 msgstr ""
19599
19600 #. type: example
19601 #: guix-git/doc/guix.texi:11088
19602 #, no-wrap
19603 msgid "guix hash @var{option} @var{file}\n"
19604 msgstr ""
19605
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:"
19609 msgstr ""
19610
19611 #. type: table
19612 #: guix-git/doc/guix.texi:11100
19613 msgid "Compute a hash using the specified @var{algorithm}, @code{sha256} by default."
19614 msgstr ""
19615
19616 #. type: table
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})."
19619 msgstr ""
19620
19621 #. type: table
19622 #: guix-git/doc/guix.texi:11109
19623 msgid "Write the hash in the format specified by @var{fmt}."
19624 msgstr ""
19625
19626 #. type: table
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)."
19629 msgstr ""
19630
19631 #. type: table
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."
19634 msgstr ""
19635
19636 #. type: table
19637 #: guix-git/doc/guix.texi:11120
19638 msgid "Compute the hash on @var{file} recursively."
19639 msgstr ""
19640
19641 #. type: table
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})."
19644 msgstr ""
19645
19646 #. type: item
19647 #: guix-git/doc/guix.texi:11130
19648 #, no-wrap
19649 msgid "--exclude-vcs"
19650 msgstr ""
19651
19652 #. type: itemx
19653 #: guix-git/doc/guix.texi:11131 guix-git/doc/guix.texi:12089
19654 #, no-wrap
19655 msgid "-x"
19656 msgstr ""
19657
19658 #. type: table
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.)."
19661 msgstr ""
19662
19663 #. type: vindex
19664 #: guix-git/doc/guix.texi:11135
19665 #, no-wrap
19666 msgid "git-fetch"
19667 msgstr ""
19668
19669 #. type: table
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}):"
19672 msgstr ""
19673
19674 #. type: example
19675 #: guix-git/doc/guix.texi:11144
19676 #, no-wrap
19677 msgid ""
19678 "$ git clone http://example.org/foo.git\n"
19679 "$ cd foo\n"
19680 "$ guix hash -rx .\n"
19681 msgstr ""
19682
19683 #. type: cindex
19684 #: guix-git/doc/guix.texi:11148 guix-git/doc/guix.texi:11153
19685 #, no-wrap
19686 msgid "Invoking @command{guix import}"
19687 msgstr ""
19688
19689 #. type: cindex
19690 #: guix-git/doc/guix.texi:11150
19691 #, no-wrap
19692 msgid "importing packages"
19693 msgstr ""
19694
19695 #. type: cindex
19696 #: guix-git/doc/guix.texi:11151
19697 #, no-wrap
19698 msgid "package import"
19699 msgstr ""
19700
19701 #. type: cindex
19702 #: guix-git/doc/guix.texi:11152
19703 #, no-wrap
19704 msgid "package conversion"
19705 msgstr ""
19706
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})."
19710 msgstr ""
19711
19712 #. type: example
19713 #: guix-git/doc/guix.texi:11165
19714 #, no-wrap
19715 msgid "guix import @var{importer} @var{options}@dots{}\n"
19716 msgstr ""
19717
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}."
19721 msgstr ""
19722
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."
19726 msgstr ""
19727
19728 #. type: Plain text
19729 #: guix-git/doc/guix.texi:11176
19730 msgid "Currently, the available ``importers'' are:"
19731 msgstr ""
19732
19733 #. type: item
19734 #: guix-git/doc/guix.texi:11178 guix-git/doc/guix.texi:11736
19735 #, no-wrap
19736 msgid "gnu"
19737 msgstr ""
19738
19739 #. type: table
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."
19742 msgstr ""
19743
19744 #. type: table
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."
19747 msgstr ""
19748
19749 #. type: table
19750 #: guix-git/doc/guix.texi:11188
19751 msgid "For example, the following command returns a package definition for GNU@tie{}Hello:"
19752 msgstr ""
19753
19754 #. type: example
19755 #: guix-git/doc/guix.texi:11191
19756 #, no-wrap
19757 msgid "guix import gnu hello\n"
19758 msgstr ""
19759
19760 #. type: table
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:"
19764 msgstr ""
19765
19766 #. type: item
19767 #: guix-git/doc/guix.texi:11196 guix-git/doc/guix.texi:11897
19768 #, no-wrap
19769 msgid "--key-download=@var{policy}"
19770 msgstr ""
19771
19772 #. type: table
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}}."
19775 msgstr ""
19776
19777 #. type: item
19778 #: guix-git/doc/guix.texi:11202 guix-git/doc/guix.texi:11203
19779 #: guix-git/doc/guix.texi:11758
19780 #, no-wrap
19781 msgid "pypi"
19782 msgstr ""
19783
19784 #. type: table
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."
19787 msgstr ""
19788
19789 #. type: table
19790 #: guix-git/doc/guix.texi:11213
19791 msgid "The command below imports metadata for the @code{itsdangerous} Python package:"
19792 msgstr ""
19793
19794 #. type: example
19795 #: guix-git/doc/guix.texi:11216
19796 #, no-wrap
19797 msgid "guix import pypi itsdangerous\n"
19798 msgstr ""
19799
19800 #. type: table
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."
19806 msgstr ""
19807
19808 #. type: item
19809 #: guix-git/doc/guix.texi:11226 guix-git/doc/guix.texi:11227
19810 #: guix-git/doc/guix.texi:11760
19811 #, no-wrap
19812 msgid "gem"
19813 msgstr ""
19814
19815 #. type: table
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."
19818 msgstr ""
19819
19820 #. type: table
19821 #: guix-git/doc/guix.texi:11238
19822 msgid "The command below imports metadata for the @code{rails} Ruby package:"
19823 msgstr ""
19824
19825 #. type: example
19826 #: guix-git/doc/guix.texi:11241
19827 #, no-wrap
19828 msgid "guix import gem rails\n"
19829 msgstr ""
19830
19831 #. type: item
19832 #: guix-git/doc/guix.texi:11251 guix-git/doc/guix.texi:11756
19833 #, no-wrap
19834 msgid "cpan"
19835 msgstr ""
19836
19837 #. type: cindex
19838 #: guix-git/doc/guix.texi:11252
19839 #, no-wrap
19840 msgid "CPAN"
19841 msgstr ""
19842
19843 #. type: table
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."
19846 msgstr ""
19847
19848 #. type: table
19849 #: guix-git/doc/guix.texi:11263
19850 msgid "The command command below imports metadata for the Acme::Boolean Perl module:"
19851 msgstr ""
19852
19853 #. type: example
19854 #: guix-git/doc/guix.texi:11266
19855 #, no-wrap
19856 msgid "guix import cpan Acme::Boolean\n"
19857 msgstr ""
19858
19859 #. type: item
19860 #: guix-git/doc/guix.texi:11268 guix-git/doc/guix.texi:11752
19861 #, no-wrap
19862 msgid "cran"
19863 msgstr ""
19864
19865 #. type: cindex
19866 #: guix-git/doc/guix.texi:11269
19867 #, no-wrap
19868 msgid "CRAN"
19869 msgstr ""
19870
19871 #. type: cindex
19872 #: guix-git/doc/guix.texi:11270
19873 #, no-wrap
19874 msgid "Bioconductor"
19875 msgstr ""
19876
19877 #. type: table
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}."
19880 msgstr ""
19881
19882 #. type: table
19883 #: guix-git/doc/guix.texi:11276
19884 msgid "Information is extracted from the @file{DESCRIPTION} file of the package."
19885 msgstr ""
19886
19887 #. type: table
19888 #: guix-git/doc/guix.texi:11278
19889 msgid "The command command below imports metadata for the Cairo R package:"
19890 msgstr ""
19891
19892 #. type: example
19893 #: guix-git/doc/guix.texi:11281
19894 #, no-wrap
19895 msgid "guix import cran Cairo\n"
19896 msgstr ""
19897
19898 #. type: table
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."
19901 msgstr ""
19902
19903 #. type: table
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}."
19906 msgstr ""
19907
19908 #. type: table
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."
19911 msgstr ""
19912
19913 #. type: table
19914 #: guix-git/doc/guix.texi:11301
19915 msgid "Information is extracted from the @file{DESCRIPTION} file contained in the package archive."
19916 msgstr ""
19917
19918 #. type: table
19919 #: guix-git/doc/guix.texi:11303
19920 msgid "The command below imports metadata for the GenomicRanges R package:"
19921 msgstr ""
19922
19923 #. type: example
19924 #: guix-git/doc/guix.texi:11306
19925 #, no-wrap
19926 msgid "guix import cran --archive=bioconductor GenomicRanges\n"
19927 msgstr ""
19928
19929 #. type: table
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:"
19932 msgstr ""
19933
19934 #. type: example
19935 #: guix-git/doc/guix.texi:11314
19936 #, no-wrap
19937 msgid "guix import cran --archive=git https://github.com/immunogenomics/harmony\n"
19938 msgstr ""
19939
19940 #. type: item
19941 #: guix-git/doc/guix.texi:11316
19942 #, no-wrap
19943 msgid "texlive"
19944 msgstr ""
19945
19946 #. type: cindex
19947 #: guix-git/doc/guix.texi:11317
19948 #, no-wrap
19949 msgid "TeX Live"
19950 msgstr ""
19951
19952 #. type: cindex
19953 #: guix-git/doc/guix.texi:11318
19954 #, no-wrap
19955 msgid "CTAN"
19956 msgstr ""
19957
19958 #. type: table
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}."
19961 msgstr ""
19962
19963 #. type: table
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."
19966 msgstr ""
19967
19968 #. type: table
19969 #: guix-git/doc/guix.texi:11330
19970 msgid "The command command below imports metadata for the @code{fontspec} TeX package:"
19971 msgstr ""
19972
19973 #. type: example
19974 #: guix-git/doc/guix.texi:11333
19975 #, no-wrap
19976 msgid "guix import texlive fontspec\n"
19977 msgstr ""
19978
19979 #. type: table
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."
19982 msgstr ""
19983
19984 #. type: table
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}:"
19987 msgstr ""
19988
19989 #. type: example
19990 #: guix-git/doc/guix.texi:11346
19991 #, no-wrap
19992 msgid "guix import texlive --archive=generic ifxetex\n"
19993 msgstr ""
19994
19995 #. type: cindex
19996 #: guix-git/doc/guix.texi:11349
19997 #, no-wrap
19998 msgid "JSON, import"
19999 msgstr ""
20000
20001 #. type: table
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:"
20004 msgstr ""
20005
20006 #. type: example
20007 #: guix-git/doc/guix.texi:11365
20008 #, no-wrap
20009 msgid ""
20010 "@{\n"
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"
20020 "@}\n"
20021 msgstr ""
20022
20023 #. type: table
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}."
20026 msgstr ""
20027
20028 #. type: table
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:"
20031 msgstr ""
20032
20033 #. type: example
20034 #: guix-git/doc/guix.texi:11387
20035 #, no-wrap
20036 msgid ""
20037 "@{\n"
20038 " @dots{}\n"
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"
20044 " @}\n"
20045 " @}\n"
20046 " @dots{}\n"
20047 "@}\n"
20048 msgstr ""
20049
20050 #. type: table
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:"
20053 msgstr ""
20054
20055 #. type: example
20056 #: guix-git/doc/guix.texi:11394
20057 #, no-wrap
20058 msgid "guix import json hello.json\n"
20059 msgstr ""
20060
20061 #. type: item
20062 #: guix-git/doc/guix.texi:11396 guix-git/doc/guix.texi:11397
20063 #: guix-git/doc/guix.texi:11764
20064 #, no-wrap
20065 msgid "hackage"
20066 msgstr ""
20067
20068 #. type: table
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."
20071 msgstr ""
20072
20073 #. type: item
20074 #: guix-git/doc/guix.texi:11406
20075 #, no-wrap
20076 msgid "--stdin"
20077 msgstr ""
20078
20079 #. type: itemx
20080 #: guix-git/doc/guix.texi:11407
20081 #, no-wrap
20082 msgid "-s"
20083 msgstr ""
20084
20085 #. type: table
20086 #: guix-git/doc/guix.texi:11409
20087 msgid "Read a Cabal file from standard input."
20088 msgstr ""
20089
20090 #. type: item
20091 #: guix-git/doc/guix.texi:11409 guix-git/doc/guix.texi:11456
20092 #, no-wrap
20093 msgid "--no-test-dependencies"
20094 msgstr ""
20095
20096 #. type: table
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."
20099 msgstr ""
20100
20101 #. type: item
20102 #: guix-git/doc/guix.texi:11412
20103 #, no-wrap
20104 msgid "--cabal-environment=@var{alist}"
20105 msgstr ""
20106
20107 #. type: itemx
20108 #: guix-git/doc/guix.texi:11413
20109 #, no-wrap
20110 msgid "-e @var{alist}"
20111 msgstr ""
20112
20113 #. type: table
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."
20116 msgstr ""
20117
20118 #. type: table
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}:"
20121 msgstr ""
20122
20123 #. type: example
20124 #: guix-git/doc/guix.texi:11435
20125 #, no-wrap
20126 msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n"
20127 msgstr ""
20128
20129 #. type: table
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:"
20132 msgstr ""
20133
20134 #. type: example
20135 #: guix-git/doc/guix.texi:11442
20136 #, no-wrap
20137 msgid "guix import hackage mtl@@2.1.3.1\n"
20138 msgstr ""
20139
20140 #. type: item
20141 #: guix-git/doc/guix.texi:11444 guix-git/doc/guix.texi:11445
20142 #: guix-git/doc/guix.texi:11766
20143 #, no-wrap
20144 msgid "stackage"
20145 msgstr ""
20146
20147 #. type: table
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."
20150 msgstr ""
20151
20152 #. type: item
20153 #: guix-git/doc/guix.texi:11459
20154 #, no-wrap
20155 msgid "--lts-version=@var{version}"
20156 msgstr ""
20157
20158 #. type: itemx
20159 #: guix-git/doc/guix.texi:11460
20160 #, no-wrap
20161 msgid "-l @var{version}"
20162 msgstr ""
20163
20164 #. type: table
20165 #: guix-git/doc/guix.texi:11463
20166 msgid "@var{version} is the desired LTS release version. If omitted the latest release is used."
20167 msgstr ""
20168
20169 #. type: table
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:"
20172 msgstr ""
20173
20174 #. type: example
20175 #: guix-git/doc/guix.texi:11475
20176 #, no-wrap
20177 msgid "guix import stackage --lts-version=7.18 HTTP\n"
20178 msgstr ""
20179
20180 #. type: item
20181 #: guix-git/doc/guix.texi:11477 guix-git/doc/guix.texi:11478
20182 #: guix-git/doc/guix.texi:11750
20183 #, no-wrap
20184 msgid "elpa"
20185 msgstr ""
20186
20187 #. type: table
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})."
20190 msgstr ""
20191
20192 #. type: item
20193 #: guix-git/doc/guix.texi:11485
20194 #, no-wrap
20195 msgid "--archive=@var{repo}"
20196 msgstr ""
20197
20198 #. type: itemx
20199 #: guix-git/doc/guix.texi:11486
20200 #, no-wrap
20201 msgid "-a @var{repo}"
20202 msgstr ""
20203
20204 #. type: table
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:"
20207 msgstr ""
20208
20209 #. type: itemize
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."
20212 msgstr ""
20213
20214 #. type: itemize
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})."
20217 msgstr ""
20218
20219 #. type: itemize
20220 #: guix-git/doc/guix.texi:11504
20221 msgid "@uref{https://stable.melpa.org/packages, MELPA-Stable}, selected by the @code{melpa-stable} identifier."
20222 msgstr ""
20223
20224 #. type: itemize
20225 #: guix-git/doc/guix.texi:11508
20226 msgid "@uref{https://melpa.org/packages, MELPA}, selected by the @code{melpa} identifier."
20227 msgstr ""
20228
20229 #. type: item
20230 #: guix-git/doc/guix.texi:11517 guix-git/doc/guix.texi:11518
20231 #: guix-git/doc/guix.texi:11768
20232 #, no-wrap
20233 msgid "crate"
20234 msgstr ""
20235
20236 #. type: table
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:"
20239 msgstr ""
20240
20241 #. type: example
20242 #: guix-git/doc/guix.texi:11524
20243 #, no-wrap
20244 msgid "guix import crate blake2-rfc\n"
20245 msgstr ""
20246
20247 #. type: table
20248 #: guix-git/doc/guix.texi:11527
20249 msgid "The crate importer also allows you to specify a version string:"
20250 msgstr ""
20251
20252 #. type: example
20253 #: guix-git/doc/guix.texi:11530
20254 #, no-wrap
20255 msgid "guix import crate constant-time-eq@@0.1.0\n"
20256 msgstr ""
20257
20258 #. type: table
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:"
20262 msgstr ""
20263
20264 #. type: item
20265 #: guix-git/doc/guix.texi:11542
20266 #, no-wrap
20267 msgid "opam"
20268 msgstr ""
20269
20270 #. type: cindex
20271 #: guix-git/doc/guix.texi:11543
20272 #, no-wrap
20273 msgid "OPAM"
20274 msgstr ""
20275
20276 #. type: cindex
20277 #: guix-git/doc/guix.texi:11544
20278 #, no-wrap
20279 msgid "OCaml"
20280 msgstr ""
20281
20282 #. type: table
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."
20285 msgstr ""
20286
20287 #. type: item
20288 #: guix-git/doc/guix.texi:11556
20289 #, no-wrap
20290 msgid "--repo"
20291 msgstr ""
20292
20293 #. type: table
20294 #: guix-git/doc/guix.texi:11558
20295 msgid "Select the given repository (a repository name). Possible values include:"
20296 msgstr ""
20297
20298 #. type: item
20299 #: guix-git/doc/guix.texi:11559
20300 #, no-wrap
20301 msgid "@code{opam}, the default opam repository,"
20302 msgstr ""
20303
20304 #. type: item
20305 #: guix-git/doc/guix.texi:11560
20306 #, no-wrap
20307 msgid "@code{coq} or @code{coq-released}, the stable repository for coq packages,"
20308 msgstr ""
20309
20310 #. type: item
20311 #: guix-git/doc/guix.texi:11561
20312 #, no-wrap
20313 msgid "@code{coq-core-dev}, the repository that contains development versions of coq,"
20314 msgstr ""
20315
20316 #. type: item
20317 #: guix-git/doc/guix.texi:11562
20318 #, no-wrap
20319 msgid "@code{coq-extra-dev}, the repository that contains development versions"
20320 msgstr ""
20321
20322 #. type: itemize
20323 #: guix-git/doc/guix.texi:11564
20324 msgid "of coq packages."
20325 msgstr ""
20326
20327 #. type: cindex
20328 #: guix-git/doc/guix.texi:11567 guix-git/doc/guix.texi:11568
20329 #, no-wrap
20330 msgid "go"
20331 msgstr ""
20332
20333 #. type: table
20334 #: guix-git/doc/guix.texi:11571
20335 msgid "Import metadata for a Go module using @uref{https://proxy.golang.org, proxy.golang.org}."
20336 msgstr ""
20337
20338 #. type: example
20339 #: guix-git/doc/guix.texi:11574
20340 #, no-wrap
20341 msgid "guix import go gopkg.in/yaml.v2\n"
20342 msgstr ""
20343
20344 #. type: table
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."
20347 msgstr ""
20348
20349 #. type: item
20350 #: guix-git/doc/guix.texi:11587
20351 #, no-wrap
20352 msgid "--pin-versions"
20353 msgstr ""
20354
20355 #. type: table
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."
20358 msgstr ""
20359
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})."
20363 msgstr ""
20364
20365 #. type: section
20366 #: guix-git/doc/guix.texi:11603
20367 #, no-wrap
20368 msgid "Invoking @command{guix refresh}"
20369 msgstr ""
20370
20371 #. type: command{#1}
20372 #: guix-git/doc/guix.texi:11605
20373 #, no-wrap
20374 msgid "guix refresh"
20375 msgstr ""
20376
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:"
20380 msgstr ""
20381
20382 #. type: example
20383 #: guix-git/doc/guix.texi:11618
20384 #, no-wrap
20385 msgid ""
20386 "$ guix refresh\n"
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"
20389 msgstr ""
20390
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:"
20394 msgstr ""
20395
20396 #. type: example
20397 #: guix-git/doc/guix.texi:11627
20398 #, no-wrap
20399 msgid ""
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"
20403 msgstr ""
20404
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!"
20408 msgstr ""
20409
20410 #. type: table
20411 #: guix-git/doc/guix.texi:11641
20412 msgid "Consider the packages specified, and all the packages upon which they depend."
20413 msgstr ""
20414
20415 #. type: example
20416 #: guix-git/doc/guix.texi:11649
20417 #, no-wrap
20418 msgid ""
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"
20424 "@dots{}\n"
20425 msgstr ""
20426
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:"
20430 msgstr ""
20431
20432 #. type: lisp
20433 #: guix-git/doc/guix.texi:11664
20434 #, no-wrap
20435 msgid ""
20436 "(define-public network-manager\n"
20437 " (package\n"
20438 " (name \"network-manager\")\n"
20439 " ;; @dots{}\n"
20440 " (properties '((upstream-name . \"NetworkManager\")))))\n"
20441 msgstr ""
20442
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."
20446 msgstr ""
20447
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."
20451 msgstr ""
20452
20453 #. type: Plain text
20454 #: guix-git/doc/guix.texi:11681
20455 msgid "The following options are supported:"
20456 msgstr ""
20457
20458 #. type: table
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:"
20461 msgstr ""
20462
20463 #. type: example
20464 #: guix-git/doc/guix.texi:11692
20465 #, no-wrap
20466 msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n"
20467 msgstr ""
20468
20469 #. type: table
20470 #: guix-git/doc/guix.texi:11696
20471 msgid "This command lists the dependents of the ``final'' libc (essentially all the packages)."
20472 msgstr ""
20473
20474 #. type: item
20475 #: guix-git/doc/guix.texi:11697
20476 #, no-wrap
20477 msgid "--update"
20478 msgstr ""
20479
20480 #. type: itemx
20481 #: guix-git/doc/guix.texi:11698
20482 #, no-wrap
20483 msgid "-u"
20484 msgstr ""
20485
20486 #. type: table
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}):"
20489 msgstr ""
20490
20491 #. type: example
20492 #: guix-git/doc/guix.texi:11705
20493 #, no-wrap
20494 msgid "$ ./pre-inst-env guix refresh -s non-core -u\n"
20495 msgstr ""
20496
20497 #. type: table
20498 #: guix-git/doc/guix.texi:11708
20499 msgid "@xref{Defining Packages}, for more information on package definitions."
20500 msgstr ""
20501
20502 #. type: item
20503 #: guix-git/doc/guix.texi:11709
20504 #, no-wrap
20505 msgid "--select=[@var{subset}]"
20506 msgstr ""
20507
20508 #. type: itemx
20509 #: guix-git/doc/guix.texi:11710
20510 #, no-wrap
20511 msgid "-s @var{subset}"
20512 msgstr ""
20513
20514 #. type: table
20515 #: guix-git/doc/guix.texi:11713
20516 msgid "Select all the packages in @var{subset}, one of @code{core} or @code{non-core}."
20517 msgstr ""
20518
20519 #. type: table
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."
20522 msgstr ""
20523
20524 #. type: table
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."
20527 msgstr ""
20528
20529 #. type: table
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."
20532 msgstr ""
20533
20534 #. type: item
20535 #: guix-git/doc/guix.texi:11730
20536 #, no-wrap
20537 msgid "--type=@var{updater}"
20538 msgstr ""
20539
20540 #. type: itemx
20541 #: guix-git/doc/guix.texi:11731
20542 #, no-wrap
20543 msgid "-t @var{updater}"
20544 msgstr ""
20545
20546 #. type: table
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:"
20549 msgstr ""
20550
20551 #. type: table
20552 #: guix-git/doc/guix.texi:11738
20553 msgid "the updater for GNU packages;"
20554 msgstr ""
20555
20556 #. type: item
20557 #: guix-git/doc/guix.texi:11738
20558 #, no-wrap
20559 msgid "savannah"
20560 msgstr ""
20561
20562 #. type: table
20563 #: guix-git/doc/guix.texi:11740
20564 msgid "the updater for packages hosted at @uref{https://savannah.gnu.org, Savannah};"
20565 msgstr ""
20566
20567 #. type: item
20568 #: guix-git/doc/guix.texi:11740
20569 #, no-wrap
20570 msgid "sourceforge"
20571 msgstr ""
20572
20573 #. type: table
20574 #: guix-git/doc/guix.texi:11742
20575 msgid "the updater for packages hosted at @uref{https://sourceforge.net, SourceForge};"
20576 msgstr ""
20577
20578 #. type: item
20579 #: guix-git/doc/guix.texi:11742
20580 #, no-wrap
20581 msgid "gnome"
20582 msgstr ""
20583
20584 #. type: table
20585 #: guix-git/doc/guix.texi:11744
20586 msgid "the updater for GNOME packages;"
20587 msgstr ""
20588
20589 #. type: item
20590 #: guix-git/doc/guix.texi:11744
20591 #, no-wrap
20592 msgid "kde"
20593 msgstr ""
20594
20595 #. type: table
20596 #: guix-git/doc/guix.texi:11746
20597 msgid "the updater for KDE packages;"
20598 msgstr ""
20599
20600 #. type: item
20601 #: guix-git/doc/guix.texi:11746
20602 #, no-wrap
20603 msgid "xorg"
20604 msgstr ""
20605
20606 #. type: table
20607 #: guix-git/doc/guix.texi:11748
20608 msgid "the updater for X.org packages;"
20609 msgstr ""
20610
20611 #. type: item
20612 #: guix-git/doc/guix.texi:11748
20613 #, no-wrap
20614 msgid "kernel.org"
20615 msgstr ""
20616
20617 #. type: table
20618 #: guix-git/doc/guix.texi:11750
20619 msgid "the updater for packages hosted on kernel.org;"
20620 msgstr ""
20621
20622 #. type: table
20623 #: guix-git/doc/guix.texi:11752
20624 msgid "the updater for @uref{https://elpa.gnu.org/, ELPA} packages;"
20625 msgstr ""
20626
20627 #. type: table
20628 #: guix-git/doc/guix.texi:11754
20629 msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;"
20630 msgstr ""
20631
20632 #. type: item
20633 #: guix-git/doc/guix.texi:11754
20634 #, no-wrap
20635 msgid "bioconductor"
20636 msgstr ""
20637
20638 #. type: table
20639 #: guix-git/doc/guix.texi:11756
20640 msgid "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R packages;"
20641 msgstr ""
20642
20643 #. type: table
20644 #: guix-git/doc/guix.texi:11758
20645 msgid "the updater for @uref{https://www.cpan.org/, CPAN} packages;"
20646 msgstr ""
20647
20648 #. type: table
20649 #: guix-git/doc/guix.texi:11760
20650 msgid "the updater for @uref{https://pypi.python.org, PyPI} packages."
20651 msgstr ""
20652
20653 #. type: table
20654 #: guix-git/doc/guix.texi:11762
20655 msgid "the updater for @uref{https://rubygems.org, RubyGems} packages."
20656 msgstr ""
20657
20658 #. type: item
20659 #: guix-git/doc/guix.texi:11762
20660 #, no-wrap
20661 msgid "github"
20662 msgstr ""
20663
20664 #. type: table
20665 #: guix-git/doc/guix.texi:11764
20666 msgid "the updater for @uref{https://github.com, GitHub} packages."
20667 msgstr ""
20668
20669 #. type: table
20670 #: guix-git/doc/guix.texi:11766
20671 msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages."
20672 msgstr ""
20673
20674 #. type: table
20675 #: guix-git/doc/guix.texi:11768
20676 msgid "the updater for @uref{https://www.stackage.org, Stackage} packages."
20677 msgstr ""
20678
20679 #. type: table
20680 #: guix-git/doc/guix.texi:11770
20681 msgid "the updater for @uref{https://crates.io, Crates} packages."
20682 msgstr ""
20683
20684 #. type: item
20685 #: guix-git/doc/guix.texi:11770
20686 #, no-wrap
20687 msgid "launchpad"
20688 msgstr ""
20689
20690 #. type: table
20691 #: guix-git/doc/guix.texi:11772
20692 msgid "the updater for @uref{https://launchpad.net, Launchpad} packages."
20693 msgstr ""
20694
20695 #. type: item
20696 #: guix-git/doc/guix.texi:11772
20697 #, no-wrap
20698 msgid "generic-html"
20699 msgstr ""
20700
20701 #. type: table
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."
20704 msgstr ""
20705
20706 #. type: table
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:"
20709 msgstr ""
20710
20711 #. type: example
20712 #: guix-git/doc/guix.texi:11784
20713 #, no-wrap
20714 msgid ""
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"
20718 msgstr ""
20719
20720 #. type: item
20721 #: guix-git/doc/guix.texi:11786
20722 #, no-wrap
20723 msgid "--list-updaters"
20724 msgstr ""
20725
20726 #. type: itemx
20727 #: guix-git/doc/guix.texi:11787
20728 #, no-wrap
20729 msgid "-L"
20730 msgstr ""
20731
20732 #. type: table
20733 #: guix-git/doc/guix.texi:11789
20734 msgid "List available updaters and exit (see @option{--type} above)."
20735 msgstr ""
20736
20737 #. type: table
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."
20740 msgstr ""
20741
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:"
20745 msgstr ""
20746
20747 #. type: example
20748 #: guix-git/doc/guix.texi:11799
20749 #, no-wrap
20750 msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n"
20751 msgstr ""
20752
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:"
20756 msgstr ""
20757
20758 #. type: example
20759 #: guix-git/doc/guix.texi:11810
20760 #, no-wrap
20761 msgid ""
20762 "$ ./pre-inst-env guix refresh -u \\\n"
20763 " $(guix package --list-installed | cut -f1)\n"
20764 msgstr ""
20765
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:"
20769 msgstr ""
20770
20771 #. type: item
20772 #: guix-git/doc/guix.texi:11819
20773 #, no-wrap
20774 msgid "--list-dependent"
20775 msgstr ""
20776
20777 #. type: itemx
20778 #: guix-git/doc/guix.texi:11820 guix-git/doc/guix.texi:12079
20779 #, no-wrap
20780 msgid "-l"
20781 msgstr ""
20782
20783 #. type: table
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."
20786 msgstr ""
20787
20788 #. type: table
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."
20791 msgstr ""
20792
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."
20796 msgstr ""
20797
20798 #. type: example
20799 #: guix-git/doc/guix.texi:11838
20800 #, no-wrap
20801 msgid ""
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"
20805 msgstr ""
20806
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."
20810 msgstr ""
20811
20812 #. type: item
20813 #: guix-git/doc/guix.texi:11845
20814 #, no-wrap
20815 msgid "--list-transitive"
20816 msgstr ""
20817
20818 #. type: table
20819 #: guix-git/doc/guix.texi:11847
20820 msgid "List all the packages which one or more packages depend upon."
20821 msgstr ""
20822
20823 #. type: example
20824 #: guix-git/doc/guix.texi:11852
20825 #, no-wrap
20826 msgid ""
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"
20830 msgstr ""
20831
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."
20835 msgstr ""
20836
20837 #. type: Plain text
20838 #: guix-git/doc/guix.texi:11860
20839 msgid "The following options can be used to customize GnuPG operation:"
20840 msgstr ""
20841
20842 #. type: item
20843 #: guix-git/doc/guix.texi:11863
20844 #, no-wrap
20845 msgid "--gpg=@var{command}"
20846 msgstr ""
20847
20848 #. type: table
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}."
20851 msgstr ""
20852
20853 #. type: item
20854 #: guix-git/doc/guix.texi:11867
20855 #, no-wrap
20856 msgid "--keyring=@var{file}"
20857 msgstr ""
20858
20859 #. type: table
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)."
20862 msgstr ""
20863
20864 #. type: table
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)."
20867 msgstr ""
20868
20869 #. type: table
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:"
20872 msgstr ""
20873
20874 #. type: example
20875 #: guix-git/doc/guix.texi:11885
20876 #, no-wrap
20877 msgid "gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx\n"
20878 msgstr ""
20879
20880 #. type: table
20881 #: guix-git/doc/guix.texi:11888
20882 msgid "Likewise, you can fetch keys to a specific keybox file like this:"
20883 msgstr ""
20884
20885 #. type: example
20886 #: guix-git/doc/guix.texi:11892
20887 #, no-wrap
20888 msgid ""
20889 "gpg --no-default-keyring --keyring mykeyring.kbx \\\n"
20890 " --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n"
20891 msgstr ""
20892
20893 #. type: table
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."
20896 msgstr ""
20897
20898 #. type: table
20899 #: guix-git/doc/guix.texi:11900
20900 msgid "Handle missing OpenPGP keys according to @var{policy}, which may be one of:"
20901 msgstr ""
20902
20903 #. type: item
20904 #: guix-git/doc/guix.texi:11902 guix-git/doc/guix.texi:20769
20905 #, no-wrap
20906 msgid "always"
20907 msgstr ""
20908
20909 #. type: table
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."
20912 msgstr ""
20913
20914 #. type: item
20915 #: guix-git/doc/guix.texi:11906 guix-git/doc/guix.texi:20771
20916 #, no-wrap
20917 msgid "never"
20918 msgstr ""
20919
20920 #. type: table
20921 #: guix-git/doc/guix.texi:11908
20922 msgid "Never try to download missing OpenPGP keys. Instead just bail out."
20923 msgstr ""
20924
20925 #. type: item
20926 #: guix-git/doc/guix.texi:11909
20927 #, no-wrap
20928 msgid "interactive"
20929 msgstr ""
20930
20931 #. type: table
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."
20934 msgstr ""
20935
20936 #. type: item
20937 #: guix-git/doc/guix.texi:11914
20938 #, no-wrap
20939 msgid "--key-server=@var{host}"
20940 msgstr ""
20941
20942 #. type: table
20943 #: guix-git/doc/guix.texi:11916
20944 msgid "Use @var{host} as the OpenPGP key server when importing a public key."
20945 msgstr ""
20946
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."
20950 msgstr ""
20951
20952 #. type: section
20953 #: guix-git/doc/guix.texi:11939
20954 #, no-wrap
20955 msgid "Invoking @command{guix lint}"
20956 msgstr ""
20957
20958 #. type: command{#1}
20959 #: guix-git/doc/guix.texi:11941
20960 #, no-wrap
20961 msgid "guix lint"
20962 msgstr ""
20963
20964 #. type: cindex
20965 #: guix-git/doc/guix.texi:11942
20966 #, no-wrap
20967 msgid "package, checking for errors"
20968 msgstr ""
20969
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):"
20973 msgstr ""
20974
20975 #. type: table
20976 #: guix-git/doc/guix.texi:11954
20977 msgid "Validate certain typographical and stylistic rules about package descriptions and synopses."
20978 msgstr ""
20979
20980 #. type: item
20981 #: guix-git/doc/guix.texi:11955
20982 #, no-wrap
20983 msgid "inputs-should-be-native"
20984 msgstr ""
20985
20986 #. type: table
20987 #: guix-git/doc/guix.texi:11957
20988 msgid "Identify inputs that should most likely be native inputs."
20989 msgstr ""
20990
20991 #. type: itemx
20992 #: guix-git/doc/guix.texi:11960
20993 #, no-wrap
20994 msgid "mirror-url"
20995 msgstr ""
20996
20997 #. type: itemx
20998 #: guix-git/doc/guix.texi:11961
20999 #, no-wrap
21000 msgid "github-url"
21001 msgstr ""
21002
21003 #. type: itemx
21004 #: guix-git/doc/guix.texi:11962
21005 #, no-wrap
21006 msgid "source-file-name"
21007 msgstr ""
21008
21009 #. type: table
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})."
21012 msgstr ""
21013
21014 #. type: item
21015 #: guix-git/doc/guix.texi:11970
21016 #, no-wrap
21017 msgid "source-unstable-tarball"
21018 msgstr ""
21019
21020 #. type: table
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."
21023 msgstr ""
21024
21025 #. type: table
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})."
21028 msgstr ""
21029
21030 #. type: item
21031 #: guix-git/doc/guix.texi:11979
21032 #, no-wrap
21033 msgid "profile-collisions"
21034 msgstr ""
21035
21036 #. type: table
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."
21039 msgstr ""
21040
21041 #. type: item
21042 #: guix-git/doc/guix.texi:11986
21043 #, no-wrap
21044 msgid "archival"
21045 msgstr ""
21046
21047 #. type: cindex
21048 #: guix-git/doc/guix.texi:11987
21049 #, no-wrap
21050 msgid "Software Heritage, source code archive"
21051 msgstr ""
21052
21053 #. type: cindex
21054 #: guix-git/doc/guix.texi:11988
21055 #, no-wrap
21056 msgid "archival of source code, Software Heritage"
21057 msgstr ""
21058
21059 #. type: table
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}."
21062 msgstr ""
21063
21064 #. type: table
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}."
21067 msgstr ""
21068
21069 #. type: table
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."
21072 msgstr ""
21073
21074 #. type: table
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."
21077 msgstr ""
21078
21079 #. type: item
21080 #: guix-git/doc/guix.texi:12011
21081 #, no-wrap
21082 msgid "cve"
21083 msgstr ""
21084
21085 #. type: cindex
21086 #: guix-git/doc/guix.texi:12012 guix-git/doc/guix.texi:34545
21087 #, no-wrap
21088 msgid "security vulnerabilities"
21089 msgstr ""
21090
21091 #. type: cindex
21092 #: guix-git/doc/guix.texi:12013
21093 #, no-wrap
21094 msgid "CVE, Common Vulnerabilities and Exposures"
21095 msgstr ""
21096
21097 #. type: table
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}."
21100 msgstr ""
21101
21102 #. type: table
21103 #: guix-git/doc/guix.texi:12020
21104 msgid "To view information about a particular vulnerability, visit pages such as:"
21105 msgstr ""
21106
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"
21110 msgstr ""
21111
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"
21115 msgstr ""
21116
21117 #. type: table
21118 #: guix-git/doc/guix.texi:12031
21119 msgid "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., @code{CVE-2015-7554}."
21120 msgstr ""
21121
21122 #. type: table
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:"
21125 msgstr ""
21126
21127 #. type: lisp
21128 #: guix-git/doc/guix.texi:12044
21129 #, no-wrap
21130 msgid ""
21131 "(package\n"
21132 " (name \"grub\")\n"
21133 " ;; @dots{}\n"
21134 " ;; CPE calls this package \"grub2\".\n"
21135 " (properties '((cpe-name . \"grub2\")\n"
21136 " (cpe-version . \"2.3\"))))\n"
21137 msgstr ""
21138
21139 #. type: table
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:"
21142 msgstr ""
21143
21144 #. type: lisp
21145 #: guix-git/doc/guix.texi:12061
21146 #, no-wrap
21147 msgid ""
21148 "(package\n"
21149 " (name \"t1lib\")\n"
21150 " ;; @dots{}\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"
21156 msgstr ""
21157
21158 #. type: item
21159 #: guix-git/doc/guix.texi:12063
21160 #, no-wrap
21161 msgid "formatting"
21162 msgstr ""
21163
21164 #. type: table
21165 #: guix-git/doc/guix.texi:12066
21166 msgid "Warn about obvious source code formatting issues: trailing white space, use of tabulations, etc."
21167 msgstr ""
21168
21169 #. type: example
21170 #: guix-git/doc/guix.texi:12072
21171 #, no-wrap
21172 msgid "guix lint @var{options} @var{package}@dots{}\n"
21173 msgstr ""
21174
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:"
21178 msgstr ""
21179
21180 #. type: item
21181 #: guix-git/doc/guix.texi:12078
21182 #, no-wrap
21183 msgid "--list-checkers"
21184 msgstr ""
21185
21186 #. type: table
21187 #: guix-git/doc/guix.texi:12082
21188 msgid "List and describe all the available checkers that will be run on packages and exit."
21189 msgstr ""
21190
21191 #. type: item
21192 #: guix-git/doc/guix.texi:12083
21193 #, no-wrap
21194 msgid "--checkers"
21195 msgstr ""
21196
21197 #. type: itemx
21198 #: guix-git/doc/guix.texi:12084
21199 #, no-wrap
21200 msgid "-c"
21201 msgstr ""
21202
21203 #. type: table
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}."
21206 msgstr ""
21207
21208 #. type: item
21209 #: guix-git/doc/guix.texi:12088
21210 #, no-wrap
21211 msgid "--exclude"
21212 msgstr ""
21213
21214 #. type: table
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}."
21217 msgstr ""
21218
21219 #. type: item
21220 #: guix-git/doc/guix.texi:12093
21221 #, no-wrap
21222 msgid "--no-network"
21223 msgstr ""
21224
21225 #. type: table
21226 #: guix-git/doc/guix.texi:12096
21227 msgid "Only enable the checkers that do not depend on Internet access."
21228 msgstr ""
21229
21230 #. type: section
21231 #: guix-git/doc/guix.texi:12108
21232 #, no-wrap
21233 msgid "Invoking @command{guix size}"
21234 msgstr ""
21235
21236 #. type: code{#1}
21237 #: guix-git/doc/guix.texi:12110 guix-git/doc/guix.texi:33481
21238 #, no-wrap
21239 msgid "size"
21240 msgstr ""
21241
21242 #. type: cindex
21243 #: guix-git/doc/guix.texi:12111
21244 #, no-wrap
21245 msgid "package size"
21246 msgstr ""
21247
21248 #. type: command{#1}
21249 #: guix-git/doc/guix.texi:12113
21250 #, no-wrap
21251 msgid "guix size"
21252 msgstr ""
21253
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."
21257 msgstr ""
21258
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:"
21262 msgstr ""
21263
21264 #. type: example
21265 #: guix-git/doc/guix.texi:12138
21266 #, no-wrap
21267 msgid ""
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"
21279 msgstr ""
21280
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:"
21284 msgstr ""
21285
21286 #. type: example
21287 #: guix-git/doc/guix.texi:12147
21288 #, no-wrap
21289 msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n"
21290 msgstr ""
21291
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."
21295 msgstr ""
21296
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.)"
21300 msgstr ""
21301
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:"
21305 msgstr ""
21306
21307 #. type: example
21308 #: guix-git/doc/guix.texi:12167
21309 #, no-wrap
21310 msgid "guix size $(guix system build config.scm)\n"
21311 msgstr ""
21312
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})."
21316 msgstr ""
21317
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."
21321 msgstr ""
21322
21323 #. type: Plain text
21324 #: guix-git/doc/guix.texi:12184
21325 msgid "You can also specify several package names:"
21326 msgstr ""
21327
21328 #. type: example
21329 #: guix-git/doc/guix.texi:12194
21330 #, no-wrap
21331 msgid ""
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"
21338 "@dots{}\n"
21339 "total: 102.3 MiB\n"
21340 msgstr ""
21341
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."
21345 msgstr ""
21346
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})."
21350 msgstr ""
21351
21352 #. type: Plain text
21353 #: guix-git/doc/guix.texi:12208
21354 msgid "The available options are:"
21355 msgstr ""
21356
21357 #. type: table
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}}."
21360 msgstr ""
21361
21362 #. type: item
21363 #: guix-git/doc/guix.texi:12215
21364 #, no-wrap
21365 msgid "--sort=@var{key}"
21366 msgstr ""
21367
21368 #. type: table
21369 #: guix-git/doc/guix.texi:12217
21370 msgid "Sort lines according to @var{key}, one of the following options:"
21371 msgstr ""
21372
21373 #. type: item
21374 #: guix-git/doc/guix.texi:12219
21375 #, no-wrap
21376 msgid "self"
21377 msgstr "sám"
21378
21379 #. type: table
21380 #: guix-git/doc/guix.texi:12221
21381 msgid "the size of each item (the default);"
21382 msgstr ""
21383
21384 #. type: table
21385 #: guix-git/doc/guix.texi:12223
21386 msgid "the total size of the item's closure."
21387 msgstr ""
21388
21389 #. type: item
21390 #: guix-git/doc/guix.texi:12225
21391 #, no-wrap
21392 msgid "--map-file=@var{file}"
21393 msgstr ""
21394
21395 #. type: table
21396 #: guix-git/doc/guix.texi:12227
21397 msgid "Write a graphical map of disk usage in PNG format to @var{file}."
21398 msgstr ""
21399
21400 #. type: table
21401 #: guix-git/doc/guix.texi:12229
21402 msgid "For the example above, the map looks like this:"
21403 msgstr ""
21404
21405 #. type: table
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}}"
21408 msgstr ""
21409
21410 #. type: table
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."
21413 msgstr ""
21414
21415 #. type: table
21416 #: guix-git/doc/guix.texi:12241
21417 msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}."
21418 msgstr ""
21419
21420 #. type: section
21421 #: guix-git/doc/guix.texi:12252
21422 #, no-wrap
21423 msgid "Invoking @command{guix graph}"
21424 msgstr ""
21425
21426 #. type: cindex
21427 #: guix-git/doc/guix.texi:12254
21428 #, no-wrap
21429 msgid "DAG"
21430 msgstr ""
21431
21432 #. type: command{#1}
21433 #: guix-git/doc/guix.texi:12255
21434 #, no-wrap
21435 msgid "guix graph"
21436 msgstr ""
21437
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:"
21441 msgstr ""
21442
21443 #. type: example
21444 #: guix-git/doc/guix.texi:12273
21445 #, no-wrap
21446 msgid "guix graph @var{options} @var{package}@dots{}\n"
21447 msgstr ""
21448
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:"
21452 msgstr ""
21453
21454 #. type: example
21455 #: guix-git/doc/guix.texi:12281
21456 #, no-wrap
21457 msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n"
21458 msgstr ""
21459
21460 #. type: Plain text
21461 #: guix-git/doc/guix.texi:12284
21462 msgid "The output looks like this:"
21463 msgstr ""
21464
21465 #. type: Plain text
21466 #: guix-git/doc/guix.texi:12286
21467 msgid "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}"
21468 msgstr ""
21469
21470 #. type: Plain text
21471 #: guix-git/doc/guix.texi:12288
21472 msgid "Nice little graph, no?"
21473 msgstr ""
21474
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):"
21478 msgstr ""
21479
21480 #. type: example
21481 #: guix-git/doc/guix.texi:12294
21482 #, no-wrap
21483 msgid "guix graph coreutils | xdot -\n"
21484 msgstr ""
21485
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:"
21489 msgstr ""
21490
21491 #. type: table
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."
21494 msgstr ""
21495
21496 #. type: item
21497 #: guix-git/doc/guix.texi:12308
21498 #, no-wrap
21499 msgid "reverse-package"
21500 msgstr ""
21501
21502 #. type: table
21503 #: guix-git/doc/guix.texi:12310
21504 msgid "This shows the @emph{reverse} DAG of packages. For example:"
21505 msgstr ""
21506
21507 #. type: example
21508 #: guix-git/doc/guix.texi:12313
21509 #, no-wrap
21510 msgid "guix graph --type=reverse-package ocaml\n"
21511 msgstr ""
21512
21513 #. type: table
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)."
21516 msgstr ""
21517
21518 #. type: table
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}})."
21521 msgstr ""
21522
21523 #. type: item
21524 #: guix-git/doc/guix.texi:12324
21525 #, no-wrap
21526 msgid "bag-emerged"
21527 msgstr ""
21528
21529 #. type: table
21530 #: guix-git/doc/guix.texi:12326
21531 msgid "This is the package DAG, @emph{including} implicit inputs."
21532 msgstr ""
21533
21534 #. type: table
21535 #: guix-git/doc/guix.texi:12328
21536 msgid "For instance, the following command:"
21537 msgstr ""
21538
21539 #. type: example
21540 #: guix-git/doc/guix.texi:12331
21541 #, no-wrap
21542 msgid "guix graph --type=bag-emerged coreutils\n"
21543 msgstr ""
21544
21545 #. type: table
21546 #: guix-git/doc/guix.texi:12334
21547 msgid "...@: yields this bigger graph:"
21548 msgstr ""
21549
21550 #. type: table
21551 #: guix-git/doc/guix.texi:12336
21552 msgid "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils}"
21553 msgstr ""
21554
21555 #. type: table
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}})."
21558 msgstr ""
21559
21560 #. type: table
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."
21563 msgstr ""
21564
21565 #. type: item
21566 #: guix-git/doc/guix.texi:12344
21567 #, no-wrap
21568 msgid "bag"
21569 msgstr ""
21570
21571 #. type: table
21572 #: guix-git/doc/guix.texi:12347
21573 msgid "Similar to @code{bag-emerged}, but this time including all the bootstrap dependencies."
21574 msgstr ""
21575
21576 #. type: item
21577 #: guix-git/doc/guix.texi:12348
21578 #, no-wrap
21579 msgid "bag-with-origins"
21580 msgstr ""
21581
21582 #. type: table
21583 #: guix-git/doc/guix.texi:12350
21584 msgid "Similar to @code{bag}, but also showing origins and their dependencies."
21585 msgstr ""
21586
21587 #. type: item
21588 #: guix-git/doc/guix.texi:12351
21589 #, no-wrap
21590 msgid "reverse-bag"
21591 msgstr ""
21592
21593 #. type: table
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:"
21596 msgstr ""
21597
21598 #. type: example
21599 #: guix-git/doc/guix.texi:12357
21600 #, no-wrap
21601 msgid "guix graph -t reverse-bag dune\n"
21602 msgstr ""
21603
21604 #. type: table
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."
21607 msgstr ""
21608
21609 #. type: table
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."
21612 msgstr ""
21613
21614 #. type: table
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:"
21617 msgstr ""
21618
21619 #. type: example
21620 #: guix-git/doc/guix.texi:12376
21621 #, no-wrap
21622 msgid "guix graph -t derivation $(guix system build -d my-config.scm)\n"
21623 msgstr ""
21624
21625 #. type: item
21626 #: guix-git/doc/guix.texi:12378
21627 #, no-wrap
21628 msgid "module"
21629 msgstr ""
21630
21631 #. type: table
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:"
21634 msgstr ""
21635
21636 #. type: example
21637 #: guix-git/doc/guix.texi:12385
21638 #, no-wrap
21639 msgid "guix graph -t module guile | xdot -\n"
21640 msgstr ""
21641
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}:"
21645 msgstr ""
21646
21647 #. type: table
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})."
21650 msgstr ""
21651
21652 #. type: table
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."
21655 msgstr ""
21656
21657 #. type: table
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!):"
21660 msgstr ""
21661
21662 #. type: example
21663 #: guix-git/doc/guix.texi:12405
21664 #, no-wrap
21665 msgid "guix graph -t references $(readlink -f ~/.guix-profile)\n"
21666 msgstr ""
21667
21668 #. type: item
21669 #: guix-git/doc/guix.texi:12407
21670 #, no-wrap
21671 msgid "referrers"
21672 msgstr ""
21673
21674 #. type: table
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})."
21677 msgstr ""
21678
21679 #. type: table
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."
21682 msgstr ""
21683
21684 #. type: table
21685 #: guix-git/doc/guix.texi:12419
21686 msgid "It can help determine what is preventing a store item from being garbage collected."
21687 msgstr ""
21688
21689 #. type: cindex
21690 #: guix-git/doc/guix.texi:12422
21691 #, no-wrap
21692 msgid "shortest path, between packages"
21693 msgstr ""
21694
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.):"
21698 msgstr ""
21699
21700 #. type: example
21701 #: guix-git/doc/guix.texi:12443
21702 #, no-wrap
21703 msgid ""
21704 "$ guix graph --path emacs libunistring\n"
21705 "emacs@@26.3\n"
21706 "mailutils@@3.9\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"
21716 msgstr ""
21717
21718 #. type: Plain text
21719 #: guix-git/doc/guix.texi:12446
21720 msgid "The available options are the following:"
21721 msgstr ""
21722
21723 #. type: table
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."
21726 msgstr ""
21727
21728 #. type: item
21729 #: guix-git/doc/guix.texi:12453
21730 #, no-wrap
21731 msgid "--list-types"
21732 msgstr ""
21733
21734 #. type: table
21735 #: guix-git/doc/guix.texi:12455
21736 msgid "List the supported graph types."
21737 msgstr ""
21738
21739 #. type: item
21740 #: guix-git/doc/guix.texi:12456
21741 #, no-wrap
21742 msgid "--backend=@var{backend}"
21743 msgstr ""
21744
21745 #. type: itemx
21746 #: guix-git/doc/guix.texi:12457
21747 #, no-wrap
21748 msgid "-b @var{backend}"
21749 msgstr ""
21750
21751 #. type: table
21752 #: guix-git/doc/guix.texi:12459
21753 msgid "Produce a graph using the selected @var{backend}."
21754 msgstr ""
21755
21756 #. type: item
21757 #: guix-git/doc/guix.texi:12460
21758 #, no-wrap
21759 msgid "--list-backends"
21760 msgstr ""
21761
21762 #. type: table
21763 #: guix-git/doc/guix.texi:12462
21764 msgid "List the supported graph backends."
21765 msgstr ""
21766
21767 #. type: table
21768 #: guix-git/doc/guix.texi:12464
21769 msgid "Currently, the available backends are Graphviz and d3.js."
21770 msgstr ""
21771
21772 #. type: item
21773 #: guix-git/doc/guix.texi:12465
21774 #, no-wrap
21775 msgid "--path"
21776 msgstr ""
21777
21778 #. type: table
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}:"
21781 msgstr ""
21782
21783 #. type: example
21784 #: guix-git/doc/guix.texi:12477
21785 #, no-wrap
21786 msgid ""
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"
21792 msgstr ""
21793
21794 #. type: example
21795 #: guix-git/doc/guix.texi:12487
21796 #, no-wrap
21797 msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n"
21798 msgstr ""
21799
21800 #. type: table
21801 #: guix-git/doc/guix.texi:12492
21802 msgid "Display the graph for @var{system}---e.g., @code{i686-linux}."
21803 msgstr ""
21804
21805 #. type: table
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."
21808 msgstr ""
21809
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:"
21813 msgstr ""
21814
21815 #. type: example
21816 #: guix-git/doc/guix.texi:12514
21817 #, no-wrap
21818 msgid "guix graph git --with-input=openssl=libressl\n"
21819 msgstr ""
21820
21821 #. type: Plain text
21822 #: guix-git/doc/guix.texi:12517
21823 msgid "So many possibilities, so much fun!"
21824 msgstr ""
21825
21826 #. type: section
21827 #: guix-git/doc/guix.texi:12519
21828 #, no-wrap
21829 msgid "Invoking @command{guix publish}"
21830 msgstr ""
21831
21832 #. type: command{#1}
21833 #: guix-git/doc/guix.texi:12521
21834 #, no-wrap
21835 msgid "guix publish"
21836 msgstr ""
21837
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})."
21841 msgstr ""
21842
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."
21846 msgstr ""
21847
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."
21851 msgstr ""
21852
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})."
21856 msgstr ""
21857
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})."
21861 msgstr ""
21862
21863 #. type: example
21864 #: guix-git/doc/guix.texi:12551
21865 #, no-wrap
21866 msgid "guix publish @var{options}@dots{}\n"
21867 msgstr ""
21868
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:"
21872 msgstr ""
21873
21874 #. type: example
21875 #: guix-git/doc/guix.texi:12558
21876 #, no-wrap
21877 msgid "guix publish\n"
21878 msgstr ""
21879
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}."
21883 msgstr ""
21884
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})."
21888 msgstr ""
21889
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}):"
21893 msgstr ""
21894
21895 #. type: example
21896 #: guix-git/doc/guix.texi:12580
21897 #, no-wrap
21898 msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n"
21899 msgstr ""
21900
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'')."
21904 msgstr ""
21905
21906 #. type: cindex
21907 #: guix-git/doc/guix.texi:12585
21908 #, no-wrap
21909 msgid "build logs, publication"
21910 msgstr ""
21911
21912 #. type: Plain text
21913 #: guix-git/doc/guix.texi:12587
21914 msgid "Build logs are available from @code{/log} URLs like:"
21915 msgstr ""
21916
21917 #. type: example
21918 #: guix-git/doc/guix.texi:12590
21919 #, no-wrap
21920 msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n"
21921 msgstr ""
21922
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."
21926 msgstr ""
21927
21928 #. type: item
21929 #: guix-git/doc/guix.texi:12604
21930 #, no-wrap
21931 msgid "--port=@var{port}"
21932 msgstr ""
21933
21934 #. type: itemx
21935 #: guix-git/doc/guix.texi:12605
21936 #, no-wrap
21937 msgid "-p @var{port}"
21938 msgstr ""
21939
21940 #. type: table
21941 #: guix-git/doc/guix.texi:12607
21942 msgid "Listen for HTTP requests on @var{port}."
21943 msgstr ""
21944
21945 #. type: item
21946 #: guix-git/doc/guix.texi:12608
21947 #, no-wrap
21948 msgid "--listen=@var{host}"
21949 msgstr ""
21950
21951 #. type: table
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."
21954 msgstr ""
21955
21956 #. type: table
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."
21959 msgstr ""
21960
21961 #. type: item
21962 #: guix-git/doc/guix.texi:12617
21963 #, no-wrap
21964 msgid "--compression[=@var{method}[:@var{level}]]"
21965 msgstr ""
21966
21967 #. type: itemx
21968 #: guix-git/doc/guix.texi:12618
21969 #, no-wrap
21970 msgid "-C [@var{method}[:@var{level}]]"
21971 msgstr ""
21972
21973 #. type: table
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."
21976 msgstr ""
21977
21978 #. type: table
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."
21981 msgstr ""
21982
21983 #. type: table
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."
21986 msgstr ""
21987
21988 #. type: table
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}."
21991 msgstr ""
21992
21993 #. type: table
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."
21996 msgstr ""
21997
21998 #. type: table
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."
22001 msgstr ""
22002
22003 #. type: item
22004 #: guix-git/doc/guix.texi:12652
22005 #, no-wrap
22006 msgid "--cache=@var{directory}"
22007 msgstr ""
22008
22009 #. type: itemx
22010 #: guix-git/doc/guix.texi:12653
22011 #, no-wrap
22012 msgid "-c @var{directory}"
22013 msgstr ""
22014
22015 #. type: table
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."
22018 msgstr ""
22019
22020 #. type: table
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."
22023 msgstr ""
22024
22025 #. type: table
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."
22028 msgstr ""
22029
22030 #. type: table
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."
22033 msgstr ""
22034
22035 #. type: table
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."
22038 msgstr ""
22039
22040 #. type: table
22041 #: guix-git/doc/guix.texi:12686
22042 msgid "When @option{--ttl} is used, cached entries are automatically deleted when they have expired."
22043 msgstr ""
22044
22045 #. type: item
22046 #: guix-git/doc/guix.texi:12687
22047 #, no-wrap
22048 msgid "--workers=@var{N}"
22049 msgstr ""
22050
22051 #. type: table
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."
22054 msgstr ""
22055
22056 #. type: item
22057 #: guix-git/doc/guix.texi:12691
22058 #, no-wrap
22059 msgid "--ttl=@var{ttl}"
22060 msgstr ""
22061
22062 #. type: table
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."
22065 msgstr ""
22066
22067 #. type: table
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}."
22070 msgstr ""
22071
22072 #. type: table
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."
22075 msgstr ""
22076
22077 #. type: item
22078 #: guix-git/doc/guix.texi:12705
22079 #, no-wrap
22080 msgid "--cache-bypass-threshold=@var{size}"
22081 msgstr ""
22082
22083 #. type: table
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}."
22086 msgstr ""
22087
22088 #. type: table
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."
22091 msgstr ""
22092
22093 #. type: table
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."
22096 msgstr ""
22097
22098 #. type: item
22099 #: guix-git/doc/guix.texi:12720
22100 #, no-wrap
22101 msgid "--nar-path=@var{path}"
22102 msgstr ""
22103
22104 #. type: table
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})."
22107 msgstr ""
22108
22109 #. type: table
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}."
22112 msgstr ""
22113
22114 #. type: item
22115 #: guix-git/doc/guix.texi:12728
22116 #, no-wrap
22117 msgid "--public-key=@var{file}"
22118 msgstr ""
22119
22120 #. type: itemx
22121 #: guix-git/doc/guix.texi:12729
22122 #, no-wrap
22123 msgid "--private-key=@var{file}"
22124 msgstr ""
22125
22126 #. type: table
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."
22130 msgstr ""
22131
22132 #. type: table
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."
22135 msgstr ""
22136
22137 #. type: item
22138 #: guix-git/doc/guix.texi:12740
22139 #, no-wrap
22140 msgid "--repl[=@var{port}]"
22141 msgstr ""
22142
22143 #. type: itemx
22144 #: guix-git/doc/guix.texi:12741
22145 #, no-wrap
22146 msgid "-r [@var{port}]"
22147 msgstr ""
22148
22149 #. type: table
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."
22152 msgstr ""
22153
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}})."
22157 msgstr ""
22158
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:"
22162 msgstr ""
22163
22164 #. type: itemize
22165 #: guix-git/doc/guix.texi:12758
22166 msgid "If your host distro uses the systemd init system:"
22167 msgstr ""
22168
22169 #. type: example
22170 #: guix-git/doc/guix.texi:12763
22171 #, no-wrap
22172 msgid ""
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"
22176 msgstr ""
22177
22178 #. type: example
22179 #: guix-git/doc/guix.texi:12771
22180 #, no-wrap
22181 msgid ""
22182 "# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n"
22183 "# start guix-publish\n"
22184 msgstr ""
22185
22186 #. type: itemize
22187 #: guix-git/doc/guix.texi:12775
22188 msgid "Otherwise, proceed similarly with your distro's init system."
22189 msgstr ""
22190
22191 #. type: section
22192 #: guix-git/doc/guix.texi:12778
22193 #, no-wrap
22194 msgid "Invoking @command{guix challenge}"
22195 msgstr ""
22196
22197 #. type: cindex
22198 #: guix-git/doc/guix.texi:12781
22199 #, no-wrap
22200 msgid "verifiable builds"
22201 msgstr ""
22202
22203 #. type: command{#1}
22204 #: guix-git/doc/guix.texi:12782
22205 #, no-wrap
22206 msgid "guix challenge"
22207 msgstr ""
22208
22209 #. type: cindex
22210 #: guix-git/doc/guix.texi:12783
22211 #, no-wrap
22212 msgid "challenge"
22213 msgstr ""
22214
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."
22218 msgstr ""
22219
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."
22223 msgstr ""
22224
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."
22228 msgstr ""
22229
22230 #. type: Plain text
22231 #: guix-git/doc/guix.texi:12807
22232 msgid "The command output looks like this:"
22233 msgstr ""
22234
22235 #. type: smallexample
22236 #: guix-git/doc/guix.texi:12819
22237 #, no-wrap
22238 msgid ""
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"
22249 "\n"
22250 msgstr ""
22251
22252 #. type: smallexample
22253 #: guix-git/doc/guix.texi:12826
22254 #, no-wrap
22255 msgid ""
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"
22262 "\n"
22263 msgstr ""
22264
22265 #. type: smallexample
22266 #: guix-git/doc/guix.texi:12833
22267 #, no-wrap
22268 msgid ""
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"
22275 "\n"
22276 msgstr ""
22277
22278 #. type: smallexample
22279 #: guix-git/doc/guix.texi:12835
22280 #, no-wrap
22281 msgid ""
22282 "@dots{}\n"
22283 "\n"
22284 msgstr ""
22285
22286 #. type: smallexample
22287 #: guix-git/doc/guix.texi:12840
22288 #, no-wrap
22289 msgid ""
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"
22294 msgstr ""
22295
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."
22299 msgstr ""
22300
22301 #. type: cindex
22302 #: guix-git/doc/guix.texi:12849
22303 #, no-wrap
22304 msgid "non-determinism, in package builds"
22305 msgstr ""
22306
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."
22310 msgstr ""
22311
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:"
22315 msgstr ""
22316
22317 #. type: example
22318 #: guix-git/doc/guix.texi:12868
22319 #, no-wrap
22320 msgid ""
22321 "guix challenge git \\\n"
22322 " --diff=diffoscope \\\n"
22323 " --substitute-urls=\"https://@value{SUBSTITUTE-SERVER} https://guix.example.org\"\n"
22324 msgstr ""
22325
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."
22329 msgstr ""
22330
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}):"
22334 msgstr ""
22335
22336 #. type: example
22337 #: guix-git/doc/guix.texi:12880
22338 #, no-wrap
22339 msgid ""
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"
22343 msgstr ""
22344
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."
22348 msgstr ""
22349
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."
22353 msgstr ""
22354
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:"
22358 msgstr ""
22359
22360 #. type: example
22361 #: guix-git/doc/guix.texi:12904
22362 #, no-wrap
22363 msgid "$ guix challenge @var{package}\n"
22364 msgstr ""
22365
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}."
22369 msgstr ""
22370
22371 #. type: example
22372 #: guix-git/doc/guix.texi:12914
22373 #, no-wrap
22374 msgid "guix challenge @var{options} [@var{packages}@dots{}]\n"
22375 msgstr ""
22376
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)."
22380 msgstr ""
22381
22382 #. type: Plain text
22383 #: guix-git/doc/guix.texi:12923
22384 msgid "The one option that matters is:"
22385 msgstr ""
22386
22387 #. type: table
22388 #: guix-git/doc/guix.texi:12929
22389 msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs to compare to."
22390 msgstr ""
22391
22392 #. type: item
22393 #: guix-git/doc/guix.texi:12930
22394 #, no-wrap
22395 msgid "--diff=@var{mode}"
22396 msgstr ""
22397
22398 #. type: table
22399 #: guix-git/doc/guix.texi:12932
22400 msgid "Upon mismatches, show differences according to @var{mode}, one of:"
22401 msgstr ""
22402
22403 #. type: item
22404 #: guix-git/doc/guix.texi:12934
22405 #, no-wrap
22406 msgid "@code{simple} (the default)"
22407 msgstr ""
22408
22409 #. type: table
22410 #: guix-git/doc/guix.texi:12936
22411 msgid "Show the list of files that differ."
22412 msgstr ""
22413
22414 #. type: code{#1}
22415 #: guix-git/doc/guix.texi:12937
22416 #, no-wrap
22417 msgid "diffoscope"
22418 msgstr ""
22419
22420 #. type: var{#1}
22421 #: guix-git/doc/guix.texi:12938
22422 #, no-wrap
22423 msgid "command"
22424 msgstr ""
22425
22426 #. type: table
22427 #: guix-git/doc/guix.texi:12941
22428 msgid "Invoke @uref{https://diffoscope.org/, Diffoscope}, passing it two directories whose contents do not match."
22429 msgstr ""
22430
22431 #. type: table
22432 #: guix-git/doc/guix.texi:12944
22433 msgid "When @var{command} is an absolute file name, run @var{command} instead of Diffoscope."
22434 msgstr ""
22435
22436 #. type: item
22437 #: guix-git/doc/guix.texi:12945 guix-git/doc/guix.texi:16257
22438 #: guix-git/doc/guix.texi:18246
22439 #, no-wrap
22440 msgid "none"
22441 msgstr ""
22442
22443 #. type: table
22444 #: guix-git/doc/guix.texi:12947
22445 msgid "Do not show further details about the differences."
22446 msgstr ""
22447
22448 #. type: table
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."
22451 msgstr ""
22452
22453 #. type: item
22454 #: guix-git/doc/guix.texi:12953
22455 #, no-wrap
22456 msgid "--verbose"
22457 msgstr ""
22458
22459 #. type: itemx
22460 #: guix-git/doc/guix.texi:12954
22461 #, no-wrap
22462 msgid "-v"
22463 msgstr ""
22464
22465 #. type: table
22466 #: guix-git/doc/guix.texi:12957
22467 msgid "Show details about matches (identical contents) in addition to information about mismatches."
22468 msgstr ""
22469
22470 #. type: section
22471 #: guix-git/doc/guix.texi:12961
22472 #, no-wrap
22473 msgid "Invoking @command{guix copy}"
22474 msgstr ""
22475
22476 #. type: cindex
22477 #: guix-git/doc/guix.texi:12963
22478 #, no-wrap
22479 msgid "copy, of store items, over SSH"
22480 msgstr ""
22481
22482 #. type: cindex
22483 #: guix-git/doc/guix.texi:12964
22484 #, no-wrap
22485 msgid "SSH, copy of store items"
22486 msgstr ""
22487
22488 #. type: cindex
22489 #: guix-git/doc/guix.texi:12965
22490 #, no-wrap
22491 msgid "sharing store items across machines"
22492 msgstr ""
22493
22494 #. type: cindex
22495 #: guix-git/doc/guix.texi:12966
22496 #, no-wrap
22497 msgid "transferring store items across machines"
22498 msgstr ""
22499
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}:"
22503 msgstr ""
22504
22505 #. type: example
22506 #: guix-git/doc/guix.texi:12977
22507 #, no-wrap
22508 msgid ""
22509 "guix copy --to=@var{user}@@@var{host} \\\n"
22510 " coreutils $(readlink -f ~/.guix-profile)\n"
22511 msgstr ""
22512
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."
22516 msgstr ""
22517
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:"
22521 msgstr ""
22522
22523 #. type: example
22524 #: guix-git/doc/guix.texi:12987
22525 #, no-wrap
22526 msgid "guix copy --from=@var{host} libreoffice gimp\n"
22527 msgstr ""
22528
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."
22532 msgstr ""
22533
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."
22537 msgstr ""
22538
22539 #. type: example
22540 #: guix-git/doc/guix.texi:13003
22541 #, no-wrap
22542 msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n"
22543 msgstr ""
22544
22545 #. type: Plain text
22546 #: guix-git/doc/guix.texi:13006
22547 msgid "You must always specify one of the following options:"
22548 msgstr ""
22549
22550 #. type: item
22551 #: guix-git/doc/guix.texi:13008
22552 #, no-wrap
22553 msgid "--to=@var{spec}"
22554 msgstr ""
22555
22556 #. type: itemx
22557 #: guix-git/doc/guix.texi:13009
22558 #, no-wrap
22559 msgid "--from=@var{spec}"
22560 msgstr ""
22561
22562 #. type: table
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}."
22565 msgstr ""
22566
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}."
22570 msgstr ""
22571
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})."
22575 msgstr ""
22576
22577 #. type: section
22578 #: guix-git/doc/guix.texi:13024
22579 #, no-wrap
22580 msgid "Invoking @command{guix container}"
22581 msgstr ""
22582
22583 #. type: command{#1}
22584 #: guix-git/doc/guix.texi:13026
22585 #, no-wrap
22586 msgid "guix container"
22587 msgstr ""
22588
22589 #. type: quotation
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."
22592 msgstr ""
22593
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."
22597 msgstr ""
22598
22599 #. type: example
22600 #: guix-git/doc/guix.texi:13042
22601 #, no-wrap
22602 msgid "guix container @var{action} @var{options}@dots{}\n"
22603 msgstr ""
22604
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."
22608 msgstr ""
22609
22610 #. type: Plain text
22611 #: guix-git/doc/guix.texi:13048
22612 msgid "The following actions are available:"
22613 msgstr ""
22614
22615 #. type: item
22616 #: guix-git/doc/guix.texi:13050
22617 #, no-wrap
22618 msgid "exec"
22619 msgstr ""
22620
22621 #. type: table
22622 #: guix-git/doc/guix.texi:13052
22623 msgid "Execute a command within the context of a running container."
22624 msgstr ""
22625
22626 #. type: table
22627 #: guix-git/doc/guix.texi:13054
22628 msgid "The syntax is:"
22629 msgstr ""
22630
22631 #. type: example
22632 #: guix-git/doc/guix.texi:13057
22633 #, no-wrap
22634 msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n"
22635 msgstr ""
22636
22637 #. type: table
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}."
22640 msgstr ""
22641
22642 #. type: table
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:"
22645 msgstr ""
22646
22647 #. type: example
22648 #: guix-git/doc/guix.texi:13070
22649 #, no-wrap
22650 msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n"
22651 msgstr ""
22652
22653 #. type: table
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."
22656 msgstr ""
22657
22658 #. type: section
22659 #: guix-git/doc/guix.texi:13078
22660 #, no-wrap
22661 msgid "Invoking @command{guix weather}"
22662 msgstr ""
22663
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})."
22667 msgstr ""
22668
22669 #. type: cindex
22670 #: guix-git/doc/guix.texi:13088
22671 #, no-wrap
22672 msgid "statistics, for substitutes"
22673 msgstr ""
22674
22675 #. type: cindex
22676 #: guix-git/doc/guix.texi:13089
22677 #, no-wrap
22678 msgid "availability of substitutes"
22679 msgstr ""
22680
22681 #. type: cindex
22682 #: guix-git/doc/guix.texi:13090
22683 #, no-wrap
22684 msgid "substitute availability"
22685 msgstr ""
22686
22687 #. type: cindex
22688 #: guix-git/doc/guix.texi:13091
22689 #, no-wrap
22690 msgid "weather, substitute availability"
22691 msgstr ""
22692
22693 #. type: Plain text
22694 #: guix-git/doc/guix.texi:13093
22695 msgid "Here's a sample run:"
22696 msgstr ""
22697
22698 #. type: example
22699 #: guix-git/doc/guix.texi:13105
22700 #, no-wrap
22701 msgid ""
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"
22712 "\n"
22713 msgstr ""
22714
22715 #. type: example
22716 #: guix-git/doc/guix.texi:13115
22717 #, no-wrap
22718 msgid ""
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"
22728 msgstr ""
22729
22730 #. type: cindex
22731 #: guix-git/doc/guix.texi:13117
22732 #, no-wrap
22733 msgid "continuous integration, statistics"
22734 msgstr ""
22735
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)."
22739 msgstr ""
22740
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."
22744 msgstr ""
22745
22746 #. type: example
22747 #: guix-git/doc/guix.texi:13139
22748 #, no-wrap
22749 msgid "guix weather @var{options}@dots{} [@var{packages}@dots{}]\n"
22750 msgstr ""
22751
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%."
22755 msgstr ""
22756
22757 #. type: Plain text
22758 #: guix-git/doc/guix.texi:13149
22759 msgid "The available options are listed below."
22760 msgstr ""
22761
22762 #. type: table
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."
22765 msgstr ""
22766
22767 #. type: table
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."
22770 msgstr ""
22771
22772 #. type: table
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})."
22775 msgstr ""
22776
22777 #. type: table
22778 #: guix-git/doc/guix.texi:13170
22779 msgid "This option can be repeated several times, in which case the manifests are concatenated."
22780 msgstr ""
22781
22782 #. type: item
22783 #: guix-git/doc/guix.texi:13171
22784 #, no-wrap
22785 msgid "--coverage[=@var{count}]"
22786 msgstr ""
22787
22788 #. type: itemx
22789 #: guix-git/doc/guix.texi:13172
22790 #, no-wrap
22791 msgid "-c [@var{count}]"
22792 msgstr ""
22793
22794 #. type: table
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:"
22797 msgstr ""
22798
22799 #. type: example
22800 #: guix-git/doc/guix.texi:13192
22801 #, no-wrap
22802 msgid ""
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"
22809 "@dots{}\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"
22814 " @dots{}\n"
22815 msgstr ""
22816
22817 #. type: table
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."
22820 msgstr ""
22821
22822 #. type: table
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."
22825 msgstr ""
22826
22827 #. type: item
22828 #: guix-git/doc/guix.texi:13203
22829 #, no-wrap
22830 msgid "--display-missing"
22831 msgstr ""
22832
22833 #. type: table
22834 #: guix-git/doc/guix.texi:13205
22835 msgid "Display the list of store items for which substitutes are missing."
22836 msgstr ""
22837
22838 #. type: section
22839 #: guix-git/doc/guix.texi:13208
22840 #, no-wrap
22841 msgid "Invoking @command{guix processes}"
22842 msgstr ""
22843
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:"
22847 msgstr ""
22848
22849 #. type: example
22850 #: guix-git/doc/guix.texi:13222
22851 #, no-wrap
22852 msgid ""
22853 "$ sudo guix processes\n"
22854 "SessionPID: 19002\n"
22855 "ClientPID: 19090\n"
22856 "ClientCommand: guix environment --ad-hoc python\n"
22857 "\n"
22858 msgstr ""
22859
22860 #. type: example
22861 #: guix-git/doc/guix.texi:13226
22862 #, no-wrap
22863 msgid ""
22864 "SessionPID: 19402\n"
22865 "ClientPID: 19367\n"
22866 "ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{}\n"
22867 "\n"
22868 msgstr ""
22869
22870 #. type: example
22871 #: guix-git/doc/guix.texi:13239
22872 #, no-wrap
22873 msgid ""
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"
22886 msgstr ""
22887
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."
22891 msgstr ""
22892
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})."
22896 msgstr ""
22897
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:"
22901 msgstr ""
22902
22903 #. type: example
22904 #: guix-git/doc/guix.texi:13264
22905 #, no-wrap
22906 msgid ""
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"
22911 msgstr ""
22912
22913 #. type: Plain text
22914 #: guix-git/doc/guix.texi:13267
22915 msgid "Additional options are listed below."
22916 msgstr ""
22917
22918 #. type: table
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."
22921 msgstr ""
22922
22923 #. type: item
22924 #: guix-git/doc/guix.texi:13278
22925 #, no-wrap
22926 msgid "normalized"
22927 msgstr ""
22928
22929 #. type: table
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}."
22932 msgstr ""
22933
22934 #. type: example
22935 #: guix-git/doc/guix.texi:13295
22936 #, no-wrap
22937 msgid ""
22938 "$ guix processes --format=normalized | \\\n"
22939 " recsel \\\n"
22940 " -j Session \\\n"
22941 " -t ChildProcess \\\n"
22942 " -p Session.PID,PID \\\n"
22943 " -e 'Session.ClientCommand ~ \"guix build\"'\n"
22944 "PID: 4435\n"
22945 "Session_PID: 4278\n"
22946 "\n"
22947 msgstr ""
22948
22949 #. type: example
22950 #: guix-git/doc/guix.texi:13298
22951 #, no-wrap
22952 msgid ""
22953 "PID: 4554\n"
22954 "Session_PID: 4278\n"
22955 "\n"
22956 msgstr ""
22957
22958 #. type: example
22959 #: guix-git/doc/guix.texi:13301
22960 #, no-wrap
22961 msgid ""
22962 "PID: 4646\n"
22963 "Session_PID: 4278\n"
22964 msgstr ""
22965
22966 #. type: cindex
22967 #: guix-git/doc/guix.texi:13308
22968 #, no-wrap
22969 msgid "system configuration"
22970 msgstr ""
22971
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."
22975 msgstr ""
22976
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."
22980 msgstr ""
22981
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."
22985 msgstr ""
22986
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:"
22990 msgstr ""
22991
22992 #. type: code{#1}
22993 #: guix-git/doc/guix.texi:13359 guix-git/doc/guix.texi:33410
22994 #, no-wrap
22995 msgid "operating-system"
22996 msgstr ""
22997
22998 #. type: include
22999 #: guix-git/doc/guix.texi:13361
23000 #, no-wrap
23001 msgid "os-config-bare-bones.texi"
23002 msgstr ""
23003
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."
23007 msgstr ""
23008
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}."
23012 msgstr ""
23013
23014 #. type: unnumberedsubsec
23015 #: guix-git/doc/guix.texi:13374
23016 #, no-wrap
23017 msgid "Bootloader"
23018 msgstr ""
23019
23020 #. type: cindex
23021 #: guix-git/doc/guix.texi:13376
23022 #, no-wrap
23023 msgid "legacy boot, on Intel machines"
23024 msgstr ""
23025
23026 #. type: cindex
23027 #: guix-git/doc/guix.texi:13377
23028 #, no-wrap
23029 msgid "BIOS boot, on Intel machines"
23030 msgstr ""
23031
23032 #. type: cindex
23033 #: guix-git/doc/guix.texi:13378
23034 #, no-wrap
23035 msgid "UEFI boot"
23036 msgstr ""
23037
23038 #. type: cindex
23039 #: guix-git/doc/guix.texi:13379
23040 #, no-wrap
23041 msgid "EFI boot"
23042 msgstr ""
23043
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:"
23047 msgstr ""
23048
23049 #. type: lisp
23050 #: guix-git/doc/guix.texi:13390
23051 #, no-wrap
23052 msgid ""
23053 "(bootloader-configuration\n"
23054 " (bootloader grub-efi-bootloader)\n"
23055 " (target \"/boot/efi\"))\n"
23056 msgstr ""
23057
23058 #. type: Plain text
23059 #: guix-git/doc/guix.texi:13394
23060 msgid "@xref{Bootloader Configuration}, for more information on the available configuration options."
23061 msgstr ""
23062
23063 #. type: unnumberedsubsec
23064 #: guix-git/doc/guix.texi:13395
23065 #, no-wrap
23066 msgid "Globally-Visible Packages"
23067 msgstr ""
23068
23069 #. type: vindex
23070 #: guix-git/doc/guix.texi:13397
23071 #, no-wrap
23072 msgid "%base-packages"
23073 msgstr ""
23074
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:"
23078 msgstr ""
23079
23080 #. type: lisp
23081 #: guix-git/doc/guix.texi:13414
23082 #, no-wrap
23083 msgid ""
23084 "(use-modules (gnu packages))\n"
23085 "(use-modules (gnu packages dns))\n"
23086 "\n"
23087 msgstr ""
23088
23089 #. type: lisp
23090 #: guix-git/doc/guix.texi:13419
23091 #, no-wrap
23092 msgid ""
23093 "(operating-system\n"
23094 " ;; ...\n"
23095 " (packages (cons (list bind \"utils\")\n"
23096 " %base-packages)))\n"
23097 msgstr ""
23098
23099 #. type: findex
23100 #: guix-git/doc/guix.texi:13421
23101 #, no-wrap
23102 msgid "specification->package"
23103 msgstr ""
23104
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:"
23108 msgstr ""
23109
23110 #. type: lisp
23111 #: guix-git/doc/guix.texi:13433
23112 #, no-wrap
23113 msgid ""
23114 "(use-modules (gnu packages))\n"
23115 "\n"
23116 msgstr ""
23117
23118 #. type: lisp
23119 #: guix-git/doc/guix.texi:13439
23120 #, no-wrap
23121 msgid ""
23122 "(operating-system\n"
23123 " ;; ...\n"
23124 " (packages (append (map specification->package\n"
23125 " '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n"
23126 " %base-packages)))\n"
23127 msgstr ""
23128
23129 #. type: unnumberedsubsec
23130 #: guix-git/doc/guix.texi:13441
23131 #, no-wrap
23132 msgid "System Services"
23133 msgstr ""
23134
23135 #. type: cindex
23136 #: guix-git/doc/guix.texi:13443 guix-git/doc/guix.texi:32193
23137 #: guix-git/doc/guix.texi:33635
23138 #, no-wrap
23139 msgid "services"
23140 msgstr ""
23141
23142 #. type: vindex
23143 #: guix-git/doc/guix.texi:13444
23144 #, no-wrap
23145 msgid "%base-services"
23146 msgstr ""
23147
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})."
23151 msgstr ""
23152
23153 #. type: cindex
23154 #: guix-git/doc/guix.texi:13455
23155 #, no-wrap
23156 msgid "customization, of services"
23157 msgstr ""
23158
23159 #. type: findex
23160 #: guix-git/doc/guix.texi:13456
23161 #, no-wrap
23162 msgid "modify-services"
23163 msgstr ""
23164
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."
23168 msgstr ""
23169
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:"
23173 msgstr ""
23174
23175 #. type: lisp
23176 #: guix-git/doc/guix.texi:13482
23177 #, no-wrap
23178 msgid ""
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"
23194 "\n"
23195 msgstr ""
23196
23197 #. type: lisp
23198 #: guix-git/doc/guix.texi:13486
23199 #, no-wrap
23200 msgid ""
23201 "(operating-system\n"
23202 " ;; @dots{}\n"
23203 " (services %my-services))\n"
23204 msgstr ""
23205
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."
23209 msgstr ""
23210
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:"
23214 msgstr ""
23215
23216 #. type: include
23217 #: guix-git/doc/guix.texi:13506
23218 #, no-wrap
23219 msgid "os-config-desktop.texi"
23220 msgstr ""
23221
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:"
23225 msgstr ""
23226
23227 #. type: include
23228 #: guix-git/doc/guix.texi:13513
23229 #, no-wrap
23230 msgid "os-config-lightweight-desktop.texi"
23231 msgstr ""
23232
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."
23236 msgstr ""
23237
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."
23241 msgstr ""
23242
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:"
23246 msgstr ""
23247
23248 #. type: lisp
23249 #: guix-git/doc/guix.texi:13535
23250 #, no-wrap
23251 msgid ""
23252 "(remove (lambda (service)\n"
23253 " (eq? (service-kind service) avahi-service-type))\n"
23254 " %desktop-services)\n"
23255 msgstr ""
23256
23257 #. type: Plain text
23258 #: guix-git/doc/guix.texi:13538
23259 msgid "Alternatively, the @code{modify-services} macro can be used:"
23260 msgstr ""
23261
23262 #. type: lisp
23263 #: guix-git/doc/guix.texi:13542
23264 #, no-wrap
23265 msgid ""
23266 "(modify-services %desktop-services\n"
23267 " (delete avahi-service-type))\n"
23268 msgstr ""
23269
23270 #. type: unnumberedsubsec
23271 #: guix-git/doc/guix.texi:13545
23272 #, no-wrap
23273 msgid "Instantiating the System"
23274 msgstr ""
23275
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})."
23279 msgstr ""
23280
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."
23284 msgstr ""
23285
23286 #. type: cindex
23287 #: guix-git/doc/guix.texi:13561
23288 #, no-wrap
23289 msgid "roll-back, of the operating system"
23290 msgstr ""
23291
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}."
23295 msgstr ""
23296
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})."
23300 msgstr ""
23301
23302 #. type: unnumberedsubsec
23303 #: guix-git/doc/guix.texi:13578
23304 #, no-wrap
23305 msgid "The Programming Interface"
23306 msgstr ""
23307
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}):"
23311 msgstr ""
23312
23313 #. type: deffn
23314 #: guix-git/doc/guix.texi:13584
23315 #, no-wrap
23316 msgid "{Monadic Procedure} operating-system-derivation os"
23317 msgstr ""
23318
23319 #. type: deffn
23320 #: guix-git/doc/guix.texi:13587
23321 msgid "Return a derivation that builds @var{os}, an @code{operating-system} object (@pxref{Derivations})."
23322 msgstr ""
23323
23324 #. type: deffn
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}."
23327 msgstr ""
23328
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!"
23332 msgstr ""
23333
23334 #. type: section
23335 #: guix-git/doc/guix.texi:13599
23336 #, no-wrap
23337 msgid "@code{operating-system} Reference"
23338 msgstr ""
23339
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})."
23343 msgstr ""
23344
23345 #. type: deftp
23346 #: guix-git/doc/guix.texi:13605
23347 #, no-wrap
23348 msgid "{Data Type} operating-system"
23349 msgstr ""
23350
23351 #. type: deftp
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})."
23354 msgstr ""
23355
23356 #. type: item
23357 #: guix-git/doc/guix.texi:13611
23358 #, no-wrap
23359 msgid "@code{kernel} (default: @code{linux-libre})"
23360 msgstr ""
23361
23362 #. type: table
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.}."
23365 msgstr ""
23366
23367 #. type: code{#1}
23368 #: guix-git/doc/guix.texi:13617 guix-git/doc/guix.texi:28901
23369 #, no-wrap
23370 msgid "hurd"
23371 msgstr ""
23372
23373 #. type: item
23374 #: guix-git/doc/guix.texi:13618
23375 #, no-wrap
23376 msgid "@code{hurd} (default: @code{#f})"
23377 msgstr ""
23378
23379 #. type: table
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."
23382 msgstr ""
23383
23384 #. type: quotation
23385 #: guix-git/doc/guix.texi:13626
23386 msgid "This feature is experimental and only supported for disk images."
23387 msgstr ""
23388
23389 #. type: item
23390 #: guix-git/doc/guix.texi:13628
23391 #, no-wrap
23392 msgid "@code{kernel-loadable-modules} (default: '())"
23393 msgstr ""
23394
23395 #. type: table
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)}."
23398 msgstr ""
23399
23400 #. type: item
23401 #: guix-git/doc/guix.texi:13632
23402 #, no-wrap
23403 msgid "@code{kernel-arguments} (default: @code{%default-kernel-arguments})"
23404 msgstr ""
23405
23406 #. type: table
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\")}."
23409 msgstr ""
23410
23411 #. type: code{#1}
23412 #: guix-git/doc/guix.texi:13636 guix-git/doc/guix.texi:32406
23413 #: guix-git/doc/guix.texi:32425
23414 #, no-wrap
23415 msgid "bootloader"
23416 msgstr ""
23417
23418 #. type: table
23419 #: guix-git/doc/guix.texi:13638
23420 msgid "The system bootloader configuration object. @xref{Bootloader Configuration}."
23421 msgstr ""
23422
23423 #. type: code{#1}
23424 #: guix-git/doc/guix.texi:13639 guix-git/doc/guix.texi:32595
23425 #, no-wrap
23426 msgid "label"
23427 msgstr ""
23428
23429 #. type: table
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."
23432 msgstr ""
23433
23434 #. type: item
23435 #: guix-git/doc/guix.texi:13643 guix-git/doc/guix.texi:18070
23436 #: guix-git/doc/guix.texi:32525
23437 #, no-wrap
23438 msgid "@code{keyboard-layout} (default: @code{#f})"
23439 msgstr ""
23440
23441 #. type: table
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."
23444 msgstr ""
23445
23446 #. type: table
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})."
23449 msgstr ""
23450
23451 #. type: quotation
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."
23454 msgstr ""
23455
23456 #. type: item
23457 #: guix-git/doc/guix.texi:13662
23458 #, no-wrap
23459 msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})"
23460 msgstr ""
23461
23462 #. type: cindex
23463 #: guix-git/doc/guix.texi:13663 guix-git/doc/guix.texi:32230
23464 #: guix-git/doc/guix.texi:32334
23465 #, no-wrap
23466 msgid "initrd"
23467 msgstr ""
23468
23469 #. type: cindex
23470 #: guix-git/doc/guix.texi:13664 guix-git/doc/guix.texi:32231
23471 #: guix-git/doc/guix.texi:32335
23472 #, no-wrap
23473 msgid "initial RAM disk"
23474 msgstr ""
23475
23476 #. type: table
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}."
23479 msgstr ""
23480
23481 #. type: item
23482 #: guix-git/doc/guix.texi:13668
23483 #, no-wrap
23484 msgid "@code{initrd} (default: @code{base-initrd})"
23485 msgstr ""
23486
23487 #. type: table
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}."
23490 msgstr ""
23491
23492 #. type: item
23493 #: guix-git/doc/guix.texi:13673
23494 #, no-wrap
23495 msgid "@code{firmware} (default: @code{%base-firmware})"
23496 msgstr ""
23497
23498 #. type: cindex
23499 #: guix-git/doc/guix.texi:13674
23500 #, no-wrap
23501 msgid "firmware"
23502 msgstr ""
23503
23504 #. type: table
23505 #: guix-git/doc/guix.texi:13676
23506 msgid "List of firmware packages loadable by the operating system kernel."
23507 msgstr ""
23508
23509 #. type: table
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."
23512 msgstr ""
23513
23514 #. type: code{#1}
23515 #: guix-git/doc/guix.texi:13682 guix-git/doc/guix.texi:33429
23516 #, no-wrap
23517 msgid "host-name"
23518 msgstr ""
23519
23520 #. type: table
23521 #: guix-git/doc/guix.texi:13684
23522 msgid "The host name."
23523 msgstr ""
23524
23525 #. type: code{#1}
23526 #: guix-git/doc/guix.texi:13685
23527 #, no-wrap
23528 msgid "hosts-file"
23529 msgstr ""
23530
23531 #. type: cindex
23532 #: guix-git/doc/guix.texi:13686
23533 #, no-wrap
23534 msgid "hosts file"
23535 msgstr ""
23536
23537 #. type: table
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}."
23540 msgstr ""
23541
23542 #. type: item
23543 #: guix-git/doc/guix.texi:13692
23544 #, no-wrap
23545 msgid "@code{mapped-devices} (default: @code{'()})"
23546 msgstr ""
23547
23548 #. type: table
23549 #: guix-git/doc/guix.texi:13694
23550 msgid "A list of mapped devices. @xref{Mapped Devices}."
23551 msgstr ""
23552
23553 #. type: code{#1}
23554 #: guix-git/doc/guix.texi:13695
23555 #, no-wrap
23556 msgid "file-systems"
23557 msgstr ""
23558
23559 #. type: table
23560 #: guix-git/doc/guix.texi:13697
23561 msgid "A list of file systems. @xref{File Systems}."
23562 msgstr ""
23563
23564 #. type: cindex
23565 #: guix-git/doc/guix.texi:13698
23566 #, no-wrap
23567 msgid "swap devices"
23568 msgstr ""
23569
23570 #. type: cindex
23571 #: guix-git/doc/guix.texi:13699
23572 #, no-wrap
23573 msgid "swap space"
23574 msgstr ""
23575
23576 #. type: item
23577 #: guix-git/doc/guix.texi:13700
23578 #, no-wrap
23579 msgid "@code{swap-devices} (default: @code{'()})"
23580 msgstr ""
23581
23582 #. type: table
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:"
23585 msgstr ""
23586
23587 #. type: item
23588 #: guix-git/doc/guix.texi:13707
23589 #, no-wrap
23590 msgid "(list (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\"))"
23591 msgstr ""
23592
23593 #. type: table
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."
23596 msgstr ""
23597
23598 #. type: item
23599 #: guix-git/doc/guix.texi:13712
23600 #, no-wrap
23601 msgid "(list (file-system-label \"swap\"))"
23602 msgstr ""
23603
23604 #. type: table
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."
23607 msgstr ""
23608
23609 #. type: item
23610 #: guix-git/doc/guix.texi:13717
23611 #, no-wrap
23612 msgid "(list \"/swapfile\")"
23613 msgstr ""
23614
23615 #. type: table
23616 #: guix-git/doc/guix.texi:13719
23617 msgid "Use the file @file{/swapfile} as swap space."
23618 msgstr ""
23619
23620 #. type: item
23621 #: guix-git/doc/guix.texi:13720
23622 #, no-wrap
23623 msgid "(list \"/dev/sda3\" \"/dev/sdb2\")"
23624 msgstr ""
23625
23626 #. type: table
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."
23629 msgstr ""
23630
23631 #. type: table
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}."
23634 msgstr ""
23635
23636 #. type: item
23637 #: guix-git/doc/guix.texi:13731
23638 #, no-wrap
23639 msgid "@code{users} (default: @code{%base-user-accounts})"
23640 msgstr ""
23641
23642 #. type: itemx
23643 #: guix-git/doc/guix.texi:13732
23644 #, no-wrap
23645 msgid "@code{groups} (default: @code{%base-groups})"
23646 msgstr ""
23647
23648 #. type: table
23649 #: guix-git/doc/guix.texi:13734
23650 msgid "List of user accounts and groups. @xref{User Accounts}."
23651 msgstr ""
23652
23653 #. type: table
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."
23656 msgstr ""
23657
23658 #. type: item
23659 #: guix-git/doc/guix.texi:13738
23660 #, no-wrap
23661 msgid "@code{skeletons} (default: @code{(default-skeletons)})"
23662 msgstr ""
23663
23664 #. type: table
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."
23667 msgstr ""
23668
23669 #. type: table
23670 #: guix-git/doc/guix.texi:13744
23671 msgid "For instance, a valid value may look like this:"
23672 msgstr ""
23673
23674 #. type: lisp
23675 #: guix-git/doc/guix.texi:13750
23676 #, no-wrap
23677 msgid ""
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"
23682 msgstr ""
23683
23684 #. type: item
23685 #: guix-git/doc/guix.texi:13752
23686 #, no-wrap
23687 msgid "@code{issue} (default: @code{%default-issue})"
23688 msgstr ""
23689
23690 #. type: table
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."
23693 msgstr ""
23694
23695 #. type: item
23696 #: guix-git/doc/guix.texi:13756
23697 #, no-wrap
23698 msgid "@code{packages} (default: @code{%base-packages})"
23699 msgstr ""
23700
23701 #. type: table
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:"
23704 msgstr ""
23705
23706 #. type: lisp
23707 #: guix-git/doc/guix.texi:13765
23708 #, no-wrap
23709 msgid ""
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"
23713 msgstr ""
23714
23715 #. type: table
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})."
23718 msgstr ""
23719
23720 #. type: code{#1}
23721 #: guix-git/doc/guix.texi:13771
23722 #, no-wrap
23723 msgid "timezone"
23724 msgstr ""
23725
23726 #. type: table
23727 #: guix-git/doc/guix.texi:13773
23728 msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}."
23729 msgstr ""
23730
23731 #. type: table
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."
23734 msgstr ""
23735
23736 #. type: item
23737 #: guix-git/doc/guix.texi:13778 guix-git/doc/guix.texi:19681
23738 #, no-wrap
23739 msgid "@code{locale} (default: @code{\"en_US.utf8\"})"
23740 msgstr ""
23741
23742 #. type: table
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."
23745 msgstr ""
23746
23747 #. type: item
23748 #: guix-git/doc/guix.texi:13782
23749 #, no-wrap
23750 msgid "@code{locale-definitions} (default: @code{%default-locale-definitions})"
23751 msgstr ""
23752
23753 #. type: table
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}."
23756 msgstr ""
23757
23758 #. type: item
23759 #: guix-git/doc/guix.texi:13786
23760 #, no-wrap
23761 msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})"
23762 msgstr ""
23763
23764 #. type: table
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."
23767 msgstr ""
23768
23769 #. type: item
23770 #: guix-git/doc/guix.texi:13791
23771 #, no-wrap
23772 msgid "@code{name-service-switch} (default: @code{%default-nss})"
23773 msgstr ""
23774
23775 #. type: table
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."
23778 msgstr ""
23779
23780 #. type: item
23781 #: guix-git/doc/guix.texi:13796
23782 #, no-wrap
23783 msgid "@code{services} (default: @code{%base-services})"
23784 msgstr ""
23785
23786 #. type: table
23787 #: guix-git/doc/guix.texi:13798
23788 msgid "A list of service objects denoting system services. @xref{Services}."
23789 msgstr ""
23790
23791 #. type: cindex
23792 #: guix-git/doc/guix.texi:13799
23793 #, no-wrap
23794 msgid "essential services"
23795 msgstr ""
23796
23797 #. type: item
23798 #: guix-git/doc/guix.texi:13800
23799 #, no-wrap
23800 msgid "@code{essential-services} (default: ...)"
23801 msgstr ""
23802
23803 #. type: table
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."
23806 msgstr ""
23807
23808 #. type: item
23809 #: guix-git/doc/guix.texi:13806
23810 #, no-wrap
23811 msgid "@code{pam-services} (default: @code{(base-pam-services)})"
23812 msgstr ""
23813
23814 #. type: cindex
23815 #: guix-git/doc/guix.texi:13807
23816 #, no-wrap
23817 msgid "PAM"
23818 msgstr ""
23819
23820 #. type: cindex
23821 #: guix-git/doc/guix.texi:13808
23822 #, no-wrap
23823 msgid "pluggable authentication modules"
23824 msgstr ""
23825
23826 #. type: table
23827 #: guix-git/doc/guix.texi:13811
23828 msgid "Linux @dfn{pluggable authentication module} (PAM) services."
23829 msgstr ""
23830
23831 #. type: item
23832 #: guix-git/doc/guix.texi:13812
23833 #, no-wrap
23834 msgid "@code{setuid-programs} (default: @code{%setuid-programs})"
23835 msgstr ""
23836
23837 #. type: table
23838 #: guix-git/doc/guix.texi:13815
23839 msgid "List of string-valued G-expressions denoting setuid programs. @xref{Setuid Programs}."
23840 msgstr ""
23841
23842 #. type: item
23843 #: guix-git/doc/guix.texi:13816
23844 #, no-wrap
23845 msgid "@code{sudoers-file} (default: @code{%sudoers-specification})"
23846 msgstr ""
23847
23848 #. type: cindex
23849 #: guix-git/doc/guix.texi:13817
23850 #, no-wrap
23851 msgid "sudoers file"
23852 msgstr ""
23853
23854 #. type: table
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}})."
23857 msgstr ""
23858
23859 #. type: table
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}."
23862 msgstr ""
23863
23864 #. type: deffn
23865 #: guix-git/doc/guix.texi:13828
23866 #, no-wrap
23867 msgid "{Scheme Syntax} this-operating-system"
23868 msgstr ""
23869
23870 #. type: deffn
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."
23873 msgstr ""
23874
23875 #. type: deffn
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:"
23878 msgstr ""
23879
23880 #. type: lisp
23881 #: guix-git/doc/guix.texi:13837 guix-git/doc/guix.texi:17299
23882 #, no-wrap
23883 msgid ""
23884 "(use-modules (gnu) (guix))\n"
23885 "\n"
23886 msgstr ""
23887
23888 #. type: lisp
23889 #: guix-git/doc/guix.texi:13842
23890 #, no-wrap
23891 msgid ""
23892 "(operating-system\n"
23893 " ;; ...\n"
23894 " (label (package-full-name\n"
23895 " (operating-system-kernel this-operating-system))))\n"
23896 msgstr ""
23897
23898 #. type: deffn
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."
23901 msgstr ""
23902
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:"
23906 msgstr ""
23907
23908 #. type: lisp
23909 #: guix-git/doc/guix.texi:13863
23910 #, no-wrap
23911 msgid ""
23912 "(file-system\n"
23913 " (mount-point \"/home\")\n"
23914 " (device \"/dev/sda3\")\n"
23915 " (type \"ext4\"))\n"
23916 msgstr ""
23917
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."
23921 msgstr ""
23922
23923 #. type: deftp
23924 #: guix-git/doc/guix.texi:13868
23925 #, no-wrap
23926 msgid "{Data Type} file-system"
23927 msgstr ""
23928
23929 #. type: deftp
23930 #: guix-git/doc/guix.texi:13871
23931 msgid "Objects of this type represent file systems to be mounted. They contain the following members:"
23932 msgstr ""
23933
23934 #. type: item
23935 #: guix-git/doc/guix.texi:13873 guix-git/doc/guix.texi:14223
23936 #, no-wrap
23937 msgid "type"
23938 msgstr ""
23939
23940 #. type: table
23941 #: guix-git/doc/guix.texi:13876
23942 msgid "This is a string specifying the type of the file system---e.g., @code{\"ext4\"}."
23943 msgstr ""
23944
23945 #. type: code{#1}
23946 #: guix-git/doc/guix.texi:13877
23947 #, no-wrap
23948 msgid "mount-point"
23949 msgstr ""
23950
23951 #. type: table
23952 #: guix-git/doc/guix.texi:13879
23953 msgid "This designates the place where the file system is to be mounted."
23954 msgstr ""
23955
23956 #. type: code{#1}
23957 #: guix-git/doc/guix.texi:13880
23958 #, no-wrap
23959 msgid "device"
23960 msgstr ""
23961
23962 #. type: table
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.}."
23965 msgstr ""
23966
23967 #. type: findex
23968 #: guix-git/doc/guix.texi:13891
23969 #, no-wrap
23970 msgid "file-system-label"
23971 msgstr ""
23972
23973 #. type: table
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:"
23976 msgstr ""
23977
23978 #. type: lisp
23979 #: guix-git/doc/guix.texi:13902
23980 #, no-wrap
23981 msgid ""
23982 "(file-system\n"
23983 " (mount-point \"/home\")\n"
23984 " (type \"ext4\")\n"
23985 " (device (file-system-label \"my-home\")))\n"
23986 msgstr ""
23987
23988 #. type: code{#1}
23989 #: guix-git/doc/guix.texi:13904 guix-git/doc/guix.texi:31144
23990 #: guix-git/doc/guix.texi:31160
23991 #, no-wrap
23992 msgid "uuid"
23993 msgstr ""
23994
23995 #. type: table
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:"
23998 msgstr ""
23999
24000 #. type: lisp
24001 #: guix-git/doc/guix.texi:13918
24002 #, no-wrap
24003 msgid ""
24004 "(file-system\n"
24005 " (mount-point \"/home\")\n"
24006 " (type \"ext4\")\n"
24007 " (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n"
24008 msgstr ""
24009
24010 #. type: table
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."
24013 msgstr ""
24014
24015 #. type: item
24016 #: guix-git/doc/guix.texi:13927
24017 #, no-wrap
24018 msgid "@code{flags} (default: @code{'()})"
24019 msgstr ""
24020
24021 #. type: table
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."
24024 msgstr ""
24025
24026 #. type: item
24027 #: guix-git/doc/guix.texi:13938
24028 #, no-wrap
24029 msgid "@code{options} (default: @code{#f})"
24030 msgstr ""
24031
24032 #. type: table
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."
24035 msgstr ""
24036
24037 #. type: item
24038 #: guix-git/doc/guix.texi:13948
24039 #, no-wrap
24040 msgid "@code{mount?} (default: @code{#t})"
24041 msgstr ""
24042
24043 #. type: table
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."
24046 msgstr ""
24047
24048 #. type: item
24049 #: guix-git/doc/guix.texi:13954
24050 #, no-wrap
24051 msgid "@code{needed-for-boot?} (default: @code{#f})"
24052 msgstr ""
24053
24054 #. type: table
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."
24057 msgstr ""
24058
24059 #. type: item
24060 #: guix-git/doc/guix.texi:13960
24061 #, no-wrap
24062 msgid "@code{check?} (default: @code{#t})"
24063 msgstr ""
24064
24065 #. type: table
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."
24068 msgstr ""
24069
24070 #. type: item
24071 #: guix-git/doc/guix.texi:13964
24072 #, no-wrap
24073 msgid "@code{create-mount-point?} (default: @code{#f})"
24074 msgstr ""
24075
24076 #. type: table
24077 #: guix-git/doc/guix.texi:13966
24078 msgid "When true, the mount point is created if it does not exist yet."
24079 msgstr ""
24080
24081 #. type: item
24082 #: guix-git/doc/guix.texi:13967
24083 #, no-wrap
24084 msgid "@code{mount-may-fail?} (default: @code{#f})"
24085 msgstr ""
24086
24087 #. type: table
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."
24090 msgstr ""
24091
24092 #. type: item
24093 #: guix-git/doc/guix.texi:13973
24094 #, no-wrap
24095 msgid "@code{dependencies} (default: @code{'()})"
24096 msgstr ""
24097
24098 #. type: table
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."
24101 msgstr ""
24102
24103 #. type: table
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}."
24106 msgstr ""
24107
24108 #. type: table
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})."
24111 msgstr ""
24112
24113 #. type: deffn
24114 #: guix-git/doc/guix.texi:13987
24115 #, no-wrap
24116 msgid "{Scheme Procedure} file-system-label @var{str}"
24117 msgstr ""
24118
24119 #. type: deffn
24120 #: guix-git/doc/guix.texi:13990
24121 msgid "This procedure returns an opaque file system label from @var{str}, a string:"
24122 msgstr ""
24123
24124 #. type: lisp
24125 #: guix-git/doc/guix.texi:13994
24126 #, no-wrap
24127 msgid ""
24128 "(file-system-label \"home\")\n"
24129 "@result{} #<file-system-label \"home\">\n"
24130 msgstr ""
24131
24132 #. type: deffn
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."
24135 msgstr ""
24136
24137 #. type: Plain text
24138 #: guix-git/doc/guix.texi:14002
24139 msgid "The @code{(gnu system file-systems)} exports the following useful variables."
24140 msgstr ""
24141
24142 #. type: defvr
24143 #: guix-git/doc/guix.texi:14003
24144 #, no-wrap
24145 msgid "{Scheme Variable} %base-file-systems"
24146 msgstr ""
24147
24148 #. type: defvr
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."
24151 msgstr ""
24152
24153 #. type: defvr
24154 #: guix-git/doc/guix.texi:14010
24155 #, no-wrap
24156 msgid "{Scheme Variable} %pseudo-terminal-file-system"
24157 msgstr ""
24158
24159 #. type: defvr
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}."
24162 msgstr ""
24163
24164 #. type: defvr
24165 #: guix-git/doc/guix.texi:14018
24166 #, no-wrap
24167 msgid "{Scheme Variable} %shared-memory-file-system"
24168 msgstr ""
24169
24170 #. type: defvr
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})."
24173 msgstr ""
24174
24175 #. type: defvr
24176 #: guix-git/doc/guix.texi:14024
24177 #, no-wrap
24178 msgid "{Scheme Variable} %immutable-store"
24179 msgstr ""
24180
24181 #. type: defvr
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."
24184 msgstr ""
24185
24186 #. type: defvr
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.''"
24189 msgstr ""
24190
24191 #. type: defvr
24192 #: guix-git/doc/guix.texi:14034
24193 #, no-wrap
24194 msgid "{Scheme Variable} %binary-format-file-system"
24195 msgstr ""
24196
24197 #. type: defvr
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."
24200 msgstr ""
24201
24202 #. type: defvr
24203 #: guix-git/doc/guix.texi:14040
24204 #, no-wrap
24205 msgid "{Scheme Variable} %fuse-control-file-system"
24206 msgstr ""
24207
24208 #. type: defvr
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."
24211 msgstr ""
24212
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)."
24216 msgstr ""
24217
24218 #. type: deffn
24219 #: guix-git/doc/guix.texi:14049
24220 #, no-wrap
24221 msgid "{Scheme Procedure} uuid @var{str} [@var{type}]"
24222 msgstr ""
24223
24224 #. type: deffn
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):"
24227 msgstr ""
24228
24229 #. type: lisp
24230 #: guix-git/doc/guix.texi:14056
24231 #, no-wrap
24232 msgid ""
24233 "(uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")\n"
24234 "@result{} #<<uuid> type: dce bv: @dots{}>\n"
24235 "\n"
24236 msgstr ""
24237
24238 #. type: lisp
24239 #: guix-git/doc/guix.texi:14059
24240 #, no-wrap
24241 msgid ""
24242 "(uuid \"1234-ABCD\" 'fat)\n"
24243 "@result{} #<<uuid> type: fat bv: @dots{}>\n"
24244 msgstr ""
24245
24246 #. type: deffn
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."
24249 msgstr ""
24250
24251 #. type: deffn
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."
24254 msgstr ""
24255
24256 #. type: subsection
24257 #: guix-git/doc/guix.texi:14069 guix-git/doc/guix.texi:14070
24258 #, no-wrap
24259 msgid "Btrfs file system"
24260 msgstr ""
24261
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."
24265 msgstr ""
24266
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:"
24270 msgstr ""
24271
24272 #. type: lisp
24273 #: guix-git/doc/guix.texi:14085
24274 #, no-wrap
24275 msgid ""
24276 "(file-system\n"
24277 " (mount-point \"/home\")\n"
24278 " (type \"btrfs\")\n"
24279 " (device (file-system-label \"my-home\")))\n"
24280 msgstr ""
24281
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}):"
24285 msgstr ""
24286
24287 #. type: lisp
24288 #: guix-git/doc/guix.texi:14099
24289 #, no-wrap
24290 msgid ""
24291 "(file-system\n"
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"
24297 msgstr ""
24298
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."
24302 msgstr ""
24303
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.:"
24307 msgstr ""
24308
24309 #. type: example
24310 #: guix-git/doc/guix.texi:14125
24311 #, no-wrap
24312 msgid ""
24313 "/ (top level)\n"
24314 "├── rootfs (subvolume directory)\n"
24315 " ├── gnu (normal directory)\n"
24316 " ├── store (normal directory)\n"
24317 "[...]\n"
24318 msgstr ""
24319
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."
24323 msgstr ""
24324
24325 #. type: Plain text
24326 #: guix-git/doc/guix.texi:14133
24327 msgid "The next example shows a nested hierarchy of subvolumes and directories:"
24328 msgstr ""
24329
24330 #. type: example
24331 #: guix-git/doc/guix.texi:14140
24332 #, no-wrap
24333 msgid ""
24334 "/ (top level)\n"
24335 "├── rootfs (subvolume)\n"
24336 " ├── gnu (normal directory)\n"
24337 " ├── store (subvolume)\n"
24338 "[...]\n"
24339 msgstr ""
24340
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}."
24344 msgstr ""
24345
24346 #. type: Plain text
24347 #: guix-git/doc/guix.texi:14149
24348 msgid "Finally, a more contrived example of nested subvolumes:"
24349 msgstr ""
24350
24351 #. type: example
24352 #: guix-git/doc/guix.texi:14156
24353 #, no-wrap
24354 msgid ""
24355 "/ (top level)\n"
24356 "├── root-snapshots (subvolume)\n"
24357 " ├── root-current (subvolume)\n"
24358 " ├── guix-store (subvolume)\n"
24359 "[...]\n"
24360 msgstr ""
24361
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:"
24365 msgstr ""
24366
24367 #. type: lisp
24368 #: guix-git/doc/guix.texi:14171
24369 #, no-wrap
24370 msgid ""
24371 "(file-system\n"
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"
24377 msgstr ""
24378
24379 #. type: cindex
24380 #: guix-git/doc/guix.texi:14176
24381 #, no-wrap
24382 msgid "device mapping"
24383 msgstr ""
24384
24385 #. type: cindex
24386 #: guix-git/doc/guix.texi:14177
24387 #, no-wrap
24388 msgid "mapped devices"
24389 msgstr ""
24390
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."
24394 msgstr ""
24395
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."
24399 msgstr ""
24400
24401 #. type: deftp
24402 #: guix-git/doc/guix.texi:14198
24403 #, no-wrap
24404 msgid "{Data Type} mapped-device"
24405 msgstr ""
24406
24407 #. type: deftp
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."
24410 msgstr ""
24411
24412 #. type: table
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."
24415 msgstr ""
24416
24417 #. type: code{#1}
24418 #: guix-git/doc/guix.texi:14209 guix-git/doc/guix.texi:32498
24419 #, no-wrap
24420 msgid "target"
24421 msgstr ""
24422
24423 #. type: table
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\"}."
24426 msgstr ""
24427
24428 #. type: item
24429 #: guix-git/doc/guix.texi:14219
24430 #, no-wrap
24431 msgid "targets"
24432 msgstr ""
24433
24434 #. type: table
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}."
24437 msgstr ""
24438
24439 #. type: table
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}."
24442 msgstr ""
24443
24444 #. type: defvr
24445 #: guix-git/doc/guix.texi:14229
24446 #, no-wrap
24447 msgid "{Scheme Variable} luks-device-mapping"
24448 msgstr ""
24449
24450 #. type: defvr
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."
24453 msgstr ""
24454
24455 #. type: defvr
24456 #: guix-git/doc/guix.texi:14235
24457 #, no-wrap
24458 msgid "{Scheme Variable} raid-device-mapping"
24459 msgstr ""
24460
24461 #. type: defvr
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."
24464 msgstr ""
24465
24466 #. type: cindex
24467 #: guix-git/doc/guix.texi:14242
24468 #, no-wrap
24469 msgid "LVM, logical volume manager"
24470 msgstr ""
24471
24472 #. type: defvr
24473 #: guix-git/doc/guix.texi:14243
24474 #, no-wrap
24475 msgid "{Scheme Variable} lvm-device-mapping"
24476 msgstr ""
24477
24478 #. type: defvr
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."
24481 msgstr ""
24482
24483 #. type: cindex
24484 #: guix-git/doc/guix.texi:14250
24485 #, no-wrap
24486 msgid "disk encryption"
24487 msgstr ""
24488
24489 #. type: cindex
24490 #: guix-git/doc/guix.texi:14251
24491 #, no-wrap
24492 msgid "LUKS"
24493 msgstr ""
24494
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})."
24498 msgstr ""
24499
24500 #. type: lisp
24501 #: guix-git/doc/guix.texi:14265
24502 #, no-wrap
24503 msgid ""
24504 "(mapped-device\n"
24505 " (source \"/dev/sda3\")\n"
24506 " (target \"home\")\n"
24507 " (type luks-device-mapping))\n"
24508 msgstr ""
24509
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:"
24513 msgstr ""
24514
24515 #. type: example
24516 #: guix-git/doc/guix.texi:14273
24517 #, no-wrap
24518 msgid "cryptsetup luksUUID /dev/sda3\n"
24519 msgstr ""
24520
24521 #. type: Plain text
24522 #: guix-git/doc/guix.texi:14276
24523 msgid "and use it as follows:"
24524 msgstr ""
24525
24526 #. type: lisp
24527 #: guix-git/doc/guix.texi:14282
24528 #, no-wrap
24529 msgid ""
24530 "(mapped-device\n"
24531 " (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n"
24532 " (target \"home\")\n"
24533 " (type luks-device-mapping))\n"
24534 msgstr ""
24535
24536 #. type: cindex
24537 #: guix-git/doc/guix.texi:14284
24538 #, no-wrap
24539 msgid "swap encryption"
24540 msgstr ""
24541
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."
24545 msgstr ""
24546
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:"
24550 msgstr ""
24551
24552 #. type: lisp
24553 #: guix-git/doc/guix.texi:14299
24554 #, no-wrap
24555 msgid ""
24556 "(mapped-device\n"
24557 " (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n"
24558 " (target \"/dev/md0\")\n"
24559 " (type raid-device-mapping))\n"
24560 msgstr ""
24561
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."
24565 msgstr ""
24566
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:"
24570 msgstr ""
24571
24572 #. type: lisp
24573 #: guix-git/doc/guix.texi:14315
24574 #, no-wrap
24575 msgid ""
24576 "(mapped-device\n"
24577 " (source \"vg0\")\n"
24578 " (targets (list \"vg0-alpha\" \"vg0-beta\"))\n"
24579 " (type lvm-device-mapping))\n"
24580 msgstr ""
24581
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})."
24585 msgstr ""
24586
24587 #. type: cindex
24588 #: guix-git/doc/guix.texi:14324
24589 #, no-wrap
24590 msgid "users"
24591 msgstr ""
24592
24593 #. type: cindex
24594 #: guix-git/doc/guix.texi:14325
24595 #, no-wrap
24596 msgid "accounts"
24597 msgstr ""
24598
24599 #. type: cindex
24600 #: guix-git/doc/guix.texi:14326
24601 #, no-wrap
24602 msgid "user accounts"
24603 msgstr ""
24604
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:"
24608 msgstr ""
24609
24610 #. type: lisp
24611 #: guix-git/doc/guix.texi:14340
24612 #, no-wrap
24613 msgid ""
24614 "(user-account\n"
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"
24622 msgstr ""
24623
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\"}):"
24627 msgstr ""
24628
24629 #. type: lisp
24630 #: guix-git/doc/guix.texi:14352
24631 #, no-wrap
24632 msgid ""
24633 "(user-account\n"
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"
24639 msgstr ""
24640
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."
24644 msgstr ""
24645
24646 #. type: deftp
24647 #: guix-git/doc/guix.texi:14362
24648 #, no-wrap
24649 msgid "{Data Type} user-account"
24650 msgstr ""
24651
24652 #. type: deftp
24653 #: guix-git/doc/guix.texi:14365
24654 msgid "Objects of this type represent user accounts. The following members may be specified:"
24655 msgstr ""
24656
24657 #. type: table
24658 #: guix-git/doc/guix.texi:14369
24659 msgid "The name of the user account."
24660 msgstr ""
24661
24662 #. type: itemx
24663 #: guix-git/doc/guix.texi:14370 guix-git/doc/guix.texi:32184
24664 #, no-wrap
24665 msgid "group"
24666 msgstr ""
24667
24668 #. type: cindex
24669 #: guix-git/doc/guix.texi:14371 guix-git/doc/guix.texi:14450
24670 #, no-wrap
24671 msgid "groups"
24672 msgstr ""
24673
24674 #. type: table
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."
24677 msgstr ""
24678
24679 #. type: item
24680 #: guix-git/doc/guix.texi:14375
24681 #, no-wrap
24682 msgid "@code{supplementary-groups} (default: @code{'()})"
24683 msgstr ""
24684
24685 #. type: table
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."
24688 msgstr ""
24689
24690 #. type: item
24691 #: guix-git/doc/guix.texi:14379
24692 #, no-wrap
24693 msgid "@code{uid} (default: @code{#f})"
24694 msgstr ""
24695
24696 #. type: table
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."
24699 msgstr ""
24700
24701 #. type: item
24702 #: guix-git/doc/guix.texi:14384
24703 #, no-wrap
24704 msgid "@code{comment} (default: @code{\"\"})"
24705 msgstr ""
24706
24707 #. type: table
24708 #: guix-git/doc/guix.texi:14386
24709 msgid "A comment about the account, such as the account owner's full name."
24710 msgstr ""
24711
24712 #. type: code{#1}
24713 #: guix-git/doc/guix.texi:14387
24714 #, no-wrap
24715 msgid "home-directory"
24716 msgstr ""
24717
24718 #. type: table
24719 #: guix-git/doc/guix.texi:14389
24720 msgid "This is the name of the home directory for the account."
24721 msgstr ""
24722
24723 #. type: item
24724 #: guix-git/doc/guix.texi:14390
24725 #, no-wrap
24726 msgid "@code{create-home-directory?} (default: @code{#t})"
24727 msgstr ""
24728
24729 #. type: table
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."
24732 msgstr ""
24733
24734 #. type: item
24735 #: guix-git/doc/guix.texi:14394
24736 #, no-wrap
24737 msgid "@code{shell} (default: Bash)"
24738 msgstr ""
24739
24740 #. type: table
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:"
24743 msgstr ""
24744
24745 #. type: lisp
24746 #: guix-git/doc/guix.texi:14401
24747 #, no-wrap
24748 msgid "(file-append bash \"/bin/bash\")\n"
24749 msgstr ""
24750
24751 #. type: table
24752 #: guix-git/doc/guix.texi:14405
24753 msgid "... and to the Zsh executable like that:"
24754 msgstr ""
24755
24756 #. type: lisp
24757 #: guix-git/doc/guix.texi:14408
24758 #, no-wrap
24759 msgid "(file-append zsh \"/bin/zsh\")\n"
24760 msgstr ""
24761
24762 #. type: item
24763 #: guix-git/doc/guix.texi:14410 guix-git/doc/guix.texi:14468
24764 #, no-wrap
24765 msgid "@code{system?} (default: @code{#f})"
24766 msgstr ""
24767
24768 #. type: table
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."
24771 msgstr ""
24772
24773 #. type: anchor{#1}
24774 #: guix-git/doc/guix.texi:14416
24775 msgid "user-account-password"
24776 msgstr ""
24777
24778 #. type: cindex
24779 #: guix-git/doc/guix.texi:14416
24780 #, no-wrap
24781 msgid "password, for user accounts"
24782 msgstr ""
24783
24784 #. type: item
24785 #: guix-git/doc/guix.texi:14417 guix-git/doc/guix.texi:14472
24786 #, no-wrap
24787 msgid "@code{password} (default: @code{#f})"
24788 msgstr ""
24789
24790 #. type: table
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."
24793 msgstr ""
24794
24795 #. type: table
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:"
24798 msgstr ""
24799
24800 #. type: lisp
24801 #: guix-git/doc/guix.texi:14432
24802 #, no-wrap
24803 msgid ""
24804 "(user-account\n"
24805 " (name \"charlie\")\n"
24806 " (group \"users\")\n"
24807 "\n"
24808 msgstr ""
24809
24810 #. type: lisp
24811 #: guix-git/doc/guix.texi:14435
24812 #, no-wrap
24813 msgid ""
24814 " ;; Specify a SHA-512-hashed initial password.\n"
24815 " (password (crypt \"InitialPassword!\" \"$6$abc\")))\n"
24816 msgstr ""
24817
24818 #. type: quotation
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."
24821 msgstr ""
24822
24823 #. type: table
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."
24826 msgstr ""
24827
24828 #. type: Plain text
24829 #: guix-git/doc/guix.texi:14452
24830 msgid "User group declarations are even simpler:"
24831 msgstr ""
24832
24833 #. type: lisp
24834 #: guix-git/doc/guix.texi:14455
24835 #, no-wrap
24836 msgid "(user-group (name \"students\"))\n"
24837 msgstr ""
24838
24839 #. type: deftp
24840 #: guix-git/doc/guix.texi:14457
24841 #, no-wrap
24842 msgid "{Data Type} user-group"
24843 msgstr ""
24844
24845 #. type: deftp
24846 #: guix-git/doc/guix.texi:14459
24847 msgid "This type is for, well, user groups. There are just a few fields:"
24848 msgstr ""
24849
24850 #. type: table
24851 #: guix-git/doc/guix.texi:14463
24852 msgid "The name of the group."
24853 msgstr ""
24854
24855 #. type: item
24856 #: guix-git/doc/guix.texi:14464 guix-git/doc/guix.texi:28988
24857 #, no-wrap
24858 msgid "@code{id} (default: @code{#f})"
24859 msgstr ""
24860
24861 #. type: table
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."
24864 msgstr ""
24865
24866 #. type: table
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."
24869 msgstr ""
24870
24871 #. type: table
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."
24874 msgstr ""
24875
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:"
24879 msgstr ""
24880
24881 #. type: defvr
24882 #: guix-git/doc/guix.texi:14482
24883 #, no-wrap
24884 msgid "{Scheme Variable} %base-groups"
24885 msgstr ""
24886
24887 #. type: defvr
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''."
24890 msgstr ""
24891
24892 #. type: defvr
24893 #: guix-git/doc/guix.texi:14489
24894 #, no-wrap
24895 msgid "{Scheme Variable} %base-user-accounts"
24896 msgstr ""
24897
24898 #. type: defvr
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."
24901 msgstr ""
24902
24903 #. type: defvr
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."
24906 msgstr ""
24907
24908 #. type: cindex
24909 #: guix-git/doc/guix.texi:14501
24910 #, no-wrap
24911 msgid "keymap"
24912 msgstr ""
24913
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."
24917 msgstr ""
24918
24919 #. type: cindex
24920 #: guix-git/doc/guix.texi:14510
24921 #, no-wrap
24922 msgid "keyboard layout, definition"
24923 msgstr ""
24924
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:"
24928 msgstr ""
24929
24930 #. type: itemize
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."
24933 msgstr ""
24934
24935 #. type: itemize
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}})."
24938 msgstr ""
24939
24940 #. type: itemize
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}})."
24943 msgstr ""
24944
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."
24948 msgstr ""
24949
24950 #. type: cindex
24951 #: guix-git/doc/guix.texi:14533
24952 #, no-wrap
24953 msgid "XKB, keyboard layouts"
24954 msgstr ""
24955
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."
24959 msgstr ""
24960
24961 #. type: deffn
24962 #: guix-git/doc/guix.texi:14542
24963 #, no-wrap
24964 msgid "{Scheme Procedure} keyboard-layout @var{name} [@var{variant}] @"
24965 msgstr ""
24966
24967 #. type: deffn
24968 #: guix-git/doc/guix.texi:14545
24969 msgid "[#:model] [#:options '()] Return a new keyboard layout with the given @var{name} and @var{variant}."
24970 msgstr ""
24971
24972 #. type: deffn
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."
24975 msgstr ""
24976
24977 #. type: Plain text
24978 #: guix-git/doc/guix.texi:14552
24979 msgid "Here are a few examples:"
24980 msgstr ""
24981
24982 #. type: lisp
24983 #: guix-git/doc/guix.texi:14557
24984 #, no-wrap
24985 msgid ""
24986 ";; The German QWERTZ layout. Here we assume a standard\n"
24987 ";; \"pc105\" keyboard model.\n"
24988 "(keyboard-layout \"de\")\n"
24989 "\n"
24990 msgstr ""
24991
24992 #. type: lisp
24993 #: guix-git/doc/guix.texi:14560
24994 #, no-wrap
24995 msgid ""
24996 ";; The bépo variant of the French layout.\n"
24997 "(keyboard-layout \"fr\" \"bepo\")\n"
24998 "\n"
24999 msgstr ""
25000
25001 #. type: lisp
25002 #: guix-git/doc/guix.texi:14563
25003 #, no-wrap
25004 msgid ""
25005 ";; The Catalan layout.\n"
25006 "(keyboard-layout \"es\" \"cat\")\n"
25007 "\n"
25008 msgstr ""
25009
25010 #. type: lisp
25011 #: guix-git/doc/guix.texi:14566
25012 #, no-wrap
25013 msgid ""
25014 ";; Arabic layout with \"Alt-Shift\" to switch to US layout.\n"
25015 "(keyboard-layout \"ar,us\" #:options '(\"grp:alt_shift_toggle\"))\n"
25016 "\n"
25017 msgstr ""
25018
25019 #. type: lisp
25020 #: guix-git/doc/guix.texi:14573
25021 #, no-wrap
25022 msgid ""
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"
25029 "\n"
25030 msgstr ""
25031
25032 #. type: lisp
25033 #: guix-git/doc/guix.texi:14576
25034 #, no-wrap
25035 msgid ""
25036 ";; The Russian layout for a ThinkPad keyboard.\n"
25037 "(keyboard-layout \"ru\" #:model \"thinkpad\")\n"
25038 "\n"
25039 msgstr ""
25040
25041 #. type: lisp
25042 #: guix-git/doc/guix.texi:14581
25043 #, no-wrap
25044 msgid ""
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"
25049 msgstr ""
25050
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."
25054 msgstr ""
25055
25056 #. type: cindex
25057 #: guix-git/doc/guix.texi:14586
25058 #, no-wrap
25059 msgid "keyboard layout, configuration"
25060 msgstr ""
25061
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:"
25065 msgstr ""
25066
25067 #. type: findex
25068 #: guix-git/doc/guix.texi:14591
25069 #, no-wrap
25070 msgid "set-xorg-configuration"
25071 msgstr ""
25072
25073 #. type: lisp
25074 #: guix-git/doc/guix.texi:14595
25075 #, no-wrap
25076 msgid ""
25077 ";; Using the Turkish layout for the bootloader, the console,\n"
25078 ";; and for Xorg.\n"
25079 "\n"
25080 msgstr ""
25081
25082 #. type: lisp
25083 #: guix-git/doc/guix.texi:14607
25084 #, no-wrap
25085 msgid ""
25086 "(operating-system\n"
25087 " ;; ...\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"
25097 msgstr ""
25098
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."
25102 msgstr ""
25103
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:"
25107 msgstr ""
25108
25109 #. type: itemize
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."
25112 msgstr ""
25113
25114 #. type: itemize
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:"
25117 msgstr ""
25118
25119 #. type: example
25120 #: guix-git/doc/guix.texi:14630
25121 #, no-wrap
25122 msgid "setxkbmap us dvorak\n"
25123 msgstr ""
25124
25125 #. type: itemize
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:"
25128 msgstr ""
25129
25130 #. type: example
25131 #: guix-git/doc/guix.texi:14640
25132 #, no-wrap
25133 msgid "loadkeys fr-bepo\n"
25134 msgstr ""
25135
25136 #. type: cindex
25137 #: guix-git/doc/guix.texi:14646
25138 #, no-wrap
25139 msgid "locale"
25140 msgstr ""
25141
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."
25145 msgstr ""
25146
25147 #. type: cindex
25148 #: guix-git/doc/guix.texi:14654
25149 #, no-wrap
25150 msgid "locale definition"
25151 msgstr ""
25152
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}})."
25156 msgstr ""
25157
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."
25161 msgstr ""
25162
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:"
25166 msgstr ""
25167
25168 #. type: lisp
25169 #: guix-git/doc/guix.texi:14675
25170 #, no-wrap
25171 msgid ""
25172 "(cons (locale-definition\n"
25173 " (name \"fy_DE.utf8\") (source \"fy_DE\"))\n"
25174 " %default-locale-definitions)\n"
25175 msgstr ""
25176
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:"
25180 msgstr ""
25181
25182 #. type: lisp
25183 #: guix-git/doc/guix.texi:14684
25184 #, no-wrap
25185 msgid ""
25186 "(list (locale-definition\n"
25187 " (name \"ja_JP.eucjp\") (source \"ja_JP\")\n"
25188 " (charset \"EUC-JP\")))\n"
25189 msgstr ""
25190
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})."
25194 msgstr ""
25195
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."
25199 msgstr ""
25200
25201 #. type: deftp
25202 #: guix-git/doc/guix.texi:14697
25203 #, no-wrap
25204 msgid "{Data Type} locale-definition"
25205 msgstr ""
25206
25207 #. type: deftp
25208 #: guix-git/doc/guix.texi:14699
25209 msgid "This is the data type of a locale definition."
25210 msgstr ""
25211
25212 #. type: table
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."
25215 msgstr ""
25216
25217 #. type: table
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."
25220 msgstr ""
25221
25222 #. type: item
25223 #: guix-git/doc/guix.texi:14710
25224 #, no-wrap
25225 msgid "@code{charset} (default: @code{\"UTF-8\"})"
25226 msgstr ""
25227
25228 #. type: table
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}."
25231 msgstr ""
25232
25233 #. type: defvr
25234 #: guix-git/doc/guix.texi:14718
25235 #, no-wrap
25236 msgid "{Scheme Variable} %default-locale-definitions"
25237 msgstr ""
25238
25239 #. type: defvr
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."
25242 msgstr ""
25243
25244 #. type: cindex
25245 #: guix-git/doc/guix.texi:14723
25246 #, no-wrap
25247 msgid "locale name"
25248 msgstr ""
25249
25250 #. type: cindex
25251 #: guix-git/doc/guix.texi:14724
25252 #, no-wrap
25253 msgid "normalized codeset in locale names"
25254 msgstr ""
25255
25256 #. type: defvr
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}."
25259 msgstr ""
25260
25261 #. type: subsection
25262 #: guix-git/doc/guix.texi:14732
25263 #, no-wrap
25264 msgid "Locale Data Compatibility Considerations"
25265 msgstr ""
25266
25267 #. type: cindex
25268 #: guix-git/doc/guix.texi:14734
25269 #, no-wrap
25270 msgid "incompatibility, of locale data"
25271 msgstr ""
25272
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."
25276 msgstr ""
25277
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."
25281 msgstr ""
25282
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."
25286 msgstr ""
25287
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})."
25291 msgstr ""
25292
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}:"
25296 msgstr ""
25297
25298 #. type: lisp
25299 #: guix-git/doc/guix.texi:14772
25300 #, no-wrap
25301 msgid ""
25302 "(use-package-modules base)\n"
25303 "\n"
25304 msgstr ""
25305
25306 #. type: lisp
25307 #: guix-git/doc/guix.texi:14776
25308 #, no-wrap
25309 msgid ""
25310 "(operating-system\n"
25311 " ;; @dots{}\n"
25312 " (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n"
25313 msgstr ""
25314
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}."
25318 msgstr ""
25319
25320 #. type: cindex
25321 #: guix-git/doc/guix.texi:14786
25322 #, no-wrap
25323 msgid "system services"
25324 msgstr ""
25325
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."
25329 msgstr ""
25330
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:"
25334 msgstr ""
25335
25336 #. type: example
25337 #: guix-git/doc/guix.texi:14802
25338 #, no-wrap
25339 msgid "# herd status\n"
25340 msgstr ""
25341
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:"
25345 msgstr ""
25346
25347 #. type: example
25348 #: guix-git/doc/guix.texi:14811
25349 #, no-wrap
25350 msgid ""
25351 "# herd doc nscd\n"
25352 "Run libc's name service cache daemon (nscd).\n"
25353 "\n"
25354 msgstr ""
25355
25356 #. type: example
25357 #: guix-git/doc/guix.texi:14814
25358 #, no-wrap
25359 msgid ""
25360 "# herd doc nscd action invalidate\n"
25361 "invalidate: Invalidate the given cache--e.g., 'hosts' for host name lookups.\n"
25362 msgstr ""
25363
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:"
25367 msgstr ""
25368
25369 #. type: example
25370 #: guix-git/doc/guix.texi:14826
25371 #, no-wrap
25372 msgid ""
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"
25378 msgstr ""
25379
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."
25383 msgstr ""
25384
25385 #. type: subsection
25386 #: guix-git/doc/guix.texi:14866 guix-git/doc/guix.texi:22490
25387 #: guix-git/doc/guix.texi:22491
25388 #, no-wrap
25389 msgid "File-Sharing Services"
25390 msgstr ""
25391
25392 #. type: menuentry
25393 #: guix-git/doc/guix.texi:14866
25394 msgid "File-sharing services."
25395 msgstr ""
25396
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."
25400 msgstr ""
25401
25402 #. type: defvr
25403 #: guix-git/doc/guix.texi:14875
25404 #, no-wrap
25405 msgid "{Scheme Variable} %base-services"
25406 msgstr ""
25407
25408 #. type: defvr
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."
25411 msgstr ""
25412
25413 #. type: defvr
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:"
25416 msgstr ""
25417
25418 #. type: lisp
25419 #: guix-git/doc/guix.texi:14891
25420 #, no-wrap
25421 msgid ""
25422 "(append (list (service avahi-service-type)\n"
25423 " (service openssh-service-type))\n"
25424 " %base-services)\n"
25425 msgstr ""
25426
25427 #. type: defvr
25428 #: guix-git/doc/guix.texi:14894
25429 #, no-wrap
25430 msgid "{Scheme Variable} special-files-service-type"
25431 msgstr ""
25432
25433 #. type: defvr
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}."
25436 msgstr ""
25437
25438 #. type: defvr
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:"
25441 msgstr ""
25442
25443 #. type: file{#1}
25444 #: guix-git/doc/guix.texi:14902
25445 #, no-wrap
25446 msgid "/bin/sh"
25447 msgstr ""
25448
25449 #. type: cindex
25450 #: guix-git/doc/guix.texi:14903
25451 #, no-wrap
25452 msgid "@file{sh}, in @file{/bin}"
25453 msgstr ""
25454
25455 #. type: lisp
25456 #: guix-git/doc/guix.texi:14906
25457 #, no-wrap
25458 msgid "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\")))\n"
25459 msgstr ""
25460
25461 #. type: file{#1}
25462 #: guix-git/doc/guix.texi:14908
25463 #, no-wrap
25464 msgid "/usr/bin/env"
25465 msgstr ""
25466
25467 #. type: cindex
25468 #: guix-git/doc/guix.texi:14909
25469 #, no-wrap
25470 msgid "@file{env}, in @file{/usr/bin}"
25471 msgstr ""
25472
25473 #. type: defvr
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:"
25476 msgstr ""
25477
25478 #. type: lisp
25479 #: guix-git/doc/guix.texi:14916
25480 #, no-wrap
25481 msgid ""
25482 "`((\"/bin/sh\" ,(file-append bash \"/bin/sh\"))\n"
25483 " (\"/usr/bin/env\" ,(file-append coreutils \"/bin/env\")))\n"
25484 msgstr ""
25485
25486 #. type: defvr
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)."
25489 msgstr ""
25490
25491 #. type: deffn
25492 #: guix-git/doc/guix.texi:14925
25493 #, no-wrap
25494 msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}"
25495 msgstr ""
25496
25497 #. type: deffn
25498 #: guix-git/doc/guix.texi:14927
25499 msgid "Use @var{target} as the ``special file'' @var{file}."
25500 msgstr ""
25501
25502 #. type: deffn
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:"
25505 msgstr ""
25506
25507 #. type: lisp
25508 #: guix-git/doc/guix.texi:14935
25509 #, no-wrap
25510 msgid ""
25511 "(extra-special-file \"/usr/bin/env\"\n"
25512 " (file-append coreutils \"/bin/env\"))\n"
25513 msgstr ""
25514
25515 #. type: deffn
25516 #: guix-git/doc/guix.texi:14938
25517 #, no-wrap
25518 msgid "{Scheme Procedure} host-name-service @var{name}"
25519 msgstr ""
25520
25521 #. type: deffn
25522 #: guix-git/doc/guix.texi:14940
25523 msgid "Return a service that sets the host name to @var{name}."
25524 msgstr ""
25525
25526 #. type: defvr
25527 #: guix-git/doc/guix.texi:14942
25528 #, no-wrap
25529 msgid "{Scheme Variable} console-font-service-type"
25530 msgstr ""
25531
25532 #. type: defvr
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:"
25535 msgstr ""
25536
25537 #. type: lisp
25538 #: guix-git/doc/guix.texi:14956
25539 #, no-wrap
25540 msgid ""
25541 "`((\"tty1\" . \"LatGrkCyr-8x16\")\n"
25542 " (\"tty2\" . ,(file-append\n"
25543 " font-tamzen\n"
25544 " \"/share/kbd/consolefonts/TamzenForPowerline10x20.psf\"))\n"
25545 " (\"tty3\" . ,(file-append\n"
25546 " font-terminus\n"
25547 " \"/share/consolefonts/ter-132n\"))) ; for HDPI\n"
25548 msgstr ""
25549
25550 #. type: deffn
25551 #: guix-git/doc/guix.texi:14959
25552 #, no-wrap
25553 msgid "{Scheme Procedure} login-service @var{config}"
25554 msgstr ""
25555
25556 #. type: deffn
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."
25559 msgstr ""
25560
25561 #. type: deftp
25562 #: guix-git/doc/guix.texi:14965
25563 #, no-wrap
25564 msgid "{Data Type} login-configuration"
25565 msgstr ""
25566
25567 #. type: deftp
25568 #: guix-git/doc/guix.texi:14967
25569 msgid "This is the data type representing the configuration of login."
25570 msgstr ""
25571
25572 #. type: code{#1}
25573 #: guix-git/doc/guix.texi:14970
25574 #, no-wrap
25575 msgid "motd"
25576 msgstr ""
25577
25578 #. type: cindex
25579 #: guix-git/doc/guix.texi:14971
25580 #, no-wrap
25581 msgid "message of the day"
25582 msgstr ""
25583
25584 #. type: table
25585 #: guix-git/doc/guix.texi:14973
25586 msgid "A file-like object containing the ``message of the day''."
25587 msgstr ""
25588
25589 #. type: item
25590 #: guix-git/doc/guix.texi:14974 guix-git/doc/guix.texi:17855
25591 #, no-wrap
25592 msgid "@code{allow-empty-passwords?} (default: @code{#t})"
25593 msgstr ""
25594
25595 #. type: table
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."
25598 msgstr ""
25599
25600 #. type: deffn
25601 #: guix-git/doc/guix.texi:14981
25602 #, no-wrap
25603 msgid "{Scheme Procedure} mingetty-service @var{config}"
25604 msgstr ""
25605
25606 #. type: deffn
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."
25609 msgstr ""
25610
25611 #. type: deftp
25612 #: guix-git/doc/guix.texi:14987
25613 #, no-wrap
25614 msgid "{Data Type} mingetty-configuration"
25615 msgstr ""
25616
25617 #. type: deftp
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."
25620 msgstr ""
25621
25622 #. type: code{#1}
25623 #: guix-git/doc/guix.texi:14993 guix-git/doc/guix.texi:15032
25624 #: guix-git/doc/guix.texi:31484
25625 #, no-wrap
25626 msgid "tty"
25627 msgstr ""
25628
25629 #. type: table
25630 #: guix-git/doc/guix.texi:14995
25631 msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}."
25632 msgstr ""
25633
25634 #. type: item
25635 #: guix-git/doc/guix.texi:14996 guix-git/doc/guix.texi:15061
25636 #: guix-git/doc/guix.texi:15220
25637 #, no-wrap
25638 msgid "@code{auto-login} (default: @code{#f})"
25639 msgstr ""
25640
25641 #. type: table
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."
25644 msgstr ""
25645
25646 #. type: item
25647 #: guix-git/doc/guix.texi:15001
25648 #, no-wrap
25649 msgid "@code{login-program} (default: @code{#f})"
25650 msgstr ""
25651
25652 #. type: table
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."
25655 msgstr ""
25656
25657 #. type: item
25658 #: guix-git/doc/guix.texi:15006
25659 #, no-wrap
25660 msgid "@code{login-pause?} (default: @code{#f})"
25661 msgstr ""
25662
25663 #. type: table
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."
25666 msgstr ""
25667
25668 #. type: item
25669 #: guix-git/doc/guix.texi:15010
25670 #, no-wrap
25671 msgid "@code{clear-on-logout?} (default: @code{#t})"
25672 msgstr ""
25673
25674 #. type: table
25675 #: guix-git/doc/guix.texi:15012
25676 msgid "When set to @code{#t}, the screen will be cleared after logout."
25677 msgstr ""
25678
25679 #. type: item
25680 #: guix-git/doc/guix.texi:15013
25681 #, no-wrap
25682 msgid "@code{mingetty} (default: @var{mingetty})"
25683 msgstr ""
25684
25685 #. type: table
25686 #: guix-git/doc/guix.texi:15015
25687 msgid "The Mingetty package to use."
25688 msgstr ""
25689
25690 #. type: deffn
25691 #: guix-git/doc/guix.texi:15019
25692 #, no-wrap
25693 msgid "{Scheme Procedure} agetty-service @var{config}"
25694 msgstr ""
25695
25696 #. type: deffn
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."
25699 msgstr ""
25700
25701 #. type: deftp
25702 #: guix-git/doc/guix.texi:15025
25703 #, no-wrap
25704 msgid "{Data Type} agetty-configuration"
25705 msgstr ""
25706
25707 #. type: deftp
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."
25710 msgstr ""
25711
25712 #. type: table
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."
25715 msgstr ""
25716
25717 #. type: table
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."
25720 msgstr ""
25721
25722 #. type: table
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."
25725 msgstr ""
25726
25727 #. type: table
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."
25730 msgstr ""
25731
25732 #. type: item
25733 #: guix-git/doc/guix.texi:15049 guix-git/doc/guix.texi:31645
25734 #, no-wrap
25735 msgid "@code{baud-rate} (default: @code{#f})"
25736 msgstr ""
25737
25738 #. type: table
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."
25741 msgstr ""
25742
25743 #. type: item
25744 #: guix-git/doc/guix.texi:15053
25745 #, no-wrap
25746 msgid "@code{term} (default: @code{#f})"
25747 msgstr ""
25748
25749 #. type: table
25750 #: guix-git/doc/guix.texi:15056
25751 msgid "A string containing the value used for the @env{TERM} environment variable."
25752 msgstr ""
25753
25754 #. type: item
25755 #: guix-git/doc/guix.texi:15057
25756 #, no-wrap
25757 msgid "@code{eight-bits?} (default: @code{#f})"
25758 msgstr ""
25759
25760 #. type: table
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."
25763 msgstr ""
25764
25765 #. type: table
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."
25768 msgstr ""
25769
25770 #. type: item
25771 #: guix-git/doc/guix.texi:15065
25772 #, no-wrap
25773 msgid "@code{no-reset?} (default: @code{#f})"
25774 msgstr ""
25775
25776 #. type: table
25777 #: guix-git/doc/guix.texi:15067
25778 msgid "When @code{#t}, don't reset terminal cflags (control modes)."
25779 msgstr ""
25780
25781 #. type: item
25782 #: guix-git/doc/guix.texi:15068
25783 #, no-wrap
25784 msgid "@code{host} (default: @code{#f})"
25785 msgstr ""
25786
25787 #. type: table
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."
25790 msgstr ""
25791
25792 #. type: item
25793 #: guix-git/doc/guix.texi:15072
25794 #, no-wrap
25795 msgid "@code{remote?} (default: @code{#f})"
25796 msgstr ""
25797
25798 #. type: table
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}."
25801 msgstr ""
25802
25803 #. type: item
25804 #: guix-git/doc/guix.texi:15077
25805 #, no-wrap
25806 msgid "@code{flow-control?} (default: @code{#f})"
25807 msgstr ""
25808
25809 #. type: table
25810 #: guix-git/doc/guix.texi:15079
25811 msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control."
25812 msgstr ""
25813
25814 #. type: item
25815 #: guix-git/doc/guix.texi:15080
25816 #, no-wrap
25817 msgid "@code{no-issue?} (default: @code{#f})"
25818 msgstr ""
25819
25820 #. type: table
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."
25823 msgstr ""
25824
25825 #. type: item
25826 #: guix-git/doc/guix.texi:15084
25827 #, no-wrap
25828 msgid "@code{init-string} (default: @code{#f})"
25829 msgstr ""
25830
25831 #. type: table
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."
25834 msgstr ""
25835
25836 #. type: item
25837 #: guix-git/doc/guix.texi:15088
25838 #, no-wrap
25839 msgid "@code{no-clear?} (default: @code{#f})"
25840 msgstr ""
25841
25842 #. type: table
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."
25845 msgstr ""
25846
25847 #. type: item
25848 #: guix-git/doc/guix.texi:15092
25849 #, no-wrap
25850 msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))"
25851 msgstr ""
25852
25853 #. type: table
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."
25856 msgstr ""
25857
25858 #. type: item
25859 #: guix-git/doc/guix.texi:15097
25860 #, no-wrap
25861 msgid "@code{local-line} (default: @code{#f})"
25862 msgstr ""
25863
25864 #. type: table
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}."
25867 msgstr ""
25868
25869 #. type: item
25870 #: guix-git/doc/guix.texi:15102
25871 #, no-wrap
25872 msgid "@code{extract-baud?} (default: @code{#f})"
25873 msgstr ""
25874
25875 #. type: table
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."
25878 msgstr ""
25879
25880 #. type: item
25881 #: guix-git/doc/guix.texi:15106
25882 #, no-wrap
25883 msgid "@code{skip-login?} (default: @code{#f})"
25884 msgstr ""
25885
25886 #. type: table
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."
25889 msgstr ""
25890
25891 #. type: item
25892 #: guix-git/doc/guix.texi:15111
25893 #, no-wrap
25894 msgid "@code{no-newline?} (default: @code{#f})"
25895 msgstr ""
25896
25897 #. type: table
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."
25900 msgstr ""
25901
25902 #. type: item
25903 #: guix-git/doc/guix.texi:15116
25904 #, no-wrap
25905 msgid "@code{login-options} (default: @code{#f})"
25906 msgstr ""
25907
25908 #. type: table
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."
25911 msgstr ""
25912
25913 #. type: item
25914 #: guix-git/doc/guix.texi:15122
25915 #, no-wrap
25916 msgid "@code{login-pause} (default: @code{#f})"
25917 msgstr ""
25918
25919 #. type: table
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."
25922 msgstr ""
25923
25924 #. type: item
25925 #: guix-git/doc/guix.texi:15127
25926 #, no-wrap
25927 msgid "@code{chroot} (default: @code{#f})"
25928 msgstr ""
25929
25930 #. type: table
25931 #: guix-git/doc/guix.texi:15130
25932 msgid "Change root to the specified directory. This option accepts a directory path as a string."
25933 msgstr ""
25934
25935 #. type: item
25936 #: guix-git/doc/guix.texi:15131
25937 #, no-wrap
25938 msgid "@code{hangup?} (default: @code{#f})"
25939 msgstr ""
25940
25941 #. type: table
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."
25944 msgstr ""
25945
25946 #. type: item
25947 #: guix-git/doc/guix.texi:15135
25948 #, no-wrap
25949 msgid "@code{keep-baud?} (default: @code{#f})"
25950 msgstr ""
25951
25952 #. type: table
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."
25955 msgstr ""
25956
25957 #. type: item
25958 #: guix-git/doc/guix.texi:15140
25959 #, no-wrap
25960 msgid "@code{timeout} (default: @code{#f})"
25961 msgstr ""
25962
25963 #. type: table
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."
25966 msgstr ""
25967
25968 #. type: item
25969 #: guix-git/doc/guix.texi:15144
25970 #, no-wrap
25971 msgid "@code{detect-case?} (default: @code{#f})"
25972 msgstr ""
25973
25974 #. type: table
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."
25977 msgstr ""
25978
25979 #. type: item
25980 #: guix-git/doc/guix.texi:15151
25981 #, no-wrap
25982 msgid "@code{wait-cr?} (default: @code{#f})"
25983 msgstr ""
25984
25985 #. type: table
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."
25988 msgstr ""
25989
25990 #. type: item
25991 #: guix-git/doc/guix.texi:15157
25992 #, no-wrap
25993 msgid "@code{no-hints?} (default: @code{#f})"
25994 msgstr ""
25995
25996 #. type: table
25997 #: guix-git/doc/guix.texi:15160
25998 msgid "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks."
25999 msgstr ""
26000
26001 #. type: item
26002 #: guix-git/doc/guix.texi:15161
26003 #, no-wrap
26004 msgid "@code{no-hostname?} (default: @code{#f})"
26005 msgstr ""
26006
26007 #. type: table
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."
26010 msgstr ""
26011
26012 #. type: item
26013 #: guix-git/doc/guix.texi:15165
26014 #, no-wrap
26015 msgid "@code{long-hostname?} (default: @code{#f})"
26016 msgstr ""
26017
26018 #. type: table
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."
26021 msgstr ""
26022
26023 #. type: item
26024 #: guix-git/doc/guix.texi:15170
26025 #, no-wrap
26026 msgid "@code{erase-characters} (default: @code{#f})"
26027 msgstr ""
26028
26029 #. type: table
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."
26032 msgstr ""
26033
26034 #. type: item
26035 #: guix-git/doc/guix.texi:15174
26036 #, no-wrap
26037 msgid "@code{kill-characters} (default: @code{#f})"
26038 msgstr ""
26039
26040 #. type: table
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."
26043 msgstr ""
26044
26045 #. type: item
26046 #: guix-git/doc/guix.texi:15179
26047 #, no-wrap
26048 msgid "@code{chdir} (default: @code{#f})"
26049 msgstr ""
26050
26051 #. type: table
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."
26054 msgstr ""
26055
26056 #. type: item
26057 #: guix-git/doc/guix.texi:15183
26058 #, no-wrap
26059 msgid "@code{delay} (default: @code{#f})"
26060 msgstr ""
26061
26062 #. type: table
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."
26065 msgstr ""
26066
26067 #. type: item
26068 #: guix-git/doc/guix.texi:15187
26069 #, no-wrap
26070 msgid "@code{nice} (default: @code{#f})"
26071 msgstr ""
26072
26073 #. type: table
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."
26076 msgstr ""
26077
26078 #. type: item
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
26084 #, no-wrap
26085 msgid "@code{extra-options} (default: @code{'()})"
26086 msgstr ""
26087
26088 #. type: table
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."
26091 msgstr ""
26092
26093 #. type: deffn
26094 #: guix-git/doc/guix.texi:15198
26095 #, no-wrap
26096 msgid "{Scheme Procedure} kmscon-service-type @var{config}"
26097 msgstr ""
26098
26099 #. type: deffn
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."
26102 msgstr ""
26103
26104 #. type: deftp
26105 #: guix-git/doc/guix.texi:15204
26106 #, no-wrap
26107 msgid "{Data Type} kmscon-configuration"
26108 msgstr ""
26109
26110 #. type: deftp
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."
26113 msgstr ""
26114
26115 #. type: code{#1}
26116 #: guix-git/doc/guix.texi:15210
26117 #, no-wrap
26118 msgid "virtual-terminal"
26119 msgstr ""
26120
26121 #. type: table
26122 #: guix-git/doc/guix.texi:15212
26123 msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}."
26124 msgstr ""
26125
26126 #. type: item
26127 #: guix-git/doc/guix.texi:15213
26128 #, no-wrap
26129 msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})"
26130 msgstr ""
26131
26132 #. type: table
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."
26135 msgstr ""
26136
26137 #. type: item
26138 #: guix-git/doc/guix.texi:15217
26139 #, no-wrap
26140 msgid "@code{login-arguments} (default: @code{'(\"-p\")})"
26141 msgstr ""
26142
26143 #. type: table
26144 #: guix-git/doc/guix.texi:15219
26145 msgid "A list of arguments to pass to @command{login}."
26146 msgstr ""
26147
26148 #. type: item
26149 #: guix-git/doc/guix.texi:15224
26150 #, no-wrap
26151 msgid "@code{hardware-acceleration?} (default: #f)"
26152 msgstr ""
26153
26154 #. type: table
26155 #: guix-git/doc/guix.texi:15226
26156 msgid "Whether to use hardware acceleration."
26157 msgstr ""
26158
26159 #. type: item
26160 #: guix-git/doc/guix.texi:15227
26161 #, no-wrap
26162 msgid "@code{font-engine} (default: @code{\"pango\"})"
26163 msgstr ""
26164
26165 #. type: table
26166 #: guix-git/doc/guix.texi:15229
26167 msgid "Font engine used in Kmscon."
26168 msgstr ""
26169
26170 #. type: item
26171 #: guix-git/doc/guix.texi:15230
26172 #, no-wrap
26173 msgid "@code{font-size} (default: @code{12})"
26174 msgstr ""
26175
26176 #. type: table
26177 #: guix-git/doc/guix.texi:15232
26178 msgid "Font size used in Kmscon."
26179 msgstr ""
26180
26181 #. type: item
26182 #: guix-git/doc/guix.texi:15233
26183 #, no-wrap
26184 msgid "@code{kmscon} (default: @var{kmscon})"
26185 msgstr ""
26186
26187 #. type: table
26188 #: guix-git/doc/guix.texi:15235
26189 msgid "The Kmscon package to use."
26190 msgstr ""
26191
26192 #. type: cindex
26193 #: guix-git/doc/guix.texi:15239
26194 #, no-wrap
26195 msgid "name service cache daemon"
26196 msgstr ""
26197
26198 #. type: cindex
26199 #: guix-git/doc/guix.texi:15240
26200 #, no-wrap
26201 msgid "nscd"
26202 msgstr ""
26203
26204 #. type: deffn
26205 #: guix-git/doc/guix.texi:15241
26206 #, no-wrap
26207 msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @"
26208 msgstr ""
26209
26210 #. type: deffn
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."
26213 msgstr ""
26214
26215 #. type: deffn
26216 #: guix-git/doc/guix.texi:15248
26217 msgid "For convenience, the Shepherd service for nscd provides the following actions:"
26218 msgstr ""
26219
26220 #. type: item
26221 #: guix-git/doc/guix.texi:15250
26222 #, no-wrap
26223 msgid "invalidate"
26224 msgstr ""
26225
26226 #. type: cindex
26227 #: guix-git/doc/guix.texi:15251
26228 #, no-wrap
26229 msgid "cache invalidation, nscd"
26230 msgstr ""
26231
26232 #. type: cindex
26233 #: guix-git/doc/guix.texi:15252
26234 #, no-wrap
26235 msgid "nscd, cache invalidation"
26236 msgstr ""
26237
26238 #. type: table
26239 #: guix-git/doc/guix.texi:15254
26240 msgid "This invalidate the given cache. For instance, running:"
26241 msgstr ""
26242
26243 #. type: example
26244 #: guix-git/doc/guix.texi:15257
26245 #, no-wrap
26246 msgid "herd invalidate nscd hosts\n"
26247 msgstr ""
26248
26249 #. type: table
26250 #: guix-git/doc/guix.texi:15261
26251 msgid "invalidates the host name lookup cache of nscd."
26252 msgstr ""
26253
26254 #. type: item
26255 #: guix-git/doc/guix.texi:15262
26256 #, no-wrap
26257 msgid "statistics"
26258 msgstr ""
26259
26260 #. type: table
26261 #: guix-git/doc/guix.texi:15265
26262 msgid "Running @command{herd statistics nscd} displays information about nscd usage and caches."
26263 msgstr ""
26264
26265 #. type: defvr
26266 #: guix-git/doc/guix.texi:15269
26267 #, no-wrap
26268 msgid "{Scheme Variable} %nscd-default-configuration"
26269 msgstr ""
26270
26271 #. type: defvr
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."
26274 msgstr ""
26275
26276 #. type: deftp
26277 #: guix-git/doc/guix.texi:15275
26278 #, no-wrap
26279 msgid "{Data Type} nscd-configuration"
26280 msgstr ""
26281
26282 #. type: deftp
26283 #: guix-git/doc/guix.texi:15278
26284 msgid "This is the data type representing the name service cache daemon (nscd) configuration."
26285 msgstr ""
26286
26287 #. type: item
26288 #: guix-git/doc/guix.texi:15281
26289 #, no-wrap
26290 msgid "@code{name-services} (default: @code{'()})"
26291 msgstr ""
26292
26293 #. type: table
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})}."
26296 msgstr ""
26297
26298 #. type: item
26299 #: guix-git/doc/guix.texi:15285
26300 #, no-wrap
26301 msgid "@code{glibc} (default: @var{glibc})"
26302 msgstr ""
26303
26304 #. type: table
26305 #: guix-git/doc/guix.texi:15288
26306 msgid "Package object denoting the GNU C Library providing the @command{nscd} command."
26307 msgstr ""
26308
26309 #. type: item
26310 #: guix-git/doc/guix.texi:15289
26311 #, no-wrap
26312 msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})"
26313 msgstr ""
26314
26315 #. type: table
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."
26318 msgstr ""
26319
26320 #. type: item
26321 #: guix-git/doc/guix.texi:15293
26322 #, no-wrap
26323 msgid "@code{debug-level} (default: @code{0})"
26324 msgstr ""
26325
26326 #. type: table
26327 #: guix-git/doc/guix.texi:15296
26328 msgid "Integer denoting the debugging levels. Higher numbers mean that more debugging output is logged."
26329 msgstr ""
26330
26331 #. type: item
26332 #: guix-git/doc/guix.texi:15297
26333 #, no-wrap
26334 msgid "@code{caches} (default: @code{%nscd-default-caches})"
26335 msgstr ""
26336
26337 #. type: table
26338 #: guix-git/doc/guix.texi:15300
26339 msgid "List of @code{<nscd-cache>} objects denoting things to be cached; see below."
26340 msgstr ""
26341
26342 #. type: deftp
26343 #: guix-git/doc/guix.texi:15304
26344 #, no-wrap
26345 msgid "{Data Type} nscd-cache"
26346 msgstr ""
26347
26348 #. type: deftp
26349 #: guix-git/doc/guix.texi:15306
26350 msgid "Data type representing a cache database of nscd and its parameters."
26351 msgstr ""
26352
26353 #. type: cindex
26354 #: guix-git/doc/guix.texi:15309 guix-git/doc/guix.texi:19637
26355 #, no-wrap
26356 msgid "database"
26357 msgstr ""
26358
26359 #. type: table
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})."
26362 msgstr ""
26363
26364 #. type: code{#1}
26365 #: guix-git/doc/guix.texi:15315
26366 #, no-wrap
26367 msgid "positive-time-to-live"
26368 msgstr ""
26369
26370 #. type: itemx
26371 #: guix-git/doc/guix.texi:15316
26372 #, no-wrap
26373 msgid "@code{negative-time-to-live} (default: @code{20})"
26374 msgstr ""
26375
26376 #. type: table
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."
26379 msgstr ""
26380
26381 #. type: item
26382 #: guix-git/doc/guix.texi:15320
26383 #, no-wrap
26384 msgid "@code{check-files?} (default: @code{#t})"
26385 msgstr ""
26386
26387 #. type: table
26388 #: guix-git/doc/guix.texi:15323
26389 msgid "Whether to check for updates of the files corresponding to @var{database}."
26390 msgstr ""
26391
26392 #. type: table
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."
26395 msgstr ""
26396
26397 #. type: item
26398 #: guix-git/doc/guix.texi:15328
26399 #, no-wrap
26400 msgid "@code{persistent?} (default: @code{#t})"
26401 msgstr ""
26402
26403 #. type: table
26404 #: guix-git/doc/guix.texi:15330
26405 msgid "Whether the cache should be stored persistently on disk."
26406 msgstr ""
26407
26408 #. type: item
26409 #: guix-git/doc/guix.texi:15331
26410 #, no-wrap
26411 msgid "@code{shared?} (default: @code{#t})"
26412 msgstr ""
26413
26414 #. type: table
26415 #: guix-git/doc/guix.texi:15333
26416 msgid "Whether the cache should be shared among users."
26417 msgstr ""
26418
26419 #. type: item
26420 #: guix-git/doc/guix.texi:15334
26421 #, no-wrap
26422 msgid "@code{max-database-size} (default: 32@tie{}MiB)"
26423 msgstr ""
26424
26425 #. type: table
26426 #: guix-git/doc/guix.texi:15336
26427 msgid "Maximum size in bytes of the database cache."
26428 msgstr ""
26429
26430 #. type: defvr
26431 #: guix-git/doc/guix.texi:15343
26432 #, no-wrap
26433 msgid "{Scheme Variable} %nscd-default-caches"
26434 msgstr ""
26435
26436 #. type: defvr
26437 #: guix-git/doc/guix.texi:15346
26438 msgid "List of @code{<nscd-cache>} objects used by default by @code{nscd-configuration} (see above)."
26439 msgstr ""
26440
26441 #. type: defvr
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."
26444 msgstr ""
26445
26446 #. type: anchor{#1}
26447 #: guix-git/doc/guix.texi:15355
26448 msgid "syslog-configuration-type"
26449 msgstr ""
26450
26451 #. type: cindex
26452 #: guix-git/doc/guix.texi:15355 guix-git/doc/guix.texi:15371
26453 #, no-wrap
26454 msgid "syslog"
26455 msgstr ""
26456
26457 #. type: cindex
26458 #: guix-git/doc/guix.texi:15356 guix-git/doc/guix.texi:15930
26459 #, no-wrap
26460 msgid "logging"
26461 msgstr ""
26462
26463 #. type: deftp
26464 #: guix-git/doc/guix.texi:15357
26465 #, no-wrap
26466 msgid "{Data Type} syslog-configuration"
26467 msgstr ""
26468
26469 #. type: deftp
26470 #: guix-git/doc/guix.texi:15359
26471 msgid "This data type represents the configuration of the syslog daemon."
26472 msgstr ""
26473
26474 #. type: item
26475 #: guix-git/doc/guix.texi:15361
26476 #, no-wrap
26477 msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})"
26478 msgstr ""
26479
26480 #. type: table
26481 #: guix-git/doc/guix.texi:15363
26482 msgid "The syslog daemon to use."
26483 msgstr ""
26484
26485 #. type: item
26486 #: guix-git/doc/guix.texi:15364
26487 #, no-wrap
26488 msgid "@code{config-file} (default: @code{%default-syslog.conf})"
26489 msgstr ""
26490
26491 #. type: table
26492 #: guix-git/doc/guix.texi:15366
26493 msgid "The syslog configuration file to use."
26494 msgstr ""
26495
26496 #. type: anchor{#1}
26497 #: guix-git/doc/guix.texi:15371
26498 msgid "syslog-service"
26499 msgstr ""
26500
26501 #. type: deffn
26502 #: guix-git/doc/guix.texi:15372
26503 #, no-wrap
26504 msgid "{Scheme Procedure} syslog-service @var{config}"
26505 msgstr ""
26506
26507 #. type: deffn
26508 #: guix-git/doc/guix.texi:15374
26509 msgid "Return a service that runs a syslog daemon according to @var{config}."
26510 msgstr ""
26511
26512 #. type: deffn
26513 #: guix-git/doc/guix.texi:15377
26514 msgid "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax."
26515 msgstr ""
26516
26517 #. type: defvr
26518 #: guix-git/doc/guix.texi:15379
26519 #, no-wrap
26520 msgid "{Scheme Variable} guix-service-type"
26521 msgstr ""
26522
26523 #. type: defvr
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."
26526 msgstr ""
26527
26528 #. type: anchor{#1}
26529 #: guix-git/doc/guix.texi:15386
26530 msgid "guix-configuration-type"
26531 msgstr ""
26532
26533 #. type: deftp
26534 #: guix-git/doc/guix.texi:15386
26535 #, no-wrap
26536 msgid "{Data Type} guix-configuration"
26537 msgstr ""
26538
26539 #. type: deftp
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."
26542 msgstr ""
26543
26544 #. type: item
26545 #: guix-git/doc/guix.texi:15391
26546 #, no-wrap
26547 msgid "@code{guix} (default: @var{guix})"
26548 msgstr ""
26549
26550 #. type: table
26551 #: guix-git/doc/guix.texi:15393 guix-git/doc/guix.texi:15667
26552 msgid "The Guix package to use."
26553 msgstr ""
26554
26555 #. type: item
26556 #: guix-git/doc/guix.texi:15394
26557 #, no-wrap
26558 msgid "@code{build-group} (default: @code{\"guixbuild\"})"
26559 msgstr ""
26560
26561 #. type: table
26562 #: guix-git/doc/guix.texi:15396
26563 msgid "Name of the group for build user accounts."
26564 msgstr ""
26565
26566 #. type: item
26567 #: guix-git/doc/guix.texi:15397
26568 #, no-wrap
26569 msgid "@code{build-accounts} (default: @code{10})"
26570 msgstr ""
26571
26572 #. type: table
26573 #: guix-git/doc/guix.texi:15399
26574 msgid "Number of build user accounts to create."
26575 msgstr ""
26576
26577 #. type: item
26578 #: guix-git/doc/guix.texi:15400
26579 #, no-wrap
26580 msgid "@code{authorize-key?} (default: @code{#t})"
26581 msgstr ""
26582
26583 #. type: table
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})."
26586 msgstr ""
26587
26588 #. type: table
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."
26591 msgstr ""
26592
26593 #. type: quotation
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}."
26596 msgstr ""
26597
26598 #. type: vindex
26599 #: guix-git/doc/guix.texi:15420
26600 #, no-wrap
26601 msgid "%default-authorized-guix-keys"
26602 msgstr ""
26603
26604 #. type: item
26605 #: guix-git/doc/guix.texi:15421
26606 #, no-wrap
26607 msgid "@code{authorized-keys} (default: @code{%default-authorized-guix-keys})"
26608 msgstr ""
26609
26610 #. type: table
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."
26613 msgstr ""
26614
26615 #. type: item
26616 #: guix-git/doc/guix.texi:15427
26617 #, no-wrap
26618 msgid "@code{use-substitutes?} (default: @code{#t})"
26619 msgstr ""
26620
26621 #. type: table
26622 #: guix-git/doc/guix.texi:15429
26623 msgid "Whether to use substitutes."
26624 msgstr ""
26625
26626 #. type: item
26627 #: guix-git/doc/guix.texi:15430
26628 #, no-wrap
26629 msgid "@code{substitute-urls} (default: @code{%default-substitute-urls})"
26630 msgstr ""
26631
26632 #. type: table
26633 #: guix-git/doc/guix.texi:15432
26634 msgid "The list of URLs where to look for substitutes by default."
26635 msgstr ""
26636
26637 #. type: table
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:"
26640 msgstr ""
26641
26642 #. type: lisp
26643 #: guix-git/doc/guix.texi:15448
26644 #, no-wrap
26645 msgid ""
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"
26653 msgstr ""
26654
26655 #. type: table
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."
26658 msgstr ""
26659
26660 #. type: item
26661 #: guix-git/doc/guix.texi:15454
26662 #, no-wrap
26663 msgid "@code{max-silent-time} (default: @code{0})"
26664 msgstr ""
26665
26666 #. type: itemx
26667 #: guix-git/doc/guix.texi:15455
26668 #, no-wrap
26669 msgid "@code{timeout} (default: @code{0})"
26670 msgstr ""
26671
26672 #. type: table
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."
26675 msgstr ""
26676
26677 #. type: item
26678 #: guix-git/doc/guix.texi:15460
26679 #, no-wrap
26680 msgid "@code{log-compression} (default: @code{'bzip2})"
26681 msgstr ""
26682
26683 #. type: table
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}."
26686 msgstr ""
26687
26688 #. type: item
26689 #: guix-git/doc/guix.texi:15464
26690 #, no-wrap
26691 msgid "@code{discover?} (default: @code{#f})"
26692 msgstr ""
26693
26694 #. type: table
26695 #: guix-git/doc/guix.texi:15470
26696 msgid "List of extra command-line options for @command{guix-daemon}."
26697 msgstr ""
26698
26699 #. type: item
26700 #: guix-git/doc/guix.texi:15471
26701 #, no-wrap
26702 msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})"
26703 msgstr ""
26704
26705 #. type: table
26706 #: guix-git/doc/guix.texi:15474
26707 msgid "File where @command{guix-daemon}'s standard output and standard error are written."
26708 msgstr ""
26709
26710 #. type: cindex
26711 #: guix-git/doc/guix.texi:15475
26712 #, no-wrap
26713 msgid "HTTP proxy, for @code{guix-daemon}"
26714 msgstr ""
26715
26716 #. type: cindex
26717 #: guix-git/doc/guix.texi:15476
26718 #, no-wrap
26719 msgid "proxy, for @code{guix-daemon} HTTP access"
26720 msgstr ""
26721
26722 #. type: item
26723 #: guix-git/doc/guix.texi:15477
26724 #, no-wrap
26725 msgid "@code{http-proxy} (default: @code{#f})"
26726 msgstr ""
26727
26728 #. type: table
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."
26731 msgstr ""
26732
26733 #. type: table
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:"
26736 msgstr ""
26737
26738 #. type: example
26739 #: guix-git/doc/guix.texi:15486
26740 #, no-wrap
26741 msgid "herd set-http-proxy guix-daemon http://localhost:8118\n"
26742 msgstr ""
26743
26744 #. type: table
26745 #: guix-git/doc/guix.texi:15489
26746 msgid "To clear the proxy settings, run:"
26747 msgstr ""
26748
26749 #. type: example
26750 #: guix-git/doc/guix.texi:15492
26751 #, no-wrap
26752 msgid "herd set-http-proxy guix-daemon\n"
26753 msgstr ""
26754
26755 #. type: item
26756 #: guix-git/doc/guix.texi:15494
26757 #, no-wrap
26758 msgid "@code{tmpdir} (default: @code{#f})"
26759 msgstr ""
26760
26761 #. type: table
26762 #: guix-git/doc/guix.texi:15496
26763 msgid "A directory path where the @command{guix-daemon} will perform builds."
26764 msgstr ""
26765
26766 #. type: deffn
26767 #: guix-git/doc/guix.texi:15500
26768 #, no-wrap
26769 msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]"
26770 msgstr ""
26771
26772 #. type: deffn
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."
26775 msgstr ""
26776
26777 #. type: deffn
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."
26780 msgstr ""
26781
26782 #. type: deffn
26783 #: guix-git/doc/guix.texi:15511
26784 #, no-wrap
26785 msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]"
26786 msgstr ""
26787
26788 #. type: deffn
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."
26791 msgstr ""
26792
26793 #. type: deffn
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."
26796 msgstr ""
26797
26798 #. type: lisp
26799 #: guix-git/doc/guix.texi:15526
26800 #, no-wrap
26801 msgid ""
26802 "(define %example-udev-rule\n"
26803 " (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"
26808 msgstr ""
26809
26810 #. type: deffn
26811 #: guix-git/doc/guix.texi:15529
26812 #, no-wrap
26813 msgid "{Scheme Procedure} udev-rules-service [@var{name} @var{rules}] @"
26814 msgstr ""
26815
26816 #. type: deffn
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."
26819 msgstr ""
26820
26821 #. type: deffn
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}."
26824 msgstr ""
26825
26826 #. type: lisp
26827 #: guix-git/doc/guix.texi:15546
26828 #, no-wrap
26829 msgid ""
26830 "(operating-system\n"
26831 " ;; @dots{}\n"
26832 " (services\n"
26833 " (cons (udev-rules-service 'usb-thing %example-udev-rule)\n"
26834 " %desktop-services)))\n"
26835 msgstr ""
26836
26837 #. type: deffn
26838 #: guix-git/doc/guix.texi:15549
26839 #, no-wrap
26840 msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]"
26841 msgstr ""
26842
26843 #. type: deffn
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."
26846 msgstr ""
26847
26848 #. type: deffn
26849 #: guix-git/doc/guix.texi:15554
26850 msgid "The following example showcases how we can use an existing rule file."
26851 msgstr ""
26852
26853 #. type: lisp
26854 #: guix-git/doc/guix.texi:15559
26855 #, no-wrap
26856 msgid ""
26857 "(use-modules (guix download) ;for url-fetch\n"
26858 " (guix packages) ;for origin\n"
26859 " @dots{})\n"
26860 "\n"
26861 msgstr ""
26862
26863 #. type: lisp
26864 #: guix-git/doc/guix.texi:15570
26865 #, no-wrap
26866 msgid ""
26867 "(define %android-udev-rules\n"
26868 " (file->udev-rule\n"
26869 " \"51-android-udev.rules\"\n"
26870 " (let ((version \"20170910\"))\n"
26871 " (origin\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"
26875 " (sha256\n"
26876 " (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n"
26877 msgstr ""
26878
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."
26882 msgstr ""
26883
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."
26887 msgstr ""
26888
26889 #. type: lisp
26890 #: guix-git/doc/guix.texi:15593
26891 #, no-wrap
26892 msgid ""
26893 "(use-modules (gnu packages android) ;for android-udev-rules\n"
26894 " (gnu system shadow) ;for user-group\n"
26895 " @dots{})\n"
26896 "\n"
26897 msgstr ""
26898
26899 #. type: lisp
26900 #: guix-git/doc/guix.texi:15606
26901 #, no-wrap
26902 msgid ""
26903 "(operating-system\n"
26904 " ;; @dots{}\n"
26905 " (users (cons (user-account\n"
26906 " ;; @dots{}\n"
26907 " (supplementary-groups\n"
26908 " '(\"adbusers\" ;for adb\n"
26909 " \"wheel\" \"netdev\" \"audio\" \"video\")))))\n"
26910 " ;; @dots{}\n"
26911 " (services\n"
26912 " (cons (udev-rules-service 'android android-udev-rules\n"
26913 " #:groups '(\"adbusers\"))\n"
26914 " %desktop-services)))\n"
26915 msgstr ""
26916
26917 #. type: defvr
26918 #: guix-git/doc/guix.texi:15608
26919 #, no-wrap
26920 msgid "{Scheme Variable} urandom-seed-service-type"
26921 msgstr ""
26922
26923 #. type: defvr
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."
26926 msgstr ""
26927
26928 #. type: defvr
26929 #: guix-git/doc/guix.texi:15615
26930 #, no-wrap
26931 msgid "{Scheme Variable} %random-seed-file"
26932 msgstr ""
26933
26934 #. type: defvr
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}."
26937 msgstr ""
26938
26939 #. type: cindex
26940 #: guix-git/doc/guix.texi:15621
26941 #, no-wrap
26942 msgid "mouse"
26943 msgstr ""
26944
26945 #. type: cindex
26946 #: guix-git/doc/guix.texi:15622
26947 #, no-wrap
26948 msgid "gpm"
26949 msgstr ""
26950
26951 #. type: defvr
26952 #: guix-git/doc/guix.texi:15623
26953 #, no-wrap
26954 msgid "{Scheme Variable} gpm-service-type"
26955 msgstr ""
26956
26957 #. type: defvr
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."
26960 msgstr ""
26961
26962 #. type: defvr
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}."
26965 msgstr ""
26966
26967 #. type: deftp
26968 #: guix-git/doc/guix.texi:15633
26969 #, no-wrap
26970 msgid "{Data Type} gpm-configuration"
26971 msgstr ""
26972
26973 #. type: deftp
26974 #: guix-git/doc/guix.texi:15635
26975 msgid "Data type representing the configuration of GPM."
26976 msgstr ""
26977
26978 #. type: item
26979 #: guix-git/doc/guix.texi:15637
26980 #, no-wrap
26981 msgid "@code{options} (default: @code{%default-gpm-options})"
26982 msgstr ""
26983
26984 #. type: table
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."
26987 msgstr ""
26988
26989 #. type: item
26990 #: guix-git/doc/guix.texi:15643
26991 #, no-wrap
26992 msgid "@code{gpm} (default: @code{gpm})"
26993 msgstr ""
26994
26995 #. type: table
26996 #: guix-git/doc/guix.texi:15645
26997 msgid "The GPM package to use."
26998 msgstr ""
26999
27000 #. type: anchor{#1}
27001 #: guix-git/doc/guix.texi:15650
27002 msgid "guix-publish-service-type"
27003 msgstr ""
27004
27005 #. type: deffn
27006 #: guix-git/doc/guix.texi:15650
27007 #, no-wrap
27008 msgid "{Scheme Variable} guix-publish-service-type"
27009 msgstr ""
27010
27011 #. type: deffn
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."
27014 msgstr ""
27015
27016 #. type: deffn
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."
27019 msgstr ""
27020
27021 #. type: deftp
27022 #: guix-git/doc/guix.texi:15660
27023 #, no-wrap
27024 msgid "{Data Type} guix-publish-configuration"
27025 msgstr ""
27026
27027 #. type: deftp
27028 #: guix-git/doc/guix.texi:15663
27029 msgid "Data type representing the configuration of the @code{guix publish} service."
27030 msgstr ""
27031
27032 #. type: item
27033 #: guix-git/doc/guix.texi:15665
27034 #, no-wrap
27035 msgid "@code{guix} (default: @code{guix})"
27036 msgstr ""
27037
27038 #. type: item
27039 #: guix-git/doc/guix.texi:15668 guix-git/doc/guix.texi:29638
27040 #, no-wrap
27041 msgid "@code{port} (default: @code{80})"
27042 msgstr ""
27043
27044 #. type: table
27045 #: guix-git/doc/guix.texi:15670
27046 msgid "The TCP port to listen for connections."
27047 msgstr ""
27048
27049 #. type: item
27050 #: guix-git/doc/guix.texi:15671 guix-git/doc/guix.texi:27277
27051 #, no-wrap
27052 msgid "@code{host} (default: @code{\"localhost\"})"
27053 msgstr ""
27054
27055 #. type: table
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."
27058 msgstr ""
27059
27060 #. type: item
27061 #: guix-git/doc/guix.texi:15675
27062 #, no-wrap
27063 msgid "@code{advertise?} (default: @code{#f})"
27064 msgstr ""
27065
27066 #. type: table
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."
27069 msgstr ""
27070
27071 #. type: table
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."
27074 msgstr ""
27075
27076 #. type: item
27077 #: guix-git/doc/guix.texi:15683
27078 #, no-wrap
27079 msgid "@code{compression} (default: @code{'((\"gzip\" 3) (\"zstd\" 3))})"
27080 msgstr ""
27081
27082 #. type: table
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:"
27085 msgstr ""
27086
27087 #. type: lisp
27088 #: guix-git/doc/guix.texi:15690
27089 #, no-wrap
27090 msgid "'((\"lzip\" 7) (\"gzip\" 9))\n"
27091 msgstr ""
27092
27093 #. type: table
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."
27096 msgstr ""
27097
27098 #. type: table
27099 #: guix-git/doc/guix.texi:15698
27100 msgid "An empty list disables compression altogether."
27101 msgstr ""
27102
27103 #. type: item
27104 #: guix-git/doc/guix.texi:15699
27105 #, no-wrap
27106 msgid "@code{nar-path} (default: @code{\"nar\"})"
27107 msgstr ""
27108
27109 #. type: table
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."
27112 msgstr ""
27113
27114 #. type: item
27115 #: guix-git/doc/guix.texi:15703
27116 #, no-wrap
27117 msgid "@code{cache} (default: @code{#f})"
27118 msgstr ""
27119
27120 #. type: table
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."
27123 msgstr ""
27124
27125 #. type: item
27126 #: guix-git/doc/guix.texi:15710
27127 #, no-wrap
27128 msgid "@code{workers} (default: @code{#f})"
27129 msgstr ""
27130
27131 #. type: table
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."
27134 msgstr ""
27135
27136 #. type: item
27137 #: guix-git/doc/guix.texi:15715
27138 #, no-wrap
27139 msgid "@code{cache-bypass-threshold} (default: 10 MiB)"
27140 msgstr ""
27141
27142 #. type: table
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."
27145 msgstr ""
27146
27147 #. type: item
27148 #: guix-git/doc/guix.texi:15721
27149 #, no-wrap
27150 msgid "@code{ttl} (default: @code{#f})"
27151 msgstr ""
27152
27153 #. type: table
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."
27156 msgstr ""
27157
27158 #. type: anchor{#1}
27159 #: guix-git/doc/guix.texi:15729
27160 msgid "rngd-service"
27161 msgstr ""
27162
27163 #. type: deffn
27164 #: guix-git/doc/guix.texi:15729
27165 #, no-wrap
27166 msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @"
27167 msgstr ""
27168
27169 #. type: deffn
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."
27172 msgstr ""
27173
27174 #. type: anchor{#1}
27175 #: guix-git/doc/guix.texi:15737
27176 msgid "pam-limits-service"
27177 msgstr ""
27178
27179 #. type: cindex
27180 #: guix-git/doc/guix.texi:15737
27181 #, no-wrap
27182 msgid "session limits"
27183 msgstr ""
27184
27185 #. type: cindex
27186 #: guix-git/doc/guix.texi:15738
27187 #, no-wrap
27188 msgid "ulimit"
27189 msgstr ""
27190
27191 #. type: cindex
27192 #: guix-git/doc/guix.texi:15739
27193 #, no-wrap
27194 msgid "priority"
27195 msgstr ""
27196
27197 #. type: cindex
27198 #: guix-git/doc/guix.texi:15740
27199 #, no-wrap
27200 msgid "realtime"
27201 msgstr ""
27202
27203 #. type: cindex
27204 #: guix-git/doc/guix.texi:15741
27205 #, no-wrap
27206 msgid "jackd"
27207 msgstr ""
27208
27209 #. type: cindex
27210 #: guix-git/doc/guix.texi:15742
27211 #, no-wrap
27212 msgid "nofile"
27213 msgstr ""
27214
27215 #. type: cindex
27216 #: guix-git/doc/guix.texi:15743
27217 #, no-wrap
27218 msgid "open file descriptors"
27219 msgstr ""
27220
27221 #. type: deffn
27222 #: guix-git/doc/guix.texi:15744
27223 #, no-wrap
27224 msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]"
27225 msgstr ""
27226
27227 #. type: deffn
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."
27230 msgstr ""
27231
27232 #. type: deffn
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:"
27235 msgstr ""
27236
27237 #. type: lisp
27238 #: guix-git/doc/guix.texi:15760
27239 #, no-wrap
27240 msgid ""
27241 "(pam-limits-service\n"
27242 " (list\n"
27243 " (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n"
27244 " (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n"
27245 msgstr ""
27246
27247 #. type: deffn
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."
27250 msgstr ""
27251
27252 #. type: deffn
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:"
27255 msgstr ""
27256
27257 #. type: lisp
27258 #: guix-git/doc/guix.texi:15774
27259 #, no-wrap
27260 msgid ""
27261 "(pam-limits-service\n"
27262 " (list\n"
27263 " (pam-limits-entry \"*\" 'both 'nofile 100000)))\n"
27264 msgstr ""
27265
27266 #. type: deffn
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."
27269 msgstr ""
27270
27271 #. type: cindex
27272 #: guix-git/doc/guix.texi:15787
27273 #, no-wrap
27274 msgid "cron"
27275 msgstr ""
27276
27277 #. type: cindex
27278 #: guix-git/doc/guix.texi:15788
27279 #, no-wrap
27280 msgid "mcron"
27281 msgstr ""
27282
27283 #. type: cindex
27284 #: guix-git/doc/guix.texi:15789
27285 #, no-wrap
27286 msgid "scheduling jobs"
27287 msgstr ""
27288
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."
27292 msgstr ""
27293
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})."
27297 msgstr ""
27298
27299 #. type: lisp
27300 #: guix-git/doc/guix.texi:15808
27301 #, no-wrap
27302 msgid ""
27303 "(use-modules (guix) (gnu) (gnu services mcron))\n"
27304 "(use-package-modules base idutils)\n"
27305 "\n"
27306 msgstr ""
27307
27308 #. type: lisp
27309 #: guix-git/doc/guix.texi:15817
27310 #, no-wrap
27311 msgid ""
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"
27316 " (lambda ()\n"
27317 " (execl (string-append #$findutils \"/bin/updatedb\")\n"
27318 " \"updatedb\"\n"
27319 " \"--prunepaths=/tmp /var/tmp /gnu/store\"))))\n"
27320 "\n"
27321 msgstr ""
27322
27323 #. type: lisp
27324 #: guix-git/doc/guix.texi:15823
27325 #, no-wrap
27326 msgid ""
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"
27332 "\n"
27333 msgstr ""
27334
27335 #. type: lisp
27336 #: guix-git/doc/guix.texi:15830
27337 #, no-wrap
27338 msgid ""
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"
27345 "\n"
27346 msgstr ""
27347
27348 #. type: lisp
27349 #: guix-git/doc/guix.texi:15833
27350 #, no-wrap
27351 msgid ""
27352 "(operating-system\n"
27353 " ;; @dots{}\n"
27354 "\n"
27355 msgstr ""
27356
27357 #. type: lisp
27358 #: guix-git/doc/guix.texi:15843
27359 #, no-wrap
27360 msgid ""
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"
27367 " updatedb-job\n"
27368 " idutils-job))\n"
27369 " %base-services)))\n"
27370 msgstr ""
27371
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."
27375 msgstr ""
27376
27377 #. type: lisp
27378 #: guix-git/doc/guix.texi:15866
27379 #, no-wrap
27380 msgid ""
27381 "(define %battery-alert-job\n"
27382 " ;; Beep when the battery percentage falls below %MIN-LEVEL.\n"
27383 " #~(job\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"
27389 " #~(begin\n"
27390 " (use-modules (guix build utils)\n"
27391 " (ice-9 popen)\n"
27392 " (ice-9 regex)\n"
27393 " (ice-9 textual-ports)\n"
27394 " (srfi srfi-2))\n"
27395 "\n"
27396 msgstr ""
27397
27398 #. type: lisp
27399 #: guix-git/doc/guix.texi:15868
27400 #, no-wrap
27401 msgid ""
27402 " (define %min-level 20)\n"
27403 "\n"
27404 msgstr ""
27405
27406 #. type: lisp
27407 #: guix-git/doc/guix.texi:15879
27408 #, no-wrap
27409 msgid ""
27410 " (setenv \"LC_ALL\" \"C\") ;ensure English output\n"
27411 " (and-let* ((input-pipe (open-pipe*\n"
27412 " OPEN_READ\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"
27420 msgstr ""
27421
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."
27425 msgstr ""
27426
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:"
27430 msgstr ""
27431
27432 #. type: example
27433 #: guix-git/doc/guix.texi:15890
27434 #, no-wrap
27435 msgid "# herd schedule mcron\n"
27436 msgstr ""
27437
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:"
27441 msgstr ""
27442
27443 #. type: example
27444 #: guix-git/doc/guix.texi:15898
27445 #, no-wrap
27446 msgid "# herd schedule mcron 10\n"
27447 msgstr ""
27448
27449 #. type: defvr
27450 #: guix-git/doc/guix.texi:15900
27451 #, no-wrap
27452 msgid "{Scheme Variable} mcron-service-type"
27453 msgstr ""
27454
27455 #. type: defvr
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."
27458 msgstr ""
27459
27460 #. type: defvr
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."
27463 msgstr ""
27464
27465 #. type: deftp
27466 #: guix-git/doc/guix.texi:15910
27467 #, no-wrap
27468 msgid "{Data Type} mcron-configuration"
27469 msgstr ""
27470
27471 #. type: deftp
27472 #: guix-git/doc/guix.texi:15912
27473 msgid "Data type representing the configuration of mcron."
27474 msgstr ""
27475
27476 #. type: item
27477 #: guix-git/doc/guix.texi:15914
27478 #, no-wrap
27479 msgid "@code{mcron} (default: @var{mcron})"
27480 msgstr ""
27481
27482 #. type: table
27483 #: guix-git/doc/guix.texi:15916
27484 msgid "The mcron package to use."
27485 msgstr ""
27486
27487 #. type: code{#1}
27488 #: guix-git/doc/guix.texi:15917 guix-git/doc/guix.texi:15986
27489 #, no-wrap
27490 msgid "jobs"
27491 msgstr ""
27492
27493 #. type: table
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})."
27496 msgstr ""
27497
27498 #. type: cindex
27499 #: guix-git/doc/guix.texi:15928
27500 #, no-wrap
27501 msgid "rottlog"
27502 msgstr ""
27503
27504 #. type: cindex
27505 #: guix-git/doc/guix.texi:15929
27506 #, no-wrap
27507 msgid "log rotation"
27508 msgstr ""
27509
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})."
27513 msgstr ""
27514
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):"
27518 msgstr ""
27519
27520 #. type: lisp
27521 #: guix-git/doc/guix.texi:15946
27522 #, no-wrap
27523 msgid ""
27524 "(use-modules (guix) (gnu))\n"
27525 "(use-service-modules admin)\n"
27526 "\n"
27527 msgstr ""
27528
27529 #. type: lisp
27530 #: guix-git/doc/guix.texi:15950
27531 #, no-wrap
27532 msgid ""
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"
27536 "\n"
27537 msgstr ""
27538
27539 #. type: lisp
27540 #: guix-git/doc/guix.texi:15959
27541 #, no-wrap
27542 msgid ""
27543 "(operating-system\n"
27544 " ;; @dots{}\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"
27551 msgstr ""
27552
27553 #. type: defvr
27554 #: guix-git/doc/guix.texi:15961
27555 #, no-wrap
27556 msgid "{Scheme Variable} rottlog-service-type"
27557 msgstr ""
27558
27559 #. type: defvr
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."
27562 msgstr ""
27563
27564 #. type: defvr
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."
27567 msgstr ""
27568
27569 #. type: defvr
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."
27572 msgstr ""
27573
27574 #. type: deftp
27575 #: guix-git/doc/guix.texi:15972
27576 #, no-wrap
27577 msgid "{Data Type} rottlog-configuration"
27578 msgstr ""
27579
27580 #. type: deftp
27581 #: guix-git/doc/guix.texi:15974
27582 msgid "Data type representing the configuration of rottlog."
27583 msgstr ""
27584
27585 #. type: item
27586 #: guix-git/doc/guix.texi:15976
27587 #, no-wrap
27588 msgid "@code{rottlog} (default: @code{rottlog})"
27589 msgstr ""
27590
27591 #. type: table
27592 #: guix-git/doc/guix.texi:15978
27593 msgid "The Rottlog package to use."
27594 msgstr ""
27595
27596 #. type: item
27597 #: guix-git/doc/guix.texi:15979
27598 #, no-wrap
27599 msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})"
27600 msgstr ""
27601
27602 #. type: table
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})."
27605 msgstr ""
27606
27607 #. type: item
27608 #: guix-git/doc/guix.texi:15983
27609 #, no-wrap
27610 msgid "@code{rotations} (default: @code{%default-rotations})"
27611 msgstr ""
27612
27613 #. type: table
27614 #: guix-git/doc/guix.texi:15985
27615 msgid "A list of @code{log-rotation} objects as defined below."
27616 msgstr ""
27617
27618 #. type: table
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})."
27621 msgstr ""
27622
27623 #. type: deftp
27624 #: guix-git/doc/guix.texi:15992
27625 #, no-wrap
27626 msgid "{Data Type} log-rotation"
27627 msgstr ""
27628
27629 #. type: deftp
27630 #: guix-git/doc/guix.texi:15994
27631 msgid "Data type representing the rotation of a group of log files."
27632 msgstr ""
27633
27634 #. type: deftp
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:"
27637 msgstr ""
27638
27639 #. type: lisp
27640 #: guix-git/doc/guix.texi:16007
27641 #, no-wrap
27642 msgid ""
27643 "(log-rotation\n"
27644 " (frequency 'daily)\n"
27645 " (files '(\"/var/log/apache/*\"))\n"
27646 " (options '(\"storedir apache-archives\"\n"
27647 " \"rotate 6\"\n"
27648 " \"notifempty\"\n"
27649 " \"nocompress\")))\n"
27650 msgstr ""
27651
27652 #. type: deftp
27653 #: guix-git/doc/guix.texi:16010
27654 msgid "The list of fields is as follows:"
27655 msgstr ""
27656
27657 #. type: item
27658 #: guix-git/doc/guix.texi:16012
27659 #, no-wrap
27660 msgid "@code{frequency} (default: @code{'weekly})"
27661 msgstr ""
27662
27663 #. type: table
27664 #: guix-git/doc/guix.texi:16014
27665 msgid "The log rotation frequency, a symbol."
27666 msgstr ""
27667
27668 #. type: code{#1}
27669 #: guix-git/doc/guix.texi:16015
27670 #, no-wrap
27671 msgid "files"
27672 msgstr ""
27673
27674 #. type: table
27675 #: guix-git/doc/guix.texi:16017
27676 msgid "The list of files or file glob patterns to rotate."
27677 msgstr ""
27678
27679 #. type: item
27680 #: guix-git/doc/guix.texi:16018
27681 #, no-wrap
27682 msgid "@code{options} (default: @code{'()})"
27683 msgstr ""
27684
27685 #. type: table
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})."
27688 msgstr ""
27689
27690 #. type: item
27691 #: guix-git/doc/guix.texi:16022
27692 #, no-wrap
27693 msgid "@code{post-rotate} (default: @code{#f})"
27694 msgstr ""
27695
27696 #. type: table
27697 #: guix-git/doc/guix.texi:16024
27698 msgid "Either @code{#f} or a gexp to execute once the rotation has completed."
27699 msgstr ""
27700
27701 #. type: defvr
27702 #: guix-git/doc/guix.texi:16027
27703 #, no-wrap
27704 msgid "{Scheme Variable} %default-rotations"
27705 msgstr ""
27706
27707 #. type: defvr
27708 #: guix-git/doc/guix.texi:16030
27709 msgid "Specifies weekly rotation of @code{%rotated-files} and of @file{/var/log/guix-daemon.log}."
27710 msgstr ""
27711
27712 #. type: defvr
27713 #: guix-git/doc/guix.texi:16032
27714 #, no-wrap
27715 msgid "{Scheme Variable} %rotated-files"
27716 msgstr ""
27717
27718 #. type: defvr
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\")}."
27721 msgstr ""
27722
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."
27726 msgstr ""
27727
27728 #. type: cindex
27729 #: guix-git/doc/guix.texi:16044
27730 #, no-wrap
27731 msgid "DHCP, networking service"
27732 msgstr ""
27733
27734 #. type: defvr
27735 #: guix-git/doc/guix.texi:16045
27736 #, no-wrap
27737 msgid "{Scheme Variable} dhcp-client-service-type"
27738 msgstr ""
27739
27740 #. type: defvr
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."
27743 msgstr ""
27744
27745 #. type: deffn
27746 #: guix-git/doc/guix.texi:16051
27747 #, no-wrap
27748 msgid "{Scheme Procedure} dhcpd-service-type"
27749 msgstr ""
27750
27751 #. type: deffn
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:"
27754 msgstr ""
27755
27756 #. type: lisp
27757 #: guix-git/doc/guix.texi:16061
27758 #, no-wrap
27759 msgid ""
27760 "(service dhcpd-service-type\n"
27761 " (dhcpd-configuration\n"
27762 " (config-file (local-file \"my-dhcpd.conf\"))\n"
27763 " (interfaces '(\"enp0s25\"))))\n"
27764 msgstr ""
27765
27766 #. type: deftp
27767 #: guix-git/doc/guix.texi:16064
27768 #, no-wrap
27769 msgid "{Data Type} dhcpd-configuration"
27770 msgstr ""
27771
27772 #. type: item
27773 #: guix-git/doc/guix.texi:16066
27774 #, no-wrap
27775 msgid "@code{package} (default: @code{isc-dhcp})"
27776 msgstr ""
27777
27778 #. type: table
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}."
27781 msgstr ""
27782
27783 #. type: item
27784 #: guix-git/doc/guix.texi:16071 guix-git/doc/guix.texi:16327
27785 #: guix-git/doc/guix.texi:21399
27786 #, no-wrap
27787 msgid "@code{config-file} (default: @code{#f})"
27788 msgstr ""
27789
27790 #. type: table
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."
27793 msgstr ""
27794
27795 #. type: item
27796 #: guix-git/doc/guix.texi:16076
27797 #, no-wrap
27798 msgid "@code{version} (default: @code{\"4\"})"
27799 msgstr ""
27800
27801 #. type: table
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."
27804 msgstr ""
27805
27806 #. type: item
27807 #: guix-git/doc/guix.texi:16081
27808 #, no-wrap
27809 msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})"
27810 msgstr ""
27811
27812 #. type: table
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."
27815 msgstr ""
27816
27817 #. type: item
27818 #: guix-git/doc/guix.texi:16084
27819 #, no-wrap
27820 msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})"
27821 msgstr ""
27822
27823 #. type: table
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."
27826 msgstr ""
27827
27828 #. type: item
27829 #: guix-git/doc/guix.texi:16087
27830 #, no-wrap
27831 msgid "@code{interfaces} (default: @code{'()})"
27832 msgstr ""
27833
27834 #. type: table
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."
27837 msgstr ""
27838
27839 #. type: defvr
27840 #: guix-git/doc/guix.texi:16096
27841 #, no-wrap
27842 msgid "{Scheme Variable} static-networking-service-type"
27843 msgstr ""
27844
27845 #. type: defvr
27846 #: guix-git/doc/guix.texi:16099
27847 msgid "This is the type for statically-configured network interfaces."
27848 msgstr ""
27849
27850 #. type: deffn
27851 #: guix-git/doc/guix.texi:16101
27852 #, no-wrap
27853 msgid "{Scheme Procedure} static-networking-service @var{interface} @var{ip} @"
27854 msgstr ""
27855
27856 #. type: deffn
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."
27859 msgstr ""
27860
27861 #. type: deffn
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."
27864 msgstr ""
27865
27866 #. type: defvr
27867 #: guix-git/doc/guix.texi:16116 guix-git/doc/guix.texi:28950
27868 msgid "For example:"
27869 msgstr ""
27870
27871 #. type: lisp
27872 #: guix-git/doc/guix.texi:16121
27873 #, no-wrap
27874 msgid ""
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"
27878 msgstr ""
27879
27880 #. type: cindex
27881 #: guix-git/doc/guix.texi:16124
27882 #, no-wrap
27883 msgid "wicd"
27884 msgstr ""
27885
27886 #. type: cindex
27887 #: guix-git/doc/guix.texi:16127
27888 #, no-wrap
27889 msgid "network management"
27890 msgstr ""
27891
27892 #. type: deffn
27893 #: guix-git/doc/guix.texi:16128
27894 #, no-wrap
27895 msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]"
27896 msgstr ""
27897
27898 #. type: deffn
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."
27901 msgstr ""
27902
27903 #. type: deffn
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."
27906 msgstr ""
27907
27908 #. type: cindex
27909 #: guix-git/doc/guix.texi:16138
27910 #, no-wrap
27911 msgid "ModemManager"
27912 msgstr ""
27913
27914 #. type: defvr
27915 #: guix-git/doc/guix.texi:16140
27916 #, no-wrap
27917 msgid "{Scheme Variable} modem-manager-service-type"
27918 msgstr ""
27919
27920 #. type: defvr
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."
27923 msgstr ""
27924
27925 #. type: defvr
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})."
27929 msgstr ""
27930
27931 #. type: deftp
27932 #: guix-git/doc/guix.texi:16150
27933 #, no-wrap
27934 msgid "{Data Type} modem-manager-configuration"
27935 msgstr ""
27936
27937 #. type: deftp
27938 #: guix-git/doc/guix.texi:16152
27939 msgid "Data type representing the configuration of ModemManager."
27940 msgstr ""
27941
27942 #. type: item
27943 #: guix-git/doc/guix.texi:16154
27944 #, no-wrap
27945 msgid "@code{modem-manager} (default: @code{modem-manager})"
27946 msgstr ""
27947
27948 #. type: table
27949 #: guix-git/doc/guix.texi:16156
27950 msgid "The ModemManager package to use."
27951 msgstr ""
27952
27953 #. type: cindex
27954 #: guix-git/doc/guix.texi:16160
27955 #, no-wrap
27956 msgid "USB_ModeSwitch"
27957 msgstr ""
27958
27959 #. type: cindex
27960 #: guix-git/doc/guix.texi:16161
27961 #, no-wrap
27962 msgid "Modeswitching"
27963 msgstr ""
27964
27965 #. type: defvr
27966 #: guix-git/doc/guix.texi:16163
27967 #, no-wrap
27968 msgid "{Scheme Variable} usb-modeswitch-service-type"
27969 msgstr ""
27970
27971 #. type: defvr
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."
27974 msgstr ""
27975
27976 #. type: defvr
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."
27979 msgstr ""
27980
27981 #. type: deftp
27982 #: guix-git/doc/guix.texi:16179
27983 #, no-wrap
27984 msgid "{Data Type} usb-modeswitch-configuration"
27985 msgstr ""
27986
27987 #. type: deftp
27988 #: guix-git/doc/guix.texi:16181
27989 msgid "Data type representing the configuration of USB_ModeSwitch."
27990 msgstr ""
27991
27992 #. type: item
27993 #: guix-git/doc/guix.texi:16183
27994 #, no-wrap
27995 msgid "@code{usb-modeswitch} (default: @code{usb-modeswitch})"
27996 msgstr ""
27997
27998 #. type: table
27999 #: guix-git/doc/guix.texi:16185
28000 msgid "The USB_ModeSwitch package providing the binaries for modeswitching."
28001 msgstr ""
28002
28003 #. type: item
28004 #: guix-git/doc/guix.texi:16186
28005 #, no-wrap
28006 msgid "@code{usb-modeswitch-data} (default: @code{usb-modeswitch-data})"
28007 msgstr ""
28008
28009 #. type: table
28010 #: guix-git/doc/guix.texi:16189
28011 msgid "The package providing the device data and udev rules file used by USB_ModeSwitch."
28012 msgstr ""
28013
28014 #. type: item
28015 #: guix-git/doc/guix.texi:16190
28016 #, no-wrap
28017 msgid "@code{config-file} (default: @code{#~(string-append #$usb-modeswitch:dispatcher \"/etc/usb_modeswitch.conf\")})"
28018 msgstr ""
28019
28020 #. type: table
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."
28023 msgstr ""
28024
28025 #. type: cindex
28026 #: guix-git/doc/guix.texi:16199
28027 #, no-wrap
28028 msgid "NetworkManager"
28029 msgstr ""
28030
28031 #. type: defvr
28032 #: guix-git/doc/guix.texi:16201
28033 #, no-wrap
28034 msgid "{Scheme Variable} network-manager-service-type"
28035 msgstr ""
28036
28037 #. type: defvr
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."
28040 msgstr ""
28041
28042 #. type: deftp
28043 #: guix-git/doc/guix.texi:16211
28044 #, no-wrap
28045 msgid "{Data Type} network-manager-configuration"
28046 msgstr ""
28047
28048 #. type: deftp
28049 #: guix-git/doc/guix.texi:16213
28050 msgid "Data type representing the configuration of NetworkManager."
28051 msgstr ""
28052
28053 #. type: item
28054 #: guix-git/doc/guix.texi:16215
28055 #, no-wrap
28056 msgid "@code{network-manager} (default: @code{network-manager})"
28057 msgstr ""
28058
28059 #. type: table
28060 #: guix-git/doc/guix.texi:16217
28061 msgid "The NetworkManager package to use."
28062 msgstr ""
28063
28064 #. type: item
28065 #: guix-git/doc/guix.texi:16218
28066 #, no-wrap
28067 msgid "@code{dns} (default: @code{\"default\"})"
28068 msgstr ""
28069
28070 #. type: table
28071 #: guix-git/doc/guix.texi:16221
28072 msgid "Processing mode for DNS, which affects how NetworkManager uses the @code{resolv.conf} configuration file."
28073 msgstr ""
28074
28075 #. type: table
28076 #: guix-git/doc/guix.texi:16226
28077 msgid "NetworkManager will update @code{resolv.conf} to reflect the nameservers provided by currently active connections."
28078 msgstr ""
28079
28080 #. type: item
28081 #: guix-git/doc/guix.texi:16227
28082 #, no-wrap
28083 msgid "dnsmasq"
28084 msgstr ""
28085
28086 #. type: table
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."
28089 msgstr ""
28090
28091 #. type: table
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)."
28094 msgstr ""
28095
28096 #. type: table
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:"
28099 msgstr ""
28100
28101 #. type: example
28102 #: guix-git/doc/guix.texi:16251
28103 #, no-wrap
28104 msgid ""
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"
28110 msgstr ""
28111
28112 #. type: table
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-...}."
28115 msgstr ""
28116
28117 #. type: table
28118 #: guix-git/doc/guix.texi:16259
28119 msgid "NetworkManager will not modify @code{resolv.conf}."
28120 msgstr ""
28121
28122 #. type: item
28123 #: guix-git/doc/guix.texi:16261
28124 #, no-wrap
28125 msgid "@code{vpn-plugins} (default: @code{'()})"
28126 msgstr ""
28127
28128 #. type: table
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."
28131 msgstr ""
28132
28133 #. type: cindex
28134 #: guix-git/doc/guix.texi:16269
28135 #, no-wrap
28136 msgid "Connman"
28137 msgstr ""
28138
28139 #. type: deffn
28140 #: guix-git/doc/guix.texi:16270
28141 #, no-wrap
28142 msgid "{Scheme Variable} connman-service-type"
28143 msgstr ""
28144
28145 #. type: deffn
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."
28148 msgstr ""
28149
28150 #. type: deffn
28151 #: guix-git/doc/guix.texi:16276
28152 msgid "Its value must be an @code{connman-configuration} record as in this example:"
28153 msgstr ""
28154
28155 #. type: lisp
28156 #: guix-git/doc/guix.texi:16281
28157 #, no-wrap
28158 msgid ""
28159 "(service connman-service-type\n"
28160 " (connman-configuration\n"
28161 " (disable-vpn? #t)))\n"
28162 msgstr ""
28163
28164 #. type: deffn
28165 #: guix-git/doc/guix.texi:16284
28166 msgid "See below for details about @code{connman-configuration}."
28167 msgstr ""
28168
28169 #. type: deftp
28170 #: guix-git/doc/guix.texi:16286
28171 #, no-wrap
28172 msgid "{Data Type} connman-configuration"
28173 msgstr ""
28174
28175 #. type: deftp
28176 #: guix-git/doc/guix.texi:16288
28177 msgid "Data Type representing the configuration of connman."
28178 msgstr ""
28179
28180 #. type: item
28181 #: guix-git/doc/guix.texi:16290
28182 #, no-wrap
28183 msgid "@code{connman} (default: @var{connman})"
28184 msgstr ""
28185
28186 #. type: table
28187 #: guix-git/doc/guix.texi:16292
28188 msgid "The connman package to use."
28189 msgstr ""
28190
28191 #. type: item
28192 #: guix-git/doc/guix.texi:16293
28193 #, no-wrap
28194 msgid "@code{disable-vpn?} (default: @code{#f})"
28195 msgstr ""
28196
28197 #. type: table
28198 #: guix-git/doc/guix.texi:16295
28199 msgid "When true, disable connman's vpn plugin."
28200 msgstr ""
28201
28202 #. type: cindex
28203 #: guix-git/doc/guix.texi:16298
28204 #, no-wrap
28205 msgid "WPA Supplicant"
28206 msgstr ""
28207
28208 #. type: defvr
28209 #: guix-git/doc/guix.texi:16299
28210 #, no-wrap
28211 msgid "{Scheme Variable} wpa-supplicant-service-type"
28212 msgstr ""
28213
28214 #. type: defvr
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."
28217 msgstr ""
28218
28219 #. type: deftp
28220 #: guix-git/doc/guix.texi:16305
28221 #, no-wrap
28222 msgid "{Data Type} wpa-supplicant-configuration"
28223 msgstr ""
28224
28225 #. type: deftp
28226 #: guix-git/doc/guix.texi:16307
28227 msgid "Data type representing the configuration of WPA Supplicant."
28228 msgstr ""
28229
28230 #. type: deftp
28231 #: guix-git/doc/guix.texi:16309 guix-git/doc/guix.texi:30962
28232 msgid "It takes the following parameters:"
28233 msgstr ""
28234
28235 #. type: item
28236 #: guix-git/doc/guix.texi:16311
28237 #, no-wrap
28238 msgid "@code{wpa-supplicant} (default: @code{wpa-supplicant})"
28239 msgstr ""
28240
28241 #. type: table
28242 #: guix-git/doc/guix.texi:16313
28243 msgid "The WPA Supplicant package to use."
28244 msgstr ""
28245
28246 #. type: item
28247 #: guix-git/doc/guix.texi:16314
28248 #, no-wrap
28249 msgid "@code{requirement} (default: @code{'(user-processes loopback syslogd)}"
28250 msgstr ""
28251
28252 #. type: table
28253 #: guix-git/doc/guix.texi:16316
28254 msgid "List of services that should be started before WPA Supplicant starts."
28255 msgstr ""
28256
28257 #. type: item
28258 #: guix-git/doc/guix.texi:16317
28259 #, no-wrap
28260 msgid "@code{dbus?} (default: @code{#t})"
28261 msgstr ""
28262
28263 #. type: table
28264 #: guix-git/doc/guix.texi:16319
28265 msgid "Whether to listen for requests on D-Bus."
28266 msgstr ""
28267
28268 #. type: item
28269 #: guix-git/doc/guix.texi:16320
28270 #, no-wrap
28271 msgid "@code{pid-file} (default: @code{\"/var/run/wpa_supplicant.pid\"})"
28272 msgstr ""
28273
28274 #. type: table
28275 #: guix-git/doc/guix.texi:16322
28276 msgid "Where to store the PID file."
28277 msgstr ""
28278
28279 #. type: item
28280 #: guix-git/doc/guix.texi:16323 guix-git/doc/guix.texi:29407
28281 #: guix-git/doc/guix.texi:29549
28282 #, no-wrap
28283 msgid "@code{interface} (default: @code{#f})"
28284 msgstr ""
28285
28286 #. type: table
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."
28289 msgstr ""
28290
28291 #. type: table
28292 #: guix-git/doc/guix.texi:16329
28293 msgid "Optional configuration file to use."
28294 msgstr ""
28295
28296 #. type: table
28297 #: guix-git/doc/guix.texi:16332
28298 msgid "List of additional command-line arguments to pass to the daemon."
28299 msgstr ""
28300
28301 #. type: cindex
28302 #: guix-git/doc/guix.texi:16335
28303 #, no-wrap
28304 msgid "hostapd service, for Wi-Fi access points"
28305 msgstr ""
28306
28307 #. type: cindex
28308 #: guix-git/doc/guix.texi:16336
28309 #, no-wrap
28310 msgid "Wi-Fi access points, hostapd service"
28311 msgstr ""
28312
28313 #. type: defvr
28314 #: guix-git/doc/guix.texi:16337
28315 #, no-wrap
28316 msgid "{Scheme Variable} hostapd-service-type"
28317 msgstr ""
28318
28319 #. type: defvr
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:"
28322 msgstr ""
28323
28324 #. type: lisp
28325 #: guix-git/doc/guix.texi:16350
28326 #, no-wrap
28327 msgid ""
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"
28334 msgstr ""
28335
28336 #. type: deftp
28337 #: guix-git/doc/guix.texi:16353
28338 #, no-wrap
28339 msgid "{Data Type} hostapd-configuration"
28340 msgstr ""
28341
28342 #. type: deftp
28343 #: guix-git/doc/guix.texi:16356
28344 msgid "This data type represents the configuration of the hostapd service, with the following fields:"
28345 msgstr ""
28346
28347 #. type: item
28348 #: guix-git/doc/guix.texi:16358
28349 #, no-wrap
28350 msgid "@code{package} (default: @code{hostapd})"
28351 msgstr ""
28352
28353 #. type: table
28354 #: guix-git/doc/guix.texi:16360
28355 msgid "The hostapd package to use."
28356 msgstr ""
28357
28358 #. type: item
28359 #: guix-git/doc/guix.texi:16361
28360 #, no-wrap
28361 msgid "@code{interface} (default: @code{\"wlan0\"})"
28362 msgstr ""
28363
28364 #. type: table
28365 #: guix-git/doc/guix.texi:16363
28366 msgid "The network interface to run the WiFi access point."
28367 msgstr ""
28368
28369 #. type: code{#1}
28370 #: guix-git/doc/guix.texi:16364
28371 #, no-wrap
28372 msgid "ssid"
28373 msgstr ""
28374
28375 #. type: table
28376 #: guix-git/doc/guix.texi:16367
28377 msgid "The SSID (@dfn{service set identifier}), a string that identifies this network."
28378 msgstr ""
28379
28380 #. type: item
28381 #: guix-git/doc/guix.texi:16368
28382 #, no-wrap
28383 msgid "@code{broadcast-ssid?} (default: @code{#t})"
28384 msgstr ""
28385
28386 #. type: table
28387 #: guix-git/doc/guix.texi:16370
28388 msgid "Whether to broadcast this SSID."
28389 msgstr ""
28390
28391 #. type: item
28392 #: guix-git/doc/guix.texi:16371
28393 #, no-wrap
28394 msgid "@code{channel} (default: @code{1})"
28395 msgstr ""
28396
28397 #. type: table
28398 #: guix-git/doc/guix.texi:16373
28399 msgid "The WiFi channel to use."
28400 msgstr ""
28401
28402 #. type: item
28403 #: guix-git/doc/guix.texi:16374
28404 #, no-wrap
28405 msgid "@code{driver} (default: @code{\"nl80211\"})"
28406 msgstr ""
28407
28408 #. type: table
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."
28411 msgstr ""
28412
28413 #. type: item
28414 #: guix-git/doc/guix.texi:16379 guix-git/doc/guix.texi:22248
28415 #: guix-git/doc/guix.texi:25098
28416 #, no-wrap
28417 msgid "@code{extra-settings} (default: @code{\"\"})"
28418 msgstr ""
28419
28420 #. type: table
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."
28423 msgstr ""
28424
28425 #. type: defvr
28426 #: guix-git/doc/guix.texi:16386
28427 #, no-wrap
28428 msgid "{Scheme Variable} simulated-wifi-service-type"
28429 msgstr ""
28430
28431 #. type: defvr
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."
28434 msgstr ""
28435
28436 #. type: defvr
28437 #: guix-git/doc/guix.texi:16395
28438 msgid "The service's value is a @code{hostapd-configuration} record."
28439 msgstr ""
28440
28441 #. type: cindex
28442 #: guix-git/doc/guix.texi:16397
28443 #, no-wrap
28444 msgid "iptables"
28445 msgstr ""
28446
28447 #. type: defvr
28448 #: guix-git/doc/guix.texi:16398
28449 #, no-wrap
28450 msgid "{Scheme Variable} iptables-service-type"
28451 msgstr ""
28452
28453 #. type: defvr
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."
28456 msgstr ""
28457
28458 #. type: lisp
28459 #: guix-git/doc/guix.texi:16424
28460 #, no-wrap
28461 msgid ""
28462 "(service iptables-service-type\n"
28463 " (iptables-configuration\n"
28464 " (ipv4-rules (plain-file \"iptables.rules\" \"*filter\n"
28465 ":INPUT ACCEPT\n"
28466 ":FORWARD ACCEPT\n"
28467 ":OUTPUT ACCEPT\n"
28468 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28469 "-A INPUT -j REJECT --reject-with icmp-port-unreachable\n"
28470 "COMMIT\n"
28471 "\"))\n"
28472 " (ipv6-rules (plain-file \"ip6tables.rules\" \"*filter\n"
28473 ":INPUT ACCEPT\n"
28474 ":FORWARD ACCEPT\n"
28475 ":OUTPUT ACCEPT\n"
28476 "-A INPUT -p tcp --dport 22 -j ACCEPT\n"
28477 "-A INPUT -j REJECT --reject-with icmp6-port-unreachable\n"
28478 "COMMIT\n"
28479 "\"))))\n"
28480 msgstr ""
28481
28482 #. type: deftp
28483 #: guix-git/doc/guix.texi:16427
28484 #, no-wrap
28485 msgid "{Data Type} iptables-configuration"
28486 msgstr ""
28487
28488 #. type: deftp
28489 #: guix-git/doc/guix.texi:16429
28490 msgid "The data type representing the configuration of iptables."
28491 msgstr ""
28492
28493 #. type: item
28494 #: guix-git/doc/guix.texi:16431
28495 #, no-wrap
28496 msgid "@code{iptables} (default: @code{iptables})"
28497 msgstr ""
28498
28499 #. type: table
28500 #: guix-git/doc/guix.texi:16434
28501 msgid "The iptables package that provides @code{iptables-restore} and @code{ip6tables-restore}."
28502 msgstr ""
28503
28504 #. type: item
28505 #: guix-git/doc/guix.texi:16434
28506 #, no-wrap
28507 msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})"
28508 msgstr ""
28509
28510 #. type: table
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})."
28513 msgstr ""
28514
28515 #. type: item
28516 #: guix-git/doc/guix.texi:16438
28517 #, no-wrap
28518 msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})"
28519 msgstr ""
28520
28521 #. type: table
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})."
28524 msgstr ""
28525
28526 #. type: cindex
28527 #: guix-git/doc/guix.texi:16445
28528 #, no-wrap
28529 msgid "nftables"
28530 msgstr ""
28531
28532 #. type: defvr
28533 #: guix-git/doc/guix.texi:16446
28534 #, no-wrap
28535 msgid "{Scheme Variable} nftables-service-type"
28536 msgstr ""
28537
28538 #. type: defvr
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:"
28541 msgstr ""
28542
28543 #. type: lisp
28544 #: guix-git/doc/guix.texi:16457
28545 #, no-wrap
28546 msgid "(service nftables-service-type)\n"
28547 msgstr ""
28548
28549 #. type: deftp
28550 #: guix-git/doc/guix.texi:16460
28551 #, no-wrap
28552 msgid "{Data Type} nftables-configuration"
28553 msgstr ""
28554
28555 #. type: deftp
28556 #: guix-git/doc/guix.texi:16462
28557 msgid "The data type representing the configuration of nftables."
28558 msgstr ""
28559
28560 #. type: item
28561 #: guix-git/doc/guix.texi:16464
28562 #, no-wrap
28563 msgid "@code{package} (default: @code{nftables})"
28564 msgstr ""
28565
28566 #. type: table
28567 #: guix-git/doc/guix.texi:16466
28568 msgid "The nftables package that provides @command{nft}."
28569 msgstr ""
28570
28571 #. type: item
28572 #: guix-git/doc/guix.texi:16466
28573 #, no-wrap
28574 msgid "@code{ruleset} (default: @code{%default-nftables-ruleset})"
28575 msgstr ""
28576
28577 #. type: table
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})."
28580 msgstr ""
28581
28582 #. type: cindex
28583 #: guix-git/doc/guix.texi:16472
28584 #, no-wrap
28585 msgid "NTP (Network Time Protocol), service"
28586 msgstr ""
28587
28588 #. type: cindex
28589 #: guix-git/doc/guix.texi:16473
28590 #, no-wrap
28591 msgid "ntpd, service for the Network Time Protocol daemon"
28592 msgstr ""
28593
28594 #. type: cindex
28595 #: guix-git/doc/guix.texi:16474
28596 #, no-wrap
28597 msgid "real time clock"
28598 msgstr ""
28599
28600 #. type: defvr
28601 #: guix-git/doc/guix.texi:16475
28602 #, no-wrap
28603 msgid "{Scheme Variable} ntp-service-type"
28604 msgstr ""
28605
28606 #. type: defvr
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."
28609 msgstr ""
28610
28611 #. type: defvr
28612 #: guix-git/doc/guix.texi:16482
28613 msgid "The value of this service is an @code{ntpd-configuration} object, as described below."
28614 msgstr ""
28615
28616 #. type: deftp
28617 #: guix-git/doc/guix.texi:16484
28618 #, no-wrap
28619 msgid "{Data Type} ntp-configuration"
28620 msgstr ""
28621
28622 #. type: deftp
28623 #: guix-git/doc/guix.texi:16486
28624 msgid "This is the data type for the NTP service configuration."
28625 msgstr ""
28626
28627 #. type: item
28628 #: guix-git/doc/guix.texi:16488
28629 #, no-wrap
28630 msgid "@code{servers} (default: @code{%ntp-servers})"
28631 msgstr ""
28632
28633 #. type: table
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."
28636 msgstr ""
28637
28638 #. type: item
28639 #: guix-git/doc/guix.texi:16493
28640 #, no-wrap
28641 msgid "@code{allow-large-adjustment?} (default: @code{#t})"
28642 msgstr ""
28643
28644 #. type: table
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."
28647 msgstr ""
28648
28649 #. type: item
28650 #: guix-git/doc/guix.texi:16497
28651 #, no-wrap
28652 msgid "@code{ntp} (default: @code{ntp})"
28653 msgstr ""
28654
28655 #. type: table
28656 #: guix-git/doc/guix.texi:16499
28657 msgid "The NTP package to use."
28658 msgstr ""
28659
28660 #. type: defvr
28661 #: guix-git/doc/guix.texi:16502
28662 #, no-wrap
28663 msgid "{Scheme Variable} %ntp-servers"
28664 msgstr ""
28665
28666 #. type: defvr
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}."
28669 msgstr ""
28670
28671 #. type: deftp
28672 #: guix-git/doc/guix.texi:16507
28673 #, no-wrap
28674 msgid "{Data Type} ntp-server"
28675 msgstr ""
28676
28677 #. type: deftp
28678 #: guix-git/doc/guix.texi:16509
28679 msgid "The data type representing the configuration of a NTP server."
28680 msgstr ""
28681
28682 #. type: item
28683 #: guix-git/doc/guix.texi:16511
28684 #, no-wrap
28685 msgid "@code{type} (default: @code{'server})"
28686 msgstr ""
28687
28688 #. type: table
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}."
28691 msgstr ""
28692
28693 #. type: code{#1}
28694 #: guix-git/doc/guix.texi:16515
28695 #, no-wrap
28696 msgid "address"
28697 msgstr ""
28698
28699 #. type: table
28700 #: guix-git/doc/guix.texi:16517
28701 msgid "The address of the server, as a string."
28702 msgstr ""
28703
28704 #. type: code{#1}
28705 #: guix-git/doc/guix.texi:16518 guix-git/doc/guix.texi:31708
28706 #: guix-git/doc/guix.texi:31728
28707 #, no-wrap
28708 msgid "options"
28709 msgstr ""
28710
28711 #. type: table
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."
28714 msgstr ""
28715
28716 #. type: example
28717 #: guix-git/doc/guix.texi:16529
28718 #, no-wrap
28719 msgid ""
28720 "(ntp-server\n"
28721 " (type 'server)\n"
28722 " (address \"some.ntp.server.org\")\n"
28723 " (options `(iburst (version 3) (maxpoll 16) prefer))))\n"
28724 msgstr ""
28725
28726 #. type: cindex
28727 #: guix-git/doc/guix.texi:16533
28728 #, no-wrap
28729 msgid "OpenNTPD"
28730 msgstr ""
28731
28732 #. type: deffn
28733 #: guix-git/doc/guix.texi:16534
28734 #, no-wrap
28735 msgid "{Scheme Procedure} openntpd-service-type"
28736 msgstr ""
28737
28738 #. type: deffn
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."
28741 msgstr ""
28742
28743 #. type: lisp
28744 #: guix-git/doc/guix.texi:16547
28745 #, no-wrap
28746 msgid ""
28747 "(service\n"
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"
28754 "\n"
28755 msgstr ""
28756
28757 #. type: defvr
28758 #: guix-git/doc/guix.texi:16551
28759 #, no-wrap
28760 msgid "{Scheme Variable} %openntpd-servers"
28761 msgstr ""
28762
28763 #. type: defvr
28764 #: guix-git/doc/guix.texi:16554
28765 msgid "This variable is a list of the server addresses defined in @code{%ntp-servers}."
28766 msgstr ""
28767
28768 #. type: deftp
28769 #: guix-git/doc/guix.texi:16556
28770 #, no-wrap
28771 msgid "{Data Type} openntpd-configuration"
28772 msgstr ""
28773
28774 #. type: item
28775 #: guix-git/doc/guix.texi:16558
28776 #, no-wrap
28777 msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})"
28778 msgstr ""
28779
28780 #. type: table
28781 #: guix-git/doc/guix.texi:16560
28782 msgid "The openntpd executable to use."
28783 msgstr ""
28784
28785 #. type: item
28786 #: guix-git/doc/guix.texi:16560
28787 #, no-wrap
28788 msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})"
28789 msgstr ""
28790
28791 #. type: table
28792 #: guix-git/doc/guix.texi:16562
28793 msgid "A list of local IP addresses or hostnames the ntpd daemon should listen on."
28794 msgstr ""
28795
28796 #. type: item
28797 #: guix-git/doc/guix.texi:16562
28798 #, no-wrap
28799 msgid "@code{query-from} (default: @code{'()})"
28800 msgstr ""
28801
28802 #. type: table
28803 #: guix-git/doc/guix.texi:16564
28804 msgid "A list of local IP address the ntpd daemon should use for outgoing queries."
28805 msgstr ""
28806
28807 #. type: item
28808 #: guix-git/doc/guix.texi:16564
28809 #, no-wrap
28810 msgid "@code{sensor} (default: @code{'()})"
28811 msgstr ""
28812
28813 #. type: table
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."
28816 msgstr ""
28817
28818 #. type: item
28819 #: guix-git/doc/guix.texi:16569
28820 #, no-wrap
28821 msgid "@code{server} (default: @code{'()})"
28822 msgstr ""
28823
28824 #. type: table
28825 #: guix-git/doc/guix.texi:16571
28826 msgid "Specify a list of IP addresses or hostnames of NTP servers to synchronize to."
28827 msgstr ""
28828
28829 #. type: item
28830 #: guix-git/doc/guix.texi:16571
28831 #, no-wrap
28832 msgid "@code{servers} (default: @code{%openntp-servers})"
28833 msgstr ""
28834
28835 #. type: table
28836 #: guix-git/doc/guix.texi:16573
28837 msgid "Specify a list of IP addresses or hostnames of NTP pools to synchronize to."
28838 msgstr ""
28839
28840 #. type: item
28841 #: guix-git/doc/guix.texi:16573
28842 #, no-wrap
28843 msgid "@code{constraint-from} (default: @code{'()})"
28844 msgstr ""
28845
28846 #. type: table
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."
28849 msgstr ""
28850
28851 #. type: item
28852 #: guix-git/doc/guix.texi:16580
28853 #, no-wrap
28854 msgid "@code{constraints-from} (default: @code{'()})"
28855 msgstr ""
28856
28857 #. type: table
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."
28860 msgstr ""
28861
28862 #. type: cindex
28863 #: guix-git/doc/guix.texi:16587
28864 #, no-wrap
28865 msgid "inetd"
28866 msgstr ""
28867
28868 #. type: deffn
28869 #: guix-git/doc/guix.texi:16588
28870 #, no-wrap
28871 msgid "{Scheme variable} inetd-service-type"
28872 msgstr ""
28873
28874 #. type: deffn
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."
28877 msgstr ""
28878
28879 #. type: deffn
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}:"
28882 msgstr ""
28883
28884 #. type: lisp
28885 #: guix-git/doc/guix.texi:16622
28886 #, no-wrap
28887 msgid ""
28888 "(service\n"
28889 " inetd-service-type\n"
28890 " (inetd-configuration\n"
28891 " (entries (list\n"
28892 " (inetd-entry\n"
28893 " (name \"echo\")\n"
28894 " (socket-type 'stream)\n"
28895 " (protocol \"tcp\")\n"
28896 " (wait? #f)\n"
28897 " (user \"root\"))\n"
28898 " (inetd-entry\n"
28899 " (node \"127.0.0.1\")\n"
28900 " (name \"smtp\")\n"
28901 " (socket-type 'stream)\n"
28902 " (protocol \"tcp\")\n"
28903 " (wait? #f)\n"
28904 " (user \"root\")\n"
28905 " (program (file-append openssh \"/bin/ssh\"))\n"
28906 " (arguments\n"
28907 " '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n"
28908 " \"-W\" \"smtp-server:25\" \"user@@hostname\")))))))\n"
28909 msgstr ""
28910
28911 #. type: deffn
28912 #: guix-git/doc/guix.texi:16625
28913 msgid "See below for more details about @code{inetd-configuration}."
28914 msgstr ""
28915
28916 #. type: deftp
28917 #: guix-git/doc/guix.texi:16627
28918 #, no-wrap
28919 msgid "{Data Type} inetd-configuration"
28920 msgstr ""
28921
28922 #. type: deftp
28923 #: guix-git/doc/guix.texi:16629
28924 msgid "Data type representing the configuration of @command{inetd}."
28925 msgstr ""
28926
28927 #. type: item
28928 #: guix-git/doc/guix.texi:16631
28929 #, no-wrap
28930 msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})"
28931 msgstr ""
28932
28933 #. type: table
28934 #: guix-git/doc/guix.texi:16633
28935 msgid "The @command{inetd} executable to use."
28936 msgstr ""
28937
28938 #. type: item
28939 #: guix-git/doc/guix.texi:16634 guix-git/doc/guix.texi:25932
28940 #, no-wrap
28941 msgid "@code{entries} (default: @code{'()})"
28942 msgstr ""
28943
28944 #. type: table
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."
28947 msgstr ""
28948
28949 #. type: deftp
28950 #: guix-git/doc/guix.texi:16640
28951 #, no-wrap
28952 msgid "{Data Type} inetd-entry"
28953 msgstr ""
28954
28955 #. type: deftp
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."
28958 msgstr ""
28959
28960 #. type: item
28961 #: guix-git/doc/guix.texi:16646
28962 #, no-wrap
28963 msgid "@code{node} (default: @code{#f})"
28964 msgstr ""
28965
28966 #. type: table
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."
28969 msgstr ""
28970
28971 #. type: table
28972 #: guix-git/doc/guix.texi:16653
28973 msgid "A string, the name must correspond to an entry in @code{/etc/services}."
28974 msgstr ""
28975
28976 #. type: code{#1}
28977 #: guix-git/doc/guix.texi:16653
28978 #, no-wrap
28979 msgid "socket-type"
28980 msgstr ""
28981
28982 #. type: table
28983 #: guix-git/doc/guix.texi:16656
28984 msgid "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or @code{'seqpacket}."
28985 msgstr ""
28986
28987 #. type: code{#1}
28988 #: guix-git/doc/guix.texi:16656
28989 #, no-wrap
28990 msgid "protocol"
28991 msgstr ""
28992
28993 #. type: table
28994 #: guix-git/doc/guix.texi:16658
28995 msgid "A string, must correspond to an entry in @code{/etc/protocols}."
28996 msgstr ""
28997
28998 #. type: item
28999 #: guix-git/doc/guix.texi:16658
29000 #, no-wrap
29001 msgid "@code{wait?} (default: @code{#t})"
29002 msgstr ""
29003
29004 #. type: table
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."
29007 msgstr ""
29008
29009 #. type: table
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\"}."
29012 msgstr ""
29013
29014 #. type: item
29015 #: guix-git/doc/guix.texi:16666
29016 #, no-wrap
29017 msgid "@code{program} (default: @code{\"internal\"})"
29018 msgstr ""
29019
29020 #. type: table
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."
29023 msgstr ""
29024
29025 #. type: table
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\")}."
29028 msgstr ""
29029
29030 #. type: deftp
29031 #: guix-git/doc/guix.texi:16678
29032 msgid "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed discussion of each configuration field."
29033 msgstr ""
29034
29035 #. type: cindex
29036 #: guix-git/doc/guix.texi:16680
29037 #, no-wrap
29038 msgid "Tor"
29039 msgstr ""
29040
29041 #. type: defvr
29042 #: guix-git/doc/guix.texi:16681
29043 #, no-wrap
29044 msgid "{Scheme Variable} tor-service-type"
29045 msgstr ""
29046
29047 #. type: defvr
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."
29050 msgstr ""
29051
29052 #. type: deftp
29053 #: guix-git/doc/guix.texi:16689
29054 #, no-wrap
29055 msgid "{Data Type} tor-configuration"
29056 msgstr ""
29057
29058 #. type: item
29059 #: guix-git/doc/guix.texi:16691
29060 #, no-wrap
29061 msgid "@code{tor} (default: @code{tor})"
29062 msgstr ""
29063
29064 #. type: table
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."
29067 msgstr ""
29068
29069 #. type: item
29070 #: guix-git/doc/guix.texi:16697
29071 #, no-wrap
29072 msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})"
29073 msgstr ""
29074
29075 #. type: table
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."
29078 msgstr ""
29079
29080 #. type: item
29081 #: guix-git/doc/guix.texi:16704
29082 #, no-wrap
29083 msgid "@code{hidden-services} (default: @code{'()})"
29084 msgstr ""
29085
29086 #. type: table
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."
29089 msgstr ""
29090
29091 #. type: item
29092 #: guix-git/doc/guix.texi:16711
29093 #, no-wrap
29094 msgid "@code{socks-socket-type} (default: @code{'tcp})"
29095 msgstr ""
29096
29097 #. type: table
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."
29100 msgstr ""
29101
29102 #. type: table
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."
29105 msgstr ""
29106
29107 #. type: item
29108 #: guix-git/doc/guix.texi:16724
29109 #, no-wrap
29110 msgid "@code{control-socket?} (default: @code{#f})"
29111 msgstr ""
29112
29113 #. type: table
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."
29116 msgstr ""
29117
29118 #. type: cindex
29119 #: guix-git/doc/guix.texi:16734
29120 #, no-wrap
29121 msgid "hidden service"
29122 msgstr ""
29123
29124 #. type: deffn
29125 #: guix-git/doc/guix.texi:16735
29126 #, no-wrap
29127 msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}"
29128 msgstr ""
29129
29130 #. type: deffn
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:"
29133 msgstr ""
29134
29135 #. type: example
29136 #: guix-git/doc/guix.texi:16742
29137 #, no-wrap
29138 msgid ""
29139 " '((22 \"127.0.0.1:22\")\n"
29140 " (80 \"127.0.0.1:8080\"))\n"
29141 msgstr ""
29142
29143 #. type: deffn
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."
29146 msgstr ""
29147
29148 #. type: deffn
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."
29151 msgstr ""
29152
29153 #. type: deffn
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."
29156 msgstr ""
29157
29158 #. type: Plain text
29159 #: guix-git/doc/guix.texi:16756
29160 msgid "The @code{(gnu services rsync)} module provides the following services:"
29161 msgstr ""
29162
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."
29166 msgstr ""
29167
29168 #. type: deffn
29169 #: guix-git/doc/guix.texi:16761
29170 #, no-wrap
29171 msgid "{Scheme Variable} rsync-service-type"
29172 msgstr ""
29173
29174 #. type: deffn
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:"
29177 msgstr ""
29178
29179 #. type: lisp
29180 #: guix-git/doc/guix.texi:16768
29181 #, no-wrap
29182 msgid "(service rsync-service-type)\n"
29183 msgstr ""
29184
29185 #. type: deffn
29186 #: guix-git/doc/guix.texi:16771
29187 msgid "See below for details about @code{rsync-configuration}."
29188 msgstr ""
29189
29190 #. type: deftp
29191 #: guix-git/doc/guix.texi:16773
29192 #, no-wrap
29193 msgid "{Data Type} rsync-configuration"
29194 msgstr ""
29195
29196 #. type: deftp
29197 #: guix-git/doc/guix.texi:16775
29198 msgid "Data type representing the configuration for @code{rsync-service}."
29199 msgstr ""
29200
29201 #. type: item
29202 #: guix-git/doc/guix.texi:16777
29203 #, no-wrap
29204 msgid "@code{package} (default: @var{rsync})"
29205 msgstr ""
29206
29207 #. type: table
29208 #: guix-git/doc/guix.texi:16779
29209 msgid "@code{rsync} package to use."
29210 msgstr ""
29211
29212 #. type: item
29213 #: guix-git/doc/guix.texi:16780
29214 #, no-wrap
29215 msgid "@code{port-number} (default: @code{873})"
29216 msgstr ""
29217
29218 #. type: table
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."
29221 msgstr ""
29222
29223 #. type: item
29224 #: guix-git/doc/guix.texi:16785
29225 #, no-wrap
29226 msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})"
29227 msgstr ""
29228
29229 #. type: table
29230 #: guix-git/doc/guix.texi:16787
29231 msgid "Name of the file where @command{rsync} writes its PID."
29232 msgstr ""
29233
29234 #. type: item
29235 #: guix-git/doc/guix.texi:16788
29236 #, no-wrap
29237 msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})"
29238 msgstr ""
29239
29240 #. type: table
29241 #: guix-git/doc/guix.texi:16790
29242 msgid "Name of the file where @command{rsync} writes its lock file."
29243 msgstr ""
29244
29245 #. type: item
29246 #: guix-git/doc/guix.texi:16791
29247 #, no-wrap
29248 msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})"
29249 msgstr ""
29250
29251 #. type: table
29252 #: guix-git/doc/guix.texi:16793
29253 msgid "Name of the file where @command{rsync} writes its log file."
29254 msgstr ""
29255
29256 #. type: item
29257 #: guix-git/doc/guix.texi:16794
29258 #, no-wrap
29259 msgid "@code{use-chroot?} (default: @var{#t})"
29260 msgstr ""
29261
29262 #. type: table
29263 #: guix-git/doc/guix.texi:16796
29264 msgid "Whether to use chroot for @command{rsync} shared directory."
29265 msgstr ""
29266
29267 #. type: item
29268 #: guix-git/doc/guix.texi:16797
29269 #, no-wrap
29270 msgid "@code{share-path} (default: @file{/srv/rsync})"
29271 msgstr ""
29272
29273 #. type: table
29274 #: guix-git/doc/guix.texi:16799
29275 msgid "Location of the @command{rsync} shared directory."
29276 msgstr ""
29277
29278 #. type: item
29279 #: guix-git/doc/guix.texi:16800
29280 #, no-wrap
29281 msgid "@code{share-comment} (default: @code{\"Rsync share\"})"
29282 msgstr ""
29283
29284 #. type: table
29285 #: guix-git/doc/guix.texi:16802
29286 msgid "Comment of the @command{rsync} shared directory."
29287 msgstr ""
29288
29289 #. type: item
29290 #: guix-git/doc/guix.texi:16803
29291 #, no-wrap
29292 msgid "@code{read-only?} (default: @var{#f})"
29293 msgstr ""
29294
29295 #. type: table
29296 #: guix-git/doc/guix.texi:16805
29297 msgid "Read-write permissions to shared directory."
29298 msgstr ""
29299
29300 #. type: item
29301 #: guix-git/doc/guix.texi:16806
29302 #, no-wrap
29303 msgid "@code{timeout} (default: @code{300})"
29304 msgstr ""
29305
29306 #. type: table
29307 #: guix-git/doc/guix.texi:16808
29308 msgid "I/O timeout in seconds."
29309 msgstr ""
29310
29311 #. type: item
29312 #: guix-git/doc/guix.texi:16809
29313 #, no-wrap
29314 msgid "@code{user} (default: @var{\"root\"})"
29315 msgstr ""
29316
29317 #. type: table
29318 #: guix-git/doc/guix.texi:16811
29319 msgid "Owner of the @code{rsync} process."
29320 msgstr ""
29321
29322 #. type: item
29323 #: guix-git/doc/guix.texi:16812
29324 #, no-wrap
29325 msgid "@code{group} (default: @var{\"root\"})"
29326 msgstr ""
29327
29328 #. type: table
29329 #: guix-git/doc/guix.texi:16814
29330 msgid "Group of the @code{rsync} process."
29331 msgstr ""
29332
29333 #. type: item
29334 #: guix-git/doc/guix.texi:16815
29335 #, no-wrap
29336 msgid "@code{uid} (default: @var{\"rsyncd\"})"
29337 msgstr ""
29338
29339 #. type: table
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}."
29342 msgstr ""
29343
29344 #. type: item
29345 #: guix-git/doc/guix.texi:16819
29346 #, no-wrap
29347 msgid "@code{gid} (default: @var{\"rsyncd\"})"
29348 msgstr ""
29349
29350 #. type: table
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."
29353 msgstr ""
29354
29355 #. type: Plain text
29356 #: guix-git/doc/guix.texi:16826
29357 msgid "The @code{(gnu services syncthing)} module provides the following services:"
29358 msgstr ""
29359
29360 #. type: cindex
29361 #: guix-git/doc/guix.texi:16826
29362 #, no-wrap
29363 msgid "syncthing"
29364 msgstr ""
29365
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."
29369 msgstr ""
29370
29371 #. type: deffn
29372 #: guix-git/doc/guix.texi:16832
29373 #, no-wrap
29374 msgid "{Scheme Variable} syncthing-service-type"
29375 msgstr ""
29376
29377 #. type: deffn
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:"
29380 msgstr ""
29381
29382 #. type: lisp
29383 #: guix-git/doc/guix.texi:16840
29384 #, no-wrap
29385 msgid ""
29386 "(service syncthing-service-type\n"
29387 " (syncthing-configuration (user \"alice\")))\n"
29388 msgstr ""
29389
29390 #. type: deffn
29391 #: guix-git/doc/guix.texi:16843
29392 msgid "See below for details about @code{syncthing-configuration}."
29393 msgstr ""
29394
29395 #. type: deftp
29396 #: guix-git/doc/guix.texi:16844
29397 #, no-wrap
29398 msgid "{Data Type} syncthing-configuration"
29399 msgstr ""
29400
29401 #. type: deftp
29402 #: guix-git/doc/guix.texi:16846
29403 msgid "Data type representing the configuration for @code{syncthing-service-type}."
29404 msgstr ""
29405
29406 #. type: item
29407 #: guix-git/doc/guix.texi:16848
29408 #, no-wrap
29409 msgid "@code{syncthing} (default: @var{syncthing})"
29410 msgstr ""
29411
29412 #. type: table
29413 #: guix-git/doc/guix.texi:16850
29414 msgid "@code{syncthing} package to use."
29415 msgstr ""
29416
29417 #. type: item
29418 #: guix-git/doc/guix.texi:16851
29419 #, no-wrap
29420 msgid "@code{arguments} (default: @var{'()})"
29421 msgstr ""
29422
29423 #. type: table
29424 #: guix-git/doc/guix.texi:16853
29425 msgid "List of command-line arguments passing to @code{syncthing} binary."
29426 msgstr ""
29427
29428 #. type: item
29429 #: guix-git/doc/guix.texi:16854
29430 #, no-wrap
29431 msgid "@code{logflags} (default: @var{0})"
29432 msgstr ""
29433
29434 #. type: table
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}."
29437 msgstr ""
29438
29439 #. type: item
29440 #: guix-git/doc/guix.texi:16858
29441 #, no-wrap
29442 msgid "@code{user} (default: @var{#f})"
29443 msgstr ""
29444
29445 #. type: table
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."
29448 msgstr ""
29449
29450 #. type: item
29451 #: guix-git/doc/guix.texi:16862
29452 #, no-wrap
29453 msgid "@code{group} (default: @var{\"users\"})"
29454 msgstr ""
29455
29456 #. type: table
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."
29459 msgstr ""
29460
29461 #. type: item
29462 #: guix-git/doc/guix.texi:16866
29463 #, no-wrap
29464 msgid "@code{home} (default: @var{#f})"
29465 msgstr ""
29466
29467 #. type: table
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}."
29470 msgstr ""
29471
29472 #. type: Plain text
29473 #: guix-git/doc/guix.texi:16875
29474 msgid "Furthermore, @code{(gnu services ssh)} provides the following services."
29475 msgstr ""
29476
29477 #. type: cindex
29478 #: guix-git/doc/guix.texi:16875 guix-git/doc/guix.texi:16914
29479 #: guix-git/doc/guix.texi:33575
29480 #, no-wrap
29481 msgid "SSH"
29482 msgstr ""
29483
29484 #. type: cindex
29485 #: guix-git/doc/guix.texi:16876 guix-git/doc/guix.texi:16915
29486 #: guix-git/doc/guix.texi:33576
29487 #, no-wrap
29488 msgid "SSH server"
29489 msgstr ""
29490
29491 #. type: deffn
29492 #: guix-git/doc/guix.texi:16878
29493 #, no-wrap
29494 msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @"
29495 msgstr ""
29496
29497 #. type: deffn
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."
29500 msgstr ""
29501
29502 #. type: deffn
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}."
29505 msgstr ""
29506
29507 #. type: deffn
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."
29510 msgstr ""
29511
29512 #. type: deffn
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})."
29515 msgstr ""
29516
29517 #. type: deffn
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."
29520 msgstr ""
29521
29522 #. type: deffn
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."
29525 msgstr ""
29526
29527 #. type: deffn
29528 #: guix-git/doc/guix.texi:16912
29529 msgid "The other options should be self-descriptive."
29530 msgstr ""
29531
29532 #. type: deffn
29533 #: guix-git/doc/guix.texi:16916
29534 #, no-wrap
29535 msgid "{Scheme Variable} openssh-service-type"
29536 msgstr ""
29537
29538 #. type: deffn
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:"
29541 msgstr ""
29542
29543 #. type: lisp
29544 #: guix-git/doc/guix.texi:16929
29545 #, no-wrap
29546 msgid ""
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"
29554 msgstr ""
29555
29556 #. type: deffn
29557 #: guix-git/doc/guix.texi:16932
29558 msgid "See below for details about @code{openssh-configuration}."
29559 msgstr ""
29560
29561 #. type: deffn
29562 #: guix-git/doc/guix.texi:16935
29563 msgid "This service can be extended with extra authorized keys, as in this example:"
29564 msgstr ""
29565
29566 #. type: lisp
29567 #: guix-git/doc/guix.texi:16940
29568 #, no-wrap
29569 msgid ""
29570 "(service-extension openssh-service-type\n"
29571 " (const `((\"charlie\"\n"
29572 " ,(local-file \"charlie.pub\")))))\n"
29573 msgstr ""
29574
29575 #. type: deftp
29576 #: guix-git/doc/guix.texi:16943
29577 #, no-wrap
29578 msgid "{Data Type} openssh-configuration"
29579 msgstr ""
29580
29581 #. type: deftp
29582 #: guix-git/doc/guix.texi:16945
29583 msgid "This is the configuration record for OpenSSH's @command{sshd}."
29584 msgstr ""
29585
29586 #. type: item
29587 #: guix-git/doc/guix.texi:16947
29588 #, no-wrap
29589 msgid "@code{openssh} (default @var{openssh})"
29590 msgstr ""
29591
29592 #. type: table
29593 #: guix-git/doc/guix.texi:16949
29594 msgid "The Openssh package to use."
29595 msgstr ""
29596
29597 #. type: item
29598 #: guix-git/doc/guix.texi:16950
29599 #, no-wrap
29600 msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})"
29601 msgstr ""
29602
29603 #. type: table
29604 #: guix-git/doc/guix.texi:16952
29605 msgid "Name of the file where @command{sshd} writes its PID."
29606 msgstr ""
29607
29608 #. type: item
29609 #: guix-git/doc/guix.texi:16953
29610 #, no-wrap
29611 msgid "@code{port-number} (default: @code{22})"
29612 msgstr ""
29613
29614 #. type: table
29615 #: guix-git/doc/guix.texi:16955
29616 msgid "TCP port on which @command{sshd} listens for incoming connections."
29617 msgstr ""
29618
29619 #. type: item
29620 #: guix-git/doc/guix.texi:16956
29621 #, no-wrap
29622 msgid "@code{permit-root-login} (default: @code{#f})"
29623 msgstr ""
29624
29625 #. type: table
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."
29628 msgstr ""
29629
29630 #. type: item
29631 #: guix-git/doc/guix.texi:16962 guix-git/doc/guix.texi:17123
29632 #, no-wrap
29633 msgid "@code{allow-empty-passwords?} (default: @code{#f})"
29634 msgstr ""
29635
29636 #. type: table
29637 #: guix-git/doc/guix.texi:16965
29638 msgid "When true, users with empty passwords may log in. When false, they may not."
29639 msgstr ""
29640
29641 #. type: item
29642 #: guix-git/doc/guix.texi:16966 guix-git/doc/guix.texi:17126
29643 #, no-wrap
29644 msgid "@code{password-authentication?} (default: @code{#t})"
29645 msgstr ""
29646
29647 #. type: table
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."
29650 msgstr ""
29651
29652 #. type: item
29653 #: guix-git/doc/guix.texi:16970
29654 #, no-wrap
29655 msgid "@code{public-key-authentication?} (default: @code{#t})"
29656 msgstr ""
29657
29658 #. type: table
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."
29661 msgstr ""
29662
29663 #. type: table
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."
29666 msgstr ""
29667
29668 #. type: item
29669 #: guix-git/doc/guix.texi:16977
29670 #, no-wrap
29671 msgid "@code{x11-forwarding?} (default: @code{#f})"
29672 msgstr ""
29673
29674 #. type: table
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."
29677 msgstr ""
29678
29679 #. type: item
29680 #: guix-git/doc/guix.texi:16982
29681 #, no-wrap
29682 msgid "@code{allow-agent-forwarding?} (default: @code{#t})"
29683 msgstr ""
29684
29685 #. type: table
29686 #: guix-git/doc/guix.texi:16984
29687 msgid "Whether to allow agent forwarding."
29688 msgstr ""
29689
29690 #. type: item
29691 #: guix-git/doc/guix.texi:16985
29692 #, no-wrap
29693 msgid "@code{allow-tcp-forwarding?} (default: @code{#t})"
29694 msgstr ""
29695
29696 #. type: table
29697 #: guix-git/doc/guix.texi:16987
29698 msgid "Whether to allow TCP forwarding."
29699 msgstr ""
29700
29701 #. type: item
29702 #: guix-git/doc/guix.texi:16988
29703 #, no-wrap
29704 msgid "@code{gateway-ports?} (default: @code{#f})"
29705 msgstr ""
29706
29707 #. type: table
29708 #: guix-git/doc/guix.texi:16990
29709 msgid "Whether to allow gateway ports."
29710 msgstr ""
29711
29712 #. type: item
29713 #: guix-git/doc/guix.texi:16991
29714 #, no-wrap
29715 msgid "@code{challenge-response-authentication?} (default: @code{#f})"
29716 msgstr ""
29717
29718 #. type: table
29719 #: guix-git/doc/guix.texi:16994
29720 msgid "Specifies whether challenge response authentication is allowed (e.g.@: via PAM)."
29721 msgstr ""
29722
29723 #. type: item
29724 #: guix-git/doc/guix.texi:16995
29725 #, no-wrap
29726 msgid "@code{use-pam?} (default: @code{#t})"
29727 msgstr ""
29728
29729 #. type: table
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."
29732 msgstr ""
29733
29734 #. type: table
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?}."
29737 msgstr ""
29738
29739 #. type: item
29740 #: guix-git/doc/guix.texi:17007
29741 #, no-wrap
29742 msgid "@code{print-last-log?} (default: @code{#t})"
29743 msgstr ""
29744
29745 #. type: table
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."
29748 msgstr ""
29749
29750 #. type: item
29751 #: guix-git/doc/guix.texi:17011
29752 #, no-wrap
29753 msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})"
29754 msgstr ""
29755
29756 #. type: table
29757 #: guix-git/doc/guix.texi:17013
29758 msgid "Configures external subsystems (e.g.@: file transfer daemon)."
29759 msgstr ""
29760
29761 #. type: table
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."
29764 msgstr ""
29765
29766 #. type: table
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:"
29769 msgstr ""
29770
29771 #. type: lisp
29772 #: guix-git/doc/guix.texi:17025
29773 #, no-wrap
29774 msgid ""
29775 "(service openssh-service-type\n"
29776 " (openssh-configuration\n"
29777 " (subsystems\n"
29778 " `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n"
29779 msgstr ""
29780
29781 #. type: item
29782 #: guix-git/doc/guix.texi:17027
29783 #, no-wrap
29784 msgid "@code{accepted-environment} (default: @code{'()})"
29785 msgstr ""
29786
29787 #. type: table
29788 #: guix-git/doc/guix.texi:17029
29789 msgid "List of strings describing which environment variables may be exported."
29790 msgstr ""
29791
29792 #. type: table
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}."
29795 msgstr ""
29796
29797 #. type: table
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."
29800 msgstr ""
29801
29802 #. type: lisp
29803 #: guix-git/doc/guix.texi:17042
29804 #, no-wrap
29805 msgid ""
29806 "(service openssh-service-type\n"
29807 " (openssh-configuration\n"
29808 " (accepted-environment '(\"COLORTERM\"))))\n"
29809 msgstr ""
29810
29811 #. type: item
29812 #: guix-git/doc/guix.texi:17044
29813 #, no-wrap
29814 msgid "@code{authorized-keys} (default: @code{'()})"
29815 msgstr ""
29816
29817 #. type: cindex
29818 #: guix-git/doc/guix.texi:17045
29819 #, no-wrap
29820 msgid "authorized keys, SSH"
29821 msgstr ""
29822
29823 #. type: cindex
29824 #: guix-git/doc/guix.texi:17046
29825 #, no-wrap
29826 msgid "SSH authorized keys"
29827 msgstr ""
29828
29829 #. type: table
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:"
29832 msgstr ""
29833
29834 #. type: lisp
29835 #: guix-git/doc/guix.texi:17057
29836 #, no-wrap
29837 msgid ""
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"
29843 msgstr ""
29844
29845 #. type: table
29846 #: guix-git/doc/guix.texi:17062
29847 msgid "registers the specified public keys for user accounts @code{rekado}, @code{chris}, and @code{root}."
29848 msgstr ""
29849
29850 #. type: table
29851 #: guix-git/doc/guix.texi:17065
29852 msgid "Additional authorized keys can be specified @i{via} @code{service-extension}."
29853 msgstr ""
29854
29855 #. type: table
29856 #: guix-git/doc/guix.texi:17068
29857 msgid "Note that this does @emph{not} interfere with the use of @file{~/.ssh/authorized_keys}."
29858 msgstr ""
29859
29860 #. type: item
29861 #: guix-git/doc/guix.texi:17069 guix-git/doc/guix.texi:17500
29862 #, no-wrap
29863 msgid "@code{log-level} (default: @code{'info})"
29864 msgstr ""
29865
29866 #. type: table
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."
29869 msgstr ""
29870
29871 #. type: item
29872 #: guix-git/doc/guix.texi:17074 guix-git/doc/guix.texi:19894
29873 #: guix-git/doc/guix.texi:24760
29874 #, no-wrap
29875 msgid "@code{extra-content} (default: @code{\"\"})"
29876 msgstr ""
29877
29878 #. type: table
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:"
29881 msgstr ""
29882
29883 #. type: lisp
29884 #: guix-git/doc/guix.texi:17085
29885 #, no-wrap
29886 msgid ""
29887 "(openssh-configuration\n"
29888 " (extra-content \"\\\n"
29889 "Match Address 192.168.0.1\n"
29890 " PermitRootLogin yes\"))\n"
29891 msgstr ""
29892
29893 #. type: deffn
29894 #: guix-git/doc/guix.texi:17090
29895 #, no-wrap
29896 msgid "{Scheme Procedure} dropbear-service [@var{config}]"
29897 msgstr ""
29898
29899 #. type: deffn
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."
29902 msgstr ""
29903
29904 #. type: deffn
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:"
29907 msgstr ""
29908
29909 #. type: lisp
29910 #: guix-git/doc/guix.texi:17101
29911 #, no-wrap
29912 msgid ""
29913 "(dropbear-service (dropbear-configuration\n"
29914 " (port-number 1234)))\n"
29915 msgstr ""
29916
29917 #. type: deftp
29918 #: guix-git/doc/guix.texi:17104
29919 #, no-wrap
29920 msgid "{Data Type} dropbear-configuration"
29921 msgstr ""
29922
29923 #. type: deftp
29924 #: guix-git/doc/guix.texi:17106
29925 msgid "This data type represents the configuration of a Dropbear SSH daemon."
29926 msgstr ""
29927
29928 #. type: item
29929 #: guix-git/doc/guix.texi:17108
29930 #, no-wrap
29931 msgid "@code{dropbear} (default: @var{dropbear})"
29932 msgstr ""
29933
29934 #. type: table
29935 #: guix-git/doc/guix.texi:17110
29936 msgid "The Dropbear package to use."
29937 msgstr ""
29938
29939 #. type: item
29940 #: guix-git/doc/guix.texi:17111
29941 #, no-wrap
29942 msgid "@code{port-number} (default: 22)"
29943 msgstr ""
29944
29945 #. type: table
29946 #: guix-git/doc/guix.texi:17113
29947 msgid "The TCP port where the daemon waits for incoming connections."
29948 msgstr ""
29949
29950 #. type: item
29951 #: guix-git/doc/guix.texi:17114
29952 #, no-wrap
29953 msgid "@code{syslog-output?} (default: @code{#t})"
29954 msgstr ""
29955
29956 #. type: table
29957 #: guix-git/doc/guix.texi:17116
29958 msgid "Whether to enable syslog output."
29959 msgstr ""
29960
29961 #. type: item
29962 #: guix-git/doc/guix.texi:17117
29963 #, no-wrap
29964 msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})"
29965 msgstr ""
29966
29967 #. type: table
29968 #: guix-git/doc/guix.texi:17119
29969 msgid "File name of the daemon's PID file."
29970 msgstr ""
29971
29972 #. type: item
29973 #: guix-git/doc/guix.texi:17120
29974 #, no-wrap
29975 msgid "@code{root-login?} (default: @code{#f})"
29976 msgstr ""
29977
29978 #. type: table
29979 #: guix-git/doc/guix.texi:17122
29980 msgid "Whether to allow @code{root} logins."
29981 msgstr ""
29982
29983 #. type: table
29984 #: guix-git/doc/guix.texi:17125
29985 msgid "Whether to allow empty passwords."
29986 msgstr ""
29987
29988 #. type: table
29989 #: guix-git/doc/guix.texi:17128
29990 msgid "Whether to enable password-based authentication."
29991 msgstr ""
29992
29993 #. type: cindex
29994 #: guix-git/doc/guix.texi:17131
29995 #, no-wrap
29996 msgid "AutoSSH"
29997 msgstr ""
29998
29999 #. type: deffn
30000 #: guix-git/doc/guix.texi:17132
30001 #, no-wrap
30002 msgid "{Scheme Variable} autossh-service-type"
30003 msgstr ""
30004
30005 #. type: deffn
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."
30008 msgstr ""
30009
30010 #. type: deffn
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."
30013 msgstr ""
30014
30015 #. type: deffn
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:"
30018 msgstr ""
30019
30020 #. type: lisp
30021 #: guix-git/doc/guix.texi:17155
30022 #, no-wrap
30023 msgid ""
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"
30028 msgstr ""
30029
30030 #. type: deftp
30031 #: guix-git/doc/guix.texi:17158
30032 #, no-wrap
30033 msgid "{Data Type} autossh-configuration"
30034 msgstr ""
30035
30036 #. type: deftp
30037 #: guix-git/doc/guix.texi:17160
30038 msgid "This data type represents the configuration of an AutoSSH service."
30039 msgstr ""
30040
30041 #. type: item
30042 #: guix-git/doc/guix.texi:17163
30043 #, no-wrap
30044 msgid "@code{user} (default @code{\"autossh\"})"
30045 msgstr ""
30046
30047 #. type: table
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."
30050 msgstr ""
30051
30052 #. type: item
30053 #: guix-git/doc/guix.texi:17167
30054 #, no-wrap
30055 msgid "@code{poll} (default @code{600})"
30056 msgstr ""
30057
30058 #. type: table
30059 #: guix-git/doc/guix.texi:17169
30060 msgid "Specifies the connection poll time in seconds."
30061 msgstr ""
30062
30063 #. type: item
30064 #: guix-git/doc/guix.texi:17170
30065 #, no-wrap
30066 msgid "@code{first-poll} (default @code{#f})"
30067 msgstr ""
30068
30069 #. type: table
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}."
30072 msgstr ""
30073
30074 #. type: item
30075 #: guix-git/doc/guix.texi:17177
30076 #, no-wrap
30077 msgid "@code{gate-time} (default @code{30})"
30078 msgstr ""
30079
30080 #. type: table
30081 #: guix-git/doc/guix.texi:17180
30082 msgid "Specifies how many seconds an SSH connection must be active before it is considered successful."
30083 msgstr ""
30084
30085 #. type: item
30086 #: guix-git/doc/guix.texi:17181
30087 #, no-wrap
30088 msgid "@code{log-level} (default @code{1})"
30089 msgstr ""
30090
30091 #. type: table
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."
30094 msgstr ""
30095
30096 #. type: item
30097 #: guix-git/doc/guix.texi:17185
30098 #, no-wrap
30099 msgid "@code{max-start} (default @code{#f})"
30100 msgstr ""
30101
30102 #. type: table
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."
30105 msgstr ""
30106
30107 #. type: item
30108 #: guix-git/doc/guix.texi:17189
30109 #, no-wrap
30110 msgid "@code{message} (default @code{\"\"})"
30111 msgstr ""
30112
30113 #. type: table
30114 #: guix-git/doc/guix.texi:17191
30115 msgid "The message to append to the echo message sent when testing connections."
30116 msgstr ""
30117
30118 #. type: item
30119 #: guix-git/doc/guix.texi:17192
30120 #, no-wrap
30121 msgid "@code{port} (default @code{\"0\"})"
30122 msgstr ""
30123
30124 #. type: table
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."
30127 msgstr ""
30128
30129 #. type: item
30130 #: guix-git/doc/guix.texi:17203
30131 #, no-wrap
30132 msgid "@code{ssh-options} (default @code{'()})"
30133 msgstr ""
30134
30135 #. type: table
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."
30138 msgstr ""
30139
30140 #. type: cindex
30141 #: guix-git/doc/guix.texi:17211
30142 #, no-wrap
30143 msgid "WebSSH"
30144 msgstr ""
30145
30146 #. type: deffn
30147 #: guix-git/doc/guix.texi:17212
30148 #, no-wrap
30149 msgid "{Scheme Variable} webssh-service-type"
30150 msgstr ""
30151
30152 #. type: deffn
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."
30155 msgstr ""
30156
30157 #. type: deffn
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:"
30160 msgstr ""
30161
30162 #. type: lisp
30163 #: guix-git/doc/guix.texi:17232
30164 #, no-wrap
30165 msgid ""
30166 "(service webssh-service-type\n"
30167 " (webssh-configuration (address \"127.0.0.1\")\n"
30168 " (port 8888)\n"
30169 " (policy 'reject)\n"
30170 " (known-hosts '(\"localhost ecdsa-sha2-nistp256 AAAA…\"\n"
30171 " \"127.0.0.1 ecdsa-sha2-nistp256 AAAA…\"))))\n"
30172 "\n"
30173 msgstr ""
30174
30175 #. type: lisp
30176 #: guix-git/doc/guix.texi:17248
30177 #, no-wrap
30178 msgid ""
30179 "(service nginx-service-type\n"
30180 " (nginx-configuration\n"
30181 " (server-blocks\n"
30182 " (list\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"
30189 " (locations\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"
30194 msgstr ""
30195
30196 #. type: deftp
30197 #: guix-git/doc/guix.texi:17251
30198 #, no-wrap
30199 msgid "{Data Type} webssh-configuration"
30200 msgstr ""
30201
30202 #. type: deftp
30203 #: guix-git/doc/guix.texi:17253
30204 msgid "Data type representing the configuration for @code{webssh-service}."
30205 msgstr ""
30206
30207 #. type: item
30208 #: guix-git/doc/guix.texi:17255
30209 #, no-wrap
30210 msgid "@code{package} (default: @var{webssh})"
30211 msgstr ""
30212
30213 #. type: table
30214 #: guix-git/doc/guix.texi:17257
30215 msgid "@code{webssh} package to use."
30216 msgstr ""
30217
30218 #. type: item
30219 #: guix-git/doc/guix.texi:17258
30220 #, no-wrap
30221 msgid "@code{user-name} (default: @var{\"webssh\"})"
30222 msgstr ""
30223
30224 #. type: table
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."
30227 msgstr ""
30228
30229 #. type: item
30230 #: guix-git/doc/guix.texi:17262
30231 #, no-wrap
30232 msgid "@code{group-name} (default: @var{\"webssh\"})"
30233 msgstr ""
30234
30235 #. type: item
30236 #: guix-git/doc/guix.texi:17265
30237 #, no-wrap
30238 msgid "@code{address} (default: @var{#f})"
30239 msgstr ""
30240
30241 #. type: table
30242 #: guix-git/doc/guix.texi:17267
30243 msgid "IP address on which @command{webssh} listens for incoming connections."
30244 msgstr ""
30245
30246 #. type: item
30247 #: guix-git/doc/guix.texi:17268
30248 #, no-wrap
30249 msgid "@code{port} (default: @var{8888})"
30250 msgstr ""
30251
30252 #. type: table
30253 #: guix-git/doc/guix.texi:17270
30254 msgid "TCP port on which @command{webssh} listens for incoming connections."
30255 msgstr ""
30256
30257 #. type: item
30258 #: guix-git/doc/guix.texi:17271
30259 #, no-wrap
30260 msgid "@code{policy} (default: @var{#f})"
30261 msgstr ""
30262
30263 #. type: table
30264 #: guix-git/doc/guix.texi:17273
30265 msgid "Connection policy. @var{reject} policy requires to specify @var{known-hosts}."
30266 msgstr ""
30267
30268 #. type: item
30269 #: guix-git/doc/guix.texi:17274
30270 #, no-wrap
30271 msgid "@code{known-hosts} (default: @var{'()})"
30272 msgstr ""
30273
30274 #. type: table
30275 #: guix-git/doc/guix.texi:17276
30276 msgid "List of hosts which allowed for SSH connection from @command{webssh}."
30277 msgstr ""
30278
30279 #. type: item
30280 #: guix-git/doc/guix.texi:17277
30281 #, no-wrap
30282 msgid "@code{log-file} (default: @file{\"/var/log/webssh.log\"})"
30283 msgstr ""
30284
30285 #. type: table
30286 #: guix-git/doc/guix.texi:17279
30287 msgid "Name of the file where @command{webssh} writes its log file."
30288 msgstr ""
30289
30290 #. type: item
30291 #: guix-git/doc/guix.texi:17280
30292 #, no-wrap
30293 msgid "@code{log-level} (default: @var{#f})"
30294 msgstr ""
30295
30296 #. type: table
30297 #: guix-git/doc/guix.texi:17282
30298 msgid "Logging level."
30299 msgstr ""
30300
30301 #. type: defvr
30302 #: guix-git/doc/guix.texi:17286
30303 #, no-wrap
30304 msgid "{Scheme Variable} %facebook-host-aliases"
30305 msgstr ""
30306
30307 #. type: defvr
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}."
30310 msgstr ""
30311
30312 #. type: defvr
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}}):"
30315 msgstr ""
30316
30317 #. type: lisp
30318 #: guix-git/doc/guix.texi:17309
30319 #, no-wrap
30320 msgid ""
30321 "(operating-system\n"
30322 " (host-name \"mymachine\")\n"
30323 " ;; ...\n"
30324 " (hosts-file\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"
30330 msgstr ""
30331
30332 #. type: defvr
30333 #: guix-git/doc/guix.texi:17313
30334 msgid "This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook."
30335 msgstr ""
30336
30337 #. type: Plain text
30338 #: guix-git/doc/guix.texi:17316
30339 msgid "The @code{(gnu services avahi)} provides the following definition."
30340 msgstr ""
30341
30342 #. type: defvr
30343 #: guix-git/doc/guix.texi:17317
30344 #, no-wrap
30345 msgid "{Scheme Variable} avahi-service-type"
30346 msgstr ""
30347
30348 #. type: defvr
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."
30351 msgstr ""
30352
30353 #. type: defvr
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."
30356 msgstr ""
30357
30358 #. type: defvr
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."
30361 msgstr ""
30362
30363 #. type: deftp
30364 #: guix-git/doc/guix.texi:17332
30365 #, no-wrap
30366 msgid "{Data Type} avahi-configuration"
30367 msgstr ""
30368
30369 #. type: deftp
30370 #: guix-git/doc/guix.texi:17334
30371 msgid "Data type representation the configuration for Avahi."
30372 msgstr ""
30373
30374 #. type: item
30375 #: guix-git/doc/guix.texi:17337
30376 #, no-wrap
30377 msgid "@code{host-name} (default: @code{#f})"
30378 msgstr ""
30379
30380 #. type: table
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."
30383 msgstr ""
30384
30385 #. type: item
30386 #: guix-git/doc/guix.texi:17341
30387 #, no-wrap
30388 msgid "@code{publish?} (default: @code{#t})"
30389 msgstr ""
30390
30391 #. type: table
30392 #: guix-git/doc/guix.texi:17344
30393 msgid "When true, allow host names and services to be published (broadcast) over the network."
30394 msgstr ""
30395
30396 #. type: item
30397 #: guix-git/doc/guix.texi:17345
30398 #, no-wrap
30399 msgid "@code{publish-workstation?} (default: @code{#t})"
30400 msgstr ""
30401
30402 #. type: table
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:"
30405 msgstr ""
30406
30407 #. type: example
30408 #: guix-git/doc/guix.texi:17352
30409 #, no-wrap
30410 msgid "avahi-browse _workstation._tcp\n"
30411 msgstr ""
30412
30413 #. type: item
30414 #: guix-git/doc/guix.texi:17354
30415 #, no-wrap
30416 msgid "@code{wide-area?} (default: @code{#f})"
30417 msgstr ""
30418
30419 #. type: table
30420 #: guix-git/doc/guix.texi:17356
30421 msgid "When true, DNS-SD over unicast DNS is enabled."
30422 msgstr ""
30423
30424 #. type: item
30425 #: guix-git/doc/guix.texi:17357
30426 #, no-wrap
30427 msgid "@code{ipv4?} (default: @code{#t})"
30428 msgstr ""
30429
30430 #. type: itemx
30431 #: guix-git/doc/guix.texi:17358
30432 #, no-wrap
30433 msgid "@code{ipv6?} (default: @code{#t})"
30434 msgstr ""
30435
30436 #. type: table
30437 #: guix-git/doc/guix.texi:17360
30438 msgid "These fields determine whether to use IPv4/IPv6 sockets."
30439 msgstr ""
30440
30441 #. type: item
30442 #: guix-git/doc/guix.texi:17361
30443 #, no-wrap
30444 msgid "@code{domains-to-browse} (default: @code{'()})"
30445 msgstr ""
30446
30447 #. type: table
30448 #: guix-git/doc/guix.texi:17363
30449 msgid "This is a list of domains to browse."
30450 msgstr ""
30451
30452 #. type: deffn
30453 #: guix-git/doc/guix.texi:17366
30454 #, no-wrap
30455 msgid "{Scheme Variable} openvswitch-service-type"
30456 msgstr ""
30457
30458 #. type: deffn
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."
30461 msgstr ""
30462
30463 #. type: deftp
30464 #: guix-git/doc/guix.texi:17372
30465 #, no-wrap
30466 msgid "{Data Type} openvswitch-configuration"
30467 msgstr ""
30468
30469 #. type: deftp
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."
30472 msgstr ""
30473
30474 #. type: item
30475 #: guix-git/doc/guix.texi:17378
30476 #, no-wrap
30477 msgid "@code{package} (default: @var{openvswitch})"
30478 msgstr ""
30479
30480 #. type: table
30481 #: guix-git/doc/guix.texi:17380
30482 msgid "Package object of the Open vSwitch."
30483 msgstr ""
30484
30485 #. type: defvr
30486 #: guix-git/doc/guix.texi:17384
30487 #, no-wrap
30488 msgid "{Scheme Variable} pagekite-service-type"
30489 msgstr ""
30490
30491 #. type: defvr
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."
30494 msgstr ""
30495
30496 #. type: defvr
30497 #: guix-git/doc/guix.texi:17391
30498 msgid "Here's an example exposing the local HTTP and SSH daemons:"
30499 msgstr ""
30500
30501 #. type: lisp
30502 #: guix-git/doc/guix.texi:17398
30503 #, no-wrap
30504 msgid ""
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"
30510 msgstr ""
30511
30512 #. type: deftp
30513 #: guix-git/doc/guix.texi:17401
30514 #, no-wrap
30515 msgid "{Data Type} pagekite-configuration"
30516 msgstr ""
30517
30518 #. type: deftp
30519 #: guix-git/doc/guix.texi:17403
30520 msgid "Data type representing the configuration of PageKite."
30521 msgstr ""
30522
30523 #. type: item
30524 #: guix-git/doc/guix.texi:17405
30525 #, no-wrap
30526 msgid "@code{package} (default: @var{pagekite})"
30527 msgstr ""
30528
30529 #. type: table
30530 #: guix-git/doc/guix.texi:17407
30531 msgid "Package object of PageKite."
30532 msgstr ""
30533
30534 #. type: item
30535 #: guix-git/doc/guix.texi:17408
30536 #, no-wrap
30537 msgid "@code{kitename} (default: @code{#f})"
30538 msgstr ""
30539
30540 #. type: table
30541 #: guix-git/doc/guix.texi:17410
30542 msgid "PageKite name for authenticating to the frontend server."
30543 msgstr ""
30544
30545 #. type: item
30546 #: guix-git/doc/guix.texi:17411
30547 #, no-wrap
30548 msgid "@code{kitesecret} (default: @code{#f})"
30549 msgstr ""
30550
30551 #. type: table
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."
30554 msgstr ""
30555
30556 #. type: item
30557 #: guix-git/doc/guix.texi:17415
30558 #, no-wrap
30559 msgid "@code{frontend} (default: @code{#f})"
30560 msgstr ""
30561
30562 #. type: table
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."
30565 msgstr ""
30566
30567 #. type: item
30568 #: guix-git/doc/guix.texi:17419
30569 #, no-wrap
30570 msgid "@code{kites} (default: @code{'(\"http:@@kitename:localhost:80:@@kitesecret\")})"
30571 msgstr ""
30572
30573 #. type: table
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}."
30576 msgstr ""
30577
30578 #. type: item
30579 #: guix-git/doc/guix.texi:17423
30580 #, no-wrap
30581 msgid "@code{extra-file} (default: @code{#f})"
30582 msgstr ""
30583
30584 #. type: table
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."
30587 msgstr ""
30588
30589 #. type: defvr
30590 #: guix-git/doc/guix.texi:17430
30591 #, no-wrap
30592 msgid "{Scheme Variable} yggdrasil-service-type"
30593 msgstr ""
30594
30595 #. type: defvr
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."
30598 msgstr ""
30599
30600 #. type: quotation
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}"
30603 msgstr ""
30604
30605 #. type: defvr
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."
30608 msgstr ""
30609
30610 #. type: defvr
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})."
30613 msgstr ""
30614
30615 #. type: lisp
30616 #: guix-git/doc/guix.texi:17461
30617 #, no-wrap
30618 msgid ""
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"
30623 " (json-config\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"
30628 " ))\n"
30629 msgstr ""
30630
30631 #. type: example
30632 #: guix-git/doc/guix.texi:17468
30633 #, no-wrap
30634 msgid ""
30635 "# sample content for /etc/yggdrasil-private.conf\n"
30636 "@{\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"
30640 "\n"
30641 msgstr ""
30642
30643 #. type: example
30644 #: guix-git/doc/guix.texi:17471
30645 #, no-wrap
30646 msgid ""
30647 " # Your private encryption key. DO NOT share this with anyone!\n"
30648 " EncryptionPrivateKey: 0777...\n"
30649 "\n"
30650 msgstr ""
30651
30652 #. type: example
30653 #: guix-git/doc/guix.texi:17475
30654 #, no-wrap
30655 msgid ""
30656 " # Your public signing key. You should not ordinarily need to share\n"
30657 " # this with anyone.\n"
30658 " SigningPublicKey: e1664...\n"
30659 "\n"
30660 msgstr ""
30661
30662 #. type: example
30663 #: guix-git/doc/guix.texi:17479
30664 #, no-wrap
30665 msgid ""
30666 " # Your private signing key. DO NOT share this with anyone!\n"
30667 " SigningPrivateKey: 0589d...\n"
30668 "@}\n"
30669 msgstr ""
30670
30671 #. type: deftp
30672 #: guix-git/doc/guix.texi:17482
30673 #, no-wrap
30674 msgid "{Data Type} yggdrasil-configuration"
30675 msgstr ""
30676
30677 #. type: deftp
30678 #: guix-git/doc/guix.texi:17484
30679 msgid "Data type representing the configuration of Yggdrasil."
30680 msgstr ""
30681
30682 #. type: item
30683 #: guix-git/doc/guix.texi:17486
30684 #, no-wrap
30685 msgid "@code{package} (default: @code{yggdrasil})"
30686 msgstr ""
30687
30688 #. type: table
30689 #: guix-git/doc/guix.texi:17488
30690 msgid "Package object of Yggdrasil."
30691 msgstr ""
30692
30693 #. type: item
30694 #: guix-git/doc/guix.texi:17489
30695 #, no-wrap
30696 msgid "@code{json-config} (default: @code{'()})"
30697 msgstr ""
30698
30699 #. type: table
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."
30702 msgstr ""
30703
30704 #. type: item
30705 #: guix-git/doc/guix.texi:17496
30706 #, no-wrap
30707 msgid "@code{autoconf?} (default: @code{#f})"
30708 msgstr ""
30709
30710 #. type: table
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."
30713 msgstr ""
30714
30715 #. type: table
30716 #: guix-git/doc/guix.texi:17502
30717 msgid "How much detail to include in logs. Use @code{'debug} for more detail."
30718 msgstr ""
30719
30720 #. type: item
30721 #: guix-git/doc/guix.texi:17503
30722 #, no-wrap
30723 msgid "@code{log-to} (default: @code{'stdout})"
30724 msgstr ""
30725
30726 #. type: table
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."
30729 msgstr ""
30730
30731 #. type: item
30732 #: guix-git/doc/guix.texi:17508
30733 #, no-wrap
30734 msgid "@code{config-file} (default: @code{\"/etc/yggdrasil-private.conf\"})"
30735 msgstr ""
30736
30737 #. type: table
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:"
30740 msgstr ""
30741
30742 #. type: code{#1}
30743 #: guix-git/doc/guix.texi:17517
30744 #, no-wrap
30745 msgid "EncryptionPublicKey"
30746 msgstr ""
30747
30748 #. type: code{#1}
30749 #: guix-git/doc/guix.texi:17518
30750 #, no-wrap
30751 msgid "EncryptionPrivateKey"
30752 msgstr ""
30753
30754 #. type: code{#1}
30755 #: guix-git/doc/guix.texi:17519
30756 #, no-wrap
30757 msgid "SigningPublicKey"
30758 msgstr ""
30759
30760 #. type: code{#1}
30761 #: guix-git/doc/guix.texi:17520
30762 #, no-wrap
30763 msgid "SigningPrivateKey"
30764 msgstr ""
30765
30766 #. type: cindex
30767 #: guix-git/doc/guix.texi:17525
30768 #, no-wrap
30769 msgid "IPFS"
30770 msgstr ""
30771
30772 #. type: defvr
30773 #: guix-git/doc/guix.texi:17526
30774 #, no-wrap
30775 msgid "{Scheme Variable} ipfs-service-type"
30776 msgstr ""
30777
30778 #. type: defvr
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."
30781 msgstr ""
30782
30783 #. type: defvr
30784 #: guix-git/doc/guix.texi:17532
30785 msgid "Here's an example configuration, using some non-standard ports:"
30786 msgstr ""
30787
30788 #. type: lisp
30789 #: guix-git/doc/guix.texi:17538
30790 #, no-wrap
30791 msgid ""
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"
30796 msgstr ""
30797
30798 #. type: deftp
30799 #: guix-git/doc/guix.texi:17541
30800 #, no-wrap
30801 msgid "{Data Type} ipfs-configuration"
30802 msgstr ""
30803
30804 #. type: deftp
30805 #: guix-git/doc/guix.texi:17543
30806 msgid "Data type representing the configuration of IPFS."
30807 msgstr ""
30808
30809 #. type: item
30810 #: guix-git/doc/guix.texi:17545
30811 #, no-wrap
30812 msgid "@code{package} (default: @code{go-ipfs})"
30813 msgstr ""
30814
30815 #. type: table
30816 #: guix-git/doc/guix.texi:17547
30817 msgid "Package object of IPFS."
30818 msgstr ""
30819
30820 #. type: item
30821 #: guix-git/doc/guix.texi:17548
30822 #, no-wrap
30823 msgid "@code{gateway} (default: @code{\"/ip4/127.0.0.1/tcp/8082\"})"
30824 msgstr ""
30825
30826 #. type: table
30827 #: guix-git/doc/guix.texi:17550
30828 msgid "Address of the gateway, in ‘multiaddress’ format."
30829 msgstr ""
30830
30831 #. type: item
30832 #: guix-git/doc/guix.texi:17551
30833 #, no-wrap
30834 msgid "@code{api} (default: @code{\"/ip4/127.0.0.1/tcp/5001\"})"
30835 msgstr ""
30836
30837 #. type: table
30838 #: guix-git/doc/guix.texi:17553
30839 msgid "Address of the API endpoint, in ‘multiaddress’ format."
30840 msgstr ""
30841
30842 #. type: cindex
30843 #: guix-git/doc/guix.texi:17556
30844 #, no-wrap
30845 msgid "keepalived"
30846 msgstr ""
30847
30848 #. type: deffn
30849 #: guix-git/doc/guix.texi:17557
30850 #, no-wrap
30851 msgid "{Scheme Variable} keepalived-service-type"
30852 msgstr ""
30853
30854 #. type: deffn
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:"
30857 msgstr ""
30858
30859 #. type: lisp
30860 #: guix-git/doc/guix.texi:17567
30861 #, no-wrap
30862 msgid ""
30863 "(service keepalived-service-type\n"
30864 " (keepalived-configuration\n"
30865 " (config-file (local-file \"keepalived-master.conf\"))))\n"
30866 msgstr ""
30867
30868 #. type: deffn
30869 #: guix-git/doc/guix.texi:17570
30870 msgid "where @file{keepalived-master.conf}:"
30871 msgstr ""
30872
30873 #. type: example
30874 #: guix-git/doc/guix.texi:17582
30875 #, no-wrap
30876 msgid ""
30877 "vrrp_instance my-group @{\n"
30878 " state MASTER\n"
30879 " interface enp9s0\n"
30880 " virtual_router_id 100\n"
30881 " priority 100\n"
30882 " unicast_peer @{ 10.0.0.2 @}\n"
30883 " virtual_ipaddress @{\n"
30884 " 10.0.0.4/24\n"
30885 " @}\n"
30886 "@}\n"
30887 msgstr ""
30888
30889 #. type: deffn
30890 #: guix-git/doc/guix.texi:17585
30891 msgid "and for backup machine:"
30892 msgstr ""
30893
30894 #. type: lisp
30895 #: guix-git/doc/guix.texi:17590
30896 #, no-wrap
30897 msgid ""
30898 "(service keepalived-service-type\n"
30899 " (keepalived-configuration\n"
30900 " (config-file (local-file \"keepalived-backup.conf\"))))\n"
30901 msgstr ""
30902
30903 #. type: deffn
30904 #: guix-git/doc/guix.texi:17593
30905 msgid "where @file{keepalived-backup.conf}:"
30906 msgstr ""
30907
30908 #. type: example
30909 #: guix-git/doc/guix.texi:17605
30910 #, no-wrap
30911 msgid ""
30912 "vrrp_instance my-group @{\n"
30913 " state BACKUP\n"
30914 " interface enp9s0\n"
30915 " virtual_router_id 100\n"
30916 " priority 99\n"
30917 " unicast_peer @{ 10.0.0.3 @}\n"
30918 " virtual_ipaddress @{\n"
30919 " 10.0.0.4/24\n"
30920 " @}\n"
30921 "@}\n"
30922 msgstr ""
30923
30924 #. type: cindex
30925 #: guix-git/doc/guix.texi:17611
30926 #, no-wrap
30927 msgid "unattended upgrades"
30928 msgstr ""
30929
30930 #. type: cindex
30931 #: guix-git/doc/guix.texi:17612
30932 #, no-wrap
30933 msgid "upgrades, unattended"
30934 msgstr ""
30935
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:"
30939 msgstr ""
30940
30941 #. type: itemize
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);"
30944 msgstr ""
30945
30946 #. type: itemize
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;"
30949 msgstr ""
30950
30951 #. type: itemize
30952 #: guix-git/doc/guix.texi:17629
30953 msgid "channel code is authenticated so you know you can only run genuine code (@pxref{Channels});"
30954 msgstr ""
30955
30956 #. type: itemize
30957 #: guix-git/doc/guix.texi:17632
30958 msgid "@command{guix system reconfigure} prevents downgrades, which makes it immune to @dfn{downgrade attacks}."
30959 msgstr ""
30960
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:"
30964 msgstr ""
30965
30966 #. type: lisp
30967 #: guix-git/doc/guix.texi:17640
30968 #, no-wrap
30969 msgid "(service unattended-upgrade-service-type)\n"
30970 msgstr ""
30971
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."
30975 msgstr ""
30976
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."
30980 msgstr ""
30981
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)."
30985 msgstr ""
30986
30987 #. type: defvr
30988 #: guix-git/doc/guix.texi:17658
30989 #, no-wrap
30990 msgid "{Scheme Variable} unattended-upgrade-service-type"
30991 msgstr ""
30992
30993 #. type: defvr
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."
30996 msgstr ""
30997
30998 #. type: defvr
30999 #: guix-git/doc/guix.texi:17665
31000 msgid "Its value must be a @code{unattended-upgrade-configuration} record (see below)."
31001 msgstr ""
31002
31003 #. type: deftp
31004 #: guix-git/doc/guix.texi:17667
31005 #, no-wrap
31006 msgid "{Data Type} unattended-upgrade-configuration"
31007 msgstr ""
31008
31009 #. type: deftp
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:"
31012 msgstr ""
31013
31014 #. type: item
31015 #: guix-git/doc/guix.texi:17672
31016 #, no-wrap
31017 msgid "@code{schedule} (default: @code{\"30 01 * * 0\"})"
31018 msgstr ""
31019
31020 #. type: table
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})."
31023 msgstr ""
31024
31025 #. type: item
31026 #: guix-git/doc/guix.texi:17677
31027 #, no-wrap
31028 msgid "@code{channels} (default: @code{#~%default-channels})"
31029 msgstr ""
31030
31031 #. type: table
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."
31034 msgstr ""
31035
31036 #. type: item
31037 #: guix-git/doc/guix.texi:17682
31038 #, no-wrap
31039 msgid "@code{operating-system-file} (default: @code{\"/run/current-system/configuration.scm\"})"
31040 msgstr ""
31041
31042 #. type: table
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."
31045 msgstr ""
31046
31047 #. type: table
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:"
31050 msgstr ""
31051
31052 #. type: lisp
31053 #: guix-git/doc/guix.texi:17697
31054 #, no-wrap
31055 msgid ""
31056 "(unattended-upgrade-configuration\n"
31057 " (operating-system-file\n"
31058 " (file-append (local-file \".\" \"config-dir\" #:recursive? #t)\n"
31059 " \"/config.scm\")))\n"
31060 msgstr ""
31061
31062 #. type: table
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}."
31065 msgstr ""
31066
31067 #. type: item
31068 #: guix-git/doc/guix.texi:17705
31069 #, no-wrap
31070 msgid "@code{services-to-restart} (default: @code{'(mcron)})"
31071 msgstr ""
31072
31073 #. type: table
31074 #: guix-git/doc/guix.texi:17708
31075 msgid "This field specifies the Shepherd services to restart when the upgrade completes."
31076 msgstr ""
31077
31078 #. type: table
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."
31081 msgstr ""
31082
31083 #. type: table
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}."
31086 msgstr ""
31087
31088 #. type: table
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."
31091 msgstr ""
31092
31093 #. type: item
31094 #: guix-git/doc/guix.texi:17723
31095 #, no-wrap
31096 msgid "@code{system-expiration} (default: @code{(* 3 30 24 3600)})"
31097 msgstr ""
31098
31099 #. type: table
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."
31102 msgstr ""
31103
31104 #. type: quotation
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."
31107 msgstr ""
31108
31109 #. type: item
31110 #: guix-git/doc/guix.texi:17734
31111 #, no-wrap
31112 msgid "@code{maximum-duration} (default: @code{3600})"
31113 msgstr ""
31114
31115 #. type: table
31116 #: guix-git/doc/guix.texi:17737
31117 msgid "Maximum duration in seconds for the upgrade; past that time, the upgrade aborts."
31118 msgstr ""
31119
31120 #. type: table
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''."
31123 msgstr ""
31124
31125 #. type: item
31126 #: guix-git/doc/guix.texi:17741
31127 #, no-wrap
31128 msgid "@code{log-file} (default: @code{\"/var/log/unattended-upgrade.log\"})"
31129 msgstr ""
31130
31131 #. type: table
31132 #: guix-git/doc/guix.texi:17743
31133 msgid "File where unattended upgrades are logged."
31134 msgstr ""
31135
31136 #. type: cindex
31137 #: guix-git/doc/guix.texi:17749
31138 #, no-wrap
31139 msgid "X11"
31140 msgstr ""
31141
31142 #. type: cindex
31143 #: guix-git/doc/guix.texi:17750
31144 #, no-wrap
31145 msgid "X Window System"
31146 msgstr ""
31147
31148 #. type: cindex
31149 #: guix-git/doc/guix.texi:17751 guix-git/doc/guix.texi:18003
31150 #, no-wrap
31151 msgid "login manager"
31152 msgstr ""
31153
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)."
31157 msgstr ""
31158
31159 #. type: cindex
31160 #: guix-git/doc/guix.texi:17757
31161 #, no-wrap
31162 msgid "GDM"
31163 msgstr ""
31164
31165 #. type: cindex
31166 #: guix-git/doc/guix.texi:17758
31167 #, no-wrap
31168 msgid "GNOME, login manager"
31169 msgstr ""
31170
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."
31174 msgstr ""
31175
31176 #. type: cindex
31177 #: guix-git/doc/guix.texi:17763
31178 #, no-wrap
31179 msgid "window manager"
31180 msgstr ""
31181
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})."
31185 msgstr ""
31186
31187 #. type: defvr
31188 #: guix-git/doc/guix.texi:17769
31189 #, no-wrap
31190 msgid "{Scheme Variable} gdm-service-type"
31191 msgstr ""
31192
31193 #. type: defvr
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)."
31196 msgstr ""
31197
31198 #. type: cindex
31199 #: guix-git/doc/guix.texi:17775
31200 #, no-wrap
31201 msgid "session types (X11)"
31202 msgstr ""
31203
31204 #. type: cindex
31205 #: guix-git/doc/guix.texi:17776
31206 #, no-wrap
31207 msgid "X11 session types"
31208 msgstr ""
31209
31210 #. type: defvr
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."
31213 msgstr ""
31214
31215 #. type: defvr
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."
31218 msgstr ""
31219
31220 #. type: deftp
31221 #: guix-git/doc/guix.texi:17788
31222 #, no-wrap
31223 msgid "{Data Type} gdm-configuration"
31224 msgstr ""
31225
31226 #. type: item
31227 #: guix-git/doc/guix.texi:17790 guix-git/doc/guix.texi:17858
31228 #, no-wrap
31229 msgid "@code{auto-login?} (default: @code{#f})"
31230 msgstr ""
31231
31232 #. type: itemx
31233 #: guix-git/doc/guix.texi:17791
31234 #, no-wrap
31235 msgid "@code{default-user} (default: @code{#f})"
31236 msgstr ""
31237
31238 #. type: table
31239 #: guix-git/doc/guix.texi:17793
31240 msgid "When @code{auto-login?} is false, GDM presents a log-in screen."
31241 msgstr ""
31242
31243 #. type: table
31244 #: guix-git/doc/guix.texi:17796
31245 msgid "When @code{auto-login?} is true, GDM logs in directly as @code{default-user}."
31246 msgstr ""
31247
31248 #. type: item
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
31255 #, no-wrap
31256 msgid "@code{debug?} (default: @code{#f})"
31257 msgstr ""
31258
31259 #. type: table
31260 #: guix-git/doc/guix.texi:17799
31261 msgid "When true, GDM writes debug messages to its log."
31262 msgstr ""
31263
31264 #. type: item
31265 #: guix-git/doc/guix.texi:17800
31266 #, no-wrap
31267 msgid "@code{gnome-shell-assets} (default: ...)"
31268 msgstr ""
31269
31270 #. type: table
31271 #: guix-git/doc/guix.texi:17802
31272 msgid "List of GNOME Shell assets needed by GDM: icon theme, fonts, etc."
31273 msgstr ""
31274
31275 #. type: item
31276 #: guix-git/doc/guix.texi:17803
31277 #, no-wrap
31278 msgid "@code{xorg-configuration} (default: @code{(xorg-configuration)})"
31279 msgstr ""
31280
31281 #. type: table
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."
31285 msgstr ""
31286
31287 #. type: item
31288 #: guix-git/doc/guix.texi:17806
31289 #, no-wrap
31290 msgid "@code{xsession} (default: @code{(xinitrc)})"
31291 msgstr ""
31292
31293 #. type: table
31294 #: guix-git/doc/guix.texi:17808 guix-git/doc/guix.texi:17984
31295 msgid "Script to run before starting a X session."
31296 msgstr ""
31297
31298 #. type: item
31299 #: guix-git/doc/guix.texi:17809
31300 #, no-wrap
31301 msgid "@code{dbus-daemon} (default: @code{dbus-daemon-wrapper})"
31302 msgstr ""
31303
31304 #. type: table
31305 #: guix-git/doc/guix.texi:17811
31306 msgid "File name of the @code{dbus-daemon} executable."
31307 msgstr ""
31308
31309 #. type: item
31310 #: guix-git/doc/guix.texi:17812
31311 #, no-wrap
31312 msgid "@code{gdm} (default: @code{gdm})"
31313 msgstr ""
31314
31315 #. type: table
31316 #: guix-git/doc/guix.texi:17814
31317 msgid "The GDM package to use."
31318 msgstr ""
31319
31320 #. type: defvr
31321 #: guix-git/doc/guix.texi:17817
31322 #, no-wrap
31323 msgid "{Scheme Variable} slim-service-type"
31324 msgstr ""
31325
31326 #. type: defvr
31327 #: guix-git/doc/guix.texi:17819
31328 msgid "This is the type for the SLiM graphical login manager for X11."
31329 msgstr ""
31330
31331 #. type: defvr
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."
31334 msgstr ""
31335
31336 #. type: defvr
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."
31339 msgstr ""
31340
31341 #. type: lisp
31342 #: guix-git/doc/guix.texi:17836
31343 #, no-wrap
31344 msgid ""
31345 "(use-modules (gnu services)\n"
31346 " (gnu services desktop)\n"
31347 " (gnu services xorg)\n"
31348 " (srfi srfi-1)) ;for 'remove'\n"
31349 "\n"
31350 msgstr ""
31351
31352 #. type: lisp
31353 #: guix-git/doc/guix.texi:17847
31354 #, no-wrap
31355 msgid ""
31356 "(operating-system\n"
31357 " ;; ...\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"
31366 msgstr ""
31367
31368 #. type: deftp
31369 #: guix-git/doc/guix.texi:17851
31370 #, no-wrap
31371 msgid "{Data Type} slim-configuration"
31372 msgstr ""
31373
31374 #. type: deftp
31375 #: guix-git/doc/guix.texi:17853
31376 msgid "Data type representing the configuration of @code{slim-service-type}."
31377 msgstr ""
31378
31379 #. type: table
31380 #: guix-git/doc/guix.texi:17857
31381 msgid "Whether to allow logins with empty passwords."
31382 msgstr ""
31383
31384 #. type: itemx
31385 #: guix-git/doc/guix.texi:17859
31386 #, no-wrap
31387 msgid "@code{default-user} (default: @code{\"\"})"
31388 msgstr ""
31389
31390 #. type: table
31391 #: guix-git/doc/guix.texi:17861
31392 msgid "When @code{auto-login?} is false, SLiM presents a log-in screen."
31393 msgstr ""
31394
31395 #. type: table
31396 #: guix-git/doc/guix.texi:17864
31397 msgid "When @code{auto-login?} is true, SLiM logs in directly as @code{default-user}."
31398 msgstr ""
31399
31400 #. type: item
31401 #: guix-git/doc/guix.texi:17865
31402 #, no-wrap
31403 msgid "@code{theme} (default: @code{%default-slim-theme})"
31404 msgstr ""
31405
31406 #. type: itemx
31407 #: guix-git/doc/guix.texi:17866
31408 #, no-wrap
31409 msgid "@code{theme-name} (default: @code{%default-slim-theme-name})"
31410 msgstr ""
31411
31412 #. type: table
31413 #: guix-git/doc/guix.texi:17868
31414 msgid "The graphical theme to use and its name."
31415 msgstr ""
31416
31417 #. type: item
31418 #: guix-git/doc/guix.texi:17869
31419 #, no-wrap
31420 msgid "@code{auto-login-session} (default: @code{#f})"
31421 msgstr ""
31422
31423 #. type: table
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\")}."
31426 msgstr ""
31427
31428 #. type: table
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."
31431 msgstr ""
31432
31433 #. type: quotation
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."
31436 msgstr ""
31437
31438 #. type: item
31439 #: guix-git/doc/guix.texi:17883 guix-git/doc/guix.texi:17967
31440 #, no-wrap
31441 msgid "@code{xorg-configuration} (default @code{(xorg-configuration)})"
31442 msgstr ""
31443
31444 #. type: item
31445 #: guix-git/doc/guix.texi:17886
31446 #, no-wrap
31447 msgid "@code{display} (default @code{\":0\"})"
31448 msgstr ""
31449
31450 #. type: table
31451 #: guix-git/doc/guix.texi:17888
31452 msgid "The display on which to start the Xorg graphical server."
31453 msgstr ""
31454
31455 #. type: item
31456 #: guix-git/doc/guix.texi:17889
31457 #, no-wrap
31458 msgid "@code{vt} (default @code{\"vt7\"})"
31459 msgstr ""
31460
31461 #. type: table
31462 #: guix-git/doc/guix.texi:17891
31463 msgid "The VT on which to start the Xorg graphical server."
31464 msgstr ""
31465
31466 #. type: item
31467 #: guix-git/doc/guix.texi:17892
31468 #, no-wrap
31469 msgid "@code{xauth} (default: @code{xauth})"
31470 msgstr ""
31471
31472 #. type: table
31473 #: guix-git/doc/guix.texi:17894
31474 msgid "The XAuth package to use."
31475 msgstr ""
31476
31477 #. type: item
31478 #: guix-git/doc/guix.texi:17895
31479 #, no-wrap
31480 msgid "@code{shepherd} (default: @code{shepherd})"
31481 msgstr ""
31482
31483 #. type: table
31484 #: guix-git/doc/guix.texi:17898
31485 msgid "The Shepherd package used when invoking @command{halt} and @command{reboot}."
31486 msgstr ""
31487
31488 #. type: item
31489 #: guix-git/doc/guix.texi:17899
31490 #, no-wrap
31491 msgid "@code{sessreg} (default: @code{sessreg})"
31492 msgstr ""
31493
31494 #. type: table
31495 #: guix-git/doc/guix.texi:17901
31496 msgid "The sessreg package used in order to register the session."
31497 msgstr ""
31498
31499 #. type: item
31500 #: guix-git/doc/guix.texi:17902
31501 #, no-wrap
31502 msgid "@code{slim} (default: @code{slim})"
31503 msgstr ""
31504
31505 #. type: table
31506 #: guix-git/doc/guix.texi:17904
31507 msgid "The SLiM package to use."
31508 msgstr ""
31509
31510 #. type: defvr
31511 #: guix-git/doc/guix.texi:17907
31512 #, no-wrap
31513 msgid "{Scheme Variable} %default-theme"
31514 msgstr ""
31515
31516 #. type: defvrx
31517 #: guix-git/doc/guix.texi:17908
31518 #, no-wrap
31519 msgid "{Scheme Variable} %default-theme-name"
31520 msgstr ""
31521
31522 #. type: defvr
31523 #: guix-git/doc/guix.texi:17910
31524 msgid "The default SLiM theme and its name."
31525 msgstr ""
31526
31527 #. type: deftp
31528 #: guix-git/doc/guix.texi:17913 guix-git/doc/guix.texi:18020
31529 #, no-wrap
31530 msgid "{Data Type} sddm-configuration"
31531 msgstr ""
31532
31533 #. type: deftp
31534 #: guix-git/doc/guix.texi:17915
31535 msgid "This is the data type representing the SDDM service configuration."
31536 msgstr ""
31537
31538 #. type: item
31539 #: guix-git/doc/guix.texi:17917
31540 #, no-wrap
31541 msgid "@code{display-server} (default: \"x11\")"
31542 msgstr ""
31543
31544 #. type: table
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\"}."
31547 msgstr ""
31548
31549 #. type: item
31550 #: guix-git/doc/guix.texi:17921
31551 #, no-wrap
31552 msgid "@code{numlock} (default: \"on\")"
31553 msgstr ""
31554
31555 #. type: table
31556 #: guix-git/doc/guix.texi:17923
31557 msgid "Valid values are @samp{\"on\"}, @samp{\"off\"} or @samp{\"none\"}."
31558 msgstr ""
31559
31560 #. type: item
31561 #: guix-git/doc/guix.texi:17924
31562 #, no-wrap
31563 msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})"
31564 msgstr ""
31565
31566 #. type: table
31567 #: guix-git/doc/guix.texi:17926
31568 msgid "Command to run when halting."
31569 msgstr ""
31570
31571 #. type: item
31572 #: guix-git/doc/guix.texi:17927
31573 #, no-wrap
31574 msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})"
31575 msgstr ""
31576
31577 #. type: table
31578 #: guix-git/doc/guix.texi:17929
31579 msgid "Command to run when rebooting."
31580 msgstr ""
31581
31582 #. type: item
31583 #: guix-git/doc/guix.texi:17930
31584 #, no-wrap
31585 msgid "@code{theme} (default \"maldives\")"
31586 msgstr ""
31587
31588 #. type: table
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\"}."
31591 msgstr ""
31592
31593 #. type: item
31594 #: guix-git/doc/guix.texi:17934
31595 #, no-wrap
31596 msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")"
31597 msgstr ""
31598
31599 #. type: table
31600 #: guix-git/doc/guix.texi:17936
31601 msgid "Directory to look for themes."
31602 msgstr ""
31603
31604 #. type: item
31605 #: guix-git/doc/guix.texi:17937
31606 #, no-wrap
31607 msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")"
31608 msgstr ""
31609
31610 #. type: table
31611 #: guix-git/doc/guix.texi:17939
31612 msgid "Directory to look for faces."
31613 msgstr ""
31614
31615 #. type: item
31616 #: guix-git/doc/guix.texi:17940
31617 #, no-wrap
31618 msgid "@code{default-path} (default \"/run/current-system/profile/bin\")"
31619 msgstr ""
31620
31621 #. type: table
31622 #: guix-git/doc/guix.texi:17942
31623 msgid "Default PATH to use."
31624 msgstr ""
31625
31626 #. type: item
31627 #: guix-git/doc/guix.texi:17943
31628 #, no-wrap
31629 msgid "@code{minimum-uid} (default: 1000)"
31630 msgstr ""
31631
31632 #. type: table
31633 #: guix-git/doc/guix.texi:17945
31634 msgid "Minimum UID displayed in SDDM and allowed for log-in."
31635 msgstr ""
31636
31637 #. type: item
31638 #: guix-git/doc/guix.texi:17946
31639 #, no-wrap
31640 msgid "@code{maximum-uid} (default: 2000)"
31641 msgstr ""
31642
31643 #. type: table
31644 #: guix-git/doc/guix.texi:17948
31645 msgid "Maximum UID to display in SDDM."
31646 msgstr ""
31647
31648 #. type: item
31649 #: guix-git/doc/guix.texi:17949
31650 #, no-wrap
31651 msgid "@code{remember-last-user?} (default #t)"
31652 msgstr ""
31653
31654 #. type: table
31655 #: guix-git/doc/guix.texi:17951
31656 msgid "Remember last user."
31657 msgstr ""
31658
31659 #. type: item
31660 #: guix-git/doc/guix.texi:17952
31661 #, no-wrap
31662 msgid "@code{remember-last-session?} (default #t)"
31663 msgstr ""
31664
31665 #. type: table
31666 #: guix-git/doc/guix.texi:17954
31667 msgid "Remember last session."
31668 msgstr ""
31669
31670 #. type: item
31671 #: guix-git/doc/guix.texi:17955
31672 #, no-wrap
31673 msgid "@code{hide-users} (default \"\")"
31674 msgstr ""
31675
31676 #. type: table
31677 #: guix-git/doc/guix.texi:17957
31678 msgid "Usernames to hide from SDDM greeter."
31679 msgstr ""
31680
31681 #. type: item
31682 #: guix-git/doc/guix.texi:17958
31683 #, no-wrap
31684 msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})"
31685 msgstr ""
31686
31687 #. type: table
31688 #: guix-git/doc/guix.texi:17960
31689 msgid "Users with shells listed will be hidden from the SDDM greeter."
31690 msgstr ""
31691
31692 #. type: item
31693 #: guix-git/doc/guix.texi:17961
31694 #, no-wrap
31695 msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})"
31696 msgstr ""
31697
31698 #. type: table
31699 #: guix-git/doc/guix.texi:17963
31700 msgid "Script to run before starting a wayland session."
31701 msgstr ""
31702
31703 #. type: item
31704 #: guix-git/doc/guix.texi:17964
31705 #, no-wrap
31706 msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")"
31707 msgstr ""
31708
31709 #. type: table
31710 #: guix-git/doc/guix.texi:17966
31711 msgid "Directory to look for desktop files starting wayland sessions."
31712 msgstr ""
31713
31714 #. type: item
31715 #: guix-git/doc/guix.texi:17970
31716 #, no-wrap
31717 msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})"
31718 msgstr ""
31719
31720 #. type: table
31721 #: guix-git/doc/guix.texi:17972
31722 msgid "Path to xauth."
31723 msgstr ""
31724
31725 #. type: item
31726 #: guix-git/doc/guix.texi:17973
31727 #, no-wrap
31728 msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})"
31729 msgstr ""
31730
31731 #. type: table
31732 #: guix-git/doc/guix.texi:17975
31733 msgid "Path to Xephyr."
31734 msgstr ""
31735
31736 #. type: item
31737 #: guix-git/doc/guix.texi:17976
31738 #, no-wrap
31739 msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})"
31740 msgstr ""
31741
31742 #. type: table
31743 #: guix-git/doc/guix.texi:17978
31744 msgid "Script to run after starting xorg-server."
31745 msgstr ""
31746
31747 #. type: item
31748 #: guix-git/doc/guix.texi:17979
31749 #, no-wrap
31750 msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})"
31751 msgstr ""
31752
31753 #. type: table
31754 #: guix-git/doc/guix.texi:17981
31755 msgid "Script to run before stopping xorg-server."
31756 msgstr ""
31757
31758 #. type: item
31759 #: guix-git/doc/guix.texi:17982
31760 #, no-wrap
31761 msgid "@code{xsession-command} (default: @code{xinitrc})"
31762 msgstr ""
31763
31764 #. type: item
31765 #: guix-git/doc/guix.texi:17985
31766 #, no-wrap
31767 msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")"
31768 msgstr ""
31769
31770 #. type: table
31771 #: guix-git/doc/guix.texi:17987
31772 msgid "Directory to look for desktop files starting X sessions."
31773 msgstr ""
31774
31775 #. type: item
31776 #: guix-git/doc/guix.texi:17988
31777 #, no-wrap
31778 msgid "@code{minimum-vt} (default: 7)"
31779 msgstr ""
31780
31781 #. type: table
31782 #: guix-git/doc/guix.texi:17990
31783 msgid "Minimum VT to use."
31784 msgstr ""
31785
31786 #. type: item
31787 #: guix-git/doc/guix.texi:17991
31788 #, no-wrap
31789 msgid "@code{auto-login-user} (default \"\")"
31790 msgstr ""
31791
31792 #. type: table
31793 #: guix-git/doc/guix.texi:17993
31794 msgid "User to use for auto-login."
31795 msgstr ""
31796
31797 #. type: item
31798 #: guix-git/doc/guix.texi:17994
31799 #, no-wrap
31800 msgid "@code{auto-login-session} (default \"\")"
31801 msgstr ""
31802
31803 #. type: table
31804 #: guix-git/doc/guix.texi:17996
31805 msgid "Desktop file to use for auto-login."
31806 msgstr ""
31807
31808 #. type: item
31809 #: guix-git/doc/guix.texi:17997
31810 #, no-wrap
31811 msgid "@code{relogin?} (default #f)"
31812 msgstr ""
31813
31814 #. type: table
31815 #: guix-git/doc/guix.texi:17999
31816 msgid "Relogin after logout."
31817 msgstr ""
31818
31819 #. type: cindex
31820 #: guix-git/doc/guix.texi:18004
31821 #, no-wrap
31822 msgid "X11 login"
31823 msgstr ""
31824
31825 #. type: defvr
31826 #: guix-git/doc/guix.texi:18005
31827 #, no-wrap
31828 msgid "{Scheme Variable} sddm-service-type"
31829 msgstr ""
31830
31831 #. type: defvr
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)."
31834 msgstr ""
31835
31836 #. type: defvr
31837 #: guix-git/doc/guix.texi:18011
31838 msgid "Here's an example use:"
31839 msgstr ""
31840
31841 #. type: lisp
31842 #: guix-git/doc/guix.texi:18017
31843 #, no-wrap
31844 msgid ""
31845 "(service sddm-service-type\n"
31846 " (sddm-configuration\n"
31847 " (auto-login-user \"alice\")\n"
31848 " (auto-login-session \"xfce.desktop\")))\n"
31849 msgstr ""
31850
31851 #. type: deftp
31852 #: guix-git/doc/guix.texi:18023
31853 msgid "This data type represents the configuration of the SDDM login manager. The available fields are:"
31854 msgstr ""
31855
31856 #. type: item
31857 #: guix-git/doc/guix.texi:18025
31858 #, no-wrap
31859 msgid "@code{sddm} (default: @code{sddm})"
31860 msgstr ""
31861
31862 #. type: table
31863 #: guix-git/doc/guix.texi:18027
31864 msgid "The SDDM package to use."
31865 msgstr ""
31866
31867 #. type: item
31868 #: guix-git/doc/guix.texi:18028
31869 #, no-wrap
31870 msgid "@code{display-server} (default: @code{\"x11\"})"
31871 msgstr ""
31872
31873 #. type: table
31874 #: guix-git/doc/guix.texi:18030
31875 msgid "This must be either @code{\"x11\"} or @code{\"wayland\"}."
31876 msgstr ""
31877
31878 #. type: item
31879 #: guix-git/doc/guix.texi:18033
31880 #, no-wrap
31881 msgid "@code{auto-login-user} (default: @code{\"\"})"
31882 msgstr ""
31883
31884 #. type: table
31885 #: guix-git/doc/guix.texi:18036
31886 msgid "If non-empty, this is the user account under which to log in automatically."
31887 msgstr ""
31888
31889 #. type: item
31890 #: guix-git/doc/guix.texi:18037
31891 #, no-wrap
31892 msgid "@code{auto-login-session} (default: @code{\"\"})"
31893 msgstr ""
31894
31895 #. type: table
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."
31898 msgstr ""
31899
31900 #. type: cindex
31901 #: guix-git/doc/guix.texi:18043
31902 #, no-wrap
31903 msgid "Xorg, configuration"
31904 msgstr ""
31905
31906 #. type: deftp
31907 #: guix-git/doc/guix.texi:18044
31908 #, no-wrap
31909 msgid "{Data Type} xorg-configuration"
31910 msgstr ""
31911
31912 #. type: deftp
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."
31915 msgstr ""
31916
31917 #. type: item
31918 #: guix-git/doc/guix.texi:18051
31919 #, no-wrap
31920 msgid "@code{modules} (default: @code{%default-xorg-modules})"
31921 msgstr ""
31922
31923 #. type: table
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."
31926 msgstr ""
31927
31928 #. type: item
31929 #: guix-git/doc/guix.texi:18055
31930 #, no-wrap
31931 msgid "@code{fonts} (default: @code{%default-xorg-fonts})"
31932 msgstr ""
31933
31934 #. type: table
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}."
31937 msgstr ""
31938
31939 #. type: item
31940 #: guix-git/doc/guix.texi:18058
31941 #, no-wrap
31942 msgid "@code{drivers} (default: @code{'()})"
31943 msgstr ""
31944
31945 #. type: table
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\")}."
31948 msgstr ""
31949
31950 #. type: item
31951 #: guix-git/doc/guix.texi:18063
31952 #, no-wrap
31953 msgid "@code{resolutions} (default: @code{'()})"
31954 msgstr ""
31955
31956 #. type: table
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))}."
31959 msgstr ""
31960
31961 #. type: cindex
31962 #: guix-git/doc/guix.texi:18068
31963 #, no-wrap
31964 msgid "keyboard layout, for Xorg"
31965 msgstr ""
31966
31967 #. type: cindex
31968 #: guix-git/doc/guix.texi:18069
31969 #, no-wrap
31970 msgid "keymap, for Xorg"
31971 msgstr ""
31972
31973 #. type: table
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."
31976 msgstr ""
31977
31978 #. type: table
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."
31981 msgstr ""
31982
31983 #. type: item
31984 #: guix-git/doc/guix.texi:18078 guix-git/doc/guix.texi:19789
31985 #: guix-git/doc/guix.texi:31970
31986 #, no-wrap
31987 msgid "@code{extra-config} (default: @code{'()})"
31988 msgstr ""
31989
31990 #. type: table
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."
31993 msgstr ""
31994
31995 #. type: item
31996 #: guix-git/doc/guix.texi:18082
31997 #, no-wrap
31998 msgid "@code{server} (default: @code{xorg-server})"
31999 msgstr ""
32000
32001 #. type: table
32002 #: guix-git/doc/guix.texi:18084
32003 msgid "This is the package providing the Xorg server."
32004 msgstr ""
32005
32006 #. type: item
32007 #: guix-git/doc/guix.texi:18085
32008 #, no-wrap
32009 msgid "@code{server-arguments} (default: @code{%default-xorg-server-arguments})"
32010 msgstr ""
32011
32012 #. type: table
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}."
32015 msgstr ""
32016
32017 #. type: deffn
32018 #: guix-git/doc/guix.texi:18091
32019 #, no-wrap
32020 msgid "{Scheme Procedure} set-xorg-configuration @var{config} @"
32021 msgstr ""
32022
32023 #. type: deffn
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."
32026 msgstr ""
32027
32028 #. type: deffn
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."
32031 msgstr ""
32032
32033 #. type: deffn
32034 #: guix-git/doc/guix.texi:18101
32035 #, no-wrap
32036 msgid "{Scheme Procedure} xorg-start-command [@var{config}]"
32037 msgstr ""
32038
32039 #. type: deffn
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}."
32042 msgstr ""
32043
32044 #. type: deffn
32045 #: guix-git/doc/guix.texi:18107
32046 msgid "Usually the X server is started by a login manager."
32047 msgstr ""
32048
32049 #. type: deffn
32050 #: guix-git/doc/guix.texi:18110
32051 #, no-wrap
32052 msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]"
32053 msgstr ""
32054
32055 #. type: deffn
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:"
32058 msgstr ""
32059
32060 #. type: lisp
32061 #: guix-git/doc/guix.texi:18117
32062 #, no-wrap
32063 msgid "(screen-locker-service xlockmore \"xlock\")\n"
32064 msgstr ""
32065
32066 #. type: deffn
32067 #: guix-git/doc/guix.texi:18120
32068 msgid "makes the good ol' XlockMore usable."
32069 msgstr ""
32070
32071 #. type: cindex
32072 #: guix-git/doc/guix.texi:18126
32073 #, no-wrap
32074 msgid "printer support with CUPS"
32075 msgstr ""
32076
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:"
32080 msgstr ""
32081
32082 #. type: deffn
32083 #: guix-git/doc/guix.texi:18131
32084 #, no-wrap
32085 msgid "{Scheme Variable} cups-service-type"
32086 msgstr ""
32087
32088 #. type: deffn
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:"
32091 msgstr ""
32092
32093 #. type: lisp
32094 #: guix-git/doc/guix.texi:18137
32095 #, no-wrap
32096 msgid "(service cups-service-type)\n"
32097 msgstr ""
32098
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."
32102 msgstr ""
32103
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):"
32107 msgstr ""
32108
32109 #. type: lisp
32110 #: guix-git/doc/guix.texi:18160
32111 #, no-wrap
32112 msgid ""
32113 "(service cups-service-type\n"
32114 " (cups-configuration\n"
32115 " (web-interface? #t)\n"
32116 " (extensions\n"
32117 " (list cups-filters epson-inkjet-printer-escpr hplip-minimal))))\n"
32118 msgstr ""
32119
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."
32123 msgstr ""
32124
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."
32128 msgstr ""
32129
32130 #. type: Plain text
32131 #: guix-git/doc/guix.texi:18183
32132 msgid "Available @code{cups-configuration} fields are:"
32133 msgstr ""
32134
32135 #. type: deftypevr
32136 #: guix-git/doc/guix.texi:18184
32137 #, no-wrap
32138 msgid "{@code{cups-configuration} parameter} package cups"
32139 msgstr ""
32140
32141 #. type: deftypevr
32142 #: guix-git/doc/guix.texi:18186 guix-git/doc/guix.texi:18954
32143 msgid "The CUPS package."
32144 msgstr ""
32145
32146 #. type: deftypevr
32147 #: guix-git/doc/guix.texi:18188
32148 #, no-wrap
32149 msgid "{@code{cups-configuration} parameter} package-list extensions (default: @code{(list brlaser cups-filters epson-inkjet-printer-escpr foomatic-filters hplip-minimal splix)})"
32150 msgstr ""
32151
32152 #. type: deftypevr
32153 #: guix-git/doc/guix.texi:18190
32154 msgid "Drivers and other extensions to the CUPS package."
32155 msgstr ""
32156
32157 #. type: deftypevr
32158 #: guix-git/doc/guix.texi:18192
32159 #, no-wrap
32160 msgid "{@code{cups-configuration} parameter} files-configuration files-configuration"
32161 msgstr ""
32162
32163 #. type: deftypevr
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."
32166 msgstr ""
32167
32168 #. type: deftypevr
32169 #: guix-git/doc/guix.texi:18197
32170 msgid "Available @code{files-configuration} fields are:"
32171 msgstr ""
32172
32173 #. type: deftypevr
32174 #: guix-git/doc/guix.texi:18198
32175 #, no-wrap
32176 msgid "{@code{files-configuration} parameter} log-location access-log"
32177 msgstr ""
32178
32179 #. type: deftypevr
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}."
32182 msgstr ""
32183
32184 #. type: deftypevr
32185 #: guix-git/doc/guix.texi:18208
32186 msgid "Defaults to @samp{\"/var/log/cups/access_log\"}."
32187 msgstr ""
32188
32189 #. type: deftypevr
32190 #: guix-git/doc/guix.texi:18210
32191 #, no-wrap
32192 msgid "{@code{files-configuration} parameter} file-name cache-dir"
32193 msgstr ""
32194
32195 #. type: deftypevr
32196 #: guix-git/doc/guix.texi:18212
32197 msgid "Where CUPS should cache data."
32198 msgstr ""
32199
32200 #. type: deftypevr
32201 #: guix-git/doc/guix.texi:18214
32202 msgid "Defaults to @samp{\"/var/cache/cups\"}."
32203 msgstr ""
32204
32205 #. type: deftypevr
32206 #: guix-git/doc/guix.texi:18216
32207 #, no-wrap
32208 msgid "{@code{files-configuration} parameter} string config-file-perm"
32209 msgstr ""
32210
32211 #. type: deftypevr
32212 #: guix-git/doc/guix.texi:18219
32213 msgid "Specifies the permissions for all configuration files that the scheduler writes."
32214 msgstr ""
32215
32216 #. type: deftypevr
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."
32219 msgstr ""
32220
32221 #. type: deftypevr
32222 #: guix-git/doc/guix.texi:18227
32223 msgid "Defaults to @samp{\"0640\"}."
32224 msgstr ""
32225
32226 #. type: deftypevr
32227 #: guix-git/doc/guix.texi:18229
32228 #, no-wrap
32229 msgid "{@code{files-configuration} parameter} log-location error-log"
32230 msgstr ""
32231
32232 #. type: deftypevr
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}."
32235 msgstr ""
32236
32237 #. type: deftypevr
32238 #: guix-git/doc/guix.texi:18239
32239 msgid "Defaults to @samp{\"/var/log/cups/error_log\"}."
32240 msgstr ""
32241
32242 #. type: deftypevr
32243 #: guix-git/doc/guix.texi:18241
32244 #, no-wrap
32245 msgid "{@code{files-configuration} parameter} string fatal-errors"
32246 msgstr ""
32247
32248 #. type: deftypevr
32249 #: guix-git/doc/guix.texi:18244
32250 msgid "Specifies which errors are fatal, causing the scheduler to exit. The kind strings are:"
32251 msgstr ""
32252
32253 #. type: table
32254 #: guix-git/doc/guix.texi:18248
32255 msgid "No errors are fatal."
32256 msgstr ""
32257
32258 #. type: table
32259 #: guix-git/doc/guix.texi:18251
32260 msgid "All of the errors below are fatal."
32261 msgstr ""
32262
32263 #. type: item
32264 #: guix-git/doc/guix.texi:18252
32265 #, no-wrap
32266 msgid "browse"
32267 msgstr ""
32268
32269 #. type: table
32270 #: guix-git/doc/guix.texi:18255
32271 msgid "Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon."
32272 msgstr ""
32273
32274 #. type: item
32275 #: guix-git/doc/guix.texi:18256
32276 #, no-wrap
32277 msgid "config"
32278 msgstr ""
32279
32280 #. type: table
32281 #: guix-git/doc/guix.texi:18258
32282 msgid "Configuration file syntax errors are fatal."
32283 msgstr ""
32284
32285 #. type: item
32286 #: guix-git/doc/guix.texi:18259
32287 #, no-wrap
32288 msgid "listen"
32289 msgstr ""
32290
32291 #. type: table
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."
32294 msgstr ""
32295
32296 #. type: item
32297 #: guix-git/doc/guix.texi:18263
32298 #, no-wrap
32299 msgid "log"
32300 msgstr ""
32301
32302 #. type: table
32303 #: guix-git/doc/guix.texi:18265
32304 msgid "Log file creation or write errors are fatal."
32305 msgstr ""
32306
32307 #. type: item
32308 #: guix-git/doc/guix.texi:18266
32309 #, no-wrap
32310 msgid "permissions"
32311 msgstr ""
32312
32313 #. type: table
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."
32316 msgstr ""
32317
32318 #. type: deftypevr
32319 #: guix-git/doc/guix.texi:18272
32320 msgid "Defaults to @samp{\"all -browse\"}."
32321 msgstr ""
32322
32323 #. type: deftypevr
32324 #: guix-git/doc/guix.texi:18274
32325 #, no-wrap
32326 msgid "{@code{files-configuration} parameter} boolean file-device?"
32327 msgstr ""
32328
32329 #. type: deftypevr
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."
32332 msgstr ""
32333
32334 #. type: deftypevr
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}."
32371 msgstr ""
32372
32373 #. type: deftypevr
32374 #: guix-git/doc/guix.texi:18281
32375 #, no-wrap
32376 msgid "{@code{files-configuration} parameter} string group"
32377 msgstr ""
32378
32379 #. type: deftypevr
32380 #: guix-git/doc/guix.texi:18284
32381 msgid "Specifies the group name or ID that will be used when executing external programs."
32382 msgstr ""
32383
32384 #. type: deftypevr
32385 #: guix-git/doc/guix.texi:18286 guix-git/doc/guix.texi:18366
32386 msgid "Defaults to @samp{\"lp\"}."
32387 msgstr ""
32388
32389 #. type: deftypevr
32390 #: guix-git/doc/guix.texi:18288
32391 #, no-wrap
32392 msgid "{@code{files-configuration} parameter} string log-file-perm"
32393 msgstr ""
32394
32395 #. type: deftypevr
32396 #: guix-git/doc/guix.texi:18290
32397 msgid "Specifies the permissions for all log files that the scheduler writes."
32398 msgstr ""
32399
32400 #. type: deftypevr
32401 #: guix-git/doc/guix.texi:18292
32402 msgid "Defaults to @samp{\"0644\"}."
32403 msgstr ""
32404
32405 #. type: deftypevr
32406 #: guix-git/doc/guix.texi:18294
32407 #, no-wrap
32408 msgid "{@code{files-configuration} parameter} log-location page-log"
32409 msgstr ""
32410
32411 #. type: deftypevr
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}."
32414 msgstr ""
32415
32416 #. type: deftypevr
32417 #: guix-git/doc/guix.texi:18304
32418 msgid "Defaults to @samp{\"/var/log/cups/page_log\"}."
32419 msgstr ""
32420
32421 #. type: deftypevr
32422 #: guix-git/doc/guix.texi:18306
32423 #, no-wrap
32424 msgid "{@code{files-configuration} parameter} string remote-root"
32425 msgstr ""
32426
32427 #. type: deftypevr
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}."
32430 msgstr ""
32431
32432 #. type: deftypevr
32433 #: guix-git/doc/guix.texi:18311
32434 msgid "Defaults to @samp{\"remroot\"}."
32435 msgstr ""
32436
32437 #. type: deftypevr
32438 #: guix-git/doc/guix.texi:18313
32439 #, no-wrap
32440 msgid "{@code{files-configuration} parameter} file-name request-root"
32441 msgstr ""
32442
32443 #. type: deftypevr
32444 #: guix-git/doc/guix.texi:18316
32445 msgid "Specifies the directory that contains print jobs and other HTTP request data."
32446 msgstr ""
32447
32448 #. type: deftypevr
32449 #: guix-git/doc/guix.texi:18318
32450 msgid "Defaults to @samp{\"/var/spool/cups\"}."
32451 msgstr ""
32452
32453 #. type: deftypevr
32454 #: guix-git/doc/guix.texi:18320
32455 #, no-wrap
32456 msgid "{@code{files-configuration} parameter} sandboxing sandboxing"
32457 msgstr ""
32458
32459 #. type: deftypevr
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."
32462 msgstr ""
32463
32464 #. type: deftypevr
32465 #: guix-git/doc/guix.texi:18327
32466 msgid "Defaults to @samp{strict}."
32467 msgstr ""
32468
32469 #. type: deftypevr
32470 #: guix-git/doc/guix.texi:18329
32471 #, no-wrap
32472 msgid "{@code{files-configuration} parameter} file-name server-keychain"
32473 msgstr ""
32474
32475 #. type: deftypevr
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."
32478 msgstr ""
32479
32480 #. type: deftypevr
32481 #: guix-git/doc/guix.texi:18336
32482 msgid "Defaults to @samp{\"/etc/cups/ssl\"}."
32483 msgstr ""
32484
32485 #. type: deftypevr
32486 #: guix-git/doc/guix.texi:18338
32487 #, no-wrap
32488 msgid "{@code{files-configuration} parameter} file-name server-root"
32489 msgstr ""
32490
32491 #. type: deftypevr
32492 #: guix-git/doc/guix.texi:18340
32493 msgid "Specifies the directory containing the server configuration files."
32494 msgstr ""
32495
32496 #. type: deftypevr
32497 #: guix-git/doc/guix.texi:18342
32498 msgid "Defaults to @samp{\"/etc/cups\"}."
32499 msgstr ""
32500
32501 #. type: deftypevr
32502 #: guix-git/doc/guix.texi:18344
32503 #, no-wrap
32504 msgid "{@code{files-configuration} parameter} boolean sync-on-close?"
32505 msgstr ""
32506
32507 #. type: deftypevr
32508 #: guix-git/doc/guix.texi:18347
32509 msgid "Specifies whether the scheduler calls fsync(2) after writing configuration or state files."
32510 msgstr ""
32511
32512 #. type: deftypevr
32513 #: guix-git/doc/guix.texi:18351
32514 #, no-wrap
32515 msgid "{@code{files-configuration} parameter} space-separated-string-list system-group"
32516 msgstr ""
32517
32518 #. type: deftypevr
32519 #: guix-git/doc/guix.texi:18353
32520 msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication."
32521 msgstr ""
32522
32523 #. type: deftypevr
32524 #: guix-git/doc/guix.texi:18355
32525 #, no-wrap
32526 msgid "{@code{files-configuration} parameter} file-name temp-dir"
32527 msgstr ""
32528
32529 #. type: deftypevr
32530 #: guix-git/doc/guix.texi:18357
32531 msgid "Specifies the directory where temporary files are stored."
32532 msgstr ""
32533
32534 #. type: deftypevr
32535 #: guix-git/doc/guix.texi:18359
32536 msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}."
32537 msgstr ""
32538
32539 #. type: deftypevr
32540 #: guix-git/doc/guix.texi:18361
32541 #, no-wrap
32542 msgid "{@code{files-configuration} parameter} string user"
32543 msgstr ""
32544
32545 #. type: deftypevr
32546 #: guix-git/doc/guix.texi:18364
32547 msgid "Specifies the user name or ID that is used when running external programs."
32548 msgstr ""
32549
32550 #. type: deftypevr
32551 #: guix-git/doc/guix.texi:18368
32552 #, no-wrap
32553 msgid "{@code{files-configuration} parameter} string set-env"
32554 msgstr ""
32555
32556 #. type: deftypevr
32557 #: guix-git/doc/guix.texi:18370
32558 msgid "Set the specified environment variable to be passed to child processes."
32559 msgstr ""
32560
32561 #. type: deftypevr
32562 #: guix-git/doc/guix.texi:18372
32563 msgid "Defaults to @samp{\"variable value\"}."
32564 msgstr ""
32565
32566 #. type: deftypevr
32567 #: guix-git/doc/guix.texi:18375
32568 #, no-wrap
32569 msgid "{@code{cups-configuration} parameter} access-log-level access-log-level"
32570 msgstr ""
32571
32572 #. type: deftypevr
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."
32575 msgstr ""
32576
32577 #. type: deftypevr
32578 #: guix-git/doc/guix.texi:18384
32579 msgid "Defaults to @samp{actions}."
32580 msgstr ""
32581
32582 #. type: deftypevr
32583 #: guix-git/doc/guix.texi:18386
32584 #, no-wrap
32585 msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?"
32586 msgstr ""
32587
32588 #. type: deftypevr
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."
32591 msgstr ""
32592
32593 #. type: deftypevr
32594 #: guix-git/doc/guix.texi:18393
32595 #, no-wrap
32596 msgid "{@code{cups-configuration} parameter} comma-separated-string-list browse-dns-sd-sub-types"
32597 msgstr ""
32598
32599 #. type: deftypevr
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."
32602 msgstr ""
32603
32604 #. type: deftypevr
32605 #: guix-git/doc/guix.texi:18399
32606 msgid "Defaults to @samp{\"_cups\"}."
32607 msgstr ""
32608
32609 #. type: deftypevr
32610 #: guix-git/doc/guix.texi:18401
32611 #, no-wrap
32612 msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols"
32613 msgstr ""
32614
32615 #. type: deftypevr
32616 #: guix-git/doc/guix.texi:18403
32617 msgid "Specifies which protocols to use for local printer sharing."
32618 msgstr ""
32619
32620 #. type: deftypevr
32621 #: guix-git/doc/guix.texi:18405
32622 msgid "Defaults to @samp{dnssd}."
32623 msgstr ""
32624
32625 #. type: deftypevr
32626 #: guix-git/doc/guix.texi:18407
32627 #, no-wrap
32628 msgid "{@code{cups-configuration} parameter} boolean browse-web-if?"
32629 msgstr ""
32630
32631 #. type: deftypevr
32632 #: guix-git/doc/guix.texi:18409
32633 msgid "Specifies whether the CUPS web interface is advertised."
32634 msgstr ""
32635
32636 #. type: deftypevr
32637 #: guix-git/doc/guix.texi:18413
32638 #, no-wrap
32639 msgid "{@code{cups-configuration} parameter} boolean browsing?"
32640 msgstr ""
32641
32642 #. type: deftypevr
32643 #: guix-git/doc/guix.texi:18415
32644 msgid "Specifies whether shared printers are advertised."
32645 msgstr ""
32646
32647 #. type: deftypevr
32648 #: guix-git/doc/guix.texi:18419
32649 #, no-wrap
32650 msgid "{@code{cups-configuration} parameter} string classification"
32651 msgstr ""
32652
32653 #. type: deftypevr
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."
32656 msgstr ""
32657
32658 #. type: deftypevr
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{\"\"}."
32694 msgstr ""
32695
32696 #. type: deftypevr
32697 #: guix-git/doc/guix.texi:18428
32698 #, no-wrap
32699 msgid "{@code{cups-configuration} parameter} boolean classify-override?"
32700 msgstr ""
32701
32702 #. type: deftypevr
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."
32705 msgstr ""
32706
32707 #. type: deftypevr
32708 #: guix-git/doc/guix.texi:18435
32709 #, no-wrap
32710 msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type"
32711 msgstr ""
32712
32713 #. type: deftypevr
32714 #: guix-git/doc/guix.texi:18437
32715 msgid "Specifies the default type of authentication to use."
32716 msgstr ""
32717
32718 #. type: deftypevr
32719 #: guix-git/doc/guix.texi:18439
32720 msgid "Defaults to @samp{Basic}."
32721 msgstr ""
32722
32723 #. type: deftypevr
32724 #: guix-git/doc/guix.texi:18441
32725 #, no-wrap
32726 msgid "{@code{cups-configuration} parameter} default-encryption default-encryption"
32727 msgstr ""
32728
32729 #. type: deftypevr
32730 #: guix-git/doc/guix.texi:18443
32731 msgid "Specifies whether encryption will be used for authenticated requests."
32732 msgstr ""
32733
32734 #. type: deftypevr
32735 #: guix-git/doc/guix.texi:18445
32736 msgid "Defaults to @samp{Required}."
32737 msgstr ""
32738
32739 #. type: deftypevr
32740 #: guix-git/doc/guix.texi:18447
32741 #, no-wrap
32742 msgid "{@code{cups-configuration} parameter} string default-language"
32743 msgstr ""
32744
32745 #. type: deftypevr
32746 #: guix-git/doc/guix.texi:18449
32747 msgid "Specifies the default language to use for text and web content."
32748 msgstr ""
32749
32750 #. type: deftypevr
32751 #: guix-git/doc/guix.texi:18451
32752 msgid "Defaults to @samp{\"en\"}."
32753 msgstr ""
32754
32755 #. type: deftypevr
32756 #: guix-git/doc/guix.texi:18453
32757 #, no-wrap
32758 msgid "{@code{cups-configuration} parameter} string default-paper-size"
32759 msgstr ""
32760
32761 #. type: deftypevr
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\"}."
32764 msgstr ""
32765
32766 #. type: deftypevr
32767 #: guix-git/doc/guix.texi:18460
32768 msgid "Defaults to @samp{\"Auto\"}."
32769 msgstr ""
32770
32771 #. type: deftypevr
32772 #: guix-git/doc/guix.texi:18462
32773 #, no-wrap
32774 msgid "{@code{cups-configuration} parameter} string default-policy"
32775 msgstr ""
32776
32777 #. type: deftypevr
32778 #: guix-git/doc/guix.texi:18464
32779 msgid "Specifies the default access policy to use."
32780 msgstr ""
32781
32782 #. type: deftypevr
32783 #: guix-git/doc/guix.texi:18466
32784 msgid "Defaults to @samp{\"default\"}."
32785 msgstr ""
32786
32787 #. type: deftypevr
32788 #: guix-git/doc/guix.texi:18468
32789 #, no-wrap
32790 msgid "{@code{cups-configuration} parameter} boolean default-shared?"
32791 msgstr ""
32792
32793 #. type: deftypevr
32794 #: guix-git/doc/guix.texi:18470
32795 msgid "Specifies whether local printers are shared by default."
32796 msgstr ""
32797
32798 #. type: deftypevr
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}."
32821 msgstr ""
32822
32823 #. type: deftypevr
32824 #: guix-git/doc/guix.texi:18474
32825 #, no-wrap
32826 msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval"
32827 msgstr ""
32828
32829 #. type: deftypevr
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."
32832 msgstr ""
32833
32834 #. type: deftypevr
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}."
32840 msgstr ""
32841
32842 #. type: deftypevr
32843 #: guix-git/doc/guix.texi:18482
32844 #, no-wrap
32845 msgid "{@code{cups-configuration} parameter} error-policy error-policy"
32846 msgstr ""
32847
32848 #. type: deftypevr
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."
32851 msgstr ""
32852
32853 #. type: deftypevr
32854 #: guix-git/doc/guix.texi:18490
32855 msgid "Defaults to @samp{stop-printer}."
32856 msgstr ""
32857
32858 #. type: deftypevr
32859 #: guix-git/doc/guix.texi:18492
32860 #, no-wrap
32861 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit"
32862 msgstr ""
32863
32864 #. type: deftypevr
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."
32867 msgstr ""
32868
32869 #. type: deftypevr
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}."
32881 msgstr ""
32882
32883 #. type: deftypevr
32884 #: guix-git/doc/guix.texi:18504
32885 #, no-wrap
32886 msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice"
32887 msgstr ""
32888
32889 #. type: deftypevr
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."
32892 msgstr ""
32893
32894 #. type: deftypevr
32895 #: guix-git/doc/guix.texi:18512
32896 #, no-wrap
32897 msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups"
32898 msgstr ""
32899
32900 #. type: deftypevr
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."
32903 msgstr ""
32904
32905 #. type: deftypevr
32906 #: guix-git/doc/guix.texi:18523
32907 #, no-wrap
32908 msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay"
32909 msgstr ""
32910
32911 #. type: deftypevr
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."
32914 msgstr ""
32915
32916 #. type: deftypevr
32917 #: guix-git/doc/guix.texi:18530
32918 #, no-wrap
32919 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval"
32920 msgstr ""
32921
32922 #. type: deftypevr
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}."
32925 msgstr ""
32926
32927 #. type: deftypevr
32928 #: guix-git/doc/guix.texi:18539
32929 #, no-wrap
32930 msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit"
32931 msgstr ""
32932
32933 #. type: deftypevr
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}."
32936 msgstr ""
32937
32938 #. type: deftypevr
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}."
32949 msgstr ""
32950
32951 #. type: deftypevr
32952 #: guix-git/doc/guix.texi:18548
32953 #, no-wrap
32954 msgid "{@code{cups-configuration} parameter} boolean keep-alive?"
32955 msgstr ""
32956
32957 #. type: deftypevr
32958 #: guix-git/doc/guix.texi:18550
32959 msgid "Specifies whether to support HTTP keep-alive connections."
32960 msgstr ""
32961
32962 #. type: deftypevr
32963 #: guix-git/doc/guix.texi:18554
32964 #, no-wrap
32965 msgid "{@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout"
32966 msgstr ""
32967
32968 #. type: deftypevr
32969 #: guix-git/doc/guix.texi:18556
32970 msgid "Specifies how long an idle client connection remains open, in seconds."
32971 msgstr ""
32972
32973 #. type: deftypevr
32974 #: guix-git/doc/guix.texi:18560
32975 #, no-wrap
32976 msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body"
32977 msgstr ""
32978
32979 #. type: deftypevr
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."
32982 msgstr ""
32983
32984 #. type: deftypevr
32985 #: guix-git/doc/guix.texi:18567
32986 #, no-wrap
32987 msgid "{@code{cups-configuration} parameter} multiline-string-list listen"
32988 msgstr ""
32989
32990 #. type: deftypevr
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."
32993 msgstr ""
32994
32995 #. type: deftypevr
32996 #: guix-git/doc/guix.texi:18576
32997 #, no-wrap
32998 msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log"
32999 msgstr ""
33000
33001 #. type: deftypevr
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."
33004 msgstr ""
33005
33006 #. type: deftypevr
33007 #: guix-git/doc/guix.texi:18585
33008 msgid "Defaults to @samp{128}."
33009 msgstr ""
33010
33011 #. type: deftypevr
33012 #: guix-git/doc/guix.texi:18587
33013 #, no-wrap
33014 msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls"
33015 msgstr ""
33016
33017 #. type: deftypevr
33018 #: guix-git/doc/guix.texi:18589
33019 msgid "Specifies a set of additional access controls."
33020 msgstr ""
33021
33022 #. type: deftypevr
33023 #: guix-git/doc/guix.texi:18591
33024 msgid "Available @code{location-access-controls} fields are:"
33025 msgstr ""
33026
33027 #. type: deftypevr
33028 #: guix-git/doc/guix.texi:18592
33029 #, no-wrap
33030 msgid "{@code{location-access-controls} parameter} file-name path"
33031 msgstr ""
33032
33033 #. type: deftypevr
33034 #: guix-git/doc/guix.texi:18594
33035 msgid "Specifies the URI path to which the access control applies."
33036 msgstr ""
33037
33038 #. type: deftypevr
33039 #: guix-git/doc/guix.texi:18596
33040 #, no-wrap
33041 msgid "{@code{location-access-controls} parameter} access-control-list access-controls"
33042 msgstr ""
33043
33044 #. type: deftypevr
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}."
33047 msgstr ""
33048
33049 #. type: deftypevr
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{()}."
33070 msgstr ""
33071
33072 #. type: deftypevr
33073 #: guix-git/doc/guix.texi:18603
33074 #, no-wrap
33075 msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls"
33076 msgstr ""
33077
33078 #. type: deftypevr
33079 #: guix-git/doc/guix.texi:18605
33080 msgid "Access controls for method-specific access to this path."
33081 msgstr ""
33082
33083 #. type: deftypevr
33084 #: guix-git/doc/guix.texi:18609
33085 msgid "Available @code{method-access-controls} fields are:"
33086 msgstr ""
33087
33088 #. type: deftypevr
33089 #: guix-git/doc/guix.texi:18610
33090 #, no-wrap
33091 msgid "{@code{method-access-controls} parameter} boolean reverse?"
33092 msgstr ""
33093
33094 #. type: deftypevr
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."
33097 msgstr ""
33098
33099 #. type: deftypevr
33100 #: guix-git/doc/guix.texi:18617
33101 #, no-wrap
33102 msgid "{@code{method-access-controls} parameter} method-list methods"
33103 msgstr ""
33104
33105 #. type: deftypevr
33106 #: guix-git/doc/guix.texi:18619
33107 msgid "Methods to which this access control applies."
33108 msgstr ""
33109
33110 #. type: deftypevr
33111 #: guix-git/doc/guix.texi:18623
33112 #, no-wrap
33113 msgid "{@code{method-access-controls} parameter} access-control-list access-controls"
33114 msgstr ""
33115
33116 #. type: deftypevr
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\"}."
33119 msgstr ""
33120
33121 #. type: deftypevr
33122 #: guix-git/doc/guix.texi:18632
33123 #, no-wrap
33124 msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history"
33125 msgstr ""
33126
33127 #. type: deftypevr
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."
33130 msgstr ""
33131
33132 #. type: deftypevr
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}."
33138 msgstr ""
33139
33140 #. type: deftypevr
33141 #: guix-git/doc/guix.texi:18640
33142 #, no-wrap
33143 msgid "{@code{cups-configuration} parameter} log-level log-level"
33144 msgstr ""
33145
33146 #. type: deftypevr
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."
33149 msgstr ""
33150
33151 #. type: deftypevr
33152 #: guix-git/doc/guix.texi:18645 guix-git/doc/guix.texi:23228
33153 msgid "Defaults to @samp{info}."
33154 msgstr ""
33155
33156 #. type: deftypevr
33157 #: guix-git/doc/guix.texi:18647
33158 #, no-wrap
33159 msgid "{@code{cups-configuration} parameter} log-time-format log-time-format"
33160 msgstr ""
33161
33162 #. type: deftypevr
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."
33165 msgstr ""
33166
33167 #. type: deftypevr
33168 #: guix-git/doc/guix.texi:18652
33169 msgid "Defaults to @samp{standard}."
33170 msgstr ""
33171
33172 #. type: deftypevr
33173 #: guix-git/doc/guix.texi:18654
33174 #, no-wrap
33175 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients"
33176 msgstr ""
33177
33178 #. type: deftypevr
33179 #: guix-git/doc/guix.texi:18657
33180 msgid "Specifies the maximum number of simultaneous clients that are allowed by the scheduler."
33181 msgstr ""
33182
33183 #. type: deftypevr
33184 #: guix-git/doc/guix.texi:18661
33185 #, no-wrap
33186 msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host"
33187 msgstr ""
33188
33189 #. type: deftypevr
33190 #: guix-git/doc/guix.texi:18664
33191 msgid "Specifies the maximum number of simultaneous clients that are allowed from a single address."
33192 msgstr ""
33193
33194 #. type: deftypevr
33195 #: guix-git/doc/guix.texi:18668
33196 #, no-wrap
33197 msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies"
33198 msgstr ""
33199
33200 #. type: deftypevr
33201 #: guix-git/doc/guix.texi:18671
33202 msgid "Specifies the maximum number of copies that a user can print of each job."
33203 msgstr ""
33204
33205 #. type: deftypevr
33206 #: guix-git/doc/guix.texi:18673
33207 msgid "Defaults to @samp{9999}."
33208 msgstr ""
33209
33210 #. type: deftypevr
33211 #: guix-git/doc/guix.texi:18675
33212 #, no-wrap
33213 msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time"
33214 msgstr ""
33215
33216 #. type: deftypevr
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."
33219 msgstr ""
33220
33221 #. type: deftypevr
33222 #: guix-git/doc/guix.texi:18683
33223 #, no-wrap
33224 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs"
33225 msgstr ""
33226
33227 #. type: deftypevr
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."
33230 msgstr ""
33231
33232 #. type: deftypevr
33233 #: guix-git/doc/guix.texi:18688
33234 msgid "Defaults to @samp{500}."
33235 msgstr ""
33236
33237 #. type: deftypevr
33238 #: guix-git/doc/guix.texi:18690
33239 #, no-wrap
33240 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer"
33241 msgstr ""
33242
33243 #. type: deftypevr
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."
33246 msgstr ""
33247
33248 #. type: deftypevr
33249 #: guix-git/doc/guix.texi:18697
33250 #, no-wrap
33251 msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user"
33252 msgstr ""
33253
33254 #. type: deftypevr
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."
33257 msgstr ""
33258
33259 #. type: deftypevr
33260 #: guix-git/doc/guix.texi:18704
33261 #, no-wrap
33262 msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time"
33263 msgstr ""
33264
33265 #. type: deftypevr
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."
33268 msgstr ""
33269
33270 #. type: deftypevr
33271 #: guix-git/doc/guix.texi:18709
33272 msgid "Defaults to @samp{10800}."
33273 msgstr ""
33274
33275 #. type: deftypevr
33276 #: guix-git/doc/guix.texi:18711
33277 #, no-wrap
33278 msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size"
33279 msgstr ""
33280
33281 #. type: deftypevr
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."
33284 msgstr ""
33285
33286 #. type: deftypevr
33287 #: guix-git/doc/guix.texi:18716
33288 msgid "Defaults to @samp{1048576}."
33289 msgstr ""
33290
33291 #. type: deftypevr
33292 #: guix-git/doc/guix.texi:18718
33293 #, no-wrap
33294 msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout"
33295 msgstr ""
33296
33297 #. type: deftypevr
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."
33300 msgstr ""
33301
33302 #. type: deftypevr
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}."
33306 msgstr ""
33307
33308 #. type: deftypevr
33309 #: guix-git/doc/guix.texi:18725
33310 #, no-wrap
33311 msgid "{@code{cups-configuration} parameter} string page-log-format"
33312 msgstr ""
33313
33314 #. type: deftypevr
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:"
33317 msgstr ""
33318
33319 #. type: item
33320 #: guix-git/doc/guix.texi:18732
33321 #, no-wrap
33322 msgid "%%"
33323 msgstr ""
33324
33325 #. type: table
33326 #: guix-git/doc/guix.texi:18734
33327 msgid "insert a single percent character"
33328 msgstr ""
33329
33330 #. type: item
33331 #: guix-git/doc/guix.texi:18735
33332 #, no-wrap
33333 msgid "%@{name@}"
33334 msgstr ""
33335
33336 #. type: table
33337 #: guix-git/doc/guix.texi:18737
33338 msgid "insert the value of the specified IPP attribute"
33339 msgstr ""
33340
33341 #. type: item
33342 #: guix-git/doc/guix.texi:18738
33343 #, no-wrap
33344 msgid "%C"
33345 msgstr ""
33346
33347 #. type: table
33348 #: guix-git/doc/guix.texi:18740
33349 msgid "insert the number of copies for the current page"
33350 msgstr ""
33351
33352 #. type: item
33353 #: guix-git/doc/guix.texi:18741
33354 #, no-wrap
33355 msgid "%P"
33356 msgstr ""
33357
33358 #. type: table
33359 #: guix-git/doc/guix.texi:18743
33360 msgid "insert the current page number"
33361 msgstr ""
33362
33363 #. type: item
33364 #: guix-git/doc/guix.texi:18744
33365 #, no-wrap
33366 msgid "%T"
33367 msgstr ""
33368
33369 #. type: table
33370 #: guix-git/doc/guix.texi:18746
33371 msgid "insert the current date and time in common log format"
33372 msgstr ""
33373
33374 #. type: item
33375 #: guix-git/doc/guix.texi:18747
33376 #, no-wrap
33377 msgid "%j"
33378 msgstr ""
33379
33380 #. type: table
33381 #: guix-git/doc/guix.texi:18749
33382 msgid "insert the job ID"
33383 msgstr ""
33384
33385 #. type: item
33386 #: guix-git/doc/guix.texi:18750 guix-git/doc/guix.texi:20671
33387 #, no-wrap
33388 msgid "%p"
33389 msgstr ""
33390
33391 #. type: table
33392 #: guix-git/doc/guix.texi:18752
33393 msgid "insert the printer name"
33394 msgstr ""
33395
33396 #. type: item
33397 #: guix-git/doc/guix.texi:18753 guix-git/doc/guix.texi:20694
33398 #, no-wrap
33399 msgid "%u"
33400 msgstr ""
33401
33402 #. type: table
33403 #: guix-git/doc/guix.texi:18755
33404 msgid "insert the username"
33405 msgstr ""
33406
33407 #. type: deftypevr
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."
33410 msgstr ""
33411
33412 #. type: deftypevr
33413 #: guix-git/doc/guix.texi:18765
33414 #, no-wrap
33415 msgid "{@code{cups-configuration} parameter} environment-variables environment-variables"
33416 msgstr ""
33417
33418 #. type: deftypevr
33419 #: guix-git/doc/guix.texi:18768
33420 msgid "Passes the specified environment variable(s) to child processes; a list of strings."
33421 msgstr ""
33422
33423 #. type: deftypevr
33424 #: guix-git/doc/guix.texi:18772
33425 #, no-wrap
33426 msgid "{@code{cups-configuration} parameter} policy-configuration-list policies"
33427 msgstr ""
33428
33429 #. type: deftypevr
33430 #: guix-git/doc/guix.texi:18774
33431 msgid "Specifies named access control policies."
33432 msgstr ""
33433
33434 #. type: deftypevr
33435 #: guix-git/doc/guix.texi:18776
33436 msgid "Available @code{policy-configuration} fields are:"
33437 msgstr ""
33438
33439 #. type: deftypevr
33440 #: guix-git/doc/guix.texi:18777
33441 #, no-wrap
33442 msgid "{@code{policy-configuration} parameter} string name"
33443 msgstr ""
33444
33445 #. type: deftypevr
33446 #: guix-git/doc/guix.texi:18779
33447 msgid "Name of the policy."
33448 msgstr ""
33449
33450 #. type: deftypevr
33451 #: guix-git/doc/guix.texi:18781
33452 #, no-wrap
33453 msgid "{@code{policy-configuration} parameter} string job-private-access"
33454 msgstr ""
33455
33456 #. type: deftypevr
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}."
33459 msgstr ""
33460
33461 #. type: deftypevr
33462 #: guix-git/doc/guix.texi:18793 guix-git/doc/guix.texi:18815
33463 msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}."
33464 msgstr ""
33465
33466 #. type: deftypevr
33467 #: guix-git/doc/guix.texi:18795
33468 #, no-wrap
33469 msgid "{@code{policy-configuration} parameter} string job-private-values"
33470 msgstr ""
33471
33472 #. type: deftypevr
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}."
33475 msgstr ""
33476
33477 #. type: deftypevr
33478 #: guix-git/doc/guix.texi:18801
33479 msgid "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-name phone\"}."
33480 msgstr ""
33481
33482 #. type: deftypevr
33483 #: guix-git/doc/guix.texi:18803
33484 #, no-wrap
33485 msgid "{@code{policy-configuration} parameter} string subscription-private-access"
33486 msgstr ""
33487
33488 #. type: deftypevr
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}."
33491 msgstr ""
33492
33493 #. type: deftypevr
33494 #: guix-git/doc/guix.texi:18817
33495 #, no-wrap
33496 msgid "{@code{policy-configuration} parameter} string subscription-private-values"
33497 msgstr ""
33498
33499 #. type: deftypevr
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\"}."
33502 msgstr ""
33503
33504 #. type: deftypevr
33505 #: guix-git/doc/guix.texi:18825
33506 #, no-wrap
33507 msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls"
33508 msgstr ""
33509
33510 #. type: deftypevr
33511 #: guix-git/doc/guix.texi:18827
33512 msgid "Access control by IPP operation."
33513 msgstr ""
33514
33515 #. type: deftypevr
33516 #: guix-git/doc/guix.texi:18832
33517 #, no-wrap
33518 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files"
33519 msgstr ""
33520
33521 #. type: deftypevr
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."
33524 msgstr ""
33525
33526 #. type: deftypevr
33527 #: guix-git/doc/guix.texi:18839
33528 msgid "Defaults to @samp{86400}."
33529 msgstr ""
33530
33531 #. type: deftypevr
33532 #: guix-git/doc/guix.texi:18841
33533 #, no-wrap
33534 msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history"
33535 msgstr ""
33536
33537 #. type: deftypevr
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."
33540 msgstr ""
33541
33542 #. type: deftypevr
33543 #: guix-git/doc/guix.texi:18850
33544 #, no-wrap
33545 msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout"
33546 msgstr ""
33547
33548 #. type: deftypevr
33549 #: guix-git/doc/guix.texi:18853
33550 msgid "Specifies the amount of time to wait for job completion before restarting the scheduler."
33551 msgstr ""
33552
33553 #. type: deftypevr
33554 #: guix-git/doc/guix.texi:18857
33555 #, no-wrap
33556 msgid "{@code{cups-configuration} parameter} string rip-cache"
33557 msgstr ""
33558
33559 #. type: deftypevr
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."
33562 msgstr ""
33563
33564 #. type: deftypevr
33565 #: guix-git/doc/guix.texi:18862
33566 msgid "Defaults to @samp{\"128m\"}."
33567 msgstr ""
33568
33569 #. type: deftypevr
33570 #: guix-git/doc/guix.texi:18864
33571 #, no-wrap
33572 msgid "{@code{cups-configuration} parameter} string server-admin"
33573 msgstr ""
33574
33575 #. type: deftypevr
33576 #: guix-git/doc/guix.texi:18866
33577 msgid "Specifies the email address of the server administrator."
33578 msgstr ""
33579
33580 #. type: deftypevr
33581 #: guix-git/doc/guix.texi:18868
33582 msgid "Defaults to @samp{\"root@@localhost.localdomain\"}."
33583 msgstr ""
33584
33585 #. type: deftypevr
33586 #: guix-git/doc/guix.texi:18870
33587 #, no-wrap
33588 msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias"
33589 msgstr ""
33590
33591 #. type: deftypevr
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{*}."
33594 msgstr ""
33595
33596 #. type: deftypevr
33597 #: guix-git/doc/guix.texi:18880
33598 msgid "Defaults to @samp{*}."
33599 msgstr ""
33600
33601 #. type: deftypevr
33602 #: guix-git/doc/guix.texi:18882
33603 #, no-wrap
33604 msgid "{@code{cups-configuration} parameter} string server-name"
33605 msgstr ""
33606
33607 #. type: deftypevr
33608 #: guix-git/doc/guix.texi:18884
33609 msgid "Specifies the fully-qualified host name of the server."
33610 msgstr ""
33611
33612 #. type: deftypevr
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\"}."
33616 msgstr ""
33617
33618 #. type: deftypevr
33619 #: guix-git/doc/guix.texi:18888
33620 #, no-wrap
33621 msgid "{@code{cups-configuration} parameter} server-tokens server-tokens"
33622 msgstr ""
33623
33624 #. type: deftypevr
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}."
33627 msgstr ""
33628
33629 #. type: deftypevr
33630 #: guix-git/doc/guix.texi:18898
33631 msgid "Defaults to @samp{Minimal}."
33632 msgstr ""
33633
33634 #. type: deftypevr
33635 #: guix-git/doc/guix.texi:18900
33636 #, no-wrap
33637 msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen"
33638 msgstr ""
33639
33640 #. type: deftypevr
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."
33643 msgstr ""
33644
33645 #. type: deftypevr
33646 #: guix-git/doc/guix.texi:18909
33647 #, no-wrap
33648 msgid "{@code{cups-configuration} parameter} ssl-options ssl-options"
33649 msgstr ""
33650
33651 #. type: deftypevr
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."
33654 msgstr ""
33655
33656 #. type: deftypevr
33657 #: guix-git/doc/guix.texi:18923
33658 #, no-wrap
33659 msgid "{@code{cups-configuration} parameter} boolean strict-conformance?"
33660 msgstr ""
33661
33662 #. type: deftypevr
33663 #: guix-git/doc/guix.texi:18926
33664 msgid "Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications."
33665 msgstr ""
33666
33667 #. type: deftypevr
33668 #: guix-git/doc/guix.texi:18930
33669 #, no-wrap
33670 msgid "{@code{cups-configuration} parameter} non-negative-integer timeout"
33671 msgstr ""
33672
33673 #. type: deftypevr
33674 #: guix-git/doc/guix.texi:18932
33675 msgid "Specifies the HTTP request timeout, in seconds."
33676 msgstr ""
33677
33678 #. type: deftypevr
33679 #: guix-git/doc/guix.texi:18937
33680 #, no-wrap
33681 msgid "{@code{cups-configuration} parameter} boolean web-interface?"
33682 msgstr ""
33683
33684 #. type: deftypevr
33685 #: guix-git/doc/guix.texi:18939
33686 msgid "Specifies whether the web interface is enabled."
33687 msgstr ""
33688
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}."
33692 msgstr ""
33693
33694 #. type: Plain text
33695 #: guix-git/doc/guix.texi:18951
33696 msgid "Available @code{opaque-cups-configuration} fields are:"
33697 msgstr ""
33698
33699 #. type: deftypevr
33700 #: guix-git/doc/guix.texi:18952
33701 #, no-wrap
33702 msgid "{@code{opaque-cups-configuration} parameter} package cups"
33703 msgstr ""
33704
33705 #. type: deftypevr
33706 #: guix-git/doc/guix.texi:18956
33707 #, no-wrap
33708 msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf"
33709 msgstr ""
33710
33711 #. type: deftypevr
33712 #: guix-git/doc/guix.texi:18958
33713 msgid "The contents of the @code{cupsd.conf}, as a string."
33714 msgstr ""
33715
33716 #. type: deftypevr
33717 #: guix-git/doc/guix.texi:18960
33718 #, no-wrap
33719 msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf"
33720 msgstr ""
33721
33722 #. type: deftypevr
33723 #: guix-git/doc/guix.texi:18962
33724 msgid "The contents of the @code{cups-files.conf} file, as a string."
33725 msgstr ""
33726
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:"
33730 msgstr ""
33731
33732 #. type: lisp
33733 #: guix-git/doc/guix.texi:18973
33734 #, no-wrap
33735 msgid ""
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"
33740 msgstr ""
33741
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."
33745 msgstr ""
33746
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:"
33750 msgstr ""
33751
33752 #. type: defvr
33753 #: guix-git/doc/guix.texi:18989
33754 #, no-wrap
33755 msgid "{Scheme Variable} %desktop-services"
33756 msgstr ""
33757
33758 #. type: defvr
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."
33761 msgstr ""
33762
33763 #. type: defvr
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})."
33766 msgstr ""
33767
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}})."
33771 msgstr ""
33772
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."
33776 msgstr ""
33777
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."
33781 msgstr ""
33782
33783 #. type: defvr
33784 #: guix-git/doc/guix.texi:19041
33785 #, no-wrap
33786 msgid "{Scheme Variable} gnome-desktop-service-type"
33787 msgstr ""
33788
33789 #. type: defvr
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)."
33792 msgstr ""
33793
33794 #. type: defvr
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}."
33797 msgstr ""
33798
33799 #. type: deftp
33800 #: guix-git/doc/guix.texi:19050
33801 #, no-wrap
33802 msgid "{Data Type} gnome-desktop-configuration"
33803 msgstr ""
33804
33805 #. type: deftp
33806 #: guix-git/doc/guix.texi:19052
33807 msgid "Configuration record for the GNOME desktop environment."
33808 msgstr ""
33809
33810 #. type: item
33811 #: guix-git/doc/guix.texi:19054
33812 #, no-wrap
33813 msgid "@code{gnome} (default: @code{gnome})"
33814 msgstr ""
33815
33816 #. type: table
33817 #: guix-git/doc/guix.texi:19056
33818 msgid "The GNOME package to use."
33819 msgstr ""
33820
33821 #. type: defvr
33822 #: guix-git/doc/guix.texi:19059
33823 #, no-wrap
33824 msgid "{Scheme Variable} xfce-desktop-service-type"
33825 msgstr ""
33826
33827 #. type: defvr
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)."
33830 msgstr ""
33831
33832 #. type: defvr
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."
33835 msgstr ""
33836
33837 #. type: defvr
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}."
33840 msgstr ""
33841
33842 #. type: deftp
33843 #: guix-git/doc/guix.texi:19076
33844 #, no-wrap
33845 msgid "{Data Type} xfce-desktop-configuration"
33846 msgstr ""
33847
33848 #. type: deftp
33849 #: guix-git/doc/guix.texi:19078
33850 msgid "Configuration record for the Xfce desktop environment."
33851 msgstr ""
33852
33853 #. type: item
33854 #: guix-git/doc/guix.texi:19080
33855 #, no-wrap
33856 msgid "@code{xfce} (default: @code{xfce})"
33857 msgstr ""
33858
33859 #. type: table
33860 #: guix-git/doc/guix.texi:19082
33861 msgid "The Xfce package to use."
33862 msgstr ""
33863
33864 #. type: deffn
33865 #: guix-git/doc/guix.texi:19085
33866 #, no-wrap
33867 msgid "{Scheme Variable} mate-desktop-service-type"
33868 msgstr ""
33869
33870 #. type: deffn
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)."
33873 msgstr ""
33874
33875 #. type: deffn
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}."
33878 msgstr ""
33879
33880 #. type: deftp
33881 #: guix-git/doc/guix.texi:19095
33882 #, no-wrap
33883 msgid "{Data Type} mate-desktop-configuration"
33884 msgstr ""
33885
33886 #. type: deftp
33887 #: guix-git/doc/guix.texi:19097
33888 msgid "Configuration record for the MATE desktop environment."
33889 msgstr ""
33890
33891 #. type: item
33892 #: guix-git/doc/guix.texi:19099
33893 #, no-wrap
33894 msgid "@code{mate} (default: @code{mate})"
33895 msgstr ""
33896
33897 #. type: table
33898 #: guix-git/doc/guix.texi:19101
33899 msgid "The MATE package to use."
33900 msgstr ""
33901
33902 #. type: deffn
33903 #: guix-git/doc/guix.texi:19104
33904 #, no-wrap
33905 msgid "{Scheme Variable} lxqt-desktop-service-type"
33906 msgstr ""
33907
33908 #. type: deffn
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)."
33911 msgstr ""
33912
33913 #. type: deffn
33914 #: guix-git/doc/guix.texi:19111
33915 msgid "This service adds the @code{lxqt} package to the system profile."
33916 msgstr ""
33917
33918 #. type: deftp
33919 #: guix-git/doc/guix.texi:19113
33920 #, no-wrap
33921 msgid "{Data Type} lxqt-desktop-configuration"
33922 msgstr ""
33923
33924 #. type: deftp
33925 #: guix-git/doc/guix.texi:19115
33926 msgid "Configuration record for the LXQt desktop environment."
33927 msgstr ""
33928
33929 #. type: item
33930 #: guix-git/doc/guix.texi:19117
33931 #, no-wrap
33932 msgid "@code{lxqt} (default: @code{lxqt})"
33933 msgstr ""
33934
33935 #. type: table
33936 #: guix-git/doc/guix.texi:19119
33937 msgid "The LXQT package to use."
33938 msgstr ""
33939
33940 #. type: deffn
33941 #: guix-git/doc/guix.texi:19122
33942 #, no-wrap
33943 msgid "{Scheme Variable} enlightenment-desktop-service-type"
33944 msgstr ""
33945
33946 #. type: deffn
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}."
33949 msgstr ""
33950
33951 #. type: deftp
33952 #: guix-git/doc/guix.texi:19127
33953 #, no-wrap
33954 msgid "{Data Type} enlightenment-desktop-service-configuration"
33955 msgstr ""
33956
33957 #. type: item
33958 #: guix-git/doc/guix.texi:19129
33959 #, no-wrap
33960 msgid "@code{enlightenment} (default: @code{enlightenment})"
33961 msgstr ""
33962
33963 #. type: table
33964 #: guix-git/doc/guix.texi:19131
33965 msgid "The enlightenment package to use."
33966 msgstr ""
33967
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}:"
33971 msgstr ""
33972
33973 #. type: lisp
33974 #: guix-git/doc/guix.texi:19150
33975 #, no-wrap
33976 msgid ""
33977 "(use-modules (gnu))\n"
33978 "(use-service-modules desktop)\n"
33979 "(operating-system\n"
33980 " ...\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"
33985 " ...)\n"
33986 msgstr ""
33987
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."
33991 msgstr ""
33992
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."
33996 msgstr ""
33997
33998 #. type: deffn
33999 #: guix-git/doc/guix.texi:19159
34000 #, no-wrap
34001 msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]"
34002 msgstr ""
34003
34004 #. type: deffn
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}."
34007 msgstr ""
34008
34009 #. type: deffn
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."
34012 msgstr ""
34013
34014 #. type: deffn
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)}."
34017 msgstr ""
34018
34019 #. type: deffn
34020 #: guix-git/doc/guix.texi:19173
34021 #, no-wrap
34022 msgid "{Scheme Procedure} elogind-service [#:config @var{config}]"
34023 msgstr ""
34024
34025 #. type: deffn
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."
34028 msgstr ""
34029
34030 #. type: deffn
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."
34033 msgstr ""
34034
34035 #. type: deffn
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:"
34038 msgstr ""
34039
34040 #. type: item
34041 #: guix-git/doc/guix.texi:19190
34042 #, no-wrap
34043 msgid "kill-user-processes?"
34044 msgstr ""
34045
34046 #. type: code{#1}
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
34050 msgid "#f"
34051 msgstr ""
34052
34053 #. type: item
34054 #: guix-git/doc/guix.texi:19192
34055 #, no-wrap
34056 msgid "kill-only-users"
34057 msgstr ""
34058
34059 #. type: code{#1}
34060 #: guix-git/doc/guix.texi:19194 guix-git/doc/guix.texi:19234
34061 msgid "()"
34062 msgstr ""
34063
34064 #. type: item
34065 #: guix-git/doc/guix.texi:19194
34066 #, no-wrap
34067 msgid "kill-exclude-users"
34068 msgstr ""
34069
34070 #. type: code{#1}
34071 #: guix-git/doc/guix.texi:19196
34072 msgid "(\"root\")"
34073 msgstr ""
34074
34075 #. type: item
34076 #: guix-git/doc/guix.texi:19196
34077 #, no-wrap
34078 msgid "inhibit-delay-max-seconds"
34079 msgstr ""
34080
34081 #. type: code{#1}
34082 #: guix-git/doc/guix.texi:19198
34083 msgid "5"
34084 msgstr ""
34085
34086 #. type: item
34087 #: guix-git/doc/guix.texi:19198
34088 #, no-wrap
34089 msgid "handle-power-key"
34090 msgstr ""
34091
34092 #. type: code{#1}
34093 #: guix-git/doc/guix.texi:19200
34094 msgid "poweroff"
34095 msgstr ""
34096
34097 #. type: item
34098 #: guix-git/doc/guix.texi:19200
34099 #, no-wrap
34100 msgid "handle-suspend-key"
34101 msgstr ""
34102
34103 #. type: code{#1}
34104 #: guix-git/doc/guix.texi:19202 guix-git/doc/guix.texi:19206
34105 msgid "suspend"
34106 msgstr ""
34107
34108 #. type: item
34109 #: guix-git/doc/guix.texi:19202
34110 #, no-wrap
34111 msgid "handle-hibernate-key"
34112 msgstr ""
34113
34114 #. type: code{#1}
34115 #: guix-git/doc/guix.texi:19204
34116 msgid "hibernate"
34117 msgstr ""
34118
34119 #. type: item
34120 #: guix-git/doc/guix.texi:19204
34121 #, no-wrap
34122 msgid "handle-lid-switch"
34123 msgstr ""
34124
34125 #. type: item
34126 #: guix-git/doc/guix.texi:19206
34127 #, no-wrap
34128 msgid "handle-lid-switch-docked"
34129 msgstr ""
34130
34131 #. type: code{#1}
34132 #: guix-git/doc/guix.texi:19208 guix-git/doc/guix.texi:19210
34133 #: guix-git/doc/guix.texi:19222
34134 msgid "ignore"
34135 msgstr ""
34136
34137 #. type: item
34138 #: guix-git/doc/guix.texi:19208
34139 #, no-wrap
34140 msgid "handle-lid-switch-external-power"
34141 msgstr ""
34142
34143 #. type: item
34144 #: guix-git/doc/guix.texi:19210
34145 #, no-wrap
34146 msgid "power-key-ignore-inhibited?"
34147 msgstr ""
34148
34149 #. type: item
34150 #: guix-git/doc/guix.texi:19212
34151 #, no-wrap
34152 msgid "suspend-key-ignore-inhibited?"
34153 msgstr ""
34154
34155 #. type: item
34156 #: guix-git/doc/guix.texi:19214
34157 #, no-wrap
34158 msgid "hibernate-key-ignore-inhibited?"
34159 msgstr ""
34160
34161 #. type: item
34162 #: guix-git/doc/guix.texi:19216
34163 #, no-wrap
34164 msgid "lid-switch-ignore-inhibited?"
34165 msgstr ""
34166
34167 #. type: code{#1}
34168 #: guix-git/doc/guix.texi:19218 guix-git/doc/guix.texi:19230
34169 msgid "#t"
34170 msgstr ""
34171
34172 #. type: item
34173 #: guix-git/doc/guix.texi:19218
34174 #, no-wrap
34175 msgid "holdoff-timeout-seconds"
34176 msgstr ""
34177
34178 #. type: code{#1}
34179 #: guix-git/doc/guix.texi:19220
34180 msgid "30"
34181 msgstr ""
34182
34183 #. type: item
34184 #: guix-git/doc/guix.texi:19220
34185 #, no-wrap
34186 msgid "idle-action"
34187 msgstr ""
34188
34189 #. type: item
34190 #: guix-git/doc/guix.texi:19222
34191 #, no-wrap
34192 msgid "idle-action-seconds"
34193 msgstr ""
34194
34195 #. type: code{#1}
34196 #: guix-git/doc/guix.texi:19224
34197 msgid "(* 30 60)"
34198 msgstr ""
34199
34200 #. type: item
34201 #: guix-git/doc/guix.texi:19224
34202 #, no-wrap
34203 msgid "runtime-directory-size-percent"
34204 msgstr ""
34205
34206 #. type: code{#1}
34207 #: guix-git/doc/guix.texi:19226
34208 msgid "10"
34209 msgstr ""
34210
34211 #. type: item
34212 #: guix-git/doc/guix.texi:19226
34213 #, no-wrap
34214 msgid "runtime-directory-size"
34215 msgstr ""
34216
34217 #. type: item
34218 #: guix-git/doc/guix.texi:19228
34219 #, no-wrap
34220 msgid "remove-ipc?"
34221 msgstr ""
34222
34223 #. type: item
34224 #: guix-git/doc/guix.texi:19230
34225 #, no-wrap
34226 msgid "suspend-state"
34227 msgstr ""
34228
34229 #. type: code{#1}
34230 #: guix-git/doc/guix.texi:19232
34231 msgid "(\"mem\" \"standby\" \"freeze\")"
34232 msgstr ""
34233
34234 #. type: item
34235 #: guix-git/doc/guix.texi:19232
34236 #, no-wrap
34237 msgid "suspend-mode"
34238 msgstr ""
34239
34240 #. type: item
34241 #: guix-git/doc/guix.texi:19234
34242 #, no-wrap
34243 msgid "hibernate-state"
34244 msgstr ""
34245
34246 #. type: code{#1}
34247 #: guix-git/doc/guix.texi:19236 guix-git/doc/guix.texi:19240
34248 msgid "(\"disk\")"
34249 msgstr ""
34250
34251 #. type: item
34252 #: guix-git/doc/guix.texi:19236
34253 #, no-wrap
34254 msgid "hibernate-mode"
34255 msgstr ""
34256
34257 #. type: code{#1}
34258 #: guix-git/doc/guix.texi:19238
34259 msgid "(\"platform\" \"shutdown\")"
34260 msgstr ""
34261
34262 #. type: item
34263 #: guix-git/doc/guix.texi:19238
34264 #, no-wrap
34265 msgid "hybrid-sleep-state"
34266 msgstr ""
34267
34268 #. type: item
34269 #: guix-git/doc/guix.texi:19240
34270 #, no-wrap
34271 msgid "hybrid-sleep-mode"
34272 msgstr ""
34273
34274 #. type: code{#1}
34275 #: guix-git/doc/guix.texi:19242
34276 msgid "(\"suspend\" \"platform\" \"shutdown\")"
34277 msgstr ""
34278
34279 #. type: deffn
34280 #: guix-git/doc/guix.texi:19245
34281 #, no-wrap
34282 msgid "{Scheme Procedure} accountsservice-service @"
34283 msgstr ""
34284
34285 #. type: deffn
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."
34288 msgstr ""
34289
34290 #. type: deffn
34291 #: guix-git/doc/guix.texi:19256
34292 msgid "The @var{accountsservice} keyword argument is the @code{accountsservice} package to expose as a service."
34293 msgstr ""
34294
34295 #. type: deffn
34296 #: guix-git/doc/guix.texi:19258
34297 #, no-wrap
34298 msgid "{Scheme Procedure} polkit-service @"
34299 msgstr ""
34300
34301 #. type: deffn
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."
34304 msgstr ""
34305
34306 #. type: defvr
34307 #: guix-git/doc/guix.texi:19269
34308 #, no-wrap
34309 msgid "{Scheme Variable} polkit-wheel-service"
34310 msgstr ""
34311
34312 #. type: defvr
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}."
34315 msgstr ""
34316
34317 #. type: defvr
34318 #: guix-git/doc/guix.texi:19276
34319 #, no-wrap
34320 msgid "{Scheme Variable} upower-service-type"
34321 msgstr ""
34322
34323 #. type: defvr
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."
34326 msgstr ""
34327
34328 #. type: defvr
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."
34331 msgstr ""
34332
34333 #. type: deftp
34334 #: guix-git/doc/guix.texi:19285
34335 #, no-wrap
34336 msgid "{Data Type} upower-configuration"
34337 msgstr ""
34338
34339 #. type: deftp
34340 #: guix-git/doc/guix.texi:19287
34341 msgid "Data type representation the configuration for UPower."
34342 msgstr ""
34343
34344 #. type: item
34345 #: guix-git/doc/guix.texi:19290
34346 #, no-wrap
34347 msgid "@code{upower} (default: @var{upower})"
34348 msgstr ""
34349
34350 #. type: table
34351 #: guix-git/doc/guix.texi:19292
34352 msgid "Package to use for @code{upower}."
34353 msgstr ""
34354
34355 #. type: item
34356 #: guix-git/doc/guix.texi:19293
34357 #, no-wrap
34358 msgid "@code{watts-up-pro?} (default: @code{#f})"
34359 msgstr ""
34360
34361 #. type: table
34362 #: guix-git/doc/guix.texi:19295
34363 msgid "Enable the Watts Up Pro device."
34364 msgstr ""
34365
34366 #. type: item
34367 #: guix-git/doc/guix.texi:19296
34368 #, no-wrap
34369 msgid "@code{poll-batteries?} (default: @code{#t})"
34370 msgstr ""
34371
34372 #. type: table
34373 #: guix-git/doc/guix.texi:19298
34374 msgid "Enable polling the kernel for battery level changes."
34375 msgstr ""
34376
34377 #. type: item
34378 #: guix-git/doc/guix.texi:19299
34379 #, no-wrap
34380 msgid "@code{ignore-lid?} (default: @code{#f})"
34381 msgstr ""
34382
34383 #. type: table
34384 #: guix-git/doc/guix.texi:19301
34385 msgid "Ignore the lid state, this can be useful if it's incorrect on a device."
34386 msgstr ""
34387
34388 #. type: item
34389 #: guix-git/doc/guix.texi:19302
34390 #, no-wrap
34391 msgid "@code{use-percentage-for-policy?} (default: @code{#f})"
34392 msgstr ""
34393
34394 #. type: table
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."
34397 msgstr ""
34398
34399 #. type: item
34400 #: guix-git/doc/guix.texi:19306
34401 #, no-wrap
34402 msgid "@code{percentage-low} (default: @code{10})"
34403 msgstr ""
34404
34405 #. type: table
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."
34408 msgstr ""
34409
34410 #. type: item
34411 #: guix-git/doc/guix.texi:19310
34412 #, no-wrap
34413 msgid "@code{percentage-critical} (default: @code{3})"
34414 msgstr ""
34415
34416 #. type: table
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."
34419 msgstr ""
34420
34421 #. type: item
34422 #: guix-git/doc/guix.texi:19314
34423 #, no-wrap
34424 msgid "@code{percentage-action} (default: @code{2})"
34425 msgstr ""
34426
34427 #. type: table
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."
34430 msgstr ""
34431
34432 #. type: item
34433 #: guix-git/doc/guix.texi:19318
34434 #, no-wrap
34435 msgid "@code{time-low} (default: @code{1200})"
34436 msgstr ""
34437
34438 #. type: table
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."
34441 msgstr ""
34442
34443 #. type: item
34444 #: guix-git/doc/guix.texi:19322
34445 #, no-wrap
34446 msgid "@code{time-critical} (default: @code{300})"
34447 msgstr ""
34448
34449 #. type: table
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."
34452 msgstr ""
34453
34454 #. type: item
34455 #: guix-git/doc/guix.texi:19326
34456 #, no-wrap
34457 msgid "@code{time-action} (default: @code{120})"
34458 msgstr ""
34459
34460 #. type: table
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."
34463 msgstr ""
34464
34465 #. type: item
34466 #: guix-git/doc/guix.texi:19330
34467 #, no-wrap
34468 msgid "@code{critical-power-action} (default: @code{'hybrid-sleep})"
34469 msgstr ""
34470
34471 #. type: table
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?})."
34474 msgstr ""
34475
34476 #. type: table
34477 #: guix-git/doc/guix.texi:19335
34478 msgid "Possible values are:"
34479 msgstr ""
34480
34481 #. type: code{#1}
34482 #: guix-git/doc/guix.texi:19339
34483 msgid "'power-off"
34484 msgstr ""
34485
34486 #. type: code{#1}
34487 #: guix-git/doc/guix.texi:19342
34488 msgid "'hibernate"
34489 msgstr ""
34490
34491 #. type: itemize
34492 #: guix-git/doc/guix.texi:19345
34493 msgid "@code{'hybrid-sleep}."
34494 msgstr ""
34495
34496 #. type: deffn
34497 #: guix-git/doc/guix.texi:19350
34498 #, no-wrap
34499 msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]"
34500 msgstr ""
34501
34502 #. type: deffn
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."
34505 msgstr ""
34506
34507 #. type: deffn
34508 #: guix-git/doc/guix.texi:19362
34509 #, no-wrap
34510 msgid "{Scheme Variable} colord-service-type"
34511 msgstr ""
34512
34513 #. type: deffn
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."
34516 msgstr ""
34517
34518 #. type: cindex
34519 #: guix-git/doc/guix.texi:19371
34520 #, no-wrap
34521 msgid "scanner access"
34522 msgstr ""
34523
34524 #. type: defvr
34525 #: guix-git/doc/guix.texi:19372
34526 #, no-wrap
34527 msgid "{Scheme Variable} sane-service-type"
34528 msgstr ""
34529
34530 #. type: defvr
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."
34533 msgstr ""
34534
34535 #. type: defvr
34536 #: guix-git/doc/guix.texi:19380
34537 #, no-wrap
34538 msgid "{Scheme Variable} sane-backends-minimal"
34539 msgstr ""
34540
34541 #. type: defvr
34542 #: guix-git/doc/guix.texi:19383
34543 msgid "The default package which the @code{sane-service-type} installs. It supports many recent scanners."
34544 msgstr ""
34545
34546 #. type: defvr
34547 #: guix-git/doc/guix.texi:19385
34548 #, no-wrap
34549 msgid "{Scheme Variable} sane-backends"
34550 msgstr ""
34551
34552 #. type: defvr
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:"
34555 msgstr ""
34556
34557 #. type: lisp
34558 #: guix-git/doc/guix.texi:19401
34559 #, no-wrap
34560 msgid ""
34561 "(use-modules (gnu))\n"
34562 "(use-service-modules\n"
34563 " @dots{}\n"
34564 " desktop)\n"
34565 "(use-package-modules\n"
34566 " @dots{}\n"
34567 " scanner)\n"
34568 "\n"
34569 msgstr ""
34570
34571 #. type: lisp
34572 #: guix-git/doc/guix.texi:19406
34573 #, no-wrap
34574 msgid ""
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"
34579 "\n"
34580 msgstr ""
34581
34582 #. type: lisp
34583 #: guix-git/doc/guix.texi:19410
34584 #, no-wrap
34585 msgid ""
34586 "(operating-system\n"
34587 " @dots{}\n"
34588 " (services %my-desktop-services)\n"
34589 msgstr ""
34590
34591 #. type: deffn
34592 #: guix-git/doc/guix.texi:19413
34593 #, no-wrap
34594 msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]"
34595 msgstr ""
34596
34597 #. type: deffn
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."
34600 msgstr ""
34601
34602 #. type: defvr
34603 #: guix-git/doc/guix.texi:19424
34604 #, no-wrap
34605 msgid "{Scheme Variable} %standard-geoclue-applications"
34606 msgstr ""
34607
34608 #. type: defvr
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."
34611 msgstr ""
34612
34613 #. type: deffn
34614 #: guix-git/doc/guix.texi:19433
34615 #, no-wrap
34616 msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @"
34617 msgstr ""
34618
34619 #. type: deffn
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."
34622 msgstr ""
34623
34624 #. type: deffn
34625 #: guix-git/doc/guix.texi:19448
34626 #, no-wrap
34627 msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @"
34628 msgstr ""
34629
34630 #. type: deffn
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."
34633 msgstr ""
34634
34635 #. type: deffn
34636 #: guix-git/doc/guix.texi:19457
34637 msgid "Users need to be in the @code{lp} group to access the D-Bus service."
34638 msgstr ""
34639
34640 #. type: defvr
34641 #: guix-git/doc/guix.texi:19459
34642 #, no-wrap
34643 msgid "{Scheme Variable} gnome-keyring-service-type"
34644 msgstr ""
34645
34646 #. type: defvr
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)."
34649 msgstr ""
34650
34651 #. type: defvr
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."
34654 msgstr ""
34655
34656 #. type: deftp
34657 #: guix-git/doc/guix.texi:19469
34658 #, no-wrap
34659 msgid "{Data Type} gnome-keyring-configuration"
34660 msgstr ""
34661
34662 #. type: deftp
34663 #: guix-git/doc/guix.texi:19471
34664 msgid "Configuration record for the GNOME Keyring service."
34665 msgstr ""
34666
34667 #. type: item
34668 #: guix-git/doc/guix.texi:19473
34669 #, no-wrap
34670 msgid "@code{keyring} (default: @code{gnome-keyring})"
34671 msgstr ""
34672
34673 #. type: table
34674 #: guix-git/doc/guix.texi:19475
34675 msgid "The GNOME keyring package to use."
34676 msgstr ""
34677
34678 #. type: code{#1}
34679 #: guix-git/doc/guix.texi:19476
34680 #, no-wrap
34681 msgid "pam-services"
34682 msgstr ""
34683
34684 #. type: table
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}."
34687 msgstr ""
34688
34689 #. type: table
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."
34692 msgstr ""
34693
34694 #. type: table
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}."
34697 msgstr ""
34698
34699 #. type: cindex
34700 #: guix-git/doc/guix.texi:19497
34701 #, no-wrap
34702 msgid "sound support"
34703 msgstr ""
34704
34705 #. type: cindex
34706 #: guix-git/doc/guix.texi:19498
34707 #, no-wrap
34708 msgid "ALSA"
34709 msgstr ""
34710
34711 #. type: cindex
34712 #: guix-git/doc/guix.texi:19499
34713 #, no-wrap
34714 msgid "PulseAudio, sound support"
34715 msgstr ""
34716
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."
34720 msgstr ""
34721
34722 #. type: deffn
34723 #: guix-git/doc/guix.texi:19505
34724 #, no-wrap
34725 msgid "{Scheme Variable} alsa-service-type"
34726 msgstr ""
34727
34728 #. type: deffn
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:"
34731 msgstr ""
34732
34733 #. type: lisp
34734 #: guix-git/doc/guix.texi:19513
34735 #, no-wrap
34736 msgid "(service alsa-service-type)\n"
34737 msgstr ""
34738
34739 #. type: deffn
34740 #: guix-git/doc/guix.texi:19516
34741 msgid "See below for details about @code{alsa-configuration}."
34742 msgstr ""
34743
34744 #. type: deftp
34745 #: guix-git/doc/guix.texi:19518
34746 #, no-wrap
34747 msgid "{Data Type} alsa-configuration"
34748 msgstr ""
34749
34750 #. type: deftp
34751 #: guix-git/doc/guix.texi:19520
34752 msgid "Data type representing the configuration for @code{alsa-service}."
34753 msgstr ""
34754
34755 #. type: item
34756 #: guix-git/doc/guix.texi:19522
34757 #, no-wrap
34758 msgid "@code{alsa-plugins} (default: @var{alsa-plugins})"
34759 msgstr ""
34760
34761 #. type: table
34762 #: guix-git/doc/guix.texi:19524
34763 msgid "@code{alsa-plugins} package to use."
34764 msgstr ""
34765
34766 #. type: item
34767 #: guix-git/doc/guix.texi:19525
34768 #, no-wrap
34769 msgid "@code{pulseaudio?} (default: @var{#t})"
34770 msgstr ""
34771
34772 #. type: table
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."
34775 msgstr ""
34776
34777 #. type: table
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."
34780 msgstr ""
34781
34782 #. type: item
34783 #: guix-git/doc/guix.texi:19533
34784 #, no-wrap
34785 msgid "@code{extra-options} (default: @var{\"\"})"
34786 msgstr ""
34787
34788 #. type: table
34789 #: guix-git/doc/guix.texi:19535
34790 msgid "String to append to the @file{/etc/asound.conf} file."
34791 msgstr ""
34792
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:"
34796 msgstr ""
34797
34798 #. type: example
34799 #: guix-git/doc/guix.texi:19547
34800 #, no-wrap
34801 msgid ""
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"
34805 "@}\n"
34806 "\n"
34807 msgstr ""
34808
34809 #. type: example
34810 #: guix-git/doc/guix.texi:19556
34811 #, no-wrap
34812 msgid ""
34813 "# Routing ALSA to jack:\n"
34814 "# <http://jackaudio.org/faq/routing_alsa.html>.\n"
34815 "pcm.rawjack @{\n"
34816 " type jack\n"
34817 " playback_ports @{\n"
34818 " 0 system:playback_1\n"
34819 " 1 system:playback_2\n"
34820 " @}\n"
34821 "\n"
34822 msgstr ""
34823
34824 #. type: example
34825 #: guix-git/doc/guix.texi:19562
34826 #, no-wrap
34827 msgid ""
34828 " capture_ports @{\n"
34829 " 0 system:capture_1\n"
34830 " 1 system:capture_2\n"
34831 " @}\n"
34832 "@}\n"
34833 "\n"
34834 msgstr ""
34835
34836 #. type: example
34837 #: guix-git/doc/guix.texi:19569
34838 #, no-wrap
34839 msgid ""
34840 "pcm.!default @{\n"
34841 " type plug\n"
34842 " slave @{\n"
34843 " pcm \"rawjack\"\n"
34844 " @}\n"
34845 "@}\n"
34846 msgstr ""
34847
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."
34851 msgstr ""
34852
34853 #. type: deffn
34854 #: guix-git/doc/guix.texi:19574
34855 #, no-wrap
34856 msgid "{Scheme Variable} pulseaudio-service-type"
34857 msgstr ""
34858
34859 #. type: deffn
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."
34862 msgstr ""
34863
34864 #. type: quotation
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}."
34867 msgstr ""
34868
34869 #. type: quotation
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."
34872 msgstr ""
34873
34874 #. type: deftp
34875 #: guix-git/doc/guix.texi:19595
34876 #, no-wrap
34877 msgid "{Data Type} pulseaudio-configuration"
34878 msgstr ""
34879
34880 #. type: deftp
34881 #: guix-git/doc/guix.texi:19597
34882 msgid "Data type representing the configuration for @code{pulseaudio-service}."
34883 msgstr ""
34884
34885 #. type: item
34886 #: guix-git/doc/guix.texi:19599
34887 #, no-wrap
34888 msgid "@code{client-conf} (default: @code{'()})"
34889 msgstr ""
34890
34891 #. type: table
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."
34894 msgstr ""
34895
34896 #. type: item
34897 #: guix-git/doc/guix.texi:19605
34898 #, no-wrap
34899 msgid "@code{daemon-conf} (default: @code{'((flat-volumes . no))})"
34900 msgstr ""
34901
34902 #. type: table
34903 #: guix-git/doc/guix.texi:19608
34904 msgid "List of settings to set in @file{daemon.conf}, formatted just like @var{client-conf}."
34905 msgstr ""
34906
34907 #. type: item
34908 #: guix-git/doc/guix.texi:19609
34909 #, no-wrap
34910 msgid "@code{script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/default.pa\")})"
34911 msgstr ""
34912
34913 #. type: table
34914 #: guix-git/doc/guix.texi:19611
34915 msgid "Script file to use as @file{default.pa}."
34916 msgstr ""
34917
34918 #. type: item
34919 #: guix-git/doc/guix.texi:19612
34920 #, no-wrap
34921 msgid "@code{system-script-file} (default: @code{(file-append pulseaudio \"/etc/pulse/system.pa\")})"
34922 msgstr ""
34923
34924 #. type: table
34925 #: guix-git/doc/guix.texi:19614
34926 msgid "Script file to use as @file{system.pa}."
34927 msgstr ""
34928
34929 #. type: deffn
34930 #: guix-git/doc/guix.texi:19617
34931 #, no-wrap
34932 msgid "{Scheme Variable} ladspa-service-type"
34933 msgstr ""
34934
34935 #. type: deffn
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."
34938 msgstr ""
34939
34940 #. type: deffn
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:"
34943 msgstr ""
34944
34945 #. type: lisp
34946 #: guix-git/doc/guix.texi:19627
34947 #, no-wrap
34948 msgid ""
34949 "(service ladspa-service-type\n"
34950 " (ladspa-configuration (plugins (list swh-plugins))))\n"
34951 msgstr ""
34952
34953 #. type: deffn
34954 #: guix-git/doc/guix.texi:19631
34955 msgid "See @uref{http://plugin.org.uk/ladspa-swh/docs/ladspa-swh.html} for the details."
34956 msgstr ""
34957
34958 #. type: cindex
34959 #: guix-git/doc/guix.texi:19638
34960 #, no-wrap
34961 msgid "SQL"
34962 msgstr ""
34963
34964 #. type: Plain text
34965 #: guix-git/doc/guix.texi:19640
34966 msgid "The @code{(gnu services databases)} module provides the following services."
34967 msgstr ""
34968
34969 #. type: subsubheading
34970 #: guix-git/doc/guix.texi:19641
34971 #, no-wrap
34972 msgid "PostgreSQL"
34973 msgstr ""
34974
34975 #. type: Plain text
34976 #: guix-git/doc/guix.texi:19645
34977 msgid "The following example describes a PostgreSQL service with the default configuration."
34978 msgstr ""
34979
34980 #. type: lisp
34981 #: guix-git/doc/guix.texi:19650
34982 #, no-wrap
34983 msgid ""
34984 "(service postgresql-service-type\n"
34985 " (postgresql-configuration\n"
34986 " (postgresql postgresql-10)))\n"
34987 msgstr ""
34988
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."
34992 msgstr ""
34993
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."
34997 msgstr ""
34998
34999 #. type: example
35000 #: guix-git/doc/guix.texi:19668
35001 #, no-wrap
35002 msgid ""
35003 "sudo -u postgres -s /bin/sh\n"
35004 "createuser --interactive\n"
35005 "createdb $MY_USER_LOGIN # Replace appropriately.\n"
35006 msgstr ""
35007
35008 #. type: deftp
35009 #: guix-git/doc/guix.texi:19670
35010 #, no-wrap
35011 msgid "{Data Type} postgresql-configuration"
35012 msgstr ""
35013
35014 #. type: deftp
35015 #: guix-git/doc/guix.texi:19673
35016 msgid "Data type representing the configuration for the @code{postgresql-service-type}."
35017 msgstr ""
35018
35019 #. type: code{#1}
35020 #: guix-git/doc/guix.texi:19675
35021 #, no-wrap
35022 msgid "postgresql"
35023 msgstr ""
35024
35025 #. type: table
35026 #: guix-git/doc/guix.texi:19677
35027 msgid "PostgreSQL package to use for the service."
35028 msgstr ""
35029
35030 #. type: item
35031 #: guix-git/doc/guix.texi:19678
35032 #, no-wrap
35033 msgid "@code{port} (default: @code{5432})"
35034 msgstr ""
35035
35036 #. type: table
35037 #: guix-git/doc/guix.texi:19680
35038 msgid "Port on which PostgreSQL should listen."
35039 msgstr ""
35040
35041 #. type: table
35042 #: guix-git/doc/guix.texi:19683
35043 msgid "Locale to use as the default when creating the database cluster."
35044 msgstr ""
35045
35046 #. type: item
35047 #: guix-git/doc/guix.texi:19684
35048 #, no-wrap
35049 msgid "@code{config-file} (default: @code{(postgresql-config-file)})"
35050 msgstr ""
35051
35052 #. type: table
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."
35055 msgstr ""
35056
35057 #. type: item
35058 #: guix-git/doc/guix.texi:19689
35059 #, no-wrap
35060 msgid "@code{log-directory} (default: @code{\"/var/log/postgresql\"})"
35061 msgstr ""
35062
35063 #. type: table
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."
35066 msgstr ""
35067
35068 #. type: item
35069 #: guix-git/doc/guix.texi:19694
35070 #, no-wrap
35071 msgid "@code{data-directory} (default: @code{\"/var/lib/postgresql/data\"})"
35072 msgstr ""
35073
35074 #. type: table
35075 #: guix-git/doc/guix.texi:19696
35076 msgid "Directory in which to store the data."
35077 msgstr ""
35078
35079 #. type: item
35080 #: guix-git/doc/guix.texi:19697
35081 #, no-wrap
35082 msgid "@code{extension-packages} (default: @code{'()})"
35083 msgstr ""
35084
35085 #. type: cindex
35086 #: guix-git/doc/guix.texi:19698
35087 #, no-wrap
35088 msgid "postgresql extension-packages"
35089 msgstr ""
35090
35091 #. type: table
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:"
35094 msgstr ""
35095
35096 #. type: cindex
35097 #: guix-git/doc/guix.texi:19704
35098 #, no-wrap
35099 msgid "postgis"
35100 msgstr ""
35101
35102 #. type: lisp
35103 #: guix-git/doc/guix.texi:19707
35104 #, no-wrap
35105 msgid ""
35106 "(use-package-modules databases geo)\n"
35107 "\n"
35108 msgstr ""
35109
35110 #. type: lisp
35111 #: guix-git/doc/guix.texi:19720
35112 #, no-wrap
35113 msgid ""
35114 "(operating-system\n"
35115 " ...\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"
35119 " (services\n"
35120 " (cons*\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"
35126 msgstr ""
35127
35128 #. type: table
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:"
35131 msgstr ""
35132
35133 #. type: example
35134 #: guix-git/doc/guix.texi:19731
35135 #, no-wrap
35136 msgid ""
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"
35142 msgstr ""
35143
35144 #. type: table
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."
35147 msgstr ""
35148
35149 #. type: deftp
35150 #: guix-git/doc/guix.texi:19740
35151 #, no-wrap
35152 msgid "{Data Type} postgresql-config-file"
35153 msgstr ""
35154
35155 #. type: deftp
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."
35158 msgstr ""
35159
35160 #. type: lisp
35161 #: guix-git/doc/guix.texi:19766
35162 #, no-wrap
35163 msgid ""
35164 "(service postgresql-service-type\n"
35165 " (postgresql-configuration\n"
35166 " (config-file\n"
35167 " (postgresql-config-file\n"
35168 " (log-destination \"stderr\")\n"
35169 " (hba-file\n"
35170 " (plain-file \"pg_hba.conf\"\n"
35171 " \"\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"
35175 " (extra-config\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"
35182 msgstr ""
35183
35184 #. type: item
35185 #: guix-git/doc/guix.texi:19769
35186 #, no-wrap
35187 msgid "@code{log-destination} (default: @code{\"syslog\"})"
35188 msgstr ""
35189
35190 #. type: table
35191 #: guix-git/doc/guix.texi:19772
35192 msgid "The logging method to use for PostgreSQL@. Multiple values are accepted, separated by commas."
35193 msgstr ""
35194
35195 #. type: item
35196 #: guix-git/doc/guix.texi:19773
35197 #, no-wrap
35198 msgid "@code{hba-file} (default: @code{%default-postgres-hba})"
35199 msgstr ""
35200
35201 #. type: table
35202 #: guix-git/doc/guix.texi:19776
35203 msgid "Filename or G-expression for the host-based authentication configuration."
35204 msgstr ""
35205
35206 #. type: item
35207 #: guix-git/doc/guix.texi:19777
35208 #, no-wrap
35209 msgid "@code{ident-file} (default: @code{%default-postgres-ident})"
35210 msgstr ""
35211
35212 #. type: table
35213 #: guix-git/doc/guix.texi:19779
35214 msgid "Filename or G-expression for the user name mapping configuration."
35215 msgstr ""
35216
35217 #. type: item
35218 #: guix-git/doc/guix.texi:19780
35219 #, no-wrap
35220 msgid "@code{socket-directory} (default: @code{#false})"
35221 msgstr ""
35222
35223 #. type: table
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."
35226 msgstr ""
35227
35228 #. type: table
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}."
35231 msgstr ""
35232
35233 #. type: table
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."
35236 msgstr ""
35237
35238 #. type: table
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}."
35241 msgstr ""
35242
35243 #. type: deffn
35244 #: guix-git/doc/guix.texi:19803
35245 #, no-wrap
35246 msgid "{Scheme Variable} postgresql-role-service-type"
35247 msgstr ""
35248
35249 #. type: deffn
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."
35252 msgstr ""
35253
35254 #. type: lisp
35255 #: guix-git/doc/guix.texi:19814
35256 #, no-wrap
35257 msgid ""
35258 "(service postgresql-role-service-type\n"
35259 " (postgresql-role-configuration\n"
35260 " (roles\n"
35261 " (list (postgresql-role\n"
35262 " (name \"test\")\n"
35263 " (create-database? #t))))))\n"
35264 msgstr ""
35265
35266 #. type: deffn
35267 #: guix-git/doc/guix.texi:19818
35268 msgid "This service can be extended with extra roles, as in this example:"
35269 msgstr ""
35270
35271 #. type: lisp
35272 #: guix-git/doc/guix.texi:19824
35273 #, no-wrap
35274 msgid ""
35275 "(service-extension postgresql-role-service-type\n"
35276 " (const (postgresql-role\n"
35277 " (name \"alice\")\n"
35278 " (create-database? #t))))\n"
35279 msgstr ""
35280
35281 #. type: deftp
35282 #: guix-git/doc/guix.texi:19827
35283 #, no-wrap
35284 msgid "{Data Type} postgresql-role"
35285 msgstr ""
35286
35287 #. type: deftp
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."
35290 msgstr ""
35291
35292 #. type: table
35293 #: guix-git/doc/guix.texi:19837
35294 msgid "The role name."
35295 msgstr ""
35296
35297 #. type: item
35298 #: guix-git/doc/guix.texi:19838
35299 #, no-wrap
35300 msgid "@code{permissions} (default: @code{'(createdb login)})"
35301 msgstr ""
35302
35303 #. type: table
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}."
35306 msgstr ""
35307
35308 #. type: item
35309 #: guix-git/doc/guix.texi:19843
35310 #, no-wrap
35311 msgid "@code{create-database?} (default: @code{#f})"
35312 msgstr ""
35313
35314 #. type: table
35315 #: guix-git/doc/guix.texi:19845
35316 msgid "Whether to create a database with the same name as the role."
35317 msgstr ""
35318
35319 #. type: deftp
35320 #: guix-git/doc/guix.texi:19849
35321 #, no-wrap
35322 msgid "{Data Type} postgresql-role-configuration"
35323 msgstr ""
35324
35325 #. type: deftp
35326 #: guix-git/doc/guix.texi:19852
35327 msgid "Data type representing the configuration of @var{postgresql-role-service-type}."
35328 msgstr ""
35329
35330 #. type: item
35331 #: guix-git/doc/guix.texi:19854
35332 #, no-wrap
35333 msgid "@code{host} (default: @code{\"/var/run/postgresql\"})"
35334 msgstr ""
35335
35336 #. type: table
35337 #: guix-git/doc/guix.texi:19856
35338 msgid "The PostgreSQL host to connect to."
35339 msgstr ""
35340
35341 #. type: item
35342 #: guix-git/doc/guix.texi:19857
35343 #, no-wrap
35344 msgid "@code{log} (default: @code{\"/var/log/postgresql_roles.log\"})"
35345 msgstr ""
35346
35347 #. type: table
35348 #: guix-git/doc/guix.texi:19859
35349 msgid "File name of the log file."
35350 msgstr ""
35351
35352 #. type: item
35353 #: guix-git/doc/guix.texi:19860
35354 #, no-wrap
35355 msgid "@code{roles} (default: @code{'()})"
35356 msgstr ""
35357
35358 #. type: table
35359 #: guix-git/doc/guix.texi:19862
35360 msgid "The initial PostgreSQL roles to create."
35361 msgstr ""
35362
35363 #. type: subsubheading
35364 #: guix-git/doc/guix.texi:19865
35365 #, no-wrap
35366 msgid "MariaDB/MySQL"
35367 msgstr ""
35368
35369 #. type: defvr
35370 #: guix-git/doc/guix.texi:19867
35371 #, no-wrap
35372 msgid "{Scheme Variable} mysql-service-type"
35373 msgstr ""
35374
35375 #. type: defvr
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."
35378 msgstr ""
35379
35380 #. type: deftp
35381 #: guix-git/doc/guix.texi:19873
35382 #, no-wrap
35383 msgid "{Data Type} mysql-configuration"
35384 msgstr ""
35385
35386 #. type: deftp
35387 #: guix-git/doc/guix.texi:19875
35388 msgid "Data type representing the configuration of @var{mysql-service-type}."
35389 msgstr ""
35390
35391 #. type: item
35392 #: guix-git/doc/guix.texi:19877
35393 #, no-wrap
35394 msgid "@code{mysql} (default: @var{mariadb})"
35395 msgstr ""
35396
35397 #. type: table
35398 #: guix-git/doc/guix.texi:19880
35399 msgid "Package object of the MySQL database server, can be either @var{mariadb} or @var{mysql}."
35400 msgstr ""
35401
35402 #. type: table
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."
35405 msgstr ""
35406
35407 #. type: item
35408 #: guix-git/doc/guix.texi:19884 guix-git/doc/guix.texi:23430
35409 #, no-wrap
35410 msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})"
35411 msgstr ""
35412
35413 #. type: table
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."
35416 msgstr ""
35417
35418 #. type: item
35419 #: guix-git/doc/guix.texi:19888
35420 #, no-wrap
35421 msgid "@code{port} (default: @code{3306})"
35422 msgstr ""
35423
35424 #. type: table
35425 #: guix-git/doc/guix.texi:19890
35426 msgid "TCP port on which the database server listens for incoming connections."
35427 msgstr ""
35428
35429 #. type: item
35430 #: guix-git/doc/guix.texi:19891
35431 #, no-wrap
35432 msgid "@code{socket} (default: @code{\"/run/mysqld/mysqld.sock\"})"
35433 msgstr ""
35434
35435 #. type: table
35436 #: guix-git/doc/guix.texi:19893
35437 msgid "Socket file to use for local (non-network) connections."
35438 msgstr ""
35439
35440 #. type: table
35441 #: guix-git/doc/guix.texi:19896
35442 msgid "Additional settings for the @file{my.cnf} configuration file."
35443 msgstr ""
35444
35445 #. type: item
35446 #: guix-git/doc/guix.texi:19897
35447 #, no-wrap
35448 msgid "@code{auto-upgrade?} (default: @code{#t})"
35449 msgstr ""
35450
35451 #. type: table
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."
35454 msgstr ""
35455
35456 #. type: subsubheading
35457 #: guix-git/doc/guix.texi:19906
35458 #, no-wrap
35459 msgid "Memcached"
35460 msgstr ""
35461
35462 #. type: defvr
35463 #: guix-git/doc/guix.texi:19908
35464 #, no-wrap
35465 msgid "{Scheme Variable} memcached-service-type"
35466 msgstr ""
35467
35468 #. type: defvr
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."
35471 msgstr ""
35472
35473 #. type: lisp
35474 #: guix-git/doc/guix.texi:19916
35475 #, no-wrap
35476 msgid "(service memcached-service-type)\n"
35477 msgstr ""
35478
35479 #. type: deftp
35480 #: guix-git/doc/guix.texi:19918
35481 #, no-wrap
35482 msgid "{Data Type} memcached-configuration"
35483 msgstr ""
35484
35485 #. type: deftp
35486 #: guix-git/doc/guix.texi:19920
35487 msgid "Data type representing the configuration of memcached."
35488 msgstr ""
35489
35490 #. type: item
35491 #: guix-git/doc/guix.texi:19922
35492 #, no-wrap
35493 msgid "@code{memcached} (default: @code{memcached})"
35494 msgstr ""
35495
35496 #. type: table
35497 #: guix-git/doc/guix.texi:19924
35498 msgid "The Memcached package to use."
35499 msgstr ""
35500
35501 #. type: item
35502 #: guix-git/doc/guix.texi:19925
35503 #, no-wrap
35504 msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})"
35505 msgstr ""
35506
35507 #. type: table
35508 #: guix-git/doc/guix.texi:19927
35509 msgid "Network interfaces on which to listen."
35510 msgstr ""
35511
35512 #. type: item
35513 #: guix-git/doc/guix.texi:19928
35514 #, no-wrap
35515 msgid "@code{tcp-port} (default: @code{11211})"
35516 msgstr ""
35517
35518 #. type: table
35519 #: guix-git/doc/guix.texi:19930
35520 msgid "Port on which to accept connections."
35521 msgstr ""
35522
35523 #. type: item
35524 #: guix-git/doc/guix.texi:19931
35525 #, no-wrap
35526 msgid "@code{udp-port} (default: @code{11211})"
35527 msgstr ""
35528
35529 #. type: table
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."
35532 msgstr ""
35533
35534 #. type: item
35535 #: guix-git/doc/guix.texi:19935
35536 #, no-wrap
35537 msgid "@code{additional-options} (default: @code{'()})"
35538 msgstr ""
35539
35540 #. type: table
35541 #: guix-git/doc/guix.texi:19937
35542 msgid "Additional command line options to pass to @code{memcached}."
35543 msgstr ""
35544
35545 #. type: subsubheading
35546 #: guix-git/doc/guix.texi:19940
35547 #, no-wrap
35548 msgid "Redis"
35549 msgstr ""
35550
35551 #. type: defvr
35552 #: guix-git/doc/guix.texi:19942
35553 #, no-wrap
35554 msgid "{Scheme Variable} redis-service-type"
35555 msgstr ""
35556
35557 #. type: defvr
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."
35560 msgstr ""
35561
35562 #. type: deftp
35563 #: guix-git/doc/guix.texi:19947
35564 #, no-wrap
35565 msgid "{Data Type} redis-configuration"
35566 msgstr ""
35567
35568 #. type: deftp
35569 #: guix-git/doc/guix.texi:19949
35570 msgid "Data type representing the configuration of redis."
35571 msgstr ""
35572
35573 #. type: item
35574 #: guix-git/doc/guix.texi:19951
35575 #, no-wrap
35576 msgid "@code{redis} (default: @code{redis})"
35577 msgstr ""
35578
35579 #. type: table
35580 #: guix-git/doc/guix.texi:19953
35581 msgid "The Redis package to use."
35582 msgstr ""
35583
35584 #. type: item
35585 #: guix-git/doc/guix.texi:19954
35586 #, no-wrap
35587 msgid "@code{bind} (default: @code{\"127.0.0.1\"})"
35588 msgstr ""
35589
35590 #. type: table
35591 #: guix-git/doc/guix.texi:19956
35592 msgid "Network interface on which to listen."
35593 msgstr ""
35594
35595 #. type: item
35596 #: guix-git/doc/guix.texi:19957
35597 #, no-wrap
35598 msgid "@code{port} (default: @code{6379})"
35599 msgstr ""
35600
35601 #. type: table
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."
35604 msgstr ""
35605
35606 #. type: item
35607 #: guix-git/doc/guix.texi:19961
35608 #, no-wrap
35609 msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})"
35610 msgstr ""
35611
35612 #. type: table
35613 #: guix-git/doc/guix.texi:19963
35614 msgid "Directory in which to store the database and related files."
35615 msgstr ""
35616
35617 #. type: cindex
35618 #: guix-git/doc/guix.texi:19969
35619 #, no-wrap
35620 msgid "mail"
35621 msgstr ""
35622
35623 #. type: cindex
35624 #: guix-git/doc/guix.texi:19970
35625 #, no-wrap
35626 msgid "email"
35627 msgstr ""
35628
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."
35632 msgstr ""
35633
35634 #. type: subsubheading
35635 #: guix-git/doc/guix.texi:19976
35636 #, no-wrap
35637 msgid "Dovecot Service"
35638 msgstr ""
35639
35640 #. type: deffn
35641 #: guix-git/doc/guix.texi:19978
35642 #, no-wrap
35643 msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]"
35644 msgstr ""
35645
35646 #. type: deffn
35647 #: guix-git/doc/guix.texi:19980
35648 msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server."
35649 msgstr ""
35650
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."
35654 msgstr ""
35655
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:"
35659 msgstr ""
35660
35661 #. type: lisp
35662 #: guix-git/doc/guix.texi:19998
35663 #, no-wrap
35664 msgid ""
35665 "(dovecot-service #:config\n"
35666 " (dovecot-configuration\n"
35667 " (mail-location \"maildir:~/.mail\")))\n"
35668 msgstr ""
35669
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."
35673 msgstr ""
35674
35675 #. type: Plain text
35676 #: guix-git/doc/guix.texi:20016
35677 msgid "Available @code{dovecot-configuration} fields are:"
35678 msgstr ""
35679
35680 #. type: deftypevr
35681 #: guix-git/doc/guix.texi:20017
35682 #, no-wrap
35683 msgid "{@code{dovecot-configuration} parameter} package dovecot"
35684 msgstr ""
35685
35686 #. type: deftypevr
35687 #: guix-git/doc/guix.texi:20019 guix-git/doc/guix.texi:21325
35688 msgid "The dovecot package."
35689 msgstr ""
35690
35691 #. type: deftypevr
35692 #: guix-git/doc/guix.texi:20021
35693 #, no-wrap
35694 msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen"
35695 msgstr ""
35696
35697 #. type: deftypevr
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."
35700 msgstr ""
35701
35702 #. type: deftypevr
35703 #: guix-git/doc/guix.texi:20029
35704 #, no-wrap
35705 msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols"
35706 msgstr ""
35707
35708 #. type: deftypevr
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}."
35711 msgstr ""
35712
35713 #. type: deftypevr
35714 #: guix-git/doc/guix.texi:20034
35715 msgid "Available @code{protocol-configuration} fields are:"
35716 msgstr ""
35717
35718 #. type: deftypevr
35719 #: guix-git/doc/guix.texi:20035
35720 #, no-wrap
35721 msgid "{@code{protocol-configuration} parameter} string name"
35722 msgstr ""
35723
35724 #. type: deftypevr
35725 #: guix-git/doc/guix.texi:20037
35726 msgid "The name of the protocol."
35727 msgstr ""
35728
35729 #. type: deftypevr
35730 #: guix-git/doc/guix.texi:20039
35731 #, no-wrap
35732 msgid "{@code{protocol-configuration} parameter} string auth-socket-path"
35733 msgstr ""
35734
35735 #. type: deftypevr
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\"}."
35738 msgstr ""
35739
35740 #. type: deftypevr
35741 #: guix-git/doc/guix.texi:20045
35742 #, no-wrap
35743 msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins"
35744 msgstr ""
35745
35746 #. type: deftypevr
35747 #: guix-git/doc/guix.texi:20047
35748 msgid "Space separated list of plugins to load."
35749 msgstr ""
35750
35751 #. type: deftypevr
35752 #: guix-git/doc/guix.texi:20049
35753 #, no-wrap
35754 msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections"
35755 msgstr ""
35756
35757 #. type: deftypevr
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}."
35760 msgstr ""
35761
35762 #. type: deftypevr
35763 #: guix-git/doc/guix.texi:20057
35764 #, no-wrap
35765 msgid "{@code{dovecot-configuration} parameter} service-configuration-list services"
35766 msgstr ""
35767
35768 #. type: deftypevr
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}."
35771 msgstr ""
35772
35773 #. type: deftypevr
35774 #: guix-git/doc/guix.texi:20063
35775 msgid "Available @code{service-configuration} fields are:"
35776 msgstr ""
35777
35778 #. type: deftypevr
35779 #: guix-git/doc/guix.texi:20064
35780 #, no-wrap
35781 msgid "{@code{service-configuration} parameter} string kind"
35782 msgstr ""
35783
35784 #. type: deftypevr
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."
35787 msgstr ""
35788
35789 #. type: deftypevr
35790 #: guix-git/doc/guix.texi:20071
35791 #, no-wrap
35792 msgid "{@code{service-configuration} parameter} listener-configuration-list listeners"
35793 msgstr ""
35794
35795 #. type: deftypevr
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{()}."
35798 msgstr ""
35799
35800 #. type: deftypevr
35801 #: guix-git/doc/guix.texi:20078
35802 msgid "Available @code{unix-listener-configuration} fields are:"
35803 msgstr ""
35804
35805 #. type: deftypevr
35806 #: guix-git/doc/guix.texi:20079
35807 #, no-wrap
35808 msgid "{@code{unix-listener-configuration} parameter} string path"
35809 msgstr ""
35810
35811 #. type: deftypevr
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."
35814 msgstr ""
35815
35816 #. type: deftypevr
35817 #: guix-git/doc/guix.texi:20084
35818 #, no-wrap
35819 msgid "{@code{unix-listener-configuration} parameter} string mode"
35820 msgstr ""
35821
35822 #. type: deftypevr
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\"}."
35825 msgstr ""
35826
35827 #. type: deftypevr
35828 #: guix-git/doc/guix.texi:20089
35829 #, no-wrap
35830 msgid "{@code{unix-listener-configuration} parameter} string user"
35831 msgstr ""
35832
35833 #. type: deftypevr
35834 #: guix-git/doc/guix.texi:20092 guix-git/doc/guix.texi:20115
35835 msgid "The user to own the socket. Defaults to @samp{\"\"}."
35836 msgstr ""
35837
35838 #. type: deftypevr
35839 #: guix-git/doc/guix.texi:20094
35840 #, no-wrap
35841 msgid "{@code{unix-listener-configuration} parameter} string group"
35842 msgstr ""
35843
35844 #. type: deftypevr
35845 #: guix-git/doc/guix.texi:20097 guix-git/doc/guix.texi:20120
35846 msgid "The group to own the socket. Defaults to @samp{\"\"}."
35847 msgstr ""
35848
35849 #. type: deftypevr
35850 #: guix-git/doc/guix.texi:20101
35851 msgid "Available @code{fifo-listener-configuration} fields are:"
35852 msgstr ""
35853
35854 #. type: deftypevr
35855 #: guix-git/doc/guix.texi:20102
35856 #, no-wrap
35857 msgid "{@code{fifo-listener-configuration} parameter} string path"
35858 msgstr ""
35859
35860 #. type: deftypevr
35861 #: guix-git/doc/guix.texi:20107
35862 #, no-wrap
35863 msgid "{@code{fifo-listener-configuration} parameter} string mode"
35864 msgstr ""
35865
35866 #. type: deftypevr
35867 #: guix-git/doc/guix.texi:20112
35868 #, no-wrap
35869 msgid "{@code{fifo-listener-configuration} parameter} string user"
35870 msgstr ""
35871
35872 #. type: deftypevr
35873 #: guix-git/doc/guix.texi:20117
35874 #, no-wrap
35875 msgid "{@code{fifo-listener-configuration} parameter} string group"
35876 msgstr ""
35877
35878 #. type: deftypevr
35879 #: guix-git/doc/guix.texi:20124
35880 msgid "Available @code{inet-listener-configuration} fields are:"
35881 msgstr ""
35882
35883 #. type: deftypevr
35884 #: guix-git/doc/guix.texi:20125
35885 #, no-wrap
35886 msgid "{@code{inet-listener-configuration} parameter} string protocol"
35887 msgstr ""
35888
35889 #. type: deftypevr
35890 #: guix-git/doc/guix.texi:20127
35891 msgid "The protocol to listen for."
35892 msgstr ""
35893
35894 #. type: deftypevr
35895 #: guix-git/doc/guix.texi:20129
35896 #, no-wrap
35897 msgid "{@code{inet-listener-configuration} parameter} string address"
35898 msgstr ""
35899
35900 #. type: deftypevr
35901 #: guix-git/doc/guix.texi:20132
35902 msgid "The address on which to listen, or empty for all addresses. Defaults to @samp{\"\"}."
35903 msgstr ""
35904
35905 #. type: deftypevr
35906 #: guix-git/doc/guix.texi:20134
35907 #, no-wrap
35908 msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port"
35909 msgstr ""
35910
35911 #. type: deftypevr
35912 #: guix-git/doc/guix.texi:20136
35913 msgid "The port on which to listen."
35914 msgstr ""
35915
35916 #. type: deftypevr
35917 #: guix-git/doc/guix.texi:20138
35918 #, no-wrap
35919 msgid "{@code{inet-listener-configuration} parameter} boolean ssl?"
35920 msgstr ""
35921
35922 #. type: deftypevr
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}."
35925 msgstr ""
35926
35927 #. type: deftypevr
35928 #: guix-git/doc/guix.texi:20146
35929 #, no-wrap
35930 msgid "{@code{service-configuration} parameter} non-negative-integer client-limit"
35931 msgstr ""
35932
35933 #. type: deftypevr
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."
35936 msgstr ""
35937
35938 #. type: deftypevr
35939 #: guix-git/doc/guix.texi:20156
35940 #, no-wrap
35941 msgid "{@code{service-configuration} parameter} non-negative-integer service-count"
35942 msgstr ""
35943
35944 #. type: deftypevr
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}."
35947 msgstr ""
35948
35949 #. type: deftypevr
35950 #: guix-git/doc/guix.texi:20164
35951 #, no-wrap
35952 msgid "{@code{service-configuration} parameter} non-negative-integer process-limit"
35953 msgstr ""
35954
35955 #. type: deftypevr
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."
35958 msgstr ""
35959
35960 #. type: deftypevr
35961 #: guix-git/doc/guix.texi:20172
35962 #, no-wrap
35963 msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail"
35964 msgstr ""
35965
35966 #. type: deftypevr
35967 #: guix-git/doc/guix.texi:20175
35968 msgid "Number of processes to always keep waiting for more connections. Defaults to @samp{0}."
35969 msgstr ""
35970
35971 #. type: deftypevr
35972 #: guix-git/doc/guix.texi:20177
35973 #, no-wrap
35974 msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit"
35975 msgstr ""
35976
35977 #. type: deftypevr
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}."
35980 msgstr ""
35981
35982 #. type: deftypevr
35983 #: guix-git/doc/guix.texi:20185
35984 #, no-wrap
35985 msgid "{@code{dovecot-configuration} parameter} dict-configuration dict"
35986 msgstr ""
35987
35988 #. type: deftypevr
35989 #: guix-git/doc/guix.texi:20188
35990 msgid "Dict configuration, as created by the @code{dict-configuration} constructor."
35991 msgstr ""
35992
35993 #. type: deftypevr
35994 #: guix-git/doc/guix.texi:20190
35995 msgid "Available @code{dict-configuration} fields are:"
35996 msgstr ""
35997
35998 #. type: deftypevr
35999 #: guix-git/doc/guix.texi:20191
36000 #, no-wrap
36001 msgid "{@code{dict-configuration} parameter} free-form-fields entries"
36002 msgstr ""
36003
36004 #. type: deftypevr
36005 #: guix-git/doc/guix.texi:20194
36006 msgid "A list of key-value pairs that this dict should hold. Defaults to @samp{()}."
36007 msgstr ""
36008
36009 #. type: deftypevr
36010 #: guix-git/doc/guix.texi:20198
36011 #, no-wrap
36012 msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs"
36013 msgstr ""
36014
36015 #. type: deftypevr
36016 #: guix-git/doc/guix.texi:20201
36017 msgid "A list of passdb configurations, each one created by the @code{passdb-configuration} constructor."
36018 msgstr ""
36019
36020 #. type: deftypevr
36021 #: guix-git/doc/guix.texi:20203
36022 msgid "Available @code{passdb-configuration} fields are:"
36023 msgstr ""
36024
36025 #. type: deftypevr
36026 #: guix-git/doc/guix.texi:20204
36027 #, no-wrap
36028 msgid "{@code{passdb-configuration} parameter} string driver"
36029 msgstr ""
36030
36031 #. type: deftypevr
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\"}."
36034 msgstr ""
36035
36036 #. type: deftypevr
36037 #: guix-git/doc/guix.texi:20211
36038 #, no-wrap
36039 msgid "{@code{passdb-configuration} parameter} space-separated-string-list args"
36040 msgstr ""
36041
36042 #. type: deftypevr
36043 #: guix-git/doc/guix.texi:20214
36044 msgid "Space separated list of arguments to the passdb driver. Defaults to @samp{\"\"}."
36045 msgstr ""
36046
36047 #. type: deftypevr
36048 #: guix-git/doc/guix.texi:20218
36049 #, no-wrap
36050 msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs"
36051 msgstr ""
36052
36053 #. type: deftypevr
36054 #: guix-git/doc/guix.texi:20221
36055 msgid "List of userdb configurations, each one created by the @code{userdb-configuration} constructor."
36056 msgstr ""
36057
36058 #. type: deftypevr
36059 #: guix-git/doc/guix.texi:20223
36060 msgid "Available @code{userdb-configuration} fields are:"
36061 msgstr ""
36062
36063 #. type: deftypevr
36064 #: guix-git/doc/guix.texi:20224
36065 #, no-wrap
36066 msgid "{@code{userdb-configuration} parameter} string driver"
36067 msgstr ""
36068
36069 #. type: deftypevr
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\"}."
36072 msgstr ""
36073
36074 #. type: deftypevr
36075 #: guix-git/doc/guix.texi:20230
36076 #, no-wrap
36077 msgid "{@code{userdb-configuration} parameter} space-separated-string-list args"
36078 msgstr ""
36079
36080 #. type: deftypevr
36081 #: guix-git/doc/guix.texi:20233
36082 msgid "Space separated list of arguments to the userdb driver. Defaults to @samp{\"\"}."
36083 msgstr ""
36084
36085 #. type: deftypevr
36086 #: guix-git/doc/guix.texi:20235
36087 #, no-wrap
36088 msgid "{@code{userdb-configuration} parameter} free-form-args override-fields"
36089 msgstr ""
36090
36091 #. type: deftypevr
36092 #: guix-git/doc/guix.texi:20238
36093 msgid "Override fields from passwd. Defaults to @samp{()}."
36094 msgstr ""
36095
36096 #. type: deftypevr
36097 #: guix-git/doc/guix.texi:20242
36098 #, no-wrap
36099 msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration"
36100 msgstr ""
36101
36102 #. type: deftypevr
36103 #: guix-git/doc/guix.texi:20245
36104 msgid "Plug-in configuration, created by the @code{plugin-configuration} constructor."
36105 msgstr ""
36106
36107 #. type: deftypevr
36108 #: guix-git/doc/guix.texi:20247
36109 #, no-wrap
36110 msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces"
36111 msgstr ""
36112
36113 #. type: deftypevr
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."
36116 msgstr ""
36117
36118 #. type: deftypevr
36119 #: guix-git/doc/guix.texi:20252
36120 msgid "Available @code{namespace-configuration} fields are:"
36121 msgstr ""
36122
36123 #. type: deftypevr
36124 #: guix-git/doc/guix.texi:20253
36125 #, no-wrap
36126 msgid "{@code{namespace-configuration} parameter} string name"
36127 msgstr ""
36128
36129 #. type: deftypevr
36130 #: guix-git/doc/guix.texi:20255
36131 msgid "Name for this namespace."
36132 msgstr ""
36133
36134 #. type: deftypevr
36135 #: guix-git/doc/guix.texi:20257
36136 #, no-wrap
36137 msgid "{@code{namespace-configuration} parameter} string type"
36138 msgstr ""
36139
36140 #. type: deftypevr
36141 #: guix-git/doc/guix.texi:20260
36142 msgid "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to @samp{\"private\"}."
36143 msgstr ""
36144
36145 #. type: deftypevr
36146 #: guix-git/doc/guix.texi:20262
36147 #, no-wrap
36148 msgid "{@code{namespace-configuration} parameter} string separator"
36149 msgstr ""
36150
36151 #. type: deftypevr
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{\"\"}."
36154 msgstr ""
36155
36156 #. type: deftypevr
36157 #: guix-git/doc/guix.texi:20270
36158 #, no-wrap
36159 msgid "{@code{namespace-configuration} parameter} string prefix"
36160 msgstr ""
36161
36162 #. type: deftypevr
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{\"\"}."
36165 msgstr ""
36166
36167 #. type: deftypevr
36168 #: guix-git/doc/guix.texi:20276
36169 #, no-wrap
36170 msgid "{@code{namespace-configuration} parameter} string location"
36171 msgstr ""
36172
36173 #. type: deftypevr
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{\"\"}."
36176 msgstr ""
36177
36178 #. type: deftypevr
36179 #: guix-git/doc/guix.texi:20282
36180 #, no-wrap
36181 msgid "{@code{namespace-configuration} parameter} boolean inbox?"
36182 msgstr ""
36183
36184 #. type: deftypevr
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}."
36187 msgstr ""
36188
36189 #. type: deftypevr
36190 #: guix-git/doc/guix.texi:20288
36191 #, no-wrap
36192 msgid "{@code{namespace-configuration} parameter} boolean hidden?"
36193 msgstr ""
36194
36195 #. type: deftypevr
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}."
36198 msgstr ""
36199
36200 #. type: deftypevr
36201 #: guix-git/doc/guix.texi:20298
36202 #, no-wrap
36203 msgid "{@code{namespace-configuration} parameter} boolean list?"
36204 msgstr ""
36205
36206 #. type: deftypevr
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}."
36209 msgstr ""
36210
36211 #. type: deftypevr
36212 #: guix-git/doc/guix.texi:20306
36213 #, no-wrap
36214 msgid "{@code{namespace-configuration} parameter} boolean subscriptions?"
36215 msgstr ""
36216
36217 #. type: deftypevr
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}."
36220 msgstr ""
36221
36222 #. type: deftypevr
36223 #: guix-git/doc/guix.texi:20313
36224 #, no-wrap
36225 msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes"
36226 msgstr ""
36227
36228 #. type: deftypevr
36229 #: guix-git/doc/guix.texi:20316
36230 msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}."
36231 msgstr ""
36232
36233 #. type: deftypevr
36234 #: guix-git/doc/guix.texi:20318
36235 msgid "Available @code{mailbox-configuration} fields are:"
36236 msgstr ""
36237
36238 #. type: deftypevr
36239 #: guix-git/doc/guix.texi:20319
36240 #, no-wrap
36241 msgid "{@code{mailbox-configuration} parameter} string name"
36242 msgstr ""
36243
36244 #. type: deftypevr
36245 #: guix-git/doc/guix.texi:20321
36246 msgid "Name for this mailbox."
36247 msgstr ""
36248
36249 #. type: deftypevr
36250 #: guix-git/doc/guix.texi:20323
36251 #, no-wrap
36252 msgid "{@code{mailbox-configuration} parameter} string auto"
36253 msgstr ""
36254
36255 #. type: deftypevr
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\"}."
36258 msgstr ""
36259
36260 #. type: deftypevr
36261 #: guix-git/doc/guix.texi:20329
36262 #, no-wrap
36263 msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use"
36264 msgstr ""
36265
36266 #. type: deftypevr
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{()}."
36269 msgstr ""
36270
36271 #. type: deftypevr
36272 #: guix-git/doc/guix.texi:20340
36273 #, no-wrap
36274 msgid "{@code{dovecot-configuration} parameter} file-name base-dir"
36275 msgstr ""
36276
36277 #. type: deftypevr
36278 #: guix-git/doc/guix.texi:20343
36279 msgid "Base directory where to store runtime data. Defaults to @samp{\"/var/run/dovecot/\"}."
36280 msgstr ""
36281
36282 #. type: deftypevr
36283 #: guix-git/doc/guix.texi:20345
36284 #, no-wrap
36285 msgid "{@code{dovecot-configuration} parameter} string login-greeting"
36286 msgstr ""
36287
36288 #. type: deftypevr
36289 #: guix-git/doc/guix.texi:20348
36290 msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}."
36291 msgstr ""
36292
36293 #. type: deftypevr
36294 #: guix-git/doc/guix.texi:20350
36295 #, no-wrap
36296 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks"
36297 msgstr ""
36298
36299 #. type: deftypevr
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{()}."
36302 msgstr ""
36303
36304 #. type: deftypevr
36305 #: guix-git/doc/guix.texi:20359
36306 #, no-wrap
36307 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets"
36308 msgstr ""
36309
36310 #. type: deftypevr
36311 #: guix-git/doc/guix.texi:20362
36312 msgid "List of login access check sockets (e.g.@: tcpwrap). Defaults to @samp{()}."
36313 msgstr ""
36314
36315 #. type: deftypevr
36316 #: guix-git/doc/guix.texi:20364
36317 #, no-wrap
36318 msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?"
36319 msgstr ""
36320
36321 #. type: deftypevr
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}."
36324 msgstr ""
36325
36326 #. type: deftypevr
36327 #: guix-git/doc/guix.texi:20372
36328 #, no-wrap
36329 msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?"
36330 msgstr ""
36331
36332 #. type: deftypevr
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}."
36335 msgstr ""
36336
36337 #. type: deftypevr
36338 #: guix-git/doc/guix.texi:20380
36339 #, no-wrap
36340 msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count"
36341 msgstr ""
36342
36343 #. type: deftypevr
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}."
36346 msgstr ""
36347
36348 #. type: deftypevr
36349 #: guix-git/doc/guix.texi:20386
36350 #, no-wrap
36351 msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path"
36352 msgstr ""
36353
36354 #. type: deftypevr
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\"}."
36357 msgstr ""
36358
36359 #. type: deftypevr
36360 #: guix-git/doc/guix.texi:20391
36361 #, no-wrap
36362 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment"
36363 msgstr ""
36364
36365 #. type: deftypevr
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."
36368 msgstr ""
36369
36370 #. type: deftypevr
36371 #: guix-git/doc/guix.texi:20397
36372 #, no-wrap
36373 msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?"
36374 msgstr ""
36375
36376 #. type: deftypevr
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}."
36379 msgstr ""
36380
36381 #. type: deftypevr
36382 #: guix-git/doc/guix.texi:20406
36383 #, no-wrap
36384 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size"
36385 msgstr ""
36386
36387 #. type: deftypevr
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}."
36390 msgstr ""
36391
36392 #. type: deftypevr
36393 #: guix-git/doc/guix.texi:20413
36394 #, no-wrap
36395 msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl"
36396 msgstr ""
36397
36398 #. type: deftypevr
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\"}."
36401 msgstr ""
36402
36403 #. type: deftypevr
36404 #: guix-git/doc/guix.texi:20423
36405 #, no-wrap
36406 msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl"
36407 msgstr ""
36408
36409 #. type: deftypevr
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\"}."
36412 msgstr ""
36413
36414 #. type: deftypevr
36415 #: guix-git/doc/guix.texi:20429
36416 #, no-wrap
36417 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms"
36418 msgstr ""
36419
36420 #. type: deftypevr
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{()}."
36423 msgstr ""
36424
36425 #. type: deftypevr
36426 #: guix-git/doc/guix.texi:20437
36427 #, no-wrap
36428 msgid "{@code{dovecot-configuration} parameter} string auth-default-realm"
36429 msgstr ""
36430
36431 #. type: deftypevr
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{\"\"}."
36434 msgstr ""
36435
36436 #. type: deftypevr
36437 #: guix-git/doc/guix.texi:20444
36438 #, no-wrap
36439 msgid "{@code{dovecot-configuration} parameter} string auth-username-chars"
36440 msgstr ""
36441
36442 #. type: deftypevr
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.-_@@\"}."
36445 msgstr ""
36446
36447 #. type: deftypevr
36448 #: guix-git/doc/guix.texi:20453
36449 #, no-wrap
36450 msgid "{@code{dovecot-configuration} parameter} string auth-username-translation"
36451 msgstr ""
36452
36453 #. type: deftypevr
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{\"\"}."
36456 msgstr ""
36457
36458 #. type: deftypevr
36459 #: guix-git/doc/guix.texi:20461
36460 #, no-wrap
36461 msgid "{@code{dovecot-configuration} parameter} string auth-username-format"
36462 msgstr ""
36463
36464 #. type: deftypevr
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\"}."
36467 msgstr ""
36468
36469 #. type: deftypevr
36470 #: guix-git/doc/guix.texi:20470
36471 #, no-wrap
36472 msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator"
36473 msgstr ""
36474
36475 #. type: deftypevr
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{\"\"}."
36478 msgstr ""
36479
36480 #. type: deftypevr
36481 #: guix-git/doc/guix.texi:20480
36482 #, no-wrap
36483 msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username"
36484 msgstr ""
36485
36486 #. type: deftypevr
36487 #: guix-git/doc/guix.texi:20484
36488 msgid "Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to @samp{\"anonymous\"}."
36489 msgstr ""
36490
36491 #. type: deftypevr
36492 #: guix-git/doc/guix.texi:20486
36493 #, no-wrap
36494 msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count"
36495 msgstr ""
36496
36497 #. type: deftypevr
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}."
36500 msgstr ""
36501
36502 #. type: deftypevr
36503 #: guix-git/doc/guix.texi:20493
36504 #, no-wrap
36505 msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname"
36506 msgstr ""
36507
36508 #. type: deftypevr
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{\"\"}."
36511 msgstr ""
36512
36513 #. type: deftypevr
36514 #: guix-git/doc/guix.texi:20500
36515 #, no-wrap
36516 msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab"
36517 msgstr ""
36518
36519 #. type: deftypevr
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{\"\"}."
36522 msgstr ""
36523
36524 #. type: deftypevr
36525 #: guix-git/doc/guix.texi:20508
36526 #, no-wrap
36527 msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?"
36528 msgstr ""
36529
36530 #. type: deftypevr
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}."
36533 msgstr ""
36534
36535 #. type: deftypevr
36536 #: guix-git/doc/guix.texi:20515
36537 #, no-wrap
36538 msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path"
36539 msgstr ""
36540
36541 #. type: deftypevr
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\"}."
36544 msgstr ""
36545
36546 #. type: deftypevr
36547 #: guix-git/doc/guix.texi:20520
36548 #, no-wrap
36549 msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay"
36550 msgstr ""
36551
36552 #. type: deftypevr
36553 #: guix-git/doc/guix.texi:20523
36554 msgid "Time to delay before replying to failed authentications. Defaults to @samp{\"2 secs\"}."
36555 msgstr ""
36556
36557 #. type: deftypevr
36558 #: guix-git/doc/guix.texi:20525
36559 #, no-wrap
36560 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?"
36561 msgstr ""
36562
36563 #. type: deftypevr
36564 #: guix-git/doc/guix.texi:20529
36565 msgid "Require a valid SSL client certificate or the authentication fails. Defaults to @samp{#f}."
36566 msgstr ""
36567
36568 #. type: deftypevr
36569 #: guix-git/doc/guix.texi:20531
36570 #, no-wrap
36571 msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?"
36572 msgstr ""
36573
36574 #. type: deftypevr
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}."
36577 msgstr ""
36578
36579 #. type: deftypevr
36580 #: guix-git/doc/guix.texi:20538
36581 #, no-wrap
36582 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms"
36583 msgstr ""
36584
36585 #. type: deftypevr
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."
36588 msgstr ""
36589
36590 #. type: deftypevr
36591 #: guix-git/doc/guix.texi:20546
36592 #, no-wrap
36593 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers"
36594 msgstr ""
36595
36596 #. type: deftypevr
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{()}."
36599 msgstr ""
36600
36601 #. type: deftypevr
36602 #: guix-git/doc/guix.texi:20553
36603 #, no-wrap
36604 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers"
36605 msgstr ""
36606
36607 #. type: deftypevr
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{()}."
36610 msgstr ""
36611
36612 #. type: deftypevr
36613 #: guix-git/doc/guix.texi:20559
36614 #, no-wrap
36615 msgid "{@code{dovecot-configuration} parameter} string director-user-expire"
36616 msgstr ""
36617
36618 #. type: deftypevr
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\"}."
36621 msgstr ""
36622
36623 #. type: deftypevr
36624 #: guix-git/doc/guix.texi:20565
36625 #, no-wrap
36626 msgid "{@code{dovecot-configuration} parameter} string director-username-hash"
36627 msgstr ""
36628
36629 #. type: deftypevr
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\"}."
36632 msgstr ""
36633
36634 #. type: deftypevr
36635 #: guix-git/doc/guix.texi:20572
36636 #, no-wrap
36637 msgid "{@code{dovecot-configuration} parameter} string log-path"
36638 msgstr ""
36639
36640 #. type: deftypevr
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\"}."
36643 msgstr ""
36644
36645 #. type: deftypevr
36646 #: guix-git/doc/guix.texi:20578
36647 #, no-wrap
36648 msgid "{@code{dovecot-configuration} parameter} string info-log-path"
36649 msgstr ""
36650
36651 #. type: deftypevr
36652 #: guix-git/doc/guix.texi:20582
36653 msgid "Log file to use for informational messages. Defaults to @samp{log-path}. Defaults to @samp{\"\"}."
36654 msgstr ""
36655
36656 #. type: deftypevr
36657 #: guix-git/doc/guix.texi:20584
36658 #, no-wrap
36659 msgid "{@code{dovecot-configuration} parameter} string debug-log-path"
36660 msgstr ""
36661
36662 #. type: deftypevr
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{\"\"}."
36665 msgstr ""
36666
36667 #. type: deftypevr
36668 #: guix-git/doc/guix.texi:20590
36669 #, no-wrap
36670 msgid "{@code{dovecot-configuration} parameter} string syslog-facility"
36671 msgstr ""
36672
36673 #. type: deftypevr
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\"}."
36676 msgstr ""
36677
36678 #. type: deftypevr
36679 #: guix-git/doc/guix.texi:20597
36680 #, no-wrap
36681 msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?"
36682 msgstr ""
36683
36684 #. type: deftypevr
36685 #: guix-git/doc/guix.texi:20601
36686 msgid "Log unsuccessful authentication attempts and the reasons why they failed. Defaults to @samp{#f}."
36687 msgstr ""
36688
36689 #. type: deftypevr
36690 #: guix-git/doc/guix.texi:20603
36691 #, no-wrap
36692 msgid "{@code{dovecot-configuration} parameter} string auth-verbose-passwords"
36693 msgstr ""
36694
36695 #. type: deftypevr
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\"}."
36698 msgstr ""
36699
36700 #. type: deftypevr
36701 #: guix-git/doc/guix.texi:20612
36702 #, no-wrap
36703 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?"
36704 msgstr ""
36705
36706 #. type: deftypevr
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}."
36709 msgstr ""
36710
36711 #. type: deftypevr
36712 #: guix-git/doc/guix.texi:20618
36713 #, no-wrap
36714 msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?"
36715 msgstr ""
36716
36717 #. type: deftypevr
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}."
36720 msgstr ""
36721
36722 #. type: deftypevr
36723 #: guix-git/doc/guix.texi:20625
36724 #, no-wrap
36725 msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?"
36726 msgstr ""
36727
36728 #. type: deftypevr
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}."
36731 msgstr ""
36732
36733 #. type: deftypevr
36734 #: guix-git/doc/guix.texi:20631
36735 #, no-wrap
36736 msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?"
36737 msgstr ""
36738
36739 #. type: deftypevr
36740 #: guix-git/doc/guix.texi:20634
36741 msgid "Show protocol level SSL errors. Defaults to @samp{#f}."
36742 msgstr ""
36743
36744 #. type: deftypevr
36745 #: guix-git/doc/guix.texi:20636
36746 #, no-wrap
36747 msgid "{@code{dovecot-configuration} parameter} string log-timestamp"
36748 msgstr ""
36749
36750 #. type: deftypevr
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 \\\"\"}."
36753 msgstr ""
36754
36755 #. type: deftypevr
36756 #: guix-git/doc/guix.texi:20642
36757 #, no-wrap
36758 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements"
36759 msgstr ""
36760
36761 #. type: deftypevr
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."
36764 msgstr ""
36765
36766 #. type: deftypevr
36767 #: guix-git/doc/guix.texi:20648
36768 #, no-wrap
36769 msgid "{@code{dovecot-configuration} parameter} string login-log-format"
36770 msgstr ""
36771
36772 #. type: deftypevr
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\"}."
36775 msgstr ""
36776
36777 #. type: deftypevr
36778 #: guix-git/doc/guix.texi:20654
36779 #, no-wrap
36780 msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix"
36781 msgstr ""
36782
36783 #. type: deftypevr
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@}>: \\\"\"}."
36786 msgstr ""
36787
36788 #. type: deftypevr
36789 #: guix-git/doc/guix.texi:20660
36790 #, no-wrap
36791 msgid "{@code{dovecot-configuration} parameter} string deliver-log-format"
36792 msgstr ""
36793
36794 #. type: deftypevr
36795 #: guix-git/doc/guix.texi:20662
36796 msgid "Format to use for logging mail deliveries. You can use variables:"
36797 msgstr ""
36798
36799 #. type: item
36800 #: guix-git/doc/guix.texi:20663
36801 #, no-wrap
36802 msgid "%$"
36803 msgstr ""
36804
36805 #. type: table
36806 #: guix-git/doc/guix.texi:20665
36807 msgid "Delivery status message (e.g.@: @samp{saved to INBOX})"
36808 msgstr ""
36809
36810 #. type: item
36811 #: guix-git/doc/guix.texi:20665
36812 #, no-wrap
36813 msgid "%m"
36814 msgstr ""
36815
36816 #. type: table
36817 #: guix-git/doc/guix.texi:20667
36818 msgid "Message-ID"
36819 msgstr ""
36820
36821 #. type: item
36822 #: guix-git/doc/guix.texi:20667 guix-git/doc/guix.texi:21199
36823 #, no-wrap
36824 msgid "%s"
36825 msgstr ""
36826
36827 #. type: table
36828 #: guix-git/doc/guix.texi:20669
36829 msgid "Subject"
36830 msgstr ""
36831
36832 #. type: item
36833 #: guix-git/doc/guix.texi:20669
36834 #, no-wrap
36835 msgid "%f"
36836 msgstr ""
36837
36838 #. type: table
36839 #: guix-git/doc/guix.texi:20671
36840 msgid "From address"
36841 msgstr ""
36842
36843 #. type: table
36844 #: guix-git/doc/guix.texi:20673
36845 msgid "Physical size"
36846 msgstr ""
36847
36848 #. type: item
36849 #: guix-git/doc/guix.texi:20673
36850 #, no-wrap
36851 msgid "%w"
36852 msgstr ""
36853
36854 #. type: table
36855 #: guix-git/doc/guix.texi:20675
36856 msgid "Virtual size."
36857 msgstr ""
36858
36859 #. type: deftypevr
36860 #: guix-git/doc/guix.texi:20677
36861 msgid "Defaults to @samp{\"msgid=%m: %$\"}."
36862 msgstr ""
36863
36864 #. type: deftypevr
36865 #: guix-git/doc/guix.texi:20679
36866 #, no-wrap
36867 msgid "{@code{dovecot-configuration} parameter} string mail-location"
36868 msgstr ""
36869
36870 #. type: deftypevr
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."
36873 msgstr ""
36874
36875 #. type: deftypevr
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."
36878 msgstr ""
36879
36880 #. type: deftypevr
36881 #: guix-git/doc/guix.texi:20692
36882 msgid "There are a few special variables you can use, e.g.:"
36883 msgstr ""
36884
36885 #. type: table
36886 #: guix-git/doc/guix.texi:20696
36887 msgid "username"
36888 msgstr ""
36889
36890 #. type: item
36891 #: guix-git/doc/guix.texi:20696 guix-git/doc/guix.texi:21195
36892 #, no-wrap
36893 msgid "%n"
36894 msgstr ""
36895
36896 #. type: table
36897 #: guix-git/doc/guix.texi:20698
36898 msgid "user part in user@@domain, same as %u if there's no domain"
36899 msgstr ""
36900
36901 #. type: item
36902 #: guix-git/doc/guix.texi:20698
36903 #, no-wrap
36904 msgid "%d"
36905 msgstr ""
36906
36907 #. type: table
36908 #: guix-git/doc/guix.texi:20700
36909 msgid "domain part in user@@domain, empty if there's no domain"
36910 msgstr ""
36911
36912 #. type: item
36913 #: guix-git/doc/guix.texi:20700
36914 #, no-wrap
36915 msgid "%h"
36916 msgstr ""
36917
36918 #. type: table
36919 #: guix-git/doc/guix.texi:20702
36920 msgid "home director"
36921 msgstr ""
36922
36923 #. type: deftypevr
36924 #: guix-git/doc/guix.texi:20705
36925 msgid "See doc/wiki/Variables.txt for full list. Some examples:"
36926 msgstr ""
36927
36928 #. type: item
36929 #: guix-git/doc/guix.texi:20706
36930 #, no-wrap
36931 msgid "maildir:~/Maildir"
36932 msgstr ""
36933
36934 #. type: item
36935 #: guix-git/doc/guix.texi:20707
36936 #, no-wrap
36937 msgid "mbox:~/mail:INBOX=/var/mail/%u"
36938 msgstr ""
36939
36940 #. type: item
36941 #: guix-git/doc/guix.texi:20708
36942 #, no-wrap
36943 msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%"
36944 msgstr ""
36945
36946 #. type: deftypevr
36947 #: guix-git/doc/guix.texi:20713
36948 #, no-wrap
36949 msgid "{@code{dovecot-configuration} parameter} string mail-uid"
36950 msgstr ""
36951
36952 #. type: deftypevr
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{\"\"}."
36955 msgstr ""
36956
36957 #. type: deftypevr
36958 #: guix-git/doc/guix.texi:20720
36959 #, no-wrap
36960 msgid "{@code{dovecot-configuration} parameter} string mail-gid"
36961 msgstr ""
36962
36963 #. type: deftypevr
36964 #: guix-git/doc/guix.texi:20725
36965 #, no-wrap
36966 msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group"
36967 msgstr ""
36968
36969 #. type: deftypevr
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{\"\"}."
36972 msgstr ""
36973
36974 #. type: deftypevr
36975 #: guix-git/doc/guix.texi:20733
36976 #, no-wrap
36977 msgid "{@code{dovecot-configuration} parameter} string mail-access-groups"
36978 msgstr ""
36979
36980 #. type: deftypevr
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{\"\"}."
36983 msgstr ""
36984
36985 #. type: deftypevr
36986 #: guix-git/doc/guix.texi:20743
36987 #, no-wrap
36988 msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?"
36989 msgstr ""
36990
36991 #. type: deftypevr
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}."
36994 msgstr ""
36995
36996 #. type: deftypevr
36997 #: guix-git/doc/guix.texi:20751
36998 #, no-wrap
36999 msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?"
37000 msgstr ""
37001
37002 #. type: deftypevr
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}."
37005 msgstr ""
37006
37007 #. type: deftypevr
37008 #: guix-git/doc/guix.texi:20757
37009 #, no-wrap
37010 msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?"
37011 msgstr ""
37012
37013 #. type: deftypevr
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}."
37016 msgstr ""
37017
37018 #. type: deftypevr
37019 #: guix-git/doc/guix.texi:20764
37020 #, no-wrap
37021 msgid "{@code{dovecot-configuration} parameter} string mail-fsync"
37022 msgstr ""
37023
37024 #. type: deftypevr
37025 #: guix-git/doc/guix.texi:20766
37026 msgid "When to use fsync() or fdatasync() calls:"
37027 msgstr ""
37028
37029 #. type: item
37030 #: guix-git/doc/guix.texi:20767
37031 #, no-wrap
37032 msgid "optimized"
37033 msgstr ""
37034
37035 #. type: table
37036 #: guix-git/doc/guix.texi:20769
37037 msgid "Whenever necessary to avoid losing important data"
37038 msgstr ""
37039
37040 #. type: table
37041 #: guix-git/doc/guix.texi:20771
37042 msgid "Useful with e.g.@: NFS when @code{write()}s are delayed"
37043 msgstr ""
37044
37045 #. type: table
37046 #: guix-git/doc/guix.texi:20773
37047 msgid "Never use it (best performance, but crashes can lose data)."
37048 msgstr ""
37049
37050 #. type: deftypevr
37051 #: guix-git/doc/guix.texi:20775
37052 msgid "Defaults to @samp{\"optimized\"}."
37053 msgstr ""
37054
37055 #. type: deftypevr
37056 #: guix-git/doc/guix.texi:20777
37057 #, no-wrap
37058 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?"
37059 msgstr ""
37060
37061 #. type: deftypevr
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}."
37064 msgstr ""
37065
37066 #. type: deftypevr
37067 #: guix-git/doc/guix.texi:20784
37068 #, no-wrap
37069 msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?"
37070 msgstr ""
37071
37072 #. type: deftypevr
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}."
37075 msgstr ""
37076
37077 #. type: deftypevr
37078 #: guix-git/doc/guix.texi:20790
37079 #, no-wrap
37080 msgid "{@code{dovecot-configuration} parameter} string lock-method"
37081 msgstr ""
37082
37083 #. type: deftypevr
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\"}."
37086 msgstr ""
37087
37088 #. type: deftypevr
37089 #: guix-git/doc/guix.texi:20798
37090 #, no-wrap
37091 msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir"
37092 msgstr ""
37093
37094 #. type: deftypevr
37095 #: guix-git/doc/guix.texi:20802
37096 msgid "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to @samp{\"/tmp\"}."
37097 msgstr ""
37098
37099 #. type: deftypevr
37100 #: guix-git/doc/guix.texi:20804
37101 #, no-wrap
37102 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid"
37103 msgstr ""
37104
37105 #. type: deftypevr
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}."
37108 msgstr ""
37109
37110 #. type: deftypevr
37111 #: guix-git/doc/guix.texi:20812
37112 #, no-wrap
37113 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid"
37114 msgstr ""
37115
37116 #. type: deftypevr
37117 #: guix-git/doc/guix.texi:20817
37118 #, no-wrap
37119 msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid"
37120 msgstr ""
37121
37122 #. type: deftypevr
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}."
37125 msgstr ""
37126
37127 #. type: deftypevr
37128 #: guix-git/doc/guix.texi:20824
37129 #, no-wrap
37130 msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid"
37131 msgstr ""
37132
37133 #. type: deftypevr
37134 #: guix-git/doc/guix.texi:20829
37135 #, no-wrap
37136 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length"
37137 msgstr ""
37138
37139 #. type: deftypevr
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}."
37142 msgstr ""
37143
37144 #. type: deftypevr
37145 #: guix-git/doc/guix.texi:20835
37146 #, no-wrap
37147 msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs"
37148 msgstr ""
37149
37150 #. type: deftypevr
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{()}."
37153 msgstr ""
37154
37155 #. type: deftypevr
37156 #: guix-git/doc/guix.texi:20847
37157 #, no-wrap
37158 msgid "{@code{dovecot-configuration} parameter} string mail-chroot"
37159 msgstr ""
37160
37161 #. type: deftypevr
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{\"\"}."
37164 msgstr ""
37165
37166 #. type: deftypevr
37167 #: guix-git/doc/guix.texi:20858
37168 #, no-wrap
37169 msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path"
37170 msgstr ""
37171
37172 #. type: deftypevr
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\"}."
37175 msgstr ""
37176
37177 #. type: deftypevr
37178 #: guix-git/doc/guix.texi:20864
37179 #, no-wrap
37180 msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir"
37181 msgstr ""
37182
37183 #. type: deftypevr
37184 #: guix-git/doc/guix.texi:20867
37185 msgid "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/dovecot\"}."
37186 msgstr ""
37187
37188 #. type: deftypevr
37189 #: guix-git/doc/guix.texi:20869
37190 #, no-wrap
37191 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins"
37192 msgstr ""
37193
37194 #. type: deftypevr
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{()}."
37197 msgstr ""
37198
37199 #. type: deftypevr
37200 #: guix-git/doc/guix.texi:20875
37201 #, no-wrap
37202 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count"
37203 msgstr ""
37204
37205 #. type: deftypevr
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}."
37208 msgstr ""
37209
37210 #. type: deftypevr
37211 #: guix-git/doc/guix.texi:20882
37212 #, no-wrap
37213 msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval"
37214 msgstr ""
37215
37216 #. type: deftypevr
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\"}."
37219 msgstr ""
37220
37221 #. type: deftypevr
37222 #: guix-git/doc/guix.texi:20891
37223 #, no-wrap
37224 msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?"
37225 msgstr ""
37226
37227 #. type: deftypevr
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}."
37230 msgstr ""
37231
37232 #. type: deftypevr
37233 #: guix-git/doc/guix.texi:20900
37234 #, no-wrap
37235 msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?"
37236 msgstr ""
37237
37238 #. type: deftypevr
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}."
37241 msgstr ""
37242
37243 #. type: deftypevr
37244 #: guix-git/doc/guix.texi:20910
37245 #, no-wrap
37246 msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?"
37247 msgstr ""
37248
37249 #. type: deftypevr
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}."
37252 msgstr ""
37253
37254 #. type: deftypevr
37255 #: guix-git/doc/guix.texi:20917
37256 #, no-wrap
37257 msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?"
37258 msgstr ""
37259
37260 #. type: deftypevr
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}."
37263 msgstr ""
37264
37265 #. type: deftypevr
37266 #: guix-git/doc/guix.texi:20924
37267 #, no-wrap
37268 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks"
37269 msgstr ""
37270
37271 #. type: deftypevr
37272 #: guix-git/doc/guix.texi:20927
37273 msgid "Which locking methods to use for locking mbox. There are four available:"
37274 msgstr ""
37275
37276 #. type: item
37277 #: guix-git/doc/guix.texi:20929
37278 #, no-wrap
37279 msgid "dotlock"
37280 msgstr ""
37281
37282 #. type: table
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."
37285 msgstr ""
37286
37287 #. type: item
37288 #: guix-git/doc/guix.texi:20933
37289 #, no-wrap
37290 msgid "dotlock-try"
37291 msgstr ""
37292
37293 #. type: table
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."
37296 msgstr ""
37297
37298 #. type: item
37299 #: guix-git/doc/guix.texi:20936
37300 #, no-wrap
37301 msgid "fcntl"
37302 msgstr ""
37303
37304 #. type: table
37305 #: guix-git/doc/guix.texi:20938
37306 msgid "Use this if possible. Works with NFS too if lockd is used."
37307 msgstr ""
37308
37309 #. type: item
37310 #: guix-git/doc/guix.texi:20938
37311 #, no-wrap
37312 msgid "flock"
37313 msgstr ""
37314
37315 #. type: table
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."
37318 msgstr ""
37319
37320 #. type: item
37321 #: guix-git/doc/guix.texi:20940
37322 #, no-wrap
37323 msgid "lockf"
37324 msgstr ""
37325
37326 #. type: deftypevr
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."
37329 msgstr ""
37330
37331 #. type: deftypevr
37332 #: guix-git/doc/guix.texi:20950
37333 #, no-wrap
37334 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks"
37335 msgstr ""
37336
37337 #. type: deftypevr
37338 #: guix-git/doc/guix.texi:20954
37339 #, no-wrap
37340 msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout"
37341 msgstr ""
37342
37343 #. type: deftypevr
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\"}."
37346 msgstr ""
37347
37348 #. type: deftypevr
37349 #: guix-git/doc/guix.texi:20959
37350 #, no-wrap
37351 msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout"
37352 msgstr ""
37353
37354 #. type: deftypevr
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\"}."
37357 msgstr ""
37358
37359 #. type: deftypevr
37360 #: guix-git/doc/guix.texi:20965
37361 #, no-wrap
37362 msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?"
37363 msgstr ""
37364
37365 #. type: deftypevr
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}."
37368 msgstr ""
37369
37370 #. type: deftypevr
37371 #: guix-git/doc/guix.texi:20978
37372 #, no-wrap
37373 msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?"
37374 msgstr ""
37375
37376 #. type: deftypevr
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}."
37379 msgstr ""
37380
37381 #. type: deftypevr
37382 #: guix-git/doc/guix.texi:20985
37383 #, no-wrap
37384 msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?"
37385 msgstr ""
37386
37387 #. type: deftypevr
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}."
37390 msgstr ""
37391
37392 #. type: deftypevr
37393 #: guix-git/doc/guix.texi:20993
37394 #, no-wrap
37395 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size"
37396 msgstr ""
37397
37398 #. type: deftypevr
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}."
37401 msgstr ""
37402
37403 #. type: deftypevr
37404 #: guix-git/doc/guix.texi:21000
37405 #, no-wrap
37406 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size"
37407 msgstr ""
37408
37409 #. type: deftypevr
37410 #: guix-git/doc/guix.texi:21003
37411 msgid "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}."
37412 msgstr ""
37413
37414 #. type: deftypevr
37415 #: guix-git/doc/guix.texi:21005
37416 #, no-wrap
37417 msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval"
37418 msgstr ""
37419
37420 #. type: deftypevr
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\"}."
37423 msgstr ""
37424
37425 #. type: deftypevr
37426 #: guix-git/doc/guix.texi:21012
37427 #, no-wrap
37428 msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?"
37429 msgstr ""
37430
37431 #. type: deftypevr
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}."
37434 msgstr ""
37435
37436 #. type: deftypevr
37437 #: guix-git/doc/guix.texi:21019
37438 #, no-wrap
37439 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir"
37440 msgstr ""
37441
37442 #. type: deftypevr
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."
37445 msgstr ""
37446
37447 #. type: deftypevr
37448 #: guix-git/doc/guix.texi:21025
37449 msgid "WARNING: This feature hasn't been tested much yet. Use at your own risk."
37450 msgstr ""
37451
37452 #. type: deftypevr
37453 #: guix-git/doc/guix.texi:21028
37454 msgid "Directory root where to store mail attachments. Disabled, if empty. Defaults to @samp{\"\"}."
37455 msgstr ""
37456
37457 #. type: deftypevr
37458 #: guix-git/doc/guix.texi:21030
37459 #, no-wrap
37460 msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size"
37461 msgstr ""
37462
37463 #. type: deftypevr
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}."
37466 msgstr ""
37467
37468 #. type: deftypevr
37469 #: guix-git/doc/guix.texi:21037
37470 #, no-wrap
37471 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs"
37472 msgstr ""
37473
37474 #. type: deftypevr
37475 #: guix-git/doc/guix.texi:21039
37476 msgid "File system backend to use for saving attachments:"
37477 msgstr ""
37478
37479 #. type: item
37480 #: guix-git/doc/guix.texi:21040
37481 #, no-wrap
37482 msgid "posix"
37483 msgstr ""
37484
37485 #. type: table
37486 #: guix-git/doc/guix.texi:21042
37487 msgid "No SiS done by Dovecot (but this might help FS's own deduplication)"
37488 msgstr ""
37489
37490 #. type: item
37491 #: guix-git/doc/guix.texi:21042
37492 #, no-wrap
37493 msgid "sis posix"
37494 msgstr ""
37495
37496 #. type: table
37497 #: guix-git/doc/guix.texi:21044
37498 msgid "SiS with immediate byte-by-byte comparison during saving"
37499 msgstr ""
37500
37501 #. type: item
37502 #: guix-git/doc/guix.texi:21044
37503 #, no-wrap
37504 msgid "sis-queue posix"
37505 msgstr ""
37506
37507 #. type: table
37508 #: guix-git/doc/guix.texi:21046
37509 msgid "SiS with delayed comparison and deduplication."
37510 msgstr ""
37511
37512 #. type: deftypevr
37513 #: guix-git/doc/guix.texi:21048
37514 msgid "Defaults to @samp{\"sis posix\"}."
37515 msgstr ""
37516
37517 #. type: deftypevr
37518 #: guix-git/doc/guix.texi:21050
37519 #, no-wrap
37520 msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash"
37521 msgstr ""
37522
37523 #. type: deftypevr
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@}\"}."
37526 msgstr ""
37527
37528 #. type: deftypevr
37529 #: guix-git/doc/guix.texi:21058
37530 #, no-wrap
37531 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit"
37532 msgstr ""
37533
37534 #. type: deftypevr
37535 #: guix-git/doc/guix.texi:21063
37536 #, no-wrap
37537 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit"
37538 msgstr ""
37539
37540 #. type: deftypevr
37541 #: guix-git/doc/guix.texi:21066 guix-git/doc/guix.texi:28386
37542 msgid "Defaults to @samp{1000}."
37543 msgstr ""
37544
37545 #. type: deftypevr
37546 #: guix-git/doc/guix.texi:21068
37547 #, no-wrap
37548 msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit"
37549 msgstr ""
37550
37551 #. type: deftypevr
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}."
37554 msgstr ""
37555
37556 #. type: deftypevr
37557 #: guix-git/doc/guix.texi:21075
37558 #, no-wrap
37559 msgid "{@code{dovecot-configuration} parameter} string default-login-user"
37560 msgstr ""
37561
37562 #. type: deftypevr
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\"}."
37565 msgstr ""
37566
37567 #. type: deftypevr
37568 #: guix-git/doc/guix.texi:21082
37569 #, no-wrap
37570 msgid "{@code{dovecot-configuration} parameter} string default-internal-user"
37571 msgstr ""
37572
37573 #. type: deftypevr
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\"}."
37576 msgstr ""
37577
37578 #. type: deftypevr
37579 #: guix-git/doc/guix.texi:21089
37580 #, no-wrap
37581 msgid "{@code{dovecot-configuration} parameter} string ssl?"
37582 msgstr ""
37583
37584 #. type: deftypevr
37585 #: guix-git/doc/guix.texi:21092
37586 msgid "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to @samp{\"required\"}."
37587 msgstr ""
37588
37589 #. type: deftypevr
37590 #: guix-git/doc/guix.texi:21094
37591 #, no-wrap
37592 msgid "{@code{dovecot-configuration} parameter} string ssl-cert"
37593 msgstr ""
37594
37595 #. type: deftypevr
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\"}."
37598 msgstr ""
37599
37600 #. type: deftypevr
37601 #: guix-git/doc/guix.texi:21099
37602 #, no-wrap
37603 msgid "{@code{dovecot-configuration} parameter} string ssl-key"
37604 msgstr ""
37605
37606 #. type: deftypevr
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\"}."
37609 msgstr ""
37610
37611 #. type: deftypevr
37612 #: guix-git/doc/guix.texi:21106
37613 #, no-wrap
37614 msgid "{@code{dovecot-configuration} parameter} string ssl-key-password"
37615 msgstr ""
37616
37617 #. type: deftypevr
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{\"\"}."
37620 msgstr ""
37621
37622 #. type: deftypevr
37623 #: guix-git/doc/guix.texi:21114
37624 #, no-wrap
37625 msgid "{@code{dovecot-configuration} parameter} string ssl-ca"
37626 msgstr ""
37627
37628 #. type: deftypevr
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{\"\"}."
37631 msgstr ""
37632
37633 #. type: deftypevr
37634 #: guix-git/doc/guix.texi:21122
37635 #, no-wrap
37636 msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?"
37637 msgstr ""
37638
37639 #. type: deftypevr
37640 #: guix-git/doc/guix.texi:21125
37641 msgid "Require that CRL check succeeds for client certificates. Defaults to @samp{#t}."
37642 msgstr ""
37643
37644 #. type: deftypevr
37645 #: guix-git/doc/guix.texi:21127
37646 #, no-wrap
37647 msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?"
37648 msgstr ""
37649
37650 #. type: deftypevr
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}."
37653 msgstr ""
37654
37655 #. type: deftypevr
37656 #: guix-git/doc/guix.texi:21133
37657 #, no-wrap
37658 msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field"
37659 msgstr ""
37660
37661 #. type: deftypevr
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\"}."
37664 msgstr ""
37665
37666 #. type: deftypevr
37667 #: guix-git/doc/guix.texi:21140
37668 #, no-wrap
37669 msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol"
37670 msgstr ""
37671
37672 #. type: deftypevr
37673 #: guix-git/doc/guix.texi:21143
37674 msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}."
37675 msgstr ""
37676
37677 #. type: deftypevr
37678 #: guix-git/doc/guix.texi:21145
37679 #, no-wrap
37680 msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list"
37681 msgstr ""
37682
37683 #. type: deftypevr
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\"}."
37686 msgstr ""
37687
37688 #. type: deftypevr
37689 #: guix-git/doc/guix.texi:21150
37690 #, no-wrap
37691 msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device"
37692 msgstr ""
37693
37694 #. type: deftypevr
37695 #: guix-git/doc/guix.texi:21153
37696 msgid "SSL crypto device to use, for valid values run \"openssl engine\". Defaults to @samp{\"\"}."
37697 msgstr ""
37698
37699 #. type: deftypevr
37700 #: guix-git/doc/guix.texi:21155
37701 #, no-wrap
37702 msgid "{@code{dovecot-configuration} parameter} string postmaster-address"
37703 msgstr ""
37704
37705 #. type: deftypevr
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\"}."
37708 msgstr ""
37709
37710 #. type: deftypevr
37711 #: guix-git/doc/guix.texi:21161
37712 #, no-wrap
37713 msgid "{@code{dovecot-configuration} parameter} string hostname"
37714 msgstr ""
37715
37716 #. type: deftypevr
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{\"\"}."
37719 msgstr ""
37720
37721 #. type: deftypevr
37722 #: guix-git/doc/guix.texi:21167
37723 #, no-wrap
37724 msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?"
37725 msgstr ""
37726
37727 #. type: deftypevr
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}."
37730 msgstr ""
37731
37732 #. type: deftypevr
37733 #: guix-git/doc/guix.texi:21173
37734 #, no-wrap
37735 msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path"
37736 msgstr ""
37737
37738 #. type: deftypevr
37739 #: guix-git/doc/guix.texi:21176
37740 msgid "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}."
37741 msgstr ""
37742
37743 #. type: deftypevr
37744 #: guix-git/doc/guix.texi:21178
37745 #, no-wrap
37746 msgid "{@code{dovecot-configuration} parameter} string submission-host"
37747 msgstr ""
37748
37749 #. type: deftypevr
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{\"\"}."
37752 msgstr ""
37753
37754 #. type: deftypevr
37755 #: guix-git/doc/guix.texi:21184
37756 #, no-wrap
37757 msgid "{@code{dovecot-configuration} parameter} string rejection-subject"
37758 msgstr ""
37759
37760 #. type: deftypevr
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\"}."
37763 msgstr ""
37764
37765 #. type: deftypevr
37766 #: guix-git/doc/guix.texi:21190
37767 #, no-wrap
37768 msgid "{@code{dovecot-configuration} parameter} string rejection-reason"
37769 msgstr ""
37770
37771 #. type: deftypevr
37772 #: guix-git/doc/guix.texi:21193
37773 msgid "Human readable error message for rejection mails. You can use variables:"
37774 msgstr ""
37775
37776 #. type: table
37777 #: guix-git/doc/guix.texi:21197
37778 msgid "CRLF"
37779 msgstr ""
37780
37781 #. type: item
37782 #: guix-git/doc/guix.texi:21197
37783 #, no-wrap
37784 msgid "%r"
37785 msgstr ""
37786
37787 #. type: table
37788 #: guix-git/doc/guix.texi:21199
37789 msgid "reason"
37790 msgstr ""
37791
37792 #. type: table
37793 #: guix-git/doc/guix.texi:21201
37794 msgid "original subject"
37795 msgstr ""
37796
37797 #. type: item
37798 #: guix-git/doc/guix.texi:21201
37799 #, no-wrap
37800 msgid "%t"
37801 msgstr ""
37802
37803 #. type: table
37804 #: guix-git/doc/guix.texi:21203
37805 msgid "recipient"
37806 msgstr ""
37807
37808 #. type: deftypevr
37809 #: guix-git/doc/guix.texi:21205
37810 msgid "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}."
37811 msgstr ""
37812
37813 #. type: deftypevr
37814 #: guix-git/doc/guix.texi:21207
37815 #, no-wrap
37816 msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter"
37817 msgstr ""
37818
37819 #. type: deftypevr
37820 #: guix-git/doc/guix.texi:21211
37821 msgid "Delimiter character between local-part and detail in email address. Defaults to @samp{\"+\"}."
37822 msgstr ""
37823
37824 #. type: deftypevr
37825 #: guix-git/doc/guix.texi:21213
37826 #, no-wrap
37827 msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header"
37828 msgstr ""
37829
37830 #. type: deftypevr
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{\"\"}."
37833 msgstr ""
37834
37835 #. type: deftypevr
37836 #: guix-git/doc/guix.texi:21221
37837 #, no-wrap
37838 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?"
37839 msgstr ""
37840
37841 #. type: deftypevr
37842 #: guix-git/doc/guix.texi:21225
37843 msgid "Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to @samp{#f}."
37844 msgstr ""
37845
37846 #. type: deftypevr
37847 #: guix-git/doc/guix.texi:21227
37848 #, no-wrap
37849 msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?"
37850 msgstr ""
37851
37852 #. type: deftypevr
37853 #: guix-git/doc/guix.texi:21231
37854 msgid "Should automatically created mailboxes be also automatically subscribed?. Defaults to @samp{#f}."
37855 msgstr ""
37856
37857 #. type: deftypevr
37858 #: guix-git/doc/guix.texi:21233
37859 #, no-wrap
37860 msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length"
37861 msgstr ""
37862
37863 #. type: deftypevr
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}."
37866 msgstr ""
37867
37868 #. type: deftypevr
37869 #: guix-git/doc/guix.texi:21241
37870 #, no-wrap
37871 msgid "{@code{dovecot-configuration} parameter} string imap-logout-format"
37872 msgstr ""
37873
37874 #. type: deftypevr
37875 #: guix-git/doc/guix.texi:21243
37876 msgid "IMAP logout format string:"
37877 msgstr ""
37878
37879 #. type: item
37880 #: guix-git/doc/guix.texi:21244
37881 #, no-wrap
37882 msgid "%i"
37883 msgstr ""
37884
37885 #. type: table
37886 #: guix-git/doc/guix.texi:21246
37887 msgid "total number of bytes read from client"
37888 msgstr ""
37889
37890 #. type: item
37891 #: guix-git/doc/guix.texi:21246
37892 #, no-wrap
37893 msgid "%o"
37894 msgstr ""
37895
37896 #. type: table
37897 #: guix-git/doc/guix.texi:21248
37898 msgid "total number of bytes sent to client."
37899 msgstr ""
37900
37901 #. type: deftypevr
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@}\"}."
37904 msgstr ""
37905
37906 #. type: deftypevr
37907 #: guix-git/doc/guix.texi:21253
37908 #, no-wrap
37909 msgid "{@code{dovecot-configuration} parameter} string imap-capability"
37910 msgstr ""
37911
37912 #. type: deftypevr
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{\"\"}."
37915 msgstr ""
37916
37917 #. type: deftypevr
37918 #: guix-git/doc/guix.texi:21259
37919 #, no-wrap
37920 msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval"
37921 msgstr ""
37922
37923 #. type: deftypevr
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\"}."
37926 msgstr ""
37927
37928 #. type: deftypevr
37929 #: guix-git/doc/guix.texi:21265
37930 #, no-wrap
37931 msgid "{@code{dovecot-configuration} parameter} string imap-id-send"
37932 msgstr ""
37933
37934 #. type: deftypevr
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{\"\"}."
37937 msgstr ""
37938
37939 #. type: deftypevr
37940 #: guix-git/doc/guix.texi:21273
37941 #, no-wrap
37942 msgid "{@code{dovecot-configuration} parameter} string imap-id-log"
37943 msgstr ""
37944
37945 #. type: deftypevr
37946 #: guix-git/doc/guix.texi:21276
37947 msgid "ID fields sent by client to log. * means everything. Defaults to @samp{\"\"}."
37948 msgstr ""
37949
37950 #. type: deftypevr
37951 #: guix-git/doc/guix.texi:21278
37952 #, no-wrap
37953 msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds"
37954 msgstr ""
37955
37956 #. type: deftypevr
37957 #: guix-git/doc/guix.texi:21280
37958 msgid "Workarounds for various client bugs:"
37959 msgstr ""
37960
37961 #. type: item
37962 #: guix-git/doc/guix.texi:21282
37963 #, no-wrap
37964 msgid "delay-newmail"
37965 msgstr ""
37966
37967 #. type: table
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\"."
37970 msgstr ""
37971
37972 #. type: item
37973 #: guix-git/doc/guix.texi:21290
37974 #, no-wrap
37975 msgid "tb-extra-mailbox-sep"
37976 msgstr ""
37977
37978 #. type: table
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."
37981 msgstr ""
37982
37983 #. type: item
37984 #: guix-git/doc/guix.texi:21295
37985 #, no-wrap
37986 msgid "tb-lsub-flags"
37987 msgstr ""
37988
37989 #. type: table
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."
37992 msgstr ""
37993
37994 #. type: deftypevr
37995 #: guix-git/doc/guix.texi:21303
37996 #, no-wrap
37997 msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host"
37998 msgstr ""
37999
38000 #. type: deftypevr
38001 #: guix-git/doc/guix.texi:21306
38002 msgid "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to @samp{\"\"}."
38003 msgstr ""
38004
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."
38008 msgstr ""
38009
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."
38013 msgstr ""
38014
38015 #. type: Plain text
38016 #: guix-git/doc/guix.texi:21322
38017 msgid "Available @code{opaque-dovecot-configuration} fields are:"
38018 msgstr ""
38019
38020 #. type: deftypevr
38021 #: guix-git/doc/guix.texi:21323
38022 #, no-wrap
38023 msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot"
38024 msgstr ""
38025
38026 #. type: deftypevr
38027 #: guix-git/doc/guix.texi:21327
38028 #, no-wrap
38029 msgid "{@code{opaque-dovecot-configuration} parameter} string string"
38030 msgstr ""
38031
38032 #. type: deftypevr
38033 #: guix-git/doc/guix.texi:21329
38034 msgid "The contents of the @code{dovecot.conf}, as a string."
38035 msgstr ""
38036
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:"
38040 msgstr ""
38041
38042 #. type: lisp
38043 #: guix-git/doc/guix.texi:21338
38044 #, no-wrap
38045 msgid ""
38046 "(dovecot-service #:config\n"
38047 " (opaque-dovecot-configuration\n"
38048 " (string \"\")))\n"
38049 msgstr ""
38050
38051 #. type: subsubheading
38052 #: guix-git/doc/guix.texi:21340
38053 #, no-wrap
38054 msgid "OpenSMTPD Service"
38055 msgstr ""
38056
38057 #. type: deffn
38058 #: guix-git/doc/guix.texi:21342
38059 #, no-wrap
38060 msgid "{Scheme Variable} opensmtpd-service-type"
38061 msgstr ""
38062
38063 #. type: deffn
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:"
38066 msgstr ""
38067
38068 #. type: lisp
38069 #: guix-git/doc/guix.texi:21351
38070 #, no-wrap
38071 msgid ""
38072 "(service opensmtpd-service-type\n"
38073 " (opensmtpd-configuration\n"
38074 " (config-file (local-file \"./my-smtpd.conf\"))))\n"
38075 msgstr ""
38076
38077 #. type: deftp
38078 #: guix-git/doc/guix.texi:21354
38079 #, no-wrap
38080 msgid "{Data Type} opensmtpd-configuration"
38081 msgstr ""
38082
38083 #. type: deftp
38084 #: guix-git/doc/guix.texi:21356
38085 msgid "Data type representing the configuration of opensmtpd."
38086 msgstr ""
38087
38088 #. type: item
38089 #: guix-git/doc/guix.texi:21358
38090 #, no-wrap
38091 msgid "@code{package} (default: @var{opensmtpd})"
38092 msgstr ""
38093
38094 #. type: table
38095 #: guix-git/doc/guix.texi:21360
38096 msgid "Package object of the OpenSMTPD SMTP server."
38097 msgstr ""
38098
38099 #. type: item
38100 #: guix-git/doc/guix.texi:21361
38101 #, no-wrap
38102 msgid "@code{config-file} (default: @code{%default-opensmtpd-file})"
38103 msgstr ""
38104
38105 #. type: table
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."
38108 msgstr ""
38109
38110 #. type: subsubheading
38111 #: guix-git/doc/guix.texi:21370
38112 #, no-wrap
38113 msgid "Exim Service"
38114 msgstr ""
38115
38116 #. type: cindex
38117 #: guix-git/doc/guix.texi:21372
38118 #, no-wrap
38119 msgid "mail transfer agent (MTA)"
38120 msgstr ""
38121
38122 #. type: cindex
38123 #: guix-git/doc/guix.texi:21373
38124 #, no-wrap
38125 msgid "MTA (mail transfer agent)"
38126 msgstr ""
38127
38128 #. type: cindex
38129 #: guix-git/doc/guix.texi:21374
38130 #, no-wrap
38131 msgid "SMTP"
38132 msgstr ""
38133
38134 #. type: deffn
38135 #: guix-git/doc/guix.texi:21376
38136 #, no-wrap
38137 msgid "{Scheme Variable} exim-service-type"
38138 msgstr ""
38139
38140 #. type: deffn
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:"
38143 msgstr ""
38144
38145 #. type: lisp
38146 #: guix-git/doc/guix.texi:21385
38147 #, no-wrap
38148 msgid ""
38149 "(service exim-service-type\n"
38150 " (exim-configuration\n"
38151 " (config-file (local-file \"./my-exim.conf\"))))\n"
38152 msgstr ""
38153
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)."
38157 msgstr ""
38158
38159 #. type: deftp
38160 #: guix-git/doc/guix.texi:21392
38161 #, no-wrap
38162 msgid "{Data Type} exim-configuration"
38163 msgstr ""
38164
38165 #. type: deftp
38166 #: guix-git/doc/guix.texi:21394
38167 msgid "Data type representing the configuration of exim."
38168 msgstr ""
38169
38170 #. type: item
38171 #: guix-git/doc/guix.texi:21396
38172 #, no-wrap
38173 msgid "@code{package} (default: @var{exim})"
38174 msgstr ""
38175
38176 #. type: table
38177 #: guix-git/doc/guix.texi:21398
38178 msgid "Package object of the Exim server."
38179 msgstr ""
38180
38181 #. type: table
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."
38184 msgstr ""
38185
38186 #. type: subsubheading
38187 #: guix-git/doc/guix.texi:21409
38188 #, no-wrap
38189 msgid "Getmail service"
38190 msgstr ""
38191
38192 #. type: cindex
38193 #: guix-git/doc/guix.texi:21411
38194 #, no-wrap
38195 msgid "IMAP"
38196 msgstr ""
38197
38198 #. type: cindex
38199 #: guix-git/doc/guix.texi:21412
38200 #, no-wrap
38201 msgid "POP"
38202 msgstr ""
38203
38204 #. type: deffn
38205 #: guix-git/doc/guix.texi:21414
38206 #, no-wrap
38207 msgid "{Scheme Variable} getmail-service-type"
38208 msgstr ""
38209
38210 #. type: deffn
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}."
38213 msgstr ""
38214
38215 #. type: Plain text
38216 #: guix-git/doc/guix.texi:21420
38217 msgid "Available @code{getmail-configuration} fields are:"
38218 msgstr ""
38219
38220 #. type: deftypevr
38221 #: guix-git/doc/guix.texi:21421
38222 #, no-wrap
38223 msgid "{@code{getmail-configuration} parameter} symbol name"
38224 msgstr ""
38225
38226 #. type: deftypevr
38227 #: guix-git/doc/guix.texi:21423
38228 msgid "A symbol to identify the getmail service."
38229 msgstr ""
38230
38231 #. type: deftypevr
38232 #: guix-git/doc/guix.texi:21425
38233 msgid "Defaults to @samp{\"unset\"}."
38234 msgstr ""
38235
38236 #. type: deftypevr
38237 #: guix-git/doc/guix.texi:21428
38238 #, no-wrap
38239 msgid "{@code{getmail-configuration} parameter} package package"
38240 msgstr ""
38241
38242 #. type: deftypevr
38243 #: guix-git/doc/guix.texi:21430
38244 msgid "The getmail package to use."
38245 msgstr ""
38246
38247 #. type: deftypevr
38248 #: guix-git/doc/guix.texi:21433
38249 #, no-wrap
38250 msgid "{@code{getmail-configuration} parameter} string user"
38251 msgstr ""
38252
38253 #. type: deftypevr
38254 #: guix-git/doc/guix.texi:21435
38255 msgid "The user to run getmail as."
38256 msgstr ""
38257
38258 #. type: deftypevr
38259 #: guix-git/doc/guix.texi:21437 guix-git/doc/guix.texi:21444
38260 msgid "Defaults to @samp{\"getmail\"}."
38261 msgstr ""
38262
38263 #. type: deftypevr
38264 #: guix-git/doc/guix.texi:21440
38265 #, no-wrap
38266 msgid "{@code{getmail-configuration} parameter} string group"
38267 msgstr ""
38268
38269 #. type: deftypevr
38270 #: guix-git/doc/guix.texi:21442
38271 msgid "The group to run getmail as."
38272 msgstr ""
38273
38274 #. type: deftypevr
38275 #: guix-git/doc/guix.texi:21447
38276 #, no-wrap
38277 msgid "{@code{getmail-configuration} parameter} string directory"
38278 msgstr ""
38279
38280 #. type: deftypevr
38281 #: guix-git/doc/guix.texi:21449
38282 msgid "The getmail directory to use."
38283 msgstr ""
38284
38285 #. type: deftypevr
38286 #: guix-git/doc/guix.texi:21451
38287 msgid "Defaults to @samp{\"/var/lib/getmail/default\"}."
38288 msgstr ""
38289
38290 #. type: deftypevr
38291 #: guix-git/doc/guix.texi:21454
38292 #, no-wrap
38293 msgid "{@code{getmail-configuration} parameter} getmail-configuration-file rcfile"
38294 msgstr ""
38295
38296 #. type: deftypevr
38297 #: guix-git/doc/guix.texi:21456
38298 msgid "The getmail configuration file to use."
38299 msgstr ""
38300
38301 #. type: deftypevr
38302 #: guix-git/doc/guix.texi:21458
38303 msgid "Available @code{getmail-configuration-file} fields are:"
38304 msgstr ""
38305
38306 #. type: deftypevr
38307 #: guix-git/doc/guix.texi:21459
38308 #, no-wrap
38309 msgid "{@code{getmail-configuration-file} parameter} getmail-retriever-configuration retriever"
38310 msgstr ""
38311
38312 #. type: deftypevr
38313 #: guix-git/doc/guix.texi:21461
38314 msgid "What mail account to retrieve mail from, and how to access that account."
38315 msgstr ""
38316
38317 #. type: deftypevr
38318 #: guix-git/doc/guix.texi:21463
38319 msgid "Available @code{getmail-retriever-configuration} fields are:"
38320 msgstr ""
38321
38322 #. type: deftypevr
38323 #: guix-git/doc/guix.texi:21464
38324 #, no-wrap
38325 msgid "{@code{getmail-retriever-configuration} parameter} string type"
38326 msgstr ""
38327
38328 #. type: deftypevr
38329 #: guix-git/doc/guix.texi:21467
38330 msgid "The type of mail retriever to use. Valid values include @samp{passwd} and @samp{static}."
38331 msgstr ""
38332
38333 #. type: deftypevr
38334 #: guix-git/doc/guix.texi:21469
38335 msgid "Defaults to @samp{\"SimpleIMAPSSLRetriever\"}."
38336 msgstr ""
38337
38338 #. type: deftypevr
38339 #: guix-git/doc/guix.texi:21472
38340 #, no-wrap
38341 msgid "{@code{getmail-retriever-configuration} parameter} string server"
38342 msgstr ""
38343
38344 #. type: deftypevr
38345 #: guix-git/doc/guix.texi:21474 guix-git/doc/guix.texi:21481
38346 msgid "Username to login to the mail server with."
38347 msgstr ""
38348
38349 #. type: deftypevr
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}."
38353 msgstr ""
38354
38355 #. type: deftypevr
38356 #: guix-git/doc/guix.texi:21479
38357 #, no-wrap
38358 msgid "{@code{getmail-retriever-configuration} parameter} string username"
38359 msgstr ""
38360
38361 #. type: deftypevr
38362 #: guix-git/doc/guix.texi:21486
38363 #, no-wrap
38364 msgid "{@code{getmail-retriever-configuration} parameter} non-negative-integer port"
38365 msgstr ""
38366
38367 #. type: deftypevr
38368 #: guix-git/doc/guix.texi:21488
38369 msgid "Port number to connect to."
38370 msgstr ""
38371
38372 #. type: deftypevr
38373 #: guix-git/doc/guix.texi:21493
38374 #, no-wrap
38375 msgid "{@code{getmail-retriever-configuration} parameter} string password"
38376 msgstr ""
38377
38378 #. type: deftypevr
38379 #: guix-git/doc/guix.texi:21495 guix-git/doc/guix.texi:21502
38380 msgid "Override fields from passwd."
38381 msgstr ""
38382
38383 #. type: deftypevr
38384 #: guix-git/doc/guix.texi:21500
38385 #, no-wrap
38386 msgid "{@code{getmail-retriever-configuration} parameter} list password-command"
38387 msgstr ""
38388
38389 #. type: deftypevr
38390 #: guix-git/doc/guix.texi:21507
38391 #, no-wrap
38392 msgid "{@code{getmail-retriever-configuration} parameter} string keyfile"
38393 msgstr ""
38394
38395 #. type: deftypevr
38396 #: guix-git/doc/guix.texi:21509
38397 msgid "PEM-formatted key file to use for the TLS negotiation."
38398 msgstr ""
38399
38400 #. type: deftypevr
38401 #: guix-git/doc/guix.texi:21514
38402 #, no-wrap
38403 msgid "{@code{getmail-retriever-configuration} parameter} string certfile"
38404 msgstr ""
38405
38406 #. type: deftypevr
38407 #: guix-git/doc/guix.texi:21516
38408 msgid "PEM-formatted certificate file to use for the TLS negotiation."
38409 msgstr ""
38410
38411 #. type: deftypevr
38412 #: guix-git/doc/guix.texi:21521
38413 #, no-wrap
38414 msgid "{@code{getmail-retriever-configuration} parameter} string ca-certs"
38415 msgstr ""
38416
38417 #. type: deftypevr
38418 #: guix-git/doc/guix.texi:21523
38419 msgid "CA certificates to use."
38420 msgstr ""
38421
38422 #. type: deftypevr
38423 #: guix-git/doc/guix.texi:21528
38424 #, no-wrap
38425 msgid "{@code{getmail-retriever-configuration} parameter} parameter-alist extra-parameters"
38426 msgstr ""
38427
38428 #. type: deftypevr
38429 #: guix-git/doc/guix.texi:21530
38430 msgid "Extra retriever parameters."
38431 msgstr ""
38432
38433 #. type: deftypevr
38434 #: guix-git/doc/guix.texi:21537
38435 #, no-wrap
38436 msgid "{@code{getmail-configuration-file} parameter} getmail-destination-configuration destination"
38437 msgstr ""
38438
38439 #. type: deftypevr
38440 #: guix-git/doc/guix.texi:21539
38441 msgid "What to do with retrieved messages."
38442 msgstr ""
38443
38444 #. type: deftypevr
38445 #: guix-git/doc/guix.texi:21541
38446 msgid "Available @code{getmail-destination-configuration} fields are:"
38447 msgstr ""
38448
38449 #. type: deftypevr
38450 #: guix-git/doc/guix.texi:21542
38451 #, no-wrap
38452 msgid "{@code{getmail-destination-configuration} parameter} string type"
38453 msgstr ""
38454
38455 #. type: deftypevr
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}."
38458 msgstr ""
38459
38460 #. type: deftypevr
38461 #: guix-git/doc/guix.texi:21550
38462 #, no-wrap
38463 msgid "{@code{getmail-destination-configuration} parameter} string-or-filelike path"
38464 msgstr ""
38465
38466 #. type: deftypevr
38467 #: guix-git/doc/guix.texi:21553
38468 msgid "The path option for the mail destination. The behaviour depends on the chosen type."
38469 msgstr ""
38470
38471 #. type: deftypevr
38472 #: guix-git/doc/guix.texi:21558
38473 #, no-wrap
38474 msgid "{@code{getmail-destination-configuration} parameter} parameter-alist extra-parameters"
38475 msgstr ""
38476
38477 #. type: deftypevr
38478 #: guix-git/doc/guix.texi:21560
38479 msgid "Extra destination parameters"
38480 msgstr ""
38481
38482 #. type: deftypevr
38483 #: guix-git/doc/guix.texi:21567
38484 #, no-wrap
38485 msgid "{@code{getmail-configuration-file} parameter} getmail-options-configuration options"
38486 msgstr ""
38487
38488 #. type: deftypevr
38489 #: guix-git/doc/guix.texi:21569
38490 msgid "Configure getmail."
38491 msgstr ""
38492
38493 #. type: deftypevr
38494 #: guix-git/doc/guix.texi:21571
38495 msgid "Available @code{getmail-options-configuration} fields are:"
38496 msgstr ""
38497
38498 #. type: deftypevr
38499 #: guix-git/doc/guix.texi:21572
38500 #, no-wrap
38501 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer verbose"
38502 msgstr ""
38503
38504 #. type: deftypevr
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."
38507 msgstr ""
38508
38509 #. type: deftypevr
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}."
38513 msgstr ""
38514
38515 #. type: deftypevr
38516 #: guix-git/doc/guix.texi:21582
38517 #, no-wrap
38518 msgid "{@code{getmail-options-configuration} parameter} boolean read-all"
38519 msgstr ""
38520
38521 #. type: deftypevr
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."
38524 msgstr ""
38525
38526 #. type: deftypevr
38527 #: guix-git/doc/guix.texi:21590
38528 #, no-wrap
38529 msgid "{@code{getmail-options-configuration} parameter} boolean delete"
38530 msgstr ""
38531
38532 #. type: deftypevr
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."
38535 msgstr ""
38536
38537 #. type: deftypevr
38538 #: guix-git/doc/guix.texi:21599
38539 #, no-wrap
38540 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-after"
38541 msgstr ""
38542
38543 #. type: deftypevr
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."
38546 msgstr ""
38547
38548 #. type: deftypevr
38549 #: guix-git/doc/guix.texi:21609
38550 #, no-wrap
38551 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer delete-bigger-than"
38552 msgstr ""
38553
38554 #. type: deftypevr
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."
38557 msgstr ""
38558
38559 #. type: deftypevr
38560 #: guix-git/doc/guix.texi:21618
38561 #, no-wrap
38562 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-bytes-per-session"
38563 msgstr ""
38564
38565 #. type: deftypevr
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."
38568 msgstr ""
38569
38570 #. type: deftypevr
38571 #: guix-git/doc/guix.texi:21626
38572 #, no-wrap
38573 msgid "{@code{getmail-options-configuration} parameter} non-negative-integer max-message-size"
38574 msgstr ""
38575
38576 #. type: deftypevr
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."
38579 msgstr ""
38580
38581 #. type: deftypevr
38582 #: guix-git/doc/guix.texi:21634
38583 #, no-wrap
38584 msgid "{@code{getmail-options-configuration} parameter} boolean delivered-to"
38585 msgstr ""
38586
38587 #. type: deftypevr
38588 #: guix-git/doc/guix.texi:21636
38589 msgid "If true, getmail will add a Delivered-To header to messages."
38590 msgstr ""
38591
38592 #. type: deftypevr
38593 #: guix-git/doc/guix.texi:21641
38594 #, no-wrap
38595 msgid "{@code{getmail-options-configuration} parameter} boolean received"
38596 msgstr ""
38597
38598 #. type: deftypevr
38599 #: guix-git/doc/guix.texi:21643
38600 msgid "If set, getmail adds a Received header to the messages."
38601 msgstr ""
38602
38603 #. type: deftypevr
38604 #: guix-git/doc/guix.texi:21648
38605 #, no-wrap
38606 msgid "{@code{getmail-options-configuration} parameter} string message-log"
38607 msgstr ""
38608
38609 #. type: deftypevr
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."
38612 msgstr ""
38613
38614 #. type: deftypevr
38615 #: guix-git/doc/guix.texi:21656
38616 #, no-wrap
38617 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-syslog"
38618 msgstr ""
38619
38620 #. type: deftypevr
38621 #: guix-git/doc/guix.texi:21659
38622 msgid "If true, getmail will record a log of its actions using the system logger."
38623 msgstr ""
38624
38625 #. type: deftypevr
38626 #: guix-git/doc/guix.texi:21664
38627 #, no-wrap
38628 msgid "{@code{getmail-options-configuration} parameter} boolean message-log-verbose"
38629 msgstr ""
38630
38631 #. type: deftypevr
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."
38634 msgstr ""
38635
38636 #. type: deftypevr
38637 #: guix-git/doc/guix.texi:21673
38638 #, no-wrap
38639 msgid "{@code{getmail-options-configuration} parameter} parameter-alist extra-parameters"
38640 msgstr ""
38641
38642 #. type: deftypevr
38643 #: guix-git/doc/guix.texi:21675
38644 msgid "Extra options to include."
38645 msgstr ""
38646
38647 #. type: deftypevr
38648 #: guix-git/doc/guix.texi:21684
38649 #, no-wrap
38650 msgid "{@code{getmail-configuration} parameter} list idle"
38651 msgstr ""
38652
38653 #. type: deftypevr
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."
38656 msgstr ""
38657
38658 #. type: deftypevr
38659 #: guix-git/doc/guix.texi:21693
38660 #, no-wrap
38661 msgid "{@code{getmail-configuration} parameter} list environment-variables"
38662 msgstr ""
38663
38664 #. type: deftypevr
38665 #: guix-git/doc/guix.texi:21695
38666 msgid "Environment variables to set for getmail."
38667 msgstr ""
38668
38669 #. type: subsubheading
38670 #: guix-git/doc/guix.texi:21700
38671 #, no-wrap
38672 msgid "Mail Aliases Service"
38673 msgstr ""
38674
38675 #. type: cindex
38676 #: guix-git/doc/guix.texi:21702
38677 #, no-wrap
38678 msgid "email aliases"
38679 msgstr ""
38680
38681 #. type: cindex
38682 #: guix-git/doc/guix.texi:21703
38683 #, no-wrap
38684 msgid "aliases, for email addresses"
38685 msgstr ""
38686
38687 #. type: deffn
38688 #: guix-git/doc/guix.texi:21705
38689 #, no-wrap
38690 msgid "{Scheme Variable} mail-aliases-service-type"
38691 msgstr ""
38692
38693 #. type: deffn
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."
38696 msgstr ""
38697
38698 #. type: lisp
38699 #: guix-git/doc/guix.texi:21713
38700 #, no-wrap
38701 msgid ""
38702 "(service mail-aliases-service-type\n"
38703 " '((\"postmaster\" \"bob\")\n"
38704 " (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n"
38705 msgstr ""
38706
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."
38710 msgstr ""
38711
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})."
38715 msgstr ""
38716
38717 #. type: cindex
38718 #: guix-git/doc/guix.texi:21728 guix-git/doc/guix.texi:21729
38719 #, no-wrap
38720 msgid "GNU Mailutils IMAP4 Daemon"
38721 msgstr ""
38722
38723 #. type: deffn
38724 #: guix-git/doc/guix.texi:21731
38725 #, no-wrap
38726 msgid "{Scheme Variable} imap4d-service-type"
38727 msgstr ""
38728
38729 #. type: deffn
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:"
38732 msgstr ""
38733
38734 #. type: lisp
38735 #: guix-git/doc/guix.texi:21740
38736 #, no-wrap
38737 msgid ""
38738 "(service imap4d-service-type\n"
38739 " (imap4d-configuration\n"
38740 " (config-file (local-file \"imap4d.conf\"))))\n"
38741 msgstr ""
38742
38743 #. type: deftp
38744 #: guix-git/doc/guix.texi:21743
38745 #, no-wrap
38746 msgid "{Data Type} imap4d-configuration"
38747 msgstr ""
38748
38749 #. type: deftp
38750 #: guix-git/doc/guix.texi:21745
38751 msgid "Data type representing the configuration of @command{imap4d}."
38752 msgstr ""
38753
38754 #. type: item
38755 #: guix-git/doc/guix.texi:21747
38756 #, no-wrap
38757 msgid "@code{package} (default: @code{mailutils})"
38758 msgstr ""
38759
38760 #. type: table
38761 #: guix-git/doc/guix.texi:21749
38762 msgid "The package that provides @command{imap4d}."
38763 msgstr ""
38764
38765 #. type: item
38766 #: guix-git/doc/guix.texi:21750
38767 #, no-wrap
38768 msgid "@code{config-file} (default: @code{%default-imap4d-config-file})"
38769 msgstr ""
38770
38771 #. type: table
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."
38774 msgstr ""
38775
38776 #. type: subsubheading
38777 #: guix-git/doc/guix.texi:21758
38778 #, no-wrap
38779 msgid "Radicale Service"
38780 msgstr ""
38781
38782 #. type: cindex
38783 #: guix-git/doc/guix.texi:21759
38784 #, no-wrap
38785 msgid "CalDAV"
38786 msgstr ""
38787
38788 #. type: cindex
38789 #: guix-git/doc/guix.texi:21760
38790 #, no-wrap
38791 msgid "CardDAV"
38792 msgstr ""
38793
38794 #. type: deffn
38795 #: guix-git/doc/guix.texi:21762
38796 #, no-wrap
38797 msgid "{Scheme Variable} radicale-service-type"
38798 msgstr ""
38799
38800 #. type: deffn
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}."
38803 msgstr ""
38804
38805 #. type: deftp
38806 #: guix-git/doc/guix.texi:21767
38807 #, no-wrap
38808 msgid "{Data Type} radicale-configuration"
38809 msgstr ""
38810
38811 #. type: deftp
38812 #: guix-git/doc/guix.texi:21769
38813 msgid "Data type representing the configuration of @command{radicale}."
38814 msgstr ""
38815
38816 #. type: item
38817 #: guix-git/doc/guix.texi:21771
38818 #, no-wrap
38819 msgid "@code{package} (default: @code{radicale})"
38820 msgstr ""
38821
38822 #. type: table
38823 #: guix-git/doc/guix.texi:21773
38824 msgid "The package that provides @command{radicale}."
38825 msgstr ""
38826
38827 #. type: item
38828 #: guix-git/doc/guix.texi:21774
38829 #, no-wrap
38830 msgid "@code{config-file} (default: @code{%default-radicale-config-file})"
38831 msgstr ""
38832
38833 #. type: table
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."
38836 msgstr ""
38837
38838 #. type: cindex
38839 #: guix-git/doc/guix.texi:21785
38840 #, no-wrap
38841 msgid "messaging"
38842 msgstr ""
38843
38844 #. type: cindex
38845 #: guix-git/doc/guix.texi:21786
38846 #, no-wrap
38847 msgid "jabber"
38848 msgstr ""
38849
38850 #. type: cindex
38851 #: guix-git/doc/guix.texi:21787
38852 #, no-wrap
38853 msgid "XMPP"
38854 msgstr ""
38855
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:"
38859 msgstr ""
38860
38861 #. type: subsubheading
38862 #: guix-git/doc/guix.texi:21792
38863 #, no-wrap
38864 msgid "Prosody Service"
38865 msgstr ""
38866
38867 #. type: deffn
38868 #: guix-git/doc/guix.texi:21794
38869 #, no-wrap
38870 msgid "{Scheme Variable} prosody-service-type"
38871 msgstr ""
38872
38873 #. type: deffn
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:"
38876 msgstr ""
38877
38878 #. type: lisp
38879 #: guix-git/doc/guix.texi:21813
38880 #, no-wrap
38881 msgid ""
38882 "(service prosody-service-type\n"
38883 " (prosody-configuration\n"
38884 " (modules-enabled (cons* \"groups\" \"mam\" %default-modules-enabled))\n"
38885 " (int-components\n"
38886 " (list\n"
38887 " (int-component-configuration\n"
38888 " (hostname \"conference.example.net\")\n"
38889 " (plugin \"muc\")\n"
38890 " (mod-muc (mod-muc-configuration)))))\n"
38891 " (virtualhosts\n"
38892 " (list\n"
38893 " (virtualhost-configuration\n"
38894 " (domain \"example.net\"))))))\n"
38895 msgstr ""
38896
38897 #. type: deffn
38898 #: guix-git/doc/guix.texi:21816
38899 msgid "See below for details about @code{prosody-configuration}."
38900 msgstr ""
38901
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."
38905 msgstr ""
38906
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."
38910 msgstr ""
38911
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}."
38915 msgstr ""
38916
38917 #. type: example
38918 #: guix-git/doc/guix.texi:21832
38919 #, no-wrap
38920 msgid "prosodyctl --root cert import /etc/letsencrypt/live\n"
38921 msgstr ""
38922
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}."
38926 msgstr ""
38927
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."
38931 msgstr ""
38932
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."
38936 msgstr ""
38937
38938 #. type: Plain text
38939 #: guix-git/doc/guix.texi:21856
38940 msgid "Available @code{prosody-configuration} fields are:"
38941 msgstr ""
38942
38943 #. type: deftypevr
38944 #: guix-git/doc/guix.texi:21857
38945 #, no-wrap
38946 msgid "{@code{prosody-configuration} parameter} package prosody"
38947 msgstr ""
38948
38949 #. type: deftypevr
38950 #: guix-git/doc/guix.texi:21859
38951 msgid "The Prosody package."
38952 msgstr ""
38953
38954 #. type: deftypevr
38955 #: guix-git/doc/guix.texi:21861
38956 #, no-wrap
38957 msgid "{@code{prosody-configuration} parameter} file-name data-path"
38958 msgstr ""
38959
38960 #. type: deftypevr
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\"}."
38963 msgstr ""
38964
38965 #. type: deftypevr
38966 #: guix-git/doc/guix.texi:21867
38967 #, no-wrap
38968 msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths"
38969 msgstr ""
38970
38971 #. type: deftypevr
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{()}."
38974 msgstr ""
38975
38976 #. type: deftypevr
38977 #: guix-git/doc/guix.texi:21873
38978 #, no-wrap
38979 msgid "{@code{prosody-configuration} parameter} file-name certificates"
38980 msgstr ""
38981
38982 #. type: deftypevr
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\"}."
38985 msgstr ""
38986
38987 #. type: deftypevr
38988 #: guix-git/doc/guix.texi:21880
38989 #, no-wrap
38990 msgid "{@code{prosody-configuration} parameter} string-list admins"
38991 msgstr ""
38992
38993 #. type: deftypevr
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{()}."
38996 msgstr ""
38997
38998 #. type: deftypevr
38999 #: guix-git/doc/guix.texi:21888
39000 #, no-wrap
39001 msgid "{@code{prosody-configuration} parameter} boolean use-libevent?"
39002 msgstr ""
39003
39004 #. type: deftypevr
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}."
39007 msgstr ""
39008
39009 #. type: deftypevr
39010 #: guix-git/doc/guix.texi:21894
39011 #, no-wrap
39012 msgid "{@code{prosody-configuration} parameter} module-list modules-enabled"
39013 msgstr ""
39014
39015 #. type: deftypevr
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\")}."
39018 msgstr ""
39019
39020 #. type: deftypevr
39021 #: guix-git/doc/guix.texi:21902
39022 #, no-wrap
39023 msgid "{@code{prosody-configuration} parameter} string-list modules-disabled"
39024 msgstr ""
39025
39026 #. type: deftypevr
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{()}."
39029 msgstr ""
39030
39031 #. type: deftypevr
39032 #: guix-git/doc/guix.texi:21908
39033 #, no-wrap
39034 msgid "{@code{prosody-configuration} parameter} file-object groups-file"
39035 msgstr ""
39036
39037 #. type: deftypevr
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\"}."
39040 msgstr ""
39041
39042 #. type: deftypevr
39043 #: guix-git/doc/guix.texi:21915
39044 #, no-wrap
39045 msgid "{@code{prosody-configuration} parameter} boolean allow-registration?"
39046 msgstr ""
39047
39048 #. type: deftypevr
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}."
39051 msgstr ""
39052
39053 #. type: deftypevr
39054 #: guix-git/doc/guix.texi:21921
39055 #, no-wrap
39056 msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl"
39057 msgstr ""
39058
39059 #. type: deftypevr
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}."
39062 msgstr ""
39063
39064 #. type: deftypevr
39065 #: guix-git/doc/guix.texi:21928
39066 msgid "Available @code{ssl-configuration} fields are:"
39067 msgstr ""
39068
39069 #. type: deftypevr
39070 #: guix-git/doc/guix.texi:21929
39071 #, no-wrap
39072 msgid "{@code{ssl-configuration} parameter} maybe-string protocol"
39073 msgstr ""
39074
39075 #. type: deftypevr
39076 #: guix-git/doc/guix.texi:21931
39077 msgid "This determines what handshake to use."
39078 msgstr ""
39079
39080 #. type: deftypevr
39081 #: guix-git/doc/guix.texi:21933
39082 #, no-wrap
39083 msgid "{@code{ssl-configuration} parameter} maybe-file-name key"
39084 msgstr ""
39085
39086 #. type: deftypevr
39087 #: guix-git/doc/guix.texi:21935
39088 msgid "Path to your private key file."
39089 msgstr ""
39090
39091 #. type: deftypevr
39092 #: guix-git/doc/guix.texi:21937
39093 #, no-wrap
39094 msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate"
39095 msgstr ""
39096
39097 #. type: deftypevr
39098 #: guix-git/doc/guix.texi:21939
39099 msgid "Path to your certificate file."
39100 msgstr ""
39101
39102 #. type: deftypevr
39103 #: guix-git/doc/guix.texi:21941
39104 #, no-wrap
39105 msgid "{@code{ssl-configuration} parameter} file-object capath"
39106 msgstr ""
39107
39108 #. type: deftypevr
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\"}."
39111 msgstr ""
39112
39113 #. type: deftypevr
39114 #: guix-git/doc/guix.texi:21947
39115 #, no-wrap
39116 msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile"
39117 msgstr ""
39118
39119 #. type: deftypevr
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."
39122 msgstr ""
39123
39124 #. type: deftypevr
39125 #: guix-git/doc/guix.texi:21952
39126 #, no-wrap
39127 msgid "{@code{ssl-configuration} parameter} maybe-string-list verify"
39128 msgstr ""
39129
39130 #. type: deftypevr
39131 #: guix-git/doc/guix.texi:21955
39132 msgid "A list of verification options (these mostly map to OpenSSL's @code{set_verify()} flags)."
39133 msgstr ""
39134
39135 #. type: deftypevr
39136 #: guix-git/doc/guix.texi:21957
39137 #, no-wrap
39138 msgid "{@code{ssl-configuration} parameter} maybe-string-list options"
39139 msgstr ""
39140
39141 #. type: deftypevr
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."
39144 msgstr ""
39145
39146 #. type: deftypevr
39147 #: guix-git/doc/guix.texi:21963
39148 #, no-wrap
39149 msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth"
39150 msgstr ""
39151
39152 #. type: deftypevr
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."
39155 msgstr ""
39156
39157 #. type: deftypevr
39158 #: guix-git/doc/guix.texi:21968
39159 #, no-wrap
39160 msgid "{@code{ssl-configuration} parameter} maybe-string ciphers"
39161 msgstr ""
39162
39163 #. type: deftypevr
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."
39166 msgstr ""
39167
39168 #. type: deftypevr
39169 #: guix-git/doc/guix.texi:21973
39170 #, no-wrap
39171 msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam"
39172 msgstr ""
39173
39174 #. type: deftypevr
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}"
39177 msgstr ""
39178
39179 #. type: deftypevr
39180 #: guix-git/doc/guix.texi:21979
39181 #, no-wrap
39182 msgid "{@code{ssl-configuration} parameter} maybe-string curve"
39183 msgstr ""
39184
39185 #. type: deftypevr
39186 #: guix-git/doc/guix.texi:21982
39187 msgid "Curve for Elliptic curve Diffie-Hellman. Prosody's default is @samp{\"secp384r1\"}."
39188 msgstr ""
39189
39190 #. type: deftypevr
39191 #: guix-git/doc/guix.texi:21984
39192 #, no-wrap
39193 msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext"
39194 msgstr ""
39195
39196 #. type: deftypevr
39197 #: guix-git/doc/guix.texi:21986
39198 msgid "A list of ``extra'' verification options."
39199 msgstr ""
39200
39201 #. type: deftypevr
39202 #: guix-git/doc/guix.texi:21988
39203 #, no-wrap
39204 msgid "{@code{ssl-configuration} parameter} maybe-string password"
39205 msgstr ""
39206
39207 #. type: deftypevr
39208 #: guix-git/doc/guix.texi:21990
39209 msgid "Password for encrypted private keys."
39210 msgstr ""
39211
39212 #. type: deftypevr
39213 #: guix-git/doc/guix.texi:21994
39214 #, no-wrap
39215 msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?"
39216 msgstr ""
39217
39218 #. type: deftypevr
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}."
39221 msgstr ""
39222
39223 #. type: deftypevr
39224 #: guix-git/doc/guix.texi:22000
39225 #, no-wrap
39226 msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms"
39227 msgstr ""
39228
39229 #. type: deftypevr
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\")}."
39232 msgstr ""
39233
39234 #. type: deftypevr
39235 #: guix-git/doc/guix.texi:22006
39236 #, no-wrap
39237 msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?"
39238 msgstr ""
39239
39240 #. type: deftypevr
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}."
39243 msgstr ""
39244
39245 #. type: deftypevr
39246 #: guix-git/doc/guix.texi:22012
39247 #, no-wrap
39248 msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?"
39249 msgstr ""
39250
39251 #. type: deftypevr
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}."
39254 msgstr ""
39255
39256 #. type: deftypevr
39257 #: guix-git/doc/guix.texi:22020
39258 #, no-wrap
39259 msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains"
39260 msgstr ""
39261
39262 #. type: deftypevr
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{()}."
39265 msgstr ""
39266
39267 #. type: deftypevr
39268 #: guix-git/doc/guix.texi:22028
39269 #, no-wrap
39270 msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains"
39271 msgstr ""
39272
39273 #. type: deftypevr
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{()}."
39276 msgstr ""
39277
39278 #. type: deftypevr
39279 #: guix-git/doc/guix.texi:22035
39280 #, no-wrap
39281 msgid "{@code{prosody-configuration} parameter} string authentication"
39282 msgstr ""
39283
39284 #. type: deftypevr
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\"}."
39287 msgstr ""
39288
39289 #. type: deftypevr
39290 #: guix-git/doc/guix.texi:22045
39291 #, no-wrap
39292 msgid "{@code{prosody-configuration} parameter} maybe-string log"
39293 msgstr ""
39294
39295 #. type: deftypevr
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\"}."
39298 msgstr ""
39299
39300 #. type: deftypevr
39301 #: guix-git/doc/guix.texi:22051
39302 #, no-wrap
39303 msgid "{@code{prosody-configuration} parameter} file-name pidfile"
39304 msgstr ""
39305
39306 #. type: deftypevr
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\"}."
39309 msgstr ""
39310
39311 #. type: deftypevr
39312 #: guix-git/doc/guix.texi:22056
39313 #, no-wrap
39314 msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size"
39315 msgstr ""
39316
39317 #. type: deftypevr
39318 #: guix-git/doc/guix.texi:22058
39319 msgid "Maximum allowed size of the HTTP body (in bytes)."
39320 msgstr ""
39321
39322 #. type: deftypevr
39323 #: guix-git/doc/guix.texi:22060
39324 #, no-wrap
39325 msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url"
39326 msgstr ""
39327
39328 #. type: deftypevr
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}."
39331 msgstr ""
39332
39333 #. type: deftypevr
39334 #: guix-git/doc/guix.texi:22067
39335 #, no-wrap
39336 msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts"
39337 msgstr ""
39338
39339 #. type: deftypevr
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."
39342 msgstr ""
39343
39344 #. type: deftypevr
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."
39347 msgstr ""
39348
39349 #. type: deftypevr
39350 #: guix-git/doc/guix.texi:22080
39351 msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}."
39352 msgstr ""
39353
39354 #. type: deftypevr
39355 #: guix-git/doc/guix.texi:22082
39356 msgid "Available @code{virtualhost-configuration} fields are:"
39357 msgstr ""
39358
39359 #. type: deftypevr
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:"
39363 msgstr ""
39364
39365 #. type: deftypevr
39366 #: guix-git/doc/guix.texi:22084
39367 #, no-wrap
39368 msgid "{@code{virtualhost-configuration} parameter} string domain"
39369 msgstr ""
39370
39371 #. type: deftypevr
39372 #: guix-git/doc/guix.texi:22086
39373 msgid "Domain you wish Prosody to serve."
39374 msgstr ""
39375
39376 #. type: deftypevr
39377 #: guix-git/doc/guix.texi:22090
39378 #, no-wrap
39379 msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components"
39380 msgstr ""
39381
39382 #. type: deftypevr
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."
39385 msgstr ""
39386
39387 #. type: deftypevr
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."
39390 msgstr ""
39391
39392 #. type: deftypevr
39393 #: guix-git/doc/guix.texi:22102
39394 msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}."
39395 msgstr ""
39396
39397 #. type: deftypevr
39398 #: guix-git/doc/guix.texi:22104
39399 msgid "Available @code{int-component-configuration} fields are:"
39400 msgstr ""
39401
39402 #. type: deftypevr
39403 #: guix-git/doc/guix.texi:22106
39404 #, no-wrap
39405 msgid "{@code{int-component-configuration} parameter} string hostname"
39406 msgstr ""
39407
39408 #. type: deftypevr
39409 #: guix-git/doc/guix.texi:22108 guix-git/doc/guix.texi:22165
39410 msgid "Hostname of the component."
39411 msgstr ""
39412
39413 #. type: deftypevr
39414 #: guix-git/doc/guix.texi:22110
39415 #, no-wrap
39416 msgid "{@code{int-component-configuration} parameter} string plugin"
39417 msgstr ""
39418
39419 #. type: deftypevr
39420 #: guix-git/doc/guix.texi:22112
39421 msgid "Plugin you wish to use for the component."
39422 msgstr ""
39423
39424 #. type: deftypevr
39425 #: guix-git/doc/guix.texi:22114
39426 #, no-wrap
39427 msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc"
39428 msgstr ""
39429
39430 #. type: deftypevr
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."
39433 msgstr ""
39434
39435 #. type: deftypevr
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."
39438 msgstr ""
39439
39440 #. type: deftypevr
39441 #: guix-git/doc/guix.texi:22123
39442 msgid "See also @url{https://prosody.im/doc/modules/mod_muc}."
39443 msgstr ""
39444
39445 #. type: deftypevr
39446 #: guix-git/doc/guix.texi:22125
39447 msgid "Available @code{mod-muc-configuration} fields are:"
39448 msgstr ""
39449
39450 #. type: deftypevr
39451 #: guix-git/doc/guix.texi:22126
39452 #, no-wrap
39453 msgid "{@code{mod-muc-configuration} parameter} string name"
39454 msgstr ""
39455
39456 #. type: deftypevr
39457 #: guix-git/doc/guix.texi:22129
39458 msgid "The name to return in service discovery responses. Defaults to @samp{\"Prosody Chatrooms\"}."
39459 msgstr ""
39460
39461 #. type: deftypevr
39462 #: guix-git/doc/guix.texi:22131
39463 #, no-wrap
39464 msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation"
39465 msgstr ""
39466
39467 #. type: deftypevr
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}."
39470 msgstr ""
39471
39472 #. type: deftypevr
39473 #: guix-git/doc/guix.texi:22140
39474 #, no-wrap
39475 msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages"
39476 msgstr ""
39477
39478 #. type: deftypevr
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}."
39481 msgstr ""
39482
39483 #. type: deftypevr
39484 #: guix-git/doc/guix.texi:22150
39485 #, no-wrap
39486 msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components"
39487 msgstr ""
39488
39489 #. type: deftypevr
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{()}."
39492 msgstr ""
39493
39494 #. type: deftypevr
39495 #: guix-git/doc/guix.texi:22157
39496 msgid "Available @code{ext-component-configuration} fields are:"
39497 msgstr ""
39498
39499 #. type: deftypevr
39500 #: guix-git/doc/guix.texi:22159
39501 #, no-wrap
39502 msgid "{@code{ext-component-configuration} parameter} string component-secret"
39503 msgstr ""
39504
39505 #. type: deftypevr
39506 #: guix-git/doc/guix.texi:22161
39507 msgid "Password which the component will use to log in."
39508 msgstr ""
39509
39510 #. type: deftypevr
39511 #: guix-git/doc/guix.texi:22163
39512 #, no-wrap
39513 msgid "{@code{ext-component-configuration} parameter} string hostname"
39514 msgstr ""
39515
39516 #. type: deftypevr
39517 #: guix-git/doc/guix.texi:22169
39518 #, no-wrap
39519 msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports"
39520 msgstr ""
39521
39522 #. type: deftypevr
39523 #: guix-git/doc/guix.texi:22172
39524 msgid "Port(s) Prosody listens on for component connections. Defaults to @samp{(5347)}."
39525 msgstr ""
39526
39527 #. type: deftypevr
39528 #: guix-git/doc/guix.texi:22174
39529 #, no-wrap
39530 msgid "{@code{prosody-configuration} parameter} string component-interface"
39531 msgstr ""
39532
39533 #. type: deftypevr
39534 #: guix-git/doc/guix.texi:22177
39535 msgid "Interface Prosody listens on for component connections. Defaults to @samp{\"127.0.0.1\"}."
39536 msgstr ""
39537
39538 #. type: deftypevr
39539 #: guix-git/doc/guix.texi:22179
39540 #, no-wrap
39541 msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content"
39542 msgstr ""
39543
39544 #. type: deftypevr
39545 #: guix-git/doc/guix.texi:22181
39546 msgid "Raw content that will be added to the configuration file."
39547 msgstr ""
39548
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:"
39552 msgstr ""
39553
39554 #. type: deftypevr
39555 #: guix-git/doc/guix.texi:22190
39556 #, no-wrap
39557 msgid "{@code{opaque-prosody-configuration} parameter} package prosody"
39558 msgstr ""
39559
39560 #. type: deftypevr
39561 #: guix-git/doc/guix.texi:22192
39562 msgid "The prosody package."
39563 msgstr ""
39564
39565 #. type: deftypevr
39566 #: guix-git/doc/guix.texi:22194
39567 #, no-wrap
39568 msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua"
39569 msgstr ""
39570
39571 #. type: deftypevr
39572 #: guix-git/doc/guix.texi:22196
39573 msgid "The contents of the @code{prosody.cfg.lua} to use."
39574 msgstr ""
39575
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:"
39579 msgstr ""
39580
39581 #. type: lisp
39582 #: guix-git/doc/guix.texi:22205
39583 #, no-wrap
39584 msgid ""
39585 "(service prosody-service-type\n"
39586 " (opaque-prosody-configuration\n"
39587 " (prosody.cfg.lua \"\")))\n"
39588 msgstr ""
39589
39590 #. type: subsubheading
39591 #: guix-git/doc/guix.texi:22209
39592 #, no-wrap
39593 msgid "BitlBee Service"
39594 msgstr ""
39595
39596 #. type: cindex
39597 #: guix-git/doc/guix.texi:22211 guix-git/doc/guix.texi:22255
39598 #, no-wrap
39599 msgid "IRC (Internet Relay Chat)"
39600 msgstr ""
39601
39602 #. type: cindex
39603 #: guix-git/doc/guix.texi:22212
39604 #, no-wrap
39605 msgid "IRC gateway"
39606 msgstr ""
39607
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."
39611 msgstr ""
39612
39613 #. type: defvr
39614 #: guix-git/doc/guix.texi:22216
39615 #, no-wrap
39616 msgid "{Scheme Variable} bitlbee-service-type"
39617 msgstr ""
39618
39619 #. type: defvr
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)."
39622 msgstr ""
39623
39624 #. type: defvr
39625 #: guix-git/doc/guix.texi:22223
39626 msgid "To have BitlBee listen on port 6667 on localhost, add this line to your services:"
39627 msgstr ""
39628
39629 #. type: lisp
39630 #: guix-git/doc/guix.texi:22226
39631 #, no-wrap
39632 msgid "(service bitlbee-service-type)\n"
39633 msgstr ""
39634
39635 #. type: deftp
39636 #: guix-git/doc/guix.texi:22229
39637 #, no-wrap
39638 msgid "{Data Type} bitlbee-configuration"
39639 msgstr ""
39640
39641 #. type: deftp
39642 #: guix-git/doc/guix.texi:22231
39643 msgid "This is the configuration for BitlBee, with the following fields:"
39644 msgstr ""
39645
39646 #. type: item
39647 #: guix-git/doc/guix.texi:22233
39648 #, no-wrap
39649 msgid "@code{interface} (default: @code{\"127.0.0.1\"})"
39650 msgstr ""
39651
39652 #. type: itemx
39653 #: guix-git/doc/guix.texi:22234
39654 #, no-wrap
39655 msgid "@code{port} (default: @code{6667})"
39656 msgstr ""
39657
39658 #. type: table
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}."
39661 msgstr ""
39662
39663 #. type: table
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."
39666 msgstr ""
39667
39668 #. type: item
39669 #: guix-git/doc/guix.texi:22242
39670 #, no-wrap
39671 msgid "@code{bitlbee} (default: @code{bitlbee})"
39672 msgstr ""
39673
39674 #. type: table
39675 #: guix-git/doc/guix.texi:22244
39676 msgid "The BitlBee package to use."
39677 msgstr ""
39678
39679 #. type: item
39680 #: guix-git/doc/guix.texi:22245
39681 #, no-wrap
39682 msgid "@code{plugins} (default: @code{'()})"
39683 msgstr ""
39684
39685 #. type: table
39686 #: guix-git/doc/guix.texi:22247
39687 msgid "List of plugin packages to use---e.g., @code{bitlbee-discord}."
39688 msgstr ""
39689
39690 #. type: table
39691 #: guix-git/doc/guix.texi:22250
39692 msgid "Configuration snippet added as-is to the BitlBee configuration file."
39693 msgstr ""
39694
39695 #. type: subsubheading
39696 #: guix-git/doc/guix.texi:22253
39697 #, no-wrap
39698 msgid "Quassel Service"
39699 msgstr ""
39700
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."
39704 msgstr ""
39705
39706 #. type: defvr
39707 #: guix-git/doc/guix.texi:22260
39708 #, no-wrap
39709 msgid "{Scheme Variable} quassel-service-type"
39710 msgstr ""
39711
39712 #. type: defvr
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)."
39715 msgstr ""
39716
39717 #. type: deftp
39718 #: guix-git/doc/guix.texi:22266
39719 #, no-wrap
39720 msgid "{Data Type} quassel-configuration"
39721 msgstr ""
39722
39723 #. type: deftp
39724 #: guix-git/doc/guix.texi:22268
39725 msgid "This is the configuration for Quassel, with the following fields:"
39726 msgstr ""
39727
39728 #. type: item
39729 #: guix-git/doc/guix.texi:22270
39730 #, no-wrap
39731 msgid "@code{quassel} (default: @code{quassel})"
39732 msgstr ""
39733
39734 #. type: table
39735 #: guix-git/doc/guix.texi:22272
39736 msgid "The Quassel package to use."
39737 msgstr ""
39738
39739 #. type: item
39740 #: guix-git/doc/guix.texi:22273
39741 #, no-wrap
39742 msgid "@code{interface} (default: @code{\"::,0.0.0.0\"})"
39743 msgstr ""
39744
39745 #. type: item
39746 #: guix-git/doc/guix.texi:22274
39747 #, no-wrap
39748 msgid "@code{port} (default: @code{4242})"
39749 msgstr ""
39750
39751 #. type: table
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}."
39754 msgstr ""
39755
39756 #. type: item
39757 #: guix-git/doc/guix.texi:22279
39758 #, no-wrap
39759 msgid "@code{loglevel} (default: @code{\"Info\"})"
39760 msgstr ""
39761
39762 #. type: table
39763 #: guix-git/doc/guix.texi:22282
39764 msgid "The level of logging desired. Accepted values are Debug, Info, Warning and Error."
39765 msgstr ""
39766
39767 #. type: cindex
39768 #: guix-git/doc/guix.texi:22288
39769 #, no-wrap
39770 msgid "Murmur (VoIP server)"
39771 msgstr ""
39772
39773 #. type: cindex
39774 #: guix-git/doc/guix.texi:22289
39775 #, no-wrap
39776 msgid "VoIP server"
39777 msgstr ""
39778
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."
39782 msgstr ""
39783
39784 #. type: deftp
39785 #: guix-git/doc/guix.texi:22294
39786 #, no-wrap
39787 msgid "{Data Type} murmur-configuration"
39788 msgstr ""
39789
39790 #. type: deftp
39791 #: guix-git/doc/guix.texi:22297
39792 msgid "The service type for the Murmur server. An example configuration can look like this:"
39793 msgstr ""
39794
39795 #. type: lisp
39796 #: guix-git/doc/guix.texi:22306
39797 #, no-wrap
39798 msgid ""
39799 "(service murmur-service-type\n"
39800 " (murmur-configuration\n"
39801 " (welcome-text\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"
39806 msgstr ""
39807
39808 #. type: deftp
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."
39811 msgstr ""
39812
39813 #. type: deftp
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."
39816 msgstr ""
39817
39818 #. type: deftp
39819 #: guix-git/doc/guix.texi:22321
39820 msgid "Available @code{murmur-configuration} fields are:"
39821 msgstr ""
39822
39823 #. type: item
39824 #: guix-git/doc/guix.texi:22323
39825 #, no-wrap
39826 msgid "@code{package} (default: @code{mumble})"
39827 msgstr ""
39828
39829 #. type: table
39830 #: guix-git/doc/guix.texi:22325
39831 msgid "Package that contains @code{bin/murmurd}."
39832 msgstr ""
39833
39834 #. type: item
39835 #: guix-git/doc/guix.texi:22326
39836 #, no-wrap
39837 msgid "@code{user} (default: @code{\"murmur\"})"
39838 msgstr ""
39839
39840 #. type: table
39841 #: guix-git/doc/guix.texi:22328
39842 msgid "User who will run the Murmur server."
39843 msgstr ""
39844
39845 #. type: item
39846 #: guix-git/doc/guix.texi:22329
39847 #, no-wrap
39848 msgid "@code{group} (default: @code{\"murmur\"})"
39849 msgstr ""
39850
39851 #. type: table
39852 #: guix-git/doc/guix.texi:22331
39853 msgid "Group of the user who will run the murmur server."
39854 msgstr ""
39855
39856 #. type: item
39857 #: guix-git/doc/guix.texi:22332
39858 #, no-wrap
39859 msgid "@code{port} (default: @code{64738})"
39860 msgstr ""
39861
39862 #. type: table
39863 #: guix-git/doc/guix.texi:22334
39864 msgid "Port on which the server will listen."
39865 msgstr ""
39866
39867 #. type: item
39868 #: guix-git/doc/guix.texi:22335
39869 #, no-wrap
39870 msgid "@code{welcome-text} (default: @code{\"\"})"
39871 msgstr ""
39872
39873 #. type: table
39874 #: guix-git/doc/guix.texi:22337
39875 msgid "Welcome text sent to clients when they connect."
39876 msgstr ""
39877
39878 #. type: item
39879 #: guix-git/doc/guix.texi:22338
39880 #, no-wrap
39881 msgid "@code{server-password} (default: @code{\"\"})"
39882 msgstr ""
39883
39884 #. type: table
39885 #: guix-git/doc/guix.texi:22340
39886 msgid "Password the clients have to enter in order to connect."
39887 msgstr ""
39888
39889 #. type: item
39890 #: guix-git/doc/guix.texi:22341
39891 #, no-wrap
39892 msgid "@code{max-users} (default: @code{100})"
39893 msgstr ""
39894
39895 #. type: table
39896 #: guix-git/doc/guix.texi:22343
39897 msgid "Maximum of users that can be connected to the server at once."
39898 msgstr ""
39899
39900 #. type: item
39901 #: guix-git/doc/guix.texi:22344
39902 #, no-wrap
39903 msgid "@code{max-user-bandwidth} (default: @code{#f})"
39904 msgstr ""
39905
39906 #. type: table
39907 #: guix-git/doc/guix.texi:22346
39908 msgid "Maximum voice traffic a user can send per second."
39909 msgstr ""
39910
39911 #. type: item
39912 #: guix-git/doc/guix.texi:22347
39913 #, no-wrap
39914 msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})"
39915 msgstr ""
39916
39917 #. type: table
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."
39920 msgstr ""
39921
39922 #. type: item
39923 #: guix-git/doc/guix.texi:22351
39924 #, no-wrap
39925 msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})"
39926 msgstr ""
39927
39928 #. type: table
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."
39931 msgstr ""
39932
39933 #. type: item
39934 #: guix-git/doc/guix.texi:22355
39935 #, no-wrap
39936 msgid "@code{autoban-attempts} (default: @code{10})"
39937 msgstr ""
39938
39939 #. type: table
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}."
39942 msgstr ""
39943
39944 #. type: item
39945 #: guix-git/doc/guix.texi:22359
39946 #, no-wrap
39947 msgid "@code{autoban-timeframe} (default: @code{120})"
39948 msgstr ""
39949
39950 #. type: table
39951 #: guix-git/doc/guix.texi:22361
39952 msgid "Timeframe for autoban in seconds."
39953 msgstr ""
39954
39955 #. type: item
39956 #: guix-git/doc/guix.texi:22362
39957 #, no-wrap
39958 msgid "@code{autoban-time} (default: @code{300})"
39959 msgstr ""
39960
39961 #. type: table
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."
39964 msgstr ""
39965
39966 #. type: item
39967 #: guix-git/doc/guix.texi:22366
39968 #, no-wrap
39969 msgid "@code{opus-threshold} (default: @code{100})"
39970 msgstr ""
39971
39972 #. type: table
39973 #: guix-git/doc/guix.texi:22369
39974 msgid "Percentage of clients that need to support opus before switching over to opus audio codec."
39975 msgstr ""
39976
39977 #. type: item
39978 #: guix-git/doc/guix.texi:22370
39979 #, no-wrap
39980 msgid "@code{channel-nesting-limit} (default: @code{10})"
39981 msgstr ""
39982
39983 #. type: table
39984 #: guix-git/doc/guix.texi:22372
39985 msgid "How deep channels can be nested at maximum."
39986 msgstr ""
39987
39988 #. type: item
39989 #: guix-git/doc/guix.texi:22373
39990 #, no-wrap
39991 msgid "@code{channelname-regex} (default: @code{#f})"
39992 msgstr ""
39993
39994 #. type: table
39995 #: guix-git/doc/guix.texi:22375
39996 msgid "A string in form of a Qt regular expression that channel names must conform to."
39997 msgstr ""
39998
39999 #. type: item
40000 #: guix-git/doc/guix.texi:22376
40001 #, no-wrap
40002 msgid "@code{username-regex} (default: @code{#f})"
40003 msgstr ""
40004
40005 #. type: table
40006 #: guix-git/doc/guix.texi:22378
40007 msgid "A string in form of a Qt regular expression that user names must conform to."
40008 msgstr ""
40009
40010 #. type: item
40011 #: guix-git/doc/guix.texi:22379
40012 #, no-wrap
40013 msgid "@code{text-message-length} (default: @code{5000})"
40014 msgstr ""
40015
40016 #. type: table
40017 #: guix-git/doc/guix.texi:22381
40018 msgid "Maximum size in bytes that a user can send in one text chat message."
40019 msgstr ""
40020
40021 #. type: item
40022 #: guix-git/doc/guix.texi:22382
40023 #, no-wrap
40024 msgid "@code{image-message-length} (default: @code{(* 128 1024)})"
40025 msgstr ""
40026
40027 #. type: table
40028 #: guix-git/doc/guix.texi:22384
40029 msgid "Maximum size in bytes that a user can send in one image message."
40030 msgstr ""
40031
40032 #. type: item
40033 #: guix-git/doc/guix.texi:22385
40034 #, no-wrap
40035 msgid "@code{cert-required?} (default: @code{#f})"
40036 msgstr ""
40037
40038 #. type: table
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."
40041 msgstr ""
40042
40043 #. type: item
40044 #: guix-git/doc/guix.texi:22389
40045 #, no-wrap
40046 msgid "@code{remember-channel?} (default: @code{#f})"
40047 msgstr ""
40048
40049 #. type: table
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."
40052 msgstr ""
40053
40054 #. type: item
40055 #: guix-git/doc/guix.texi:22393
40056 #, no-wrap
40057 msgid "@code{allow-html?} (default: @code{#f})"
40058 msgstr ""
40059
40060 #. type: table
40061 #: guix-git/doc/guix.texi:22395
40062 msgid "Should html be allowed in text messages, user comments, and channel descriptions."
40063 msgstr ""
40064
40065 #. type: item
40066 #: guix-git/doc/guix.texi:22396
40067 #, no-wrap
40068 msgid "@code{allow-ping?} (default: @code{#f})"
40069 msgstr ""
40070
40071 #. type: table
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."
40074 msgstr ""
40075
40076 #. type: table
40077 #: guix-git/doc/guix.texi:22402
40078 msgid "Disabling this setting will prevent public listing of the server."
40079 msgstr ""
40080
40081 #. type: item
40082 #: guix-git/doc/guix.texi:22403
40083 #, no-wrap
40084 msgid "@code{bonjour?} (default: @code{#f})"
40085 msgstr ""
40086
40087 #. type: table
40088 #: guix-git/doc/guix.texi:22405
40089 msgid "Should the server advertise itself in the local network through the bonjour protocol."
40090 msgstr ""
40091
40092 #. type: item
40093 #: guix-git/doc/guix.texi:22406
40094 #, no-wrap
40095 msgid "@code{send-version?} (default: @code{#f})"
40096 msgstr ""
40097
40098 #. type: table
40099 #: guix-git/doc/guix.texi:22408
40100 msgid "Should the murmur server version be exposed in ping requests."
40101 msgstr ""
40102
40103 #. type: item
40104 #: guix-git/doc/guix.texi:22409
40105 #, no-wrap
40106 msgid "@code{log-days} (default: @code{31})"
40107 msgstr ""
40108
40109 #. type: table
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."
40112 msgstr ""
40113
40114 #. type: item
40115 #: guix-git/doc/guix.texi:22414
40116 #, no-wrap
40117 msgid "@code{obfuscate-ips?} (default: @code{#t})"
40118 msgstr ""
40119
40120 #. type: table
40121 #: guix-git/doc/guix.texi:22416
40122 msgid "Should logged ips be obfuscated to protect the privacy of users."
40123 msgstr ""
40124
40125 #. type: item
40126 #: guix-git/doc/guix.texi:22417
40127 #, no-wrap
40128 msgid "@code{ssl-cert} (default: @code{#f})"
40129 msgstr ""
40130
40131 #. type: table
40132 #: guix-git/doc/guix.texi:22419
40133 msgid "File name of the SSL/TLS certificate used for encrypted connections."
40134 msgstr ""
40135
40136 #. type: lisp
40137 #: guix-git/doc/guix.texi:22422
40138 #, no-wrap
40139 msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n"
40140 msgstr ""
40141
40142 #. type: item
40143 #: guix-git/doc/guix.texi:22423
40144 #, no-wrap
40145 msgid "@code{ssl-key} (default: @code{#f})"
40146 msgstr ""
40147
40148 #. type: table
40149 #: guix-git/doc/guix.texi:22425
40150 msgid "Filepath to the ssl private key used for encrypted connections."
40151 msgstr ""
40152
40153 #. type: lisp
40154 #: guix-git/doc/guix.texi:22427
40155 #, no-wrap
40156 msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n"
40157 msgstr ""
40158
40159 #. type: item
40160 #: guix-git/doc/guix.texi:22429
40161 #, no-wrap
40162 msgid "@code{ssl-dh-params} (default: @code{#f})"
40163 msgstr ""
40164
40165 #. type: table
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."
40168 msgstr ""
40169
40170 #. type: item
40171 #: guix-git/doc/guix.texi:22435
40172 #, no-wrap
40173 msgid "@code{ssl-ciphers} (default: @code{#f})"
40174 msgstr ""
40175
40176 #. type: table
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."
40179 msgstr ""
40180
40181 #. type: table
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}."
40184 msgstr ""
40185
40186 #. type: table
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."
40189 msgstr ""
40190
40191 #. type: table
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."
40194 msgstr ""
40195
40196 #. type: item
40197 #: guix-git/doc/guix.texi:22452
40198 #, no-wrap
40199 msgid "@code{public-registration} (default: @code{#f})"
40200 msgstr ""
40201
40202 #. type: table
40203 #: guix-git/doc/guix.texi:22454
40204 msgid "Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}."
40205 msgstr ""
40206
40207 #. type: table
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}."
40210 msgstr ""
40211
40212 #. type: table
40213 #: guix-git/doc/guix.texi:22461
40214 msgid "It might take a few hours until it shows up in the public list."
40215 msgstr ""
40216
40217 #. type: item
40218 #: guix-git/doc/guix.texi:22462 guix-git/doc/guix.texi:24698
40219 #, no-wrap
40220 msgid "@code{file} (default: @code{#f})"
40221 msgstr ""
40222
40223 #. type: table
40224 #: guix-git/doc/guix.texi:22464
40225 msgid "Optional alternative override for this configuration."
40226 msgstr ""
40227
40228 #. type: deftp
40229 #: guix-git/doc/guix.texi:22467
40230 #, no-wrap
40231 msgid "{Data Type} murmur-public-registration-configuration"
40232 msgstr ""
40233
40234 #. type: deftp
40235 #: guix-git/doc/guix.texi:22469
40236 msgid "Configuration for public registration of a murmur service."
40237 msgstr ""
40238
40239 #. type: table
40240 #: guix-git/doc/guix.texi:22473
40241 msgid "This is a display name for your server. Not to be confused with the hostname."
40242 msgstr ""
40243
40244 #. type: itemx
40245 #: guix-git/doc/guix.texi:22474 guix-git/doc/guix.texi:31149
40246 #: guix-git/doc/guix.texi:32190
40247 #, no-wrap
40248 msgid "password"
40249 msgstr ""
40250
40251 #. type: table
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."
40254 msgstr ""
40255
40256 #. type: table
40257 #: guix-git/doc/guix.texi:22481
40258 msgid "This should be a @code{http://} or @code{https://} link to your web site."
40259 msgstr ""
40260
40261 #. type: item
40262 #: guix-git/doc/guix.texi:22482 guix-git/doc/guix.texi:25577
40263 #, no-wrap
40264 msgid "@code{hostname} (default: @code{#f})"
40265 msgstr ""
40266
40267 #. type: table
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."
40270 msgstr ""
40271
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."
40275 msgstr ""
40276
40277 #. type: subsubheading
40278 #: guix-git/doc/guix.texi:22496
40279 #, no-wrap
40280 msgid "Transmission Daemon Service"
40281 msgstr ""
40282
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."
40286 msgstr ""
40287
40288 #. type: deffn
40289 #: guix-git/doc/guix.texi:22505
40290 #, no-wrap
40291 msgid "{Scheme Variable} transmission-daemon-service-type"
40292 msgstr ""
40293
40294 #. type: deffn
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:"
40297 msgstr ""
40298
40299 #. type: lisp
40300 #: guix-git/doc/guix.texi:22520
40301 #, no-wrap
40302 msgid ""
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"
40308 " (rpc-password\n"
40309 " (transmission-password-hash\n"
40310 " \"transmission\" ; desired password\n"
40311 " \"uKd1uMs9\")) ; arbitrary salt value\n"
40312 "\n"
40313 msgstr ""
40314
40315 #. type: lisp
40316 #: guix-git/doc/guix.texi:22525
40317 #, no-wrap
40318 msgid ""
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"
40323 "\n"
40324 msgstr ""
40325
40326 #. type: lisp
40327 #: guix-git/doc/guix.texi:22529
40328 #, no-wrap
40329 msgid ""
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"
40333 "\n"
40334 msgstr ""
40335
40336 #. type: lisp
40337 #: guix-git/doc/guix.texi:22536
40338 #, no-wrap
40339 msgid ""
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"
40346 msgstr ""
40347
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."
40351 msgstr ""
40352
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."
40356 msgstr ""
40357
40358 #. type: deffn
40359 #: guix-git/doc/guix.texi:22558
40360 #, no-wrap
40361 msgid "{Scheme Procedure} transmission-password-hash @var{password} @var{salt}"
40362 msgstr ""
40363
40364 #. type: deffn
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."
40367 msgstr ""
40368
40369 #. type: deffn
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."
40372 msgstr ""
40373
40374 #. type: deffn
40375 #: guix-git/doc/guix.texi:22568
40376 #, no-wrap
40377 msgid "{Scheme Procedure} transmission-random-salt"
40378 msgstr ""
40379
40380 #. type: deffn
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."
40383 msgstr ""
40384
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:"
40388 msgstr ""
40389
40390 #. type: example
40391 #: guix-git/doc/guix.texi:22584
40392 #, no-wrap
40393 msgid ""
40394 "$ guix repl\n"
40395 "scheme@@(guix-user)> ,use (gnu services file-sharing)\n"
40396 "scheme@@(guix-user)> (transmission-random-salt)\n"
40397 "$1 = \"uKd1uMs9\"\n"
40398 msgstr ""
40399
40400 #. type: Plain text
40401 #: guix-git/doc/guix.texi:22587
40402 msgid "Alternatively, a complete password hash can generated in a single step:"
40403 msgstr ""
40404
40405 #. type: example
40406 #: guix-git/doc/guix.texi:22592
40407 #, no-wrap
40408 msgid ""
40409 "scheme@@(guix-user)> (transmission-password-hash \"transmission\"\n"
40410 "(transmission-random-salt))\n"
40411 "$2 = \"@{c8bbc6d1740cd8dc819a6e25563b67812c1c19c9VtFPfdsX\"\n"
40412 msgstr ""
40413
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."
40417 msgstr ""
40418
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."
40422 msgstr ""
40423
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.)"
40427 msgstr ""
40428
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:"
40432 msgstr ""
40433
40434 #. type: example
40435 #: guix-git/doc/guix.texi:22621
40436 #, no-wrap
40437 msgid "# herd reload transmission-daemon\n"
40438 msgstr ""
40439
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."
40443 msgstr ""
40444
40445 #. type: deftp
40446 #: guix-git/doc/guix.texi:22626
40447 #, no-wrap
40448 msgid "{Data Type} transmission-daemon-configuration"
40449 msgstr ""
40450
40451 #. type: deftp
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."
40454 msgstr ""
40455
40456 #. type: Plain text
40457 #: guix-git/doc/guix.texi:22644
40458 msgid "Available @code{transmission-daemon-configuration} fields are:"
40459 msgstr ""
40460
40461 #. type: deftypevr
40462 #: guix-git/doc/guix.texi:22645
40463 #, no-wrap
40464 msgid "{@code{transmission-daemon-configuration} parameter} package transmission"
40465 msgstr ""
40466
40467 #. type: deftypevr
40468 #: guix-git/doc/guix.texi:22647
40469 msgid "The Transmission package to use."
40470 msgstr ""
40471
40472 #. type: deftypevr
40473 #: guix-git/doc/guix.texi:22650
40474 #, no-wrap
40475 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer stop-wait-period"
40476 msgstr ""
40477
40478 #. type: deftypevr
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."
40481 msgstr ""
40482
40483 #. type: deftypevr
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}."
40488 msgstr ""
40489
40490 #. type: deftypevr
40491 #: guix-git/doc/guix.texi:22661
40492 #, no-wrap
40493 msgid "{@code{transmission-daemon-configuration} parameter} string download-dir"
40494 msgstr ""
40495
40496 #. type: deftypevr
40497 #: guix-git/doc/guix.texi:22663
40498 msgid "The directory to which torrent files are downloaded."
40499 msgstr ""
40500
40501 #. type: deftypevr
40502 #: guix-git/doc/guix.texi:22665
40503 msgid "Defaults to @samp{\"/var/lib/transmission-daemon/downloads\"}."
40504 msgstr ""
40505
40506 #. type: deftypevr
40507 #: guix-git/doc/guix.texi:22668
40508 #, no-wrap
40509 msgid "{@code{transmission-daemon-configuration} parameter} boolean incomplete-dir-enabled?"
40510 msgstr ""
40511
40512 #. type: deftypevr
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}."
40515 msgstr ""
40516
40517 #. type: deftypevr
40518 #: guix-git/doc/guix.texi:22678
40519 #, no-wrap
40520 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string incomplete-dir"
40521 msgstr ""
40522
40523 #. type: deftypevr
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}."
40526 msgstr ""
40527
40528 #. type: deftypevr
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}."
40569 msgstr ""
40570
40571 #. type: deftypevr
40572 #: guix-git/doc/guix.texi:22686
40573 #, no-wrap
40574 msgid "{@code{transmission-daemon-configuration} parameter} umask umask"
40575 msgstr ""
40576
40577 #. type: deftypevr
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.)"
40580 msgstr ""
40581
40582 #. type: deftypevr
40583 #: guix-git/doc/guix.texi:22691
40584 msgid "Defaults to @samp{18}."
40585 msgstr ""
40586
40587 #. type: deftypevr
40588 #: guix-git/doc/guix.texi:22694
40589 #, no-wrap
40590 msgid "{@code{transmission-daemon-configuration} parameter} boolean rename-partial-files?"
40591 msgstr ""
40592
40593 #. type: deftypevr
40594 #: guix-git/doc/guix.texi:22697
40595 msgid "When @code{#t}, ``.part'' is appended to the name of partially downloaded files."
40596 msgstr ""
40597
40598 #. type: deftypevr
40599 #: guix-git/doc/guix.texi:22702
40600 #, no-wrap
40601 msgid "{@code{transmission-daemon-configuration} parameter} preallocation-mode preallocation"
40602 msgstr ""
40603
40604 #. type: deftypevr
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."
40607 msgstr ""
40608
40609 #. type: deftypevr
40610 #: guix-git/doc/guix.texi:22709
40611 msgid "Defaults to @samp{fast}."
40612 msgstr ""
40613
40614 #. type: deftypevr
40615 #: guix-git/doc/guix.texi:22712
40616 #, no-wrap
40617 msgid "{@code{transmission-daemon-configuration} parameter} boolean watch-dir-enabled?"
40618 msgstr ""
40619
40620 #. type: deftypevr
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})."
40623 msgstr ""
40624
40625 #. type: deftypevr
40626 #: guix-git/doc/guix.texi:22722
40627 #, no-wrap
40628 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string watch-dir"
40629 msgstr ""
40630
40631 #. type: deftypevr
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}."
40634 msgstr ""
40635
40636 #. type: deftypevr
40637 #: guix-git/doc/guix.texi:22730
40638 #, no-wrap
40639 msgid "{@code{transmission-daemon-configuration} parameter} boolean trash-original-torrent-files?"
40640 msgstr ""
40641
40642 #. type: deftypevr
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?})."
40645 msgstr ""
40646
40647 #. type: deftypevr
40648 #: guix-git/doc/guix.texi:22739
40649 #, no-wrap
40650 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-down-enabled?"
40651 msgstr ""
40652
40653 #. type: deftypevr
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}."
40656 msgstr ""
40657
40658 #. type: deftypevr
40659 #: guix-git/doc/guix.texi:22747
40660 #, no-wrap
40661 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-down"
40662 msgstr ""
40663
40664 #. type: deftypevr
40665 #: guix-git/doc/guix.texi:22749
40666 msgid "The default global-maximum download speed, in kilobytes per second."
40667 msgstr ""
40668
40669 #. type: deftypevr
40670 #: guix-git/doc/guix.texi:22754
40671 #, no-wrap
40672 msgid "{@code{transmission-daemon-configuration} parameter} boolean speed-limit-up-enabled?"
40673 msgstr ""
40674
40675 #. type: deftypevr
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}."
40678 msgstr ""
40679
40680 #. type: deftypevr
40681 #: guix-git/doc/guix.texi:22762
40682 #, no-wrap
40683 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer speed-limit-up"
40684 msgstr ""
40685
40686 #. type: deftypevr
40687 #: guix-git/doc/guix.texi:22764
40688 msgid "The default global-maximum upload speed, in kilobytes per second."
40689 msgstr ""
40690
40691 #. type: deftypevr
40692 #: guix-git/doc/guix.texi:22769
40693 #, no-wrap
40694 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-enabled?"
40695 msgstr ""
40696
40697 #. type: deftypevr
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?}."
40700 msgstr ""
40701
40702 #. type: deftypevr
40703 #: guix-git/doc/guix.texi:22780
40704 #, no-wrap
40705 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-down"
40706 msgstr ""
40707
40708 #. type: deftypevr
40709 #: guix-git/doc/guix.texi:22782
40710 msgid "The alternate global-maximum download speed, in kilobytes per second."
40711 msgstr ""
40712
40713 #. type: deftypevr
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}."
40718 msgstr ""
40719
40720 #. type: deftypevr
40721 #: guix-git/doc/guix.texi:22787
40722 #, no-wrap
40723 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-up"
40724 msgstr ""
40725
40726 #. type: deftypevr
40727 #: guix-git/doc/guix.texi:22789
40728 msgid "The alternate global-maximum upload speed, in kilobytes per second."
40729 msgstr ""
40730
40731 #. type: deftypevr
40732 #: guix-git/doc/guix.texi:22794
40733 #, no-wrap
40734 msgid "{@code{transmission-daemon-configuration} parameter} boolean alt-speed-time-enabled?"
40735 msgstr ""
40736
40737 #. type: deftypevr
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}."
40740 msgstr ""
40741
40742 #. type: deftypevr
40743 #: guix-git/doc/guix.texi:22804
40744 #, no-wrap
40745 msgid "{@code{transmission-daemon-configuration} parameter} day-list alt-speed-time-day"
40746 msgstr ""
40747
40748 #. type: deftypevr
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}."
40751 msgstr ""
40752
40753 #. type: deftypevr
40754 #: guix-git/doc/guix.texi:22811
40755 msgid "Defaults to @samp{all}."
40756 msgstr ""
40757
40758 #. type: deftypevr
40759 #: guix-git/doc/guix.texi:22814
40760 #, no-wrap
40761 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-begin"
40762 msgstr ""
40763
40764 #. type: deftypevr
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."
40767 msgstr ""
40768
40769 #. type: deftypevr
40770 #: guix-git/doc/guix.texi:22819
40771 msgid "Defaults to @samp{540}."
40772 msgstr ""
40773
40774 #. type: deftypevr
40775 #: guix-git/doc/guix.texi:22822
40776 #, no-wrap
40777 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer alt-speed-time-end"
40778 msgstr ""
40779
40780 #. type: deftypevr
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."
40783 msgstr ""
40784
40785 #. type: deftypevr
40786 #: guix-git/doc/guix.texi:22827
40787 msgid "Defaults to @samp{1020}."
40788 msgstr ""
40789
40790 #. type: deftypevr
40791 #: guix-git/doc/guix.texi:22830
40792 #, no-wrap
40793 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv4"
40794 msgstr ""
40795
40796 #. type: deftypevr
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."
40799 msgstr ""
40800
40801 #. type: deftypevr
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\"}."
40805 msgstr ""
40806
40807 #. type: deftypevr
40808 #: guix-git/doc/guix.texi:22838
40809 #, no-wrap
40810 msgid "{@code{transmission-daemon-configuration} parameter} string bind-address-ipv6"
40811 msgstr ""
40812
40813 #. type: deftypevr
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."
40816 msgstr ""
40817
40818 #. type: deftypevr
40819 #: guix-git/doc/guix.texi:22843
40820 msgid "Defaults to @samp{\"::\"}."
40821 msgstr ""
40822
40823 #. type: deftypevr
40824 #: guix-git/doc/guix.texi:22846
40825 #, no-wrap
40826 msgid "{@code{transmission-daemon-configuration} parameter} boolean peer-port-random-on-start?"
40827 msgstr ""
40828
40829 #. type: deftypevr
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}."
40832 msgstr ""
40833
40834 #. type: deftypevr
40835 #: guix-git/doc/guix.texi:22857
40836 #, no-wrap
40837 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-low"
40838 msgstr ""
40839
40840 #. type: deftypevr
40841 #: guix-git/doc/guix.texi:22860
40842 msgid "The lowest selectable port number when @code{peer-port-random-on-start?} is @code{#t}."
40843 msgstr ""
40844
40845 #. type: deftypevr
40846 #: guix-git/doc/guix.texi:22862
40847 msgid "Defaults to @samp{49152}."
40848 msgstr ""
40849
40850 #. type: deftypevr
40851 #: guix-git/doc/guix.texi:22865
40852 #, no-wrap
40853 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port-random-high"
40854 msgstr ""
40855
40856 #. type: deftypevr
40857 #: guix-git/doc/guix.texi:22868
40858 msgid "The highest selectable port number when @code{peer-port-random-on-start} is @code{#t}."
40859 msgstr ""
40860
40861 #. type: deftypevr
40862 #: guix-git/doc/guix.texi:22870
40863 msgid "Defaults to @samp{65535}."
40864 msgstr ""
40865
40866 #. type: deftypevr
40867 #: guix-git/doc/guix.texi:22873
40868 #, no-wrap
40869 msgid "{@code{transmission-daemon-configuration} parameter} port-number peer-port"
40870 msgstr ""
40871
40872 #. type: deftypevr
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}."
40875 msgstr ""
40876
40877 #. type: deftypevr
40878 #: guix-git/doc/guix.texi:22878
40879 msgid "Defaults to @samp{51413}."
40880 msgstr ""
40881
40882 #. type: deftypevr
40883 #: guix-git/doc/guix.texi:22881
40884 #, no-wrap
40885 msgid "{@code{transmission-daemon-configuration} parameter} boolean port-forwarding-enabled?"
40886 msgstr ""
40887
40888 #. type: deftypevr
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}."
40891 msgstr ""
40892
40893 #. type: deftypevr
40894 #: guix-git/doc/guix.texi:22890
40895 #, no-wrap
40896 msgid "{@code{transmission-daemon-configuration} parameter} encryption-mode encryption"
40897 msgstr ""
40898
40899 #. type: deftypevr
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}."
40902 msgstr ""
40903
40904 #. type: deftypevr
40905 #: guix-git/doc/guix.texi:22897
40906 msgid "Defaults to @samp{prefer-encrypted-connections}."
40907 msgstr ""
40908
40909 #. type: deftypevr
40910 #: guix-git/doc/guix.texi:22900
40911 #, no-wrap
40912 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string peer-congestion-algorithm"
40913 msgstr ""
40914
40915 #. type: deftypevr
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)."
40918 msgstr ""
40919
40920 #. type: deftypevr
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."
40923 msgstr ""
40924
40925 #. type: deftypevr
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:"
40928 msgstr ""
40929
40930 #. type: lisp
40931 #: guix-git/doc/guix.texi:22929
40932 #, no-wrap
40933 msgid ""
40934 "(service sysctl-service-type\n"
40935 " (sysctl-configuration\n"
40936 " (settings\n"
40937 " (\"net.ipv4.tcp_allowed_congestion_control\" .\n"
40938 " \"reno cubic lp\"))))\n"
40939 msgstr ""
40940
40941 #. type: deftypevr
40942 #: guix-git/doc/guix.texi:22932
40943 msgid "The Transmission Daemon configuration can then be updated with"
40944 msgstr ""
40945
40946 #. type: lisp
40947 #: guix-git/doc/guix.texi:22935
40948 #, no-wrap
40949 msgid "(peer-congestion-algorithm \"lp\")\n"
40950 msgstr ""
40951
40952 #. type: deftypevr
40953 #: guix-git/doc/guix.texi:22938
40954 msgid "and the system reconfigured to have the changes take effect."
40955 msgstr ""
40956
40957 #. type: deftypevr
40958 #: guix-git/doc/guix.texi:22943
40959 #, no-wrap
40960 msgid "{@code{transmission-daemon-configuration} parameter} tcp-type-of-service peer-socket-tos"
40961 msgstr ""
40962
40963 #. type: deftypevr
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}."
40966 msgstr ""
40967
40968 #. type: deftypevr
40969 #: guix-git/doc/guix.texi:22949
40970 msgid "Defaults to @samp{default}."
40971 msgstr ""
40972
40973 #. type: deftypevr
40974 #: guix-git/doc/guix.texi:22952
40975 #, no-wrap
40976 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-global"
40977 msgstr ""
40978
40979 #. type: deftypevr
40980 #: guix-git/doc/guix.texi:22954
40981 msgid "The global limit on the number of connected peers."
40982 msgstr ""
40983
40984 #. type: deftypevr
40985 #: guix-git/doc/guix.texi:22956
40986 msgid "Defaults to @samp{200}."
40987 msgstr ""
40988
40989 #. type: deftypevr
40990 #: guix-git/doc/guix.texi:22959
40991 #, no-wrap
40992 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-limit-per-torrent"
40993 msgstr ""
40994
40995 #. type: deftypevr
40996 #: guix-git/doc/guix.texi:22961
40997 msgid "The per-torrent limit on the number of connected peers."
40998 msgstr ""
40999
41000 #. type: deftypevr
41001 #: guix-git/doc/guix.texi:22966
41002 #, no-wrap
41003 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer upload-slots-per-torrent"
41004 msgstr ""
41005
41006 #. type: deftypevr
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."
41009 msgstr ""
41010
41011 #. type: deftypevr
41012 #: guix-git/doc/guix.texi:22971
41013 msgid "Defaults to @samp{14}."
41014 msgstr ""
41015
41016 #. type: deftypevr
41017 #: guix-git/doc/guix.texi:22974
41018 #, no-wrap
41019 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer peer-id-ttl-hours"
41020 msgstr ""
41021
41022 #. type: deftypevr
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."
41025 msgstr ""
41026
41027 #. type: deftypevr
41028 #: guix-git/doc/guix.texi:22979
41029 msgid "Defaults to @samp{6}."
41030 msgstr ""
41031
41032 #. type: deftypevr
41033 #: guix-git/doc/guix.texi:22982
41034 #, no-wrap
41035 msgid "{@code{transmission-daemon-configuration} parameter} boolean blocklist-enabled?"
41036 msgstr ""
41037
41038 #. type: deftypevr
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}."
41041 msgstr ""
41042
41043 #. type: deftypevr
41044 #: guix-git/doc/guix.texi:22990
41045 #, no-wrap
41046 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string blocklist-url"
41047 msgstr ""
41048
41049 #. type: deftypevr
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}."
41052 msgstr ""
41053
41054 #. type: deftypevr
41055 #: guix-git/doc/guix.texi:22999
41056 #, no-wrap
41057 msgid "{@code{transmission-daemon-configuration} parameter} boolean download-queue-enabled?"
41058 msgstr ""
41059
41060 #. type: deftypevr
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."
41063 msgstr ""
41064
41065 #. type: deftypevr
41066 #: guix-git/doc/guix.texi:23007
41067 #, no-wrap
41068 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer download-queue-size"
41069 msgstr ""
41070
41071 #. type: deftypevr
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}."
41074 msgstr ""
41075
41076 #. type: deftypevr
41077 #: guix-git/doc/guix.texi:23016
41078 #, no-wrap
41079 msgid "{@code{transmission-daemon-configuration} parameter} boolean seed-queue-enabled?"
41080 msgstr ""
41081
41082 #. type: deftypevr
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."
41085 msgstr ""
41086
41087 #. type: deftypevr
41088 #: guix-git/doc/guix.texi:23024
41089 #, no-wrap
41090 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer seed-queue-size"
41091 msgstr ""
41092
41093 #. type: deftypevr
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}."
41096 msgstr ""
41097
41098 #. type: deftypevr
41099 #: guix-git/doc/guix.texi:23033
41100 #, no-wrap
41101 msgid "{@code{transmission-daemon-configuration} parameter} boolean queue-stalled-enabled?"
41102 msgstr ""
41103
41104 #. type: deftypevr
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."
41107 msgstr ""
41108
41109 #. type: deftypevr
41110 #: guix-git/doc/guix.texi:23043
41111 #, no-wrap
41112 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer queue-stalled-minutes"
41113 msgstr ""
41114
41115 #. type: deftypevr
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}."
41118 msgstr ""
41119
41120 #. type: deftypevr
41121 #: guix-git/doc/guix.texi:23052
41122 #, no-wrap
41123 msgid "{@code{transmission-daemon-configuration} parameter} boolean ratio-limit-enabled?"
41124 msgstr ""
41125
41126 #. type: deftypevr
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}."
41129 msgstr ""
41130
41131 #. type: deftypevr
41132 #: guix-git/doc/guix.texi:23060
41133 #, no-wrap
41134 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-rational ratio-limit"
41135 msgstr ""
41136
41137 #. type: deftypevr
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}."
41140 msgstr ""
41141
41142 #. type: deftypevr
41143 #: guix-git/doc/guix.texi:23065
41144 msgid "Defaults to @samp{2.0}."
41145 msgstr ""
41146
41147 #. type: deftypevr
41148 #: guix-git/doc/guix.texi:23068
41149 #, no-wrap
41150 msgid "{@code{transmission-daemon-configuration} parameter} boolean idle-seeding-limit-enabled?"
41151 msgstr ""
41152
41153 #. type: deftypevr
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."
41156 msgstr ""
41157
41158 #. type: deftypevr
41159 #: guix-git/doc/guix.texi:23076
41160 #, no-wrap
41161 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer idle-seeding-limit"
41162 msgstr ""
41163
41164 #. type: deftypevr
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}."
41167 msgstr ""
41168
41169 #. type: deftypevr
41170 #: guix-git/doc/guix.texi:23085
41171 #, no-wrap
41172 msgid "{@code{transmission-daemon-configuration} parameter} boolean dht-enabled?"
41173 msgstr ""
41174
41175 #. type: deftypevr
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."
41178 msgstr ""
41179
41180 #. type: deftypevr
41181 #: guix-git/doc/guix.texi:23094
41182 #, no-wrap
41183 msgid "{@code{transmission-daemon-configuration} parameter} boolean lpd-enabled?"
41184 msgstr ""
41185
41186 #. type: deftypevr
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."
41189 msgstr ""
41190
41191 #. type: deftypevr
41192 #: guix-git/doc/guix.texi:23104
41193 #, no-wrap
41194 msgid "{@code{transmission-daemon-configuration} parameter} boolean pex-enabled?"
41195 msgstr ""
41196
41197 #. type: deftypevr
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."
41200 msgstr ""
41201
41202 #. type: deftypevr
41203 #: guix-git/doc/guix.texi:23113
41204 #, no-wrap
41205 msgid "{@code{transmission-daemon-configuration} parameter} boolean utp-enabled?"
41206 msgstr ""
41207
41208 #. type: deftypevr
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."
41211 msgstr ""
41212
41213 #. type: deftypevr
41214 #: guix-git/doc/guix.texi:23123
41215 #, no-wrap
41216 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-enabled?"
41217 msgstr ""
41218
41219 #. type: deftypevr
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."
41222 msgstr ""
41223
41224 #. type: deftypevr
41225 #: guix-git/doc/guix.texi:23133
41226 #, no-wrap
41227 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-bind-address"
41228 msgstr ""
41229
41230 #. type: deftypevr
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."
41233 msgstr ""
41234
41235 #. type: deftypevr
41236 #: guix-git/doc/guix.texi:23141
41237 #, no-wrap
41238 msgid "{@code{transmission-daemon-configuration} parameter} port-number rpc-port"
41239 msgstr ""
41240
41241 #. type: deftypevr
41242 #: guix-git/doc/guix.texi:23143
41243 msgid "The port on which to listen for @acronym{RPC} connections."
41244 msgstr ""
41245
41246 #. type: deftypevr
41247 #: guix-git/doc/guix.texi:23145
41248 msgid "Defaults to @samp{9091}."
41249 msgstr ""
41250
41251 #. type: deftypevr
41252 #: guix-git/doc/guix.texi:23148
41253 #, no-wrap
41254 msgid "{@code{transmission-daemon-configuration} parameter} string rpc-url"
41255 msgstr ""
41256
41257 #. type: deftypevr
41258 #: guix-git/doc/guix.texi:23150
41259 msgid "The path prefix to use in the @acronym{RPC}-endpoint @acronym{URL}."
41260 msgstr ""
41261
41262 #. type: deftypevr
41263 #: guix-git/doc/guix.texi:23152
41264 msgid "Defaults to @samp{\"/transmission/\"}."
41265 msgstr ""
41266
41267 #. type: deftypevr
41268 #: guix-git/doc/guix.texi:23155
41269 #, no-wrap
41270 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-authentication-required?"
41271 msgstr ""
41272
41273 #. type: deftypevr
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?}."
41276 msgstr ""
41277
41278 #. type: deftypevr
41279 #: guix-git/doc/guix.texi:23165
41280 #, no-wrap
41281 msgid "{@code{transmission-daemon-configuration} parameter} maybe-string rpc-username"
41282 msgstr ""
41283
41284 #. type: deftypevr
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}."
41287 msgstr ""
41288
41289 #. type: deftypevr
41290 #: guix-git/doc/guix.texi:23173
41291 #, no-wrap
41292 msgid "{@code{transmission-daemon-configuration} parameter} maybe-transmission-password-hash rpc-password"
41293 msgstr ""
41294
41295 #. type: deftypevr
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."
41298 msgstr ""
41299
41300 #. type: deftypevr
41301 #: guix-git/doc/guix.texi:23184
41302 #, no-wrap
41303 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-whitelist-enabled?"
41304 msgstr ""
41305
41306 #. type: deftypevr
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}."
41309 msgstr ""
41310
41311 #. type: deftypevr
41312 #: guix-git/doc/guix.texi:23192
41313 #, no-wrap
41314 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-whitelist"
41315 msgstr ""
41316
41317 #. type: deftypevr
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{*}."
41320 msgstr ""
41321
41322 #. type: deftypevr
41323 #: guix-git/doc/guix.texi:23198
41324 msgid "Defaults to @samp{(\"127.0.0.1\" \"::1\")}."
41325 msgstr ""
41326
41327 #. type: deftypevr
41328 #: guix-git/doc/guix.texi:23201
41329 #, no-wrap
41330 msgid "{@code{transmission-daemon-configuration} parameter} boolean rpc-host-whitelist-enabled?"
41331 msgstr ""
41332
41333 #. type: deftypevr
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."
41336 msgstr ""
41337
41338 #. type: deftypevr
41339 #: guix-git/doc/guix.texi:23209
41340 msgid "Note also this functionality is disabled when @code{rpc-authentication-required?} is @code{#t}."
41341 msgstr ""
41342
41343 #. type: deftypevr
41344 #: guix-git/doc/guix.texi:23214
41345 #, no-wrap
41346 msgid "{@code{transmission-daemon-configuration} parameter} string-list rpc-host-whitelist"
41347 msgstr ""
41348
41349 #. type: deftypevr
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}."
41352 msgstr ""
41353
41354 #. type: deftypevr
41355 #: guix-git/doc/guix.texi:23222
41356 #, no-wrap
41357 msgid "{@code{transmission-daemon-configuration} parameter} message-level message-level"
41358 msgstr ""
41359
41360 #. type: deftypevr
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}."
41363 msgstr ""
41364
41365 #. type: deftypevr
41366 #: guix-git/doc/guix.texi:23231
41367 #, no-wrap
41368 msgid "{@code{transmission-daemon-configuration} parameter} boolean start-added-torrents?"
41369 msgstr ""
41370
41371 #. type: deftypevr
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."
41374 msgstr ""
41375
41376 #. type: deftypevr
41377 #: guix-git/doc/guix.texi:23239
41378 #, no-wrap
41379 msgid "{@code{transmission-daemon-configuration} parameter} boolean script-torrent-done-enabled?"
41380 msgstr ""
41381
41382 #. type: deftypevr
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."
41385 msgstr ""
41386
41387 #. type: deftypevr
41388 #: guix-git/doc/guix.texi:23248
41389 #, no-wrap
41390 msgid "{@code{transmission-daemon-configuration} parameter} maybe-file-object script-torrent-done-filename"
41391 msgstr ""
41392
41393 #. type: deftypevr
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}."
41396 msgstr ""
41397
41398 #. type: deftypevr
41399 #: guix-git/doc/guix.texi:23257
41400 #, no-wrap
41401 msgid "{@code{transmission-daemon-configuration} parameter} boolean scrape-paused-torrents-enabled?"
41402 msgstr ""
41403
41404 #. type: deftypevr
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."
41407 msgstr ""
41408
41409 #. type: deftypevr
41410 #: guix-git/doc/guix.texi:23265
41411 #, no-wrap
41412 msgid "{@code{transmission-daemon-configuration} parameter} non-negative-integer cache-size-mb"
41413 msgstr ""
41414
41415 #. type: deftypevr
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."
41418 msgstr ""
41419
41420 #. type: deftypevr
41421 #: guix-git/doc/guix.texi:23271
41422 msgid "Defaults to @samp{4}."
41423 msgstr ""
41424
41425 #. type: deftypevr
41426 #: guix-git/doc/guix.texi:23274
41427 #, no-wrap
41428 msgid "{@code{transmission-daemon-configuration} parameter} boolean prefetch-enabled?"
41429 msgstr ""
41430
41431 #. type: deftypevr
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."
41434 msgstr ""
41435
41436 #. type: subsubheading
41437 #: guix-git/doc/guix.texi:23291
41438 #, no-wrap
41439 msgid "Tailon Service"
41440 msgstr ""
41441
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."
41445 msgstr ""
41446
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})."
41450 msgstr ""
41451
41452 #. type: lisp
41453 #: guix-git/doc/guix.texi:23301
41454 #, no-wrap
41455 msgid "(service tailon-service-type)\n"
41456 msgstr ""
41457
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."
41461 msgstr ""
41462
41463 #. type: lisp
41464 #: guix-git/doc/guix.texi:23312
41465 #, no-wrap
41466 msgid ""
41467 "(service tailon-service-type\n"
41468 " (tailon-configuration\n"
41469 " (config-file\n"
41470 " (tailon-configuration-file\n"
41471 " (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n"
41472 msgstr ""
41473
41474 #. type: deftp
41475 #: guix-git/doc/guix.texi:23315
41476 #, no-wrap
41477 msgid "{Data Type} tailon-configuration"
41478 msgstr ""
41479
41480 #. type: deftp
41481 #: guix-git/doc/guix.texi:23318
41482 msgid "Data type representing the configuration of Tailon. This type has the following parameters:"
41483 msgstr ""
41484
41485 #. type: item
41486 #: guix-git/doc/guix.texi:23320
41487 #, no-wrap
41488 msgid "@code{config-file} (default: @code{(tailon-configuration-file)})"
41489 msgstr ""
41490
41491 #. type: table
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})."
41494 msgstr ""
41495
41496 #. type: table
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:"
41499 msgstr ""
41500
41501 #. type: lisp
41502 #: guix-git/doc/guix.texi:23332
41503 #, no-wrap
41504 msgid ""
41505 "(service tailon-service-type\n"
41506 " (tailon-configuration\n"
41507 " (config-file (local-file \"./my-tailon.conf\"))))\n"
41508 msgstr ""
41509
41510 #. type: item
41511 #: guix-git/doc/guix.texi:23334
41512 #, no-wrap
41513 msgid "@code{package} (default: @code{tailon})"
41514 msgstr ""
41515
41516 #. type: table
41517 #: guix-git/doc/guix.texi:23336
41518 msgid "The tailon package to use."
41519 msgstr ""
41520
41521 #. type: deftp
41522 #: guix-git/doc/guix.texi:23340
41523 #, no-wrap
41524 msgid "{Data Type} tailon-configuration-file"
41525 msgstr ""
41526
41527 #. type: deftp
41528 #: guix-git/doc/guix.texi:23343
41529 msgid "Data type representing the configuration options for Tailon. This type has the following parameters:"
41530 msgstr ""
41531
41532 #. type: item
41533 #: guix-git/doc/guix.texi:23345
41534 #, no-wrap
41535 msgid "@code{files} (default: @code{(list \"/var/log\")})"
41536 msgstr ""
41537
41538 #. type: table
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."
41541 msgstr ""
41542
41543 #. type: item
41544 #: guix-git/doc/guix.texi:23351
41545 #, no-wrap
41546 msgid "@code{bind} (default: @code{\"localhost:8080\"})"
41547 msgstr ""
41548
41549 #. type: table
41550 #: guix-git/doc/guix.texi:23353
41551 msgid "Address and port to which Tailon should bind on."
41552 msgstr ""
41553
41554 #. type: item
41555 #: guix-git/doc/guix.texi:23354
41556 #, no-wrap
41557 msgid "@code{relative-root} (default: @code{#f})"
41558 msgstr ""
41559
41560 #. type: table
41561 #: guix-git/doc/guix.texi:23356
41562 msgid "URL path to use for Tailon, set to @code{#f} to not use a path."
41563 msgstr ""
41564
41565 #. type: item
41566 #: guix-git/doc/guix.texi:23357
41567 #, no-wrap
41568 msgid "@code{allow-transfers?} (default: @code{#t})"
41569 msgstr ""
41570
41571 #. type: table
41572 #: guix-git/doc/guix.texi:23359
41573 msgid "Allow downloading the log files in the web interface."
41574 msgstr ""
41575
41576 #. type: item
41577 #: guix-git/doc/guix.texi:23360
41578 #, no-wrap
41579 msgid "@code{follow-names?} (default: @code{#t})"
41580 msgstr ""
41581
41582 #. type: table
41583 #: guix-git/doc/guix.texi:23362
41584 msgid "Allow tailing of not-yet existent files."
41585 msgstr ""
41586
41587 #. type: item
41588 #: guix-git/doc/guix.texi:23363
41589 #, no-wrap
41590 msgid "@code{tail-lines} (default: @code{200})"
41591 msgstr ""
41592
41593 #. type: table
41594 #: guix-git/doc/guix.texi:23365
41595 msgid "Number of lines to read initially from each file."
41596 msgstr ""
41597
41598 #. type: item
41599 #: guix-git/doc/guix.texi:23366
41600 #, no-wrap
41601 msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})"
41602 msgstr ""
41603
41604 #. type: table
41605 #: guix-git/doc/guix.texi:23368
41606 msgid "Commands to allow running. By default, @code{sed} is disabled."
41607 msgstr ""
41608
41609 #. type: table
41610 #: guix-git/doc/guix.texi:23371
41611 msgid "Set @code{debug?} to @code{#t} to show debug messages."
41612 msgstr ""
41613
41614 #. type: item
41615 #: guix-git/doc/guix.texi:23372
41616 #, no-wrap
41617 msgid "@code{wrap-lines} (default: @code{#t})"
41618 msgstr ""
41619
41620 #. type: table
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."
41623 msgstr ""
41624
41625 #. type: item
41626 #: guix-git/doc/guix.texi:23377
41627 #, no-wrap
41628 msgid "@code{http-auth} (default: @code{#f})"
41629 msgstr ""
41630
41631 #. type: table
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\"}."
41634 msgstr ""
41635
41636 #. type: item
41637 #: guix-git/doc/guix.texi:23382
41638 #, no-wrap
41639 msgid "@code{users} (default: @code{#f})"
41640 msgstr ""
41641
41642 #. type: table
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."
41645 msgstr ""
41646
41647 #. type: lisp
41648 #: guix-git/doc/guix.texi:23393
41649 #, no-wrap
41650 msgid ""
41651 "(tailon-configuration-file\n"
41652 " (http-auth \"basic\")\n"
41653 " (users '((\"user1\" . \"password1\")\n"
41654 " (\"user2\" . \"password2\"))))\n"
41655 msgstr ""
41656
41657 #. type: subsubheading
41658 #: guix-git/doc/guix.texi:23399
41659 #, no-wrap
41660 msgid "Darkstat Service"
41661 msgstr ""
41662
41663 #. type: cindex
41664 #: guix-git/doc/guix.texi:23400
41665 #, no-wrap
41666 msgid "darkstat"
41667 msgstr ""
41668
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."
41672 msgstr ""
41673
41674 #. type: defvar
41675 #: guix-git/doc/guix.texi:23404
41676 #, no-wrap
41677 msgid "{Scheme Variable} darkstat-service-type"
41678 msgstr ""
41679
41680 #. type: defvar
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:"
41683 msgstr ""
41684
41685 #. type: lisp
41686 #: guix-git/doc/guix.texi:23414
41687 #, no-wrap
41688 msgid ""
41689 "(service darkstat-service-type\n"
41690 " (darkstat-configuration\n"
41691 " (interface \"eno1\")))\n"
41692 msgstr ""
41693
41694 #. type: deftp
41695 #: guix-git/doc/guix.texi:23417
41696 #, no-wrap
41697 msgid "{Data Type} darkstat-configuration"
41698 msgstr ""
41699
41700 #. type: deftp
41701 #: guix-git/doc/guix.texi:23419
41702 msgid "Data type representing the configuration of @command{darkstat}."
41703 msgstr ""
41704
41705 #. type: item
41706 #: guix-git/doc/guix.texi:23421
41707 #, no-wrap
41708 msgid "@code{package} (default: @code{darkstat})"
41709 msgstr ""
41710
41711 #. type: table
41712 #: guix-git/doc/guix.texi:23423
41713 msgid "The darkstat package to use."
41714 msgstr ""
41715
41716 #. type: code{#1}
41717 #: guix-git/doc/guix.texi:23424
41718 #, no-wrap
41719 msgid "interface"
41720 msgstr ""
41721
41722 #. type: table
41723 #: guix-git/doc/guix.texi:23426
41724 msgid "Capture traffic on the specified network interface."
41725 msgstr ""
41726
41727 #. type: item
41728 #: guix-git/doc/guix.texi:23427
41729 #, no-wrap
41730 msgid "@code{port} (default: @code{\"667\"})"
41731 msgstr ""
41732
41733 #. type: table
41734 #: guix-git/doc/guix.texi:23429
41735 msgid "Bind the web interface to the specified port."
41736 msgstr ""
41737
41738 #. type: table
41739 #: guix-git/doc/guix.texi:23432 guix-git/doc/guix.texi:23467
41740 msgid "Bind the web interface to the specified address."
41741 msgstr ""
41742
41743 #. type: item
41744 #: guix-git/doc/guix.texi:23433
41745 #, no-wrap
41746 msgid "@code{base} (default: @code{\"/\"})"
41747 msgstr ""
41748
41749 #. type: table
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."
41752 msgstr ""
41753
41754 #. type: subsubheading
41755 #: guix-git/doc/guix.texi:23440
41756 #, no-wrap
41757 msgid "Prometheus Node Exporter Service"
41758 msgstr ""
41759
41760 #. type: cindex
41761 #: guix-git/doc/guix.texi:23442
41762 #, no-wrap
41763 msgid "prometheus-node-exporter"
41764 msgstr ""
41765
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."
41769 msgstr ""
41770
41771 #. type: defvar
41772 #: guix-git/doc/guix.texi:23448
41773 #, no-wrap
41774 msgid "{Scheme variable} prometheus-node-exporter-service-type"
41775 msgstr ""
41776
41777 #. type: defvar
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}."
41780 msgstr ""
41781
41782 #. type: lisp
41783 #: guix-git/doc/guix.texi:23455
41784 #, no-wrap
41785 msgid "(service prometheus-node-exporter-service-type)\n"
41786 msgstr ""
41787
41788 #. type: deftp
41789 #: guix-git/doc/guix.texi:23458
41790 #, no-wrap
41791 msgid "{Data Type} prometheus-node-exporter-configuration"
41792 msgstr ""
41793
41794 #. type: deftp
41795 #: guix-git/doc/guix.texi:23460
41796 msgid "Data type representing the configuration of @command{node_exporter}."
41797 msgstr ""
41798
41799 #. type: item
41800 #: guix-git/doc/guix.texi:23462
41801 #, no-wrap
41802 msgid "@code{package} (default: @code{go-github-com-prometheus-node-exporter})"
41803 msgstr ""
41804
41805 #. type: table
41806 #: guix-git/doc/guix.texi:23464
41807 msgid "The prometheus-node-exporter package to use."
41808 msgstr ""
41809
41810 #. type: item
41811 #: guix-git/doc/guix.texi:23465
41812 #, no-wrap
41813 msgid "@code{web-listen-address} (default: @code{\":9100\"})"
41814 msgstr ""
41815
41816 #. type: item
41817 #: guix-git/doc/guix.texi:23468
41818 #, no-wrap
41819 msgid "@code{textfile-directory} (default: @code{\"/var/lib/prometheus/node-exporter\"})"
41820 msgstr ""
41821
41822 #. type: table
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."
41825 msgstr ""
41826
41827 #. type: table
41828 #: guix-git/doc/guix.texi:23475
41829 msgid "Extra options to pass to the Prometheus node exporter."
41830 msgstr ""
41831
41832 #. type: subsubheading
41833 #: guix-git/doc/guix.texi:23479
41834 #, no-wrap
41835 msgid "Zabbix server"
41836 msgstr ""
41837
41838 #. type: cindex
41839 #: guix-git/doc/guix.texi:23480
41840 #, no-wrap
41841 msgid "zabbix zabbix-server"
41842 msgstr ""
41843
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:"
41847 msgstr ""
41848
41849 #. type: item
41850 #: guix-git/doc/guix.texi:23485
41851 #, no-wrap
41852 msgid "High performance, high capacity (able to monitor hundreds of thousands of devices)."
41853 msgstr ""
41854
41855 #. type: item
41856 #: guix-git/doc/guix.texi:23486
41857 #, no-wrap
41858 msgid "Auto-discovery of servers and network devices and interfaces."
41859 msgstr ""
41860
41861 #. type: item
41862 #: guix-git/doc/guix.texi:23487
41863 #, no-wrap
41864 msgid "Low-level discovery, allows to automatically start monitoring new items, file systems or network interfaces among others."
41865 msgstr ""
41866
41867 #. type: item
41868 #: guix-git/doc/guix.texi:23488
41869 #, no-wrap
41870 msgid "Distributed monitoring with centralized web administration."
41871 msgstr ""
41872
41873 #. type: item
41874 #: guix-git/doc/guix.texi:23489
41875 #, no-wrap
41876 msgid "Native high performance agents."
41877 msgstr ""
41878
41879 #. type: item
41880 #: guix-git/doc/guix.texi:23490
41881 #, no-wrap
41882 msgid "SLA, and ITIL KPI metrics on reporting."
41883 msgstr ""
41884
41885 #. type: item
41886 #: guix-git/doc/guix.texi:23491
41887 #, no-wrap
41888 msgid "High-level (business) view of monitored resources through user-defined visual console screens and dashboards."
41889 msgstr ""
41890
41891 #. type: item
41892 #: guix-git/doc/guix.texi:23492
41893 #, no-wrap
41894 msgid "Remote command execution through Zabbix proxies."
41895 msgstr ""
41896
41897 #. type: Plain text
41898 #: guix-git/doc/guix.texi:23498
41899 msgid "Available @code{zabbix-server-configuration} fields are:"
41900 msgstr ""
41901
41902 #. type: deftypevr
41903 #: guix-git/doc/guix.texi:23499
41904 #, no-wrap
41905 msgid "{@code{zabbix-server-configuration} parameter} package zabbix-server"
41906 msgstr ""
41907
41908 #. type: deftypevr
41909 #: guix-git/doc/guix.texi:23501
41910 msgid "The zabbix-server package."
41911 msgstr ""
41912
41913 #. type: deftypevr
41914 #: guix-git/doc/guix.texi:23504
41915 #, no-wrap
41916 msgid "{@code{zabbix-server-configuration} parameter} string user"
41917 msgstr ""
41918
41919 #. type: deftypevr
41920 #: guix-git/doc/guix.texi:23506
41921 msgid "User who will run the Zabbix server."
41922 msgstr ""
41923
41924 #. type: deftypevr
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\"}."
41930 msgstr ""
41931
41932 #. type: deftypevr
41933 #: guix-git/doc/guix.texi:23511
41934 #, no-wrap
41935 msgid "{@code{zabbix-server-configuration} parameter} group group"
41936 msgstr ""
41937
41938 #. type: deftypevr
41939 #: guix-git/doc/guix.texi:23513
41940 msgid "Group who will run the Zabbix server."
41941 msgstr ""
41942
41943 #. type: deftypevr
41944 #: guix-git/doc/guix.texi:23518
41945 #, no-wrap
41946 msgid "{@code{zabbix-server-configuration} parameter} string db-host"
41947 msgstr ""
41948
41949 #. type: deftypevr
41950 #: guix-git/doc/guix.texi:23520 guix-git/doc/guix.texi:23739
41951 msgid "Database host name."
41952 msgstr ""
41953
41954 #. type: deftypevr
41955 #: guix-git/doc/guix.texi:23522
41956 msgid "Defaults to @samp{\"127.0.0.1\"}."
41957 msgstr ""
41958
41959 #. type: deftypevr
41960 #: guix-git/doc/guix.texi:23525
41961 #, no-wrap
41962 msgid "{@code{zabbix-server-configuration} parameter} string db-name"
41963 msgstr ""
41964
41965 #. type: deftypevr
41966 #: guix-git/doc/guix.texi:23527 guix-git/doc/guix.texi:23753
41967 msgid "Database name."
41968 msgstr ""
41969
41970 #. type: deftypevr
41971 #: guix-git/doc/guix.texi:23532
41972 #, no-wrap
41973 msgid "{@code{zabbix-server-configuration} parameter} string db-user"
41974 msgstr ""
41975
41976 #. type: deftypevr
41977 #: guix-git/doc/guix.texi:23534 guix-git/doc/guix.texi:23760
41978 msgid "Database user."
41979 msgstr ""
41980
41981 #. type: deftypevr
41982 #: guix-git/doc/guix.texi:23539
41983 #, no-wrap
41984 msgid "{@code{zabbix-server-configuration} parameter} string db-password"
41985 msgstr ""
41986
41987 #. type: deftypevr
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."
41990 msgstr ""
41991
41992 #. type: deftypevr
41993 #: guix-git/doc/guix.texi:23547
41994 #, no-wrap
41995 msgid "{@code{zabbix-server-configuration} parameter} number db-port"
41996 msgstr ""
41997
41998 #. type: deftypevr
41999 #: guix-git/doc/guix.texi:23549 guix-git/doc/guix.texi:23746
42000 msgid "Database port."
42001 msgstr ""
42002
42003 #. type: deftypevr
42004 #: guix-git/doc/guix.texi:23551 guix-git/doc/guix.texi:23748
42005 msgid "Defaults to @samp{5432}."
42006 msgstr ""
42007
42008 #. type: deftypevr
42009 #: guix-git/doc/guix.texi:23554
42010 #, no-wrap
42011 msgid "{@code{zabbix-server-configuration} parameter} string log-type"
42012 msgstr ""
42013
42014 #. type: deftypevr
42015 #: guix-git/doc/guix.texi:23556 guix-git/doc/guix.texi:23657
42016 msgid "Specifies where log messages are written to:"
42017 msgstr ""
42018
42019 #. type: itemize
42020 #: guix-git/doc/guix.texi:23560 guix-git/doc/guix.texi:23661
42021 msgid "@code{system} - syslog."
42022 msgstr ""
42023
42024 #. type: itemize
42025 #: guix-git/doc/guix.texi:23563 guix-git/doc/guix.texi:23664
42026 msgid "@code{file} - file specified with @code{log-file} parameter."
42027 msgstr ""
42028
42029 #. type: itemize
42030 #: guix-git/doc/guix.texi:23566 guix-git/doc/guix.texi:23667
42031 msgid "@code{console} - standard output."
42032 msgstr ""
42033
42034 #. type: deftypevr
42035 #: guix-git/doc/guix.texi:23573
42036 #, no-wrap
42037 msgid "{@code{zabbix-server-configuration} parameter} string log-file"
42038 msgstr ""
42039
42040 #. type: deftypevr
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."
42043 msgstr ""
42044
42045 #. type: deftypevr
42046 #: guix-git/doc/guix.texi:23577
42047 msgid "Defaults to @samp{\"/var/log/zabbix/server.log\"}."
42048 msgstr ""
42049
42050 #. type: deftypevr
42051 #: guix-git/doc/guix.texi:23580
42052 #, no-wrap
42053 msgid "{@code{zabbix-server-configuration} parameter} string pid-file"
42054 msgstr ""
42055
42056 #. type: deftypevr
42057 #: guix-git/doc/guix.texi:23582 guix-git/doc/guix.texi:23683
42058 msgid "Name of PID file."
42059 msgstr ""
42060
42061 #. type: deftypevr
42062 #: guix-git/doc/guix.texi:23584
42063 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_server.pid\"}."
42064 msgstr ""
42065
42066 #. type: deftypevr
42067 #: guix-git/doc/guix.texi:23587
42068 #, no-wrap
42069 msgid "{@code{zabbix-server-configuration} parameter} string ssl-ca-location"
42070 msgstr ""
42071
42072 #. type: deftypevr
42073 #: guix-git/doc/guix.texi:23590
42074 msgid "The location of certificate authority (CA) files for SSL server certificate verification."
42075 msgstr ""
42076
42077 #. type: deftypevr
42078 #: guix-git/doc/guix.texi:23592
42079 msgid "Defaults to @samp{\"/etc/ssl/certs/ca-certificates.crt\"}."
42080 msgstr ""
42081
42082 #. type: deftypevr
42083 #: guix-git/doc/guix.texi:23595
42084 #, no-wrap
42085 msgid "{@code{zabbix-server-configuration} parameter} string ssl-cert-location"
42086 msgstr ""
42087
42088 #. type: deftypevr
42089 #: guix-git/doc/guix.texi:23597
42090 msgid "Location of SSL client certificates."
42091 msgstr ""
42092
42093 #. type: deftypevr
42094 #: guix-git/doc/guix.texi:23599
42095 msgid "Defaults to @samp{\"/etc/ssl/certs\"}."
42096 msgstr ""
42097
42098 #. type: deftypevr
42099 #: guix-git/doc/guix.texi:23602
42100 #, no-wrap
42101 msgid "{@code{zabbix-server-configuration} parameter} string extra-options"
42102 msgstr ""
42103
42104 #. type: deftypevr
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."
42107 msgstr ""
42108
42109 #. type: deftypevr
42110 #: guix-git/doc/guix.texi:23609
42111 #, no-wrap
42112 msgid "{@code{zabbix-server-configuration} parameter} include-files include-files"
42113 msgstr ""
42114
42115 #. type: deftypevr
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."
42118 msgstr ""
42119
42120 #. type: subsubheading
42121 #: guix-git/doc/guix.texi:23619
42122 #, no-wrap
42123 msgid "Zabbix agent"
42124 msgstr ""
42125
42126 #. type: cindex
42127 #: guix-git/doc/guix.texi:23620
42128 #, no-wrap
42129 msgid "zabbix zabbix-agent"
42130 msgstr ""
42131
42132 #. type: Plain text
42133 #: guix-git/doc/guix.texi:23623
42134 msgid "Zabbix agent gathers information for Zabbix server."
42135 msgstr ""
42136
42137 #. type: Plain text
42138 #: guix-git/doc/guix.texi:23627
42139 msgid "Available @code{zabbix-agent-configuration} fields are:"
42140 msgstr ""
42141
42142 #. type: deftypevr
42143 #: guix-git/doc/guix.texi:23628
42144 #, no-wrap
42145 msgid "{@code{zabbix-agent-configuration} parameter} package zabbix-agent"
42146 msgstr ""
42147
42148 #. type: deftypevr
42149 #: guix-git/doc/guix.texi:23630
42150 msgid "The zabbix-agent package."
42151 msgstr ""
42152
42153 #. type: deftypevr
42154 #: guix-git/doc/guix.texi:23633
42155 #, no-wrap
42156 msgid "{@code{zabbix-agent-configuration} parameter} string user"
42157 msgstr ""
42158
42159 #. type: deftypevr
42160 #: guix-git/doc/guix.texi:23635
42161 msgid "User who will run the Zabbix agent."
42162 msgstr ""
42163
42164 #. type: deftypevr
42165 #: guix-git/doc/guix.texi:23640
42166 #, no-wrap
42167 msgid "{@code{zabbix-agent-configuration} parameter} group group"
42168 msgstr ""
42169
42170 #. type: deftypevr
42171 #: guix-git/doc/guix.texi:23642
42172 msgid "Group who will run the Zabbix agent."
42173 msgstr ""
42174
42175 #. type: deftypevr
42176 #: guix-git/doc/guix.texi:23647
42177 #, no-wrap
42178 msgid "{@code{zabbix-agent-configuration} parameter} string hostname"
42179 msgstr ""
42180
42181 #. type: deftypevr
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."
42184 msgstr ""
42185
42186 #. type: deftypevr
42187 #: guix-git/doc/guix.texi:23655
42188 #, no-wrap
42189 msgid "{@code{zabbix-agent-configuration} parameter} string log-type"
42190 msgstr ""
42191
42192 #. type: deftypevr
42193 #: guix-git/doc/guix.texi:23674
42194 #, no-wrap
42195 msgid "{@code{zabbix-agent-configuration} parameter} string log-file"
42196 msgstr ""
42197
42198 #. type: deftypevr
42199 #: guix-git/doc/guix.texi:23678
42200 msgid "Defaults to @samp{\"/var/log/zabbix/agent.log\"}."
42201 msgstr ""
42202
42203 #. type: deftypevr
42204 #: guix-git/doc/guix.texi:23681
42205 #, no-wrap
42206 msgid "{@code{zabbix-agent-configuration} parameter} string pid-file"
42207 msgstr ""
42208
42209 #. type: deftypevr
42210 #: guix-git/doc/guix.texi:23685
42211 msgid "Defaults to @samp{\"/var/run/zabbix/zabbix_agent.pid\"}."
42212 msgstr ""
42213
42214 #. type: deftypevr
42215 #: guix-git/doc/guix.texi:23688
42216 #, no-wrap
42217 msgid "{@code{zabbix-agent-configuration} parameter} list server"
42218 msgstr ""
42219
42220 #. type: deftypevr
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."
42223 msgstr ""
42224
42225 #. type: deftypevr
42226 #: guix-git/doc/guix.texi:23694 guix-git/doc/guix.texi:23703
42227 msgid "Defaults to @samp{(\"127.0.0.1\")}."
42228 msgstr ""
42229
42230 #. type: deftypevr
42231 #: guix-git/doc/guix.texi:23697
42232 #, no-wrap
42233 msgid "{@code{zabbix-agent-configuration} parameter} list server-active"
42234 msgstr ""
42235
42236 #. type: deftypevr
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."
42239 msgstr ""
42240
42241 #. type: deftypevr
42242 #: guix-git/doc/guix.texi:23706
42243 #, no-wrap
42244 msgid "{@code{zabbix-agent-configuration} parameter} string extra-options"
42245 msgstr ""
42246
42247 #. type: deftypevr
42248 #: guix-git/doc/guix.texi:23713
42249 #, no-wrap
42250 msgid "{@code{zabbix-agent-configuration} parameter} include-files include-files"
42251 msgstr ""
42252
42253 #. type: subsubheading
42254 #: guix-git/doc/guix.texi:23723
42255 #, no-wrap
42256 msgid "Zabbix front-end"
42257 msgstr ""
42258
42259 #. type: cindex
42260 #: guix-git/doc/guix.texi:23724
42261 #, no-wrap
42262 msgid "zabbix zabbix-front-end"
42263 msgstr ""
42264
42265 #. type: Plain text
42266 #: guix-git/doc/guix.texi:23727
42267 msgid "This service provides a WEB interface to Zabbix server."
42268 msgstr ""
42269
42270 #. type: Plain text
42271 #: guix-git/doc/guix.texi:23731
42272 msgid "Available @code{zabbix-front-end-configuration} fields are:"
42273 msgstr ""
42274
42275 #. type: deftypevr
42276 #: guix-git/doc/guix.texi:23732
42277 #, no-wrap
42278 msgid "{@code{zabbix-front-end-configuration} parameter} nginx-server-configuration-list nginx"
42279 msgstr ""
42280
42281 #. type: deftypevr
42282 #: guix-git/doc/guix.texi:23734 guix-git/doc/guix.texi:29896
42283 msgid "NGINX configuration."
42284 msgstr ""
42285
42286 #. type: deftypevr
42287 #: guix-git/doc/guix.texi:23737
42288 #, no-wrap
42289 msgid "{@code{zabbix-front-end-configuration} parameter} string db-host"
42290 msgstr ""
42291
42292 #. type: deftypevr
42293 #: guix-git/doc/guix.texi:23744
42294 #, no-wrap
42295 msgid "{@code{zabbix-front-end-configuration} parameter} number db-port"
42296 msgstr ""
42297
42298 #. type: deftypevr
42299 #: guix-git/doc/guix.texi:23751
42300 #, no-wrap
42301 msgid "{@code{zabbix-front-end-configuration} parameter} string db-name"
42302 msgstr ""
42303
42304 #. type: deftypevr
42305 #: guix-git/doc/guix.texi:23758
42306 #, no-wrap
42307 msgid "{@code{zabbix-front-end-configuration} parameter} string db-user"
42308 msgstr ""
42309
42310 #. type: deftypevr
42311 #: guix-git/doc/guix.texi:23765
42312 #, no-wrap
42313 msgid "{@code{zabbix-front-end-configuration} parameter} string db-password"
42314 msgstr ""
42315
42316 #. type: deftypevr
42317 #: guix-git/doc/guix.texi:23767
42318 msgid "Database password. Please, use @code{db-secret-file} instead."
42319 msgstr ""
42320
42321 #. type: deftypevr
42322 #: guix-git/doc/guix.texi:23772
42323 #, no-wrap
42324 msgid "{@code{zabbix-front-end-configuration} parameter} string db-secret-file"
42325 msgstr ""
42326
42327 #. type: deftypevr
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']}."
42330 msgstr ""
42331
42332 #. type: deftypevr
42333 #: guix-git/doc/guix.texi:23782
42334 #, no-wrap
42335 msgid "{@code{zabbix-front-end-configuration} parameter} string zabbix-host"
42336 msgstr ""
42337
42338 #. type: deftypevr
42339 #: guix-git/doc/guix.texi:23784
42340 msgid "Zabbix server hostname."
42341 msgstr ""
42342
42343 #. type: deftypevr
42344 #: guix-git/doc/guix.texi:23789
42345 #, no-wrap
42346 msgid "{@code{zabbix-front-end-configuration} parameter} number zabbix-port"
42347 msgstr ""
42348
42349 #. type: deftypevr
42350 #: guix-git/doc/guix.texi:23791
42351 msgid "Zabbix server port."
42352 msgstr ""
42353
42354 #. type: deftypevr
42355 #: guix-git/doc/guix.texi:23793
42356 msgid "Defaults to @samp{10051}."
42357 msgstr ""
42358
42359 #. type: cindex
42360 #: guix-git/doc/guix.texi:23801
42361 #, no-wrap
42362 msgid "Kerberos"
42363 msgstr ""
42364
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}."
42368 msgstr ""
42369
42370 #. type: subsubheading
42371 #: guix-git/doc/guix.texi:23806
42372 #, no-wrap
42373 msgid "Krb5 Service"
42374 msgstr ""
42375
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."
42379 msgstr ""
42380
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."
42384 msgstr ""
42385
42386 #. type: defvr
42387 #: guix-git/doc/guix.texi:23818
42388 #, no-wrap
42389 msgid "{Scheme Variable} krb5-service-type"
42390 msgstr ""
42391
42392 #. type: defvr
42393 #: guix-git/doc/guix.texi:23820
42394 msgid "A service type for Kerberos 5 clients."
42395 msgstr ""
42396
42397 #. type: Plain text
42398 #: guix-git/doc/guix.texi:23824
42399 msgid "Here is an example of its use:"
42400 msgstr ""
42401
42402 #. type: lisp
42403 #: guix-git/doc/guix.texi:23838
42404 #, no-wrap
42405 msgid ""
42406 "(service krb5-service-type\n"
42407 " (krb5-configuration\n"
42408 " (default-realm \"EXAMPLE.COM\")\n"
42409 " (allow-weak-crypto? #t)\n"
42410 " (realms (list\n"
42411 " (krb5-realm\n"
42412 " (name \"EXAMPLE.COM\")\n"
42413 " (admin-server \"groucho.example.com\")\n"
42414 " (kdc \"karl.example.com\"))\n"
42415 " (krb5-realm\n"
42416 " (name \"ARGRX.EDU\")\n"
42417 " (admin-server \"kerb-admin.argrx.edu\")\n"
42418 " (kdc \"keys.argrx.edu\"))))))\n"
42419 msgstr ""
42420
42421 #. type: Plain text
42422 #: guix-git/doc/guix.texi:23842
42423 msgid "This example provides a Kerberos@tie{}5 client configuration which:"
42424 msgstr ""
42425
42426 #. type: item
42427 #: guix-git/doc/guix.texi:23843
42428 #, no-wrap
42429 msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both"
42430 msgstr ""
42431
42432 #. type: itemize
42433 #: guix-git/doc/guix.texi:23845
42434 msgid "of which have distinct administration servers and key distribution centers;"
42435 msgstr ""
42436
42437 #. type: item
42438 #: guix-git/doc/guix.texi:23845
42439 #, no-wrap
42440 msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly"
42441 msgstr ""
42442
42443 #. type: itemize
42444 #: guix-git/doc/guix.texi:23847
42445 msgid "specified by clients;"
42446 msgstr ""
42447
42448 #. type: item
42449 #: guix-git/doc/guix.texi:23847
42450 #, no-wrap
42451 msgid "Accepts services which only support encryption types known to be weak."
42452 msgstr ""
42453
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."
42457 msgstr ""
42458
42459 #. type: deftp
42460 #: guix-git/doc/guix.texi:23857
42461 #, no-wrap
42462 msgid "{Data Type} krb5-realm"
42463 msgstr ""
42464
42465 #. type: cindex
42466 #: guix-git/doc/guix.texi:23858
42467 #, no-wrap
42468 msgid "realm, kerberos"
42469 msgstr ""
42470
42471 #. type: table
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."
42474 msgstr ""
42475
42476 #. type: code{#1}
42477 #: guix-git/doc/guix.texi:23865
42478 #, no-wrap
42479 msgid "admin-server"
42480 msgstr ""
42481
42482 #. type: table
42483 #: guix-git/doc/guix.texi:23868
42484 msgid "This field is a string identifying the host where the administration server is running."
42485 msgstr ""
42486
42487 #. type: code{#1}
42488 #: guix-git/doc/guix.texi:23869
42489 #, no-wrap
42490 msgid "kdc"
42491 msgstr ""
42492
42493 #. type: table
42494 #: guix-git/doc/guix.texi:23872
42495 msgid "This field is a string identifying the key distribution center for the realm."
42496 msgstr ""
42497
42498 #. type: deftp
42499 #: guix-git/doc/guix.texi:23875
42500 #, no-wrap
42501 msgid "{Data Type} krb5-configuration"
42502 msgstr ""
42503
42504 #. type: item
42505 #: guix-git/doc/guix.texi:23878
42506 #, no-wrap
42507 msgid "@code{allow-weak-crypto?} (default: @code{#f})"
42508 msgstr ""
42509
42510 #. type: table
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."
42513 msgstr ""
42514
42515 #. type: item
42516 #: guix-git/doc/guix.texi:23882
42517 #, no-wrap
42518 msgid "@code{default-realm} (default: @code{#f})"
42519 msgstr ""
42520
42521 #. type: table
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}."
42524 msgstr ""
42525
42526 #. type: code{#1}
42527 #: guix-git/doc/guix.texi:23890
42528 #, no-wrap
42529 msgid "realms"
42530 msgstr ""
42531
42532 #. type: table
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."
42535 msgstr ""
42536
42537 #. type: subsubheading
42538 #: guix-git/doc/guix.texi:23899
42539 #, no-wrap
42540 msgid "PAM krb5 Service"
42541 msgstr ""
42542
42543 #. type: cindex
42544 #: guix-git/doc/guix.texi:23900
42545 #, no-wrap
42546 msgid "pam-krb5"
42547 msgstr ""
42548
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."
42552 msgstr ""
42553
42554 #. type: defvr
42555 #: guix-git/doc/guix.texi:23907
42556 #, no-wrap
42557 msgid "{Scheme Variable} pam-krb5-service-type"
42558 msgstr ""
42559
42560 #. type: defvr
42561 #: guix-git/doc/guix.texi:23909
42562 msgid "A service type for the Kerberos 5 PAM module."
42563 msgstr ""
42564
42565 #. type: deftp
42566 #: guix-git/doc/guix.texi:23911
42567 #, no-wrap
42568 msgid "{Data Type} pam-krb5-configuration"
42569 msgstr ""
42570
42571 #. type: deftp
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:"
42574 msgstr ""
42575
42576 #. type: item
42577 #: guix-git/doc/guix.texi:23915
42578 #, no-wrap
42579 msgid "@code{pam-krb5} (default: @code{pam-krb5})"
42580 msgstr ""
42581
42582 #. type: table
42583 #: guix-git/doc/guix.texi:23917
42584 msgid "The pam-krb5 package to use."
42585 msgstr ""
42586
42587 #. type: item
42588 #: guix-git/doc/guix.texi:23918
42589 #, no-wrap
42590 msgid "@code{minimum-uid} (default: @code{1000})"
42591 msgstr ""
42592
42593 #. type: table
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."
42596 msgstr ""
42597
42598 #. type: cindex
42599 #: guix-git/doc/guix.texi:23927
42600 #, no-wrap
42601 msgid "LDAP"
42602 msgstr ""
42603
42604 #. type: cindex
42605 #: guix-git/doc/guix.texi:23928
42606 #, no-wrap
42607 msgid "nslcd, LDAP service"
42608 msgstr ""
42609
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."
42613 msgstr ""
42614
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:"
42618 msgstr ""
42619
42620 #. type: lisp
42621 #: guix-git/doc/guix.texi:23962
42622 #, no-wrap
42623 msgid ""
42624 "(use-service-modules authentication)\n"
42625 "(use-modules (gnu system nss))\n"
42626 "...\n"
42627 "(operating-system\n"
42628 " ...\n"
42629 " (services\n"
42630 " (cons*\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"
42645 msgstr ""
42646
42647 #. type: Plain text
42648 #: guix-git/doc/guix.texi:23967
42649 msgid "Available @code{nslcd-configuration} fields are:"
42650 msgstr ""
42651
42652 #. type: deftypevr
42653 #: guix-git/doc/guix.texi:23968
42654 #, no-wrap
42655 msgid "{@code{nslcd-configuration} parameter} package nss-pam-ldapd"
42656 msgstr ""
42657
42658 #. type: deftypevr
42659 #: guix-git/doc/guix.texi:23970
42660 msgid "The @code{nss-pam-ldapd} package to use."
42661 msgstr ""
42662
42663 #. type: deftypevr
42664 #: guix-git/doc/guix.texi:23973
42665 #, no-wrap
42666 msgid "{@code{nslcd-configuration} parameter} maybe-number threads"
42667 msgstr ""
42668
42669 #. type: deftypevr
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."
42672 msgstr ""
42673
42674 #. type: deftypevr
42675 #: guix-git/doc/guix.texi:23982
42676 #, no-wrap
42677 msgid "{@code{nslcd-configuration} parameter} string uid"
42678 msgstr ""
42679
42680 #. type: deftypevr
42681 #: guix-git/doc/guix.texi:23984
42682 msgid "This specifies the user id with which the daemon should be run."
42683 msgstr ""
42684
42685 #. type: deftypevr
42686 #: guix-git/doc/guix.texi:23986 guix-git/doc/guix.texi:23993
42687 msgid "Defaults to @samp{\"nslcd\"}."
42688 msgstr ""
42689
42690 #. type: deftypevr
42691 #: guix-git/doc/guix.texi:23989
42692 #, no-wrap
42693 msgid "{@code{nslcd-configuration} parameter} string gid"
42694 msgstr ""
42695
42696 #. type: deftypevr
42697 #: guix-git/doc/guix.texi:23991
42698 msgid "This specifies the group id with which the daemon should be run."
42699 msgstr ""
42700
42701 #. type: deftypevr
42702 #: guix-git/doc/guix.texi:23996
42703 #, no-wrap
42704 msgid "{@code{nslcd-configuration} parameter} log-option log"
42705 msgstr ""
42706
42707 #. type: deftypevr
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."
42710 msgstr ""
42711
42712 #. type: deftypevr
42713 #: guix-git/doc/guix.texi:24006
42714 msgid "Defaults to @samp{(\"/var/log/nslcd\" info)}."
42715 msgstr ""
42716
42717 #. type: deftypevr
42718 #: guix-git/doc/guix.texi:24009
42719 #, no-wrap
42720 msgid "{@code{nslcd-configuration} parameter} list uri"
42721 msgstr ""
42722
42723 #. type: deftypevr
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."
42726 msgstr ""
42727
42728 #. type: deftypevr
42729 #: guix-git/doc/guix.texi:24014
42730 msgid "Defaults to @samp{(\"ldap://localhost:389/\")}."
42731 msgstr ""
42732
42733 #. type: deftypevr
42734 #: guix-git/doc/guix.texi:24017
42735 #, no-wrap
42736 msgid "{@code{nslcd-configuration} parameter} maybe-string ldap-version"
42737 msgstr ""
42738
42739 #. type: deftypevr
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."
42742 msgstr ""
42743
42744 #. type: deftypevr
42745 #: guix-git/doc/guix.texi:24025
42746 #, no-wrap
42747 msgid "{@code{nslcd-configuration} parameter} maybe-string binddn"
42748 msgstr ""
42749
42750 #. type: deftypevr
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."
42753 msgstr ""
42754
42755 #. type: deftypevr
42756 #: guix-git/doc/guix.texi:24033
42757 #, no-wrap
42758 msgid "{@code{nslcd-configuration} parameter} maybe-string bindpw"
42759 msgstr ""
42760
42761 #. type: deftypevr
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."
42764 msgstr ""
42765
42766 #. type: deftypevr
42767 #: guix-git/doc/guix.texi:24041
42768 #, no-wrap
42769 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmoddn"
42770 msgstr ""
42771
42772 #. type: deftypevr
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."
42775 msgstr ""
42776
42777 #. type: deftypevr
42778 #: guix-git/doc/guix.texi:24049
42779 #, no-wrap
42780 msgid "{@code{nslcd-configuration} parameter} maybe-string rootpwmodpw"
42781 msgstr ""
42782
42783 #. type: deftypevr
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"
42786 msgstr ""
42787
42788 #. type: deftypevr
42789 #: guix-git/doc/guix.texi:24058
42790 #, no-wrap
42791 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-mech"
42792 msgstr ""
42793
42794 #. type: deftypevr
42795 #: guix-git/doc/guix.texi:24061
42796 msgid "Specifies the SASL mechanism to be used when performing SASL authentication."
42797 msgstr ""
42798
42799 #. type: deftypevr
42800 #: guix-git/doc/guix.texi:24066
42801 #, no-wrap
42802 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-realm"
42803 msgstr ""
42804
42805 #. type: deftypevr
42806 #: guix-git/doc/guix.texi:24068
42807 msgid "Specifies the SASL realm to be used when performing SASL authentication."
42808 msgstr ""
42809
42810 #. type: deftypevr
42811 #: guix-git/doc/guix.texi:24073
42812 #, no-wrap
42813 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authcid"
42814 msgstr ""
42815
42816 #. type: deftypevr
42817 #: guix-git/doc/guix.texi:24076
42818 msgid "Specifies the authentication identity to be used when performing SASL authentication."
42819 msgstr ""
42820
42821 #. type: deftypevr
42822 #: guix-git/doc/guix.texi:24081
42823 #, no-wrap
42824 msgid "{@code{nslcd-configuration} parameter} maybe-string sasl-authzid"
42825 msgstr ""
42826
42827 #. type: deftypevr
42828 #: guix-git/doc/guix.texi:24084
42829 msgid "Specifies the authorization identity to be used when performing SASL authentication."
42830 msgstr ""
42831
42832 #. type: deftypevr
42833 #: guix-git/doc/guix.texi:24089
42834 #, no-wrap
42835 msgid "{@code{nslcd-configuration} parameter} maybe-boolean sasl-canonicalize?"
42836 msgstr ""
42837
42838 #. type: deftypevr
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."
42841 msgstr ""
42842
42843 #. type: deftypevr
42844 #: guix-git/doc/guix.texi:24099
42845 #, no-wrap
42846 msgid "{@code{nslcd-configuration} parameter} maybe-string krb5-ccname"
42847 msgstr ""
42848
42849 #. type: deftypevr
42850 #: guix-git/doc/guix.texi:24101
42851 msgid "Set the name for the GSS-API Kerberos credentials cache."
42852 msgstr ""
42853
42854 #. type: deftypevr
42855 #: guix-git/doc/guix.texi:24106
42856 #, no-wrap
42857 msgid "{@code{nslcd-configuration} parameter} string base"
42858 msgstr ""
42859
42860 #. type: deftypevr
42861 #: guix-git/doc/guix.texi:24108
42862 msgid "The directory search base."
42863 msgstr ""
42864
42865 #. type: deftypevr
42866 #: guix-git/doc/guix.texi:24110
42867 msgid "Defaults to @samp{\"dc=example,dc=com\"}."
42868 msgstr ""
42869
42870 #. type: deftypevr
42871 #: guix-git/doc/guix.texi:24113
42872 #, no-wrap
42873 msgid "{@code{nslcd-configuration} parameter} scope-option scope"
42874 msgstr ""
42875
42876 #. type: deftypevr
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."
42879 msgstr ""
42880
42881 #. type: deftypevr
42882 #: guix-git/doc/guix.texi:24119
42883 msgid "Defaults to @samp{(subtree)}."
42884 msgstr ""
42885
42886 #. type: deftypevr
42887 #: guix-git/doc/guix.texi:24122
42888 #, no-wrap
42889 msgid "{@code{nslcd-configuration} parameter} maybe-deref-option deref"
42890 msgstr ""
42891
42892 #. type: deftypevr
42893 #: guix-git/doc/guix.texi:24125
42894 msgid "Specifies the policy for dereferencing aliases. The default policy is to never dereference aliases."
42895 msgstr ""
42896
42897 #. type: deftypevr
42898 #: guix-git/doc/guix.texi:24130
42899 #, no-wrap
42900 msgid "{@code{nslcd-configuration} parameter} maybe-boolean referrals"
42901 msgstr ""
42902
42903 #. type: deftypevr
42904 #: guix-git/doc/guix.texi:24133
42905 msgid "Specifies whether automatic referral chasing should be enabled. The default behaviour is to chase referrals."
42906 msgstr ""
42907
42908 #. type: deftypevr
42909 #: guix-git/doc/guix.texi:24138
42910 #, no-wrap
42911 msgid "{@code{nslcd-configuration} parameter} list-of-map-entries maps"
42912 msgstr ""
42913
42914 #. type: deftypevr
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."
42917 msgstr ""
42918
42919 #. type: deftypevr
42920 #: guix-git/doc/guix.texi:24148
42921 #, no-wrap
42922 msgid "{@code{nslcd-configuration} parameter} list-of-filter-entries filters"
42923 msgstr ""
42924
42925 #. type: deftypevr
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."
42928 msgstr ""
42929
42930 #. type: deftypevr
42931 #: guix-git/doc/guix.texi:24156
42932 #, no-wrap
42933 msgid "{@code{nslcd-configuration} parameter} maybe-number bind-timelimit"
42934 msgstr ""
42935
42936 #. type: deftypevr
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."
42939 msgstr ""
42940
42941 #. type: deftypevr
42942 #: guix-git/doc/guix.texi:24164
42943 #, no-wrap
42944 msgid "{@code{nslcd-configuration} parameter} maybe-number timelimit"
42945 msgstr ""
42946
42947 #. type: deftypevr
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."
42950 msgstr ""
42951
42952 #. type: deftypevr
42953 #: guix-git/doc/guix.texi:24173
42954 #, no-wrap
42955 msgid "{@code{nslcd-configuration} parameter} maybe-number idle-timelimit"
42956 msgstr ""
42957
42958 #. type: deftypevr
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."
42961 msgstr ""
42962
42963 #. type: deftypevr
42964 #: guix-git/doc/guix.texi:24182
42965 #, no-wrap
42966 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-sleeptime"
42967 msgstr ""
42968
42969 #. type: deftypevr
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."
42972 msgstr ""
42973
42974 #. type: deftypevr
42975 #: guix-git/doc/guix.texi:24191
42976 #, no-wrap
42977 msgid "{@code{nslcd-configuration} parameter} maybe-number reconnect-retrytime"
42978 msgstr ""
42979
42980 #. type: deftypevr
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."
42983 msgstr ""
42984
42985 #. type: deftypevr
42986 #: guix-git/doc/guix.texi:24200
42987 #, no-wrap
42988 msgid "{@code{nslcd-configuration} parameter} maybe-ssl-option ssl"
42989 msgstr ""
42990
42991 #. type: deftypevr
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."
42994 msgstr ""
42995
42996 #. type: deftypevr
42997 #: guix-git/doc/guix.texi:24209
42998 #, no-wrap
42999 msgid "{@code{nslcd-configuration} parameter} maybe-tls-reqcert-option tls-reqcert"
43000 msgstr ""
43001
43002 #. type: deftypevr
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."
43005 msgstr ""
43006
43007 #. type: deftypevr
43008 #: guix-git/doc/guix.texi:24217
43009 #, no-wrap
43010 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertdir"
43011 msgstr ""
43012
43013 #. type: deftypevr
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."
43016 msgstr ""
43017
43018 #. type: deftypevr
43019 #: guix-git/doc/guix.texi:24225
43020 #, no-wrap
43021 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cacertfile"
43022 msgstr ""
43023
43024 #. type: deftypevr
43025 #: guix-git/doc/guix.texi:24227
43026 msgid "Specifies the path to the X.509 certificate for peer authentication."
43027 msgstr ""
43028
43029 #. type: deftypevr
43030 #: guix-git/doc/guix.texi:24232
43031 #, no-wrap
43032 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-randfile"
43033 msgstr ""
43034
43035 #. type: deftypevr
43036 #: guix-git/doc/guix.texi:24235
43037 msgid "Specifies the path to an entropy source. This parameter is ignored when using GnuTLS."
43038 msgstr ""
43039
43040 #. type: deftypevr
43041 #: guix-git/doc/guix.texi:24240
43042 #, no-wrap
43043 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-ciphers"
43044 msgstr ""
43045
43046 #. type: deftypevr
43047 #: guix-git/doc/guix.texi:24242
43048 msgid "Specifies the ciphers to use for TLS as a string."
43049 msgstr ""
43050
43051 #. type: deftypevr
43052 #: guix-git/doc/guix.texi:24247
43053 #, no-wrap
43054 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-cert"
43055 msgstr ""
43056
43057 #. type: deftypevr
43058 #: guix-git/doc/guix.texi:24250
43059 msgid "Specifies the path to the file containing the local certificate for client TLS authentication."
43060 msgstr ""
43061
43062 #. type: deftypevr
43063 #: guix-git/doc/guix.texi:24255
43064 #, no-wrap
43065 msgid "{@code{nslcd-configuration} parameter} maybe-string tls-key"
43066 msgstr ""
43067
43068 #. type: deftypevr
43069 #: guix-git/doc/guix.texi:24258
43070 msgid "Specifies the path to the file containing the private key for client TLS authentication."
43071 msgstr ""
43072
43073 #. type: deftypevr
43074 #: guix-git/doc/guix.texi:24263
43075 #, no-wrap
43076 msgid "{@code{nslcd-configuration} parameter} maybe-number pagesize"
43077 msgstr ""
43078
43079 #. type: deftypevr
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."
43082 msgstr ""
43083
43084 #. type: deftypevr
43085 #: guix-git/doc/guix.texi:24272
43086 #, no-wrap
43087 msgid "{@code{nslcd-configuration} parameter} maybe-ignore-users-option nss-initgroups-ignoreusers"
43088 msgstr ""
43089
43090 #. type: deftypevr
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."
43093 msgstr ""
43094
43095 #. type: deftypevr
43096 #: guix-git/doc/guix.texi:24281
43097 #, no-wrap
43098 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-min-uid"
43099 msgstr ""
43100
43101 #. type: deftypevr
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."
43104 msgstr ""
43105
43106 #. type: deftypevr
43107 #: guix-git/doc/guix.texi:24289
43108 #, no-wrap
43109 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-uid-offset"
43110 msgstr ""
43111
43112 #. type: deftypevr
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."
43115 msgstr ""
43116
43117 #. type: deftypevr
43118 #: guix-git/doc/guix.texi:24297
43119 #, no-wrap
43120 msgid "{@code{nslcd-configuration} parameter} maybe-number nss-gid-offset"
43121 msgstr ""
43122
43123 #. type: deftypevr
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."
43126 msgstr ""
43127
43128 #. type: deftypevr
43129 #: guix-git/doc/guix.texi:24305
43130 #, no-wrap
43131 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-nested-groups"
43132 msgstr ""
43133
43134 #. type: deftypevr
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."
43137 msgstr ""
43138
43139 #. type: deftypevr
43140 #: guix-git/doc/guix.texi:24316
43141 #, no-wrap
43142 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-getgrent-skipmembers"
43143 msgstr ""
43144
43145 #. type: deftypevr
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."
43148 msgstr ""
43149
43150 #. type: deftypevr
43151 #: guix-git/doc/guix.texi:24326
43152 #, no-wrap
43153 msgid "{@code{nslcd-configuration} parameter} maybe-boolean nss-disable-enumeration"
43154 msgstr ""
43155
43156 #. type: deftypevr
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."
43159 msgstr ""
43160
43161 #. type: deftypevr
43162 #: guix-git/doc/guix.texi:24337
43163 #, no-wrap
43164 msgid "{@code{nslcd-configuration} parameter} maybe-string validnames"
43165 msgstr ""
43166
43167 #. type: deftypevr
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."
43170 msgstr ""
43171
43172 #. type: deftypevr
43173 #: guix-git/doc/guix.texi:24346
43174 #, no-wrap
43175 msgid "{@code{nslcd-configuration} parameter} maybe-boolean ignorecase"
43176 msgstr ""
43177
43178 #. type: deftypevr
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."
43181 msgstr ""
43182
43183 #. type: deftypevr
43184 #: guix-git/doc/guix.texi:24356
43185 #, no-wrap
43186 msgid "{@code{nslcd-configuration} parameter} maybe-boolean pam-authc-ppolicy"
43187 msgstr ""
43188
43189 #. type: deftypevr
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."
43192 msgstr ""
43193
43194 #. type: deftypevr
43195 #: guix-git/doc/guix.texi:24364
43196 #, no-wrap
43197 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authc-search"
43198 msgstr ""
43199
43200 #. type: deftypevr
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."
43203 msgstr ""
43204
43205 #. type: deftypevr
43206 #: guix-git/doc/guix.texi:24375
43207 #, no-wrap
43208 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-authz-search"
43209 msgstr ""
43210
43211 #. type: deftypevr
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."
43214 msgstr ""
43215
43216 #. type: deftypevr
43217 #: guix-git/doc/guix.texi:24384
43218 #, no-wrap
43219 msgid "{@code{nslcd-configuration} parameter} maybe-string pam-password-prohibit-message"
43220 msgstr ""
43221
43222 #. type: deftypevr
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."
43225 msgstr ""
43226
43227 #. type: deftypevr
43228 #: guix-git/doc/guix.texi:24394
43229 #, no-wrap
43230 msgid "{@code{nslcd-configuration} parameter} list pam-services"
43231 msgstr ""
43232
43233 #. type: deftypevr
43234 #: guix-git/doc/guix.texi:24396
43235 msgid "List of pam service names for which LDAP authentication should suffice."
43236 msgstr ""
43237
43238 #. type: cindex
43239 #: guix-git/doc/guix.texi:24407
43240 #, no-wrap
43241 msgid "web"
43242 msgstr ""
43243
43244 #. type: cindex
43245 #: guix-git/doc/guix.texi:24408
43246 #, no-wrap
43247 msgid "www"
43248 msgstr ""
43249
43250 #. type: cindex
43251 #: guix-git/doc/guix.texi:24409
43252 #, no-wrap
43253 msgid "HTTP"
43254 msgstr ""
43255
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."
43259 msgstr ""
43260
43261 #. type: subsubheading
43262 #: guix-git/doc/guix.texi:24413
43263 #, no-wrap
43264 msgid "Apache HTTP Server"
43265 msgstr ""
43266
43267 #. type: deffn
43268 #: guix-git/doc/guix.texi:24415
43269 #, no-wrap
43270 msgid "{Scheme Variable} httpd-service-type"
43271 msgstr ""
43272
43273 #. type: deffn
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."
43276 msgstr ""
43277
43278 #. type: deffn
43279 #: guix-git/doc/guix.texi:24421 guix-git/doc/guix.texi:24602
43280 msgid "A simple example configuration is given below."
43281 msgstr ""
43282
43283 #. type: lisp
43284 #: guix-git/doc/guix.texi:24429
43285 #, no-wrap
43286 msgid ""
43287 "(service httpd-service-type\n"
43288 " (httpd-configuration\n"
43289 " (config\n"
43290 " (httpd-config-file\n"
43291 " (server-name \"www.example.com\")\n"
43292 " (document-root \"/srv/http/www.example.com\")))))\n"
43293 msgstr ""
43294
43295 #. type: deffn
43296 #: guix-git/doc/guix.texi:24433
43297 msgid "Other services can also extend the @code{httpd-service-type} to add to the configuration."
43298 msgstr ""
43299
43300 #. type: lisp
43301 #: guix-git/doc/guix.texi:24442 guix-git/doc/guix.texi:24582
43302 #, no-wrap
43303 msgid ""
43304 "(simple-service 'www.example.com-server httpd-service-type\n"
43305 " (list\n"
43306 " (httpd-virtualhost\n"
43307 " \"*:80\"\n"
43308 " (list (string-join '(\"ServerName www.example.com\"\n"
43309 " \"DocumentRoot /srv/http/www.example.com\")\n"
43310 " \"\\n\")))))\n"
43311 msgstr ""
43312
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."
43316 msgstr ""
43317
43318 #. type: deffn
43319 #: guix-git/doc/guix.texi:24449
43320 #, no-wrap
43321 msgid "{Data Type} httpd-configuration"
43322 msgstr ""
43323
43324 #. type: deffn
43325 #: guix-git/doc/guix.texi:24451
43326 msgid "This data type represents the configuration for the httpd service."
43327 msgstr ""
43328
43329 #. type: item
43330 #: guix-git/doc/guix.texi:24453
43331 #, no-wrap
43332 msgid "@code{package} (default: @code{httpd})"
43333 msgstr ""
43334
43335 #. type: table
43336 #: guix-git/doc/guix.texi:24455
43337 msgid "The httpd package to use."
43338 msgstr ""
43339
43340 #. type: item
43341 #: guix-git/doc/guix.texi:24456 guix-git/doc/guix.texi:24545
43342 #, no-wrap
43343 msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})"
43344 msgstr ""
43345
43346 #. type: table
43347 #: guix-git/doc/guix.texi:24458
43348 msgid "The pid file used by the shepherd-service."
43349 msgstr ""
43350
43351 #. type: item
43352 #: guix-git/doc/guix.texi:24459
43353 #, no-wrap
43354 msgid "@code{config} (default: @code{(httpd-config-file)})"
43355 msgstr ""
43356
43357 #. type: table
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."
43360 msgstr ""
43361
43362 #. type: deffn
43363 #: guix-git/doc/guix.texi:24468
43364 #, no-wrap
43365 msgid "{Data Type} httpd-module"
43366 msgstr ""
43367
43368 #. type: deffn
43369 #: guix-git/doc/guix.texi:24470
43370 msgid "This data type represents a module for the httpd service."
43371 msgstr ""
43372
43373 #. type: table
43374 #: guix-git/doc/guix.texi:24474
43375 msgid "The name of the module."
43376 msgstr ""
43377
43378 #. type: table
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\")}."
43381 msgstr ""
43382
43383 #. type: defvr
43384 #: guix-git/doc/guix.texi:24484
43385 #, no-wrap
43386 msgid "{Scheme Variable} %default-httpd-modules"
43387 msgstr ""
43388
43389 #. type: defvr
43390 #: guix-git/doc/guix.texi:24486
43391 msgid "A default list of @code{httpd-module} objects."
43392 msgstr ""
43393
43394 #. type: deffn
43395 #: guix-git/doc/guix.texi:24488
43396 #, no-wrap
43397 msgid "{Data Type} httpd-config-file"
43398 msgstr ""
43399
43400 #. type: deffn
43401 #: guix-git/doc/guix.texi:24490
43402 msgid "This data type represents a configuration file for the httpd service."
43403 msgstr ""
43404
43405 #. type: item
43406 #: guix-git/doc/guix.texi:24492
43407 #, no-wrap
43408 msgid "@code{modules} (default: @code{%default-httpd-modules})"
43409 msgstr ""
43410
43411 #. type: table
43412 #: guix-git/doc/guix.texi:24495
43413 msgid "The modules to load. Additional modules can be added here, or loaded by additional configuration."
43414 msgstr ""
43415
43416 #. type: table
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}:"
43419 msgstr ""
43420
43421 #. type: lisp
43422 #: guix-git/doc/guix.texi:24520
43423 #, no-wrap
43424 msgid ""
43425 "(service httpd-service-type\n"
43426 " (httpd-configuration\n"
43427 " (config\n"
43428 " (httpd-config-file\n"
43429 " (modules (cons*\n"
43430 " (httpd-module\n"
43431 " (name \"proxy_module\")\n"
43432 " (file \"modules/mod_proxy.so\"))\n"
43433 " (httpd-module\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"
43445 msgstr ""
43446
43447 #. type: item
43448 #: guix-git/doc/guix.texi:24522
43449 #, no-wrap
43450 msgid "@code{server-root} (default: @code{httpd})"
43451 msgstr ""
43452
43453 #. type: table
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."
43456 msgstr ""
43457
43458 #. type: item
43459 #: guix-git/doc/guix.texi:24527
43460 #, no-wrap
43461 msgid "@code{server-name} (default: @code{#f})"
43462 msgstr ""
43463
43464 #. type: table
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."
43467 msgstr ""
43468
43469 #. type: table
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}."
43472 msgstr ""
43473
43474 #. type: item
43475 #: guix-git/doc/guix.texi:24536
43476 #, no-wrap
43477 msgid "@code{document-root} (default: @code{\"/srv/http\"})"
43478 msgstr ""
43479
43480 #. type: table
43481 #: guix-git/doc/guix.texi:24538
43482 msgid "The @code{DocumentRoot} from which files will be served."
43483 msgstr ""
43484
43485 #. type: item
43486 #: guix-git/doc/guix.texi:24539
43487 #, no-wrap
43488 msgid "@code{listen} (default: @code{'(\"80\")})"
43489 msgstr ""
43490
43491 #. type: table
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."
43494 msgstr ""
43495
43496 #. type: table
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."
43499 msgstr ""
43500
43501 #. type: item
43502 #: guix-git/doc/guix.texi:24550
43503 #, no-wrap
43504 msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})"
43505 msgstr ""
43506
43507 #. type: table
43508 #: guix-git/doc/guix.texi:24552
43509 msgid "The @code{ErrorLog} to which the server will log errors."
43510 msgstr ""
43511
43512 #. type: item
43513 #: guix-git/doc/guix.texi:24553 guix-git/doc/guix.texi:25114
43514 #, no-wrap
43515 msgid "@code{user} (default: @code{\"httpd\"})"
43516 msgstr ""
43517
43518 #. type: table
43519 #: guix-git/doc/guix.texi:24555
43520 msgid "The @code{User} which the server will answer requests as."
43521 msgstr ""
43522
43523 #. type: item
43524 #: guix-git/doc/guix.texi:24556
43525 #, no-wrap
43526 msgid "@code{group} (default: @code{\"httpd\"})"
43527 msgstr ""
43528
43529 #. type: table
43530 #: guix-git/doc/guix.texi:24558
43531 msgid "The @code{Group} which the server will answer requests as."
43532 msgstr ""
43533
43534 #. type: item
43535 #: guix-git/doc/guix.texi:24559
43536 #, no-wrap
43537 msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})"
43538 msgstr ""
43539
43540 #. type: table
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."
43543 msgstr ""
43544
43545 #. type: table
43546 #: guix-git/doc/guix.texi:24565
43547 msgid "Any values which the service is extended with will be appended to this list."
43548 msgstr ""
43549
43550 #. type: deffn
43551 #: guix-git/doc/guix.texi:24569
43552 #, no-wrap
43553 msgid "{Data Type} httpd-virtualhost"
43554 msgstr ""
43555
43556 #. type: deffn
43557 #: guix-git/doc/guix.texi:24571
43558 msgid "This data type represents a virtualhost configuration block for the httpd service."
43559 msgstr ""
43560
43561 #. type: deffn
43562 #: guix-git/doc/guix.texi:24573
43563 msgid "These should be added to the extra-config for the httpd-service."
43564 msgstr ""
43565
43566 #. type: code{#1}
43567 #: guix-git/doc/guix.texi:24585
43568 #, no-wrap
43569 msgid "addresses-and-ports"
43570 msgstr ""
43571
43572 #. type: table
43573 #: guix-git/doc/guix.texi:24587
43574 msgid "The addresses and ports for the @code{VirtualHost} directive."
43575 msgstr ""
43576
43577 #. type: code{#1}
43578 #: guix-git/doc/guix.texi:24588
43579 #, no-wrap
43580 msgid "contents"
43581 msgstr ""
43582
43583 #. type: table
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."
43586 msgstr ""
43587
43588 #. type: subsubheading
43589 #: guix-git/doc/guix.texi:24595
43590 #, no-wrap
43591 msgid "NGINX"
43592 msgstr ""
43593
43594 #. type: deffn
43595 #: guix-git/doc/guix.texi:24597
43596 #, no-wrap
43597 msgid "{Scheme Variable} nginx-service-type"
43598 msgstr ""
43599
43600 #. type: deffn
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."
43603 msgstr ""
43604
43605 #. type: lisp
43606 #: guix-git/doc/guix.texi:24610 guix-git/doc/guix.texi:24664
43607 #, no-wrap
43608 msgid ""
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"
43615 msgstr ""
43616
43617 #. type: deffn
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:"
43620 msgstr ""
43621
43622 #. type: lisp
43623 #: guix-git/doc/guix.texi:24621
43624 #, no-wrap
43625 msgid ""
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"
43630 msgstr ""
43631
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."
43635 msgstr ""
43636
43637 #. type: deffn
43638 #: guix-git/doc/guix.texi:24633
43639 #, no-wrap
43640 msgid "{Data Type} nginx-configuration"
43641 msgstr ""
43642
43643 #. type: deffn
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."
43646 msgstr ""
43647
43648 #. type: item
43649 #: guix-git/doc/guix.texi:24639
43650 #, no-wrap
43651 msgid "@code{nginx} (default: @code{nginx})"
43652 msgstr ""
43653
43654 #. type: table
43655 #: guix-git/doc/guix.texi:24641
43656 msgid "The nginx package to use."
43657 msgstr ""
43658
43659 #. type: item
43660 #: guix-git/doc/guix.texi:24642
43661 #, no-wrap
43662 msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})"
43663 msgstr ""
43664
43665 #. type: table
43666 #: guix-git/doc/guix.texi:24644
43667 msgid "The directory to which NGinx will write log files."
43668 msgstr ""
43669
43670 #. type: item
43671 #: guix-git/doc/guix.texi:24645
43672 #, no-wrap
43673 msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})"
43674 msgstr ""
43675
43676 #. type: table
43677 #: guix-git/doc/guix.texi:24648
43678 msgid "The directory in which NGinx will create a pid file, and write temporary files."
43679 msgstr ""
43680
43681 #. type: item
43682 #: guix-git/doc/guix.texi:24649
43683 #, no-wrap
43684 msgid "@code{server-blocks} (default: @code{'()})"
43685 msgstr ""
43686
43687 #. type: table
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>}."
43690 msgstr ""
43691
43692 #. type: table
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."
43695 msgstr ""
43696
43697 #. type: item
43698 #: guix-git/doc/guix.texi:24666
43699 #, no-wrap
43700 msgid "@code{upstream-blocks} (default: @code{'()})"
43701 msgstr ""
43702
43703 #. type: table
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>}."
43706 msgstr ""
43707
43708 #. type: table
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."
43711 msgstr ""
43712
43713 #. type: lisp
43714 #: guix-git/doc/guix.texi:24696
43715 #, no-wrap
43716 msgid ""
43717 "(service\n"
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"
43724 " (locations\n"
43725 " (list\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"
43734 msgstr ""
43735
43736 #. type: table
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."
43739 msgstr ""
43740
43741 #. type: table
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."
43744 msgstr ""
43745
43746 #. type: item
43747 #: guix-git/doc/guix.texi:24709
43748 #, no-wrap
43749 msgid "@code{server-names-hash-bucket-size} (default: @code{#f})"
43750 msgstr ""
43751
43752 #. type: table
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."
43755 msgstr ""
43756
43757 #. type: item
43758 #: guix-git/doc/guix.texi:24713
43759 #, no-wrap
43760 msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})"
43761 msgstr ""
43762
43763 #. type: table
43764 #: guix-git/doc/guix.texi:24715
43765 msgid "Maximum bucket size for the server names hash tables."
43766 msgstr ""
43767
43768 #. type: table
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:"
43771 msgstr ""
43772
43773 #. type: lisp
43774 #: guix-git/doc/guix.texi:24727
43775 #, no-wrap
43776 msgid ""
43777 "(modules\n"
43778 " (list\n"
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"
43783 msgstr ""
43784
43785 #. type: item
43786 #: guix-git/doc/guix.texi:24729
43787 #, no-wrap
43788 msgid "@code{lua-package-path} (default: @code{'()})"
43789 msgstr ""
43790
43791 #. type: table
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:"
43794 msgstr ""
43795
43796 #. type: lisp
43797 #: guix-git/doc/guix.texi:24739
43798 #, no-wrap
43799 msgid ""
43800 "(lua-package-path (list lua-resty-core\n"
43801 " lua-resty-lrucache\n"
43802 " lua-resty-signal\n"
43803 " lua-tablepool\n"
43804 " lua-resty-shell))\n"
43805 msgstr ""
43806
43807 #. type: item
43808 #: guix-git/doc/guix.texi:24741
43809 #, no-wrap
43810 msgid "@code{lua-package-cpath} (default: @code{'()})"
43811 msgstr ""
43812
43813 #. type: table
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:"
43816 msgstr ""
43817
43818 #. type: lisp
43819 #: guix-git/doc/guix.texi:24747
43820 #, no-wrap
43821 msgid "(lua-package-cpath (list lua-resty-signal))\n"
43822 msgstr ""
43823
43824 #. type: item
43825 #: guix-git/doc/guix.texi:24749
43826 #, no-wrap
43827 msgid "@code{global-directives} (default: @code{'((events . ()))})"
43828 msgstr ""
43829
43830 #. type: table
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."
43833 msgstr ""
43834
43835 #. type: lisp
43836 #: guix-git/doc/guix.texi:24758
43837 #, no-wrap
43838 msgid ""
43839 "(global-directives\n"
43840 " `((worker_processes . 16)\n"
43841 " (pcre_jit . on)\n"
43842 " (events . ((worker_connections . 1024)))))\n"
43843 msgstr ""
43844
43845 #. type: table
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."
43848 msgstr ""
43849
43850 #. type: deftp
43851 #: guix-git/doc/guix.texi:24767
43852 #, no-wrap
43853 msgid "{Data Type} nginx-server-configuration"
43854 msgstr ""
43855
43856 #. type: deftp
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:"
43859 msgstr ""
43860
43861 #. type: item
43862 #: guix-git/doc/guix.texi:24772
43863 #, no-wrap
43864 msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})"
43865 msgstr ""
43866
43867 #. type: table
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:"
43870 msgstr ""
43871
43872 #. type: lisp
43873 #: guix-git/doc/guix.texi:24780
43874 #, no-wrap
43875 msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n"
43876 msgstr ""
43877
43878 #. type: item
43879 #: guix-git/doc/guix.texi:24782
43880 #, no-wrap
43881 msgid "@code{server-name} (default: @code{(list 'default)})"
43882 msgstr ""
43883
43884 #. type: table
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."
43887 msgstr ""
43888
43889 #. type: item
43890 #: guix-git/doc/guix.texi:24786
43891 #, no-wrap
43892 msgid "@code{root} (default: @code{\"/srv/http\"})"
43893 msgstr ""
43894
43895 #. type: table
43896 #: guix-git/doc/guix.texi:24788
43897 msgid "Root of the website nginx will serve."
43898 msgstr ""
43899
43900 #. type: item
43901 #: guix-git/doc/guix.texi:24789
43902 #, no-wrap
43903 msgid "@code{locations} (default: @code{'()})"
43904 msgstr ""
43905
43906 #. type: table
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."
43909 msgstr ""
43910
43911 #. type: item
43912 #: guix-git/doc/guix.texi:24794
43913 #, no-wrap
43914 msgid "@code{index} (default: @code{(list \"index.html\")})"
43915 msgstr ""
43916
43917 #. type: table
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."
43920 msgstr ""
43921
43922 #. type: item
43923 #: guix-git/doc/guix.texi:24798
43924 #, no-wrap
43925 msgid "@code{try-files} (default: @code{'()})"
43926 msgstr ""
43927
43928 #. type: table
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."
43931 msgstr ""
43932
43933 #. type: item
43934 #: guix-git/doc/guix.texi:24802
43935 #, no-wrap
43936 msgid "@code{ssl-certificate} (default: @code{#f})"
43937 msgstr ""
43938
43939 #. type: table
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."
43942 msgstr ""
43943
43944 #. type: item
43945 #: guix-git/doc/guix.texi:24806
43946 #, no-wrap
43947 msgid "@code{ssl-certificate-key} (default: @code{#f})"
43948 msgstr ""
43949
43950 #. type: table
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."
43953 msgstr ""
43954
43955 #. type: item
43956 #: guix-git/doc/guix.texi:24810
43957 #, no-wrap
43958 msgid "@code{server-tokens?} (default: @code{#f})"
43959 msgstr ""
43960
43961 #. type: table
43962 #: guix-git/doc/guix.texi:24812
43963 msgid "Whether the server should add its configuration to response."
43964 msgstr ""
43965
43966 #. type: item
43967 #: guix-git/doc/guix.texi:24813
43968 #, no-wrap
43969 msgid "@code{raw-content} (default: @code{'()})"
43970 msgstr ""
43971
43972 #. type: table
43973 #: guix-git/doc/guix.texi:24815
43974 msgid "A list of raw lines added to the server block."
43975 msgstr ""
43976
43977 #. type: deftp
43978 #: guix-git/doc/guix.texi:24819
43979 #, no-wrap
43980 msgid "{Data Type} nginx-upstream-configuration"
43981 msgstr ""
43982
43983 #. type: deftp
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:"
43986 msgstr ""
43987
43988 #. type: table
43989 #: guix-git/doc/guix.texi:24826
43990 msgid "Name for this group of servers."
43991 msgstr ""
43992
43993 #. type: code{#1}
43994 #: guix-git/doc/guix.texi:24827
43995 #, no-wrap
43996 msgid "servers"
43997 msgstr ""
43998
43999 #. type: table
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."
44002 msgstr ""
44003
44004 #. type: deftp
44005 #: guix-git/doc/guix.texi:24838
44006 #, no-wrap
44007 msgid "{Data Type} nginx-location-configuration"
44008 msgstr ""
44009
44010 #. type: deftp
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:"
44013 msgstr ""
44014
44015 #. type: table
44016 #: guix-git/doc/guix.texi:24845
44017 msgid "URI which this location block matches."
44018 msgstr ""
44019
44020 #. type: anchor{#1}
44021 #: guix-git/doc/guix.texi:24847
44022 msgid "nginx-location-configuration body"
44023 msgstr ""
44024
44025 #. type: code{#1}
44026 #: guix-git/doc/guix.texi:24847 guix-git/doc/guix.texi:24868
44027 #, no-wrap
44028 msgid "body"
44029 msgstr ""
44030
44031 #. type: table
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;\")}."
44034 msgstr ""
44035
44036 #. type: deftp
44037 #: guix-git/doc/guix.texi:24858
44038 #, no-wrap
44039 msgid "{Data Type} nginx-named-location-configuration"
44040 msgstr ""
44041
44042 #. type: deftp
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:"
44045 msgstr ""
44046
44047 #. type: table
44048 #: guix-git/doc/guix.texi:24867
44049 msgid "Name to identify this location block."
44050 msgstr ""
44051
44052 #. type: table
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."
44055 msgstr ""
44056
44057 #. type: subsubheading
44058 #: guix-git/doc/guix.texi:24877
44059 #, no-wrap
44060 msgid "Varnish Cache"
44061 msgstr ""
44062
44063 #. type: cindex
44064 #: guix-git/doc/guix.texi:24878
44065 #, no-wrap
44066 msgid "Varnish"
44067 msgstr ""
44068
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."
44072 msgstr ""
44073
44074 #. type: defvr
44075 #: guix-git/doc/guix.texi:24884
44076 #, no-wrap
44077 msgid "{Scheme Variable} varnish-service-type"
44078 msgstr ""
44079
44080 #. type: defvr
44081 #: guix-git/doc/guix.texi:24886
44082 msgid "Service type for the Varnish daemon."
44083 msgstr ""
44084
44085 #. type: deftp
44086 #: guix-git/doc/guix.texi:24888
44087 #, no-wrap
44088 msgid "{Data Type} varnish-configuration"
44089 msgstr ""
44090
44091 #. type: deftp
44092 #: guix-git/doc/guix.texi:24891
44093 msgid "Data type representing the @code{varnish} service configuration. This type has the following parameters:"
44094 msgstr ""
44095
44096 #. type: item
44097 #: guix-git/doc/guix.texi:24893
44098 #, no-wrap
44099 msgid "@code{package} (default: @code{varnish})"
44100 msgstr ""
44101
44102 #. type: table
44103 #: guix-git/doc/guix.texi:24895
44104 msgid "The Varnish package to use."
44105 msgstr ""
44106
44107 #. type: item
44108 #: guix-git/doc/guix.texi:24896
44109 #, no-wrap
44110 msgid "@code{name} (default: @code{\"default\"})"
44111 msgstr ""
44112
44113 #. type: table
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."
44116 msgstr ""
44117
44118 #. type: table
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}."
44121 msgstr ""
44122
44123 #. type: item
44124 #: guix-git/doc/guix.texi:24905
44125 #, no-wrap
44126 msgid "@code{backend} (default: @code{\"localhost:8080\"})"
44127 msgstr ""
44128
44129 #. type: table
44130 #: guix-git/doc/guix.texi:24907
44131 msgid "The backend to use. This option has no effect if @code{vcl} is set."
44132 msgstr ""
44133
44134 #. type: item
44135 #: guix-git/doc/guix.texi:24908
44136 #, no-wrap
44137 msgid "@code{vcl} (default: #f)"
44138 msgstr ""
44139
44140 #. type: table
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."
44143 msgstr ""
44144
44145 #. type: table
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:"
44148 msgstr ""
44149
44150 #. type: lisp
44151 #: guix-git/doc/guix.texi:24923
44152 #, no-wrap
44153 msgid ""
44154 "(define %gnu-mirror\n"
44155 " (plain-file \"gnu.vcl\"\n"
44156 " \"vcl 4.1;\n"
44157 "backend gnu @{ .host = \\\"www.gnu.org\\\"; @}\"))\n"
44158 "\n"
44159 msgstr ""
44160
44161 #. type: lisp
44162 #: guix-git/doc/guix.texi:24931
44163 #, no-wrap
44164 msgid ""
44165 "(operating-system\n"
44166 " ;; @dots{}\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"
44172 msgstr ""
44173
44174 #. type: table
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."
44177 msgstr ""
44178
44179 #. type: table
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."
44182 msgstr ""
44183
44184 #. type: item
44185 #: guix-git/doc/guix.texi:24940
44186 #, no-wrap
44187 msgid "@code{listen} (default: @code{'(\"localhost:80\")})"
44188 msgstr ""
44189
44190 #. type: table
44191 #: guix-git/doc/guix.texi:24942
44192 msgid "List of addresses Varnish will listen on."
44193 msgstr ""
44194
44195 #. type: item
44196 #: guix-git/doc/guix.texi:24943
44197 #, no-wrap
44198 msgid "@code{storage} (default: @code{'(\"malloc,128m\")})"
44199 msgstr ""
44200
44201 #. type: table
44202 #: guix-git/doc/guix.texi:24945
44203 msgid "List of storage backends that will be available in VCL."
44204 msgstr ""
44205
44206 #. type: item
44207 #: guix-git/doc/guix.texi:24946
44208 #, no-wrap
44209 msgid "@code{parameters} (default: @code{'()})"
44210 msgstr ""
44211
44212 #. type: table
44213 #: guix-git/doc/guix.texi:24948
44214 msgid "List of run-time parameters in the form @code{'((\"parameter\" . \"value\"))}."
44215 msgstr ""
44216
44217 #. type: table
44218 #: guix-git/doc/guix.texi:24951
44219 msgid "Additional arguments to pass to the @command{varnishd} process."
44220 msgstr ""
44221
44222 #. type: cindex
44223 #: guix-git/doc/guix.texi:24955 guix-git/doc/guix.texi:24956
44224 #, no-wrap
44225 msgid "Patchwork"
44226 msgstr ""
44227
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."
44231 msgstr ""
44232
44233 #. type: defvr
44234 #: guix-git/doc/guix.texi:24960
44235 #, no-wrap
44236 msgid "{Scheme Variable} patchwork-service-type"
44237 msgstr ""
44238
44239 #. type: defvr
44240 #: guix-git/doc/guix.texi:24962
44241 msgid "Service type for Patchwork."
44242 msgstr ""
44243
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."
44247 msgstr ""
44248
44249 #. type: lisp
44250 #: guix-git/doc/guix.texi:24986
44251 #, no-wrap
44252 msgid ""
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"
44264 " (port 993)\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"
44271 "\n"
44272 msgstr ""
44273
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."
44277 msgstr ""
44278
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."
44282 msgstr ""
44283
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."
44287 msgstr ""
44288
44289 #. type: deftp
44290 #: guix-git/doc/guix.texi:25001
44291 #, no-wrap
44292 msgid "{Data Type} patchwork-configuration"
44293 msgstr ""
44294
44295 #. type: deftp
44296 #: guix-git/doc/guix.texi:25004
44297 msgid "Data type representing the Patchwork service configuration. This type has the following parameters:"
44298 msgstr ""
44299
44300 #. type: item
44301 #: guix-git/doc/guix.texi:25006
44302 #, no-wrap
44303 msgid "@code{patchwork} (default: @code{patchwork})"
44304 msgstr ""
44305
44306 #. type: table
44307 #: guix-git/doc/guix.texi:25008
44308 msgid "The Patchwork package to use."
44309 msgstr ""
44310
44311 #. type: code{#1}
44312 #: guix-git/doc/guix.texi:25009
44313 #, no-wrap
44314 msgid "domain"
44315 msgstr ""
44316
44317 #. type: table
44318 #: guix-git/doc/guix.texi:25012
44319 msgid "The domain to use for Patchwork, this is used in the HTTPD service virtual host."
44320 msgstr ""
44321
44322 #. type: code{#1}
44323 #: guix-git/doc/guix.texi:25013
44324 #, no-wrap
44325 msgid "settings-module"
44326 msgstr ""
44327
44328 #. type: table
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."
44331 msgstr ""
44332
44333 #. type: item
44334 #: guix-git/doc/guix.texi:25020
44335 #, no-wrap
44336 msgid "@code{static-path} (default: @code{\"/static/\"})"
44337 msgstr ""
44338
44339 #. type: table
44340 #: guix-git/doc/guix.texi:25022
44341 msgid "The path under which the HTTPD service should serve the static files."
44342 msgstr ""
44343
44344 #. type: code{#1}
44345 #: guix-git/doc/guix.texi:25023
44346 #, no-wrap
44347 msgid "getmail-retriever-config"
44348 msgstr ""
44349
44350 #. type: table
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."
44353 msgstr ""
44354
44355 #. type: deftp
44356 #: guix-git/doc/guix.texi:25031
44357 #, no-wrap
44358 msgid "{Data Type} patchwork-settings-module"
44359 msgstr ""
44360
44361 #. type: deftp
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:"
44364 msgstr ""
44365
44366 #. type: item
44367 #: guix-git/doc/guix.texi:25038
44368 #, no-wrap
44369 msgid "@code{database-configuration} (default: @code{(patchwork-database-configuration)})"
44370 msgstr ""
44371
44372 #. type: table
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."
44375 msgstr ""
44376
44377 #. type: item
44378 #: guix-git/doc/guix.texi:25042
44379 #, no-wrap
44380 msgid "@code{secret-key-file} (default: @code{\"/etc/patchwork/django-secret-key\"})"
44381 msgstr ""
44382
44383 #. type: table
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."
44386 msgstr ""
44387
44388 #. type: table
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."
44391 msgstr ""
44392
44393 #. type: table
44394 #: guix-git/doc/guix.texi:25050
44395 msgid "This setting relates to Django."
44396 msgstr ""
44397
44398 #. type: code{#1}
44399 #: guix-git/doc/guix.texi:25051
44400 #, no-wrap
44401 msgid "allowed-hosts"
44402 msgstr ""
44403
44404 #. type: table
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."
44407 msgstr ""
44408
44409 #. type: table
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."
44413 msgstr ""
44414
44415 #. type: code{#1}
44416 #: guix-git/doc/guix.texi:25057
44417 #, no-wrap
44418 msgid "default-from-email"
44419 msgstr ""
44420
44421 #. type: table
44422 #: guix-git/doc/guix.texi:25059
44423 msgid "The email address from which Patchwork should send email by default."
44424 msgstr ""
44425
44426 #. type: table
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."
44430 msgstr ""
44431
44432 #. type: item
44433 #: guix-git/doc/guix.texi:25062
44434 #, no-wrap
44435 msgid "@code{static-url} (default: @code{#f})"
44436 msgstr ""
44437
44438 #. type: table
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{/}."
44441 msgstr ""
44442
44443 #. type: table
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."
44446 msgstr ""
44447
44448 #. type: item
44449 #: guix-git/doc/guix.texi:25071
44450 #, no-wrap
44451 msgid "@code{admins} (default: @code{'()})"
44452 msgstr ""
44453
44454 #. type: table
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."
44457 msgstr ""
44458
44459 #. type: table
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."
44462 msgstr ""
44463
44464 #. type: item
44465 #: guix-git/doc/guix.texi:25083
44466 #, no-wrap
44467 msgid "@code{enable-rest-api?} (default: @code{#t})"
44468 msgstr ""
44469
44470 #. type: table
44471 #: guix-git/doc/guix.texi:25085
44472 msgid "Whether to enable the Patchwork REST API."
44473 msgstr ""
44474
44475 #. type: item
44476 #: guix-git/doc/guix.texi:25088
44477 #, no-wrap
44478 msgid "@code{enable-xmlrpc?} (default: @code{#t})"
44479 msgstr ""
44480
44481 #. type: table
44482 #: guix-git/doc/guix.texi:25090
44483 msgid "Whether to enable the XML RPC API."
44484 msgstr ""
44485
44486 #. type: item
44487 #: guix-git/doc/guix.texi:25093
44488 #, no-wrap
44489 msgid "@code{force-https-links?} (default: @code{#t})"
44490 msgstr ""
44491
44492 #. type: table
44493 #: guix-git/doc/guix.texi:25095
44494 msgid "Whether to use HTTPS links on Patchwork pages."
44495 msgstr ""
44496
44497 #. type: table
44498 #: guix-git/doc/guix.texi:25100
44499 msgid "Extra code to place at the end of the Patchwork settings module."
44500 msgstr ""
44501
44502 #. type: deftp
44503 #: guix-git/doc/guix.texi:25104
44504 #, no-wrap
44505 msgid "{Data Type} patchwork-database-configuration"
44506 msgstr ""
44507
44508 #. type: deftp
44509 #: guix-git/doc/guix.texi:25106
44510 msgid "Data type representing the database configuration for Patchwork."
44511 msgstr ""
44512
44513 #. type: item
44514 #: guix-git/doc/guix.texi:25108
44515 #, no-wrap
44516 msgid "@code{engine} (default: @code{\"django.db.backends.postgresql_psycopg2\"})"
44517 msgstr ""
44518
44519 #. type: table
44520 #: guix-git/doc/guix.texi:25110
44521 msgid "The database engine to use."
44522 msgstr ""
44523
44524 #. type: item
44525 #: guix-git/doc/guix.texi:25111
44526 #, no-wrap
44527 msgid "@code{name} (default: @code{\"patchwork\"})"
44528 msgstr ""
44529
44530 #. type: table
44531 #: guix-git/doc/guix.texi:25113
44532 msgid "The name of the database to use."
44533 msgstr ""
44534
44535 #. type: table
44536 #: guix-git/doc/guix.texi:25116
44537 msgid "The user to connect to the database as."
44538 msgstr ""
44539
44540 #. type: item
44541 #: guix-git/doc/guix.texi:25117
44542 #, no-wrap
44543 msgid "@code{password} (default: @code{\"\"})"
44544 msgstr ""
44545
44546 #. type: table
44547 #: guix-git/doc/guix.texi:25119
44548 msgid "The password to use when connecting to the database."
44549 msgstr ""
44550
44551 #. type: item
44552 #: guix-git/doc/guix.texi:25120
44553 #, no-wrap
44554 msgid "@code{host} (default: @code{\"\"})"
44555 msgstr ""
44556
44557 #. type: table
44558 #: guix-git/doc/guix.texi:25122
44559 msgid "The host to make the database connection to."
44560 msgstr ""
44561
44562 #. type: item
44563 #: guix-git/doc/guix.texi:25123
44564 #, no-wrap
44565 msgid "@code{port} (default: @code{\"\"})"
44566 msgstr ""
44567
44568 #. type: table
44569 #: guix-git/doc/guix.texi:25125
44570 msgid "The port on which to connect to the database."
44571 msgstr ""
44572
44573 #. type: subsubheading
44574 #: guix-git/doc/guix.texi:25129
44575 #, no-wrap
44576 msgid "Mumi"
44577 msgstr ""
44578
44579 #. type: cindex
44580 #: guix-git/doc/guix.texi:25131
44581 #, no-wrap
44582 msgid "Mumi, Debbugs Web interface"
44583 msgstr ""
44584
44585 #. type: cindex
44586 #: guix-git/doc/guix.texi:25132
44587 #, no-wrap
44588 msgid "Debbugs, Mumi Web interface"
44589 msgstr ""
44590
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."
44594 msgstr ""
44595
44596 #. type: defvr
44597 #: guix-git/doc/guix.texi:25138
44598 #, no-wrap
44599 msgid "{Scheme Variable} mumi-service-type"
44600 msgstr ""
44601
44602 #. type: defvr
44603 #: guix-git/doc/guix.texi:25140
44604 msgid "This is the service type for Mumi."
44605 msgstr ""
44606
44607 #. type: deftp
44608 #: guix-git/doc/guix.texi:25142
44609 #, no-wrap
44610 msgid "{Data Type} mumi-configuration"
44611 msgstr ""
44612
44613 #. type: deftp
44614 #: guix-git/doc/guix.texi:25145
44615 msgid "Data type representing the Mumi service configuration. This type has the following fields:"
44616 msgstr ""
44617
44618 #. type: item
44619 #: guix-git/doc/guix.texi:25147
44620 #, no-wrap
44621 msgid "@code{mumi} (default: @code{mumi})"
44622 msgstr ""
44623
44624 #. type: table
44625 #: guix-git/doc/guix.texi:25149
44626 msgid "The Mumi package to use."
44627 msgstr ""
44628
44629 #. type: item
44630 #: guix-git/doc/guix.texi:25150
44631 #, no-wrap
44632 msgid "@code{mailer?} (default: @code{#true})"
44633 msgstr ""
44634
44635 #. type: table
44636 #: guix-git/doc/guix.texi:25152
44637 msgid "Whether to enable or disable the mailer component."
44638 msgstr ""
44639
44640 #. type: code{#1}
44641 #: guix-git/doc/guix.texi:25153
44642 #, no-wrap
44643 msgid "mumi-configuration-sender"
44644 msgstr ""
44645
44646 #. type: table
44647 #: guix-git/doc/guix.texi:25155
44648 msgid "The email address used as the sender for comments."
44649 msgstr ""
44650
44651 #. type: code{#1}
44652 #: guix-git/doc/guix.texi:25156
44653 #, no-wrap
44654 msgid "mumi-configuration-smtp"
44655 msgstr ""
44656
44657 #. type: table
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}."
44660 msgstr ""
44661
44662 #. type: subsubheading
44663 #: guix-git/doc/guix.texi:25166
44664 #, no-wrap
44665 msgid "FastCGI"
44666 msgstr ""
44667
44668 #. type: cindex
44669 #: guix-git/doc/guix.texi:25167
44670 #, no-wrap
44671 msgid "fastcgi"
44672 msgstr ""
44673
44674 #. type: cindex
44675 #: guix-git/doc/guix.texi:25168
44676 #, no-wrap
44677 msgid "fcgiwrap"
44678 msgstr ""
44679
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."
44683 msgstr ""
44684
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."
44688 msgstr ""
44689
44690 #. type: defvr
44691 #: guix-git/doc/guix.texi:25183
44692 #, no-wrap
44693 msgid "{Scheme Variable} fcgiwrap-service-type"
44694 msgstr ""
44695
44696 #. type: defvr
44697 #: guix-git/doc/guix.texi:25185
44698 msgid "A service type for the @code{fcgiwrap} FastCGI proxy."
44699 msgstr ""
44700
44701 #. type: deftp
44702 #: guix-git/doc/guix.texi:25187
44703 #, no-wrap
44704 msgid "{Data Type} fcgiwrap-configuration"
44705 msgstr ""
44706
44707 #. type: deftp
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:"
44710 msgstr ""
44711
44712 #. type: item
44713 #: guix-git/doc/guix.texi:25191
44714 #, no-wrap
44715 msgid "@code{package} (default: @code{fcgiwrap})"
44716 msgstr ""
44717
44718 #. type: table
44719 #: guix-git/doc/guix.texi:25193
44720 msgid "The fcgiwrap package to use."
44721 msgstr ""
44722
44723 #. type: item
44724 #: guix-git/doc/guix.texi:25194
44725 #, no-wrap
44726 msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})"
44727 msgstr ""
44728
44729 #. type: table
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}."
44732 msgstr ""
44733
44734 #. type: item
44735 #: guix-git/doc/guix.texi:25201
44736 #, no-wrap
44737 msgid "@code{user} (default: @code{fcgiwrap})"
44738 msgstr ""
44739
44740 #. type: itemx
44741 #: guix-git/doc/guix.texi:25202
44742 #, no-wrap
44743 msgid "@code{group} (default: @code{fcgiwrap})"
44744 msgstr ""
44745
44746 #. type: table
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."
44749 msgstr ""
44750
44751 #. type: table
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."
44754 msgstr ""
44755
44756 #. type: cindex
44757 #: guix-git/doc/guix.texi:25217
44758 #, no-wrap
44759 msgid "php-fpm"
44760 msgstr ""
44761
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."
44765 msgstr ""
44766
44767 #. type: Plain text
44768 #: guix-git/doc/guix.texi:25222
44769 msgid "These features include:"
44770 msgstr ""
44771
44772 #. type: item
44773 #: guix-git/doc/guix.texi:25223
44774 #, no-wrap
44775 msgid "Adaptive process spawning"
44776 msgstr ""
44777
44778 #. type: item
44779 #: guix-git/doc/guix.texi:25224
44780 #, no-wrap
44781 msgid "Basic statistics (similar to Apache's mod_status)"
44782 msgstr ""
44783
44784 #. type: item
44785 #: guix-git/doc/guix.texi:25225
44786 #, no-wrap
44787 msgid "Advanced process management with graceful stop/start"
44788 msgstr ""
44789
44790 #. type: item
44791 #: guix-git/doc/guix.texi:25226
44792 #, no-wrap
44793 msgid "Ability to start workers with different uid/gid/chroot/environment"
44794 msgstr ""
44795
44796 #. type: itemize
44797 #: guix-git/doc/guix.texi:25228
44798 msgid "and different php.ini (replaces safe_mode)"
44799 msgstr ""
44800
44801 #. type: item
44802 #: guix-git/doc/guix.texi:25228
44803 #, no-wrap
44804 msgid "Stdout & stderr logging"
44805 msgstr ""
44806
44807 #. type: item
44808 #: guix-git/doc/guix.texi:25229
44809 #, no-wrap
44810 msgid "Emergency restart in case of accidental opcode cache destruction"
44811 msgstr ""
44812
44813 #. type: item
44814 #: guix-git/doc/guix.texi:25230
44815 #, no-wrap
44816 msgid "Accelerated upload support"
44817 msgstr ""
44818
44819 #. type: item
44820 #: guix-git/doc/guix.texi:25231
44821 #, no-wrap
44822 msgid "Support for a \"slowlog\""
44823 msgstr ""
44824
44825 #. type: item
44826 #: guix-git/doc/guix.texi:25232
44827 #, no-wrap
44828 msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -"
44829 msgstr ""
44830
44831 #. type: itemize
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.)"
44834 msgstr ""
44835
44836 #. type: Plain text
44837 #: guix-git/doc/guix.texi:25237
44838 msgid "...@: and much more."
44839 msgstr ""
44840
44841 #. type: defvr
44842 #: guix-git/doc/guix.texi:25238
44843 #, no-wrap
44844 msgid "{Scheme Variable} php-fpm-service-type"
44845 msgstr ""
44846
44847 #. type: defvr
44848 #: guix-git/doc/guix.texi:25240
44849 msgid "A Service type for @code{php-fpm}."
44850 msgstr ""
44851
44852 #. type: deftp
44853 #: guix-git/doc/guix.texi:25242
44854 #, no-wrap
44855 msgid "{Data Type} php-fpm-configuration"
44856 msgstr ""
44857
44858 #. type: deftp
44859 #: guix-git/doc/guix.texi:25244
44860 msgid "Data Type for php-fpm service configuration."
44861 msgstr ""
44862
44863 #. type: item
44864 #: guix-git/doc/guix.texi:25245
44865 #, no-wrap
44866 msgid "@code{php} (default: @code{php})"
44867 msgstr ""
44868
44869 #. type: table
44870 #: guix-git/doc/guix.texi:25247
44871 msgid "The php package to use."
44872 msgstr ""
44873
44874 #. type: item
44875 #: guix-git/doc/guix.texi:25247
44876 #, no-wrap
44877 msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})"
44878 msgstr ""
44879
44880 #. type: table
44881 #: guix-git/doc/guix.texi:25249
44882 msgid "The address on which to accept FastCGI requests. Valid syntaxes are:"
44883 msgstr ""
44884
44885 #. type: code{#1}
44886 #: guix-git/doc/guix.texi:25250
44887 #, no-wrap
44888 msgid "\"ip.add.re.ss:port\""
44889 msgstr ""
44890
44891 #. type: table
44892 #: guix-git/doc/guix.texi:25252
44893 msgid "Listen on a TCP socket to a specific address on a specific port."
44894 msgstr ""
44895
44896 #. type: code{#1}
44897 #: guix-git/doc/guix.texi:25252
44898 #, no-wrap
44899 msgid "\"port\""
44900 msgstr ""
44901
44902 #. type: table
44903 #: guix-git/doc/guix.texi:25254
44904 msgid "Listen on a TCP socket to all addresses on a specific port."
44905 msgstr ""
44906
44907 #. type: code{#1}
44908 #: guix-git/doc/guix.texi:25254
44909 #, no-wrap
44910 msgid "\"/path/to/unix/socket\""
44911 msgstr ""
44912
44913 #. type: table
44914 #: guix-git/doc/guix.texi:25256
44915 msgid "Listen on a unix socket."
44916 msgstr ""
44917
44918 #. type: item
44919 #: guix-git/doc/guix.texi:25258
44920 #, no-wrap
44921 msgid "@code{user} (default: @code{php-fpm})"
44922 msgstr ""
44923
44924 #. type: table
44925 #: guix-git/doc/guix.texi:25260
44926 msgid "User who will own the php worker processes."
44927 msgstr ""
44928
44929 #. type: item
44930 #: guix-git/doc/guix.texi:25260
44931 #, no-wrap
44932 msgid "@code{group} (default: @code{php-fpm})"
44933 msgstr ""
44934
44935 #. type: table
44936 #: guix-git/doc/guix.texi:25262
44937 msgid "Group of the worker processes."
44938 msgstr ""
44939
44940 #. type: item
44941 #: guix-git/doc/guix.texi:25262
44942 #, no-wrap
44943 msgid "@code{socket-user} (default: @code{php-fpm})"
44944 msgstr ""
44945
44946 #. type: table
44947 #: guix-git/doc/guix.texi:25264
44948 msgid "User who can speak to the php-fpm socket."
44949 msgstr ""
44950
44951 #. type: item
44952 #: guix-git/doc/guix.texi:25264
44953 #, no-wrap
44954 msgid "@code{socket-group} (default: @code{nginx})"
44955 msgstr ""
44956
44957 #. type: table
44958 #: guix-git/doc/guix.texi:25266
44959 msgid "Group that can speak to the php-fpm socket."
44960 msgstr ""
44961
44962 #. type: item
44963 #: guix-git/doc/guix.texi:25266
44964 #, no-wrap
44965 msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})"
44966 msgstr ""
44967
44968 #. type: table
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."
44971 msgstr ""
44972
44973 #. type: item
44974 #: guix-git/doc/guix.texi:25269
44975 #, no-wrap
44976 msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})"
44977 msgstr ""
44978
44979 #. type: table
44980 #: guix-git/doc/guix.texi:25271
44981 msgid "Log for the php-fpm master process."
44982 msgstr ""
44983
44984 #. type: item
44985 #: guix-git/doc/guix.texi:25271
44986 #, no-wrap
44987 msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})"
44988 msgstr ""
44989
44990 #. type: table
44991 #: guix-git/doc/guix.texi:25274
44992 msgid "Detailed settings for the php-fpm process manager. Must be one of:"
44993 msgstr ""
44994
44995 #. type: code{#1}
44996 #: guix-git/doc/guix.texi:25275
44997 #, no-wrap
44998 msgid "<php-fpm-dynamic-process-manager-configuration>"
44999 msgstr ""
45000
45001 #. type: code{#1}
45002 #: guix-git/doc/guix.texi:25276
45003 #, no-wrap
45004 msgid "<php-fpm-static-process-manager-configuration>"
45005 msgstr ""
45006
45007 #. type: code{#1}
45008 #: guix-git/doc/guix.texi:25277
45009 #, no-wrap
45010 msgid "<php-fpm-on-demand-process-manager-configuration>"
45011 msgstr ""
45012
45013 #. type: item
45014 #: guix-git/doc/guix.texi:25279
45015 #, no-wrap
45016 msgid "@code{display-errors} (default @code{#f})"
45017 msgstr ""
45018
45019 #. type: table
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."
45022 msgstr ""
45023
45024 #. type: item
45025 #: guix-git/doc/guix.texi:25284
45026 #, no-wrap
45027 msgid "@code{timezone} (default @code{#f})"
45028 msgstr ""
45029
45030 #. type: table
45031 #: guix-git/doc/guix.texi:25286
45032 msgid "Specifies @code{php_admin_value[date.timezone]} parameter."
45033 msgstr ""
45034
45035 #. type: item
45036 #: guix-git/doc/guix.texi:25286
45037 #, no-wrap
45038 msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})"
45039 msgstr ""
45040
45041 #. type: table
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."
45044 msgstr ""
45045
45046 #. type: item
45047 #: guix-git/doc/guix.texi:25289
45048 #, no-wrap
45049 msgid "@code{file} (default @code{#f})"
45050 msgstr ""
45051
45052 #. type: table
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."
45055 msgstr ""
45056
45057 #. type: item
45058 #: guix-git/doc/guix.texi:25292
45059 #, no-wrap
45060 msgid "@code{php-ini-file} (default @code{#f})"
45061 msgstr ""
45062
45063 #. type: table
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."
45066 msgstr ""
45067
45068 #. type: table
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:"
45071 msgstr ""
45072
45073 #. type: lisp
45074 #: guix-git/doc/guix.texi:25305
45075 #, no-wrap
45076 msgid ""
45077 "(define %local-php-ini\n"
45078 " (plain-file \"php.ini\"\n"
45079 " \"memory_limit = 2G\n"
45080 "max_execution_time = 1800\"))\n"
45081 "\n"
45082 msgstr ""
45083
45084 #. type: lisp
45085 #: guix-git/doc/guix.texi:25312
45086 #, no-wrap
45087 msgid ""
45088 "(operating-system\n"
45089 " ;; @dots{}\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"
45094 msgstr ""
45095
45096 #. type: table
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."
45099 msgstr ""
45100
45101 #. type: deftp
45102 #: guix-git/doc/guix.texi:25320
45103 #, no-wrap
45104 msgid "{Data type} php-fpm-dynamic-process-manager-configuration"
45105 msgstr ""
45106
45107 #. type: deftp
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."
45110 msgstr ""
45111
45112 #. type: item
45113 #: guix-git/doc/guix.texi:25325 guix-git/doc/guix.texi:25341
45114 #: guix-git/doc/guix.texi:25351
45115 #, no-wrap
45116 msgid "@code{max-children} (default: @code{5})"
45117 msgstr ""
45118
45119 #. type: table
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."
45123 msgstr ""
45124
45125 #. type: item
45126 #: guix-git/doc/guix.texi:25327
45127 #, no-wrap
45128 msgid "@code{start-servers} (default: @code{2})"
45129 msgstr ""
45130
45131 #. type: table
45132 #: guix-git/doc/guix.texi:25329
45133 msgid "How many worker processes should be started on start-up."
45134 msgstr ""
45135
45136 #. type: item
45137 #: guix-git/doc/guix.texi:25329
45138 #, no-wrap
45139 msgid "@code{min-spare-servers} (default: @code{1})"
45140 msgstr ""
45141
45142 #. type: table
45143 #: guix-git/doc/guix.texi:25331
45144 msgid "How many spare worker processes should be kept around at minimum."
45145 msgstr ""
45146
45147 #. type: item
45148 #: guix-git/doc/guix.texi:25331
45149 #, no-wrap
45150 msgid "@code{max-spare-servers} (default: @code{3})"
45151 msgstr ""
45152
45153 #. type: table
45154 #: guix-git/doc/guix.texi:25333
45155 msgid "How many spare worker processes should be kept around at maximum."
45156 msgstr ""
45157
45158 #. type: deftp
45159 #: guix-git/doc/guix.texi:25336
45160 #, no-wrap
45161 msgid "{Data type} php-fpm-static-process-manager-configuration"
45162 msgstr ""
45163
45164 #. type: deftp
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."
45167 msgstr ""
45168
45169 #. type: deftp
45170 #: guix-git/doc/guix.texi:25346
45171 #, no-wrap
45172 msgid "{Data type} php-fpm-on-demand-process-manager-configuration"
45173 msgstr ""
45174
45175 #. type: deftp
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."
45178 msgstr ""
45179
45180 #. type: item
45181 #: guix-git/doc/guix.texi:25353
45182 #, no-wrap
45183 msgid "@code{process-idle-timeout} (default: @code{10})"
45184 msgstr ""
45185
45186 #. type: table
45187 #: guix-git/doc/guix.texi:25355
45188 msgid "The time in seconds after which a process with no requests is killed."
45189 msgstr ""
45190
45191 #. type: deffn
45192 #: guix-git/doc/guix.texi:25359
45193 #, no-wrap
45194 msgid "{Scheme Procedure} nginx-php-location @"
45195 msgstr ""
45196
45197 #. type: deffn
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}."
45200 msgstr ""
45201
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:"
45205 msgstr ""
45206
45207 #. type: lisp
45208 #: guix-git/doc/guix.texi:25381
45209 #, no-wrap
45210 msgid ""
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"
45217 " (locations\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"
45223 msgstr ""
45224
45225 #. type: cindex
45226 #: guix-git/doc/guix.texi:25383
45227 #, no-wrap
45228 msgid "cat-avatar-generator"
45229 msgstr ""
45230
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."
45234 msgstr ""
45235
45236 #. type: deffn
45237 #: guix-git/doc/guix.texi:25388
45238 #, no-wrap
45239 msgid "{Scheme Procedure} cat-avatar-generator-service @"
45240 msgstr ""
45241
45242 #. type: deffn
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."
45245 msgstr ""
45246
45247 #. type: Plain text
45248 #: guix-git/doc/guix.texi:25399
45249 msgid "A simple setup for cat-avatar-generator can look like this:"
45250 msgstr ""
45251
45252 #. type: lisp
45253 #: guix-git/doc/guix.texi:25406
45254 #, no-wrap
45255 msgid ""
45256 "(services (cons* (cat-avatar-generator-service\n"
45257 " #:configuration\n"
45258 " (nginx-server-configuration\n"
45259 " (server-name '(\"example.com\"))))\n"
45260 " ...\n"
45261 " %base-services))\n"
45262 msgstr ""
45263
45264 #. type: subsubheading
45265 #: guix-git/doc/guix.texi:25408
45266 #, no-wrap
45267 msgid "Hpcguix-web"
45268 msgstr ""
45269
45270 #. type: cindex
45271 #: guix-git/doc/guix.texi:25410
45272 #, no-wrap
45273 msgid "hpcguix-web"
45274 msgstr ""
45275
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."
45279 msgstr ""
45280
45281 #. type: defvr
45282 #: guix-git/doc/guix.texi:25416
45283 #, no-wrap
45284 msgid "{Scheme Variable} hpcguix-web-service-type"
45285 msgstr ""
45286
45287 #. type: defvr
45288 #: guix-git/doc/guix.texi:25418
45289 msgid "The service type for @code{hpcguix-web}."
45290 msgstr ""
45291
45292 #. type: deftp
45293 #: guix-git/doc/guix.texi:25420
45294 #, no-wrap
45295 msgid "{Data Type} hpcguix-web-configuration"
45296 msgstr ""
45297
45298 #. type: deftp
45299 #: guix-git/doc/guix.texi:25422
45300 msgid "Data type for the hpcguix-web service configuration."
45301 msgstr ""
45302
45303 #. type: code{#1}
45304 #: guix-git/doc/guix.texi:25424
45305 #, no-wrap
45306 msgid "specs"
45307 msgstr ""
45308
45309 #. type: table
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:"
45312 msgstr ""
45313
45314 #. type: item
45315 #: guix-git/doc/guix.texi:25429
45316 #, no-wrap
45317 msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})"
45318 msgstr ""
45319
45320 #. type: table
45321 #: guix-git/doc/guix.texi:25431
45322 msgid "The page title prefix."
45323 msgstr ""
45324
45325 #. type: item
45326 #: guix-git/doc/guix.texi:25432
45327 #, no-wrap
45328 msgid "@code{guix-command} (default: @code{\"guix\"})"
45329 msgstr ""
45330
45331 #. type: table
45332 #: guix-git/doc/guix.texi:25434
45333 msgid "The @command{guix} command."
45334 msgstr ""
45335
45336 #. type: item
45337 #: guix-git/doc/guix.texi:25435
45338 #, no-wrap
45339 msgid "@code{package-filter-proc} (default: @code{(const #t)})"
45340 msgstr ""
45341
45342 #. type: table
45343 #: guix-git/doc/guix.texi:25437
45344 msgid "A procedure specifying how to filter packages that are displayed."
45345 msgstr ""
45346
45347 #. type: item
45348 #: guix-git/doc/guix.texi:25438
45349 #, no-wrap
45350 msgid "@code{package-page-extension-proc} (default: @code{(const '())})"
45351 msgstr ""
45352
45353 #. type: table
45354 #: guix-git/doc/guix.texi:25440
45355 msgid "Extension package for @code{hpcguix-web}."
45356 msgstr ""
45357
45358 #. type: item
45359 #: guix-git/doc/guix.texi:25441
45360 #, no-wrap
45361 msgid "@code{menu} (default: @code{'()})"
45362 msgstr ""
45363
45364 #. type: table
45365 #: guix-git/doc/guix.texi:25443
45366 msgid "Additional entry in page @code{menu}."
45367 msgstr ""
45368
45369 #. type: item
45370 #: guix-git/doc/guix.texi:25444
45371 #, no-wrap
45372 msgid "@code{channels} (default: @code{%default-channels})"
45373 msgstr ""
45374
45375 #. type: table
45376 #: guix-git/doc/guix.texi:25446
45377 msgid "List of channels from which the package list is built (@pxref{Channels})."
45378 msgstr ""
45379
45380 #. type: item
45381 #: guix-git/doc/guix.texi:25447
45382 #, no-wrap
45383 msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})"
45384 msgstr ""
45385
45386 #. type: table
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."
45389 msgstr ""
45390
45391 #. type: table
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}."
45394 msgstr ""
45395
45396 #. type: item
45397 #: guix-git/doc/guix.texi:25456
45398 #, no-wrap
45399 msgid "@code{package} (default: @code{hpcguix-web})"
45400 msgstr ""
45401
45402 #. type: table
45403 #: guix-git/doc/guix.texi:25458
45404 msgid "The hpcguix-web package to use."
45405 msgstr ""
45406
45407 #. type: Plain text
45408 #: guix-git/doc/guix.texi:25462
45409 msgid "A typical hpcguix-web service declaration looks like this:"
45410 msgstr ""
45411
45412 #. type: lisp
45413 #: guix-git/doc/guix.texi:25471
45414 #, no-wrap
45415 msgid ""
45416 "(service hpcguix-web-service-type\n"
45417 " (hpcguix-web-configuration\n"
45418 " (specs\n"
45419 " #~(define site-config\n"
45420 " (hpcweb-configuration\n"
45421 " (title-prefix \"Guix-HPC - \")\n"
45422 " (menu '((\"/about\" \"ABOUT\"))))))))\n"
45423 msgstr ""
45424
45425 #. type: quotation
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."
45428 msgstr ""
45429
45430 #. type: quotation
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."
45433 msgstr ""
45434
45435 #. type: cindex
45436 #: guix-git/doc/guix.texi:25484 guix-git/doc/guix.texi:25486
45437 #, no-wrap
45438 msgid "gmnisrv"
45439 msgstr ""
45440
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."
45444 msgstr ""
45445
45446 #. type: deffn
45447 #: guix-git/doc/guix.texi:25490
45448 #, no-wrap
45449 msgid "{Scheme Variable} gmnisrv-service-type"
45450 msgstr ""
45451
45452 #. type: deffn
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:"
45455 msgstr ""
45456
45457 #. type: lisp
45458 #: guix-git/doc/guix.texi:25498
45459 #, no-wrap
45460 msgid ""
45461 "(service gmnisrv-service-type\n"
45462 " (gmnisrv-configuration\n"
45463 " (config-file (local-file \"./my-gmnisrv.ini\"))))\n"
45464 msgstr ""
45465
45466 #. type: deftp
45467 #: guix-git/doc/guix.texi:25501
45468 #, no-wrap
45469 msgid "{Data Type} gmnisrv-configuration"
45470 msgstr ""
45471
45472 #. type: deftp
45473 #: guix-git/doc/guix.texi:25503
45474 msgid "Data type representing the configuration of gmnisrv."
45475 msgstr ""
45476
45477 #. type: item
45478 #: guix-git/doc/guix.texi:25505
45479 #, no-wrap
45480 msgid "@code{package} (default: @var{gmnisrv})"
45481 msgstr ""
45482
45483 #. type: table
45484 #: guix-git/doc/guix.texi:25507
45485 msgid "Package object of the gmnisrv server."
45486 msgstr ""
45487
45488 #. type: item
45489 #: guix-git/doc/guix.texi:25508
45490 #, no-wrap
45491 msgid "@code{config-file} (default: @code{%default-gmnisrv-config-file})"
45492 msgstr ""
45493
45494 #. type: table
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}."
45497 msgstr ""
45498
45499 #. type: subsubheading
45500 #: guix-git/doc/guix.texi:25518
45501 #, no-wrap
45502 msgid "Agate"
45503 msgstr ""
45504
45505 #. type: cindex
45506 #: guix-git/doc/guix.texi:25520
45507 #, no-wrap
45508 msgid "agate"
45509 msgstr ""
45510
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."
45514 msgstr ""
45515
45516 #. type: deffn
45517 #: guix-git/doc/guix.texi:25526
45518 #, no-wrap
45519 msgid "{Scheme Variable} agate-service-type"
45520 msgstr ""
45521
45522 #. type: deffn
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:"
45525 msgstr ""
45526
45527 #. type: lisp
45528 #: guix-git/doc/guix.texi:25536
45529 #, no-wrap
45530 msgid ""
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"
45536 msgstr ""
45537
45538 #. type: deffn
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."
45541 msgstr ""
45542
45543 #. type: deffn
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:"
45546 msgstr ""
45547
45548 #. type: example
45549 #: guix-git/doc/guix.texi:25548
45550 #, no-wrap
45551 msgid ""
45552 "openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \\\n"
45553 " -days 3650 -nodes -subj \"/CN=example.com\"\n"
45554 msgstr ""
45555
45556 #. type: deffn
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."
45559 msgstr ""
45560
45561 #. type: deftp
45562 #: guix-git/doc/guix.texi:25556
45563 #, no-wrap
45564 msgid "{Data Type} agate-configuration"
45565 msgstr ""
45566
45567 #. type: deftp
45568 #: guix-git/doc/guix.texi:25558
45569 msgid "Data type representing the configuration of Agate."
45570 msgstr ""
45571
45572 #. type: item
45573 #: guix-git/doc/guix.texi:25560
45574 #, no-wrap
45575 msgid "@code{package} (default: @code{agate})"
45576 msgstr ""
45577
45578 #. type: table
45579 #: guix-git/doc/guix.texi:25562
45580 msgid "The package object of the Agate server."
45581 msgstr ""
45582
45583 #. type: item
45584 #: guix-git/doc/guix.texi:25563
45585 #, no-wrap
45586 msgid "@code{content} (default: @file{\"/srv/gemini\"})"
45587 msgstr ""
45588
45589 #. type: table
45590 #: guix-git/doc/guix.texi:25565
45591 msgid "The directory from which Agate will serve files."
45592 msgstr ""
45593
45594 #. type: item
45595 #: guix-git/doc/guix.texi:25566
45596 #, no-wrap
45597 msgid "@code{cert} (default: @code{#f})"
45598 msgstr ""
45599
45600 #. type: table
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."
45603 msgstr ""
45604
45605 #. type: item
45606 #: guix-git/doc/guix.texi:25570 guix-git/doc/guix.texi:25998
45607 #, no-wrap
45608 msgid "@code{key} (default: @code{#f})"
45609 msgstr ""
45610
45611 #. type: table
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."
45614 msgstr ""
45615
45616 #. type: item
45617 #: guix-git/doc/guix.texi:25574
45618 #, no-wrap
45619 msgid "@code{addr} (default: @code{'(\"0.0.0.0:1965\" \"[::]:1965\")})"
45620 msgstr ""
45621
45622 #. type: table
45623 #: guix-git/doc/guix.texi:25576
45624 msgid "A list of the addresses to listen on."
45625 msgstr ""
45626
45627 #. type: table
45628 #: guix-git/doc/guix.texi:25579
45629 msgid "The domain name of this Gemini server. Optional."
45630 msgstr ""
45631
45632 #. type: item
45633 #: guix-git/doc/guix.texi:25580
45634 #, no-wrap
45635 msgid "@code{lang} (default: @code{#f})"
45636 msgstr ""
45637
45638 #. type: table
45639 #: guix-git/doc/guix.texi:25582
45640 msgid "RFC 4646 language code(s) for text/gemini documents. Optional."
45641 msgstr ""
45642
45643 #. type: item
45644 #: guix-git/doc/guix.texi:25583
45645 #, no-wrap
45646 msgid "@code{silent?} (default: @code{#f})"
45647 msgstr ""
45648
45649 #. type: table
45650 #: guix-git/doc/guix.texi:25585
45651 msgid "Set to @code{#t} to disable logging output."
45652 msgstr ""
45653
45654 #. type: item
45655 #: guix-git/doc/guix.texi:25586
45656 #, no-wrap
45657 msgid "@code{serve-secret?} (default: @code{#f})"
45658 msgstr ""
45659
45660 #. type: table
45661 #: guix-git/doc/guix.texi:25589
45662 msgid "Set to @code{#t} to serve secret files (files/directories starting with a dot)."
45663 msgstr ""
45664
45665 #. type: item
45666 #: guix-git/doc/guix.texi:25590
45667 #, no-wrap
45668 msgid "@code{log-ip?} (default: @code{#t})"
45669 msgstr ""
45670
45671 #. type: table
45672 #: guix-git/doc/guix.texi:25592
45673 msgid "Whether or not to output IP addresses when logging."
45674 msgstr ""
45675
45676 #. type: item
45677 #: guix-git/doc/guix.texi:25593
45678 #, no-wrap
45679 msgid "@code{user} (default: @code{\"agate\"})"
45680 msgstr ""
45681
45682 #. type: table
45683 #: guix-git/doc/guix.texi:25595
45684 msgid "Owner of the @code{agate} process."
45685 msgstr ""
45686
45687 #. type: item
45688 #: guix-git/doc/guix.texi:25596
45689 #, no-wrap
45690 msgid "@code{group} (default: @code{\"agate\"})"
45691 msgstr ""
45692
45693 #. type: table
45694 #: guix-git/doc/guix.texi:25598
45695 msgid "Owner's group of the @code{agate} process."
45696 msgstr ""
45697
45698 #. type: item
45699 #: guix-git/doc/guix.texi:25599
45700 #, no-wrap
45701 msgid "@code{log-file} (default: @file{\"/var/log/agate.log\"})"
45702 msgstr ""
45703
45704 #. type: table
45705 #: guix-git/doc/guix.texi:25601
45706 msgid "The file which should store the logging output of Agate."
45707 msgstr ""
45708
45709 #. type: cindex
45710 #: guix-git/doc/guix.texi:25608
45711 #, no-wrap
45712 msgid "Web"
45713 msgstr ""
45714
45715 #. type: cindex
45716 #: guix-git/doc/guix.texi:25609
45717 #, no-wrap
45718 msgid "HTTP, HTTPS"
45719 msgstr ""
45720
45721 #. type: cindex
45722 #: guix-git/doc/guix.texi:25610
45723 #, no-wrap
45724 msgid "Let's Encrypt"
45725 msgstr ""
45726
45727 #. type: cindex
45728 #: guix-git/doc/guix.texi:25611
45729 #, no-wrap
45730 msgid "TLS certificates"
45731 msgstr ""
45732
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."
45736 msgstr ""
45737
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."
45741 msgstr ""
45742
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)."
45746 msgstr ""
45747
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."
45751 msgstr ""
45752
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}."
45756 msgstr ""
45757
45758 #. type: defvr
45759 #: guix-git/doc/guix.texi:25648
45760 #, no-wrap
45761 msgid "{Scheme Variable} certbot-service-type"
45762 msgstr ""
45763
45764 #. type: defvr
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:"
45767 msgstr ""
45768
45769 #. type: lisp
45770 #: guix-git/doc/guix.texi:25658
45771 #, no-wrap
45772 msgid ""
45773 "(define %nginx-deploy-hook\n"
45774 " (program-file\n"
45775 " \"nginx-deploy-hook\"\n"
45776 " #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n"
45777 " (kill pid SIGHUP))))\n"
45778 "\n"
45779 msgstr ""
45780
45781 #. type: lisp
45782 #: guix-git/doc/guix.texi:25669
45783 #, no-wrap
45784 msgid ""
45785 "(service certbot-service-type\n"
45786 " (certbot-configuration\n"
45787 " (email \"foo@@example.net\")\n"
45788 " (certificates\n"
45789 " (list\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"
45795 msgstr ""
45796
45797 #. type: defvr
45798 #: guix-git/doc/guix.texi:25672
45799 msgid "See below for details about @code{certbot-configuration}."
45800 msgstr ""
45801
45802 #. type: deftp
45803 #: guix-git/doc/guix.texi:25674
45804 #, no-wrap
45805 msgid "{Data Type} certbot-configuration"
45806 msgstr ""
45807
45808 #. type: deftp
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:"
45811 msgstr ""
45812
45813 #. type: item
45814 #: guix-git/doc/guix.texi:25679
45815 #, no-wrap
45816 msgid "@code{package} (default: @code{certbot})"
45817 msgstr ""
45818
45819 #. type: table
45820 #: guix-git/doc/guix.texi:25681
45821 msgid "The certbot package to use."
45822 msgstr ""
45823
45824 #. type: item
45825 #: guix-git/doc/guix.texi:25682
45826 #, no-wrap
45827 msgid "@code{webroot} (default: @code{/var/www})"
45828 msgstr ""
45829
45830 #. type: table
45831 #: guix-git/doc/guix.texi:25685
45832 msgid "The directory from which to serve the Let's Encrypt challenge/response files."
45833 msgstr ""
45834
45835 #. type: item
45836 #: guix-git/doc/guix.texi:25686
45837 #, no-wrap
45838 msgid "@code{certificates} (default: @code{()})"
45839 msgstr ""
45840
45841 #. type: table
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}."
45844 msgstr ""
45845
45846 #. type: item
45847 #: guix-git/doc/guix.texi:25691
45848 #, no-wrap
45849 msgid "@code{email} (default: @code{#f})"
45850 msgstr ""
45851
45852 #. type: table
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."
45855 msgstr ""
45856
45857 #. type: item
45858 #: guix-git/doc/guix.texi:25696 guix-git/doc/guix.texi:27376
45859 #, no-wrap
45860 msgid "@code{server} (default: @code{#f})"
45861 msgstr ""
45862
45863 #. type: table
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."
45866 msgstr ""
45867
45868 #. type: item
45869 #: guix-git/doc/guix.texi:25700
45870 #, no-wrap
45871 msgid "@code{rsa-key-size} (default: @code{2048})"
45872 msgstr ""
45873
45874 #. type: table
45875 #: guix-git/doc/guix.texi:25702
45876 msgid "Size of the RSA key."
45877 msgstr ""
45878
45879 #. type: item
45880 #: guix-git/doc/guix.texi:25703
45881 #, no-wrap
45882 msgid "@code{default-location} (default: @i{see below})"
45883 msgstr ""
45884
45885 #. type: table
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."
45888 msgstr ""
45889
45890 #. type: table
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."
45893 msgstr ""
45894
45895 #. type: table
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}."
45898 msgstr ""
45899
45900 #. type: table
45901 #: guix-git/doc/guix.texi:25722
45902 msgid "Pass @code{#f} to not issue a default location."
45903 msgstr ""
45904
45905 #. type: deftp
45906 #: guix-git/doc/guix.texi:25725
45907 #, no-wrap
45908 msgid "{Data Type} certificate-configuration"
45909 msgstr ""
45910
45911 #. type: deftp
45912 #: guix-git/doc/guix.texi:25728
45913 msgid "Data type representing the configuration of a certificate. This type has the following parameters:"
45914 msgstr ""
45915
45916 #. type: item
45917 #: guix-git/doc/guix.texi:25730
45918 #, no-wrap
45919 msgid "@code{name} (default: @i{see below})"
45920 msgstr ""
45921
45922 #. type: table
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}."
45925 msgstr ""
45926
45927 #. type: table
45928 #: guix-git/doc/guix.texi:25736
45929 msgid "Its default is the first provided domain."
45930 msgstr ""
45931
45932 #. type: item
45933 #: guix-git/doc/guix.texi:25737
45934 #, no-wrap
45935 msgid "@code{domains} (default: @code{()})"
45936 msgstr ""
45937
45938 #. type: table
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."
45941 msgstr ""
45942
45943 #. type: item
45944 #: guix-git/doc/guix.texi:25741
45945 #, no-wrap
45946 msgid "@code{challenge} (default: @code{#f})"
45947 msgstr ""
45948
45949 #. type: table
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."
45952 msgstr ""
45953
45954 #. type: item
45955 #: guix-git/doc/guix.texi:25749
45956 #, no-wrap
45957 msgid "@code{authentication-hook} (default: @code{#f})"
45958 msgstr ""
45959
45960 #. type: table
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."
45963 msgstr ""
45964
45965 #. type: item
45966 #: guix-git/doc/guix.texi:25756
45967 #, no-wrap
45968 msgid "@code{cleanup-hook} (default: @code{#f})"
45969 msgstr ""
45970
45971 #. type: table
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."
45974 msgstr ""
45975
45976 #. type: item
45977 #: guix-git/doc/guix.texi:25763
45978 #, no-wrap
45979 msgid "@code{deploy-hook} (default: @code{#f})"
45980 msgstr ""
45981
45982 #. type: table
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\"}."
45985 msgstr ""
45986
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}."
45990 msgstr ""
45991
45992 #. type: cindex
45993 #: guix-git/doc/guix.texi:25780
45994 #, no-wrap
45995 msgid "DNS (domain name system)"
45996 msgstr ""
45997
45998 #. type: cindex
45999 #: guix-git/doc/guix.texi:25781
46000 #, no-wrap
46001 msgid "domain name system (DNS)"
46002 msgstr ""
46003
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}."
46007 msgstr ""
46008
46009 #. type: subsubheading
46010 #: guix-git/doc/guix.texi:25790
46011 #, no-wrap
46012 msgid "Knot Service"
46013 msgstr ""
46014
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:"
46018 msgstr ""
46019
46020 #. type: lisp
46021 #: guix-git/doc/guix.texi:25801
46022 #, no-wrap
46023 msgid ""
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"
46029 "\n"
46030 msgstr ""
46031
46032 #. type: lisp
46033 #: guix-git/doc/guix.texi:25808
46034 #, no-wrap
46035 msgid ""
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"
46042 "\n"
46043 msgstr ""
46044
46045 #. type: lisp
46046 #: guix-git/doc/guix.texi:25814
46047 #, no-wrap
46048 msgid ""
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"
46054 "\n"
46055 msgstr ""
46056
46057 #. type: lisp
46058 #: guix-git/doc/guix.texi:25819
46059 #, no-wrap
46060 msgid ""
46061 "(define plop-master\n"
46062 " (knot-remote-configuration\n"
46063 " (id \"plop-master\")\n"
46064 " (address (list \"208.76.58.171\"))))\n"
46065 "\n"
46066 msgstr ""
46067
46068 #. type: lisp
46069 #: guix-git/doc/guix.texi:25828
46070 #, no-wrap
46071 msgid ""
46072 "(operating-system\n"
46073 " ;; ...\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"
46078 " ;; ...\n"
46079 " %base-services)))\n"
46080 msgstr ""
46081
46082 #. type: deffn
46083 #: guix-git/doc/guix.texi:25830
46084 #, no-wrap
46085 msgid "{Scheme Variable} knot-service-type"
46086 msgstr ""
46087
46088 #. type: deffn
46089 #: guix-git/doc/guix.texi:25832
46090 msgid "This is the type for the Knot DNS server."
46091 msgstr ""
46092
46093 #. type: deffn
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."
46096 msgstr ""
46097
46098 #. type: deffn
46099 #: guix-git/doc/guix.texi:25842
46100 msgid "The following data types are used to configure the Knot DNS server:"
46101 msgstr ""
46102
46103 #. type: deftp
46104 #: guix-git/doc/guix.texi:25844
46105 #, no-wrap
46106 msgid "{Data Type} knot-key-configuration"
46107 msgstr ""
46108
46109 #. type: deftp
46110 #: guix-git/doc/guix.texi:25847
46111 msgid "Data type representing a key. This type has the following parameters:"
46112 msgstr ""
46113
46114 #. type: item
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
46118 #, no-wrap
46119 msgid "@code{id} (default: @code{\"\"})"
46120 msgstr ""
46121
46122 #. type: table
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."
46125 msgstr ""
46126
46127 #. type: item
46128 #: guix-git/doc/guix.texi:25853
46129 #, no-wrap
46130 msgid "@code{algorithm} (default: @code{#f})"
46131 msgstr ""
46132
46133 #. type: table
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}."
46136 msgstr ""
46137
46138 #. type: item
46139 #: guix-git/doc/guix.texi:25858
46140 #, no-wrap
46141 msgid "@code{secret} (default: @code{\"\"})"
46142 msgstr ""
46143
46144 #. type: table
46145 #: guix-git/doc/guix.texi:25860
46146 msgid "The secret key itself."
46147 msgstr ""
46148
46149 #. type: deftp
46150 #: guix-git/doc/guix.texi:25864
46151 #, no-wrap
46152 msgid "{Data Type} knot-acl-configuration"
46153 msgstr ""
46154
46155 #. type: deftp
46156 #: guix-git/doc/guix.texi:25867
46157 msgid "Data type representing an Access Control List (ACL) configuration. This type has the following parameters:"
46158 msgstr ""
46159
46160 #. type: item
46161 #: guix-git/doc/guix.texi:25873 guix-git/doc/guix.texi:25988
46162 #, no-wrap
46163 msgid "@code{address} (default: @code{'()})"
46164 msgstr ""
46165
46166 #. type: table
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."
46169 msgstr ""
46170
46171 #. type: item
46172 #: guix-git/doc/guix.texi:25878
46173 #, no-wrap
46174 msgid "@code{key} (default: @code{'()})"
46175 msgstr ""
46176
46177 #. type: table
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."
46180 msgstr ""
46181
46182 #. type: item
46183 #: guix-git/doc/guix.texi:25883
46184 #, no-wrap
46185 msgid "@code{action} (default: @code{'()})"
46186 msgstr ""
46187
46188 #. type: table
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}."
46191 msgstr ""
46192
46193 #. type: item
46194 #: guix-git/doc/guix.texi:25888
46195 #, no-wrap
46196 msgid "@code{deny?} (default: @code{#f})"
46197 msgstr ""
46198
46199 #. type: table
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."
46202 msgstr ""
46203
46204 #. type: deftp
46205 #: guix-git/doc/guix.texi:25895
46206 #, no-wrap
46207 msgid "{Data Type} zone-entry"
46208 msgstr ""
46209
46210 #. type: deftp
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:"
46213 msgstr ""
46214
46215 #. type: item
46216 #: guix-git/doc/guix.texi:25900
46217 #, no-wrap
46218 msgid "@code{name} (default: @code{\"@@\"})"
46219 msgstr ""
46220
46221 #. type: table
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}."
46224 msgstr ""
46225
46226 #. type: item
46227 #: guix-git/doc/guix.texi:25907
46228 #, no-wrap
46229 msgid "@code{ttl} (default: @code{\"\"})"
46230 msgstr ""
46231
46232 #. type: table
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."
46235 msgstr ""
46236
46237 #. type: item
46238 #: guix-git/doc/guix.texi:25910
46239 #, no-wrap
46240 msgid "@code{class} (default: @code{\"IN\"})"
46241 msgstr ""
46242
46243 #. type: table
46244 #: guix-git/doc/guix.texi:25913
46245 msgid "The class of the record. Knot currently supports only @code{\"IN\"} and partially @code{\"CH\"}."
46246 msgstr ""
46247
46248 #. type: item
46249 #: guix-git/doc/guix.texi:25914
46250 #, no-wrap
46251 msgid "@code{type} (default: @code{\"A\"})"
46252 msgstr ""
46253
46254 #. type: table
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."
46257 msgstr ""
46258
46259 #. type: item
46260 #: guix-git/doc/guix.texi:25919
46261 #, no-wrap
46262 msgid "@code{data} (default: @code{\"\"})"
46263 msgstr ""
46264
46265 #. type: table
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."
46268 msgstr ""
46269
46270 #. type: deftp
46271 #: guix-git/doc/guix.texi:25927
46272 #, no-wrap
46273 msgid "{Data Type} zone-file"
46274 msgstr ""
46275
46276 #. type: deftp
46277 #: guix-git/doc/guix.texi:25930
46278 msgid "Data type representing the content of a zone file. This type has the following parameters:"
46279 msgstr ""
46280
46281 #. type: table
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}."
46284 msgstr ""
46285
46286 #. type: item
46287 #: guix-git/doc/guix.texi:25940
46288 #, no-wrap
46289 msgid "@code{origin} (default: @code{\"\"})"
46290 msgstr ""
46291
46292 #. type: table
46293 #: guix-git/doc/guix.texi:25942
46294 msgid "The name of your zone. This parameter cannot be empty."
46295 msgstr ""
46296
46297 #. type: item
46298 #: guix-git/doc/guix.texi:25943
46299 #, no-wrap
46300 msgid "@code{ns} (default: @code{\"ns\"})"
46301 msgstr ""
46302
46303 #. type: table
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."
46306 msgstr ""
46307
46308 #. type: item
46309 #: guix-git/doc/guix.texi:25949
46310 #, no-wrap
46311 msgid "@code{mail} (default: @code{\"hostmaster\"})"
46312 msgstr ""
46313
46314 #. type: table
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>}."
46317 msgstr ""
46318
46319 #. type: item
46320 #: guix-git/doc/guix.texi:25953
46321 #, no-wrap
46322 msgid "@code{serial} (default: @code{1})"
46323 msgstr ""
46324
46325 #. type: table
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."
46328 msgstr ""
46329
46330 #. type: item
46331 #: guix-git/doc/guix.texi:25958
46332 #, no-wrap
46333 msgid "@code{refresh} (default: @code{(* 2 24 3600)})"
46334 msgstr ""
46335
46336 #. type: table
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)}."
46339 msgstr ""
46340
46341 #. type: item
46342 #: guix-git/doc/guix.texi:25963
46343 #, no-wrap
46344 msgid "@code{retry} (default: @code{(* 15 60)})"
46345 msgstr ""
46346
46347 #. type: table
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."
46350 msgstr ""
46351
46352 #. type: item
46353 #: guix-git/doc/guix.texi:25967
46354 #, no-wrap
46355 msgid "@code{expiry} (default: @code{(* 14 24 3600)})"
46356 msgstr ""
46357
46358 #. type: table
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."
46361 msgstr ""
46362
46363 #. type: item
46364 #: guix-git/doc/guix.texi:25972
46365 #, no-wrap
46366 msgid "@code{nx} (default: @code{3600})"
46367 msgstr ""
46368
46369 #. type: table
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."
46372 msgstr ""
46373
46374 #. type: deftp
46375 #: guix-git/doc/guix.texi:25979
46376 #, no-wrap
46377 msgid "{Data Type} knot-remote-configuration"
46378 msgstr ""
46379
46380 #. type: deftp
46381 #: guix-git/doc/guix.texi:25982
46382 msgid "Data type representing a remote configuration. This type has the following parameters:"
46383 msgstr ""
46384
46385 #. type: table
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."
46388 msgstr ""
46389
46390 #. type: table
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."
46393 msgstr ""
46394
46395 #. type: item
46396 #: guix-git/doc/guix.texi:25993
46397 #, no-wrap
46398 msgid "@code{via} (default: @code{'()})"
46399 msgstr ""
46400
46401 #. type: table
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."
46404 msgstr ""
46405
46406 #. type: table
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."
46409 msgstr ""
46410
46411 #. type: deftp
46412 #: guix-git/doc/guix.texi:26005
46413 #, no-wrap
46414 msgid "{Data Type} knot-keystore-configuration"
46415 msgstr ""
46416
46417 #. type: deftp
46418 #: guix-git/doc/guix.texi:26008
46419 msgid "Data type representing a keystore to hold dnssec keys. This type has the following parameters:"
46420 msgstr ""
46421
46422 #. type: table
46423 #: guix-git/doc/guix.texi:26012
46424 msgid "The id of the keystore. It must not be empty."
46425 msgstr ""
46426
46427 #. type: item
46428 #: guix-git/doc/guix.texi:26013
46429 #, no-wrap
46430 msgid "@code{backend} (default: @code{'pem})"
46431 msgstr ""
46432
46433 #. type: table
46434 #: guix-git/doc/guix.texi:26015
46435 msgid "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}."
46436 msgstr ""
46437
46438 #. type: item
46439 #: guix-git/doc/guix.texi:26016
46440 #, no-wrap
46441 msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})"
46442 msgstr ""
46443
46444 #. type: table
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."
46447 msgstr ""
46448
46449 #. type: deftp
46450 #: guix-git/doc/guix.texi:26024
46451 #, no-wrap
46452 msgid "{Data Type} knot-policy-configuration"
46453 msgstr ""
46454
46455 #. type: deftp
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."
46458 msgstr ""
46459
46460 #. type: deftp
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."
46463 msgstr ""
46464
46465 #. type: deftp
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."
46468 msgstr ""
46469
46470 #. type: deftp
46471 #: guix-git/doc/guix.texi:26043
46472 msgid "This type has the following parameters:"
46473 msgstr ""
46474
46475 #. type: table
46476 #: guix-git/doc/guix.texi:26047
46477 msgid "The id of the policy. It must not be empty."
46478 msgstr ""
46479
46480 #. type: item
46481 #: guix-git/doc/guix.texi:26048
46482 #, no-wrap
46483 msgid "@code{keystore} (default: @code{\"default\"})"
46484 msgstr ""
46485
46486 #. type: table
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)."
46489 msgstr ""
46490
46491 #. type: item
46492 #: guix-git/doc/guix.texi:26054
46493 #, no-wrap
46494 msgid "@code{manual?} (default: @code{#f})"
46495 msgstr ""
46496
46497 #. type: table
46498 #: guix-git/doc/guix.texi:26056
46499 msgid "Whether the key management is manual or automatic."
46500 msgstr ""
46501
46502 #. type: item
46503 #: guix-git/doc/guix.texi:26057
46504 #, no-wrap
46505 msgid "@code{single-type-signing?} (default: @code{#f})"
46506 msgstr ""
46507
46508 #. type: table
46509 #: guix-git/doc/guix.texi:26059
46510 msgid "When @code{#t}, use the Single-Type Signing Scheme."
46511 msgstr ""
46512
46513 #. type: item
46514 #: guix-git/doc/guix.texi:26060
46515 #, no-wrap
46516 msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})"
46517 msgstr ""
46518
46519 #. type: table
46520 #: guix-git/doc/guix.texi:26062
46521 msgid "An algorithm of signing keys and issued signatures."
46522 msgstr ""
46523
46524 #. type: item
46525 #: guix-git/doc/guix.texi:26063
46526 #, no-wrap
46527 msgid "@code{ksk-size} (default: @code{256})"
46528 msgstr ""
46529
46530 #. type: table
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."
46533 msgstr ""
46534
46535 #. type: item
46536 #: guix-git/doc/guix.texi:26067
46537 #, no-wrap
46538 msgid "@code{zsk-size} (default: @code{256})"
46539 msgstr ""
46540
46541 #. type: table
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."
46544 msgstr ""
46545
46546 #. type: item
46547 #: guix-git/doc/guix.texi:26071
46548 #, no-wrap
46549 msgid "@code{dnskey-ttl} (default: @code{'default})"
46550 msgstr ""
46551
46552 #. type: table
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."
46555 msgstr ""
46556
46557 #. type: item
46558 #: guix-git/doc/guix.texi:26075
46559 #, no-wrap
46560 msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})"
46561 msgstr ""
46562
46563 #. type: table
46564 #: guix-git/doc/guix.texi:26077
46565 msgid "The period between ZSK publication and the next rollover initiation."
46566 msgstr ""
46567
46568 #. type: item
46569 #: guix-git/doc/guix.texi:26078
46570 #, no-wrap
46571 msgid "@code{propagation-delay} (default: @code{(* 24 3600)})"
46572 msgstr ""
46573
46574 #. type: table
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."
46577 msgstr ""
46578
46579 #. type: item
46580 #: guix-git/doc/guix.texi:26082
46581 #, no-wrap
46582 msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})"
46583 msgstr ""
46584
46585 #. type: table
46586 #: guix-git/doc/guix.texi:26084
46587 msgid "A validity period of newly issued signatures."
46588 msgstr ""
46589
46590 #. type: item
46591 #: guix-git/doc/guix.texi:26085
46592 #, no-wrap
46593 msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})"
46594 msgstr ""
46595
46596 #. type: table
46597 #: guix-git/doc/guix.texi:26087
46598 msgid "A period how long before a signature expiration the signature will be refreshed."
46599 msgstr ""
46600
46601 #. type: item
46602 #: guix-git/doc/guix.texi:26088
46603 #, no-wrap
46604 msgid "@code{nsec3?} (default: @code{#f})"
46605 msgstr ""
46606
46607 #. type: table
46608 #: guix-git/doc/guix.texi:26090
46609 msgid "When @code{#t}, NSEC3 will be used instead of NSEC."
46610 msgstr ""
46611
46612 #. type: item
46613 #: guix-git/doc/guix.texi:26091
46614 #, no-wrap
46615 msgid "@code{nsec3-iterations} (default: @code{5})"
46616 msgstr ""
46617
46618 #. type: table
46619 #: guix-git/doc/guix.texi:26093
46620 msgid "The number of additional times the hashing is performed."
46621 msgstr ""
46622
46623 #. type: item
46624 #: guix-git/doc/guix.texi:26094
46625 #, no-wrap
46626 msgid "@code{nsec3-salt-length} (default: @code{8})"
46627 msgstr ""
46628
46629 #. type: table
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."
46632 msgstr ""
46633
46634 #. type: item
46635 #: guix-git/doc/guix.texi:26098
46636 #, no-wrap
46637 msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})"
46638 msgstr ""
46639
46640 #. type: table
46641 #: guix-git/doc/guix.texi:26100
46642 msgid "The validity period of newly issued salt field."
46643 msgstr ""
46644
46645 #. type: deftp
46646 #: guix-git/doc/guix.texi:26104
46647 #, no-wrap
46648 msgid "{Data Type} knot-zone-configuration"
46649 msgstr ""
46650
46651 #. type: deftp
46652 #: guix-git/doc/guix.texi:26107
46653 msgid "Data type representing a zone served by Knot. This type has the following parameters:"
46654 msgstr ""
46655
46656 #. type: item
46657 #: guix-git/doc/guix.texi:26109
46658 #, no-wrap
46659 msgid "@code{domain} (default: @code{\"\"})"
46660 msgstr ""
46661
46662 #. type: table
46663 #: guix-git/doc/guix.texi:26111
46664 msgid "The domain served by this configuration. It must not be empty."
46665 msgstr ""
46666
46667 #. type: item
46668 #: guix-git/doc/guix.texi:26112
46669 #, no-wrap
46670 msgid "@code{file} (default: @code{\"\"})"
46671 msgstr ""
46672
46673 #. type: table
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."
46676 msgstr ""
46677
46678 #. type: item
46679 #: guix-git/doc/guix.texi:26116
46680 #, no-wrap
46681 msgid "@code{zone} (default: @code{(zone-file)})"
46682 msgstr ""
46683
46684 #. type: table
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."
46687 msgstr ""
46688
46689 #. type: item
46690 #: guix-git/doc/guix.texi:26120
46691 #, no-wrap
46692 msgid "@code{master} (default: @code{'()})"
46693 msgstr ""
46694
46695 #. type: table
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."
46698 msgstr ""
46699
46700 #. type: item
46701 #: guix-git/doc/guix.texi:26124
46702 #, no-wrap
46703 msgid "@code{ddns-master} (default: @code{#f})"
46704 msgstr ""
46705
46706 #. type: table
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."
46709 msgstr ""
46710
46711 #. type: item
46712 #: guix-git/doc/guix.texi:26128
46713 #, no-wrap
46714 msgid "@code{notify} (default: @code{'()})"
46715 msgstr ""
46716
46717 #. type: table
46718 #: guix-git/doc/guix.texi:26130
46719 msgid "A list of slave remote identifiers."
46720 msgstr ""
46721
46722 #. type: item
46723 #: guix-git/doc/guix.texi:26131
46724 #, no-wrap
46725 msgid "@code{acl} (default: @code{'()})"
46726 msgstr ""
46727
46728 #. type: table
46729 #: guix-git/doc/guix.texi:26133
46730 msgid "A list of acl identifiers."
46731 msgstr ""
46732
46733 #. type: item
46734 #: guix-git/doc/guix.texi:26134
46735 #, no-wrap
46736 msgid "@code{semantic-checks?} (default: @code{#f})"
46737 msgstr ""
46738
46739 #. type: table
46740 #: guix-git/doc/guix.texi:26136
46741 msgid "When set, this adds more semantic checks to the zone."
46742 msgstr ""
46743
46744 #. type: item
46745 #: guix-git/doc/guix.texi:26137
46746 #, no-wrap
46747 msgid "@code{disable-any?} (default: @code{#f})"
46748 msgstr ""
46749
46750 #. type: table
46751 #: guix-git/doc/guix.texi:26139
46752 msgid "When set, this forbids queries of the ANY type."
46753 msgstr ""
46754
46755 #. type: item
46756 #: guix-git/doc/guix.texi:26140
46757 #, no-wrap
46758 msgid "@code{zonefile-sync} (default: @code{0})"
46759 msgstr ""
46760
46761 #. type: table
46762 #: guix-git/doc/guix.texi:26143
46763 msgid "The delay between a modification in memory and on disk. 0 means immediate synchronization."
46764 msgstr ""
46765
46766 #. type: item
46767 #: guix-git/doc/guix.texi:26144
46768 #, no-wrap
46769 msgid "@code{zonefile-load} (default: @code{#f})"
46770 msgstr ""
46771
46772 #. type: table
46773 #: guix-git/doc/guix.texi:26147
46774 msgid "The way the zone file contents are applied during zone load. Possible values are:"
46775 msgstr ""
46776
46777 #. type: item
46778 #: guix-git/doc/guix.texi:26149
46779 #, no-wrap
46780 msgid "@code{#f} for using the default value from Knot,"
46781 msgstr ""
46782
46783 #. type: item
46784 #: guix-git/doc/guix.texi:26150
46785 #, no-wrap
46786 msgid "@code{'none} for not using the zone file at all,"
46787 msgstr ""
46788
46789 #. type: item
46790 #: guix-git/doc/guix.texi:26151
46791 #, no-wrap
46792 msgid "@code{'difference} for computing the difference between already available"
46793 msgstr ""
46794
46795 #. type: itemize
46796 #: guix-git/doc/guix.texi:26153
46797 msgid "contents and zone contents and applying it to the current zone contents,"
46798 msgstr ""
46799
46800 #. type: item
46801 #: guix-git/doc/guix.texi:26153
46802 #, no-wrap
46803 msgid "@code{'difference-no-serial} for the same as @code{'difference}, but"
46804 msgstr ""
46805
46806 #. type: itemize
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."
46809 msgstr ""
46810
46811 #. type: item
46812 #: guix-git/doc/guix.texi:26156
46813 #, no-wrap
46814 msgid "@code{'whole} for loading zone contents from the zone file."
46815 msgstr ""
46816
46817 #. type: item
46818 #: guix-git/doc/guix.texi:26159
46819 #, no-wrap
46820 msgid "@code{journal-content} (default: @code{#f})"
46821 msgstr ""
46822
46823 #. type: table
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."
46826 msgstr ""
46827
46828 #. type: item
46829 #: guix-git/doc/guix.texi:26165
46830 #, no-wrap
46831 msgid "@code{max-journal-usage} (default: @code{#f})"
46832 msgstr ""
46833
46834 #. type: table
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."
46837 msgstr ""
46838
46839 #. type: item
46840 #: guix-git/doc/guix.texi:26169
46841 #, no-wrap
46842 msgid "@code{max-journal-depth} (default: @code{#f})"
46843 msgstr ""
46844
46845 #. type: table
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."
46848 msgstr ""
46849
46850 #. type: item
46851 #: guix-git/doc/guix.texi:26173
46852 #, no-wrap
46853 msgid "@code{max-zone-size} (default: @code{#f})"
46854 msgstr ""
46855
46856 #. type: table
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."
46859 msgstr ""
46860
46861 #. type: item
46862 #: guix-git/doc/guix.texi:26178
46863 #, no-wrap
46864 msgid "@code{dnssec-policy} (default: @code{#f})"
46865 msgstr ""
46866
46867 #. type: table
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."
46870 msgstr ""
46871
46872 #. type: item
46873 #: guix-git/doc/guix.texi:26183
46874 #, no-wrap
46875 msgid "@code{serial-policy} (default: @code{'increment})"
46876 msgstr ""
46877
46878 #. type: table
46879 #: guix-git/doc/guix.texi:26185
46880 msgid "A policy between @code{'increment} and @code{'unixtime}."
46881 msgstr ""
46882
46883 #. type: deftp
46884 #: guix-git/doc/guix.texi:26189
46885 #, no-wrap
46886 msgid "{Data Type} knot-configuration"
46887 msgstr ""
46888
46889 #. type: deftp
46890 #: guix-git/doc/guix.texi:26192
46891 msgid "Data type representing the Knot configuration. This type has the following parameters:"
46892 msgstr ""
46893
46894 #. type: item
46895 #: guix-git/doc/guix.texi:26194
46896 #, no-wrap
46897 msgid "@code{knot} (default: @code{knot})"
46898 msgstr ""
46899
46900 #. type: table
46901 #: guix-git/doc/guix.texi:26196
46902 msgid "The Knot package."
46903 msgstr ""
46904
46905 #. type: item
46906 #: guix-git/doc/guix.texi:26197
46907 #, no-wrap
46908 msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})"
46909 msgstr ""
46910
46911 #. type: table
46912 #: guix-git/doc/guix.texi:26199
46913 msgid "The run directory. This directory will be used for pid file and sockets."
46914 msgstr ""
46915
46916 #. type: item
46917 #: guix-git/doc/guix.texi:26200
46918 #, no-wrap
46919 msgid "@code{includes} (default: @code{'()})"
46920 msgstr ""
46921
46922 #. type: table
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."
46925 msgstr ""
46926
46927 #. type: cindex
46928 #: guix-git/doc/guix.texi:26204
46929 #, no-wrap
46930 msgid "secrets, Knot service"
46931 msgstr ""
46932
46933 #. type: table
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."
46936 msgstr ""
46937
46938 #. type: table
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:"
46941 msgstr ""
46942
46943 #. type: example
46944 #: guix-git/doc/guix.texi:26219
46945 #, no-wrap
46946 msgid ""
46947 "keymgr -t mysecret > /etc/knot/secrets.conf\n"
46948 "chmod 600 /etc/knot/secrets.conf\n"
46949 msgstr ""
46950
46951 #. type: table
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."
46954 msgstr ""
46955
46956 #. type: table
46957 #: guix-git/doc/guix.texi:26227
46958 msgid "It can also be used to add configuration not supported by this interface."
46959 msgstr ""
46960
46961 #. type: item
46962 #: guix-git/doc/guix.texi:26228
46963 #, no-wrap
46964 msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})"
46965 msgstr ""
46966
46967 #. type: table
46968 #: guix-git/doc/guix.texi:26230 guix-git/doc/guix.texi:26233
46969 msgid "An ip address on which to listen."
46970 msgstr ""
46971
46972 #. type: item
46973 #: guix-git/doc/guix.texi:26231
46974 #, no-wrap
46975 msgid "@code{listen-v6} (default: @code{\"::\"})"
46976 msgstr ""
46977
46978 #. type: item
46979 #: guix-git/doc/guix.texi:26234
46980 #, no-wrap
46981 msgid "@code{listen-port} (default: @code{53})"
46982 msgstr ""
46983
46984 #. type: table
46985 #: guix-git/doc/guix.texi:26236
46986 msgid "A port on which to listen."
46987 msgstr ""
46988
46989 #. type: item
46990 #: guix-git/doc/guix.texi:26237
46991 #, no-wrap
46992 msgid "@code{keys} (default: @code{'()})"
46993 msgstr ""
46994
46995 #. type: table
46996 #: guix-git/doc/guix.texi:26239
46997 msgid "The list of knot-key-configuration used by this configuration."
46998 msgstr ""
46999
47000 #. type: item
47001 #: guix-git/doc/guix.texi:26240
47002 #, no-wrap
47003 msgid "@code{acls} (default: @code{'()})"
47004 msgstr ""
47005
47006 #. type: table
47007 #: guix-git/doc/guix.texi:26242
47008 msgid "The list of knot-acl-configuration used by this configuration."
47009 msgstr ""
47010
47011 #. type: item
47012 #: guix-git/doc/guix.texi:26243
47013 #, no-wrap
47014 msgid "@code{remotes} (default: @code{'()})"
47015 msgstr ""
47016
47017 #. type: table
47018 #: guix-git/doc/guix.texi:26245
47019 msgid "The list of knot-remote-configuration used by this configuration."
47020 msgstr ""
47021
47022 #. type: item
47023 #: guix-git/doc/guix.texi:26246
47024 #, no-wrap
47025 msgid "@code{zones} (default: @code{'()})"
47026 msgstr ""
47027
47028 #. type: table
47029 #: guix-git/doc/guix.texi:26248
47030 msgid "The list of knot-zone-configuration used by this configuration."
47031 msgstr ""
47032
47033 #. type: subsubheading
47034 #: guix-git/doc/guix.texi:26252
47035 #, no-wrap
47036 msgid "Knot Resolver Service"
47037 msgstr ""
47038
47039 #. type: deffn
47040 #: guix-git/doc/guix.texi:26254
47041 #, no-wrap
47042 msgid "{Scheme Variable} knot-resolver-service-type"
47043 msgstr ""
47044
47045 #. type: deffn
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:"
47048 msgstr ""
47049
47050 #. type: lisp
47051 #: guix-git/doc/guix.texi:26267
47052 #, no-wrap
47053 msgid ""
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"
47061 "\"))))\n"
47062 msgstr ""
47063
47064 #. type: deffn
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}."
47067 msgstr ""
47068
47069 #. type: deftp
47070 #: guix-git/doc/guix.texi:26272
47071 #, no-wrap
47072 msgid "{Data Type} knot-resolver-configuration"
47073 msgstr ""
47074
47075 #. type: deftp
47076 #: guix-git/doc/guix.texi:26274
47077 msgid "Data type representing the configuration of knot-resolver."
47078 msgstr ""
47079
47080 #. type: item
47081 #: guix-git/doc/guix.texi:26276
47082 #, no-wrap
47083 msgid "@code{package} (default: @var{knot-resolver})"
47084 msgstr ""
47085
47086 #. type: table
47087 #: guix-git/doc/guix.texi:26278
47088 msgid "Package object of the knot DNS resolver."
47089 msgstr ""
47090
47091 #. type: item
47092 #: guix-git/doc/guix.texi:26279
47093 #, no-wrap
47094 msgid "@code{kresd-config-file} (default: %kresd.conf)"
47095 msgstr ""
47096
47097 #. type: table
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}."
47100 msgstr ""
47101
47102 #. type: item
47103 #: guix-git/doc/guix.texi:26283
47104 #, no-wrap
47105 msgid "@code{garbage-collection-interval} (default: 1000)"
47106 msgstr ""
47107
47108 #. type: table
47109 #: guix-git/doc/guix.texi:26285
47110 msgid "Number of milliseconds for @code{kres-cache-gc} to periodically trim the cache."
47111 msgstr ""
47112
47113 #. type: subsubheading
47114 #: guix-git/doc/guix.texi:26290
47115 #, no-wrap
47116 msgid "Dnsmasq Service"
47117 msgstr ""
47118
47119 #. type: deffn
47120 #: guix-git/doc/guix.texi:26292
47121 #, no-wrap
47122 msgid "{Scheme Variable} dnsmasq-service-type"
47123 msgstr ""
47124
47125 #. type: deffn
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:"
47128 msgstr ""
47129
47130 #. type: lisp
47131 #: guix-git/doc/guix.texi:26301
47132 #, no-wrap
47133 msgid ""
47134 "(service dnsmasq-service-type\n"
47135 " (dnsmasq-configuration\n"
47136 " (no-resolv? #t)\n"
47137 " (servers '(\"192.168.1.1\"))))\n"
47138 msgstr ""
47139
47140 #. type: deftp
47141 #: guix-git/doc/guix.texi:26304
47142 #, no-wrap
47143 msgid "{Data Type} dnsmasq-configuration"
47144 msgstr ""
47145
47146 #. type: deftp
47147 #: guix-git/doc/guix.texi:26306
47148 msgid "Data type representing the configuration of dnsmasq."
47149 msgstr ""
47150
47151 #. type: item
47152 #: guix-git/doc/guix.texi:26308
47153 #, no-wrap
47154 msgid "@code{package} (default: @var{dnsmasq})"
47155 msgstr ""
47156
47157 #. type: table
47158 #: guix-git/doc/guix.texi:26310
47159 msgid "Package object of the dnsmasq server."
47160 msgstr ""
47161
47162 #. type: item
47163 #: guix-git/doc/guix.texi:26311
47164 #, no-wrap
47165 msgid "@code{no-hosts?} (default: @code{#f})"
47166 msgstr ""
47167
47168 #. type: table
47169 #: guix-git/doc/guix.texi:26313
47170 msgid "When true, don't read the hostnames in /etc/hosts."
47171 msgstr ""
47172
47173 #. type: item
47174 #: guix-git/doc/guix.texi:26314
47175 #, no-wrap
47176 msgid "@code{port} (default: @code{53})"
47177 msgstr ""
47178
47179 #. type: table
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."
47182 msgstr ""
47183
47184 #. type: item
47185 #: guix-git/doc/guix.texi:26318
47186 #, no-wrap
47187 msgid "@code{local-service?} (default: @code{#t})"
47188 msgstr ""
47189
47190 #. type: table
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."
47193 msgstr ""
47194
47195 #. type: item
47196 #: guix-git/doc/guix.texi:26322
47197 #, no-wrap
47198 msgid "@code{listen-addresses} (default: @code{'()})"
47199 msgstr ""
47200
47201 #. type: table
47202 #: guix-git/doc/guix.texi:26324
47203 msgid "Listen on the given IP addresses."
47204 msgstr ""
47205
47206 #. type: item
47207 #: guix-git/doc/guix.texi:26325
47208 #, no-wrap
47209 msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})"
47210 msgstr ""
47211
47212 #. type: table
47213 #: guix-git/doc/guix.texi:26327
47214 msgid "The file to read the IP address of the upstream nameservers from."
47215 msgstr ""
47216
47217 #. type: item
47218 #: guix-git/doc/guix.texi:26328
47219 #, no-wrap
47220 msgid "@code{no-resolv?} (default: @code{#f})"
47221 msgstr ""
47222
47223 #. type: table
47224 #: guix-git/doc/guix.texi:26330
47225 msgid "When true, don't read @var{resolv-file}."
47226 msgstr ""
47227
47228 #. type: item
47229 #: guix-git/doc/guix.texi:26331
47230 #, no-wrap
47231 msgid "@code{servers} (default: @code{'()})"
47232 msgstr ""
47233
47234 #. type: table
47235 #: guix-git/doc/guix.texi:26333
47236 msgid "Specify IP address of upstream servers directly."
47237 msgstr ""
47238
47239 #. type: item
47240 #: guix-git/doc/guix.texi:26334
47241 #, no-wrap
47242 msgid "@code{addresses} (default: @code{'()})"
47243 msgstr ""
47244
47245 #. type: table
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."
47248 msgstr ""
47249
47250 #. type: table
47251 #: guix-git/doc/guix.texi:26340
47252 msgid "This is useful for redirecting hosts locally, for example:"
47253 msgstr ""
47254
47255 #. type: lisp
47256 #: guix-git/doc/guix.texi:26349
47257 #, no-wrap
47258 msgid ""
47259 "(service dnsmasq-service-type\n"
47260 " (dnsmasq-configuration\n"
47261 " (addresses\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"
47266 msgstr ""
47267
47268 #. type: table
47269 #: guix-git/doc/guix.texi:26352
47270 msgid "Note that rules in @file{/etc/hosts} take precedence over this."
47271 msgstr ""
47272
47273 #. type: item
47274 #: guix-git/doc/guix.texi:26353
47275 #, no-wrap
47276 msgid "@code{cache-size} (default: @code{150})"
47277 msgstr ""
47278
47279 #. type: table
47280 #: guix-git/doc/guix.texi:26356
47281 msgid "Set the size of dnsmasq's cache. Setting the cache size to zero disables caching."
47282 msgstr ""
47283
47284 #. type: item
47285 #: guix-git/doc/guix.texi:26357
47286 #, no-wrap
47287 msgid "@code{negative-cache?} (default: @code{#t})"
47288 msgstr ""
47289
47290 #. type: table
47291 #: guix-git/doc/guix.texi:26359
47292 msgid "When false, disable negative caching."
47293 msgstr ""
47294
47295 #. type: item
47296 #: guix-git/doc/guix.texi:26360
47297 #, no-wrap
47298 msgid "@code{tftp-enable?} (default: @code{#f})"
47299 msgstr ""
47300
47301 #. type: table
47302 #: guix-git/doc/guix.texi:26362
47303 msgid "Whether to enable the built-in TFTP server."
47304 msgstr ""
47305
47306 #. type: item
47307 #: guix-git/doc/guix.texi:26363
47308 #, no-wrap
47309 msgid "@code{tftp-no-fail?} (default: @code{#f})"
47310 msgstr ""
47311
47312 #. type: table
47313 #: guix-git/doc/guix.texi:26365
47314 msgid "If true, does not fail dnsmasq if the TFTP server could not start up."
47315 msgstr ""
47316
47317 #. type: item
47318 #: guix-git/doc/guix.texi:26366
47319 #, no-wrap
47320 msgid "@code{tftp-single-port?} (default: @code{#f})"
47321 msgstr ""
47322
47323 #. type: table
47324 #: guix-git/doc/guix.texi:26368
47325 msgid "Whether to use only one single port for TFTP."
47326 msgstr ""
47327
47328 #. type: item
47329 #: guix-git/doc/guix.texi:26369
47330 #, no-wrap
47331 msgid "@code{tftp-secure?} (default: @code{#f})"
47332 msgstr ""
47333
47334 #. type: table
47335 #: guix-git/doc/guix.texi:26371
47336 msgid "If true, only files owned by the user running the dnsmasq process are accessible."
47337 msgstr ""
47338
47339 #. type: table
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."
47342 msgstr ""
47343
47344 #. type: item
47345 #: guix-git/doc/guix.texi:26376
47346 #, no-wrap
47347 msgid "@code{tftp-max} (default: @code{#f})"
47348 msgstr ""
47349
47350 #. type: table
47351 #: guix-git/doc/guix.texi:26378
47352 msgid "If set, sets the maximal number of concurrent connections allowed."
47353 msgstr ""
47354
47355 #. type: item
47356 #: guix-git/doc/guix.texi:26379
47357 #, no-wrap
47358 msgid "@code{tftp-mtu} (default: @code{#f})"
47359 msgstr ""
47360
47361 #. type: table
47362 #: guix-git/doc/guix.texi:26381
47363 msgid "If set, sets the MTU for TFTP packets to that value."
47364 msgstr ""
47365
47366 #. type: item
47367 #: guix-git/doc/guix.texi:26382
47368 #, no-wrap
47369 msgid "@code{tftp-no-blocksize?} (default: @code{#f})"
47370 msgstr ""
47371
47372 #. type: table
47373 #: guix-git/doc/guix.texi:26384
47374 msgid "If true, stops the TFTP server from negotiating the blocksize with a client."
47375 msgstr ""
47376
47377 #. type: item
47378 #: guix-git/doc/guix.texi:26385
47379 #, no-wrap
47380 msgid "@code{tftp-lowercase?} (default: @code{#f})"
47381 msgstr ""
47382
47383 #. type: table
47384 #: guix-git/doc/guix.texi:26387
47385 msgid "Whether to convert all filenames in TFTP requests to lowercase."
47386 msgstr ""
47387
47388 #. type: item
47389 #: guix-git/doc/guix.texi:26388
47390 #, no-wrap
47391 msgid "@code{tftp-port-range} (default: @code{#f})"
47392 msgstr ""
47393
47394 #. type: table
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>\"})."
47397 msgstr ""
47398
47399 #. type: item
47400 #: guix-git/doc/guix.texi:26392
47401 #, no-wrap
47402 msgid "@code{tftp-root} (default: @code{/var/empty,lo})"
47403 msgstr ""
47404
47405 #. type: table
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."
47408 msgstr ""
47409
47410 #. type: item
47411 #: guix-git/doc/guix.texi:26400
47412 #, no-wrap
47413 msgid "@code{tftp-unique-root} (default: @code{#f})"
47414 msgstr ""
47415
47416 #. type: table
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)."
47419 msgstr ""
47420
47421 #. type: table
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."
47424 msgstr ""
47425
47426 #. type: subsubheading
47427 #: guix-git/doc/guix.texi:26418
47428 #, no-wrap
47429 msgid "ddclient Service"
47430 msgstr ""
47431
47432 #. type: cindex
47433 #: guix-git/doc/guix.texi:26420
47434 #, no-wrap
47435 msgid "ddclient"
47436 msgstr ""
47437
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}."
47441 msgstr ""
47442
47443 #. type: Plain text
47444 #: guix-git/doc/guix.texi:26427
47445 msgid "The following example show instantiates the service with its default configuration:"
47446 msgstr ""
47447
47448 #. type: lisp
47449 #: guix-git/doc/guix.texi:26430
47450 #, no-wrap
47451 msgid "(service ddclient-service-type)\n"
47452 msgstr ""
47453
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."
47457 msgstr ""
47458
47459 #. type: Plain text
47460 #: guix-git/doc/guix.texi:26443
47461 msgid "Available @code{ddclient-configuration} fields are:"
47462 msgstr ""
47463
47464 #. type: deftypevr
47465 #: guix-git/doc/guix.texi:26444
47466 #, no-wrap
47467 msgid "{@code{ddclient-configuration} parameter} package ddclient"
47468 msgstr ""
47469
47470 #. type: deftypevr
47471 #: guix-git/doc/guix.texi:26446
47472 msgid "The ddclient package."
47473 msgstr ""
47474
47475 #. type: deftypevr
47476 #: guix-git/doc/guix.texi:26449
47477 #, no-wrap
47478 msgid "{@code{ddclient-configuration} parameter} integer daemon"
47479 msgstr ""
47480
47481 #. type: deftypevr
47482 #: guix-git/doc/guix.texi:26451
47483 msgid "The period after which ddclient will retry to check IP and domain name."
47484 msgstr ""
47485
47486 #. type: deftypevr
47487 #: guix-git/doc/guix.texi:26456
47488 #, no-wrap
47489 msgid "{@code{ddclient-configuration} parameter} boolean syslog"
47490 msgstr ""
47491
47492 #. type: deftypevr
47493 #: guix-git/doc/guix.texi:26458
47494 msgid "Use syslog for the output."
47495 msgstr ""
47496
47497 #. type: deftypevr
47498 #: guix-git/doc/guix.texi:26463
47499 #, no-wrap
47500 msgid "{@code{ddclient-configuration} parameter} string mail"
47501 msgstr ""
47502
47503 #. type: deftypevr
47504 #: guix-git/doc/guix.texi:26465
47505 msgid "Mail to user."
47506 msgstr ""
47507
47508 #. type: deftypevr
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\"}."
47512 msgstr ""
47513
47514 #. type: deftypevr
47515 #: guix-git/doc/guix.texi:26470
47516 #, no-wrap
47517 msgid "{@code{ddclient-configuration} parameter} string mail-failure"
47518 msgstr ""
47519
47520 #. type: deftypevr
47521 #: guix-git/doc/guix.texi:26472
47522 msgid "Mail failed update to user."
47523 msgstr ""
47524
47525 #. type: deftypevr
47526 #: guix-git/doc/guix.texi:26477
47527 #, no-wrap
47528 msgid "{@code{ddclient-configuration} parameter} string pid"
47529 msgstr ""
47530
47531 #. type: deftypevr
47532 #: guix-git/doc/guix.texi:26479
47533 msgid "The ddclient PID file."
47534 msgstr ""
47535
47536 #. type: deftypevr
47537 #: guix-git/doc/guix.texi:26481
47538 msgid "Defaults to @samp{\"/var/run/ddclient/ddclient.pid\"}."
47539 msgstr ""
47540
47541 #. type: deftypevr
47542 #: guix-git/doc/guix.texi:26484
47543 #, no-wrap
47544 msgid "{@code{ddclient-configuration} parameter} boolean ssl"
47545 msgstr ""
47546
47547 #. type: deftypevr
47548 #: guix-git/doc/guix.texi:26486
47549 msgid "Enable SSL support."
47550 msgstr ""
47551
47552 #. type: deftypevr
47553 #: guix-git/doc/guix.texi:26491
47554 #, no-wrap
47555 msgid "{@code{ddclient-configuration} parameter} string user"
47556 msgstr ""
47557
47558 #. type: deftypevr
47559 #: guix-git/doc/guix.texi:26494
47560 msgid "Specifies the user name or ID that is used when running ddclient program."
47561 msgstr ""
47562
47563 #. type: deftypevr
47564 #: guix-git/doc/guix.texi:26496 guix-git/doc/guix.texi:26503
47565 msgid "Defaults to @samp{\"ddclient\"}."
47566 msgstr ""
47567
47568 #. type: deftypevr
47569 #: guix-git/doc/guix.texi:26499
47570 #, no-wrap
47571 msgid "{@code{ddclient-configuration} parameter} string group"
47572 msgstr ""
47573
47574 #. type: deftypevr
47575 #: guix-git/doc/guix.texi:26501
47576 msgid "Group of the user who will run the ddclient program."
47577 msgstr ""
47578
47579 #. type: deftypevr
47580 #: guix-git/doc/guix.texi:26506
47581 #, no-wrap
47582 msgid "{@code{ddclient-configuration} parameter} string secret-file"
47583 msgstr ""
47584
47585 #. type: deftypevr
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."
47588 msgstr ""
47589
47590 #. type: deftypevr
47591 #: guix-git/doc/guix.texi:26512
47592 msgid "Defaults to @samp{\"/etc/ddclient/secrets.conf\"}."
47593 msgstr ""
47594
47595 #. type: deftypevr
47596 #: guix-git/doc/guix.texi:26515
47597 #, no-wrap
47598 msgid "{@code{ddclient-configuration} parameter} list extra-options"
47599 msgstr ""
47600
47601 #. type: deftypevr
47602 #: guix-git/doc/guix.texi:26517
47603 msgid "Extra options will be appended to @file{ddclient.conf} file."
47604 msgstr ""
47605
47606 #. type: cindex
47607 #: guix-git/doc/guix.texi:26528
47608 #, no-wrap
47609 msgid "VPN (virtual private network)"
47610 msgstr ""
47611
47612 #. type: cindex
47613 #: guix-git/doc/guix.texi:26529
47614 #, no-wrap
47615 msgid "virtual private network (VPN)"
47616 msgstr ""
47617
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)."
47621 msgstr ""
47622
47623 #. type: subsubheading
47624 #: guix-git/doc/guix.texi:26534
47625 #, no-wrap
47626 msgid "OpenVPN"
47627 msgstr ""
47628
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@."
47632 msgstr ""
47633
47634 #. type: deffn
47635 #: guix-git/doc/guix.texi:26539
47636 #, no-wrap
47637 msgid "{Scheme Procedure} openvpn-client-service @"
47638 msgstr ""
47639
47640 #. type: deffn
47641 #: guix-git/doc/guix.texi:26541
47642 msgid "[#:config (openvpn-client-configuration)]"
47643 msgstr ""
47644
47645 #. type: deffn
47646 #: guix-git/doc/guix.texi:26543
47647 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a client."
47648 msgstr ""
47649
47650 #. type: deffn
47651 #: guix-git/doc/guix.texi:26545
47652 #, no-wrap
47653 msgid "{Scheme Procedure} openvpn-server-service @"
47654 msgstr ""
47655
47656 #. type: deffn
47657 #: guix-git/doc/guix.texi:26547
47658 msgid "[#:config (openvpn-server-configuration)]"
47659 msgstr ""
47660
47661 #. type: deffn
47662 #: guix-git/doc/guix.texi:26549
47663 msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a server."
47664 msgstr ""
47665
47666 #. type: deffn
47667 #: guix-git/doc/guix.texi:26551
47668 msgid "Both can be run simultaneously."
47669 msgstr ""
47670
47671 #. type: Plain text
47672 #: guix-git/doc/guix.texi:26556
47673 msgid "Available @code{openvpn-client-configuration} fields are:"
47674 msgstr ""
47675
47676 #. type: deftypevr
47677 #: guix-git/doc/guix.texi:26557
47678 #, no-wrap
47679 msgid "{@code{openvpn-client-configuration} parameter} package openvpn"
47680 msgstr ""
47681
47682 #. type: deftypevr
47683 #: guix-git/doc/guix.texi:26559 guix-git/doc/guix.texi:26714
47684 msgid "The OpenVPN package."
47685 msgstr ""
47686
47687 #. type: deftypevr
47688 #: guix-git/doc/guix.texi:26562
47689 #, no-wrap
47690 msgid "{@code{openvpn-client-configuration} parameter} string pid-file"
47691 msgstr ""
47692
47693 #. type: deftypevr
47694 #: guix-git/doc/guix.texi:26564 guix-git/doc/guix.texi:26719
47695 msgid "The OpenVPN pid file."
47696 msgstr ""
47697
47698 #. type: deftypevr
47699 #: guix-git/doc/guix.texi:26566 guix-git/doc/guix.texi:26721
47700 msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}."
47701 msgstr ""
47702
47703 #. type: deftypevr
47704 #: guix-git/doc/guix.texi:26569
47705 #, no-wrap
47706 msgid "{@code{openvpn-client-configuration} parameter} proto proto"
47707 msgstr ""
47708
47709 #. type: deftypevr
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."
47712 msgstr ""
47713
47714 #. type: deftypevr
47715 #: guix-git/doc/guix.texi:26574 guix-git/doc/guix.texi:26729
47716 msgid "Defaults to @samp{udp}."
47717 msgstr ""
47718
47719 #. type: deftypevr
47720 #: guix-git/doc/guix.texi:26577
47721 #, no-wrap
47722 msgid "{@code{openvpn-client-configuration} parameter} dev dev"
47723 msgstr ""
47724
47725 #. type: deftypevr
47726 #: guix-git/doc/guix.texi:26579 guix-git/doc/guix.texi:26734
47727 msgid "The device type used to represent the VPN connection."
47728 msgstr ""
47729
47730 #. type: deftypevr
47731 #: guix-git/doc/guix.texi:26581 guix-git/doc/guix.texi:26736
47732 msgid "Defaults to @samp{tun}."
47733 msgstr ""
47734
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}."
47738 msgstr ""
47739
47740 #. type: deftypevr
47741 #: guix-git/doc/guix.texi:26588
47742 #, no-wrap
47743 msgid "{@code{openvpn-client-configuration} parameter} maybe-string ca"
47744 msgstr ""
47745
47746 #. type: deftypevr
47747 #: guix-git/doc/guix.texi:26590 guix-git/doc/guix.texi:26745
47748 msgid "The certificate authority to check connections against."
47749 msgstr ""
47750
47751 #. type: deftypevr
47752 #: guix-git/doc/guix.texi:26592 guix-git/doc/guix.texi:26747
47753 msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}."
47754 msgstr ""
47755
47756 #. type: deftypevr
47757 #: guix-git/doc/guix.texi:26595
47758 #, no-wrap
47759 msgid "{@code{openvpn-client-configuration} parameter} maybe-string cert"
47760 msgstr ""
47761
47762 #. type: deftypevr
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}."
47765 msgstr ""
47766
47767 #. type: deftypevr
47768 #: guix-git/doc/guix.texi:26600 guix-git/doc/guix.texi:26755
47769 msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}."
47770 msgstr ""
47771
47772 #. type: deftypevr
47773 #: guix-git/doc/guix.texi:26603
47774 #, no-wrap
47775 msgid "{@code{openvpn-client-configuration} parameter} maybe-string key"
47776 msgstr ""
47777
47778 #. type: deftypevr
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}."
47781 msgstr ""
47782
47783 #. type: deftypevr
47784 #: guix-git/doc/guix.texi:26608 guix-git/doc/guix.texi:26763
47785 msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}."
47786 msgstr ""
47787
47788 #. type: deftypevr
47789 #: guix-git/doc/guix.texi:26611
47790 #, no-wrap
47791 msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?"
47792 msgstr ""
47793
47794 #. type: deftypevr
47795 #: guix-git/doc/guix.texi:26613 guix-git/doc/guix.texi:26768
47796 msgid "Whether to use the lzo compression algorithm."
47797 msgstr ""
47798
47799 #. type: deftypevr
47800 #: guix-git/doc/guix.texi:26618
47801 #, no-wrap
47802 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?"
47803 msgstr ""
47804
47805 #. type: deftypevr
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."
47808 msgstr ""
47809
47810 #. type: deftypevr
47811 #: guix-git/doc/guix.texi:26625
47812 #, no-wrap
47813 msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?"
47814 msgstr ""
47815
47816 #. type: deftypevr
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."
47819 msgstr ""
47820
47821 #. type: deftypevr
47822 #: guix-git/doc/guix.texi:26633
47823 #, no-wrap
47824 msgid "{@code{openvpn-client-configuration} parameter} boolean fast-io?"
47825 msgstr ""
47826
47827 #. type: deftypevr
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."
47830 msgstr ""
47831
47832 #. type: deftypevr
47833 #: guix-git/doc/guix.texi:26640
47834 #, no-wrap
47835 msgid "{@code{openvpn-client-configuration} parameter} number verbosity"
47836 msgstr ""
47837
47838 #. type: deftypevr
47839 #: guix-git/doc/guix.texi:26642 guix-git/doc/guix.texi:26797
47840 msgid "Verbosity level."
47841 msgstr ""
47842
47843 #. type: deftypevr
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}."
47847 msgstr ""
47848
47849 #. type: deftypevr
47850 #: guix-git/doc/guix.texi:26647
47851 #, no-wrap
47852 msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth"
47853 msgstr ""
47854
47855 #. type: deftypevr
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."
47858 msgstr ""
47859
47860 #. type: deftypevr
47861 #: guix-git/doc/guix.texi:26655
47862 #, no-wrap
47863 msgid "{@code{openvpn-client-configuration} parameter} maybe-string auth-user-pass"
47864 msgstr ""
47865
47866 #. type: deftypevr
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."
47869 msgstr ""
47870
47871 #. type: deftypevr
47872 #: guix-git/doc/guix.texi:26661
47873 msgid "Defaults to @samp{'disabled}."
47874 msgstr ""
47875
47876 #. type: deftypevr
47877 #: guix-git/doc/guix.texi:26663
47878 #, no-wrap
47879 msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?"
47880 msgstr ""
47881
47882 #. type: deftypevr
47883 #: guix-git/doc/guix.texi:26665
47884 msgid "Whether to check the server certificate has server usage extension."
47885 msgstr ""
47886
47887 #. type: deftypevr
47888 #: guix-git/doc/guix.texi:26670
47889 #, no-wrap
47890 msgid "{@code{openvpn-client-configuration} parameter} bind bind?"
47891 msgstr ""
47892
47893 #. type: deftypevr
47894 #: guix-git/doc/guix.texi:26672
47895 msgid "Bind to a specific local port number."
47896 msgstr ""
47897
47898 #. type: deftypevr
47899 #: guix-git/doc/guix.texi:26677
47900 #, no-wrap
47901 msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?"
47902 msgstr ""
47903
47904 #. type: deftypevr
47905 #: guix-git/doc/guix.texi:26679
47906 msgid "Retry resolving server address."
47907 msgstr ""
47908
47909 #. type: deftypevr
47910 #: guix-git/doc/guix.texi:26684
47911 #, no-wrap
47912 msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote"
47913 msgstr ""
47914
47915 #. type: deftypevr
47916 #: guix-git/doc/guix.texi:26686
47917 msgid "A list of remote servers to connect to."
47918 msgstr ""
47919
47920 #. type: deftypevr
47921 #: guix-git/doc/guix.texi:26690
47922 msgid "Available @code{openvpn-remote-configuration} fields are:"
47923 msgstr ""
47924
47925 #. type: deftypevr
47926 #: guix-git/doc/guix.texi:26691
47927 #, no-wrap
47928 msgid "{@code{openvpn-remote-configuration} parameter} string name"
47929 msgstr ""
47930
47931 #. type: deftypevr
47932 #: guix-git/doc/guix.texi:26693
47933 msgid "Server name."
47934 msgstr ""
47935
47936 #. type: deftypevr
47937 #: guix-git/doc/guix.texi:26695
47938 msgid "Defaults to @samp{\"my-server\"}."
47939 msgstr ""
47940
47941 #. type: deftypevr
47942 #: guix-git/doc/guix.texi:26698
47943 #, no-wrap
47944 msgid "{@code{openvpn-remote-configuration} parameter} number port"
47945 msgstr ""
47946
47947 #. type: deftypevr
47948 #: guix-git/doc/guix.texi:26700
47949 msgid "Port number the server listens to."
47950 msgstr ""
47951
47952 #. type: deftypevr
47953 #: guix-git/doc/guix.texi:26702 guix-git/doc/guix.texi:26814
47954 msgid "Defaults to @samp{1194}."
47955 msgstr ""
47956
47957 #. type: Plain text
47958 #: guix-git/doc/guix.texi:26711
47959 msgid "Available @code{openvpn-server-configuration} fields are:"
47960 msgstr ""
47961
47962 #. type: deftypevr
47963 #: guix-git/doc/guix.texi:26712
47964 #, no-wrap
47965 msgid "{@code{openvpn-server-configuration} parameter} package openvpn"
47966 msgstr ""
47967
47968 #. type: deftypevr
47969 #: guix-git/doc/guix.texi:26717
47970 #, no-wrap
47971 msgid "{@code{openvpn-server-configuration} parameter} string pid-file"
47972 msgstr ""
47973
47974 #. type: deftypevr
47975 #: guix-git/doc/guix.texi:26724
47976 #, no-wrap
47977 msgid "{@code{openvpn-server-configuration} parameter} proto proto"
47978 msgstr ""
47979
47980 #. type: deftypevr
47981 #: guix-git/doc/guix.texi:26732
47982 #, no-wrap
47983 msgid "{@code{openvpn-server-configuration} parameter} dev dev"
47984 msgstr ""
47985
47986 #. type: deftypevr
47987 #: guix-git/doc/guix.texi:26743
47988 #, no-wrap
47989 msgid "{@code{openvpn-server-configuration} parameter} maybe-string ca"
47990 msgstr ""
47991
47992 #. type: deftypevr
47993 #: guix-git/doc/guix.texi:26750
47994 #, no-wrap
47995 msgid "{@code{openvpn-server-configuration} parameter} maybe-string cert"
47996 msgstr ""
47997
47998 #. type: deftypevr
47999 #: guix-git/doc/guix.texi:26758
48000 #, no-wrap
48001 msgid "{@code{openvpn-server-configuration} parameter} maybe-string key"
48002 msgstr ""
48003
48004 #. type: deftypevr
48005 #: guix-git/doc/guix.texi:26766
48006 #, no-wrap
48007 msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?"
48008 msgstr ""
48009
48010 #. type: deftypevr
48011 #: guix-git/doc/guix.texi:26773
48012 #, no-wrap
48013 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?"
48014 msgstr ""
48015
48016 #. type: deftypevr
48017 #: guix-git/doc/guix.texi:26780
48018 #, no-wrap
48019 msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?"
48020 msgstr ""
48021
48022 #. type: deftypevr
48023 #: guix-git/doc/guix.texi:26788
48024 #, no-wrap
48025 msgid "{@code{openvpn-server-configuration} parameter} boolean fast-io?"
48026 msgstr ""
48027
48028 #. type: deftypevr
48029 #: guix-git/doc/guix.texi:26795
48030 #, no-wrap
48031 msgid "{@code{openvpn-server-configuration} parameter} number verbosity"
48032 msgstr ""
48033
48034 #. type: deftypevr
48035 #: guix-git/doc/guix.texi:26802
48036 #, no-wrap
48037 msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth"
48038 msgstr ""
48039
48040 #. type: deftypevr
48041 #: guix-git/doc/guix.texi:26810
48042 #, no-wrap
48043 msgid "{@code{openvpn-server-configuration} parameter} number port"
48044 msgstr ""
48045
48046 #. type: deftypevr
48047 #: guix-git/doc/guix.texi:26812
48048 msgid "Specifies the port number on which the server listens."
48049 msgstr ""
48050
48051 #. type: deftypevr
48052 #: guix-git/doc/guix.texi:26817
48053 #, no-wrap
48054 msgid "{@code{openvpn-server-configuration} parameter} ip-mask server"
48055 msgstr ""
48056
48057 #. type: deftypevr
48058 #: guix-git/doc/guix.texi:26819
48059 msgid "An ip and mask specifying the subnet inside the virtual network."
48060 msgstr ""
48061
48062 #. type: deftypevr
48063 #: guix-git/doc/guix.texi:26821
48064 msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}."
48065 msgstr ""
48066
48067 #. type: deftypevr
48068 #: guix-git/doc/guix.texi:26824
48069 #, no-wrap
48070 msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6"
48071 msgstr ""
48072
48073 #. type: deftypevr
48074 #: guix-git/doc/guix.texi:26826
48075 msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network."
48076 msgstr ""
48077
48078 #. type: deftypevr
48079 #: guix-git/doc/guix.texi:26831
48080 #, no-wrap
48081 msgid "{@code{openvpn-server-configuration} parameter} string dh"
48082 msgstr ""
48083
48084 #. type: deftypevr
48085 #: guix-git/doc/guix.texi:26833
48086 msgid "The Diffie-Hellman parameters file."
48087 msgstr ""
48088
48089 #. type: deftypevr
48090 #: guix-git/doc/guix.texi:26835
48091 msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}."
48092 msgstr ""
48093
48094 #. type: deftypevr
48095 #: guix-git/doc/guix.texi:26838
48096 #, no-wrap
48097 msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist"
48098 msgstr ""
48099
48100 #. type: deftypevr
48101 #: guix-git/doc/guix.texi:26840
48102 msgid "The file that records client IPs."
48103 msgstr ""
48104
48105 #. type: deftypevr
48106 #: guix-git/doc/guix.texi:26842
48107 msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}."
48108 msgstr ""
48109
48110 #. type: deftypevr
48111 #: guix-git/doc/guix.texi:26845
48112 #, no-wrap
48113 msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?"
48114 msgstr ""
48115
48116 #. type: deftypevr
48117 #: guix-git/doc/guix.texi:26847
48118 msgid "When true, the server will act as a gateway for its clients."
48119 msgstr ""
48120
48121 #. type: deftypevr
48122 #: guix-git/doc/guix.texi:26852
48123 #, no-wrap
48124 msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?"
48125 msgstr ""
48126
48127 #. type: deftypevr
48128 #: guix-git/doc/guix.texi:26854
48129 msgid "When true, clients are allowed to talk to each other inside the VPN."
48130 msgstr ""
48131
48132 #. type: deftypevr
48133 #: guix-git/doc/guix.texi:26859
48134 #, no-wrap
48135 msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive"
48136 msgstr ""
48137
48138 #. type: deftypevr
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."
48141 msgstr ""
48142
48143 #. type: deftypevr
48144 #: guix-git/doc/guix.texi:26868
48145 #, no-wrap
48146 msgid "{@code{openvpn-server-configuration} parameter} number max-clients"
48147 msgstr ""
48148
48149 #. type: deftypevr
48150 #: guix-git/doc/guix.texi:26870
48151 msgid "The maximum number of clients."
48152 msgstr ""
48153
48154 #. type: deftypevr
48155 #: guix-git/doc/guix.texi:26875
48156 #, no-wrap
48157 msgid "{@code{openvpn-server-configuration} parameter} string status"
48158 msgstr ""
48159
48160 #. type: deftypevr
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."
48163 msgstr ""
48164
48165 #. type: deftypevr
48166 #: guix-git/doc/guix.texi:26880
48167 msgid "Defaults to @samp{\"/var/run/openvpn/status\"}."
48168 msgstr ""
48169
48170 #. type: deftypevr
48171 #: guix-git/doc/guix.texi:26883
48172 #, no-wrap
48173 msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir"
48174 msgstr ""
48175
48176 #. type: deftypevr
48177 #: guix-git/doc/guix.texi:26885
48178 msgid "The list of configuration for some clients."
48179 msgstr ""
48180
48181 #. type: deftypevr
48182 #: guix-git/doc/guix.texi:26889
48183 msgid "Available @code{openvpn-ccd-configuration} fields are:"
48184 msgstr ""
48185
48186 #. type: deftypevr
48187 #: guix-git/doc/guix.texi:26890
48188 #, no-wrap
48189 msgid "{@code{openvpn-ccd-configuration} parameter} string name"
48190 msgstr ""
48191
48192 #. type: deftypevr
48193 #: guix-git/doc/guix.texi:26892
48194 msgid "Client name."
48195 msgstr ""
48196
48197 #. type: deftypevr
48198 #: guix-git/doc/guix.texi:26894
48199 msgid "Defaults to @samp{\"client\"}."
48200 msgstr ""
48201
48202 #. type: deftypevr
48203 #: guix-git/doc/guix.texi:26897
48204 #, no-wrap
48205 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute"
48206 msgstr ""
48207
48208 #. type: deftypevr
48209 #: guix-git/doc/guix.texi:26899
48210 msgid "Client own network"
48211 msgstr ""
48212
48213 #. type: deftypevr
48214 #: guix-git/doc/guix.texi:26904
48215 #, no-wrap
48216 msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push"
48217 msgstr ""
48218
48219 #. type: deftypevr
48220 #: guix-git/doc/guix.texi:26906
48221 msgid "Client VPN IP."
48222 msgstr ""
48223
48224 #. type: subsubheading
48225 #: guix-git/doc/guix.texi:26916
48226 #, no-wrap
48227 msgid "Wireguard"
48228 msgstr ""
48229
48230 #. type: defvr
48231 #: guix-git/doc/guix.texi:26918
48232 #, no-wrap
48233 msgid "{Scheme Variable} wireguard-service-type"
48234 msgstr ""
48235
48236 #. type: defvr
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:"
48239 msgstr ""
48240
48241 #. type: lisp
48242 #: guix-git/doc/guix.texi:26932
48243 #, no-wrap
48244 msgid ""
48245 "(service wireguard-service-type\n"
48246 " (wireguard-configuration\n"
48247 " (peers\n"
48248 " (list\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"
48254 msgstr ""
48255
48256 #. type: deftp
48257 #: guix-git/doc/guix.texi:26936
48258 #, no-wrap
48259 msgid "{Data Type} wireguard-configuration"
48260 msgstr ""
48261
48262 #. type: deftp
48263 #: guix-git/doc/guix.texi:26938
48264 msgid "Data type representing the configuration of the Wireguard service."
48265 msgstr ""
48266
48267 #. type: code{#1}
48268 #: guix-git/doc/guix.texi:26940
48269 #, no-wrap
48270 msgid "wireguard"
48271 msgstr ""
48272
48273 #. type: table
48274 #: guix-git/doc/guix.texi:26942
48275 msgid "The wireguard package to use for this service."
48276 msgstr ""
48277
48278 #. type: item
48279 #: guix-git/doc/guix.texi:26943
48280 #, no-wrap
48281 msgid "@code{interface} (default: @code{\"wg0\"})"
48282 msgstr ""
48283
48284 #. type: table
48285 #: guix-git/doc/guix.texi:26945
48286 msgid "The interface name for the VPN."
48287 msgstr ""
48288
48289 #. type: item
48290 #: guix-git/doc/guix.texi:26946
48291 #, no-wrap
48292 msgid "@code{addresses} (default: @code{'(\"10.0.0.1/32\")})"
48293 msgstr ""
48294
48295 #. type: table
48296 #: guix-git/doc/guix.texi:26948
48297 msgid "The IP addresses to be assigned to the above interface."
48298 msgstr ""
48299
48300 #. type: item
48301 #: guix-git/doc/guix.texi:26949
48302 #, no-wrap
48303 msgid "@code{private-key} (default: @code{\"/etc/wireguard/private.key\"})"
48304 msgstr ""
48305
48306 #. type: table
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."
48309 msgstr ""
48310
48311 #. type: item
48312 #: guix-git/doc/guix.texi:26953
48313 #, no-wrap
48314 msgid "@code{peers} (default: @code{'()})"
48315 msgstr ""
48316
48317 #. type: table
48318 #: guix-git/doc/guix.texi:26956
48319 msgid "The authorized peers on this interface. This is a list of @var{wireguard-peer} records."
48320 msgstr ""
48321
48322 #. type: deftp
48323 #: guix-git/doc/guix.texi:26960
48324 #, no-wrap
48325 msgid "{Data Type} wireguard-peer"
48326 msgstr ""
48327
48328 #. type: deftp
48329 #: guix-git/doc/guix.texi:26962
48330 msgid "Data type representing a Wireguard peer attached to a given interface."
48331 msgstr ""
48332
48333 #. type: table
48334 #: guix-git/doc/guix.texi:26966
48335 msgid "The peer name."
48336 msgstr ""
48337
48338 #. type: item
48339 #: guix-git/doc/guix.texi:26967
48340 #, no-wrap
48341 msgid "@code{endpoint} (default: @code{#f})"
48342 msgstr ""
48343
48344 #. type: table
48345 #: guix-git/doc/guix.texi:26970
48346 msgid "The optional endpoint for the peer, such as @code{\"demo.wireguard.com:51820\"}."
48347 msgstr ""
48348
48349 #. type: itemx
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
48352 #, no-wrap
48353 msgid "public-key"
48354 msgstr ""
48355
48356 #. type: table
48357 #: guix-git/doc/guix.texi:26973
48358 msgid "The peer public-key represented as a base64 string."
48359 msgstr ""
48360
48361 #. type: code{#1}
48362 #: guix-git/doc/guix.texi:26974
48363 #, no-wrap
48364 msgid "allowed-ips"
48365 msgstr ""
48366
48367 #. type: table
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."
48370 msgstr ""
48371
48372 #. type: cindex
48373 #: guix-git/doc/guix.texi:26983
48374 #, no-wrap
48375 msgid "NFS"
48376 msgstr ""
48377
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)."
48381 msgstr ""
48382
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}."
48386 msgstr ""
48387
48388 #. type: subsubheading
48389 #: guix-git/doc/guix.texi:26993
48390 #, no-wrap
48391 msgid "NFS Service"
48392 msgstr ""
48393
48394 #. type: cindex
48395 #: guix-git/doc/guix.texi:26994
48396 #, no-wrap
48397 msgid "NFS, server"
48398 msgstr ""
48399
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."
48403 msgstr ""
48404
48405 #. type: defvr
48406 #: guix-git/doc/guix.texi:27000
48407 #, no-wrap
48408 msgid "{Scheme Variable} nfs-service-type"
48409 msgstr ""
48410
48411 #. type: defvr
48412 #: guix-git/doc/guix.texi:27002
48413 msgid "A service type for a complete NFS server."
48414 msgstr ""
48415
48416 #. type: deftp
48417 #: guix-git/doc/guix.texi:27004
48418 #, no-wrap
48419 msgid "{Data Type} nfs-configuration"
48420 msgstr ""
48421
48422 #. type: deftp
48423 #: guix-git/doc/guix.texi:27007
48424 msgid "This data type represents the configuration of the NFS service and all of its subsystems."
48425 msgstr ""
48426
48427 #. type: deftp
48428 #: guix-git/doc/guix.texi:27009
48429 msgid "It has the following parameters:"
48430 msgstr ""
48431
48432 #. type: item
48433 #: guix-git/doc/guix.texi:27010 guix-git/doc/guix.texi:27135
48434 #: guix-git/doc/guix.texi:27160
48435 #, no-wrap
48436 msgid "@code{nfs-utils} (default: @code{nfs-utils})"
48437 msgstr ""
48438
48439 #. type: table
48440 #: guix-git/doc/guix.texi:27012
48441 msgid "The nfs-utils package to use."
48442 msgstr ""
48443
48444 #. type: item
48445 #: guix-git/doc/guix.texi:27013
48446 #, no-wrap
48447 msgid "@code{nfs-versions} (default: @code{'(\"4.2\" \"4.1\" \"4.0\")})"
48448 msgstr ""
48449
48450 #. type: table
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."
48453 msgstr ""
48454
48455 #. type: item
48456 #: guix-git/doc/guix.texi:27017
48457 #, no-wrap
48458 msgid "@code{exports} (default: @code{'()})"
48459 msgstr ""
48460
48461 #. type: table
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:"
48464 msgstr ""
48465
48466 #. type: lisp
48467 #: guix-git/doc/guix.texi:27028
48468 #, no-wrap
48469 msgid ""
48470 "(nfs-configuration\n"
48471 " (exports\n"
48472 " '((\"/export\"\n"
48473 " \"*(ro,insecure,no_subtree_check,crossmnt,fsid=0)\"))))\n"
48474 msgstr ""
48475
48476 #. type: item
48477 #: guix-git/doc/guix.texi:27030
48478 #, no-wrap
48479 msgid "@code{rpcmountd-port} (default: @code{#f})"
48480 msgstr ""
48481
48482 #. type: table
48483 #: guix-git/doc/guix.texi:27032
48484 msgid "The network port that the @command{rpc.mountd} daemon should use."
48485 msgstr ""
48486
48487 #. type: item
48488 #: guix-git/doc/guix.texi:27033
48489 #, no-wrap
48490 msgid "@code{rpcstatd-port} (default: @code{#f})"
48491 msgstr ""
48492
48493 #. type: table
48494 #: guix-git/doc/guix.texi:27035
48495 msgid "The network port that the @command{rpc.statd} daemon should use."
48496 msgstr ""
48497
48498 #. type: item
48499 #: guix-git/doc/guix.texi:27036 guix-git/doc/guix.texi:27084
48500 #, no-wrap
48501 msgid "@code{rpcbind} (default: @code{rpcbind})"
48502 msgstr ""
48503
48504 #. type: table
48505 #: guix-git/doc/guix.texi:27038 guix-git/doc/guix.texi:27086
48506 msgid "The rpcbind package to use."
48507 msgstr ""
48508
48509 #. type: item
48510 #: guix-git/doc/guix.texi:27039
48511 #, no-wrap
48512 msgid "@code{idmap-domain} (default: @code{\"localdomain\"})"
48513 msgstr ""
48514
48515 #. type: table
48516 #: guix-git/doc/guix.texi:27041
48517 msgid "The local NFSv4 domain name."
48518 msgstr ""
48519
48520 #. type: item
48521 #: guix-git/doc/guix.texi:27042
48522 #, no-wrap
48523 msgid "@code{nfsd-port} (default: @code{2049})"
48524 msgstr ""
48525
48526 #. type: table
48527 #: guix-git/doc/guix.texi:27044
48528 msgid "The network port that the @command{nfsd} daemon should use."
48529 msgstr ""
48530
48531 #. type: item
48532 #: guix-git/doc/guix.texi:27045
48533 #, no-wrap
48534 msgid "@code{nfsd-threads} (default: @code{8})"
48535 msgstr ""
48536
48537 #. type: table
48538 #: guix-git/doc/guix.texi:27047
48539 msgid "The number of threads used by the @command{nfsd} daemon."
48540 msgstr ""
48541
48542 #. type: item
48543 #: guix-git/doc/guix.texi:27048
48544 #, no-wrap
48545 msgid "@code{nfsd-tcp?} (default: @code{#t})"
48546 msgstr ""
48547
48548 #. type: table
48549 #: guix-git/doc/guix.texi:27050
48550 msgid "Whether the @command{nfsd} daemon should listen on a TCP socket."
48551 msgstr ""
48552
48553 #. type: item
48554 #: guix-git/doc/guix.texi:27051
48555 #, no-wrap
48556 msgid "@code{nfsd-udp?} (default: @code{#f})"
48557 msgstr ""
48558
48559 #. type: table
48560 #: guix-git/doc/guix.texi:27053
48561 msgid "Whether the @command{nfsd} daemon should listen on a UDP socket."
48562 msgstr ""
48563
48564 #. type: item
48565 #: guix-git/doc/guix.texi:27054 guix-git/doc/guix.texi:27138
48566 #: guix-git/doc/guix.texi:27163
48567 #, no-wrap
48568 msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48569 msgstr ""
48570
48571 #. type: table
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."
48575 msgstr ""
48576
48577 #. type: item
48578 #: guix-git/doc/guix.texi:27057
48579 #, no-wrap
48580 msgid "@code{debug} (default: @code{'()\"})"
48581 msgstr ""
48582
48583 #. type: table
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}."
48586 msgstr ""
48587
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."
48591 msgstr ""
48592
48593 #. type: subsubheading
48594 #: guix-git/doc/guix.texi:27067
48595 #, no-wrap
48596 msgid "RPC Bind Service"
48597 msgstr ""
48598
48599 #. type: cindex
48600 #: guix-git/doc/guix.texi:27068
48601 #, no-wrap
48602 msgid "rpcbind"
48603 msgstr ""
48604
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."
48608 msgstr ""
48609
48610 #. type: defvr
48611 #: guix-git/doc/guix.texi:27075
48612 #, no-wrap
48613 msgid "{Scheme Variable} rpcbind-service-type"
48614 msgstr ""
48615
48616 #. type: defvr
48617 #: guix-git/doc/guix.texi:27077
48618 msgid "A service type for the RPC portmapper daemon."
48619 msgstr ""
48620
48621 #. type: deftp
48622 #: guix-git/doc/guix.texi:27080
48623 #, no-wrap
48624 msgid "{Data Type} rpcbind-configuration"
48625 msgstr ""
48626
48627 #. type: deftp
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:"
48630 msgstr ""
48631
48632 #. type: item
48633 #: guix-git/doc/guix.texi:27087
48634 #, no-wrap
48635 msgid "@code{warm-start?} (default: @code{#t})"
48636 msgstr ""
48637
48638 #. type: table
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."
48641 msgstr ""
48642
48643 #. type: subsubheading
48644 #: guix-git/doc/guix.texi:27095
48645 #, no-wrap
48646 msgid "Pipefs Pseudo File System"
48647 msgstr ""
48648
48649 #. type: cindex
48650 #: guix-git/doc/guix.texi:27096
48651 #, no-wrap
48652 msgid "pipefs"
48653 msgstr ""
48654
48655 #. type: cindex
48656 #: guix-git/doc/guix.texi:27097
48657 #, no-wrap
48658 msgid "rpc_pipefs"
48659 msgstr ""
48660
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."
48664 msgstr ""
48665
48666 #. type: defvr
48667 #: guix-git/doc/guix.texi:27102
48668 #, no-wrap
48669 msgid "{Scheme Variable} pipefs-service-type"
48670 msgstr ""
48671
48672 #. type: defvr
48673 #: guix-git/doc/guix.texi:27104
48674 msgid "A service type for the pipefs pseudo file system."
48675 msgstr ""
48676
48677 #. type: deftp
48678 #: guix-git/doc/guix.texi:27106
48679 #, no-wrap
48680 msgid "{Data Type} pipefs-configuration"
48681 msgstr ""
48682
48683 #. type: deftp
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:"
48686 msgstr ""
48687
48688 #. type: item
48689 #: guix-git/doc/guix.texi:27110
48690 #, no-wrap
48691 msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})"
48692 msgstr ""
48693
48694 #. type: table
48695 #: guix-git/doc/guix.texi:27112
48696 msgid "The directory to which the file system is to be attached."
48697 msgstr ""
48698
48699 #. type: subsubheading
48700 #: guix-git/doc/guix.texi:27116
48701 #, no-wrap
48702 msgid "GSS Daemon Service"
48703 msgstr ""
48704
48705 #. type: cindex
48706 #: guix-git/doc/guix.texi:27117
48707 #, no-wrap
48708 msgid "GSSD"
48709 msgstr ""
48710
48711 #. type: cindex
48712 #: guix-git/doc/guix.texi:27118
48713 #, no-wrap
48714 msgid "GSS"
48715 msgstr ""
48716
48717 #. type: cindex
48718 #: guix-git/doc/guix.texi:27119
48719 #, no-wrap
48720 msgid "global security system"
48721 msgstr ""
48722
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})."
48726 msgstr ""
48727
48728 #. type: defvr
48729 #: guix-git/doc/guix.texi:27127
48730 #, no-wrap
48731 msgid "{Scheme Variable} gss-service-type"
48732 msgstr ""
48733
48734 #. type: defvr
48735 #: guix-git/doc/guix.texi:27129
48736 msgid "A service type for the Global Security System (GSS) daemon."
48737 msgstr ""
48738
48739 #. type: deftp
48740 #: guix-git/doc/guix.texi:27131
48741 #, no-wrap
48742 msgid "{Data Type} gss-configuration"
48743 msgstr ""
48744
48745 #. type: deftp
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:"
48748 msgstr ""
48749
48750 #. type: table
48751 #: guix-git/doc/guix.texi:27137
48752 msgid "The package in which the @command{rpc.gssd} command is to be found."
48753 msgstr ""
48754
48755 #. type: subsubheading
48756 #: guix-git/doc/guix.texi:27145
48757 #, no-wrap
48758 msgid "IDMAP Daemon Service"
48759 msgstr ""
48760
48761 #. type: cindex
48762 #: guix-git/doc/guix.texi:27146
48763 #, no-wrap
48764 msgid "idmapd"
48765 msgstr ""
48766
48767 #. type: cindex
48768 #: guix-git/doc/guix.texi:27147
48769 #, no-wrap
48770 msgid "name mapper"
48771 msgstr ""
48772
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."
48776 msgstr ""
48777
48778 #. type: defvr
48779 #: guix-git/doc/guix.texi:27152
48780 #, no-wrap
48781 msgid "{Scheme Variable} idmap-service-type"
48782 msgstr ""
48783
48784 #. type: defvr
48785 #: guix-git/doc/guix.texi:27154
48786 msgid "A service type for the Identity Mapper (IDMAP) daemon."
48787 msgstr ""
48788
48789 #. type: deftp
48790 #: guix-git/doc/guix.texi:27156
48791 #, no-wrap
48792 msgid "{Data Type} idmap-configuration"
48793 msgstr ""
48794
48795 #. type: deftp
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:"
48798 msgstr ""
48799
48800 #. type: table
48801 #: guix-git/doc/guix.texi:27162
48802 msgid "The package in which the @command{rpc.idmapd} command is to be found."
48803 msgstr ""
48804
48805 #. type: item
48806 #: guix-git/doc/guix.texi:27166
48807 #, no-wrap
48808 msgid "@code{domain} (default: @code{#f})"
48809 msgstr ""
48810
48811 #. type: table
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."
48814 msgstr ""
48815
48816 #. type: item
48817 #: guix-git/doc/guix.texi:27171
48818 #, no-wrap
48819 msgid "@code{verbosity} (default: @code{0})"
48820 msgstr ""
48821
48822 #. type: table
48823 #: guix-git/doc/guix.texi:27173
48824 msgid "The verbosity level of the daemon."
48825 msgstr ""
48826
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})."
48830 msgstr ""
48831
48832 #. type: Plain text
48833 #: guix-git/doc/guix.texi:27186
48834 msgid "The @code{(gnu services cuirass)} module provides the following service."
48835 msgstr ""
48836
48837 #. type: defvr
48838 #: guix-git/doc/guix.texi:27187
48839 #, no-wrap
48840 msgid "{Scheme Procedure} cuirass-service-type"
48841 msgstr ""
48842
48843 #. type: defvr
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."
48846 msgstr ""
48847
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."
48851 msgstr ""
48852
48853 #. type: lisp
48854 #: guix-git/doc/guix.texi:27206
48855 #, no-wrap
48856 msgid ""
48857 "(define %cuirass-specs\n"
48858 " #~(list (specification\n"
48859 " (name \"my-channel\")\n"
48860 " (build '(channels my-channel))\n"
48861 " (channels\n"
48862 " (cons (channel\n"
48863 " (name 'my-channel)\n"
48864 " (url \"https://my-channel.git\"))\n"
48865 " %default-channels)))))\n"
48866 "\n"
48867 msgstr ""
48868
48869 #. type: lisp
48870 #: guix-git/doc/guix.texi:27210 guix-git/doc/guix.texi:27224
48871 #, no-wrap
48872 msgid ""
48873 "(service cuirass-service-type\n"
48874 " (cuirass-configuration\n"
48875 " (specifications %cuirass-specs)))\n"
48876 msgstr ""
48877
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."
48881 msgstr ""
48882
48883 #. type: lisp
48884 #: guix-git/doc/guix.texi:27220
48885 #, no-wrap
48886 msgid ""
48887 "(define %cuirass-specs\n"
48888 " #~(list (specification\n"
48889 " (name \"my-linux\")\n"
48890 " (build '(packages \"linux-libre\")))))\n"
48891 "\n"
48892 msgstr ""
48893
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})."
48897 msgstr ""
48898
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."
48902 msgstr ""
48903
48904 #. type: deftp
48905 #: guix-git/doc/guix.texi:27234
48906 #, no-wrap
48907 msgid "{Data Type} cuirass-configuration"
48908 msgstr ""
48909
48910 #. type: deftp
48911 #: guix-git/doc/guix.texi:27236
48912 msgid "Data type representing the configuration of Cuirass."
48913 msgstr ""
48914
48915 #. type: item
48916 #: guix-git/doc/guix.texi:27238 guix-git/doc/guix.texi:27370
48917 #, no-wrap
48918 msgid "@code{cuirass} (default: @code{cuirass})"
48919 msgstr ""
48920
48921 #. type: table
48922 #: guix-git/doc/guix.texi:27240 guix-git/doc/guix.texi:27372
48923 msgid "The Cuirass package to use."
48924 msgstr ""
48925
48926 #. type: item
48927 #: guix-git/doc/guix.texi:27241
48928 #, no-wrap
48929 msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})"
48930 msgstr ""
48931
48932 #. type: table
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."
48936 msgstr ""
48937
48938 #. type: item
48939 #: guix-git/doc/guix.texi:27244
48940 #, no-wrap
48941 msgid "@code{web-log-file} (default: @code{\"/var/log/cuirass-web.log\"})"
48942 msgstr ""
48943
48944 #. type: table
48945 #: guix-git/doc/guix.texi:27246
48946 msgid "Location of the log file used by the web interface."
48947 msgstr ""
48948
48949 #. type: item
48950 #: guix-git/doc/guix.texi:27247
48951 #, no-wrap
48952 msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})"
48953 msgstr ""
48954
48955 #. type: table
48956 #: guix-git/doc/guix.texi:27249
48957 msgid "Location of the repository cache."
48958 msgstr ""
48959
48960 #. type: item
48961 #: guix-git/doc/guix.texi:27250
48962 #, no-wrap
48963 msgid "@code{user} (default: @code{\"cuirass\"})"
48964 msgstr ""
48965
48966 #. type: table
48967 #: guix-git/doc/guix.texi:27252
48968 msgid "Owner of the @code{cuirass} process."
48969 msgstr ""
48970
48971 #. type: item
48972 #: guix-git/doc/guix.texi:27253
48973 #, no-wrap
48974 msgid "@code{group} (default: @code{\"cuirass\"})"
48975 msgstr ""
48976
48977 #. type: table
48978 #: guix-git/doc/guix.texi:27255
48979 msgid "Owner's group of the @code{cuirass} process."
48980 msgstr ""
48981
48982 #. type: item
48983 #: guix-git/doc/guix.texi:27256
48984 #, no-wrap
48985 msgid "@code{interval} (default: @code{60})"
48986 msgstr ""
48987
48988 #. type: table
48989 #: guix-git/doc/guix.texi:27259
48990 msgid "Number of seconds between the poll of the repositories followed by the Cuirass jobs."
48991 msgstr ""
48992
48993 #. type: item
48994 #: guix-git/doc/guix.texi:27260
48995 #, no-wrap
48996 msgid "@code{parameters} (default: @code{#f})"
48997 msgstr ""
48998
48999 #. type: table
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})."
49002 msgstr ""
49003
49004 #. type: item
49005 #: guix-git/doc/guix.texi:27264
49006 #, no-wrap
49007 msgid "@code{remote-server} (default: @code{#f})"
49008 msgstr ""
49009
49010 #. type: table
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."
49013 msgstr ""
49014
49015 #. type: item
49016 #: guix-git/doc/guix.texi:27268
49017 #, no-wrap
49018 msgid "@code{database} (default: @code{\"dbname=cuirass host=/var/run/postgresql\"})"
49019 msgstr ""
49020
49021 #. type: table
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\"}."
49024 msgstr ""
49025
49026 #. type: item
49027 #: guix-git/doc/guix.texi:27274
49028 #, no-wrap
49029 msgid "@code{port} (default: @code{8081})"
49030 msgstr ""
49031
49032 #. type: table
49033 #: guix-git/doc/guix.texi:27276
49034 msgid "Port number used by the HTTP server."
49035 msgstr ""
49036
49037 #. type: table
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."
49040 msgstr ""
49041
49042 #. type: item
49043 #: guix-git/doc/guix.texi:27281
49044 #, no-wrap
49045 msgid "@code{specifications} (default: @code{#~'()})"
49046 msgstr ""
49047
49048 #. type: table
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})."
49051 msgstr ""
49052
49053 #. type: item
49054 #: guix-git/doc/guix.texi:27286
49055 #, no-wrap
49056 msgid "@code{use-substitutes?} (default: @code{#f})"
49057 msgstr ""
49058
49059 #. type: table
49060 #: guix-git/doc/guix.texi:27289
49061 msgid "This allows using substitutes to avoid building every dependencies of a job from source."
49062 msgstr ""
49063
49064 #. type: item
49065 #: guix-git/doc/guix.texi:27290 guix-git/doc/guix.texi:34160
49066 #, no-wrap
49067 msgid "@code{one-shot?} (default: @code{#f})"
49068 msgstr ""
49069
49070 #. type: table
49071 #: guix-git/doc/guix.texi:27292
49072 msgid "Only evaluate specifications and build derivations once."
49073 msgstr ""
49074
49075 #. type: item
49076 #: guix-git/doc/guix.texi:27293
49077 #, no-wrap
49078 msgid "@code{fallback?} (default: @code{#f})"
49079 msgstr ""
49080
49081 #. type: table
49082 #: guix-git/doc/guix.texi:27296
49083 msgid "When substituting a pre-built binary fails, fall back to building packages locally."
49084 msgstr ""
49085
49086 #. type: table
49087 #: guix-git/doc/guix.texi:27299
49088 msgid "Extra options to pass when running the Cuirass processes."
49089 msgstr ""
49090
49091 #. type: cindex
49092 #: guix-git/doc/guix.texi:27303
49093 #, no-wrap
49094 msgid "remote build"
49095 msgstr ""
49096
49097 #. type: subsubheading
49098 #: guix-git/doc/guix.texi:27304
49099 #, no-wrap
49100 msgid "Cuirass remote building"
49101 msgstr ""
49102
49103 #. type: Plain text
49104 #: guix-git/doc/guix.texi:27307
49105 msgid "Cuirass supports two mechanisms to build derivations."
49106 msgstr ""
49107
49108 #. type: item
49109 #: guix-git/doc/guix.texi:27309
49110 #, no-wrap
49111 msgid "Using the local Guix daemon."
49112 msgstr ""
49113
49114 #. type: itemize
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."
49117 msgstr ""
49118
49119 #. type: item
49120 #: guix-git/doc/guix.texi:27314
49121 #, no-wrap
49122 msgid "Using the remote build mechanism."
49123 msgstr ""
49124
49125 #. type: itemize
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."
49128 msgstr ""
49129
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."
49133 msgstr ""
49134
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."
49138 msgstr ""
49139
49140 #. type: deftp
49141 #: guix-git/doc/guix.texi:27331
49142 #, no-wrap
49143 msgid "{Data Type} cuirass-remote-server-configuration"
49144 msgstr ""
49145
49146 #. type: deftp
49147 #: guix-git/doc/guix.texi:27333
49148 msgid "Data type representing the configuration of the Cuirass remote-server."
49149 msgstr ""
49150
49151 #. type: item
49152 #: guix-git/doc/guix.texi:27335
49153 #, no-wrap
49154 msgid "@code{backend-port} (default: @code{5555})"
49155 msgstr ""
49156
49157 #. type: table
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}."
49160 msgstr ""
49161
49162 #. type: item
49163 #: guix-git/doc/guix.texi:27339
49164 #, no-wrap
49165 msgid "@code{log-port} (default: @code{5556})"
49166 msgstr ""
49167
49168 #. type: table
49169 #: guix-git/doc/guix.texi:27341
49170 msgid "The TCP port of the log server. It defaults to @code{5556}."
49171 msgstr ""
49172
49173 #. type: item
49174 #: guix-git/doc/guix.texi:27342
49175 #, no-wrap
49176 msgid "@code{publish-port} (default: @code{5557})"
49177 msgstr ""
49178
49179 #. type: table
49180 #: guix-git/doc/guix.texi:27344
49181 msgid "The TCP port of the publish server. It defaults to @code{5557}."
49182 msgstr ""
49183
49184 #. type: item
49185 #: guix-git/doc/guix.texi:27345
49186 #, no-wrap
49187 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-server.log\"})"
49188 msgstr ""
49189
49190 #. type: item
49191 #: guix-git/doc/guix.texi:27348
49192 #, no-wrap
49193 msgid "@code{cache} (default: @code{\"/var/cache/cuirass/remote\"})"
49194 msgstr ""
49195
49196 #. type: table
49197 #: guix-git/doc/guix.texi:27350
49198 msgid "Use @var{cache} directory to cache build log files."
49199 msgstr ""
49200
49201 #. type: item
49202 #: guix-git/doc/guix.texi:27351
49203 #, no-wrap
49204 msgid "@code{trigger-url} (default: @code{#f})"
49205 msgstr ""
49206
49207 #. type: table
49208 #: guix-git/doc/guix.texi:27354
49209 msgid "Once a substitute is successfully fetched, trigger substitute baking at @var{trigger-url}."
49210 msgstr ""
49211
49212 #. type: code{#1}
49213 #: guix-git/doc/guix.texi:27356 guix-git/doc/guix.texi:27390
49214 #, no-wrap
49215 msgid "private-key"
49216 msgstr ""
49217
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."
49221 msgstr ""
49222
49223 #. type: deftp
49224 #: guix-git/doc/guix.texi:27366
49225 #, no-wrap
49226 msgid "{Data Type} cuirass-remote-worker-configuration"
49227 msgstr ""
49228
49229 #. type: deftp
49230 #: guix-git/doc/guix.texi:27368
49231 msgid "Data type representing the configuration of the Cuirass remote-worker."
49232 msgstr ""
49233
49234 #. type: item
49235 #: guix-git/doc/guix.texi:27373
49236 #, no-wrap
49237 msgid "@code{workers} (default: @code{1})"
49238 msgstr ""
49239
49240 #. type: table
49241 #: guix-git/doc/guix.texi:27375
49242 msgid "Start @var{workers} parallel workers."
49243 msgstr ""
49244
49245 #. type: table
49246 #: guix-git/doc/guix.texi:27379
49247 msgid "Do not use Avahi discovery and connect to the given @code{server} IP address instead."
49248 msgstr ""
49249
49250 #. type: item
49251 #: guix-git/doc/guix.texi:27380
49252 #, no-wrap
49253 msgid "@code{systems} (default: @code{(list (%current-system))})"
49254 msgstr ""
49255
49256 #. type: table
49257 #: guix-git/doc/guix.texi:27382
49258 msgid "Only request builds for the given @var{systems}."
49259 msgstr ""
49260
49261 #. type: item
49262 #: guix-git/doc/guix.texi:27383
49263 #, no-wrap
49264 msgid "@code{log-file} (default: @code{\"/var/log/cuirass-remote-worker.log\"})"
49265 msgstr ""
49266
49267 #. type: item
49268 #: guix-git/doc/guix.texi:27386
49269 #, no-wrap
49270 msgid "@code{publish-port} (default: @code{5558})"
49271 msgstr ""
49272
49273 #. type: table
49274 #: guix-git/doc/guix.texi:27388
49275 msgid "The TCP port of the publish server. It defaults to @code{5558}."
49276 msgstr ""
49277
49278 #. type: subsubheading
49279 #: guix-git/doc/guix.texi:27397
49280 #, no-wrap
49281 msgid "Laminar"
49282 msgstr ""
49283
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."
49287 msgstr ""
49288
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."
49292 msgstr ""
49293
49294 #. type: defvr
49295 #: guix-git/doc/guix.texi:27406
49296 #, no-wrap
49297 msgid "{Scheme Procedure} laminar-service-type"
49298 msgstr ""
49299
49300 #. type: defvr
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."
49303 msgstr ""
49304
49305 #. type: defvr
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."
49308 msgstr ""
49309
49310 #. type: lisp
49311 #: guix-git/doc/guix.texi:27416
49312 #, no-wrap
49313 msgid "(service laminar-service-type)\n"
49314 msgstr ""
49315
49316 #. type: deftp
49317 #: guix-git/doc/guix.texi:27419
49318 #, no-wrap
49319 msgid "{Data Type} laminar-configuration"
49320 msgstr ""
49321
49322 #. type: deftp
49323 #: guix-git/doc/guix.texi:27421
49324 msgid "Data type representing the configuration of Laminar."
49325 msgstr ""
49326
49327 #. type: item
49328 #: guix-git/doc/guix.texi:27423
49329 #, no-wrap
49330 msgid "@code{laminar} (default: @code{laminar})"
49331 msgstr ""
49332
49333 #. type: table
49334 #: guix-git/doc/guix.texi:27425
49335 msgid "The Laminar package to use."
49336 msgstr ""
49337
49338 #. type: item
49339 #: guix-git/doc/guix.texi:27426
49340 #, no-wrap
49341 msgid "@code{home-directory} (default: @code{\"/var/lib/laminar\"})"
49342 msgstr ""
49343
49344 #. type: table
49345 #: guix-git/doc/guix.texi:27428
49346 msgid "The directory for job configurations and run directories."
49347 msgstr ""
49348
49349 #. type: item
49350 #: guix-git/doc/guix.texi:27429
49351 #, no-wrap
49352 msgid "@code{bind-http} (default: @code{\"*:8080\"})"
49353 msgstr ""
49354
49355 #. type: table
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."
49358 msgstr ""
49359
49360 #. type: item
49361 #: guix-git/doc/guix.texi:27433
49362 #, no-wrap
49363 msgid "@code{bind-rpc} (default: @code{\"unix-abstract:laminar\"})"
49364 msgstr ""
49365
49366 #. type: table
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."
49369 msgstr ""
49370
49371 #. type: item
49372 #: guix-git/doc/guix.texi:27437
49373 #, no-wrap
49374 msgid "@code{title} (default: @code{\"Laminar\"})"
49375 msgstr ""
49376
49377 #. type: table
49378 #: guix-git/doc/guix.texi:27439
49379 msgid "The page title to show in the web frontend."
49380 msgstr ""
49381
49382 #. type: item
49383 #: guix-git/doc/guix.texi:27440
49384 #, no-wrap
49385 msgid "@code{keep-rundirs} (default: @code{0})"
49386 msgstr ""
49387
49388 #. type: table
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."
49391 msgstr ""
49392
49393 #. type: item
49394 #: guix-git/doc/guix.texi:27445
49395 #, no-wrap
49396 msgid "@code{archive-url} (default: @code{#f})"
49397 msgstr ""
49398
49399 #. type: table
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."
49402 msgstr ""
49403
49404 #. type: item
49405 #: guix-git/doc/guix.texi:27449
49406 #, no-wrap
49407 msgid "@code{base-url} (default: @code{#f})"
49408 msgstr ""
49409
49410 #. type: table
49411 #: guix-git/doc/guix.texi:27451
49412 msgid "Base URL to use for links to laminar itself."
49413 msgstr ""
49414
49415 #. type: cindex
49416 #: guix-git/doc/guix.texi:27458
49417 #, no-wrap
49418 msgid "tlp"
49419 msgstr ""
49420
49421 #. type: cindex
49422 #: guix-git/doc/guix.texi:27459
49423 #, no-wrap
49424 msgid "power management with TLP"
49425 msgstr ""
49426
49427 #. type: subsubheading
49428 #: guix-git/doc/guix.texi:27460
49429 #, no-wrap
49430 msgid "TLP daemon"
49431 msgstr ""
49432
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."
49436 msgstr ""
49437
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}."
49441 msgstr ""
49442
49443 #. type: deffn
49444 #: guix-git/doc/guix.texi:27471
49445 #, no-wrap
49446 msgid "{Scheme Variable} tlp-service-type"
49447 msgstr ""
49448
49449 #. type: deffn
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}:"
49452 msgstr ""
49453
49454 #. type: lisp
49455 #: guix-git/doc/guix.texi:27480
49456 #, no-wrap
49457 msgid ""
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"
49462 msgstr ""
49463
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}."
49467 msgstr ""
49468
49469 #. type: Plain text
49470 #: guix-git/doc/guix.texi:27498
49471 msgid "Available @code{tlp-configuration} fields are:"
49472 msgstr ""
49473
49474 #. type: deftypevr
49475 #: guix-git/doc/guix.texi:27499
49476 #, no-wrap
49477 msgid "{@code{tlp-configuration} parameter} package tlp"
49478 msgstr ""
49479
49480 #. type: deftypevr
49481 #: guix-git/doc/guix.texi:27501
49482 msgid "The TLP package."
49483 msgstr ""
49484
49485 #. type: deftypevr
49486 #: guix-git/doc/guix.texi:27504
49487 #, no-wrap
49488 msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?"
49489 msgstr ""
49490
49491 #. type: deftypevr
49492 #: guix-git/doc/guix.texi:27506
49493 msgid "Set to true if you wish to enable TLP."
49494 msgstr ""
49495
49496 #. type: deftypevr
49497 #: guix-git/doc/guix.texi:27511
49498 #, no-wrap
49499 msgid "{@code{tlp-configuration} parameter} string tlp-default-mode"
49500 msgstr ""
49501
49502 #. type: deftypevr
49503 #: guix-git/doc/guix.texi:27514
49504 msgid "Default mode when no power supply can be detected. Alternatives are AC and BAT."
49505 msgstr ""
49506
49507 #. type: deftypevr
49508 #: guix-git/doc/guix.texi:27516
49509 msgid "Defaults to @samp{\"AC\"}."
49510 msgstr ""
49511
49512 #. type: deftypevr
49513 #: guix-git/doc/guix.texi:27519
49514 #, no-wrap
49515 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac"
49516 msgstr ""
49517
49518 #. type: deftypevr
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."
49521 msgstr ""
49522
49523 #. type: deftypevr
49524 #: guix-git/doc/guix.texi:27527
49525 #, no-wrap
49526 msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat"
49527 msgstr ""
49528
49529 #. type: deftypevr
49530 #: guix-git/doc/guix.texi:27529
49531 msgid "Same as @code{disk-idle-ac} but on BAT mode."
49532 msgstr ""
49533
49534 #. type: deftypevr
49535 #: guix-git/doc/guix.texi:27531
49536 msgid "Defaults to @samp{2}."
49537 msgstr ""
49538
49539 #. type: deftypevr
49540 #: guix-git/doc/guix.texi:27534
49541 #, no-wrap
49542 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac"
49543 msgstr ""
49544
49545 #. type: deftypevr
49546 #: guix-git/doc/guix.texi:27536
49547 msgid "Dirty pages flushing periodicity, expressed in seconds."
49548 msgstr ""
49549
49550 #. type: deftypevr
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}."
49554 msgstr ""
49555
49556 #. type: deftypevr
49557 #: guix-git/doc/guix.texi:27541
49558 #, no-wrap
49559 msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat"
49560 msgstr ""
49561
49562 #. type: deftypevr
49563 #: guix-git/doc/guix.texi:27543
49564 msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode."
49565 msgstr ""
49566
49567 #. type: deftypevr
49568 #: guix-git/doc/guix.texi:27545
49569 msgid "Defaults to @samp{60}."
49570 msgstr ""
49571
49572 #. type: deftypevr
49573 #: guix-git/doc/guix.texi:27548
49574 #, no-wrap
49575 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac"
49576 msgstr ""
49577
49578 #. type: deftypevr
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."
49581 msgstr ""
49582
49583 #. type: deftypevr
49584 #: guix-git/doc/guix.texi:27557
49585 #, no-wrap
49586 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat"
49587 msgstr ""
49588
49589 #. type: deftypevr
49590 #: guix-git/doc/guix.texi:27559
49591 msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode."
49592 msgstr ""
49593
49594 #. type: deftypevr
49595 #: guix-git/doc/guix.texi:27564
49596 #, no-wrap
49597 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac"
49598 msgstr ""
49599
49600 #. type: deftypevr
49601 #: guix-git/doc/guix.texi:27566
49602 msgid "Set the min available frequency for the scaling governor on AC."
49603 msgstr ""
49604
49605 #. type: deftypevr
49606 #: guix-git/doc/guix.texi:27571
49607 #, no-wrap
49608 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac"
49609 msgstr ""
49610
49611 #. type: deftypevr
49612 #: guix-git/doc/guix.texi:27573
49613 msgid "Set the max available frequency for the scaling governor on AC."
49614 msgstr ""
49615
49616 #. type: deftypevr
49617 #: guix-git/doc/guix.texi:27578
49618 #, no-wrap
49619 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat"
49620 msgstr ""
49621
49622 #. type: deftypevr
49623 #: guix-git/doc/guix.texi:27580
49624 msgid "Set the min available frequency for the scaling governor on BAT."
49625 msgstr ""
49626
49627 #. type: deftypevr
49628 #: guix-git/doc/guix.texi:27585
49629 #, no-wrap
49630 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat"
49631 msgstr ""
49632
49633 #. type: deftypevr
49634 #: guix-git/doc/guix.texi:27587
49635 msgid "Set the max available frequency for the scaling governor on BAT."
49636 msgstr ""
49637
49638 #. type: deftypevr
49639 #: guix-git/doc/guix.texi:27592
49640 #, no-wrap
49641 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac"
49642 msgstr ""
49643
49644 #. type: deftypevr
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."
49647 msgstr ""
49648
49649 #. type: deftypevr
49650 #: guix-git/doc/guix.texi:27600
49651 #, no-wrap
49652 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac"
49653 msgstr ""
49654
49655 #. type: deftypevr
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."
49658 msgstr ""
49659
49660 #. type: deftypevr
49661 #: guix-git/doc/guix.texi:27608
49662 #, no-wrap
49663 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat"
49664 msgstr ""
49665
49666 #. type: deftypevr
49667 #: guix-git/doc/guix.texi:27610
49668 msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode."
49669 msgstr ""
49670
49671 #. type: deftypevr
49672 #: guix-git/doc/guix.texi:27615
49673 #, no-wrap
49674 msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat"
49675 msgstr ""
49676
49677 #. type: deftypevr
49678 #: guix-git/doc/guix.texi:27617
49679 msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode."
49680 msgstr ""
49681
49682 #. type: deftypevr
49683 #: guix-git/doc/guix.texi:27622
49684 #, no-wrap
49685 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?"
49686 msgstr ""
49687
49688 #. type: deftypevr
49689 #: guix-git/doc/guix.texi:27624
49690 msgid "Enable CPU turbo boost feature on AC mode."
49691 msgstr ""
49692
49693 #. type: deftypevr
49694 #: guix-git/doc/guix.texi:27629
49695 #, no-wrap
49696 msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?"
49697 msgstr ""
49698
49699 #. type: deftypevr
49700 #: guix-git/doc/guix.texi:27631
49701 msgid "Same as @code{cpu-boost-on-ac?} on BAT mode."
49702 msgstr ""
49703
49704 #. type: deftypevr
49705 #: guix-git/doc/guix.texi:27636
49706 #, no-wrap
49707 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?"
49708 msgstr ""
49709
49710 #. type: deftypevr
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."
49713 msgstr ""
49714
49715 #. type: deftypevr
49716 #: guix-git/doc/guix.texi:27644
49717 #, no-wrap
49718 msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?"
49719 msgstr ""
49720
49721 #. type: deftypevr
49722 #: guix-git/doc/guix.texi:27646
49723 msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode."
49724 msgstr ""
49725
49726 #. type: deftypevr
49727 #: guix-git/doc/guix.texi:27651
49728 #, no-wrap
49729 msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?"
49730 msgstr ""
49731
49732 #. type: deftypevr
49733 #: guix-git/doc/guix.texi:27653
49734 msgid "Enable Linux kernel NMI watchdog."
49735 msgstr ""
49736
49737 #. type: deftypevr
49738 #: guix-git/doc/guix.texi:27658
49739 #, no-wrap
49740 msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls"
49741 msgstr ""
49742
49743 #. type: deftypevr
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\"}."
49746 msgstr ""
49747
49748 #. type: deftypevr
49749 #: guix-git/doc/guix.texi:27666
49750 #, no-wrap
49751 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac"
49752 msgstr ""
49753
49754 #. type: deftypevr
49755 #: guix-git/doc/guix.texi:27669
49756 msgid "Set CPU performance versus energy saving policy on AC@. Alternatives are performance, normal, powersave."
49757 msgstr ""
49758
49759 #. type: deftypevr
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\"}."
49763 msgstr ""
49764
49765 #. type: deftypevr
49766 #: guix-git/doc/guix.texi:27674
49767 #, no-wrap
49768 msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat"
49769 msgstr ""
49770
49771 #. type: deftypevr
49772 #: guix-git/doc/guix.texi:27676
49773 msgid "Same as @code{energy-perf-policy-ac} but on BAT mode."
49774 msgstr ""
49775
49776 #. type: deftypevr
49777 #: guix-git/doc/guix.texi:27678 guix-git/doc/guix.texi:27776
49778 msgid "Defaults to @samp{\"powersave\"}."
49779 msgstr ""
49780
49781 #. type: deftypevr
49782 #: guix-git/doc/guix.texi:27681
49783 #, no-wrap
49784 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices"
49785 msgstr ""
49786
49787 #. type: deftypevr
49788 #: guix-git/doc/guix.texi:27683
49789 msgid "Hard disk devices."
49790 msgstr ""
49791
49792 #. type: deftypevr
49793 #: guix-git/doc/guix.texi:27686
49794 #, no-wrap
49795 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac"
49796 msgstr ""
49797
49798 #. type: deftypevr
49799 #: guix-git/doc/guix.texi:27688
49800 msgid "Hard disk advanced power management level."
49801 msgstr ""
49802
49803 #. type: deftypevr
49804 #: guix-git/doc/guix.texi:27691
49805 #, no-wrap
49806 msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat"
49807 msgstr ""
49808
49809 #. type: deftypevr
49810 #: guix-git/doc/guix.texi:27693
49811 msgid "Same as @code{disk-apm-bat} but on BAT mode."
49812 msgstr ""
49813
49814 #. type: deftypevr
49815 #: guix-git/doc/guix.texi:27696
49816 #, no-wrap
49817 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac"
49818 msgstr ""
49819
49820 #. type: deftypevr
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."
49823 msgstr ""
49824
49825 #. type: deftypevr
49826 #: guix-git/doc/guix.texi:27704
49827 #, no-wrap
49828 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat"
49829 msgstr ""
49830
49831 #. type: deftypevr
49832 #: guix-git/doc/guix.texi:27706
49833 msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode."
49834 msgstr ""
49835
49836 #. type: deftypevr
49837 #: guix-git/doc/guix.texi:27711
49838 #, no-wrap
49839 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched"
49840 msgstr ""
49841
49842 #. type: deftypevr
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."
49845 msgstr ""
49846
49847 #. type: deftypevr
49848 #: guix-git/doc/guix.texi:27720
49849 #, no-wrap
49850 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac"
49851 msgstr ""
49852
49853 #. type: deftypevr
49854 #: guix-git/doc/guix.texi:27723
49855 msgid "SATA aggressive link power management (ALPM) level. Alternatives are min_power, medium_power, max_performance."
49856 msgstr ""
49857
49858 #. type: deftypevr
49859 #: guix-git/doc/guix.texi:27725
49860 msgid "Defaults to @samp{\"max_performance\"}."
49861 msgstr ""
49862
49863 #. type: deftypevr
49864 #: guix-git/doc/guix.texi:27728
49865 #, no-wrap
49866 msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat"
49867 msgstr ""
49868
49869 #. type: deftypevr
49870 #: guix-git/doc/guix.texi:27730
49871 msgid "Same as @code{sata-linkpwr-ac} but on BAT mode."
49872 msgstr ""
49873
49874 #. type: deftypevr
49875 #: guix-git/doc/guix.texi:27732
49876 msgid "Defaults to @samp{\"min_power\"}."
49877 msgstr ""
49878
49879 #. type: deftypevr
49880 #: guix-git/doc/guix.texi:27735
49881 #, no-wrap
49882 msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist"
49883 msgstr ""
49884
49885 #. type: deftypevr
49886 #: guix-git/doc/guix.texi:27737
49887 msgid "Exclude specified SATA host devices for link power management."
49888 msgstr ""
49889
49890 #. type: deftypevr
49891 #: guix-git/doc/guix.texi:27742
49892 #, no-wrap
49893 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?"
49894 msgstr ""
49895
49896 #. type: deftypevr
49897 #: guix-git/doc/guix.texi:27745
49898 msgid "Enable Runtime Power Management for AHCI controller and disks on AC mode."
49899 msgstr ""
49900
49901 #. type: deftypevr
49902 #: guix-git/doc/guix.texi:27750
49903 #, no-wrap
49904 msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?"
49905 msgstr ""
49906
49907 #. type: deftypevr
49908 #: guix-git/doc/guix.texi:27752
49909 msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode."
49910 msgstr ""
49911
49912 #. type: deftypevr
49913 #: guix-git/doc/guix.texi:27757
49914 #, no-wrap
49915 msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout"
49916 msgstr ""
49917
49918 #. type: deftypevr
49919 #: guix-git/doc/guix.texi:27759
49920 msgid "Seconds of inactivity before disk is suspended."
49921 msgstr ""
49922
49923 #. type: deftypevr
49924 #: guix-git/doc/guix.texi:27764
49925 #, no-wrap
49926 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac"
49927 msgstr ""
49928
49929 #. type: deftypevr
49930 #: guix-git/doc/guix.texi:27767
49931 msgid "PCI Express Active State Power Management level. Alternatives are default, performance, powersave."
49932 msgstr ""
49933
49934 #. type: deftypevr
49935 #: guix-git/doc/guix.texi:27772
49936 #, no-wrap
49937 msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat"
49938 msgstr ""
49939
49940 #. type: deftypevr
49941 #: guix-git/doc/guix.texi:27774
49942 msgid "Same as @code{pcie-aspm-ac} but on BAT mode."
49943 msgstr ""
49944
49945 #. type: deftypevr
49946 #: guix-git/doc/guix.texi:27779
49947 #, no-wrap
49948 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac"
49949 msgstr ""
49950
49951 #. type: deftypevr
49952 #: guix-git/doc/guix.texi:27782
49953 msgid "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, default."
49954 msgstr ""
49955
49956 #. type: deftypevr
49957 #: guix-git/doc/guix.texi:27784
49958 msgid "Defaults to @samp{\"high\"}."
49959 msgstr ""
49960
49961 #. type: deftypevr
49962 #: guix-git/doc/guix.texi:27787
49963 #, no-wrap
49964 msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat"
49965 msgstr ""
49966
49967 #. type: deftypevr
49968 #: guix-git/doc/guix.texi:27789
49969 msgid "Same as @code{radeon-power-ac} but on BAT mode."
49970 msgstr ""
49971
49972 #. type: deftypevr
49973 #: guix-git/doc/guix.texi:27791
49974 msgid "Defaults to @samp{\"low\"}."
49975 msgstr ""
49976
49977 #. type: deftypevr
49978 #: guix-git/doc/guix.texi:27794
49979 #, no-wrap
49980 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac"
49981 msgstr ""
49982
49983 #. type: deftypevr
49984 #: guix-git/doc/guix.texi:27797
49985 msgid "Radeon dynamic power management method (DPM). Alternatives are battery, performance."
49986 msgstr ""
49987
49988 #. type: deftypevr
49989 #: guix-git/doc/guix.texi:27802
49990 #, no-wrap
49991 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat"
49992 msgstr ""
49993
49994 #. type: deftypevr
49995 #: guix-git/doc/guix.texi:27804
49996 msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode."
49997 msgstr ""
49998
49999 #. type: deftypevr
50000 #: guix-git/doc/guix.texi:27806
50001 msgid "Defaults to @samp{\"battery\"}."
50002 msgstr ""
50003
50004 #. type: deftypevr
50005 #: guix-git/doc/guix.texi:27809
50006 #, no-wrap
50007 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac"
50008 msgstr ""
50009
50010 #. type: deftypevr
50011 #: guix-git/doc/guix.texi:27811
50012 msgid "Radeon DPM performance level. Alternatives are auto, low, high."
50013 msgstr ""
50014
50015 #. type: deftypevr
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\"}."
50019 msgstr ""
50020
50021 #. type: deftypevr
50022 #: guix-git/doc/guix.texi:27816
50023 #, no-wrap
50024 msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat"
50025 msgstr ""
50026
50027 #. type: deftypevr
50028 #: guix-git/doc/guix.texi:27818
50029 msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode."
50030 msgstr ""
50031
50032 #. type: deftypevr
50033 #: guix-git/doc/guix.texi:27823
50034 #, no-wrap
50035 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?"
50036 msgstr ""
50037
50038 #. type: deftypevr
50039 #: guix-git/doc/guix.texi:27825
50040 msgid "Wifi power saving mode."
50041 msgstr ""
50042
50043 #. type: deftypevr
50044 #: guix-git/doc/guix.texi:27830
50045 #, no-wrap
50046 msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?"
50047 msgstr ""
50048
50049 #. type: deftypevr
50050 #: guix-git/doc/guix.texi:27832
50051 msgid "Same as @code{wifi-power-ac?} but on BAT mode."
50052 msgstr ""
50053
50054 #. type: deftypevr
50055 #: guix-git/doc/guix.texi:27837
50056 #, no-wrap
50057 msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?"
50058 msgstr ""
50059
50060 #. type: deftypevr
50061 #: guix-git/doc/guix.texi:27839
50062 msgid "Disable wake on LAN."
50063 msgstr ""
50064
50065 #. type: deftypevr
50066 #: guix-git/doc/guix.texi:27844
50067 #, no-wrap
50068 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac"
50069 msgstr ""
50070
50071 #. type: deftypevr
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."
50074 msgstr ""
50075
50076 #. type: deftypevr
50077 #: guix-git/doc/guix.texi:27852
50078 #, no-wrap
50079 msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat"
50080 msgstr ""
50081
50082 #. type: deftypevr
50083 #: guix-git/doc/guix.texi:27854
50084 msgid "Same as @code{sound-powersave-ac} but on BAT mode."
50085 msgstr ""
50086
50087 #. type: deftypevr
50088 #: guix-git/doc/guix.texi:27859
50089 #, no-wrap
50090 msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?"
50091 msgstr ""
50092
50093 #. type: deftypevr
50094 #: guix-git/doc/guix.texi:27861
50095 msgid "Disable controller in powersaving mode on Intel HDA devices."
50096 msgstr ""
50097
50098 #. type: deftypevr
50099 #: guix-git/doc/guix.texi:27866
50100 #, no-wrap
50101 msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?"
50102 msgstr ""
50103
50104 #. type: deftypevr
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."
50107 msgstr ""
50108
50109 #. type: deftypevr
50110 #: guix-git/doc/guix.texi:27875
50111 #, no-wrap
50112 msgid "{@code{tlp-configuration} parameter} string bay-device"
50113 msgstr ""
50114
50115 #. type: deftypevr
50116 #: guix-git/doc/guix.texi:27877
50117 msgid "Name of the optical drive device to power off."
50118 msgstr ""
50119
50120 #. type: deftypevr
50121 #: guix-git/doc/guix.texi:27879
50122 msgid "Defaults to @samp{\"sr0\"}."
50123 msgstr ""
50124
50125 #. type: deftypevr
50126 #: guix-git/doc/guix.texi:27882
50127 #, no-wrap
50128 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac"
50129 msgstr ""
50130
50131 #. type: deftypevr
50132 #: guix-git/doc/guix.texi:27885
50133 msgid "Runtime Power Management for PCI(e) bus devices. Alternatives are on and auto."
50134 msgstr ""
50135
50136 #. type: deftypevr
50137 #: guix-git/doc/guix.texi:27887
50138 msgid "Defaults to @samp{\"on\"}."
50139 msgstr ""
50140
50141 #. type: deftypevr
50142 #: guix-git/doc/guix.texi:27890
50143 #, no-wrap
50144 msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat"
50145 msgstr ""
50146
50147 #. type: deftypevr
50148 #: guix-git/doc/guix.texi:27892
50149 msgid "Same as @code{runtime-pm-ac} but on BAT mode."
50150 msgstr ""
50151
50152 #. type: deftypevr
50153 #: guix-git/doc/guix.texi:27897
50154 #, no-wrap
50155 msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?"
50156 msgstr ""
50157
50158 #. type: deftypevr
50159 #: guix-git/doc/guix.texi:27900
50160 msgid "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones."
50161 msgstr ""
50162
50163 #. type: deftypevr
50164 #: guix-git/doc/guix.texi:27905
50165 #, no-wrap
50166 msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist"
50167 msgstr ""
50168
50169 #. type: deftypevr
50170 #: guix-git/doc/guix.texi:27907
50171 msgid "Exclude specified PCI(e) device addresses from Runtime Power Management."
50172 msgstr ""
50173
50174 #. type: deftypevr
50175 #: guix-git/doc/guix.texi:27912
50176 #, no-wrap
50177 msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist"
50178 msgstr ""
50179
50180 #. type: deftypevr
50181 #: guix-git/doc/guix.texi:27915
50182 msgid "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management."
50183 msgstr ""
50184
50185 #. type: deftypevr
50186 #: guix-git/doc/guix.texi:27918
50187 #, no-wrap
50188 msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?"
50189 msgstr ""
50190
50191 #. type: deftypevr
50192 #: guix-git/doc/guix.texi:27920
50193 msgid "Enable USB autosuspend feature."
50194 msgstr ""
50195
50196 #. type: deftypevr
50197 #: guix-git/doc/guix.texi:27925
50198 #, no-wrap
50199 msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist"
50200 msgstr ""
50201
50202 #. type: deftypevr
50203 #: guix-git/doc/guix.texi:27927
50204 msgid "Exclude specified devices from USB autosuspend."
50205 msgstr ""
50206
50207 #. type: deftypevr
50208 #: guix-git/doc/guix.texi:27932
50209 #, no-wrap
50210 msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?"
50211 msgstr ""
50212
50213 #. type: deftypevr
50214 #: guix-git/doc/guix.texi:27934
50215 msgid "Exclude WWAN devices from USB autosuspend."
50216 msgstr ""
50217
50218 #. type: deftypevr
50219 #: guix-git/doc/guix.texi:27939
50220 #, no-wrap
50221 msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist"
50222 msgstr ""
50223
50224 #. type: deftypevr
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?}."
50227 msgstr ""
50228
50229 #. type: deftypevr
50230 #: guix-git/doc/guix.texi:27947
50231 #, no-wrap
50232 msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?"
50233 msgstr ""
50234
50235 #. type: deftypevr
50236 #: guix-git/doc/guix.texi:27949
50237 msgid "Enable USB autosuspend before shutdown."
50238 msgstr ""
50239
50240 #. type: deftypevr
50241 #: guix-git/doc/guix.texi:27954
50242 #, no-wrap
50243 msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?"
50244 msgstr ""
50245
50246 #. type: deftypevr
50247 #: guix-git/doc/guix.texi:27957
50248 msgid "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup."
50249 msgstr ""
50250
50251 #. type: cindex
50252 #: guix-git/doc/guix.texi:27962
50253 #, no-wrap
50254 msgid "thermald"
50255 msgstr ""
50256
50257 #. type: cindex
50258 #: guix-git/doc/guix.texi:27963
50259 #, no-wrap
50260 msgid "CPU frequency scaling with thermald"
50261 msgstr ""
50262
50263 #. type: subsubheading
50264 #: guix-git/doc/guix.texi:27964
50265 #, no-wrap
50266 msgid "Thermald daemon"
50267 msgstr ""
50268
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."
50272 msgstr ""
50273
50274 #. type: defvr
50275 #: guix-git/doc/guix.texi:27969
50276 #, no-wrap
50277 msgid "{Scheme Variable} thermald-service-type"
50278 msgstr ""
50279
50280 #. type: defvr
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."
50283 msgstr ""
50284
50285 #. type: deftp
50286 #: guix-git/doc/guix.texi:27976
50287 #, no-wrap
50288 msgid "{Data Type} thermald-configuration"
50289 msgstr ""
50290
50291 #. type: deftp
50292 #: guix-git/doc/guix.texi:27978
50293 msgid "Data type representing the configuration of @code{thermald-service-type}."
50294 msgstr ""
50295
50296 #. type: item
50297 #: guix-git/doc/guix.texi:27980
50298 #, no-wrap
50299 msgid "@code{ignore-cpuid-check?} (default: @code{#f})"
50300 msgstr ""
50301
50302 #. type: table
50303 #: guix-git/doc/guix.texi:27982
50304 msgid "Ignore cpuid check for supported CPU models."
50305 msgstr ""
50306
50307 #. type: item
50308 #: guix-git/doc/guix.texi:27983
50309 #, no-wrap
50310 msgid "@code{thermald} (default: @var{thermald})"
50311 msgstr ""
50312
50313 #. type: table
50314 #: guix-git/doc/guix.texi:27985
50315 msgid "Package object of thermald."
50316 msgstr ""
50317
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)."
50321 msgstr ""
50322
50323 #. type: cindex
50324 #: guix-git/doc/guix.texi:27995
50325 #, no-wrap
50326 msgid "mpd"
50327 msgstr ""
50328
50329 #. type: subsubheading
50330 #: guix-git/doc/guix.texi:27996
50331 #, no-wrap
50332 msgid "Music Player Daemon"
50333 msgstr ""
50334
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."
50338 msgstr ""
50339
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."
50343 msgstr ""
50344
50345 #. type: lisp
50346 #: guix-git/doc/guix.texi:28010
50347 #, no-wrap
50348 msgid ""
50349 "(service mpd-service-type\n"
50350 " (mpd-configuration\n"
50351 " (user \"bob\")\n"
50352 " (port \"6666\")))\n"
50353 msgstr ""
50354
50355 #. type: defvr
50356 #: guix-git/doc/guix.texi:28012
50357 #, no-wrap
50358 msgid "{Scheme Variable} mpd-service-type"
50359 msgstr ""
50360
50361 #. type: defvr
50362 #: guix-git/doc/guix.texi:28014
50363 msgid "The service type for @command{mpd}"
50364 msgstr ""
50365
50366 #. type: deftp
50367 #: guix-git/doc/guix.texi:28016
50368 #, no-wrap
50369 msgid "{Data Type} mpd-configuration"
50370 msgstr ""
50371
50372 #. type: deftp
50373 #: guix-git/doc/guix.texi:28018
50374 msgid "Data type representing the configuration of @command{mpd}."
50375 msgstr ""
50376
50377 #. type: item
50378 #: guix-git/doc/guix.texi:28020
50379 #, no-wrap
50380 msgid "@code{user} (default: @code{\"mpd\"})"
50381 msgstr ""
50382
50383 #. type: table
50384 #: guix-git/doc/guix.texi:28022
50385 msgid "The user to run mpd as."
50386 msgstr ""
50387
50388 #. type: item
50389 #: guix-git/doc/guix.texi:28023
50390 #, no-wrap
50391 msgid "@code{music-dir} (default: @code{\"~/Music\"})"
50392 msgstr ""
50393
50394 #. type: table
50395 #: guix-git/doc/guix.texi:28025
50396 msgid "The directory to scan for music files."
50397 msgstr ""
50398
50399 #. type: item
50400 #: guix-git/doc/guix.texi:28026
50401 #, no-wrap
50402 msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})"
50403 msgstr ""
50404
50405 #. type: table
50406 #: guix-git/doc/guix.texi:28028
50407 msgid "The directory to store playlists."
50408 msgstr ""
50409
50410 #. type: item
50411 #: guix-git/doc/guix.texi:28029
50412 #, no-wrap
50413 msgid "@code{db-file} (default: @code{\"~/.mpd/tag_cache\"})"
50414 msgstr ""
50415
50416 #. type: table
50417 #: guix-git/doc/guix.texi:28031
50418 msgid "The location of the music database."
50419 msgstr ""
50420
50421 #. type: item
50422 #: guix-git/doc/guix.texi:28032
50423 #, no-wrap
50424 msgid "@code{state-file} (default: @code{\"~/.mpd/state\"})"
50425 msgstr ""
50426
50427 #. type: table
50428 #: guix-git/doc/guix.texi:28034
50429 msgid "The location of the file that stores current MPD's state."
50430 msgstr ""
50431
50432 #. type: item
50433 #: guix-git/doc/guix.texi:28035
50434 #, no-wrap
50435 msgid "@code{sticker-file} (default: @code{\"~/.mpd/sticker.sql\"})"
50436 msgstr ""
50437
50438 #. type: table
50439 #: guix-git/doc/guix.texi:28037
50440 msgid "The location of the sticker database."
50441 msgstr ""
50442
50443 #. type: item
50444 #: guix-git/doc/guix.texi:28038
50445 #, no-wrap
50446 msgid "@code{port} (default: @code{\"6600\"})"
50447 msgstr ""
50448
50449 #. type: table
50450 #: guix-git/doc/guix.texi:28040
50451 msgid "The port to run mpd on."
50452 msgstr ""
50453
50454 #. type: item
50455 #: guix-git/doc/guix.texi:28041
50456 #, no-wrap
50457 msgid "@code{address} (default: @code{\"any\"})"
50458 msgstr ""
50459
50460 #. type: table
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."
50463 msgstr ""
50464
50465 #. type: item
50466 #: guix-git/doc/guix.texi:28045
50467 #, no-wrap
50468 msgid "@code{outputs} (default: @code{\"(list (mpd-output))\"})"
50469 msgstr ""
50470
50471 #. type: table
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."
50474 msgstr ""
50475
50476 #. type: deftp
50477 #: guix-git/doc/guix.texi:28051
50478 #, no-wrap
50479 msgid "{Data Type} mpd-output"
50480 msgstr ""
50481
50482 #. type: deftp
50483 #: guix-git/doc/guix.texi:28053
50484 msgid "Data type representing an @command{mpd} audio output."
50485 msgstr ""
50486
50487 #. type: item
50488 #: guix-git/doc/guix.texi:28055
50489 #, no-wrap
50490 msgid "@code{name} (default: @code{\"MPD\"})"
50491 msgstr ""
50492
50493 #. type: table
50494 #: guix-git/doc/guix.texi:28057
50495 msgid "The name of the audio output."
50496 msgstr ""
50497
50498 #. type: item
50499 #: guix-git/doc/guix.texi:28058
50500 #, no-wrap
50501 msgid "@code{type} (default: @code{\"pulse\"})"
50502 msgstr ""
50503
50504 #. type: table
50505 #: guix-git/doc/guix.texi:28060
50506 msgid "The type of audio output."
50507 msgstr ""
50508
50509 #. type: item
50510 #: guix-git/doc/guix.texi:28061
50511 #, no-wrap
50512 msgid "@code{enabled?} (default: @code{#t})"
50513 msgstr ""
50514
50515 #. type: table
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."
50518 msgstr ""
50519
50520 #. type: item
50521 #: guix-git/doc/guix.texi:28067
50522 #, no-wrap
50523 msgid "@code{tags?} (default: @code{#t})"
50524 msgstr ""
50525
50526 #. type: table
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."
50529 msgstr ""
50530
50531 #. type: item
50532 #: guix-git/doc/guix.texi:28072
50533 #, no-wrap
50534 msgid "@code{always-on?} (default: @code{#f})"
50535 msgstr ""
50536
50537 #. type: table
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."
50540 msgstr ""
50541
50542 #. type: code{#1}
50543 #: guix-git/doc/guix.texi:28077
50544 #, no-wrap
50545 msgid "mixer-type"
50546 msgstr ""
50547
50548 #. type: table
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})."
50551 msgstr ""
50552
50553 #. type: table
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."
50556 msgstr ""
50557
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."
50561 msgstr ""
50562
50563 #. type: lisp
50564 #: guix-git/doc/guix.texi:28105
50565 #, no-wrap
50566 msgid ""
50567 "(service mpd-service-type\n"
50568 " (mpd-configuration\n"
50569 " (outputs\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"
50577 msgstr ""
50578
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."
50582 msgstr ""
50583
50584 #. type: subsubheading
50585 #: guix-git/doc/guix.texi:28115
50586 #, no-wrap
50587 msgid "Libvirt daemon"
50588 msgstr ""
50589
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."
50593 msgstr ""
50594
50595 #. type: deffn
50596 #: guix-git/doc/guix.texi:28121
50597 #, no-wrap
50598 msgid "{Scheme Variable} libvirt-service-type"
50599 msgstr ""
50600
50601 #. type: deffn
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}."
50604 msgstr ""
50605
50606 #. type: lisp
50607 #: guix-git/doc/guix.texi:28130
50608 #, no-wrap
50609 msgid ""
50610 "(service libvirt-service-type\n"
50611 " (libvirt-configuration\n"
50612 " (unix-sock-group \"libvirt\")\n"
50613 " (tls-port \"16555\")))\n"
50614 msgstr ""
50615
50616 #. type: Plain text
50617 #: guix-git/doc/guix.texi:28135
50618 msgid "Available @code{libvirt-configuration} fields are:"
50619 msgstr ""
50620
50621 #. type: deftypevr
50622 #: guix-git/doc/guix.texi:28136
50623 #, no-wrap
50624 msgid "{@code{libvirt-configuration} parameter} package libvirt"
50625 msgstr ""
50626
50627 #. type: deftypevr
50628 #: guix-git/doc/guix.texi:28138
50629 msgid "Libvirt package."
50630 msgstr ""
50631
50632 #. type: deftypevr
50633 #: guix-git/doc/guix.texi:28141
50634 #, no-wrap
50635 msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?"
50636 msgstr ""
50637
50638 #. type: deftypevr
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."
50641 msgstr ""
50642
50643 #. type: deftypevr
50644 #: guix-git/doc/guix.texi:28147
50645 msgid "It is necessary to setup a CA and issue server certificates before using this capability."
50646 msgstr ""
50647
50648 #. type: deftypevr
50649 #: guix-git/doc/guix.texi:28152
50650 #, no-wrap
50651 msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?"
50652 msgstr ""
50653
50654 #. type: deftypevr
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."
50657 msgstr ""
50658
50659 #. type: deftypevr
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)."
50662 msgstr ""
50663
50664 #. type: deftypevr
50665 #: guix-git/doc/guix.texi:28164
50666 #, no-wrap
50667 msgid "{@code{libvirt-configuration} parameter} string tls-port"
50668 msgstr ""
50669
50670 #. type: deftypevr
50671 #: guix-git/doc/guix.texi:28167
50672 msgid "Port for accepting secure TLS connections. This can be a port number, or service name."
50673 msgstr ""
50674
50675 #. type: deftypevr
50676 #: guix-git/doc/guix.texi:28169
50677 msgid "Defaults to @samp{\"16514\"}."
50678 msgstr ""
50679
50680 #. type: deftypevr
50681 #: guix-git/doc/guix.texi:28172
50682 #, no-wrap
50683 msgid "{@code{libvirt-configuration} parameter} string tcp-port"
50684 msgstr ""
50685
50686 #. type: deftypevr
50687 #: guix-git/doc/guix.texi:28175
50688 msgid "Port for accepting insecure TCP connections. This can be a port number, or service name."
50689 msgstr ""
50690
50691 #. type: deftypevr
50692 #: guix-git/doc/guix.texi:28177
50693 msgid "Defaults to @samp{\"16509\"}."
50694 msgstr ""
50695
50696 #. type: deftypevr
50697 #: guix-git/doc/guix.texi:28180
50698 #, no-wrap
50699 msgid "{@code{libvirt-configuration} parameter} string listen-addr"
50700 msgstr ""
50701
50702 #. type: deftypevr
50703 #: guix-git/doc/guix.texi:28182
50704 msgid "IP address or hostname used for client connections."
50705 msgstr ""
50706
50707 #. type: deftypevr
50708 #: guix-git/doc/guix.texi:28187
50709 #, no-wrap
50710 msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?"
50711 msgstr ""
50712
50713 #. type: deftypevr
50714 #: guix-git/doc/guix.texi:28189
50715 msgid "Flag toggling mDNS advertisement of the libvirt service."
50716 msgstr ""
50717
50718 #. type: deftypevr
50719 #: guix-git/doc/guix.texi:28192
50720 msgid "Alternatively can disable for all services on a host by stopping the Avahi daemon."
50721 msgstr ""
50722
50723 #. type: deftypevr
50724 #: guix-git/doc/guix.texi:28197
50725 #, no-wrap
50726 msgid "{@code{libvirt-configuration} parameter} string mdns-name"
50727 msgstr ""
50728
50729 #. type: deftypevr
50730 #: guix-git/doc/guix.texi:28200
50731 msgid "Default mDNS advertisement name. This must be unique on the immediate broadcast network."
50732 msgstr ""
50733
50734 #. type: deftypevr
50735 #: guix-git/doc/guix.texi:28202
50736 msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}."
50737 msgstr ""
50738
50739 #. type: deftypevr
50740 #: guix-git/doc/guix.texi:28205
50741 #, no-wrap
50742 msgid "{@code{libvirt-configuration} parameter} string unix-sock-group"
50743 msgstr ""
50744
50745 #. type: deftypevr
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."
50748 msgstr ""
50749
50750 #. type: deftypevr
50751 #: guix-git/doc/guix.texi:28214
50752 #, no-wrap
50753 msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms"
50754 msgstr ""
50755
50756 #. type: deftypevr
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."
50759 msgstr ""
50760
50761 #. type: deftypevr
50762 #: guix-git/doc/guix.texi:28219 guix-git/doc/guix.texi:28237
50763 msgid "Defaults to @samp{\"0777\"}."
50764 msgstr ""
50765
50766 #. type: deftypevr
50767 #: guix-git/doc/guix.texi:28222
50768 #, no-wrap
50769 msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms"
50770 msgstr ""
50771
50772 #. type: deftypevr
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)"
50775 msgstr ""
50776
50777 #. type: deftypevr
50778 #: guix-git/doc/guix.texi:28228
50779 msgid "Defaults to @samp{\"0770\"}."
50780 msgstr ""
50781
50782 #. type: deftypevr
50783 #: guix-git/doc/guix.texi:28231
50784 #, no-wrap
50785 msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms"
50786 msgstr ""
50787
50788 #. type: deftypevr
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."
50791 msgstr ""
50792
50793 #. type: deftypevr
50794 #: guix-git/doc/guix.texi:28240
50795 #, no-wrap
50796 msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir"
50797 msgstr ""
50798
50799 #. type: deftypevr
50800 #: guix-git/doc/guix.texi:28242
50801 msgid "The directory in which sockets will be found/created."
50802 msgstr ""
50803
50804 #. type: deftypevr
50805 #: guix-git/doc/guix.texi:28244
50806 msgid "Defaults to @samp{\"/var/run/libvirt\"}."
50807 msgstr ""
50808
50809 #. type: deftypevr
50810 #: guix-git/doc/guix.texi:28247
50811 #, no-wrap
50812 msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro"
50813 msgstr ""
50814
50815 #. type: deftypevr
50816 #: guix-git/doc/guix.texi:28250
50817 msgid "Authentication scheme for UNIX read-only sockets. By default socket permissions allow anyone to connect"
50818 msgstr ""
50819
50820 #. type: deftypevr
50821 #: guix-git/doc/guix.texi:28252 guix-git/doc/guix.texi:28261
50822 msgid "Defaults to @samp{\"polkit\"}."
50823 msgstr ""
50824
50825 #. type: deftypevr
50826 #: guix-git/doc/guix.texi:28255
50827 #, no-wrap
50828 msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw"
50829 msgstr ""
50830
50831 #. type: deftypevr
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."
50834 msgstr ""
50835
50836 #. type: deftypevr
50837 #: guix-git/doc/guix.texi:28264
50838 #, no-wrap
50839 msgid "{@code{libvirt-configuration} parameter} string auth-tcp"
50840 msgstr ""
50841
50842 #. type: deftypevr
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."
50845 msgstr ""
50846
50847 #. type: deftypevr
50848 #: guix-git/doc/guix.texi:28270
50849 msgid "Defaults to @samp{\"sasl\"}."
50850 msgstr ""
50851
50852 #. type: deftypevr
50853 #: guix-git/doc/guix.texi:28273
50854 #, no-wrap
50855 msgid "{@code{libvirt-configuration} parameter} string auth-tls"
50856 msgstr ""
50857
50858 #. type: deftypevr
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."
50861 msgstr ""
50862
50863 #. type: deftypevr
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"
50866 msgstr ""
50867
50868 #. type: deftypevr
50869 #: guix-git/doc/guix.texi:28282
50870 msgid "Defaults to @samp{\"none\"}."
50871 msgstr ""
50872
50873 #. type: deftypevr
50874 #: guix-git/doc/guix.texi:28285
50875 #, no-wrap
50876 msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers"
50877 msgstr ""
50878
50879 #. type: deftypevr
50880 #: guix-git/doc/guix.texi:28287
50881 msgid "API access control scheme."
50882 msgstr ""
50883
50884 #. type: deftypevr
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."
50887 msgstr ""
50888
50889 #. type: deftypevr
50890 #: guix-git/doc/guix.texi:28295
50891 #, no-wrap
50892 msgid "{@code{libvirt-configuration} parameter} string key-file"
50893 msgstr ""
50894
50895 #. type: deftypevr
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."
50898 msgstr ""
50899
50900 #. type: deftypevr
50901 #: guix-git/doc/guix.texi:28303
50902 #, no-wrap
50903 msgid "{@code{libvirt-configuration} parameter} string cert-file"
50904 msgstr ""
50905
50906 #. type: deftypevr
50907 #: guix-git/doc/guix.texi:28306
50908 msgid "Server key file path. If set to an empty string, then no certificate is loaded."
50909 msgstr ""
50910
50911 #. type: deftypevr
50912 #: guix-git/doc/guix.texi:28311
50913 #, no-wrap
50914 msgid "{@code{libvirt-configuration} parameter} string ca-file"
50915 msgstr ""
50916
50917 #. type: deftypevr
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."
50920 msgstr ""
50921
50922 #. type: deftypevr
50923 #: guix-git/doc/guix.texi:28319
50924 #, no-wrap
50925 msgid "{@code{libvirt-configuration} parameter} string crl-file"
50926 msgstr ""
50927
50928 #. type: deftypevr
50929 #: guix-git/doc/guix.texi:28322
50930 msgid "Certificate revocation list path. If set to an empty string, then no CRL is loaded."
50931 msgstr ""
50932
50933 #. type: deftypevr
50934 #: guix-git/doc/guix.texi:28327
50935 #, no-wrap
50936 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert"
50937 msgstr ""
50938
50939 #. type: deftypevr
50940 #: guix-git/doc/guix.texi:28329
50941 msgid "Disable verification of our own server certificates."
50942 msgstr ""
50943
50944 #. type: deftypevr
50945 #: guix-git/doc/guix.texi:28332
50946 msgid "When libvirtd starts it performs some sanity checks against its own certificates."
50947 msgstr ""
50948
50949 #. type: deftypevr
50950 #: guix-git/doc/guix.texi:28337
50951 #, no-wrap
50952 msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert"
50953 msgstr ""
50954
50955 #. type: deftypevr
50956 #: guix-git/doc/guix.texi:28339
50957 msgid "Disable verification of client certificates."
50958 msgstr ""
50959
50960 #. type: deftypevr
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."
50963 msgstr ""
50964
50965 #. type: deftypevr
50966 #: guix-git/doc/guix.texi:28348
50967 #, no-wrap
50968 msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list"
50969 msgstr ""
50970
50971 #. type: deftypevr
50972 #: guix-git/doc/guix.texi:28350
50973 msgid "Whitelist of allowed x509 Distinguished Name."
50974 msgstr ""
50975
50976 #. type: deftypevr
50977 #: guix-git/doc/guix.texi:28355
50978 #, no-wrap
50979 msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames"
50980 msgstr ""
50981
50982 #. type: deftypevr
50983 #: guix-git/doc/guix.texi:28358
50984 msgid "Whitelist of allowed SASL usernames. The format for username depends on the SASL authentication mechanism."
50985 msgstr ""
50986
50987 #. type: deftypevr
50988 #: guix-git/doc/guix.texi:28363
50989 #, no-wrap
50990 msgid "{@code{libvirt-configuration} parameter} string tls-priority"
50991 msgstr ""
50992
50993 #. type: deftypevr
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."
50996 msgstr ""
50997
50998 #. type: deftypevr
50999 #: guix-git/doc/guix.texi:28369
51000 msgid "Defaults to @samp{\"NORMAL\"}."
51001 msgstr ""
51002
51003 #. type: deftypevr
51004 #: guix-git/doc/guix.texi:28372
51005 #, no-wrap
51006 msgid "{@code{libvirt-configuration} parameter} integer max-clients"
51007 msgstr ""
51008
51009 #. type: deftypevr
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."
51012 msgstr ""
51013
51014 #. type: deftypevr
51015 #: guix-git/doc/guix.texi:28377
51016 msgid "Defaults to @samp{5000}."
51017 msgstr ""
51018
51019 #. type: deftypevr
51020 #: guix-git/doc/guix.texi:28380
51021 #, no-wrap
51022 msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients"
51023 msgstr ""
51024
51025 #. type: deftypevr
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."
51028 msgstr ""
51029
51030 #. type: deftypevr
51031 #: guix-git/doc/guix.texi:28389
51032 #, no-wrap
51033 msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients"
51034 msgstr ""
51035
51036 #. type: deftypevr
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"
51039 msgstr ""
51040
51041 #. type: deftypevr
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}."
51045 msgstr ""
51046
51047 #. type: deftypevr
51048 #: guix-git/doc/guix.texi:28397
51049 #, no-wrap
51050 msgid "{@code{libvirt-configuration} parameter} integer min-workers"
51051 msgstr ""
51052
51053 #. type: deftypevr
51054 #: guix-git/doc/guix.texi:28399
51055 msgid "Number of workers to start up initially."
51056 msgstr ""
51057
51058 #. type: deftypevr
51059 #: guix-git/doc/guix.texi:28404
51060 #, no-wrap
51061 msgid "{@code{libvirt-configuration} parameter} integer max-workers"
51062 msgstr ""
51063
51064 #. type: deftypevr
51065 #: guix-git/doc/guix.texi:28406
51066 msgid "Maximum number of worker threads."
51067 msgstr ""
51068
51069 #. type: deftypevr
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."
51072 msgstr ""
51073
51074 #. type: deftypevr
51075 #: guix-git/doc/guix.texi:28415
51076 #, no-wrap
51077 msgid "{@code{libvirt-configuration} parameter} integer prio-workers"
51078 msgstr ""
51079
51080 #. type: deftypevr
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."
51083 msgstr ""
51084
51085 #. type: deftypevr
51086 #: guix-git/doc/guix.texi:28424
51087 #, no-wrap
51088 msgid "{@code{libvirt-configuration} parameter} integer max-requests"
51089 msgstr ""
51090
51091 #. type: deftypevr
51092 #: guix-git/doc/guix.texi:28426
51093 msgid "Total global limit on concurrent RPC calls."
51094 msgstr ""
51095
51096 #. type: deftypevr
51097 #: guix-git/doc/guix.texi:28431
51098 #, no-wrap
51099 msgid "{@code{libvirt-configuration} parameter} integer max-client-requests"
51100 msgstr ""
51101
51102 #. type: deftypevr
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."
51105 msgstr ""
51106
51107 #. type: deftypevr
51108 #: guix-git/doc/guix.texi:28440
51109 #, no-wrap
51110 msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers"
51111 msgstr ""
51112
51113 #. type: deftypevr
51114 #: guix-git/doc/guix.texi:28442
51115 msgid "Same as @code{min-workers} but for the admin interface."
51116 msgstr ""
51117
51118 #. type: deftypevr
51119 #: guix-git/doc/guix.texi:28447
51120 #, no-wrap
51121 msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers"
51122 msgstr ""
51123
51124 #. type: deftypevr
51125 #: guix-git/doc/guix.texi:28449
51126 msgid "Same as @code{max-workers} but for the admin interface."
51127 msgstr ""
51128
51129 #. type: deftypevr
51130 #: guix-git/doc/guix.texi:28454
51131 #, no-wrap
51132 msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients"
51133 msgstr ""
51134
51135 #. type: deftypevr
51136 #: guix-git/doc/guix.texi:28456
51137 msgid "Same as @code{max-clients} but for the admin interface."
51138 msgstr ""
51139
51140 #. type: deftypevr
51141 #: guix-git/doc/guix.texi:28461
51142 #, no-wrap
51143 msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients"
51144 msgstr ""
51145
51146 #. type: deftypevr
51147 #: guix-git/doc/guix.texi:28463
51148 msgid "Same as @code{max-queued-clients} but for the admin interface."
51149 msgstr ""
51150
51151 #. type: deftypevr
51152 #: guix-git/doc/guix.texi:28468
51153 #, no-wrap
51154 msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests"
51155 msgstr ""
51156
51157 #. type: deftypevr
51158 #: guix-git/doc/guix.texi:28470
51159 msgid "Same as @code{max-client-requests} but for the admin interface."
51160 msgstr ""
51161
51162 #. type: deftypevr
51163 #: guix-git/doc/guix.texi:28475
51164 #, no-wrap
51165 msgid "{@code{libvirt-configuration} parameter} integer log-level"
51166 msgstr ""
51167
51168 #. type: deftypevr
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."
51171 msgstr ""
51172
51173 #. type: deftypevr
51174 #: guix-git/doc/guix.texi:28482
51175 #, no-wrap
51176 msgid "{@code{libvirt-configuration} parameter} string log-filters"
51177 msgstr ""
51178
51179 #. type: deftypevr
51180 #: guix-git/doc/guix.texi:28484 guix-git/doc/guix.texi:28708
51181 msgid "Logging filters."
51182 msgstr ""
51183
51184 #. type: deftypevr
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:"
51187 msgstr ""
51188
51189 #. type: itemize
51190 #: guix-git/doc/guix.texi:28491 guix-git/doc/guix.texi:28715
51191 msgid "x:name"
51192 msgstr ""
51193
51194 #. type: itemize
51195 #: guix-git/doc/guix.texi:28494 guix-git/doc/guix.texi:28718
51196 msgid "x:+name"
51197 msgstr ""
51198
51199 #. type: deftypevr
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:"
51202 msgstr ""
51203
51204 #. type: itemize
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
51207 msgid "1: DEBUG"
51208 msgstr ""
51209
51210 #. type: itemize
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
51213 msgid "2: INFO"
51214 msgstr ""
51215
51216 #. type: itemize
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
51219 msgid "3: WARNING"
51220 msgstr ""
51221
51222 #. type: itemize
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
51225 msgid "4: ERROR"
51226 msgstr ""
51227
51228 #. type: deftypevr
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."
51231 msgstr ""
51232
51233 #. type: deftypevr
51234 #: guix-git/doc/guix.texi:28525 guix-git/doc/guix.texi:28748
51235 msgid "Defaults to @samp{\"3:remote 4:event\"}."
51236 msgstr ""
51237
51238 #. type: deftypevr
51239 #: guix-git/doc/guix.texi:28528
51240 #, no-wrap
51241 msgid "{@code{libvirt-configuration} parameter} string log-outputs"
51242 msgstr ""
51243
51244 #. type: deftypevr
51245 #: guix-git/doc/guix.texi:28530 guix-git/doc/guix.texi:28753
51246 msgid "Logging outputs."
51247 msgstr ""
51248
51249 #. type: deftypevr
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:"
51252 msgstr ""
51253
51254 #. type: item
51255 #: guix-git/doc/guix.texi:28535 guix-git/doc/guix.texi:28758
51256 #, no-wrap
51257 msgid "x:stderr"
51258 msgstr ""
51259
51260 #. type: table
51261 #: guix-git/doc/guix.texi:28537 guix-git/doc/guix.texi:28760
51262 msgid "output goes to stderr"
51263 msgstr ""
51264
51265 #. type: item
51266 #: guix-git/doc/guix.texi:28538 guix-git/doc/guix.texi:28761
51267 #, no-wrap
51268 msgid "x:syslog:name"
51269 msgstr ""
51270
51271 #. type: table
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"
51274 msgstr ""
51275
51276 #. type: item
51277 #: guix-git/doc/guix.texi:28541 guix-git/doc/guix.texi:28764
51278 #, no-wrap
51279 msgid "x:file:file_path"
51280 msgstr ""
51281
51282 #. type: table
51283 #: guix-git/doc/guix.texi:28543 guix-git/doc/guix.texi:28766
51284 msgid "output to a file, with the given filepath"
51285 msgstr ""
51286
51287 #. type: item
51288 #: guix-git/doc/guix.texi:28544 guix-git/doc/guix.texi:28767
51289 #, no-wrap
51290 msgid "x:journald"
51291 msgstr ""
51292
51293 #. type: table
51294 #: guix-git/doc/guix.texi:28546 guix-git/doc/guix.texi:28769
51295 msgid "output to journald logging system"
51296 msgstr ""
51297
51298 #. type: deftypevr
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"
51301 msgstr ""
51302
51303 #. type: deftypevr
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."
51306 msgstr ""
51307
51308 #. type: deftypevr
51309 #: guix-git/doc/guix.texi:28570 guix-git/doc/guix.texi:28793
51310 msgid "Defaults to @samp{\"3:stderr\"}."
51311 msgstr ""
51312
51313 #. type: deftypevr
51314 #: guix-git/doc/guix.texi:28573
51315 #, no-wrap
51316 msgid "{@code{libvirt-configuration} parameter} integer audit-level"
51317 msgstr ""
51318
51319 #. type: deftypevr
51320 #: guix-git/doc/guix.texi:28575
51321 msgid "Allows usage of the auditing subsystem to be altered"
51322 msgstr ""
51323
51324 #. type: itemize
51325 #: guix-git/doc/guix.texi:28579
51326 msgid "0: disable all auditing"
51327 msgstr ""
51328
51329 #. type: itemize
51330 #: guix-git/doc/guix.texi:28582
51331 msgid "1: enable auditing, only if enabled on host"
51332 msgstr ""
51333
51334 #. type: itemize
51335 #: guix-git/doc/guix.texi:28585
51336 msgid "2: enable auditing, and exit if disabled on host."
51337 msgstr ""
51338
51339 #. type: deftypevr
51340 #: guix-git/doc/guix.texi:28592
51341 #, no-wrap
51342 msgid "{@code{libvirt-configuration} parameter} boolean audit-logging"
51343 msgstr ""
51344
51345 #. type: deftypevr
51346 #: guix-git/doc/guix.texi:28594
51347 msgid "Send audit messages via libvirt logging infrastructure."
51348 msgstr ""
51349
51350 #. type: deftypevr
51351 #: guix-git/doc/guix.texi:28599
51352 #, no-wrap
51353 msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid"
51354 msgstr ""
51355
51356 #. type: deftypevr
51357 #: guix-git/doc/guix.texi:28601
51358 msgid "Host UUID@. UUID must not have all digits be the same."
51359 msgstr ""
51360
51361 #. type: deftypevr
51362 #: guix-git/doc/guix.texi:28606
51363 #, no-wrap
51364 msgid "{@code{libvirt-configuration} parameter} string host-uuid-source"
51365 msgstr ""
51366
51367 #. type: deftypevr
51368 #: guix-git/doc/guix.texi:28608
51369 msgid "Source to read host UUID."
51370 msgstr ""
51371
51372 #. type: itemize
51373 #: guix-git/doc/guix.texi:28612
51374 msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}"
51375 msgstr ""
51376
51377 #. type: itemize
51378 #: guix-git/doc/guix.texi:28615
51379 msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}"
51380 msgstr ""
51381
51382 #. type: deftypevr
51383 #: guix-git/doc/guix.texi:28620
51384 msgid "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be generated."
51385 msgstr ""
51386
51387 #. type: deftypevr
51388 #: guix-git/doc/guix.texi:28622
51389 msgid "Defaults to @samp{\"smbios\"}."
51390 msgstr ""
51391
51392 #. type: deftypevr
51393 #: guix-git/doc/guix.texi:28625
51394 #, no-wrap
51395 msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval"
51396 msgstr ""
51397
51398 #. type: deftypevr
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."
51401 msgstr ""
51402
51403 #. type: deftypevr
51404 #: guix-git/doc/guix.texi:28635
51405 #, no-wrap
51406 msgid "{@code{libvirt-configuration} parameter} integer keepalive-count"
51407 msgstr ""
51408
51409 #. type: deftypevr
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."
51412 msgstr ""
51413
51414 #. type: deftypevr
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."
51417 msgstr ""
51418
51419 #. type: deftypevr
51420 #: guix-git/doc/guix.texi:28651
51421 #, no-wrap
51422 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval"
51423 msgstr ""
51424
51425 #. type: deftypevr
51426 #: guix-git/doc/guix.texi:28653 guix-git/doc/guix.texi:28660
51427 msgid "Same as above but for admin interface."
51428 msgstr ""
51429
51430 #. type: deftypevr
51431 #: guix-git/doc/guix.texi:28658
51432 #, no-wrap
51433 msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count"
51434 msgstr ""
51435
51436 #. type: deftypevr
51437 #: guix-git/doc/guix.texi:28665
51438 #, no-wrap
51439 msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout"
51440 msgstr ""
51441
51442 #. type: deftypevr
51443 #: guix-git/doc/guix.texi:28667
51444 msgid "Timeout for Open vSwitch calls."
51445 msgstr ""
51446
51447 #. type: deftypevr
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."
51450 msgstr ""
51451
51452 #. type: subsubheading
51453 #: guix-git/doc/guix.texi:28678
51454 #, no-wrap
51455 msgid "Virtlog daemon"
51456 msgstr ""
51457
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."
51461 msgstr ""
51462
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."
51466 msgstr ""
51467
51468 #. type: deffn
51469 #: guix-git/doc/guix.texi:28688
51470 #, no-wrap
51471 msgid "{Scheme Variable} virtlog-service-type"
51472 msgstr ""
51473
51474 #. type: deffn
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}."
51477 msgstr ""
51478
51479 #. type: lisp
51480 #: guix-git/doc/guix.texi:28696
51481 #, no-wrap
51482 msgid ""
51483 "(service virtlog-service-type\n"
51484 " (virtlog-configuration\n"
51485 " (max-clients 1000)))\n"
51486 msgstr ""
51487
51488 #. type: deftypevr
51489 #: guix-git/doc/guix.texi:28699
51490 #, no-wrap
51491 msgid "{@code{virtlog-configuration} parameter} integer log-level"
51492 msgstr ""
51493
51494 #. type: deftypevr
51495 #: guix-git/doc/guix.texi:28706
51496 #, no-wrap
51497 msgid "{@code{virtlog-configuration} parameter} string log-filters"
51498 msgstr ""
51499
51500 #. type: deftypevr
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:"
51503 msgstr ""
51504
51505 #. type: deftypevr
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:"
51508 msgstr ""
51509
51510 #. type: deftypevr
51511 #: guix-git/doc/guix.texi:28751
51512 #, no-wrap
51513 msgid "{@code{virtlog-configuration} parameter} string log-outputs"
51514 msgstr ""
51515
51516 #. type: deftypevr
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:"
51519 msgstr ""
51520
51521 #. type: deftypevr
51522 #: guix-git/doc/guix.texi:28796
51523 #, no-wrap
51524 msgid "{@code{virtlog-configuration} parameter} integer max-clients"
51525 msgstr ""
51526
51527 #. type: deftypevr
51528 #: guix-git/doc/guix.texi:28801
51529 msgid "Defaults to @samp{1024}."
51530 msgstr ""
51531
51532 #. type: deftypevr
51533 #: guix-git/doc/guix.texi:28804
51534 #, no-wrap
51535 msgid "{@code{virtlog-configuration} parameter} integer max-size"
51536 msgstr ""
51537
51538 #. type: deftypevr
51539 #: guix-git/doc/guix.texi:28806
51540 msgid "Maximum file size before rolling over."
51541 msgstr ""
51542
51543 #. type: deftypevr
51544 #: guix-git/doc/guix.texi:28808
51545 msgid "Defaults to @samp{2MB}"
51546 msgstr ""
51547
51548 #. type: deftypevr
51549 #: guix-git/doc/guix.texi:28811
51550 #, no-wrap
51551 msgid "{@code{virtlog-configuration} parameter} integer max-backups"
51552 msgstr ""
51553
51554 #. type: deftypevr
51555 #: guix-git/doc/guix.texi:28813
51556 msgid "Maximum number of backup files to keep."
51557 msgstr ""
51558
51559 #. type: deftypevr
51560 #: guix-git/doc/guix.texi:28815
51561 msgid "Defaults to @samp{3}"
51562 msgstr ""
51563
51564 #. type: anchor{#1}
51565 #: guix-git/doc/guix.texi:28819
51566 msgid "transparent-emulation-qemu"
51567 msgstr ""
51568
51569 #. type: subsubheading
51570 #: guix-git/doc/guix.texi:28819
51571 #, no-wrap
51572 msgid "Transparent Emulation with QEMU"
51573 msgstr ""
51574
51575 #. type: cindex
51576 #: guix-git/doc/guix.texi:28821
51577 #, no-wrap
51578 msgid "emulation"
51579 msgstr ""
51580
51581 #. type: code{#1}
51582 #: guix-git/doc/guix.texi:28822
51583 #, no-wrap
51584 msgid "binfmt_misc"
51585 msgstr ""
51586
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."
51590 msgstr ""
51591
51592 #. type: defvr
51593 #: guix-git/doc/guix.texi:28831
51594 #, no-wrap
51595 msgid "{Scheme Variable} qemu-binfmt-service-type"
51596 msgstr ""
51597
51598 #. type: defvr
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:"
51601 msgstr ""
51602
51603 #. type: lisp
51604 #: guix-git/doc/guix.texi:28841
51605 #, no-wrap
51606 msgid ""
51607 "(service qemu-binfmt-service-type\n"
51608 " (qemu-binfmt-configuration\n"
51609 " (platforms (lookup-qemu-platforms \"arm\" \"aarch64\"))))\n"
51610 msgstr ""
51611
51612 #. type: defvr
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})."
51615 msgstr ""
51616
51617 #. type: deftp
51618 #: guix-git/doc/guix.texi:28849
51619 #, no-wrap
51620 msgid "{Data Type} qemu-binfmt-configuration"
51621 msgstr ""
51622
51623 #. type: deftp
51624 #: guix-git/doc/guix.texi:28851
51625 msgid "This is the configuration for the @code{qemu-binfmt} service."
51626 msgstr ""
51627
51628 #. type: item
51629 #: guix-git/doc/guix.texi:28853
51630 #, no-wrap
51631 msgid "@code{platforms} (default: @code{'()})"
51632 msgstr ""
51633
51634 #. type: table
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)."
51637 msgstr ""
51638
51639 #. type: table
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:"
51642 msgstr ""
51643
51644 #. type: lisp
51645 #: guix-git/doc/guix.texi:28864
51646 #, no-wrap
51647 msgid ""
51648 "(service qemu-binfmt-service-type\n"
51649 " (qemu-binfmt-configuration\n"
51650 " (platforms (lookup-qemu-platforms \"arm\"))))\n"
51651 msgstr ""
51652
51653 #. type: table
51654 #: guix-git/doc/guix.texi:28867
51655 msgid "You can run:"
51656 msgstr ""
51657
51658 #. type: example
51659 #: guix-git/doc/guix.texi:28870
51660 #, no-wrap
51661 msgid "guix build -s armhf-linux inkscape\n"
51662 msgstr ""
51663
51664 #. type: table
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!"
51667 msgstr ""
51668
51669 #. type: item
51670 #: guix-git/doc/guix.texi:28878
51671 #, no-wrap
51672 msgid "@code{qemu} (default: @code{qemu})"
51673 msgstr ""
51674
51675 #. type: table
51676 #: guix-git/doc/guix.texi:28880 guix-git/doc/guix.texi:28974
51677 msgid "The QEMU package to use."
51678 msgstr ""
51679
51680 #. type: deffn
51681 #: guix-git/doc/guix.texi:28883
51682 #, no-wrap
51683 msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}"
51684 msgstr ""
51685
51686 #. type: deffn
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."
51689 msgstr ""
51690
51691 #. type: deffn
51692 #: guix-git/doc/guix.texi:28890
51693 #, no-wrap
51694 msgid "{Scheme Procedure} qemu-platform? @var{obj}"
51695 msgstr ""
51696
51697 #. type: deffn
51698 #: guix-git/doc/guix.texi:28892
51699 msgid "Return true if @var{obj} is a platform object."
51700 msgstr ""
51701
51702 #. type: deffn
51703 #: guix-git/doc/guix.texi:28894
51704 #, no-wrap
51705 msgid "{Scheme Procedure} qemu-platform-name @var{platform}"
51706 msgstr ""
51707
51708 #. type: deffn
51709 #: guix-git/doc/guix.texi:28896
51710 msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}."
51711 msgstr ""
51712
51713 #. type: subsubheading
51714 #: guix-git/doc/guix.texi:28899
51715 #, no-wrap
51716 msgid "The Hurd in a Virtual Machine"
51717 msgstr ""
51718
51719 #. type: cindex
51720 #: guix-git/doc/guix.texi:28902
51721 #, no-wrap
51722 msgid "the Hurd"
51723 msgstr ""
51724
51725 #. type: cindex
51726 #: guix-git/doc/guix.texi:28903
51727 #, no-wrap
51728 msgid "childhurd"
51729 msgstr ""
51730
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:"
51734 msgstr ""
51735
51736 #. type: example
51737 #: guix-git/doc/guix.texi:28915
51738 #, no-wrap
51739 msgid ""
51740 "herd start hurd-vm\n"
51741 "herd stop childhurd\n"
51742 msgstr ""
51743
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:"
51747 msgstr ""
51748
51749 #. type: example
51750 #: guix-git/doc/guix.texi:28923
51751 #, no-wrap
51752 msgid ""
51753 "guix environment --ad-hoc tigervnc-client -- \\\n"
51754 " vncviewer localhost:5900\n"
51755 msgstr ""
51756
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:"
51760 msgstr ""
51761
51762 #. type: example
51763 #: guix-git/doc/guix.texi:28932
51764 #, no-wrap
51765 msgid "ssh root@@localhost -p 10022\n"
51766 msgstr ""
51767
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."
51771 msgstr ""
51772
51773 #. type: defvr
51774 #: guix-git/doc/guix.texi:28942
51775 #, no-wrap
51776 msgid "{Scheme Variable} hurd-vm-service-type"
51777 msgstr ""
51778
51779 #. type: defvr
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."
51782 msgstr ""
51783
51784 #. type: lisp
51785 #: guix-git/doc/guix.texi:28956
51786 #, no-wrap
51787 msgid ""
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"
51792 msgstr ""
51793
51794 #. type: defvr
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."
51797 msgstr ""
51798
51799 #. type: deftp
51800 #: guix-git/doc/guix.texi:28962
51801 #, no-wrap
51802 msgid "{Data Type} hurd-vm-configuration"
51803 msgstr ""
51804
51805 #. type: deftp
51806 #: guix-git/doc/guix.texi:28965
51807 msgid "The data type representing the configuration for @code{hurd-vm-service-type}."
51808 msgstr ""
51809
51810 #. type: item
51811 #: guix-git/doc/guix.texi:28967
51812 #, no-wrap
51813 msgid "@code{os} (default: @var{%hurd-vm-operating-system})"
51814 msgstr ""
51815
51816 #. type: table
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}})."
51819 msgstr ""
51820
51821 #. type: item
51822 #: guix-git/doc/guix.texi:28972
51823 #, no-wrap
51824 msgid "@code{qemu} (default: @code{qemu-minimal})"
51825 msgstr ""
51826
51827 #. type: item
51828 #: guix-git/doc/guix.texi:28975
51829 #, no-wrap
51830 msgid "@code{image} (default: @var{hurd-vm-disk-image})"
51831 msgstr ""
51832
51833 #. type: table
51834 #: guix-git/doc/guix.texi:28978
51835 msgid "The procedure used to build the disk-image built from this configuration."
51836 msgstr ""
51837
51838 #. type: item
51839 #: guix-git/doc/guix.texi:28979
51840 #, no-wrap
51841 msgid "@code{disk-size} (default: @code{'guess})"
51842 msgstr ""
51843
51844 #. type: table
51845 #: guix-git/doc/guix.texi:28981
51846 msgid "The size of the disk image."
51847 msgstr ""
51848
51849 #. type: item
51850 #: guix-git/doc/guix.texi:28982
51851 #, no-wrap
51852 msgid "@code{memory-size} (default: @code{512})"
51853 msgstr ""
51854
51855 #. type: table
51856 #: guix-git/doc/guix.texi:28984
51857 msgid "The memory size of the Virtual Machine in mebibytes."
51858 msgstr ""
51859
51860 #. type: item
51861 #: guix-git/doc/guix.texi:28985
51862 #, no-wrap
51863 msgid "@code{options} (default: @code{'(\"--snapshot\")})"
51864 msgstr ""
51865
51866 #. type: table
51867 #: guix-git/doc/guix.texi:28987
51868 msgid "The extra options for running QEMU."
51869 msgstr ""
51870
51871 #. type: table
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}."
51874 msgstr ""
51875
51876 #. type: item
51877 #: guix-git/doc/guix.texi:28993
51878 #, no-wrap
51879 msgid "@code{net-options} (default: @var{hurd-vm-net-options})"
51880 msgstr ""
51881
51882 #. type: table
51883 #: guix-git/doc/guix.texi:28995
51884 msgid "The procedure used to produce the list of QEMU networking options."
51885 msgstr ""
51886
51887 #. type: table
51888 #: guix-git/doc/guix.texi:28997
51889 msgid "By default, it produces"
51890 msgstr ""
51891
51892 #. type: lisp
51893 #: guix-git/doc/guix.texi:29004
51894 #, no-wrap
51895 msgid ""
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"
51901 msgstr ""
51902
51903 #. type: table
51904 #: guix-git/doc/guix.texi:29007
51905 msgid "with forwarded ports:"
51906 msgstr ""
51907
51908 #. type: example
51909 #: guix-git/doc/guix.texi:29012
51910 #, no-wrap
51911 msgid ""
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"
51915 msgstr ""
51916
51917 #. type: item
51918 #: guix-git/doc/guix.texi:29014
51919 #, no-wrap
51920 msgid "@code{secret-root} (default: @file{/etc/childhurd})"
51921 msgstr ""
51922
51923 #. type: table
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."
51926 msgstr ""
51927
51928 #. type: table
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."
51931 msgstr ""
51932
51933 #. type: table
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:"
51936 msgstr ""
51937
51938 #. type: example
51939 #: guix-git/doc/guix.texi:29035
51940 #, no-wrap
51941 msgid ""
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"
51949 msgstr ""
51950
51951 #. type: table
51952 #: guix-git/doc/guix.texi:29039
51953 msgid "These files are automatically sent to the guest Hurd VM when it boots, including permissions."
51954 msgstr ""
51955
51956 #. type: cindex
51957 #: guix-git/doc/guix.texi:29040
51958 #, no-wrap
51959 msgid "childhurd, offloading"
51960 msgstr ""
51961
51962 #. type: cindex
51963 #: guix-git/doc/guix.texi:29041
51964 #, no-wrap
51965 msgid "Hurd, offloading"
51966 msgstr ""
51967
51968 #. type: table
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:"
51971 msgstr ""
51972
51973 #. type: enumerate
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:"
51976 msgstr ""
51977
51978 #. type: example
51979 #: guix-git/doc/guix.texi:29054
51980 #, no-wrap
51981 msgid ""
51982 "guix archive --authorize < \\\n"
51983 " /etc/childhurd/etc/guix/signing-key.pub\n"
51984 msgstr ""
51985
51986 #. type: enumerate
51987 #: guix-git/doc/guix.texi:29059
51988 msgid "Adding the childhurd to @file{/etc/guix/machines.scm} (@pxref{Daemon Offload Setup})."
51989 msgstr ""
51990
51991 #. type: table
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!"
51994 msgstr ""
51995
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:"
51999 msgstr ""
52000
52001 #. type: lisp
52002 #: guix-git/doc/guix.texi:29076
52003 #, no-wrap
52004 msgid ""
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"
52009 msgstr ""
52010
52011 #. type: subsubheading
52012 #: guix-git/doc/guix.texi:29078
52013 #, no-wrap
52014 msgid "Ganeti"
52015 msgstr ""
52016
52017 #. type: cindex
52018 #: guix-git/doc/guix.texi:29080
52019 #, no-wrap
52020 msgid "ganeti"
52021 msgstr ""
52022
52023 #. type: quotation
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}."
52026 msgstr ""
52027
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)."
52031 msgstr ""
52032
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}:"
52036 msgstr ""
52037
52038 #. type: lisp
52039 #: guix-git/doc/guix.texi:29112
52040 #, no-wrap
52041 msgid ""
52042 "(use-package-modules virtualization)\n"
52043 "(use-service-modules base ganeti networking ssh)\n"
52044 "(operating-system\n"
52045 " ;; @dots{}\n"
52046 " (host-name \"node1\")\n"
52047 " (hosts-file (plain-file \"hosts\" (format #f \"\n"
52048 "127.0.0.1 localhost\n"
52049 "::1 localhost\n"
52050 "\n"
52051 msgstr ""
52052
52053 #. type: lisp
52054 #: guix-git/doc/guix.texi:29117
52055 #, no-wrap
52056 msgid ""
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"
52060 "\")))\n"
52061 "\n"
52062 msgstr ""
52063
52064 #. type: lisp
52065 #: guix-git/doc/guix.texi:29131
52066 #, no-wrap
52067 msgid ""
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"
52075 " (services\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"
52081 "\n"
52082 msgstr ""
52083
52084 #. type: lisp
52085 #: guix-git/doc/guix.texi:29136
52086 #, no-wrap
52087 msgid ""
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"
52092 "\n"
52093 msgstr ""
52094
52095 #. type: lisp
52096 #: guix-git/doc/guix.texi:29146
52097 #, no-wrap
52098 msgid ""
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"
52108 msgstr ""
52109
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."
52113 msgstr ""
52114
52115 #. type: defvr
52116 #: guix-git/doc/guix.texi:29155
52117 #, no-wrap
52118 msgid "{Scheme Variable} ganeti-service-type"
52119 msgstr ""
52120
52121 #. type: defvr
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."
52124 msgstr ""
52125
52126 #. type: defvr
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."
52129 msgstr ""
52130
52131 #. type: deftp
52132 #: guix-git/doc/guix.texi:29165
52133 #, no-wrap
52134 msgid "{Data Type} ganeti-configuration"
52135 msgstr ""
52136
52137 #. type: deftp
52138 #: guix-git/doc/guix.texi:29167
52139 msgid "The @code{ganeti} service takes the following configuration options:"
52140 msgstr ""
52141
52142 #. type: item
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
52149 #, no-wrap
52150 msgid "@code{ganeti} (default: @code{ganeti})"
52151 msgstr ""
52152
52153 #. type: table
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)."
52156 msgstr ""
52157
52158 #. type: item
52159 #: guix-git/doc/guix.texi:29175
52160 #, no-wrap
52161 msgid "@code{noded-configuration} (default: @code{(ganeti-noded-configuration)})"
52162 msgstr ""
52163
52164 #. type: itemx
52165 #: guix-git/doc/guix.texi:29176
52166 #, no-wrap
52167 msgid "@code{confd-configuration} (default: @code{(ganeti-confd-configuration)})"
52168 msgstr ""
52169
52170 #. type: itemx
52171 #: guix-git/doc/guix.texi:29177
52172 #, no-wrap
52173 msgid "@code{wconfd-configuration} (default: @code{(ganeti-wconfd-configuration)})"
52174 msgstr ""
52175
52176 #. type: itemx
52177 #: guix-git/doc/guix.texi:29178
52178 #, no-wrap
52179 msgid "@code{luxid-configuration} (default: @code{(ganeti-luxid-configuration)})"
52180 msgstr ""
52181
52182 #. type: itemx
52183 #: guix-git/doc/guix.texi:29179
52184 #, no-wrap
52185 msgid "@code{rapi-configuration} (default: @code{(ganeti-rapi-configuration)})"
52186 msgstr ""
52187
52188 #. type: itemx
52189 #: guix-git/doc/guix.texi:29180
52190 #, no-wrap
52191 msgid "@code{kvmd-configuration} (default: @code{(ganeti-kvmd-configuration)})"
52192 msgstr ""
52193
52194 #. type: itemx
52195 #: guix-git/doc/guix.texi:29181
52196 #, no-wrap
52197 msgid "@code{mond-configuration} (default: @code{(ganeti-mond-configuration)})"
52198 msgstr ""
52199
52200 #. type: itemx
52201 #: guix-git/doc/guix.texi:29182
52202 #, no-wrap
52203 msgid "@code{metad-configuration} (default: @code{(ganeti-metad-configuration)})"
52204 msgstr ""
52205
52206 #. type: itemx
52207 #: guix-git/doc/guix.texi:29183
52208 #, no-wrap
52209 msgid "@code{watcher-configuration} (default: @code{(ganeti-watcher-configuration)})"
52210 msgstr ""
52211
52212 #. type: itemx
52213 #: guix-git/doc/guix.texi:29184
52214 #, no-wrap
52215 msgid "@code{cleaner-configuration} (default: @code{(ganeti-cleaner-configuration)})"
52216 msgstr ""
52217
52218 #. type: table
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:"
52221 msgstr ""
52222
52223 #. type: lisp
52224 #: guix-git/doc/guix.texi:29199
52225 #, no-wrap
52226 msgid ""
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"
52235 msgstr ""
52236
52237 #. type: item
52238 #: guix-git/doc/guix.texi:29201
52239 #, no-wrap
52240 msgid "@code{file-storage-paths} (default: @code{'()})"
52241 msgstr ""
52242
52243 #. type: table
52244 #: guix-git/doc/guix.texi:29203
52245 msgid "List of allowed directories for file storage backend."
52246 msgstr ""
52247
52248 #. type: item
52249 #: guix-git/doc/guix.texi:29204
52250 #, no-wrap
52251 msgid "@code{os} (default: @code{%default-ganeti-os})"
52252 msgstr ""
52253
52254 #. type: table
52255 #: guix-git/doc/guix.texi:29206
52256 msgid "List of @code{<ganeti-os>} records."
52257 msgstr ""
52258
52259 #. type: deftp
52260 #: guix-git/doc/guix.texi:29210
52261 msgid "In essence @code{ganeti-service-type} is shorthand for declaring each service individually:"
52262 msgstr ""
52263
52264 #. type: lisp
52265 #: guix-git/doc/guix.texi:29221
52266 #, no-wrap
52267 msgid ""
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"
52277 msgstr ""
52278
52279 #. type: deftp
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."
52282 msgstr ""
52283
52284 #. type: deftp
52285 #: guix-git/doc/guix.texi:29228
52286 #, no-wrap
52287 msgid "{Data Type} ganeti-os"
52288 msgstr ""
52289
52290 #. type: deftp
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:"
52293 msgstr ""
52294
52295 #. type: table
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}."
52298 msgstr ""
52299
52300 #. type: code{#1}
52301 #: guix-git/doc/guix.texi:29238
52302 #, no-wrap
52303 msgid "extension"
52304 msgstr ""
52305
52306 #. type: table
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}."
52309 msgstr ""
52310
52311 #. type: item
52312 #: guix-git/doc/guix.texi:29242
52313 #, no-wrap
52314 msgid "@code{variants} (default: @code{'()})"
52315 msgstr ""
52316
52317 #. type: table
52318 #: guix-git/doc/guix.texi:29244
52319 msgid "List of @code{ganeti-os-variant} objects for this OS."
52320 msgstr ""
52321
52322 #. type: deftp
52323 #: guix-git/doc/guix.texi:29248
52324 #, no-wrap
52325 msgid "{Data Type} ganeti-os-variant"
52326 msgstr ""
52327
52328 #. type: deftp
52329 #: guix-git/doc/guix.texi:29251
52330 msgid "This is the data type for a Ganeti OS variant. It takes the following parameters:"
52331 msgstr ""
52332
52333 #. type: table
52334 #: guix-git/doc/guix.texi:29255
52335 msgid "The name of this variant."
52336 msgstr ""
52337
52338 #. type: code{#1}
52339 #: guix-git/doc/guix.texi:29256
52340 #, no-wrap
52341 msgid "configuration"
52342 msgstr ""
52343
52344 #. type: table
52345 #: guix-git/doc/guix.texi:29258
52346 msgid "A configuration file for this variant."
52347 msgstr ""
52348
52349 #. type: defvr
52350 #: guix-git/doc/guix.texi:29261
52351 #, no-wrap
52352 msgid "{Scheme Variable} %default-debootstrap-hooks"
52353 msgstr ""
52354
52355 #. type: defvr
52356 #: guix-git/doc/guix.texi:29263
52357 msgid "This variable contains hooks to configure networking and the GRUB bootloader."
52358 msgstr ""
52359
52360 #. type: defvr
52361 #: guix-git/doc/guix.texi:29265
52362 #, no-wrap
52363 msgid "{Scheme Variable} %default-debootstrap-extra-pkgs"
52364 msgstr ""
52365
52366 #. type: defvr
52367 #: guix-git/doc/guix.texi:29267
52368 msgid "This variable contains a list of packages suitable for a fully-virtualized guest."
52369 msgstr ""
52370
52371 #. type: deftp
52372 #: guix-git/doc/guix.texi:29269
52373 #, no-wrap
52374 msgid "{Data Type} debootstrap-configuration"
52375 msgstr ""
52376
52377 #. type: deftp
52378 #: guix-git/doc/guix.texi:29272
52379 msgid "This data type creates configuration files suitable for the debootstrap OS provider."
52380 msgstr ""
52381
52382 #. type: item
52383 #: guix-git/doc/guix.texi:29274
52384 #, no-wrap
52385 msgid "@code{hooks} (default: @code{%default-debootstrap-hooks})"
52386 msgstr ""
52387
52388 #. type: table
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:"
52391 msgstr ""
52392
52393 #. type: lisp
52394 #: guix-git/doc/guix.texi:29281
52395 #, no-wrap
52396 msgid "`((99-hello-world . ,(plain-file \"#!/bin/sh\\necho Hello, World\")))\n"
52397 msgstr ""
52398
52399 #. type: table
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."
52402 msgstr ""
52403
52404 #. type: item
52405 #: guix-git/doc/guix.texi:29286
52406 #, no-wrap
52407 msgid "@code{proxy} (default: @code{#f})"
52408 msgstr ""
52409
52410 #. type: table
52411 #: guix-git/doc/guix.texi:29288
52412 msgid "Optional HTTP proxy to use."
52413 msgstr ""
52414
52415 #. type: item
52416 #: guix-git/doc/guix.texi:29288
52417 #, no-wrap
52418 msgid "@code{mirror} (default: @code{#f})"
52419 msgstr ""
52420
52421 #. type: table
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."
52424 msgstr ""
52425
52426 #. type: item
52427 #: guix-git/doc/guix.texi:29291
52428 #, no-wrap
52429 msgid "@code{arch} (default: @code{#f})"
52430 msgstr ""
52431
52432 #. type: table
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."
52435 msgstr ""
52436
52437 #. type: item
52438 #: guix-git/doc/guix.texi:29294
52439 #, no-wrap
52440 msgid "@code{suite} (default: @code{\"stable\"})"
52441 msgstr ""
52442
52443 #. type: table
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."
52446 msgstr ""
52447
52448 #. type: item
52449 #: guix-git/doc/guix.texi:29297
52450 #, no-wrap
52451 msgid "@code{extra-pkgs} (default: @code{%default-debootstrap-extra-pkgs})"
52452 msgstr ""
52453
52454 #. type: table
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."
52457 msgstr ""
52458
52459 #. type: item
52460 #: guix-git/doc/guix.texi:29300
52461 #, no-wrap
52462 msgid "@code{components} (default: @code{#f})"
52463 msgstr ""
52464
52465 #. type: table
52466 #: guix-git/doc/guix.texi:29303
52467 msgid "When set, must be a list of Debian repository ``components''. For example @code{'(\"main\" \"contrib\")}."
52468 msgstr ""
52469
52470 #. type: item
52471 #: guix-git/doc/guix.texi:29303
52472 #, no-wrap
52473 msgid "@code{generate-cache?} (default: @code{#t})"
52474 msgstr ""
52475
52476 #. type: table
52477 #: guix-git/doc/guix.texi:29305
52478 msgid "Whether to automatically cache the generated debootstrap archive."
52479 msgstr ""
52480
52481 #. type: item
52482 #: guix-git/doc/guix.texi:29305
52483 #, no-wrap
52484 msgid "@code{clean-cache} (default: @code{14})"
52485 msgstr ""
52486
52487 #. type: table
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."
52490 msgstr ""
52491
52492 #. type: item
52493 #: guix-git/doc/guix.texi:29308
52494 #, no-wrap
52495 msgid "@code{partition-style} (default: @code{'msdos})"
52496 msgstr ""
52497
52498 #. type: table
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."
52501 msgstr ""
52502
52503 #. type: item
52504 #: guix-git/doc/guix.texi:29311
52505 #, no-wrap
52506 msgid "@code{partition-alignment} (default: @code{2048})"
52507 msgstr ""
52508
52509 #. type: table
52510 #: guix-git/doc/guix.texi:29313
52511 msgid "Alignment of the partition in sectors."
52512 msgstr ""
52513
52514 #. type: deffn
52515 #: guix-git/doc/guix.texi:29316
52516 #, no-wrap
52517 msgid "{Scheme Procedure} debootstrap-variant @var{name} @var{configuration}"
52518 msgstr ""
52519
52520 #. type: deffn
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."
52523 msgstr ""
52524
52525 #. type: deffn
52526 #: guix-git/doc/guix.texi:29321
52527 #, no-wrap
52528 msgid "{Scheme Procedure} debootstrap-os @var{variants}@dots{}"
52529 msgstr ""
52530
52531 #. type: deffn
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}."
52534 msgstr ""
52535
52536 #. type: deffn
52537 #: guix-git/doc/guix.texi:29326
52538 #, no-wrap
52539 msgid "{Scheme Procedure} guix-variant @var{name} @var{configuration}"
52540 msgstr ""
52541
52542 #. type: deffn
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."
52545 msgstr ""
52546
52547 #. type: deffn
52548 #: guix-git/doc/guix.texi:29333
52549 #, no-wrap
52550 msgid "{Scheme Procedure} guix-os @var{variants}@dots{}"
52551 msgstr ""
52552
52553 #. type: deffn
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}."
52556 msgstr ""
52557
52558 #. type: defvr
52559 #: guix-git/doc/guix.texi:29338
52560 #, no-wrap
52561 msgid "{Scheme Variable} %default-debootstrap-variants"
52562 msgstr ""
52563
52564 #. type: defvr
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:"
52567 msgstr ""
52568
52569 #. type: lisp
52570 #: guix-git/doc/guix.texi:29347
52571 #, no-wrap
52572 msgid ""
52573 "(list (debootstrap-variant\n"
52574 " \"default\"\n"
52575 " (debootstrap-configuration)))\n"
52576 msgstr ""
52577
52578 #. type: defvr
52579 #: guix-git/doc/guix.texi:29350
52580 #, no-wrap
52581 msgid "{Scheme Variable} %default-guix-variants"
52582 msgstr ""
52583
52584 #. type: defvr
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."
52587 msgstr ""
52588
52589 #. type: lisp
52590 #: guix-git/doc/guix.texi:29360
52591 #, no-wrap
52592 msgid ""
52593 "(list (guix-variant\n"
52594 " \"default\"\n"
52595 " (file-append ganeti-instance-guix\n"
52596 " \"/share/doc/ganeti-instance-guix/examples/dynamic.scm\")))\n"
52597 msgstr ""
52598
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:"
52602 msgstr ""
52603
52604 #. type: lisp
52605 #: guix-git/doc/guix.texi:29375
52606 #, no-wrap
52607 msgid ""
52608 "(ganeti-os\n"
52609 " (name \"custom\")\n"
52610 " (extension \".conf\")\n"
52611 " (variants\n"
52612 " (list (ganeti-os-variant\n"
52613 " (name \"foo\")\n"
52614 " (configuration (plain-file \"bar\" \"this is fine\"))))))\n"
52615 msgstr ""
52616
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}."
52620 msgstr ""
52621
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}."
52625 msgstr ""
52626
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}."
52630 msgstr ""
52631
52632 #. type: defvr
52633 #: guix-git/doc/guix.texi:29387
52634 #, no-wrap
52635 msgid "{Scheme Variable} ganeti-noded-service-type"
52636 msgstr ""
52637
52638 #. type: defvr
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."
52641 msgstr ""
52642
52643 #. type: deftp
52644 #: guix-git/doc/guix.texi:29393
52645 #, no-wrap
52646 msgid "{Data Type} ganeti-noded-configuration"
52647 msgstr ""
52648
52649 #. type: deftp
52650 #: guix-git/doc/guix.texi:29395
52651 msgid "This is the configuration for the @code{ganeti-noded} service."
52652 msgstr ""
52653
52654 #. type: table
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."
52661 msgstr ""
52662
52663 #. type: item
52664 #: guix-git/doc/guix.texi:29400
52665 #, no-wrap
52666 msgid "@code{port} (default: @code{1811})"
52667 msgstr ""
52668
52669 #. type: table
52670 #: guix-git/doc/guix.texi:29402
52671 msgid "The TCP port on which the node daemon listens for network requests."
52672 msgstr ""
52673
52674 #. type: item
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
52677 #, no-wrap
52678 msgid "@code{address} (default: @code{\"0.0.0.0\"})"
52679 msgstr ""
52680
52681 #. type: table
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."
52684 msgstr ""
52685
52686 #. type: table
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."
52689 msgstr ""
52690
52691 #. type: item
52692 #: guix-git/doc/guix.texi:29411 guix-git/doc/guix.texi:29553
52693 #, no-wrap
52694 msgid "@code{max-clients} (default: @code{20})"
52695 msgstr ""
52696
52697 #. type: table
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."
52700 msgstr ""
52701
52702 #. type: item
52703 #: guix-git/doc/guix.texi:29416 guix-git/doc/guix.texi:29558
52704 #, no-wrap
52705 msgid "@code{ssl?} (default: @code{#t})"
52706 msgstr ""
52707
52708 #. type: table
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}."
52711 msgstr ""
52712
52713 #. type: item
52714 #: guix-git/doc/guix.texi:29421 guix-git/doc/guix.texi:29561
52715 #, no-wrap
52716 msgid "@code{ssl-key} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52717 msgstr ""
52718
52719 #. type: table
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."
52722 msgstr ""
52723
52724 #. type: item
52725 #: guix-git/doc/guix.texi:29424 guix-git/doc/guix.texi:29564
52726 #, no-wrap
52727 msgid "@code{ssl-cert} (default: @file{\"/var/lib/ganeti/server.pem\"})"
52728 msgstr ""
52729
52730 #. type: table
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."
52733 msgstr ""
52734
52735 #. type: table
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."
52738 msgstr ""
52739
52740 #. type: defvr
52741 #: guix-git/doc/guix.texi:29434
52742 #, no-wrap
52743 msgid "{Scheme Variable} ganeti-confd-service-type"
52744 msgstr ""
52745
52746 #. type: defvr
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."
52749 msgstr ""
52750
52751 #. type: deftp
52752 #: guix-git/doc/guix.texi:29443
52753 #, no-wrap
52754 msgid "{Data Type} ganeti-confd-configuration"
52755 msgstr ""
52756
52757 #. type: deftp
52758 #: guix-git/doc/guix.texi:29445
52759 msgid "This is the configuration for the @code{ganeti-confd} service."
52760 msgstr ""
52761
52762 #. type: item
52763 #: guix-git/doc/guix.texi:29450
52764 #, no-wrap
52765 msgid "@code{port} (default: @code{1814})"
52766 msgstr ""
52767
52768 #. type: table
52769 #: guix-git/doc/guix.texi:29452
52770 msgid "The UDP port on which to listen for network requests."
52771 msgstr ""
52772
52773 #. type: table
52774 #: guix-git/doc/guix.texi:29455
52775 msgid "Network address that the daemon will bind to."
52776 msgstr ""
52777
52778 #. type: table
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."
52783 msgstr ""
52784
52785 #. type: defvr
52786 #: guix-git/doc/guix.texi:29462
52787 #, no-wrap
52788 msgid "{Scheme Variable} ganeti-wconfd-service-type"
52789 msgstr ""
52790
52791 #. type: defvr
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."
52794 msgstr ""
52795
52796 #. type: defvr
52797 #: guix-git/doc/guix.texi:29471
52798 msgid "The value of this service must be a @code{ganeti-wconfd-configuration} object."
52799 msgstr ""
52800
52801 #. type: deftp
52802 #: guix-git/doc/guix.texi:29473
52803 #, no-wrap
52804 msgid "{Data Type} ganeti-wconfd-configuration"
52805 msgstr ""
52806
52807 #. type: deftp
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."
52810 msgstr ""
52811
52812 #. type: item
52813 #: guix-git/doc/guix.texi:29480 guix-git/doc/guix.texi:29507
52814 #, no-wrap
52815 msgid "@code{no-voting?} (default: @code{#f})"
52816 msgstr ""
52817
52818 #. type: table
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)."
52821 msgstr ""
52822
52823 #. type: defvr
52824 #: guix-git/doc/guix.texi:29491
52825 #, no-wrap
52826 msgid "{Scheme Variable} ganeti-luxid-service-type"
52827 msgstr ""
52828
52829 #. type: defvr
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."
52832 msgstr ""
52833
52834 #. type: defvr
52835 #: guix-git/doc/guix.texi:29498
52836 msgid "It takes a @code{ganeti-luxid-configuration} object."
52837 msgstr ""
52838
52839 #. type: deftp
52840 #: guix-git/doc/guix.texi:29500
52841 #, no-wrap
52842 msgid "{Data Type} ganeti-luxid-configuration"
52843 msgstr ""
52844
52845 #. type: table
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)."
52848 msgstr ""
52849
52850 #. type: defvr
52851 #: guix-git/doc/guix.texi:29518
52852 #, no-wrap
52853 msgid "{Scheme Variable} ganeti-rapi-service-type"
52854 msgstr ""
52855
52856 #. type: defvr
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."
52859 msgstr ""
52860
52861 #. type: defvr
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."
52864 msgstr ""
52865
52866 #. type: defvr
52867 #: guix-git/doc/guix.texi:29530
52868 msgid "The value of this service must be a @code{ganeti-rapi-configuration} object."
52869 msgstr ""
52870
52871 #. type: deftp
52872 #: guix-git/doc/guix.texi:29532
52873 #, no-wrap
52874 msgid "{Data Type} ganeti-rapi-configuration"
52875 msgstr ""
52876
52877 #. type: deftp
52878 #: guix-git/doc/guix.texi:29534
52879 msgid "This is the configuration for the @code{ganeti-rapi} service."
52880 msgstr ""
52881
52882 #. type: item
52883 #: guix-git/doc/guix.texi:29539
52884 #, no-wrap
52885 msgid "@code{require-authentication?} (default: @code{#f})"
52886 msgstr ""
52887
52888 #. type: table
52889 #: guix-git/doc/guix.texi:29541
52890 msgid "Whether to require authentication even for read-only operations."
52891 msgstr ""
52892
52893 #. type: item
52894 #: guix-git/doc/guix.texi:29542
52895 #, no-wrap
52896 msgid "@code{port} (default: @code{5080})"
52897 msgstr ""
52898
52899 #. type: table
52900 #: guix-git/doc/guix.texi:29544
52901 msgid "The TCP port on which to listen to API requests."
52902 msgstr ""
52903
52904 #. type: table
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."
52907 msgstr ""
52908
52909 #. type: table
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."
52912 msgstr ""
52913
52914 #. type: table
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."
52917 msgstr ""
52918
52919 #. type: table
52920 #: guix-git/doc/guix.texi:29560
52921 msgid "Whether to use SSL/TLS encryption on the RAPI port."
52922 msgstr ""
52923
52924 #. type: defvr
52925 #: guix-git/doc/guix.texi:29574
52926 #, no-wrap
52927 msgid "{Scheme Variable} ganeti-kvmd-service-type"
52928 msgstr ""
52929
52930 #. type: defvr
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."
52933 msgstr ""
52934
52935 #. type: defvr
52936 #: guix-git/doc/guix.texi:29584
52937 msgid "It takes a @code{ganeti-kvmd-configuration} object."
52938 msgstr ""
52939
52940 #. type: deftp
52941 #: guix-git/doc/guix.texi:29586
52942 #, no-wrap
52943 msgid "{Data Type} ganeti-kvmd-configuration"
52944 msgstr ""
52945
52946 #. type: defvr
52947 #: guix-git/doc/guix.texi:29598
52948 #, no-wrap
52949 msgid "{Scheme Variable} ganeti-mond-service-type"
52950 msgstr ""
52951
52952 #. type: defvr
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."
52955 msgstr ""
52956
52957 #. type: defvr
52958 #: guix-git/doc/guix.texi:29604
52959 msgid "It takes a @code{ganeti-mond-configuration} object."
52960 msgstr ""
52961
52962 #. type: deftp
52963 #: guix-git/doc/guix.texi:29606
52964 #, no-wrap
52965 msgid "{Data Type} ganeti-mond-configuration"
52966 msgstr ""
52967
52968 #. type: item
52969 #: guix-git/doc/guix.texi:29612
52970 #, no-wrap
52971 msgid "@code{port} (default: @code{1815})"
52972 msgstr ""
52973
52974 #. type: table
52975 #: guix-git/doc/guix.texi:29614 guix-git/doc/guix.texi:29640
52976 msgid "The port on which the daemon will listen."
52977 msgstr ""
52978
52979 #. type: table
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."
52982 msgstr ""
52983
52984 #. type: defvr
52985 #: guix-git/doc/guix.texi:29625
52986 #, no-wrap
52987 msgid "{Scheme Variable} ganeti-metad-service-type"
52988 msgstr ""
52989
52990 #. type: defvr
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."
52993 msgstr ""
52994
52995 #. type: defvr
52996 #: guix-git/doc/guix.texi:29630
52997 msgid "It takes a @code{ganeti-metad-configuration} object."
52998 msgstr ""
52999
53000 #. type: deftp
53001 #: guix-git/doc/guix.texi:29632
53002 #, no-wrap
53003 msgid "{Data Type} ganeti-metad-configuration"
53004 msgstr ""
53005
53006 #. type: item
53007 #: guix-git/doc/guix.texi:29641
53008 #, no-wrap
53009 msgid "@code{address} (default: @code{#f})"
53010 msgstr ""
53011
53012 #. type: table
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."
53015 msgstr ""
53016
53017 #. type: defvr
53018 #: guix-git/doc/guix.texi:29651
53019 #, no-wrap
53020 msgid "{Scheme Variable} ganeti-watcher-service-type"
53021 msgstr ""
53022
53023 #. type: defvr
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."
53026 msgstr ""
53027
53028 #. type: defvr
53029 #: guix-git/doc/guix.texi:29661
53030 msgid "It can be paused on all nodes with @command{gnt-cluster watcher pause}."
53031 msgstr ""
53032
53033 #. type: defvr
53034 #: guix-git/doc/guix.texi:29663
53035 msgid "The service takes a @code{ganeti-watcher-configuration} object."
53036 msgstr ""
53037
53038 #. type: deftp
53039 #: guix-git/doc/guix.texi:29665
53040 #, no-wrap
53041 msgid "{Data Type} ganeti-watcher-configuration"
53042 msgstr ""
53043
53044 #. type: item
53045 #: guix-git/doc/guix.texi:29671
53046 #, no-wrap
53047 msgid "@code{schedule} (default: @code{'(next-second-from (next-minute (range 0 60 5)))})"
53048 msgstr ""
53049
53050 #. type: table
53051 #: guix-git/doc/guix.texi:29673
53052 msgid "How often to run the script. The default is every five minutes."
53053 msgstr ""
53054
53055 #. type: item
53056 #: guix-git/doc/guix.texi:29674
53057 #, no-wrap
53058 msgid "@code{rapi-ip} (default: @code{#f})"
53059 msgstr ""
53060
53061 #. type: table
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."
53064 msgstr ""
53065
53066 #. type: item
53067 #: guix-git/doc/guix.texi:29678
53068 #, no-wrap
53069 msgid "@code{job-age} (default: @code{(* 6 3600)})"
53070 msgstr ""
53071
53072 #. type: table
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."
53075 msgstr ""
53076
53077 #. type: item
53078 #: guix-git/doc/guix.texi:29682
53079 #, no-wrap
53080 msgid "@code{verify-disks?} (default: @code{#t})"
53081 msgstr ""
53082
53083 #. type: table
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."
53086 msgstr ""
53087
53088 #. type: table
53089 #: guix-git/doc/guix.texi:29689
53090 msgid "When @code{#t}, the script performs additional logging for debugging purposes."
53091 msgstr ""
53092
53093 #. type: defvr
53094 #: guix-git/doc/guix.texi:29693
53095 #, no-wrap
53096 msgid "{Scheme Variable} ganeti-cleaner-service-type"
53097 msgstr ""
53098
53099 #. type: defvr
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."
53102 msgstr ""
53103
53104 #. type: defvr
53105 #: guix-git/doc/guix.texi:29703
53106 msgid "It takes a @code{ganeti-cleaner-configuration} object."
53107 msgstr ""
53108
53109 #. type: deftp
53110 #: guix-git/doc/guix.texi:29705
53111 #, no-wrap
53112 msgid "{Data Type} ganeti-cleaner-configuration"
53113 msgstr ""
53114
53115 #. type: table
53116 #: guix-git/doc/guix.texi:29710
53117 msgid "The @code{ganeti} package to use for the @command{gnt-cleaner} command."
53118 msgstr ""
53119
53120 #. type: item
53121 #: guix-git/doc/guix.texi:29711
53122 #, no-wrap
53123 msgid "@code{master-schedule} (default: @code{\"45 1 * * *\"})"
53124 msgstr ""
53125
53126 #. type: table
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."
53129 msgstr ""
53130
53131 #. type: item
53132 #: guix-git/doc/guix.texi:29715
53133 #, no-wrap
53134 msgid "@code{node-schedule} (default: @code{\"45 2 * * *\"})"
53135 msgstr ""
53136
53137 #. type: table
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."
53140 msgstr ""
53141
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}."
53145 msgstr ""
53146
53147 #. type: deffn
53148 #: guix-git/doc/guix.texi:29733
53149 #, no-wrap
53150 msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]"
53151 msgstr ""
53152
53153 #. type: deffn
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."
53156 msgstr ""
53157
53158 #. type: deffn
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}."
53161 msgstr ""
53162
53163 #. type: deftp
53164 #: guix-git/doc/guix.texi:29746
53165 #, no-wrap
53166 msgid "{Data Type} git-daemon-configuration"
53167 msgstr ""
53168
53169 #. type: deftp
53170 #: guix-git/doc/guix.texi:29748
53171 msgid "Data type representing the configuration for @code{git-daemon-service}."
53172 msgstr ""
53173
53174 #. type: item
53175 #: guix-git/doc/guix.texi:29750
53176 #, no-wrap
53177 msgid "@code{package} (default: @code{git})"
53178 msgstr ""
53179
53180 #. type: table
53181 #: guix-git/doc/guix.texi:29752 guix-git/doc/guix.texi:29812
53182 msgid "Package object of the Git distributed version control system."
53183 msgstr ""
53184
53185 #. type: item
53186 #: guix-git/doc/guix.texi:29753 guix-git/doc/guix.texi:29816
53187 #, no-wrap
53188 msgid "@code{export-all?} (default: @code{#f})"
53189 msgstr ""
53190
53191 #. type: table
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."
53194 msgstr ""
53195
53196 #. type: item
53197 #: guix-git/doc/guix.texi:29757
53198 #, no-wrap
53199 msgid "@code{base-path} (default: @file{/srv/git})"
53200 msgstr ""
53201
53202 #. type: table
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}."
53205 msgstr ""
53206
53207 #. type: item
53208 #: guix-git/doc/guix.texi:29764
53209 #, no-wrap
53210 msgid "@code{user-path} (default: @code{#f})"
53211 msgstr ""
53212
53213 #. type: table
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}."
53216 msgstr ""
53217
53218 #. type: item
53219 #: guix-git/doc/guix.texi:29773
53220 #, no-wrap
53221 msgid "@code{listen} (default: @code{'()})"
53222 msgstr ""
53223
53224 #. type: table
53225 #: guix-git/doc/guix.texi:29776
53226 msgid "Whether to listen on specific IP addresses or hostnames, defaults to all."
53227 msgstr ""
53228
53229 #. type: item
53230 #: guix-git/doc/guix.texi:29777
53231 #, no-wrap
53232 msgid "@code{port} (default: @code{#f})"
53233 msgstr ""
53234
53235 #. type: table
53236 #: guix-git/doc/guix.texi:29779
53237 msgid "Whether to listen on an alternative port, which defaults to 9418."
53238 msgstr ""
53239
53240 #. type: item
53241 #: guix-git/doc/guix.texi:29780
53242 #, no-wrap
53243 msgid "@code{whitelist} (default: @code{'()})"
53244 msgstr ""
53245
53246 #. type: table
53247 #: guix-git/doc/guix.texi:29782
53248 msgid "If not empty, only allow access to this list of directories."
53249 msgstr ""
53250
53251 #. type: table
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."
53254 msgstr ""
53255
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."
53259 msgstr ""
53260
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."
53264 msgstr ""
53265
53266 #. type: deftp
53267 #: guix-git/doc/guix.texi:29804
53268 #, no-wrap
53269 msgid "{Data Type} git-http-configuration"
53270 msgstr ""
53271
53272 #. type: deftp
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}."
53275 msgstr ""
53276
53277 #. type: item
53278 #: guix-git/doc/guix.texi:29810
53279 #, no-wrap
53280 msgid "@code{package} (default: @var{git})"
53281 msgstr ""
53282
53283 #. type: item
53284 #: guix-git/doc/guix.texi:29813
53285 #, no-wrap
53286 msgid "@code{git-root} (default: @file{/srv/git})"
53287 msgstr ""
53288
53289 #. type: table
53290 #: guix-git/doc/guix.texi:29815
53291 msgid "Directory containing the Git repositories to expose to the world."
53292 msgstr ""
53293
53294 #. type: table
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."
53297 msgstr ""
53298
53299 #. type: item
53300 #: guix-git/doc/guix.texi:29820
53301 #, no-wrap
53302 msgid "@code{uri-path} (default: @samp{/git/})"
53303 msgstr ""
53304
53305 #. type: table
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."
53308 msgstr ""
53309
53310 #. type: item
53311 #: guix-git/doc/guix.texi:29826
53312 #, no-wrap
53313 msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})"
53314 msgstr ""
53315
53316 #. type: table
53317 #: guix-git/doc/guix.texi:29829
53318 msgid "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web Services}."
53319 msgstr ""
53320
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."
53324 msgstr ""
53325
53326 #. type: deffn
53327 #: guix-git/doc/guix.texi:29837
53328 #, no-wrap
53329 msgid "{Scheme Procedure} git-http-nginx-location-configuration @"
53330 msgstr ""
53331
53332 #. type: deffn
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:"
53335 msgstr ""
53336
53337 #. type: lisp
53338 #: guix-git/doc/guix.texi:29859
53339 #, no-wrap
53340 msgid ""
53341 "(service nginx-service-type\n"
53342 " (nginx-configuration\n"
53343 " (server-blocks\n"
53344 " (list\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"
53352 " (locations\n"
53353 " (list\n"
53354 " (git-http-nginx-location-configuration\n"
53355 " (git-http-configuration (uri-path \"/\"))))))))))\n"
53356 msgstr ""
53357
53358 #. type: deffn
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}."
53361 msgstr ""
53362
53363 #. type: subsubheading
53364 #: guix-git/doc/guix.texi:29868
53365 #, no-wrap
53366 msgid "Cgit Service"
53367 msgstr ""
53368
53369 #. type: cindex
53370 #: guix-git/doc/guix.texi:29870
53371 #, no-wrap
53372 msgid "Cgit service"
53373 msgstr ""
53374
53375 #. type: cindex
53376 #: guix-git/doc/guix.texi:29871
53377 #, no-wrap
53378 msgid "Git, web interface"
53379 msgstr ""
53380
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."
53384 msgstr ""
53385
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})."
53389 msgstr ""
53390
53391 #. type: lisp
53392 #: guix-git/doc/guix.texi:29880
53393 #, no-wrap
53394 msgid "(service cgit-service-type)\n"
53395 msgstr ""
53396
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."
53400 msgstr ""
53401
53402 #. type: Plain text
53403 #: guix-git/doc/guix.texi:29888
53404 msgid "Available @code{cgit-configuration} fields are:"
53405 msgstr ""
53406
53407 #. type: deftypevr
53408 #: guix-git/doc/guix.texi:29889
53409 #, no-wrap
53410 msgid "{@code{cgit-configuration} parameter} package package"
53411 msgstr ""
53412
53413 #. type: deftypevr
53414 #: guix-git/doc/guix.texi:29891
53415 msgid "The CGIT package."
53416 msgstr ""
53417
53418 #. type: deftypevr
53419 #: guix-git/doc/guix.texi:29894
53420 #, no-wrap
53421 msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx"
53422 msgstr ""
53423
53424 #. type: deftypevr
53425 #: guix-git/doc/guix.texi:29899
53426 #, no-wrap
53427 msgid "{@code{cgit-configuration} parameter} file-object about-filter"
53428 msgstr ""
53429
53430 #. type: deftypevr
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)."
53433 msgstr ""
53434
53435 #. type: deftypevr
53436 #: guix-git/doc/guix.texi:29907
53437 #, no-wrap
53438 msgid "{@code{cgit-configuration} parameter} string agefile"
53439 msgstr ""
53440
53441 #. type: deftypevr
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."
53444 msgstr ""
53445
53446 #. type: deftypevr
53447 #: guix-git/doc/guix.texi:29915
53448 #, no-wrap
53449 msgid "{@code{cgit-configuration} parameter} file-object auth-filter"
53450 msgstr ""
53451
53452 #. type: deftypevr
53453 #: guix-git/doc/guix.texi:29918
53454 msgid "Specifies a command that will be invoked for authenticating repository access."
53455 msgstr ""
53456
53457 #. type: deftypevr
53458 #: guix-git/doc/guix.texi:29923
53459 #, no-wrap
53460 msgid "{@code{cgit-configuration} parameter} string branch-sort"
53461 msgstr ""
53462
53463 #. type: deftypevr
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."
53466 msgstr ""
53467
53468 #. type: deftypevr
53469 #: guix-git/doc/guix.texi:29928
53470 msgid "Defaults to @samp{\"name\"}."
53471 msgstr ""
53472
53473 #. type: deftypevr
53474 #: guix-git/doc/guix.texi:29931
53475 #, no-wrap
53476 msgid "{@code{cgit-configuration} parameter} string cache-root"
53477 msgstr ""
53478
53479 #. type: deftypevr
53480 #: guix-git/doc/guix.texi:29933
53481 msgid "Path used to store the cgit cache entries."
53482 msgstr ""
53483
53484 #. type: deftypevr
53485 #: guix-git/doc/guix.texi:29935
53486 msgid "Defaults to @samp{\"/var/cache/cgit\"}."
53487 msgstr ""
53488
53489 #. type: deftypevr
53490 #: guix-git/doc/guix.texi:29938
53491 #, no-wrap
53492 msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl"
53493 msgstr ""
53494
53495 #. type: deftypevr
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."
53498 msgstr ""
53499
53500 #. type: deftypevr
53501 #: guix-git/doc/guix.texi:29943 guix-git/doc/guix.texi:30386
53502 msgid "Defaults to @samp{-1}."
53503 msgstr ""
53504
53505 #. type: deftypevr
53506 #: guix-git/doc/guix.texi:29946
53507 #, no-wrap
53508 msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl"
53509 msgstr ""
53510
53511 #. type: deftypevr
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."
53514 msgstr ""
53515
53516 #. type: deftypevr
53517 #: guix-git/doc/guix.texi:29954
53518 #, no-wrap
53519 msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl"
53520 msgstr ""
53521
53522 #. type: deftypevr
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."
53525 msgstr ""
53526
53527 #. type: deftypevr
53528 #: guix-git/doc/guix.texi:29962
53529 #, no-wrap
53530 msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl"
53531 msgstr ""
53532
53533 #. type: deftypevr
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."
53536 msgstr ""
53537
53538 #. type: deftypevr
53539 #: guix-git/doc/guix.texi:29970
53540 #, no-wrap
53541 msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl"
53542 msgstr ""
53543
53544 #. type: deftypevr
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."
53547 msgstr ""
53548
53549 #. type: deftypevr
53550 #: guix-git/doc/guix.texi:29978
53551 #, no-wrap
53552 msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl"
53553 msgstr ""
53554
53555 #. type: deftypevr
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."
53558 msgstr ""
53559
53560 #. type: deftypevr
53561 #: guix-git/doc/guix.texi:29986
53562 #, no-wrap
53563 msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl"
53564 msgstr ""
53565
53566 #. type: deftypevr
53567 #: guix-git/doc/guix.texi:29989
53568 msgid "Number which specifies the time-to-live, in minutes, for the cached version of snapshots."
53569 msgstr ""
53570
53571 #. type: deftypevr
53572 #: guix-git/doc/guix.texi:29994
53573 #, no-wrap
53574 msgid "{@code{cgit-configuration} parameter} integer cache-size"
53575 msgstr ""
53576
53577 #. type: deftypevr
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."
53580 msgstr ""
53581
53582 #. type: deftypevr
53583 #: guix-git/doc/guix.texi:30002
53584 #, no-wrap
53585 msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?"
53586 msgstr ""
53587
53588 #. type: deftypevr
53589 #: guix-git/doc/guix.texi:30004
53590 msgid "Sort items in the repo list case sensitively."
53591 msgstr ""
53592
53593 #. type: deftypevr
53594 #: guix-git/doc/guix.texi:30009
53595 #, no-wrap
53596 msgid "{@code{cgit-configuration} parameter} list clone-prefix"
53597 msgstr ""
53598
53599 #. type: deftypevr
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."
53602 msgstr ""
53603
53604 #. type: deftypevr
53605 #: guix-git/doc/guix.texi:30017
53606 #, no-wrap
53607 msgid "{@code{cgit-configuration} parameter} list clone-url"
53608 msgstr ""
53609
53610 #. type: deftypevr
53611 #: guix-git/doc/guix.texi:30019
53612 msgid "List of @code{clone-url} templates."
53613 msgstr ""
53614
53615 #. type: deftypevr
53616 #: guix-git/doc/guix.texi:30024
53617 #, no-wrap
53618 msgid "{@code{cgit-configuration} parameter} file-object commit-filter"
53619 msgstr ""
53620
53621 #. type: deftypevr
53622 #: guix-git/doc/guix.texi:30026
53623 msgid "Command which will be invoked to format commit messages."
53624 msgstr ""
53625
53626 #. type: deftypevr
53627 #: guix-git/doc/guix.texi:30031
53628 #, no-wrap
53629 msgid "{@code{cgit-configuration} parameter} string commit-sort"
53630 msgstr ""
53631
53632 #. type: deftypevr
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."
53635 msgstr ""
53636
53637 #. type: deftypevr
53638 #: guix-git/doc/guix.texi:30037
53639 msgid "Defaults to @samp{\"git log\"}."
53640 msgstr ""
53641
53642 #. type: deftypevr
53643 #: guix-git/doc/guix.texi:30040
53644 #, no-wrap
53645 msgid "{@code{cgit-configuration} parameter} file-object css"
53646 msgstr ""
53647
53648 #. type: deftypevr
53649 #: guix-git/doc/guix.texi:30042
53650 msgid "URL which specifies the css document to include in all cgit pages."
53651 msgstr ""
53652
53653 #. type: deftypevr
53654 #: guix-git/doc/guix.texi:30044
53655 msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}."
53656 msgstr ""
53657
53658 #. type: deftypevr
53659 #: guix-git/doc/guix.texi:30047
53660 #, no-wrap
53661 msgid "{@code{cgit-configuration} parameter} file-object email-filter"
53662 msgstr ""
53663
53664 #. type: deftypevr
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."
53667 msgstr ""
53668
53669 #. type: deftypevr
53670 #: guix-git/doc/guix.texi:30056
53671 #, no-wrap
53672 msgid "{@code{cgit-configuration} parameter} boolean embedded?"
53673 msgstr ""
53674
53675 #. type: deftypevr
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."
53678 msgstr ""
53679
53680 #. type: deftypevr
53681 #: guix-git/doc/guix.texi:30064
53682 #, no-wrap
53683 msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?"
53684 msgstr ""
53685
53686 #. type: deftypevr
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."
53689 msgstr ""
53690
53691 #. type: deftypevr
53692 #: guix-git/doc/guix.texi:30073
53693 #, no-wrap
53694 msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?"
53695 msgstr ""
53696
53697 #. type: deftypevr
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."
53700 msgstr ""
53701
53702 #. type: deftypevr
53703 #: guix-git/doc/guix.texi:30081
53704 #, no-wrap
53705 msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?"
53706 msgstr ""
53707
53708 #. type: deftypevr
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."
53711 msgstr ""
53712
53713 #. type: deftypevr
53714 #: guix-git/doc/guix.texi:30089
53715 #, no-wrap
53716 msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?"
53717 msgstr ""
53718
53719 #. type: deftypevr
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."
53722 msgstr ""
53723
53724 #. type: deftypevr
53725 #: guix-git/doc/guix.texi:30097
53726 #, no-wrap
53727 msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?"
53728 msgstr ""
53729
53730 #. type: deftypevr
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."
53733 msgstr ""
53734
53735 #. type: deftypevr
53736 #: guix-git/doc/guix.texi:30105
53737 #, no-wrap
53738 msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?"
53739 msgstr ""
53740
53741 #. type: deftypevr
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."
53744 msgstr ""
53745
53746 #. type: deftypevr
53747 #: guix-git/doc/guix.texi:30113
53748 #, no-wrap
53749 msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?"
53750 msgstr ""
53751
53752 #. type: deftypevr
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."
53755 msgstr ""
53756
53757 #. type: deftypevr
53758 #: guix-git/doc/guix.texi:30121
53759 #, no-wrap
53760 msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?"
53761 msgstr ""
53762
53763 #. type: deftypevr
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."
53766 msgstr ""
53767
53768 #. type: deftypevr
53769 #: guix-git/doc/guix.texi:30129
53770 #, no-wrap
53771 msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?"
53772 msgstr ""
53773
53774 #. type: deftypevr
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."
53777 msgstr ""
53778
53779 #. type: deftypevr
53780 #: guix-git/doc/guix.texi:30137
53781 #, no-wrap
53782 msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?"
53783 msgstr ""
53784
53785 #. type: deftypevr
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."
53788 msgstr ""
53789
53790 #. type: deftypevr
53791 #: guix-git/doc/guix.texi:30146
53792 #, no-wrap
53793 msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?"
53794 msgstr ""
53795
53796 #. type: deftypevr
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."
53799 msgstr ""
53800
53801 #. type: deftypevr
53802 #: guix-git/doc/guix.texi:30155
53803 #, no-wrap
53804 msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?"
53805 msgstr ""
53806
53807 #. type: deftypevr
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."
53810 msgstr ""
53811
53812 #. type: deftypevr
53813 #: guix-git/doc/guix.texi:30163
53814 #, no-wrap
53815 msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?"
53816 msgstr ""
53817
53818 #. type: deftypevr
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."
53821 msgstr ""
53822
53823 #. type: deftypevr
53824 #: guix-git/doc/guix.texi:30171
53825 #, no-wrap
53826 msgid "{@code{cgit-configuration} parameter} file-object favicon"
53827 msgstr ""
53828
53829 #. type: deftypevr
53830 #: guix-git/doc/guix.texi:30173
53831 msgid "URL used as link to a shortcut icon for cgit."
53832 msgstr ""
53833
53834 #. type: deftypevr
53835 #: guix-git/doc/guix.texi:30175
53836 msgid "Defaults to @samp{\"/favicon.ico\"}."
53837 msgstr ""
53838
53839 #. type: deftypevr
53840 #: guix-git/doc/guix.texi:30178
53841 #, no-wrap
53842 msgid "{@code{cgit-configuration} parameter} string footer"
53843 msgstr ""
53844
53845 #. type: deftypevr
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)."
53848 msgstr ""
53849
53850 #. type: deftypevr
53851 #: guix-git/doc/guix.texi:30187
53852 #, no-wrap
53853 msgid "{@code{cgit-configuration} parameter} string head-include"
53854 msgstr ""
53855
53856 #. type: deftypevr
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."
53859 msgstr ""
53860
53861 #. type: deftypevr
53862 #: guix-git/doc/guix.texi:30195
53863 #, no-wrap
53864 msgid "{@code{cgit-configuration} parameter} string header"
53865 msgstr ""
53866
53867 #. type: deftypevr
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."
53870 msgstr ""
53871
53872 #. type: deftypevr
53873 #: guix-git/doc/guix.texi:30203
53874 #, no-wrap
53875 msgid "{@code{cgit-configuration} parameter} file-object include"
53876 msgstr ""
53877
53878 #. type: deftypevr
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."
53881 msgstr ""
53882
53883 #. type: deftypevr
53884 #: guix-git/doc/guix.texi:30211
53885 #, no-wrap
53886 msgid "{@code{cgit-configuration} parameter} string index-header"
53887 msgstr ""
53888
53889 #. type: deftypevr
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."
53892 msgstr ""
53893
53894 #. type: deftypevr
53895 #: guix-git/doc/guix.texi:30219
53896 #, no-wrap
53897 msgid "{@code{cgit-configuration} parameter} string index-info"
53898 msgstr ""
53899
53900 #. type: deftypevr
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."
53903 msgstr ""
53904
53905 #. type: deftypevr
53906 #: guix-git/doc/guix.texi:30227
53907 #, no-wrap
53908 msgid "{@code{cgit-configuration} parameter} boolean local-time?"
53909 msgstr ""
53910
53911 #. type: deftypevr
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."
53914 msgstr ""
53915
53916 #. type: deftypevr
53917 #: guix-git/doc/guix.texi:30235
53918 #, no-wrap
53919 msgid "{@code{cgit-configuration} parameter} file-object logo"
53920 msgstr ""
53921
53922 #. type: deftypevr
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."
53925 msgstr ""
53926
53927 #. type: deftypevr
53928 #: guix-git/doc/guix.texi:30240
53929 msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}."
53930 msgstr ""
53931
53932 #. type: deftypevr
53933 #: guix-git/doc/guix.texi:30243
53934 #, no-wrap
53935 msgid "{@code{cgit-configuration} parameter} string logo-link"
53936 msgstr ""
53937
53938 #. type: deftypevr
53939 #: guix-git/doc/guix.texi:30245 guix-git/doc/guix.texi:30702
53940 msgid "URL loaded when clicking on the cgit logo image."
53941 msgstr ""
53942
53943 #. type: deftypevr
53944 #: guix-git/doc/guix.texi:30250
53945 #, no-wrap
53946 msgid "{@code{cgit-configuration} parameter} file-object owner-filter"
53947 msgstr ""
53948
53949 #. type: deftypevr
53950 #: guix-git/doc/guix.texi:30253
53951 msgid "Command which will be invoked to format the Owner column of the main page."
53952 msgstr ""
53953
53954 #. type: deftypevr
53955 #: guix-git/doc/guix.texi:30258
53956 #, no-wrap
53957 msgid "{@code{cgit-configuration} parameter} integer max-atom-items"
53958 msgstr ""
53959
53960 #. type: deftypevr
53961 #: guix-git/doc/guix.texi:30260
53962 msgid "Number of items to display in atom feeds view."
53963 msgstr ""
53964
53965 #. type: deftypevr
53966 #: guix-git/doc/guix.texi:30265
53967 #, no-wrap
53968 msgid "{@code{cgit-configuration} parameter} integer max-commit-count"
53969 msgstr ""
53970
53971 #. type: deftypevr
53972 #: guix-git/doc/guix.texi:30267
53973 msgid "Number of entries to list per page in \"log\" view."
53974 msgstr ""
53975
53976 #. type: deftypevr
53977 #: guix-git/doc/guix.texi:30272
53978 #, no-wrap
53979 msgid "{@code{cgit-configuration} parameter} integer max-message-length"
53980 msgstr ""
53981
53982 #. type: deftypevr
53983 #: guix-git/doc/guix.texi:30274
53984 msgid "Number of commit message characters to display in \"log\" view."
53985 msgstr ""
53986
53987 #. type: deftypevr
53988 #: guix-git/doc/guix.texi:30276 guix-git/doc/guix.texi:30292
53989 msgid "Defaults to @samp{80}."
53990 msgstr ""
53991
53992 #. type: deftypevr
53993 #: guix-git/doc/guix.texi:30279
53994 #, no-wrap
53995 msgid "{@code{cgit-configuration} parameter} integer max-repo-count"
53996 msgstr ""
53997
53998 #. type: deftypevr
53999 #: guix-git/doc/guix.texi:30282
54000 msgid "Specifies the number of entries to list per page on the repository index page."
54001 msgstr ""
54002
54003 #. type: deftypevr
54004 #: guix-git/doc/guix.texi:30287
54005 #, no-wrap
54006 msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length"
54007 msgstr ""
54008
54009 #. type: deftypevr
54010 #: guix-git/doc/guix.texi:30290
54011 msgid "Specifies the maximum number of repo description characters to display on the repository index page."
54012 msgstr ""
54013
54014 #. type: deftypevr
54015 #: guix-git/doc/guix.texi:30295
54016 #, no-wrap
54017 msgid "{@code{cgit-configuration} parameter} integer max-blob-size"
54018 msgstr ""
54019
54020 #. type: deftypevr
54021 #: guix-git/doc/guix.texi:30297
54022 msgid "Specifies the maximum size of a blob to display HTML for in KBytes."
54023 msgstr ""
54024
54025 #. type: deftypevr
54026 #: guix-git/doc/guix.texi:30302
54027 #, no-wrap
54028 msgid "{@code{cgit-configuration} parameter} string max-stats"
54029 msgstr ""
54030
54031 #. type: deftypevr
54032 #: guix-git/doc/guix.texi:30305
54033 msgid "Maximum statistics period. Valid values are @samp{week},@samp{month}, @samp{quarter} and @samp{year}."
54034 msgstr ""
54035
54036 #. type: deftypevr
54037 #: guix-git/doc/guix.texi:30310
54038 #, no-wrap
54039 msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype"
54040 msgstr ""
54041
54042 #. type: deftypevr
54043 #: guix-git/doc/guix.texi:30312
54044 msgid "Mimetype for the specified filename extension."
54045 msgstr ""
54046
54047 #. type: deftypevr
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\"))}."
54050 msgstr ""
54051
54052 #. type: deftypevr
54053 #: guix-git/doc/guix.texi:30319
54054 #, no-wrap
54055 msgid "{@code{cgit-configuration} parameter} file-object mimetype-file"
54056 msgstr ""
54057
54058 #. type: deftypevr
54059 #: guix-git/doc/guix.texi:30321
54060 msgid "Specifies the file to use for automatic mimetype lookup."
54061 msgstr ""
54062
54063 #. type: deftypevr
54064 #: guix-git/doc/guix.texi:30326
54065 #, no-wrap
54066 msgid "{@code{cgit-configuration} parameter} string module-link"
54067 msgstr ""
54068
54069 #. type: deftypevr
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."
54072 msgstr ""
54073
54074 #. type: deftypevr
54075 #: guix-git/doc/guix.texi:30334
54076 #, no-wrap
54077 msgid "{@code{cgit-configuration} parameter} boolean nocache?"
54078 msgstr ""
54079
54080 #. type: deftypevr
54081 #: guix-git/doc/guix.texi:30336
54082 msgid "If set to the value @samp{#t} caching will be disabled."
54083 msgstr ""
54084
54085 #. type: deftypevr
54086 #: guix-git/doc/guix.texi:30341
54087 #, no-wrap
54088 msgid "{@code{cgit-configuration} parameter} boolean noplainemail?"
54089 msgstr ""
54090
54091 #. type: deftypevr
54092 #: guix-git/doc/guix.texi:30344
54093 msgid "If set to @samp{#t} showing full author email addresses will be disabled."
54094 msgstr ""
54095
54096 #. type: deftypevr
54097 #: guix-git/doc/guix.texi:30349
54098 #, no-wrap
54099 msgid "{@code{cgit-configuration} parameter} boolean noheader?"
54100 msgstr ""
54101
54102 #. type: deftypevr
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."
54105 msgstr ""
54106
54107 #. type: deftypevr
54108 #: guix-git/doc/guix.texi:30357
54109 #, no-wrap
54110 msgid "{@code{cgit-configuration} parameter} project-list project-list"
54111 msgstr ""
54112
54113 #. type: deftypevr
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."
54116 msgstr ""
54117
54118 #. type: deftypevr
54119 #: guix-git/doc/guix.texi:30366
54120 #, no-wrap
54121 msgid "{@code{cgit-configuration} parameter} file-object readme"
54122 msgstr ""
54123
54124 #. type: deftypevr
54125 #: guix-git/doc/guix.texi:30368
54126 msgid "Text which will be used as default value for @code{cgit-repo-readme}."
54127 msgstr ""
54128
54129 #. type: deftypevr
54130 #: guix-git/doc/guix.texi:30373
54131 #, no-wrap
54132 msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?"
54133 msgstr ""
54134
54135 #. type: deftypevr
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."
54138 msgstr ""
54139
54140 #. type: deftypevr
54141 #: guix-git/doc/guix.texi:30382
54142 #, no-wrap
54143 msgid "{@code{cgit-configuration} parameter} integer renamelimit"
54144 msgstr ""
54145
54146 #. type: deftypevr
54147 #: guix-git/doc/guix.texi:30384
54148 msgid "Maximum number of files to consider when detecting renames."
54149 msgstr ""
54150
54151 #. type: deftypevr
54152 #: guix-git/doc/guix.texi:30389
54153 #, no-wrap
54154 msgid "{@code{cgit-configuration} parameter} string repository-sort"
54155 msgstr ""
54156
54157 #. type: deftypevr
54158 #: guix-git/doc/guix.texi:30391
54159 msgid "The way in which repositories in each section are sorted."
54160 msgstr ""
54161
54162 #. type: deftypevr
54163 #: guix-git/doc/guix.texi:30396
54164 #, no-wrap
54165 msgid "{@code{cgit-configuration} parameter} robots-list robots"
54166 msgstr ""
54167
54168 #. type: deftypevr
54169 #: guix-git/doc/guix.texi:30398
54170 msgid "Text used as content for the @code{robots} meta-tag."
54171 msgstr ""
54172
54173 #. type: deftypevr
54174 #: guix-git/doc/guix.texi:30400
54175 msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}."
54176 msgstr ""
54177
54178 #. type: deftypevr
54179 #: guix-git/doc/guix.texi:30403
54180 #, no-wrap
54181 msgid "{@code{cgit-configuration} parameter} string root-desc"
54182 msgstr ""
54183
54184 #. type: deftypevr
54185 #: guix-git/doc/guix.texi:30405
54186 msgid "Text printed below the heading on the repository index page."
54187 msgstr ""
54188
54189 #. type: deftypevr
54190 #: guix-git/doc/guix.texi:30407
54191 msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}."
54192 msgstr ""
54193
54194 #. type: deftypevr
54195 #: guix-git/doc/guix.texi:30410
54196 #, no-wrap
54197 msgid "{@code{cgit-configuration} parameter} string root-readme"
54198 msgstr ""
54199
54200 #. type: deftypevr
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."
54203 msgstr ""
54204
54205 #. type: deftypevr
54206 #: guix-git/doc/guix.texi:30418
54207 #, no-wrap
54208 msgid "{@code{cgit-configuration} parameter} string root-title"
54209 msgstr ""
54210
54211 #. type: deftypevr
54212 #: guix-git/doc/guix.texi:30420
54213 msgid "Text printed as heading on the repository index page."
54214 msgstr ""
54215
54216 #. type: deftypevr
54217 #: guix-git/doc/guix.texi:30425
54218 #, no-wrap
54219 msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path"
54220 msgstr ""
54221
54222 #. type: deftypevr
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."
54225 msgstr ""
54226
54227 #. type: deftypevr
54228 #: guix-git/doc/guix.texi:30436
54229 #, no-wrap
54230 msgid "{@code{cgit-configuration} parameter} list snapshots"
54231 msgstr ""
54232
54233 #. type: deftypevr
54234 #: guix-git/doc/guix.texi:30439
54235 msgid "Text which specifies the default set of snapshot formats that cgit generates links for."
54236 msgstr ""
54237
54238 #. type: deftypevr
54239 #: guix-git/doc/guix.texi:30444
54240 #, no-wrap
54241 msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory"
54242 msgstr ""
54243
54244 #. type: deftypevr
54245 #: guix-git/doc/guix.texi:30447
54246 msgid "Name of the directory to scan for repositories (represents @code{scan-path})."
54247 msgstr ""
54248
54249 #. type: deftypevr
54250 #: guix-git/doc/guix.texi:30449
54251 msgid "Defaults to @samp{\"/srv/git\"}."
54252 msgstr ""
54253
54254 #. type: deftypevr
54255 #: guix-git/doc/guix.texi:30452
54256 #, no-wrap
54257 msgid "{@code{cgit-configuration} parameter} string section"
54258 msgstr ""
54259
54260 #. type: deftypevr
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."
54263 msgstr ""
54264
54265 #. type: deftypevr
54266 #: guix-git/doc/guix.texi:30460
54267 #, no-wrap
54268 msgid "{@code{cgit-configuration} parameter} string section-sort"
54269 msgstr ""
54270
54271 #. type: deftypevr
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."
54274 msgstr ""
54275
54276 #. type: deftypevr
54277 #: guix-git/doc/guix.texi:30468
54278 #, no-wrap
54279 msgid "{@code{cgit-configuration} parameter} integer section-from-path"
54280 msgstr ""
54281
54282 #. type: deftypevr
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."
54285 msgstr ""
54286
54287 #. type: deftypevr
54288 #: guix-git/doc/guix.texi:30476
54289 #, no-wrap
54290 msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?"
54291 msgstr ""
54292
54293 #. type: deftypevr
54294 #: guix-git/doc/guix.texi:30479
54295 msgid "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default."
54296 msgstr ""
54297
54298 #. type: deftypevr
54299 #: guix-git/doc/guix.texi:30484
54300 #, no-wrap
54301 msgid "{@code{cgit-configuration} parameter} file-object source-filter"
54302 msgstr ""
54303
54304 #. type: deftypevr
54305 #: guix-git/doc/guix.texi:30487
54306 msgid "Specifies a command which will be invoked to format plaintext blobs in the tree view."
54307 msgstr ""
54308
54309 #. type: deftypevr
54310 #: guix-git/doc/guix.texi:30492
54311 #, no-wrap
54312 msgid "{@code{cgit-configuration} parameter} integer summary-branches"
54313 msgstr ""
54314
54315 #. type: deftypevr
54316 #: guix-git/doc/guix.texi:30495
54317 msgid "Specifies the number of branches to display in the repository ``summary'' view."
54318 msgstr ""
54319
54320 #. type: deftypevr
54321 #: guix-git/doc/guix.texi:30500
54322 #, no-wrap
54323 msgid "{@code{cgit-configuration} parameter} integer summary-log"
54324 msgstr ""
54325
54326 #. type: deftypevr
54327 #: guix-git/doc/guix.texi:30503
54328 msgid "Specifies the number of log entries to display in the repository ``summary'' view."
54329 msgstr ""
54330
54331 #. type: deftypevr
54332 #: guix-git/doc/guix.texi:30508
54333 #, no-wrap
54334 msgid "{@code{cgit-configuration} parameter} integer summary-tags"
54335 msgstr ""
54336
54337 #. type: deftypevr
54338 #: guix-git/doc/guix.texi:30511
54339 msgid "Specifies the number of tags to display in the repository ``summary'' view."
54340 msgstr ""
54341
54342 #. type: deftypevr
54343 #: guix-git/doc/guix.texi:30516
54344 #, no-wrap
54345 msgid "{@code{cgit-configuration} parameter} string strict-export"
54346 msgstr ""
54347
54348 #. type: deftypevr
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."
54351 msgstr ""
54352
54353 #. type: deftypevr
54354 #: guix-git/doc/guix.texi:30524
54355 #, no-wrap
54356 msgid "{@code{cgit-configuration} parameter} string virtual-root"
54357 msgstr ""
54358
54359 #. type: deftypevr
54360 #: guix-git/doc/guix.texi:30526
54361 msgid "URL which, if specified, will be used as root for all cgit links."
54362 msgstr ""
54363
54364 #. type: deftypevr
54365 #: guix-git/doc/guix.texi:30528
54366 msgid "Defaults to @samp{\"/\"}."
54367 msgstr ""
54368
54369 #. type: deftypevr
54370 #: guix-git/doc/guix.texi:30531
54371 #, no-wrap
54372 msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories"
54373 msgstr ""
54374
54375 #. type: deftypevr
54376 #: guix-git/doc/guix.texi:30533
54377 msgid "A list of @dfn{cgit-repo} records to use with config."
54378 msgstr ""
54379
54380 #. type: deftypevr
54381 #: guix-git/doc/guix.texi:30537
54382 msgid "Available @code{repository-cgit-configuration} fields are:"
54383 msgstr ""
54384
54385 #. type: deftypevr
54386 #: guix-git/doc/guix.texi:30538
54387 #, no-wrap
54388 msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots"
54389 msgstr ""
54390
54391 #. type: deftypevr
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."
54394 msgstr ""
54395
54396 #. type: deftypevr
54397 #: guix-git/doc/guix.texi:30546
54398 #, no-wrap
54399 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter"
54400 msgstr ""
54401
54402 #. type: deftypevr
54403 #: guix-git/doc/guix.texi:30548
54404 msgid "Override the default @code{source-filter}."
54405 msgstr ""
54406
54407 #. type: deftypevr
54408 #: guix-git/doc/guix.texi:30553
54409 #, no-wrap
54410 msgid "{@code{repository-cgit-configuration} parameter} repo-string url"
54411 msgstr ""
54412
54413 #. type: deftypevr
54414 #: guix-git/doc/guix.texi:30555
54415 msgid "The relative URL used to access the repository."
54416 msgstr ""
54417
54418 #. type: deftypevr
54419 #: guix-git/doc/guix.texi:30560
54420 #, no-wrap
54421 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter"
54422 msgstr ""
54423
54424 #. type: deftypevr
54425 #: guix-git/doc/guix.texi:30562
54426 msgid "Override the default @code{about-filter}."
54427 msgstr ""
54428
54429 #. type: deftypevr
54430 #: guix-git/doc/guix.texi:30567
54431 #, no-wrap
54432 msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort"
54433 msgstr ""
54434
54435 #. type: deftypevr
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."
54438 msgstr ""
54439
54440 #. type: deftypevr
54441 #: guix-git/doc/guix.texi:30575
54442 #, no-wrap
54443 msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url"
54444 msgstr ""
54445
54446 #. type: deftypevr
54447 #: guix-git/doc/guix.texi:30577
54448 msgid "A list of URLs which can be used to clone repo."
54449 msgstr ""
54450
54451 #. type: deftypevr
54452 #: guix-git/doc/guix.texi:30582
54453 #, no-wrap
54454 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter"
54455 msgstr ""
54456
54457 #. type: deftypevr
54458 #: guix-git/doc/guix.texi:30584
54459 msgid "Override the default @code{commit-filter}."
54460 msgstr ""
54461
54462 #. type: deftypevr
54463 #: guix-git/doc/guix.texi:30589
54464 #, no-wrap
54465 msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort"
54466 msgstr ""
54467
54468 #. type: deftypevr
54469 #: guix-git/doc/guix.texi:30598
54470 #, no-wrap
54471 msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch"
54472 msgstr ""
54473
54474 #. type: deftypevr
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."
54477 msgstr ""
54478
54479 #. type: deftypevr
54480 #: guix-git/doc/guix.texi:30608
54481 #, no-wrap
54482 msgid "{@code{repository-cgit-configuration} parameter} repo-string desc"
54483 msgstr ""
54484
54485 #. type: deftypevr
54486 #: guix-git/doc/guix.texi:30610
54487 msgid "The value to show as repository description."
54488 msgstr ""
54489
54490 #. type: deftypevr
54491 #: guix-git/doc/guix.texi:30615
54492 #, no-wrap
54493 msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage"
54494 msgstr ""
54495
54496 #. type: deftypevr
54497 #: guix-git/doc/guix.texi:30617
54498 msgid "The value to show as repository homepage."
54499 msgstr ""
54500
54501 #. type: deftypevr
54502 #: guix-git/doc/guix.texi:30622
54503 #, no-wrap
54504 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter"
54505 msgstr ""
54506
54507 #. type: deftypevr
54508 #: guix-git/doc/guix.texi:30624
54509 msgid "Override the default @code{email-filter}."
54510 msgstr ""
54511
54512 #. type: deftypevr
54513 #: guix-git/doc/guix.texi:30629
54514 #, no-wrap
54515 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph?"
54516 msgstr ""
54517
54518 #. type: deftypevr
54519 #: guix-git/doc/guix.texi:30632
54520 msgid "A flag which can be used to disable the global setting @code{enable-commit-graph?}."
54521 msgstr ""
54522
54523 #. type: deftypevr
54524 #: guix-git/doc/guix.texi:30637
54525 #, no-wrap
54526 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount?"
54527 msgstr ""
54528
54529 #. type: deftypevr
54530 #: guix-git/doc/guix.texi:30640
54531 msgid "A flag which can be used to disable the global setting @code{enable-log-filecount?}."
54532 msgstr ""
54533
54534 #. type: deftypevr
54535 #: guix-git/doc/guix.texi:30645
54536 #, no-wrap
54537 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount?"
54538 msgstr ""
54539
54540 #. type: deftypevr
54541 #: guix-git/doc/guix.texi:30648
54542 msgid "A flag which can be used to disable the global setting @code{enable-log-linecount?}."
54543 msgstr ""
54544
54545 #. type: deftypevr
54546 #: guix-git/doc/guix.texi:30653
54547 #, no-wrap
54548 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches?"
54549 msgstr ""
54550
54551 #. type: deftypevr
54552 #: guix-git/doc/guix.texi:30661
54553 #, no-wrap
54554 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links?"
54555 msgstr ""
54556
54557 #. type: deftypevr
54558 #: guix-git/doc/guix.texi:30664
54559 msgid "A flag which can be used to override the global setting @code{enable-subject-links?}."
54560 msgstr ""
54561
54562 #. type: deftypevr
54563 #: guix-git/doc/guix.texi:30669
54564 #, no-wrap
54565 msgid "{@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving?"
54566 msgstr ""
54567
54568 #. type: deftypevr
54569 #: guix-git/doc/guix.texi:30672
54570 msgid "A flag which can be used to override the global setting @code{enable-html-serving?}."
54571 msgstr ""
54572
54573 #. type: deftypevr
54574 #: guix-git/doc/guix.texi:30677
54575 #, no-wrap
54576 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?"
54577 msgstr ""
54578
54579 #. type: deftypevr
54580 #: guix-git/doc/guix.texi:30680
54581 msgid "Flag which, when set to @code{#t}, hides the repository from the repository index."
54582 msgstr ""
54583
54584 #. type: deftypevr
54585 #: guix-git/doc/guix.texi:30685
54586 #, no-wrap
54587 msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?"
54588 msgstr ""
54589
54590 #. type: deftypevr
54591 #: guix-git/doc/guix.texi:30687
54592 msgid "Flag which, when set to @samp{#t}, ignores the repository."
54593 msgstr ""
54594
54595 #. type: deftypevr
54596 #: guix-git/doc/guix.texi:30692
54597 #, no-wrap
54598 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo"
54599 msgstr ""
54600
54601 #. type: deftypevr
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."
54604 msgstr ""
54605
54606 #. type: deftypevr
54607 #: guix-git/doc/guix.texi:30700
54608 #, no-wrap
54609 msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link"
54610 msgstr ""
54611
54612 #. type: deftypevr
54613 #: guix-git/doc/guix.texi:30707
54614 #, no-wrap
54615 msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter"
54616 msgstr ""
54617
54618 #. type: deftypevr
54619 #: guix-git/doc/guix.texi:30709
54620 msgid "Override the default @code{owner-filter}."
54621 msgstr ""
54622
54623 #. type: deftypevr
54624 #: guix-git/doc/guix.texi:30714
54625 #, no-wrap
54626 msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link"
54627 msgstr ""
54628
54629 #. type: deftypevr
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."
54632 msgstr ""
54633
54634 #. type: deftypevr
54635 #: guix-git/doc/guix.texi:30723
54636 #, no-wrap
54637 msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path"
54638 msgstr ""
54639
54640 #. type: deftypevr
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."
54643 msgstr ""
54644
54645 #. type: deftypevr
54646 #: guix-git/doc/guix.texi:30732
54647 #, no-wrap
54648 msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats"
54649 msgstr ""
54650
54651 #. type: deftypevr
54652 #: guix-git/doc/guix.texi:30734
54653 msgid "Override the default maximum statistics period."
54654 msgstr ""
54655
54656 #. type: deftypevr
54657 #: guix-git/doc/guix.texi:30739
54658 #, no-wrap
54659 msgid "{@code{repository-cgit-configuration} parameter} repo-string name"
54660 msgstr ""
54661
54662 #. type: deftypevr
54663 #: guix-git/doc/guix.texi:30741
54664 msgid "The value to show as repository name."
54665 msgstr ""
54666
54667 #. type: deftypevr
54668 #: guix-git/doc/guix.texi:30746
54669 #, no-wrap
54670 msgid "{@code{repository-cgit-configuration} parameter} repo-string owner"
54671 msgstr ""
54672
54673 #. type: deftypevr
54674 #: guix-git/doc/guix.texi:30748
54675 msgid "A value used to identify the owner of the repository."
54676 msgstr ""
54677
54678 #. type: deftypevr
54679 #: guix-git/doc/guix.texi:30753
54680 #, no-wrap
54681 msgid "{@code{repository-cgit-configuration} parameter} repo-string path"
54682 msgstr ""
54683
54684 #. type: deftypevr
54685 #: guix-git/doc/guix.texi:30755
54686 msgid "An absolute path to the repository directory."
54687 msgstr ""
54688
54689 #. type: deftypevr
54690 #: guix-git/doc/guix.texi:30760
54691 #, no-wrap
54692 msgid "{@code{repository-cgit-configuration} parameter} repo-string readme"
54693 msgstr ""
54694
54695 #. type: deftypevr
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."
54698 msgstr ""
54699
54700 #. type: deftypevr
54701 #: guix-git/doc/guix.texi:30768
54702 #, no-wrap
54703 msgid "{@code{repository-cgit-configuration} parameter} repo-string section"
54704 msgstr ""
54705
54706 #. type: deftypevr
54707 #: guix-git/doc/guix.texi:30776
54708 #, no-wrap
54709 msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options"
54710 msgstr ""
54711
54712 #. type: deftypevr
54713 #: guix-git/doc/guix.texi:30778 guix-git/doc/guix.texi:30787
54714 msgid "Extra options will be appended to cgitrc file."
54715 msgstr ""
54716
54717 #. type: deftypevr
54718 #: guix-git/doc/guix.texi:30785
54719 #, no-wrap
54720 msgid "{@code{cgit-configuration} parameter} list extra-options"
54721 msgstr ""
54722
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."
54726 msgstr ""
54727
54728 #. type: Plain text
54729 #: guix-git/doc/guix.texi:30801
54730 msgid "Available @code{opaque-cgit-configuration} fields are:"
54731 msgstr ""
54732
54733 #. type: deftypevr
54734 #: guix-git/doc/guix.texi:30802
54735 #, no-wrap
54736 msgid "{@code{opaque-cgit-configuration} parameter} package cgit"
54737 msgstr ""
54738
54739 #. type: deftypevr
54740 #: guix-git/doc/guix.texi:30804
54741 msgid "The cgit package."
54742 msgstr ""
54743
54744 #. type: deftypevr
54745 #: guix-git/doc/guix.texi:30806
54746 #, no-wrap
54747 msgid "{@code{opaque-cgit-configuration} parameter} string string"
54748 msgstr ""
54749
54750 #. type: deftypevr
54751 #: guix-git/doc/guix.texi:30808
54752 msgid "The contents of the @code{cgitrc}, as a string."
54753 msgstr ""
54754
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:"
54758 msgstr ""
54759
54760 #. type: lisp
54761 #: guix-git/doc/guix.texi:30817
54762 #, no-wrap
54763 msgid ""
54764 "(service cgit-service-type\n"
54765 " (opaque-cgit-configuration\n"
54766 " (cgitrc \"\")))\n"
54767 msgstr ""
54768
54769 #. type: subsubheading
54770 #: guix-git/doc/guix.texi:30819
54771 #, no-wrap
54772 msgid "Gitolite Service"
54773 msgstr ""
54774
54775 #. type: cindex
54776 #: guix-git/doc/guix.texi:30821
54777 #, no-wrap
54778 msgid "Gitolite service"
54779 msgstr ""
54780
54781 #. type: cindex
54782 #: guix-git/doc/guix.texi:30822
54783 #, no-wrap
54784 msgid "Git, hosting"
54785 msgstr ""
54786
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."
54790 msgstr ""
54791
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."
54795 msgstr ""
54796
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."
54800 msgstr ""
54801
54802 #. type: lisp
54803 #: guix-git/doc/guix.texi:30838
54804 #, no-wrap
54805 msgid ""
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"
54811 msgstr ""
54812
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."
54816 msgstr ""
54817
54818 #. type: example
54819 #: guix-git/doc/guix.texi:30846
54820 #, no-wrap
54821 msgid "git clone git@@example.com:gitolite-admin\n"
54822 msgstr ""
54823
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''."
54827 msgstr ""
54828
54829 #. type: deftp
54830 #: guix-git/doc/guix.texi:30853
54831 #, no-wrap
54832 msgid "{Data Type} gitolite-configuration"
54833 msgstr ""
54834
54835 #. type: deftp
54836 #: guix-git/doc/guix.texi:30855
54837 msgid "Data type representing the configuration for @code{gitolite-service-type}."
54838 msgstr ""
54839
54840 #. type: item
54841 #: guix-git/doc/guix.texi:30857
54842 #, no-wrap
54843 msgid "@code{package} (default: @var{gitolite})"
54844 msgstr ""
54845
54846 #. type: table
54847 #: guix-git/doc/guix.texi:30859
54848 msgid "Gitolite package to use."
54849 msgstr ""
54850
54851 #. type: item
54852 #: guix-git/doc/guix.texi:30860
54853 #, no-wrap
54854 msgid "@code{user} (default: @var{git})"
54855 msgstr ""
54856
54857 #. type: table
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."
54860 msgstr ""
54861
54862 #. type: item
54863 #: guix-git/doc/guix.texi:30864
54864 #, no-wrap
54865 msgid "@code{group} (default: @var{git})"
54866 msgstr ""
54867
54868 #. type: table
54869 #: guix-git/doc/guix.texi:30866
54870 msgid "Group to use for Gitolite."
54871 msgstr ""
54872
54873 #. type: item
54874 #: guix-git/doc/guix.texi:30867
54875 #, no-wrap
54876 msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})"
54877 msgstr ""
54878
54879 #. type: table
54880 #: guix-git/doc/guix.texi:30869
54881 msgid "Directory in which to store the Gitolite configuration and repositories."
54882 msgstr ""
54883
54884 #. type: item
54885 #: guix-git/doc/guix.texi:30870
54886 #, no-wrap
54887 msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})"
54888 msgstr ""
54889
54890 #. type: table
54891 #: guix-git/doc/guix.texi:30873
54892 msgid "A ``file-like'' object (@pxref{G-Expressions, file-like objects}), representing the configuration for Gitolite."
54893 msgstr ""
54894
54895 #. type: item
54896 #: guix-git/doc/guix.texi:30874
54897 #, no-wrap
54898 msgid "@code{admin-pubkey} (default: @var{#f})"
54899 msgstr ""
54900
54901 #. type: table
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."
54904 msgstr ""
54905
54906 #. type: table
54907 #: guix-git/doc/guix.texi:30880
54908 msgid "To specify the SSH key as a string, use the @code{plain-file} function."
54909 msgstr ""
54910
54911 #. type: lisp
54912 #: guix-git/doc/guix.texi:30883
54913 #, no-wrap
54914 msgid "(plain-file \"yourname.pub\" \"ssh-rsa AAAA... guix@@example.com\")\n"
54915 msgstr ""
54916
54917 #. type: deftp
54918 #: guix-git/doc/guix.texi:30888
54919 #, no-wrap
54920 msgid "{Data Type} gitolite-rc-file"
54921 msgstr ""
54922
54923 #. type: deftp
54924 #: guix-git/doc/guix.texi:30890
54925 msgid "Data type representing the Gitolite RC file."
54926 msgstr ""
54927
54928 #. type: item
54929 #: guix-git/doc/guix.texi:30892
54930 #, no-wrap
54931 msgid "@code{umask} (default: @code{#o0077})"
54932 msgstr ""
54933
54934 #. type: table
54935 #: guix-git/doc/guix.texi:30895
54936 msgid "This controls the permissions Gitolite sets on the repositories and their contents."
54937 msgstr ""
54938
54939 #. type: table
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."
54942 msgstr ""
54943
54944 #. type: item
54945 #: guix-git/doc/guix.texi:30900
54946 #, no-wrap
54947 msgid "@code{git-config-keys} (default: @code{\"\"})"
54948 msgstr ""
54949
54950 #. type: table
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."
54953 msgstr ""
54954
54955 #. type: item
54956 #: guix-git/doc/guix.texi:30904
54957 #, no-wrap
54958 msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})"
54959 msgstr ""
54960
54961 #. type: table
54962 #: guix-git/doc/guix.texi:30906
54963 msgid "Set the role names allowed to be used by users running the perms command."
54964 msgstr ""
54965
54966 #. type: item
54967 #: guix-git/doc/guix.texi:30907
54968 #, no-wrap
54969 msgid "@code{enable} (default: @code{'(\"help\" \"desc\" \"info\" \"perms\" \"writable\" \"ssh-authkeys\" \"git-config\" \"daemon\" \"gitweb\")})"
54970 msgstr ""
54971
54972 #. type: table
54973 #: guix-git/doc/guix.texi:30909
54974 msgid "This setting controls the commands and features to enable within Gitolite."
54975 msgstr ""
54976
54977 #. type: subsubheading
54978 #: guix-git/doc/guix.texi:30917
54979 #, no-wrap
54980 msgid "The Battle for Wesnoth Service"
54981 msgstr ""
54982
54983 #. type: cindex
54984 #: guix-git/doc/guix.texi:30918
54985 #, no-wrap
54986 msgid "wesnothd"
54987 msgstr ""
54988
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)."
54992 msgstr ""
54993
54994 #. type: defvar
54995 #: guix-git/doc/guix.texi:30923
54996 #, no-wrap
54997 msgid "{Scheme Variable} wesnothd-service-type"
54998 msgstr ""
54999
55000 #. type: defvar
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:"
55003 msgstr ""
55004
55005 #. type: lisp
55006 #: guix-git/doc/guix.texi:30930
55007 #, no-wrap
55008 msgid "(service wesnothd-service-type)\n"
55009 msgstr ""
55010
55011 #. type: deftp
55012 #: guix-git/doc/guix.texi:30933
55013 #, no-wrap
55014 msgid "{Data Type} wesnothd-configuration"
55015 msgstr ""
55016
55017 #. type: deftp
55018 #: guix-git/doc/guix.texi:30935
55019 msgid "Data type representing the configuration of @command{wesnothd}."
55020 msgstr ""
55021
55022 #. type: item
55023 #: guix-git/doc/guix.texi:30937
55024 #, no-wrap
55025 msgid "@code{package} (default: @code{wesnoth-server})"
55026 msgstr ""
55027
55028 #. type: table
55029 #: guix-git/doc/guix.texi:30939
55030 msgid "The wesnoth server package to use."
55031 msgstr ""
55032
55033 #. type: item
55034 #: guix-git/doc/guix.texi:30940
55035 #, no-wrap
55036 msgid "@code{port} (default: @code{15000})"
55037 msgstr ""
55038
55039 #. type: table
55040 #: guix-git/doc/guix.texi:30942
55041 msgid "The port to bind the server to."
55042 msgstr ""
55043
55044 #. type: cindex
55045 #: guix-git/doc/guix.texi:30948
55046 #, no-wrap
55047 msgid "pam-mount"
55048 msgstr ""
55049
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."
55053 msgstr ""
55054
55055 #. type: defvar
55056 #: guix-git/doc/guix.texi:30954
55057 #, no-wrap
55058 msgid "{Scheme Variable} pam-mount-service-type"
55059 msgstr ""
55060
55061 #. type: defvar
55062 #: guix-git/doc/guix.texi:30956
55063 msgid "Service type for PAM Mount support."
55064 msgstr ""
55065
55066 #. type: deftp
55067 #: guix-git/doc/guix.texi:30958
55068 #, no-wrap
55069 msgid "{Data Type} pam-mount-configuration"
55070 msgstr ""
55071
55072 #. type: deftp
55073 #: guix-git/doc/guix.texi:30960
55074 msgid "Data type representing the configuration of PAM Mount."
55075 msgstr ""
55076
55077 #. type: code{#1}
55078 #: guix-git/doc/guix.texi:30964
55079 #, no-wrap
55080 msgid "rules"
55081 msgstr ""
55082
55083 #. type: table
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}."
55086 msgstr ""
55087
55088 #. type: table
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:"
55091 msgstr ""
55092
55093 #. type: lisp
55094 #: guix-git/doc/guix.texi:30986
55095 #, no-wrap
55096 msgid ""
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"
55102 " \",\"))))\n"
55103 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55104 " (logout (@@ (wait \"0\")\n"
55105 " (hup \"0\")\n"
55106 " (term \"no\")\n"
55107 " (kill \"no\")))\n"
55108 " (mkmountpoint (@@ (enable \"1\")\n"
55109 " (remove \"true\"))))\n"
55110 msgstr ""
55111
55112 #. type: table
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:"
55115 msgstr ""
55116
55117 #. type: lisp
55118 #: guix-git/doc/guix.texi:31017
55119 #, no-wrap
55120 msgid ""
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"
55136 " \",\"))))\n"
55137 " (mntoptions (@@ (require \"nosuid,nodev\")))\n"
55138 " (logout (@@ (wait \"0\")\n"
55139 " (hup \"0\")\n"
55140 " (term \"no\")\n"
55141 " (kill \"no\")))\n"
55142 " (mkmountpoint (@@ (enable \"1\")\n"
55143 " (remove \"true\")))))\n"
55144 "\n"
55145 msgstr ""
55146
55147 #. type: lisp
55148 #: guix-git/doc/guix.texi:31021
55149 #, no-wrap
55150 msgid ""
55151 "(service pam-mount-service-type\n"
55152 " (pam-mount-configuration\n"
55153 " (rules pam-mount-rules)))\n"
55154 msgstr ""
55155
55156 #. type: table
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}."
55159 msgstr ""
55160
55161 #. type: subsubheading
55162 #: guix-git/doc/guix.texi:31032
55163 #, no-wrap
55164 msgid "Guix Build Coordinator"
55165 msgstr ""
55166
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."
55170 msgstr ""
55171
55172 #. type: quotation
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."
55175 msgstr ""
55176
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."
55180 msgstr ""
55181
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."
55185 msgstr ""
55186
55187 #. type: defvar
55188 #: guix-git/doc/guix.texi:31055
55189 #, no-wrap
55190 msgid "{Scheme Variable} guix-build-coordinator-service-type"
55191 msgstr ""
55192
55193 #. type: defvar
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."
55196 msgstr ""
55197
55198 #. type: deftp
55199 #: guix-git/doc/guix.texi:31060
55200 #, no-wrap
55201 msgid "{Data Type} guix-build-coordinator-configuration"
55202 msgstr ""
55203
55204 #. type: deftp
55205 #: guix-git/doc/guix.texi:31062
55206 msgid "Data type representing the configuration of the Guix Build Coordinator."
55207 msgstr ""
55208
55209 #. type: item
55210 #: guix-git/doc/guix.texi:31064 guix-git/doc/guix.texi:31108
55211 #: guix-git/doc/guix.texi:31225
55212 #, no-wrap
55213 msgid "@code{package} (default: @code{guix-build-coordinator})"
55214 msgstr ""
55215
55216 #. type: table
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."
55220 msgstr ""
55221
55222 #. type: item
55223 #: guix-git/doc/guix.texi:31067
55224 #, no-wrap
55225 msgid "@code{user} (default: @code{\"guix-build-coordinator\"})"
55226 msgstr ""
55227
55228 #. type: table
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."
55232 msgstr ""
55233
55234 #. type: item
55235 #: guix-git/doc/guix.texi:31070
55236 #, no-wrap
55237 msgid "@code{group} (default: @code{\"guix-build-coordinator\"})"
55238 msgstr ""
55239
55240 #. type: table
55241 #: guix-git/doc/guix.texi:31072 guix-git/doc/guix.texi:31279
55242 msgid "The system group to run the service as."
55243 msgstr ""
55244
55245 #. type: item
55246 #: guix-git/doc/guix.texi:31073
55247 #, no-wrap
55248 msgid "@code{database-uri-string} (default: @code{\"sqlite:///var/lib/guix-build-coordinator/guix_build_coordinator.db\"})"
55249 msgstr ""
55250
55251 #. type: table
55252 #: guix-git/doc/guix.texi:31075
55253 msgid "The URI to use for the database."
55254 msgstr ""
55255
55256 #. type: item
55257 #: guix-git/doc/guix.texi:31076
55258 #, no-wrap
55259 msgid "@code{agent-communication-uri} (default: @code{\"http://0.0.0.0:8745\"})"
55260 msgstr ""
55261
55262 #. type: table
55263 #: guix-git/doc/guix.texi:31078
55264 msgid "The URI describing how to listen to requests from agent processes."
55265 msgstr ""
55266
55267 #. type: item
55268 #: guix-git/doc/guix.texi:31079
55269 #, no-wrap
55270 msgid "@code{client-communication-uri} (default: @code{\"http://127.0.0.1:8746\"})"
55271 msgstr ""
55272
55273 #. type: table
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."
55276 msgstr ""
55277
55278 #. type: item
55279 #: guix-git/doc/guix.texi:31084
55280 #, no-wrap
55281 msgid "@code{allocation-strategy} (default: @code{#~basic-build-allocation-strategy})"
55282 msgstr ""
55283
55284 #. type: table
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."
55287 msgstr ""
55288
55289 #. type: item
55290 #: guix-git/doc/guix.texi:31089
55291 #, no-wrap
55292 msgid "@code{hooks} (default: @var{'()})"
55293 msgstr ""
55294
55295 #. type: table
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."
55298 msgstr ""
55299
55300 #. type: item
55301 #: guix-git/doc/guix.texi:31093
55302 #, no-wrap
55303 msgid "@code{guile} (default: @code{guile-3.0-latest})"
55304 msgstr ""
55305
55306 #. type: table
55307 #: guix-git/doc/guix.texi:31095
55308 msgid "The Guile package with which to run the Guix Build Coordinator."
55309 msgstr ""
55310
55311 #. type: defvar
55312 #: guix-git/doc/guix.texi:31099
55313 #, no-wrap
55314 msgid "{Scheme Variable} guix-build-coordinator-agent-service-type"
55315 msgstr ""
55316
55317 #. type: defvar
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."
55320 msgstr ""
55321
55322 #. type: deftp
55323 #: guix-git/doc/guix.texi:31104
55324 #, no-wrap
55325 msgid "{Data Type} guix-build-coordinator-agent-configuration"
55326 msgstr ""
55327
55328 #. type: deftp
55329 #: guix-git/doc/guix.texi:31106
55330 msgid "Data type representing the configuration a Guix Build Coordinator agent."
55331 msgstr ""
55332
55333 #. type: item
55334 #: guix-git/doc/guix.texi:31111
55335 #, no-wrap
55336 msgid "@code{user} (default: @code{\"guix-build-coordinator-agent\"})"
55337 msgstr ""
55338
55339 #. type: item
55340 #: guix-git/doc/guix.texi:31114 guix-git/doc/guix.texi:31231
55341 #, no-wrap
55342 msgid "@code{coordinator} (default: @code{\"http://localhost:8745\"})"
55343 msgstr ""
55344
55345 #. type: table
55346 #: guix-git/doc/guix.texi:31116 guix-git/doc/guix.texi:31233
55347 msgid "The URI to use when connecting to the coordinator."
55348 msgstr ""
55349
55350 #. type: code{#1}
55351 #: guix-git/doc/guix.texi:31117
55352 #, no-wrap
55353 msgid "authentication"
55354 msgstr ""
55355
55356 #. type: table
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."
55359 msgstr ""
55360
55361 #. type: item
55362 #: guix-git/doc/guix.texi:31121 guix-git/doc/guix.texi:31234
55363 #, no-wrap
55364 msgid "@code{systems} (default: @code{#f})"
55365 msgstr ""
55366
55367 #. type: table
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."
55370 msgstr ""
55371
55372 #. type: item
55373 #: guix-git/doc/guix.texi:31125
55374 #, no-wrap
55375 msgid "@code{max-parallel-builds} (default: @code{1})"
55376 msgstr ""
55377
55378 #. type: table
55379 #: guix-git/doc/guix.texi:31127
55380 msgid "The number of builds to perform in parallel."
55381 msgstr ""
55382
55383 #. type: item
55384 #: guix-git/doc/guix.texi:31128
55385 #, no-wrap
55386 msgid "@code{derivation-substitute-urls} (default: @code{#f})"
55387 msgstr ""
55388
55389 #. type: table
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."
55392 msgstr ""
55393
55394 #. type: item
55395 #: guix-git/doc/guix.texi:31132
55396 #, no-wrap
55397 msgid "@code{non-derivation-substitute-urls} (default: @code{#f})"
55398 msgstr ""
55399
55400 #. type: table
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."
55403 msgstr ""
55404
55405 #. type: deftp
55406 #: guix-git/doc/guix.texi:31139
55407 #, no-wrap
55408 msgid "{Data Type} guix-build-coordinator-agent-password-auth"
55409 msgstr ""
55410
55411 #. type: deftp
55412 #: guix-git/doc/guix.texi:31142
55413 msgid "Data type representing an agent authenticating with a coordinator via a UUID and password."
55414 msgstr ""
55415
55416 #. type: table
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."
55419 msgstr ""
55420
55421 #. type: table
55422 #: guix-git/doc/guix.texi:31151
55423 msgid "The password to use when connecting to the coordinator."
55424 msgstr ""
55425
55426 #. type: deftp
55427 #: guix-git/doc/guix.texi:31155
55428 #, no-wrap
55429 msgid "{Data Type} guix-build-coordinator-agent-password-file-auth"
55430 msgstr ""
55431
55432 #. type: deftp
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."
55435 msgstr ""
55436
55437 #. type: code{#1}
55438 #: guix-git/doc/guix.texi:31165
55439 #, no-wrap
55440 msgid "password-file"
55441 msgstr ""
55442
55443 #. type: table
55444 #: guix-git/doc/guix.texi:31168
55445 msgid "A file containing the password to use when connecting to the coordinator."
55446 msgstr ""
55447
55448 #. type: deftp
55449 #: guix-git/doc/guix.texi:31172
55450 #, no-wrap
55451 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth"
55452 msgstr ""
55453
55454 #. type: deftp
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."
55457 msgstr ""
55458
55459 #. type: code{#1}
55460 #: guix-git/doc/guix.texi:31177 guix-git/doc/guix.texi:31194
55461 #, no-wrap
55462 msgid "agent-name"
55463 msgstr ""
55464
55465 #. type: table
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."
55468 msgstr ""
55469
55470 #. type: code{#1}
55471 #: guix-git/doc/guix.texi:31182
55472 #, no-wrap
55473 msgid "token"
55474 msgstr ""
55475
55476 #. type: table
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."
55479 msgstr ""
55480
55481 #. type: deftp
55482 #: guix-git/doc/guix.texi:31189
55483 #, no-wrap
55484 msgid "{Data Type} guix-build-coordinator-agent-dynamic-auth-with-file"
55485 msgstr ""
55486
55487 #. type: deftp
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."
55490 msgstr ""
55491
55492 #. type: code{#1}
55493 #: guix-git/doc/guix.texi:31199
55494 #, no-wrap
55495 msgid "token-file"
55496 msgstr ""
55497
55498 #. type: table
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."
55501 msgstr ""
55502
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."
55506 msgstr ""
55507
55508 #. type: defvar
55509 #: guix-git/doc/guix.texi:31213
55510 #, no-wrap
55511 msgid "{Scheme Variable} guix-build-coordinator-queue-builds-service-type"
55512 msgstr ""
55513
55514 #. type: defvar
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."
55517 msgstr ""
55518
55519 #. type: deftp
55520 #: guix-git/doc/guix.texi:31220
55521 #, no-wrap
55522 msgid "{Data Type} guix-build-coordinator-queue-builds-configuration"
55523 msgstr ""
55524
55525 #. type: deftp
55526 #: guix-git/doc/guix.texi:31223
55527 msgid "Data type representing the options to the queue builds from guix data service script."
55528 msgstr ""
55529
55530 #. type: item
55531 #: guix-git/doc/guix.texi:31228
55532 #, no-wrap
55533 msgid "@code{user} (default: @code{\"guix-build-coordinator-queue-builds\"})"
55534 msgstr ""
55535
55536 #. type: table
55537 #: guix-git/doc/guix.texi:31236
55538 msgid "The systems for which to fetch derivations to build."
55539 msgstr ""
55540
55541 #. type: item
55542 #: guix-git/doc/guix.texi:31237
55543 #, no-wrap
55544 msgid "@code{systems-and-targets} (default: @code{#f})"
55545 msgstr ""
55546
55547 #. type: table
55548 #: guix-git/doc/guix.texi:31240
55549 msgid "An association list of system and target pairs for which to fetch derivations to build."
55550 msgstr ""
55551
55552 #. type: item
55553 #: guix-git/doc/guix.texi:31241
55554 #, no-wrap
55555 msgid "@code{guix-data-service} (default: @code{\"https://data.guix.gnu.org\"})"
55556 msgstr ""
55557
55558 #. type: table
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."
55561 msgstr ""
55562
55563 #. type: item
55564 #: guix-git/doc/guix.texi:31245
55565 #, no-wrap
55566 msgid "@code{processed-commits-file} (default: @code{\"/var/cache/guix-build-coordinator-queue-builds/processed-commits\"})"
55567 msgstr ""
55568
55569 #. type: table
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."
55572 msgstr ""
55573
55574 #. type: subsubheading
55575 #: guix-git/doc/guix.texi:31252
55576 #, no-wrap
55577 msgid "Guix Data Service"
55578 msgstr ""
55579
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."
55583 msgstr ""
55584
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."
55588 msgstr ""
55589
55590 #. type: defvar
55591 #: guix-git/doc/guix.texi:31260
55592 #, no-wrap
55593 msgid "{Scheme Variable} guix-data-service-type"
55594 msgstr ""
55595
55596 #. type: defvar
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."
55599 msgstr ""
55600
55601 #. type: deftp
55602 #: guix-git/doc/guix.texi:31267
55603 #, no-wrap
55604 msgid "{Data Type} guix-data-service-configuration"
55605 msgstr ""
55606
55607 #. type: deftp
55608 #: guix-git/doc/guix.texi:31269
55609 msgid "Data type representing the configuration of the Guix Data Service."
55610 msgstr ""
55611
55612 #. type: item
55613 #: guix-git/doc/guix.texi:31271
55614 #, no-wrap
55615 msgid "@code{package} (default: @code{guix-data-service})"
55616 msgstr ""
55617
55618 #. type: table
55619 #: guix-git/doc/guix.texi:31273
55620 msgid "The Guix Data Service package to use."
55621 msgstr ""
55622
55623 #. type: item
55624 #: guix-git/doc/guix.texi:31274
55625 #, no-wrap
55626 msgid "@code{user} (default: @code{\"guix-data-service\"})"
55627 msgstr ""
55628
55629 #. type: item
55630 #: guix-git/doc/guix.texi:31277
55631 #, no-wrap
55632 msgid "@code{group} (default: @code{\"guix-data-service\"})"
55633 msgstr ""
55634
55635 #. type: item
55636 #: guix-git/doc/guix.texi:31280
55637 #, no-wrap
55638 msgid "@code{port} (default: @code{8765})"
55639 msgstr ""
55640
55641 #. type: table
55642 #: guix-git/doc/guix.texi:31282
55643 msgid "The port to bind the web service to."
55644 msgstr ""
55645
55646 #. type: item
55647 #: guix-git/doc/guix.texi:31283
55648 #, no-wrap
55649 msgid "@code{host} (default: @code{\"127.0.0.1\"})"
55650 msgstr ""
55651
55652 #. type: table
55653 #: guix-git/doc/guix.texi:31285
55654 msgid "The host to bind the web service to."
55655 msgstr ""
55656
55657 #. type: item
55658 #: guix-git/doc/guix.texi:31286
55659 #, no-wrap
55660 msgid "@code{getmail-idle-mailboxes} (default: @code{#f})"
55661 msgstr ""
55662
55663 #. type: table
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."
55666 msgstr ""
55667
55668 #. type: item
55669 #: guix-git/doc/guix.texi:31290
55670 #, no-wrap
55671 msgid "@code{commits-getmail-retriever-configuration} (default: @code{#f})"
55672 msgstr ""
55673
55674 #. type: table
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."
55677 msgstr ""
55678
55679 #. type: item
55680 #: guix-git/doc/guix.texi:31295
55681 #, no-wrap
55682 msgid "@code{extra-options} (default: @var{'()})"
55683 msgstr ""
55684
55685 #. type: table
55686 #: guix-git/doc/guix.texi:31297
55687 msgid "Extra command line options for @code{guix-data-service}."
55688 msgstr ""
55689
55690 #. type: item
55691 #: guix-git/doc/guix.texi:31298
55692 #, no-wrap
55693 msgid "@code{extra-process-jobs-options} (default: @var{'()})"
55694 msgstr ""
55695
55696 #. type: table
55697 #: guix-git/doc/guix.texi:31300
55698 msgid "Extra command line options for @code{guix-data-service-process-jobs}."
55699 msgstr ""
55700
55701 #. type: cindex
55702 #: guix-git/doc/guix.texi:31307
55703 #, no-wrap
55704 msgid "oom"
55705 msgstr ""
55706
55707 #. type: cindex
55708 #: guix-git/doc/guix.texi:31308
55709 #, no-wrap
55710 msgid "out of memory killer"
55711 msgstr ""
55712
55713 #. type: cindex
55714 #: guix-git/doc/guix.texi:31309
55715 #, no-wrap
55716 msgid "earlyoom"
55717 msgstr ""
55718
55719 #. type: cindex
55720 #: guix-git/doc/guix.texi:31310
55721 #, no-wrap
55722 msgid "early out of memory daemon"
55723 msgstr ""
55724
55725 #. type: subsubheading
55726 #: guix-git/doc/guix.texi:31311
55727 #, no-wrap
55728 msgid "Early OOM Service"
55729 msgstr ""
55730
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."
55734 msgstr ""
55735
55736 #. type: deffn
55737 #: guix-git/doc/guix.texi:31319
55738 #, no-wrap
55739 msgid "{Scheme Variable} earlyoom-service-type"
55740 msgstr ""
55741
55742 #. type: deffn
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:"
55745 msgstr ""
55746
55747 #. type: lisp
55748 #: guix-git/doc/guix.texi:31327
55749 #, no-wrap
55750 msgid "(service earlyoom-service-type)\n"
55751 msgstr ""
55752
55753 #. type: deftp
55754 #: guix-git/doc/guix.texi:31330
55755 #, no-wrap
55756 msgid "{Data Type} earlyoom-configuration"
55757 msgstr ""
55758
55759 #. type: deftp
55760 #: guix-git/doc/guix.texi:31332
55761 msgid "This is the configuration record for the @code{earlyoom-service-type}."
55762 msgstr ""
55763
55764 #. type: item
55765 #: guix-git/doc/guix.texi:31334
55766 #, no-wrap
55767 msgid "@code{earlyoom} (default: @var{earlyoom})"
55768 msgstr ""
55769
55770 #. type: table
55771 #: guix-git/doc/guix.texi:31336
55772 msgid "The Earlyoom package to use."
55773 msgstr ""
55774
55775 #. type: item
55776 #: guix-git/doc/guix.texi:31337
55777 #, no-wrap
55778 msgid "@code{minimum-available-memory} (default: @code{10})"
55779 msgstr ""
55780
55781 #. type: table
55782 #: guix-git/doc/guix.texi:31339
55783 msgid "The threshold for the minimum @emph{available} memory, in percentages."
55784 msgstr ""
55785
55786 #. type: item
55787 #: guix-git/doc/guix.texi:31340
55788 #, no-wrap
55789 msgid "@code{minimum-free-swap} (default: @code{10})"
55790 msgstr ""
55791
55792 #. type: table
55793 #: guix-git/doc/guix.texi:31342
55794 msgid "The threshold for the minimum free swap memory, in percentages."
55795 msgstr ""
55796
55797 #. type: item
55798 #: guix-git/doc/guix.texi:31343
55799 #, no-wrap
55800 msgid "@code{prefer-regexp} (default: @code{#f})"
55801 msgstr ""
55802
55803 #. type: table
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."
55806 msgstr ""
55807
55808 #. type: item
55809 #: guix-git/doc/guix.texi:31347
55810 #, no-wrap
55811 msgid "@code{avoid-regexp} (default: @code{#f})"
55812 msgstr ""
55813
55814 #. type: table
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."
55817 msgstr ""
55818
55819 #. type: item
55820 #: guix-git/doc/guix.texi:31351
55821 #, no-wrap
55822 msgid "@code{memory-report-interval} (default: @code{0})"
55823 msgstr ""
55824
55825 #. type: table
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."
55828 msgstr ""
55829
55830 #. type: item
55831 #: guix-git/doc/guix.texi:31355
55832 #, no-wrap
55833 msgid "@code{ignore-positive-oom-score-adj?} (default: @code{#f})"
55834 msgstr ""
55835
55836 #. type: table
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."
55839 msgstr ""
55840
55841 #. type: item
55842 #: guix-git/doc/guix.texi:31359
55843 #, no-wrap
55844 msgid "@code{show-debug-messages?} (default: @code{#f})"
55845 msgstr ""
55846
55847 #. type: table
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}."
55850 msgstr ""
55851
55852 #. type: item
55853 #: guix-git/doc/guix.texi:31363
55854 #, no-wrap
55855 msgid "@code{send-notification-command} (default: @code{#f})"
55856 msgstr ""
55857
55858 #. type: table
55859 #: guix-git/doc/guix.texi:31366
55860 msgid "This can be used to provide a custom command used for sending notifications."
55861 msgstr ""
55862
55863 #. type: cindex
55864 #: guix-git/doc/guix.texi:31369
55865 #, no-wrap
55866 msgid "modprobe"
55867 msgstr ""
55868
55869 #. type: cindex
55870 #: guix-git/doc/guix.texi:31370
55871 #, no-wrap
55872 msgid "kernel module loader"
55873 msgstr ""
55874
55875 #. type: subsubheading
55876 #: guix-git/doc/guix.texi:31371
55877 #, no-wrap
55878 msgid "Kernel Module Loader Service"
55879 msgstr ""
55880
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}."
55884 msgstr ""
55885
55886 #. type: deffn
55887 #: guix-git/doc/guix.texi:31378
55888 #, no-wrap
55889 msgid "{Scheme Variable} kernel-module-loader-service-type"
55890 msgstr ""
55891
55892 #. type: deffn
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:"
55895 msgstr ""
55896
55897 #. type: lisp
55898 #: guix-git/doc/guix.texi:31389
55899 #, no-wrap
55900 msgid ""
55901 "(use-modules (gnu) (gnu services))\n"
55902 "(use-package-modules linux)\n"
55903 "(use-service-modules linux)\n"
55904 "\n"
55905 msgstr ""
55906
55907 #. type: lisp
55908 #: guix-git/doc/guix.texi:31393
55909 #, no-wrap
55910 msgid ""
55911 "(define ddcci-config\n"
55912 " (plain-file \"ddcci.conf\"\n"
55913 " \"options ddcci dyndbg delay=120\"))\n"
55914 "\n"
55915 msgstr ""
55916
55917 #. type: lisp
55918 #: guix-git/doc/guix.texi:31403
55919 #, no-wrap
55920 msgid ""
55921 "(operating-system\n"
55922 " ...\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"
55930 msgstr ""
55931
55932 #. type: cindex
55933 #: guix-git/doc/guix.texi:31406
55934 #, no-wrap
55935 msgid "zram"
55936 msgstr ""
55937
55938 #. type: cindex
55939 #: guix-git/doc/guix.texi:31407
55940 #, no-wrap
55941 msgid "compressed swap"
55942 msgstr ""
55943
55944 #. type: cindex
55945 #: guix-git/doc/guix.texi:31408
55946 #, no-wrap
55947 msgid "Compressed RAM-based block devices"
55948 msgstr ""
55949
55950 #. type: subsubheading
55951 #: guix-git/doc/guix.texi:31409
55952 #, no-wrap
55953 msgid "Zram Device Service"
55954 msgstr ""
55955
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."
55959 msgstr ""
55960
55961 #. type: deffn
55962 #: guix-git/doc/guix.texi:31416
55963 #, no-wrap
55964 msgid "{Scheme Variable} zram-device-service-type"
55965 msgstr ""
55966
55967 #. type: deffn
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."
55970 msgstr ""
55971
55972 #. type: deftp
55973 #: guix-git/doc/guix.texi:31421
55974 #, no-wrap
55975 msgid "{Data Type} zram-device-configuration"
55976 msgstr ""
55977
55978 #. type: deftp
55979 #: guix-git/doc/guix.texi:31424
55980 msgid "This is the data type representing the configuration for the zram-device service."
55981 msgstr ""
55982
55983 #. type: item
55984 #: guix-git/doc/guix.texi:31426
55985 #, no-wrap
55986 msgid "@code{size} (default @code{\"1G\"})"
55987 msgstr ""
55988
55989 #. type: table
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}."
55992 msgstr ""
55993
55994 #. type: item
55995 #: guix-git/doc/guix.texi:31430
55996 #, no-wrap
55997 msgid "@code{compression-algorithm} (default @code{'lzo})"
55998 msgstr ""
55999
56000 #. type: table
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}."
56003 msgstr ""
56004
56005 #. type: item
56006 #: guix-git/doc/guix.texi:31434
56007 #, no-wrap
56008 msgid "@code{memory-limit} (default @code{0})"
56009 msgstr ""
56010
56011 #. type: table
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\"}."
56014 msgstr ""
56015
56016 #. type: item
56017 #: guix-git/doc/guix.texi:31441
56018 #, no-wrap
56019 msgid "@code{priority} (default @code{-1})"
56020 msgstr ""
56021
56022 #. type: table
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."
56025 msgstr ""
56026
56027 #. type: defvr
56028 #: guix-git/doc/guix.texi:31454
56029 #, no-wrap
56030 msgid "{Scheme Variable} hurd-console-service-type"
56031 msgstr ""
56032
56033 #. type: defvr
56034 #: guix-git/doc/guix.texi:31456
56035 msgid "This service starts the fancy @code{VGA} console client on the Hurd."
56036 msgstr ""
56037
56038 #. type: defvr
56039 #: guix-git/doc/guix.texi:31458
56040 msgid "The service's value is a @code{hurd-console-configuration} record."
56041 msgstr ""
56042
56043 #. type: deftp
56044 #: guix-git/doc/guix.texi:31460
56045 #, no-wrap
56046 msgid "{Data Type} hurd-console-configuration"
56047 msgstr ""
56048
56049 #. type: deftp
56050 #: guix-git/doc/guix.texi:31463
56051 msgid "This is the data type representing the configuration for the hurd-console-service."
56052 msgstr ""
56053
56054 #. type: item
56055 #: guix-git/doc/guix.texi:31465 guix-git/doc/guix.texi:31481
56056 #, no-wrap
56057 msgid "@code{hurd} (default: @var{hurd})"
56058 msgstr ""
56059
56060 #. type: table
56061 #: guix-git/doc/guix.texi:31467 guix-git/doc/guix.texi:31483
56062 msgid "The Hurd package to use."
56063 msgstr ""
56064
56065 #. type: defvr
56066 #: guix-git/doc/guix.texi:31470
56067 #, no-wrap
56068 msgid "{Scheme Variable} hurd-getty-service-type"
56069 msgstr ""
56070
56071 #. type: defvr
56072 #: guix-git/doc/guix.texi:31472
56073 msgid "This service starts a tty using the Hurd @code{getty} program."
56074 msgstr ""
56075
56076 #. type: defvr
56077 #: guix-git/doc/guix.texi:31474
56078 msgid "The service's value is a @code{hurd-getty-configuration} record."
56079 msgstr ""
56080
56081 #. type: deftp
56082 #: guix-git/doc/guix.texi:31476
56083 #, no-wrap
56084 msgid "{Data Type} hurd-getty-configuration"
56085 msgstr ""
56086
56087 #. type: deftp
56088 #: guix-git/doc/guix.texi:31479
56089 msgid "This is the data type representing the configuration for the hurd-getty-service."
56090 msgstr ""
56091
56092 #. type: table
56093 #: guix-git/doc/guix.texi:31486
56094 msgid "The name of the console this Getty runs on---e.g., @code{\"tty1\"}."
56095 msgstr ""
56096
56097 #. type: item
56098 #: guix-git/doc/guix.texi:31487
56099 #, no-wrap
56100 msgid "@code{baud-rate} (default: @code{38400})"
56101 msgstr ""
56102
56103 #. type: table
56104 #: guix-git/doc/guix.texi:31489
56105 msgid "An integer specifying the baud rate of the tty."
56106 msgstr ""
56107
56108 #. type: cindex
56109 #: guix-git/doc/guix.texi:31496
56110 #, no-wrap
56111 msgid "fingerprint"
56112 msgstr ""
56113
56114 #. type: subsubheading
56115 #: guix-git/doc/guix.texi:31497
56116 #, no-wrap
56117 msgid "Fingerprint Service"
56118 msgstr ""
56119
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."
56123 msgstr ""
56124
56125 #. type: defvr
56126 #: guix-git/doc/guix.texi:31502
56127 #, no-wrap
56128 msgid "{Scheme Variable} fprintd-service-type"
56129 msgstr ""
56130
56131 #. type: defvr
56132 #: guix-git/doc/guix.texi:31505
56133 msgid "The service type for @command{fprintd}, which provides the fingerprint reading capability."
56134 msgstr ""
56135
56136 #. type: lisp
56137 #: guix-git/doc/guix.texi:31508
56138 #, no-wrap
56139 msgid "(service fprintd-service-type)\n"
56140 msgstr ""
56141
56142 #. type: cindex
56143 #: guix-git/doc/guix.texi:31511
56144 #, no-wrap
56145 msgid "sysctl"
56146 msgstr ""
56147
56148 #. type: subsubheading
56149 #: guix-git/doc/guix.texi:31512
56150 #, no-wrap
56151 msgid "System Control Service"
56152 msgstr ""
56153
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."
56157 msgstr ""
56158
56159 #. type: defvr
56160 #: guix-git/doc/guix.texi:31517
56161 #, no-wrap
56162 msgid "{Scheme Variable} sysctl-service-type"
56163 msgstr ""
56164
56165 #. type: defvr
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:"
56168 msgstr ""
56169
56170 #. type: lisp
56171 #: guix-git/doc/guix.texi:31526
56172 #, no-wrap
56173 msgid ""
56174 "(service sysctl-service-type\n"
56175 " (sysctl-configuration\n"
56176 " (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n"
56177 msgstr ""
56178
56179 #. type: defvr
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}})."
56182 msgstr ""
56183
56184 #. type: lisp
56185 #: guix-git/doc/guix.texi:31540
56186 #, no-wrap
56187 msgid ""
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"
56193 msgstr ""
56194
56195 #. type: deftp
56196 #: guix-git/doc/guix.texi:31544
56197 #, no-wrap
56198 msgid "{Data Type} sysctl-configuration"
56199 msgstr ""
56200
56201 #. type: deftp
56202 #: guix-git/doc/guix.texi:31546
56203 msgid "The data type representing the configuration of @command{sysctl}."
56204 msgstr ""
56205
56206 #. type: item
56207 #: guix-git/doc/guix.texi:31548
56208 #, no-wrap
56209 msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})"
56210 msgstr ""
56211
56212 #. type: table
56213 #: guix-git/doc/guix.texi:31550
56214 msgid "The @command{sysctl} executable to use."
56215 msgstr ""
56216
56217 #. type: item
56218 #: guix-git/doc/guix.texi:31551
56219 #, no-wrap
56220 msgid "@code{settings} (default: @code{%default-sysctl-settings})"
56221 msgstr ""
56222
56223 #. type: table
56224 #: guix-git/doc/guix.texi:31553
56225 msgid "An association list specifies kernel parameters and their values."
56226 msgstr ""
56227
56228 #. type: defvr
56229 #: guix-git/doc/guix.texi:31556
56230 #, no-wrap
56231 msgid "{Scheme Variable} %default-sysctl-settings"
56232 msgstr ""
56233
56234 #. type: defvr
56235 #: guix-git/doc/guix.texi:31559
56236 msgid "An association list specifying the default @command{sysctl} parameters on Guix System."
56237 msgstr ""
56238
56239 #. type: cindex
56240 #: guix-git/doc/guix.texi:31561
56241 #, no-wrap
56242 msgid "pcscd"
56243 msgstr ""
56244
56245 #. type: subsubheading
56246 #: guix-git/doc/guix.texi:31562
56247 #, no-wrap
56248 msgid "PC/SC Smart Card Daemon Service"
56249 msgstr ""
56250
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."
56254 msgstr ""
56255
56256 #. type: defvr
56257 #: guix-git/doc/guix.texi:31570
56258 #, no-wrap
56259 msgid "{Scheme Variable} pcscd-service-type"
56260 msgstr ""
56261
56262 #. type: defvr
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:"
56265 msgstr ""
56266
56267 #. type: lisp
56268 #: guix-git/doc/guix.texi:31577
56269 #, no-wrap
56270 msgid "(service pcscd-service-type)\n"
56271 msgstr ""
56272
56273 #. type: deftp
56274 #: guix-git/doc/guix.texi:31580
56275 #, no-wrap
56276 msgid "{Data Type} pcscd-configuration"
56277 msgstr ""
56278
56279 #. type: deftp
56280 #: guix-git/doc/guix.texi:31582
56281 msgid "The data type representing the configuration of @command{pcscd}."
56282 msgstr ""
56283
56284 #. type: item
56285 #: guix-git/doc/guix.texi:31584
56286 #, no-wrap
56287 msgid "@code{pcsc-lite} (default: @code{pcsc-lite})"
56288 msgstr ""
56289
56290 #. type: table
56291 #: guix-git/doc/guix.texi:31586
56292 msgid "The pcsc-lite package that provides pcscd."
56293 msgstr ""
56294
56295 #. type: item
56296 #: guix-git/doc/guix.texi:31586
56297 #, no-wrap
56298 msgid "@code{usb-drivers} (default: @code{(list ccid)})"
56299 msgstr ""
56300
56301 #. type: table
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."
56304 msgstr ""
56305
56306 #. type: cindex
56307 #: guix-git/doc/guix.texi:31592
56308 #, no-wrap
56309 msgid "lirc"
56310 msgstr ""
56311
56312 #. type: subsubheading
56313 #: guix-git/doc/guix.texi:31593
56314 #, no-wrap
56315 msgid "Lirc Service"
56316 msgstr ""
56317
56318 #. type: Plain text
56319 #: guix-git/doc/guix.texi:31596
56320 msgid "The @code{(gnu services lirc)} module provides the following service."
56321 msgstr ""
56322
56323 #. type: deffn
56324 #: guix-git/doc/guix.texi:31597
56325 #, no-wrap
56326 msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @"
56327 msgstr ""
56328
56329 #. type: deffn
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."
56332 msgstr ""
56333
56334 #. type: deffn
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."
56337 msgstr ""
56338
56339 #. type: deffn
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}."
56342 msgstr ""
56343
56344 #. type: cindex
56345 #: guix-git/doc/guix.texi:31611
56346 #, no-wrap
56347 msgid "spice"
56348 msgstr ""
56349
56350 #. type: subsubheading
56351 #: guix-git/doc/guix.texi:31612
56352 #, no-wrap
56353 msgid "Spice Service"
56354 msgstr ""
56355
56356 #. type: Plain text
56357 #: guix-git/doc/guix.texi:31615
56358 msgid "The @code{(gnu services spice)} module provides the following service."
56359 msgstr ""
56360
56361 #. type: deffn
56362 #: guix-git/doc/guix.texi:31616
56363 #, no-wrap
56364 msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]"
56365 msgstr ""
56366
56367 #. type: deffn
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."
56370 msgstr ""
56371
56372 #. type: cindex
56373 #: guix-git/doc/guix.texi:31622
56374 #, no-wrap
56375 msgid "inputattach"
56376 msgstr ""
56377
56378 #. type: subsubheading
56379 #: guix-git/doc/guix.texi:31623
56380 #, no-wrap
56381 msgid "inputattach Service"
56382 msgstr ""
56383
56384 #. type: cindex
56385 #: guix-git/doc/guix.texi:31625
56386 #, no-wrap
56387 msgid "tablet input, for Xorg"
56388 msgstr ""
56389
56390 #. type: cindex
56391 #: guix-git/doc/guix.texi:31626
56392 #, no-wrap
56393 msgid "touchscreen input, for Xorg"
56394 msgstr ""
56395
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."
56399 msgstr ""
56400
56401 #. type: deffn
56402 #: guix-git/doc/guix.texi:31631
56403 #, no-wrap
56404 msgid "{Scheme Variable} inputattach-service-type"
56405 msgstr ""
56406
56407 #. type: deffn
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."
56410 msgstr ""
56411
56412 #. type: deftp
56413 #: guix-git/doc/guix.texi:31636
56414 #, no-wrap
56415 msgid "{Data Type} inputattach-configuration"
56416 msgstr ""
56417
56418 #. type: item
56419 #: guix-git/doc/guix.texi:31638
56420 #, no-wrap
56421 msgid "@code{device-type} (default: @code{\"wacom\"})"
56422 msgstr ""
56423
56424 #. type: table
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."
56427 msgstr ""
56428
56429 #. type: item
56430 #: guix-git/doc/guix.texi:31642
56431 #, no-wrap
56432 msgid "@code{device} (default: @code{\"/dev/ttyS0\"})"
56433 msgstr ""
56434
56435 #. type: table
56436 #: guix-git/doc/guix.texi:31644
56437 msgid "The device file to connect to the device."
56438 msgstr ""
56439
56440 #. type: table
56441 #: guix-git/doc/guix.texi:31648
56442 msgid "Baud rate to use for the serial connection. Should be a number or @code{#f}."
56443 msgstr ""
56444
56445 #. type: item
56446 #: guix-git/doc/guix.texi:31649
56447 #, no-wrap
56448 msgid "@code{log-file} (default: @code{#f})"
56449 msgstr ""
56450
56451 #. type: table
56452 #: guix-git/doc/guix.texi:31651
56453 msgid "If true, this must be the name of a file to log messages to."
56454 msgstr ""
56455
56456 #. type: subsubheading
56457 #: guix-git/doc/guix.texi:31654
56458 #, no-wrap
56459 msgid "Dictionary Service"
56460 msgstr ""
56461
56462 #. type: cindex
56463 #: guix-git/doc/guix.texi:31655
56464 #, no-wrap
56465 msgid "dictionary"
56466 msgstr ""
56467
56468 #. type: Plain text
56469 #: guix-git/doc/guix.texi:31657
56470 msgid "The @code{(gnu services dict)} module provides the following service:"
56471 msgstr ""
56472
56473 #. type: defvr
56474 #: guix-git/doc/guix.texi:31658
56475 #, no-wrap
56476 msgid "{Scheme Variable} dicod-service-type"
56477 msgstr ""
56478
56479 #. type: defvr
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})."
56482 msgstr ""
56483
56484 #. type: deffn
56485 #: guix-git/doc/guix.texi:31663
56486 #, no-wrap
56487 msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]"
56488 msgstr ""
56489
56490 #. type: deffn
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})."
56493 msgstr ""
56494
56495 #. type: deffn
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."
56498 msgstr ""
56499
56500 #. type: deffn
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})."
56503 msgstr ""
56504
56505 #. type: deftp
56506 #: guix-git/doc/guix.texi:31676
56507 #, no-wrap
56508 msgid "{Data Type} dicod-configuration"
56509 msgstr ""
56510
56511 #. type: deftp
56512 #: guix-git/doc/guix.texi:31678
56513 msgid "Data type representing the configuration of dicod."
56514 msgstr ""
56515
56516 #. type: item
56517 #: guix-git/doc/guix.texi:31680
56518 #, no-wrap
56519 msgid "@code{dico} (default: @var{dico})"
56520 msgstr ""
56521
56522 #. type: table
56523 #: guix-git/doc/guix.texi:31682
56524 msgid "Package object of the GNU Dico dictionary server."
56525 msgstr ""
56526
56527 #. type: item
56528 #: guix-git/doc/guix.texi:31683
56529 #, no-wrap
56530 msgid "@code{interfaces} (default: @var{'(\"localhost\")})"
56531 msgstr ""
56532
56533 #. type: table
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})."
56536 msgstr ""
56537
56538 #. type: item
56539 #: guix-git/doc/guix.texi:31688
56540 #, no-wrap
56541 msgid "@code{handlers} (default: @var{'()})"
56542 msgstr ""
56543
56544 #. type: table
56545 #: guix-git/doc/guix.texi:31690
56546 msgid "List of @code{<dicod-handler>} objects denoting handlers (module instances)."
56547 msgstr ""
56548
56549 #. type: item
56550 #: guix-git/doc/guix.texi:31691
56551 #, no-wrap
56552 msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})"
56553 msgstr ""
56554
56555 #. type: table
56556 #: guix-git/doc/guix.texi:31693
56557 msgid "List of @code{<dicod-database>} objects denoting dictionaries to be served."
56558 msgstr ""
56559
56560 #. type: deftp
56561 #: guix-git/doc/guix.texi:31696
56562 #, no-wrap
56563 msgid "{Data Type} dicod-handler"
56564 msgstr ""
56565
56566 #. type: deftp
56567 #: guix-git/doc/guix.texi:31698
56568 msgid "Data type representing a dictionary handler (module instance)."
56569 msgstr ""
56570
56571 #. type: table
56572 #: guix-git/doc/guix.texi:31702
56573 msgid "Name of the handler (module instance)."
56574 msgstr ""
56575
56576 #. type: item
56577 #: guix-git/doc/guix.texi:31703
56578 #, no-wrap
56579 msgid "@code{module} (default: @var{#f})"
56580 msgstr ""
56581
56582 #. type: table
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})."
56585 msgstr ""
56586
56587 #. type: table
56588 #: guix-git/doc/guix.texi:31710
56589 msgid "List of strings or gexps representing the arguments for the module handler"
56590 msgstr ""
56591
56592 #. type: deftp
56593 #: guix-git/doc/guix.texi:31713
56594 #, no-wrap
56595 msgid "{Data Type} dicod-database"
56596 msgstr ""
56597
56598 #. type: deftp
56599 #: guix-git/doc/guix.texi:31715
56600 msgid "Data type representing a dictionary database."
56601 msgstr ""
56602
56603 #. type: table
56604 #: guix-git/doc/guix.texi:31719
56605 msgid "Name of the database, will be used in DICT commands."
56606 msgstr ""
56607
56608 #. type: code{#1}
56609 #: guix-git/doc/guix.texi:31720
56610 #, no-wrap
56611 msgid "handler"
56612 msgstr ""
56613
56614 #. type: table
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})."
56617 msgstr ""
56618
56619 #. type: item
56620 #: guix-git/doc/guix.texi:31724
56621 #, no-wrap
56622 msgid "@code{complex?} (default: @var{#f})"
56623 msgstr ""
56624
56625 #. type: table
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."
56628 msgstr ""
56629
56630 #. type: table
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})."
56633 msgstr ""
56634
56635 #. type: defvr
56636 #: guix-git/doc/guix.texi:31734
56637 #, no-wrap
56638 msgid "{Scheme Variable} %dicod-database:gcide"
56639 msgstr ""
56640
56641 #. type: defvr
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."
56644 msgstr ""
56645
56646 #. type: Plain text
56647 #: guix-git/doc/guix.texi:31740
56648 msgid "The following is an example @code{dicod-service} configuration."
56649 msgstr ""
56650
56651 #. type: lisp
56652 #: guix-git/doc/guix.texi:31755
56653 #, no-wrap
56654 msgid ""
56655 "(dicod-service #:config\n"
56656 " (dicod-configuration\n"
56657 " (handlers (list (dicod-handler\n"
56658 " (name \"wordnet\")\n"
56659 " (module \"dictorg\")\n"
56660 " (options\n"
56661 " (list #~(string-append \"dbdir=\" #$wordnet))))))\n"
56662 " (databases (list (dicod-database\n"
56663 " (name \"wordnet\")\n"
56664 " (complex? #t)\n"
56665 " (handler \"wordnet\")\n"
56666 " (options '(\"database=wn\")))\n"
56667 " %dicod-database:gcide))))\n"
56668 msgstr ""
56669
56670 #. type: cindex
56671 #: guix-git/doc/guix.texi:31757
56672 #, no-wrap
56673 msgid "Docker"
56674 msgstr ""
56675
56676 #. type: subsubheading
56677 #: guix-git/doc/guix.texi:31758
56678 #, no-wrap
56679 msgid "Docker Service"
56680 msgstr ""
56681
56682 #. type: Plain text
56683 #: guix-git/doc/guix.texi:31761
56684 msgid "The @code{(gnu services docker)} module provides the following services."
56685 msgstr ""
56686
56687 #. type: defvr
56688 #: guix-git/doc/guix.texi:31762
56689 #, no-wrap
56690 msgid "{Scheme Variable} docker-service-type"
56691 msgstr ""
56692
56693 #. type: defvr
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."
56696 msgstr ""
56697
56698 #. type: deftp
56699 #: guix-git/doc/guix.texi:31770
56700 #, no-wrap
56701 msgid "{Data Type} docker-configuration"
56702 msgstr ""
56703
56704 #. type: deftp
56705 #: guix-git/doc/guix.texi:31772
56706 msgid "This is the data type representing the configuration of Docker and Containerd."
56707 msgstr ""
56708
56709 #. type: item
56710 #: guix-git/doc/guix.texi:31775
56711 #, no-wrap
56712 msgid "@code{package} (default: @code{docker})"
56713 msgstr ""
56714
56715 #. type: table
56716 #: guix-git/doc/guix.texi:31777
56717 msgid "The Docker daemon package to use."
56718 msgstr ""
56719
56720 #. type: item
56721 #: guix-git/doc/guix.texi:31778
56722 #, no-wrap
56723 msgid "@code{package} (default: @code{docker-cli})"
56724 msgstr ""
56725
56726 #. type: table
56727 #: guix-git/doc/guix.texi:31780
56728 msgid "The Docker client package to use."
56729 msgstr ""
56730
56731 #. type: item
56732 #: guix-git/doc/guix.texi:31781
56733 #, no-wrap
56734 msgid "@code{containerd} (default: @var{containerd})"
56735 msgstr ""
56736
56737 #. type: table
56738 #: guix-git/doc/guix.texi:31783
56739 msgid "The Containerd package to use."
56740 msgstr ""
56741
56742 #. type: item
56743 #: guix-git/doc/guix.texi:31784
56744 #, no-wrap
56745 msgid "@code{proxy} (default @var{docker-libnetwork-cmd-proxy})"
56746 msgstr ""
56747
56748 #. type: table
56749 #: guix-git/doc/guix.texi:31786
56750 msgid "The Docker user-land networking proxy package to use."
56751 msgstr ""
56752
56753 #. type: item
56754 #: guix-git/doc/guix.texi:31787
56755 #, no-wrap
56756 msgid "@code{enable-proxy?} (default @code{#t})"
56757 msgstr ""
56758
56759 #. type: table
56760 #: guix-git/doc/guix.texi:31789
56761 msgid "Enable or disable the use of the Docker user-land networking proxy."
56762 msgstr ""
56763
56764 #. type: item
56765 #: guix-git/doc/guix.texi:31790
56766 #, no-wrap
56767 msgid "@code{debug?} (default @code{#f})"
56768 msgstr ""
56769
56770 #. type: table
56771 #: guix-git/doc/guix.texi:31792
56772 msgid "Enable or disable debug output."
56773 msgstr ""
56774
56775 #. type: item
56776 #: guix-git/doc/guix.texi:31793
56777 #, no-wrap
56778 msgid "@code{enable-iptables?} (default @code{#t})"
56779 msgstr ""
56780
56781 #. type: table
56782 #: guix-git/doc/guix.texi:31795
56783 msgid "Enable or disable the addition of iptables rules."
56784 msgstr ""
56785
56786 #. type: cindex
56787 #: guix-git/doc/guix.texi:31799
56788 #, no-wrap
56789 msgid "Singularity, container service"
56790 msgstr ""
56791
56792 #. type: defvr
56793 #: guix-git/doc/guix.texi:31800
56794 #, no-wrap
56795 msgid "{Scheme Variable} singularity-service-type"
56796 msgstr ""
56797
56798 #. type: defvr
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."
56801 msgstr ""
56802
56803 #. type: defvr
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."
56806 msgstr ""
56807
56808 #. type: cindex
56809 #: guix-git/doc/guix.texi:31811
56810 #, no-wrap
56811 msgid "Audit"
56812 msgstr ""
56813
56814 #. type: subsubheading
56815 #: guix-git/doc/guix.texi:31812
56816 #, no-wrap
56817 msgid "Auditd Service"
56818 msgstr ""
56819
56820 #. type: Plain text
56821 #: guix-git/doc/guix.texi:31815
56822 msgid "The @code{(gnu services auditd)} module provides the following service."
56823 msgstr ""
56824
56825 #. type: defvr
56826 #: guix-git/doc/guix.texi:31816
56827 #, no-wrap
56828 msgid "{Scheme Variable} auditd-service-type"
56829 msgstr ""
56830
56831 #. type: defvr
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."
56834 msgstr ""
56835
56836 #. type: defvr
56837 #: guix-git/doc/guix.texi:31823
56838 msgid "Examples of things that can be tracked:"
56839 msgstr ""
56840
56841 #. type: enumerate
56842 #: guix-git/doc/guix.texi:31827
56843 msgid "File accesses"
56844 msgstr ""
56845
56846 #. type: enumerate
56847 #: guix-git/doc/guix.texi:31829
56848 msgid "System calls"
56849 msgstr ""
56850
56851 #. type: enumerate
56852 #: guix-git/doc/guix.texi:31831
56853 msgid "Invoked commands"
56854 msgstr ""
56855
56856 #. type: enumerate
56857 #: guix-git/doc/guix.texi:31833
56858 msgid "Failed login attempts"
56859 msgstr ""
56860
56861 #. type: enumerate
56862 #: guix-git/doc/guix.texi:31835
56863 msgid "Firewall filtering"
56864 msgstr ""
56865
56866 #. type: enumerate
56867 #: guix-git/doc/guix.texi:31837
56868 msgid "Network access"
56869 msgstr ""
56870
56871 #. type: defvr
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}."
56874 msgstr ""
56875
56876 #. type: deftp
56877 #: guix-git/doc/guix.texi:31851
56878 #, no-wrap
56879 msgid "{Data Type} auditd-configuration"
56880 msgstr ""
56881
56882 #. type: deftp
56883 #: guix-git/doc/guix.texi:31853
56884 msgid "This is the data type representing the configuration of auditd."
56885 msgstr ""
56886
56887 #. type: item
56888 #: guix-git/doc/guix.texi:31856
56889 #, no-wrap
56890 msgid "@code{audit} (default: @code{audit})"
56891 msgstr ""
56892
56893 #. type: table
56894 #: guix-git/doc/guix.texi:31858
56895 msgid "The audit package to use."
56896 msgstr ""
56897
56898 #. type: item
56899 #: guix-git/doc/guix.texi:31859
56900 #, no-wrap
56901 msgid "@code{configuration-directory} (default: @code{%default-auditd-configuration-directory})"
56902 msgstr ""
56903
56904 #. type: table
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."
56907 msgstr ""
56908
56909 #. type: cindex
56910 #: guix-git/doc/guix.texi:31867
56911 #, no-wrap
56912 msgid "rshiny"
56913 msgstr ""
56914
56915 #. type: subsubheading
56916 #: guix-git/doc/guix.texi:31868
56917 #, no-wrap
56918 msgid "R-Shiny service"
56919 msgstr ""
56920
56921 #. type: Plain text
56922 #: guix-git/doc/guix.texi:31871
56923 msgid "The @code{(gnu services science)} module provides the following service."
56924 msgstr ""
56925
56926 #. type: defvr
56927 #: guix-git/doc/guix.texi:31872
56928 #, no-wrap
56929 msgid "{Scheme Variable} rshiny-service-type"
56930 msgstr ""
56931
56932 #. type: defvr
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}."
56935 msgstr ""
56936
56937 #. type: deftp
56938 #: guix-git/doc/guix.texi:31878
56939 #, no-wrap
56940 msgid "{Data Type} rshiny-configuration"
56941 msgstr ""
56942
56943 #. type: deftp
56944 #: guix-git/doc/guix.texi:31880
56945 msgid "This is the data type representing the configuration of rshiny."
56946 msgstr ""
56947
56948 #. type: item
56949 #: guix-git/doc/guix.texi:31883
56950 #, no-wrap
56951 msgid "@code{package} (default: @code{r-shiny})"
56952 msgstr ""
56953
56954 #. type: table
56955 #: guix-git/doc/guix.texi:31885
56956 msgid "The package to use."
56957 msgstr ""
56958
56959 #. type: item
56960 #: guix-git/doc/guix.texi:31886
56961 #, no-wrap
56962 msgid "@code{binary} (defaunlt @code{\"rshiny\"})"
56963 msgstr ""
56964
56965 #. type: table
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."
56968 msgstr ""
56969
56970 #. type: table
56971 #: guix-git/doc/guix.texi:31891
56972 msgid "The common way to create this file is as follows:"
56973 msgstr ""
56974
56975 #. type: lisp
56976 #: guix-git/doc/guix.texi:31909
56977 #, no-wrap
56978 msgid ""
56979 "@dots{}\n"
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"
56985 " ;; @dots{}\n"
56986 " (mkdir-p (string-append out \"/bin\"))\n"
56987 " (call-with-output-file app\n"
56988 " (lambda (port)\n"
56989 " (format port\n"
56990 "\"#!~a\n"
56991 "library(shiny)\n"
56992 "setwd(\\\"~a\\\")\n"
56993 "runApp(launch.browser=0, port=4202)~%\\n\"\n"
56994 " Rbin targetdir))))\n"
56995 msgstr ""
56996
56997 #. type: cindex
56998 #: guix-git/doc/guix.texi:31915
56999 #, no-wrap
57000 msgid "Nix"
57001 msgstr ""
57002
57003 #. type: subsubheading
57004 #: guix-git/doc/guix.texi:31916
57005 #, no-wrap
57006 msgid "Nix service"
57007 msgstr ""
57008
57009 #. type: Plain text
57010 #: guix-git/doc/guix.texi:31919
57011 msgid "The @code{(gnu services nix)} module provides the following service."
57012 msgstr ""
57013
57014 #. type: defvr
57015 #: guix-git/doc/guix.texi:31920
57016 #, no-wrap
57017 msgid "{Scheme Variable} nix-service-type"
57018 msgstr ""
57019
57020 #. type: defvr
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:"
57023 msgstr ""
57024
57025 #. type: lisp
57026 #: guix-git/doc/guix.texi:31930
57027 #, no-wrap
57028 msgid ""
57029 "(use-modules (gnu))\n"
57030 "(use-service-modules nix)\n"
57031 "(use-package-modules package-management)\n"
57032 "\n"
57033 msgstr ""
57034
57035 #. type: lisp
57036 #: guix-git/doc/guix.texi:31935
57037 #, no-wrap
57038 msgid ""
57039 "(operating-system\n"
57040 " ;; @dots{}\n"
57041 " (packages (append (list nix)\n"
57042 " %base-packages))\n"
57043 "\n"
57044 msgstr ""
57045
57046 #. type: lisp
57047 #: guix-git/doc/guix.texi:31938
57048 #, no-wrap
57049 msgid ""
57050 " (services (append (list (service nix-service-type))\n"
57051 " %base-services)))\n"
57052 msgstr ""
57053
57054 #. type: defvr
57055 #: guix-git/doc/guix.texi:31941
57056 msgid "After @command{guix system reconfigure} configure Nix for your user:"
57057 msgstr ""
57058
57059 #. type: item
57060 #: guix-git/doc/guix.texi:31943
57061 #, no-wrap
57062 msgid "Add a Nix channel and update it. See"
57063 msgstr ""
57064
57065 #. type: itemize
57066 #: guix-git/doc/guix.texi:31945
57067 msgid "@url{https://nixos.org/nix/manual/, Nix Package Manager Guide}."
57068 msgstr ""
57069
57070 #. type: item
57071 #: guix-git/doc/guix.texi:31946
57072 #, no-wrap
57073 msgid "Create a symlink to your profile and activate Nix profile:"
57074 msgstr ""
57075
57076 #. type: example
57077 #: guix-git/doc/guix.texi:31952
57078 #, no-wrap
57079 msgid ""
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"
57082 msgstr ""
57083
57084 #. type: deftp
57085 #: guix-git/doc/guix.texi:31956
57086 #, no-wrap
57087 msgid "{Data Type} nix-configuration"
57088 msgstr ""
57089
57090 #. type: deftp
57091 #: guix-git/doc/guix.texi:31958
57092 msgid "This data type represents the configuration of the Nix daemon."
57093 msgstr ""
57094
57095 #. type: item
57096 #: guix-git/doc/guix.texi:31960
57097 #, no-wrap
57098 msgid "@code{nix} (default: @code{nix})"
57099 msgstr ""
57100
57101 #. type: table
57102 #: guix-git/doc/guix.texi:31962
57103 msgid "The Nix package to use."
57104 msgstr ""
57105
57106 #. type: item
57107 #: guix-git/doc/guix.texi:31963
57108 #, no-wrap
57109 msgid "@code{sandbox} (default: @code{#t})"
57110 msgstr ""
57111
57112 #. type: table
57113 #: guix-git/doc/guix.texi:31965
57114 msgid "Specifies whether builds are sandboxed by default."
57115 msgstr ""
57116
57117 #. type: item
57118 #: guix-git/doc/guix.texi:31966
57119 #, no-wrap
57120 msgid "@code{build-sandbox-items} (default: @code{'()})"
57121 msgstr ""
57122
57123 #. type: table
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."
57126 msgstr ""
57127
57128 #. type: table
57129 #: guix-git/doc/guix.texi:31977
57130 msgid "Extra command line options for @code{nix-service-type}."
57131 msgstr ""
57132
57133 #. type: cindex
57134 #: guix-git/doc/guix.texi:31983
57135 #, no-wrap
57136 msgid "setuid programs"
57137 msgstr ""
57138
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)."
57142 msgstr ""
57143
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."
57147 msgstr ""
57148
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}):"
57152 msgstr ""
57153
57154 #. type: example
57155 #: guix-git/doc/guix.texi:32009
57156 #, no-wrap
57157 msgid "#~(string-append #$shadow \"/bin/passwd\")\n"
57158 msgstr ""
57159
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."
57163 msgstr ""
57164
57165 #. type: defvr
57166 #: guix-git/doc/guix.texi:32014
57167 #, no-wrap
57168 msgid "{Scheme Variable} %setuid-programs"
57169 msgstr ""
57170
57171 #. type: defvr
57172 #: guix-git/doc/guix.texi:32016
57173 msgid "A list of G-expressions denoting common programs that are setuid-root."
57174 msgstr ""
57175
57176 #. type: defvr
57177 #: guix-git/doc/guix.texi:32019
57178 msgid "The list includes commands such as @command{passwd}, @command{ping}, @command{su}, and @command{sudo}."
57179 msgstr ""
57180
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."
57184 msgstr ""
57185
57186 #. type: cindex
57187 #: guix-git/doc/guix.texi:32029
57188 #, no-wrap
57189 msgid "HTTPS, certificates"
57190 msgstr ""
57191
57192 #. type: cindex
57193 #: guix-git/doc/guix.texi:32030
57194 #, no-wrap
57195 msgid "X.509 certificates"
57196 msgstr ""
57197
57198 #. type: cindex
57199 #: guix-git/doc/guix.texi:32031
57200 #, no-wrap
57201 msgid "TLS"
57202 msgstr ""
57203
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."
57207 msgstr ""
57208
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."
57212 msgstr ""
57213
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."
57217 msgstr ""
57218
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."
57222 msgstr ""
57223
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."
57227 msgstr ""
57228
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:"
57232 msgstr ""
57233
57234 #. type: example
57235 #: guix-git/doc/guix.texi:32074
57236 #, no-wrap
57237 msgid ""
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"
57242 msgstr ""
57243
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:"
57247 msgstr ""
57248
57249 #. type: example
57250 #: guix-git/doc/guix.texi:32083
57251 #, no-wrap
57252 msgid ""
57253 "guix install nss-certs\n"
57254 "export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n"
57255 msgstr ""
57256
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."
57260 msgstr ""
57261
57262 #. type: cindex
57263 #: guix-git/doc/guix.texi:32092
57264 #, no-wrap
57265 msgid "name service switch"
57266 msgstr ""
57267
57268 #. type: cindex
57269 #: guix-git/doc/guix.texi:32093
57270 #, no-wrap
57271 msgid "NSS"
57272 msgstr ""
57273
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})."
57277 msgstr ""
57278
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}})."
57282 msgstr ""
57283
57284 #. type: cindex
57285 #: guix-git/doc/guix.texi:32110
57286 #, no-wrap
57287 msgid "nss-mdns"
57288 msgstr ""
57289
57290 #. type: cindex
57291 #: guix-git/doc/guix.texi:32111
57292 #, no-wrap
57293 msgid ".local, host name lookup"
57294 msgstr ""
57295
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}:"
57299 msgstr ""
57300
57301 #. type: lisp
57302 #: guix-git/doc/guix.texi:32120
57303 #, no-wrap
57304 msgid ""
57305 "(name-service-switch\n"
57306 " (hosts (list %files ;first, check /etc/hosts\n"
57307 "\n"
57308 msgstr ""
57309
57310 #. type: lisp
57311 #: guix-git/doc/guix.texi:32125
57312 #, no-wrap
57313 msgid ""
57314 " ;; If the above did not succeed, try\n"
57315 " ;; with 'mdns_minimal'.\n"
57316 " (name-service\n"
57317 " (name \"mdns_minimal\")\n"
57318 "\n"
57319 msgstr ""
57320
57321 #. type: lisp
57322 #: guix-git/doc/guix.texi:32131
57323 #, no-wrap
57324 msgid ""
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"
57330 "\n"
57331 msgstr ""
57332
57333 #. type: lisp
57334 #: guix-git/doc/guix.texi:32135
57335 #, no-wrap
57336 msgid ""
57337 " ;; Then fall back to DNS.\n"
57338 " (name-service\n"
57339 " (name \"dns\"))\n"
57340 "\n"
57341 msgstr ""
57342
57343 #. type: lisp
57344 #: guix-git/doc/guix.texi:32139
57345 #, no-wrap
57346 msgid ""
57347 " ;; Finally, try with the \"full\" 'mdns'.\n"
57348 " (name-service\n"
57349 " (name \"mdns\")))))\n"
57350 msgstr ""
57351
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."
57355 msgstr ""
57356
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}})."
57360 msgstr ""
57361
57362 #. type: Plain text
57363 #: guix-git/doc/guix.texi:32155
57364 msgid "For convenience, the following variables provide typical NSS configurations."
57365 msgstr ""
57366
57367 #. type: defvr
57368 #: guix-git/doc/guix.texi:32156
57369 #, no-wrap
57370 msgid "{Scheme Variable} %default-nss"
57371 msgstr ""
57372
57373 #. type: defvr
57374 #: guix-git/doc/guix.texi:32159
57375 msgid "This is the default name service switch configuration, a @code{name-service-switch} object."
57376 msgstr ""
57377
57378 #. type: defvr
57379 #: guix-git/doc/guix.texi:32161
57380 #, no-wrap
57381 msgid "{Scheme Variable} %mdns-host-lookup-nss"
57382 msgstr ""
57383
57384 #. type: defvr
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}."
57387 msgstr ""
57388
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}."
57392 msgstr ""
57393
57394 #. type: deftp
57395 #: guix-git/doc/guix.texi:32175
57396 #, no-wrap
57397 msgid "{Data Type} name-service-switch"
57398 msgstr ""
57399
57400 #. type: deftp
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."
57403 msgstr ""
57404
57405 #. type: item
57406 #: guix-git/doc/guix.texi:32182
57407 #, no-wrap
57408 msgid "aliases"
57409 msgstr ""
57410
57411 #. type: itemx
57412 #: guix-git/doc/guix.texi:32183
57413 #, no-wrap
57414 msgid "ethers"
57415 msgstr ""
57416
57417 #. type: itemx
57418 #: guix-git/doc/guix.texi:32185
57419 #, no-wrap
57420 msgid "gshadow"
57421 msgstr ""
57422
57423 #. type: itemx
57424 #: guix-git/doc/guix.texi:32186
57425 #, no-wrap
57426 msgid "hosts"
57427 msgstr ""
57428
57429 #. type: itemx
57430 #: guix-git/doc/guix.texi:32187
57431 #, no-wrap
57432 msgid "initgroups"
57433 msgstr ""
57434
57435 #. type: itemx
57436 #: guix-git/doc/guix.texi:32188
57437 #, no-wrap
57438 msgid "netgroup"
57439 msgstr ""
57440
57441 #. type: itemx
57442 #: guix-git/doc/guix.texi:32189
57443 #, no-wrap
57444 msgid "networks"
57445 msgstr ""
57446
57447 #. type: itemx
57448 #: guix-git/doc/guix.texi:32192
57449 #, no-wrap
57450 msgid "rpc"
57451 msgstr ""
57452
57453 #. type: itemx
57454 #: guix-git/doc/guix.texi:32194
57455 #, no-wrap
57456 msgid "shadow"
57457 msgstr ""
57458
57459 #. type: table
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)."
57462 msgstr ""
57463
57464 #. type: deftp
57465 #: guix-git/doc/guix.texi:32200
57466 #, no-wrap
57467 msgid "{Data Type} name-service"
57468 msgstr ""
57469
57470 #. type: deftp
57471 #: guix-git/doc/guix.texi:32204
57472 msgid "This is the data type representing an actual name service and the associated lookup action."
57473 msgstr ""
57474
57475 #. type: table
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})."
57478 msgstr ""
57479
57480 #. type: table
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}})."
57483 msgstr ""
57484
57485 #. type: item
57486 #: guix-git/doc/guix.texi:32215
57487 #, no-wrap
57488 msgid "reaction"
57489 msgstr ""
57490
57491 #. type: table
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:"
57494 msgstr ""
57495
57496 #. type: lisp
57497 #: guix-git/doc/guix.texi:32223
57498 #, no-wrap
57499 msgid ""
57500 "(lookup-specification (unavailable => continue)\n"
57501 " (success => return))\n"
57502 msgstr ""
57503
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."
57507 msgstr ""
57508
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:"
57512 msgstr ""
57513
57514 #. type: lisp
57515 #: guix-git/doc/guix.texi:32251
57516 #, no-wrap
57517 msgid ""
57518 "(operating-system\n"
57519 " ;; @dots{}\n"
57520 " (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n"
57521 msgstr ""
57522
57523 #. type: defvr
57524 #: guix-git/doc/guix.texi:32253
57525 #, no-wrap
57526 msgid "{Scheme Variable} %base-initrd-modules"
57527 msgstr ""
57528
57529 #. type: defvr
57530 #: guix-git/doc/guix.texi:32255
57531 msgid "This is the list of kernel modules included in the initrd by default."
57532 msgstr ""
57533
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."
57537 msgstr ""
57538
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:"
57542 msgstr ""
57543
57544 #. type: lisp
57545 #: guix-git/doc/guix.texi:32276
57546 #, no-wrap
57547 msgid ""
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"
57553 " rest)))\n"
57554 msgstr ""
57555
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."
57559 msgstr ""
57560
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."
57564 msgstr ""
57565
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:"
57569 msgstr ""
57570
57571 #. type: item
57572 #: guix-git/doc/guix.texi:32295
57573 #, no-wrap
57574 msgid "--load=@var{boot}"
57575 msgstr ""
57576
57577 #. type: table
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."
57580 msgstr ""
57581
57582 #. type: table
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."
57585 msgstr ""
57586
57587 #. type: item
57588 #: guix-git/doc/guix.texi:32303
57589 #, no-wrap
57590 msgid "--root=@var{root}"
57591 msgstr ""
57592
57593 #. type: table
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."
57596 msgstr ""
57597
57598 #. type: table
57599 #: guix-git/doc/guix.texi:32312
57600 msgid "Have @file{/run/booted-system} and @file{/run/current-system} point to @var{system}."
57601 msgstr ""
57602
57603 #. type: item
57604 #: guix-git/doc/guix.texi:32313
57605 #, no-wrap
57606 msgid "modprobe.blacklist=@var{modules}@dots{}"
57607 msgstr ""
57608
57609 #. type: cindex
57610 #: guix-git/doc/guix.texi:32314
57611 #, no-wrap
57612 msgid "module, black-listing"
57613 msgstr ""
57614
57615 #. type: cindex
57616 #: guix-git/doc/guix.texi:32315
57617 #, no-wrap
57618 msgid "black list, of kernel modules"
57619 msgstr ""
57620
57621 #. type: table
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}."
57624 msgstr ""
57625
57626 #. type: item
57627 #: guix-git/doc/guix.texi:32321
57628 #, no-wrap
57629 msgid "--repl"
57630 msgstr ""
57631
57632 #. type: table
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."
57635 msgstr ""
57636
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."
57640 msgstr ""
57641
57642 #. type: deffn
57643 #: guix-git/doc/guix.texi:32336
57644 #, no-wrap
57645 msgid "{Scheme Procedure} raw-initrd @var{file-systems} @"
57646 msgstr ""
57647
57648 #. type: deffn
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."
57651 msgstr ""
57652
57653 #. type: deffn
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."
57656 msgstr ""
57657
57658 #. type: deffn
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."
57661 msgstr ""
57662
57663 #. type: deffn
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."
57666 msgstr ""
57667
57668 #. type: deffn
57669 #: guix-git/doc/guix.texi:32365
57670 #, no-wrap
57671 msgid "{Scheme Procedure} base-initrd @var{file-systems} @"
57672 msgstr ""
57673
57674 #. type: deffn
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."
57677 msgstr ""
57678
57679 #. type: deffn
57680 #: guix-git/doc/guix.texi:32382
57681 msgid "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-initrd}."
57682 msgstr ""
57683
57684 #. type: deffn
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."
57687 msgstr ""
57688
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."
57692 msgstr ""
57693
57694 #. type: deffn
57695 #: guix-git/doc/guix.texi:32395
57696 #, no-wrap
57697 msgid "{Scheme Procedure} expression->initrd @var{exp} @"
57698 msgstr ""
57699
57700 #. type: deffn
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."
57703 msgstr ""
57704
57705 #. type: cindex
57706 #: guix-git/doc/guix.texi:32407
57707 #, no-wrap
57708 msgid "boot loader"
57709 msgstr ""
57710
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."
57714 msgstr ""
57715
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."
57719 msgstr ""
57720
57721 #. type: deftp
57722 #: guix-git/doc/guix.texi:32420
57723 #, no-wrap
57724 msgid "{Data Type} bootloader-configuration"
57725 msgstr ""
57726
57727 #. type: deftp
57728 #: guix-git/doc/guix.texi:32422
57729 msgid "The type of a bootloader configuration declaration."
57730 msgstr ""
57731
57732 #. type: cindex
57733 #: guix-git/doc/guix.texi:32426
57734 #, no-wrap
57735 msgid "EFI, bootloader"
57736 msgstr ""
57737
57738 #. type: cindex
57739 #: guix-git/doc/guix.texi:32427
57740 #, no-wrap
57741 msgid "UEFI, bootloader"
57742 msgstr ""
57743
57744 #. type: cindex
57745 #: guix-git/doc/guix.texi:32428
57746 #, no-wrap
57747 msgid "BIOS, bootloader"
57748 msgstr ""
57749
57750 #. type: table
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."
57753 msgstr ""
57754
57755 #. type: cindex
57756 #: guix-git/doc/guix.texi:32434
57757 #, no-wrap
57758 msgid "ARM, bootloaders"
57759 msgstr ""
57760
57761 #. type: cindex
57762 #: guix-git/doc/guix.texi:32435
57763 #, no-wrap
57764 msgid "AArch64, bootloaders"
57765 msgstr ""
57766
57767 #. type: table
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}."
57770 msgstr ""
57771
57772 #. type: table
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."
57775 msgstr ""
57776
57777 #. type: table
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."
57780 msgstr ""
57781
57782 #. type: vindex
57783 #: guix-git/doc/guix.texi:32451
57784 #, no-wrap
57785 msgid "grub-efi-netboot-bootloader"
57786 msgstr ""
57787
57788 #. type: table
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."
57791 msgstr ""
57792
57793 #. type: table
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."
57796 msgstr ""
57797
57798 #. type: table
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}."
57801 msgstr ""
57802
57803 #. type: table
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."
57806 msgstr ""
57807
57808 #. type: table
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."
57811 msgstr ""
57812
57813 #. type: table
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}."
57816 msgstr ""
57817
57818 #. type: table
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."
57821 msgstr ""
57822
57823 #. type: table
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}."
57826 msgstr ""
57827
57828 #. type: table
57829 #: guix-git/doc/guix.texi:32501
57830 msgid "This is a string denoting the target onto which to install the bootloader."
57831 msgstr ""
57832
57833 #. type: table
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."
57836 msgstr ""
57837
57838 #. type: item
57839 #: guix-git/doc/guix.texi:32511
57840 #, no-wrap
57841 msgid "@code{menu-entries} (default: @code{()})"
57842 msgstr ""
57843
57844 #. type: table
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."
57847 msgstr ""
57848
57849 #. type: item
57850 #: guix-git/doc/guix.texi:32516
57851 #, no-wrap
57852 msgid "@code{default-entry} (default: @code{0})"
57853 msgstr ""
57854
57855 #. type: table
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."
57858 msgstr ""
57859
57860 #. type: item
57861 #: guix-git/doc/guix.texi:32520
57862 #, no-wrap
57863 msgid "@code{timeout} (default: @code{5})"
57864 msgstr ""
57865
57866 #. type: table
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."
57869 msgstr ""
57870
57871 #. type: cindex
57872 #: guix-git/doc/guix.texi:32524
57873 #, no-wrap
57874 msgid "keyboard layout, for the bootloader"
57875 msgstr ""
57876
57877 #. type: table
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'')."
57880 msgstr ""
57881
57882 #. type: table
57883 #: guix-git/doc/guix.texi:32531
57884 msgid "Otherwise, this must be a @code{keyboard-layout} object (@pxref{Keyboard Layout})."
57885 msgstr ""
57886
57887 #. type: quotation
57888 #: guix-git/doc/guix.texi:32535
57889 msgid "This option is currently ignored by bootloaders other than @code{grub} and @code{grub-efi}."
57890 msgstr ""
57891
57892 #. type: item
57893 #: guix-git/doc/guix.texi:32537
57894 #, no-wrap
57895 msgid "@code{theme} (default: @var{#f})"
57896 msgstr ""
57897
57898 #. type: table
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."
57901 msgstr ""
57902
57903 #. type: item
57904 #: guix-git/doc/guix.texi:32542
57905 #, no-wrap
57906 msgid "@code{terminal-outputs} (default: @code{'(gfxterm)})"
57907 msgstr ""
57908
57909 #. type: table
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})."
57912 msgstr ""
57913
57914 #. type: item
57915 #: guix-git/doc/guix.texi:32550
57916 #, no-wrap
57917 msgid "@code{terminal-inputs} (default: @code{'()})"
57918 msgstr ""
57919
57920 #. type: table
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})."
57923 msgstr ""
57924
57925 #. type: item
57926 #: guix-git/doc/guix.texi:32559
57927 #, no-wrap
57928 msgid "@code{serial-unit} (default: @code{#f})"
57929 msgstr ""
57930
57931 #. type: table
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})."
57934 msgstr ""
57935
57936 #. type: item
57937 #: guix-git/doc/guix.texi:32564
57938 #, no-wrap
57939 msgid "@code{serial-speed} (default: @code{#f})"
57940 msgstr ""
57941
57942 #. type: table
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})."
57945 msgstr ""
57946
57947 #. type: cindex
57948 #: guix-git/doc/guix.texi:32572
57949 #, no-wrap
57950 msgid "dual boot"
57951 msgstr ""
57952
57953 #. type: cindex
57954 #: guix-git/doc/guix.texi:32573
57955 #, no-wrap
57956 msgid "boot menu"
57957 msgstr ""
57958
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:"
57962 msgstr ""
57963
57964 #. type: lisp
57965 #: guix-git/doc/guix.texi:32586
57966 #, no-wrap
57967 msgid ""
57968 "(menu-entry\n"
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"
57973 msgstr ""
57974
57975 #. type: Plain text
57976 #: guix-git/doc/guix.texi:32589
57977 msgid "Details below."
57978 msgstr ""
57979
57980 #. type: deftp
57981 #: guix-git/doc/guix.texi:32590
57982 #, no-wrap
57983 msgid "{Data Type} menu-entry"
57984 msgstr ""
57985
57986 #. type: deftp
57987 #: guix-git/doc/guix.texi:32592
57988 msgid "The type of an entry in the bootloader menu."
57989 msgstr ""
57990
57991 #. type: table
57992 #: guix-git/doc/guix.texi:32597
57993 msgid "The label to show in the menu---e.g., @code{\"GNU\"}."
57994 msgstr ""
57995
57996 #. type: item
57997 #: guix-git/doc/guix.texi:32598
57998 #, no-wrap
57999 msgid "@code{linux} (default: @code{#f})"
58000 msgstr ""
58001
58002 #. type: table
58003 #: guix-git/doc/guix.texi:32600
58004 msgid "The Linux kernel image to boot, for example:"
58005 msgstr ""
58006
58007 #. type: lisp
58008 #: guix-git/doc/guix.texi:32603
58009 #, no-wrap
58010 msgid "(file-append linux-libre \"/bzImage\")\n"
58011 msgstr ""
58012
58013 #. type: table
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:"
58016 msgstr ""
58017
58018 #. type: example
58019 #: guix-git/doc/guix.texi:32611
58020 #, no-wrap
58021 msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n"
58022 msgstr ""
58023
58024 #. type: table
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."
58027 msgstr ""
58028
58029 #. type: item
58030 #: guix-git/doc/guix.texi:32616
58031 #, no-wrap
58032 msgid "@code{linux-arguments} (default: @code{()})"
58033 msgstr ""
58034
58035 #. type: table
58036 #: guix-git/doc/guix.texi:32619
58037 msgid "The list of extra Linux kernel command-line arguments---e.g., @code{(\"console=ttyS0\")}."
58038 msgstr ""
58039
58040 #. type: item
58041 #: guix-git/doc/guix.texi:32620
58042 #, no-wrap
58043 msgid "@code{initrd} (default: @code{#f})"
58044 msgstr ""
58045
58046 #. type: table
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})."
58049 msgstr ""
58050
58051 #. type: item
58052 #: guix-git/doc/guix.texi:32624
58053 #, no-wrap
58054 msgid "@code{device} (default: @code{#f})"
58055 msgstr ""
58056
58057 #. type: table
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})."
58060 msgstr ""
58061
58062 #. type: table
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}."
58065 msgstr ""
58066
58067 #. type: item
58068 #: guix-git/doc/guix.texi:32634
58069 #, no-wrap
58070 msgid "@code{multiboot-kernel} (default: @code{#f})"
58071 msgstr ""
58072
58073 #. type: table
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:"
58076 msgstr ""
58077
58078 #. type: lisp
58079 #: guix-git/doc/guix.texi:32641
58080 #, no-wrap
58081 msgid "(file-append mach \"/boot/gnumach\")\n"
58082 msgstr ""
58083
58084 #. type: item
58085 #: guix-git/doc/guix.texi:32643
58086 #, no-wrap
58087 msgid "@code{multiboot-arguments} (default: @code{()})"
58088 msgstr ""
58089
58090 #. type: table
58091 #: guix-git/doc/guix.texi:32645
58092 msgid "The list of extra command-line arguments for the multiboot-kernel."
58093 msgstr ""
58094
58095 #. type: item
58096 #: guix-git/doc/guix.texi:32646
58097 #, no-wrap
58098 msgid "@code{multiboot-modules} (default: @code{()})"
58099 msgstr ""
58100
58101 #. type: table
58102 #: guix-git/doc/guix.texi:32648
58103 msgid "The list of commands for loading Multiboot modules. For example:"
58104 msgstr ""
58105
58106 #. type: lisp
58107 #: guix-git/doc/guix.texi:32654
58108 #, no-wrap
58109 msgid ""
58110 "(list (list (file-append hurd \"/hurd/ext2fs.static\") \"ext2fs\"\n"
58111 " @dots{})\n"
58112 " (list (file-append libc \"/lib/ld.so.1\") \"exec\"\n"
58113 " @dots{}))\n"
58114 msgstr ""
58115
58116 #. type: cindex
58117 #: guix-git/doc/guix.texi:32659 guix-git/doc/guix.texi:32718
58118 #, no-wrap
58119 msgid "HDPI"
58120 msgstr ""
58121
58122 #. type: cindex
58123 #: guix-git/doc/guix.texi:32660 guix-git/doc/guix.texi:32719
58124 #, no-wrap
58125 msgid "HiDPI"
58126 msgstr ""
58127
58128 #. type: cindex
58129 #: guix-git/doc/guix.texi:32661 guix-git/doc/guix.texi:32720
58130 #, no-wrap
58131 msgid "resolution"
58132 msgstr ""
58133
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."
58137 msgstr ""
58138
58139 #. type: deftp
58140 #: guix-git/doc/guix.texi:32666
58141 #, no-wrap
58142 msgid "{Data Type} grub-theme"
58143 msgstr ""
58144
58145 #. type: deftp
58146 #: guix-git/doc/guix.texi:32668
58147 msgid "Data type representing the configuration of the GRUB theme."
58148 msgstr ""
58149
58150 #. type: item
58151 #: guix-git/doc/guix.texi:32670
58152 #, no-wrap
58153 msgid "@code{gfxmode} (default: @code{'(\"auto\")})"
58154 msgstr ""
58155
58156 #. type: table
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})."
58159 msgstr ""
58160
58161 #. type: deffn
58162 #: guix-git/doc/guix.texi:32676
58163 #, no-wrap
58164 msgid "{Scheme Procedure} grub-theme"
58165 msgstr ""
58166
58167 #. type: deffn
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."
58170 msgstr ""
58171
58172 #. type: deffn
58173 #: guix-git/doc/guix.texi:32683
58174 msgid "It comes with a fancy background image displaying the GNU and Guix logos."
58175 msgstr ""
58176
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"
58180 msgstr ""
58181
58182 #. type: lisp
58183 #: guix-git/doc/guix.texi:32695
58184 #, no-wrap
58185 msgid ""
58186 "(bootloader\n"
58187 " (bootloader-configuration\n"
58188 " ;; @dots{}\n"
58189 " (theme (grub-theme\n"
58190 " (inherit (grub-theme))\n"
58191 " (gfxmode '(\"1024x786x32\" \"auto\"))))))\n"
58192 msgstr ""
58193
58194 #. type: section
58195 #: guix-git/doc/guix.texi:32698
58196 #, no-wrap
58197 msgid "Invoking @code{guix system}"
58198 msgstr ""
58199
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:"
58203 msgstr ""
58204
58205 #. type: example
58206 #: guix-git/doc/guix.texi:32706
58207 #, no-wrap
58208 msgid "guix system @var{options}@dots{} @var{action} @var{file}\n"
58209 msgstr ""
58210
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:"
58214 msgstr ""
58215
58216 #. type: item
58217 #: guix-git/doc/guix.texi:32714
58218 #, no-wrap
58219 msgid "search"
58220 msgstr ""
58221
58222 #. type: table
58223 #: guix-git/doc/guix.texi:32717
58224 msgid "Display available service type definitions that match the given regular expressions, sorted by relevance:"
58225 msgstr ""
58226
58227 #. type: example
58228 #: guix-git/doc/guix.texi:32739
58229 #, no-wrap
58230 msgid ""
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"
58239 "+\n"
58240 "+ '((\"tty1\" . \"LatGrkCyr-8x16\")\n"
58241 "+ (\"tty2\" . (file-append\n"
58242 "+ font-tamzen\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"
58247 "relevance: 9\n"
58248 "\n"
58249 msgstr ""
58250
58251 #. type: example
58252 #: guix-git/doc/guix.texi:32745
58253 #, no-wrap
58254 msgid ""
58255 "name: mingetty\n"
58256 "location: gnu/services/base.scm:1190:2\n"
58257 "extends: shepherd-root\n"
58258 "description: Provide console login using the `mingetty' program.\n"
58259 "relevance: 2\n"
58260 "\n"
58261 msgstr ""
58262
58263 #. type: example
58264 #: guix-git/doc/guix.texi:32752
58265 #, no-wrap
58266 msgid ""
58267 "name: login\n"
58268 "location: gnu/services/base.scm:860:2\n"
58269 "extends: pam\n"
58270 "description: Provide a console log-in service as specified by its\n"
58271 "+ configuration value, a `login-configuration' object.\n"
58272 "relevance: 2\n"
58273 "\n"
58274 msgstr ""
58275
58276 #. type: example
58277 #: guix-git/doc/guix.texi:32754
58278 #, no-wrap
58279 msgid "@dots{}\n"
58280 msgstr ""
58281
58282 #. type: table
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})."
58285 msgstr ""
58286
58287 #. type: item
58288 #: guix-git/doc/guix.texi:32760
58289 #, no-wrap
58290 msgid "reconfigure"
58291 msgstr ""
58292
58293 #. type: table
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.}."
58296 msgstr ""
58297
58298 #. type: quotation
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."
58301 msgstr ""
58302
58303 #. type: table
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})."
58306 msgstr ""
58307
58308 #. type: table
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})."
58311 msgstr ""
58312
58313 #. type: table
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."
58316 msgstr ""
58317
58318 #. type: cindex
58319 #: guix-git/doc/guix.texi:32793 guix-git/doc/guix.texi:33118
58320 #: guix-git/doc/guix.texi:34066
58321 #, no-wrap
58322 msgid "provenance tracking, of the operating system"
58323 msgstr ""
58324
58325 #. type: table
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:"
58328 msgstr ""
58329
58330 #. type: example
58331 #: guix-git/doc/guix.texi:32801
58332 #, no-wrap
58333 msgid "guix system describe\n"
58334 msgstr ""
58335
58336 #. type: table
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:"
58339 msgstr ""
58340
58341 #. type: example
58342 #: guix-git/doc/guix.texi:32813
58343 #, no-wrap
58344 msgid ""
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"
58349 msgstr ""
58350
58351 #. type: table
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."
58354 msgstr ""
58355
58356 #. type: table
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}."
58359 msgstr ""
58360
58361 #. type: item
58362 #: guix-git/doc/guix.texi:32826
58363 #, no-wrap
58364 msgid "switch-generation"
58365 msgstr ""
58366
58367 #. type: table
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."
58370 msgstr ""
58371
58372 #. type: table
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."
58375 msgstr ""
58376
58377 #. type: table
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:"
58380 msgstr ""
58381
58382 #. type: example
58383 #: guix-git/doc/guix.texi:32846
58384 #, no-wrap
58385 msgid "guix system switch-generation 7\n"
58386 msgstr ""
58387
58388 #. type: table
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:"
58391 msgstr ""
58392
58393 #. type: example
58394 #: guix-git/doc/guix.texi:32857
58395 #, no-wrap
58396 msgid "guix system switch-generation -- -1\n"
58397 msgstr ""
58398
58399 #. type: table
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."
58402 msgstr ""
58403
58404 #. type: table
58405 #: guix-git/doc/guix.texi:32867
58406 msgid "This action will fail if the specified generation does not exist."
58407 msgstr ""
58408
58409 #. type: item
58410 #: guix-git/doc/guix.texi:32868
58411 #, no-wrap
58412 msgid "roll-back"
58413 msgstr ""
58414
58415 #. type: table
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}."
58418 msgstr ""
58419
58420 #. type: table
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."
58423 msgstr ""
58424
58425 #. type: item
58426 #: guix-git/doc/guix.texi:32879
58427 #, no-wrap
58428 msgid "delete-generations"
58429 msgstr ""
58430
58431 #. type: cindex
58432 #: guix-git/doc/guix.texi:32880
58433 #, no-wrap
58434 msgid "deleting system generations"
58435 msgstr ""
58436
58437 #. type: cindex
58438 #: guix-git/doc/guix.texi:32881
58439 #, no-wrap
58440 msgid "saving space"
58441 msgstr ""
58442
58443 #. type: table
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'')."
58446 msgstr ""
58447
58448 #. type: table
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:"
58451 msgstr ""
58452
58453 #. type: example
58454 #: guix-git/doc/guix.texi:32892
58455 #, no-wrap
58456 msgid "guix system delete-generations\n"
58457 msgstr ""
58458
58459 #. type: table
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:"
58462 msgstr ""
58463
58464 #. type: example
58465 #: guix-git/doc/guix.texi:32899
58466 #, no-wrap
58467 msgid "guix system delete-generations 2m\n"
58468 msgstr ""
58469
58470 #. type: table
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."
58473 msgstr ""
58474
58475 #. type: table
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."
58478 msgstr ""
58479
58480 #. type: item
58481 #: guix-git/doc/guix.texi:32910
58482 #, no-wrap
58483 msgid "init"
58484 msgstr ""
58485
58486 #. type: table
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:"
58489 msgstr ""
58490
58491 #. type: example
58492 #: guix-git/doc/guix.texi:32917
58493 #, no-wrap
58494 msgid "guix system init my-os-config.scm /mnt\n"
58495 msgstr ""
58496
58497 #. type: table
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."
58500 msgstr ""
58501
58502 #. type: table
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."
58505 msgstr ""
58506
58507 #. type: item
58508 #: guix-git/doc/guix.texi:32929
58509 #, no-wrap
58510 msgid "vm"
58511 msgstr ""
58512
58513 #. type: cindex
58514 #: guix-git/doc/guix.texi:32930 guix-git/doc/guix.texi:33491
58515 #, no-wrap
58516 msgid "virtual machine"
58517 msgstr ""
58518
58519 #. type: cindex
58520 #: guix-git/doc/guix.texi:32931
58521 #, no-wrap
58522 msgid "VM"
58523 msgstr ""
58524
58525 #. type: anchor{#1}
58526 #: guix-git/doc/guix.texi:32935
58527 msgid "guix system vm"
58528 msgstr ""
58529
58530 #. type: table
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)."
58533 msgstr ""
58534
58535 #. type: quotation
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})."
58538 msgstr ""
58539
58540 #. type: table
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:"
58543 msgstr ""
58544
58545 #. type: example
58546 #: guix-git/doc/guix.texi:32951
58547 #, no-wrap
58548 msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -smp 2 -net user,model=virtio-net-pci\n"
58549 msgstr ""
58550
58551 #. type: table
58552 #: guix-git/doc/guix.texi:32954
58553 msgid "The VM shares its store with the host system."
58554 msgstr ""
58555
58556 #. type: table
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."
58559 msgstr ""
58560
58561 #. type: table
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:"
58564 msgstr ""
58565
58566 #. type: example
58567 #: guix-git/doc/guix.texi:32967
58568 #, no-wrap
58569 msgid ""
58570 "guix system vm my-config.scm \\\n"
58571 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58572 msgstr ""
58573
58574 #. type: table
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."
58577 msgstr ""
58578
58579 #. type: table
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."
58582 msgstr ""
58583
58584 #. type: cindex
58585 #: guix-git/doc/guix.texi:32979
58586 #, no-wrap
58587 msgid "System images, creation in various formats"
58588 msgstr ""
58589
58590 #. type: cindex
58591 #: guix-git/doc/guix.texi:32980
58592 #, no-wrap
58593 msgid "Creating system images in various formats"
58594 msgstr ""
58595
58596 #. type: item
58597 #: guix-git/doc/guix.texi:32981
58598 #, no-wrap
58599 msgid "image"
58600 msgstr ""
58601
58602 #. type: itemx
58603 #: guix-git/doc/guix.texi:32982
58604 #, no-wrap
58605 msgid "docker-image"
58606 msgstr ""
58607
58608 #. type: table
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}."
58611 msgstr ""
58612
58613 #. type: cindex
58614 #: guix-git/doc/guix.texi:32991
58615 #, no-wrap
58616 msgid "image, creating disk images"
58617 msgstr ""
58618
58619 #. type: table
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:"
58622 msgstr ""
58623
58624 #. type: example
58625 #: guix-git/doc/guix.texi:33011
58626 #, no-wrap
58627 msgid ""
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"
58634 msgstr ""
58635
58636 #. type: table
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:"
58639 msgstr ""
58640
58641 #. type: example
58642 #: guix-git/doc/guix.texi:33020
58643 #, no-wrap
58644 msgid "# dd if=$(guix system image my-os.scm) of=/dev/sdc status=progress\n"
58645 msgstr ""
58646
58647 #. type: table
58648 #: guix-git/doc/guix.texi:33024
58649 msgid "The @code{--list-image-types} command lists all the available image types."
58650 msgstr ""
58651
58652 #. type: cindex
58653 #: guix-git/doc/guix.texi:33025
58654 #, no-wrap
58655 msgid "creating virtual machine images"
58656 msgstr ""
58657
58658 #. type: table
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)."
58661 msgstr ""
58662
58663 #. type: cindex
58664 #: guix-git/doc/guix.texi:33035
58665 #, no-wrap
58666 msgid "docker-image, creating docker images"
58667 msgstr ""
58668
58669 #. type: table
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:"
58672 msgstr ""
58673
58674 #. type: example
58675 #: guix-git/doc/guix.texi:33046
58676 #, no-wrap
58677 msgid ""
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"
58681 msgstr ""
58682
58683 #. type: table
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}:"
58686 msgstr ""
58687
58688 #. type: example
58689 #: guix-git/doc/guix.texi:33056
58690 #, no-wrap
58691 msgid "docker exec -ti $container_id /run/current-system/profile/bin/bash --login\n"
58692 msgstr ""
58693
58694 #. type: table
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}."
58697 msgstr ""
58698
58699 #. type: table
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."
58702 msgstr ""
58703
58704 #. type: table
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."
58707 msgstr ""
58708
58709 #. type: table
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."
58712 msgstr ""
58713
58714 #. type: table
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:"
58717 msgstr ""
58718
58719 #. type: example
58720 #: guix-git/doc/guix.texi:33087
58721 #, no-wrap
58722 msgid ""
58723 "guix system container my-config.scm \\\n"
58724 " --expose=$HOME --share=$HOME/tmp=/exchange\n"
58725 msgstr ""
58726
58727 #. type: quotation
58728 #: guix-git/doc/guix.texi:33091
58729 msgid "This option requires Linux-libre 3.19 or newer."
58730 msgstr ""
58731
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:"
58735 msgstr ""
58736
58737 #. type: table
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})."
58740 msgstr ""
58741
58742 #. type: table
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})."
58745 msgstr ""
58746
58747 #. type: table
58748 #: guix-git/doc/guix.texi:33117
58749 msgid "Return the derivation file name of the given operating system without building anything."
58750 msgstr ""
58751
58752 #. type: table
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:"
58755 msgstr ""
58756
58757 #. type: example
58758 #: guix-git/doc/guix.texi:33129
58759 #, no-wrap
58760 msgid "guix system image -t qcow2 --save-provenance config.scm\n"
58761 msgstr ""
58762
58763 #. type: table
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."
58766 msgstr ""
58767
58768 #. type: item
58769 #: guix-git/doc/guix.texi:33137
58770 #, no-wrap
58771 msgid "--image-type=@var{type}"
58772 msgstr ""
58773
58774 #. type: table
58775 #: guix-git/doc/guix.texi:33140
58776 msgid "For the @code{image} action, create an image with given @var{type}."
58777 msgstr ""
58778
58779 #. type: table
58780 #: guix-git/doc/guix.texi:33143
58781 msgid "When this option is omitted, @command{guix system} uses the @code{efi-raw} image type."
58782 msgstr ""
58783
58784 #. type: cindex
58785 #: guix-git/doc/guix.texi:33144
58786 #, no-wrap
58787 msgid "ISO-9660 format"
58788 msgstr ""
58789
58790 #. type: cindex
58791 #: guix-git/doc/guix.texi:33145
58792 #, no-wrap
58793 msgid "CD image format"
58794 msgstr ""
58795
58796 #. type: cindex
58797 #: guix-git/doc/guix.texi:33146
58798 #, no-wrap
58799 msgid "DVD image format"
58800 msgstr ""
58801
58802 #. type: table
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."
58805 msgstr ""
58806
58807 #. type: item
58808 #: guix-git/doc/guix.texi:33150
58809 #, no-wrap
58810 msgid "--image-size=@var{size}"
58811 msgstr ""
58812
58813 #. type: table
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})."
58816 msgstr ""
58817
58818 #. type: table
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}."
58821 msgstr ""
58822
58823 #. type: table
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."
58826 msgstr ""
58827
58828 #. type: item
58829 #: guix-git/doc/guix.texi:33170
58830 #, no-wrap
58831 msgid "--skip-checks"
58832 msgstr ""
58833
58834 #. type: table
58835 #: guix-git/doc/guix.texi:33172
58836 msgid "Skip pre-installation safety checks."
58837 msgstr ""
58838
58839 #. type: table
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."
58842 msgstr ""
58843
58844 #. type: table
58845 #: guix-git/doc/guix.texi:33182
58846 msgid "Instruct @command{guix system reconfigure} to allow system downgrades."
58847 msgstr ""
58848
58849 #. type: table
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."
58852 msgstr ""
58853
58854 #. type: cindex
58855 #: guix-git/doc/guix.texi:33196
58856 #, no-wrap
58857 msgid "on-error"
58858 msgstr ""
58859
58860 #. type: cindex
58861 #: guix-git/doc/guix.texi:33197
58862 #, no-wrap
58863 msgid "on-error strategy"
58864 msgstr ""
58865
58866 #. type: cindex
58867 #: guix-git/doc/guix.texi:33198
58868 #, no-wrap
58869 msgid "error strategy"
58870 msgstr ""
58871
58872 #. type: item
58873 #: guix-git/doc/guix.texi:33199
58874 #, no-wrap
58875 msgid "--on-error=@var{strategy}"
58876 msgstr ""
58877
58878 #. type: table
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:"
58881 msgstr ""
58882
58883 #. type: item
58884 #: guix-git/doc/guix.texi:33204
58885 #, no-wrap
58886 msgid "nothing-special"
58887 msgstr ""
58888
58889 #. type: table
58890 #: guix-git/doc/guix.texi:33206
58891 msgid "Report the error concisely and exit. This is the default strategy."
58892 msgstr ""
58893
58894 #. type: item
58895 #: guix-git/doc/guix.texi:33207
58896 #, no-wrap
58897 msgid "backtrace"
58898 msgstr ""
58899
58900 #. type: table
58901 #: guix-git/doc/guix.texi:33209
58902 msgid "Likewise, but also display a backtrace."
58903 msgstr ""
58904
58905 #. type: item
58906 #: guix-git/doc/guix.texi:33210
58907 #, no-wrap
58908 msgid "debug"
58909 msgstr ""
58910
58911 #. type: table
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."
58914 msgstr ""
58915
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:"
58919 msgstr ""
58920
58921 #. type: item
58922 #: guix-git/doc/guix.texi:33226
58923 #, no-wrap
58924 msgid "describe"
58925 msgstr ""
58926
58927 #. type: table
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."
58930 msgstr ""
58931
58932 #. type: item
58933 #: guix-git/doc/guix.texi:33230
58934 #, no-wrap
58935 msgid "list-generations"
58936 msgstr ""
58937
58938 #. type: table
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})."
58941 msgstr ""
58942
58943 #. type: table
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:"
58946 msgstr ""
58947
58948 #. type: example
58949 #: guix-git/doc/guix.texi:33243
58950 #, no-wrap
58951 msgid "$ guix system list-generations 10d\n"
58952 msgstr ""
58953
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:"
58957 msgstr ""
58958
58959 #. type: anchor{#1}
58960 #: guix-git/doc/guix.texi:33252
58961 msgid "system-extension-graph"
58962 msgstr ""
58963
58964 #. type: item
58965 #: guix-git/doc/guix.texi:33254
58966 #, no-wrap
58967 msgid "extension-graph"
58968 msgstr ""
58969
58970 #. type: table
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}}):"
58973 msgstr ""
58974
58975 #. type: table
58976 #: guix-git/doc/guix.texi:33263
58977 msgid "The command:"
58978 msgstr ""
58979
58980 #. type: example
58981 #: guix-git/doc/guix.texi:33266
58982 #, no-wrap
58983 msgid "$ guix system extension-graph @var{file} | xdot -\n"
58984 msgstr ""
58985
58986 #. type: table
58987 #: guix-git/doc/guix.texi:33269
58988 msgid "shows the extension relations among services."
58989 msgstr ""
58990
58991 #. type: anchor{#1}
58992 #: guix-git/doc/guix.texi:33271
58993 msgid "system-shepherd-graph"
58994 msgstr ""
58995
58996 #. type: item
58997 #: guix-git/doc/guix.texi:33271
58998 #, no-wrap
58999 msgid "shepherd-graph"
59000 msgstr ""
59001
59002 #. type: table
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."
59005 msgstr ""
59006
59007 #. type: table
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."
59010 msgstr ""
59011
59012 #. type: section
59013 #: guix-git/doc/guix.texi:33283
59014 #, no-wrap
59015 msgid "Invoking @code{guix deploy}"
59016 msgstr ""
59017
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''."
59021 msgstr ""
59022
59023 #. type: quotation
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}!"
59026 msgstr ""
59027
59028 #. type: example
59029 #: guix-git/doc/guix.texi:33300
59030 #, no-wrap
59031 msgid "guix deploy @var{file}\n"
59032 msgstr ""
59033
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:"
59037 msgstr ""
59038
59039 #. type: lisp
59040 #: guix-git/doc/guix.texi:33311
59041 #, no-wrap
59042 msgid ""
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"
59048 "\n"
59049 msgstr ""
59050
59051 #. type: lisp
59052 #: guix-git/doc/guix.texi:33314
59053 #, no-wrap
59054 msgid ""
59055 "(use-service-modules networking ssh)\n"
59056 "(use-package-modules bootloaders)\n"
59057 "\n"
59058 msgstr ""
59059
59060 #. type: lisp
59061 #: guix-git/doc/guix.texi:33335
59062 #, no-wrap
59063 msgid ""
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"
59077 " (services\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"
59084 "\n"
59085 msgstr ""
59086
59087 #. type: lisp
59088 #: guix-git/doc/guix.texi:33345
59089 #, no-wrap
59090 msgid ""
59091 "(list (machine\n"
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"
59100 msgstr ""
59101
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."
59105 msgstr ""
59106
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:"
59110 msgstr ""
59111
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:"
59115 msgstr ""
59116
59117 #. type: example
59118 #: guix-git/doc/guix.texi:33374
59119 #, no-wrap
59120 msgid "# guix archive --authorize < coordinator-public-key.txt\n"
59121 msgstr ""
59122
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:"
59126 msgstr ""
59127
59128 #. type: lisp
59129 #: guix-git/doc/guix.texi:33389
59130 #, no-wrap
59131 msgid ""
59132 "(use-modules ...\n"
59133 " (gnu system)) ;for %sudoers-specification\n"
59134 "\n"
59135 msgstr ""
59136
59137 #. type: lisp
59138 #: guix-git/doc/guix.texi:33391
59139 #, no-wrap
59140 msgid ""
59141 "(define %user \"username\")\n"
59142 "\n"
59143 msgstr ""
59144
59145 #. type: lisp
59146 #: guix-git/doc/guix.texi:33399
59147 #, no-wrap
59148 msgid ""
59149 "(operating-system\n"
59150 " ...\n"
59151 " (sudoers-file\n"
59152 " (plain-file \"sudoers\"\n"
59153 " (string-append (plain-file-content %sudoers-specification)\n"
59154 " (format #f \"~a ALL = NOPASSWD: ALL~%\"\n"
59155 " %user)))))\n"
59156 "\n"
59157 msgstr ""
59158
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}."
59162 msgstr ""
59163
59164 #. type: deftp
59165 #: guix-git/doc/guix.texi:33405
59166 #, no-wrap
59167 msgid "{Data Type} machine"
59168 msgstr ""
59169
59170 #. type: deftp
59171 #: guix-git/doc/guix.texi:33408
59172 msgid "This is the data type representing a single machine in a heterogeneous Guix deployment."
59173 msgstr ""
59174
59175 #. type: table
59176 #: guix-git/doc/guix.texi:33412
59177 msgid "The object of the operating system configuration to deploy."
59178 msgstr ""
59179
59180 #. type: code{#1}
59181 #: guix-git/doc/guix.texi:33413
59182 #, no-wrap
59183 msgid "environment"
59184 msgstr ""
59185
59186 #. type: table
59187 #: guix-git/doc/guix.texi:33415
59188 msgid "An @code{environment-type} describing how the machine should be provisioned."
59189 msgstr ""
59190
59191 #. type: item
59192 #: guix-git/doc/guix.texi:33416
59193 #, no-wrap
59194 msgid "@code{configuration} (default: @code{#f})"
59195 msgstr ""
59196
59197 #. type: table
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."
59200 msgstr ""
59201
59202 #. type: deftp
59203 #: guix-git/doc/guix.texi:33424
59204 #, no-wrap
59205 msgid "{Data Type} machine-ssh-configuration"
59206 msgstr ""
59207
59208 #. type: deftp
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}."
59211 msgstr ""
59212
59213 #. type: item
59214 #: guix-git/doc/guix.texi:33430
59215 #, no-wrap
59216 msgid "@code{build-locally?} (default: @code{#t})"
59217 msgstr ""
59218
59219 #. type: table
59220 #: guix-git/doc/guix.texi:33432
59221 msgid "If false, system derivations will be built on the machine being deployed to."
59222 msgstr ""
59223
59224 #. type: code{#1}
59225 #: guix-git/doc/guix.texi:33432
59226 #, no-wrap
59227 msgid "system"
59228 msgstr ""
59229
59230 #. type: table
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\"}."
59233 msgstr ""
59234
59235 #. type: item
59236 #: guix-git/doc/guix.texi:33435
59237 #, no-wrap
59238 msgid "@code{authorize?} (default: @code{#t})"
59239 msgstr ""
59240
59241 #. type: table
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."
59244 msgstr ""
59245
59246 #. type: item
59247 #: guix-git/doc/guix.texi:33439
59248 #, no-wrap
59249 msgid "@code{user} (default: @code{\"root\"})"
59250 msgstr ""
59251
59252 #. type: item
59253 #: guix-git/doc/guix.texi:33440
59254 #, no-wrap
59255 msgid "@code{identity} (default: @code{#f})"
59256 msgstr ""
59257
59258 #. type: table
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."
59261 msgstr ""
59262
59263 #. type: item
59264 #: guix-git/doc/guix.texi:33444
59265 #, no-wrap
59266 msgid "@code{host-key} (default: @code{#f})"
59267 msgstr ""
59268
59269 #. type: table
59270 #: guix-git/doc/guix.texi:33446
59271 msgid "This should be the SSH host key of the machine, which looks like this:"
59272 msgstr ""
59273
59274 #. type: example
59275 #: guix-git/doc/guix.texi:33449
59276 #, no-wrap
59277 msgid "ssh-ed25519 AAAAC3Nz@dots{} root@@example.org\n"
59278 msgstr ""
59279
59280 #. type: table
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."
59283 msgstr ""
59284
59285 #. type: item
59286 #: guix-git/doc/guix.texi:33455
59287 #, no-wrap
59288 msgid "@code{allow-downgrades?} (default: @code{#f})"
59289 msgstr ""
59290
59291 #. type: table
59292 #: guix-git/doc/guix.texi:33457
59293 msgid "Whether to allow potential downgrades."
59294 msgstr ""
59295
59296 #. type: table
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."
59299 msgstr ""
59300
59301 #. type: deftp
59302 #: guix-git/doc/guix.texi:33468
59303 #, no-wrap
59304 msgid "{Data Type} digital-ocean-configuration"
59305 msgstr ""
59306
59307 #. type: deftp
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}."
59310 msgstr ""
59311
59312 #. type: code{#1}
59313 #: guix-git/doc/guix.texi:33473
59314 #, no-wrap
59315 msgid "ssh-key"
59316 msgstr ""
59317
59318 #. type: table
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."
59321 msgstr ""
59322
59323 #. type: code{#1}
59324 #: guix-git/doc/guix.texi:33476
59325 #, no-wrap
59326 msgid "tags"
59327 msgstr ""
59328
59329 #. type: table
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."
59332 msgstr ""
59333
59334 #. type: code{#1}
59335 #: guix-git/doc/guix.texi:33479
59336 #, no-wrap
59337 msgid "region"
59338 msgstr ""
59339
59340 #. type: table
59341 #: guix-git/doc/guix.texi:33481
59342 msgid "A Digital Ocean region slug, such as @code{\"nyc3\"}."
59343 msgstr ""
59344
59345 #. type: table
59346 #: guix-git/doc/guix.texi:33483
59347 msgid "A Digital Ocean size slug, such as @code{\"s-1vcpu-1gb\"}"
59348 msgstr ""
59349
59350 #. type: code{#1}
59351 #: guix-git/doc/guix.texi:33483
59352 #, no-wrap
59353 msgid "enable-ipv6?"
59354 msgstr ""
59355
59356 #. type: table
59357 #: guix-git/doc/guix.texi:33485
59358 msgid "Whether or not the droplet should be created with IPv6 networking."
59359 msgstr ""
59360
59361 #. type: section
59362 #: guix-git/doc/guix.texi:33489
59363 #, no-wrap
59364 msgid "Running Guix in a Virtual Machine"
59365 msgstr ""
59366
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)."
59370 msgstr ""
59371
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})."
59375 msgstr ""
59376
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."
59380 msgstr ""
59381
59382 #. type: cindex
59383 #: guix-git/doc/guix.texi:33511
59384 #, no-wrap
59385 msgid "QEMU"
59386 msgstr ""
59387
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:"
59391 msgstr ""
59392
59393 #. type: example
59394 #: guix-git/doc/guix.texi:33525
59395 #, no-wrap
59396 msgid ""
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"
59402 msgstr ""
59403
59404 #. type: Plain text
59405 #: guix-git/doc/guix.texi:33528
59406 msgid "Here is what each of these options means:"
59407 msgstr ""
59408
59409 #. type: item
59410 #: guix-git/doc/guix.texi:33530
59411 #, no-wrap
59412 msgid "qemu-system-x86_64"
59413 msgstr ""
59414
59415 #. type: table
59416 #: guix-git/doc/guix.texi:33533
59417 msgid "This specifies the hardware platform to emulate. This should match the host."
59418 msgstr ""
59419
59420 #. type: item
59421 #: guix-git/doc/guix.texi:33534
59422 #, no-wrap
59423 msgid "-nic user,model=virtio-net-pci"
59424 msgstr ""
59425
59426 #. type: table
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}."
59429 msgstr ""
59430
59431 #. type: item
59432 #: guix-git/doc/guix.texi:33543
59433 #, no-wrap
59434 msgid "-enable-kvm"
59435 msgstr ""
59436
59437 #. type: table
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."
59440 msgstr ""
59441
59442 #. type: item
59443 #: guix-git/doc/guix.texi:33549
59444 #, no-wrap
59445 msgid "-m 1024"
59446 msgstr ""
59447
59448 #. type: table
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."
59451 msgstr ""
59452
59453 #. type: item
59454 #: guix-git/doc/guix.texi:33553
59455 #, no-wrap
59456 msgid "-device virtio-blk,drive=myhd"
59457 msgstr ""
59458
59459 #. type: table
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."
59462 msgstr ""
59463
59464 #. type: item
59465 #: guix-git/doc/guix.texi:33559
59466 #, no-wrap
59467 msgid "-drive if=none,file=/tmp/qemu-image,id=myhd"
59468 msgstr ""
59469
59470 #. type: table
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."
59473 msgstr ""
59474
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}."
59478 msgstr ""
59479
59480 #. type: subsection
59481 #: guix-git/doc/guix.texi:33573
59482 #, no-wrap
59483 msgid "Connecting Through SSH"
59484 msgstr ""
59485
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"
59489 msgstr ""
59490
59491 #. type: example
59492 #: guix-git/doc/guix.texi:33584
59493 #, no-wrap
59494 msgid "$(guix system vm config.scm) -nic user,model=virtio-net-pci,hostfwd=tcp::10022-:22\n"
59495 msgstr ""
59496
59497 #. type: Plain text
59498 #: guix-git/doc/guix.texi:33587
59499 msgid "To connect to the VM you can run"
59500 msgstr ""
59501
59502 #. type: example
59503 #: guix-git/doc/guix.texi:33590
59504 #, no-wrap
59505 msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 localhost\n"
59506 msgstr ""
59507
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."
59511 msgstr ""
59512
59513 #. type: subsection
59514 #: guix-git/doc/guix.texi:33598
59515 #, no-wrap
59516 msgid "Using @command{virt-viewer} with Spice"
59517 msgstr ""
59518
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."
59522 msgstr ""
59523
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}:"
59527 msgstr ""
59528
59529 #. type: example
59530 #: guix-git/doc/guix.texi:33613
59531 #, no-wrap
59532 msgid ""
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"
59537 msgstr ""
59538
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})."
59542 msgstr ""
59543
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?"
59547 msgstr ""
59548
59549 #. type: cindex
59550 #: guix-git/doc/guix.texi:33636
59551 #, no-wrap
59552 msgid "daemons"
59553 msgstr ""
59554
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."
59558 msgstr ""
59559
59560 #. type: cindex
59561 #: guix-git/doc/guix.texi:33650
59562 #, no-wrap
59563 msgid "service extensions"
59564 msgstr ""
59565
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})."
59569 msgstr ""
59570
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:"
59574 msgstr ""
59575
59576 #. type: Plain text
59577 #: guix-git/doc/guix.texi:33668
59578 msgid "@image{images/service-graph,,5in,Typical service extension graph.}"
59579 msgstr ""
59580
59581 #. type: cindex
59582 #: guix-git/doc/guix.texi:33669
59583 #, no-wrap
59584 msgid "system service"
59585 msgstr ""
59586
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."
59590 msgstr ""
59591
59592 #. type: cindex
59593 #: guix-git/doc/guix.texi:33678
59594 #, no-wrap
59595 msgid "service types"
59596 msgstr ""
59597
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."
59601 msgstr ""
59602
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."
59606 msgstr ""
59607
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}):"
59611 msgstr ""
59612
59613 #. type: lisp
59614 #: guix-git/doc/guix.texi:33704
59615 #, no-wrap
59616 msgid ""
59617 "(define guix-service-type\n"
59618 " (service-type\n"
59619 " (name 'guix)\n"
59620 " (extensions\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"
59625 msgstr ""
59626
59627 #. type: Plain text
59628 #: guix-git/doc/guix.texi:33708
59629 msgid "It defines three things:"
59630 msgstr ""
59631
59632 #. type: enumerate
59633 #: guix-git/doc/guix.texi:33712
59634 msgid "A name, whose sole purpose is to make inspection and debugging easier."
59635 msgstr ""
59636
59637 #. type: enumerate
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."
59640 msgstr ""
59641
59642 #. type: enumerate
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."
59645 msgstr ""
59646
59647 #. type: enumerate
59648 #: guix-git/doc/guix.texi:33723
59649 msgid "Optionally, a default value for instances of this type."
59650 msgstr ""
59651
59652 #. type: Plain text
59653 #: guix-git/doc/guix.texi:33726
59654 msgid "In this example, @code{guix-service-type} extends three services:"
59655 msgstr ""
59656
59657 #. type: item
59658 #: guix-git/doc/guix.texi:33728
59659 #, no-wrap
59660 msgid "shepherd-root-service-type"
59661 msgstr ""
59662
59663 #. type: table
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})."
59666 msgstr ""
59667
59668 #. type: item
59669 #: guix-git/doc/guix.texi:33734
59670 #, no-wrap
59671 msgid "account-service-type"
59672 msgstr ""
59673
59674 #. type: table
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})."
59677 msgstr ""
59678
59679 #. type: item
59680 #: guix-git/doc/guix.texi:33740
59681 #, no-wrap
59682 msgid "activation-service-type"
59683 msgstr ""
59684
59685 #. type: table
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."
59688 msgstr ""
59689
59690 #. type: Plain text
59691 #: guix-git/doc/guix.texi:33747
59692 msgid "A service of this type is instantiated like this:"
59693 msgstr ""
59694
59695 #. type: lisp
59696 #: guix-git/doc/guix.texi:33753
59697 #, no-wrap
59698 msgid ""
59699 "(service guix-service-type\n"
59700 " (guix-configuration\n"
59701 " (build-accounts 5)\n"
59702 " (extra-options '(\"--gc-keep-derivations\"))))\n"
59703 msgstr ""
59704
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:"
59708 msgstr ""
59709
59710 #. type: lisp
59711 #: guix-git/doc/guix.texi:33764
59712 #, no-wrap
59713 msgid "(service guix-service-type)\n"
59714 msgstr ""
59715
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."
59719 msgstr ""
59720
59721 #. type: Plain text
59722 #: guix-git/doc/guix.texi:33772
59723 msgid "The service type for an @emph{extensible} service looks like this:"
59724 msgstr ""
59725
59726 #. type: lisp
59727 #: guix-git/doc/guix.texi:33779
59728 #, no-wrap
59729 msgid ""
59730 "(define udev-service-type\n"
59731 " (service-type (name 'udev)\n"
59732 " (extensions\n"
59733 " (list (service-extension shepherd-root-service-type\n"
59734 " udev-shepherd-service)))\n"
59735 "\n"
59736 msgstr ""
59737
59738 #. type: lisp
59739 #: guix-git/doc/guix.texi:33787
59740 #, no-wrap
59741 msgid ""
59742 " (compose concatenate) ;concatenate the list of rules\n"
59743 " (extend (lambda (config rules)\n"
59744 " (match config\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"
59749 msgstr ""
59750
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:"
59754 msgstr ""
59755
59756 #. type: item
59757 #: guix-git/doc/guix.texi:33795
59758 #, no-wrap
59759 msgid "compose"
59760 msgstr ""
59761
59762 #. type: table
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."
59765 msgstr ""
59766
59767 #. type: table
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."
59770 msgstr ""
59771
59772 #. type: item
59773 #: guix-git/doc/guix.texi:33802
59774 #, no-wrap
59775 msgid "extend"
59776 msgstr ""
59777
59778 #. type: table
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."
59781 msgstr ""
59782
59783 #. type: table
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."
59786 msgstr ""
59787
59788 #. type: table
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})."
59791 msgstr ""
59792
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."
59796 msgstr ""
59797
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."
59801 msgstr ""
59802
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."
59806 msgstr ""
59807
59808 #. type: deffn
59809 #: guix-git/doc/guix.texi:33833
59810 #, no-wrap
59811 msgid "{Scheme Procedure} service @var{type} [@var{value}]"
59812 msgstr ""
59813
59814 #. type: deffn
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."
59817 msgstr ""
59818
59819 #. type: deffn
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."
59822 msgstr ""
59823
59824 #. type: deffn
59825 #: guix-git/doc/guix.texi:33843
59826 msgid "For instance, this:"
59827 msgstr ""
59828
59829 #. type: lisp
59830 #: guix-git/doc/guix.texi:33846
59831 #, no-wrap
59832 msgid "(service openssh-service-type)\n"
59833 msgstr ""
59834
59835 #. type: deffn
59836 #: guix-git/doc/guix.texi:33850
59837 msgid "is equivalent to this:"
59838 msgstr ""
59839
59840 #. type: lisp
59841 #: guix-git/doc/guix.texi:33854
59842 #, no-wrap
59843 msgid ""
59844 "(service openssh-service-type\n"
59845 " (openssh-configuration))\n"
59846 msgstr ""
59847
59848 #. type: deffn
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."
59851 msgstr ""
59852
59853 #. type: deffn
59854 #: guix-git/doc/guix.texi:33860
59855 #, no-wrap
59856 msgid "{Scheme Procedure} service? @var{obj}"
59857 msgstr ""
59858
59859 #. type: deffn
59860 #: guix-git/doc/guix.texi:33862
59861 msgid "Return true if @var{obj} is a service."
59862 msgstr ""
59863
59864 #. type: deffn
59865 #: guix-git/doc/guix.texi:33864
59866 #, no-wrap
59867 msgid "{Scheme Procedure} service-kind @var{service}"
59868 msgstr ""
59869
59870 #. type: deffn
59871 #: guix-git/doc/guix.texi:33866
59872 msgid "Return the type of @var{service}---i.e., a @code{<service-type>} object."
59873 msgstr ""
59874
59875 #. type: deffn
59876 #: guix-git/doc/guix.texi:33868
59877 #, no-wrap
59878 msgid "{Scheme Procedure} service-value @var{service}"
59879 msgstr ""
59880
59881 #. type: deffn
59882 #: guix-git/doc/guix.texi:33871
59883 msgid "Return the value associated with @var{service}. It represents its parameters."
59884 msgstr ""
59885
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:"
59889 msgstr ""
59890
59891 #. type: lisp
59892 #: guix-git/doc/guix.texi:33883
59893 #, no-wrap
59894 msgid ""
59895 "(define s\n"
59896 " (service nginx-service-type\n"
59897 " (nginx-configuration\n"
59898 " (nginx nginx)\n"
59899 " (log-directory log-directory)\n"
59900 " (run-directory run-directory)\n"
59901 " (file config-file))))\n"
59902 "\n"
59903 msgstr ""
59904
59905 #. type: lisp
59906 #: guix-git/doc/guix.texi:33886
59907 #, no-wrap
59908 msgid ""
59909 "(service? s)\n"
59910 "@result{} #t\n"
59911 "\n"
59912 msgstr ""
59913
59914 #. type: lisp
59915 #: guix-git/doc/guix.texi:33889
59916 #, no-wrap
59917 msgid ""
59918 "(eq? (service-kind s) nginx-service-type)\n"
59919 "@result{} #t\n"
59920 msgstr ""
59921
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."
59925 msgstr ""
59926
59927 #. type: deffn
59928 #: guix-git/doc/guix.texi:33900
59929 #, no-wrap
59930 msgid "{Scheme Syntax} modify-services @var{services} @"
59931 msgstr ""
59932
59933 #. type: deffn
59934 #: guix-git/doc/guix.texi:33902
59935 msgid "(@var{type} @var{variable} => @var{body}) @dots{}"
59936 msgstr ""
59937
59938 #. type: deffn
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:"
59941 msgstr ""
59942
59943 #. type: example
59944 #: guix-git/doc/guix.texi:33908
59945 #, no-wrap
59946 msgid "(@var{type} @var{variable} => @var{body})\n"
59947 msgstr ""
59948
59949 #. type: deffn
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}."
59952 msgstr ""
59953
59954 #. type: deffn
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."
59957 msgstr ""
59958
59959 #. type: deffn
59960 #: guix-git/doc/guix.texi:33924
59961 msgid "@xref{Using the Configuration System}, for example usage."
59962 msgstr ""
59963
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."
59967 msgstr ""
59968
59969 #. type: deftp
59970 #: guix-git/doc/guix.texi:33932
59971 #, no-wrap
59972 msgid "{Data Type} service-type"
59973 msgstr ""
59974
59975 #. type: cindex
59976 #: guix-git/doc/guix.texi:33933
59977 #, no-wrap
59978 msgid "service type"
59979 msgstr ""
59980
59981 #. type: deftp
59982 #: guix-git/doc/guix.texi:33936
59983 msgid "This is the representation of a @dfn{service type} (@pxref{Service Types and Services})."
59984 msgstr ""
59985
59986 #. type: table
59987 #: guix-git/doc/guix.texi:33940
59988 msgid "This is a symbol, used only to simplify inspection and debugging."
59989 msgstr ""
59990
59991 #. type: code{#1}
59992 #: guix-git/doc/guix.texi:33941
59993 #, no-wrap
59994 msgid "extensions"
59995 msgstr ""
59996
59997 #. type: table
59998 #: guix-git/doc/guix.texi:33943
59999 msgid "A non-empty list of @code{<service-extension>} objects (see below)."
60000 msgstr ""
60001
60002 #. type: item
60003 #: guix-git/doc/guix.texi:33944
60004 #, no-wrap
60005 msgid "@code{compose} (default: @code{#f})"
60006 msgstr ""
60007
60008 #. type: table
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."
60011 msgstr ""
60012
60013 #. type: table
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."
60016 msgstr ""
60017
60018 #. type: item
60019 #: guix-git/doc/guix.texi:33953
60020 #, no-wrap
60021 msgid "@code{extend} (default: @code{#f})"
60022 msgstr ""
60023
60024 #. type: table
60025 #: guix-git/doc/guix.texi:33955
60026 msgid "If this is @code{#f}, services of this type cannot be extended."
60027 msgstr ""
60028
60029 #. type: table
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."
60032 msgstr ""
60033
60034 #. type: table
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})."
60037 msgstr ""
60038
60039 #. type: item
60040 #: guix-git/doc/guix.texi:33968
60041 #, no-wrap
60042 msgid "@code{default-value} (default: @code{&no-default-value})"
60043 msgstr ""
60044
60045 #. type: table
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:"
60048 msgstr ""
60049
60050 #. type: lisp
60051 #: guix-git/doc/guix.texi:33974
60052 #, no-wrap
60053 msgid "(service @var{type})\n"
60054 msgstr ""
60055
60056 #. type: table
60057 #: guix-git/doc/guix.texi:33978
60058 msgid "The returned service in this case has the default value specified by @var{type}."
60059 msgstr ""
60060
60061 #. type: deftp
60062 #: guix-git/doc/guix.texi:33981
60063 msgid "@xref{Service Types and Services}, for examples."
60064 msgstr ""
60065
60066 #. type: deffn
60067 #: guix-git/doc/guix.texi:33983
60068 #, no-wrap
60069 msgid "{Scheme Procedure} service-extension @var{target-type} @"
60070 msgstr ""
60071
60072 #. type: deffn
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."
60075 msgstr ""
60076
60077 #. type: deffn
60078 #: guix-git/doc/guix.texi:33991
60079 #, no-wrap
60080 msgid "{Scheme Procedure} service-extension? @var{obj}"
60081 msgstr ""
60082
60083 #. type: deffn
60084 #: guix-git/doc/guix.texi:33993
60085 msgid "Return true if @var{obj} is a service extension."
60086 msgstr ""
60087
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."
60091 msgstr ""
60092
60093 #. type: deffn
60094 #: guix-git/doc/guix.texi:34000
60095 #, no-wrap
60096 msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}"
60097 msgstr ""
60098
60099 #. type: deffn
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."
60102 msgstr ""
60103
60104 #. type: deffn
60105 #: guix-git/doc/guix.texi:34007
60106 msgid "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an additional job:"
60107 msgstr ""
60108
60109 #. type: lisp
60110 #: guix-git/doc/guix.texi:34011
60111 #, no-wrap
60112 msgid ""
60113 "(simple-service 'my-mcron-job mcron-service-type\n"
60114 " #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n"
60115 msgstr ""
60116
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."
60120 msgstr ""
60121
60122 #. type: deffn
60123 #: guix-git/doc/guix.texi:34022
60124 #, no-wrap
60125 msgid "{Scheme Procedure} fold-services @var{services} @"
60126 msgstr ""
60127
60128 #. type: deffn
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."
60131 msgstr ""
60132
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."
60136 msgstr ""
60137
60138 #. type: defvr
60139 #: guix-git/doc/guix.texi:34031
60140 #, no-wrap
60141 msgid "{Scheme Variable} system-service-type"
60142 msgstr ""
60143
60144 #. type: defvr
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."
60147 msgstr ""
60148
60149 #. type: defvr
60150 #: guix-git/doc/guix.texi:34036
60151 #, no-wrap
60152 msgid "{Scheme Variable} boot-service-type"
60153 msgstr ""
60154
60155 #. type: defvr
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."
60158 msgstr ""
60159
60160 #. type: defvr
60161 #: guix-git/doc/guix.texi:34041
60162 #, no-wrap
60163 msgid "{Scheme Variable} etc-service-type"
60164 msgstr ""
60165
60166 #. type: defvr
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:"
60169 msgstr ""
60170
60171 #. type: lisp
60172 #: guix-git/doc/guix.texi:34048
60173 #, no-wrap
60174 msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n"
60175 msgstr ""
60176
60177 #. type: defvr
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."
60180 msgstr ""
60181
60182 #. type: defvr
60183 #: guix-git/doc/guix.texi:34054
60184 #, no-wrap
60185 msgid "{Scheme Variable} setuid-program-service-type"
60186 msgstr ""
60187
60188 #. type: defvr
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})."
60191 msgstr ""
60192
60193 #. type: defvr
60194 #: guix-git/doc/guix.texi:34060
60195 #, no-wrap
60196 msgid "{Scheme Variable} profile-service-type"
60197 msgstr ""
60198
60199 #. type: defvr
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."
60202 msgstr ""
60203
60204 #. type: anchor{#1}
60205 #: guix-git/doc/guix.texi:34068
60206 msgid "provenance-service-type"
60207 msgstr ""
60208
60209 #. type: defvr
60210 #: guix-git/doc/guix.texi:34068
60211 #, no-wrap
60212 msgid "{Scheme Variable} provenance-service-type"
60213 msgstr ""
60214
60215 #. type: defvr
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}:"
60218 msgstr ""
60219
60220 #. type: item
60221 #: guix-git/doc/guix.texi:34074
60222 #, no-wrap
60223 msgid "channels.scm"
60224 msgstr ""
60225
60226 #. type: table
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})."
60229 msgstr ""
60230
60231 #. type: item
60232 #: guix-git/doc/guix.texi:34080
60233 #, no-wrap
60234 msgid "configuration.scm"
60235 msgstr ""
60236
60237 #. type: table
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."
60240 msgstr ""
60241
60242 #. type: item
60243 #: guix-git/doc/guix.texi:34086
60244 #, no-wrap
60245 msgid "provenance"
60246 msgstr ""
60247
60248 #. type: table
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."
60251 msgstr ""
60252
60253 #. type: defvr
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''."
60256 msgstr ""
60257
60258 #. type: quotation
60259 #: guix-git/doc/guix.texi:34094
60260 #, no-wrap
60261 msgid "Caveats"
60262 msgstr ""
60263
60264 #. type: quotation
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."
60267 msgstr ""
60268
60269 #. type: quotation
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."
60272 msgstr ""
60273
60274 #. type: defvr
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}."
60277 msgstr ""
60278
60279 #. type: cindex
60280 #: guix-git/doc/guix.texi:34119
60281 #, no-wrap
60282 msgid "shepherd services"
60283 msgstr ""
60284
60285 #. type: cindex
60286 #: guix-git/doc/guix.texi:34120
60287 #, no-wrap
60288 msgid "PID 1"
60289 msgstr ""
60290
60291 #. type: cindex
60292 #: guix-git/doc/guix.texi:34121
60293 #, no-wrap
60294 msgid "init system"
60295 msgstr ""
60296
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})."
60300 msgstr ""
60301
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:"
60305 msgstr ""
60306
60307 #. type: Plain text
60308 #: guix-git/doc/guix.texi:34135
60309 msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}"
60310 msgstr ""
60311
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}})."
60315 msgstr ""
60316
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."
60320 msgstr ""
60321
60322 #. type: deftp
60323 #: guix-git/doc/guix.texi:34144
60324 #, no-wrap
60325 msgid "{Data Type} shepherd-service"
60326 msgstr ""
60327
60328 #. type: deftp
60329 #: guix-git/doc/guix.texi:34146
60330 msgid "The data type representing a service managed by the Shepherd."
60331 msgstr ""
60332
60333 #. type: code{#1}
60334 #: guix-git/doc/guix.texi:34148
60335 #, no-wrap
60336 msgid "provision"
60337 msgstr ""
60338
60339 #. type: table
60340 #: guix-git/doc/guix.texi:34150
60341 msgid "This is a list of symbols denoting what the service provides."
60342 msgstr ""
60343
60344 #. type: table
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."
60347 msgstr ""
60348
60349 #. type: item
60350 #: guix-git/doc/guix.texi:34156
60351 #, no-wrap
60352 msgid "@code{requirement} (default: @code{'()})"
60353 msgstr ""
60354
60355 #. type: table
60356 #: guix-git/doc/guix.texi:34158
60357 msgid "List of symbols denoting the Shepherd services this one depends on."
60358 msgstr ""
60359
60360 #. type: cindex
60361 #: guix-git/doc/guix.texi:34159
60362 #, no-wrap
60363 msgid "one-shot services, for the Shepherd"
60364 msgstr ""
60365
60366 #. type: table
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."
60369 msgstr ""
60370
60371 #. type: item
60372 #: guix-git/doc/guix.texi:34165
60373 #, no-wrap
60374 msgid "@code{respawn?} (default: @code{#t})"
60375 msgstr ""
60376
60377 #. type: table
60378 #: guix-git/doc/guix.texi:34168
60379 msgid "Whether to restart the service when it stops, for instance when the underlying process dies."
60380 msgstr ""
60381
60382 #. type: code{#1}
60383 #: guix-git/doc/guix.texi:34169
60384 #, no-wrap
60385 msgid "start"
60386 msgstr ""
60387
60388 #. type: itemx
60389 #: guix-git/doc/guix.texi:34170
60390 #, no-wrap
60391 msgid "@code{stop} (default: @code{#~(const #f)})"
60392 msgstr ""
60393
60394 #. type: table
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})."
60397 msgstr ""
60398
60399 #. type: item
60400 #: guix-git/doc/guix.texi:34177
60401 #, no-wrap
60402 msgid "@code{actions} (default: @code{'()})"
60403 msgstr ""
60404
60405 #. type: cindex
60406 #: guix-git/doc/guix.texi:34178
60407 #, no-wrap
60408 msgid "actions, of Shepherd services"
60409 msgstr ""
60410
60411 #. type: table
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:"
60414 msgstr ""
60415
60416 #. type: example
60417 #: guix-git/doc/guix.texi:34186
60418 #, no-wrap
60419 msgid "herd @var{action} @var{service} [@var{arguments}@dots{}]\n"
60420 msgstr ""
60421
60422 #. type: item
60423 #: guix-git/doc/guix.texi:34188
60424 #, no-wrap
60425 msgid "@code{auto-start?} (default: @code{#t})"
60426 msgstr ""
60427
60428 #. type: table
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}."
60431 msgstr ""
60432
60433 #. type: table
60434 #: guix-git/doc/guix.texi:34194
60435 msgid "A documentation string, as shown when running:"
60436 msgstr ""
60437
60438 #. type: example
60439 #: guix-git/doc/guix.texi:34197
60440 #, no-wrap
60441 msgid "herd doc @var{service-name}\n"
60442 msgstr ""
60443
60444 #. type: table
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})."
60447 msgstr ""
60448
60449 #. type: item
60450 #: guix-git/doc/guix.texi:34202
60451 #, no-wrap
60452 msgid "@code{modules} (default: @code{%default-modules})"
60453 msgstr ""
60454
60455 #. type: table
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."
60458 msgstr ""
60459
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}):"
60463 msgstr ""
60464
60465 #. type: example
60466 #: guix-git/doc/guix.texi:34225
60467 #, no-wrap
60468 msgid ""
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"
60479 msgstr ""
60480
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})."
60484 msgstr ""
60485
60486 #. type: deftp
60487 #: guix-git/doc/guix.texi:34241
60488 #, no-wrap
60489 msgid "{Data Type} shepherd-action"
60490 msgstr ""
60491
60492 #. type: deftp
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)."
60495 msgstr ""
60496
60497 #. type: table
60498 #: guix-git/doc/guix.texi:34248
60499 msgid "Symbol naming the action."
60500 msgstr ""
60501
60502 #. type: table
60503 #: guix-git/doc/guix.texi:34251
60504 msgid "This is a documentation string for the action. It can be viewed by running:"
60505 msgstr ""
60506
60507 #. type: example
60508 #: guix-git/doc/guix.texi:34254
60509 #, no-wrap
60510 msgid "herd doc @var{service} action @var{action}\n"
60511 msgstr ""
60512
60513 #. type: item
60514 #: guix-git/doc/guix.texi:34256
60515 #, no-wrap
60516 msgid "procedure"
60517 msgstr ""
60518
60519 #. type: table
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})."
60522 msgstr ""
60523
60524 #. type: deftp
60525 #: guix-git/doc/guix.texi:34264
60526 msgid "The following example defines an action called @code{say-hello} that kindly greets the user:"
60527 msgstr ""
60528
60529 #. type: lisp
60530 #: guix-git/doc/guix.texi:34273
60531 #, no-wrap
60532 msgid ""
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"
60538 " args)\n"
60539 " #t)))\n"
60540 msgstr ""
60541
60542 #. type: deftp
60543 #: guix-git/doc/guix.texi:34276
60544 msgid "Assuming this action is added to the @code{example} service, then you can do:"
60545 msgstr ""
60546
60547 #. type: example
60548 #: guix-git/doc/guix.texi:34282
60549 #, no-wrap
60550 msgid ""
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"
60555 msgstr ""
60556
60557 #. type: deftp
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."
60560 msgstr ""
60561
60562 #. type: defvr
60563 #: guix-git/doc/guix.texi:34289
60564 #, no-wrap
60565 msgid "{Scheme Variable} shepherd-root-service-type"
60566 msgstr ""
60567
60568 #. type: defvr
60569 #: guix-git/doc/guix.texi:34291
60570 msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1."
60571 msgstr ""
60572
60573 #. type: defvr
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."
60576 msgstr ""
60577
60578 #. type: deftp
60579 #: guix-git/doc/guix.texi:34298
60580 #, no-wrap
60581 msgid "{Data Type} shepherd-configuration"
60582 msgstr ""
60583
60584 #. type: deftp
60585 #: guix-git/doc/guix.texi:34300
60586 msgid "This data type represents the Shepherd's configuration."
60587 msgstr ""
60588
60589 #. type: item
60590 #: guix-git/doc/guix.texi:34302
60591 #, no-wrap
60592 msgid "shepherd (default: @code{shepherd})"
60593 msgstr ""
60594
60595 #. type: table
60596 #: guix-git/doc/guix.texi:34304
60597 msgid "The Shepherd package to use."
60598 msgstr ""
60599
60600 #. type: item
60601 #: guix-git/doc/guix.texi:34305
60602 #, no-wrap
60603 msgid "services (default: @code{'()})"
60604 msgstr ""
60605
60606 #. type: table
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})."
60609 msgstr ""
60610
60611 #. type: Plain text
60612 #: guix-git/doc/guix.texi:34314
60613 msgid "The following example specifies the Shepherd package for the operating system:"
60614 msgstr ""
60615
60616 #. type: lisp
60617 #: guix-git/doc/guix.texi:34329
60618 #, no-wrap
60619 msgid ""
60620 "(operating-system\n"
60621 " ;; ...\n"
60622 " (services (append (list openssh-service-type))\n"
60623 " ;; ...\n"
60624 " %desktop-services)\n"
60625 " ;; ...\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"
60633 msgstr ""
60634
60635 #. type: defvr
60636 #: guix-git/doc/guix.texi:34331
60637 #, no-wrap
60638 msgid "{Scheme Variable} %shepherd-root-service"
60639 msgstr ""
60640
60641 #. type: defvr
60642 #: guix-git/doc/guix.texi:34333
60643 msgid "This service represents PID@tie{}1."
60644 msgstr ""
60645
60646 #. type: cindex
60647 #: guix-git/doc/guix.texi:34339
60648 #, no-wrap
60649 msgid "documentation, searching for"
60650 msgstr ""
60651
60652 #. type: cindex
60653 #: guix-git/doc/guix.texi:34340
60654 #, no-wrap
60655 msgid "searching for documentation"
60656 msgstr ""
60657
60658 #. type: cindex
60659 #: guix-git/doc/guix.texi:34341
60660 #, no-wrap
60661 msgid "Info, documentation format"
60662 msgstr ""
60663
60664 #. type: cindex
60665 #: guix-git/doc/guix.texi:34342
60666 #, no-wrap
60667 msgid "man pages"
60668 msgstr ""
60669
60670 #. type: cindex
60671 #: guix-git/doc/guix.texi:34343
60672 #, no-wrap
60673 msgid "manual pages"
60674 msgstr ""
60675
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}."
60679 msgstr ""
60680
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:"
60684 msgstr ""
60685
60686 #. type: example
60687 #: guix-git/doc/guix.texi:34362
60688 #, no-wrap
60689 msgid ""
60690 "$ info -k TLS\n"
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"
60695 "@dots{}\n"
60696 msgstr ""
60697
60698 #. type: Plain text
60699 #: guix-git/doc/guix.texi:34366
60700 msgid "The command below searches for the same keyword in man pages:"
60701 msgstr ""
60702
60703 #. type: example
60704 #: guix-git/doc/guix.texi:34372
60705 #, no-wrap
60706 msgid ""
60707 "$ man -k TLS\n"
60708 "SSL (7) - OpenSSL SSL/TLS library\n"
60709 "certtool (1) - GnuTLS certificate tool\n"
60710 "@dots {}\n"
60711 msgstr ""
60712
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."
60716 msgstr ""
60717
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:"
60721 msgstr ""
60722
60723 #. type: example
60724 #: guix-git/doc/guix.texi:34384
60725 #, no-wrap
60726 msgid "$ info \"(gnutls)Core TLS API\"\n"
60727 msgstr ""
60728
60729 #. type: Plain text
60730 #: guix-git/doc/guix.texi:34388
60731 msgid "or:"
60732 msgstr ""
60733
60734 #. type: example
60735 #: guix-git/doc/guix.texi:34391
60736 #, no-wrap
60737 msgid "$ man certtool\n"
60738 msgstr ""
60739
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."
60743 msgstr ""
60744
60745 #. type: cindex
60746 #: guix-git/doc/guix.texi:34403
60747 #, no-wrap
60748 msgid "debugging files"
60749 msgstr ""
60750
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."
60754 msgstr ""
60755
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."
60759 msgstr ""
60760
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})."
60764 msgstr ""
60765
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})."
60769 msgstr ""
60770
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:"
60774 msgstr ""
60775
60776 #. type: example
60777 #: guix-git/doc/guix.texi:34447
60778 #, no-wrap
60779 msgid "guix install glibc:debug guile:debug\n"
60780 msgstr ""
60781
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}):"
60785 msgstr ""
60786
60787 #. type: example
60788 #: guix-git/doc/guix.texi:34456
60789 #, no-wrap
60790 msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n"
60791 msgstr ""
60792
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}."
60796 msgstr ""
60797
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})."
60801 msgstr ""
60802
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})."
60806 msgstr ""
60807
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."
60811 msgstr ""
60812
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."
60816 msgstr ""
60817
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:"
60821 msgstr ""
60822
60823 #. type: example
60824 #: guix-git/doc/guix.texi:34505
60825 #, no-wrap
60826 msgid ""
60827 "(gdb) bt\n"
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"
60836 msgstr ""
60837
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:"
60841 msgstr ""
60842
60843 #. type: Plain text
60844 #: guix-git/doc/guix.texi:34515
60845 msgid "This time, debugging will be a whole lot nicer:"
60846 msgstr ""
60847
60848 #. type: example
60849 #: guix-git/doc/guix.texi:34533
60850 #, no-wrap
60851 msgid ""
60852 "$ gdb --args sh -c 'exec inkscape'\n"
60853 "@dots{}\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"
60858 "(gdb) r\n"
60859 "Starting program: /gnu/store/@dots{}-profile/bin/sh -c exec\\ inkscape\n"
60860 "@dots{}\n"
60861 "(gdb) bt\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"
60867 "@dots{}\n"
60868 msgstr ""
60869
60870 #. type: Plain text
60871 #: guix-git/doc/guix.texi:34536
60872 msgid "Much better!"
60873 msgstr ""
60874
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."
60878 msgstr ""
60879
60880 #. type: cindex
60881 #: guix-git/doc/guix.texi:34544
60882 #, no-wrap
60883 msgid "security updates"
60884 msgstr ""
60885
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:"
60889 msgstr ""
60890
60891 #. type: smallexample
60892 #: guix-git/doc/guix.texi:34560
60893 #, no-wrap
60894 msgid ""
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"
60899 "@dots{}\n"
60900 msgstr ""
60901
60902 #. type: Plain text
60903 #: guix-git/doc/guix.texi:34563
60904 msgid "@xref{Invoking guix lint}, for more information."
60905 msgstr ""
60906
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."
60910 msgstr ""
60911
60912 #. type: cindex
60913 #: guix-git/doc/guix.texi:34573
60914 #, no-wrap
60915 msgid "grafts"
60916 msgstr ""
60917
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."
60921 msgstr ""
60922
60923 #. type: cindex
60924 #: guix-git/doc/guix.texi:34582
60925 #, no-wrap
60926 msgid "replacements of packages, for grafts"
60927 msgstr ""
60928
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:"
60932 msgstr ""
60933
60934 #. type: lisp
60935 #: guix-git/doc/guix.texi:34595
60936 #, no-wrap
60937 msgid ""
60938 "(define bash\n"
60939 " (package\n"
60940 " (name \"bash\")\n"
60941 " ;; @dots{}\n"
60942 " (replacement bash-fixed)))\n"
60943 msgstr ""
60944
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."
60948 msgstr ""
60949
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."
60953 msgstr ""
60954
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:"
60958 msgstr ""
60959
60960 #. type: example
60961 #: guix-git/doc/guix.texi:34620
60962 #, no-wrap
60963 msgid "guix build bash --no-grafts\n"
60964 msgstr ""
60965
60966 #. type: Plain text
60967 #: guix-git/doc/guix.texi:34624
60968 msgid "returns the store file name of the original Bash, whereas:"
60969 msgstr ""
60970
60971 #. type: example
60972 #: guix-git/doc/guix.texi:34627
60973 #, no-wrap
60974 msgid "guix build bash\n"
60975 msgstr ""
60976
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."
60980 msgstr ""
60981
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}):"
60985 msgstr ""
60986
60987 #. type: example
60988 #: guix-git/doc/guix.texi:34638
60989 #, no-wrap
60990 msgid "guix gc -R $(readlink -f ~/.guix-profile) | grep bash\n"
60991 msgstr ""
60992
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:"
60996 msgstr ""
60997
60998 #. type: example
60999 #: guix-git/doc/guix.texi:34646
61000 #, no-wrap
61001 msgid "guix gc -R $(guix system build my-config.scm) | grep bash\n"
61002 msgstr ""
61003
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:"
61007 msgstr ""
61008
61009 #. type: example
61010 #: guix-git/doc/guix.texi:34653
61011 #, no-wrap
61012 msgid "lsof | grep /gnu/store/.*bash\n"
61013 msgstr ""
61014
61015 #. type: cindex
61016 #: guix-git/doc/guix.texi:34661
61017 #, no-wrap
61018 msgid "bootstrapping"
61019 msgstr ""
61020
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?"
61024 msgstr ""
61025
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."
61029 msgstr ""
61030
61031 #. type: cindex
61032 #: guix-git/doc/guix.texi:34677 guix-git/doc/guix.texi:34889
61033 #, no-wrap
61034 msgid "bootstrap binaries"
61035 msgstr ""
61036
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}."
61040 msgstr ""
61041
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})."
61045 msgstr ""
61046
61047 #. type: section
61048 #: guix-git/doc/guix.texi:34698
61049 #, no-wrap
61050 msgid "The Reduced Binary Seed Bootstrap"
61051 msgstr ""
61052
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.''"
61056 msgstr ""
61057
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."
61061 msgstr ""
61062
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.}."
61066 msgstr ""
61067
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)."
61071 msgstr ""
61072
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."
61076 msgstr ""
61077
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."
61081 msgstr ""
61082
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."
61086 msgstr ""
61087
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."
61091 msgstr ""
61092
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}"
61096 msgstr ""
61097
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.}."
61101 msgstr ""
61102
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}."
61106 msgstr ""
61107
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."
61111 msgstr ""
61112
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}."
61116 msgstr ""
61117
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}"
61121 msgstr ""
61122
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:"
61126 msgstr ""
61127
61128 #. type: example
61129 #: guix-git/doc/guix.texi:34788
61130 #, no-wrap
61131 msgid ""
61132 "guix graph -t derivation \\\n"
61133 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n"
61134 " | dot -Tps > gcc.ps\n"
61135 msgstr ""
61136
61137 #. type: Plain text
61138 #: guix-git/doc/guix.texi:34791
61139 msgid "or, for the further Reduced Binary Seed bootstrap"
61140 msgstr ""
61141
61142 #. type: example
61143 #: guix-git/doc/guix.texi:34796
61144 #, no-wrap
61145 msgid ""
61146 "guix graph -t derivation \\\n"
61147 " -e '(@@@@ (gnu packages bootstrap) %bootstrap-mes)' \\\n"
61148 " | dot -Tps > mes.ps\n"
61149 msgstr ""
61150
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})."
61154 msgstr ""
61155
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."
61159 msgstr ""
61160
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})."
61164 msgstr ""
61165
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."
61169 msgstr ""
61170
61171 #. type: unnumberedsec
61172 #: guix-git/doc/guix.texi:34832
61173 #, no-wrap
61174 msgid "Building the Build Tools"
61175 msgstr ""
61176
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."
61180 msgstr ""
61181
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:"
61185 msgstr ""
61186
61187 #. type: example
61188 #: guix-git/doc/guix.texi:34853
61189 #, no-wrap
61190 msgid ""
61191 "guix graph -t bag \\\n"
61192 " -e '(@@@@ (gnu packages commencement)\n"
61193 " glibc-final-with-bootstrap-bash)' | xdot -\n"
61194 msgstr ""
61195
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."
61199 msgstr ""
61200
61201 #. type: Plain text
61202 #: guix-git/doc/guix.texi:34862
61203 msgid "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}"
61204 msgstr ""
61205
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."
61209 msgstr ""
61210
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."
61214 msgstr ""
61215
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."
61219 msgstr ""
61220
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}})."
61224 msgstr ""
61225
61226 #. type: unnumberedsec
61227 #: guix-git/doc/guix.texi:34887
61228 #, no-wrap
61229 msgid "Building the Bootstrap Binaries"
61230 msgstr ""
61231
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."
61235 msgstr ""
61236
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):"
61240 msgstr ""
61241
61242 #. type: example
61243 #: guix-git/doc/guix.texi:34903
61244 #, no-wrap
61245 msgid "guix build bootstrap-tarballs\n"
61246 msgstr ""
61247
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."
61251 msgstr ""
61252
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."
61256 msgstr ""
61257
61258 #. type: unnumberedsec
61259 #: guix-git/doc/guix.texi:34915
61260 #, no-wrap
61261 msgid "Reducing the Set of Bootstrap Binaries"
61262 msgstr ""
61263
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}."
61267 msgstr ""
61268
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."
61272 msgstr ""
61273
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."
61277 msgstr ""
61278
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."
61282 msgstr ""
61283
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!"
61287 msgstr ""
61288
61289 #. type: chapter
61290 #: guix-git/doc/guix.texi:34949
61291 #, no-wrap
61292 msgid "Porting to a New Platform"
61293 msgstr ""
61294
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."
61298 msgstr ""
61299
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:"
61303 msgstr ""
61304
61305 #. type: example
61306 #: guix-git/doc/guix.texi:34966
61307 #, no-wrap
61308 msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n"
61309 msgstr ""
61310
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."
61314 msgstr ""
61315
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."
61319 msgstr ""
61320
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."
61324 msgstr ""
61325
61326 #. type: include
61327 #: guix-git/doc/guix.texi:34993
61328 #, no-wrap
61329 msgid "contributing.texi"
61330 msgstr "contributing.sk.texi"
61331
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."
61335 msgstr ""
61336
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."
61340 msgstr ""
61341
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!"
61345 msgstr ""
61346
61347 #. type: cindex
61348 #: guix-git/doc/guix.texi:35020
61349 #, no-wrap
61350 msgid "license, GNU Free Documentation License"
61351 msgstr ""
61352
61353 #. type: include
61354 #: guix-git/doc/guix.texi:35021
61355 #, no-wrap
61356 msgid "fdl-1.3.texi"
61357 msgstr ""