Commit | Line | Data |
---|---|---|
568717fd LC |
1 | \input texinfo |
2 | @c -*-texinfo-*- | |
3 | ||
4 | @c %**start of header | |
5 | @setfilename guix.info | |
6 | @documentencoding UTF-8 | |
f8348b91 | 7 | @settitle GNU Guix Reference Manual |
568717fd LC |
8 | @c %**end of header |
9 | ||
10 | @include version.texi | |
7df7a74e NK |
11 | |
12 | @copying | |
db5a9444 | 13 | Copyright @copyright{} 2012, 2013, 2014, 2015, 2016 Ludovic Courtès@* |
f97c9175 | 14 | Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* |
87eafdbd | 15 | Copyright @copyright{} 2013 Nikita Karetnikov@* |
8c01b9d0 ML |
16 | Copyright @copyright{} 2015 Mathieu Lirzin@* |
17 | Copyright @copyright{} 2014 Pierre-Antoine Rault@* | |
97d76250 LF |
18 | Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* |
19 | Copyright @copyright{} 2015, 2016 Leo Famulari | |
7df7a74e NK |
20 | |
21 | Permission is granted to copy, distribute and/or modify this document | |
22 | under the terms of the GNU Free Documentation License, Version 1.3 or | |
23 | any later version published by the Free Software Foundation; with no | |
24 | Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | |
25 | copy of the license is included in the section entitled ``GNU Free | |
26 | Documentation License''. | |
27 | @end copying | |
568717fd | 28 | |
eeaf4427 | 29 | @dircategory Package management |
568717fd LC |
30 | @direntry |
31 | * guix: (guix). Guix, the functional package manager. | |
e49951eb | 32 | * guix package: (guix)Invoking guix package |
eeaf4427 | 33 | Managing packages with Guix. |
e49951eb | 34 | * guix build: (guix)Invoking guix build |
568717fd | 35 | Building packages with Guix. |
054e8576 LC |
36 | * guix system: (guix)Invoking guix system |
37 | Managing the operating system configuration. | |
568717fd | 38 | @end direntry |
568717fd | 39 | |
372c4bbc DT |
40 | @dircategory Software development |
41 | @direntry | |
42 | * guix environment: (guix)Invoking guix environment | |
43 | Building development environments with Guix. | |
44 | @end direntry | |
45 | ||
568717fd | 46 | @titlepage |
7730d112 LC |
47 | @title GNU Guix Reference Manual |
48 | @subtitle Using the GNU Guix Functional Package Manager | |
2cbed07e | 49 | @author The GNU Guix Developers |
568717fd LC |
50 | |
51 | @page | |
52 | @vskip 0pt plus 1filll | |
53 | Edition @value{EDITION} @* | |
54 | @value{UPDATED} @* | |
55 | ||
7df7a74e | 56 | @insertcopying |
568717fd LC |
57 | @end titlepage |
58 | ||
568717fd LC |
59 | @contents |
60 | ||
61 | @c ********************************************************************* | |
62 | @node Top | |
f8348b91 | 63 | @top GNU Guix |
568717fd | 64 | |
f8348b91 LC |
65 | This document describes GNU Guix version @value{VERSION}, a functional |
66 | package management tool written for the GNU system. | |
568717fd LC |
67 | |
68 | @menu | |
69 | * Introduction:: What is Guix about? | |
bd5e766b | 70 | * Installation:: Installing Guix. |
eeaf4427 | 71 | * Package Management:: Package installation, upgrade, etc. |
c554de89 | 72 | * Emacs Interface:: Using Guix from Emacs. |
568717fd LC |
73 | * Programming Interface:: Using Guix in Scheme. |
74 | * Utilities:: Package management commands. | |
a1ba8475 | 75 | * GNU Distribution:: Software for your friendly GNU system. |
9bf3c1a7 | 76 | * Contributing:: Your help needed! |
568717fd LC |
77 | |
78 | * Acknowledgments:: Thanks! | |
79 | * GNU Free Documentation License:: The license of this manual. | |
80 | * Concept Index:: Concepts. | |
a85b83d2 | 81 | * Programming Index:: Data types, functions, and variables. |
aaa3eaa9 LC |
82 | |
83 | @detailmenu | |
84 | --- The Detailed Node Listing --- | |
85 | ||
86 | Installation | |
87 | ||
1b2b8177 | 88 | * Binary Installation:: Getting Guix running in no time! |
aaa3eaa9 | 89 | * Requirements:: Software needed to build and run Guix. |
ec0339cd | 90 | * Running the Test Suite:: Testing Guix. |
aaa3eaa9 LC |
91 | * Setting Up the Daemon:: Preparing the build daemon's environment. |
92 | * Invoking guix-daemon:: Running the build daemon. | |
0e2d0213 | 93 | * Application Setup:: Application-specific setup. |
aaa3eaa9 LC |
94 | |
95 | Setting Up the Daemon | |
96 | ||
97 | * Build Environment Setup:: Preparing the isolated build environment. | |
98 | * Daemon Offload Setup:: Offloading builds to remote machines. | |
99 | ||
100 | Package Management | |
101 | ||
102 | * Features:: How Guix will make your life brighter. | |
103 | * Invoking guix package:: Package installation, removal, etc. | |
aaa3eaa9 LC |
104 | * Substitutes:: Downloading pre-built binaries. |
105 | * Packages with Multiple Outputs:: Single source package, multiple outputs. | |
106 | * Invoking guix gc:: Running the garbage collector. | |
107 | * Invoking guix pull:: Fetching the latest Guix and distribution. | |
108 | * Invoking guix archive:: Exporting and importing store files. | |
109 | ||
c554de89 AK |
110 | Emacs Interface |
111 | ||
112 | * Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}. | |
113 | * Package Management: Emacs Package Management. Managing packages and generations. | |
687c9bc0 | 114 | * Licenses: Emacs Licenses. Interface for licenses of Guix packages. |
9b0afb0d | 115 | * Popup Interface: Emacs Popup Interface. Magit-like interface for guix commands. |
c554de89 | 116 | * Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}} file names. |
34850cd5 | 117 | * Build Log Mode: Emacs Build Log. Highlighting Guix build logs. |
187f80c6 AK |
118 | * Completions: Emacs Completions. Completing @command{guix} shell command. |
119 | * Development: Emacs Development. Tools for Guix developers. | |
32950fc8 | 120 | * Hydra: Emacs Hydra. Interface for Guix build farm. |
c554de89 | 121 | |
aaa3eaa9 LC |
122 | Programming Interface |
123 | ||
124 | * Defining Packages:: Defining new packages. | |
125 | * Build Systems:: Specifying how packages are built. | |
126 | * The Store:: Manipulating the package store. | |
127 | * Derivations:: Low-level interface to package derivations. | |
128 | * The Store Monad:: Purely functional interface to the store. | |
129 | * G-Expressions:: Manipulating build expressions. | |
130 | ||
92492b23 LC |
131 | Defining Packages |
132 | ||
133 | * package Reference:: The package data type. | |
134 | * origin Reference:: The origin data type. | |
135 | ||
aaa3eaa9 LC |
136 | Utilities |
137 | ||
138 | * Invoking guix build:: Building packages from the command line. | |
fcc58db6 | 139 | * Invoking guix edit:: Editing package definitions. |
aaa3eaa9 LC |
140 | * Invoking guix download:: Downloading a file and printing its hash. |
141 | * Invoking guix hash:: Computing the cryptographic hash of a file. | |
142 | * Invoking guix import:: Importing package definitions. | |
143 | * Invoking guix refresh:: Updating package definitions. | |
144 | * Invoking guix lint:: Finding errors in package definitions. | |
fcc58db6 | 145 | * Invoking guix size:: Profiling disk usage. |
88856916 | 146 | * Invoking guix graph:: Visualizing the graph of packages. |
aaa3eaa9 | 147 | * Invoking guix environment:: Setting up development environments. |
aff8ce7c | 148 | * Invoking guix publish:: Sharing substitutes. |
d23c20f1 | 149 | * Invoking guix challenge:: Challenging substitute servers. |
32efa254 | 150 | * Invoking guix container:: Process isolation. |
aaa3eaa9 LC |
151 | |
152 | GNU Distribution | |
153 | ||
154 | * System Installation:: Installing the whole operating system. | |
35ed9306 | 155 | * System Configuration:: Configuring the operating system. |
aaa3eaa9 LC |
156 | * Installing Debugging Files:: Feeding the debugger. |
157 | * Security Updates:: Deploying security fixes quickly. | |
158 | * Package Modules:: Packages from the programmer's viewpoint. | |
159 | * Packaging Guidelines:: Growing the distribution. | |
160 | * Bootstrapping:: GNU/Linux built from scratch. | |
161 | * Porting:: Targeting another platform or kernel. | |
162 | ||
163 | System Configuration | |
164 | ||
165 | * Using the Configuration System:: Customizing your GNU system. | |
166 | * operating-system Reference:: Detail of operating-system declarations. | |
167 | * File Systems:: Configuring file system mounts. | |
168 | * Mapped Devices:: Block device extra processing. | |
169 | * User Accounts:: Specifying user accounts. | |
598e19dc | 170 | * Locales:: Language and cultural convention settings. |
aaa3eaa9 LC |
171 | * Services:: Specifying system services. |
172 | * Setuid Programs:: Programs running with root privileges. | |
1b2b8177 | 173 | * X.509 Certificates:: Authenticating HTTPS servers. |
996ed739 | 174 | * Name Service Switch:: Configuring libc's name service switch. |
aaa3eaa9 LC |
175 | * Initial RAM Disk:: Linux-Libre bootstrapping. |
176 | * GRUB Configuration:: Configuring the boot loader. | |
177 | * Invoking guix system:: Instantiating a system configuration. | |
97d76250 | 178 | * Running GuixSD in a VM:: How to run GuixSD in a virtual machine. |
aaa3eaa9 LC |
179 | * Defining Services:: Adding new service definitions. |
180 | ||
181 | Services | |
182 | ||
183 | * Base Services:: Essential system services. | |
184 | * Networking Services:: Network setup, SSH daemon, etc. | |
185 | * X Window:: Graphical display. | |
1b2b8177 LC |
186 | * Desktop Services:: D-Bus and desktop services. |
187 | * Database Services:: SQL databases. | |
d8c18af8 | 188 | * Mail Services:: IMAP, POP3, SMTP, and all that. |
cbd02397 | 189 | * Web Services:: Web servers. |
aa4ed923 | 190 | * Various Services:: Other services. |
aaa3eaa9 | 191 | |
0adfe95a LC |
192 | Defining Services |
193 | ||
194 | * Service Composition:: The model for composing services. | |
195 | * Service Types and Services:: Types and services. | |
196 | * Service Reference:: API reference. | |
dd17bc38 | 197 | * Shepherd Services:: A particular type of service. |
0adfe95a | 198 | |
aaa3eaa9 LC |
199 | Packaging Guidelines |
200 | ||
ec0339cd LC |
201 | * Software Freedom:: What may go into the distribution. |
202 | * Package Naming:: What's in a name? | |
203 | * Version Numbers:: When the name is not enough. | |
cbd02397 | 204 | * Synopses and Descriptions:: Helping users find the right package. |
ec0339cd LC |
205 | * Python Modules:: Taming the snake. |
206 | * Perl Modules:: Little pearls. | |
207 | * Fonts:: Fond of fonts. | |
aaa3eaa9 | 208 | |
8c01b9d0 ML |
209 | Contributing |
210 | ||
211 | * Building from Git:: The latest and greatest. | |
212 | * Running Guix Before It Is Installed:: Hacker tricks. | |
213 | * The Perfect Setup:: The right tools. | |
214 | * Coding Style:: Hygiene of the contributor. | |
215 | * Submitting Patches:: Share your work. | |
216 | ||
217 | Coding Style | |
218 | ||
219 | * Programming Paradigm:: How to compose your elements. | |
220 | * Modules:: Where to store your code? | |
221 | * Data Types and Pattern Matching:: Implementing data structures. | |
222 | * Formatting Code:: Writing conventions. | |
223 | ||
aaa3eaa9 | 224 | @end detailmenu |
568717fd LC |
225 | @end menu |
226 | ||
227 | @c ********************************************************************* | |
228 | @node Introduction | |
229 | @chapter Introduction | |
230 | ||
c80e7e55 LC |
231 | GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' |
232 | using the international phonetic alphabet (IPA).} is a functional | |
233 | package management tool for the GNU system. Package management consists | |
4bfc4ea3 NK |
234 | of all activities that relate to building packages from sources, |
235 | honoring their build-time and run-time dependencies, | |
c80e7e55 LC |
236 | installing packages in user environments, upgrading installed packages |
237 | to new versions or rolling back to a previous set, removing unused | |
238 | software packages, etc. | |
568717fd LC |
239 | |
240 | @cindex functional package management | |
241 | The term @dfn{functional} refers to a specific package management | |
136787cb LC |
242 | discipline pioneered by Nix (@pxref{Acknowledgments}). |
243 | In Guix, the package build and installation process is seen | |
4bfc4ea3 NK |
244 | as a function, in the mathematical sense. That function takes inputs, |
245 | such as build scripts, a compiler, and libraries, and | |
246 | returns an installed package. As a pure function, its result depends | |
568717fd LC |
247 | solely on its inputs---for instance, it cannot refer to software or |
248 | scripts that were not explicitly passed as inputs. A build function | |
4bfc4ea3 | 249 | always produces the same result when passed a given set of inputs. It |
f97c9175 | 250 | cannot alter the environment of the running system in |
568717fd LC |
251 | any way; for instance, it cannot create, modify, or delete files outside |
252 | of its build and installation directories. This is achieved by running | |
e900c503 | 253 | build processes in isolated environments (or @dfn{containers}), where only their |
4bfc4ea3 | 254 | explicit inputs are visible. |
568717fd | 255 | |
e531ac2a | 256 | @cindex store |
568717fd | 257 | The result of package build functions is @dfn{cached} in the file |
e531ac2a | 258 | system, in a special directory called @dfn{the store} (@pxref{The |
f97c9175 | 259 | Store}). Each package is installed in a directory of its own in the |
834129e0 | 260 | store---by default under @file{/gnu/store}. The directory name contains |
568717fd LC |
261 | a hash of all the inputs used to build that package; thus, changing an |
262 | input yields a different directory name. | |
263 | ||
f97c9175 AE |
264 | This approach is the foundation for the salient features of Guix: support |
265 | for transactional package upgrade and rollback, per-user installation, and | |
eeaf4427 | 266 | garbage collection of packages (@pxref{Features}). |
568717fd | 267 | |
4bfc4ea3 | 268 | Guix has a command-line interface, which allows users to build, install, |
568717fd | 269 | upgrade, and remove packages, as well as a Scheme programming interface. |
568717fd | 270 | |
3ca2731c | 271 | @cindex Guix System Distribution |
4705641f | 272 | @cindex GuixSD |
a1ba8475 | 273 | Last but not least, Guix is used to build a distribution of the GNU |
3ca2731c | 274 | system, with many GNU and non-GNU free software packages. The Guix |
4705641f LC |
275 | System Distribution, or GNU@tie{}GuixSD, takes advantage of the core |
276 | properties of Guix at the system level. With GuixSD, users | |
3ca2731c LC |
277 | @emph{declare} all aspects of the operating system configuration, and |
278 | Guix takes care of instantiating that configuration in a reproducible, | |
279 | stateless fashion. @xref{GNU Distribution}. | |
a1ba8475 | 280 | |
bd5e766b LC |
281 | @c ********************************************************************* |
282 | @node Installation | |
283 | @chapter Installation | |
284 | ||
48febeb8 LC |
285 | GNU Guix is available for download from its website at |
286 | @url{http://www.gnu.org/software/guix/}. This section describes the | |
287 | software requirements of Guix, as well as how to install it and get | |
288 | ready to use it. | |
bd5e766b | 289 | |
5af6de3e LC |
290 | Note that this section is concerned with the installation of the package |
291 | manager, which can be done on top of a running GNU/Linux system. If, | |
292 | instead, you want to install the complete GNU operating system, | |
6621cdb6 | 293 | @pxref{System Installation}. |
5af6de3e | 294 | |
bd5e766b | 295 | @menu |
09722b11 | 296 | * Binary Installation:: Getting Guix running in no time! |
bd5e766b | 297 | * Requirements:: Software needed to build and run Guix. |
ec0339cd | 298 | * Running the Test Suite:: Testing Guix. |
bd5e766b LC |
299 | * Setting Up the Daemon:: Preparing the build daemon's environment. |
300 | * Invoking guix-daemon:: Running the build daemon. | |
0e2d0213 | 301 | * Application Setup:: Application-specific setup. |
bd5e766b LC |
302 | @end menu |
303 | ||
09722b11 LC |
304 | @node Binary Installation |
305 | @section Binary Installation | |
306 | ||
307 | This section describes how to install Guix on an arbitrary system from a | |
308 | self-contained tarball providing binaries for Guix and for all its | |
309 | dependencies. This is often quicker than installing from source, which | |
310 | is described in the next sections. The only requirement is to have | |
311 | GNU@tie{}tar and Xz. | |
312 | ||
313 | Installing goes along these lines: | |
314 | ||
315 | @enumerate | |
316 | @item | |
317 | Download the binary tarball from | |
daa8922a LC |
318 | @indicateurl{ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz}, |
319 | where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine | |
320 | already running the kernel Linux, and so on. | |
321 | ||
322 | Make sure to download the associated @file{.sig} file and to verify the | |
323 | authenticity of the tarball against it, along these lines: | |
324 | ||
325 | @example | |
326 | $ wget ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig | |
327 | $ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig | |
328 | @end example | |
329 | ||
f97c9175 | 330 | If that command fails because you do not have the required public key, |
daa8922a LC |
331 | then run this command to import it: |
332 | ||
333 | @example | |
334 | $ gpg --keyserver keys.gnupg.net --recv-keys 3D9AEBB5 | |
335 | @end example | |
336 | ||
337 | @noindent | |
338 | and rerun the @code{gpg --verify} command. | |
09722b11 LC |
339 | |
340 | @item | |
341 | As @code{root}, run: | |
342 | ||
343 | @example | |
5dc42964 | 344 | # cd /tmp |
254b1c2e LC |
345 | # tar --warning=no-timestamp -xf \ |
346 | guix-binary-@value{VERSION}.@var{system}.tar.xz | |
5dc42964 | 347 | # mv var/guix /var/ && mv gnu / |
09722b11 LC |
348 | @end example |
349 | ||
7acd3439 LC |
350 | This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. |
351 | The latter contains a ready-to-use profile for @code{root} (see next | |
352 | step.) | |
09722b11 | 353 | |
5dc3ce5f LC |
354 | Do @emph{not} unpack the tarball on a working Guix system since that |
355 | would overwrite its own essential files. | |
356 | ||
254b1c2e | 357 | The @code{--warning=no-timestamp} option makes sure GNU@tie{}tar does |
e9ba6357 LC |
358 | not emit warnings about ``implausibly old time stamps'' (such |
359 | warnings were triggered by GNU@tie{}tar 1.26 and older; recent | |
360 | versions are fine.) | |
361 | They stem from the fact that all the | |
254b1c2e LC |
362 | files in the archive have their modification time set to zero (which |
363 | means January 1st, 1970.) This is done on purpose to make sure the | |
364 | archive content is independent of its creation time, thus making it | |
365 | reproducible. | |
366 | ||
7acd3439 LC |
367 | @item |
368 | Make @code{root}'s profile available under @file{~/.guix-profile}: | |
369 | ||
370 | @example | |
371 | # ln -sf /var/guix/profiles/per-user/root/guix-profile \ | |
372 | ~root/.guix-profile | |
373 | @end example | |
374 | ||
43c33047 LC |
375 | @item |
376 | Create the group and user accounts for build users as explained below | |
377 | (@pxref{Build Environment Setup}). | |
378 | ||
09722b11 | 379 | @item |
bf98aea9 | 380 | Run the daemon, and set it to automatically start on boot. |
c8e26887 | 381 | |
bf98aea9 LC |
382 | If your host distro uses the systemd init system, this can be achieved |
383 | with these commands: | |
c8e26887 GC |
384 | |
385 | @example | |
386 | # cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \ | |
387 | /etc/systemd/system/ | |
388 | # systemctl start guix-daemon && systemctl enable guix-daemon | |
389 | @end example | |
390 | ||
391 | If your host distro uses the Upstart init system: | |
09722b11 LC |
392 | |
393 | @example | |
c8e26887 | 394 | # cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/ |
bf98aea9 | 395 | # start guix-daemon |
09722b11 LC |
396 | @end example |
397 | ||
c8e26887 GC |
398 | Otherwise, you can still start the daemon manually with: |
399 | ||
400 | @example | |
401 | # ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild | |
402 | @end example | |
d2825c96 | 403 | |
09722b11 LC |
404 | @item |
405 | Make the @command{guix} command available to other users on the machine, | |
406 | for instance with: | |
407 | ||
408 | @example | |
409 | # mkdir -p /usr/local/bin | |
410 | # cd /usr/local/bin | |
d72d05f9 | 411 | # ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix |
09722b11 | 412 | @end example |
39f8ed14 | 413 | |
aca738f3 LC |
414 | It is also a good idea to make the Info version of this manual available |
415 | there: | |
416 | ||
417 | @example | |
418 | # mkdir -p /usr/local/share/info | |
419 | # cd /usr/local/share/info | |
420 | # for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ; | |
421 | do ln -s $i ; done | |
422 | @end example | |
423 | ||
424 | That way, assuming @file{/usr/local/share/info} is in the search path, | |
425 | running @command{info guix} will open this manual (@pxref{Other Info | |
426 | Directories,,, texinfo, GNU Texinfo}, for more details on changing the | |
427 | Info search path.) | |
428 | ||
39f8ed14 LC |
429 | @item |
430 | To use substitutes from @code{hydra.gnu.org} (@pxref{Substitutes}), | |
431 | authorize them: | |
432 | ||
433 | @example | |
7acd3439 | 434 | # guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub |
39f8ed14 | 435 | @end example |
09722b11 LC |
436 | @end enumerate |
437 | ||
bf98aea9 | 438 | This completes root-level install of Guix. Each user will need to |
c8e26887 GC |
439 | perform additional steps to make their Guix envionment ready for use, |
440 | @pxref{Application Setup}. | |
09722b11 | 441 | |
c8e26887 GC |
442 | You can confirm that Guix is working by installing a sample package into |
443 | the root profile: | |
09722b11 LC |
444 | |
445 | @example | |
c8e26887 | 446 | # guix package -i hello |
09722b11 LC |
447 | @end example |
448 | ||
c8e26887 GC |
449 | The @code{guix} package must remain available in @code{root}'s profile, |
450 | or it would become subject to garbage collection---in which case you | |
451 | would find yourself badly handicapped by the lack of the @command{guix} | |
bf98aea9 LC |
452 | command. In other words, do not remove @code{guix} by running |
453 | @code{guix package -r guix}. | |
454 | ||
455 | The binary installation tarball can be (re)produced and verified simply | |
456 | by running the following command in the Guix source tree: | |
457 | ||
458 | @example | |
459 | make guix-binary.@var{system}.tar.xz | |
460 | @end example | |
c8e26887 | 461 | |
09722b11 | 462 | |
bd5e766b LC |
463 | @node Requirements |
464 | @section Requirements | |
465 | ||
09722b11 LC |
466 | This section lists requirements when building Guix from source. The |
467 | build procedure for Guix is the same as for other GNU software, and is | |
468 | not covered here. Please see the files @file{README} and @file{INSTALL} | |
469 | in the Guix source tree for additional details. | |
470 | ||
bd5e766b LC |
471 | GNU Guix depends on the following packages: |
472 | ||
473 | @itemize | |
47c66da0 | 474 | @item @url{http://gnu.org/software/guile/, GNU Guile}, version 2.0.7 or later; |
288dca55 | 475 | @item @url{http://gnupg.org/, GNU libgcrypt}; |
f0b98b84 | 476 | @item @url{http://www.gnu.org/software/make/, GNU Make}. |
8a96bd4b ID |
477 | @end itemize |
478 | ||
479 | The following dependencies are optional: | |
480 | ||
481 | @itemize | |
288dca55 | 482 | @item |
8a96bd4b | 483 | Installing |
288dca55 | 484 | @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} will |
2f7d2d91 LC |
485 | allow you to use the @command{guix import pypi} command (@pxref{Invoking |
486 | guix import}). It is of | |
288dca55 | 487 | interest primarily for developers and not for casual users. |
8a96bd4b ID |
488 | @item |
489 | Installing @uref{http://gnutls.org/, GnuTLS-Guile} will | |
490 | allow you to access @code{https} URLs with the @command{guix download} | |
d45dc6da EB |
491 | command (@pxref{Invoking guix download}), the @command{guix import pypi} |
492 | command, and the @command{guix import cpan} command. This is primarily | |
493 | of interest to developers. @xref{Guile Preparations, how to install the | |
494 | GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}. | |
bd5e766b LC |
495 | @end itemize |
496 | ||
497 | Unless @code{--disable-daemon} was passed to @command{configure}, the | |
498 | following packages are also needed: | |
499 | ||
500 | @itemize | |
368d08f7 LC |
501 | @item @url{http://sqlite.org, SQLite 3}; |
502 | @item @url{http://www.bzip.org, libbz2}; | |
503 | @item @url{http://gcc.gnu.org, GCC's g++}, with support for the | |
504 | C++11 standard. | |
bd5e766b LC |
505 | @end itemize |
506 | ||
4bfc4ea3 NK |
507 | When a working installation of @url{http://nixos.org/nix/, the Nix package |
508 | manager} is available, you | |
bd5e766b | 509 | can instead configure Guix with @code{--disable-daemon}. In that case, |
4bfc4ea3 | 510 | Nix replaces the three dependencies above. |
bd5e766b | 511 | |
b22a12fd LC |
512 | Guix is compatible with Nix, so it is possible to share the same store |
513 | between both. To do so, you must pass @command{configure} not only the | |
514 | same @code{--with-store-dir} value, but also the same | |
4bfc4ea3 NK |
515 | @code{--localstatedir} value. The latter is essential because it |
516 | specifies where the database that stores metadata about the store is | |
834129e0 | 517 | located, among other things. The default values for Nix are |
b22a12fd | 518 | @code{--with-store-dir=/nix/store} and @code{--localstatedir=/nix/var}. |
4bfc4ea3 NK |
519 | Note that @code{--disable-daemon} is not required if |
520 | your goal is to share the store with Nix. | |
b22a12fd | 521 | |
ec0339cd LC |
522 | @node Running the Test Suite |
523 | @section Running the Test Suite | |
524 | ||
525 | After a successful @command{configure} and @code{make} run, it is a good | |
526 | idea to run the test suite. It can help catch issues with the setup or | |
527 | environment, or bugs in Guix itself---and really, reporting test | |
528 | failures is a good way to help improve the software. To run the test | |
529 | suite, type: | |
530 | ||
531 | @example | |
532 | make check | |
533 | @end example | |
534 | ||
535 | Test cases can run in parallel: you can use the @code{-j} option of | |
536 | GNU@tie{}make to speed things up. The first run may take a few minutes | |
537 | on a recent machine; subsequent runs will be faster because the store | |
538 | that is created for test purposes will already have various things in | |
539 | cache. | |
540 | ||
a887fd8d LC |
541 | It is also possible to run a subset of the tests by defining the |
542 | @code{TESTS} makefile variable as in this example: | |
543 | ||
544 | @example | |
545 | make check TESTS="tests/store.scm tests/cpio.scm" | |
546 | @end example | |
547 | ||
ec0339cd LC |
548 | Upon failure, please email @email{bug-guix@@gnu.org} and attach the |
549 | @file{test-suite.log} file. When @file{tests/@var{something}.scm} | |
550 | fails, please also attach the @file{@var{something}.log} file available | |
551 | in the top-level build directory. Please specify the Guix version being | |
552 | used as well as version numbers of the dependencies | |
553 | (@pxref{Requirements}) in your message. | |
554 | ||
bd5e766b LC |
555 | @node Setting Up the Daemon |
556 | @section Setting Up the Daemon | |
557 | ||
558 | @cindex daemon | |
559 | Operations such as building a package or running the garbage collector | |
49e6291a | 560 | are all performed by a specialized process, the @dfn{build daemon}, on |
bd5e766b LC |
561 | behalf of clients. Only the daemon may access the store and its |
562 | associated database. Thus, any operation that manipulates the store | |
563 | goes through the daemon. For instance, command-line tools such as | |
e49951eb | 564 | @command{guix package} and @command{guix build} communicate with the |
bd5e766b LC |
565 | daemon (@i{via} remote procedure calls) to instruct it what to do. |
566 | ||
49e6291a | 567 | The following sections explain how to prepare the build daemon's |
f97c9175 | 568 | environment. See also @ref{Substitutes}, for information on how to allow |
225dafde | 569 | the daemon to download pre-built binaries. |
49e6291a LC |
570 | |
571 | @menu | |
572 | * Build Environment Setup:: Preparing the isolated build environment. | |
573 | * Daemon Offload Setup:: Offloading builds to remote machines. | |
574 | @end menu | |
575 | ||
576 | @node Build Environment Setup | |
577 | @subsection Build Environment Setup | |
578 | ||
bd5e766b LC |
579 | In a standard multi-user setup, Guix and its daemon---the |
580 | @command{guix-daemon} program---are installed by the system | |
834129e0 | 581 | administrator; @file{/gnu/store} is owned by @code{root} and |
bd5e766b LC |
582 | @command{guix-daemon} runs as @code{root}. Unprivileged users may use |
583 | Guix tools to build packages or otherwise access the store, and the | |
584 | daemon will do it on their behalf, ensuring that the store is kept in a | |
585 | consistent state, and allowing built packages to be shared among users. | |
586 | ||
587 | @cindex build users | |
588 | When @command{guix-daemon} runs as @code{root}, you may not want package | |
589 | build processes themselves to run as @code{root} too, for obvious | |
590 | security reasons. To avoid that, a special pool of @dfn{build users} | |
591 | should be created for use by build processes started by the daemon. | |
592 | These build users need not have a shell and a home directory: they will | |
593 | just be used when the daemon drops @code{root} privileges in build | |
594 | processes. Having several such users allows the daemon to launch | |
595 | distinct build processes under separate UIDs, which guarantees that they | |
596 | do not interfere with each other---an essential feature since builds are | |
597 | regarded as pure functions (@pxref{Introduction}). | |
598 | ||
599 | On a GNU/Linux system, a build user pool may be created like this (using | |
600 | Bash syntax and the @code{shadow} commands): | |
601 | ||
091196b3 LC |
602 | @c See http://lists.gnu.org/archive/html/bug-guix/2013-01/msg00239.html |
603 | @c for why `-G' is needed. | |
bd5e766b | 604 | @example |
cfc149dc LC |
605 | # groupadd --system guixbuild |
606 | # for i in `seq -w 1 10`; | |
bd5e766b | 607 | do |
cfc149dc LC |
608 | useradd -g guixbuild -G guixbuild \ |
609 | -d /var/empty -s `which nologin` \ | |
610 | -c "Guix build user $i" --system \ | |
611 | guixbuilder$i; | |
bd5e766b LC |
612 | done |
613 | @end example | |
614 | ||
615 | @noindent | |
54eb03ab LC |
616 | The number of build users determines how many build jobs may run in |
617 | parallel, as specified by the @option{--max-jobs} option | |
d2825c96 LC |
618 | (@pxref{Invoking guix-daemon, @option{--max-jobs}}). The |
619 | @code{guix-daemon} program may then be run as @code{root} with the | |
620 | following command@footnote{If your machine uses the systemd init system, | |
621 | dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} | |
622 | file in @file{/etc/systemd/system} will ensure that | |
ad227484 MDRS |
623 | @command{guix-daemon} is automatically started. Similarly, if your |
624 | machine uses the Upstart init system, drop the | |
625 | @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} | |
626 | file in @file{/etc/init}.}: | |
bd5e766b LC |
627 | |
628 | @example | |
cfc149dc | 629 | # guix-daemon --build-users-group=guixbuild |
bd5e766b LC |
630 | @end example |
631 | ||
e900c503 | 632 | @cindex chroot |
b095792f LC |
633 | @noindent |
634 | This way, the daemon starts build processes in a chroot, under one of | |
cfc149dc | 635 | the @code{guixbuilder} users. On GNU/Linux, by default, the chroot |
6dc99317 LC |
636 | environment contains nothing but: |
637 | ||
638 | @c Keep this list in sync with libstore/build.cc! ----------------------- | |
639 | @itemize | |
640 | @item | |
4743a4da LC |
641 | a minimal @code{/dev} directory, created mostly independently from the |
642 | host @code{/dev}@footnote{``Mostly'', because while the set of files | |
643 | that appear in the chroot's @code{/dev} is fixed, most of these files | |
644 | can only be created if the host has them.}; | |
645 | ||
646 | @item | |
f97c9175 | 647 | the @code{/proc} directory; it only shows the processes of the container |
4743a4da | 648 | since a separate PID name space is used; |
6dc99317 LC |
649 | |
650 | @item | |
651 | @file{/etc/passwd} with an entry for the current user and an entry for | |
652 | user @file{nobody}; | |
653 | ||
654 | @item | |
655 | @file{/etc/group} with an entry for the user's group; | |
656 | ||
657 | @item | |
658 | @file{/etc/hosts} with an entry that maps @code{localhost} to | |
659 | @code{127.0.0.1}; | |
660 | ||
661 | @item | |
662 | a writable @file{/tmp} directory. | |
663 | @end itemize | |
b095792f | 664 | |
cb960102 ED |
665 | You can influence the directory where the daemon stores build trees |
666 | @i{via} the @code{TMPDIR} environment variable. However, the build tree | |
f97c9175 | 667 | within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, |
cb960102 ED |
668 | where @var{name} is the derivation name---e.g., @code{coreutils-8.24}. |
669 | This way, the value of @code{TMPDIR} does not leak inside build | |
670 | environments, which avoids discrepancies in cases where build processes | |
671 | capture the name of their build tree. | |
672 | ||
e0c941fe LC |
673 | @vindex http_proxy |
674 | The daemon also honors the @code{http_proxy} environment variable for | |
675 | HTTP downloads it performs, be it for fixed-output derivations | |
676 | (@pxref{Derivations}) or for substitutes (@pxref{Substitutes}). | |
677 | ||
1e2644bb LC |
678 | If you are installing Guix as an unprivileged user, it is still possible |
679 | to run @command{guix-daemon} provided you pass @code{--disable-chroot}. | |
680 | However, build processes will not be isolated from one another, and not | |
681 | from the rest of the system. Thus, build processes may interfere with | |
682 | each other, and may access programs, libraries, and other files | |
683 | available on the system---making it much harder to view them as | |
684 | @emph{pure} functions. | |
bd5e766b | 685 | |
49e6291a LC |
686 | |
687 | @node Daemon Offload Setup | |
688 | @subsection Using the Offload Facility | |
689 | ||
690 | @cindex offloading | |
4ec2e92d LC |
691 | @cindex build hook |
692 | When desired, the build daemon can @dfn{offload} | |
693 | derivation builds to other machines | |
49e6291a LC |
694 | running Guix, using the @code{offload} @dfn{build hook}. When that |
695 | feature is enabled, a list of user-specified build machines is read from | |
f97c9175 | 696 | @file{/etc/guix/machines.scm}; every time a build is requested, for |
49e6291a | 697 | instance via @code{guix build}, the daemon attempts to offload it to one |
f97c9175 | 698 | of the machines that satisfy the constraints of the derivation, in |
49e6291a LC |
699 | particular its system type---e.g., @file{x86_64-linux}. Missing |
700 | prerequisites for the build are copied over SSH to the target machine, | |
701 | which then proceeds with the build; upon success the output(s) of the | |
702 | build are copied back to the initial machine. | |
703 | ||
4ec2e92d | 704 | The @file{/etc/guix/machines.scm} file typically looks like this: |
49e6291a LC |
705 | |
706 | @example | |
707 | (list (build-machine | |
708 | (name "eightysix.example.org") | |
709 | (system "x86_64-linux") | |
710 | (user "bob") | |
711 | (speed 2.)) ; incredibly fast! | |
712 | ||
713 | (build-machine | |
714 | (name "meeps.example.org") | |
715 | (system "mips64el-linux") | |
716 | (user "alice") | |
717 | (private-key | |
718 | (string-append (getenv "HOME") | |
c4fdfd6f | 719 | "/.lsh/identity-for-guix")))) |
49e6291a LC |
720 | @end example |
721 | ||
722 | @noindent | |
723 | In the example above we specify a list of two build machines, one for | |
724 | the @code{x86_64} architecture and one for the @code{mips64el} | |
4ec2e92d LC |
725 | architecture. |
726 | ||
727 | In fact, this file is---not surprisingly!---a Scheme file that is | |
728 | evaluated when the @code{offload} hook is started. Its return value | |
729 | must be a list of @code{build-machine} objects. While this example | |
730 | shows a fixed list of build machines, one could imagine, say, using | |
731 | DNS-SD to return a list of potential build machines discovered in the | |
732 | local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using | |
c678a4ee LC |
733 | Avahi in Guile Scheme Programs}). The @code{build-machine} data type is |
734 | detailed below. | |
4ec2e92d | 735 | |
c678a4ee | 736 | @deftp {Data Type} build-machine |
f97c9175 AE |
737 | This data type represents build machines to which the daemon may offload |
738 | builds. The important fields are: | |
49e6291a LC |
739 | |
740 | @table @code | |
741 | ||
742 | @item name | |
f97c9175 | 743 | The host name of the remote machine. |
49e6291a LC |
744 | |
745 | @item system | |
f97c9175 | 746 | The system type of the remote machine---e.g., @code{"x86_64-linux"}. |
49e6291a LC |
747 | |
748 | @item user | |
749 | The user account to use when connecting to the remote machine over SSH. | |
750 | Note that the SSH key pair must @emph{not} be passphrase-protected, to | |
751 | allow non-interactive logins. | |
752 | ||
753 | @end table | |
754 | ||
4ec2e92d | 755 | A number of optional fields may be specified: |
49e6291a LC |
756 | |
757 | @table @code | |
758 | ||
cecd72d5 | 759 | @item port |
f97c9175 | 760 | Port number of SSH server on the machine (default: 22). |
cecd72d5 | 761 | |
49e6291a LC |
762 | @item private-key |
763 | The SSH private key file to use when connecting to the machine. | |
764 | ||
c4fdfd6f LC |
765 | Currently offloading uses GNU@tie{}lsh as its SSH client |
766 | (@pxref{Invoking lsh,,, GNU lsh Manual}). Thus, the key file here must | |
767 | be an lsh key file. This may change in the future, though. | |
768 | ||
49e6291a LC |
769 | @item parallel-builds |
770 | The number of builds that may run in parallel on the machine (1 by | |
771 | default.) | |
772 | ||
773 | @item speed | |
774 | A ``relative speed factor''. The offload scheduler will tend to prefer | |
775 | machines with a higher speed factor. | |
776 | ||
777 | @item features | |
778 | A list of strings denoting specific features supported by the machine. | |
779 | An example is @code{"kvm"} for machines that have the KVM Linux modules | |
780 | and corresponding hardware support. Derivations can request features by | |
781 | name, and they will be scheduled on matching build machines. | |
782 | ||
783 | @end table | |
c678a4ee | 784 | @end deftp |
49e6291a LC |
785 | |
786 | The @code{guix} command must be in the search path on the build | |
787 | machines, since offloading works by invoking the @code{guix archive} and | |
c4fdfd6f LC |
788 | @code{guix build} commands. In addition, the Guix modules must be in |
789 | @code{$GUILE_LOAD_PATH} on the build machine---you can check whether | |
790 | this is the case by running: | |
791 | ||
792 | @example | |
74273b6f | 793 | lsh build-machine guile -c "'(use-modules (guix config))'" |
c4fdfd6f | 794 | @end example |
49e6291a | 795 | |
f97c9175 | 796 | There is one last thing to do once @file{machines.scm} is in place. As |
49e6291a | 797 | explained above, when offloading, files are transferred back and forth |
c4fdfd6f LC |
798 | between the machine stores. For this to work, you first need to |
799 | generate a key pair on each machine to allow the daemon to export signed | |
800 | archives of files from the store (@pxref{Invoking guix archive}): | |
49e6291a LC |
801 | |
802 | @example | |
803 | # guix archive --generate-key | |
804 | @end example | |
805 | ||
806 | @noindent | |
c4fdfd6f LC |
807 | Each build machine must authorize the key of the master machine so that |
808 | it accepts store items it receives from the master: | |
809 | ||
810 | @example | |
811 | # guix archive --authorize < master-public-key.txt | |
812 | @end example | |
813 | ||
814 | @noindent | |
815 | Likewise, the master machine must authorize the key of each build machine. | |
816 | ||
817 | All the fuss with keys is here to express pairwise mutual trust | |
818 | relations between the master and the build machines. Concretely, when | |
819 | the master receives files from a build machine (and @i{vice versa}), its | |
820 | build daemon can make sure they are genuine, have not been tampered | |
821 | with, and that they are signed by an authorized key. | |
49e6291a LC |
822 | |
823 | ||
bd5e766b LC |
824 | @node Invoking guix-daemon |
825 | @section Invoking @command{guix-daemon} | |
826 | ||
827 | The @command{guix-daemon} program implements all the functionality to | |
828 | access the store. This includes launching build processes, running the | |
829 | garbage collector, querying the availability of a build result, etc. It | |
830 | is normally run as @code{root} like this: | |
831 | ||
832 | @example | |
cfc149dc | 833 | # guix-daemon --build-users-group=guixbuild |
bd5e766b LC |
834 | @end example |
835 | ||
836 | @noindent | |
081145cf | 837 | For details on how to set it up, @pxref{Setting Up the Daemon}. |
bd5e766b | 838 | |
e900c503 LC |
839 | @cindex chroot |
840 | @cindex container, build environment | |
841 | @cindex build environment | |
842 | @cindex reproducible builds | |
bd5e766b LC |
843 | By default, @command{guix-daemon} launches build processes under |
844 | different UIDs, taken from the build group specified with | |
845 | @code{--build-users-group}. In addition, each build process is run in a | |
846 | chroot environment that only contains the subset of the store that the | |
847 | build process depends on, as specified by its derivation | |
848 | (@pxref{Programming Interface, derivation}), plus a set of specific | |
849 | system directories. By default, the latter contains @file{/dev} and | |
e900c503 LC |
850 | @file{/dev/pts}. Furthermore, on GNU/Linux, the build environment is a |
851 | @dfn{container}: in addition to having its own file system tree, it has | |
852 | a separate mount name space, its own PID name space, network name space, | |
853 | etc. This helps achieve reproducible builds (@pxref{Features}). | |
bd5e766b | 854 | |
cbc538fe LC |
855 | When the daemon performs a build on behalf of the user, it creates a |
856 | build directory under @file{/tmp} or under the directory specified by | |
857 | its @code{TMPDIR} environment variable; this directory is shared with | |
858 | the container for the duration of the build. Be aware that using a | |
859 | directory other than @file{/tmp} can affect build results---for example, | |
860 | with a longer directory name, a build process that uses Unix-domain | |
861 | sockets might hit the name length limitation for @code{sun_path}, which | |
862 | it would otherwise not hit. | |
863 | ||
864 | The build directory is automatically deleted upon completion, unless the | |
865 | build failed and the client specified @option{--keep-failed} | |
866 | (@pxref{Invoking guix build, @option{--keep-failed}}). | |
867 | ||
bd5e766b LC |
868 | The following command-line options are supported: |
869 | ||
870 | @table @code | |
871 | @item --build-users-group=@var{group} | |
872 | Take users from @var{group} to run build processes (@pxref{Setting Up | |
873 | the Daemon, build users}). | |
874 | ||
6858f9d1 | 875 | @item --no-substitutes |
b5385b52 | 876 | @cindex substitutes |
6858f9d1 | 877 | Do not use substitutes for build products. That is, always build things |
c4202d60 LC |
878 | locally instead of allowing downloads of pre-built binaries |
879 | (@pxref{Substitutes}). | |
6858f9d1 | 880 | |
b5385b52 LC |
881 | By default substitutes are used, unless the client---such as the |
882 | @command{guix package} command---is explicitly invoked with | |
883 | @code{--no-substitutes}. | |
884 | ||
885 | When the daemon runs with @code{--no-substitutes}, clients can still | |
886 | explicitly enable substitution @i{via} the @code{set-build-options} | |
887 | remote procedure call (@pxref{The Store}). | |
888 | ||
9176607e | 889 | @item --substitute-urls=@var{urls} |
f8a8e0fe | 890 | @anchor{daemon-substitute-urls} |
9176607e | 891 | Consider @var{urls} the default whitespace-separated list of substitute |
ae806096 | 892 | source URLs. When this option is omitted, @indicateurl{http://hydra.gnu.org} |
9176607e LC |
893 | is used. |
894 | ||
895 | This means that substitutes may be downloaded from @var{urls}, as long | |
896 | as they are signed by a trusted signature (@pxref{Substitutes}). | |
897 | ||
4ec2e92d LC |
898 | @cindex build hook |
899 | @item --no-build-hook | |
900 | Do not use the @dfn{build hook}. | |
901 | ||
902 | The build hook is a helper program that the daemon can start and to | |
903 | which it submits build requests. This mechanism is used to offload | |
904 | builds to other machines (@pxref{Daemon Offload Setup}). | |
905 | ||
bd5e766b LC |
906 | @item --cache-failures |
907 | Cache build failures. By default, only successful builds are cached. | |
908 | ||
30d9aa54 LC |
909 | When this option is used, @command{guix gc --list-failures} can be used |
910 | to query the set of store items marked as failed; @command{guix gc | |
911 | --clear-failures} removes store items from the set of cached failures. | |
912 | @xref{Invoking guix gc}. | |
913 | ||
bd5e766b LC |
914 | @item --cores=@var{n} |
915 | @itemx -c @var{n} | |
916 | Use @var{n} CPU cores to build each derivation; @code{0} means as many | |
917 | as available. | |
918 | ||
6efc160e | 919 | The default value is @code{0}, but it may be overridden by clients, such |
e49951eb MW |
920 | as the @code{--cores} option of @command{guix build} (@pxref{Invoking |
921 | guix build}). | |
bd5e766b LC |
922 | |
923 | The effect is to define the @code{NIX_BUILD_CORES} environment variable | |
924 | in the build process, which can then use it to exploit internal | |
925 | parallelism---for instance, by running @code{make -j$NIX_BUILD_CORES}. | |
926 | ||
927 | @item --max-jobs=@var{n} | |
928 | @itemx -M @var{n} | |
929 | Allow at most @var{n} build jobs in parallel. The default value is | |
f6526eb3 LC |
930 | @code{1}. Setting it to @code{0} means that no builds will be performed |
931 | locally; instead, the daemon will offload builds (@pxref{Daemon Offload | |
932 | Setup}), or simply fail. | |
bd5e766b | 933 | |
ecf84b7c LC |
934 | @item --rounds=@var{N} |
935 | Build each derivation @var{n} times in a row, and raise an error if | |
936 | consecutive build results are not bit-for-bit identical. Note that this | |
937 | setting can be overridden by clients such as @command{guix build} | |
938 | (@pxref{Invoking guix build}). | |
939 | ||
bd5e766b LC |
940 | @item --debug |
941 | Produce debugging output. | |
942 | ||
943 | This is useful to debug daemon start-up issues, but then it may be | |
944 | overridden by clients, for example the @code{--verbosity} option of | |
e49951eb | 945 | @command{guix build} (@pxref{Invoking guix build}). |
bd5e766b LC |
946 | |
947 | @item --chroot-directory=@var{dir} | |
948 | Add @var{dir} to the build chroot. | |
949 | ||
950 | Doing this may change the result of build processes---for instance if | |
951 | they use optional dependencies found in @var{dir} when it is available, | |
952 | and not otherwise. For that reason, it is not recommended to do so. | |
953 | Instead, make sure that each derivation declares all the inputs that it | |
954 | needs. | |
955 | ||
956 | @item --disable-chroot | |
957 | Disable chroot builds. | |
958 | ||
959 | Using this option is not recommended since, again, it would allow build | |
1e2644bb LC |
960 | processes to gain access to undeclared dependencies. It is necessary, |
961 | though, when @command{guix-daemon} is running under an unprivileged user | |
962 | account. | |
bd5e766b LC |
963 | |
964 | @item --disable-log-compression | |
965 | Disable compression of the build logs. | |
966 | ||
1da983b9 LC |
967 | Unless @code{--lose-logs} is used, all the build logs are kept in the |
968 | @var{localstatedir}. To save space, the daemon automatically compresses | |
969 | them with bzip2 by default. This option disables that. | |
970 | ||
ab3893d7 LC |
971 | @item --disable-deduplication |
972 | @cindex deduplication | |
bd5e766b LC |
973 | Disable automatic file ``deduplication'' in the store. |
974 | ||
1da983b9 | 975 | By default, files added to the store are automatically ``deduplicated'': |
ab3893d7 LC |
976 | if a newly added file is identical to another one found in the store, |
977 | the daemon makes the new file a hard link to the other file. This can | |
4988dd40 | 978 | noticeably reduce disk usage, at the expense of slightly increased |
ab3893d7 LC |
979 | input/output load at the end of a build process. This option disables |
980 | this optimization. | |
1da983b9 | 981 | |
6e37066e LC |
982 | @item --gc-keep-outputs[=yes|no] |
983 | Tell whether the garbage collector (GC) must keep outputs of live | |
984 | derivations. | |
985 | ||
986 | When set to ``yes'', the GC will keep the outputs of any live derivation | |
987 | available in the store---the @code{.drv} files. The default is ``no'', | |
988 | meaning that derivation outputs are kept only if they are GC roots. | |
989 | ||
990 | @item --gc-keep-derivations[=yes|no] | |
991 | Tell whether the garbage collector (GC) must keep derivations | |
992 | corresponding to live outputs. | |
993 | ||
994 | When set to ``yes'', as is the case by default, the GC keeps | |
995 | derivations---i.e., @code{.drv} files---as long as at least one of their | |
996 | outputs is live. This allows users to keep track of the origins of | |
997 | items in their store. Setting it to ``no'' saves a bit of disk space. | |
998 | ||
999 | Note that when both @code{--gc-keep-derivations} and | |
1000 | @code{--gc-keep-outputs} are used, the effect is to keep all the build | |
1001 | prerequisites (the sources, compiler, libraries, and other build-time | |
1002 | tools) of live objects in the store, regardless of whether these | |
1003 | prerequisites are live. This is convenient for developers since it | |
1004 | saves rebuilds or downloads. | |
1005 | ||
bd5e766b LC |
1006 | @item --impersonate-linux-2.6 |
1007 | On Linux-based systems, impersonate Linux 2.6. This means that the | |
1008 | kernel's @code{uname} system call will report 2.6 as the release number. | |
1009 | ||
1010 | This might be helpful to build programs that (usually wrongfully) depend | |
1011 | on the kernel version number. | |
1012 | ||
1013 | @item --lose-logs | |
1014 | Do not keep build logs. By default they are kept under | |
ce33631f | 1015 | @code{@var{localstatedir}/guix/log}. |
bd5e766b LC |
1016 | |
1017 | @item --system=@var{system} | |
1018 | Assume @var{system} as the current system type. By default it is the | |
1019 | architecture/kernel pair found at configure time, such as | |
1020 | @code{x86_64-linux}. | |
b8d2aa26 LC |
1021 | |
1022 | @item --listen=@var{socket} | |
1023 | Listen for connections on @var{socket}, the file name of a Unix-domain | |
1024 | socket. The default socket is | |
1025 | @file{@var{localstatedir}/daemon-socket/socket}. This option is only | |
1026 | useful in exceptional circumstances, such as if you need to run several | |
1027 | daemons on the same machine. | |
bd5e766b LC |
1028 | @end table |
1029 | ||
1030 | ||
0e2d0213 LC |
1031 | @node Application Setup |
1032 | @section Application Setup | |
1033 | ||
85e57214 LC |
1034 | When using Guix on top of GNU/Linux distribution other than GuixSD---a |
1035 | so-called @dfn{foreign distro}---a few additional steps are needed to | |
1036 | get everything in place. Here are some of them. | |
0e2d0213 LC |
1037 | |
1038 | @subsection Locales | |
1039 | ||
5c3c1427 | 1040 | @anchor{locales-and-locpath} |
0e2d0213 | 1041 | @cindex locales, when not on GuixSD |
5c3c1427 | 1042 | @vindex LOCPATH |
85e57214 | 1043 | @vindex GUIX_LOCPATH |
f97c9175 AE |
1044 | Packages installed @i{via} Guix will not use the locale data of the |
1045 | host system. Instead, you must first install one of the locale packages | |
85e57214 LC |
1046 | available with Guix and then define the @code{GUIX_LOCPATH} environment |
1047 | variable: | |
0e2d0213 LC |
1048 | |
1049 | @example | |
1050 | $ guix package -i glibc-locales | |
85e57214 | 1051 | $ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale |
0e2d0213 LC |
1052 | @end example |
1053 | ||
1054 | Note that the @code{glibc-locales} package contains data for all the | |
1055 | locales supported by the GNU@tie{}libc and weighs in at around | |
f97c9175 | 1056 | 110@tie{}MiB. Alternatively, the @code{glibc-utf8-locales} is smaller but |
0e2d0213 LC |
1057 | limited to a few UTF-8 locales. |
1058 | ||
85e57214 LC |
1059 | The @code{GUIX_LOCPATH} variable plays a role similar to @code{LOCPATH} |
1060 | (@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C Library Reference | |
1061 | Manual}). There are two important differences though: | |
1062 | ||
1063 | @enumerate | |
1064 | @item | |
f97c9175 | 1065 | @code{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc |
85e57214 | 1066 | provided by foreign distros. Thus, using @code{GUIX_LOCPATH} allows you |
f97c9175 | 1067 | to make sure the programs of the foreign distro will not end up loading |
85e57214 LC |
1068 | incompatible locale data. |
1069 | ||
1070 | @item | |
1071 | libc suffixes each entry of @code{GUIX_LOCPATH} with @code{/X.Y}, where | |
1072 | @code{X.Y} is the libc version---e.g., @code{2.22}. This means that, | |
1073 | should your Guix profile contain a mixture of programs linked against | |
1074 | different libc version, each libc version will only try to load locale | |
1075 | data in the right format. | |
1076 | @end enumerate | |
1077 | ||
1078 | This is important because the locale data format used by different libc | |
1079 | versions may be incompatible. | |
1080 | ||
0e2d0213 LC |
1081 | @subsection X11 Fonts |
1082 | ||
4988dd40 | 1083 | The majority of graphical applications use Fontconfig to locate and |
f97c9175 AE |
1084 | load fonts and perform X11-client-side rendering. The @code{fontconfig} |
1085 | package in Guix looks for fonts in @file{$HOME/.guix-profile} | |
0e2d0213 | 1086 | by default. Thus, to allow graphical applications installed with Guix |
f97c9175 | 1087 | to display fonts, you have to install fonts with Guix as well. |
0e2d0213 | 1088 | Essential font packages include @code{gs-fonts}, @code{font-dejavu}, and |
8fe5b1d1 | 1089 | @code{font-gnu-freefont-ttf}. |
0e2d0213 | 1090 | |
5c36edc8 LC |
1091 | To display text written in Chinese languages, Japanese, or Korean in |
1092 | graphical applications, consider installing | |
1093 | @code{font-adobe-source-han-sans} or @code{font-wqy-zenhei}. The former | |
1094 | has multiple outputs, one per language family (@pxref{Packages with | |
1095 | Multiple Outputs}). For instance, the following command installs fonts | |
1096 | for Chinese languages: | |
1097 | ||
1098 | @example | |
1099 | guix package -i font-adobe-source-han-sans:cn | |
1100 | @end example | |
1101 | ||
6d97319c AK |
1102 | @subsection Emacs Packages |
1103 | ||
1104 | When you install Emacs packages with Guix, the elisp files may be placed | |
1105 | either in @file{$HOME/.guix-profile/share/emacs/site-lisp/} or in | |
1106 | sub-directories of | |
1107 | @file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/}. The latter | |
1108 | directory exists because potentially there may exist thousands of Emacs | |
1109 | packages and storing all their files in a single directory may be not | |
1110 | reliable (because of name conflicts). So we think using a separate | |
1111 | directory for each package is a good idea. It is very similar to how | |
1112 | the Emacs package system organizes the file structure (@pxref{Package | |
1113 | Files,,, emacs, The GNU Emacs Manual}). | |
1114 | ||
1115 | By default, Emacs (installed with Guix) ``knows'' where these packages | |
f97c9175 | 1116 | are placed, so you do not need to perform any configuration. If, for |
6d97319c | 1117 | some reason, you want to avoid auto-loading Emacs packages installed |
f97c9175 | 1118 | with Guix, you can do so by running Emacs with @code{--no-site-file} |
6d97319c AK |
1119 | option (@pxref{Init File,,, emacs, The GNU Emacs Manual}). |
1120 | ||
0e2d0213 LC |
1121 | @c TODO What else? |
1122 | ||
eeaf4427 LC |
1123 | @c ********************************************************************* |
1124 | @node Package Management | |
1125 | @chapter Package Management | |
1126 | ||
f8348b91 | 1127 | The purpose of GNU Guix is to allow users to easily install, upgrade, and |
eeaf4427 | 1128 | remove software packages, without having to know about their build |
f97c9175 | 1129 | procedures or dependencies. Guix also goes beyond this obvious set of |
eeaf4427 LC |
1130 | features. |
1131 | ||
1132 | This chapter describes the main features of Guix, as well as the package | |
c1941588 | 1133 | management tools it provides. Two user interfaces are provided for |
c554de89 AK |
1134 | routine package management tasks: A command-line interface described below |
1135 | (@pxref{Invoking guix package, @code{guix package}}), as well as a visual user | |
1136 | interface in Emacs described in a subsequent chapter (@pxref{Emacs Interface}). | |
eeaf4427 LC |
1137 | |
1138 | @menu | |
1139 | * Features:: How Guix will make your life brighter. | |
e49951eb | 1140 | * Invoking guix package:: Package installation, removal, etc. |
c4202d60 | 1141 | * Substitutes:: Downloading pre-built binaries. |
760c60d6 | 1142 | * Packages with Multiple Outputs:: Single source package, multiple outputs. |
e49951eb | 1143 | * Invoking guix gc:: Running the garbage collector. |
f651b477 | 1144 | * Invoking guix pull:: Fetching the latest Guix and distribution. |
760c60d6 | 1145 | * Invoking guix archive:: Exporting and importing store files. |
eeaf4427 LC |
1146 | @end menu |
1147 | ||
1148 | @node Features | |
1149 | @section Features | |
1150 | ||
1151 | When using Guix, each package ends up in the @dfn{package store}, in its | |
1152 | own directory---something that resembles | |
9a130e19 AK |
1153 | @file{/gnu/store/xxx-package-1.2}, where @code{xxx} is a base32 string |
1154 | (note that Guix comes with an Emacs extension to shorten those file | |
081145cf | 1155 | names, @pxref{Emacs Prettify}.) |
eeaf4427 LC |
1156 | |
1157 | Instead of referring to these directories, users have their own | |
1158 | @dfn{profile}, which points to the packages that they actually want to | |
821b0015 LC |
1159 | use. These profiles are stored within each user's home directory, at |
1160 | @code{$HOME/.guix-profile}. | |
eeaf4427 | 1161 | |
821b0015 | 1162 | For example, @code{alice} installs GCC 4.7.2. As a result, |
eeaf4427 | 1163 | @file{/home/alice/.guix-profile/bin/gcc} points to |
834129e0 | 1164 | @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Now, on the same machine, |
821b0015 LC |
1165 | @code{bob} had already installed GCC 4.8.0. The profile of @code{bob} |
1166 | simply continues to point to | |
834129e0 | 1167 | @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC |
821b0015 | 1168 | coexist on the same system without any interference. |
eeaf4427 | 1169 | |
e49951eb | 1170 | The @command{guix package} command is the central tool to manage |
f97c9175 | 1171 | packages (@pxref{Invoking guix package}). It operates on the per-user |
821b0015 | 1172 | profiles, and can be used @emph{with normal user privileges}. |
eeaf4427 LC |
1173 | |
1174 | The command provides the obvious install, remove, and upgrade | |
1175 | operations. Each invocation is actually a @emph{transaction}: either | |
ba55b1cb | 1176 | the specified operation succeeds, or nothing happens. Thus, if the |
e49951eb | 1177 | @command{guix package} process is terminated during the transaction, |
eeaf4427 LC |
1178 | or if a power outage occurs during the transaction, then the user's |
1179 | profile remains in its previous state, and remains usable. | |
1180 | ||
1181 | In addition, any package transaction may be @emph{rolled back}. So, if, | |
1182 | for example, an upgrade installs a new version of a package that turns | |
1183 | out to have a serious bug, users may roll back to the previous instance | |
4af2447e LC |
1184 | of their profile, which was known to work well. Similarly, the global |
1185 | system configuration is subject to transactional upgrades and roll-back | |
1186 | (@pxref{Using the Configuration System}). | |
eeaf4427 | 1187 | |
f97c9175 AE |
1188 | All packages in the package store may be @emph{garbage-collected}. |
1189 | Guix can determine which packages are still referenced by user | |
fe8ff028 | 1190 | profiles, and remove those that are provably no longer referenced |
e49951eb | 1191 | (@pxref{Invoking guix gc}). Users may also explicitly remove old |
fe8ff028 LC |
1192 | generations of their profile so that the packages they refer to can be |
1193 | collected. | |
eeaf4427 | 1194 | |
e900c503 LC |
1195 | @cindex reproducibility |
1196 | @cindex reproducible builds | |
eeaf4427 LC |
1197 | Finally, Guix takes a @dfn{purely functional} approach to package |
1198 | management, as described in the introduction (@pxref{Introduction}). | |
834129e0 | 1199 | Each @file{/gnu/store} package directory name contains a hash of all the |
eeaf4427 LC |
1200 | inputs that were used to build that package---compiler, libraries, build |
1201 | scripts, etc. This direct correspondence allows users to make sure a | |
1202 | given package installation matches the current state of their | |
e900c503 LC |
1203 | distribution. It also helps maximize @dfn{build reproducibility}: |
1204 | thanks to the isolated build environments that are used, a given build | |
1205 | is likely to yield bit-identical files when performed on different | |
1206 | machines (@pxref{Invoking guix-daemon, container}). | |
eeaf4427 | 1207 | |
c4202d60 | 1208 | @cindex substitutes |
eeaf4427 | 1209 | This foundation allows Guix to support @dfn{transparent binary/source |
c4202d60 | 1210 | deployment}. When a pre-built binary for a @file{/gnu/store} item is |
18f2887b | 1211 | available from an external source---a @dfn{substitute}, Guix just |
c4202d60 LC |
1212 | downloads it and unpacks it; |
1213 | otherwise, it builds the package from source, locally | |
1214 | (@pxref{Substitutes}). | |
eeaf4427 | 1215 | |
f5fd4fd2 LC |
1216 | Control over the build environment is a feature that is also useful for |
1217 | developers. The @command{guix environment} command allows developers of | |
1218 | a package to quickly set up the right development environment for their | |
f97c9175 AE |
1219 | package, without having to manually install the dependencies of the |
1220 | package into their profile (@pxref{Invoking guix environment}). | |
f5fd4fd2 | 1221 | |
e49951eb MW |
1222 | @node Invoking guix package |
1223 | @section Invoking @command{guix package} | |
eeaf4427 | 1224 | |
e49951eb | 1225 | The @command{guix package} command is the tool that allows users to |
eeaf4427 LC |
1226 | install, upgrade, and remove packages, as well as rolling back to |
1227 | previous configurations. It operates only on the user's own profile, | |
1228 | and works with normal user privileges (@pxref{Features}). Its syntax | |
1229 | is: | |
1230 | ||
1231 | @example | |
e49951eb | 1232 | guix package @var{options} |
eeaf4427 LC |
1233 | @end example |
1234 | ||
ba55b1cb | 1235 | Primarily, @var{options} specifies the operations to be performed during |
eeaf4427 | 1236 | the transaction. Upon completion, a new profile is created, but |
99bd74d5 | 1237 | previous @dfn{generations} of the profile remain available, should the user |
eeaf4427 LC |
1238 | want to roll back. |
1239 | ||
6447738c MW |
1240 | For example, to remove @code{lua} and install @code{guile} and |
1241 | @code{guile-cairo} in a single transaction: | |
1242 | ||
1243 | @example | |
1244 | guix package -r lua -i guile guile-cairo | |
1245 | @end example | |
1246 | ||
99bd74d5 LC |
1247 | @command{guix package} also supports a @dfn{declarative approach} |
1248 | whereby the user specifies the exact set of packages to be available and | |
1249 | passes it @i{via} the @option{--manifest} option | |
1250 | (@pxref{profile-manifest, @option{--manifest}}). | |
1251 | ||
b9e5c0a9 | 1252 | For each user, a symlink to the user's default profile is automatically |
0ec1af59 | 1253 | created in @file{$HOME/.guix-profile}. This symlink always points to the |
b9e5c0a9 LC |
1254 | current generation of the user's default profile. Thus, users can add |
1255 | @file{$HOME/.guix-profile/bin} to their @code{PATH} environment | |
1256 | variable, and so on. | |
d664f1b4 LC |
1257 | @cindex search paths |
1258 | If you are not using the Guix System Distribution, consider adding the | |
1259 | following lines to your @file{~/.bash_profile} (@pxref{Bash Startup | |
1260 | Files,,, bash, The GNU Bash Reference Manual}) so that newly-spawned | |
1261 | shells get all the right environment variable definitions: | |
1262 | ||
1263 | @example | |
1264 | GUIX_PROFILE="$HOME/.guix-profile" \ | |
1265 | source "$HOME/.guix-profile/etc/profile" | |
1266 | @end example | |
b9e5c0a9 | 1267 | |
4379c35b LC |
1268 | In a multi-user setup, user profiles are stored in a place registered as |
1269 | a @dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points | |
1270 | to (@pxref{Invoking guix gc}). That directory is normally | |
0ec1af59 LC |
1271 | @code{@var{localstatedir}/profiles/per-user/@var{user}}, where |
1272 | @var{localstatedir} is the value passed to @code{configure} as | |
4379c35b LC |
1273 | @code{--localstatedir}, and @var{user} is the user name. The |
1274 | @file{per-user} directory is created when @command{guix-daemon} is | |
1275 | started, and the @var{user} sub-directory is created by @command{guix | |
1276 | package}. | |
0ec1af59 LC |
1277 | |
1278 | The @var{options} can be among the following: | |
1279 | ||
eeaf4427 LC |
1280 | @table @code |
1281 | ||
6447738c MW |
1282 | @item --install=@var{package} @dots{} |
1283 | @itemx -i @var{package} @dots{} | |
1284 | Install the specified @var{package}s. | |
eeaf4427 | 1285 | |
6447738c | 1286 | Each @var{package} may specify either a simple package name, such as |
eeaf4427 | 1287 | @code{guile}, or a package name followed by a hyphen and version number, |
724311a2 LC |
1288 | such as @code{guile-1.8.8} or simply @code{guile-1.8} (in the latter |
1289 | case, the newest version prefixed by @code{1.8} is selected.) | |
1290 | ||
1291 | If no version number is specified, the | |
dc5669cd MW |
1292 | newest available version will be selected. In addition, @var{package} |
1293 | may contain a colon, followed by the name of one of the outputs of the | |
6e721c4d | 1294 | package, as in @code{gcc:doc} or @code{binutils-2.22:lib} |
e7f34eb0 LC |
1295 | (@pxref{Packages with Multiple Outputs}). Packages with a corresponding |
1296 | name (and optionally version) are searched for among the GNU | |
1297 | distribution modules (@pxref{Package Modules}). | |
eeaf4427 | 1298 | |
461572cc LC |
1299 | @cindex propagated inputs |
1300 | Sometimes packages have @dfn{propagated inputs}: these are dependencies | |
21461f27 LC |
1301 | that automatically get installed along with the required package |
1302 | (@pxref{package-propagated-inputs, @code{propagated-inputs} in | |
1303 | @code{package} objects}, for information about propagated inputs in | |
1304 | package definitions). | |
461572cc | 1305 | |
21461f27 | 1306 | @anchor{package-cmd-propagated-inputs} |
461572cc LC |
1307 | An example is the GNU MPC library: its C header files refer to those of |
1308 | the GNU MPFR library, which in turn refer to those of the GMP library. | |
1309 | Thus, when installing MPC, the MPFR and GMP libraries also get installed | |
1310 | in the profile; removing MPC also removes MPFR and GMP---unless they had | |
f97c9175 | 1311 | also been explicitly installed by the user. |
461572cc | 1312 | |
ba7ea5ce | 1313 | Besides, packages sometimes rely on the definition of environment |
5924080d | 1314 | variables for their search paths (see explanation of |
ba7ea5ce | 1315 | @code{--search-paths} below). Any missing or possibly incorrect |
5924080d LC |
1316 | environment variable definitions are reported here. |
1317 | ||
ef010c0f | 1318 | @c XXX: keep me up-to-date |
5924080d | 1319 | Finally, when installing a GNU package, the tool reports the |
ef010c0f LC |
1320 | availability of a newer upstream version. In the future, it may provide |
1321 | the option of installing directly from the upstream version, even if | |
1322 | that version is not yet in the distribution. | |
1323 | ||
5d4b411f LC |
1324 | @item --install-from-expression=@var{exp} |
1325 | @itemx -e @var{exp} | |
1326 | Install the package @var{exp} evaluates to. | |
1327 | ||
1328 | @var{exp} must be a Scheme expression that evaluates to a | |
1329 | @code{<package>} object. This option is notably useful to disambiguate | |
1330 | between same-named variants of a package, with expressions such as | |
1331 | @code{(@@ (gnu packages base) guile-final)}. | |
1332 | ||
1333 | Note that this option installs the first output of the specified | |
1334 | package, which may be insufficient when needing a specific output of a | |
1335 | multiple-output package. | |
1336 | ||
0d279400 DT |
1337 | @item --install-from-file=@var{file} |
1338 | @itemx -f @var{file} | |
1339 | Install the package that the code within @var{file} evaluates to. | |
1340 | ||
1341 | As an example, @var{file} might contain a definition like this | |
1342 | (@pxref{Defining Packages}): | |
1343 | ||
1344 | @example | |
1345 | @verbatiminclude package-hello.scm | |
1346 | @end example | |
1347 | ||
1348 | Developers may find it useful to include such a @file{package.scm} file | |
f97c9175 | 1349 | in the root of their project source tree that can be used to test |
0d279400 DT |
1350 | development snapshots and create reproducible development environments |
1351 | (@pxref{Invoking guix environment}). | |
1352 | ||
6447738c MW |
1353 | @item --remove=@var{package} @dots{} |
1354 | @itemx -r @var{package} @dots{} | |
1355 | Remove the specified @var{package}s. | |
eeaf4427 | 1356 | |
6447738c | 1357 | As for @code{--install}, each @var{package} may specify a version number |
13ed095c LC |
1358 | and/or output name in addition to the package name. For instance, |
1359 | @code{-r glibc:debug} would remove the @code{debug} output of | |
1360 | @code{glibc}. | |
1361 | ||
6447738c MW |
1362 | @item --upgrade[=@var{regexp} @dots{}] |
1363 | @itemx -u [@var{regexp} @dots{}] | |
1364 | Upgrade all the installed packages. If one or more @var{regexp}s are | |
1365 | specified, upgrade only installed packages whose name matches a | |
d5f01e48 | 1366 | @var{regexp}. Also see the @code{--do-not-upgrade} option below. |
eeaf4427 | 1367 | |
f651b477 LC |
1368 | Note that this upgrades package to the latest version of packages found |
1369 | in the distribution currently installed. To update your distribution, | |
1370 | you should regularly run @command{guix pull} (@pxref{Invoking guix | |
1371 | pull}). | |
1372 | ||
d5f01e48 MW |
1373 | @item --do-not-upgrade[=@var{regexp} @dots{}] |
1374 | When used together with the @code{--upgrade} option, do @emph{not} | |
1375 | upgrade any packages whose name matches a @var{regexp}. For example, to | |
1376 | upgrade all packages in the current profile except those containing the | |
1377 | substring ``emacs'': | |
1378 | ||
1379 | @example | |
1380 | $ guix package --upgrade . --do-not-upgrade emacs | |
1381 | @end example | |
1382 | ||
99bd74d5 | 1383 | @item @anchor{profile-manifest}--manifest=@var{file} |
1b676447 | 1384 | @itemx -m @var{file} |
99bd74d5 LC |
1385 | @cindex profile declaration |
1386 | @cindex profile manifest | |
1387 | Create a new generation of the profile from the manifest object | |
1b676447 DT |
1388 | returned by the Scheme code in @var{file}. |
1389 | ||
99bd74d5 LC |
1390 | This allows you to @emph{declare} the profile's contents rather than |
1391 | constructing it through a sequence of @code{--install} and similar | |
1392 | commands. The advantage is that @var{file} can be put under version | |
1393 | control, copied to different machines to reproduce the same profile, and | |
1394 | so on. | |
1395 | ||
1396 | @c FIXME: Add reference to (guix profile) documentation when available. | |
1397 | @var{file} must return a @dfn{manifest} object, which is roughly a list | |
1398 | of packages: | |
1b676447 | 1399 | |
99bd74d5 | 1400 | @findex packages->manifest |
1b676447 | 1401 | @example |
99bd74d5 | 1402 | (use-package-modules guile emacs) |
1b676447 DT |
1403 | |
1404 | (packages->manifest | |
99bd74d5 LC |
1405 | (list emacs |
1406 | guile-2.0 | |
1b676447 | 1407 | ;; Use a specific package output. |
99bd74d5 | 1408 | (list guile-2.0 "debug"))) |
1b676447 DT |
1409 | @end example |
1410 | ||
24e262f0 LC |
1411 | @item --roll-back |
1412 | Roll back to the previous @dfn{generation} of the profile---i.e., undo | |
1413 | the last transaction. | |
1414 | ||
1415 | When combined with options such as @code{--install}, roll back occurs | |
1416 | before any other actions. | |
1417 | ||
d9307267 | 1418 | When rolling back from the first generation that actually contains |
4b2bc804 | 1419 | installed packages, the profile is made to point to the @dfn{zeroth |
f97c9175 | 1420 | generation}, which contains no files apart from its own metadata. |
d9307267 | 1421 | |
f97c9175 AE |
1422 | After having rolled back, installing, removing, or upgrading packages |
1423 | overwrites previous future generations. Thus, the history of the | |
1424 | generations in a profile is always linear. | |
82fe08ed | 1425 | |
b3bb82f1 AK |
1426 | @item --switch-generation=@var{pattern} |
1427 | @itemx -S @var{pattern} | |
1428 | Switch to a particular generation defined by @var{pattern}. | |
1429 | ||
1430 | @var{pattern} may be either a generation number or a number prefixed | |
1431 | with ``+'' or ``-''. The latter means: move forward/backward by a | |
1432 | specified number of generations. For example, if you want to return to | |
1433 | the latest generation after @code{--roll-back}, use | |
1434 | @code{--switch-generation=+1}. | |
1435 | ||
1436 | The difference between @code{--roll-back} and | |
1437 | @code{--switch-generation=-1} is that @code{--switch-generation} will | |
1438 | not make a zeroth generation, so if a specified generation does not | |
1439 | exist, the current generation will not be changed. | |
1440 | ||
dbc31ab2 | 1441 | @item --search-paths[=@var{kind}] |
5924080d LC |
1442 | @cindex search paths |
1443 | Report environment variable definitions, in Bash syntax, that may be | |
1444 | needed in order to use the set of installed packages. These environment | |
1445 | variables are used to specify @dfn{search paths} for files used by some | |
1446 | of the installed packages. | |
1447 | ||
1448 | For example, GCC needs the @code{CPATH} and @code{LIBRARY_PATH} | |
1449 | environment variables to be defined so it can look for headers and | |
1450 | libraries in the user's profile (@pxref{Environment Variables,,, gcc, | |
1451 | Using the GNU Compiler Collection (GCC)}). If GCC and, say, the C | |
1452 | library are installed in the profile, then @code{--search-paths} will | |
1453 | suggest setting these variables to @code{@var{profile}/include} and | |
1454 | @code{@var{profile}/lib}, respectively. | |
1455 | ||
dbc31ab2 LC |
1456 | The typical use case is to define these environment variables in the |
1457 | shell: | |
1458 | ||
1459 | @example | |
1460 | $ eval `guix package --search-paths` | |
1461 | @end example | |
1462 | ||
1463 | @var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, | |
1464 | meaning that the returned environment variable definitions will either | |
1465 | be exact settings, or prefixes or suffixes of the current value of these | |
1466 | variables. When omitted, @var{kind} defaults to @code{exact}. | |
1467 | ||
fc2d2339 LC |
1468 | This option can also be used to compute the @emph{combined} search paths |
1469 | of several profiles. Consider this example: | |
1470 | ||
1471 | @example | |
1472 | $ guix package -p foo -i guile | |
1473 | $ guix package -p bar -i guile-json | |
1474 | $ guix package -p foo -p bar --search-paths | |
1475 | @end example | |
1476 | ||
1477 | The last command above reports about the @code{GUILE_LOAD_PATH} | |
1478 | variable, even though, taken individually, neither @file{foo} nor | |
1479 | @file{bar} would lead to that recommendation. | |
1480 | ||
1481 | ||
eeaf4427 LC |
1482 | @item --profile=@var{profile} |
1483 | @itemx -p @var{profile} | |
1484 | Use @var{profile} instead of the user's default profile. | |
1485 | ||
70915c1a | 1486 | @item --verbose |
f97c9175 AE |
1487 | Produce verbose output. In particular, emit the build log of the |
1488 | environment on the standard error port. | |
70915c1a | 1489 | |
eeaf4427 LC |
1490 | @item --bootstrap |
1491 | Use the bootstrap Guile to build the profile. This option is only | |
1492 | useful to distribution developers. | |
1493 | ||
1494 | @end table | |
1495 | ||
f97c9175 | 1496 | In addition to these actions, @command{guix package} supports the |
733b4130 LC |
1497 | following options to query the current state of a profile, or the |
1498 | availability of packages: | |
eeaf4427 | 1499 | |
733b4130 LC |
1500 | @table @option |
1501 | ||
acc08466 NK |
1502 | @item --search=@var{regexp} |
1503 | @itemx -s @var{regexp} | |
b110869d | 1504 | @cindex searching for packages |
5763ad92 | 1505 | List the available packages whose name, synopsis, or description matches |
f97c9175 | 1506 | @var{regexp}. Print all the metadata of matching packages in |
299112d3 LC |
1507 | @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, |
1508 | GNU recutils manual}). | |
acc08466 | 1509 | |
299112d3 LC |
1510 | This allows specific fields to be extracted using the @command{recsel} |
1511 | command, for instance: | |
1512 | ||
1513 | @example | |
e49951eb | 1514 | $ guix package -s malloc | recsel -p name,version |
299112d3 LC |
1515 | name: glibc |
1516 | version: 2.17 | |
1517 | ||
1518 | name: libgc | |
1519 | version: 7.2alpha6 | |
1520 | @end example | |
acc08466 | 1521 | |
a12d92f5 LC |
1522 | Similarly, to show the name of all the packages available under the |
1523 | terms of the GNU@tie{}LGPL version 3: | |
1524 | ||
1525 | @example | |
1526 | $ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"' | |
1527 | name: elfutils | |
1528 | ||
1529 | name: gmp | |
1530 | @dots{} | |
1531 | @end example | |
1532 | ||
db5a9444 LC |
1533 | It is also possible to refine search results using several @code{-s} |
1534 | flags. For example, the following command returns a list of board | |
1535 | games: | |
1536 | ||
1537 | @example | |
1538 | $ guix package -s '\<board\>' -s game | recsel -p name | |
1539 | name: gnubg | |
1540 | @dots{} | |
1541 | @end example | |
1542 | ||
1543 | If we were to omit @code{-s game}, we would also get software packages | |
1544 | that deal with printed circuit boards; removing the angle brackets | |
1545 | around @code{board} would further add packages that have to do with | |
1546 | keyboards. | |
1547 | ||
b110869d LC |
1548 | And now for a more elaborate example. The following command searches |
1549 | for cryptographic libraries, filters out Haskell, Perl, Python, and Ruby | |
1550 | libraries, and prints the name and synopsis of the matching packages: | |
1551 | ||
1552 | @example | |
1553 | $ guix package -s crypto -s library | \ | |
1554 | recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis | |
1555 | @end example | |
1556 | ||
1557 | @noindent | |
1558 | @xref{Selection Expressions,,, recutils, GNU recutils manual}, for more | |
1559 | information on @dfn{selection expressions} for @code{recsel -e}. | |
1560 | ||
2aa6efb0 CR |
1561 | @item --show=@var{package} |
1562 | Show details about @var{package}, taken from the list of available packages, in | |
1563 | @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU | |
1564 | recutils manual}). | |
1565 | ||
1566 | @example | |
1567 | $ guix package --show=python | recsel -p name,version | |
1568 | name: python | |
1569 | version: 2.7.6 | |
1570 | ||
1571 | name: python | |
1572 | version: 3.3.5 | |
1573 | @end example | |
1574 | ||
1575 | You may also specify the full name of a package to only get details about a | |
1576 | specific version of it: | |
1577 | @example | |
1578 | $ guix package --show=python-3.3.5 | recsel -p name,version | |
1579 | name: python | |
1580 | version: 3.3.5 | |
1581 | @end example | |
1582 | ||
1583 | ||
1584 | ||
733b4130 LC |
1585 | @item --list-installed[=@var{regexp}] |
1586 | @itemx -I [@var{regexp}] | |
bd9bde1c LC |
1587 | List the currently installed packages in the specified profile, with the |
1588 | most recently installed packages shown last. When @var{regexp} is | |
1589 | specified, list only installed packages whose name matches @var{regexp}. | |
733b4130 LC |
1590 | |
1591 | For each installed package, print the following items, separated by | |
1592 | tabs: the package name, its version string, the part of the package that | |
1593 | is installed (for instance, @code{out} for the default output, | |
1594 | @code{include} for its headers, etc.), and the path of this package in | |
1595 | the store. | |
1596 | ||
64fc89b6 LC |
1597 | @item --list-available[=@var{regexp}] |
1598 | @itemx -A [@var{regexp}] | |
5763ad92 | 1599 | List packages currently available in the distribution for this system |
a1ba8475 LC |
1600 | (@pxref{GNU Distribution}). When @var{regexp} is specified, list only |
1601 | installed packages whose name matches @var{regexp}. | |
64fc89b6 LC |
1602 | |
1603 | For each package, print the following items separated by tabs: its name, | |
6e721c4d LC |
1604 | its version string, the parts of the package (@pxref{Packages with |
1605 | Multiple Outputs}), and the source location of its definition. | |
64fc89b6 | 1606 | |
f566d765 LC |
1607 | @item --list-generations[=@var{pattern}] |
1608 | @itemx -l [@var{pattern}] | |
1609 | Return a list of generations along with their creation dates; for each | |
1610 | generation, show the installed packages, with the most recently | |
4b2bc804 NK |
1611 | installed packages shown last. Note that the zeroth generation is never |
1612 | shown. | |
f566d765 LC |
1613 | |
1614 | For each installed package, print the following items, separated by | |
1615 | tabs: the name of a package, its version string, the part of the package | |
1616 | that is installed (@pxref{Packages with Multiple Outputs}), and the | |
1617 | location of this package in the store. | |
1618 | ||
1619 | When @var{pattern} is used, the command returns only matching | |
1620 | generations. Valid patterns include: | |
1621 | ||
1622 | @itemize | |
1623 | @item @emph{Integers and comma-separated integers}. Both patterns denote | |
1624 | generation numbers. For instance, @code{--list-generations=1} returns | |
1625 | the first one. | |
1626 | ||
1627 | And @code{--list-generations=1,8,2} outputs three generations in the | |
1628 | specified order. Neither spaces nor trailing commas are allowed. | |
1629 | ||
1630 | @item @emph{Ranges}. @code{--list-generations=2..9} prints the | |
1631 | specified generations and everything in between. Note that the start of | |
f97c9175 | 1632 | a range must be smaller than its end. |
f566d765 LC |
1633 | |
1634 | It is also possible to omit the endpoint. For example, | |
1635 | @code{--list-generations=2..}, returns all generations starting from the | |
1636 | second one. | |
1637 | ||
1638 | @item @emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks, | |
1639 | or months by passing an integer along with the first letter of the | |
d7ddb257 LC |
1640 | duration. For example, @code{--list-generations=20d} lists generations |
1641 | that are up to 20 days old. | |
f566d765 LC |
1642 | @end itemize |
1643 | ||
b7884ca3 NK |
1644 | @item --delete-generations[=@var{pattern}] |
1645 | @itemx -d [@var{pattern}] | |
d7ddb257 LC |
1646 | When @var{pattern} is omitted, delete all generations except the current |
1647 | one. | |
b7884ca3 NK |
1648 | |
1649 | This command accepts the same patterns as @option{--list-generations}. | |
d7ddb257 LC |
1650 | When @var{pattern} is specified, delete the matching generations. When |
1651 | @var{pattern} specifies a duration, generations @emph{older} than the | |
1652 | specified duration match. For instance, @code{--delete-generations=1m} | |
1653 | deletes generations that are more than one month old. | |
1654 | ||
391bdd8f LC |
1655 | If the current generation matches, it is @emph{not} deleted. Also, the |
1656 | zeroth generation is never deleted. | |
b7884ca3 | 1657 | |
f97c9175 | 1658 | Note that deleting generations prevents rolling back to them. |
1bb9900a LC |
1659 | Consequently, this command must be used with care. |
1660 | ||
733b4130 | 1661 | @end table |
eeaf4427 | 1662 | |
70ee5642 | 1663 | Finally, since @command{guix package} may actually start build |
ccd7158d | 1664 | processes, it supports all the common build options (@pxref{Common Build |
f97c9175 | 1665 | Options}). It also supports package transformation options, such as |
b8638f03 LC |
1666 | @option{--with-source} (@pxref{Package Transformation Options}). |
1667 | However, note that package transformations are lost when upgrading; to | |
f97c9175 | 1668 | preserve transformations across upgrades, you should define your own |
b8638f03 LC |
1669 | package variant in a Guile module and add it to @code{GUIX_PACKAGE_PATH} |
1670 | (@pxref{Defining Packages}). | |
1671 | ||
70ee5642 | 1672 | |
c4202d60 LC |
1673 | @node Substitutes |
1674 | @section Substitutes | |
1675 | ||
1676 | @cindex substitutes | |
1677 | @cindex pre-built binaries | |
1678 | Guix supports transparent source/binary deployment, which means that it | |
1679 | can either build things locally, or download pre-built items from a | |
1680 | server. We call these pre-built items @dfn{substitutes}---they are | |
1681 | substitutes for local build results. In many cases, downloading a | |
1682 | substitute is much faster than building things locally. | |
1683 | ||
1684 | Substitutes can be anything resulting from a derivation build | |
1685 | (@pxref{Derivations}). Of course, in the common case, they are | |
1686 | pre-built package binaries, but source tarballs, for instance, which | |
1687 | also result from derivation builds, can be available as substitutes. | |
1688 | ||
1689 | The @code{hydra.gnu.org} server is a front-end to a build farm that | |
1690 | builds packages from the GNU distribution continuously for some | |
32950fc8 AK |
1691 | architectures, and makes them available as substitutes (@pxref{Emacs |
1692 | Hydra}, for information on how to query the continuous integration | |
1693 | server). This is the | |
f8a8e0fe LC |
1694 | default source of substitutes; it can be overridden by passing the |
1695 | @option{--substitute-urls} option either to @command{guix-daemon} | |
1696 | (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) | |
1697 | or to client tools such as @command{guix package} | |
1698 | (@pxref{client-substitute-urls,, client @option{--substitute-urls} | |
1699 | option}). | |
c4202d60 LC |
1700 | |
1701 | @cindex security | |
1702 | @cindex digital signatures | |
1703 | To allow Guix to download substitutes from @code{hydra.gnu.org}, you | |
1704 | must add its public key to the access control list (ACL) of archive | |
1705 | imports, using the @command{guix archive} command (@pxref{Invoking guix | |
1706 | archive}). Doing so implies that you trust @code{hydra.gnu.org} to not | |
1707 | be compromised and to serve genuine substitutes. | |
1708 | ||
1709 | This public key is installed along with Guix, in | |
1710 | @code{@var{prefix}/share/guix/hydra.gnu.org.pub}, where @var{prefix} is | |
1711 | the installation prefix of Guix. If you installed Guix from source, | |
1712 | make sure you checked the GPG signature of | |
1713 | @file{guix-@value{VERSION}.tar.gz}, which contains this public key file. | |
1714 | Then, you can run something like this: | |
1715 | ||
1716 | @example | |
1717 | # guix archive --authorize < hydra.gnu.org.pub | |
1718 | @end example | |
1719 | ||
1720 | Once this is in place, the output of a command like @code{guix build} | |
1721 | should change from something like: | |
1722 | ||
1723 | @example | |
1724 | $ guix build emacs --dry-run | |
1725 | The following derivations would be built: | |
1726 | /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv | |
1727 | /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv | |
1728 | /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv | |
1729 | /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv | |
1730 | @dots{} | |
1731 | @end example | |
1732 | ||
1733 | @noindent | |
1734 | to something like: | |
1735 | ||
1736 | @example | |
1737 | $ guix build emacs --dry-run | |
1738 | The following files would be downloaded: | |
1739 | /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3 | |
1740 | /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d | |
1741 | /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16 | |
1742 | /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7 | |
1743 | @dots{} | |
1744 | @end example | |
1745 | ||
1746 | @noindent | |
1747 | This indicates that substitutes from @code{hydra.gnu.org} are usable and | |
1748 | will be downloaded, when possible, for future builds. | |
1749 | ||
1750 | Guix ignores substitutes that are not signed, or that are not signed by | |
ef27aa9c | 1751 | one of the keys listed in the ACL. It also detects and raises an error |
c4202d60 LC |
1752 | when attempting to use a substitute that has been tampered with. |
1753 | ||
e0c941fe LC |
1754 | @vindex http_proxy |
1755 | Substitutes are downloaded over HTTP. The @code{http_proxy} environment | |
1756 | variable can be set in the environment of @command{guix-daemon} and is | |
1757 | honored for downloads of substitutes. Note that the value of | |
1758 | @code{http_proxy} in the environment where @command{guix build}, | |
1759 | @command{guix package}, and other client commands are run has | |
1760 | @emph{absolutely no effect}. | |
1761 | ||
c4202d60 LC |
1762 | The substitute mechanism can be disabled globally by running |
1763 | @code{guix-daemon} with @code{--no-substitutes} (@pxref{Invoking | |
1764 | guix-daemon}). It can also be disabled temporarily by passing the | |
1765 | @code{--no-substitutes} option to @command{guix package}, @command{guix | |
1766 | build}, and other command-line tools. | |
1767 | ||
1768 | ||
1769 | Today, each individual's control over their own computing is at the | |
1770 | mercy of institutions, corporations, and groups with enough power and | |
1771 | determination to subvert the computing infrastructure and exploit its | |
1772 | weaknesses. While using @code{hydra.gnu.org} substitutes can be | |
1773 | convenient, we encourage users to also build on their own, or even run | |
1774 | their own build farm, such that @code{hydra.gnu.org} is less of an | |
8ce229fc LC |
1775 | interesting target. One way to help is by publishing the software you |
1776 | build using @command{guix publish} so that others have one more choice | |
1777 | of server to download substitutes from (@pxref{Invoking guix publish}). | |
c4202d60 LC |
1778 | |
1779 | Guix has the foundations to maximize build reproducibility | |
1780 | (@pxref{Features}). In most cases, independent builds of a given | |
1781 | package or derivation should yield bit-identical results. Thus, through | |
1782 | a diverse set of independent package builds, we can strengthen the | |
d23c20f1 LC |
1783 | integrity of our systems. The @command{guix challenge} command aims to |
1784 | help users assess substitute servers, and to assist developers in | |
1785 | finding out about non-deterministic package builds (@pxref{Invoking guix | |
a8d65643 LC |
1786 | challenge}). Similarly, the @option{--check} option of @command{guix |
1787 | build} allows users to check whether previously-installed substitutes | |
1788 | are genuine by rebuilding them locally (@pxref{build-check, | |
1789 | @command{guix build --check}}). | |
c4202d60 LC |
1790 | |
1791 | In the future, we want Guix to have support to publish and retrieve | |
1792 | binaries to/from other users, in a peer-to-peer fashion. If you would | |
1793 | like to discuss this project, join us on @email{guix-devel@@gnu.org}. | |
1794 | ||
1795 | ||
6e721c4d LC |
1796 | @node Packages with Multiple Outputs |
1797 | @section Packages with Multiple Outputs | |
1798 | ||
1799 | @cindex multiple-output packages | |
1800 | @cindex package outputs | |
1801 | ||
1802 | Often, packages defined in Guix have a single @dfn{output}---i.e., the | |
f97c9175 | 1803 | source package leads to exactly one directory in the store. When running |
6e721c4d LC |
1804 | @command{guix package -i glibc}, one installs the default output of the |
1805 | GNU libc package; the default output is called @code{out}, but its name | |
1806 | can be omitted as shown in this command. In this particular case, the | |
1807 | default output of @code{glibc} contains all the C header files, shared | |
1808 | libraries, static libraries, Info documentation, and other supporting | |
1809 | files. | |
1810 | ||
1811 | Sometimes it is more appropriate to separate the various types of files | |
1812 | produced from a single source package into separate outputs. For | |
1813 | instance, the GLib C library (used by GTK+ and related packages) | |
1814 | installs more than 20 MiB of reference documentation as HTML pages. | |
1815 | To save space for users who do not need it, the documentation goes to a | |
1816 | separate output, called @code{doc}. To install the main GLib output, | |
1817 | which contains everything but the documentation, one would run: | |
1818 | ||
1819 | @example | |
1820 | guix package -i glib | |
1821 | @end example | |
1822 | ||
1823 | The command to install its documentation is: | |
1824 | ||
1825 | @example | |
1826 | guix package -i glib:doc | |
1827 | @end example | |
1828 | ||
1829 | Some packages install programs with different ``dependency footprints''. | |
f97c9175 | 1830 | For instance, the WordNet package installs both command-line tools and |
6e721c4d LC |
1831 | graphical user interfaces (GUIs). The former depend solely on the C |
1832 | library, whereas the latter depend on Tcl/Tk and the underlying X | |
1833 | libraries. In this case, we leave the command-line tools in the default | |
1834 | output, whereas the GUIs are in a separate output. This allows users | |
fcc58db6 LC |
1835 | who do not need the GUIs to save space. The @command{guix size} command |
1836 | can help find out about such situations (@pxref{Invoking guix size}). | |
88856916 | 1837 | @command{guix graph} can also be helpful (@pxref{Invoking guix graph}). |
6e721c4d LC |
1838 | |
1839 | There are several such multiple-output packages in the GNU distribution. | |
91ef73d4 LC |
1840 | Other conventional output names include @code{lib} for libraries and |
1841 | possibly header files, @code{bin} for stand-alone programs, and | |
1842 | @code{debug} for debugging information (@pxref{Installing Debugging | |
1843 | Files}). The outputs of a packages are listed in the third column of | |
1844 | the output of @command{guix package --list-available} (@pxref{Invoking | |
1845 | guix package}). | |
6e721c4d | 1846 | |
eeaf4427 | 1847 | |
e49951eb MW |
1848 | @node Invoking guix gc |
1849 | @section Invoking @command{guix gc} | |
fe8ff028 LC |
1850 | |
1851 | @cindex garbage collector | |
f97c9175 | 1852 | Packages that are installed, but not used, may be @dfn{garbage-collected}. |
e49951eb | 1853 | The @command{guix gc} command allows users to explicitly run the garbage |
c22eb992 LC |
1854 | collector to reclaim space from the @file{/gnu/store} directory. It is |
1855 | the @emph{only} way to remove files from @file{/gnu/store}---removing | |
1856 | files or directories manually may break it beyond repair! | |
fe8ff028 LC |
1857 | |
1858 | The garbage collector has a set of known @dfn{roots}: any file under | |
834129e0 | 1859 | @file{/gnu/store} reachable from a root is considered @dfn{live} and |
fe8ff028 LC |
1860 | cannot be deleted; any other file is considered @dfn{dead} and may be |
1861 | deleted. The set of garbage collector roots includes default user | |
e49951eb MW |
1862 | profiles, and may be augmented with @command{guix build --root}, for |
1863 | example (@pxref{Invoking guix build}). | |
fe8ff028 | 1864 | |
1bb9900a LC |
1865 | Prior to running @code{guix gc --collect-garbage} to make space, it is |
1866 | often useful to remove old generations from user profiles; that way, old | |
1867 | package builds referenced by those generations can be reclaimed. This | |
1868 | is achieved by running @code{guix package --delete-generations} | |
1869 | (@pxref{Invoking guix package}). | |
1870 | ||
e49951eb | 1871 | The @command{guix gc} command has three modes of operation: it can be |
fe8ff028 | 1872 | used to garbage-collect any dead files (the default), to delete specific |
7770aafc LC |
1873 | files (the @code{--delete} option), to print garbage-collector |
1874 | information, or for more advanced queries. The garbage collection | |
1875 | options are as follows: | |
fe8ff028 LC |
1876 | |
1877 | @table @code | |
1878 | @item --collect-garbage[=@var{min}] | |
1879 | @itemx -C [@var{min}] | |
834129e0 | 1880 | Collect garbage---i.e., unreachable @file{/gnu/store} files and |
fe8ff028 LC |
1881 | sub-directories. This is the default operation when no option is |
1882 | specified. | |
1883 | ||
1884 | When @var{min} is given, stop once @var{min} bytes have been collected. | |
1885 | @var{min} may be a number of bytes, or it may include a unit as a | |
4a44d7bb LC |
1886 | suffix, such as @code{MiB} for mebibytes and @code{GB} for gigabytes |
1887 | (@pxref{Block size, size specifications,, coreutils, GNU Coreutils}). | |
fe8ff028 LC |
1888 | |
1889 | When @var{min} is omitted, collect all the garbage. | |
1890 | ||
1891 | @item --delete | |
1892 | @itemx -d | |
1893 | Attempt to delete all the store files and directories specified as | |
1894 | arguments. This fails if some of the files are not in the store, or if | |
1895 | they are still live. | |
1896 | ||
30d9aa54 LC |
1897 | @item --list-failures |
1898 | List store items corresponding to cached build failures. | |
1899 | ||
1900 | This prints nothing unless the daemon was started with | |
1901 | @option{--cache-failures} (@pxref{Invoking guix-daemon, | |
1902 | @option{--cache-failures}}). | |
1903 | ||
1904 | @item --clear-failures | |
1905 | Remove the specified store items from the failed-build cache. | |
1906 | ||
1907 | Again, this option only makes sense when the daemon is started with | |
1908 | @option{--cache-failures}. Otherwise, it does nothing. | |
1909 | ||
fe8ff028 LC |
1910 | @item --list-dead |
1911 | Show the list of dead files and directories still present in the | |
1912 | store---i.e., files and directories no longer reachable from any root. | |
1913 | ||
1914 | @item --list-live | |
1915 | Show the list of live store files and directories. | |
ba8b732d LC |
1916 | |
1917 | @end table | |
1918 | ||
1919 | In addition, the references among existing store files can be queried: | |
1920 | ||
1921 | @table @code | |
1922 | ||
1923 | @item --references | |
1924 | @itemx --referrers | |
1925 | List the references (respectively, the referrers) of store files given | |
1926 | as arguments. | |
1927 | ||
8e59fdd5 LC |
1928 | @item --requisites |
1929 | @itemx -R | |
fcc58db6 | 1930 | @cindex closure |
8e59fdd5 LC |
1931 | List the requisites of the store files passed as arguments. Requisites |
1932 | include the store files themselves, their references, and the references | |
1933 | of these, recursively. In other words, the returned list is the | |
1934 | @dfn{transitive closure} of the store files. | |
1935 | ||
f97c9175 AE |
1936 | @xref{Invoking guix size}, for a tool to profile the size of the closure |
1937 | of an element. @xref{Invoking guix graph}, for a tool to visualize | |
88856916 | 1938 | the graph of references. |
fcc58db6 | 1939 | |
fe8ff028 LC |
1940 | @end table |
1941 | ||
7770aafc LC |
1942 | Lastly, the following options allow you to check the integrity of the |
1943 | store and to control disk usage. | |
1944 | ||
1945 | @table @option | |
1946 | ||
1947 | @item --verify[=@var{options}] | |
1948 | @cindex integrity, of the store | |
1949 | @cindex integrity checking | |
1950 | Verify the integrity of the store. | |
1951 | ||
1952 | By default, make sure that all the store items marked as valid in the | |
f97c9175 | 1953 | database of the daemon actually exist in @file{/gnu/store}. |
7770aafc | 1954 | |
f97c9175 | 1955 | When provided, @var{options} must be a comma-separated list containing one |
7770aafc LC |
1956 | or more of @code{contents} and @code{repair}. |
1957 | ||
f97c9175 AE |
1958 | When passing @option{--verify=contents}, the daemon computse the |
1959 | content hash of each store item and compares it against its hash in the | |
7770aafc LC |
1960 | database. Hash mismatches are reported as data corruptions. Because it |
1961 | traverses @emph{all the files in the store}, this command can take a | |
1962 | long time, especially on systems with a slow disk drive. | |
1963 | ||
1964 | @cindex repairing the store | |
1965 | Using @option{--verify=repair} or @option{--verify=contents,repair} | |
1966 | causes the daemon to try to repair corrupt store items by fetching | |
1967 | substitutes for them (@pxref{Substitutes}). Because repairing is not | |
1968 | atomic, and thus potentially dangerous, it is available only to the | |
1969 | system administrator. | |
1970 | ||
1971 | @item --optimize | |
1972 | @cindex deduplication | |
1973 | Optimize the store by hard-linking identical files---this is | |
1974 | @dfn{deduplication}. | |
1975 | ||
1976 | The daemon performs deduplication after each successful build or archive | |
1977 | import, unless it was started with @code{--disable-deduplication} | |
1978 | (@pxref{Invoking guix-daemon, @code{--disable-deduplication}}). Thus, | |
1979 | this option is primarily useful when the daemon was running with | |
1980 | @code{--disable-deduplication}. | |
1981 | ||
1982 | @end table | |
eeaf4427 | 1983 | |
f651b477 LC |
1984 | @node Invoking guix pull |
1985 | @section Invoking @command{guix pull} | |
1986 | ||
1987 | Packages are installed or upgraded to the latest version available in | |
1988 | the distribution currently available on your local machine. To update | |
1989 | that distribution, along with the Guix tools, you must run @command{guix | |
1990 | pull}: the command downloads the latest Guix source code and package | |
1991 | descriptions, and deploys it. | |
1992 | ||
1993 | On completion, @command{guix package} will use packages and package | |
1994 | versions from this just-retrieved copy of Guix. Not only that, but all | |
1995 | the Guix commands and Scheme modules will also be taken from that latest | |
1996 | version. New @command{guix} sub-commands added by the update also | |
cb05108a LC |
1997 | become available. |
1998 | ||
1999 | Any user can update their Guix copy using @command{guix pull}, and the | |
2000 | effect is limited to the user who run @command{guix pull}. For | |
2001 | instance, when user @code{root} runs @command{guix pull}, this has no | |
2002 | effect on the version of Guix that user @code{alice} sees, and vice | |
2003 | versa@footnote{Under the hood, @command{guix pull} updates the | |
2004 | @file{~/.config/guix/latest} symbolic link to point to the latest Guix, | |
2005 | and the @command{guix} command loads code from there.}. | |
f651b477 LC |
2006 | |
2007 | The @command{guix pull} command is usually invoked with no arguments, | |
2008 | but it supports the following options: | |
2009 | ||
2010 | @table @code | |
2011 | @item --verbose | |
2012 | Produce verbose output, writing build logs to the standard error output. | |
2013 | ||
ab5d72ad LC |
2014 | @item --url=@var{url} |
2015 | Download the source tarball of Guix from @var{url}. | |
2016 | ||
2017 | By default, the tarball is taken from its canonical address at | |
2018 | @code{gnu.org}, for the stable branch of Guix. | |
2019 | ||
f651b477 LC |
2020 | @item --bootstrap |
2021 | Use the bootstrap Guile to build the latest Guix. This option is only | |
2022 | useful to Guix developers. | |
2023 | @end table | |
2024 | ||
760c60d6 LC |
2025 | |
2026 | @node Invoking guix archive | |
2027 | @section Invoking @command{guix archive} | |
2028 | ||
2029 | The @command{guix archive} command allows users to @dfn{export} files | |
2030 | from the store into a single archive, and to later @dfn{import} them. | |
2031 | In particular, it allows store files to be transferred from one machine | |
4d4c4816 AE |
2032 | to the store on another machine. |
2033 | ||
2034 | To export store files as an archive to standard output, run: | |
2035 | ||
2036 | @example | |
2037 | guix archive --export @var{options} @var{specifications}... | |
2038 | @end example | |
2039 | ||
2040 | @var{specifications} may be either store file names or package | |
2041 | specifications, as for @command{guix package} (@pxref{Invoking guix | |
2042 | package}). For instance, the following command creates an archive | |
2043 | containing the @code{gui} output of the @code{git} package and the main | |
2044 | output of @code{emacs}: | |
2045 | ||
2046 | @example | |
2047 | guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar | |
2048 | @end example | |
2049 | ||
2050 | If the specified packages are not built yet, @command{guix archive} | |
2051 | automatically builds them. The build process may be controlled with the | |
2052 | common build options (@pxref{Common Build Options}). | |
2053 | ||
2054 | To transfer the @code{emacs} package to a machine connected over SSH, | |
2055 | one would run: | |
760c60d6 LC |
2056 | |
2057 | @example | |
56607088 | 2058 | guix archive --export -r emacs | ssh the-machine guix archive --import |
760c60d6 LC |
2059 | @end example |
2060 | ||
87236aed | 2061 | @noindent |
56607088 LC |
2062 | Similarly, a complete user profile may be transferred from one machine |
2063 | to another like this: | |
2064 | ||
2065 | @example | |
2066 | guix archive --export -r $(readlink -f ~/.guix-profile) | \ | |
2067 | ssh the-machine guix-archive --import | |
2068 | @end example | |
2069 | ||
2070 | @noindent | |
2071 | However, note that, in both examples, all of @code{emacs} and the | |
2072 | profile as well as all of their dependencies are transferred (due to | |
f97c9175 AE |
2073 | @code{-r}), regardless of what is already available in the store on the |
2074 | target machine. The @code{--missing} option can help figure out which | |
2075 | items are missing from the target store. | |
87236aed | 2076 | |
760c60d6 | 2077 | Archives are stored in the ``Nix archive'' or ``Nar'' format, which is |
0dbd88db LC |
2078 | comparable in spirit to `tar', but with a few noteworthy differences |
2079 | that make it more appropriate for our purposes. First, rather than | |
f97c9175 | 2080 | recording all Unix metadata for each file, the Nar format only mentions |
0dbd88db LC |
2081 | the file type (regular, directory, or symbolic link); Unix permissions |
2082 | and owner/group are dismissed. Second, the order in which directory | |
2083 | entries are stored always follows the order of file names according to | |
2084 | the C locale collation order. This makes archive production fully | |
2085 | deterministic. | |
2086 | ||
2087 | When exporting, the daemon digitally signs the contents of the archive, | |
2088 | and that digital signature is appended. When importing, the daemon | |
2089 | verifies the signature and rejects the import in case of an invalid | |
2090 | signature or if the signing key is not authorized. | |
760c60d6 LC |
2091 | @c FIXME: Add xref to daemon doc about signatures. |
2092 | ||
2093 | The main options are: | |
2094 | ||
2095 | @table @code | |
2096 | @item --export | |
2097 | Export the specified store files or packages (see below.) Write the | |
2098 | resulting archive to the standard output. | |
2099 | ||
56607088 LC |
2100 | Dependencies are @emph{not} included in the output, unless |
2101 | @code{--recursive} is passed. | |
2102 | ||
2103 | @item -r | |
2104 | @itemx --recursive | |
2105 | When combined with @code{--export}, this instructs @command{guix | |
2106 | archive} to include dependencies of the given items in the archive. | |
2107 | Thus, the resulting archive is self-contained: it contains the closure | |
2108 | of the exported store items. | |
2109 | ||
760c60d6 LC |
2110 | @item --import |
2111 | Read an archive from the standard input, and import the files listed | |
2112 | therein into the store. Abort if the archive has an invalid digital | |
f82cc5fd LC |
2113 | signature, or if it is signed by a public key not among the authorized |
2114 | keys (see @code{--authorize} below.) | |
554f26ec | 2115 | |
87236aed LC |
2116 | @item --missing |
2117 | Read a list of store file names from the standard input, one per line, | |
2118 | and write on the standard output the subset of these files missing from | |
2119 | the store. | |
2120 | ||
554f26ec | 2121 | @item --generate-key[=@var{parameters}] |
f82cc5fd | 2122 | @cindex signing, archives |
f97c9175 | 2123 | Generate a new key pair for the daemon. This is a prerequisite before |
554f26ec LC |
2124 | archives can be exported with @code{--export}. Note that this operation |
2125 | usually takes time, because it needs to gather enough entropy to | |
2126 | generate the key pair. | |
2127 | ||
2128 | The generated key pair is typically stored under @file{/etc/guix}, in | |
2129 | @file{signing-key.pub} (public key) and @file{signing-key.sec} (private | |
867d8473 LC |
2130 | key, which must be kept secret.) When @var{parameters} is omitted, |
2131 | an ECDSA key using the Ed25519 curve is generated, or, for Libgcrypt | |
2132 | versions before 1.6.0, it is a 4096-bit RSA key. | |
f97c9175 | 2133 | Alternatively, @var{parameters} can specify |
554f26ec LC |
2134 | @code{genkey} parameters suitable for Libgcrypt (@pxref{General |
2135 | public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The | |
2136 | Libgcrypt Reference Manual}). | |
f82cc5fd LC |
2137 | |
2138 | @item --authorize | |
2139 | @cindex authorizing, archives | |
2140 | Authorize imports signed by the public key passed on standard input. | |
2141 | The public key must be in ``s-expression advanced format''---i.e., the | |
2142 | same format as the @file{signing-key.pub} file. | |
2143 | ||
2144 | The list of authorized keys is kept in the human-editable file | |
2145 | @file{/etc/guix/acl}. The file contains | |
2146 | @url{http://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format | |
2147 | s-expressions''} and is structured as an access-control list in the | |
2148 | @url{http://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure | |
2149 | (SPKI)}. | |
c6f8e9dd LC |
2150 | |
2151 | @item --extract=@var{directory} | |
2152 | @itemx -x @var{directory} | |
2153 | Read a single-item archive as served by substitute servers | |
2154 | (@pxref{Substitutes}) and extract it to @var{directory}. This is a | |
2155 | low-level operation needed in only very narrow use cases; see below. | |
2156 | ||
2157 | For example, the following command extracts the substitute for Emacs | |
2158 | served by @code{hydra.gnu.org} to @file{/tmp/emacs}: | |
2159 | ||
2160 | @example | |
2161 | $ wget -O - \ | |
2162 | http://hydra.gnu.org/nar/@dots{}-emacs-24.5 \ | |
2163 | | bunzip2 | guix archive -x /tmp/emacs | |
2164 | @end example | |
2165 | ||
2166 | Single-item archives are different from multiple-item archives produced | |
2167 | by @command{guix archive --export}; they contain a single store item, | |
2168 | and they do @emph{not} embed a signature. Thus this operation does | |
2169 | @emph{no} signature verification and its output should be considered | |
2170 | unsafe. | |
2171 | ||
2172 | The primary purpose of this operation is to facilitate inspection of | |
2173 | archive contents coming from possibly untrusted substitute servers. | |
2174 | ||
760c60d6 LC |
2175 | @end table |
2176 | ||
c554de89 AK |
2177 | @c ********************************************************************* |
2178 | @include emacs.texi | |
760c60d6 | 2179 | |
568717fd LC |
2180 | @c ********************************************************************* |
2181 | @node Programming Interface | |
2182 | @chapter Programming Interface | |
2183 | ||
3dc1970d LC |
2184 | GNU Guix provides several Scheme programming interfaces (APIs) to |
2185 | define, build, and query packages. The first interface allows users to | |
2186 | write high-level package definitions. These definitions refer to | |
2187 | familiar packaging concepts, such as the name and version of a package, | |
2188 | its build system, and its dependencies. These definitions can then be | |
2189 | turned into concrete build actions. | |
2190 | ||
ba55b1cb | 2191 | Build actions are performed by the Guix daemon, on behalf of users. In a |
3dc1970d | 2192 | standard setup, the daemon has write access to the store---the |
834129e0 | 2193 | @file{/gnu/store} directory---whereas users do not. The recommended |
3dc1970d LC |
2194 | setup also has the daemon perform builds in chroots, under a specific |
2195 | build users, to minimize interference with the rest of the system. | |
2196 | ||
2197 | @cindex derivation | |
2198 | Lower-level APIs are available to interact with the daemon and the | |
2199 | store. To instruct the daemon to perform a build action, users actually | |
2200 | provide it with a @dfn{derivation}. A derivation is a low-level | |
2201 | representation of the build actions to be taken, and the environment in | |
2202 | which they should occur---derivations are to package definitions what | |
49ad317a LC |
2203 | assembly is to C programs. The term ``derivation'' comes from the fact |
2204 | that build results @emph{derive} from them. | |
3dc1970d LC |
2205 | |
2206 | This chapter describes all these APIs in turn, starting from high-level | |
2207 | package definitions. | |
2208 | ||
568717fd | 2209 | @menu |
b860f382 | 2210 | * Defining Packages:: Defining new packages. |
7458bd0a | 2211 | * Build Systems:: Specifying how packages are built. |
b860f382 LC |
2212 | * The Store:: Manipulating the package store. |
2213 | * Derivations:: Low-level interface to package derivations. | |
2214 | * The Store Monad:: Purely functional interface to the store. | |
21b679f6 | 2215 | * G-Expressions:: Manipulating build expressions. |
568717fd LC |
2216 | @end menu |
2217 | ||
2218 | @node Defining Packages | |
2219 | @section Defining Packages | |
2220 | ||
3dc1970d LC |
2221 | The high-level interface to package definitions is implemented in the |
2222 | @code{(guix packages)} and @code{(guix build-system)} modules. As an | |
2223 | example, the package definition, or @dfn{recipe}, for the GNU Hello | |
2224 | package looks like this: | |
2225 | ||
2226 | @example | |
e7f34eb0 LC |
2227 | (define-module (gnu packages hello) |
2228 | #:use-module (guix packages) | |
2229 | #:use-module (guix download) | |
2230 | #:use-module (guix build-system gnu) | |
a6dcdcac SB |
2231 | #:use-module (guix licenses) |
2232 | #:use-module (gnu packages gawk)) | |
b22a12fd | 2233 | |
79f5dd59 | 2234 | (define-public hello |
3dc1970d LC |
2235 | (package |
2236 | (name "hello") | |
17d8e33f | 2237 | (version "2.10") |
3dc1970d | 2238 | (source (origin |
17d8e33f ML |
2239 | (method url-fetch) |
2240 | (uri (string-append "mirror://gnu/hello/hello-" version | |
2241 | ".tar.gz")) | |
2242 | (sha256 | |
2243 | (base32 | |
2244 | "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) | |
3dc1970d | 2245 | (build-system gnu-build-system) |
7458bd0a | 2246 | (arguments `(#:configure-flags '("--enable-silent-rules"))) |
3dc1970d | 2247 | (inputs `(("gawk" ,gawk))) |
7458bd0a LC |
2248 | (synopsis "Hello, GNU world: An example GNU package") |
2249 | (description "Guess what GNU Hello prints!") | |
3dc1970d | 2250 | (home-page "http://www.gnu.org/software/hello/") |
b22a12fd | 2251 | (license gpl3+))) |
3dc1970d LC |
2252 | @end example |
2253 | ||
2254 | @noindent | |
2255 | Without being a Scheme expert, the reader may have guessed the meaning | |
f97c9175 AE |
2256 | of the various fields here. This expression binds the variable |
2257 | @code{hello} to a @code{<package>} object, which is essentially a record | |
3dc1970d LC |
2258 | (@pxref{SRFI-9, Scheme records,, guile, GNU Guile Reference Manual}). |
2259 | This package object can be inspected using procedures found in the | |
2260 | @code{(guix packages)} module; for instance, @code{(package-name hello)} | |
2261 | returns---surprise!---@code{"hello"}. | |
2262 | ||
2f7d2d91 LC |
2263 | With luck, you may be able to import part or all of the definition of |
2264 | the package you are interested in from another repository, using the | |
2265 | @code{guix import} command (@pxref{Invoking guix import}). | |
2266 | ||
f97c9175 | 2267 | In the example above, @var{hello} is defined in a module of its own, |
e7f34eb0 LC |
2268 | @code{(gnu packages hello)}. Technically, this is not strictly |
2269 | necessary, but it is convenient to do so: all the packages defined in | |
2270 | modules under @code{(gnu packages @dots{})} are automatically known to | |
2271 | the command-line tools (@pxref{Package Modules}). | |
2272 | ||
3dc1970d LC |
2273 | There are a few points worth noting in the above package definition: |
2274 | ||
2275 | @itemize | |
2276 | @item | |
a2bf4907 LC |
2277 | The @code{source} field of the package is an @code{<origin>} object |
2278 | (@pxref{origin Reference}, for the complete reference). | |
3dc1970d LC |
2279 | Here, the @code{url-fetch} method from @code{(guix download)} is used, |
2280 | meaning that the source is a file to be downloaded over FTP or HTTP. | |
2281 | ||
2282 | The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of | |
2283 | the GNU mirrors defined in @code{(guix download)}. | |
2284 | ||
2285 | The @code{sha256} field specifies the expected SHA256 hash of the file | |
2286 | being downloaded. It is mandatory, and allows Guix to check the | |
2287 | integrity of the file. The @code{(base32 @dots{})} form introduces the | |
6c365eca | 2288 | base32 representation of the hash. You can obtain this information with |
210cc920 LC |
2289 | @code{guix download} (@pxref{Invoking guix download}) and @code{guix |
2290 | hash} (@pxref{Invoking guix hash}). | |
3dc1970d | 2291 | |
f9cc8971 LC |
2292 | @cindex patches |
2293 | When needed, the @code{origin} form can also have a @code{patches} field | |
2294 | listing patches to be applied, and a @code{snippet} field giving a | |
2295 | Scheme expression to modify the source code. | |
2296 | ||
3dc1970d LC |
2297 | @item |
2298 | @cindex GNU Build System | |
7458bd0a LC |
2299 | The @code{build-system} field specifies the procedure to build the |
2300 | package (@pxref{Build Systems}). Here, @var{gnu-build-system} | |
2301 | represents the familiar GNU Build System, where packages may be | |
2302 | configured, built, and installed with the usual @code{./configure && | |
2303 | make && make check && make install} command sequence. | |
2304 | ||
2305 | @item | |
2306 | The @code{arguments} field specifies options for the build system | |
2307 | (@pxref{Build Systems}). Here it is interpreted by | |
2308 | @var{gnu-build-system} as a request run @file{configure} with the | |
2309 | @code{--enable-silent-rules} flag. | |
3dc1970d LC |
2310 | |
2311 | @item | |
2312 | The @code{inputs} field specifies inputs to the build process---i.e., | |
2313 | build-time or run-time dependencies of the package. Here, we define an | |
2314 | input called @code{"gawk"} whose value is that of the @var{gawk} | |
2315 | variable; @var{gawk} is itself bound to a @code{<package>} object. | |
2316 | ||
2317 | Note that GCC, Coreutils, Bash, and other essential tools do not need to | |
2318 | be specified as inputs here. Instead, @var{gnu-build-system} takes care | |
7458bd0a | 2319 | of ensuring that they are present (@pxref{Build Systems}). |
3dc1970d LC |
2320 | |
2321 | However, any other dependencies need to be specified in the | |
2322 | @code{inputs} field. Any dependency not specified here will simply be | |
2323 | unavailable to the build process, possibly leading to a build failure. | |
2324 | @end itemize | |
2325 | ||
87eafdbd TUBK |
2326 | @xref{package Reference}, for a full description of possible fields. |
2327 | ||
2f7d2d91 | 2328 | Once a package definition is in place, the |
e49951eb | 2329 | package may actually be built using the @code{guix build} command-line |
39bee8a2 LC |
2330 | tool (@pxref{Invoking guix build}). You can easily jump back to the |
2331 | package definition using the @command{guix edit} command | |
2332 | (@pxref{Invoking guix edit}). | |
2333 | @xref{Packaging Guidelines}, for | |
b4f5e0e8 CR |
2334 | more information on how to test package definitions, and |
2335 | @ref{Invoking guix lint}, for information on how to check a definition | |
2336 | for style conformance. | |
2337 | ||
f97c9175 | 2338 | Finally, updating the package definition to a new upstream version |
7458bd0a LC |
2339 | can be partly automated by the @command{guix refresh} command |
2340 | (@pxref{Invoking guix refresh}). | |
3dc1970d LC |
2341 | |
2342 | Behind the scenes, a derivation corresponding to the @code{<package>} | |
2343 | object is first computed by the @code{package-derivation} procedure. | |
834129e0 | 2344 | That derivation is stored in a @code{.drv} file under @file{/gnu/store}. |
ba55b1cb | 2345 | The build actions it prescribes may then be realized by using the |
3dc1970d LC |
2346 | @code{build-derivations} procedure (@pxref{The Store}). |
2347 | ||
2348 | @deffn {Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}] | |
59688fc4 LC |
2349 | Return the @code{<derivation>} object of @var{package} for @var{system} |
2350 | (@pxref{Derivations}). | |
3dc1970d LC |
2351 | |
2352 | @var{package} must be a valid @code{<package>} object, and @var{system} | |
2353 | must be a string denoting the target system type---e.g., | |
2354 | @code{"x86_64-linux"} for an x86_64 Linux-based GNU system. @var{store} | |
2355 | must be a connection to the daemon, which operates on the store | |
2356 | (@pxref{The Store}). | |
2357 | @end deffn | |
568717fd | 2358 | |
9c1edabd LC |
2359 | @noindent |
2360 | @cindex cross-compilation | |
2361 | Similarly, it is possible to compute a derivation that cross-builds a | |
2362 | package for some other system: | |
2363 | ||
2364 | @deffn {Scheme Procedure} package-cross-derivation @var{store} @ | |
2365 | @var{package} @var{target} [@var{system}] | |
59688fc4 LC |
2366 | Return the @code{<derivation>} object of @var{package} cross-built from |
2367 | @var{system} to @var{target}. | |
9c1edabd LC |
2368 | |
2369 | @var{target} must be a valid GNU triplet denoting the target hardware | |
2370 | and operating system, such as @code{"mips64el-linux-gnu"} | |
2371 | (@pxref{Configuration Names, GNU configuration triplets,, configure, GNU | |
2372 | Configure and Build System}). | |
2373 | @end deffn | |
2374 | ||
87eafdbd TUBK |
2375 | @menu |
2376 | * package Reference :: The package data type. | |
2377 | * origin Reference:: The origin data type. | |
2378 | @end menu | |
2379 | ||
2380 | ||
2381 | @node package Reference | |
2382 | @subsection @code{package} Reference | |
2383 | ||
2384 | This section summarizes all the options available in @code{package} | |
2385 | declarations (@pxref{Defining Packages}). | |
2386 | ||
2387 | @deftp {Data Type} package | |
2388 | This is the data type representing a package recipe. | |
2389 | ||
2390 | @table @asis | |
2391 | @item @code{name} | |
2392 | The name of the package, as a string. | |
2393 | ||
2394 | @item @code{version} | |
2395 | The version of the package, as a string. | |
2396 | ||
2397 | @item @code{source} | |
2398 | An origin object telling how the source code for the package should be | |
2399 | acquired (@pxref{origin Reference}). | |
2400 | ||
2401 | @item @code{build-system} | |
2402 | The build system that should be used to build the package (@pxref{Build | |
2403 | Systems}). | |
2404 | ||
2405 | @item @code{arguments} (default: @code{'()}) | |
2406 | The arguments that should be passed to the build system. This is a | |
2407 | list, typically containing sequential keyword-value pairs. | |
2408 | ||
2409 | @item @code{inputs} (default: @code{'()}) | |
70650c68 LC |
2410 | @itemx @code{native-inputs} (default: @code{'()}) |
2411 | @itemx @code{propagated-inputs} (default: @code{'()}) | |
2412 | @cindex inputs, of packages | |
2413 | These fields list dependencies of the package. Each one is a list of | |
2414 | tuples, where each tuple has a label for the input (a string) as its | |
2415 | first element, a package, origin, or derivation as its second element, | |
2416 | and optionally the name of the output thereof that should be used, which | |
2417 | defaults to @code{"out"} (@pxref{Packages with Multiple Outputs}, for | |
f97c9175 | 2418 | more on package outputs). For example, the list below specifies three |
70650c68 | 2419 | inputs: |
87eafdbd | 2420 | |
70650c68 LC |
2421 | @example |
2422 | `(("libffi" ,libffi) | |
2423 | ("libunistring" ,libunistring) | |
2424 | ("glib:bin" ,glib "bin")) ;the "bin" output of Glib | |
2425 | @end example | |
2426 | ||
2427 | @cindex cross compilation, package dependencies | |
2428 | The distinction between @code{native-inputs} and @code{inputs} is | |
2429 | necessary when considering cross-compilation. When cross-compiling, | |
2430 | dependencies listed in @code{inputs} are built for the @emph{target} | |
2431 | architecture; conversely, dependencies listed in @code{native-inputs} | |
2432 | are built for the architecture of the @emph{build} machine. | |
2433 | ||
f97c9175 AE |
2434 | @code{native-inputs} is typically used to list tools needed at |
2435 | build time, but not at run time, such as Autoconf, Automake, pkg-config, | |
70650c68 LC |
2436 | Gettext, or Bison. @command{guix lint} can report likely mistakes in |
2437 | this area (@pxref{Invoking guix lint}). | |
2438 | ||
2439 | @anchor{package-propagated-inputs} | |
2440 | Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the | |
f97c9175 AE |
2441 | specified packages will be automatically installed alongside the package |
2442 | they belong to (@pxref{package-cmd-propagated-inputs, @command{guix | |
70650c68 LC |
2443 | package}}, for information on how @command{guix package} deals with |
2444 | propagated inputs.) | |
21461f27 | 2445 | |
e0508b6b LC |
2446 | For example this is necessary when a C/C++ library needs headers of |
2447 | another library to compile, or when a pkg-config file refers to another | |
2448 | one @i{via} its @code{Requires} field. | |
2449 | ||
f97c9175 AE |
2450 | Another example where @code{propagated-inputs} is useful is for languages |
2451 | that lack a facility to record the run-time search path akin to the | |
2452 | @code{RUNPATH}of ELF files; this includes Guile, Python, Perl, GHC, and | |
e0508b6b LC |
2453 | more. To ensure that libraries written in those languages can find |
2454 | library code they depend on at run time, run-time dependencies must be | |
2455 | listed in @code{propagated-inputs} rather than @code{inputs}. | |
87eafdbd | 2456 | |
87eafdbd TUBK |
2457 | @item @code{self-native-input?} (default: @code{#f}) |
2458 | This is a Boolean field telling whether the package should use itself as | |
2459 | a native input when cross-compiling. | |
2460 | ||
2461 | @item @code{outputs} (default: @code{'("out")}) | |
2462 | The list of output names of the package. @xref{Packages with Multiple | |
2463 | Outputs}, for typical uses of additional outputs. | |
2464 | ||
2465 | @item @code{native-search-paths} (default: @code{'()}) | |
2466 | @itemx @code{search-paths} (default: @code{'()}) | |
2467 | A list of @code{search-path-specification} objects describing | |
2468 | search-path environment variables honored by the package. | |
2469 | ||
2470 | @item @code{replacement} (default: @code{#f}) | |
f97c9175 | 2471 | This must be either @code{#f} or a package object that will be used as a |
87eafdbd TUBK |
2472 | @dfn{replacement} for this package. @xref{Security Updates, grafts}, |
2473 | for details. | |
2474 | ||
2475 | @item @code{synopsis} | |
2476 | A one-line description of the package. | |
2477 | ||
2478 | @item @code{description} | |
2479 | A more elaborate description of the package. | |
2480 | ||
2481 | @item @code{license} | |
f97c9175 AE |
2482 | The license of the package; a value from @code{(guix licenses)}, |
2483 | or a list of such values. | |
87eafdbd TUBK |
2484 | |
2485 | @item @code{home-page} | |
2486 | The URL to the home-page of the package, as a string. | |
2487 | ||
2488 | @item @code{supported-systems} (default: @var{%supported-systems}) | |
2489 | The list of systems supported by the package, as strings of the form | |
2490 | @code{architecture-kernel}, for example @code{"x86_64-linux"}. | |
2491 | ||
2492 | @item @code{maintainers} (default: @code{'()}) | |
2493 | The list of maintainers of the package, as @code{maintainer} objects. | |
2494 | ||
2495 | @item @code{location} (default: source location of the @code{package} form) | |
f97c9175 | 2496 | The source location of the package. It is useful to override this when |
87eafdbd TUBK |
2497 | inheriting from another package, in which case this field is not |
2498 | automatically corrected. | |
2499 | @end table | |
2500 | @end deftp | |
2501 | ||
2502 | ||
2503 | @node origin Reference | |
2504 | @subsection @code{origin} Reference | |
2505 | ||
2506 | This section summarizes all the options available in @code{origin} | |
2507 | declarations (@pxref{Defining Packages}). | |
2508 | ||
2509 | @deftp {Data Type} origin | |
2510 | This is the data type representing a source code origin. | |
2511 | ||
2512 | @table @asis | |
2513 | @item @code{uri} | |
2514 | An object containing the URI of the source. The object type depends on | |
2515 | the @code{method} (see below). For example, when using the | |
2516 | @var{url-fetch} method of @code{(guix download)}, the valid @code{uri} | |
2517 | values are: a URL represented as a string, or a list thereof. | |
2518 | ||
2519 | @item @code{method} | |
f97c9175 | 2520 | A procedure that handles the URI. |
87eafdbd TUBK |
2521 | |
2522 | Examples include: | |
2523 | ||
2524 | @table @asis | |
2525 | @item @var{url-fetch} from @code{(guix download)} | |
f97c9175 | 2526 | download a file from the HTTP, HTTPS, or FTP URL specified in the |
87eafdbd TUBK |
2527 | @code{uri} field; |
2528 | ||
2529 | @item @var{git-fetch} from @code{(guix git-download)} | |
2530 | clone the Git version control repository, and check out the revision | |
2531 | specified in the @code{uri} field as a @code{git-reference} object; a | |
2532 | @code{git-reference} looks like this: | |
2533 | ||
2534 | @example | |
2535 | (git-reference | |
2536 | (url "git://git.debian.org/git/pkg-shadow/shadow") | |
2537 | (commit "v4.1.5.1")) | |
2538 | @end example | |
2539 | @end table | |
2540 | ||
2541 | @item @code{sha256} | |
2542 | A bytevector containing the SHA-256 hash of the source. Typically the | |
2543 | @code{base32} form is used here to generate the bytevector from a | |
2544 | base-32 string. | |
2545 | ||
2546 | @item @code{file-name} (default: @code{#f}) | |
2547 | The file name under which the source code should be saved. When this is | |
2548 | @code{#f}, a sensible default value will be used in most cases. In case | |
2549 | the source is fetched from a URL, the file name from the URL will be | |
f97c9175 | 2550 | used. For version control checkouts, it is recommended to provide the |
87eafdbd TUBK |
2551 | file name explicitly because the default is not very descriptive. |
2552 | ||
2553 | @item @code{patches} (default: @code{'()}) | |
2554 | A list of file names containing patches to be applied to the source. | |
2555 | ||
2556 | @item @code{snippet} (default: @code{#f}) | |
2557 | A quoted piece of code that will be run in the source directory to make | |
2558 | any modifications, which is sometimes more convenient than a patch. | |
2559 | ||
2560 | @item @code{patch-flags} (default: @code{'("-p1")}) | |
2561 | A list of command-line flags that should be passed to the @code{patch} | |
2562 | command. | |
2563 | ||
2564 | @item @code{patch-inputs} (default: @code{#f}) | |
2565 | Input packages or derivations to the patching process. When this is | |
2566 | @code{#f}, the usual set of inputs necessary for patching are provided, | |
2567 | such as GNU@tie{}Patch. | |
2568 | ||
2569 | @item @code{modules} (default: @code{'()}) | |
2570 | A list of Guile modules that should be loaded during the patching | |
2571 | process and while running the code in the @code{snippet} field. | |
2572 | ||
2573 | @item @code{imported-modules} (default: @code{'()}) | |
2574 | The list of Guile modules to import in the patch derivation, for use by | |
2575 | the @code{snippet}. | |
2576 | ||
2577 | @item @code{patch-guile} (default: @code{#f}) | |
2578 | The Guile package that should be used in the patching process. When | |
2579 | this is @code{#f}, a sensible default is used. | |
2580 | @end table | |
2581 | @end deftp | |
2582 | ||
9c1edabd | 2583 | |
7458bd0a LC |
2584 | @node Build Systems |
2585 | @section Build Systems | |
2586 | ||
2587 | @cindex build system | |
2588 | Each package definition specifies a @dfn{build system} and arguments for | |
2589 | that build system (@pxref{Defining Packages}). This @code{build-system} | |
f97c9175 | 2590 | field represents the build procedure of the package, as well as implicit |
7458bd0a LC |
2591 | dependencies of that build procedure. |
2592 | ||
2593 | Build systems are @code{<build-system>} objects. The interface to | |
2594 | create and manipulate them is provided by the @code{(guix build-system)} | |
2595 | module, and actual build systems are exported by specific modules. | |
2596 | ||
f5fd4fd2 | 2597 | @cindex bag (low-level package representation) |
0d5a559f LC |
2598 | Under the hood, build systems first compile package objects to |
2599 | @dfn{bags}. A @dfn{bag} is like a package, but with less | |
2600 | ornamentation---in other words, a bag is a lower-level representation of | |
2601 | a package, which includes all the inputs of that package, including some | |
2602 | that were implicitly added by the build system. This intermediate | |
2603 | representation is then compiled to a derivation (@pxref{Derivations}). | |
2604 | ||
7458bd0a LC |
2605 | Build systems accept an optional list of @dfn{arguments}. In package |
2606 | definitions, these are passed @i{via} the @code{arguments} field | |
2607 | (@pxref{Defining Packages}). They are typically keyword arguments | |
2608 | (@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU | |
2609 | Guile Reference Manual}). The value of these arguments is usually | |
2610 | evaluated in the @dfn{build stratum}---i.e., by a Guile process launched | |
2611 | by the daemon (@pxref{Derivations}). | |
2612 | ||
2613 | The main build system is @var{gnu-build-system}, which implements the | |
f97c9175 | 2614 | standard build procedure for GNU and many other packages. It |
7458bd0a LC |
2615 | is provided by the @code{(guix build-system gnu)} module. |
2616 | ||
2617 | @defvr {Scheme Variable} gnu-build-system | |
2618 | @var{gnu-build-system} represents the GNU Build System, and variants | |
2619 | thereof (@pxref{Configuration, configuration and makefile conventions,, | |
2620 | standards, GNU Coding Standards}). | |
2621 | ||
2622 | @cindex build phases | |
f97c9175 | 2623 | In a nutshell, packages using it are configured, built, and installed with |
7458bd0a LC |
2624 | the usual @code{./configure && make && make check && make install} |
2625 | command sequence. In practice, a few additional steps are often needed. | |
2626 | All these steps are split up in separate @dfn{phases}, | |
2627 | notably@footnote{Please see the @code{(guix build gnu-build-system)} | |
2628 | modules for more details about the build phases.}: | |
2629 | ||
2630 | @table @code | |
2631 | @item unpack | |
2632 | Unpack the source tarball, and change the current directory to the | |
2633 | extracted source tree. If the source is actually a directory, copy it | |
2634 | to the build tree, and enter that directory. | |
2635 | ||
2636 | @item patch-source-shebangs | |
2637 | Patch shebangs encountered in source files so they refer to the right | |
2638 | store file names. For instance, this changes @code{#!/bin/sh} to | |
2639 | @code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}. | |
2640 | ||
2641 | @item configure | |
2642 | Run the @file{configure} script with a number of default options, such | |
2643 | as @code{--prefix=/gnu/store/@dots{}}, as well as the options specified | |
2644 | by the @code{#:configure-flags} argument. | |
2645 | ||
2646 | @item build | |
2647 | Run @code{make} with the list of flags specified with | |
0917e80e | 2648 | @code{#:make-flags}. If the @code{#:parallel-build?} argument is true |
7458bd0a LC |
2649 | (the default), build with @code{make -j}. |
2650 | ||
2651 | @item check | |
2652 | Run @code{make check}, or some other target specified with | |
2653 | @code{#:test-target}, unless @code{#:tests? #f} is passed. If the | |
2654 | @code{#:parallel-tests?} argument is true (the default), run @code{make | |
2655 | check -j}. | |
2656 | ||
2657 | @item install | |
2658 | Run @code{make install} with the flags listed in @code{#:make-flags}. | |
2659 | ||
2660 | @item patch-shebangs | |
2661 | Patch shebangs on the installed executable files. | |
2662 | ||
2663 | @item strip | |
2664 | Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} | |
2665 | is false), copying them to the @code{debug} output when available | |
2666 | (@pxref{Installing Debugging Files}). | |
2667 | @end table | |
2668 | ||
2669 | @vindex %standard-phases | |
2670 | The build-side module @code{(guix build gnu-build-system)} defines | |
2671 | @var{%standard-phases} as the default list of build phases. | |
2672 | @var{%standard-phases} is a list of symbol/procedure pairs, where the | |
2673 | procedure implements the actual phase. | |
2674 | ||
2675 | The list of phases used for a particular package can be changed with the | |
2676 | @code{#:phases} parameter. For instance, passing: | |
2677 | ||
2678 | @example | |
c2c5dc79 | 2679 | #:phases (modify-phases %standard-phases (delete 'configure)) |
7458bd0a LC |
2680 | @end example |
2681 | ||
9bf404e9 | 2682 | means that all the phases described above will be used, except the |
7458bd0a LC |
2683 | @code{configure} phase. |
2684 | ||
2685 | In addition, this build system ensures that the ``standard'' environment | |
2686 | for GNU packages is available. This includes tools such as GCC, libc, | |
2687 | Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix | |
f97c9175 AE |
2688 | build-system gnu)} module for a complete list). We call these the |
2689 | @dfn{implicit inputs} of a package, because package definitions do not | |
7458bd0a LC |
2690 | have to mention them. |
2691 | @end defvr | |
2692 | ||
2693 | Other @code{<build-system>} objects are defined to support other | |
2694 | conventions and tools used by free software packages. They inherit most | |
2695 | of @var{gnu-build-system}, and differ mainly in the set of inputs | |
2696 | implicitly added to the build process, and in the list of phases | |
2697 | executed. Some of these build systems are listed below. | |
2698 | ||
2699 | @defvr {Scheme Variable} cmake-build-system | |
2700 | This variable is exported by @code{(guix build-system cmake)}. It | |
2701 | implements the build procedure for packages using the | |
2702 | @url{http://www.cmake.org, CMake build tool}. | |
2703 | ||
2704 | It automatically adds the @code{cmake} package to the set of inputs. | |
2705 | Which package is used can be specified with the @code{#:cmake} | |
2706 | parameter. | |
9849cfc1 LC |
2707 | |
2708 | The @code{#:configure-flags} parameter is taken as a list of flags | |
2709 | passed to the @command{cmake} command. The @code{#:build-type} | |
2710 | parameter specifies in abstract terms the flags passed to the compiler; | |
2711 | it defaults to @code{"RelWithDebInfo"} (short for ``release mode with | |
2712 | debugging information''), which roughly means that code is compiled with | |
2713 | @code{-O2 -g}, as is the case for Autoconf-based packages by default. | |
7458bd0a LC |
2714 | @end defvr |
2715 | ||
3afcf52b FB |
2716 | @defvr {Scheme Variable} glib-or-gtk-build-system |
2717 | This variable is exported by @code{(guix build-system glib-or-gtk)}. It | |
2718 | is intended for use with packages making use of GLib or GTK+. | |
2719 | ||
2720 | This build system adds the following two phases to the ones defined by | |
2721 | @var{gnu-build-system}: | |
2722 | ||
2723 | @table @code | |
2724 | @item glib-or-gtk-wrap | |
f97c9175 AE |
2725 | The phase @code{glib-or-gtk-wrap} ensures that programs in |
2726 | @file{bin/} are able to find GLib ``schemas'' and | |
3afcf52b FB |
2727 | @uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ |
2728 | modules}. This is achieved by wrapping the programs in launch scripts | |
2729 | that appropriately set the @code{XDG_DATA_DIRS} and @code{GTK_PATH} | |
2730 | environment variables. | |
2731 | ||
73aa8ddb LC |
2732 | It is possible to exclude specific package outputs from that wrapping |
2733 | process by listing their names in the | |
2734 | @code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful | |
2735 | when an output is known not to contain any GLib or GTK+ binaries, and | |
2736 | where wrapping would gratuitously add a dependency of that output on | |
2737 | GLib and GTK+. | |
2738 | ||
3afcf52b | 2739 | @item glib-or-gtk-compile-schemas |
f97c9175 | 2740 | The phase @code{glib-or-gtk-compile-schemas} makes sure that all |
3afcf52b | 2741 | @uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, |
f97c9175 | 2742 | GSettings schemas} of GLib are compiled. Compilation is performed by the |
3afcf52b FB |
2743 | @command{glib-compile-schemas} program. It is provided by the package |
2744 | @code{glib:bin} which is automatically imported by the build system. | |
2745 | The @code{glib} package providing @command{glib-compile-schemas} can be | |
2746 | specified with the @code{#:glib} parameter. | |
2747 | @end table | |
2748 | ||
2749 | Both phases are executed after the @code{install} phase. | |
2750 | @end defvr | |
2751 | ||
7458bd0a LC |
2752 | @defvr {Scheme Variable} python-build-system |
2753 | This variable is exported by @code{(guix build-system python)}. It | |
2754 | implements the more or less standard build procedure used by Python | |
2755 | packages, which consists in running @code{python setup.py build} and | |
2756 | then @code{python setup.py install --prefix=/gnu/store/@dots{}}. | |
2757 | ||
2758 | For packages that install stand-alone Python programs under @code{bin/}, | |
f97c9175 | 2759 | it takes care of wrapping these programs so that their @code{PYTHONPATH} |
7458bd0a LC |
2760 | environment variable points to all the Python libraries they depend on. |
2761 | ||
2762 | Which Python package is used can be specified with the @code{#:python} | |
2763 | parameter. | |
2764 | @end defvr | |
2765 | ||
2766 | @defvr {Scheme Variable} perl-build-system | |
2767 | This variable is exported by @code{(guix build-system perl)}. It | |
2d2a53fc EB |
2768 | implements the standard build procedure for Perl packages, which either |
2769 | consists in running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, | |
2770 | followed by @code{Build} and @code{Build install}; or in running | |
2771 | @code{perl Makefile.PL PREFIX=/gnu/store/@dots{}}, followed by | |
f97c9175 | 2772 | @code{make} and @code{make install}, depending on which of |
2d2a53fc EB |
2773 | @code{Build.PL} or @code{Makefile.PL} is present in the package |
2774 | distribution. Preference is given to the former if both @code{Build.PL} | |
2775 | and @code{Makefile.PL} exist in the package distribution. This | |
2776 | preference can be reversed by specifying @code{#t} for the | |
2777 | @code{#:make-maker?} parameter. | |
2778 | ||
2779 | The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation | |
2780 | passes flags specified by the @code{#:make-maker-flags} or | |
2781 | @code{#:module-build-flags} parameter, respectively. | |
7458bd0a LC |
2782 | |
2783 | Which Perl package is used can be specified with @code{#:perl}. | |
2784 | @end defvr | |
2785 | ||
f8f3bef6 RW |
2786 | @defvr {Scheme Variable} r-build-system |
2787 | This variable is exported by @code{(guix build-system r)}. It | |
2788 | implements the build procedure used by @uref{http://r-project.org, R} | |
2789 | packages, which essentially is little more than running @code{R CMD | |
2790 | INSTALL --library=/gnu/store/@dots{}} in an environment where | |
2791 | @code{R_LIBS_SITE} contains the paths to all R package inputs. Tests | |
2792 | are run after installation using the R function | |
2793 | @code{tools::testInstalledPackage}. | |
2794 | @end defvr | |
2795 | ||
c08f9818 DT |
2796 | @defvr {Scheme Variable} ruby-build-system |
2797 | This variable is exported by @code{(guix build-system ruby)}. It | |
2798 | implements the RubyGems build procedure used by Ruby packages, which | |
2799 | involves running @code{gem build} followed by @code{gem install}. | |
2800 | ||
5dc87623 DT |
2801 | The @code{source} field of a package that uses this build system |
2802 | typically references a gem archive, since this is the format that Ruby | |
2803 | developers use when releasing their software. The build system unpacks | |
2804 | the gem archive, potentially patches the source, runs the test suite, | |
2805 | repackages the gem, and installs it. Additionally, directories and | |
2806 | tarballs may be referenced to allow building unreleased gems from Git or | |
2807 | a traditional source release tarball. | |
e83c6d00 | 2808 | |
c08f9818 | 2809 | Which Ruby package is used can be specified with the @code{#:ruby} |
6e9f2913 PP |
2810 | parameter. A list of additional flags to be passed to the @command{gem} |
2811 | command can be specified with the @code{#:gem-flags} parameter. | |
c08f9818 | 2812 | @end defvr |
7458bd0a | 2813 | |
a677c726 RW |
2814 | @defvr {Scheme Variable} waf-build-system |
2815 | This variable is exported by @code{(guix build-system waf)}. It | |
2816 | implements a build procedure around the @code{waf} script. The common | |
2817 | phases---@code{configure}, @code{build}, and @code{install}---are | |
2818 | implemented by passing their names as arguments to the @code{waf} | |
2819 | script. | |
2820 | ||
2821 | The @code{waf} script is executed by the Python interpreter. Which | |
2822 | Python package is used to run the script can be specified with the | |
2823 | @code{#:python} parameter. | |
2824 | @end defvr | |
2825 | ||
14dfdf2e FB |
2826 | @defvr {Scheme Variable} haskell-build-system |
2827 | This variable is exported by @code{(guix build-system haskell)}. It | |
2828 | implements the Cabal build procedure used by Haskell packages, which | |
2829 | involves running @code{runhaskell Setup.hs configure | |
2830 | --prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. | |
2831 | Instead of installing the package by running @code{runhaskell Setup.hs | |
2832 | install}, to avoid trying to register libraries in the read-only | |
2833 | compiler store directory, the build system uses @code{runhaskell | |
2834 | Setup.hs copy}, followed by @code{runhaskell Setup.hs register}. In | |
2835 | addition, the build system generates the package documentation by | |
2836 | running @code{runhaskell Setup.hs haddock}, unless @code{#:haddock? #f} | |
2837 | is passed. Optional Haddock parameters can be passed with the help of | |
2838 | the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} is | |
2839 | not found, the build system looks for @code{Setup.lhs} instead. | |
2840 | ||
2841 | Which Haskell compiler is used can be specified with the @code{#:haskell} | |
a54bd6d7 | 2842 | parameter which defaults to @code{ghc}. |
14dfdf2e FB |
2843 | @end defvr |
2844 | ||
e9137a53 FB |
2845 | @defvr {Scheme Variable} emacs-build-system |
2846 | This variable is exported by @code{(guix build-system emacs)}. It | |
f97c9175 AE |
2847 | implements an installation procedure similar to the packaging system |
2848 | of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual}). | |
e9137a53 FB |
2849 | |
2850 | It first creates the @code{@var{package}-autoloads.el} file, then it | |
2851 | byte compiles all Emacs Lisp files. Differently from the Emacs | |
2852 | packaging system, the Info documentation files are moved to the standard | |
2853 | documentation directory and the @file{dir} file is deleted. Each | |
2854 | package is installed in its own directory under | |
2855 | @file{share/emacs/site-lisp/guix.d}. | |
2856 | @end defvr | |
2857 | ||
7458bd0a LC |
2858 | Lastly, for packages that do not need anything as sophisticated, a |
2859 | ``trivial'' build system is provided. It is trivial in the sense that | |
2860 | it provides basically no support: it does not pull any implicit inputs, | |
2861 | and does not have a notion of build phases. | |
2862 | ||
2863 | @defvr {Scheme Variable} trivial-build-system | |
2864 | This variable is exported by @code{(guix build-system trivial)}. | |
2865 | ||
2866 | This build system requires a @code{#:builder} argument. This argument | |
f97c9175 | 2867 | must be a Scheme expression that builds the package output(s)---as |
7458bd0a LC |
2868 | with @code{build-expression->derivation} (@pxref{Derivations, |
2869 | @code{build-expression->derivation}}). | |
2870 | @end defvr | |
2871 | ||
568717fd LC |
2872 | @node The Store |
2873 | @section The Store | |
2874 | ||
e531ac2a LC |
2875 | @cindex store |
2876 | @cindex store paths | |
2877 | ||
f97c9175 AE |
2878 | Conceptually, the @dfn{store} is the place where derivations that have |
2879 | been built successfully are stored---by default, @file{/gnu/store}. | |
e531ac2a | 2880 | Sub-directories in the store are referred to as @dfn{store paths}. The |
4988dd40 | 2881 | store has an associated database that contains information such as the |
e531ac2a LC |
2882 | store paths referred to by each store path, and the list of @emph{valid} |
2883 | store paths---paths that result from a successful build. | |
2884 | ||
2885 | The store is always accessed by the daemon on behalf of its clients | |
2886 | (@pxref{Invoking guix-daemon}). To manipulate the store, clients | |
f97c9175 AE |
2887 | connect to the daemon over a Unix-domain socket, send requests to it, |
2888 | and read the result---these are remote procedure calls, or RPCs. | |
e531ac2a LC |
2889 | |
2890 | The @code{(guix store)} module provides procedures to connect to the | |
2891 | daemon, and to perform RPCs. These are described below. | |
2892 | ||
2893 | @deffn {Scheme Procedure} open-connection [@var{file}] [#:reserve-space? #t] | |
2894 | Connect to the daemon over the Unix-domain socket at @var{file}. When | |
2895 | @var{reserve-space?} is true, instruct it to reserve a little bit of | |
2896 | extra space on the file system so that the garbage collector can still | |
f97c9175 | 2897 | operate should the disk become full. Return a server object. |
e531ac2a LC |
2898 | |
2899 | @var{file} defaults to @var{%default-socket-path}, which is the normal | |
2900 | location given the options that were passed to @command{configure}. | |
2901 | @end deffn | |
2902 | ||
2903 | @deffn {Scheme Procedure} close-connection @var{server} | |
2904 | Close the connection to @var{server}. | |
2905 | @end deffn | |
2906 | ||
2907 | @defvr {Scheme Variable} current-build-output-port | |
2908 | This variable is bound to a SRFI-39 parameter, which refers to the port | |
2909 | where build and error logs sent by the daemon should be written. | |
2910 | @end defvr | |
2911 | ||
2912 | Procedures that make RPCs all take a server object as their first | |
2913 | argument. | |
2914 | ||
2915 | @deffn {Scheme Procedure} valid-path? @var{server} @var{path} | |
06b76acc LC |
2916 | @cindex invalid store items |
2917 | Return @code{#t} when @var{path} designates a valid store item and | |
2918 | @code{#f} otherwise (an invalid item may exist on disk but still be | |
2919 | invalid, for instance because it is the result of an aborted or failed | |
2920 | build.) | |
2921 | ||
2922 | A @code{&nix-protocol-error} condition is raised if @var{path} is not | |
2923 | prefixed by the store directory (@file{/gnu/store}). | |
e531ac2a LC |
2924 | @end deffn |
2925 | ||
cfbf9160 | 2926 | @deffn {Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}] |
e531ac2a LC |
2927 | Add @var{text} under file @var{name} in the store, and return its store |
2928 | path. @var{references} is the list of store paths referred to by the | |
2929 | resulting store path. | |
2930 | @end deffn | |
2931 | ||
874e6874 | 2932 | @deffn {Scheme Procedure} build-derivations @var{server} @var{derivations} |
59688fc4 LC |
2933 | Build @var{derivations} (a list of @code{<derivation>} objects or |
2934 | derivation paths), and return when the worker is done building them. | |
2935 | Return @code{#t} on success. | |
874e6874 LC |
2936 | @end deffn |
2937 | ||
b860f382 LC |
2938 | Note that the @code{(guix monads)} module provides a monad as well as |
2939 | monadic versions of the above procedures, with the goal of making it | |
2940 | more convenient to work with code that accesses the store (@pxref{The | |
2941 | Store Monad}). | |
2942 | ||
e531ac2a LC |
2943 | @c FIXME |
2944 | @i{This section is currently incomplete.} | |
568717fd LC |
2945 | |
2946 | @node Derivations | |
2947 | @section Derivations | |
2948 | ||
874e6874 LC |
2949 | @cindex derivations |
2950 | Low-level build actions and the environment in which they are performed | |
2951 | are represented by @dfn{derivations}. A derivation contain the | |
2952 | following pieces of information: | |
2953 | ||
2954 | @itemize | |
2955 | @item | |
2956 | The outputs of the derivation---derivations produce at least one file or | |
2957 | directory in the store, but may produce more. | |
2958 | ||
2959 | @item | |
2960 | The inputs of the derivations, which may be other derivations or plain | |
2961 | files in the store (patches, build scripts, etc.) | |
2962 | ||
2963 | @item | |
2964 | The system type targeted by the derivation---e.g., @code{x86_64-linux}. | |
2965 | ||
2966 | @item | |
2967 | The file name of a build script in the store, along with the arguments | |
2968 | to be passed. | |
2969 | ||
2970 | @item | |
2971 | A list of environment variables to be defined. | |
2972 | ||
2973 | @end itemize | |
2974 | ||
2975 | @cindex derivation path | |
2976 | Derivations allow clients of the daemon to communicate build actions to | |
2977 | the store. They exist in two forms: as an in-memory representation, | |
2978 | both on the client- and daemon-side, and as files in the store whose | |
2979 | name end in @code{.drv}---these files are referred to as @dfn{derivation | |
2980 | paths}. Derivations paths can be passed to the @code{build-derivations} | |
2981 | procedure to perform the build actions they prescribe (@pxref{The | |
2982 | Store}). | |
2983 | ||
2984 | The @code{(guix derivations)} module provides a representation of | |
2985 | derivations as Scheme objects, along with procedures to create and | |
2986 | otherwise manipulate derivations. The lowest-level primitive to create | |
2987 | a derivation is the @code{derivation} procedure: | |
2988 | ||
1909431c LC |
2989 | @deffn {Scheme Procedure} derivation @var{store} @var{name} @var{builder} @ |
2990 | @var{args} [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | |
2096ef47 | 2991 | [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ |
1909431c | 2992 | [#:system (%current-system)] [#:references-graphs #f] @ |
4a6aeb67 LC |
2993 | [#:allowed-references #f] [#:leaked-env-vars #f] [#:local-build? #f] @ |
2994 | [#:substitutable? #t] | |
59688fc4 LC |
2995 | Build a derivation with the given arguments, and return the resulting |
2996 | @code{<derivation>} object. | |
874e6874 | 2997 | |
2096ef47 | 2998 | When @var{hash} and @var{hash-algo} are given, a |
874e6874 | 2999 | @dfn{fixed-output derivation} is created---i.e., one whose result is |
36bbbbd1 LC |
3000 | known in advance, such as a file download. If, in addition, |
3001 | @var{recursive?} is true, then that fixed output may be an executable | |
3002 | file or a directory and @var{hash} must be the hash of an archive | |
3003 | containing this output. | |
5b0c9d16 | 3004 | |
858e9282 | 3005 | When @var{references-graphs} is true, it must be a list of file |
5b0c9d16 LC |
3006 | name/store path pairs. In that case, the reference graph of each store |
3007 | path is exported in the build environment in the corresponding file, in | |
3008 | a simple text format. | |
1909431c | 3009 | |
b53be755 LC |
3010 | When @var{allowed-references} is true, it must be a list of store items |
3011 | or outputs that the derivation's output may refer to. | |
3012 | ||
c0468155 LC |
3013 | When @var{leaked-env-vars} is true, it must be a list of strings |
3014 | denoting environment variables that are allowed to ``leak'' from the | |
3015 | daemon's environment to the build environment. This is only applicable | |
3016 | to fixed-output derivations---i.e., when @var{hash} is true. The main | |
3017 | use is to allow variables such as @code{http_proxy} to be passed to | |
3018 | derivations that download files. | |
3019 | ||
1909431c LC |
3020 | When @var{local-build?} is true, declare that the derivation is not a |
3021 | good candidate for offloading and should rather be built locally | |
3022 | (@pxref{Daemon Offload Setup}). This is the case for small derivations | |
3023 | where the costs of data transfers would outweigh the benefits. | |
4a6aeb67 LC |
3024 | |
3025 | When @var{substitutable?} is false, declare that substitutes of the | |
3026 | derivation's output should not be used (@pxref{Substitutes}). This is | |
3027 | useful, for instance, when building packages that capture details of the | |
3028 | host CPU instruction set. | |
874e6874 LC |
3029 | @end deffn |
3030 | ||
3031 | @noindent | |
3032 | Here's an example with a shell script as its builder, assuming | |
3033 | @var{store} is an open connection to the daemon, and @var{bash} points | |
3034 | to a Bash executable in the store: | |
3035 | ||
3036 | @lisp | |
3037 | (use-modules (guix utils) | |
3038 | (guix store) | |
3039 | (guix derivations)) | |
3040 | ||
59688fc4 LC |
3041 | (let ((builder ; add the Bash script to the store |
3042 | (add-text-to-store store "my-builder.sh" | |
3043 | "echo hello world > $out\n" '()))) | |
3044 | (derivation store "foo" | |
3045 | bash `("-e" ,builder) | |
21b679f6 | 3046 | #:inputs `((,bash) (,builder)) |
59688fc4 | 3047 | #:env-vars '(("HOME" . "/homeless")))) |
834129e0 | 3048 | @result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo> |
874e6874 LC |
3049 | @end lisp |
3050 | ||
21b679f6 LC |
3051 | As can be guessed, this primitive is cumbersome to use directly. A |
3052 | better approach is to write build scripts in Scheme, of course! The | |
3053 | best course of action for that is to write the build code as a | |
3054 | ``G-expression'', and to pass it to @code{gexp->derivation}. For more | |
6621cdb6 | 3055 | information, @pxref{G-Expressions}. |
21b679f6 | 3056 | |
f2fadbc1 AE |
3057 | Once upon a time, @code{gexp->derivation} did not exist and constructing |
3058 | derivations with build code written in Scheme was achieved with | |
3059 | @code{build-expression->derivation}, documented below. This procedure | |
3060 | is now deprecated in favor of the much nicer @code{gexp->derivation}. | |
3061 | ||
3062 | @deffn {Scheme Procedure} build-expression->derivation @var{store} @ | |
3063 | @var{name} @var{exp} @ | |
3064 | [#:system (%current-system)] [#:inputs '()] @ | |
3065 | [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ | |
3066 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ | |
3067 | [#:references-graphs #f] [#:allowed-references #f] @ | |
3068 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] | |
3069 | Return a derivation that executes Scheme expression @var{exp} as a | |
3070 | builder for derivation @var{name}. @var{inputs} must be a list of | |
3071 | @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, | |
3072 | @code{"out"} is assumed. @var{modules} is a list of names of Guile | |
3073 | modules from the current search path to be copied in the store, | |
3074 | compiled, and made available in the load path during the execution of | |
3075 | @var{exp}---e.g., @code{((guix build utils) (guix build | |
3076 | gnu-build-system))}. | |
3077 | ||
3078 | @var{exp} is evaluated in an environment where @code{%outputs} is bound | |
3079 | to a list of output/path pairs, and where @code{%build-inputs} is bound | |
3080 | to a list of string/output-path pairs made from @var{inputs}. | |
3081 | Optionally, @var{env-vars} is a list of string pairs specifying the name | |
3082 | and value of environment variables visible to the builder. The builder | |
3083 | terminates by passing the result of @var{exp} to @code{exit}; thus, when | |
3084 | @var{exp} returns @code{#f}, the build is considered to have failed. | |
3085 | ||
3086 | @var{exp} is built using @var{guile-for-build} (a derivation). When | |
3087 | @var{guile-for-build} is omitted or is @code{#f}, the value of the | |
3088 | @code{%guile-for-build} fluid is used instead. | |
3089 | ||
3090 | See the @code{derivation} procedure for the meaning of | |
3091 | @var{references-graphs}, @var{allowed-references}, @var{local-build?}, | |
3092 | and @var{substitutable?}. | |
3093 | @end deffn | |
3094 | ||
3095 | @noindent | |
3096 | Here's an example of a single-output derivation that creates a directory | |
3097 | containing one file: | |
3098 | ||
3099 | @lisp | |
3100 | (let ((builder '(let ((out (assoc-ref %outputs "out"))) | |
3101 | (mkdir out) ; create /gnu/store/@dots{}-goo | |
3102 | (call-with-output-file (string-append out "/test") | |
3103 | (lambda (p) | |
3104 | (display '(hello guix) p)))))) | |
3105 | (build-expression->derivation store "goo" builder)) | |
3106 | ||
3107 | @result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}> | |
3108 | @end lisp | |
3109 | ||
568717fd | 3110 | |
b860f382 LC |
3111 | @node The Store Monad |
3112 | @section The Store Monad | |
3113 | ||
3114 | @cindex monad | |
3115 | ||
3116 | The procedures that operate on the store described in the previous | |
3117 | sections all take an open connection to the build daemon as their first | |
3118 | argument. Although the underlying model is functional, they either have | |
3119 | side effects or depend on the current state of the store. | |
3120 | ||
3121 | The former is inconvenient: the connection to the build daemon has to be | |
3122 | carried around in all those functions, making it impossible to compose | |
3123 | functions that do not take that parameter with functions that do. The | |
3124 | latter can be problematic: since store operations have side effects | |
3125 | and/or depend on external state, they have to be properly sequenced. | |
3126 | ||
3127 | @cindex monadic values | |
3128 | @cindex monadic functions | |
3129 | This is where the @code{(guix monads)} module comes in. This module | |
3130 | provides a framework for working with @dfn{monads}, and a particularly | |
3131 | useful monad for our uses, the @dfn{store monad}. Monads are a | |
3132 | construct that allows two things: associating ``context'' with values | |
3133 | (in our case, the context is the store), and building sequences of | |
561fb6c3 | 3134 | computations (here computations include accesses to the store.) Values |
b860f382 LC |
3135 | in a monad---values that carry this additional context---are called |
3136 | @dfn{monadic values}; procedures that return such values are called | |
3137 | @dfn{monadic procedures}. | |
3138 | ||
3139 | Consider this ``normal'' procedure: | |
3140 | ||
3141 | @example | |
45adbd62 LC |
3142 | (define (sh-symlink store) |
3143 | ;; Return a derivation that symlinks the 'bash' executable. | |
3144 | (let* ((drv (package-derivation store bash)) | |
3145 | (out (derivation->output-path drv)) | |
3146 | (sh (string-append out "/bin/bash"))) | |
3147 | (build-expression->derivation store "sh" | |
3148 | `(symlink ,sh %output)))) | |
b860f382 LC |
3149 | @end example |
3150 | ||
c6f30b81 LC |
3151 | Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten |
3152 | as a monadic function: | |
b860f382 LC |
3153 | |
3154 | @example | |
45adbd62 | 3155 | (define (sh-symlink) |
b860f382 | 3156 | ;; Same, but return a monadic value. |
c6f30b81 LC |
3157 | (mlet %store-monad ((drv (package->derivation bash))) |
3158 | (gexp->derivation "sh" | |
3159 | #~(symlink (string-append #$drv "/bin/bash") | |
3160 | #$output)))) | |
b860f382 LC |
3161 | @end example |
3162 | ||
c6f30b81 LC |
3163 | There several things to note in the second version: the @code{store} |
3164 | parameter is now implicit and is ``threaded'' in the calls to the | |
3165 | @code{package->derivation} and @code{gexp->derivation} monadic | |
3166 | procedures, and the monadic value returned by @code{package->derivation} | |
3167 | is @dfn{bound} using @code{mlet} instead of plain @code{let}. | |
3168 | ||
3169 | As it turns out, the call to @code{package->derivation} can even be | |
3170 | omitted since it will take place implicitly, as we will see later | |
3171 | (@pxref{G-Expressions}): | |
3172 | ||
3173 | @example | |
3174 | (define (sh-symlink) | |
3175 | (gexp->derivation "sh" | |
3176 | #~(symlink (string-append #$bash "/bin/bash") | |
3177 | #$output))) | |
3178 | @end example | |
b860f382 | 3179 | |
7ce21611 LC |
3180 | @c See |
3181 | @c <https://syntaxexclamation.wordpress.com/2014/06/26/escaping-continuations/> | |
3182 | @c for the funny quote. | |
3183 | Calling the monadic @code{sh-symlink} has no effect. As someone once | |
3184 | said, ``you exit a monad like you exit a building on fire: by running''. | |
3185 | So, to exit the monad and get the desired effect, one must use | |
3186 | @code{run-with-store}: | |
b860f382 LC |
3187 | |
3188 | @example | |
8e9aa37f CAW |
3189 | (run-with-store (open-connection) (sh-symlink)) |
3190 | @result{} /gnu/store/...-sh-symlink | |
b860f382 LC |
3191 | @end example |
3192 | ||
f97c9175 | 3193 | Note that the @code{(guix monad-repl)} module extends the Guile REPL with |
b9b86078 | 3194 | new ``meta-commands'' to make it easier to deal with monadic procedures: |
f97c9175 | 3195 | @code{run-in-store}, and @code{enter-store-monad}. The former is used |
b9b86078 LC |
3196 | to ``run'' a single monadic value through the store: |
3197 | ||
3198 | @example | |
3199 | scheme@@(guile-user)> ,run-in-store (package->derivation hello) | |
3200 | $1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> | |
3201 | @end example | |
3202 | ||
3203 | The latter enters a recursive REPL, where all the return values are | |
3204 | automatically run through the store: | |
3205 | ||
3206 | @example | |
3207 | scheme@@(guile-user)> ,enter-store-monad | |
3208 | store-monad@@(guile-user) [1]> (package->derivation hello) | |
3209 | $2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> | |
3210 | store-monad@@(guile-user) [1]> (text-file "foo" "Hello!") | |
3211 | $3 = "/gnu/store/@dots{}-foo" | |
3212 | store-monad@@(guile-user) [1]> ,q | |
3213 | scheme@@(guile-user)> | |
3214 | @end example | |
3215 | ||
3216 | @noindent | |
3217 | Note that non-monadic values cannot be returned in the | |
3218 | @code{store-monad} REPL. | |
3219 | ||
e87f0591 LC |
3220 | The main syntactic forms to deal with monads in general are provided by |
3221 | the @code{(guix monads)} module and are described below. | |
b860f382 LC |
3222 | |
3223 | @deffn {Scheme Syntax} with-monad @var{monad} @var{body} ... | |
3224 | Evaluate any @code{>>=} or @code{return} forms in @var{body} as being | |
3225 | in @var{monad}. | |
3226 | @end deffn | |
3227 | ||
3228 | @deffn {Scheme Syntax} return @var{val} | |
3229 | Return a monadic value that encapsulates @var{val}. | |
3230 | @end deffn | |
3231 | ||
751630c9 | 3232 | @deffn {Scheme Syntax} >>= @var{mval} @var{mproc} ... |
b860f382 | 3233 | @dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic |
751630c9 LC |
3234 | procedures @var{mproc}@dots{}@footnote{This operation is commonly |
3235 | referred to as ``bind'', but that name denotes an unrelated procedure in | |
3236 | Guile. Thus we use this somewhat cryptic symbol inherited from the | |
3237 | Haskell language.}. There can be one @var{mproc} or several of them, as | |
3238 | in this example: | |
3239 | ||
3240 | @example | |
3241 | (run-with-state | |
3242 | (with-monad %state-monad | |
3243 | (>>= (return 1) | |
3244 | (lambda (x) (return (+ 1 x))) | |
3245 | (lambda (x) (return (* 2 x))))) | |
3246 | 'some-state) | |
3247 | ||
3248 | @result{} 4 | |
3249 | @result{} some-state | |
3250 | @end example | |
b860f382 LC |
3251 | @end deffn |
3252 | ||
3253 | @deffn {Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @ | |
3254 | @var{body} ... | |
3255 | @deffnx {Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @ | |
3256 | @var{body} ... | |
3257 | Bind the variables @var{var} to the monadic values @var{mval} in | |
3258 | @var{body}. The form (@var{var} -> @var{val}) binds @var{var} to the | |
3259 | ``normal'' value @var{val}, as per @code{let}. | |
3260 | ||
3261 | @code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} | |
3262 | (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual}). | |
3263 | @end deffn | |
3264 | ||
405a9d4e LC |
3265 | @deffn {Scheme System} mbegin @var{monad} @var{mexp} ... |
3266 | Bind @var{mexp} and the following monadic expressions in sequence, | |
3267 | returning the result of the last expression. | |
3268 | ||
3269 | This is akin to @code{mlet}, except that the return values of the | |
3270 | monadic expressions are ignored. In that sense, it is analogous to | |
3271 | @code{begin}, but applied to monadic expressions. | |
3272 | @end deffn | |
3273 | ||
561fb6c3 LC |
3274 | @cindex state monad |
3275 | The @code{(guix monads)} module provides the @dfn{state monad}, which | |
3276 | allows an additional value---the state---to be @emph{threaded} through | |
3277 | monadic procedure calls. | |
3278 | ||
3279 | @defvr {Scheme Variable} %state-monad | |
3280 | The state monad. Procedures in the state monad can access and change | |
3281 | the state that is threaded. | |
3282 | ||
3283 | Consider the example below. The @code{square} procedure returns a value | |
3284 | in the state monad. It returns the square of its argument, but also | |
3285 | increments the current state value: | |
3286 | ||
3287 | @example | |
3288 | (define (square x) | |
3289 | (mlet %state-monad ((count (current-state))) | |
3290 | (mbegin %state-monad | |
3291 | (set-current-state (+ 1 count)) | |
3292 | (return (* x x))))) | |
3293 | ||
3294 | (run-with-state (sequence %state-monad (map square (iota 3))) 0) | |
3295 | @result{} (0 1 4) | |
3296 | @result{} 3 | |
3297 | @end example | |
3298 | ||
3299 | When ``run'' through @var{%state-monad}, we obtain that additional state | |
3300 | value, which is the number of @code{square} calls. | |
3301 | @end defvr | |
3302 | ||
3303 | @deffn {Monadic Procedure} current-state | |
3304 | Return the current state as a monadic value. | |
3305 | @end deffn | |
3306 | ||
3307 | @deffn {Monadic Procedure} set-current-state @var{value} | |
3308 | Set the current state to @var{value} and return the previous state as a | |
3309 | monadic value. | |
3310 | @end deffn | |
3311 | ||
3312 | @deffn {Monadic Procedure} state-push @var{value} | |
3313 | Push @var{value} to the current state, which is assumed to be a list, | |
3314 | and return the previous state as a monadic value. | |
3315 | @end deffn | |
3316 | ||
3317 | @deffn {Monadic Procedure} state-pop | |
3318 | Pop a value from the current state and return it as a monadic value. | |
3319 | The state is assumed to be a list. | |
3320 | @end deffn | |
3321 | ||
3322 | @deffn {Scheme Procedure} run-with-state @var{mval} [@var{state}] | |
3323 | Run monadic value @var{mval} starting with @var{state} as the initial | |
3324 | state. Return two values: the resulting value, and the resulting state. | |
3325 | @end deffn | |
3326 | ||
e87f0591 LC |
3327 | The main interface to the store monad, provided by the @code{(guix |
3328 | store)} module, is as follows. | |
b860f382 LC |
3329 | |
3330 | @defvr {Scheme Variable} %store-monad | |
561fb6c3 LC |
3331 | The store monad---an alias for @var{%state-monad}. |
3332 | ||
3333 | Values in the store monad encapsulate accesses to the store. When its | |
3334 | effect is needed, a value of the store monad must be ``evaluated'' by | |
3335 | passing it to the @code{run-with-store} procedure (see below.) | |
b860f382 LC |
3336 | @end defvr |
3337 | ||
3338 | @deffn {Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)] | |
3339 | Run @var{mval}, a monadic value in the store monad, in @var{store}, an | |
3340 | open store connection. | |
3341 | @end deffn | |
3342 | ||
ad372953 | 3343 | @deffn {Monadic Procedure} text-file @var{name} @var{text} [@var{references}] |
b860f382 | 3344 | Return as a monadic value the absolute file name in the store of the file |
ad372953 LC |
3345 | containing @var{text}, a string. @var{references} is a list of store items that the |
3346 | resulting text file refers to; it defaults to the empty list. | |
45adbd62 LC |
3347 | @end deffn |
3348 | ||
0a90af15 LC |
3349 | @deffn {Monadic Procedure} interned-file @var{file} [@var{name}] @ |
3350 | [#:recursive? #t] | |
3351 | Return the name of @var{file} once interned in the store. Use | |
3352 | @var{name} as its store name, or the basename of @var{file} if | |
3353 | @var{name} is omitted. | |
3354 | ||
3355 | When @var{recursive?} is true, the contents of @var{file} are added | |
3356 | recursively; if @var{file} designates a flat file and @var{recursive?} | |
3357 | is true, its contents are added, and its permission bits are kept. | |
3358 | ||
3359 | The example below adds a file to the store, under two different names: | |
3360 | ||
3361 | @example | |
3362 | (run-with-store (open-connection) | |
3363 | (mlet %store-monad ((a (interned-file "README")) | |
3364 | (b (interned-file "README" "LEGU-MIN"))) | |
3365 | (return (list a b)))) | |
3366 | ||
3367 | @result{} ("/gnu/store/rwm@dots{}-README" "/gnu/store/44i@dots{}-LEGU-MIN") | |
3368 | @end example | |
3369 | ||
3370 | @end deffn | |
3371 | ||
e87f0591 LC |
3372 | The @code{(guix packages)} module exports the following package-related |
3373 | monadic procedures: | |
3374 | ||
b860f382 | 3375 | @deffn {Monadic Procedure} package-file @var{package} [@var{file}] @ |
4231f05b | 3376 | [#:system (%current-system)] [#:target #f] @ |
f97c9175 AE |
3377 | [#:output "out"] |
3378 | Return as a monadic | |
b860f382 LC |
3379 | value in the absolute file name of @var{file} within the @var{output} |
3380 | directory of @var{package}. When @var{file} is omitted, return the name | |
4231f05b LC |
3381 | of the @var{output} directory of @var{package}. When @var{target} is |
3382 | true, use it as a cross-compilation target triplet. | |
b860f382 LC |
3383 | @end deffn |
3384 | ||
b860f382 | 3385 | @deffn {Monadic Procedure} package->derivation @var{package} [@var{system}] |
4231f05b LC |
3386 | @deffnx {Monadic Procedure} package->cross-derivation @var{package} @ |
3387 | @var{target} [@var{system}] | |
3388 | Monadic version of @code{package-derivation} and | |
3389 | @code{package-cross-derivation} (@pxref{Defining Packages}). | |
b860f382 LC |
3390 | @end deffn |
3391 | ||
3392 | ||
21b679f6 LC |
3393 | @node G-Expressions |
3394 | @section G-Expressions | |
3395 | ||
3396 | @cindex G-expression | |
3397 | @cindex build code quoting | |
3398 | So we have ``derivations'', which represent a sequence of build actions | |
3399 | to be performed to produce an item in the store (@pxref{Derivations}). | |
f97c9175 | 3400 | These build actions are performed when asking the daemon to actually |
21b679f6 LC |
3401 | build the derivations; they are run by the daemon in a container |
3402 | (@pxref{Invoking guix-daemon}). | |
3403 | ||
3404 | @cindex strata of code | |
f97c9175 | 3405 | It should come as no surprise that we like to write these build actions |
21b679f6 LC |
3406 | in Scheme. When we do that, we end up with two @dfn{strata} of Scheme |
3407 | code@footnote{The term @dfn{stratum} in this context was coined by | |
ef4ab0a4 LC |
3408 | Manuel Serrano et al.@: in the context of their work on Hop. Oleg |
3409 | Kiselyov, who has written insightful | |
3410 | @url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code | |
3411 | on this topic}, refers to this kind of code generation as | |
3412 | @dfn{staging}.}: the ``host code''---code that defines packages, talks | |
3413 | to the daemon, etc.---and the ``build code''---code that actually | |
3414 | performs build actions, such as making directories, invoking | |
3415 | @command{make}, etc. | |
21b679f6 LC |
3416 | |
3417 | To describe a derivation and its build actions, one typically needs to | |
3418 | embed build code inside host code. It boils down to manipulating build | |
f97c9175 | 3419 | code as data, and the homoiconicity of Scheme---code has a direct |
21b679f6 | 3420 | representation as data---comes in handy for that. But we need more than |
f97c9175 | 3421 | the normal @code{quasiquote} mechanism in Scheme to construct build |
21b679f6 LC |
3422 | expressions. |
3423 | ||
3424 | The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of | |
3425 | S-expressions adapted to build expressions. G-expressions, or | |
f97c9175 | 3426 | @dfn{gexps}, consist essentially of three syntactic forms: @code{gexp}, |
21b679f6 | 3427 | @code{ungexp}, and @code{ungexp-splicing} (or simply: @code{#~}, |
f97c9175 AE |
3428 | @code{#$}, and @code{#$@@}), which are comparable to |
3429 | @code{quasiquote}, @code{unquote}, and @code{unquote-splicing}, | |
3430 | respectivel (@pxref{Expression Syntax, @code{quasiquote},, guile, | |
3431 | GNU Guile Reference Manual}). However, there are major differences: | |
21b679f6 LC |
3432 | |
3433 | @itemize | |
3434 | @item | |
3435 | Gexps are meant to be written to a file and run or manipulated by other | |
3436 | processes. | |
3437 | ||
3438 | @item | |
b39fc6f7 LC |
3439 | When a high-level object such as a package or derivation is unquoted |
3440 | inside a gexp, the result is as if its output file name had been | |
3441 | introduced. | |
ff40e9b7 | 3442 | |
21b679f6 LC |
3443 | @item |
3444 | Gexps carry information about the packages or derivations they refer to, | |
3445 | and these dependencies are automatically added as inputs to the build | |
3446 | processes that use them. | |
3447 | @end itemize | |
3448 | ||
c2b84676 | 3449 | @cindex lowering, of high-level objects in gexps |
343eacbe LC |
3450 | This mechanism is not limited to package and derivation |
3451 | objects: @dfn{compilers} able to ``lower'' other high-level objects to | |
c2b84676 LC |
3452 | derivations or files in the store can be defined, |
3453 | such that these objects can also be inserted | |
f97c9175 | 3454 | into gexps. For example, a useful type of high-level objects that can be |
343eacbe | 3455 | inserted in a gexp is ``file-like objects'', which make it easy to |
f97c9175 | 3456 | add files to the store and to refer to them in |
558e8b11 LC |
3457 | derivations and such (see @code{local-file} and @code{plain-file} |
3458 | below.) | |
b39fc6f7 | 3459 | |
21b679f6 LC |
3460 | To illustrate the idea, here is an example of a gexp: |
3461 | ||
3462 | @example | |
3463 | (define build-exp | |
3464 | #~(begin | |
3465 | (mkdir #$output) | |
3466 | (chdir #$output) | |
aff8ce7c | 3467 | (symlink (string-append #$coreutils "/bin/ls") |
21b679f6 LC |
3468 | "list-files"))) |
3469 | @end example | |
3470 | ||
3471 | This gexp can be passed to @code{gexp->derivation}; we obtain a | |
3472 | derivation that builds a directory containing exactly one symlink to | |
3473 | @file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}: | |
3474 | ||
3475 | @example | |
3476 | (gexp->derivation "the-thing" build-exp) | |
3477 | @end example | |
3478 | ||
e20fd1bf | 3479 | As one would expect, the @code{"/gnu/store/@dots{}-coreutils-8.22"} string is |
21b679f6 LC |
3480 | substituted to the reference to the @var{coreutils} package in the |
3481 | actual build code, and @var{coreutils} is automatically made an input to | |
3482 | the derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp | |
f97c9175 AE |
3483 | output)}) is replaced by a string containing the directory name of the |
3484 | output of the derivation. | |
667b2508 LC |
3485 | |
3486 | @cindex cross compilation | |
3487 | In a cross-compilation context, it is useful to distinguish between | |
3488 | references to the @emph{native} build of a package---that can run on the | |
3489 | host---versus references to cross builds of a package. To that end, the | |
3490 | @code{#+} plays the same role as @code{#$}, but is a reference to a | |
3491 | native package build: | |
3492 | ||
3493 | @example | |
3494 | (gexp->derivation "vi" | |
3495 | #~(begin | |
3496 | (mkdir #$output) | |
3497 | (system* (string-append #+coreutils "/bin/ln") | |
3498 | "-s" | |
3499 | (string-append #$emacs "/bin/emacs") | |
3500 | (string-append #$output "/bin/vi"))) | |
3501 | #:target "mips64el-linux") | |
3502 | @end example | |
3503 | ||
3504 | @noindent | |
3505 | In the example above, the native build of @var{coreutils} is used, so | |
3506 | that @command{ln} can actually run on the host; but then the | |
3507 | cross-compiled build of @var{emacs} is referenced. | |
3508 | ||
3509 | The syntactic form to construct gexps is summarized below. | |
21b679f6 LC |
3510 | |
3511 | @deffn {Scheme Syntax} #~@var{exp} | |
3512 | @deffnx {Scheme Syntax} (gexp @var{exp}) | |
3513 | Return a G-expression containing @var{exp}. @var{exp} may contain one | |
3514 | or more of the following forms: | |
3515 | ||
3516 | @table @code | |
3517 | @item #$@var{obj} | |
3518 | @itemx (ungexp @var{obj}) | |
b39fc6f7 LC |
3519 | Introduce a reference to @var{obj}. @var{obj} may have one of the |
3520 | supported types, for example a package or a | |
21b679f6 LC |
3521 | derivation, in which case the @code{ungexp} form is replaced by its |
3522 | output file name---e.g., @code{"/gnu/store/@dots{}-coreutils-8.22}. | |
3523 | ||
b39fc6f7 LC |
3524 | If @var{obj} is a list, it is traversed and references to supported |
3525 | objects are substituted similarly. | |
21b679f6 LC |
3526 | |
3527 | If @var{obj} is another gexp, its contents are inserted and its | |
3528 | dependencies are added to those of the containing gexp. | |
3529 | ||
3530 | If @var{obj} is another kind of object, it is inserted as is. | |
3531 | ||
b39fc6f7 LC |
3532 | @item #$@var{obj}:@var{output} |
3533 | @itemx (ungexp @var{obj} @var{output}) | |
21b679f6 | 3534 | This is like the form above, but referring explicitly to the |
b39fc6f7 LC |
3535 | @var{output} of @var{obj}---this is useful when @var{obj} produces |
3536 | multiple outputs (@pxref{Packages with Multiple Outputs}). | |
21b679f6 | 3537 | |
667b2508 LC |
3538 | @item #+@var{obj} |
3539 | @itemx #+@var{obj}:output | |
3540 | @itemx (ungexp-native @var{obj}) | |
3541 | @itemx (ungexp-native @var{obj} @var{output}) | |
3542 | Same as @code{ungexp}, but produces a reference to the @emph{native} | |
3543 | build of @var{obj} when used in a cross compilation context. | |
3544 | ||
21b679f6 LC |
3545 | @item #$output[:@var{output}] |
3546 | @itemx (ungexp output [@var{output}]) | |
3547 | Insert a reference to derivation output @var{output}, or to the main | |
3548 | output when @var{output} is omitted. | |
3549 | ||
3550 | This only makes sense for gexps passed to @code{gexp->derivation}. | |
3551 | ||
3552 | @item #$@@@var{lst} | |
3553 | @itemx (ungexp-splicing @var{lst}) | |
3554 | Like the above, but splices the contents of @var{lst} inside the | |
3555 | containing list. | |
3556 | ||
667b2508 LC |
3557 | @item #+@@@var{lst} |
3558 | @itemx (ungexp-native-splicing @var{lst}) | |
3559 | Like the above, but refers to native builds of the objects listed in | |
3560 | @var{lst}. | |
3561 | ||
21b679f6 LC |
3562 | @end table |
3563 | ||
3564 | G-expressions created by @code{gexp} or @code{#~} are run-time objects | |
3565 | of the @code{gexp?} type (see below.) | |
3566 | @end deffn | |
3567 | ||
3568 | @deffn {Scheme Procedure} gexp? @var{obj} | |
3569 | Return @code{#t} if @var{obj} is a G-expression. | |
3570 | @end deffn | |
3571 | ||
3572 | G-expressions are meant to be written to disk, either as code building | |
3573 | some derivation, or as plain files in the store. The monadic procedures | |
3574 | below allow you to do that (@pxref{The Store Monad}, for more | |
3575 | information about monads.) | |
3576 | ||
3577 | @deffn {Monadic Procedure} gexp->derivation @var{name} @var{exp} @ | |
ce45eb4c | 3578 | [#:system (%current-system)] [#:target #f] [#:graft? #t] @ |
21b679f6 LC |
3579 | [#:hash #f] [#:hash-algo #f] @ |
3580 | [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ | |
4684f301 | 3581 | [#:module-path @var{%load-path}] @ |
c8351d9a | 3582 | [#:references-graphs #f] [#:allowed-references #f] @ |
c0468155 | 3583 | [#:leaked-env-vars #f] @ |
0309e1b0 | 3584 | [#:script-name (string-append @var{name} "-builder")] @ |
4a6aeb67 | 3585 | [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] |
21b679f6 | 3586 | Return a derivation @var{name} that runs @var{exp} (a gexp) with |
0309e1b0 LC |
3587 | @var{guile-for-build} (a derivation) on @var{system}; @var{exp} is |
3588 | stored in a file called @var{script-name}. When @var{target} is true, | |
3589 | it is used as the cross-compilation target triplet for packages referred | |
3590 | to by @var{exp}. | |
21b679f6 | 3591 | |
ce45eb4c LC |
3592 | Make @var{modules} available in the evaluation context of @var{exp}; |
3593 | @var{modules} is a list of names of Guile modules searched in | |
3594 | @var{module-path} to be copied in the store, compiled, and made available in | |
21b679f6 LC |
3595 | the load path during the execution of @var{exp}---e.g., @code{((guix |
3596 | build utils) (guix build gnu-build-system))}. | |
3597 | ||
ce45eb4c LC |
3598 | @var{graft?} determines whether packages referred to by @var{exp} should be grafted when |
3599 | applicable. | |
3600 | ||
b53833b2 LC |
3601 | When @var{references-graphs} is true, it must be a list of tuples of one of the |
3602 | following forms: | |
3603 | ||
3604 | @example | |
3605 | (@var{file-name} @var{package}) | |
3606 | (@var{file-name} @var{package} @var{output}) | |
3607 | (@var{file-name} @var{derivation}) | |
3608 | (@var{file-name} @var{derivation} @var{output}) | |
3609 | (@var{file-name} @var{store-item}) | |
3610 | @end example | |
3611 | ||
3612 | The right-hand-side of each element of @var{references-graphs} is automatically made | |
3613 | an input of the build process of @var{exp}. In the build environment, each | |
3614 | @var{file-name} contains the reference graph of the corresponding item, in a simple | |
3615 | text format. | |
3616 | ||
c8351d9a LC |
3617 | @var{allowed-references} must be either @code{#f} or a list of output names and packages. |
3618 | In the latter case, the list denotes store items that the result is allowed to | |
3619 | refer to. Any reference to another store item will lead to a build error. | |
3620 | ||
e20fd1bf | 3621 | The other arguments are as for @code{derivation} (@pxref{Derivations}). |
21b679f6 LC |
3622 | @end deffn |
3623 | ||
343eacbe | 3624 | @cindex file-like objects |
e1c153e0 LC |
3625 | The @code{local-file}, @code{plain-file}, @code{computed-file}, |
3626 | @code{program-file}, and @code{scheme-file} procedures below return | |
3627 | @dfn{file-like objects}. That is, when unquoted in a G-expression, | |
3628 | these objects lead to a file in the store. Consider this G-expression: | |
343eacbe LC |
3629 | |
3630 | @example | |
3631 | #~(system* (string-append #$glibc "/sbin/nscd") "-f" | |
3632 | #$(local-file "/tmp/my-nscd.conf")) | |
3633 | @end example | |
3634 | ||
3635 | The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it | |
3636 | to the store. Once expanded, for instance @i{via} | |
3637 | @code{gexp->derivation}, the G-expression refers to that copy under | |
3638 | @file{/gnu/store}; thus, modifying or removing the file in @file{/tmp} | |
3639 | does not have any effect on what the G-expression does. | |
3640 | @code{plain-file} can be used similarly; it differs in that the file | |
3641 | content is directly passed as a string. | |
3642 | ||
d9ae938f LC |
3643 | @deffn {Scheme Procedure} local-file @var{file} [@var{name}] @ |
3644 | [#:recursive? #t] | |
3645 | Return an object representing local file @var{file} to add to the store; this | |
9d3994f7 LC |
3646 | object can be used in a gexp. If @var{file} is a relative file name, it is looked |
3647 | up relative to the source file where this form appears. @var{file} will be added to | |
3648 | the store under @var{name}--by default the base name of @var{file}. | |
d9ae938f LC |
3649 | |
3650 | When @var{recursive?} is true, the contents of @var{file} are added recursively; if @var{file} | |
3651 | designates a flat file and @var{recursive?} is true, its contents are added, and its | |
3652 | permission bits are kept. | |
3653 | ||
3654 | This is the declarative counterpart of the @code{interned-file} monadic | |
3655 | procedure (@pxref{The Store Monad, @code{interned-file}}). | |
3656 | @end deffn | |
3657 | ||
558e8b11 LC |
3658 | @deffn {Scheme Procedure} plain-file @var{name} @var{content} |
3659 | Return an object representing a text file called @var{name} with the given | |
3660 | @var{content} (a string) to be added to the store. | |
3661 | ||
3662 | This is the declarative counterpart of @code{text-file}. | |
3663 | @end deffn | |
3664 | ||
91937029 LC |
3665 | @deffn {Scheme Procedure} computed-file @var{name} @var{gexp} @ |
3666 | [#:modules '()] [#:options '(#:local-build? #t)] | |
3667 | Return an object representing the store item @var{name}, a file or | |
3668 | directory computed by @var{gexp}. @var{modules} specifies the set of | |
3669 | modules visible in the execution context of @var{gexp}. @var{options} | |
3670 | is a list of additional arguments to pass to @code{gexp->derivation}. | |
3671 | ||
3672 | This is the declarative counterpart of @code{gexp->derivation}. | |
3673 | @end deffn | |
3674 | ||
21b679f6 LC |
3675 | @deffn {Monadic Procedure} gexp->script @var{name} @var{exp} |
3676 | Return an executable script @var{name} that runs @var{exp} using | |
3677 | @var{guile} with @var{modules} in its search path. | |
3678 | ||
3679 | The example below builds a script that simply invokes the @command{ls} | |
3680 | command: | |
3681 | ||
3682 | @example | |
3683 | (use-modules (guix gexp) (gnu packages base)) | |
3684 | ||
3685 | (gexp->script "list-files" | |
3686 | #~(execl (string-append #$coreutils "/bin/ls") | |
3687 | "ls")) | |
3688 | @end example | |
3689 | ||
3690 | When ``running'' it through the store (@pxref{The Store Monad, | |
e20fd1bf | 3691 | @code{run-with-store}}), we obtain a derivation that produces an |
21b679f6 LC |
3692 | executable file @file{/gnu/store/@dots{}-list-files} along these lines: |
3693 | ||
3694 | @example | |
3695 | #!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds | |
3696 | !# | |
3697 | (execl (string-append "/gnu/store/@dots{}-coreutils-8.22"/bin/ls") | |
3698 | "ls") | |
3699 | @end example | |
3700 | @end deffn | |
3701 | ||
15a01c72 LC |
3702 | @deffn {Scheme Procedure} program-file @var{name} @var{exp} @ |
3703 | [#:modules '()] [#:guile #f] | |
3704 | Return an object representing the executable store item @var{name} that | |
3705 | runs @var{gexp}. @var{guile} is the Guile package used to execute that | |
3706 | script, and @var{modules} is the list of modules visible to that script. | |
3707 | ||
3708 | This is the declarative counterpart of @code{gexp->script}. | |
3709 | @end deffn | |
3710 | ||
21b679f6 LC |
3711 | @deffn {Monadic Procedure} gexp->file @var{name} @var{exp} |
3712 | Return a derivation that builds a file @var{name} containing @var{exp}. | |
3713 | ||
3714 | The resulting file holds references to all the dependencies of @var{exp} | |
3715 | or a subset thereof. | |
3716 | @end deffn | |
1ed19464 | 3717 | |
e1c153e0 LC |
3718 | @deffn {Scheme Procedure} scheme-file @var{name} @var{exp} |
3719 | Return an object representing the Scheme file @var{name} that contains | |
3720 | @var{exp}. | |
3721 | ||
3722 | This is the declarative counterpart of @code{gexp->file}. | |
3723 | @end deffn | |
3724 | ||
1ed19464 LC |
3725 | @deffn {Monadic Procedure} text-file* @var{name} @var{text} @dots{} |
3726 | Return as a monadic value a derivation that builds a text file | |
3727 | containing all of @var{text}. @var{text} may list, in addition to | |
d9ae938f LC |
3728 | strings, objects of any type that can be used in a gexp: packages, |
3729 | derivations, local file objects, etc. The resulting store file holds | |
3730 | references to all these. | |
1ed19464 LC |
3731 | |
3732 | This variant should be preferred over @code{text-file} anytime the file | |
3733 | to create will reference items from the store. This is typically the | |
3734 | case when building a configuration file that embeds store file names, | |
3735 | like this: | |
3736 | ||
3737 | @example | |
3738 | (define (profile.sh) | |
3739 | ;; Return the name of a shell script in the store that | |
3740 | ;; initializes the 'PATH' environment variable. | |
3741 | (text-file* "profile.sh" | |
3742 | "export PATH=" coreutils "/bin:" | |
3743 | grep "/bin:" sed "/bin\n")) | |
3744 | @end example | |
3745 | ||
3746 | In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file | |
3747 | will references @var{coreutils}, @var{grep}, and @var{sed}, thereby | |
3748 | preventing them from being garbage-collected during its lifetime. | |
3749 | @end deffn | |
21b679f6 | 3750 | |
b751cde3 LC |
3751 | @deffn {Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{} |
3752 | Return an object representing store file @var{name} containing | |
3753 | @var{text}. @var{text} is a sequence of strings and file-like objects, | |
3754 | as in: | |
3755 | ||
3756 | @example | |
3757 | (mixed-text-file "profile" | |
3758 | "export PATH=" coreutils "/bin:" grep "/bin") | |
3759 | @end example | |
3760 | ||
3761 | This is the declarative counterpart of @code{text-file*}. | |
3762 | @end deffn | |
3763 | ||
21b679f6 LC |
3764 | Of course, in addition to gexps embedded in ``host'' code, there are |
3765 | also modules containing build tools. To make it clear that they are | |
3766 | meant to be used in the build stratum, these modules are kept in the | |
3767 | @code{(guix build @dots{})} name space. | |
3768 | ||
c2b84676 LC |
3769 | @cindex lowering, of high-level objects in gexps |
3770 | Internally, high-level objects are @dfn{lowered}, using their compiler, | |
3771 | to either derivations or store items. For instance, lowering a package | |
3772 | yields a derivation, and lowering a @code{plain-file} yields a store | |
3773 | item. This is achieved using the @code{lower-object} monadic procedure. | |
3774 | ||
3775 | @deffn {Monadic Procedure} lower-object @var{obj} [@var{system}] @ | |
3776 | [#:target #f] | |
3777 | Return as a value in @var{%store-monad} the derivation or store item | |
3778 | corresponding to @var{obj} for @var{system}, cross-compiling for | |
3779 | @var{target} if @var{target} is true. @var{obj} must be an object that | |
3780 | has an associated gexp compiler, such as a @code{<package>}. | |
3781 | @end deffn | |
3782 | ||
21b679f6 | 3783 | |
568717fd LC |
3784 | @c ********************************************************************* |
3785 | @node Utilities | |
3786 | @chapter Utilities | |
3787 | ||
210cc920 LC |
3788 | This section describes tools primarily targeted at developers and users |
3789 | who write new package definitions. They complement the Scheme | |
3790 | programming interface of Guix in a convenient way. | |
3791 | ||
568717fd | 3792 | @menu |
37166310 | 3793 | * Invoking guix build:: Building packages from the command line. |
39bee8a2 | 3794 | * Invoking guix edit:: Editing package definitions. |
210cc920 | 3795 | * Invoking guix download:: Downloading a file and printing its hash. |
37166310 | 3796 | * Invoking guix hash:: Computing the cryptographic hash of a file. |
2f7d2d91 | 3797 | * Invoking guix import:: Importing package definitions. |
37166310 | 3798 | * Invoking guix refresh:: Updating package definitions. |
b4f5e0e8 | 3799 | * Invoking guix lint:: Finding errors in package definitions. |
fcc58db6 | 3800 | * Invoking guix size:: Profiling disk usage. |
88856916 | 3801 | * Invoking guix graph:: Visualizing the graph of packages. |
372c4bbc | 3802 | * Invoking guix environment:: Setting up development environments. |
aff8ce7c | 3803 | * Invoking guix publish:: Sharing substitutes. |
d23c20f1 | 3804 | * Invoking guix challenge:: Challenging substitute servers. |
32efa254 | 3805 | * Invoking guix container:: Process isolation. |
568717fd LC |
3806 | @end menu |
3807 | ||
e49951eb MW |
3808 | @node Invoking guix build |
3809 | @section Invoking @command{guix build} | |
568717fd | 3810 | |
e49951eb | 3811 | The @command{guix build} command builds packages or derivations and |
6798a8e4 LC |
3812 | their dependencies, and prints the resulting store paths. Note that it |
3813 | does not modify the user's profile---this is the job of the | |
e49951eb | 3814 | @command{guix package} command (@pxref{Invoking guix package}). Thus, |
6798a8e4 LC |
3815 | it is mainly useful for distribution developers. |
3816 | ||
3817 | The general syntax is: | |
c78bd12b LC |
3818 | |
3819 | @example | |
e49951eb | 3820 | guix build @var{options} @var{package-or-derivation}@dots{} |
c78bd12b LC |
3821 | @end example |
3822 | ||
f97c9175 | 3823 | As an example, the following command builds the latest versions of Emacs |
ccd7158d LC |
3824 | and of Guile, displays their build logs, and finally displays the |
3825 | resulting directories: | |
3826 | ||
3827 | @example | |
3828 | guix build emacs guile | |
3829 | @end example | |
3830 | ||
3831 | Similarly, the following command builds all the available packages: | |
3832 | ||
3833 | @example | |
3834 | guix build --keep-going \ | |
3835 | `guix package -A | cut -f1,2 --output-delimiter=@@` | |
3836 | @end example | |
3837 | ||
c78bd12b | 3838 | @var{package-or-derivation} may be either the name of a package found in |
5401dd75 LC |
3839 | the software distribution such as @code{coreutils} or |
3840 | @code{coreutils-8.20}, or a derivation such as | |
834129e0 | 3841 | @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the former case, a |
e7f34eb0 LC |
3842 | package with the corresponding name (and optionally version) is searched |
3843 | for among the GNU distribution modules (@pxref{Package Modules}). | |
3844 | ||
3845 | Alternatively, the @code{--expression} option may be used to specify a | |
3846 | Scheme expression that evaluates to a package; this is useful when | |
3847 | disambiguation among several same-named packages or package variants is | |
3848 | needed. | |
c78bd12b | 3849 | |
ccd7158d LC |
3850 | There may be zero or more @var{options}. The available options are |
3851 | described in the subsections below. | |
3852 | ||
3853 | @menu | |
3854 | * Common Build Options:: Build options for most commands. | |
88ad6ded | 3855 | * Package Transformation Options:: Creating variants of packages. |
ccd7158d LC |
3856 | * Additional Build Options:: Options specific to 'guix build'. |
3857 | @end menu | |
3858 | ||
3859 | @node Common Build Options | |
3860 | @subsection Common Build Options | |
3861 | ||
3862 | A number of options that control the build process are common to | |
3863 | @command{guix build} and other commands that can spawn builds, such as | |
3864 | @command{guix package} or @command{guix archive}. These are the | |
3865 | following: | |
3866 | ||
3867 | @table @code | |
3868 | ||
3869 | @item --load-path=@var{directory} | |
3870 | @itemx -L @var{directory} | |
3871 | Add @var{directory} to the front of the package module search path | |
3872 | (@pxref{Package Modules}). | |
3873 | ||
3874 | This allows users to define their own packages and make them visible to | |
3875 | the command-line tools. | |
3876 | ||
3877 | @item --keep-failed | |
3878 | @itemx -K | |
3879 | Keep the build tree of failed builds. Thus, if a build fail, its build | |
3880 | tree is kept under @file{/tmp}, in a directory whose name is shown at | |
3881 | the end of the build log. This is useful when debugging build issues. | |
3882 | ||
3883 | @item --keep-going | |
3884 | @itemx -k | |
3885 | Keep going when some of the derivations fail to build; return only once | |
3886 | all the builds have either completed or failed. | |
3887 | ||
3888 | The default behavior is to stop as soon as one of the specified | |
3889 | derivations has failed. | |
3890 | ||
3891 | @item --dry-run | |
3892 | @itemx -n | |
3893 | Do not build the derivations. | |
3894 | ||
3895 | @item --fallback | |
3896 | When substituting a pre-built binary fails, fall back to building | |
3897 | packages locally. | |
3898 | ||
3899 | @item --substitute-urls=@var{urls} | |
3900 | @anchor{client-substitute-urls} | |
3901 | Consider @var{urls} the whitespace-separated list of substitute source | |
3902 | URLs, overriding the default list of URLs of @command{guix-daemon} | |
3903 | (@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs}). | |
3904 | ||
3905 | This means that substitutes may be downloaded from @var{urls}, provided | |
3906 | they are signed by a key authorized by the system administrator | |
3907 | (@pxref{Substitutes}). | |
3908 | ||
3909 | @item --no-substitutes | |
3910 | Do not use substitutes for build products. That is, always build things | |
3911 | locally instead of allowing downloads of pre-built binaries | |
3912 | (@pxref{Substitutes}). | |
3913 | ||
3914 | @item --rounds=@var{n} | |
3915 | Build each derivation @var{n} times in a row, and raise an error if | |
3916 | consecutive build results are not bit-for-bit identical. | |
3917 | ||
3918 | This is a useful way to detect non-deterministic builds processes. | |
3919 | Non-deterministic build processes are a problem because they make it | |
3920 | practically impossible for users to @emph{verify} whether third-party | |
3921 | binaries are genuine. @xref{Invoking guix challenge}, for more. | |
3922 | ||
3923 | Note that, currently, the differing build results are not kept around, | |
3924 | so you will have to manually investigate in case of an error---e.g., by | |
3925 | stashing one of the build results with @code{guix archive --export}, | |
3926 | then rebuilding, and finally comparing the two results. | |
3927 | ||
3928 | @item --no-build-hook | |
f97c9175 | 3929 | Do not attempt to offload builds @i{via} the ``build hook'' of the daemon |
ccd7158d LC |
3930 | (@pxref{Daemon Offload Setup}). That is, always build things locally |
3931 | instead of offloading builds to remote machines. | |
3932 | ||
3933 | @item --max-silent-time=@var{seconds} | |
3934 | When the build or substitution process remains silent for more than | |
3935 | @var{seconds}, terminate it and report a build failure. | |
3936 | ||
3937 | @item --timeout=@var{seconds} | |
3938 | Likewise, when the build or substitution process lasts for more than | |
3939 | @var{seconds}, terminate it and report a build failure. | |
3940 | ||
3941 | By default there is no timeout. This behavior can be restored with | |
3942 | @code{--timeout=0}. | |
3943 | ||
3944 | @item --verbosity=@var{level} | |
3945 | Use the given verbosity level. @var{level} must be an integer between 0 | |
3946 | and 5; higher means more verbose output. Setting a level of 4 or more | |
3947 | may be helpful when debugging setup issues with the build daemon. | |
3948 | ||
3949 | @item --cores=@var{n} | |
3950 | @itemx -c @var{n} | |
3951 | Allow the use of up to @var{n} CPU cores for the build. The special | |
3952 | value @code{0} means to use as many CPU cores as available. | |
3953 | ||
3954 | @item --max-jobs=@var{n} | |
3955 | @itemx -M @var{n} | |
3956 | Allow at most @var{n} build jobs in parallel. @xref{Invoking | |
3957 | guix-daemon, @code{--max-jobs}}, for details about this option and the | |
3958 | equivalent @command{guix-daemon} option. | |
3959 | ||
3960 | @end table | |
3961 | ||
3962 | Behind the scenes, @command{guix build} is essentially an interface to | |
3963 | the @code{package-derivation} procedure of the @code{(guix packages)} | |
3964 | module, and to the @code{build-derivations} procedure of the @code{(guix | |
3965 | derivations)} module. | |
3966 | ||
3967 | In addition to options explicitly passed on the command line, | |
3968 | @command{guix build} and other @command{guix} commands that support | |
3969 | building honor the @code{GUIX_BUILD_OPTIONS} environment variable. | |
3970 | ||
3971 | @defvr {Environment Variable} GUIX_BUILD_OPTIONS | |
3972 | Users can define this variable to a list of command line options that | |
3973 | will automatically be used by @command{guix build} and other | |
3974 | @command{guix} commands that can perform builds, as in the example | |
3975 | below: | |
3976 | ||
3977 | @example | |
3978 | $ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /foo/bar" | |
3979 | @end example | |
3980 | ||
3981 | These options are parsed independently, and the result is appended to | |
3982 | the parsed command-line options. | |
3983 | @end defvr | |
3984 | ||
88ad6ded LC |
3985 | |
3986 | @node Package Transformation Options | |
3987 | @subsection Package Transformation Options | |
3988 | ||
3989 | @cindex package variants | |
3990 | Another set of command-line options supported by @command{guix build} | |
b8638f03 | 3991 | and also @command{guix package} are @dfn{package transformation |
f97c9175 | 3992 | options}. These are options that make it possible to define @dfn{package |
b8638f03 LC |
3993 | variants}---for instance, packages built from different source code. |
3994 | This is a convenient way to create customized packages on the fly | |
3995 | without having to type in the definitions of package variants | |
3996 | (@pxref{Defining Packages}). | |
88ad6ded LC |
3997 | |
3998 | @table @code | |
3999 | ||
4000 | @item --with-source=@var{source} | |
4001 | Use @var{source} as the source of the corresponding package. | |
4002 | @var{source} must be a file name or a URL, as for @command{guix | |
4003 | download} (@pxref{Invoking guix download}). | |
4004 | ||
f97c9175 AE |
4005 | The ``corresponding package'' is taken to be the one specified on the |
4006 | command line the name of which matches the base of @var{source}---e.g., | |
4007 | if @var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding | |
88ad6ded | 4008 | package is @code{guile}. Likewise, the version string is inferred from |
f97c9175 | 4009 | @var{source}; in the previous example, it is @code{2.0.10}. |
88ad6ded LC |
4010 | |
4011 | This option allows users to try out versions of packages other than the | |
4012 | one provided by the distribution. The example below downloads | |
4013 | @file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for | |
4014 | the @code{ed} package: | |
4015 | ||
4016 | @example | |
4017 | guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz | |
4018 | @end example | |
4019 | ||
4020 | As a developer, @code{--with-source} makes it easy to test release | |
4021 | candidates: | |
4022 | ||
4023 | @example | |
4024 | guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz | |
4025 | @end example | |
4026 | ||
4027 | @dots{} or to build from a checkout in a pristine environment: | |
4028 | ||
4029 | @example | |
4030 | $ git clone git://git.sv.gnu.org/guix.git | |
4031 | $ guix build guix --with-source=./guix | |
4032 | @end example | |
4033 | ||
47c0f92c LC |
4034 | @item --with-input=@var{package}=@var{replacement} |
4035 | Replace dependency on @var{package} by a dependency on | |
4036 | @var{replacement}. @var{package} must be a package name, and | |
4037 | @var{replacement} must be a package specification such as @code{guile} | |
4038 | or @code{guile@@1.8}. | |
4039 | ||
f97c9175 | 4040 | For instance, the following command builds Guix, but replaces its |
47c0f92c LC |
4041 | dependency on the current stable version of Guile with a dependency on |
4042 | the development version of Guile, @code{guile-next}: | |
4043 | ||
4044 | @example | |
4045 | guix build --with-input=guile=guile-next guix | |
4046 | @end example | |
4047 | ||
4048 | This is a recursive, deep replacement. So in this example, both | |
4049 | @code{guix} and its dependency @code{guile-json} (which also depends on | |
4050 | @code{guile}) get rebuilt against @code{guile-next}. | |
4051 | ||
4052 | However, implicit inputs are left unchanged. | |
88ad6ded LC |
4053 | @end table |
4054 | ||
ccd7158d LC |
4055 | @node Additional Build Options |
4056 | @subsection Additional Build Options | |
4057 | ||
4058 | The command-line options presented below are specific to @command{guix | |
4059 | build}. | |
c78bd12b LC |
4060 | |
4061 | @table @code | |
4062 | ||
34a1783f DT |
4063 | @item --file=@var{file} |
4064 | @itemx -f @var{file} | |
4065 | ||
4066 | Build the package or derivation that the code within @var{file} | |
4067 | evaluates to. | |
4068 | ||
4069 | As an example, @var{file} might contain a package definition like this | |
4070 | (@pxref{Defining Packages}): | |
4071 | ||
4072 | @example | |
4073 | @verbatiminclude package-hello.scm | |
4074 | @end example | |
4075 | ||
c78bd12b LC |
4076 | @item --expression=@var{expr} |
4077 | @itemx -e @var{expr} | |
ac5de156 | 4078 | Build the package or derivation @var{expr} evaluates to. |
c78bd12b | 4079 | |
5401dd75 | 4080 | For example, @var{expr} may be @code{(@@ (gnu packages guile) |
c78bd12b LC |
4081 | guile-1.8)}, which unambiguously designates this specific variant of |
4082 | version 1.8 of Guile. | |
4083 | ||
f97c9175 | 4084 | Alternatively, @var{expr} may be a G-expression, in which case it is used |
56b82106 LC |
4085 | as a build program passed to @code{gexp->derivation} |
4086 | (@pxref{G-Expressions}). | |
4087 | ||
4088 | Lastly, @var{expr} may refer to a zero-argument monadic procedure | |
ac5de156 LC |
4089 | (@pxref{The Store Monad}). The procedure must return a derivation as a |
4090 | monadic value, which is then passed through @code{run-with-store}. | |
4091 | ||
c78bd12b LC |
4092 | @item --source |
4093 | @itemx -S | |
f97c9175 | 4094 | Build the source derivations of the packages, rather than the packages |
c78bd12b LC |
4095 | themselves. |
4096 | ||
e49951eb | 4097 | For instance, @code{guix build -S gcc} returns something like |
f97c9175 AE |
4098 | @file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC |
4099 | source tarball. | |
c78bd12b | 4100 | |
f9cc8971 | 4101 | The returned source tarball is the result of applying any patches and |
f97c9175 | 4102 | code snippets specified in the package @code{origin} (@pxref{Defining |
f9cc8971 LC |
4103 | Packages}). |
4104 | ||
2cdfe13d EB |
4105 | @item --sources |
4106 | Fetch and return the source of @var{package-or-derivation} and all their | |
4107 | dependencies, recursively. This is a handy way to obtain a local copy | |
4108 | of all the source code needed to build @var{packages}, allowing you to | |
4109 | eventually build them even without network access. It is an extension | |
4110 | of the @code{--source} option and can accept one of the following | |
4111 | optional argument values: | |
4112 | ||
4113 | @table @code | |
4114 | @item package | |
4115 | This value causes the @code{--sources} option to behave in the same way | |
4116 | as the @code{--source} option. | |
4117 | ||
4118 | @item all | |
f97c9175 AE |
4119 | Build the source derivations of all packages, including any source that |
4120 | might be listed as @code{inputs}. This is the default value. | |
2cdfe13d EB |
4121 | |
4122 | @example | |
4123 | $ guix build --sources tzdata | |
4124 | The following derivations will be built: | |
4125 | /gnu/store/@dots{}-tzdata2015b.tar.gz.drv | |
4126 | /gnu/store/@dots{}-tzcode2015b.tar.gz.drv | |
4127 | @end example | |
4128 | ||
4129 | @item transitive | |
f97c9175 AE |
4130 | Build the source derivations of all packages, as well of all transitive |
4131 | inputs to the packages. This can be used e.g. to | |
2cdfe13d EB |
4132 | prefetch package source for later offline building. |
4133 | ||
4134 | @example | |
4135 | $ guix build --sources=transitive tzdata | |
4136 | The following derivations will be built: | |
4137 | /gnu/store/@dots{}-tzcode2015b.tar.gz.drv | |
4138 | /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv | |
4139 | /gnu/store/@dots{}-grep-2.21.tar.xz.drv | |
4140 | /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv | |
4141 | /gnu/store/@dots{}-make-4.1.tar.xz.drv | |
4142 | /gnu/store/@dots{}-bash-4.3.tar.xz.drv | |
4143 | @dots{} | |
4144 | @end example | |
4145 | ||
4146 | @end table | |
4147 | ||
c78bd12b LC |
4148 | @item --system=@var{system} |
4149 | @itemx -s @var{system} | |
4150 | Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of | |
f97c9175 | 4151 | the system type of the build host. |
c78bd12b LC |
4152 | |
4153 | An example use of this is on Linux-based systems, which can emulate | |
4154 | different personalities. For instance, passing | |
4155 | @code{--system=i686-linux} on an @code{x86_64-linux} system allows users | |
4156 | to build packages in a complete 32-bit environment. | |
4157 | ||
e55ec43d LC |
4158 | @item --target=@var{triplet} |
4159 | @cindex cross-compilation | |
4160 | Cross-build for @var{triplet}, which must be a valid GNU triplet, such | |
4161 | as @code{"mips64el-linux-gnu"} (@pxref{Configuration Names, GNU | |
4162 | configuration triplets,, configure, GNU Configure and Build System}). | |
4163 | ||
a8d65643 LC |
4164 | @anchor{build-check} |
4165 | @item --check | |
4166 | @cindex determinism, checking | |
4167 | @cindex reproducibility, checking | |
4168 | Rebuild @var{package-or-derivation}, which are already available in the | |
4169 | store, and raise an error if the build results are not bit-for-bit | |
4170 | identical. | |
4171 | ||
f97c9175 AE |
4172 | This mechanism allows you to check whether previously installed |
4173 | substitutes are genuine (@pxref{Substitutes}), or whether the build result | |
4174 | of a package is deterministic. @xref{Invoking guix challenge}, for more | |
a8d65643 LC |
4175 | background information and tools. |
4176 | ||
05962f29 LC |
4177 | @item --no-grafts |
4178 | Do not ``graft'' packages. In practice, this means that package updates | |
4179 | available as grafts are not applied. @xref{Security Updates}, for more | |
4180 | information on grafts. | |
7f3673f2 | 4181 | |
c78bd12b LC |
4182 | @item --derivations |
4183 | @itemx -d | |
4184 | Return the derivation paths, not the output paths, of the given | |
4185 | packages. | |
4186 | ||
70ee5642 LC |
4187 | @item --root=@var{file} |
4188 | @itemx -r @var{file} | |
4189 | Make @var{file} a symlink to the result, and register it as a garbage | |
4190 | collector root. | |
4191 | ||
4192 | @item --log-file | |
3f208ad7 | 4193 | Return the build log file names or URLs for the given |
f97c9175 | 4194 | @var{package-or-derivation}, or raise an error if build logs are |
70ee5642 LC |
4195 | missing. |
4196 | ||
4197 | This works regardless of how packages or derivations are specified. For | |
4198 | instance, the following invocations are equivalent: | |
4199 | ||
4200 | @example | |
4201 | guix build --log-file `guix build -d guile` | |
4202 | guix build --log-file `guix build guile` | |
4203 | guix build --log-file guile | |
4204 | guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)' | |
4205 | @end example | |
4206 | ||
3f208ad7 LC |
4207 | If a log is unavailable locally, and unless @code{--no-substitutes} is |
4208 | passed, the command looks for a corresponding log on one of the | |
4209 | substitute servers (as specified with @code{--substitute-urls}.) | |
70ee5642 | 4210 | |
f97c9175 AE |
4211 | So for instance, imagine you want to see the build log of GDB on MIPS, |
4212 | but you are actually on an @code{x86_64} machine: | |
3f208ad7 LC |
4213 | |
4214 | @example | |
4215 | $ guix build --log-file gdb -s mips64el-linux | |
4216 | http://hydra.gnu.org/log/@dots{}-gdb-7.10 | |
4217 | @end example | |
4218 | ||
4219 | You can freely access a huge library of build logs! | |
70ee5642 LC |
4220 | @end table |
4221 | ||
16eb115e | 4222 | |
39bee8a2 LC |
4223 | @node Invoking guix edit |
4224 | @section Invoking @command{guix edit} | |
4225 | ||
4226 | @cindex package definition, editing | |
4227 | So many packages, so many source files! The @command{guix edit} command | |
4228 | facilitates the life of packagers by pointing their editor at the source | |
4229 | file containing the definition of the specified packages. For instance: | |
4230 | ||
4231 | @example | |
4232 | guix edit gcc-4.8 vim | |
4233 | @end example | |
4234 | ||
4235 | @noindent | |
6237b9fa LC |
4236 | launches the program specified in the @code{VISUAL} or in the |
4237 | @code{EDITOR} environment variable to edit the recipe of GCC@tie{}4.8.4 | |
4238 | and that of Vim. | |
39bee8a2 | 4239 | |
f97c9175 | 4240 | If you are using Emacs, note that the Emacs user interface provides the |
7c1b1ae2 | 4241 | @kbd{M-x guix-edit} command and a similar functionality in the ``package |
f97c9175 | 4242 | info'' and ``package list'' buffers created by the @kbd{M-x |
7c1b1ae2 | 4243 | guix-search-by-name} and similar commands (@pxref{Emacs Commands}). |
39bee8a2 LC |
4244 | |
4245 | ||
210cc920 LC |
4246 | @node Invoking guix download |
4247 | @section Invoking @command{guix download} | |
4248 | ||
4249 | When writing a package definition, developers typically need to download | |
f97c9175 | 4250 | a source tarball, compute its SHA256 hash, and write that |
210cc920 LC |
4251 | hash in the package definition (@pxref{Defining Packages}). The |
4252 | @command{guix download} tool helps with this task: it downloads a file | |
4253 | from the given URI, adds it to the store, and prints both its file name | |
4254 | in the store and its SHA256 hash. | |
4255 | ||
4256 | The fact that the downloaded file is added to the store saves bandwidth: | |
4257 | when the developer eventually tries to build the newly defined package | |
4258 | with @command{guix build}, the source tarball will not have to be | |
4259 | downloaded again because it is already in the store. It is also a | |
4260 | convenient way to temporarily stash files, which may be deleted | |
4261 | eventually (@pxref{Invoking guix gc}). | |
4262 | ||
4263 | The @command{guix download} command supports the same URIs as used in | |
4264 | package definitions. In particular, it supports @code{mirror://} URIs. | |
4265 | @code{https} URIs (HTTP over TLS) are supported @emph{provided} the | |
4266 | Guile bindings for GnuTLS are available in the user's environment; when | |
537c8bb3 LC |
4267 | they are not available, an error is raised. @xref{Guile Preparations, |
4268 | how to install the GnuTLS bindings for Guile,, gnutls-guile, | |
4269 | GnuTLS-Guile}, for more information. | |
210cc920 LC |
4270 | |
4271 | The following option is available: | |
4272 | ||
4273 | @table @code | |
4274 | @item --format=@var{fmt} | |
4275 | @itemx -f @var{fmt} | |
4276 | Write the hash in the format specified by @var{fmt}. For more | |
081145cf | 4277 | information on the valid values for @var{fmt}, @pxref{Invoking guix hash}. |
210cc920 LC |
4278 | @end table |
4279 | ||
6c365eca NK |
4280 | @node Invoking guix hash |
4281 | @section Invoking @command{guix hash} | |
4282 | ||
210cc920 | 4283 | The @command{guix hash} command computes the SHA256 hash of a file. |
6c365eca NK |
4284 | It is primarily a convenience tool for anyone contributing to the |
4285 | distribution: it computes the cryptographic hash of a file, which can be | |
4286 | used in the definition of a package (@pxref{Defining Packages}). | |
4287 | ||
4288 | The general syntax is: | |
4289 | ||
4290 | @example | |
4291 | guix hash @var{option} @var{file} | |
4292 | @end example | |
4293 | ||
4294 | @command{guix hash} has the following option: | |
4295 | ||
4296 | @table @code | |
4297 | ||
4298 | @item --format=@var{fmt} | |
4299 | @itemx -f @var{fmt} | |
210cc920 | 4300 | Write the hash in the format specified by @var{fmt}. |
6c365eca NK |
4301 | |
4302 | Supported formats: @code{nix-base32}, @code{base32}, @code{base16} | |
4303 | (@code{hex} and @code{hexadecimal} can be used as well). | |
4304 | ||
4305 | If the @option{--format} option is not specified, @command{guix hash} | |
4306 | will output the hash in @code{nix-base32}. This representation is used | |
4307 | in the definitions of packages. | |
4308 | ||
3140f2df LC |
4309 | @item --recursive |
4310 | @itemx -r | |
4311 | Compute the hash on @var{file} recursively. | |
4312 | ||
4313 | In this case, the hash is computed on an archive containing @var{file}, | |
f97c9175 AE |
4314 | including its children if it is a directory. Some of the metadata of |
4315 | @var{file} is part of the archive; for instance, when @var{file} is a | |
3140f2df | 4316 | regular file, the hash is different depending on whether @var{file} is |
f97c9175 | 4317 | executable or not. Metadata such as time stamps has no impact on the |
3140f2df LC |
4318 | hash (@pxref{Invoking guix archive}). |
4319 | @c FIXME: Replace xref above with xref to an ``Archive'' section when | |
4320 | @c it exists. | |
4321 | ||
6c365eca NK |
4322 | @end table |
4323 | ||
2f7d2d91 LC |
4324 | @node Invoking guix import |
4325 | @section Invoking @command{guix import} | |
4326 | ||
4327 | @cindex importing packages | |
4328 | @cindex package import | |
4329 | @cindex package conversion | |
f97c9175 AE |
4330 | The @command{guix import} command is useful for people who would like to |
4331 | add a package to the distribution with as little work as | |
4332 | possible---a legitimate demand. The command knows of a few | |
4333 | repositories from which it can ``import'' package metadata. The result | |
2f7d2d91 LC |
4334 | is a package definition, or a template thereof, in the format we know |
4335 | (@pxref{Defining Packages}). | |
4336 | ||
4337 | The general syntax is: | |
4338 | ||
4339 | @example | |
4340 | guix import @var{importer} @var{options}@dots{} | |
4341 | @end example | |
4342 | ||
4343 | @var{importer} specifies the source from which to import package | |
f97c9175 | 4344 | metadata, and @var{options} specifies a package identifier and other |
2f7d2d91 LC |
4345 | options specific to @var{importer}. Currently, the available |
4346 | ``importers'' are: | |
4347 | ||
4348 | @table @code | |
4349 | @item gnu | |
f97c9175 | 4350 | Import metadata for the given GNU package. This provides a template |
2f7d2d91 LC |
4351 | for the latest version of that GNU package, including the hash of its |
4352 | source tarball, and its canonical synopsis and description. | |
4353 | ||
f97c9175 | 4354 | Additional information such as the package dependencies and its |
2f7d2d91 LC |
4355 | license needs to be figured out manually. |
4356 | ||
4357 | For example, the following command returns a package definition for | |
4358 | GNU@tie{}Hello: | |
4359 | ||
4360 | @example | |
4361 | guix import gnu hello | |
4362 | @end example | |
4363 | ||
4364 | Specific command-line options are: | |
4365 | ||
4366 | @table @code | |
4367 | @item --key-download=@var{policy} | |
4368 | As for @code{guix refresh}, specify the policy to handle missing OpenPGP | |
f97c9175 | 4369 | keys when verifying the package signature. @xref{Invoking guix |
2f7d2d91 LC |
4370 | refresh, @code{--key-download}}. |
4371 | @end table | |
4372 | ||
4373 | @item pypi | |
4374 | @cindex pypi | |
f97c9175 | 4375 | Import metadata from the @uref{https://pypi.python.org/, Python Package |
2f7d2d91 LC |
4376 | Index}@footnote{This functionality requires Guile-JSON to be installed. |
4377 | @xref{Requirements}.}. Information is taken from the JSON-formatted | |
4378 | description available at @code{pypi.python.org} and usually includes all | |
4379 | the relevant information, including package dependencies. | |
4380 | ||
f97c9175 | 4381 | The command below imports metadata for the @code{itsdangerous} Python |
2f7d2d91 LC |
4382 | package: |
4383 | ||
4384 | @example | |
4385 | guix import pypi itsdangerous | |
4386 | @end example | |
4387 | ||
3aae8145 DT |
4388 | @item gem |
4389 | @cindex gem | |
f97c9175 | 4390 | Import metadata from @uref{https://rubygems.org/, |
3aae8145 DT |
4391 | RubyGems}@footnote{This functionality requires Guile-JSON to be |
4392 | installed. @xref{Requirements}.}. Information is taken from the | |
4393 | JSON-formatted description available at @code{rubygems.org} and includes | |
4394 | most relevant information, including runtime dependencies. There are | |
f97c9175 | 4395 | some caveats, however. The metadata doesn't distinguish between |
3aae8145 DT |
4396 | synopses and descriptions, so the same string is used for both fields. |
4397 | Additionally, the details of non-Ruby dependencies required to build | |
4398 | native extensions is unavailable and left as an exercise to the | |
4399 | packager. | |
4400 | ||
f97c9175 | 4401 | The command below imports metadata for the @code{rails} Ruby package: |
3aae8145 DT |
4402 | |
4403 | @example | |
4404 | guix import gem rails | |
4405 | @end example | |
4406 | ||
d45dc6da EB |
4407 | @item cpan |
4408 | @cindex CPAN | |
3c192e4e AE |
4409 | Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}@footnote{This |
4410 | functionality requires Guile-JSON to be installed. | |
4411 | @xref{Requirements}.}. | |
f97c9175 | 4412 | Information is taken from the JSON-formatted metadata provided through |
d45dc6da | 4413 | @uref{https://api.metacpan.org/, MetaCPAN's API} and includes most |
66392e47 EB |
4414 | relevant information, such as module dependencies. License information |
4415 | should be checked closely. If Perl is available in the store, then the | |
4416 | @code{corelist} utility will be used to filter core modules out of the | |
4417 | list of dependencies. | |
d45dc6da | 4418 | |
f97c9175 | 4419 | The command command below imports metadata for the @code{Acme::Boolean} |
d45dc6da EB |
4420 | Perl module: |
4421 | ||
4422 | @example | |
4423 | guix import cpan Acme::Boolean | |
4424 | @end example | |
4425 | ||
e1248602 RW |
4426 | @item cran |
4427 | @cindex CRAN | |
d0bd632f | 4428 | @cindex Bioconductor |
f97c9175 | 4429 | Import metadata from @uref{http://cran.r-project.org/, CRAN}, the |
e1248602 RW |
4430 | central repository for the @uref{http://r-project.org, GNU@tie{}R |
4431 | statistical and graphical environment}. | |
4432 | ||
f97c9175 | 4433 | Information is extracted from the @code{DESCRIPTION} file of the package. |
e1248602 | 4434 | |
f97c9175 | 4435 | The command command below imports metadata for the @code{Cairo} |
e1248602 RW |
4436 | R package: |
4437 | ||
4438 | @example | |
4439 | guix import cran Cairo | |
4440 | @end example | |
4441 | ||
f97c9175 | 4442 | When @code{--archive=bioconductor} is added, metadata is imported from |
d0bd632f RW |
4443 | @uref{http://www.bioconductor.org/, Bioconductor}, a repository of R |
4444 | packages for for the analysis and comprehension of high-throughput | |
4445 | genomic data in bioinformatics. | |
4446 | ||
f97c9175 | 4447 | Information is extracted from the @code{DESCRIPTION} file of a package |
d0bd632f RW |
4448 | published on the web interface of the Bioconductor SVN repository. |
4449 | ||
f97c9175 | 4450 | The command below imports metadata for the @code{GenomicRanges} |
d0bd632f RW |
4451 | R package: |
4452 | ||
4453 | @example | |
4454 | guix import cran --archive=bioconductor GenomicRanges | |
4455 | @end example | |
4456 | ||
2f7d2d91 | 4457 | @item nix |
f97c9175 | 4458 | Import metadata from a local copy of the source of the |
2f7d2d91 LC |
4459 | @uref{http://nixos.org/nixpkgs/, Nixpkgs distribution}@footnote{This |
4460 | relies on the @command{nix-instantiate} command of | |
4461 | @uref{http://nixos.org/nix/, Nix}.}. Package definitions in Nixpkgs are | |
4462 | typically written in a mixture of Nix-language and Bash code. This | |
4463 | command only imports the high-level package structure that is written in | |
4464 | the Nix language. It normally includes all the basic fields of a | |
4465 | package definition. | |
4466 | ||
4467 | When importing a GNU package, the synopsis and descriptions are replaced | |
4468 | by their canonical upstream variant. | |
4469 | ||
961d0d2d LC |
4470 | Usually, you will first need to do: |
4471 | ||
4472 | @example | |
4473 | export NIX_REMOTE=daemon | |
4474 | @end example | |
4475 | ||
4476 | @noindent | |
4477 | so that @command{nix-instantiate} does not try to open the Nix database. | |
4478 | ||
2f7d2d91 LC |
4479 | As an example, the command below imports the package definition of |
4480 | LibreOffice (more precisely, it imports the definition of the package | |
4481 | bound to the @code{libreoffice} top-level attribute): | |
4482 | ||
4483 | @example | |
4484 | guix import nix ~/path/to/nixpkgs libreoffice | |
4485 | @end example | |
863af4e1 FB |
4486 | |
4487 | @item hackage | |
4488 | @cindex hackage | |
f97c9175 | 4489 | Import metadata from the Haskell community's central package archive |
863af4e1 FB |
4490 | @uref{https://hackage.haskell.org/, Hackage}. Information is taken from |
4491 | Cabal files and includes all the relevant information, including package | |
4492 | dependencies. | |
4493 | ||
4494 | Specific command-line options are: | |
4495 | ||
4496 | @table @code | |
a4154748 FB |
4497 | @item --stdin |
4498 | @itemx -s | |
f97c9175 | 4499 | Read a Cabal file from standard input. |
863af4e1 FB |
4500 | @item --no-test-dependencies |
4501 | @itemx -t | |
f97c9175 | 4502 | Do not include dependencies required only by the test suites. |
a4154748 FB |
4503 | @item --cabal-environment=@var{alist} |
4504 | @itemx -e @var{alist} | |
4505 | @var{alist} is a Scheme alist defining the environment in which the | |
4506 | Cabal conditionals are evaluated. The accepted keys are: @code{os}, | |
4507 | @code{arch}, @code{impl} and a string representing the name of a flag. | |
4508 | The value associated with a flag has to be either the symbol | |
4509 | @code{true} or @code{false}. The value associated with other keys | |
4510 | has to conform to the Cabal file format definition. The default value | |
4511 | associated with the keys @code{os}, @code{arch} and @code{impl} is | |
f97c9175 | 4512 | @samp{linux}, @samp{x86_64} and @samp{ghc}, respectively. |
863af4e1 FB |
4513 | @end table |
4514 | ||
f97c9175 | 4515 | The command below imports metadata for the latest version of the |
a4154748 FB |
4516 | @code{HTTP} Haskell package without including test dependencies and |
4517 | specifying the value of the flag @samp{network-uri} as @code{false}: | |
863af4e1 FB |
4518 | |
4519 | @example | |
a4154748 | 4520 | guix import hackage -t -e "'((\"network-uri\" . false))" HTTP |
863af4e1 FB |
4521 | @end example |
4522 | ||
4523 | A specific package version may optionally be specified by following the | |
4524 | package name by a hyphen and a version number as in the following example: | |
4525 | ||
4526 | @example | |
4527 | guix import hackage mtl-2.1.3.1 | |
4528 | @end example | |
7f74a931 FB |
4529 | |
4530 | @item elpa | |
4531 | @cindex elpa | |
f97c9175 | 4532 | Import metadata from an Emacs Lisp Package Archive (ELPA) package |
7f74a931 FB |
4533 | repository (@pxref{Packages,,, emacs, The GNU Emacs Manual}). |
4534 | ||
4535 | Specific command-line options are: | |
4536 | ||
4537 | @table @code | |
4538 | @item --archive=@var{repo} | |
4539 | @itemx -a @var{repo} | |
4540 | @var{repo} identifies the archive repository from which to retrieve the | |
4541 | information. Currently the supported repositories and their identifiers | |
4542 | are: | |
4543 | @itemize - | |
4544 | @item | |
840bd1d3 | 4545 | @uref{http://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} |
7f74a931 FB |
4546 | identifier. This is the default. |
4547 | ||
4548 | @item | |
840bd1d3 | 4549 | @uref{http://stable.melpa.org/packages, MELPA-Stable}, selected by the |
7f74a931 FB |
4550 | @code{melpa-stable} identifier. |
4551 | ||
4552 | @item | |
840bd1d3 | 4553 | @uref{http://melpa.org/packages, MELPA}, selected by the @code{melpa} |
7f74a931 FB |
4554 | identifier. |
4555 | @end itemize | |
4556 | @end table | |
2f7d2d91 LC |
4557 | @end table |
4558 | ||
4559 | The structure of the @command{guix import} code is modular. It would be | |
4560 | useful to have more importers for other package formats, and your help | |
4561 | is welcome here (@pxref{Contributing}). | |
4562 | ||
37166310 LC |
4563 | @node Invoking guix refresh |
4564 | @section Invoking @command{guix refresh} | |
4565 | ||
4566 | The primary audience of the @command{guix refresh} command is developers | |
4567 | of the GNU software distribution. By default, it reports any packages | |
4568 | provided by the distribution that are outdated compared to the latest | |
4569 | upstream version, like this: | |
4570 | ||
4571 | @example | |
4572 | $ guix refresh | |
4573 | gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1 | |
4574 | gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0 | |
4575 | @end example | |
4576 | ||
f97c9175 AE |
4577 | It does so by browsing the FTP directory of each package and determining |
4578 | the highest version number of the source tarballs therein. The command | |
bcb571cb LC |
4579 | knows how to update specific types of packages: GNU packages, ELPA |
4580 | packages, etc.---see the documentation for @option{--type} below. The | |
4581 | are many packages, though, for which it lacks a method to determine | |
4582 | whether a new upstream release is available. However, the mechanism is | |
4583 | extensible, so feel free to get in touch with us to add a new method! | |
37166310 LC |
4584 | |
4585 | When passed @code{--update}, it modifies distribution source files to | |
f97c9175 | 4586 | update the version numbers and source tarball hashes of those package |
37166310 LC |
4587 | recipes (@pxref{Defining Packages}). This is achieved by downloading |
4588 | each package's latest source tarball and its associated OpenPGP | |
4589 | signature, authenticating the downloaded tarball against its signature | |
4590 | using @command{gpg}, and finally computing its hash. When the public | |
4591 | key used to sign the tarball is missing from the user's keyring, an | |
4592 | attempt is made to automatically retrieve it from a public key server; | |
f97c9175 | 4593 | when this is successful, the key is added to the user's keyring; otherwise, |
37166310 LC |
4594 | @command{guix refresh} reports an error. |
4595 | ||
4596 | The following options are supported: | |
4597 | ||
4598 | @table @code | |
4599 | ||
2d7fc7da LC |
4600 | @item --expression=@var{expr} |
4601 | @itemx -e @var{expr} | |
4602 | Consider the package @var{expr} evaluates to. | |
4603 | ||
4604 | This is useful to precisely refer to a package, as in this example: | |
4605 | ||
4606 | @example | |
4607 | guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)' | |
4608 | @end example | |
4609 | ||
4610 | This command lists the dependents of the ``final'' libc (essentially all | |
4611 | the packages.) | |
4612 | ||
37166310 LC |
4613 | @item --update |
4614 | @itemx -u | |
38e16b49 LC |
4615 | Update distribution source files (package recipes) in place. This is |
4616 | usually run from a checkout of the Guix source tree (@pxref{Running | |
4617 | Guix Before It Is Installed}): | |
4618 | ||
4619 | @example | |
4620 | $ ./pre-inst-env guix refresh -s non-core | |
4621 | @end example | |
4622 | ||
081145cf | 4623 | @xref{Defining Packages}, for more information on package definitions. |
37166310 LC |
4624 | |
4625 | @item --select=[@var{subset}] | |
4626 | @itemx -s @var{subset} | |
4627 | Select all the packages in @var{subset}, one of @code{core} or | |
4628 | @code{non-core}. | |
4629 | ||
4630 | The @code{core} subset refers to all the packages at the core of the | |
4631 | distribution---i.e., packages that are used to build ``everything | |
4632 | else''. This includes GCC, libc, Binutils, Bash, etc. Usually, | |
4633 | changing one of these packages in the distribution entails a rebuild of | |
4634 | all the others. Thus, such updates are an inconvenience to users in | |
4635 | terms of build time or bandwidth used to achieve the upgrade. | |
4636 | ||
4637 | The @code{non-core} subset refers to the remaining packages. It is | |
4638 | typically useful in cases where an update of the core packages would be | |
4639 | inconvenient. | |
4640 | ||
bcb571cb LC |
4641 | @item --type=@var{updater} |
4642 | @itemx -t @var{updater} | |
7191adc5 AK |
4643 | Select only packages handled by @var{updater} (may be a comma-separated |
4644 | list of updaters). Currently, @var{updater} may be one of: | |
bcb571cb LC |
4645 | |
4646 | @table @code | |
4647 | @item gnu | |
4648 | the updater for GNU packages; | |
e80c0f85 LC |
4649 | @item gnome |
4650 | the updater for GNOME packages; | |
bcb571cb | 4651 | @item elpa |
d882c235 LC |
4652 | the updater for @uref{http://elpa.gnu.org/, ELPA} packages; |
4653 | @item cran | |
b9d044ef | 4654 | the updater for @uref{http://cran.r-project.org/, CRAN} packages; |
d0bd632f RW |
4655 | @item bioconductor |
4656 | the updater for @uref{http://www.bioconductor.org/, Bioconductor} R packages; | |
bab020d7 | 4657 | @item pypi |
b9d044ef | 4658 | the updater for @uref{https://pypi.python.org, PyPI} packages. |
fbc5b815 BW |
4659 | @item gem |
4660 | the updater for @uref{https://rubygems.org, RubyGems} packages. | |
bcb571cb LC |
4661 | @end table |
4662 | ||
f97c9175 AE |
4663 | For instance, the following command only checks for updates of Emacs |
4664 | packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages: | |
bcb571cb LC |
4665 | |
4666 | @example | |
7191adc5 | 4667 | $ guix refresh --type=elpa,cran |
d882c235 | 4668 | gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0 |
bcb571cb LC |
4669 | gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9 |
4670 | @end example | |
4671 | ||
37166310 LC |
4672 | @end table |
4673 | ||
4674 | In addition, @command{guix refresh} can be passed one or more package | |
4675 | names, as in this example: | |
4676 | ||
4677 | @example | |
38e16b49 | 4678 | $ ./pre-inst-env guix refresh -u emacs idutils gcc-4.8.4 |
37166310 LC |
4679 | @end example |
4680 | ||
4681 | @noindent | |
4682 | The command above specifically updates the @code{emacs} and | |
4683 | @code{idutils} packages. The @code{--select} option would have no | |
4684 | effect in this case. | |
4685 | ||
7d193ec3 EB |
4686 | When considering whether to upgrade a package, it is sometimes |
4687 | convenient to know which packages would be affected by the upgrade and | |
4688 | should be checked for compatibility. For this the following option may | |
4689 | be used when passing @command{guix refresh} one or more package names: | |
4690 | ||
4691 | @table @code | |
4692 | ||
6ffa706b AK |
4693 | @item --list-updaters |
4694 | @itemx -L | |
4695 | List available updaters and exit (see @option{--type} above.) | |
4696 | ||
7d193ec3 EB |
4697 | @item --list-dependent |
4698 | @itemx -l | |
4699 | List top-level dependent packages that would need to be rebuilt as a | |
4700 | result of upgrading one or more packages. | |
4701 | ||
4702 | @end table | |
4703 | ||
4704 | Be aware that the @code{--list-dependent} option only | |
4705 | @emph{approximates} the rebuilds that would be required as a result of | |
4706 | an upgrade. More rebuilds might be required under some circumstances. | |
4707 | ||
4708 | @example | |
7779ab61 LC |
4709 | $ guix refresh --list-dependent flex |
4710 | Building the following 120 packages would ensure 213 dependent packages are rebuilt: | |
4711 | hop-2.4.0 geiser-0.4 notmuch-0.18 mu-0.9.9.5 cflow-1.4 idutils-4.6 @dots{} | |
7d193ec3 EB |
4712 | @end example |
4713 | ||
4714 | The command above lists a set of packages that could be built to check | |
4715 | for compatibility with an upgraded @code{flex} package. | |
4716 | ||
f9230085 LC |
4717 | The following options can be used to customize GnuPG operation: |
4718 | ||
4719 | @table @code | |
4720 | ||
f9230085 LC |
4721 | @item --gpg=@var{command} |
4722 | Use @var{command} as the GnuPG 2.x command. @var{command} is searched | |
4723 | for in @code{$PATH}. | |
4724 | ||
2bc53ba9 LC |
4725 | @item --key-download=@var{policy} |
4726 | Handle missing OpenPGP keys according to @var{policy}, which may be one | |
4727 | of: | |
4728 | ||
4729 | @table @code | |
4730 | @item always | |
4731 | Always download missing OpenPGP keys from the key server, and add them | |
4732 | to the user's GnuPG keyring. | |
4733 | ||
4734 | @item never | |
4735 | Never try to download missing OpenPGP keys. Instead just bail out. | |
4736 | ||
4737 | @item interactive | |
4738 | When a package signed with an unknown OpenPGP key is encountered, ask | |
4739 | the user whether to download it or not. This is the default behavior. | |
4740 | @end table | |
4741 | ||
4742 | @item --key-server=@var{host} | |
4743 | Use @var{host} as the OpenPGP key server when importing a public key. | |
4744 | ||
f9230085 LC |
4745 | @end table |
4746 | ||
b4f5e0e8 CR |
4747 | @node Invoking guix lint |
4748 | @section Invoking @command{guix lint} | |
f97c9175 AE |
4749 | The @command{guix lint} command is meant to help package developers avoid |
4750 | common errors and use a consistent style. It runs a number of checks on | |
4751 | a given set of packages in order to find common mistakes in their | |
873c4085 LC |
4752 | definitions. Available @dfn{checkers} include (see |
4753 | @code{--list-checkers} for a complete list): | |
4754 | ||
4755 | @table @code | |
4756 | @item synopsis | |
4757 | @itemx description | |
4758 | Validate certain typographical and stylistic rules about package | |
4759 | descriptions and synopses. | |
4760 | ||
4761 | @item inputs-should-be-native | |
4762 | Identify inputs that should most likely be native inputs. | |
4763 | ||
4764 | @item source | |
4765 | @itemx home-page | |
50f5c46d | 4766 | @itemx source-file-name |
873c4085 | 4767 | Probe @code{home-page} and @code{source} URLs and report those that are |
50f5c46d | 4768 | invalid. Check that the source file name is meaningful, e.g. is not |
f97c9175 AE |
4769 | just a version number or ``git-checkout'', without a declared |
4770 | @code{file-name} (@pxref{origin Reference}). | |
40a7d4e5 | 4771 | |
5432734b LC |
4772 | @item cve |
4773 | Report known vulnerabilities found in the Common Vulnerabilities and | |
4774 | Exposures (CVE) database | |
4775 | @uref{https://nvd.nist.gov/download.cfm#CVE_FEED, published by the US | |
4776 | NIST}. | |
4777 | ||
40a7d4e5 LC |
4778 | @item formatting |
4779 | Warn about obvious source code formatting issues: trailing white space, | |
4780 | use of tabulations, etc. | |
873c4085 | 4781 | @end table |
b4f5e0e8 CR |
4782 | |
4783 | The general syntax is: | |
4784 | ||
4785 | @example | |
4786 | guix lint @var{options} @var{package}@dots{} | |
4787 | @end example | |
4788 | ||
4789 | If no package is given on the command line, then all packages are checked. | |
4790 | The @var{options} may be zero or more of the following: | |
4791 | ||
4792 | @table @code | |
f97c9175 AE |
4793 | @item --list-checkers |
4794 | @itemx -l | |
4795 | List and describe all the available checkers that will be run on packages | |
4796 | and exit. | |
b4f5e0e8 | 4797 | |
dd7c013d CR |
4798 | @item --checkers |
4799 | @itemx -c | |
4800 | Only enable the checkers specified in a comma-separated list using the | |
4801 | names returned by @code{--list-checkers}. | |
4802 | ||
b4f5e0e8 | 4803 | @end table |
37166310 | 4804 | |
fcc58db6 LC |
4805 | @node Invoking guix size |
4806 | @section Invoking @command{guix size} | |
4807 | ||
4808 | The @command{guix size} command helps package developers profile the | |
4809 | disk usage of packages. It is easy to overlook the impact of an | |
4810 | additional dependency added to a package, or the impact of using a | |
4811 | single output for a package that could easily be split (@pxref{Packages | |
f97c9175 | 4812 | with Multiple Outputs}). Such are the typical issues that |
fcc58db6 LC |
4813 | @command{guix size} can highlight. |
4814 | ||
4815 | The command can be passed a package specification such as @code{gcc-4.8} | |
4816 | or @code{guile:debug}, or a file name in the store. Consider this | |
4817 | example: | |
4818 | ||
4819 | @example | |
4820 | $ guix size coreutils | |
4821 | store item total self | |
4822 | /gnu/store/@dots{}-coreutils-8.23 70.0 13.9 19.8% | |
4823 | /gnu/store/@dots{}-gmp-6.0.0a 55.3 2.5 3.6% | |
4824 | /gnu/store/@dots{}-acl-2.2.52 53.7 0.5 0.7% | |
4825 | /gnu/store/@dots{}-attr-2.4.46 53.2 0.3 0.5% | |
4826 | /gnu/store/@dots{}-gcc-4.8.4-lib 52.9 15.7 22.4% | |
4827 | /gnu/store/@dots{}-glibc-2.21 37.2 37.2 53.1% | |
4828 | @end example | |
4829 | ||
4830 | @cindex closure | |
4831 | The store items listed here constitute the @dfn{transitive closure} of | |
4832 | Coreutils---i.e., Coreutils and all its dependencies, recursively---as | |
4833 | would be returned by: | |
4834 | ||
4835 | @example | |
4836 | $ guix gc -R /gnu/store/@dots{}-coreutils-8.23 | |
4837 | @end example | |
4838 | ||
f97c9175 | 4839 | Here the output shows three columns next to store items. The first column, |
fcc58db6 LC |
4840 | labeled ``total'', shows the size in mebibytes (MiB) of the closure of |
4841 | the store item---that is, its own size plus the size of all its | |
4842 | dependencies. The next column, labeled ``self'', shows the size of the | |
f97c9175 AE |
4843 | item itself. The last column shows the ratio of the size of the item |
4844 | itself to the space occupied by all the items listed here. | |
fcc58db6 LC |
4845 | |
4846 | In this example, we see that the closure of Coreutils weighs in at | |
4847 | 70@tie{}MiB, half of which is taken by libc. (That libc represents a | |
4848 | large fraction of the closure is not a problem @i{per se} because it is | |
4849 | always available on the system anyway.) | |
4850 | ||
4851 | When the package passed to @command{guix size} is available in the | |
4852 | store, @command{guix size} queries the daemon to determine its | |
4853 | dependencies, and measures its size in the store, similar to @command{du | |
4854 | -ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU | |
4855 | Coreutils}). | |
4856 | ||
4857 | When the given package is @emph{not} in the store, @command{guix size} | |
f97c9175 AE |
4858 | reports information based on the available substitutes |
4859 | (@pxref{Substitutes}). This makes it possible it to profile disk usage of | |
4860 | store items that are not even on disk, only available remotely. | |
fcc58db6 | 4861 | |
a8f996c6 | 4862 | The available options are: |
fcc58db6 LC |
4863 | |
4864 | @table @option | |
4865 | ||
d490d06e LC |
4866 | @item --substitute-urls=@var{urls} |
4867 | Use substitute information from @var{urls}. | |
4868 | @xref{client-substitute-urls, the same option for @code{guix build}}. | |
4869 | ||
a8f996c6 | 4870 | @item --map-file=@var{file} |
f97c9175 | 4871 | Write a graphical map of disk usage in PNG format to @var{file}. |
a8f996c6 LC |
4872 | |
4873 | For the example above, the map looks like this: | |
4874 | ||
4875 | @image{images/coreutils-size-map,5in,, map of Coreutils disk usage | |
4876 | produced by @command{guix size}} | |
4877 | ||
4878 | This option requires that | |
4879 | @uref{http://wingolog.org/software/guile-charting/, Guile-Charting} be | |
4880 | installed and visible in Guile's module search path. When that is not | |
4881 | the case, @command{guix size} fails as it tries to load it. | |
4882 | ||
fcc58db6 LC |
4883 | @item --system=@var{system} |
4884 | @itemx -s @var{system} | |
4885 | Consider packages for @var{system}---e.g., @code{x86_64-linux}. | |
4886 | ||
4887 | @end table | |
4888 | ||
88856916 LC |
4889 | @node Invoking guix graph |
4890 | @section Invoking @command{guix graph} | |
4891 | ||
4892 | @cindex DAG | |
4893 | Packages and their dependencies form a @dfn{graph}, specifically a | |
4894 | directed acyclic graph (DAG). It can quickly become difficult to have a | |
f97c9175 AE |
4895 | mental model of the package DAG, so the @command{guix graph} command |
4896 | provides a visual representation of the DAG. @command{guix graph} | |
4897 | emits a DAG representation in the input format of | |
88856916 | 4898 | @uref{http://www.graphviz.org/, Graphviz}, so its output can be passed |
f97c9175 | 4899 | directly to the @command{dot} command of Graphviz. The general |
88856916 LC |
4900 | syntax is: |
4901 | ||
4902 | @example | |
4903 | guix graph @var{options} @var{package}@dots{} | |
4904 | @end example | |
4905 | ||
4906 | For example, the following command generates a PDF file representing the | |
4907 | package DAG for the GNU@tie{}Core Utilities, showing its build-time | |
4908 | dependencies: | |
4909 | ||
4910 | @example | |
4911 | guix graph coreutils | dot -Tpdf > dag.pdf | |
4912 | @end example | |
4913 | ||
4914 | The output looks like this: | |
4915 | ||
4916 | @image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils} | |
4917 | ||
4918 | Nice little graph, no? | |
4919 | ||
f97c9175 | 4920 | But there is more than one graph! The one above is concise: it is the |
88856916 | 4921 | graph of package objects, omitting implicit inputs such as GCC, libc, |
f97c9175 AE |
4922 | grep, etc. It is often useful to have such a concise graph, but |
4923 | sometimes one may want to see more details. @command{guix graph} supports | |
4924 | several types of graphs, allowing you to choose the level of detail: | |
88856916 LC |
4925 | |
4926 | @table @code | |
4927 | @item package | |
f97c9175 | 4928 | This is the default type used in the example above. It shows the DAG of |
88856916 LC |
4929 | package objects, excluding implicit dependencies. It is concise, but |
4930 | filters out many details. | |
4931 | ||
4932 | @item bag-emerged | |
4933 | This is the package DAG, @emph{including} implicit inputs. | |
4934 | ||
4935 | For instance, the following command: | |
4936 | ||
4937 | @example | |
4938 | guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf | |
4939 | @end example | |
4940 | ||
4941 | ... yields this bigger graph: | |
4942 | ||
4943 | @image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils} | |
4944 | ||
4945 | At the bottom of the graph, we see all the implicit inputs of | |
4946 | @var{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}}). | |
4947 | ||
f97c9175 | 4948 | Now, note that the dependencies of these implicit inputs---that is, the |
88856916 LC |
4949 | @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown |
4950 | here, for conciseness. | |
4951 | ||
4952 | @item bag | |
4953 | Similar to @code{bag-emerged}, but this time including all the bootstrap | |
4954 | dependencies. | |
4955 | ||
38b92daa LC |
4956 | @item bag-with-origins |
4957 | Similar to @code{bag}, but also showing origins and their dependencies. | |
4958 | ||
88856916 LC |
4959 | @item derivations |
4960 | This is the most detailed representation: It shows the DAG of | |
4961 | derivations (@pxref{Derivations}) and plain store items. Compared to | |
4962 | the above representation, many additional nodes are visible, including | |
f97c9175 | 4963 | build scripts, patches, Guile modules, etc. |
88856916 LC |
4964 | |
4965 | @end table | |
4966 | ||
f97c9175 | 4967 | All the types above correspond to @emph{build-time dependencies}. The |
88856916 LC |
4968 | following graph type represents the @emph{run-time dependencies}: |
4969 | ||
4970 | @table @code | |
4971 | @item references | |
4972 | This is the graph of @dfn{references} of a package output, as returned | |
4973 | by @command{guix gc --references} (@pxref{Invoking guix gc}). | |
4974 | ||
4975 | If the given package output is not available in the store, @command{guix | |
4976 | graph} attempts to obtain dependency information from substitutes. | |
4977 | @end table | |
4978 | ||
4979 | The available options are the following: | |
4980 | ||
4981 | @table @option | |
4982 | @item --type=@var{type} | |
4983 | @itemx -t @var{type} | |
4984 | Produce a graph output of @var{type}, where @var{type} must be one of | |
4985 | the values listed above. | |
4986 | ||
4987 | @item --list-types | |
4988 | List the supported graph types. | |
4c8f997a LC |
4989 | |
4990 | @item --expression=@var{expr} | |
4991 | @itemx -e @var{expr} | |
4992 | Consider the package @var{expr} evaluates to. | |
4993 | ||
4994 | This is useful to precisely refer to a package, as in this example: | |
4995 | ||
4996 | @example | |
4997 | guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)' | |
4998 | @end example | |
88856916 LC |
4999 | @end table |
5000 | ||
5001 | ||
372c4bbc DT |
5002 | @node Invoking guix environment |
5003 | @section Invoking @command{guix environment} | |
5004 | ||
f5fd4fd2 | 5005 | @cindex reproducible build environments |
fe36d84e | 5006 | @cindex development environments |
372c4bbc DT |
5007 | The purpose of @command{guix environment} is to assist hackers in |
5008 | creating reproducible development environments without polluting their | |
5009 | package profile. The @command{guix environment} tool takes one or more | |
f97c9175 | 5010 | packages, builds all of their inputs, and creates a shell |
372c4bbc DT |
5011 | environment to use them. |
5012 | ||
5013 | The general syntax is: | |
5014 | ||
5015 | @example | |
5016 | guix environment @var{options} @var{package}@dots{} | |
5017 | @end example | |
5018 | ||
fe36d84e LC |
5019 | The following example spawns a new shell set up for the development of |
5020 | GNU@tie{}Guile: | |
372c4bbc DT |
5021 | |
5022 | @example | |
5023 | guix environment guile | |
5024 | @end example | |
5025 | ||
f97c9175 AE |
5026 | If the needed dependencies are not built yet, @command{guix environment} |
5027 | automatically builds them. The environment of the new shell is an augmented | |
372c4bbc DT |
5028 | version of the environment that @command{guix environment} was run in. |
5029 | It contains the necessary search paths for building the given package | |
5030 | added to the existing environment variables. To create a ``pure'' | |
f97c9175 | 5031 | environment, in which the original environment variables have been unset, |
50500f7c LC |
5032 | use the @code{--pure} option@footnote{Users sometimes wrongfully augment |
5033 | environment variables such as @code{PATH} in their @file{~/.bashrc} | |
5034 | file. As a consequence, when @code{guix environment} launches it, Bash | |
5035 | may read @file{~/.bashrc}, thereby introducing ``impurities'' in these | |
5036 | environment variables. It is an error to define such environment | |
5037 | variables in @file{.bashrc}; instead, they should be defined in | |
5038 | @file{.bash_profile}, which is sourced only by log-in shells. | |
5039 | @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for | |
5040 | details on Bash start-up files.}. | |
372c4bbc | 5041 | |
28de8d25 LC |
5042 | @vindex GUIX_ENVIRONMENT |
5043 | @command{guix environment} defines the @code{GUIX_ENVIRONMENT} | |
f97c9175 | 5044 | variable in the shell it spawns. This allows users to, say, define a |
28de8d25 LC |
5045 | specific prompt for development environments in their @file{.bashrc} |
5046 | (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}): | |
5047 | ||
5048 | @example | |
5049 | if [ -n "$GUIX_ENVIRONMENT" ] | |
5050 | then | |
5051 | export PS1="\u@@\h \w [dev]\$ " | |
5052 | fi | |
5053 | @end example | |
5054 | ||
372c4bbc DT |
5055 | Additionally, more than one package may be specified, in which case the |
5056 | union of the inputs for the given packages are used. For example, the | |
5057 | command below spawns a shell where all of the dependencies of both Guile | |
5058 | and Emacs are available: | |
5059 | ||
5060 | @example | |
5061 | guix environment guile emacs | |
5062 | @end example | |
5063 | ||
1de2fe95 DT |
5064 | Sometimes an interactive shell session is not desired. An arbitrary |
5065 | command may be invoked by placing the @code{--} token to separate the | |
5066 | command from the rest of the arguments: | |
372c4bbc DT |
5067 | |
5068 | @example | |
1de2fe95 | 5069 | guix environment guile -- make -j4 |
372c4bbc DT |
5070 | @end example |
5071 | ||
fe36d84e LC |
5072 | In other situations, it is more convenient to specify the list of |
5073 | packages needed in the environment. For example, the following command | |
5074 | runs @command{python} from an environment containing Python@tie{}2.7 and | |
5075 | NumPy: | |
5076 | ||
5077 | @example | |
1de2fe95 | 5078 | guix environment --ad-hoc python2-numpy python-2.7 -- python |
fe36d84e LC |
5079 | @end example |
5080 | ||
cc90fbbf DT |
5081 | Furthermore, one might want the dependencies of a package and also some |
5082 | additional packages that are not build-time or runtime dependencies, but | |
5083 | are useful when developing nonetheless. Because of this, the | |
5084 | @code{--ad-hoc} flag is positional. Packages appearing before | |
5085 | @code{--ad-hoc} are interpreted as packages whose dependencies will be | |
5086 | added to the environment. Packages appearing after are interpreted as | |
5087 | packages that will be added to the environment directly. For example, | |
5088 | the following command creates a Guix development environment that | |
5089 | additionally includes Git and strace: | |
5090 | ||
5091 | @example | |
5092 | guix environment guix --ad-hoc git strace | |
5093 | @end example | |
5094 | ||
f535dcbe DT |
5095 | Sometimes it is desirable to isolate the environment as much as |
5096 | possible, for maximal purity and reproducibility. In particular, when | |
5097 | using Guix on a host distro that is not GuixSD, it is desirable to | |
5098 | prevent access to @file{/usr/bin} and other system-wide resources from | |
5099 | the development environment. For example, the following command spawns | |
5100 | a Guile REPL in a ``container'' where only the store and the current | |
5101 | working directory are mounted: | |
5102 | ||
5103 | @example | |
5104 | guix environment --ad-hoc --container guile -- guile | |
5105 | @end example | |
5106 | ||
0f252e26 | 5107 | @quotation Note |
cfd35b4e | 5108 | The @code{--container} option requires Linux-libre 3.19 or newer. |
0f252e26 DT |
5109 | @end quotation |
5110 | ||
fe36d84e | 5111 | The available options are summarized below. |
372c4bbc DT |
5112 | |
5113 | @table @code | |
5114 | @item --expression=@var{expr} | |
5115 | @itemx -e @var{expr} | |
c9c282ce DT |
5116 | Create an environment for the package or list of packages that |
5117 | @var{expr} evaluates to. | |
372c4bbc | 5118 | |
fe36d84e LC |
5119 | For example, running: |
5120 | ||
5121 | @example | |
5122 | guix environment -e '(@@ (gnu packages maths) petsc-openmpi)' | |
5123 | @end example | |
5124 | ||
5125 | starts a shell with the environment for this specific variant of the | |
5126 | PETSc package. | |
5127 | ||
c9c282ce DT |
5128 | Running: |
5129 | ||
5130 | @example | |
5c2b2f00 | 5131 | guix environment --ad-hoc -e '(@@ (gnu) %base-packages)' |
c9c282ce DT |
5132 | @end example |
5133 | ||
5134 | starts a shell with all the GuixSD base packages available. | |
5135 | ||
779aa003 DT |
5136 | The above commands only the use default output of the given packages. |
5137 | To select other outputs, two element tuples can be specified: | |
5138 | ||
5139 | @example | |
5140 | guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")' | |
5141 | @end example | |
5142 | ||
372c4bbc DT |
5143 | @item --load=@var{file} |
5144 | @itemx -l @var{file} | |
c9c282ce DT |
5145 | Create an environment for the package or list of packages that the code |
5146 | within @var{file} evaluates to. | |
372c4bbc | 5147 | |
fe36d84e LC |
5148 | As an example, @var{file} might contain a definition like this |
5149 | (@pxref{Defining Packages}): | |
5150 | ||
5151 | @example | |
5152 | @verbatiminclude environment-gdb.scm | |
5153 | @end example | |
5154 | ||
a54bd6d7 DT |
5155 | @item --ad-hoc |
5156 | Include all specified packages in the resulting environment, as if an | |
5157 | @i{ad hoc} package were defined with them as inputs. This option is | |
5158 | useful for quickly creating an environment without having to write a | |
5159 | package expression to contain the desired inputs. | |
5160 | ||
5161 | For instance, the command: | |
5162 | ||
5163 | @example | |
1de2fe95 | 5164 | guix environment --ad-hoc guile guile-sdl -- guile |
a54bd6d7 DT |
5165 | @end example |
5166 | ||
5167 | runs @command{guile} in an environment where Guile and Guile-SDL are | |
5168 | available. | |
5169 | ||
417c39f1 | 5170 | Note that this example implicitly asks for the default output of |
f97c9175 | 5171 | @code{guile} and @code{guile-sdl}, but it is possible to ask for a |
417c39f1 LC |
5172 | specific output---e.g., @code{glib:bin} asks for the @code{bin} output |
5173 | of @code{glib} (@pxref{Packages with Multiple Outputs}). | |
5174 | ||
cc90fbbf DT |
5175 | This option may be composed with the default behavior of @command{guix |
5176 | environment}. Packages appearing before @code{--ad-hoc} are interpreted | |
5177 | as packages whose dependencies will be added to the environment, the | |
5178 | default behavior. Packages appearing after are interpreted as packages | |
5179 | that will be added to the environment directly. | |
5180 | ||
372c4bbc DT |
5181 | @item --pure |
5182 | Unset existing environment variables when building the new environment. | |
5183 | This has the effect of creating an environment in which search paths | |
5184 | only contain package inputs. | |
5185 | ||
5186 | @item --search-paths | |
5187 | Display the environment variable definitions that make up the | |
5188 | environment. | |
ce367ef3 LC |
5189 | |
5190 | @item --system=@var{system} | |
5191 | @itemx -s @var{system} | |
5192 | Attempt to build for @var{system}---e.g., @code{i686-linux}. | |
f535dcbe DT |
5193 | |
5194 | @item --container | |
5195 | @itemx -C | |
5196 | @cindex container | |
5197 | Run @var{command} within an isolated container. The current working | |
56b6befb | 5198 | directory outside the container is mapped inside the |
f535dcbe DT |
5199 | container. Additionally, the spawned process runs as the current user |
5200 | outside the container, but has root privileges in the context of the | |
5201 | container. | |
5202 | ||
5203 | @item --network | |
5204 | @itemx -N | |
5205 | For containers, share the network namespace with the host system. | |
5206 | Containers created without this flag only have access to the loopback | |
5207 | device. | |
5208 | ||
5209 | @item --expose=@var{source}[=@var{target}] | |
5210 | For containers, expose the file system @var{source} from the host system | |
5211 | as the read-only file system @var{target} within the container. If | |
5212 | @var{target} is not specified, @var{source} is used as the target mount | |
5213 | point in the container. | |
5214 | ||
5215 | The example below spawns a Guile REPL in a container in which the user's | |
5216 | home directory is accessible read-only via the @file{/exchange} | |
5217 | directory: | |
5218 | ||
5219 | @example | |
5220 | guix environment --container --expose=$HOME=/exchange guile -- guile | |
5221 | @end example | |
5222 | ||
5c2b2f00 | 5223 | @item --share=@var{source}[=@var{target}] |
f535dcbe DT |
5224 | For containers, share the file system @var{source} from the host system |
5225 | as the writable file system @var{target} within the container. If | |
5226 | @var{target} is not specified, @var{source} is used as the target mount | |
5227 | point in the container. | |
5228 | ||
5229 | The example below spawns a Guile REPL in a container in which the user's | |
5230 | home directory is accessible for both reading and writing via the | |
5231 | @file{/exchange} directory: | |
5232 | ||
5233 | @example | |
5234 | guix environment --container --share=$HOME=/exchange guile -- guile | |
5235 | @end example | |
372c4bbc DT |
5236 | @end table |
5237 | ||
5238 | It also supports all of the common build options that @command{guix | |
ccd7158d | 5239 | build} supports (@pxref{Common Build Options}). |
372c4bbc | 5240 | |
aff8ce7c DT |
5241 | @node Invoking guix publish |
5242 | @section Invoking @command{guix publish} | |
5243 | ||
5244 | The purpose of @command{guix publish} is to enable users to easily share | |
f97c9175 | 5245 | their store with others, who can then use it as a substitute server |
8ce229fc LC |
5246 | (@pxref{Substitutes}). |
5247 | ||
5248 | When @command{guix publish} runs, it spawns an HTTP server which allows | |
5249 | anyone with network access to obtain substitutes from it. This means | |
5250 | that any machine running Guix can also act as if it were a build farm, | |
5251 | since the HTTP interface is compatible with Hydra, the software behind | |
5252 | the @code{hydra.gnu.org} build farm. | |
aff8ce7c DT |
5253 | |
5254 | For security, each substitute is signed, allowing recipients to check | |
5255 | their authenticity and integrity (@pxref{Substitutes}). Because | |
f97c9175 | 5256 | @command{guix publish} uses the signing key of the system, which is only |
5463fe51 LC |
5257 | readable by the system administrator, it must be started as root; the |
5258 | @code{--user} option makes it drop root privileges early on. | |
aff8ce7c | 5259 | |
b18812b6 LC |
5260 | The signing key pair must be generated before @command{guix publish} is |
5261 | launched, using @command{guix archive --generate-key} (@pxref{Invoking | |
5262 | guix archive}). | |
5263 | ||
aff8ce7c DT |
5264 | The general syntax is: |
5265 | ||
5266 | @example | |
5267 | guix publish @var{options}@dots{} | |
5268 | @end example | |
5269 | ||
5270 | Running @command{guix publish} without any additional arguments will | |
5271 | spawn an HTTP server on port 8080: | |
5272 | ||
5273 | @example | |
5274 | guix publish | |
5275 | @end example | |
5276 | ||
5277 | Once a publishing server has been authorized (@pxref{Invoking guix | |
5278 | archive}), the daemon may download substitutes from it: | |
5279 | ||
5280 | @example | |
5281 | guix-daemon --substitute-urls=http://example.org:8080 | |
5282 | @end example | |
5283 | ||
5284 | The following options are available: | |
5285 | ||
5286 | @table @code | |
5287 | @item --port=@var{port} | |
5288 | @itemx -p @var{port} | |
5289 | Listen for HTTP requests on @var{port}. | |
5290 | ||
9e2292ef LC |
5291 | @item --listen=@var{host} |
5292 | Listen on the network interface for @var{host}. The default is to | |
5293 | accept connections from any interface. | |
5294 | ||
5463fe51 LC |
5295 | @item --user=@var{user} |
5296 | @itemx -u @var{user} | |
5297 | Change privileges to @var{user} as soon as possible---i.e., once the | |
5298 | server socket is open and the signing key has been read. | |
5299 | ||
aff8ce7c DT |
5300 | @item --repl[=@var{port}] |
5301 | @itemx -r [@var{port}] | |
5302 | Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile | |
8ce229fc LC |
5303 | Reference Manual}) on @var{port} (37146 by default). This is used |
5304 | primarily for debugging a running @command{guix publish} server. | |
aff8ce7c DT |
5305 | @end table |
5306 | ||
1c52181f LC |
5307 | Enabling @command{guix publish} on a GuixSD system is a one-liner: just |
5308 | add a call to @code{guix-publish-service} in the @code{services} field | |
5309 | of the @code{operating-system} declaration (@pxref{guix-publish-service, | |
5310 | @code{guix-publish-service}}). | |
5311 | ||
d23c20f1 LC |
5312 | |
5313 | @node Invoking guix challenge | |
5314 | @section Invoking @command{guix challenge} | |
5315 | ||
5316 | @cindex reproducible builds | |
5317 | @cindex verifiable builds | |
5318 | ||
5319 | Do the binaries provided by this server really correspond to the source | |
f97c9175 | 5320 | code it claims to build? Is a package build process deterministic? |
d23c20f1 LC |
5321 | These are the questions the @command{guix challenge} command attempts to |
5322 | answer. | |
5323 | ||
5324 | The former is obviously an important question: Before using a substitute | |
f97c9175 | 5325 | server (@pxref{Substitutes}), one had better @emph{verify} that it |
d23c20f1 LC |
5326 | provides the right binaries, and thus @emph{challenge} it. The latter |
5327 | is what enables the former: If package builds are deterministic, then | |
5328 | independent builds of the package should yield the exact same result, | |
5329 | bit for bit; if a server provides a binary different from the one | |
5330 | obtained locally, it may be either corrupt or malicious. | |
5331 | ||
5332 | We know that the hash that shows up in @file{/gnu/store} file names is | |
5333 | the hash of all the inputs of the process that built the file or | |
5334 | directory---compilers, libraries, build scripts, | |
5335 | etc. (@pxref{Introduction}). Assuming deterministic build processes, | |
5336 | one store file name should map to exactly one build output. | |
5337 | @command{guix challenge} checks whether there is, indeed, a single | |
5338 | mapping by comparing the build outputs of several independent builds of | |
5339 | any given store item. | |
5340 | ||
f97c9175 | 5341 | The command output looks like this: |
d23c20f1 LC |
5342 | |
5343 | @smallexample | |
5344 | $ guix challenge --substitute-urls="http://hydra.gnu.org http://guix.example.org" | |
5345 | updating list of substitutes from 'http://hydra.gnu.org'... 100.0% | |
5346 | updating list of substitutes from 'http://guix.example.org'... 100.0% | |
5347 | /gnu/store/@dots{}-openssl-1.0.2d contents differ: | |
5348 | local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q | |
5349 | http://hydra.gnu.org/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q | |
5350 | http://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim | |
5351 | /gnu/store/@dots{}-git-2.5.0 contents differ: | |
5352 | local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha | |
5353 | http://hydra.gnu.org/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f | |
5354 | http://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73 | |
5355 | /gnu/store/@dots{}-pius-2.1.1 contents differ: | |
5356 | local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax | |
5357 | http://hydra.gnu.org/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax | |
5358 | http://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs | |
5359 | @end smallexample | |
5360 | ||
5361 | @noindent | |
5362 | In this example, @command{guix challenge} first scans the store to | |
5363 | determine the set of locally-built derivations---as opposed to store | |
5364 | items that were downloaded from a substitute server---and then queries | |
5365 | all the substitute servers. It then reports those store items for which | |
5366 | the servers obtained a result different from the local build. | |
5367 | ||
5368 | @cindex non-determinism, in package builds | |
5369 | As an example, @code{guix.example.org} always gets a different answer. | |
5370 | Conversely, @code{hydra.gnu.org} agrees with local builds, except in the | |
5371 | case of Git. This might indicate that the build process of Git is | |
5372 | non-deterministic, meaning that its output varies as a function of | |
5373 | various things that Guix does not fully control, in spite of building | |
5374 | packages in isolated environments (@pxref{Features}). Most common | |
5375 | sources of non-determinism include the addition of timestamps in build | |
5376 | results, the inclusion of random numbers, and directory listings sorted | |
5377 | by inode number. See @uref{http://reproducible.debian.net/howto/}, for | |
5378 | more information. | |
5379 | ||
f97c9175 | 5380 | To find out what is wrong with this Git binary, we can do something along |
d23c20f1 LC |
5381 | these lines (@pxref{Invoking guix archive}): |
5382 | ||
5383 | @example | |
5384 | $ wget -q -O - http://hydra.gnu.org/nar/@dots{}-git-2.5.0 \ | |
5385 | | guix archive -x /tmp/git | |
043f4698 | 5386 | $ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git |
d23c20f1 LC |
5387 | @end example |
5388 | ||
5389 | This command shows the difference between the files resulting from the | |
5390 | local build, and the files resulting from the build on | |
5391 | @code{hydra.gnu.org} (@pxref{Overview, Comparing and Merging Files,, | |
5392 | diffutils, Comparing and Merging Files}). The @command{diff} command | |
5393 | works great for text files. When binary files differ, a better option | |
5394 | is @uref{http://diffoscope.org/, Diffoscope}, a tool that helps | |
5395 | visualize differences for all kinds of files. | |
5396 | ||
f97c9175 | 5397 | Once you have done that work, you can tell whether the differences are due |
d23c20f1 LC |
5398 | to a non-deterministic build process or to a malicious server. We try |
5399 | hard to remove sources of non-determinism in packages to make it easier | |
f97c9175 AE |
5400 | to verify substitutes, but of course, this is a process that |
5401 | involves not just Guix, but a large part of the free software community. | |
d23c20f1 LC |
5402 | In the meantime, @command{guix challenge} is one tool to help address |
5403 | the problem. | |
5404 | ||
5405 | If you are writing packages for Guix, you are encouraged to check | |
5406 | whether @code{hydra.gnu.org} and other substitute servers obtain the | |
5407 | same build result as you did with: | |
5408 | ||
5409 | @example | |
5410 | $ guix challenge @var{package} | |
5411 | @end example | |
5412 | ||
5413 | @noindent | |
f97c9175 | 5414 | where @var{package} is a package specification such as |
d23c20f1 LC |
5415 | @code{guile-2.0} or @code{glibc:debug}. |
5416 | ||
5417 | The general syntax is: | |
5418 | ||
5419 | @example | |
5420 | guix challenge @var{options} [@var{packages}@dots{}] | |
5421 | @end example | |
5422 | ||
5423 | The one option that matters is: | |
5424 | ||
5425 | @table @code | |
5426 | ||
5427 | @item --substitute-urls=@var{urls} | |
5428 | Consider @var{urls} the whitespace-separated list of substitute source | |
5429 | URLs to compare to. | |
5430 | ||
5431 | @end table | |
5432 | ||
5433 | ||
32efa254 DT |
5434 | @node Invoking guix container |
5435 | @section Invoking @command{guix container} | |
5436 | @cindex container | |
5437 | ||
5438 | @quotation Note | |
5439 | As of version @value{VERSION}, this tool is experimental. The interface | |
5440 | is subject to radical change in the future. | |
5441 | @end quotation | |
5442 | ||
5443 | The purpose of @command{guix container} is to manipulate processes | |
5444 | running within an isolated environment, commonly known as a | |
46c36586 | 5445 | ``container'', typically created by the @command{guix environment} |
32efa254 DT |
5446 | (@pxref{Invoking guix environment}) and @command{guix system container} |
5447 | (@pxref{Invoking guix system}) commands. | |
5448 | ||
5449 | The general syntax is: | |
5450 | ||
5451 | @example | |
5452 | guix container @var{action} @var{options}@dots{} | |
5453 | @end example | |
5454 | ||
5455 | @var{action} specifies the operation to perform with a container, and | |
5456 | @var{options} specifies the context-specific arguments for the action. | |
5457 | ||
5458 | The following actions are available: | |
5459 | ||
5460 | @table @code | |
5461 | @item exec | |
5462 | Execute a command within the context of a running container. | |
5463 | ||
5464 | The syntax is: | |
5465 | ||
5466 | @example | |
5467 | guix container exec @var{pid} @var{program} @var{arguments}@dots{} | |
5468 | @end example | |
5469 | ||
5470 | @var{pid} specifies the process ID of the running container. | |
f97c9175 AE |
5471 | @var{program} specifies an executable file name within the root file |
5472 | system of the container. @var{arguments} are the additional options that | |
5473 | will be passed to @var{program}. | |
32efa254 DT |
5474 | |
5475 | The following command launches an interactive login shell inside a | |
5476 | GuixSD container, started by @command{guix system container}, and whose | |
5477 | process ID is 9001: | |
5478 | ||
5479 | @example | |
5480 | guix container exec 9001 /run/current-system/profile/bin/bash --login | |
5481 | @end example | |
5482 | ||
5483 | Note that the @var{pid} cannot be the parent process of a container. It | |
f97c9175 | 5484 | must be PID 1 of the container or one of its child processes. |
32efa254 DT |
5485 | |
5486 | @end table | |
5487 | ||
a1ba8475 LC |
5488 | @c ********************************************************************* |
5489 | @node GNU Distribution | |
5490 | @chapter GNU Distribution | |
5491 | ||
3ca2731c | 5492 | @cindex Guix System Distribution |
4705641f | 5493 | @cindex GuixSD |
3ca2731c LC |
5494 | Guix comes with a distribution of the GNU system consisting entirely of |
5495 | free software@footnote{The term ``free'' here refers to the | |
a1ba8475 | 5496 | @url{http://www.gnu.org/philosophy/free-sw.html,freedom provided to |
3ca2731c | 5497 | users of that software}.}. The |
35ed9306 LC |
5498 | distribution can be installed on its own (@pxref{System Installation}), |
5499 | but it is also possible to install Guix as a package manager on top of | |
5500 | an installed GNU/Linux system (@pxref{Installation}). To distinguish | |
3ca2731c | 5501 | between the two, we refer to the standalone distribution as the Guix |
4705641f | 5502 | System Distribution, or GuixSD. |
35ed9306 LC |
5503 | |
5504 | The distribution provides core GNU packages such as GNU libc, GCC, and | |
5505 | Binutils, as well as many GNU and non-GNU applications. The complete | |
5506 | list of available packages can be browsed | |
093ae1be | 5507 | @url{http://www.gnu.org/software/guix/packages,on-line} or by |
d03bb653 | 5508 | running @command{guix package} (@pxref{Invoking guix package}): |
a1ba8475 LC |
5509 | |
5510 | @example | |
e49951eb | 5511 | guix package --list-available |
a1ba8475 LC |
5512 | @end example |
5513 | ||
f97c9175 | 5514 | Our goal is to provide a practical 100% free software distribution of |
401c53c4 LC |
5515 | Linux-based and other variants of GNU, with a focus on the promotion and |
5516 | tight integration of GNU components, and an emphasis on programs and | |
5517 | tools that help users exert that freedom. | |
5518 | ||
3ca2731c | 5519 | Packages are currently available on the following platforms: |
c320011d LC |
5520 | |
5521 | @table @code | |
5522 | ||
5523 | @item x86_64-linux | |
5524 | Intel/AMD @code{x86_64} architecture, Linux-Libre kernel; | |
5525 | ||
5526 | @item i686-linux | |
5527 | Intel 32-bit architecture (IA32), Linux-Libre kernel; | |
5528 | ||
aa1e1947 | 5529 | @item armhf-linux |
aa725117 | 5530 | ARMv7-A architecture with hard float, Thumb-2 and NEON, |
f97c9175 AE |
5531 | using the EABI hard-float application binary interface (ABI), |
5532 | and Linux-Libre kernel. | |
aa1e1947 | 5533 | |
c320011d LC |
5534 | @item mips64el-linux |
5535 | little-endian 64-bit MIPS processors, specifically the Loongson series, | |
f97c9175 | 5536 | n32 ABI, and Linux-Libre kernel. |
c320011d LC |
5537 | |
5538 | @end table | |
5539 | ||
4705641f | 5540 | GuixSD itself is currently only available on @code{i686} and @code{x86_64}. |
3ca2731c | 5541 | |
c320011d LC |
5542 | @noindent |
5543 | For information on porting to other architectures or kernels, | |
f97c9175 | 5544 | @pxref{Porting}. |
c320011d | 5545 | |
401c53c4 | 5546 | @menu |
5af6de3e | 5547 | * System Installation:: Installing the whole operating system. |
35ed9306 | 5548 | * System Configuration:: Configuring the operating system. |
91ef73d4 | 5549 | * Installing Debugging Files:: Feeding the debugger. |
05962f29 | 5550 | * Security Updates:: Deploying security fixes quickly. |
401c53c4 | 5551 | * Package Modules:: Packages from the programmer's viewpoint. |
da7cabd4 | 5552 | * Packaging Guidelines:: Growing the distribution. |
401c53c4 | 5553 | * Bootstrapping:: GNU/Linux built from scratch. |
8b315a6d | 5554 | * Porting:: Targeting another platform or kernel. |
401c53c4 LC |
5555 | @end menu |
5556 | ||
5557 | Building this distribution is a cooperative effort, and you are invited | |
081145cf | 5558 | to join! @xref{Contributing}, for information about how you can help. |
401c53c4 | 5559 | |
5af6de3e LC |
5560 | @node System Installation |
5561 | @section System Installation | |
5562 | ||
3ca2731c LC |
5563 | @cindex Guix System Distribution |
5564 | This section explains how to install the Guix System Distribution | |
5565 | on a machine. The Guix package manager can | |
35ed9306 LC |
5566 | also be installed on top of a running GNU/Linux system, |
5567 | @pxref{Installation}. | |
5af6de3e LC |
5568 | |
5569 | @ifinfo | |
5570 | @c This paragraph is for people reading this from tty2 of the | |
5571 | @c installation image. | |
5572 | You're reading this documentation with an Info reader. For details on | |
5573 | how to use it, hit the @key{RET} key (``return'' or ``enter'') on the | |
6621cdb6 | 5574 | link that follows: @pxref{Help,,, info, Info: An Introduction}. Hit |
5af6de3e LC |
5575 | @kbd{l} afterwards to come back here. |
5576 | @end ifinfo | |
5577 | ||
dedb8d5e LC |
5578 | @menu |
5579 | * Limitations:: What you can expect. | |
5580 | * USB Stick Installation:: Preparing the installation medium. | |
5581 | * Preparing for Installation:: Networking, partitioning, etc. | |
5582 | * Proceeding with the Installation:: The real thing. | |
5583 | * Building the Installation Image:: How this comes to be. | |
5584 | @end menu | |
5585 | ||
5586 | @node Limitations | |
8aaaae38 LC |
5587 | @subsection Limitations |
5588 | ||
4705641f | 5589 | As of version @value{VERSION}, the Guix System Distribution (GuixSD) is |
3ca2731c | 5590 | not production-ready. It may contain bugs and lack important |
8aaaae38 LC |
5591 | features. Thus, if you are looking for a stable production system that |
5592 | respects your freedom as a computer user, a good solution at this point | |
5593 | is to consider @url{http://www.gnu.org/distros/free-distros.html, one of | |
f97c9175 | 5594 | the more established GNU/Linux distributions}. We hope you can soon switch |
4705641f | 5595 | to the GuixSD without fear, of course. In the meantime, you can |
8aaaae38 LC |
5596 | also keep using your distribution and try out the package manager on top |
5597 | of it (@pxref{Installation}). | |
5598 | ||
5599 | Before you proceed with the installation, be aware of the following | |
5600 | noteworthy limitations applicable to version @value{VERSION}: | |
5601 | ||
5602 | @itemize | |
5603 | @item | |
5604 | The installation process does not include a graphical user interface and | |
5605 | requires familiarity with GNU/Linux (see the following subsections to | |
5606 | get a feel of what that means.) | |
5607 | ||
5608 | @item | |
093ae1be | 5609 | The system does not yet provide full GNOME and KDE desktops. Xfce and |
f97c9175 | 5610 | Enlightenment are available, though, if graphical desktop environments |
093ae1be | 5611 | are your thing, as well as a number of X11 window managers. |
8aaaae38 LC |
5612 | |
5613 | @item | |
dbcb0ab1 | 5614 | Support for the Logical Volume Manager (LVM) is missing. |
8aaaae38 LC |
5615 | |
5616 | @item | |
5617 | Few system services are currently supported out-of-the-box | |
5618 | (@pxref{Services}). | |
5619 | ||
5620 | @item | |
dedb8d5e | 5621 | More than 3,000 packages are available, but you may |
8aaaae38 LC |
5622 | occasionally find that a useful package is missing. |
5623 | @end itemize | |
5624 | ||
f97c9175 AE |
5625 | You have been warned! But more than a disclaimer, this is an invitation |
5626 | to report issues (and success stories!), and to join us in improving it. | |
8aaaae38 | 5627 | @xref{Contributing}, for more info. |
5af6de3e | 5628 | |
dedb8d5e | 5629 | @node USB Stick Installation |
5af6de3e LC |
5630 | @subsection USB Stick Installation |
5631 | ||
5632 | An installation image for USB sticks can be downloaded from | |
4705641f | 5633 | @indicateurl{ftp://alpha.gnu.org/gnu/guix/guixsd-usb-install-@value{VERSION}.@var{system}.xz}, |
5af6de3e LC |
5634 | where @var{system} is one of: |
5635 | ||
5636 | @table @code | |
5637 | @item x86_64-linux | |
5638 | for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs; | |
5639 | ||
5640 | @item i686-linux | |
5641 | for a 32-bit GNU/Linux system on Intel-compatible CPUs. | |
5642 | @end table | |
5643 | ||
5644 | This image contains a single partition with the tools necessary for an | |
5645 | installation. It is meant to be copied @emph{as is} to a large-enough | |
5646 | USB stick. | |
5647 | ||
5648 | To copy the image to a USB stick, follow these steps: | |
5649 | ||
5650 | @enumerate | |
5651 | @item | |
5652 | Decompress the image using the @command{xz} command: | |
5653 | ||
5654 | @example | |
4705641f | 5655 | xz -d guixsd-usb-install-@value{VERSION}.@var{system}.xz |
5af6de3e LC |
5656 | @end example |
5657 | ||
5658 | @item | |
f97c9175 AE |
5659 | Insert a USB stick of 1@tie{}GiB or more into your machine, and determine |
5660 | its device name. Assuming that the USB stick is known as @file{/dev/sdX}, | |
5af6de3e LC |
5661 | copy the image with: |
5662 | ||
5663 | @example | |
4705641f | 5664 | dd if=guixsd-usb-install-@value{VERSION}.x86_64 of=/dev/sdX |
5af6de3e LC |
5665 | @end example |
5666 | ||
5667 | Access to @file{/dev/sdX} usually requires root privileges. | |
5668 | @end enumerate | |
5669 | ||
5670 | Once this is done, you should be able to reboot the system and boot from | |
5671 | the USB stick. The latter usually requires you to get in the BIOS' boot | |
5672 | menu, where you can choose to boot from the USB stick. | |
5673 | ||
dedb8d5e | 5674 | @node Preparing for Installation |
5af6de3e LC |
5675 | @subsection Preparing for Installation |
5676 | ||
5677 | Once you have successfully booted the image on the USB stick, you should | |
5678 | end up with a root prompt. Several console TTYs are configured and can | |
5679 | be used to run commands as root. TTY2 shows this documentation, | |
5680 | browsable using the Info reader commands (@pxref{Help,,, info, Info: An | |
ae7ffa9e LC |
5681 | Introduction}). The installation system runs the GPM mouse daemon, |
5682 | which allows you to select text with the left mouse button and to paste | |
5683 | it with the middle button. | |
5af6de3e | 5684 | |
dedb8d5e | 5685 | @subsubsection Keyboard Layout |
5af6de3e | 5686 | |
dedb8d5e LC |
5687 | @cindex keyboard layout |
5688 | The installation image uses the US qwerty keyboard layout. If you want | |
5689 | to change it, you can use the @command{loadkeys} command. For example, | |
5690 | the following command selects the Dvorak keyboard layout: | |
5af6de3e | 5691 | |
dedb8d5e LC |
5692 | @example |
5693 | loadkeys dvorak | |
5694 | @end example | |
5695 | ||
5696 | See the files under @file{/run/current-system/profile/share/keymaps} for | |
5697 | a list of available keyboard layouts. Run @command{man loadkeys} for | |
5698 | more information. | |
5699 | ||
5700 | @subsubsection Networking | |
5701 | ||
5702 | Run the following command see what your network interfaces are called: | |
235cba85 LC |
5703 | |
5704 | @example | |
dedb8d5e | 5705 | ifconfig -a |
235cba85 LC |
5706 | @end example |
5707 | ||
95c559c1 | 5708 | @c http://cgit.freedesktop.org/systemd/systemd/tree/src/udev/udev-builtin-net_id.c#n20 |
dedb8d5e LC |
5709 | Wired interfaces have a name starting with @samp{e}; for example, the |
5710 | interface corresponding to the first on-board Ethernet controller is | |
5711 | called @samp{eno1}. Wireless interfaces have a name starting with | |
5712 | @samp{w}, like @samp{w1p2s0}. | |
5713 | ||
5714 | @table @asis | |
5715 | @item Wired connection | |
5716 | To configure a wired network run the following command, substituting | |
5717 | @var{interface} with the name of the wired interface you want to use. | |
5718 | ||
5719 | @example | |
5720 | ifconfig @var{interface} up | |
5721 | @end example | |
5722 | ||
5723 | @item Wireless connection | |
5724 | To configure wireless networking, you can create a configuration file | |
5725 | for the @command{wpa_supplicant} configuration tool (its location is not | |
5726 | important) using one of the available text editors such as | |
5727 | @command{zile}: | |
5728 | ||
5729 | @example | |
5730 | zile wpa_supplicant.conf | |
5731 | @end example | |
5732 | ||
5733 | As an example, the following stanza can go to this file and will work | |
5734 | for many wireless networks, provided you give the actual SSID and | |
5735 | passphrase for the network you are connecting to: | |
5736 | ||
5737 | @example | |
5738 | network=@{ | |
5739 | ssid=@var{my-ssid} | |
5740 | key_mgmt=WPA-PSK | |
5741 | psk="the network's secret passphrase" | |
5742 | @} | |
5743 | @end example | |
5744 | ||
5745 | Start the wireless service and run it in the background with the | |
5746 | following command (substitute @var{interface} with the name of the | |
5747 | network interface you want to use): | |
5748 | ||
5749 | @example | |
5750 | wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B | |
5751 | @end example | |
5752 | ||
5753 | Run @command{man wpa_supplication} for more information. | |
5754 | @end table | |
5755 | ||
5756 | At this point, you need to acquire an IP address. On a network where IP | |
5757 | addresses are automatically assigned @i{via} DHCP, you can run: | |
5758 | ||
5759 | @example | |
5760 | dhclient @var{interface} | |
5761 | @end example | |
5af6de3e | 5762 | |
dedb8d5e LC |
5763 | Try to ping a server to see if networking is up and running: |
5764 | ||
5765 | @example | |
5766 | ping -c 3 gnu.org | |
5767 | @end example | |
5af6de3e LC |
5768 | |
5769 | Setting up network access is almost always a requirement because the | |
5770 | image does not contain all the software and tools that may be needed. | |
5771 | ||
dedb8d5e LC |
5772 | @subsubsection Disk Partitioning |
5773 | ||
5774 | Unless this has already been done, the next step is to partition, and | |
5775 | then format the target partition(s). | |
5776 | ||
5777 | The installation image includes several partitioning tools, including | |
5778 | Parted (@pxref{Overview,,, parted, GNU Parted User Manual}), | |
5779 | @command{fdisk}, and @command{cfdisk}. Run it and set up your disk with | |
5780 | the partition layout you want: | |
5781 | ||
5782 | @example | |
5783 | cfdisk | |
5784 | @end example | |
5785 | ||
5786 | Once you are done partitioning the target hard disk drive, you have to | |
5787 | create a file system on the relevant partition(s)@footnote{Currently | |
5788 | GuixSD pretty much assumes an ext4 file system. In particular, code | |
5789 | that reads partition UUIDs and labels only works with ext4. This will | |
5790 | be fixed in the future.}. | |
5af6de3e | 5791 | |
7ab44369 LC |
5792 | Preferably, assign partitions a label so that you can easily and |
5793 | reliably refer to them in @code{file-system} declarations (@pxref{File | |
5794 | Systems}). This is typically done using the @code{-L} option of | |
dedb8d5e LC |
5795 | @command{mkfs.ext4} and related commands. So, assuming the target root |
5796 | partition lives at @file{/dev/sda1}, a file system with the label | |
5797 | @code{my-root} can be created with: | |
7ab44369 | 5798 | |
dedb8d5e LC |
5799 | @example |
5800 | mkfs.ext4 -L my-root /dev/sda1 | |
5801 | @end example | |
dd816355 | 5802 | |
316d65be LC |
5803 | @c FIXME: Uncomment this once GRUB fully supports encrypted roots. |
5804 | @c A typical command sequence may be: | |
5805 | @c | |
5806 | @c @example | |
5807 | @c # fdisk /dev/sdX | |
5808 | @c @dots{} Create partitions etc.@dots{} | |
5809 | @c # cryptsetup luksFormat /dev/sdX1 | |
5810 | @c # cryptsetup open --type luks /dev/sdX1 my-partition | |
5811 | @c # mkfs.ext4 -L my-root /dev/mapper/my-partition | |
5812 | @c @end example | |
6d6e6281 | 5813 | |
dedb8d5e LC |
5814 | In addition to e2fsprogs, the suite of tools to manipulate |
5815 | ext2/ext3/ext4 file systems, the installation image includes | |
5816 | Cryptsetup/LUKS for disk encryption. | |
5af6de3e | 5817 | |
dedb8d5e LC |
5818 | Once that is done, mount the target root partition under @file{/mnt} |
5819 | with a command like (again, assuming @file{/dev/sda1} is the root | |
5820 | partition): | |
83a17b62 | 5821 | |
dedb8d5e LC |
5822 | @example |
5823 | mount /dev/sda1 /mnt | |
5824 | @end example | |
83a17b62 | 5825 | |
dedb8d5e LC |
5826 | @node Proceeding with the Installation |
5827 | @subsection Proceeding with the Installation | |
83a17b62 | 5828 | |
dedb8d5e LC |
5829 | With the target partitions ready and the target root mounted on |
5830 | @file{/mnt}, we're ready to go. First, run: | |
5af6de3e | 5831 | |
dedb8d5e LC |
5832 | @example |
5833 | herd start cow-store /mnt | |
5834 | @end example | |
5af6de3e | 5835 | |
dedb8d5e LC |
5836 | This makes @file{/gnu/store} copy-on-write, such that packages added to |
5837 | it during the installation phase are written to the target disk rather | |
5838 | than kept in memory. | |
5af6de3e | 5839 | |
dedb8d5e | 5840 | Next, you have to edit a file and |
5af6de3e LC |
5841 | provide the declaration of the operating system to be installed. To |
5842 | that end, the installation system comes with two text editors: GNU nano | |
5843 | (@pxref{Top,,, nano, GNU nano Manual}), and GNU Zile, an Emacs clone. | |
5844 | It is better to store that file on the target root file system, say, as | |
5845 | @file{/mnt/etc/config.scm}. | |
5846 | ||
dedb8d5e LC |
5847 | @xref{Using the Configuration System}, for an overview of the |
5848 | configuration file. The example configurations discussed in that | |
5849 | section are available under @file{/etc/configuration} in the | |
5850 | installation image. Thus, to get started with a system configuration | |
5851 | providing a graphical display server (a ``desktop'' system), you can run | |
5852 | something along these lines: | |
5853 | ||
5854 | @example | |
5855 | # mkdir /mnt/etc | |
5856 | # cp /etc/configuration/desktop.scm /mnt/etc/config.scm | |
5857 | # zile /mnt/etc/config.scm | |
5858 | @end example | |
5859 | ||
5860 | You should pay attention to what your configuration file contains, and | |
5861 | in particular: | |
5862 | ||
5863 | @itemize | |
5864 | @item | |
5865 | Make sure the @code{grub-configuration} form refers to the device you | |
5866 | want to install GRUB on. | |
5867 | ||
5868 | @item | |
5869 | Be sure that your partition labels match the value of their respective | |
5870 | @code{device} fields in your @code{file-system} configuration, assuming | |
5871 | your @code{file-system} configuration sets the value of @code{title} to | |
5872 | @code{'label}. | |
5873 | @end itemize | |
5af6de3e | 5874 | |
dd51caac LC |
5875 | Once you are done preparing the configuration file, the new system must |
5876 | be initialized (remember that the target root file system is mounted | |
5877 | under @file{/mnt}): | |
5af6de3e LC |
5878 | |
5879 | @example | |
5880 | guix system init /mnt/etc/config.scm /mnt | |
5881 | @end example | |
5882 | ||
5883 | @noindent | |
dedb8d5e | 5884 | This copies all the necessary files and installs GRUB on |
5af6de3e | 5885 | @file{/dev/sdX}, unless you pass the @option{--no-grub} option. For |
6621cdb6 | 5886 | more information, @pxref{Invoking guix system}. This command may trigger |
5af6de3e LC |
5887 | downloads or builds of missing packages, which can take some time. |
5888 | ||
1bd4e6db LC |
5889 | Once that command has completed---and hopefully succeeded!---you can run |
5890 | @command{reboot} and boot into the new system. The @code{root} password | |
5891 | in the new system is initially empty; other users' passwords need to be | |
5892 | initialized by running the @command{passwd} command as @code{root}, | |
5893 | unless your configuration specifies otherwise | |
5894 | (@pxref{user-account-password, user account passwords}). | |
5895 | ||
5896 | Join us on @code{#guix} on the Freenode IRC network or on | |
5af6de3e LC |
5897 | @file{guix-devel@@gnu.org} to share your experience---good or not so |
5898 | good. | |
5899 | ||
dedb8d5e | 5900 | @node Building the Installation Image |
5af6de3e LC |
5901 | @subsection Building the Installation Image |
5902 | ||
5903 | The installation image described above was built using the @command{guix | |
5904 | system} command, specifically: | |
5905 | ||
5906 | @example | |
8a225c66 | 5907 | guix system disk-image --image-size=850MiB gnu/system/install.scm |
5af6de3e LC |
5908 | @end example |
5909 | ||
5910 | @xref{Invoking guix system}, for more information. See | |
5911 | @file{gnu/system/install.scm} in the source tree for more information | |
5912 | about the installation image. | |
5913 | ||
cf4a9129 LC |
5914 | @node System Configuration |
5915 | @section System Configuration | |
b208a005 | 5916 | |
cf4a9129 | 5917 | @cindex system configuration |
3ca2731c | 5918 | The Guix System Distribution supports a consistent whole-system configuration |
cf4a9129 LC |
5919 | mechanism. By that we mean that all aspects of the global system |
5920 | configuration---such as the available system services, timezone and | |
5921 | locale settings, user accounts---are declared in a single place. Such | |
5922 | a @dfn{system configuration} can be @dfn{instantiated}---i.e., effected. | |
91ef73d4 | 5923 | |
cf4a9129 LC |
5924 | One of the advantages of putting all the system configuration under the |
5925 | control of Guix is that it supports transactional system upgrades, and | |
5926 | makes it possible to roll-back to a previous system instantiation, | |
5927 | should something go wrong with the new one (@pxref{Features}). Another | |
5928 | one is that it makes it easy to replicate the exact same configuration | |
5929 | across different machines, or at different points in time, without | |
5930 | having to resort to additional administration tools layered on top of | |
5931 | the system's own tools. | |
5932 | @c Yes, we're talking of Puppet, Chef, & co. here. ↑ | |
91ef73d4 | 5933 | |
cf4a9129 LC |
5934 | This section describes this mechanism. First we focus on the system |
5935 | administrator's viewpoint---explaining how the system is configured and | |
5936 | instantiated. Then we show how this mechanism can be extended, for | |
5937 | instance to support new system services. | |
91ef73d4 | 5938 | |
cf4a9129 LC |
5939 | @menu |
5940 | * Using the Configuration System:: Customizing your GNU system. | |
7313a52e | 5941 | * operating-system Reference:: Detail of operating-system declarations. |
cf4a9129 | 5942 | * File Systems:: Configuring file system mounts. |
510f9d86 | 5943 | * Mapped Devices:: Block device extra processing. |
cf4a9129 | 5944 | * User Accounts:: Specifying user accounts. |
598e19dc | 5945 | * Locales:: Language and cultural convention settings. |
cf4a9129 | 5946 | * Services:: Specifying system services. |
0ae8c15a | 5947 | * Setuid Programs:: Programs running with root privileges. |
efb5e833 | 5948 | * X.509 Certificates:: Authenticating HTTPS servers. |
996ed739 | 5949 | * Name Service Switch:: Configuring libc's name service switch. |
fd1b1fa2 | 5950 | * Initial RAM Disk:: Linux-Libre bootstrapping. |
88faf933 | 5951 | * GRUB Configuration:: Configuring the boot loader. |
cf4a9129 | 5952 | * Invoking guix system:: Instantiating a system configuration. |
97d76250 | 5953 | * Running GuixSD in a VM:: How to run GuixSD in a virtual machine. |
cf4a9129 LC |
5954 | * Defining Services:: Adding new service definitions. |
5955 | @end menu | |
91ef73d4 | 5956 | |
cf4a9129 LC |
5957 | @node Using the Configuration System |
5958 | @subsection Using the Configuration System | |
64d76fa6 | 5959 | |
cf4a9129 LC |
5960 | The operating system is configured by providing an |
5961 | @code{operating-system} declaration in a file that can then be passed to | |
5962 | the @command{guix system} command (@pxref{Invoking guix system}). A | |
5963 | simple setup, with the default system services, the default Linux-Libre | |
5964 | kernel, initial RAM disk, and boot loader looks like this: | |
91ef73d4 | 5965 | |
cf4a9129 LC |
5966 | @findex operating-system |
5967 | @lisp | |
dd51caac | 5968 | @include os-config-bare-bones.texi |
cf4a9129 | 5969 | @end lisp |
401c53c4 | 5970 | |
cf4a9129 LC |
5971 | This example should be self-describing. Some of the fields defined |
5972 | above, such as @code{host-name} and @code{bootloader}, are mandatory. | |
5973 | Others, such as @code{packages} and @code{services}, can be omitted, in | |
5974 | which case they get a default value. | |
e7f34eb0 | 5975 | |
5d94ac51 LC |
5976 | Below we discuss the effect of some of the most important fields |
5977 | (@pxref{operating-system Reference}, for details about all the available | |
5978 | fields), and how to @dfn{instantiate} the operating system using | |
5979 | @command{guix system}. | |
5980 | ||
5981 | @unnumberedsubsubsec Globally-Visible Packages | |
5982 | ||
cf4a9129 | 5983 | @vindex %base-packages |
5d94ac51 LC |
5984 | The @code{packages} field lists packages that will be globally visible |
5985 | on the system, for all user accounts---i.e., in every user's @code{PATH} | |
5986 | environment variable---in addition to the per-user profiles | |
5987 | (@pxref{Invoking guix package}). The @var{%base-packages} variable | |
5988 | provides all the tools one would expect for basic user and administrator | |
5989 | tasks---including the GNU Core Utilities, the GNU Networking Utilities, | |
5990 | the GNU Zile lightweight text editor, @command{find}, @command{grep}, | |
5991 | etc. The example above adds tcpdump to those, taken from the @code{(gnu | |
5992 | packages admin)} module (@pxref{Package Modules}). | |
e7f34eb0 | 5993 | |
f6c9fb1b LC |
5994 | @findex specification->package |
5995 | Referring to packages by variable name, like @var{tcpdump} above, has | |
5996 | the advantage of being unambiguous; it also allows typos and such to be | |
5997 | diagnosed right away as ``unbound variables''. The downside is that one | |
5998 | needs to know which module defines which package, and to augment the | |
5999 | @code{use-package-modules} line accordingly. To avoid that, one can use | |
6000 | the @code{specification->package} procedure of the @code{(gnu packages)} | |
6001 | module, which returns the best package for a given name or name and | |
6002 | version: | |
6003 | ||
6004 | @lisp | |
6005 | (use-modules (gnu packages)) | |
6006 | ||
6007 | (operating-system | |
6008 | ;; ... | |
6009 | (packages (append (map specification->package | |
6010 | '("tcpdump" "htop" "gnupg-2.0")) | |
6011 | %base-packages))) | |
6012 | @end lisp | |
6013 | ||
5d94ac51 LC |
6014 | @unnumberedsubsubsec System Services |
6015 | ||
cf4a9129 LC |
6016 | @vindex %base-services |
6017 | The @code{services} field lists @dfn{system services} to be made | |
6018 | available when the system starts (@pxref{Services}). | |
6019 | The @code{operating-system} declaration above specifies that, in | |
6020 | addition to the basic services, we want the @command{lshd} secure shell | |
cd6f6c22 LC |
6021 | daemon listening on port 2222 (@pxref{Networking Services, |
6022 | @code{lsh-service}}). Under the hood, | |
cf4a9129 LC |
6023 | @code{lsh-service} arranges so that @code{lshd} is started with the |
6024 | right command-line options, possibly with supporting configuration files | |
cd6f6c22 LC |
6025 | generated as needed (@pxref{Defining Services}). |
6026 | ||
6027 | @cindex customization, of services | |
6028 | @findex modify-services | |
6029 | Occasionally, instead of using the base services as is, you will want to | |
6030 | customize them. For instance, to change the configuration of | |
6031 | @code{guix-daemon} and Mingetty (the console log-in), you may write the | |
6032 | following instead of @var{%base-services}: | |
6033 | ||
6034 | @lisp | |
6035 | (modify-services %base-services | |
6036 | (guix-service-type config => | |
6037 | (guix-configuration | |
6038 | (inherit config) | |
6039 | (use-substitutes? #f) | |
6040 | (extra-options '("--gc-keep-outputs")))) | |
6041 | (mingetty-service-type config => | |
6042 | (mingetty-configuration | |
6043 | (inherit config) | |
6044 | (motd (plain-file "motd" "Hi there!"))))) | |
6045 | @end lisp | |
6046 | ||
6047 | @noindent | |
6048 | The effect here is to change the options passed to @command{guix-daemon} | |
6049 | when it is started, as well as the ``message of the day'' that appears | |
6050 | when logging in at the console. @xref{Service Reference, | |
6051 | @code{modify-services}}, for more on that. | |
a1ba8475 | 6052 | |
dd51caac | 6053 | The configuration for a typical ``desktop'' usage, with the X11 display |
cd6f6c22 | 6054 | server, a desktop environment, network management, power management, and |
dd51caac LC |
6055 | more, would look like this: |
6056 | ||
6057 | @lisp | |
6058 | @include os-config-desktop.texi | |
6059 | @end lisp | |
6060 | ||
6061 | @xref{Desktop Services}, for the exact list of services provided by | |
efb5e833 LC |
6062 | @var{%desktop-services}. @xref{X.509 Certificates}, for background |
6063 | information about the @code{nss-certs} package that is used here. | |
dd51caac | 6064 | |
5d94ac51 LC |
6065 | Again, @var{%desktop-services} is just a list of service objects. If |
6066 | you want to remove services from there, you can do so using the | |
6067 | procedures for list filtering (@pxref{SRFI-1 Filtering and | |
6068 | Partitioning,,, guile, GNU Guile Reference Manual}). For instance, the | |
6069 | following expression returns a list that contains all the services in | |
6070 | @var{%desktop-services} minus the Avahi service: | |
6071 | ||
6072 | @example | |
6073 | (remove (lambda (service) | |
6074 | (eq? (service-kind service) avahi-service-type)) | |
6075 | %desktop-services) | |
6076 | @end example | |
6077 | ||
6078 | @unnumberedsubsubsec Instantiating the System | |
6079 | ||
6080 | Assuming the @code{operating-system} declaration | |
6081 | is stored in the @file{my-system-config.scm} | |
cf4a9129 LC |
6082 | file, the @command{guix system reconfigure my-system-config.scm} command |
6083 | instantiates that configuration, and makes it the default GRUB boot | |
65797bff LC |
6084 | entry (@pxref{Invoking guix system}). |
6085 | ||
6086 | The normal way to change the system's configuration is by updating this | |
6087 | file and re-running @command{guix system reconfigure}. One should never | |
6088 | have to touch files in @command{/etc} or to run commands that modify the | |
6089 | system state such as @command{useradd} or @command{grub-install}. In | |
6090 | fact, you must avoid that since that would not only void your warranty | |
6091 | but also prevent you from rolling back to previous versions of your | |
6092 | system, should you ever need to. | |
6093 | ||
6094 | @cindex roll-back, of the operating system | |
6095 | Speaking of roll-back, each time you run @command{guix system | |
6096 | reconfigure}, a new @dfn{generation} of the system is created---without | |
6097 | modifying or deleting previous generations. Old system generations get | |
6098 | an entry in the GRUB boot menu, allowing you to boot them in case | |
6099 | something went wrong with the latest generation. Reassuring, no? The | |
6100 | @command{guix system list-generations} command lists the system | |
6101 | generations available on disk. | |
b81e1947 | 6102 | |
5d94ac51 LC |
6103 | @unnumberedsubsubsec The Programming Interface |
6104 | ||
cf4a9129 LC |
6105 | At the Scheme level, the bulk of an @code{operating-system} declaration |
6106 | is instantiated with the following monadic procedure (@pxref{The Store | |
6107 | Monad}): | |
b81e1947 | 6108 | |
cf4a9129 LC |
6109 | @deffn {Monadic Procedure} operating-system-derivation os |
6110 | Return a derivation that builds @var{os}, an @code{operating-system} | |
6111 | object (@pxref{Derivations}). | |
b81e1947 | 6112 | |
cf4a9129 LC |
6113 | The output of the derivation is a single directory that refers to all |
6114 | the packages, configuration files, and other supporting files needed to | |
6115 | instantiate @var{os}. | |
6116 | @end deffn | |
b81e1947 | 6117 | |
5d94ac51 LC |
6118 | This procedure is provided by the @code{(gnu system)} module. Along |
6119 | with @code{(gnu services)} (@pxref{Services}), this module contains the | |
6120 | guts of GuixSD. Make sure to visit it! | |
6121 | ||
6122 | ||
7313a52e LC |
6123 | @node operating-system Reference |
6124 | @subsection @code{operating-system} Reference | |
6125 | ||
6126 | This section summarizes all the options available in | |
6127 | @code{operating-system} declarations (@pxref{Using the Configuration | |
6128 | System}). | |
6129 | ||
6130 | @deftp {Data Type} operating-system | |
6131 | This is the data type representing an operating system configuration. | |
6132 | By that, we mean all the global system configuration, not per-user | |
6133 | configuration (@pxref{Using the Configuration System}). | |
6134 | ||
6135 | @table @asis | |
6136 | @item @code{kernel} (default: @var{linux-libre}) | |
fbb25e56 | 6137 | The package object of the operating system kernel to use@footnote{Currently |
7313a52e LC |
6138 | only the Linux-libre kernel is supported. In the future, it will be |
6139 | possible to use the GNU@tie{}Hurd.}. | |
6140 | ||
ee2a6304 LC |
6141 | @item @code{kernel-arguments} (default: @code{'()}) |
6142 | List of strings or gexps representing additional arguments to pass on | |
6143 | the kernel's command-line---e.g., @code{("console=ttyS0")}. | |
6144 | ||
7313a52e | 6145 | @item @code{bootloader} |
88faf933 | 6146 | The system bootloader configuration object. @xref{GRUB Configuration}. |
7313a52e LC |
6147 | |
6148 | @item @code{initrd} (default: @code{base-initrd}) | |
6149 | A two-argument monadic procedure that returns an initial RAM disk for | |
6150 | the Linux kernel. @xref{Initial RAM Disk}. | |
6151 | ||
f34c56be LC |
6152 | @item @code{firmware} (default: @var{%base-firmware}) |
6153 | @cindex firmware | |
6154 | List of firmware packages loadable by the operating system kernel. | |
6155 | ||
6156 | The default includes firmware needed for Atheros-based WiFi devices | |
6157 | (Linux-libre module @code{ath9k}.) | |
6158 | ||
7313a52e LC |
6159 | @item @code{host-name} |
6160 | The host name. | |
6161 | ||
6162 | @item @code{hosts-file} | |
6163 | @cindex hosts file | |
24e02c28 | 6164 | A file-like object (@pxref{G-Expressions, file-like objects}) for use as |
7313a52e | 6165 | @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library |
24e02c28 | 6166 | Reference Manual}). The default is a file with entries for |
7313a52e LC |
6167 | @code{localhost} and @var{host-name}. |
6168 | ||
6169 | @item @code{mapped-devices} (default: @code{'()}) | |
6170 | A list of mapped devices. @xref{Mapped Devices}. | |
6171 | ||
6172 | @item @code{file-systems} | |
6173 | A list of file systems. @xref{File Systems}. | |
6174 | ||
6175 | @item @code{swap-devices} (default: @code{'()}) | |
6176 | @cindex swap devices | |
6177 | A list of strings identifying devices to be used for ``swap space'' | |
6178 | (@pxref{Memory Concepts,,, libc, The GNU C Library Reference Manual}). | |
6179 | For example, @code{'("/dev/sda3")}. | |
6180 | ||
bf87f38a | 6181 | @item @code{users} (default: @code{%base-user-accounts}) |
7313a52e LC |
6182 | @itemx @code{groups} (default: @var{%base-groups}) |
6183 | List of user accounts and groups. @xref{User Accounts}. | |
6184 | ||
6185 | @item @code{skeletons} (default: @code{(default-skeletons)}) | |
6186 | A monadic list of pairs of target file name and files. These are the | |
6187 | files that will be used as skeletons as new accounts are created. | |
6188 | ||
6189 | For instance, a valid value may look like this: | |
6190 | ||
6191 | @example | |
6192 | (mlet %store-monad ((bashrc (text-file "bashrc" "\ | |
6193 | export PATH=$HOME/.guix-profile/bin"))) | |
6194 | (return `((".bashrc" ,bashrc)))) | |
6195 | @end example | |
6196 | ||
6197 | @item @code{issue} (default: @var{%default-issue}) | |
6198 | A string denoting the contents of the @file{/etc/issue} file, which is | |
6199 | what displayed when users log in on a text console. | |
6200 | ||
6201 | @item @code{packages} (default: @var{%base-packages}) | |
6202 | The set of packages installed in the global profile, which is accessible | |
6203 | at @file{/run/current-system/profile}. | |
6204 | ||
6205 | The default set includes core utilities, but it is good practice to | |
6206 | install non-core utilities in user profiles (@pxref{Invoking guix | |
6207 | package}). | |
6208 | ||
6209 | @item @code{timezone} | |
6210 | A timezone identifying string---e.g., @code{"Europe/Paris"}. | |
6211 | ||
17c20385 LC |
6212 | You can run the @command{tzselect} command to find out which timezone |
6213 | string corresponds to your region. Choosing an invalid timezone name | |
6214 | causes @command{guix system} to fail. | |
6215 | ||
598e19dc LC |
6216 | @item @code{locale} (default: @code{"en_US.utf8"}) |
6217 | The name of the default locale (@pxref{Locale Names,,, libc, The GNU C | |
6218 | Library Reference Manual}). @xref{Locales}, for more information. | |
6219 | ||
6220 | @item @code{locale-definitions} (default: @var{%default-locale-definitions}) | |
6221 | The list of locale definitions to be compiled and that may be used at | |
6222 | run time. @xref{Locales}. | |
7313a52e | 6223 | |
34760ae7 LC |
6224 | @item @code{locale-libcs} (default: @code{(list @var{glibc})}) |
6225 | The list of GNU@tie{}libc packages whose locale data and tools are used | |
6226 | to build the locale definitions. @xref{Locales}, for compatibility | |
6227 | considerations that justify this option. | |
6228 | ||
996ed739 LC |
6229 | @item @code{name-service-switch} (default: @var{%default-nss}) |
6230 | Configuration of libc's name service switch (NSS)---a | |
6231 | @code{<name-service-switch>} object. @xref{Name Service Switch}, for | |
6232 | details. | |
6233 | ||
7313a52e | 6234 | @item @code{services} (default: @var{%base-services}) |
28d939af | 6235 | A list of service objects denoting system services. @xref{Services}. |
7313a52e LC |
6236 | |
6237 | @item @code{pam-services} (default: @code{(base-pam-services)}) | |
6238 | @cindex PAM | |
6239 | @cindex pluggable authentication modules | |
6240 | Linux @dfn{pluggable authentication module} (PAM) services. | |
6241 | @c FIXME: Add xref to PAM services section. | |
6242 | ||
6243 | @item @code{setuid-programs} (default: @var{%setuid-programs}) | |
6244 | List of string-valued G-expressions denoting setuid programs. | |
6245 | @xref{Setuid Programs}. | |
6246 | ||
f5a9ffa0 AK |
6247 | @item @code{sudoers-file} (default: @var{%sudoers-specification}) |
6248 | @cindex sudoers file | |
84765839 LC |
6249 | The contents of the @file{/etc/sudoers} file as a file-like object |
6250 | (@pxref{G-Expressions, @code{local-file} and @code{plain-file}}). | |
7313a52e LC |
6251 | |
6252 | This file specifies which users can use the @command{sudo} command, what | |
6253 | they are allowed to do, and what privileges they may gain. The default | |
6254 | is that only @code{root} and members of the @code{wheel} group may use | |
6255 | @code{sudo}. | |
6256 | ||
6257 | @end table | |
6258 | @end deftp | |
6259 | ||
cf4a9129 LC |
6260 | @node File Systems |
6261 | @subsection File Systems | |
b81e1947 | 6262 | |
cf4a9129 LC |
6263 | The list of file systems to be mounted is specified in the |
6264 | @code{file-systems} field of the operating system's declaration | |
6265 | (@pxref{Using the Configuration System}). Each file system is declared | |
6266 | using the @code{file-system} form, like this: | |
b81e1947 LC |
6267 | |
6268 | @example | |
cf4a9129 LC |
6269 | (file-system |
6270 | (mount-point "/home") | |
6271 | (device "/dev/sda3") | |
6272 | (type "ext4")) | |
b81e1947 LC |
6273 | @end example |
6274 | ||
cf4a9129 LC |
6275 | As usual, some of the fields are mandatory---those shown in the example |
6276 | above---while others can be omitted. These are described below. | |
b81e1947 | 6277 | |
cf4a9129 LC |
6278 | @deftp {Data Type} file-system |
6279 | Objects of this type represent file systems to be mounted. They | |
6280 | contain the following members: | |
5ff3c4b8 | 6281 | |
cf4a9129 LC |
6282 | @table @asis |
6283 | @item @code{type} | |
6284 | This is a string specifying the type of the file system---e.g., | |
6285 | @code{"ext4"}. | |
5ff3c4b8 | 6286 | |
cf4a9129 LC |
6287 | @item @code{mount-point} |
6288 | This designates the place where the file system is to be mounted. | |
b81e1947 | 6289 | |
cf4a9129 LC |
6290 | @item @code{device} |
6291 | This names the ``source'' of the file system. By default it is the name | |
6292 | of a node under @file{/dev}, but its meaning depends on the @code{title} | |
6293 | field described below. | |
401c53c4 | 6294 | |
cf4a9129 LC |
6295 | @item @code{title} (default: @code{'device}) |
6296 | This is a symbol that specifies how the @code{device} field is to be | |
6297 | interpreted. | |
401c53c4 | 6298 | |
cf4a9129 LC |
6299 | When it is the symbol @code{device}, then the @code{device} field is |
6300 | interpreted as a file name; when it is @code{label}, then @code{device} | |
6301 | is interpreted as a partition label name; when it is @code{uuid}, | |
6302 | @code{device} is interpreted as a partition unique identifier (UUID). | |
da7cabd4 | 6303 | |
661a1d79 LC |
6304 | UUIDs may be converted from their string representation (as shown by the |
6305 | @command{tune2fs -l} command) using the @code{uuid} form, like this: | |
6306 | ||
6307 | @example | |
6308 | (file-system | |
6309 | (mount-point "/home") | |
6310 | (type "ext4") | |
6311 | (title 'uuid) | |
6312 | (device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb"))) | |
6313 | @end example | |
6314 | ||
cf4a9129 | 6315 | The @code{label} and @code{uuid} options offer a way to refer to disk |
661a1d79 LC |
6316 | partitions without having to hard-code their actual device |
6317 | name@footnote{Note that, while it is tempting to use | |
6318 | @file{/dev/disk/by-uuid} and similar device names to achieve the same | |
6319 | result, this is not recommended: These special device nodes are created | |
6320 | by the udev daemon and may be unavailable at the time the device is | |
6321 | mounted.}. | |
da7cabd4 | 6322 | |
5f86a66e LC |
6323 | However, when a file system's source is a mapped device (@pxref{Mapped |
6324 | Devices}), its @code{device} field @emph{must} refer to the mapped | |
6325 | device name---e.g., @file{/dev/mapper/root-partition}---and consequently | |
6326 | @code{title} must be set to @code{'device}. This is required so that | |
6327 | the system knows that mounting the file system depends on having the | |
6328 | corresponding device mapping established. | |
6329 | ||
cf4a9129 LC |
6330 | @item @code{flags} (default: @code{'()}) |
6331 | This is a list of symbols denoting mount flags. Recognized flags | |
2c071ce9 LC |
6332 | include @code{read-only}, @code{bind-mount}, @code{no-dev} (disallow |
6333 | access to special files), @code{no-suid} (ignore setuid and setgid | |
6334 | bits), and @code{no-exec} (disallow program execution.) | |
da7cabd4 | 6335 | |
cf4a9129 LC |
6336 | @item @code{options} (default: @code{#f}) |
6337 | This is either @code{#f}, or a string denoting mount options. | |
da7cabd4 | 6338 | |
be21979d LC |
6339 | @item @code{mount?} (default: @code{#t}) |
6340 | This value indicates whether to automatically mount the file system when | |
6341 | the system is brought up. When set to @code{#f}, the file system gets | |
6342 | an entry in @file{/etc/fstab} (read by the @command{mount} command) but | |
6343 | is not automatically mounted. | |
6344 | ||
cf4a9129 LC |
6345 | @item @code{needed-for-boot?} (default: @code{#f}) |
6346 | This Boolean value indicates whether the file system is needed when | |
6347 | booting. If that is true, then the file system is mounted when the | |
6348 | initial RAM disk (initrd) is loaded. This is always the case, for | |
6349 | instance, for the root file system. | |
da7cabd4 | 6350 | |
cf4a9129 LC |
6351 | @item @code{check?} (default: @code{#t}) |
6352 | This Boolean indicates whether the file system needs to be checked for | |
6353 | errors before being mounted. | |
f9cc8971 | 6354 | |
4e469051 LC |
6355 | @item @code{create-mount-point?} (default: @code{#f}) |
6356 | When true, the mount point is created if it does not exist yet. | |
6357 | ||
e51710d1 LC |
6358 | @item @code{dependencies} (default: @code{'()}) |
6359 | This is a list of @code{<file-system>} objects representing file systems | |
6360 | that must be mounted before (and unmounted after) this one. | |
6361 | ||
6362 | As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is | |
6363 | a dependency of @file{/sys/fs/cgroup/cpu} and | |
6364 | @file{/sys/fs/cgroup/memory}. | |
6365 | ||
cf4a9129 LC |
6366 | @end table |
6367 | @end deftp | |
da7cabd4 | 6368 | |
a69576ea LC |
6369 | The @code{(gnu system file-systems)} exports the following useful |
6370 | variables. | |
6371 | ||
6372 | @defvr {Scheme Variable} %base-file-systems | |
6373 | These are essential file systems that are required on normal systems, | |
cc0e575a | 6374 | such as @var{%pseudo-terminal-file-system} and @var{%immutable-store} (see |
3392ce5d LC |
6375 | below.) Operating system declarations should always contain at least |
6376 | these. | |
a69576ea LC |
6377 | @end defvr |
6378 | ||
7f239fd3 LC |
6379 | @defvr {Scheme Variable} %pseudo-terminal-file-system |
6380 | This is the file system to be mounted as @file{/dev/pts}. It supports | |
6381 | @dfn{pseudo-terminals} created @i{via} @code{openpty} and similar | |
6382 | functions (@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference | |
6383 | Manual}). Pseudo-terminals are used by terminal emulators such as | |
6384 | @command{xterm}. | |
6385 | @end defvr | |
6386 | ||
db17ae5c LC |
6387 | @defvr {Scheme Variable} %shared-memory-file-system |
6388 | This file system is mounted as @file{/dev/shm} and is used to support | |
6389 | memory sharing across processes (@pxref{Memory-mapped I/O, | |
6390 | @code{shm_open},, libc, The GNU C Library Reference Manual}). | |
6391 | @end defvr | |
6392 | ||
3392ce5d LC |
6393 | @defvr {Scheme Variable} %immutable-store |
6394 | This file system performs a read-only ``bind mount'' of | |
6395 | @file{/gnu/store}, making it read-only for all the users including | |
6396 | @code{root}. This prevents against accidental modification by software | |
6397 | running as @code{root} or by system administrators. | |
6398 | ||
6399 | The daemon itself is still able to write to the store: it remounts it | |
6400 | read-write in its own ``name space.'' | |
6401 | @end defvr | |
6402 | ||
a69576ea LC |
6403 | @defvr {Scheme Variable} %binary-format-file-system |
6404 | The @code{binfmt_misc} file system, which allows handling of arbitrary | |
6405 | executable file types to be delegated to user space. This requires the | |
6406 | @code{binfmt.ko} kernel module to be loaded. | |
6407 | @end defvr | |
6408 | ||
6409 | @defvr {Scheme Variable} %fuse-control-file-system | |
6410 | The @code{fusectl} file system, which allows unprivileged users to mount | |
6411 | and unmount user-space FUSE file systems. This requires the | |
6412 | @code{fuse.ko} kernel module to be loaded. | |
6413 | @end defvr | |
6414 | ||
510f9d86 LC |
6415 | @node Mapped Devices |
6416 | @subsection Mapped Devices | |
6417 | ||
6418 | @cindex device mapping | |
6419 | @cindex mapped devices | |
6420 | The Linux kernel has a notion of @dfn{device mapping}: a block device, | |
6421 | such as a hard disk partition, can be @dfn{mapped} into another device, | |
6422 | with additional processing over the data that flows through | |
6423 | it@footnote{Note that the GNU@tie{}Hurd makes no difference between the | |
6424 | concept of a ``mapped device'' and that of a file system: both boil down | |
6425 | to @emph{translating} input/output operations made on a file to | |
6426 | operations on its backing store. Thus, the Hurd implements mapped | |
6427 | devices, like file systems, using the generic @dfn{translator} mechanism | |
6428 | (@pxref{Translators,,, hurd, The GNU Hurd Reference Manual}).}. A | |
6429 | typical example is encryption device mapping: all writes to the mapped | |
6430 | device are encrypted, and all reads are deciphered, transparently. | |
6431 | ||
6432 | Mapped devices are declared using the @code{mapped-device} form: | |
6433 | ||
6434 | @example | |
6435 | (mapped-device | |
6436 | (source "/dev/sda3") | |
6437 | (target "home") | |
6438 | (type luks-device-mapping)) | |
6439 | @end example | |
6440 | ||
6441 | @noindent | |
6442 | @cindex disk encryption | |
6443 | @cindex LUKS | |
6444 | This example specifies a mapping from @file{/dev/sda3} to | |
6445 | @file{/dev/mapper/home} using LUKS---the | |
6446 | @url{http://code.google.com/p/cryptsetup,Linux Unified Key Setup}, a | |
6447 | standard mechanism for disk encryption. The @file{/dev/mapper/home} | |
6448 | device can then be used as the @code{device} of a @code{file-system} | |
6449 | declaration (@pxref{File Systems}). The @code{mapped-device} form is | |
6450 | detailed below. | |
6451 | ||
6452 | @deftp {Data Type} mapped-device | |
6453 | Objects of this type represent device mappings that will be made when | |
6454 | the system boots up. | |
6455 | ||
9cb426b8 LC |
6456 | @table @code |
6457 | @item source | |
510f9d86 LC |
6458 | This string specifies the name of the block device to be mapped, such as |
6459 | @code{"/dev/sda3"}. | |
6460 | ||
9cb426b8 | 6461 | @item target |
510f9d86 LC |
6462 | This string specifies the name of the mapping to be established. For |
6463 | example, specifying @code{"my-partition"} will lead to the creation of | |
6464 | the @code{"/dev/mapper/my-partition"} device. | |
6465 | ||
9cb426b8 | 6466 | @item type |
510f9d86 LC |
6467 | This must be a @code{mapped-device-kind} object, which specifies how |
6468 | @var{source} is mapped to @var{target}. | |
6469 | @end table | |
6470 | @end deftp | |
6471 | ||
6472 | @defvr {Scheme Variable} luks-device-mapping | |
6473 | This defines LUKS block device encryption using the @command{cryptsetup} | |
6474 | command, from the same-named package. This relies on the | |
6475 | @code{dm-crypt} Linux kernel module. | |
6476 | @end defvr | |
6477 | ||
cf4a9129 LC |
6478 | @node User Accounts |
6479 | @subsection User Accounts | |
ee85f3db | 6480 | |
9bea87a5 LC |
6481 | User accounts and groups are entirely managed through the |
6482 | @code{operating-system} declaration. They are specified with the | |
6483 | @code{user-account} and @code{user-group} forms: | |
ee85f3db | 6484 | |
cf4a9129 LC |
6485 | @example |
6486 | (user-account | |
6487 | (name "alice") | |
6488 | (group "users") | |
24e752c0 LC |
6489 | (supplementary-groups '("wheel" ;allow use of sudo, etc. |
6490 | "audio" ;sound card | |
6491 | "video" ;video devices such as webcams | |
6492 | "cdrom")) ;the good ol' CD-ROM | |
cf4a9129 LC |
6493 | (comment "Bob's sister") |
6494 | (home-directory "/home/alice")) | |
6495 | @end example | |
25083588 | 6496 | |
9bea87a5 LC |
6497 | When booting or upon completion of @command{guix system reconfigure}, |
6498 | the system ensures that only the user accounts and groups specified in | |
6499 | the @code{operating-system} declaration exist, and with the specified | |
6500 | properties. Thus, account or group creations or modifications made by | |
6501 | directly invoking commands such as @command{useradd} are lost upon | |
6502 | reconfiguration or reboot. This ensures that the system remains exactly | |
6503 | as declared. | |
6504 | ||
cf4a9129 LC |
6505 | @deftp {Data Type} user-account |
6506 | Objects of this type represent user accounts. The following members may | |
6507 | be specified: | |
ee85f3db | 6508 | |
cf4a9129 LC |
6509 | @table @asis |
6510 | @item @code{name} | |
6511 | The name of the user account. | |
ee85f3db | 6512 | |
cf4a9129 LC |
6513 | @item @code{group} |
6514 | This is the name (a string) or identifier (a number) of the user group | |
6515 | this account belongs to. | |
ee85f3db | 6516 | |
cf4a9129 LC |
6517 | @item @code{supplementary-groups} (default: @code{'()}) |
6518 | Optionally, this can be defined as a list of group names that this | |
6519 | account belongs to. | |
ee85f3db | 6520 | |
cf4a9129 LC |
6521 | @item @code{uid} (default: @code{#f}) |
6522 | This is the user ID for this account (a number), or @code{#f}. In the | |
6523 | latter case, a number is automatically chosen by the system when the | |
6524 | account is created. | |
ee85f3db | 6525 | |
cf4a9129 LC |
6526 | @item @code{comment} (default: @code{""}) |
6527 | A comment about the account, such as the account's owner full name. | |
c8c871d1 | 6528 | |
cf4a9129 LC |
6529 | @item @code{home-directory} |
6530 | This is the name of the home directory for the account. | |
ee85f3db | 6531 | |
cf4a9129 LC |
6532 | @item @code{shell} (default: Bash) |
6533 | This is a G-expression denoting the file name of a program to be used as | |
6534 | the shell (@pxref{G-Expressions}). | |
ee85f3db | 6535 | |
cf4a9129 LC |
6536 | @item @code{system?} (default: @code{#f}) |
6537 | This Boolean value indicates whether the account is a ``system'' | |
6538 | account. System accounts are sometimes treated specially; for instance, | |
6539 | graphical login managers do not list them. | |
ee85f3db | 6540 | |
1bd4e6db | 6541 | @anchor{user-account-password} |
cf4a9129 | 6542 | @item @code{password} (default: @code{#f}) |
eb59595c LC |
6543 | You would normally leave this field to @code{#f}, initialize user |
6544 | passwords as @code{root} with the @command{passwd} command, and then let | |
9bea87a5 LC |
6545 | users change it with @command{passwd}. Passwords set with |
6546 | @command{passwd} are of course preserved across reboot and | |
6547 | reconfiguration. | |
eb59595c LC |
6548 | |
6549 | If you @emph{do} want to have a preset password for an account, then | |
6550 | this field must contain the encrypted password, as a string. | |
5d1f1177 LC |
6551 | @xref{crypt,,, libc, The GNU C Library Reference Manual}, for more information |
6552 | on password encryption, and @ref{Encryption,,, guile, GNU Guile Reference | |
eb59595c | 6553 | Manual}, for information on Guile's @code{crypt} procedure. |
c8c871d1 | 6554 | |
cf4a9129 LC |
6555 | @end table |
6556 | @end deftp | |
ee85f3db | 6557 | |
cf4a9129 | 6558 | User group declarations are even simpler: |
ee85f3db | 6559 | |
cf4a9129 LC |
6560 | @example |
6561 | (user-group (name "students")) | |
6562 | @end example | |
ee85f3db | 6563 | |
cf4a9129 LC |
6564 | @deftp {Data Type} user-group |
6565 | This type is for, well, user groups. There are just a few fields: | |
af8a56b8 | 6566 | |
cf4a9129 LC |
6567 | @table @asis |
6568 | @item @code{name} | |
6569 | The group's name. | |
ee85f3db | 6570 | |
cf4a9129 LC |
6571 | @item @code{id} (default: @code{#f}) |
6572 | The group identifier (a number). If @code{#f}, a new number is | |
6573 | automatically allocated when the group is created. | |
ee85f3db | 6574 | |
c8fa3426 LC |
6575 | @item @code{system?} (default: @code{#f}) |
6576 | This Boolean value indicates whether the group is a ``system'' group. | |
6577 | System groups have low numerical IDs. | |
6578 | ||
cf4a9129 LC |
6579 | @item @code{password} (default: @code{#f}) |
6580 | What, user groups can have a password? Well, apparently yes. Unless | |
6581 | @code{#f}, this field specifies the group's password. | |
ee85f3db | 6582 | |
cf4a9129 LC |
6583 | @end table |
6584 | @end deftp | |
401c53c4 | 6585 | |
cf4a9129 LC |
6586 | For convenience, a variable lists all the basic user groups one may |
6587 | expect: | |
401c53c4 | 6588 | |
cf4a9129 LC |
6589 | @defvr {Scheme Variable} %base-groups |
6590 | This is the list of basic user groups that users and/or packages expect | |
6591 | to be present on the system. This includes groups such as ``root'', | |
6592 | ``wheel'', and ``users'', as well as groups used to control access to | |
6593 | specific devices such as ``audio'', ``disk'', and ``cdrom''. | |
6594 | @end defvr | |
401c53c4 | 6595 | |
bf87f38a LC |
6596 | @defvr {Scheme Variable} %base-user-accounts |
6597 | This is the list of basic system accounts that programs may expect to | |
6598 | find on a GNU/Linux system, such as the ``nobody'' account. | |
6599 | ||
6600 | Note that the ``root'' account is not included here. It is a | |
6601 | special-case and is automatically added whether or not it is specified. | |
6602 | @end defvr | |
6603 | ||
598e19dc LC |
6604 | @node Locales |
6605 | @subsection Locales | |
6606 | ||
6607 | @cindex locale | |
6608 | A @dfn{locale} defines cultural conventions for a particular language | |
6609 | and region of the world (@pxref{Locales,,, libc, The GNU C Library | |
6610 | Reference Manual}). Each locale has a name that typically has the form | |
b2636518 | 6611 | @code{@var{language}_@var{territory}.@var{codeset}}---e.g., |
598e19dc LC |
6612 | @code{fr_LU.utf8} designates the locale for the French language, with |
6613 | cultural conventions from Luxembourg, and using the UTF-8 encoding. | |
6614 | ||
6615 | @cindex locale definition | |
6616 | Usually, you will want to specify the default locale for the machine | |
6617 | using the @code{locale} field of the @code{operating-system} declaration | |
6618 | (@pxref{operating-system Reference, @code{locale}}). | |
6619 | ||
f5582b2c LC |
6620 | The selected locale is automatically added to the @dfn{locale |
6621 | definitions} known to the system if needed, with its codeset inferred | |
6622 | from its name---e.g., @code{bo_CN.utf8} will be assumed to use the | |
6623 | @code{UTF-8} codeset. Additional locale definitions can be specified in | |
6624 | the @code{locale-definitions} slot of @code{operating-system}---this is | |
6625 | useful, for instance, if the codeset could not be inferred from the | |
6626 | locale name. The default set of locale definitions includes some widely | |
6627 | used locales, but not all the available locales, in order to save space. | |
6628 | ||
6629 | For instance, to add the North Frisian locale for Germany, the value of | |
6630 | that field may be: | |
598e19dc LC |
6631 | |
6632 | @example | |
6633 | (cons (locale-definition | |
6634 | (name "fy_DE.utf8") (source "fy_DE")) | |
6635 | %default-locale-definitions) | |
6636 | @end example | |
6637 | ||
6638 | Likewise, to save space, one might want @code{locale-definitions} to | |
6639 | list only the locales that are actually used, as in: | |
6640 | ||
6641 | @example | |
6642 | (list (locale-definition | |
6643 | (name "ja_JP.eucjp") (source "ja_JP") | |
6644 | (charset "EUC-JP"))) | |
6645 | @end example | |
6646 | ||
5c3c1427 LC |
6647 | @vindex LOCPATH |
6648 | The compiled locale definitions are available at | |
46bd6edd LC |
6649 | @file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc |
6650 | version, which is the default location where the GNU@tie{}libc provided | |
6651 | by Guix looks for locale data. This can be overridden using the | |
6652 | @code{LOCPATH} environment variable (@pxref{locales-and-locpath, | |
5c3c1427 LC |
6653 | @code{LOCPATH} and locale packages}). |
6654 | ||
598e19dc LC |
6655 | The @code{locale-definition} form is provided by the @code{(gnu system |
6656 | locale)} module. Details are given below. | |
6657 | ||
6658 | @deftp {Data Type} locale-definition | |
6659 | This is the data type of a locale definition. | |
6660 | ||
6661 | @table @asis | |
6662 | ||
6663 | @item @code{name} | |
6664 | The name of the locale. @xref{Locale Names,,, libc, The GNU C Library | |
6665 | Reference Manual}, for more information on locale names. | |
6666 | ||
6667 | @item @code{source} | |
6668 | The name of the source for that locale. This is typically the | |
6669 | @code{@var{language}_@var{territory}} part of the locale name. | |
6670 | ||
6671 | @item @code{charset} (default: @code{"UTF-8"}) | |
6672 | The ``character set'' or ``code set'' for that locale, | |
6673 | @uref{http://www.iana.org/assignments/character-sets, as defined by | |
6674 | IANA}. | |
6675 | ||
6676 | @end table | |
6677 | @end deftp | |
6678 | ||
6679 | @defvr {Scheme Variable} %default-locale-definitions | |
b2636518 LC |
6680 | An arbitrary list of commonly used UTF-8 locales, used as the default |
6681 | value of the @code{locale-definitions} field of @code{operating-system} | |
598e19dc | 6682 | declarations. |
b2636518 LC |
6683 | |
6684 | @cindex locale name | |
6685 | @cindex normalized codeset in locale names | |
6686 | These locale definitions use the @dfn{normalized codeset} for the part | |
6687 | that follows the dot in the name (@pxref{Using gettextized software, | |
6688 | normalized codeset,, libc, The GNU C Library Reference Manual}). So for | |
6689 | instance it has @code{uk_UA.utf8} but @emph{not}, say, | |
6690 | @code{uk_UA.UTF-8}. | |
598e19dc | 6691 | @end defvr |
401c53c4 | 6692 | |
34760ae7 LC |
6693 | @subsubsection Locale Data Compatibility Considerations |
6694 | ||
6695 | @cindex incompatibility, of locale data | |
6696 | @code{operating-system} declarations provide a @code{locale-libcs} field | |
6697 | to specify the GNU@tie{}libc packages that are used to compile locale | |
6698 | declarations (@pxref{operating-system Reference}). ``Why would I | |
6699 | care?'', you may ask. Well, it turns out that the binary format of | |
6700 | locale data is occasionally incompatible from one libc version to | |
6701 | another. | |
6702 | ||
6703 | @c See <https://sourceware.org/ml/libc-alpha/2015-09/msg00575.html> | |
6704 | @c and <https://lists.gnu.org/archive/html/guix-devel/2015-08/msg00737.html>. | |
6705 | For instance, a program linked against libc version 2.21 is unable to | |
6706 | read locale data produced with libc 2.22; worse, that program | |
6707 | @emph{aborts} instead of simply ignoring the incompatible locale | |
6708 | data@footnote{Versions 2.23 and later of GNU@tie{}libc will simply skip | |
6709 | the incompatible locale data, which is already an improvement.}. | |
6710 | Similarly, a program linked against libc 2.22 can read most, but not | |
6711 | all, the locale data from libc 2.21 (specifically, @code{LC_COLLATE} | |
6712 | data is incompatible); thus calls to @code{setlocale} may fail, but | |
6713 | programs will not abort. | |
6714 | ||
6715 | The ``problem'' in GuixSD is that users have a lot of freedom: They can | |
6716 | choose whether and when to upgrade software in their profiles, and might | |
6717 | be using a libc version different from the one the system administrator | |
6718 | used to build the system-wide locale data. | |
6719 | ||
6720 | Fortunately, unprivileged users can also install their own locale data | |
6721 | and define @var{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, | |
6722 | @code{GUIX_LOCPATH} and locale packages}). | |
6723 | ||
6724 | Still, it is best if the system-wide locale data at | |
6725 | @file{/run/current-system/locale} is built for all the libc versions | |
6726 | actually in use on the system, so that all the programs can access | |
6727 | it---this is especially crucial on a multi-user system. To do that, the | |
6728 | administrator can specify several libc packages in the | |
6729 | @code{locale-libcs} field of @code{operating-system}: | |
6730 | ||
6731 | @example | |
6732 | (use-package-modules base) | |
6733 | ||
6734 | (operating-system | |
6735 | ;; @dots{} | |
6736 | (locale-libcs (list glibc-2.21 (canonical-package glibc)))) | |
6737 | @end example | |
6738 | ||
6739 | This example would lead to a system containing locale definitions for | |
6740 | both libc 2.21 and the current version of libc in | |
6741 | @file{/run/current-system/locale}. | |
6742 | ||
6743 | ||
cf4a9129 LC |
6744 | @node Services |
6745 | @subsection Services | |
401c53c4 | 6746 | |
cf4a9129 LC |
6747 | @cindex system services |
6748 | An important part of preparing an @code{operating-system} declaration is | |
6749 | listing @dfn{system services} and their configuration (@pxref{Using the | |
6750 | Configuration System}). System services are typically daemons launched | |
6751 | when the system boots, or other actions needed at that time---e.g., | |
d8b94dbd LC |
6752 | configuring network access. |
6753 | ||
dd17bc38 AK |
6754 | Services are managed by the GNU@tie{}Shepherd (@pxref{Introduction,,, |
6755 | shepherd, The GNU Shepherd Manual}). On a running system, the | |
6756 | @command{herd} command allows you to list the available services, show | |
6757 | their status, start and stop them, or do other specific operations | |
6758 | (@pxref{Jump Start,,, shepherd, The GNU Shepherd Manual}). For example: | |
d8b94dbd LC |
6759 | |
6760 | @example | |
dd17bc38 | 6761 | # herd status |
d8b94dbd LC |
6762 | @end example |
6763 | ||
6764 | The above command, run as @code{root}, lists the currently defined | |
dd17bc38 | 6765 | services. The @command{herd doc} command shows a synopsis of the given |
d8b94dbd LC |
6766 | service: |
6767 | ||
6768 | @example | |
dd17bc38 | 6769 | # herd doc nscd |
d8b94dbd LC |
6770 | Run libc's name service cache daemon (nscd). |
6771 | @end example | |
6772 | ||
6773 | The @command{start}, @command{stop}, and @command{restart} sub-commands | |
6774 | have the effect you would expect. For instance, the commands below stop | |
6775 | the nscd service and restart the Xorg display server: | |
6776 | ||
6777 | @example | |
dd17bc38 | 6778 | # herd stop nscd |
d8b94dbd | 6779 | Service nscd has been stopped. |
dd17bc38 | 6780 | # herd restart xorg-server |
d8b94dbd LC |
6781 | Service xorg-server has been stopped. |
6782 | Service xorg-server has been started. | |
6783 | @end example | |
401c53c4 | 6784 | |
cf4a9129 | 6785 | The following sections document the available services, starting with |
d8b94dbd LC |
6786 | the core services, that may be used in an @code{operating-system} |
6787 | declaration. | |
401c53c4 | 6788 | |
cf4a9129 LC |
6789 | @menu |
6790 | * Base Services:: Essential system services. | |
6791 | * Networking Services:: Network setup, SSH daemon, etc. | |
6792 | * X Window:: Graphical display. | |
fe1a39d3 | 6793 | * Desktop Services:: D-Bus and desktop services. |
105369a4 | 6794 | * Database Services:: SQL databases. |
d8c18af8 | 6795 | * Mail Services:: IMAP, POP3, SMTP, and all that. |
58724c48 | 6796 | * Web Services:: Web servers. |
aa4ed923 | 6797 | * Various Services:: Other services. |
cf4a9129 | 6798 | @end menu |
401c53c4 | 6799 | |
cf4a9129 LC |
6800 | @node Base Services |
6801 | @subsubsection Base Services | |
a1ba8475 | 6802 | |
cf4a9129 LC |
6803 | The @code{(gnu services base)} module provides definitions for the basic |
6804 | services that one expects from the system. The services exported by | |
6805 | this module are listed below. | |
401c53c4 | 6806 | |
cf4a9129 | 6807 | @defvr {Scheme Variable} %base-services |
31771497 LC |
6808 | This variable contains a list of basic services (@pxref{Service Types |
6809 | and Services}, for more information on service objects) one would | |
cf4a9129 LC |
6810 | expect from the system: a login service (mingetty) on each tty, syslogd, |
6811 | libc's name service cache daemon (nscd), the udev device manager, and | |
6812 | more. | |
401c53c4 | 6813 | |
cf4a9129 LC |
6814 | This is the default value of the @code{services} field of |
6815 | @code{operating-system} declarations. Usually, when customizing a | |
6816 | system, you will want to append services to @var{%base-services}, like | |
6817 | this: | |
401c53c4 | 6818 | |
cf4a9129 | 6819 | @example |
fa1e31b8 | 6820 | (cons* (avahi-service) (lsh-service) %base-services) |
cf4a9129 LC |
6821 | @end example |
6822 | @end defvr | |
401c53c4 | 6823 | |
be1c2c54 | 6824 | @deffn {Scheme Procedure} host-name-service @var{name} |
cf4a9129 LC |
6825 | Return a service that sets the host name to @var{name}. |
6826 | @end deffn | |
401c53c4 | 6827 | |
66e4f01c LC |
6828 | @deffn {Scheme Procedure} mingetty-service @var{config} |
6829 | Return a service to run mingetty according to @var{config}, a | |
6830 | @code{<mingetty-configuration>} object, which specifies the tty to run, among | |
6831 | other things. | |
cf4a9129 | 6832 | @end deffn |
401c53c4 | 6833 | |
66e4f01c LC |
6834 | @deftp {Data Type} mingetty-configuration |
6835 | This is the data type representing the configuration of Mingetty, which | |
6836 | implements console log-in. | |
6837 | ||
6838 | @table @asis | |
6839 | ||
6840 | @item @code{tty} | |
6841 | The name of the console this Mingetty runs on---e.g., @code{"tty1"}. | |
6842 | ||
6843 | @item @code{motd} | |
6844 | A file-like object containing the ``message of the day''. | |
6845 | ||
6846 | @item @code{auto-login} (default: @code{#f}) | |
6847 | When true, this field must be a string denoting the user name under | |
f9b9a033 | 6848 | which the system automatically logs in. When it is @code{#f}, a |
66e4f01c LC |
6849 | user name and password must be entered to log in. |
6850 | ||
6851 | @item @code{login-program} (default: @code{#f}) | |
6852 | This must be either @code{#f}, in which case the default log-in program | |
6853 | is used (@command{login} from the Shadow tool suite), or a gexp denoting | |
6854 | the name of the log-in program. | |
6855 | ||
6856 | @item @code{login-pause?} (default: @code{#f}) | |
6857 | When set to @code{#t} in conjunction with @var{auto-login}, the user | |
6858 | will have to press a key before the log-in shell is launched. | |
6859 | ||
6860 | @item @code{mingetty} (default: @var{mingetty}) | |
6861 | The Mingetty package to use. | |
6862 | ||
6863 | @end table | |
6864 | @end deftp | |
6865 | ||
6454b333 LC |
6866 | @cindex name service cache daemon |
6867 | @cindex nscd | |
be1c2c54 | 6868 | @deffn {Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @ |
4aee6e60 | 6869 | [#:name-services '()] |
b893f1ae LC |
6870 | Return a service that runs libc's name service cache daemon (nscd) with the |
6871 | given @var{config}---an @code{<nscd-configuration>} object. @xref{Name | |
6872 | Service Switch}, for an example. | |
cf4a9129 | 6873 | @end deffn |
401c53c4 | 6874 | |
6454b333 LC |
6875 | @defvr {Scheme Variable} %nscd-default-configuration |
6876 | This is the default @code{<nscd-configuration>} value (see below) used | |
6877 | by @code{nscd-service}. This uses the caches defined by | |
6878 | @var{%nscd-default-caches}; see below. | |
6879 | @end defvr | |
6880 | ||
6881 | @deftp {Data Type} nscd-configuration | |
6882 | This is the type representing the name service cache daemon (nscd) | |
6883 | configuration. | |
6884 | ||
6885 | @table @asis | |
6886 | ||
b893f1ae LC |
6887 | @item @code{name-services} (default: @code{'()}) |
6888 | List of packages denoting @dfn{name services} that must be visible to | |
6889 | the nscd---e.g., @code{(list @var{nss-mdns})}. | |
6890 | ||
6891 | @item @code{glibc} (default: @var{glibc}) | |
6892 | Package object denoting the GNU C Library providing the @command{nscd} | |
6893 | command. | |
6894 | ||
6454b333 LC |
6895 | @item @code{log-file} (default: @code{"/var/log/nscd.log"}) |
6896 | Name of nscd's log file. This is where debugging output goes when | |
6897 | @code{debug-level} is strictly positive. | |
6898 | ||
6899 | @item @code{debug-level} (default: @code{0}) | |
6900 | Integer denoting the debugging levels. Higher numbers mean more | |
6901 | debugging output is logged. | |
6902 | ||
6903 | @item @code{caches} (default: @var{%nscd-default-caches}) | |
6904 | List of @code{<nscd-cache>} objects denoting things to be cached; see | |
6905 | below. | |
6906 | ||
6907 | @end table | |
6908 | @end deftp | |
6909 | ||
6910 | @deftp {Data Type} nscd-cache | |
6911 | Data type representing a cache database of nscd and its parameters. | |
6912 | ||
6913 | @table @asis | |
6914 | ||
6915 | @item @code{database} | |
6916 | This is a symbol representing the name of the database to be cached. | |
6917 | Valid values are @code{passwd}, @code{group}, @code{hosts}, and | |
6918 | @code{services}, which designate the corresponding NSS database | |
6919 | (@pxref{NSS Basics,,, libc, The GNU C Library Reference Manual}). | |
6920 | ||
6921 | @item @code{positive-time-to-live} | |
6922 | @itemx @code{negative-time-to-live} (default: @code{20}) | |
6923 | A number representing the number of seconds during which a positive or | |
6924 | negative lookup result remains in cache. | |
6925 | ||
6926 | @item @code{check-files?} (default: @code{#t}) | |
6927 | Whether to check for updates of the files corresponding to | |
6928 | @var{database}. | |
6929 | ||
6930 | For instance, when @var{database} is @code{hosts}, setting this flag | |
6931 | instructs nscd to check for updates in @file{/etc/hosts} and to take | |
6932 | them into account. | |
6933 | ||
6934 | @item @code{persistent?} (default: @code{#t}) | |
6935 | Whether the cache should be stored persistently on disk. | |
6936 | ||
6937 | @item @code{shared?} (default: @code{#t}) | |
6938 | Whether the cache should be shared among users. | |
6939 | ||
6940 | @item @code{max-database-size} (default: 32@tie{}MiB) | |
6941 | Maximum size in bytes of the database cache. | |
6942 | ||
6943 | @c XXX: 'suggested-size' and 'auto-propagate?' seem to be expert | |
6944 | @c settings, so leave them out. | |
6945 | ||
6946 | @end table | |
6947 | @end deftp | |
6948 | ||
6949 | @defvr {Scheme Variable} %nscd-default-caches | |
6950 | List of @code{<nscd-cache>} objects used by default by | |
6951 | @code{nscd-configuration} (see above.) | |
6952 | ||
6953 | It enables persistent and aggressive caching of service and host name | |
6954 | lookups. The latter provides better host name lookup performance, | |
6955 | resilience in the face of unreliable name servers, and also better | |
6956 | privacy---often the result of host name lookups is in local cache, so | |
6957 | external name servers do not even need to be queried. | |
6958 | @end defvr | |
6959 | ||
6960 | ||
be1c2c54 | 6961 | @deffn {Scheme Procedure} syslog-service [#:config-file #f] |
1bb76f75 AK |
6962 | Return a service that runs @code{syslogd}. If configuration file name |
6963 | @var{config-file} is not specified, use some reasonable default | |
cf4a9129 LC |
6964 | settings. |
6965 | @end deffn | |
401c53c4 | 6966 | |
0adfe95a LC |
6967 | @anchor{guix-configuration-type} |
6968 | @deftp {Data Type} guix-configuration | |
6969 | This data type represents the configuration of the Guix build daemon. | |
6970 | @xref{Invoking guix-daemon}, for more information. | |
6971 | ||
6972 | @table @asis | |
6973 | @item @code{guix} (default: @var{guix}) | |
6974 | The Guix package to use. | |
401c53c4 | 6975 | |
0adfe95a LC |
6976 | @item @code{build-group} (default: @code{"guixbuild"}) |
6977 | Name of the group for build user accounts. | |
401c53c4 | 6978 | |
0adfe95a LC |
6979 | @item @code{build-accounts} (default: @code{10}) |
6980 | Number of build user accounts to create. | |
401c53c4 | 6981 | |
0adfe95a LC |
6982 | @item @code{authorize-key?} (default: @code{#t}) |
6983 | Whether to authorize the substitute key for @code{hydra.gnu.org} | |
6984 | (@pxref{Substitutes}). | |
6985 | ||
6986 | @item @code{use-substitutes?} (default: @code{#t}) | |
6987 | Whether to use substitutes. | |
6988 | ||
b0b9f6e0 LC |
6989 | @item @code{substitute-urls} (default: @var{%default-substitute-urls}) |
6990 | The list of URLs where to look for substitutes by default. | |
6991 | ||
0adfe95a LC |
6992 | @item @code{extra-options} (default: @code{'()}) |
6993 | List of extra command-line options for @command{guix-daemon}. | |
6994 | ||
6995 | @item @code{lsof} (default: @var{lsof}) | |
6996 | @itemx @code{lsh} (default: @var{lsh}) | |
6997 | The lsof and lsh packages to use. | |
6998 | ||
6999 | @end table | |
7000 | @end deftp | |
7001 | ||
7002 | @deffn {Scheme Procedure} guix-service @var{config} | |
7003 | Return a service that runs the Guix build daemon according to | |
7004 | @var{config}. | |
cf4a9129 | 7005 | @end deffn |
a1ba8475 | 7006 | |
be1c2c54 | 7007 | @deffn {Scheme Procedure} udev-service [#:udev udev] |
cf4a9129 LC |
7008 | Run @var{udev}, which populates the @file{/dev} directory dynamically. |
7009 | @end deffn | |
401c53c4 | 7010 | |
be1c2c54 | 7011 | @deffn {Scheme Procedure} console-keymap-service @var{file} |
dedb8d5e | 7012 | @cindex keyboard layout |
5eca9459 AK |
7013 | Return a service to load console keymap from @var{file} using |
7014 | @command{loadkeys} command. | |
7015 | @end deffn | |
7016 | ||
8664cc88 LC |
7017 | @deffn {Scheme Procedure} gpm-service-type [#:gpm @var{gpm}] @ |
7018 | [#:options] | |
7019 | Run @var{gpm}, the general-purpose mouse daemon, with the given | |
7020 | command-line @var{options}. GPM allows users to use the mouse in the console, | |
7021 | notably to select, copy, and paste text. The default value of @var{options} | |
7022 | uses the @code{ps2} protocol, which works for both USB and PS/2 mice. | |
7023 | ||
7024 | This service is not part of @var{%base-services}. | |
7025 | @end deffn | |
7026 | ||
1c52181f LC |
7027 | @anchor{guix-publish-service} |
7028 | @deffn {Scheme Procedure} guix-publish-service [#:guix @var{guix}] @ | |
7029 | [#:port 80] [#:host "localhost"] | |
7030 | Return a service that runs @command{guix publish} listening on @var{host} | |
7031 | and @var{port} (@pxref{Invoking guix publish}). | |
7032 | ||
7033 | This assumes that @file{/etc/guix} already contains a signing key pair as | |
7034 | created by @command{guix archive --generate-key} (@pxref{Invoking guix | |
7035 | archive}). If that is not the case, the service will fail to start. | |
7036 | @end deffn | |
7037 | ||
a69576ea | 7038 | |
cf4a9129 LC |
7039 | @node Networking Services |
7040 | @subsubsection Networking Services | |
401c53c4 | 7041 | |
fa1e31b8 | 7042 | The @code{(gnu services networking)} module provides services to configure |
cf4a9129 | 7043 | the network interface. |
a1ba8475 | 7044 | |
a023cca8 | 7045 | @cindex DHCP, networking service |
be1c2c54 | 7046 | @deffn {Scheme Procedure} dhcp-client-service [#:dhcp @var{isc-dhcp}] |
a023cca8 LC |
7047 | Return a service that runs @var{dhcp}, a Dynamic Host Configuration |
7048 | Protocol (DHCP) client, on all the non-loopback network interfaces. | |
7049 | @end deffn | |
7050 | ||
be1c2c54 | 7051 | @deffn {Scheme Procedure} static-networking-service @var{interface} @var{ip} @ |
cf4a9129 LC |
7052 | [#:gateway #f] [#:name-services @code{'()}] |
7053 | Return a service that starts @var{interface} with address @var{ip}. If | |
7054 | @var{gateway} is true, it must be a string specifying the default network | |
7055 | gateway. | |
7056 | @end deffn | |
8b315a6d | 7057 | |
b7d0c494 | 7058 | @cindex wicd |
87f40011 | 7059 | @cindex network management |
be1c2c54 | 7060 | @deffn {Scheme Procedure} wicd-service [#:wicd @var{wicd}] |
87f40011 LC |
7061 | Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network |
7062 | management daemon that aims to simplify wired and wireless networking. | |
7063 | ||
7064 | This service adds the @var{wicd} package to the global profile, providing | |
7065 | several commands to interact with the daemon and configure networking: | |
7066 | @command{wicd-client}, a graphical user interface, and the @command{wicd-cli} | |
7067 | and @command{wicd-curses} user interfaces. | |
b7d0c494 MW |
7068 | @end deffn |
7069 | ||
c0a9589d SB |
7070 | @cindex NetworkManager |
7071 | @deffn {Scheme Procedure} network-manager-service @ | |
7072 | [#:network-manager @var{network-manager}] | |
7073 | Return a service that runs NetworkManager, a network connection manager | |
7074 | that attempting to keep active network connectivity when available. | |
7075 | @end deffn | |
7076 | ||
be1c2c54 | 7077 | @deffn {Scheme Procedure} ntp-service [#:ntp @var{ntp}] @ |
63854bcb LC |
7078 | [#:name-service @var{%ntp-servers}] |
7079 | Return a service that runs the daemon from @var{ntp}, the | |
7080 | @uref{http://www.ntp.org, Network Time Protocol package}. The daemon will | |
7081 | keep the system clock synchronized with that of @var{servers}. | |
7082 | @end deffn | |
7083 | ||
7084 | @defvr {Scheme Variable} %ntp-servers | |
7085 | List of host names used as the default NTP servers. | |
7086 | @end defvr | |
7087 | ||
375c6108 LC |
7088 | @deffn {Scheme Procedure} tor-service [@var{config-file}] [#:tor @var{tor}] |
7089 | Return a service to run the @uref{https://torproject.org, Tor} anonymous | |
7090 | networking daemon. | |
8b315a6d | 7091 | |
375c6108 | 7092 | The daemon runs as the @code{tor} unprivileged user. It is passed |
6331bde7 LC |
7093 | @var{config-file}, a file-like object, with an additional @code{User tor} line |
7094 | and lines for hidden services added via @code{tor-hidden-service}. Run | |
7095 | @command{man tor} for information about the configuration file. | |
7096 | @end deffn | |
7097 | ||
24a8ef3b | 7098 | @cindex hidden service |
6331bde7 LC |
7099 | @deffn {Scheme Procedure} tor-hidden-service @var{name} @var{mapping} |
7100 | Define a new Tor @dfn{hidden service} called @var{name} and implementing | |
7101 | @var{mapping}. @var{mapping} is a list of port/host tuples, such as: | |
7102 | ||
7103 | @example | |
24a8ef3b LC |
7104 | '((22 "127.0.0.1:22") |
7105 | (80 "127.0.0.1:8080")) | |
6331bde7 LC |
7106 | @end example |
7107 | ||
7108 | In this example, port 22 of the hidden service is mapped to local port 22, and | |
7109 | port 80 is mapped to local port 8080. | |
7110 | ||
6629099a LC |
7111 | This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where |
7112 | the @file{hostname} file contains the @code{.onion} host name for the hidden | |
6331bde7 LC |
7113 | service. |
7114 | ||
7115 | See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor | |
7116 | project's documentation} for more information. | |
cf4a9129 | 7117 | @end deffn |
8b315a6d | 7118 | |
be1c2c54 | 7119 | @deffn {Scheme Procedure} bitlbee-service [#:bitlbee bitlbee] @ |
4627a464 LC |
7120 | [#:interface "127.0.0.1"] [#:port 6667] @ |
7121 | [#:extra-settings ""] | |
7122 | Return a service that runs @url{http://bitlbee.org,BitlBee}, a daemon that | |
7123 | acts as a gateway between IRC and chat networks. | |
7124 | ||
7125 | The daemon will listen to the interface corresponding to the IP address | |
7126 | specified in @var{interface}, on @var{port}. @code{127.0.0.1} means that only | |
7127 | local clients can connect, whereas @code{0.0.0.0} means that connections can | |
7128 | come from any networking interface. | |
7129 | ||
7130 | In addition, @var{extra-settings} specifies a string to append to the | |
7131 | configuration file. | |
7132 | @end deffn | |
7133 | ||
f4391bec | 7134 | Furthermore, @code{(gnu services ssh)} provides the following service. |
8b315a6d | 7135 | |
be1c2c54 | 7136 | @deffn {Scheme Procedure} lsh-service [#:host-key "/etc/lsh/host-key"] @ |
5833bf33 | 7137 | [#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ |
cf4a9129 LC |
7138 | [#:allow-empty-passwords? #f] [#:root-login? #f] @ |
7139 | [#:syslog-output? #t] [#:x11-forwarding? #t] @ | |
7140 | [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ | |
21cc905a | 7141 | [#:public-key-authentication? #t] [#:initialize? #t] |
cf4a9129 LC |
7142 | Run the @command{lshd} program from @var{lsh} to listen on port @var{port-number}. |
7143 | @var{host-key} must designate a file containing the host key, and readable | |
7144 | only by root. | |
72e25e35 | 7145 | |
5833bf33 DP |
7146 | When @var{daemonic?} is true, @command{lshd} will detach from the |
7147 | controlling terminal and log its output to syslogd, unless one sets | |
7148 | @var{syslog-output?} to false. Obviously, it also makes lsh-service | |
7149 | depend on existence of syslogd service. When @var{pid-file?} is true, | |
7150 | @command{lshd} writes its PID to the file called @var{pid-file}. | |
7151 | ||
cf4a9129 LC |
7152 | When @var{initialize?} is true, automatically create the seed and host key |
7153 | upon service activation if they do not exist yet. This may take long and | |
7154 | require interaction. | |
8b315a6d | 7155 | |
20dd519c LC |
7156 | When @var{initialize?} is false, it is up to the user to initialize the |
7157 | randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create | |
7158 | a key pair with the private key stored in file @var{host-key} (@pxref{lshd | |
7159 | basics,,, lsh, LSH Manual}). | |
7160 | ||
cf4a9129 LC |
7161 | When @var{interfaces} is empty, lshd listens for connections on all the |
7162 | network interfaces; otherwise, @var{interfaces} must be a list of host names | |
7163 | or addresses. | |
9bf3c1a7 | 7164 | |
20dd519c LC |
7165 | @var{allow-empty-passwords?} specifies whether to accept log-ins with empty |
7166 | passwords, and @var{root-login?} specifies whether to accept log-ins as | |
cf4a9129 | 7167 | root. |
4af2447e | 7168 | |
cf4a9129 LC |
7169 | The other options should be self-descriptive. |
7170 | @end deffn | |
4af2447e | 7171 | |
fa0c1d61 LC |
7172 | @defvr {Scheme Variable} %facebook-host-aliases |
7173 | This variable contains a string for use in @file{/etc/hosts} | |
7174 | (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). Each | |
7175 | line contains a entry that maps a known server name of the Facebook | |
7176 | on-line service---e.g., @code{www.facebook.com}---to the local | |
7177 | host---@code{127.0.0.1} or its IPv6 equivalent, @code{::1}. | |
7178 | ||
7179 | This variable is typically used in the @code{hosts-file} field of an | |
7313a52e LC |
7180 | @code{operating-system} declaration (@pxref{operating-system Reference, |
7181 | @file{/etc/hosts}}): | |
fa0c1d61 LC |
7182 | |
7183 | @example | |
7184 | (use-modules (gnu) (guix)) | |
7185 | ||
7186 | (operating-system | |
7187 | (host-name "mymachine") | |
7188 | ;; ... | |
7189 | (hosts-file | |
7190 | ;; Create a /etc/hosts file with aliases for "localhost" | |
7191 | ;; and "mymachine", as well as for Facebook servers. | |
24e02c28 LC |
7192 | (plain-file "hosts" |
7193 | (string-append (local-host-aliases host-name) | |
7194 | %facebook-host-aliases)))) | |
fa0c1d61 LC |
7195 | @end example |
7196 | ||
7197 | This mechanism can prevent programs running locally, such as Web | |
7198 | browsers, from accessing Facebook. | |
7199 | @end defvr | |
7200 | ||
965a7332 LC |
7201 | The @code{(gnu services avahi)} provides the following definition. |
7202 | ||
be1c2c54 | 7203 | @deffn {Scheme Procedure} avahi-service [#:avahi @var{avahi}] @ |
965a7332 LC |
7204 | [#:host-name #f] [#:publish? #t] [#:ipv4? #t] @ |
7205 | [#:ipv6? #t] [#:wide-area? #f] @ | |
7206 | [#:domains-to-browse '()] | |
7207 | Return a service that runs @command{avahi-daemon}, a system-wide | |
7208 | mDNS/DNS-SD responder that allows for service discovery and | |
cc9c1f39 LC |
7209 | "zero-configuration" host name lookups (see @uref{http://avahi.org/}), and |
7210 | extends the name service cache daemon (nscd) so that it can resolve | |
7211 | @code{.local} host names using | |
1065bed9 LC |
7212 | @uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. Additionally, |
7213 | add the @var{avahi} package to the system profile so that commands such as | |
7214 | @command{avahi-browse} are directly usable. | |
965a7332 LC |
7215 | |
7216 | If @var{host-name} is different from @code{#f}, use that as the host name to | |
7217 | publish for this machine; otherwise, use the machine's actual host name. | |
7218 | ||
7219 | When @var{publish?} is true, publishing of host names and services is allowed; | |
7220 | in particular, avahi-daemon will publish the machine's host name and IP | |
7221 | address via mDNS on the local network. | |
7222 | ||
7223 | When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled. | |
7224 | ||
7225 | Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6 | |
7226 | sockets. | |
7227 | @end deffn | |
7228 | ||
7229 | ||
cf4a9129 LC |
7230 | @node X Window |
7231 | @subsubsection X Window | |
68ad877c | 7232 | |
cf4a9129 LC |
7233 | Support for the X Window graphical display system---specifically |
7234 | Xorg---is provided by the @code{(gnu services xorg)} module. Note that | |
7235 | there is no @code{xorg-service} procedure. Instead, the X server is | |
7236 | started by the @dfn{login manager}, currently SLiM. | |
4af2447e | 7237 | |
be1c2c54 | 7238 | @deffn {Scheme Procedure} slim-service [#:allow-empty-passwords? #f] @ |
0ecc3bf3 LC |
7239 | [#:auto-login? #f] [#:default-user ""] [#:startx] @ |
7240 | [#:theme @var{%default-slim-theme}] @ | |
4bd43bbe | 7241 | [#:theme-name @var{%default-slim-theme-name}] |
cf4a9129 LC |
7242 | Return a service that spawns the SLiM graphical login manager, which in |
7243 | turn starts the X display server with @var{startx}, a command as returned by | |
7244 | @code{xorg-start-command}. | |
4af2447e | 7245 | |
04e4e6ab LC |
7246 | @cindex X session |
7247 | ||
7248 | SLiM automatically looks for session types described by the @file{.desktop} | |
7249 | files in @file{/run/current-system/profile/share/xsessions} and allows users | |
7250 | to choose a session from the log-in screen using @kbd{F1}. Packages such as | |
7251 | @var{xfce}, @var{sawfish}, and @var{ratpoison} provide @file{.desktop} files; | |
7252 | adding them to the system-wide set of packages automatically makes them | |
7253 | available at the log-in screen. | |
7254 | ||
7255 | In addition, @file{~/.xsession} files are honored. When available, | |
7256 | @file{~/.xsession} must be an executable that starts a window manager | |
7257 | and/or other X clients. | |
7258 | ||
cf4a9129 LC |
7259 | When @var{allow-empty-passwords?} is true, allow logins with an empty |
7260 | password. When @var{auto-login?} is true, log in automatically as | |
7261 | @var{default-user}. | |
0ecc3bf3 LC |
7262 | |
7263 | If @var{theme} is @code{#f}, the use the default log-in theme; otherwise | |
7264 | @var{theme} must be a gexp denoting the name of a directory containing the | |
7265 | theme to use. In that case, @var{theme-name} specifies the name of the | |
7266 | theme. | |
cf4a9129 | 7267 | @end deffn |
4af2447e | 7268 | |
0ecc3bf3 LC |
7269 | @defvr {Scheme Variable} %default-theme |
7270 | @defvrx {Scheme Variable} %default-theme-name | |
7271 | The G-Expression denoting the default SLiM theme and its name. | |
7272 | @end defvr | |
7273 | ||
be1c2c54 | 7274 | @deffn {Scheme Procedure} xorg-start-command [#:guile] @ |
d1cdd7ba | 7275 | [#:configuration-file #f] [#:xorg-server @var{xorg-server}] |
f703413e | 7276 | Return a derivation that builds a @var{guile} script to start the X server |
d1cdd7ba LC |
7277 | from @var{xorg-server}. @var{configuration-file} is the server configuration |
7278 | file or a derivation that builds it; when omitted, the result of | |
7279 | @code{xorg-configuration-file} is used. | |
7280 | ||
7281 | Usually the X server is started by a login manager. | |
7282 | @end deffn | |
7283 | ||
be1c2c54 | 7284 | @deffn {Scheme Procedure} xorg-configuration-file @ |
12422c9d | 7285 | [#:drivers '()] [#:resolutions '()] [#:extra-config '()] |
d1cdd7ba LC |
7286 | Return a configuration file for the Xorg server containing search paths for |
7287 | all the common drivers. | |
f703413e LC |
7288 | |
7289 | @var{drivers} must be either the empty list, in which case Xorg chooses a | |
7290 | graphics driver automatically, or a list of driver names that will be tried in | |
d1cdd7ba | 7291 | this order---e.g., @code{(\"modesetting\" \"vesa\")}. |
d2e59637 LC |
7292 | |
7293 | Likewise, when @var{resolutions} is the empty list, Xorg chooses an | |
7294 | appropriate screen resolution; otherwise, it must be a list of | |
7295 | resolutions---e.g., @code{((1024 768) (640 480))}. | |
12422c9d LC |
7296 | |
7297 | Last, @var{extra-config} is a list of strings or objects appended to the | |
7298 | @code{text-file*} argument list. It is used to pass extra text to be added | |
7299 | verbatim to the configuration file. | |
f703413e | 7300 | @end deffn |
4af2447e | 7301 | |
6726282b LC |
7302 | @deffn {Scheme Procedure} screen-locker-service @var{package} [@var{name}] |
7303 | Add @var{package}, a package for a screen-locker or screen-saver whose | |
7304 | command is @var{program}, to the set of setuid programs and add a PAM entry | |
7305 | for it. For example: | |
7306 | ||
7307 | @lisp | |
7308 | (screen-locker-service xlockmore "xlock") | |
7309 | @end lisp | |
7310 | ||
7311 | makes the good ol' XlockMore usable. | |
7312 | @end deffn | |
7313 | ||
7314 | ||
fe1a39d3 LC |
7315 | @node Desktop Services |
7316 | @subsubsection Desktop Services | |
aa4ed923 | 7317 | |
fe1a39d3 LC |
7318 | The @code{(gnu services desktop)} module provides services that are |
7319 | usually useful in the context of a ``desktop'' setup---that is, on a | |
7320 | machine running a graphical display server, possibly with graphical user | |
7321 | interfaces, etc. | |
aa4ed923 | 7322 | |
4467be21 LC |
7323 | To simplify things, the module defines a variable containing the set of |
7324 | services that users typically expect on a machine with a graphical | |
7325 | environment and networking: | |
7326 | ||
7327 | @defvr {Scheme Variable} %desktop-services | |
7328 | This is a list of services that builds upon @var{%base-services} and | |
7329 | adds or adjust services for a typical ``desktop'' setup. | |
7330 | ||
7331 | In particular, it adds a graphical login manager (@pxref{X Window, | |
6726282b LC |
7332 | @code{slim-service}}), screen lockers, |
7333 | a network management tool (@pxref{Networking | |
4467be21 | 7334 | Services, @code{wicd-service}}), energy and color management services, |
4650a77e | 7335 | the @code{elogind} login and seat manager, the Polkit privilege service, |
cee32ee4 AW |
7336 | the GeoClue location service, an NTP client (@pxref{Networking |
7337 | Services}), the Avahi daemon, and has the name service switch service | |
7338 | configured to be able to use @code{nss-mdns} (@pxref{Name Service | |
7339 | Switch, mDNS}). | |
4467be21 LC |
7340 | @end defvr |
7341 | ||
7342 | The @var{%desktop-services} variable can be used as the @code{services} | |
7343 | field of an @code{operating-system} declaration (@pxref{operating-system | |
7344 | Reference, @code{services}}). | |
7345 | ||
0adfe95a LC |
7346 | The actual service definitions provided by @code{(gnu services dbus)} |
7347 | and @code{(gnu services desktop)} are described below. | |
4467be21 | 7348 | |
0adfe95a | 7349 | @deffn {Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()] |
fe1a39d3 LC |
7350 | Return a service that runs the ``system bus'', using @var{dbus}, with |
7351 | support for @var{services}. | |
aa4ed923 | 7352 | |
fe1a39d3 LC |
7353 | @uref{http://dbus.freedesktop.org/, D-Bus} is an inter-process communication |
7354 | facility. Its system bus is used to allow system services to communicate | |
7355 | and be notified of system-wide events. | |
aa4ed923 | 7356 | |
fe1a39d3 LC |
7357 | @var{services} must be a list of packages that provide an |
7358 | @file{etc/dbus-1/system.d} directory containing additional D-Bus configuration | |
7359 | and policy files. For example, to allow avahi-daemon to use the system bus, | |
7360 | @var{services} must be equal to @code{(list avahi)}. | |
aa4ed923 AK |
7361 | @end deffn |
7362 | ||
0adfe95a | 7363 | @deffn {Scheme Procedure} elogind-service [#:config @var{config}] |
4650a77e AW |
7364 | Return a service that runs the @code{elogind} login and |
7365 | seat management daemon. @uref{https://github.com/andywingo/elogind, | |
7366 | Elogind} exposes a D-Bus interface that can be used to know which users | |
7367 | are logged in, know what kind of sessions they have open, suspend the | |
7368 | system, inhibit system suspend, reboot the system, and other tasks. | |
7369 | ||
7370 | Elogind handles most system-level power events for a computer, for | |
7371 | example suspending the system when a lid is closed, or shutting it down | |
7372 | when the power button is pressed. | |
7373 | ||
7374 | The @var{config} keyword argument specifies the configuration for | |
7375 | elogind, and should be the result of a @code{(elogind-configuration | |
7376 | (@var{parameter} @var{value})...)} invocation. Available parameters and | |
7377 | their default values are: | |
7378 | ||
7379 | @table @code | |
7380 | @item kill-user-processes? | |
7381 | @code{#f} | |
7382 | @item kill-only-users | |
7383 | @code{()} | |
7384 | @item kill-exclude-users | |
7385 | @code{("root")} | |
7386 | @item inhibit-delay-max-seconds | |
7387 | @code{5} | |
7388 | @item handle-power-key | |
7389 | @code{poweroff} | |
7390 | @item handle-suspend-key | |
7391 | @code{suspend} | |
7392 | @item handle-hibernate-key | |
7393 | @code{hibernate} | |
7394 | @item handle-lid-switch | |
7395 | @code{suspend} | |
7396 | @item handle-lid-switch-docked | |
7397 | @code{ignore} | |
7398 | @item power-key-ignore-inhibited? | |
7399 | @code{#f} | |
7400 | @item suspend-key-ignore-inhibited? | |
7401 | @code{#f} | |
7402 | @item hibernate-key-ignore-inhibited? | |
7403 | @code{#f} | |
7404 | @item lid-switch-ignore-inhibited? | |
7405 | @code{#t} | |
7406 | @item holdoff-timeout-seconds | |
7407 | @code{30} | |
7408 | @item idle-action | |
7409 | @code{ignore} | |
7410 | @item idle-action-seconds | |
7411 | @code{(* 30 60)} | |
7412 | @item runtime-directory-size-percent | |
7413 | @code{10} | |
7414 | @item runtime-directory-size | |
7415 | @code{#f} | |
7416 | @item remove-ipc? | |
7417 | @code{#t} | |
7418 | @item suspend-state | |
7419 | @code{("mem" "standby" "freeze")} | |
7420 | @item suspend-mode | |
7421 | @code{()} | |
7422 | @item hibernate-state | |
7423 | @code{("disk")} | |
7424 | @item hibernate-mode | |
7425 | @code{("platform" "shutdown")} | |
7426 | @item hybrid-sleep-state | |
7427 | @code{("disk")} | |
7428 | @item hybrid-sleep-mode | |
7429 | @code{("suspend" "platform" "shutdown")} | |
7430 | @end table | |
7431 | @end deffn | |
7432 | ||
be1c2c54 | 7433 | @deffn {Scheme Procedure} polkit-service @ |
4650a77e | 7434 | [#:polkit @var{polkit}] |
222e3319 LC |
7435 | Return a service that runs the |
7436 | @uref{http://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege | |
7437 | management service}, which allows system administrators to grant access to | |
7438 | privileged operations in a structured way. By querying the Polkit service, a | |
7439 | privileged system component can know when it should grant additional | |
7440 | capabilities to ordinary users. For example, an ordinary user can be granted | |
7441 | the capability to suspend the system if the user is logged in locally. | |
4650a77e AW |
7442 | @end deffn |
7443 | ||
be1c2c54 | 7444 | @deffn {Scheme Procedure} upower-service [#:upower @var{upower}] @ |
be234128 AW |
7445 | [#:watts-up-pro? #f] @ |
7446 | [#:poll-batteries? #t] @ | |
7447 | [#:ignore-lid? #f] @ | |
7448 | [#:use-percentage-for-policy? #f] @ | |
7449 | [#:percentage-low 10] @ | |
7450 | [#:percentage-critical 3] @ | |
7451 | [#:percentage-action 2] @ | |
7452 | [#:time-low 1200] @ | |
7453 | [#:time-critical 300] @ | |
7454 | [#:time-action 120] @ | |
7455 | [#:critical-power-action 'hybrid-sleep] | |
7456 | Return a service that runs @uref{http://upower.freedesktop.org/, | |
7457 | @command{upowerd}}, a system-wide monitor for power consumption and battery | |
7458 | levels, with the given configuration settings. It implements the | |
7459 | @code{org.freedesktop.UPower} D-Bus interface, and is notably used by | |
7460 | GNOME. | |
7461 | @end deffn | |
7462 | ||
2b9e0a94 LC |
7463 | @deffn {Scheme Procedure} udisks-service [#:udisks @var{udisks}] |
7464 | Return a service for @uref{http://udisks.freedesktop.org/docs/latest/, | |
7465 | UDisks}, a @dfn{disk management} daemon that provides user interfaces with | |
7466 | notifications and ways to mount/unmount disks. Programs that talk to UDisks | |
7467 | include the @command{udisksctl} command, part of UDisks, and GNOME Disks. | |
7468 | @end deffn | |
7469 | ||
be1c2c54 | 7470 | @deffn {Scheme Procedure} colord-service [#:colord @var{colord}] |
7ce597ff AW |
7471 | Return a service that runs @command{colord}, a system service with a D-Bus |
7472 | interface to manage the color profiles of input and output devices such as | |
7473 | screens and scanners. It is notably used by the GNOME Color Manager graphical | |
7474 | tool. See @uref{http://www.freedesktop.org/software/colord/, the colord web | |
7475 | site} for more information. | |
7476 | @end deffn | |
7477 | ||
cee32ee4 AW |
7478 | @deffn {Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()] |
7479 | Return an configuration allowing an application to access GeoClue | |
7480 | location data. @var{name} is the Desktop ID of the application, without | |
7481 | the @code{.desktop} part. If @var{allowed?} is true, the application | |
7482 | will have access to location information by default. The boolean | |
7483 | @var{system?} value indicates that an application is a system component | |
7484 | or not. Finally @var{users} is a list of UIDs of all users for which | |
7485 | this application is allowed location info access. An empty users list | |
7486 | means that all users are allowed. | |
7487 | @end deffn | |
7488 | ||
7489 | @defvr {Scheme Variable} %standard-geoclue-applications | |
7490 | The standard list of well-known GeoClue application configurations, | |
7491 | granting authority to GNOME's date-and-time utility to ask for the | |
7492 | current location in order to set the time zone, and allowing the Firefox | |
7493 | (IceCat) and Epiphany web browsers to request location information. | |
7494 | Firefox and Epiphany both query the user before allowing a web page to | |
7495 | know the user's location. | |
7496 | @end defvr | |
7497 | ||
be1c2c54 | 7498 | @deffn {Scheme Procedure} geoclue-service [#:colord @var{colord}] @ |
cee32ee4 AW |
7499 | [#:whitelist '()] @ |
7500 | [#:wifi-geolocation-url "https://location.services.mozilla.com/v1/geolocate?key=geoclue"] @ | |
7501 | [#:submit-data? #f] | |
7502 | [#:wifi-submission-url "https://location.services.mozilla.com/v1/submit?key=geoclue"] @ | |
7503 | [#:submission-nick "geoclue"] @ | |
7504 | [#:applications %standard-geoclue-applications] | |
7505 | Return a service that runs the GeoClue location service. This service | |
7506 | provides a D-Bus interface to allow applications to request access to a | |
7507 | user's physical location, and optionally to add information to online | |
7508 | location databases. See | |
7509 | @uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue | |
7510 | web site} for more information. | |
7511 | @end deffn | |
7512 | ||
105369a4 DT |
7513 | @node Database Services |
7514 | @subsubsection Database Services | |
7515 | ||
7516 | The @code{(gnu services databases)} module provides the following service. | |
7517 | ||
be1c2c54 | 7518 | @deffn {Scheme Procedure} postgresql-service [#:postgresql postgresql] @ |
105369a4 DT |
7519 | [#:config-file] [#:data-directory ``/var/lib/postgresql/data''] |
7520 | Return a service that runs @var{postgresql}, the PostgreSQL database | |
7521 | server. | |
7522 | ||
7523 | The PostgreSQL daemon loads its runtime configuration from | |
7524 | @var{config-file} and stores the database cluster in | |
7525 | @var{data-directory}. | |
7526 | @end deffn | |
fe1a39d3 | 7527 | |
d8c18af8 AW |
7528 | @node Mail Services |
7529 | @subsubsection Mail Services | |
7530 | ||
7531 | The @code{(gnu services mail)} module provides Guix service definitions | |
7532 | for mail services. Currently the only implemented service is Dovecot, | |
7533 | an IMAP, POP3, and LMTP server. | |
7534 | ||
7535 | Guix does not yet have a mail transfer agent (MTA), although for some | |
7536 | lightweight purposes the @code{esmtp} relay-only MTA may suffice. Help | |
7537 | is needed to properly integrate a full MTA, such as Postfix. Patches | |
7538 | welcome! | |
7539 | ||
7540 | To add an IMAP/POP3 server to a GuixSD system, add a | |
7541 | @code{dovecot-service} to the operating system definition: | |
7542 | ||
7543 | @deffn {Scheme Procedure} dovecot-service [#:config (dovecot-configuration)] | |
7544 | Return a service that runs the Dovecot IMAP/POP3/LMTP mail server. | |
7545 | @end deffn | |
7546 | ||
7547 | By default, Dovecot doesn't need much configuration; the default | |
7548 | configuration object created by @code{(dovecot-configuration)} will | |
7549 | suffice if your mail is delivered to @code{~/Maildir}. A self-signed | |
7550 | certificate will be generated for TLS-protected connections, though | |
7551 | Dovecot will also listen on cleartext ports by default. There are a | |
7552 | number of options though which mail administrators might need to change, | |
7553 | and as is the case with other services, Guix allows the system | |
7554 | administrator to specify these parameters via a uniform Scheme interface. | |
7555 | ||
7556 | For example, to specify that mail is located at @code{maildir~/.mail}, | |
7557 | one would instantiate the Dovecot service like this: | |
7558 | ||
7559 | @example | |
7560 | (dovecot-service #:config | |
7561 | (dovecot-configuration | |
7562 | (mail-location "maildir:~/.mail"))) | |
7563 | @end example | |
7564 | ||
7565 | The available configuration parameters follow. Each parameter | |
7566 | definition is preceded by its type; for example, @samp{string-list foo} | |
7567 | indicates that the @code{foo} parameter should be specified as a list of | |
7568 | strings. There is also a way to specify the configuration as a string, | |
7569 | if you have an old @code{dovecot.conf} file that you want to port over | |
7570 | from some other system; see the end for more details. | |
7571 | ||
7572 | @c The following documentation was initially generated by | |
7573 | @c (generate-documentation) in (gnu services mail). Manually maintained | |
7574 | @c documentation is better, so we shouldn't hesitate to edit below as | |
7575 | @c needed. However if the change you want to make to this documentation | |
7576 | @c can be done in an automated way, it's probably easier to change | |
7577 | @c (generate-documentation) than to make it below and have to deal with | |
7578 | @c the churn as dovecot updates. | |
7579 | ||
7580 | Available @code{dovecot-configuration} fields are: | |
7581 | ||
7582 | @deftypevr {@code{dovecot-configuration} parameter} package dovecot | |
7583 | The dovecot package. | |
7584 | @end deftypevr | |
7585 | ||
7586 | @deftypevr {@code{dovecot-configuration} parameter} comma-separated-string-list listen | |
7587 | A list of IPs or hosts where to listen in for connections. @samp{*} | |
7588 | listens in all IPv4 interfaces, @samp{::} listens in all IPv6 | |
7589 | interfaces. If you want to specify non-default ports or anything more | |
7590 | complex, customize the address and port fields of the | |
7591 | @samp{inet-listener} of the specific services you are interested in. | |
7592 | @end deftypevr | |
7593 | ||
7594 | @deftypevr {@code{dovecot-configuration} parameter} protocol-configuration-list protocols | |
7595 | List of protocols we want to serve. Available protocols include | |
7596 | @samp{imap}, @samp{pop3}, and @samp{lmtp}. | |
7597 | ||
7598 | Available @code{protocol-configuration} fields are: | |
7599 | ||
7600 | @deftypevr {@code{protocol-configuration} parameter} string name | |
7601 | The name of the protocol. | |
7602 | @end deftypevr | |
7603 | ||
7604 | @deftypevr {@code{protocol-configuration} parameter} string auth-socket-path | |
7605 | UNIX socket path to master authentication server to find users. | |
7606 | This is used by imap (for shared users) and lda. | |
7607 | Defaults to @samp{"/var/run/dovecot/auth-userdb"}. | |
7608 | @end deftypevr | |
7609 | ||
7610 | @deftypevr {@code{protocol-configuration} parameter} space-separated-string-list mail-plugins | |
7611 | Space separated list of plugins to load. | |
7612 | @end deftypevr | |
7613 | ||
7614 | @deftypevr {@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections | |
7615 | Maximum number of IMAP connections allowed for a user from each IP | |
7616 | address. NOTE: The username is compared case-sensitively. | |
7617 | Defaults to @samp{10}. | |
7618 | @end deftypevr | |
7619 | ||
7620 | @end deftypevr | |
7621 | ||
7622 | @deftypevr {@code{dovecot-configuration} parameter} service-configuration-list services | |
7623 | List of services to enable. Available services include @samp{imap}, | |
7624 | @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and | |
7625 | @samp{lmtp}. | |
7626 | ||
7627 | Available @code{service-configuration} fields are: | |
7628 | ||
7629 | @deftypevr {@code{service-configuration} parameter} string kind | |
7630 | The service kind. Valid values include @code{director}, | |
7631 | @code{imap-login}, @code{pop3-login}, @code{lmtp}, @code{imap}, | |
7632 | @code{pop3}, @code{auth}, @code{auth-worker}, @code{dict}, | |
7633 | @code{tcpwrap}, @code{quota-warning}, or anything else. | |
7634 | @end deftypevr | |
7635 | ||
7636 | @deftypevr {@code{service-configuration} parameter} listener-configuration-list listeners | |
7637 | Listeners for the service. A listener is either an | |
7638 | @code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or | |
7639 | an @code{inet-listener-configuration}. | |
7640 | Defaults to @samp{()}. | |
7641 | ||
7642 | Available @code{unix-listener-configuration} fields are: | |
7643 | ||
7644 | @deftypevr {@code{unix-listener-configuration} parameter} file-name path | |
7645 | The file name on which to listen. | |
7646 | @end deftypevr | |
7647 | ||
7648 | @deftypevr {@code{unix-listener-configuration} parameter} string mode | |
7649 | The access mode for the socket. | |
7650 | Defaults to @samp{"0600"}. | |
7651 | @end deftypevr | |
7652 | ||
7653 | @deftypevr {@code{unix-listener-configuration} parameter} string user | |
f9b9a033 | 7654 | The user to own the socket. |
d8c18af8 AW |
7655 | Defaults to @samp{""}. |
7656 | @end deftypevr | |
7657 | ||
7658 | @deftypevr {@code{unix-listener-configuration} parameter} string group | |
7659 | The group to own the socket. | |
7660 | Defaults to @samp{""}. | |
7661 | @end deftypevr | |
7662 | ||
7663 | ||
7664 | Available @code{fifo-listener-configuration} fields are: | |
7665 | ||
7666 | @deftypevr {@code{fifo-listener-configuration} parameter} file-name path | |
7667 | The file name on which to listen. | |
7668 | @end deftypevr | |
7669 | ||
7670 | @deftypevr {@code{fifo-listener-configuration} parameter} string mode | |
7671 | The access mode for the socket. | |
7672 | Defaults to @samp{"0600"}. | |
7673 | @end deftypevr | |
7674 | ||
7675 | @deftypevr {@code{fifo-listener-configuration} parameter} string user | |
f9b9a033 | 7676 | The user to own the socket. |
d8c18af8 AW |
7677 | Defaults to @samp{""}. |
7678 | @end deftypevr | |
7679 | ||
7680 | @deftypevr {@code{fifo-listener-configuration} parameter} string group | |
7681 | The group to own the socket. | |
7682 | Defaults to @samp{""}. | |
7683 | @end deftypevr | |
7684 | ||
7685 | ||
7686 | Available @code{inet-listener-configuration} fields are: | |
7687 | ||
7688 | @deftypevr {@code{inet-listener-configuration} parameter} string protocol | |
7689 | The protocol to listen for. | |
7690 | @end deftypevr | |
7691 | ||
7692 | @deftypevr {@code{inet-listener-configuration} parameter} string address | |
7693 | The address on which to listen, or empty for all addresses. | |
7694 | Defaults to @samp{""}. | |
7695 | @end deftypevr | |
7696 | ||
7697 | @deftypevr {@code{inet-listener-configuration} parameter} non-negative-integer port | |
7698 | The port on which to listen. | |
7699 | @end deftypevr | |
7700 | ||
7701 | @deftypevr {@code{inet-listener-configuration} parameter} boolean ssl? | |
7702 | Whether to use SSL for this service; @samp{yes}, @samp{no}, or | |
7703 | @samp{required}. | |
7704 | Defaults to @samp{#t}. | |
7705 | @end deftypevr | |
7706 | ||
7707 | @end deftypevr | |
7708 | ||
7709 | @deftypevr {@code{service-configuration} parameter} non-negative-integer service-count | |
7710 | Number of connections to handle before starting a new process. | |
7711 | Typically the only useful values are 0 (unlimited) or 1. 1 is more | |
7712 | secure, but 0 is faster. <doc/wiki/LoginProcess.txt>. | |
7713 | Defaults to @samp{1}. | |
7714 | @end deftypevr | |
7715 | ||
7716 | @deftypevr {@code{service-configuration} parameter} non-negative-integer process-min-avail | |
7717 | Number of processes to always keep waiting for more connections. | |
7718 | Defaults to @samp{0}. | |
7719 | @end deftypevr | |
7720 | ||
7721 | @deftypevr {@code{service-configuration} parameter} non-negative-integer vsz-limit | |
7722 | If you set @samp{service-count 0}, you probably need to grow | |
7723 | this. | |
7724 | Defaults to @samp{256000000}. | |
7725 | @end deftypevr | |
7726 | ||
7727 | @end deftypevr | |
7728 | ||
7729 | @deftypevr {@code{dovecot-configuration} parameter} dict-configuration dict | |
7730 | Dict configuration, as created by the @code{dict-configuration} | |
7731 | constructor. | |
7732 | ||
7733 | Available @code{dict-configuration} fields are: | |
7734 | ||
7735 | @deftypevr {@code{dict-configuration} parameter} free-form-fields entries | |
7736 | A list of key-value pairs that this dict should hold. | |
7737 | Defaults to @samp{()}. | |
7738 | @end deftypevr | |
7739 | ||
7740 | @end deftypevr | |
7741 | ||
7742 | @deftypevr {@code{dovecot-configuration} parameter} passdb-configuration-list passdbs | |
7743 | List of passdb configurations, each one created by the | |
7744 | @code{passdb-configuration} constructor. | |
7745 | ||
7746 | Available @code{passdb-configuration} fields are: | |
7747 | ||
7748 | @deftypevr {@code{passdb-configuration} parameter} string driver | |
7749 | The driver that the passdb should use. Valid values include | |
7750 | @samp{pam}, @samp{passwd}, @samp{shadow}, @samp{bsdauth}, and | |
7751 | @samp{static}. | |
7752 | Defaults to @samp{"pam"}. | |
7753 | @end deftypevr | |
7754 | ||
7755 | @deftypevr {@code{passdb-configuration} parameter} free-form-args args | |
7756 | A list of key-value args to the passdb driver. | |
7757 | Defaults to @samp{()}. | |
7758 | @end deftypevr | |
7759 | ||
7760 | @end deftypevr | |
7761 | ||
7762 | @deftypevr {@code{dovecot-configuration} parameter} userdb-configuration-list userdbs | |
7763 | List of userdb configurations, each one created by the | |
7764 | @code{userdb-configuration} constructor. | |
7765 | ||
7766 | Available @code{userdb-configuration} fields are: | |
7767 | ||
7768 | @deftypevr {@code{userdb-configuration} parameter} string driver | |
7769 | The driver that the userdb should use. Valid values include | |
7770 | @samp{passwd} and @samp{static}. | |
7771 | Defaults to @samp{"passwd"}. | |
7772 | @end deftypevr | |
7773 | ||
7774 | @deftypevr {@code{userdb-configuration} parameter} free-form-args args | |
7775 | A list of key-value args to the userdb driver. | |
7776 | Defaults to @samp{()}. | |
7777 | @end deftypevr | |
7778 | ||
7779 | @deftypevr {@code{userdb-configuration} parameter} free-form-args override-fields | |
7780 | Override fields from passwd. | |
7781 | Defaults to @samp{()}. | |
7782 | @end deftypevr | |
7783 | ||
7784 | @end deftypevr | |
7785 | ||
7786 | @deftypevr {@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration | |
7787 | Plug-in configuration, created by the @code{plugin-configuration} | |
7788 | constructor. | |
7789 | @end deftypevr | |
7790 | ||
7791 | @deftypevr {@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces | |
7792 | List of namespaces. Each item in the list is created by the | |
7793 | @code{namespace-configuration} constructor. | |
7794 | ||
7795 | Available @code{namespace-configuration} fields are: | |
7796 | ||
7797 | @deftypevr {@code{namespace-configuration} parameter} string name | |
7798 | Name for this namespace. | |
7799 | @end deftypevr | |
7800 | ||
7801 | @deftypevr {@code{namespace-configuration} parameter} string type | |
7802 | Namespace type: @samp{private}, @samp{shared} or @samp{public}. | |
7803 | Defaults to @samp{"private"}. | |
7804 | @end deftypevr | |
7805 | ||
7806 | @deftypevr {@code{namespace-configuration} parameter} string separator | |
7807 | Hierarchy separator to use. You should use the same separator for | |
7808 | all namespaces or some clients get confused. @samp{/} is usually a good | |
7809 | one. The default however depends on the underlying mail storage | |
7810 | format. | |
7811 | Defaults to @samp{""}. | |
7812 | @end deftypevr | |
7813 | ||
7814 | @deftypevr {@code{namespace-configuration} parameter} string prefix | |
7815 | Prefix required to access this namespace. This needs to be | |
7816 | different for all namespaces. For example @samp{Public/}. | |
7817 | Defaults to @samp{""}. | |
7818 | @end deftypevr | |
7819 | ||
7820 | @deftypevr {@code{namespace-configuration} parameter} string location | |
7821 | Physical location of the mailbox. This is in same format as | |
7822 | mail_location, which is also the default for it. | |
7823 | Defaults to @samp{""}. | |
7824 | @end deftypevr | |
7825 | ||
7826 | @deftypevr {@code{namespace-configuration} parameter} boolean inbox? | |
7827 | There can be only one INBOX, and this setting defines which | |
7828 | namespace has it. | |
7829 | Defaults to @samp{#f}. | |
7830 | @end deftypevr | |
7831 | ||
7832 | @deftypevr {@code{namespace-configuration} parameter} boolean hidden? | |
7833 | If namespace is hidden, it's not advertised to clients via NAMESPACE | |
7834 | extension. You'll most likely also want to set @samp{list? #f}. This is mostly | |
7835 | useful when converting from another server with different namespaces | |
7836 | which you want to deprecate but still keep working. For example you can | |
7837 | create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} | |
7838 | and @samp{mail/}. | |
7839 | Defaults to @samp{#f}. | |
7840 | @end deftypevr | |
7841 | ||
7842 | @deftypevr {@code{namespace-configuration} parameter} boolean list? | |
7843 | Show the mailboxes under this namespace with LIST command. This | |
7844 | makes the namespace visible for clients that don't support NAMESPACE | |
7845 | extension. The special @code{children} value lists child mailboxes, but | |
7846 | hides the namespace prefix. | |
7847 | Defaults to @samp{#t}. | |
7848 | @end deftypevr | |
7849 | ||
7850 | @deftypevr {@code{namespace-configuration} parameter} boolean subscriptions? | |
7851 | Namespace handles its own subscriptions. If set to @code{#f}, the | |
7852 | parent namespace handles them. The empty prefix should always have this | |
7853 | as @code{#t}.) | |
7854 | Defaults to @samp{#t}. | |
7855 | @end deftypevr | |
7856 | ||
7857 | @deftypevr {@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes | |
7858 | List of predefined mailboxes in this namespace. | |
7859 | Defaults to @samp{()}. | |
7860 | ||
7861 | Available @code{mailbox-configuration} fields are: | |
7862 | ||
7863 | @deftypevr {@code{mailbox-configuration} parameter} string name | |
7864 | Name for this mailbox. | |
7865 | @end deftypevr | |
7866 | ||
7867 | @deftypevr {@code{mailbox-configuration} parameter} string auto | |
7868 | @samp{create} will automatically create this mailbox. | |
7869 | @samp{subscribe} will both create and subscribe to the mailbox. | |
7870 | Defaults to @samp{"no"}. | |
7871 | @end deftypevr | |
7872 | ||
7873 | @deftypevr {@code{mailbox-configuration} parameter} space-separated-string-list special-use | |
7874 | List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. | |
7875 | Valid values are @code{\All}, @code{\Archive}, @code{\Drafts}, | |
7876 | @code{\Flagged}, @code{\Junk}, @code{\Sent}, and @code{\Trash}. | |
7877 | Defaults to @samp{()}. | |
7878 | @end deftypevr | |
7879 | ||
7880 | @end deftypevr | |
7881 | ||
7882 | @end deftypevr | |
7883 | ||
7884 | @deftypevr {@code{dovecot-configuration} parameter} file-name base-dir | |
7885 | Base directory where to store runtime data. | |
7886 | Defaults to @samp{"/var/run/dovecot/"}. | |
7887 | @end deftypevr | |
7888 | ||
7889 | @deftypevr {@code{dovecot-configuration} parameter} string login-greeting | |
7890 | Greeting message for clients. | |
7891 | Defaults to @samp{"Dovecot ready."}. | |
7892 | @end deftypevr | |
7893 | ||
7894 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks | |
7895 | List of trusted network ranges. Connections from these IPs are | |
7896 | allowed to override their IP addresses and ports (for logging and for | |
7897 | authentication checks). @samp{disable-plaintext-auth} is also ignored | |
7898 | for these networks. Typically you'd specify your IMAP proxy servers | |
7899 | here. | |
7900 | Defaults to @samp{()}. | |
7901 | @end deftypevr | |
7902 | ||
7903 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets | |
7904 | List of login access check sockets (e.g. tcpwrap). | |
7905 | Defaults to @samp{()}. | |
7906 | @end deftypevr | |
7907 | ||
7908 | @deftypevr {@code{dovecot-configuration} parameter} boolean verbose-proctitle? | |
7909 | Show more verbose process titles (in ps). Currently shows user name | |
7910 | and IP address. Useful for seeing who are actually using the IMAP | |
7911 | processes (e.g. shared mailboxes or if same uid is used for multiple | |
7912 | accounts). | |
7913 | Defaults to @samp{#f}. | |
7914 | @end deftypevr | |
7915 | ||
7916 | @deftypevr {@code{dovecot-configuration} parameter} boolean shutdown-clients? | |
7917 | Should all processes be killed when Dovecot master process shuts down. | |
7918 | Setting this to @code{#f} means that Dovecot can be upgraded without | |
7919 | forcing existing client connections to close (although that could also | |
7920 | be a problem if the upgrade is e.g. because of a security fix). | |
7921 | Defaults to @samp{#t}. | |
7922 | @end deftypevr | |
7923 | ||
7924 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count | |
7925 | If non-zero, run mail commands via this many connections to doveadm | |
7926 | server, instead of running them directly in the same process. | |
7927 | Defaults to @samp{0}. | |
7928 | @end deftypevr | |
7929 | ||
7930 | @deftypevr {@code{dovecot-configuration} parameter} string doveadm-socket-path | |
7931 | UNIX socket or host:port used for connecting to doveadm server. | |
7932 | Defaults to @samp{"doveadm-server"}. | |
7933 | @end deftypevr | |
7934 | ||
7935 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list import-environment | |
7936 | List of environment variables that are preserved on Dovecot startup | |
7937 | and passed down to all of its child processes. You can also give | |
7938 | key=value pairs to always set specific settings. | |
7939 | @end deftypevr | |
7940 | ||
7941 | @deftypevr {@code{dovecot-configuration} parameter} boolean disable-plaintext-auth? | |
7942 | Disable LOGIN command and all other plaintext authentications unless | |
7943 | SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP | |
7944 | matches the local IP (i.e. you're connecting from the same computer), | |
7945 | the connection is considered secure and plaintext authentication is | |
7946 | allowed. See also ssl=required setting. | |
7947 | Defaults to @samp{#t}. | |
7948 | @end deftypevr | |
7949 | ||
7950 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size | |
7951 | Authentication cache size (e.g. @samp{#e10e6}). 0 means it's disabled. | |
7952 | Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set | |
7953 | for caching to be used. | |
7954 | Defaults to @samp{0}. | |
7955 | @end deftypevr | |
7956 | ||
7957 | @deftypevr {@code{dovecot-configuration} parameter} string auth-cache-ttl | |
7958 | Time to live for cached data. After TTL expires the cached record | |
7959 | is no longer used, *except* if the main database lookup returns internal | |
7960 | failure. We also try to handle password changes automatically: If | |
7961 | user's previous authentication was successful, but this one wasn't, the | |
7962 | cache isn't used. For now this works only with plaintext | |
7963 | authentication. | |
7964 | Defaults to @samp{"1 hour"}. | |
7965 | @end deftypevr | |
7966 | ||
7967 | @deftypevr {@code{dovecot-configuration} parameter} string auth-cache-negative-ttl | |
7968 | TTL for negative hits (user not found, password mismatch). | |
7969 | 0 disables caching them completely. | |
7970 | Defaults to @samp{"1 hour"}. | |
7971 | @end deftypevr | |
7972 | ||
7973 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-realms | |
7974 | List of realms for SASL authentication mechanisms that need them. | |
7975 | You can leave it empty if you don't want to support multiple realms. | |
7976 | Many clients simply use the first one listed here, so keep the default | |
7977 | realm first. | |
7978 | Defaults to @samp{()}. | |
7979 | @end deftypevr | |
7980 | ||
7981 | @deftypevr {@code{dovecot-configuration} parameter} string auth-default-realm | |
7982 | Default realm/domain to use if none was specified. This is used for | |
7983 | both SASL realms and appending @@domain to username in plaintext | |
7984 | logins. | |
7985 | Defaults to @samp{""}. | |
7986 | @end deftypevr | |
7987 | ||
7988 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-chars | |
7989 | List of allowed characters in username. If the user-given username | |
7990 | contains a character not listed in here, the login automatically fails. | |
7991 | This is just an extra check to make sure user can't exploit any | |
7992 | potential quote escaping vulnerabilities with SQL/LDAP databases. If | |
7993 | you want to allow all characters, set this value to empty. | |
7994 | Defaults to @samp{"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@"}. | |
7995 | @end deftypevr | |
7996 | ||
7997 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-translation | |
7998 | Username character translations before it's looked up from | |
7999 | databases. The value contains series of from -> to characters. For | |
8000 | example @samp{#@@/@@} means that @samp{#} and @samp{/} characters are | |
8001 | translated to @samp{@@}. | |
8002 | Defaults to @samp{""}. | |
8003 | @end deftypevr | |
8004 | ||
8005 | @deftypevr {@code{dovecot-configuration} parameter} string auth-username-format | |
8006 | Username formatting before it's looked up from databases. You can | |
8007 | use the standard variables here, e.g. %Lu would lowercase the username, | |
8008 | %n would drop away the domain if it was given, or @samp{%n-AT-%d} would | |
8009 | change the @samp{@@} into @samp{-AT-}. This translation is done after | |
8010 | @samp{auth-username-translation} changes. | |
8011 | Defaults to @samp{"%Lu"}. | |
8012 | @end deftypevr | |
8013 | ||
8014 | @deftypevr {@code{dovecot-configuration} parameter} string auth-master-user-separator | |
8015 | If you want to allow master users to log in by specifying the master | |
8016 | username within the normal username string (i.e. not using SASL | |
8017 | mechanism's support for it), you can specify the separator character | |
8018 | here. The format is then <username><separator><master username>. | |
8019 | UW-IMAP uses @samp{*} as the separator, so that could be a good | |
8020 | choice. | |
8021 | Defaults to @samp{""}. | |
8022 | @end deftypevr | |
8023 | ||
8024 | @deftypevr {@code{dovecot-configuration} parameter} string auth-anonymous-username | |
8025 | Username to use for users logging in with ANONYMOUS SASL | |
8026 | mechanism. | |
8027 | Defaults to @samp{"anonymous"}. | |
8028 | @end deftypevr | |
8029 | ||
8030 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count | |
8031 | Maximum number of dovecot-auth worker processes. They're used to | |
8032 | execute blocking passdb and userdb queries (e.g. MySQL and PAM). | |
8033 | They're automatically created and destroyed as needed. | |
8034 | Defaults to @samp{30}. | |
8035 | @end deftypevr | |
8036 | ||
8037 | @deftypevr {@code{dovecot-configuration} parameter} string auth-gssapi-hostname | |
8038 | Host name to use in GSSAPI principal names. The default is to use | |
8039 | the name returned by gethostname(). Use @samp{$ALL} (with quotes) to | |
8040 | allow all keytab entries. | |
8041 | Defaults to @samp{""}. | |
8042 | @end deftypevr | |
8043 | ||
8044 | @deftypevr {@code{dovecot-configuration} parameter} string auth-krb5-keytab | |
8045 | Kerberos keytab to use for the GSSAPI mechanism. Will use the | |
8046 | system default (usually /etc/krb5.keytab) if not specified. You may | |
8047 | need to change the auth service to run as root to be able to read this | |
8048 | file. | |
8049 | Defaults to @samp{""}. | |
8050 | @end deftypevr | |
8051 | ||
8052 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-use-winbind? | |
8053 | Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon | |
8054 | and @samp{ntlm-auth} helper. | |
8055 | <doc/wiki/Authentication/Mechanisms/Winbind.txt>. | |
8056 | Defaults to @samp{#f}. | |
8057 | @end deftypevr | |
8058 | ||
8059 | @deftypevr {@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path | |
8060 | Path for Samba's @samp{ntlm-auth} helper binary. | |
8061 | Defaults to @samp{"/usr/bin/ntlm_auth"}. | |
8062 | @end deftypevr | |
8063 | ||
8064 | @deftypevr {@code{dovecot-configuration} parameter} string auth-failure-delay | |
8065 | Time to delay before replying to failed authentications. | |
8066 | Defaults to @samp{"2 secs"}. | |
8067 | @end deftypevr | |
8068 | ||
8069 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert? | |
8070 | Require a valid SSL client certificate or the authentication | |
8071 | fails. | |
8072 | Defaults to @samp{#f}. | |
8073 | @end deftypevr | |
8074 | ||
8075 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert? | |
8076 | Take the username from client's SSL certificate, using | |
8077 | @code{X509_NAME_get_text_by_NID()} which returns the subject's DN's | |
8078 | CommonName. | |
8079 | Defaults to @samp{#f}. | |
8080 | @end deftypevr | |
8081 | ||
8082 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms | |
8083 | List of wanted authentication mechanisms. Supported mechanisms are: | |
8084 | @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, | |
8085 | @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, | |
8086 | @samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also | |
8087 | @samp{disable-plaintext-auth} setting. | |
8088 | @end deftypevr | |
8089 | ||
8090 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-servers | |
8091 | List of IPs or hostnames to all director servers, including ourself. | |
8092 | Ports can be specified as ip:port. The default port is the same as what | |
8093 | director service's @samp{inet-listener} is using. | |
8094 | Defaults to @samp{()}. | |
8095 | @end deftypevr | |
8096 | ||
8097 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers | |
8098 | List of IPs or hostnames to all backend mail servers. Ranges are | |
8099 | allowed too, like 10.0.0.10-10.0.0.30. | |
8100 | Defaults to @samp{()}. | |
8101 | @end deftypevr | |
8102 | ||
8103 | @deftypevr {@code{dovecot-configuration} parameter} string director-user-expire | |
8104 | How long to redirect users to a specific server after it no longer | |
8105 | has any connections. | |
8106 | Defaults to @samp{"15 min"}. | |
8107 | @end deftypevr | |
8108 | ||
8109 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer director-doveadm-port | |
8110 | TCP/IP port that accepts doveadm connections (instead of director | |
8111 | connections) If you enable this, you'll also need to add | |
8112 | @samp{inet-listener} for the port. | |
8113 | Defaults to @samp{0}. | |
8114 | @end deftypevr | |
8115 | ||
8116 | @deftypevr {@code{dovecot-configuration} parameter} string director-username-hash | |
8117 | How the username is translated before being hashed. Useful values | |
8118 | include %Ln if user can log in with or without @@domain, %Ld if mailboxes | |
8119 | are shared within domain. | |
8120 | Defaults to @samp{"%Lu"}. | |
8121 | @end deftypevr | |
8122 | ||
8123 | @deftypevr {@code{dovecot-configuration} parameter} string log-path | |
8124 | Log file to use for error messages. @samp{syslog} logs to syslog, | |
8125 | @samp{/dev/stderr} logs to stderr. | |
8126 | Defaults to @samp{"syslog"}. | |
8127 | @end deftypevr | |
8128 | ||
8129 | @deftypevr {@code{dovecot-configuration} parameter} string info-log-path | |
8130 | Log file to use for informational messages. Defaults to | |
8131 | @samp{log-path}. | |
8132 | Defaults to @samp{""}. | |
8133 | @end deftypevr | |
8134 | ||
8135 | @deftypevr {@code{dovecot-configuration} parameter} string debug-log-path | |
8136 | Log file to use for debug messages. Defaults to | |
8137 | @samp{info-log-path}. | |
8138 | Defaults to @samp{""}. | |
8139 | @end deftypevr | |
8140 | ||
8141 | @deftypevr {@code{dovecot-configuration} parameter} string syslog-facility | |
8142 | Syslog facility to use if you're logging to syslog. Usually if you | |
8143 | don't want to use @samp{mail}, you'll use local0..local7. Also other | |
8144 | standard facilities are supported. | |
8145 | Defaults to @samp{"mail"}. | |
8146 | @end deftypevr | |
8147 | ||
8148 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose? | |
8149 | Log unsuccessful authentication attempts and the reasons why they | |
8150 | failed. | |
8151 | Defaults to @samp{#f}. | |
8152 | @end deftypevr | |
8153 | ||
8154 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose-passwords? | |
8155 | In case of password mismatches, log the attempted password. Valid | |
8156 | values are no, plain and sha1. sha1 can be useful for detecting brute | |
8157 | force password attempts vs. user simply trying the same password over | |
8158 | and over again. You can also truncate the value to n chars by appending | |
8159 | ":n" (e.g. sha1:6). | |
8160 | Defaults to @samp{#f}. | |
8161 | @end deftypevr | |
8162 | ||
8163 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug? | |
8164 | Even more verbose logging for debugging purposes. Shows for example | |
8165 | SQL queries. | |
8166 | Defaults to @samp{#f}. | |
8167 | @end deftypevr | |
8168 | ||
8169 | @deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug-passwords? | |
8170 | In case of password mismatches, log the passwords and used scheme so | |
8171 | the problem can be debugged. Enabling this also enables | |
8172 | @samp{auth-debug}. | |
8173 | Defaults to @samp{#f}. | |
8174 | @end deftypevr | |
8175 | ||
8176 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-debug? | |
8177 | Enable mail process debugging. This can help you figure out why | |
8178 | Dovecot isn't finding your mails. | |
8179 | Defaults to @samp{#f}. | |
8180 | @end deftypevr | |
8181 | ||
8182 | @deftypevr {@code{dovecot-configuration} parameter} boolean verbose-ssl? | |
8183 | Show protocol level SSL errors. | |
8184 | Defaults to @samp{#f}. | |
8185 | @end deftypevr | |
8186 | ||
8187 | @deftypevr {@code{dovecot-configuration} parameter} string log-timestamp | |
8188 | Prefix for each line written to log file. % codes are in | |
8189 | strftime(3) format. | |
8190 | Defaults to @samp{"\"%b %d %H:%M:%S \""}. | |
8191 | @end deftypevr | |
8192 | ||
8193 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements | |
8194 | List of elements we want to log. The elements which have a | |
8195 | non-empty variable value are joined together to form a comma-separated | |
8196 | string. | |
8197 | @end deftypevr | |
8198 | ||
8199 | @deftypevr {@code{dovecot-configuration} parameter} string login-log-format | |
8200 | Login log format. %s contains @samp{login-log-format-elements} | |
8201 | string, %$ contains the data we want to log. | |
8202 | Defaults to @samp{"%$: %s"}. | |
8203 | @end deftypevr | |
8204 | ||
8205 | @deftypevr {@code{dovecot-configuration} parameter} string mail-log-prefix | |
8206 | Log prefix for mail processes. See doc/wiki/Variables.txt for list | |
8207 | of possible variables you can use. | |
8208 | Defaults to @samp{"\"%s(%u): \""}. | |
8209 | @end deftypevr | |
8210 | ||
8211 | @deftypevr {@code{dovecot-configuration} parameter} string deliver-log-format | |
8212 | Format to use for logging mail deliveries. You can use variables: | |
8213 | @table @code | |
8214 | @item %$ | |
8215 | Delivery status message (e.g. @samp{saved to INBOX}) | |
8216 | @item %m | |
8217 | Message-ID | |
8218 | @item %s | |
8219 | Subject | |
8220 | @item %f | |
8221 | From address | |
8222 | @item %p | |
8223 | Physical size | |
8224 | @item %w | |
8225 | Virtual size. | |
8226 | @end table | |
8227 | Defaults to @samp{"msgid=%m: %$"}. | |
8228 | @end deftypevr | |
8229 | ||
8230 | @deftypevr {@code{dovecot-configuration} parameter} string mail-location | |
8231 | Location for users' mailboxes. The default is empty, which means | |
8232 | that Dovecot tries to find the mailboxes automatically. This won't work | |
8233 | if the user doesn't yet have any mail, so you should explicitly tell | |
8234 | Dovecot the full location. | |
8235 | ||
8236 | If you're using mbox, giving a path to the INBOX | |
8237 | file (e.g. /var/mail/%u) isn't enough. You'll also need to tell Dovecot | |
8238 | where the other mailboxes are kept. This is called the "root mail | |
8239 | directory", and it must be the first path given in the | |
8240 | @samp{mail-location} setting. | |
8241 | ||
8242 | There are a few special variables you can use, eg.: | |
8243 | ||
8244 | @table @samp | |
8245 | @item %u | |
8246 | username | |
8247 | @item %n | |
8248 | user part in user@@domain, same as %u if there's no domain | |
8249 | @item %d | |
8250 | domain part in user@@domain, empty if there's no domain | |
8251 | @item %h | |
8252 | home director | |
8253 | @end table | |
8254 | ||
8255 | See doc/wiki/Variables.txt for full list. Some examples: | |
8256 | @table @samp | |
8257 | @item maildir:~/Maildir | |
8258 | @item mbox:~/mail:INBOX=/var/mail/%u | |
8259 | @item mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/% | |
8260 | @end table | |
8261 | Defaults to @samp{""}. | |
8262 | @end deftypevr | |
8263 | ||
8264 | @deftypevr {@code{dovecot-configuration} parameter} string mail-uid | |
8265 | System user and group used to access mails. If you use multiple, | |
8266 | userdb can override these by returning uid or gid fields. You can use | |
8267 | either numbers or names. <doc/wiki/UserIds.txt>. | |
8268 | Defaults to @samp{""}. | |
8269 | @end deftypevr | |
8270 | ||
8271 | @deftypevr {@code{dovecot-configuration} parameter} string mail-gid | |
8272 | ||
8273 | Defaults to @samp{""}. | |
8274 | @end deftypevr | |
8275 | ||
8276 | @deftypevr {@code{dovecot-configuration} parameter} string mail-privileged-group | |
8277 | Group to enable temporarily for privileged operations. Currently | |
8278 | this is used only with INBOX when either its initial creation or | |
8279 | dotlocking fails. Typically this is set to "mail" to give access to | |
8280 | /var/mail. | |
8281 | Defaults to @samp{""}. | |
8282 | @end deftypevr | |
8283 | ||
8284 | @deftypevr {@code{dovecot-configuration} parameter} string mail-access-groups | |
8285 | Grant access to these supplementary groups for mail processes. | |
8286 | Typically these are used to set up access to shared mailboxes. Note | |
8287 | that it may be dangerous to set these if users can create | |
8288 | symlinks (e.g. if "mail" group is set here, ln -s /var/mail ~/mail/var | |
8289 | could allow a user to delete others' mailboxes, or ln -s | |
8290 | /secret/shared/box ~/mail/mybox would allow reading it). | |
8291 | Defaults to @samp{""}. | |
8292 | @end deftypevr | |
8293 | ||
8294 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access? | |
8295 | Allow full filesystem access to clients. There's no access checks | |
8296 | other than what the operating system does for the active UID/GID. It | |
8297 | works with both maildir and mboxes, allowing you to prefix mailboxes | |
8298 | names with e.g. /path/ or ~user/. | |
8299 | Defaults to @samp{#f}. | |
8300 | @end deftypevr | |
8301 | ||
8302 | @deftypevr {@code{dovecot-configuration} parameter} boolean mmap-disable? | |
8303 | Don't use mmap() at all. This is required if you store indexes to | |
8304 | shared filesystems (NFS or clustered filesystem). | |
8305 | Defaults to @samp{#f}. | |
8306 | @end deftypevr | |
8307 | ||
8308 | @deftypevr {@code{dovecot-configuration} parameter} boolean dotlock-use-excl? | |
8309 | Rely on @samp{O_EXCL} to work when creating dotlock files. NFS | |
8310 | supports @samp{O_EXCL} since version 3, so this should be safe to use | |
8311 | nowadays by default. | |
8312 | Defaults to @samp{#t}. | |
8313 | @end deftypevr | |
8314 | ||
8315 | @deftypevr {@code{dovecot-configuration} parameter} string mail-fsync | |
8316 | When to use fsync() or fdatasync() calls: | |
8317 | @table @code | |
8318 | @item optimized | |
8319 | Whenever necessary to avoid losing important data | |
8320 | @item always | |
8321 | Useful with e.g. NFS when write()s are delayed | |
8322 | @item never | |
8323 | Never use it (best performance, but crashes can lose data). | |
8324 | @end table | |
8325 | Defaults to @samp{"optimized"}. | |
8326 | @end deftypevr | |
8327 | ||
8328 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-storage? | |
8329 | Mail storage exists in NFS. Set this to yes to make Dovecot flush | |
8330 | NFS caches whenever needed. If you're using only a single mail server | |
8331 | this isn't needed. | |
8332 | Defaults to @samp{#f}. | |
8333 | @end deftypevr | |
8334 | ||
8335 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-index? | |
8336 | Mail index files also exist in NFS. Setting this to yes requires | |
8337 | @samp{mmap-disable? #t} and @samp{fsync-disable? #f}. | |
8338 | Defaults to @samp{#f}. | |
8339 | @end deftypevr | |
8340 | ||
8341 | @deftypevr {@code{dovecot-configuration} parameter} string lock-method | |
8342 | Locking method for index files. Alternatives are fcntl, flock and | |
8343 | dotlock. Dotlocking uses some tricks which may create more disk I/O | |
8344 | than other locking methods. NFS users: flock doesn't work, remember to | |
8345 | change @samp{mmap-disable}. | |
8346 | Defaults to @samp{"fcntl"}. | |
8347 | @end deftypevr | |
8348 | ||
8349 | @deftypevr {@code{dovecot-configuration} parameter} file-name mail-temp-dir | |
8350 | Directory in which LDA/LMTP temporarily stores incoming mails >128 | |
8351 | kB. | |
8352 | Defaults to @samp{"/tmp"}. | |
8353 | @end deftypevr | |
8354 | ||
8355 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid | |
8356 | Valid UID range for users. This is mostly to make sure that users can't | |
8357 | log in as daemons or other system users. Note that denying root logins is | |
8358 | hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} | |
8359 | is set to 0. | |
8360 | Defaults to @samp{500}. | |
8361 | @end deftypevr | |
8362 | ||
8363 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid | |
8364 | ||
8365 | Defaults to @samp{0}. | |
8366 | @end deftypevr | |
8367 | ||
8368 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid | |
8369 | Valid GID range for users. Users having non-valid GID as primary group ID | |
8370 | aren't allowed to log in. If user belongs to supplementary groups with | |
8371 | non-valid GIDs, those groups are not set. | |
8372 | Defaults to @samp{1}. | |
8373 | @end deftypevr | |
8374 | ||
8375 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid | |
8376 | ||
8377 | Defaults to @samp{0}. | |
8378 | @end deftypevr | |
8379 | ||
8380 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length | |
8381 | Maximum allowed length for mail keyword name. It's only forced when | |
8382 | trying to create new keywords. | |
8383 | Defaults to @samp{50}. | |
8384 | @end deftypevr | |
8385 | ||
8386 | @deftypevr {@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs | |
8387 | List of directories under which chrooting is allowed for mail | |
8388 | processes (i.e. /var/mail will allow chrooting to /var/mail/foo/bar | |
8389 | too). This setting doesn't affect @samp{login-chroot} | |
8390 | @samp{mail-chroot} or auth chroot settings. If this setting is empty, | |
8391 | "/./" in home dirs are ignored. WARNING: Never add directories here | |
8392 | which local users can modify, that may lead to root exploit. Usually | |
8393 | this should be done only if you don't allow shell access for users. | |
8394 | <doc/wiki/Chrooting.txt>. | |
8395 | Defaults to @samp{()}. | |
8396 | @end deftypevr | |
8397 | ||
8398 | @deftypevr {@code{dovecot-configuration} parameter} string mail-chroot | |
8399 | Default chroot directory for mail processes. This can be overridden | |
8400 | for specific users in user database by giving /./ in user's home | |
8401 | directory (e.g. /home/./user chroots into /home). Note that usually | |
8402 | there is no real need to do chrooting, Dovecot doesn't allow users to | |
8403 | access files outside their mail directory anyway. If your home | |
8404 | directories are prefixed with the chroot directory, append "/." to | |
8405 | @samp{mail-chroot}. <doc/wiki/Chrooting.txt>. | |
8406 | Defaults to @samp{""}. | |
8407 | @end deftypevr | |
8408 | ||
8409 | @deftypevr {@code{dovecot-configuration} parameter} file-name auth-socket-path | |
8410 | UNIX socket path to master authentication server to find users. | |
8411 | This is used by imap (for shared users) and lda. | |
8412 | Defaults to @samp{"/var/run/dovecot/auth-userdb"}. | |
8413 | @end deftypevr | |
8414 | ||
8415 | @deftypevr {@code{dovecot-configuration} parameter} file-name mail-plugin-dir | |
8416 | Directory where to look up mail plugins. | |
8417 | Defaults to @samp{"/usr/lib/dovecot"}. | |
8418 | @end deftypevr | |
8419 | ||
8420 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins | |
8421 | List of plugins to load for all services. Plugins specific to IMAP, | |
8422 | LDA, etc. are added to this list in their own .conf files. | |
8423 | Defaults to @samp{()}. | |
8424 | @end deftypevr | |
8425 | ||
8426 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count | |
8427 | The minimum number of mails in a mailbox before updates are done to | |
8428 | cache file. This allows optimizing Dovecot's behavior to do less disk | |
8429 | writes at the cost of more disk reads. | |
8430 | Defaults to @samp{0}. | |
8431 | @end deftypevr | |
8432 | ||
8433 | @deftypevr {@code{dovecot-configuration} parameter} string mailbox-idle-check-interval | |
8434 | When IDLE command is running, mailbox is checked once in a while to | |
8435 | see if there are any new mails or other changes. This setting defines | |
8436 | the minimum time to wait between those checks. Dovecot can also use | |
8437 | dnotify, inotify and kqueue to find out immediately when changes | |
8438 | occur. | |
8439 | Defaults to @samp{"30 secs"}. | |
8440 | @end deftypevr | |
8441 | ||
8442 | @deftypevr {@code{dovecot-configuration} parameter} boolean mail-save-crlf? | |
8443 | Save mails with CR+LF instead of plain LF. This makes sending those | |
8444 | mails take less CPU, especially with sendfile() syscall with Linux and | |
8445 | FreeBSD. But it also creates a bit more disk I/O which may just make it | |
8446 | slower. Also note that if other software reads the mboxes/maildirs, | |
8447 | they may handle the extra CRs wrong and cause problems. | |
8448 | Defaults to @samp{#f}. | |
8449 | @end deftypevr | |
8450 | ||
8451 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-stat-dirs? | |
8452 | By default LIST command returns all entries in maildir beginning | |
8453 | with a dot. Enabling this option makes Dovecot return only entries | |
8454 | which are directories. This is done by stat()ing each entry, so it | |
8455 | causes more disk I/O. | |
8456 | (For systems setting struct @samp{dirent->d_type} this check is free | |
8457 | and it's done always regardless of this setting). | |
8458 | Defaults to @samp{#f}. | |
8459 | @end deftypevr | |
8460 | ||
8461 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks? | |
8462 | When copying a message, do it with hard links whenever possible. | |
8463 | This makes the performance much better, and it's unlikely to have any | |
8464 | side effects. | |
8465 | Defaults to @samp{#t}. | |
8466 | @end deftypevr | |
8467 | ||
8468 | @deftypevr {@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs? | |
8469 | Assume Dovecot is the only MUA accessing Maildir: Scan cur/ | |
8470 | directory only when its mtime changes unexpectedly or when we can't find | |
8471 | the mail otherwise. | |
8472 | Defaults to @samp{#f}. | |
8473 | @end deftypevr | |
8474 | ||
8475 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks | |
8476 | Which locking methods to use for locking mbox. There are four | |
8477 | available: | |
8478 | ||
8479 | @table @code | |
8480 | @item dotlock | |
8481 | Create <mailbox>.lock file. This is the oldest and most NFS-safe | |
8482 | solution. If you want to use /var/mail/ like directory, the users will | |
8483 | need write access to that directory. | |
8484 | @item dotlock-try | |
8485 | Same as dotlock, but if it fails because of permissions or because there | |
8486 | isn't enough disk space, just skip it. | |
8487 | @item fcntl | |
8488 | Use this if possible. Works with NFS too if lockd is used. | |
8489 | @item flock | |
8490 | May not exist in all systems. Doesn't work with NFS. | |
8491 | @item lockf | |
8492 | May not exist in all systems. Doesn't work with NFS. | |
8493 | @end table | |
8494 | ||
8495 | You can use multiple locking methods; if you do the order they're declared | |
8496 | in is important to avoid deadlocks if other MTAs/MUAs are using multiple | |
8497 | locking methods as well. Some operating systems don't allow using some of | |
8498 | them simultaneously. | |
8499 | @end deftypevr | |
8500 | ||
8501 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks | |
8502 | ||
8503 | @end deftypevr | |
8504 | ||
8505 | @deftypevr {@code{dovecot-configuration} parameter} string mbox-lock-timeout | |
8506 | Maximum time to wait for lock (all of them) before aborting. | |
8507 | Defaults to @samp{"5 mins"}. | |
8508 | @end deftypevr | |
8509 | ||
8510 | @deftypevr {@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout | |
8511 | If dotlock exists but the mailbox isn't modified in any way, | |
8512 | override the lock file after this much time. | |
8513 | Defaults to @samp{"2 mins"}. | |
8514 | @end deftypevr | |
8515 | ||
8516 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs? | |
8517 | When mbox changes unexpectedly we have to fully read it to find out | |
8518 | what changed. If the mbox is large this can take a long time. Since | |
8519 | the change is usually just a newly appended mail, it'd be faster to | |
8520 | simply read the new mails. If this setting is enabled, Dovecot does | |
8521 | this but still safely fallbacks to re-reading the whole mbox file | |
8522 | whenever something in mbox isn't how it's expected to be. The only real | |
8523 | downside to this setting is that if some other MUA changes message | |
8524 | flags, Dovecot doesn't notice it immediately. Note that a full sync is | |
8525 | done with SELECT, EXAMINE, EXPUNGE and CHECK commands. | |
8526 | Defaults to @samp{#t}. | |
8527 | @end deftypevr | |
8528 | ||
8529 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs? | |
8530 | Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, | |
8531 | EXAMINE, EXPUNGE or CHECK commands. If this is set, | |
8532 | @samp{mbox-dirty-syncs} is ignored. | |
8533 | Defaults to @samp{#f}. | |
8534 | @end deftypevr | |
8535 | ||
8536 | @deftypevr {@code{dovecot-configuration} parameter} boolean mbox-lazy-writes? | |
8537 | Delay writing mbox headers until doing a full write sync (EXPUNGE | |
8538 | and CHECK commands and when closing the mailbox). This is especially | |
8539 | useful for POP3 where clients often delete all mails. The downside is | |
8540 | that our changes aren't immediately visible to other MUAs. | |
8541 | Defaults to @samp{#t}. | |
8542 | @end deftypevr | |
8543 | ||
8544 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size | |
8545 | If mbox size is smaller than this (e.g. 100k), don't write index | |
8546 | files. If an index file already exists it's still read, just not | |
8547 | updated. | |
8548 | Defaults to @samp{0}. | |
8549 | @end deftypevr | |
8550 | ||
8551 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size | |
8552 | Maximum dbox file size until it's rotated. | |
8553 | Defaults to @samp{2000000}. | |
8554 | @end deftypevr | |
8555 | ||
8556 | @deftypevr {@code{dovecot-configuration} parameter} string mdbox-rotate-interval | |
8557 | Maximum dbox file age until it's rotated. Typically in days. Day | |
8558 | begins from midnight, so 1d = today, 2d = yesterday, etc. 0 = check | |
8559 | disabled. | |
8560 | Defaults to @samp{"1d"}. | |
8561 | @end deftypevr | |
8562 | ||
8563 | @deftypevr {@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space? | |
8564 | When creating new mdbox files, immediately preallocate their size to | |
8565 | @samp{mdbox-rotate-size}. This setting currently works only in Linux | |
8566 | with some filesystems (ext4, xfs). | |
8567 | Defaults to @samp{#f}. | |
8568 | @end deftypevr | |
8569 | ||
8570 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-dir | |
8571 | sdbox and mdbox support saving mail attachments to external files, | |
8572 | which also allows single instance storage for them. Other backends | |
8573 | don't support this for now. | |
8574 | ||
8575 | WARNING: This feature hasn't been tested much yet. Use at your own risk. | |
8576 | ||
8577 | Directory root where to store mail attachments. Disabled, if empty. | |
8578 | Defaults to @samp{""}. | |
8579 | @end deftypevr | |
8580 | ||
8581 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size | |
8582 | Attachments smaller than this aren't saved externally. It's also | |
8583 | possible to write a plugin to disable saving specific attachments | |
8584 | externally. | |
8585 | Defaults to @samp{128000}. | |
8586 | @end deftypevr | |
8587 | ||
8588 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-fs | |
8589 | Filesystem backend to use for saving attachments: | |
8590 | @table @code | |
8591 | @item posix | |
8592 | No SiS done by Dovecot (but this might help FS's own deduplication) | |
8593 | @item sis posix | |
8594 | SiS with immediate byte-by-byte comparison during saving | |
8595 | @item sis-queue posix | |
8596 | SiS with delayed comparison and deduplication. | |
8597 | @end table | |
8598 | Defaults to @samp{"sis posix"}. | |
8599 | @end deftypevr | |
8600 | ||
8601 | @deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-hash | |
8602 | Hash format to use in attachment filenames. You can add any text and | |
8603 | variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, | |
8604 | @code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be | |
8605 | truncated, e.g. @code{%@{sha256:80@}} returns only first 80 bits. | |
8606 | Defaults to @samp{"%@{sha1@}"}. | |
8607 | @end deftypevr | |
8608 | ||
8609 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-process-limit | |
8610 | ||
8611 | Defaults to @samp{100}. | |
8612 | @end deftypevr | |
8613 | ||
8614 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-client-limit | |
8615 | ||
8616 | Defaults to @samp{1000}. | |
8617 | @end deftypevr | |
8618 | ||
8619 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit | |
8620 | Default VSZ (virtual memory size) limit for service processes. | |
8621 | This is mainly intended to catch and kill processes that leak memory | |
8622 | before they eat up everything. | |
8623 | Defaults to @samp{256000000}. | |
8624 | @end deftypevr | |
8625 | ||
8626 | @deftypevr {@code{dovecot-configuration} parameter} string default-login-user | |
8627 | Login user is internally used by login processes. This is the most | |
8628 | untrusted user in Dovecot system. It shouldn't have access to anything | |
8629 | at all. | |
8630 | Defaults to @samp{"dovenull"}. | |
8631 | @end deftypevr | |
8632 | ||
8633 | @deftypevr {@code{dovecot-configuration} parameter} string default-internal-user | |
8634 | Internal user is used by unprivileged processes. It should be | |
8635 | separate from login user, so that login processes can't disturb other | |
8636 | processes. | |
8637 | Defaults to @samp{"dovecot"}. | |
8638 | @end deftypevr | |
8639 | ||
8640 | @deftypevr {@code{dovecot-configuration} parameter} string ssl? | |
8641 | SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. | |
8642 | Defaults to @samp{"required"}. | |
8643 | @end deftypevr | |
8644 | ||
8645 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cert | |
8646 | PEM encoded X.509 SSL/TLS certificate (public key). | |
8647 | Defaults to @samp{"</etc/dovecot/default.pem"}. | |
8648 | @end deftypevr | |
8649 | ||
8650 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-key | |
8651 | PEM encoded SSL/TLS private key. The key is opened before | |
8652 | dropping root privileges, so keep the key file unreadable by anyone but | |
8653 | root. | |
8654 | Defaults to @samp{"</etc/dovecot/private/default.pem"}. | |
8655 | @end deftypevr | |
8656 | ||
8657 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-key-password | |
8658 | If key file is password protected, give the password here. | |
8659 | Alternatively give it when starting dovecot with -p parameter. Since | |
8660 | this file is often world-readable, you may want to place this setting | |
8661 | instead to a different. | |
8662 | Defaults to @samp{""}. | |
8663 | @end deftypevr | |
8664 | ||
8665 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-ca | |
8666 | PEM encoded trusted certificate authority. Set this only if you | |
8667 | intend to use @samp{ssl-verify-client-cert? #t}. The file should | |
8668 | contain the CA certificate(s) followed by the matching | |
8669 | CRL(s). (e.g. @samp{ssl-ca </etc/ssl/certs/ca.pem}). | |
8670 | Defaults to @samp{""}. | |
8671 | @end deftypevr | |
8672 | ||
8673 | @deftypevr {@code{dovecot-configuration} parameter} boolean ssl-require-crl? | |
8674 | Require that CRL check succeeds for client certificates. | |
8675 | Defaults to @samp{#t}. | |
8676 | @end deftypevr | |
8677 | ||
8678 | @deftypevr {@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert? | |
8679 | Request client to send a certificate. If you also want to require | |
8680 | it, set @samp{auth-ssl-require-client-cert? #t} in auth section. | |
8681 | Defaults to @samp{#f}. | |
8682 | @end deftypevr | |
8683 | ||
8684 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cert-username-field | |
8685 | Which field from certificate to use for username. commonName and | |
8686 | x500UniqueIdentifier are the usual choices. You'll also need to set | |
8687 | @samp{auth-ssl-username-from-cert? #t}. | |
8688 | Defaults to @samp{"commonName"}. | |
8689 | @end deftypevr | |
8690 | ||
8691 | @deftypevr {@code{dovecot-configuration} parameter} hours ssl-parameters-regenerate | |
8692 | How often to regenerate the SSL parameters file. Generation is | |
8693 | quite CPU intensive operation. The value is in hours, 0 disables | |
8694 | regeneration entirely. | |
8695 | Defaults to @samp{168}. | |
8696 | @end deftypevr | |
8697 | ||
8698 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-protocols | |
8699 | SSL protocols to use. | |
8700 | Defaults to @samp{"!SSLv2"}. | |
8701 | @end deftypevr | |
8702 | ||
8703 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-cipher-list | |
8704 | SSL ciphers to use. | |
8705 | Defaults to @samp{"ALL:!LOW:!SSLv2:!EXP:!aNULL"}. | |
8706 | @end deftypevr | |
8707 | ||
8708 | @deftypevr {@code{dovecot-configuration} parameter} string ssl-crypto-device | |
8709 | SSL crypto device to use, for valid values run "openssl engine". | |
8710 | Defaults to @samp{""}. | |
8711 | @end deftypevr | |
8712 | ||
8713 | @deftypevr {@code{dovecot-configuration} parameter} string postmaster-address | |
8714 | Address to use when sending rejection mails. | |
8715 | Default is postmaster@@<your domain>. %d expands to recipient domain. | |
8716 | Defaults to @samp{""}. | |
8717 | @end deftypevr | |
8718 | ||
8719 | @deftypevr {@code{dovecot-configuration} parameter} string hostname | |
8720 | Hostname to use in various parts of sent mails (e.g. in Message-Id) | |
8721 | and in LMTP replies. Default is the system's real hostname@@domain. | |
8722 | Defaults to @samp{""}. | |
8723 | @end deftypevr | |
8724 | ||
8725 | @deftypevr {@code{dovecot-configuration} parameter} boolean quota-full-tempfail? | |
8726 | If user is over quota, return with temporary failure instead of | |
8727 | bouncing the mail. | |
8728 | Defaults to @samp{#f}. | |
8729 | @end deftypevr | |
8730 | ||
8731 | @deftypevr {@code{dovecot-configuration} parameter} file-name sendmail-path | |
8732 | Binary to use for sending mails. | |
8733 | Defaults to @samp{"/usr/sbin/sendmail"}. | |
8734 | @end deftypevr | |
8735 | ||
8736 | @deftypevr {@code{dovecot-configuration} parameter} string submission-host | |
8737 | If non-empty, send mails via this SMTP host[:port] instead of | |
8738 | sendmail. | |
8739 | Defaults to @samp{""}. | |
8740 | @end deftypevr | |
8741 | ||
8742 | @deftypevr {@code{dovecot-configuration} parameter} string rejection-subject | |
8743 | Subject: header to use for rejection mails. You can use the same | |
8744 | variables as for @samp{rejection-reason} below. | |
8745 | Defaults to @samp{"Rejected: %s"}. | |
8746 | @end deftypevr | |
8747 | ||
8748 | @deftypevr {@code{dovecot-configuration} parameter} string rejection-reason | |
8749 | Human readable error message for rejection mails. You can use | |
8750 | variables: | |
8751 | ||
8752 | @table @code | |
8753 | @item %n | |
8754 | CRLF | |
8755 | @item %r | |
8756 | reason | |
8757 | @item %s | |
8758 | original subject | |
8759 | @item %t | |
8760 | recipient | |
8761 | @end table | |
8762 | Defaults to @samp{"Your message to <%t> was automatically rejected:%n%r"}. | |
8763 | @end deftypevr | |
8764 | ||
8765 | @deftypevr {@code{dovecot-configuration} parameter} string recipient-delimiter | |
8766 | Delimiter character between local-part and detail in email | |
8767 | address. | |
8768 | Defaults to @samp{"+"}. | |
8769 | @end deftypevr | |
8770 | ||
8771 | @deftypevr {@code{dovecot-configuration} parameter} string lda-original-recipient-header | |
8772 | Header where the original recipient address (SMTP's RCPT TO: | |
8773 | address) is taken from if not available elsewhere. With dovecot-lda -a | |
8774 | parameter overrides this. A commonly used header for this is | |
8775 | X-Original-To. | |
8776 | Defaults to @samp{""}. | |
8777 | @end deftypevr | |
8778 | ||
8779 | @deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate? | |
8780 | Should saving a mail to a nonexistent mailbox automatically create | |
8781 | it?. | |
8782 | Defaults to @samp{#f}. | |
8783 | @end deftypevr | |
8784 | ||
8785 | @deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe? | |
8786 | Should automatically created mailboxes be also automatically | |
8787 | subscribed?. | |
8788 | Defaults to @samp{#f}. | |
8789 | @end deftypevr | |
8790 | ||
8791 | @deftypevr {@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length | |
8792 | Maximum IMAP command line length. Some clients generate very long | |
8793 | command lines with huge mailboxes, so you may need to raise this if you | |
8794 | get "Too long argument" or "IMAP command line too large" errors | |
8795 | often. | |
8796 | Defaults to @samp{64000}. | |
8797 | @end deftypevr | |
8798 | ||
8799 | @deftypevr {@code{dovecot-configuration} parameter} string imap-logout-format | |
8800 | IMAP logout format string: | |
8801 | @table @code | |
8802 | @item %i | |
8803 | total number of bytes read from client | |
8804 | @item %o | |
8805 | total number of bytes sent to client. | |
8806 | @end table | |
8807 | Defaults to @samp{"in=%i out=%o"}. | |
8808 | @end deftypevr | |
8809 | ||
8810 | @deftypevr {@code{dovecot-configuration} parameter} string imap-capability | |
8811 | Override the IMAP CAPABILITY response. If the value begins with '+', | |
8812 | add the given capabilities on top of the defaults (e.g. +XFOO XBAR). | |
8813 | Defaults to @samp{""}. | |
8814 | @end deftypevr | |
8815 | ||
8816 | @deftypevr {@code{dovecot-configuration} parameter} string imap-idle-notify-interval | |
8817 | How long to wait between "OK Still here" notifications when client | |
8818 | is IDLEing. | |
8819 | Defaults to @samp{"2 mins"}. | |
8820 | @end deftypevr | |
8821 | ||
8822 | @deftypevr {@code{dovecot-configuration} parameter} string imap-id-send | |
8823 | ID field names and values to send to clients. Using * as the value | |
8824 | makes Dovecot use the default value. The following fields have default | |
8825 | values currently: name, version, os, os-version, support-url, | |
8826 | support-email. | |
8827 | Defaults to @samp{""}. | |
8828 | @end deftypevr | |
8829 | ||
8830 | @deftypevr {@code{dovecot-configuration} parameter} string imap-id-log | |
8831 | ID fields sent by client to log. * means everything. | |
8832 | Defaults to @samp{""}. | |
8833 | @end deftypevr | |
8834 | ||
8835 | @deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds | |
8836 | Workarounds for various client bugs: | |
8837 | ||
8838 | @table @code | |
8839 | @item delay-newmail | |
8840 | Send EXISTS/RECENT new mail notifications only when replying to NOOP and | |
8841 | CHECK commands. Some clients ignore them otherwise, for example OSX | |
8842 | Mail (<v2.1). Outlook Express breaks more badly though, without this it | |
8843 | may show user "Message no longer in server" errors. Note that OE6 | |
8844 | still breaks even with this workaround if synchronization is set to | |
8845 | "Headers Only". | |
8846 | ||
8847 | @item tb-extra-mailbox-sep | |
8848 | Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and | |
8849 | adds extra @samp{/} suffixes to mailbox names. This option causes Dovecot to | |
8850 | ignore the extra @samp{/} instead of treating it as invalid mailbox name. | |
8851 | ||
8852 | @item tb-lsub-flags | |
8853 | Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox). | |
8854 | This makes Thunderbird realize they aren't selectable and show them | |
8855 | greyed out, instead of only later giving "not selectable" popup error. | |
8856 | @end table | |
8857 | Defaults to @samp{()}. | |
8858 | @end deftypevr | |
8859 | ||
8860 | @deftypevr {@code{dovecot-configuration} parameter} string imap-urlauth-host | |
8861 | Host allowed in URLAUTH URLs sent by client. "*" allows all. | |
8862 | Defaults to @samp{""}. | |
8863 | @end deftypevr | |
8864 | ||
8865 | ||
8866 | Whew! Lots of configuration options. The nice thing about it though is | |
8867 | that GuixSD has a complete interface to Dovecot's configuration | |
8868 | language. This allows not only a nice way to declare configurations, | |
8869 | but also offers reflective capabilities as well: users can write code to | |
8870 | inspect and transform configurations from within Scheme. | |
8871 | ||
8872 | However, it could be that you just want to get a @code{dovecot.conf} up | |
8873 | and running. In that case, you can pass an | |
8874 | @code{opaque-dovecot-configuration} as the @code{#:config} paramter to | |
8875 | @code{dovecot-service}. As its name indicates, an opaque configuration | |
8876 | does not have easy reflective capabilities. | |
8877 | ||
8878 | Available @code{opaque-dovecot-configuration} fields are: | |
8879 | ||
8880 | @deftypevr {@code{opaque-dovecot-configuration} parameter} package dovecot | |
8881 | The dovecot package. | |
8882 | @end deftypevr | |
8883 | ||
8884 | @deftypevr {@code{opaque-dovecot-configuration} parameter} string string | |
8885 | The contents of the @code{dovecot.conf}, as a string. | |
8886 | @end deftypevr | |
8887 | ||
8888 | For example, if your @code{dovecot.conf} is just the empty string, you | |
8889 | could instantiate a dovecot service like this: | |
8890 | ||
8891 | @example | |
8892 | (dovecot-service #:config | |
8893 | (opaque-dovecot-configuration | |
8894 | (string ""))) | |
8895 | @end example | |
8896 | ||
58724c48 DT |
8897 | @node Web Services |
8898 | @subsubsection Web Services | |
8899 | ||
8900 | The @code{(gnu services web)} module provides the following service: | |
8901 | ||
be1c2c54 | 8902 | @deffn {Scheme Procedure} nginx-service [#:nginx nginx] @ |
58724c48 DT |
8903 | [#:log-directory ``/var/log/nginx''] @ |
8904 | [#:run-directory ``/var/run/nginx''] @ | |
8905 | [#:config-file] | |
8906 | ||
8907 | Return a service that runs @var{nginx}, the nginx web server. | |
8908 | ||
8909 | The nginx daemon loads its runtime configuration from @var{config-file}. | |
8910 | Log files are written to @var{log-directory} and temporary runtime data | |
8911 | files are written to @var{run-directory}. For proper operation, these | |
8912 | arguments should match what is in @var{config-file} to ensure that the | |
8913 | directories are created when the service is activated. | |
8914 | ||
8915 | @end deffn | |
8916 | ||
fe1a39d3 LC |
8917 | @node Various Services |
8918 | @subsubsection Various Services | |
8919 | ||
8920 | The @code{(gnu services lirc)} module provides the following service. | |
8921 | ||
be1c2c54 | 8922 | @deffn {Scheme Procedure} lirc-service [#:lirc lirc] @ |
fe1a39d3 LC |
8923 | [#:device #f] [#:driver #f] [#:config-file #f] @ |
8924 | [#:extra-options '()] | |
8925 | Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that | |
8926 | decodes infrared signals from remote controls. | |
8927 | ||
8928 | Optionally, @var{device}, @var{driver} and @var{config-file} | |
8929 | (configuration file name) may be specified. See @command{lircd} manual | |
8930 | for details. | |
8931 | ||
8932 | Finally, @var{extra-options} is a list of additional command-line options | |
8933 | passed to @command{lircd}. | |
8934 | @end deffn | |
8935 | ||
8936 | ||
0ae8c15a LC |
8937 | @node Setuid Programs |
8938 | @subsection Setuid Programs | |
8939 | ||
8940 | @cindex setuid programs | |
8941 | Some programs need to run with ``root'' privileges, even when they are | |
8942 | launched by unprivileged users. A notorious example is the | |
4d40227c LC |
8943 | @command{passwd} program, which users can run to change their |
8944 | password, and which needs to access the @file{/etc/passwd} and | |
0ae8c15a LC |
8945 | @file{/etc/shadow} files---something normally restricted to root, for |
8946 | obvious security reasons. To address that, these executables are | |
8947 | @dfn{setuid-root}, meaning that they always run with root privileges | |
8948 | (@pxref{How Change Persona,,, libc, The GNU C Library Reference Manual}, | |
f7e4ae7f | 8949 | for more info about the setuid mechanism.) |
0ae8c15a LC |
8950 | |
8951 | The store itself @emph{cannot} contain setuid programs: that would be a | |
8952 | security issue since any user on the system can write derivations that | |
8953 | populate the store (@pxref{The Store}). Thus, a different mechanism is | |
8954 | used: instead of changing the setuid bit directly on files that are in | |
8955 | the store, we let the system administrator @emph{declare} which programs | |
8956 | should be setuid root. | |
8957 | ||
8958 | The @code{setuid-programs} field of an @code{operating-system} | |
8959 | declaration contains a list of G-expressions denoting the names of | |
8960 | programs to be setuid-root (@pxref{Using the Configuration System}). | |
8961 | For instance, the @command{passwd} program, which is part of the Shadow | |
8962 | package, can be designated by this G-expression (@pxref{G-Expressions}): | |
8963 | ||
8964 | @example | |
8965 | #~(string-append #$shadow "/bin/passwd") | |
8966 | @end example | |
8967 | ||
8968 | A default set of setuid programs is defined by the | |
8969 | @code{%setuid-programs} variable of the @code{(gnu system)} module. | |
8970 | ||
8971 | @defvr {Scheme Variable} %setuid-programs | |
8972 | A list of G-expressions denoting common programs that are setuid-root. | |
8973 | ||
8974 | The list includes commands such as @command{passwd}, @command{ping}, | |
8975 | @command{su}, and @command{sudo}. | |
8976 | @end defvr | |
8977 | ||
8978 | Under the hood, the actual setuid programs are created in the | |
8979 | @file{/run/setuid-programs} directory at system activation time. The | |
8980 | files in this directory refer to the ``real'' binaries, which are in the | |
8981 | store. | |
8982 | ||
efb5e833 LC |
8983 | @node X.509 Certificates |
8984 | @subsection X.509 Certificates | |
8985 | ||
8986 | @cindex HTTPS, certificates | |
8987 | @cindex X.509 certificates | |
8988 | @cindex TLS | |
8989 | Web servers available over HTTPS (that is, HTTP over the transport-layer | |
8990 | security mechanism, TLS) send client programs an @dfn{X.509 certificate} | |
8991 | that the client can then use to @emph{authenticate} the server. To do | |
8992 | that, clients verify that the server's certificate is signed by a | |
8993 | so-called @dfn{certificate authority} (CA). But to verify the CA's | |
8994 | signature, clients must have first acquired the CA's certificate. | |
8995 | ||
8996 | Web browsers such as GNU@tie{}IceCat include their own set of CA | |
8997 | certificates, such that they are able to verify CA signatures | |
8998 | out-of-the-box. | |
8999 | ||
9000 | However, most other programs that can talk HTTPS---@command{wget}, | |
9001 | @command{git}, @command{w3m}, etc.---need to be told where CA | |
9002 | certificates can be found. | |
9003 | ||
9004 | @cindex @code{nss-certs} | |
9005 | In GuixSD, this is done by adding a package that provides certificates | |
9006 | to the @code{packages} field of the @code{operating-system} declaration | |
9007 | (@pxref{operating-system Reference}). GuixSD includes one such package, | |
9008 | @code{nss-certs}, which is a set of CA certificates provided as part of | |
9009 | Mozilla's Network Security Services. | |
9010 | ||
9011 | Note that it is @emph{not} part of @var{%base-packages}, so you need to | |
9012 | explicitly add it. The @file{/etc/ssl/certs} directory, which is where | |
9013 | most applications and libraries look for certificates by default, points | |
9014 | to the certificates installed globally. | |
9015 | ||
9016 | Unprivileged users can also install their own certificate package in | |
9017 | their profile. A number of environment variables need to be defined so | |
9018 | that applications and libraries know where to find them. Namely, the | |
9019 | OpenSSL library honors the @code{SSL_CERT_DIR} and @code{SSL_CERT_FILE} | |
9020 | variables. Some applications add their own environment variables; for | |
9021 | instance, the Git version control system honors the certificate bundle | |
9022 | pointed to by the @code{GIT_SSL_CAINFO} environment variable. | |
9023 | ||
9024 | ||
996ed739 LC |
9025 | @node Name Service Switch |
9026 | @subsection Name Service Switch | |
9027 | ||
9028 | @cindex name service switch | |
9029 | @cindex NSS | |
9030 | The @code{(gnu system nss)} module provides bindings to the | |
9031 | configuration file of libc's @dfn{name service switch} or @dfn{NSS} | |
9032 | (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference | |
9033 | Manual}). In a nutshell, the NSS is a mechanism that allows libc to be | |
9034 | extended with new ``name'' lookup methods for system databases, which | |
9035 | includes host names, service names, user accounts, and more (@pxref{Name | |
9036 | Service Switch, System Databases and Name Service Switch,, libc, The GNU | |
9037 | C Library Reference Manual}). | |
9038 | ||
9039 | The NSS configuration specifies, for each system database, which lookup | |
9040 | method is to be used, and how the various methods are chained | |
9041 | together---for instance, under which circumstances NSS should try the | |
9042 | next method in the list. The NSS configuration is given in the | |
9043 | @code{name-service-switch} field of @code{operating-system} declarations | |
9044 | (@pxref{operating-system Reference, @code{name-service-switch}}). | |
9045 | ||
4c9050c6 LC |
9046 | @cindex nss-mdns |
9047 | @cindex .local, host name lookup | |
996ed739 | 9048 | As an example, the declaration below configures the NSS to use the |
4c9050c6 LC |
9049 | @uref{http://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} |
9050 | back-end}, which supports host name lookups over multicast DNS (mDNS) | |
9051 | for host names ending in @code{.local}: | |
996ed739 LC |
9052 | |
9053 | @example | |
9054 | (name-service-switch | |
9055 | (hosts (list %files ;first, check /etc/hosts | |
9056 | ||
9057 | ;; If the above did not succeed, try | |
9058 | ;; with 'mdns_minimal'. | |
9059 | (name-service | |
9060 | (name "mdns_minimal") | |
9061 | ||
9062 | ;; 'mdns_minimal' is authoritative for | |
9063 | ;; '.local'. When it returns "not found", | |
9064 | ;; no need to try the next methods. | |
9065 | (reaction (lookup-specification | |
9066 | (not-found => return)))) | |
9067 | ||
9068 | ;; Then fall back to DNS. | |
9069 | (name-service | |
9070 | (name "dns")) | |
9071 | ||
9072 | ;; Finally, try with the "full" 'mdns'. | |
9073 | (name-service | |
9074 | (name "mdns"))))) | |
9075 | @end example | |
9076 | ||
15137a29 LC |
9077 | Don't worry: the @code{%mdns-host-lookup-nss} variable (see below) |
9078 | contains this configuration, so you won't have to type it if all you | |
9079 | want is to have @code{.local} host lookup working. | |
9080 | ||
4c9050c6 LC |
9081 | Note that, in this case, in addition to setting the |
9082 | @code{name-service-switch} of the @code{operating-system} declaration, | |
cc9c1f39 LC |
9083 | you also need to use @code{avahi-service} (@pxref{Networking Services, |
9084 | @code{avahi-service}}), or @var{%desktop-services}, which includes it | |
9085 | (@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible | |
9086 | to the name service cache daemon (@pxref{Base Services, | |
9087 | @code{nscd-service}}). | |
15137a29 LC |
9088 | |
9089 | For convenience, the following variables provide typical NSS | |
9090 | configurations. | |
9091 | ||
9092 | @defvr {Scheme Variable} %default-nss | |
9093 | This is the default name service switch configuration, a | |
9094 | @code{name-service-switch} object. | |
9095 | @end defvr | |
9096 | ||
9097 | @defvr {Scheme Variable} %mdns-host-lookup-nss | |
9098 | This is the name service switch configuration with support for host name | |
9099 | lookup over multicast DNS (mDNS) for host names ending in @code{.local}. | |
9100 | @end defvr | |
4c9050c6 | 9101 | |
996ed739 LC |
9102 | The reference for name service switch configuration is given below. It |
9103 | is a direct mapping of the C library's configuration file format, so | |
9104 | please refer to the C library manual for more information (@pxref{NSS | |
9105 | Configuration File,,, libc, The GNU C Library Reference Manual}). | |
9106 | Compared to libc's NSS configuration file format, it has the advantage | |
9107 | not only of adding this warm parenthetic feel that we like, but also | |
9108 | static checks: you'll know about syntax errors and typos as soon as you | |
9109 | run @command{guix system}. | |
9110 | ||
996ed739 LC |
9111 | @deftp {Data Type} name-service-switch |
9112 | ||
9113 | This is the data type representation the configuration of libc's name | |
9114 | service switch (NSS). Each field below represents one of the supported | |
9115 | system databases. | |
9116 | ||
9117 | @table @code | |
9118 | @item aliases | |
9119 | @itemx ethers | |
9120 | @itemx group | |
9121 | @itemx gshadow | |
9122 | @itemx hosts | |
9123 | @itemx initgroups | |
9124 | @itemx netgroup | |
9125 | @itemx networks | |
9126 | @itemx password | |
9127 | @itemx public-key | |
9128 | @itemx rpc | |
9129 | @itemx services | |
9130 | @itemx shadow | |
9131 | The system databases handled by the NSS. Each of these fields must be a | |
9132 | list of @code{<name-service>} objects (see below.) | |
9133 | @end table | |
9134 | @end deftp | |
9135 | ||
9136 | @deftp {Data Type} name-service | |
9137 | ||
9138 | This is the data type representing an actual name service and the | |
9139 | associated lookup action. | |
9140 | ||
9141 | @table @code | |
9142 | @item name | |
9143 | A string denoting the name service (@pxref{Services in the NSS | |
9144 | configuration,,, libc, The GNU C Library Reference Manual}). | |
9145 | ||
4aee6e60 LC |
9146 | Note that name services listed here must be visible to nscd. This is |
9147 | achieved by passing the @code{#:name-services} argument to | |
9148 | @code{nscd-service} the list of packages providing the needed name | |
9149 | services (@pxref{Base Services, @code{nscd-service}}). | |
9150 | ||
996ed739 LC |
9151 | @item reaction |
9152 | An action specified using the @code{lookup-specification} macro | |
9153 | (@pxref{Actions in the NSS configuration,,, libc, The GNU C Library | |
9154 | Reference Manual}). For example: | |
9155 | ||
9156 | @example | |
9157 | (lookup-specification (unavailable => continue) | |
9158 | (success => return)) | |
9159 | @end example | |
9160 | @end table | |
9161 | @end deftp | |
0ae8c15a | 9162 | |
fd1b1fa2 LC |
9163 | @node Initial RAM Disk |
9164 | @subsection Initial RAM Disk | |
9165 | ||
9166 | @cindex initial RAM disk (initrd) | |
9167 | @cindex initrd (initial RAM disk) | |
9168 | For bootstrapping purposes, the Linux-Libre kernel is passed an | |
9169 | @dfn{initial RAM disk}, or @dfn{initrd}. An initrd contains a temporary | |
9170 | root file system, as well as an initialization script. The latter is | |
9171 | responsible for mounting the real root file system, and for loading any | |
9172 | kernel modules that may be needed to achieve that. | |
9173 | ||
9174 | The @code{initrd} field of an @code{operating-system} declaration allows | |
9175 | you to specify which initrd you would like to use. The @code{(gnu | |
9176 | system linux-initrd)} module provides two ways to build an initrd: the | |
9177 | high-level @code{base-initrd} procedure, and the low-level | |
9178 | @code{expression->initrd} procedure. | |
9179 | ||
9180 | The @code{base-initrd} procedure is intended to cover most common uses. | |
9181 | For example, if you want to add a bunch of kernel modules to be loaded | |
9182 | at boot time, you can define the @code{initrd} field of the operating | |
9183 | system declaration like this: | |
9184 | ||
9185 | @example | |
52ac153e | 9186 | (initrd (lambda (file-systems . rest) |
027981d6 LC |
9187 | ;; Create a standard initrd that has modules "foo.ko" |
9188 | ;; and "bar.ko", as well as their dependencies, in | |
9189 | ;; addition to the modules available by default. | |
52ac153e | 9190 | (apply base-initrd file-systems |
027981d6 | 9191 | #:extra-modules '("foo" "bar") |
52ac153e | 9192 | rest))) |
fd1b1fa2 LC |
9193 | @end example |
9194 | ||
52ac153e LC |
9195 | The @code{base-initrd} procedure also handles common use cases that |
9196 | involves using the system as a QEMU guest, or as a ``live'' system whose | |
9197 | root file system is volatile. | |
fd1b1fa2 | 9198 | |
e90cf6c1 LC |
9199 | The initial RAM disk produced by @code{base-initrd} honors several |
9200 | options passed on the Linux kernel command line (that is, arguments | |
9201 | passed @i{via} GRUB's @code{linux} command, or with QEMU's | |
9202 | @code{-append} option), notably: | |
9203 | ||
9204 | @table @code | |
9205 | @item --load=@var{boot} | |
9206 | Tell the initial RAM disk to load @var{boot}, a file containing a Scheme | |
9207 | program, once it has mounted the root file system. | |
9208 | ||
9209 | GuixSD uses this option to yield control to a boot program that runs the | |
dd17bc38 | 9210 | service activation programs and then spawns the GNU@tie{}Shepherd, the |
e90cf6c1 LC |
9211 | initialization system. |
9212 | ||
9213 | @item --root=@var{root} | |
9214 | Mount @var{root} as the root file system. @var{root} can be a device | |
9215 | device name like @code{/dev/sda1}, a partition label, or a partition | |
9216 | UUID. | |
9217 | ||
9218 | @item --system=@var{system} | |
9219 | Have @file{/run/booted-system} and @file{/run/current-system} point to | |
9220 | @var{system}. | |
9221 | ||
9222 | @item modprobe.blacklist=@var{modules}@dots{} | |
9223 | @cindex module, black-listing | |
9224 | @cindex black list, of kernel modules | |
9225 | Instruct the initial RAM disk as well as the @command{modprobe} command | |
9226 | (from the kmod package) to refuse to load @var{modules}. @var{modules} | |
9227 | must be a comma-separated list of module names---e.g., | |
9228 | @code{usbkbd,9pnet}. | |
9229 | ||
9230 | @item --repl | |
9231 | Start a read-eval-print loop (REPL) from the initial RAM disk before it | |
9232 | tries to load kernel modules and to mount the root file system. Our | |
9233 | marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will | |
9234 | love it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference | |
9235 | Manual}, for more information on Guile's REPL. | |
9236 | ||
9237 | @end table | |
9238 | ||
9239 | Now that you know all the features that initial RAM disks produced by | |
9240 | @code{base-initrd} provide, here is how to use it and customize it | |
9241 | further. | |
9242 | ||
fd1b1fa2 | 9243 | @deffn {Monadic Procedure} base-initrd @var{file-systems} @ |
9059b97d | 9244 | [#:qemu-networking? #f] [#:virtio? #t] [#:volatile-root? #f] @ |
52ac153e | 9245 | [#:extra-modules '()] [#:mapped-devices '()] |
fd1b1fa2 LC |
9246 | Return a monadic derivation that builds a generic initrd. @var{file-systems} is |
9247 | a list of file-systems to be mounted by the initrd, possibly in addition to | |
9248 | the root file system specified on the kernel command line via @code{--root}. | |
52ac153e LC |
9249 | @var{mapped-devices} is a list of device mappings to realize before |
9250 | @var{file-systems} are mounted (@pxref{Mapped Devices}). | |
fd1b1fa2 LC |
9251 | |
9252 | When @var{qemu-networking?} is true, set up networking with the standard QEMU | |
9253 | parameters. When @var{virtio?} is true, load additional modules so the initrd can | |
9254 | be used as a QEMU guest with para-virtualized I/O drivers. | |
9255 | ||
9256 | When @var{volatile-root?} is true, the root file system is writable but any changes | |
9257 | to it are lost. | |
9258 | ||
9259 | The initrd is automatically populated with all the kernel modules necessary | |
9260 | for @var{file-systems} and for the given options. However, additional kernel | |
9261 | modules can be listed in @var{extra-modules}. They will be added to the initrd, and | |
9262 | loaded at boot time in the order in which they appear. | |
9263 | @end deffn | |
9264 | ||
9265 | Needless to say, the initrds we produce and use embed a | |
9266 | statically-linked Guile, and the initialization program is a Guile | |
9267 | program. That gives a lot of flexibility. The | |
9268 | @code{expression->initrd} procedure builds such an initrd, given the | |
9269 | program to run in that initrd. | |
9270 | ||
9271 | @deffn {Monadic Procedure} expression->initrd @var{exp} @ | |
9272 | [#:guile %guile-static-stripped] [#:name "guile-initrd"] @ | |
42d10464 | 9273 | [#:modules '()] |
fd1b1fa2 LC |
9274 | Return a derivation that builds a Linux initrd (a gzipped cpio archive) |
9275 | containing @var{guile} and that evaluates @var{exp}, a G-expression, | |
df650fa8 LC |
9276 | upon booting. All the derivations referenced by @var{exp} are |
9277 | automatically copied to the initrd. | |
fd1b1fa2 | 9278 | |
42d10464 LC |
9279 | @var{modules} is a list of Guile module names to be embedded in the |
9280 | initrd. | |
fd1b1fa2 LC |
9281 | @end deffn |
9282 | ||
88faf933 LC |
9283 | @node GRUB Configuration |
9284 | @subsection GRUB Configuration | |
9285 | ||
9286 | @cindex GRUB | |
9287 | @cindex boot loader | |
9288 | ||
9289 | The operating system uses GNU@tie{}GRUB as its boot loader | |
9290 | (@pxref{Overview, overview of GRUB,, grub, GNU GRUB Manual}). It is | |
9291 | configured using @code{grub-configuration} declarations. This data type | |
9292 | is exported by the @code{(gnu system grub)} module, and described below. | |
9293 | ||
9294 | @deftp {Data Type} grub-configuration | |
9295 | The type of a GRUB configuration declaration. | |
9296 | ||
9297 | @table @asis | |
9298 | ||
9299 | @item @code{device} | |
9300 | This is a string denoting the boot device. It must be a device name | |
9301 | understood by the @command{grub-install} command, such as | |
9302 | @code{/dev/sda} or @code{(hd0)} (@pxref{Invoking grub-install,,, grub, | |
9303 | GNU GRUB Manual}). | |
9304 | ||
9305 | @item @code{menu-entries} (default: @code{()}) | |
9306 | A possibly empty list of @code{menu-entry} objects (see below), denoting | |
9307 | entries to appear in the GRUB boot menu, in addition to the current | |
9308 | system entry and the entry pointing to previous system generations. | |
9309 | ||
9310 | @item @code{default-entry} (default: @code{0}) | |
9311 | The index of the default boot menu entry. Index 0 is for the current | |
9312 | system's entry. | |
9313 | ||
9314 | @item @code{timeout} (default: @code{5}) | |
9315 | The number of seconds to wait for keyboard input before booting. Set to | |
9316 | 0 to boot immediately, and to -1 to wait indefinitely. | |
9317 | ||
9318 | @item @code{theme} (default: @var{%default-theme}) | |
9319 | The @code{grub-theme} object describing the theme to use. | |
9320 | @end table | |
9321 | ||
9322 | @end deftp | |
9323 | ||
9324 | Should you want to list additional boot menu entries @i{via} the | |
9325 | @code{menu-entries} field above, you will need to create them with the | |
9326 | @code{menu-entry} form: | |
9327 | ||
9328 | @deftp {Data Type} menu-entry | |
9329 | The type of an entry in the GRUB boot menu. | |
9330 | ||
9331 | @table @asis | |
9332 | ||
9333 | @item @code{label} | |
35ed9306 | 9334 | The label to show in the menu---e.g., @code{"GNU"}. |
88faf933 LC |
9335 | |
9336 | @item @code{linux} | |
9337 | The Linux kernel to boot. | |
9338 | ||
9339 | @item @code{linux-arguments} (default: @code{()}) | |
9340 | The list of extra Linux kernel command-line arguments---e.g., | |
9341 | @code{("console=ttyS0")}. | |
9342 | ||
9343 | @item @code{initrd} | |
9344 | A G-Expression or string denoting the file name of the initial RAM disk | |
9345 | to use (@pxref{G-Expressions}). | |
9346 | ||
9347 | @end table | |
9348 | @end deftp | |
9349 | ||
9350 | @c FIXME: Write documentation once it's stable. | |
9351 | Themes are created using the @code{grub-theme} form, which is not | |
9352 | documented yet. | |
9353 | ||
9354 | @defvr {Scheme Variable} %default-theme | |
9355 | This is the default GRUB theme used by the operating system, with a | |
9356 | fancy background image displaying the GNU and Guix logos. | |
9357 | @end defvr | |
9358 | ||
9359 | ||
cf4a9129 LC |
9360 | @node Invoking guix system |
9361 | @subsection Invoking @code{guix system} | |
0918e64a | 9362 | |
cf4a9129 LC |
9363 | Once you have written an operating system declaration, as seen in the |
9364 | previous section, it can be @dfn{instantiated} using the @command{guix | |
9365 | system} command. The synopsis is: | |
4af2447e | 9366 | |
cf4a9129 LC |
9367 | @example |
9368 | guix system @var{options}@dots{} @var{action} @var{file} | |
9369 | @end example | |
4af2447e | 9370 | |
cf4a9129 LC |
9371 | @var{file} must be the name of a file containing an |
9372 | @code{operating-system} declaration. @var{action} specifies how the | |
a40424bd | 9373 | operating system is instantiated. Currently the following values are |
cf4a9129 | 9374 | supported: |
4af2447e | 9375 | |
cf4a9129 LC |
9376 | @table @code |
9377 | @item reconfigure | |
9378 | Build the operating system described in @var{file}, activate it, and | |
9379 | switch to it@footnote{This action is usable only on systems already | |
65797bff | 9380 | running GuixSD.}. |
4af2447e | 9381 | |
cf4a9129 LC |
9382 | This effects all the configuration specified in @var{file}: user |
9383 | accounts, system services, global package list, setuid programs, etc. | |
240b57f0 LC |
9384 | The command starts system services specified in @var{file} that are not |
9385 | currently running; if a service is currently running, it does not | |
9386 | attempt to upgrade it since it would not be possible without stopping it | |
9387 | first. | |
4af2447e | 9388 | |
cf4a9129 LC |
9389 | It also adds a GRUB menu entry for the new OS configuration, and moves |
9390 | entries for older configurations to a submenu---unless | |
9391 | @option{--no-grub} is passed. | |
4af2447e | 9392 | |
240b57f0 | 9393 | @quotation Note |
bf2479c7 LC |
9394 | @c The paragraph below refers to the problem discussed at |
9395 | @c <http://lists.gnu.org/archive/html/guix-devel/2014-08/msg00057.html>. | |
9396 | It is highly recommended to run @command{guix pull} once before you run | |
9397 | @command{guix system reconfigure} for the first time (@pxref{Invoking | |
9398 | guix pull}). Failing to do that you would see an older version of Guix | |
9399 | once @command{reconfigure} has completed. | |
240b57f0 | 9400 | @end quotation |
bf2479c7 | 9401 | |
cf4a9129 LC |
9402 | @item build |
9403 | Build the operating system's derivation, which includes all the | |
9404 | configuration files and programs needed to boot and run the system. | |
9405 | This action does not actually install anything. | |
113daf62 | 9406 | |
cf4a9129 LC |
9407 | @item init |
9408 | Populate the given directory with all the files necessary to run the | |
9409 | operating system specified in @var{file}. This is useful for first-time | |
4705641f | 9410 | installations of GuixSD. For instance: |
113daf62 LC |
9411 | |
9412 | @example | |
cf4a9129 | 9413 | guix system init my-os-config.scm /mnt |
113daf62 LC |
9414 | @end example |
9415 | ||
cf4a9129 LC |
9416 | copies to @file{/mnt} all the store items required by the configuration |
9417 | specified in @file{my-os-config.scm}. This includes configuration | |
9418 | files, packages, and so on. It also creates other essential files | |
9419 | needed for the system to operate correctly---e.g., the @file{/etc}, | |
9420 | @file{/var}, and @file{/run} directories, and the @file{/bin/sh} file. | |
113daf62 | 9421 | |
cf4a9129 LC |
9422 | This command also installs GRUB on the device specified in |
9423 | @file{my-os-config}, unless the @option{--no-grub} option was passed. | |
113daf62 | 9424 | |
cf4a9129 LC |
9425 | @item vm |
9426 | @cindex virtual machine | |
0276f697 | 9427 | @cindex VM |
f535dcbe | 9428 | @anchor{guix system vm} |
cf4a9129 LC |
9429 | Build a virtual machine that contain the operating system declared in |
9430 | @var{file}, and return a script to run that virtual machine (VM). | |
810568b3 | 9431 | Arguments given to the script are passed as is to QEMU. |
113daf62 | 9432 | |
cf4a9129 | 9433 | The VM shares its store with the host system. |
113daf62 | 9434 | |
0276f697 LC |
9435 | Additional file systems can be shared between the host and the VM using |
9436 | the @code{--share} and @code{--expose} command-line options: the former | |
9437 | specifies a directory to be shared with write access, while the latter | |
9438 | provides read-only access to the shared directory. | |
9439 | ||
9440 | The example below creates a VM in which the user's home directory is | |
9441 | accessible read-only, and where the @file{/exchange} directory is a | |
9442 | read-write mapping of the host's @file{$HOME/tmp}: | |
9443 | ||
9444 | @example | |
9445 | guix system vm my-config.scm \ | |
9446 | --expose=$HOME --share=$HOME/tmp=/exchange | |
9447 | @end example | |
9448 | ||
6aa260af LC |
9449 | On GNU/Linux, the default is to boot directly to the kernel; this has |
9450 | the advantage of requiring only a very tiny root disk image since the | |
9451 | host's store can then be mounted. | |
9452 | ||
9453 | The @code{--full-boot} option forces a complete boot sequence, starting | |
9454 | with the bootloader. This requires more disk space since a root image | |
9455 | containing at least the kernel, initrd, and bootloader data files must | |
9456 | be created. The @code{--image-size} option can be used to specify the | |
9457 | image's size. | |
ab11f0be | 9458 | |
cf4a9129 LC |
9459 | @item vm-image |
9460 | @itemx disk-image | |
9461 | Return a virtual machine or disk image of the operating system declared | |
9462 | in @var{file} that stands alone. Use the @option{--image-size} option | |
9463 | to specify the size of the image. | |
113daf62 | 9464 | |
cf4a9129 | 9465 | When using @code{vm-image}, the returned image is in qcow2 format, which |
97d76250 LF |
9466 | the QEMU emulator can efficiently use. @xref{Running GuixSD in a VM}, |
9467 | for more information on how to run the image in a virtual machine. | |
113daf62 | 9468 | |
cf4a9129 LC |
9469 | When using @code{disk-image}, a raw disk image is produced; it can be |
9470 | copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is | |
9471 | the device corresponding to a USB stick, one can copy the image on it | |
9472 | using the following command: | |
113daf62 | 9473 | |
cf4a9129 LC |
9474 | @example |
9475 | # dd if=$(guix system disk-image my-os.scm) of=/dev/sdc | |
9476 | @end example | |
113daf62 | 9477 | |
1c8a81b1 DT |
9478 | @item container |
9479 | Return a script to run the operating system declared in @var{file} | |
9480 | within a container. Containers are a set of lightweight isolation | |
9481 | mechanisms provided by the kernel Linux-libre. Containers are | |
9482 | substantially less resource-demanding than full virtual machines since | |
9483 | the kernel, shared objects, and other resources can be shared with the | |
9484 | host system; this also means they provide thinner isolation. | |
9485 | ||
9486 | Currently, the script must be run as root in order to support more than | |
9487 | a single user and group. The container shares its store with the host | |
9488 | system. | |
9489 | ||
9490 | As with the @code{vm} action (@pxref{guix system vm}), additional file | |
9491 | systems to be shared between the host and container can be specified | |
9492 | using the @option{--share} and @option{--expose} options: | |
9493 | ||
9494 | @example | |
9495 | guix system container my-config.scm \ | |
9496 | --expose=$HOME --share=$HOME/tmp=/exchange | |
9497 | @end example | |
9498 | ||
0f252e26 | 9499 | @quotation Note |
cfd35b4e | 9500 | This option requires Linux-libre 3.19 or newer. |
0f252e26 DT |
9501 | @end quotation |
9502 | ||
cf4a9129 | 9503 | @end table |
113daf62 | 9504 | |
ccd7158d LC |
9505 | @var{options} can contain any of the common build options (@pxref{Common |
9506 | Build Options}). In addition, @var{options} can contain one of the | |
9507 | following: | |
113daf62 | 9508 | |
cf4a9129 LC |
9509 | @table @option |
9510 | @item --system=@var{system} | |
9511 | @itemx -s @var{system} | |
9512 | Attempt to build for @var{system} instead of the host's system type. | |
9513 | This works as per @command{guix build} (@pxref{Invoking guix build}). | |
113daf62 | 9514 | |
f3f427c2 LC |
9515 | @item --derivation |
9516 | @itemx -d | |
9517 | Return the derivation file name of the given operating system without | |
9518 | building anything. | |
9519 | ||
cf4a9129 LC |
9520 | @item --image-size=@var{size} |
9521 | For the @code{vm-image} and @code{disk-image} actions, create an image | |
9522 | of the given @var{size}. @var{size} may be a number of bytes, or it may | |
4a44d7bb LC |
9523 | include a unit as a suffix (@pxref{Block size, size specifications,, |
9524 | coreutils, GNU Coreutils}). | |
db030303 LC |
9525 | |
9526 | @item --on-error=@var{strategy} | |
9527 | Apply @var{strategy} when an error occurs when reading @var{file}. | |
9528 | @var{strategy} may be one of the following: | |
9529 | ||
9530 | @table @code | |
9531 | @item nothing-special | |
9532 | Report the error concisely and exit. This is the default strategy. | |
9533 | ||
9534 | @item backtrace | |
9535 | Likewise, but also display a backtrace. | |
9536 | ||
9537 | @item debug | |
9538 | Report the error and enter Guile's debugger. From there, you can run | |
9539 | commands such as @code{,bt} to get a backtrace, @code{,locals} to | |
9540 | display local variable values, and more generally inspect the program's | |
9541 | state. @xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for | |
9542 | a list of available debugging commands. | |
9543 | @end table | |
113daf62 | 9544 | @end table |
113daf62 | 9545 | |
cf4a9129 LC |
9546 | Note that all the actions above, except @code{build} and @code{init}, |
9547 | rely on KVM support in the Linux-Libre kernel. Specifically, the | |
9548 | machine should have hardware virtualization support, the corresponding | |
9549 | KVM kernel module should be loaded, and the @file{/dev/kvm} device node | |
9550 | must exist and be readable and writable by the user and by the daemon's | |
9551 | build users. | |
8451a568 | 9552 | |
65797bff LC |
9553 | Once you have built, configured, re-configured, and re-re-configured |
9554 | your GuixSD installation, you may find it useful to list the operating | |
9555 | system generations available on disk---and that you can choose from the | |
9556 | GRUB boot menu: | |
9557 | ||
9558 | @table @code | |
9559 | ||
9560 | @item list-generations | |
9561 | List a summary of each generation of the operating system available on | |
9562 | disk, in a human-readable way. This is similar to the | |
9563 | @option{--list-generations} option of @command{guix package} | |
9564 | (@pxref{Invoking guix package}). | |
9565 | ||
9566 | Optionally, one can specify a pattern, with the same syntax that is used | |
9567 | in @command{guix package --list-generations}, to restrict the list of | |
9568 | generations displayed. For instance, the following command displays | |
9569 | generations up to 10-day old: | |
9570 | ||
9571 | @example | |
9572 | $ guix system list-generations 10d | |
9573 | @end example | |
9574 | ||
9575 | @end table | |
9576 | ||
d6c3267a LC |
9577 | The @command{guix system} command has even more to offer! The following |
9578 | sub-commands allow you to visualize how your system services relate to | |
9579 | each other: | |
9580 | ||
9581 | @anchor{system-extension-graph} | |
9582 | @table @code | |
9583 | ||
9584 | @item extension-graph | |
9585 | Emit in Dot/Graphviz format to standard output the @dfn{service | |
9586 | extension graph} of the operating system defined in @var{file} | |
9587 | (@pxref{Service Composition}, for more information on service | |
9588 | extensions.) | |
9589 | ||
9590 | The command: | |
9591 | ||
9592 | @example | |
9593 | $ guix system extension-graph @var{file} | dot -Tpdf > services.pdf | |
9594 | @end example | |
9595 | ||
9596 | produces a PDF file showing the extension relations among services. | |
9597 | ||
710fa231 AK |
9598 | @anchor{system-shepherd-graph} |
9599 | @item shepherd-graph | |
6f305ea5 | 9600 | Emit in Dot/Graphviz format to standard output the @dfn{dependency |
dd17bc38 AK |
9601 | graph} of shepherd services of the operating system defined in |
9602 | @var{file}. @xref{Shepherd Services}, for more information and for an | |
9603 | example graph. | |
6f305ea5 | 9604 | |
d6c3267a LC |
9605 | @end table |
9606 | ||
97d76250 LF |
9607 | @node Running GuixSD in a VM |
9608 | @subsection Running GuixSD in a virtual machine | |
9609 | ||
9610 | One way to run GuixSD in a virtual machine (VM) is to build a GuixSD | |
9611 | virtual machine image using @command{guix system vm-image} | |
9612 | (@pxref{Invoking guix system}). The returned image is in qcow2 format, | |
9613 | which the @uref{http://qemu.org/, QEMU emulator} can efficiently use. | |
9614 | ||
9615 | To run the image in QEMU, copy it out of the store (@pxref{The Store}) | |
9616 | and give yourself permission to write to the copy. When invoking QEMU, | |
9617 | you must choose a system emulator that is suitable for your hardware | |
9618 | platform. Here is a minimal QEMU invocation that will boot the result | |
9619 | of @command{guix system vm-image} on x86_64 hardware: | |
9620 | ||
9621 | @example | |
9622 | $ qemu-system-x86_64 \ | |
9623 | -net user -net nic,model=virtio \ | |
9624 | -enable-kvm -m 256 /tmp/qemu-image | |
9625 | @end example | |
9626 | ||
9627 | Here is what each of these options means: | |
9628 | ||
9629 | @table @code | |
9630 | @item qemu-system-x86_64 | |
9631 | This specifies the hardware platform to emulate. This should match the | |
9632 | host. | |
9633 | ||
9634 | @item -net user | |
9635 | Enable the unprivileged user-mode network stack. The guest OS can | |
9636 | access the host but not vice versa. This is the simplest way to get the | |
9637 | guest OS online. If you don't choose a network stack, the boot will | |
9638 | fail. | |
9639 | ||
9640 | @item -net nic,model=virtio | |
9641 | You must create a network interface of a given model. If you don't | |
9642 | create a NIC, the boot will fail. Assuming your hardware platform is | |
9643 | x86_64, you can get a list of available NIC models by running | |
9644 | @command{qemu-system-x86_64 -net nic,model=help}. | |
9645 | ||
9646 | @item -enable-kvm | |
9647 | If your system has hardware virtualization extensions, enabling the | |
9648 | Linux kernel's virtual machine support (KVM) will make things run | |
9649 | faster. | |
9650 | ||
9651 | @item -m 256 | |
9652 | RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, | |
9653 | which may be insufficent for some operations. | |
9654 | ||
9655 | @item /tmp/qemu-image | |
9656 | The file name of the qcow2 image. | |
9657 | @end table | |
d6c3267a | 9658 | |
cf4a9129 LC |
9659 | @node Defining Services |
9660 | @subsection Defining Services | |
8451a568 | 9661 | |
eb524192 | 9662 | The previous sections show the available services and how one can combine |
0adfe95a LC |
9663 | them in an @code{operating-system} declaration. But how do we define |
9664 | them in the first place? And what is a service anyway? | |
8451a568 | 9665 | |
0adfe95a LC |
9666 | @menu |
9667 | * Service Composition:: The model for composing services. | |
9668 | * Service Types and Services:: Types and services. | |
9669 | * Service Reference:: API reference. | |
dd17bc38 | 9670 | * Shepherd Services:: A particular type of service. |
0adfe95a LC |
9671 | @end menu |
9672 | ||
9673 | @node Service Composition | |
9674 | @subsubsection Service Composition | |
9675 | ||
9676 | @cindex services | |
9677 | @cindex daemons | |
9678 | Here we define a @dfn{service} as, broadly, something that extends the | |
9679 | operating system's functionality. Often a service is a process---a | |
9680 | @dfn{daemon}---started when the system boots: a secure shell server, a | |
9681 | Web server, the Guix build daemon, etc. Sometimes a service is a daemon | |
9682 | whose execution can be triggered by another daemon---e.g., an FTP server | |
9683 | started by @command{inetd} or a D-Bus service activated by | |
9684 | @command{dbus-daemon}. Occasionally, a service does not map to a | |
9685 | daemon. For instance, the ``account'' service collects user accounts | |
9686 | and makes sure they exist when the system runs; the ``udev'' service | |
9687 | collects device management rules and makes them available to the eudev | |
9688 | daemon; the @file{/etc} service populates the system's @file{/etc} | |
9689 | directory. | |
9690 | ||
d6c3267a | 9691 | @cindex service extensions |
0adfe95a | 9692 | GuixSD services are connected by @dfn{extensions}. For instance, the |
dd17bc38 AK |
9693 | secure shell service @emph{extends} the Shepherd---GuixSD's |
9694 | initialization system, running as PID@tie{}1---by giving it the command | |
9695 | lines to start and stop the secure shell daemon (@pxref{Networking | |
9696 | Services, @code{lsh-service}}); the UPower service extends the D-Bus | |
9697 | service by passing it its @file{.service} specification, and extends the | |
9698 | udev service by passing it device management rules (@pxref{Desktop | |
9699 | Services, @code{upower-service}}); the Guix daemon service extends the | |
9700 | Shepherd by passing it the command lines to start and stop the daemon, | |
9701 | and extends the account service by passing it a list of required build | |
9702 | user accounts (@pxref{Base Services}). | |
0adfe95a LC |
9703 | |
9704 | All in all, services and their ``extends'' relations form a directed | |
9705 | acyclic graph (DAG). If we represent services as boxes and extensions | |
9706 | as arrows, a typical system might provide something like this: | |
9707 | ||
9708 | @image{images/service-graph,,5in,Typical service extension graph.} | |
9709 | ||
d62e201c LC |
9710 | @cindex system service |
9711 | At the bottom, we see the @dfn{system service}, which produces the | |
9712 | directory containing everything to run and boot the system, as returned | |
9713 | by the @command{guix system build} command. @xref{Service Reference}, | |
9714 | to learn about the other service types shown here. | |
d6c3267a LC |
9715 | @xref{system-extension-graph, the @command{guix system extension-graph} |
9716 | command}, for information on how to generate this representation for a | |
9717 | particular operating system definition. | |
0adfe95a LC |
9718 | |
9719 | @cindex service types | |
9720 | Technically, developers can define @dfn{service types} to express these | |
9721 | relations. There can be any number of services of a given type on the | |
9722 | system---for instance, a system running two instances of the GNU secure | |
9723 | shell server (lsh) has two instances of @var{lsh-service-type}, with | |
9724 | different parameters. | |
9725 | ||
9726 | The following section describes the programming interface for service | |
9727 | types and services. | |
9728 | ||
9729 | @node Service Types and Services | |
9730 | @subsubsection Service Types and Services | |
9731 | ||
9732 | A @dfn{service type} is a node in the DAG described above. Let us start | |
9733 | with a simple example, the service type for the Guix build daemon | |
9734 | (@pxref{Invoking guix-daemon}): | |
9735 | ||
9736 | @example | |
9737 | (define guix-service-type | |
9738 | (service-type | |
9739 | (name 'guix) | |
9740 | (extensions | |
d4053c71 | 9741 | (list (service-extension shepherd-root-service-type guix-shepherd-service) |
0adfe95a LC |
9742 | (service-extension account-service-type guix-accounts) |
9743 | (service-extension activation-service-type guix-activation))))) | |
9744 | @end example | |
8451a568 | 9745 | |
cf4a9129 | 9746 | @noindent |
0adfe95a LC |
9747 | It defines a two things: |
9748 | ||
9749 | @enumerate | |
9750 | @item | |
9751 | A name, whose sole purpose is to make inspection and debugging easier. | |
9752 | ||
9753 | @item | |
9754 | A list of @dfn{service extensions}, where each extension designates the | |
9755 | target service type and a procedure that, given the service's | |
9756 | parameters, returns a list of object to extend the service of that type. | |
9757 | ||
9758 | Every service type has at least one service extension. The only | |
9759 | exception is the @dfn{boot service type}, which is the ultimate service. | |
9760 | @end enumerate | |
9761 | ||
9762 | In this example, @var{guix-service-type} extends three services: | |
9763 | ||
9764 | @table @var | |
d4053c71 AK |
9765 | @item shepherd-root-service-type |
9766 | The @var{guix-shepherd-service} procedure defines how the Shepherd | |
9767 | service is extended. Namely, it returns a @code{<shepherd-service>} | |
9768 | object that defines how @command{guix-daemon} is started and stopped | |
9769 | (@pxref{Shepherd Services}). | |
0adfe95a LC |
9770 | |
9771 | @item account-service-type | |
9772 | This extension for this service is computed by @var{guix-accounts}, | |
9773 | which returns a list of @code{user-group} and @code{user-account} | |
9774 | objects representing the build user accounts (@pxref{Invoking | |
9775 | guix-daemon}). | |
9776 | ||
9777 | @item activation-service-type | |
9778 | Here @var{guix-activation} is a procedure that returns a gexp, which is | |
9779 | a code snippet to run at ``activation time''---e.g., when the service is | |
9780 | booted. | |
9781 | @end table | |
9782 | ||
9783 | A service of this type is instantiated like this: | |
9784 | ||
9785 | @example | |
9786 | (service guix-service-type | |
9787 | (guix-configuration | |
9788 | (build-accounts 5) | |
9789 | (use-substitutes? #f))) | |
9790 | @end example | |
9791 | ||
9792 | The second argument to the @code{service} form is a value representing | |
9793 | the parameters of this specific service instance. | |
9794 | @xref{guix-configuration-type, @code{guix-configuration}}, for | |
9795 | information about the @code{guix-configuration} data type. | |
9796 | ||
9797 | @var{guix-service-type} is quite simple because it extends other | |
9798 | services but is not extensible itself. | |
9799 | ||
9800 | @c @subsubsubsection Extensible Service Types | |
9801 | ||
9802 | The service type for an @emph{extensible} service looks like this: | |
9803 | ||
9804 | @example | |
9805 | (define udev-service-type | |
9806 | (service-type (name 'udev) | |
9807 | (extensions | |
d4053c71 AK |
9808 | (list (service-extension shepherd-root-service-type |
9809 | udev-shepherd-service))) | |
0adfe95a LC |
9810 | |
9811 | (compose concatenate) ;concatenate the list of rules | |
9812 | (extend (lambda (config rules) | |
9813 | (match config | |
9814 | (($ <udev-configuration> udev initial-rules) | |
9815 | (udev-configuration | |
9816 | (udev udev) ;the udev package to use | |
9817 | (rules (append initial-rules rules))))))))) | |
9818 | @end example | |
9819 | ||
9820 | This is the service type for the | |
9821 | @uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device | |
9822 | management daemon}. Compared to the previous example, in addition to an | |
d4053c71 | 9823 | extension of @var{shepherd-root-service-type}, we see two new fields: |
0adfe95a LC |
9824 | |
9825 | @table @code | |
9826 | @item compose | |
9827 | This is the procedure to @dfn{compose} the list of extensions to | |
9828 | services of this type. | |
9829 | ||
9830 | Services can extend the udev service by passing it lists of rules; we | |
9831 | compose those extensions simply by concatenating them. | |
9832 | ||
9833 | @item extend | |
9834 | This procedure defines how the service's value is @dfn{extended} with | |
9835 | the composition of the extensions. | |
9836 | ||
9837 | Udev extensions are composed into a list of rules, but the udev service | |
9838 | value is itself a @code{<udev-configuration>} record. So here, we | |
a40424bd | 9839 | extend that record by appending the list of rules it contains to the |
0adfe95a LC |
9840 | list of contributed rules. |
9841 | @end table | |
9842 | ||
9843 | There can be only one instance of an extensible service type such as | |
9844 | @var{udev-service-type}. If there were more, the | |
9845 | @code{service-extension} specifications would be ambiguous. | |
9846 | ||
9847 | Still here? The next section provides a reference of the programming | |
9848 | interface for services. | |
9849 | ||
9850 | @node Service Reference | |
9851 | @subsubsection Service Reference | |
9852 | ||
9853 | We have seen an overview of service types (@pxref{Service Types and | |
9854 | Services}). This section provides a reference on how to manipulate | |
9855 | services and service types. This interface is provided by the | |
9856 | @code{(gnu services)} module. | |
9857 | ||
9858 | @deffn {Scheme Procedure} service @var{type} @var{value} | |
9859 | Return a new service of @var{type}, a @code{<service-type>} object (see | |
9860 | below.) @var{value} can be any object; it represents the parameters of | |
9861 | this particular service instance. | |
9862 | @end deffn | |
9863 | ||
9864 | @deffn {Scheme Procedure} service? @var{obj} | |
9865 | Return true if @var{obj} is a service. | |
9866 | @end deffn | |
8451a568 | 9867 | |
0adfe95a LC |
9868 | @deffn {Scheme Procedure} service-kind @var{service} |
9869 | Return the type of @var{service}---i.e., a @code{<service-type>} object. | |
9870 | @end deffn | |
9871 | ||
9872 | @deffn {Scheme Procedure} service-parameters @var{service} | |
9873 | Return the value associated with @var{service}. It represents its | |
9874 | parameters. | |
9875 | @end deffn | |
9876 | ||
9877 | Here is an example of how a service is created and manipulated: | |
9878 | ||
9879 | @example | |
9880 | (define s | |
9881 | (service nginx-service-type | |
9882 | (nginx-configuration | |
9883 | (nginx nginx) | |
9884 | (log-directory log-directory) | |
9885 | (run-directory run-directory) | |
9886 | (file config-file)))) | |
9887 | ||
9888 | (service? s) | |
9889 | @result{} #t | |
9890 | ||
9891 | (eq? (service-kind s) nginx-service-type) | |
9892 | @result{} #t | |
9893 | @end example | |
9894 | ||
cd6f6c22 LC |
9895 | The @code{modify-services} form provides a handy way to change the |
9896 | parameters of some of the services of a list such as | |
9897 | @var{%base-services} (@pxref{Base Services, @code{%base-services}}). Of | |
9898 | course, you could always use standard list combinators such as | |
9899 | @code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, | |
9900 | guile, GNU Guile Reference Manual}); @code{modify-services} simply | |
9901 | provides a more concise form for this common pattern. | |
9902 | ||
9903 | @deffn {Scheme Syntax} modify-services @var{services} @ | |
9904 | (@var{type} @var{variable} => @var{body}) @dots{} | |
9905 | ||
9906 | Modify the services listed in @var{services} according to the given | |
9907 | clauses. Each clause has the form: | |
9908 | ||
9909 | @example | |
9910 | (@var{type} @var{variable} => @var{body}) | |
9911 | @end example | |
9912 | ||
9913 | where @var{type} is a service type, such as @var{guix-service-type}, and | |
9914 | @var{variable} is an identifier that is bound within @var{body} to the | |
9915 | value of the service of that @var{type}. @xref{Using the Configuration | |
9916 | System}, for an example. | |
9917 | ||
9918 | This is a shorthand for: | |
9919 | ||
9920 | @example | |
9921 | (map (lambda (service) @dots{}) @var{services}) | |
9922 | @end example | |
9923 | @end deffn | |
9924 | ||
9925 | Next comes the programming interface for service types. This is | |
9926 | something you want to know when writing new service definitions, but not | |
9927 | necessarily when simply looking for ways to customize your | |
9928 | @code{operating-system} declaration. | |
9929 | ||
0adfe95a LC |
9930 | @deftp {Data Type} service-type |
9931 | @cindex service type | |
9932 | This is the representation of a @dfn{service type} (@pxref{Service Types | |
9933 | and Services}). | |
9934 | ||
9935 | @table @asis | |
9936 | @item @code{name} | |
9937 | This is a symbol, used only to simplify inspection and debugging. | |
9938 | ||
9939 | @item @code{extensions} | |
9940 | A non-empty list of @code{<service-extension>} objects (see below.) | |
9941 | ||
9942 | @item @code{compose} (default: @code{#f}) | |
9943 | If this is @code{#f}, then the service type denotes services that cannot | |
9944 | be extended---i.e., services that do not receive ``values'' from other | |
9945 | services. | |
9946 | ||
9947 | Otherwise, it must be a one-argument procedure. The procedure is called | |
9948 | by @code{fold-services} and is passed a list of values collected from | |
9949 | extensions. It must return a value that is a valid parameter value for | |
9950 | the service instance. | |
9951 | ||
9952 | @item @code{extend} (default: @code{#f}) | |
9953 | If this is @code{#f}, services of this type cannot be extended. | |
9954 | ||
9955 | Otherwise, it must be a two-argument procedure: @code{fold-services} | |
9956 | calls it, passing it the service's initial value as the first argument | |
9957 | and the result of applying @code{compose} to the extension values as the | |
9958 | second argument. | |
9959 | @end table | |
9960 | ||
9961 | @xref{Service Types and Services}, for examples. | |
9962 | @end deftp | |
9963 | ||
9964 | @deffn {Scheme Procedure} service-extension @var{target-type} @ | |
9965 | @var{compute} | |
9966 | Return a new extension for services of type @var{target-type}. | |
9967 | @var{compute} must be a one-argument procedure: @code{fold-services} | |
9968 | calls it, passing it the value associated with the service that provides | |
9969 | the extension; it must return a valid value for the target service. | |
9970 | @end deffn | |
9971 | ||
9972 | @deffn {Scheme Procedure} service-extension? @var{obj} | |
9973 | Return true if @var{obj} is a service extension. | |
9974 | @end deffn | |
9975 | ||
9976 | At the core of the service abstraction lies the @code{fold-services} | |
9977 | procedure, which is responsible for ``compiling'' a list of services | |
d62e201c LC |
9978 | down to a single directory that contains everything needed to boot and |
9979 | run the system---the directory shown by the @command{guix system build} | |
9980 | command (@pxref{Invoking guix system}). In essence, it propagates | |
9981 | service extensions down the service graph, updating each node parameters | |
9982 | on the way, until it reaches the root node. | |
0adfe95a LC |
9983 | |
9984 | @deffn {Scheme Procedure} fold-services @var{services} @ | |
d62e201c | 9985 | [#:target-type @var{system-service-type}] |
0adfe95a LC |
9986 | Fold @var{services} by propagating their extensions down to the root of |
9987 | type @var{target-type}; return the root service adjusted accordingly. | |
9988 | @end deffn | |
9989 | ||
9990 | Lastly, the @code{(gnu services)} module also defines several essential | |
9991 | service types, some of which are listed below. | |
9992 | ||
d62e201c LC |
9993 | @defvr {Scheme Variable} system-service-type |
9994 | This is the root of the service graph. It produces the system directory | |
9995 | as returned by the @command{guix system build} command. | |
9996 | @end defvr | |
9997 | ||
0adfe95a | 9998 | @defvr {Scheme Variable} boot-service-type |
d62e201c LC |
9999 | The type of the ``boot service'', which produces the @dfn{boot script}. |
10000 | The boot script is what the initial RAM disk runs when booting. | |
0adfe95a LC |
10001 | @end defvr |
10002 | ||
10003 | @defvr {Scheme Variable} etc-service-type | |
10004 | The type of the @file{/etc} service. This service can be extended by | |
10005 | passing it name/file tuples such as: | |
10006 | ||
10007 | @example | |
10008 | (list `("issue" ,(plain-file "issue" "Welcome!\n"))) | |
10009 | @end example | |
10010 | ||
10011 | In this example, the effect would be to add an @file{/etc/issue} file | |
10012 | pointing to the given file. | |
10013 | @end defvr | |
10014 | ||
10015 | @defvr {Scheme Variable} setuid-program-service-type | |
10016 | Type for the ``setuid-program service''. This service collects lists of | |
10017 | executable file names, passed as gexps, and adds them to the set of | |
10018 | setuid-root programs on the system (@pxref{Setuid Programs}). | |
10019 | @end defvr | |
10020 | ||
af4c3fd5 LC |
10021 | @defvr {Scheme Variable} profile-service-type |
10022 | Type of the service that populates the @dfn{system profile}---i.e., the | |
10023 | programs under @file{/run/current-system/profile}. Other services can | |
10024 | extend it by passing it lists of packages to add to the system profile. | |
10025 | @end defvr | |
10026 | ||
0adfe95a | 10027 | |
dd17bc38 AK |
10028 | @node Shepherd Services |
10029 | @subsubsection Shepherd Services | |
0adfe95a LC |
10030 | |
10031 | @cindex PID 1 | |
10032 | @cindex init system | |
a40424bd CM |
10033 | The @code{(gnu services shepherd)} module provides a way to define |
10034 | services managed by the GNU@tie{}Shepherd, which is the GuixSD | |
10035 | initialization system---the first process that is started when the | |
10036 | system boots, aka. PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU | |
10037 | Shepherd Manual}). | |
6f305ea5 | 10038 | |
dd17bc38 AK |
10039 | Services in the Shepherd can depend on each other. For instance, the |
10040 | SSH daemon may need to be started after the syslog daemon has been | |
10041 | started, which in turn can only happen once all the file systems have | |
10042 | been mounted. The simple operating system defined earlier (@pxref{Using | |
10043 | the Configuration System}) results in a service graph like this: | |
6f305ea5 | 10044 | |
710fa231 | 10045 | @image{images/shepherd-graph,,5in,Typical shepherd service graph.} |
6f305ea5 LC |
10046 | |
10047 | You can actually generate such a graph for any operating system | |
710fa231 AK |
10048 | definition using the @command{guix system shepherd-graph} command |
10049 | (@pxref{system-shepherd-graph, @command{guix system shepherd-graph}}). | |
6f305ea5 | 10050 | |
d4053c71 AK |
10051 | The @var{%shepherd-root-service} is a service object representing |
10052 | PID@tie{}1, of type @var{shepherd-root-service-type}; it can be extended | |
10053 | by passing it lists of @code{<shepherd-service>} objects. | |
0adfe95a | 10054 | |
d4053c71 | 10055 | @deftp {Data Type} shepherd-service |
dd17bc38 | 10056 | The data type representing a service managed by the Shepherd. |
0adfe95a LC |
10057 | |
10058 | @table @asis | |
10059 | @item @code{provision} | |
10060 | This is a list of symbols denoting what the service provides. | |
10061 | ||
dd17bc38 AK |
10062 | These are the names that may be passed to @command{herd start}, |
10063 | @command{herd status}, and similar commands (@pxref{Invoking herd,,, | |
10064 | shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the | |
10065 | @code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details. | |
0adfe95a LC |
10066 | |
10067 | @item @code{requirements} (default: @code{'()}) | |
dd17bc38 | 10068 | List of symbols denoting the Shepherd services this one depends on. |
0adfe95a LC |
10069 | |
10070 | @item @code{respawn?} (default: @code{#t}) | |
10071 | Whether to restart the service when it stops, for instance when the | |
10072 | underlying process dies. | |
10073 | ||
10074 | @item @code{start} | |
10075 | @itemx @code{stop} (default: @code{#~(const #f)}) | |
dd17bc38 AK |
10076 | The @code{start} and @code{stop} fields refer to the Shepherd's |
10077 | facilities to start and stop processes (@pxref{Service De- and | |
10078 | Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as | |
10079 | G-expressions that get expanded in the Shepherd configuration file | |
10080 | (@pxref{G-Expressions}). | |
0adfe95a LC |
10081 | |
10082 | @item @code{documentation} | |
10083 | A documentation string, as shown when running: | |
10084 | ||
10085 | @example | |
dd17bc38 | 10086 | herd doc @var{service-name} |
0adfe95a LC |
10087 | @end example |
10088 | ||
10089 | where @var{service-name} is one of the symbols in @var{provision} | |
dd17bc38 | 10090 | (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). |
fae685b9 LC |
10091 | |
10092 | @item @code{modules} (default: @var{%default-modules}) | |
10093 | This is the list of modules that must be in scope when @code{start} and | |
10094 | @code{stop} are evaluated. | |
10095 | ||
10096 | @item @code{imported-modules} (default: @var{%default-imported-modules}) | |
10097 | This is the list of modules to import in the execution environment of | |
dd17bc38 | 10098 | the Shepherd. |
fae685b9 | 10099 | |
0adfe95a LC |
10100 | @end table |
10101 | @end deftp | |
10102 | ||
d4053c71 | 10103 | @defvr {Scheme Variable} shepherd-root-service-type |
dd17bc38 | 10104 | The service type for the Shepherd ``root service''---i.e., PID@tie{}1. |
0adfe95a LC |
10105 | |
10106 | This is the service type that extensions target when they want to create | |
dd17bc38 | 10107 | shepherd services (@pxref{Service Types and Services}, for an example). |
d4053c71 | 10108 | Each extension must pass a list of @code{<shepherd-service>}. |
0adfe95a LC |
10109 | @end defvr |
10110 | ||
d4053c71 | 10111 | @defvr {Scheme Variable} %shepherd-root-service |
0adfe95a LC |
10112 | This service represents PID@tie{}1. |
10113 | @end defvr | |
8451a568 | 10114 | |
8451a568 | 10115 | |
cf4a9129 LC |
10116 | @node Installing Debugging Files |
10117 | @section Installing Debugging Files | |
8451a568 | 10118 | |
cf4a9129 LC |
10119 | @cindex debugging files |
10120 | Program binaries, as produced by the GCC compilers for instance, are | |
10121 | typically written in the ELF format, with a section containing | |
10122 | @dfn{debugging information}. Debugging information is what allows the | |
10123 | debugger, GDB, to map binary code to source code; it is required to | |
10124 | debug a compiled program in good conditions. | |
8451a568 | 10125 | |
cf4a9129 LC |
10126 | The problem with debugging information is that is takes up a fair amount |
10127 | of disk space. For example, debugging information for the GNU C Library | |
10128 | weighs in at more than 60 MiB. Thus, as a user, keeping all the | |
10129 | debugging info of all the installed programs is usually not an option. | |
10130 | Yet, space savings should not come at the cost of an impediment to | |
10131 | debugging---especially in the GNU system, which should make it easier | |
10132 | for users to exert their computing freedom (@pxref{GNU Distribution}). | |
8451a568 | 10133 | |
cf4a9129 LC |
10134 | Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a |
10135 | mechanism that allows users to get the best of both worlds: debugging | |
10136 | information can be stripped from the binaries and stored in separate | |
10137 | files. GDB is then able to load debugging information from those files, | |
10138 | when they are available (@pxref{Separate Debug Files,,, gdb, Debugging | |
10139 | with GDB}). | |
8451a568 | 10140 | |
cf4a9129 LC |
10141 | The GNU distribution takes advantage of this by storing debugging |
10142 | information in the @code{lib/debug} sub-directory of a separate package | |
10143 | output unimaginatively called @code{debug} (@pxref{Packages with | |
10144 | Multiple Outputs}). Users can choose to install the @code{debug} output | |
10145 | of a package when they need it. For instance, the following command | |
10146 | installs the debugging information for the GNU C Library and for GNU | |
10147 | Guile: | |
8451a568 LC |
10148 | |
10149 | @example | |
cf4a9129 | 10150 | guix package -i glibc:debug guile:debug |
8451a568 LC |
10151 | @end example |
10152 | ||
cf4a9129 LC |
10153 | GDB must then be told to look for debug files in the user's profile, by |
10154 | setting the @code{debug-file-directory} variable (consider setting it | |
10155 | from the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with | |
10156 | GDB}): | |
8451a568 | 10157 | |
cf4a9129 LC |
10158 | @example |
10159 | (gdb) set debug-file-directory ~/.guix-profile/lib/debug | |
10160 | @end example | |
8451a568 | 10161 | |
cf4a9129 LC |
10162 | From there on, GDB will pick up debugging information from the |
10163 | @code{.debug} files under @file{~/.guix-profile/lib/debug}. | |
8451a568 | 10164 | |
cf4a9129 LC |
10165 | In addition, you will most likely want GDB to be able to show the source |
10166 | code being debugged. To do that, you will have to unpack the source | |
10167 | code of the package of interest (obtained with @code{guix build | |
10168 | --source}, @pxref{Invoking guix build}), and to point GDB to that source | |
10169 | directory using the @code{directory} command (@pxref{Source Path, | |
10170 | @code{directory},, gdb, Debugging with GDB}). | |
8451a568 | 10171 | |
cf4a9129 LC |
10172 | @c XXX: keep me up-to-date |
10173 | The @code{debug} output mechanism in Guix is implemented by the | |
10174 | @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is | |
10175 | opt-in---debugging information is available only for those packages | |
10176 | whose definition explicitly declares a @code{debug} output. This may be | |
10177 | changed to opt-out in the future, if our build farm servers can handle | |
10178 | the load. To check whether a package has a @code{debug} output, use | |
10179 | @command{guix package --list-available} (@pxref{Invoking guix package}). | |
8451a568 | 10180 | |
8451a568 | 10181 | |
05962f29 LC |
10182 | @node Security Updates |
10183 | @section Security Updates | |
10184 | ||
843858b8 LC |
10185 | @quotation Note |
10186 | As of version @value{VERSION}, the feature described in this section is | |
10187 | experimental. | |
10188 | @end quotation | |
05962f29 LC |
10189 | |
10190 | @cindex security updates | |
10191 | Occasionally, important security vulnerabilities are discovered in core | |
10192 | software packages and must be patched. Guix follows a functional | |
10193 | package management discipline (@pxref{Introduction}), which implies | |
10194 | that, when a package is changed, @emph{every package that depends on it} | |
10195 | must be rebuilt. This can significantly slow down the deployment of | |
10196 | fixes in core packages such as libc or Bash, since basically the whole | |
10197 | distribution would need to be rebuilt. Using pre-built binaries helps | |
10198 | (@pxref{Substitutes}), but deployment may still take more time than | |
10199 | desired. | |
10200 | ||
10201 | @cindex grafts | |
10202 | To address that, Guix implements @dfn{grafts}, a mechanism that allows | |
10203 | for fast deployment of critical updates without the costs associated | |
10204 | with a whole-distribution rebuild. The idea is to rebuild only the | |
10205 | package that needs to be patched, and then to ``graft'' it onto packages | |
10206 | explicitly installed by the user and that were previously referring to | |
10207 | the original package. The cost of grafting is typically very low, and | |
10208 | order of magnitudes lower than a full rebuild of the dependency chain. | |
10209 | ||
10210 | @cindex replacements of packages, for grafts | |
10211 | For instance, suppose a security update needs to be applied to Bash. | |
10212 | Guix developers will provide a package definition for the ``fixed'' | |
10213 | Bash, say @var{bash-fixed}, in the usual way (@pxref{Defining | |
10214 | Packages}). Then, the original package definition is augmented with a | |
10215 | @code{replacement} field pointing to the package containing the bug fix: | |
10216 | ||
10217 | @example | |
10218 | (define bash | |
10219 | (package | |
10220 | (name "bash") | |
10221 | ;; @dots{} | |
10222 | (replacement bash-fixed))) | |
10223 | @end example | |
10224 | ||
10225 | From there on, any package depending directly or indirectly on Bash that | |
10226 | is installed will automatically be ``rewritten'' to refer to | |
10227 | @var{bash-fixed} instead of @var{bash}. This grafting process takes | |
10228 | time proportional to the size of the package, but expect less than a | |
10229 | minute for an ``average'' package on a recent machine. | |
10230 | ||
10231 | Currently, the graft and the package it replaces (@var{bash-fixed} and | |
10232 | @var{bash} in the example above) must have the exact same @code{name} | |
10233 | and @code{version} fields. This restriction mostly comes from the fact | |
10234 | that grafting works by patching files, including binary files, directly. | |
10235 | Other restrictions may apply: for instance, when adding a graft to a | |
10236 | package providing a shared library, the original shared library and its | |
10237 | replacement must have the same @code{SONAME} and be binary-compatible. | |
10238 | ||
10239 | ||
cf4a9129 LC |
10240 | @node Package Modules |
10241 | @section Package Modules | |
8451a568 | 10242 | |
cf4a9129 LC |
10243 | From a programming viewpoint, the package definitions of the |
10244 | GNU distribution are provided by Guile modules in the @code{(gnu packages | |
10245 | @dots{})} name space@footnote{Note that packages under the @code{(gnu | |
10246 | packages @dots{})} module name space are not necessarily ``GNU | |
10247 | packages''. This module naming scheme follows the usual Guile module | |
10248 | naming convention: @code{gnu} means that these modules are distributed | |
10249 | as part of the GNU system, and @code{packages} identifies modules that | |
10250 | define packages.} (@pxref{Modules, Guile modules,, guile, GNU Guile | |
10251 | Reference Manual}). For instance, the @code{(gnu packages emacs)} | |
10252 | module exports a variable named @code{emacs}, which is bound to a | |
10253 | @code{<package>} object (@pxref{Defining Packages}). | |
113daf62 | 10254 | |
300868ba | 10255 | The @code{(gnu packages @dots{})} module name space is |
cf4a9129 LC |
10256 | automatically scanned for packages by the command-line tools. For |
10257 | instance, when running @code{guix package -i emacs}, all the @code{(gnu | |
10258 | packages @dots{})} modules are scanned until one that exports a package | |
10259 | object whose name is @code{emacs} is found. This package search | |
10260 | facility is implemented in the @code{(gnu packages)} module. | |
113daf62 | 10261 | |
300868ba | 10262 | @cindex customization, of packages |
8689901f | 10263 | @cindex package module search path |
cf4a9129 | 10264 | Users can store package definitions in modules with different |
60142854 | 10265 | names---e.g., @code{(my-packages emacs)}@footnote{Note that the file |
c95ded7e LC |
10266 | name and module name must match. For instance, the @code{(my-packages |
10267 | emacs)} module must be stored in a @file{my-packages/emacs.scm} file | |
10268 | relative to the load path specified with @option{--load-path} or | |
10269 | @code{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, | |
10270 | guile, GNU Guile Reference Manual}, for details.}. These package definitions | |
300868ba LC |
10271 | will not be visible by default. Thus, users can invoke commands such as |
10272 | @command{guix package} and @command{guix build} have to be used with the | |
c95ded7e LC |
10273 | @code{-e} option so that they know where to find the package. Better |
10274 | yet, they can use the | |
300868ba | 10275 | @code{-L} option of these commands to make those modules visible |
8689901f LC |
10276 | (@pxref{Invoking guix build, @code{--load-path}}), or define the |
10277 | @code{GUIX_PACKAGE_PATH} environment variable. This environment | |
10278 | variable makes it easy to extend or customize the distribution and is | |
10279 | honored by all the user interfaces. | |
10280 | ||
10281 | @defvr {Environment Variable} GUIX_PACKAGE_PATH | |
10282 | This is a colon-separated list of directories to search for package | |
10283 | modules. Directories listed in this variable take precedence over the | |
10284 | distribution's own modules. | |
10285 | @end defvr | |
ef5dd60a | 10286 | |
cf4a9129 LC |
10287 | The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: |
10288 | each package is built based solely on other packages in the | |
10289 | distribution. The root of this dependency graph is a small set of | |
10290 | @dfn{bootstrap binaries}, provided by the @code{(gnu packages | |
10291 | bootstrap)} module. For more information on bootstrapping, | |
081145cf | 10292 | @pxref{Bootstrapping}. |
ef5dd60a | 10293 | |
cf4a9129 LC |
10294 | @node Packaging Guidelines |
10295 | @section Packaging Guidelines | |
ef5dd60a | 10296 | |
cf4a9129 LC |
10297 | The GNU distribution is nascent and may well lack some of your favorite |
10298 | packages. This section describes how you can help make the distribution | |
10299 | grow. @xref{Contributing}, for additional information on how you can | |
10300 | help. | |
ef5dd60a | 10301 | |
cf4a9129 LC |
10302 | Free software packages are usually distributed in the form of |
10303 | @dfn{source code tarballs}---typically @file{tar.gz} files that contain | |
10304 | all the source files. Adding a package to the distribution means | |
10305 | essentially two things: adding a @dfn{recipe} that describes how to | |
10306 | build the package, including a list of other packages required to build | |
f97c9175 | 10307 | it, and adding @dfn{package metadata} along with that recipe, such as a |
cf4a9129 | 10308 | description and licensing information. |
ef5dd60a | 10309 | |
cf4a9129 LC |
10310 | In Guix all this information is embodied in @dfn{package definitions}. |
10311 | Package definitions provide a high-level view of the package. They are | |
10312 | written using the syntax of the Scheme programming language; in fact, | |
10313 | for each package we define a variable bound to the package definition, | |
10314 | and export that variable from a module (@pxref{Package Modules}). | |
10315 | However, in-depth Scheme knowledge is @emph{not} a prerequisite for | |
10316 | creating packages. For more information on package definitions, | |
081145cf | 10317 | @pxref{Defining Packages}. |
ef5dd60a | 10318 | |
cf4a9129 LC |
10319 | Once a package definition is in place, stored in a file in the Guix |
10320 | source tree, it can be tested using the @command{guix build} command | |
10321 | (@pxref{Invoking guix build}). For example, assuming the new package is | |
c71979f4 LC |
10322 | called @code{gnew}, you may run this command from the Guix build tree |
10323 | (@pxref{Running Guix Before It Is Installed}): | |
ef5dd60a LC |
10324 | |
10325 | @example | |
cf4a9129 | 10326 | ./pre-inst-env guix build gnew --keep-failed |
ef5dd60a | 10327 | @end example |
ef5dd60a | 10328 | |
cf4a9129 LC |
10329 | Using @code{--keep-failed} makes it easier to debug build failures since |
10330 | it provides access to the failed build tree. Another useful | |
10331 | command-line option when debugging is @code{--log-file}, to access the | |
10332 | build log. | |
ef5dd60a | 10333 | |
cf4a9129 LC |
10334 | If the package is unknown to the @command{guix} command, it may be that |
10335 | the source file contains a syntax error, or lacks a @code{define-public} | |
10336 | clause to export the package variable. To figure it out, you may load | |
10337 | the module from Guile to get more information about the actual error: | |
ef5dd60a | 10338 | |
cf4a9129 LC |
10339 | @example |
10340 | ./pre-inst-env guile -c '(use-modules (gnu packages gnew))' | |
10341 | @end example | |
ef5dd60a | 10342 | |
cf4a9129 LC |
10343 | Once your package builds correctly, please send us a patch |
10344 | (@pxref{Contributing}). Well, if you need help, we will be happy to | |
10345 | help you too. Once the patch is committed in the Guix repository, the | |
10346 | new package automatically gets built on the supported platforms by | |
2b1cee21 | 10347 | @url{http://hydra.gnu.org/jobset/gnu/master, our continuous integration |
cf4a9129 | 10348 | system}. |
ef5dd60a | 10349 | |
cf4a9129 LC |
10350 | @cindex substituter |
10351 | Users can obtain the new package definition simply by running | |
10352 | @command{guix pull} (@pxref{Invoking guix pull}). When | |
10353 | @code{hydra.gnu.org} is done building the package, installing the | |
10354 | package automatically downloads binaries from there | |
10355 | (@pxref{Substitutes}). The only place where human intervention is | |
10356 | needed is to review and apply the patch. | |
ef5dd60a | 10357 | |
ef5dd60a | 10358 | |
cf4a9129 | 10359 | @menu |
ec0339cd LC |
10360 | * Software Freedom:: What may go into the distribution. |
10361 | * Package Naming:: What's in a name? | |
10362 | * Version Numbers:: When the name is not enough. | |
cbd02397 | 10363 | * Synopses and Descriptions:: Helping users find the right package. |
ec0339cd LC |
10364 | * Python Modules:: Taming the snake. |
10365 | * Perl Modules:: Little pearls. | |
10366 | * Fonts:: Fond of fonts. | |
cf4a9129 | 10367 | @end menu |
ef5dd60a | 10368 | |
cf4a9129 LC |
10369 | @node Software Freedom |
10370 | @subsection Software Freedom | |
ef5dd60a | 10371 | |
cf4a9129 | 10372 | @c Adapted from http://www.gnu.org/philosophy/philosophy.html. |
c11a6eb1 | 10373 | |
cf4a9129 LC |
10374 | The GNU operating system has been developed so that users can have |
10375 | freedom in their computing. GNU is @dfn{free software}, meaning that | |
10376 | users have the @url{http://www.gnu.org/philosophy/free-sw.html,four | |
10377 | essential freedoms}: to run the program, to study and change the program | |
10378 | in source code form, to redistribute exact copies, and to distribute | |
10379 | modified versions. Packages found in the GNU distribution provide only | |
10380 | software that conveys these four freedoms. | |
c11a6eb1 | 10381 | |
cf4a9129 LC |
10382 | In addition, the GNU distribution follow the |
10383 | @url{http://www.gnu.org/distros/free-system-distribution-guidelines.html,free | |
10384 | software distribution guidelines}. Among other things, these guidelines | |
10385 | reject non-free firmware, recommendations of non-free software, and | |
10386 | discuss ways to deal with trademarks and patents. | |
ef5dd60a | 10387 | |
cf4a9129 LC |
10388 | Some packages contain a small and optional subset that violates the |
10389 | above guidelines, for instance because this subset is itself non-free | |
10390 | code. When that happens, the offending items are removed with | |
10391 | appropriate patches or code snippets in the package definition's | |
10392 | @code{origin} form (@pxref{Defining Packages}). That way, @code{guix | |
10393 | build --source} returns the ``freed'' source rather than the unmodified | |
10394 | upstream source. | |
ef5dd60a | 10395 | |
ef5dd60a | 10396 | |
cf4a9129 LC |
10397 | @node Package Naming |
10398 | @subsection Package Naming | |
ef5dd60a | 10399 | |
cf4a9129 LC |
10400 | A package has actually two names associated with it: |
10401 | First, there is the name of the @emph{Scheme variable}, the one following | |
10402 | @code{define-public}. By this name, the package can be made known in the | |
10403 | Scheme code, for instance as input to another package. Second, there is | |
10404 | the string in the @code{name} field of a package definition. This name | |
10405 | is used by package management commands such as | |
10406 | @command{guix package} and @command{guix build}. | |
ef5dd60a | 10407 | |
cf4a9129 LC |
10408 | Both are usually the same and correspond to the lowercase conversion of |
10409 | the project name chosen upstream, with underscores replaced with | |
10410 | hyphens. For instance, GNUnet is available as @code{gnunet}, and | |
10411 | SDL_net as @code{sdl-net}. | |
927097ef | 10412 | |
cf4a9129 | 10413 | We do not add @code{lib} prefixes for library packages, unless these are |
081145cf | 10414 | already part of the official project name. But @pxref{Python |
cf4a9129 LC |
10415 | Modules} and @ref{Perl Modules} for special rules concerning modules for |
10416 | the Python and Perl languages. | |
927097ef | 10417 | |
1b366ee4 | 10418 | Font package names are handled differently, @pxref{Fonts}. |
7fec52b7 | 10419 | |
ef5dd60a | 10420 | |
cf4a9129 LC |
10421 | @node Version Numbers |
10422 | @subsection Version Numbers | |
ef5dd60a | 10423 | |
cf4a9129 LC |
10424 | We usually package only the latest version of a given free software |
10425 | project. But sometimes, for instance for incompatible library versions, | |
10426 | two (or more) versions of the same package are needed. These require | |
10427 | different Scheme variable names. We use the name as defined | |
10428 | in @ref{Package Naming} | |
10429 | for the most recent version; previous versions use the same name, suffixed | |
10430 | by @code{-} and the smallest prefix of the version number that may | |
10431 | distinguish the two versions. | |
ef5dd60a | 10432 | |
cf4a9129 LC |
10433 | The name inside the package definition is the same for all versions of a |
10434 | package and does not contain any version number. | |
ef5dd60a | 10435 | |
cf4a9129 | 10436 | For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows: |
ef5dd60a | 10437 | |
cf4a9129 LC |
10438 | @example |
10439 | (define-public gtk+ | |
10440 | (package | |
17d8e33f ML |
10441 | (name "gtk+") |
10442 | (version "3.9.12") | |
10443 | ...)) | |
cf4a9129 LC |
10444 | (define-public gtk+-2 |
10445 | (package | |
17d8e33f ML |
10446 | (name "gtk+") |
10447 | (version "2.24.20") | |
10448 | ...)) | |
cf4a9129 LC |
10449 | @end example |
10450 | If we also wanted GTK+ 3.8.2, this would be packaged as | |
10451 | @example | |
10452 | (define-public gtk+-3.8 | |
10453 | (package | |
17d8e33f ML |
10454 | (name "gtk+") |
10455 | (version "3.8.2") | |
10456 | ...)) | |
cf4a9129 | 10457 | @end example |
ef5dd60a | 10458 | |
880d647d LC |
10459 | @c See <https://lists.gnu.org/archive/html/guix-devel/2016-01/msg00425.html>, |
10460 | @c for a discussion of what follows. | |
10461 | @cindex version number, for VCS snapshots | |
10462 | Occasionally, we package snapshots of upstream's version control system | |
10463 | (VCS) instead of formal releases. This should remain exceptional, | |
10464 | because it is up to upstream developers to clarify what the stable | |
10465 | release is. Yet, it is sometimes necessary. So, what should we put in | |
10466 | the @code{version} field? | |
10467 | ||
10468 | Clearly, we need to make the commit identifier of the VCS snapshot | |
10469 | visible in the version string, but we also need to make sure that the | |
10470 | version string is monotonically increasing so that @command{guix package | |
10471 | --upgrade} can determine which version is newer. Since commit | |
10472 | identifiers, notably with Git, are not monotonically increasing, we add | |
10473 | a revision number that we increase each time we upgrade to a newer | |
10474 | snapshot. The resulting version string looks like this: | |
10475 | ||
10476 | @example | |
10477 | 2.0.11-3.cabba9e | |
10478 | ^ ^ ^ | |
10479 | | | `-- upstream commit ID | |
10480 | | | | |
10481 | | `--- Guix package revision | |
10482 | | | |
10483 | latest upstream version | |
10484 | @end example | |
10485 | ||
10486 | It is a good idea to strip commit identifiers in the @code{version} | |
10487 | field to, say, 7 digits. It avoids an aesthetic annoyance (assuming | |
10488 | aesthetics have a role to play here) as well as problems related to OS | |
10489 | limits such as the maximum shebang length (127 bytes for the Linux | |
10490 | kernel.) It is best to use the full commit identifiers in | |
561360a5 LC |
10491 | @code{origin}s, though, to avoid ambiguities. A typical package |
10492 | definition may look like this: | |
10493 | ||
10494 | @example | |
10495 | (define my-package | |
10496 | (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7")) | |
10497 | (package | |
10498 | (version (string-append "0.9-1." | |
10499 | (string-take commit 7))) | |
10500 | (source (origin | |
10501 | (method git-fetch) | |
10502 | (uri (git-reference | |
10503 | (url "git://example.org/my-package.git") | |
10504 | (commit commit))) | |
10505 | (sha256 (base32 "1mbikn@dots{}")) | |
10506 | (file-name (string-append "my-package-" version | |
10507 | "-checkout")))) | |
10508 | ;; @dots{} | |
10509 | ))) | |
10510 | @end example | |
880d647d | 10511 | |
cbd02397 LC |
10512 | @node Synopses and Descriptions |
10513 | @subsection Synopses and Descriptions | |
10514 | ||
10515 | As we have seen before, each package in GNU@tie{}Guix includes a | |
10516 | synopsis and a description (@pxref{Defining Packages}). Synopses and | |
10517 | descriptions are important: They are what @command{guix package | |
10518 | --search} searches, and a crucial piece of information to help users | |
10519 | determine whether a given package suits their needs. Consequently, | |
10520 | packagers should pay attention to what goes into them. | |
10521 | ||
10522 | Synopses must start with a capital letter and must not end with a | |
10523 | period. They must not start with ``a'' or ``the'', which usually does | |
10524 | not bring anything; for instance, prefer ``File-frobbing tool'' over ``A | |
10525 | tool that frobs files''. The synopsis should say what the package | |
10526 | is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is | |
10527 | used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines | |
10528 | matching a pattern''. | |
10529 | ||
10530 | Keep in mind that the synopsis must be meaningful for a very wide | |
10531 | audience. For example, ``Manipulate alignments in the SAM format'' | |
10532 | might make sense for a seasoned bioinformatics researcher, but might be | |
10533 | fairly unhelpful or even misleading to a non-specialized audience. It | |
10534 | is a good idea to come up with a synopsis that gives an idea of the | |
10535 | application domain of the package. In this example, this might give | |
10536 | something like ``Manipulate nucleotide sequence alignments'', which | |
10537 | hopefully gives the user a better idea of whether this is what they are | |
10538 | looking for. | |
10539 | ||
10540 | @cindex Texinfo markup, in package descriptions | |
10541 | Descriptions should take between five and ten lines. Use full | |
10542 | sentences, and avoid using acronyms without first introducing them. | |
10543 | Descriptions can include Texinfo markup, which is useful to introduce | |
10544 | ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or | |
ba7d6c76 ML |
10545 | hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you |
10546 | should be careful when using some characters for example @samp{@@} and | |
10547 | curly braces which are the basic special characters in Texinfo | |
10548 | (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces | |
10549 | such as @command{guix package --show} take care of rendering it | |
10550 | appropriately. | |
cbd02397 LC |
10551 | |
10552 | Synopses and descriptions are translated by volunteers | |
10553 | @uref{http://translationproject.org/domain/guix-packages.html, at the | |
10554 | Translation Project} so that as many users as possible can read them in | |
10555 | their native language. User interfaces search them and display them in | |
10556 | the language specified by the current locale. | |
10557 | ||
10558 | Translation is a lot of work so, as a packager, please pay even more | |
10559 | attention to your synopses and descriptions as every change may entail | |
ba7d6c76 | 10560 | additional work for translators. In order to help them, it is possible |
36743e71 | 10561 | to make recommendations or instructions visible to them by inserting |
ba7d6c76 ML |
10562 | special comments like this (@pxref{xgettext Invocation,,, gettext, GNU |
10563 | Gettext}): | |
10564 | ||
10565 | @example | |
10566 | ;; TRANSLATORS: "X11 resize-and-rotate" should not be translated. | |
10567 | (description "ARandR is designed to provide a simple visual front end | |
10568 | for the X11 resize-and-rotate (RandR) extension. @dots{}") | |
10569 | @end example | |
cbd02397 | 10570 | |
ef5dd60a | 10571 | |
cf4a9129 LC |
10572 | @node Python Modules |
10573 | @subsection Python Modules | |
ef5dd60a | 10574 | |
cf4a9129 LC |
10575 | We currently package Python 2 and Python 3, under the Scheme variable names |
10576 | @code{python-2} and @code{python} as explained in @ref{Version Numbers}. | |
10577 | To avoid confusion and naming clashes with other programming languages, it | |
10578 | seems desirable that the name of a package for a Python module contains | |
10579 | the word @code{python}. | |
ef5dd60a | 10580 | |
cf4a9129 LC |
10581 | Some modules are compatible with only one version of Python, others with both. |
10582 | If the package Foo compiles only with Python 3, we name it | |
10583 | @code{python-foo}; if it compiles only with Python 2, we name it | |
10584 | @code{python2-foo}. If it is compatible with both versions, we create two | |
10585 | packages with the corresponding names. | |
ef5dd60a | 10586 | |
cf4a9129 LC |
10587 | If a project already contains the word @code{python}, we drop this; |
10588 | for instance, the module python-dateutil is packaged under the names | |
10589 | @code{python-dateutil} and @code{python2-dateutil}. | |
113daf62 | 10590 | |
523e4896 | 10591 | |
cf4a9129 LC |
10592 | @node Perl Modules |
10593 | @subsection Perl Modules | |
523e4896 | 10594 | |
cf4a9129 LC |
10595 | Perl programs standing for themselves are named as any other package, |
10596 | using the lowercase upstream name. | |
10597 | For Perl packages containing a single class, we use the lowercase class name, | |
10598 | replace all occurrences of @code{::} by dashes and prepend the prefix | |
10599 | @code{perl-}. | |
10600 | So the class @code{XML::Parser} becomes @code{perl-xml-parser}. | |
10601 | Modules containing several classes keep their lowercase upstream name and | |
10602 | are also prepended by @code{perl-}. Such modules tend to have the word | |
10603 | @code{perl} somewhere in their name, which gets dropped in favor of the | |
10604 | prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}. | |
523e4896 | 10605 | |
523e4896 | 10606 | |
7fec52b7 AE |
10607 | @node Fonts |
10608 | @subsection Fonts | |
10609 | ||
10610 | For fonts that are in general not installed by a user for typesetting | |
10611 | purposes, or that are distributed as part of a larger software package, | |
10612 | we rely on the general packaging rules for software; for instance, this | |
10613 | applies to the fonts delivered as part of the X.Org system or fonts that | |
10614 | are part of TeX Live. | |
10615 | ||
10616 | To make it easier for a user to search for fonts, names for other packages | |
10617 | containing only fonts are constructed as follows, independently of the | |
10618 | upstream package name. | |
10619 | ||
10620 | The name of a package containing only one font family starts with | |
10621 | @code{font-}; it is followed by the foundry name and a dash @code{-} | |
10622 | if the foundry is known, and the font family name, in which spaces are | |
10623 | replaced by dashes (and as usual, all upper case letters are transformed | |
10624 | to lower case). | |
10625 | For example, the Gentium font family by SIL is packaged under the name | |
10626 | @code{font-sil-gentium}. | |
10627 | ||
10628 | For a package containing several font families, the name of the collection | |
10629 | is used in the place of the font family name. | |
10630 | For instance, the Liberation fonts consist of three families, | |
10631 | Liberation Sans, Liberation Serif and Liberation Mono. | |
10632 | These could be packaged separately under the names | |
10633 | @code{font-liberation-sans} and so on; but as they are distributed together | |
10634 | under a common name, we prefer to package them together as | |
10635 | @code{font-liberation}. | |
10636 | ||
10637 | In the case where several formats of the same font family or font collection | |
10638 | are packaged separately, a short form of the format, prepended by a dash, | |
10639 | is added to the package name. We use @code{-ttf} for TrueType fonts, | |
1b366ee4 | 10640 | @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 |
7fec52b7 AE |
10641 | fonts. |
10642 | ||
10643 | ||
b25937e3 | 10644 | |
cf4a9129 LC |
10645 | @node Bootstrapping |
10646 | @section Bootstrapping | |
b25937e3 | 10647 | |
cf4a9129 | 10648 | @c Adapted from the ELS 2013 paper. |
b25937e3 | 10649 | |
cf4a9129 | 10650 | @cindex bootstrapping |
7889394e | 10651 | |
cf4a9129 LC |
10652 | Bootstrapping in our context refers to how the distribution gets built |
10653 | ``from nothing''. Remember that the build environment of a derivation | |
10654 | contains nothing but its declared inputs (@pxref{Introduction}). So | |
10655 | there's an obvious chicken-and-egg problem: how does the first package | |
10656 | get built? How does the first compiler get compiled? Note that this is | |
10657 | a question of interest only to the curious hacker, not to the regular | |
10658 | user, so you can shamelessly skip this section if you consider yourself | |
10659 | a ``regular user''. | |
72b9d60d | 10660 | |
cf4a9129 LC |
10661 | @cindex bootstrap binaries |
10662 | The GNU system is primarily made of C code, with libc at its core. The | |
10663 | GNU build system itself assumes the availability of a Bourne shell and | |
10664 | command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and | |
10665 | `grep'. Furthermore, build programs---programs that run | |
10666 | @code{./configure}, @code{make}, etc.---are written in Guile Scheme | |
10667 | (@pxref{Derivations}). Consequently, to be able to build anything at | |
10668 | all, from scratch, Guix relies on pre-built binaries of Guile, GCC, | |
10669 | Binutils, libc, and the other packages mentioned above---the | |
10670 | @dfn{bootstrap binaries}. | |
72b9d60d | 10671 | |
cf4a9129 LC |
10672 | These bootstrap binaries are ``taken for granted'', though we can also |
10673 | re-create them if needed (more on that later). | |
72b9d60d | 10674 | |
cf4a9129 | 10675 | @unnumberedsubsec Preparing to Use the Bootstrap Binaries |
c79d54fe | 10676 | |
cf4a9129 LC |
10677 | @c As of Emacs 24.3, Info-mode displays the image, but since it's a |
10678 | @c large image, it's hard to scroll. Oh well. | |
10679 | @image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations} | |
523e4896 | 10680 | |
cf4a9129 LC |
10681 | The figure above shows the very beginning of the dependency graph of the |
10682 | distribution, corresponding to the package definitions of the @code{(gnu | |
d33fa0c7 LC |
10683 | packages bootstrap)} module. A similar figure can be generated with |
10684 | @command{guix graph} (@pxref{Invoking guix graph}), along the lines of: | |
10685 | ||
10686 | @example | |
10687 | guix graph -t derivation \ | |
10688 | -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \ | |
10689 | | dot -Tps > t.ps | |
10690 | @end example | |
10691 | ||
10692 | At this level of detail, things are | |
cf4a9129 LC |
10693 | slightly complex. First, Guile itself consists of an ELF executable, |
10694 | along with many source and compiled Scheme files that are dynamically | |
10695 | loaded when it runs. This gets stored in the @file{guile-2.0.7.tar.xz} | |
10696 | tarball shown in this graph. This tarball is part of Guix's ``source'' | |
10697 | distribution, and gets inserted into the store with @code{add-to-store} | |
10698 | (@pxref{The Store}). | |
2e7b5cea | 10699 | |
cf4a9129 LC |
10700 | But how do we write a derivation that unpacks this tarball and adds it |
10701 | to the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} | |
10702 | derivation---the first one that gets built---uses @code{bash} as its | |
10703 | builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls | |
10704 | @code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, | |
10705 | @file{xz}, and @file{mkdir} are statically-linked binaries, also part of | |
10706 | the Guix source distribution, whose sole purpose is to allow the Guile | |
10707 | tarball to be unpacked. | |
fb729425 | 10708 | |
cf4a9129 LC |
10709 | Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning |
10710 | Guile that can be used to run subsequent build programs. Its first task | |
10711 | is to download tarballs containing the other pre-built binaries---this | |
10712 | is what the @code{.tar.xz.drv} derivations do. Guix modules such as | |
10713 | @code{ftp-client.scm} are used for this purpose. The | |
10714 | @code{module-import.drv} derivations import those modules in a directory | |
10715 | in the store, using the original layout. The | |
10716 | @code{module-import-compiled.drv} derivations compile those modules, and | |
10717 | write them in an output directory with the right layout. This | |
10718 | corresponds to the @code{#:modules} argument of | |
10719 | @code{build-expression->derivation} (@pxref{Derivations}). | |
fb729425 | 10720 | |
cf4a9129 LC |
10721 | Finally, the various tarballs are unpacked by the |
10722 | derivations @code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, | |
10723 | etc., at which point we have a working C tool chain. | |
fb729425 | 10724 | |
fb729425 | 10725 | |
cf4a9129 | 10726 | @unnumberedsubsec Building the Build Tools |
523e4896 | 10727 | |
cf4a9129 LC |
10728 | Bootstrapping is complete when we have a full tool chain that does not |
10729 | depend on the pre-built bootstrap tools discussed above. This | |
10730 | no-dependency requirement is verified by checking whether the files of | |
10731 | the final tool chain contain references to the @file{/gnu/store} | |
10732 | directories of the bootstrap inputs. The process that leads to this | |
10733 | ``final'' tool chain is described by the package definitions found in | |
1f6f57df | 10734 | the @code{(gnu packages commencement)} module. |
df2ce343 | 10735 | |
d33fa0c7 LC |
10736 | The @command{guix graph} command allows us to ``zoom out'' compared to |
10737 | the graph above, by looking at the level of package objects instead of | |
10738 | individual derivations---remember that a package may translate to | |
10739 | several derivations, typically one derivation to download its source, | |
10740 | one to build the Guile modules it needs, and one to actually build the | |
10741 | package from source. The command: | |
10742 | ||
10743 | @example | |
10744 | guix graph -t bag \ | |
10745 | -e '(@@@@ (gnu packages commencement) | |
10746 | glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps | |
10747 | @end example | |
10748 | ||
10749 | @noindent | |
10750 | produces the dependency graph leading to the ``final'' C | |
10751 | library@footnote{You may notice the @code{glibc-intermediate} label, | |
10752 | suggesting that it is not @emph{quite} final, but as a good | |
10753 | approximation, we will consider it final.}, depicted below. | |
10754 | ||
10755 | @image{images/bootstrap-packages,6in,,Dependency graph of the early packages} | |
10756 | ||
cf4a9129 LC |
10757 | @c See <http://lists.gnu.org/archive/html/gnu-system-discuss/2012-10/msg00000.html>. |
10758 | The first tool that gets built with the bootstrap binaries is | |
d33fa0c7 LC |
10759 | GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite |
10760 | for all the following packages. From there Findutils and Diffutils get | |
10761 | built. | |
523e4896 | 10762 | |
cf4a9129 LC |
10763 | Then come the first-stage Binutils and GCC, built as pseudo cross |
10764 | tools---i.e., with @code{--target} equal to @code{--host}. They are | |
10765 | used to build libc. Thanks to this cross-build trick, this libc is | |
10766 | guaranteed not to hold any reference to the initial tool chain. | |
4af2447e | 10767 | |
d33fa0c7 LC |
10768 | From there the final Binutils and GCC (not shown above) are built. |
10769 | GCC uses @code{ld} | |
cf4a9129 LC |
10770 | from the final Binutils, and links programs against the just-built libc. |
10771 | This tool chain is used to build the other packages used by Guix and by | |
10772 | the GNU Build System: Guile, Bash, Coreutils, etc. | |
4af2447e | 10773 | |
cf4a9129 LC |
10774 | And voilà! At this point we have the complete set of build tools that |
10775 | the GNU Build System expects. These are in the @code{%final-inputs} | |
dd164244 MW |
10776 | variable of the @code{(gnu packages commencement)} module, and are |
10777 | implicitly used by any package that uses @code{gnu-build-system} | |
1f6f57df | 10778 | (@pxref{Build Systems, @code{gnu-build-system}}). |
4af2447e | 10779 | |
4af2447e | 10780 | |
cf4a9129 | 10781 | @unnumberedsubsec Building the Bootstrap Binaries |
4af2447e | 10782 | |
cf4a9129 LC |
10783 | Because the final tool chain does not depend on the bootstrap binaries, |
10784 | those rarely need to be updated. Nevertheless, it is useful to have an | |
10785 | automated way to produce them, should an update occur, and this is what | |
10786 | the @code{(gnu packages make-bootstrap)} module provides. | |
4af2447e | 10787 | |
cf4a9129 LC |
10788 | The following command builds the tarballs containing the bootstrap |
10789 | binaries (Guile, Binutils, GCC, libc, and a tarball containing a mixture | |
10790 | of Coreutils and other basic command-line tools): | |
4b2615e1 | 10791 | |
cf4a9129 LC |
10792 | @example |
10793 | guix build bootstrap-tarballs | |
10794 | @end example | |
10795 | ||
10796 | The generated tarballs are those that should be referred to in the | |
10797 | @code{(gnu packages bootstrap)} module mentioned at the beginning of | |
10798 | this section. | |
10799 | ||
10800 | Still here? Then perhaps by now you've started to wonder: when do we | |
10801 | reach a fixed point? That is an interesting question! The answer is | |
10802 | unknown, but if you would like to investigate further (and have | |
10803 | significant computational and storage resources to do so), then let us | |
10804 | know. | |
10805 | ||
10806 | @node Porting | |
10807 | @section Porting to a New Platform | |
10808 | ||
10809 | As discussed above, the GNU distribution is self-contained, and | |
10810 | self-containment is achieved by relying on pre-built ``bootstrap | |
10811 | binaries'' (@pxref{Bootstrapping}). These binaries are specific to an | |
10812 | operating system kernel, CPU architecture, and application binary | |
10813 | interface (ABI). Thus, to port the distribution to a platform that is | |
10814 | not yet supported, one must build those bootstrap binaries, and update | |
10815 | the @code{(gnu packages bootstrap)} module to use them on that platform. | |
10816 | ||
10817 | Fortunately, Guix can @emph{cross compile} those bootstrap binaries. | |
10818 | When everything goes well, and assuming the GNU tool chain supports the | |
10819 | target platform, this can be as simple as running a command like this | |
10820 | one: | |
10821 | ||
10822 | @example | |
10823 | guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs | |
10824 | @end example | |
10825 | ||
1c0c417d LC |
10826 | For this to work, the @code{glibc-dynamic-linker} procedure in |
10827 | @code{(gnu packages bootstrap)} must be augmented to return the right | |
10828 | file name for libc's dynamic linker on that platform; likewise, | |
10829 | @code{system->linux-architecture} in @code{(gnu packages linux)} must be | |
10830 | taught about the new platform. | |
10831 | ||
cf4a9129 | 10832 | Once these are built, the @code{(gnu packages bootstrap)} module needs |
1c0c417d LC |
10833 | to be updated to refer to these binaries on the target platform. That |
10834 | is, the hashes and URLs of the bootstrap tarballs for the new platform | |
10835 | must be added alongside those of the currently supported platforms. The | |
10836 | bootstrap Guile tarball is treated specially: it is expected to be | |
10837 | available locally, and @file{gnu-system.am} has rules do download it for | |
10838 | the supported architectures; a rule for the new platform must be added | |
10839 | as well. | |
cf4a9129 LC |
10840 | |
10841 | In practice, there may be some complications. First, it may be that the | |
10842 | extended GNU triplet that specifies an ABI (like the @code{eabi} suffix | |
10843 | above) is not recognized by all the GNU tools. Typically, glibc | |
10844 | recognizes some of these, whereas GCC uses an extra @code{--with-abi} | |
10845 | configure flag (see @code{gcc.scm} for examples of how to handle this). | |
10846 | Second, some of the required packages could fail to build for that | |
10847 | platform. Lastly, the generated binaries could be broken for some | |
10848 | reason. | |
4af2447e | 10849 | |
9bf3c1a7 | 10850 | @c ********************************************************************* |
8c01b9d0 | 10851 | @include contributing.texi |
c78bd12b | 10852 | |
568717fd LC |
10853 | @c ********************************************************************* |
10854 | @node Acknowledgments | |
10855 | @chapter Acknowledgments | |
10856 | ||
136787cb LC |
10857 | Guix is based on the @uref{http://nixos.org/nix/, Nix package manager}, |
10858 | which was designed and | |
4c7ac9aa LC |
10859 | implemented by Eelco Dolstra, with contributions from other people (see |
10860 | the @file{nix/AUTHORS} file in Guix.) Nix pioneered functional package | |
568717fd LC |
10861 | management, and promoted unprecedented features, such as transactional |
10862 | package upgrades and rollbacks, per-user profiles, and referentially | |
10863 | transparent build processes. Without this work, Guix would not exist. | |
10864 | ||
10865 | The Nix-based software distributions, Nixpkgs and NixOS, have also been | |
10866 | an inspiration for Guix. | |
10867 | ||
4c7ac9aa LC |
10868 | GNU@tie{}Guix itself is a collective work with contributions from a |
10869 | number of people. See the @file{AUTHORS} file in Guix for more | |
10870 | information on these fine people. The @file{THANKS} file lists people | |
10871 | who have helped by reporting bugs, taking care of the infrastructure, | |
10872 | providing artwork and themes, making suggestions, and more---thank you! | |
10873 | ||
10874 | ||
568717fd LC |
10875 | @c ********************************************************************* |
10876 | @node GNU Free Documentation License | |
10877 | @appendix GNU Free Documentation License | |
10878 | ||
10879 | @include fdl-1.3.texi | |
10880 | ||
10881 | @c ********************************************************************* | |
10882 | @node Concept Index | |
10883 | @unnumbered Concept Index | |
10884 | @printindex cp | |
10885 | ||
a85b83d2 LC |
10886 | @node Programming Index |
10887 | @unnumbered Programming Index | |
10888 | @syncodeindex tp fn | |
10889 | @syncodeindex vr fn | |
568717fd LC |
10890 | @printindex fn |
10891 | ||
10892 | @bye | |
10893 | ||
10894 | @c Local Variables: | |
10895 | @c ispell-local-dictionary: "american"; | |
10896 | @c End: |