diff options
| author | Julien Lepiller <julien@lepiller.eu> | 2018-11-01 12:28:31 +0100 |
|---|---|---|
| committer | Julien Lepiller <julien@lepiller.eu> | 2018-11-01 12:36:47 +0100 |
| commit | 1e40e70bfebba47ccea354ddf862276d2c4223ea (patch) | |
| tree | 51e246920a6155953bc9f3dc6b02dd02b4d47b04 | |
| parent | d7ca1899aa54ad02321e9ac1ff9de210ab9126b1 (diff) | |
| download | gnu-guix-1e40e70bfebba47ccea354ddf862276d2c4223ea.tar gnu-guix-1e40e70bfebba47ccea354ddf862276d2c4223ea.tar.gz | |
doc: Add German translation.
* doc/contributing.de.texi: New file.
* doc/guix.de.texi: New file
* doc/local.mk (TRANSLATED_INFO): Add them.
(info_TEXINFOS): Add guix.de.texi.
* po/doc/guix-manual.de.po: New file.
* po/doc/local.mk (EXTRA_DIST): Add it.
* doc/guix.texi: Document the German translation.
| -rw-r--r-- | doc/contributing.de.texi | 537 | ||||
| -rw-r--r-- | doc/guix.de.texi | 23978 | ||||
| -rw-r--r-- | doc/guix.texi | 5 | ||||
| -rw-r--r-- | doc/local.mk | 5 | ||||
| -rw-r--r-- | po/doc/guix-manual.de.po | 39797 | ||||
| -rw-r--r-- | po/doc/local.mk | 1 |
6 files changed, 64320 insertions, 3 deletions
diff --git a/doc/contributing.de.texi b/doc/contributing.de.texi new file mode 100644 index 0000000000..6c302ad70d --- /dev/null +++ b/doc/contributing.de.texi @@ -0,0 +1,537 @@ +@node Mitwirken +@chapter Mitwirken + +Dieses Projekt basiert auf Kooperation, daher benötigen wir Ihre Hilfe, um +es wachsen zu lassen! Bitte kontaktieren Sie uns auf +@email{guix-devel@@gnu.org} und @code{#guix} im Freenode-IRC-Netzwerk. Wir +freuen uns auf Ihre Ideen, Fehlerberichte, Patches und alles, was hilfreich +für das Projekt ist. Besonders willkommen ist Hilfe bei der Erstellung von +Paketen (@pxref{Paketrichtlinien}). + +@cindex Verhaltensregeln, für Mitwirkende +@cindex Verhaltenskodex für Mitwirkende +Wir möchten eine angenehme, freundliche und von Belästigungen freie Umgebung +bereitstellen, so dass jeder Beiträge nach seinen Fähigkeiten leisten +kann. Zu diesem Zweck verwendet unser Projekt einen »Verhaltenskodex für +Mitwirkende«, der von @url{http://contributor-covenant.org/} übernommen +wurde. Eine übersetzte Fassung finden Sie auf +@url{https://www.contributor-covenant.org/de/version/1/4/code-of-conduct} +sowie eine mitgelieferte, englische Fassung in der Datei +@file{CODE-OF-CONDUCT} im Quellbaum. + +Von Mitwirkenden wird nicht erwartet, dass sie in Patches oder in der +Online-Kommunikation ihre echten Namen preisgeben. Sie können einen +beliebigen Namen oder ein Pseudonym ihrer Wahl verwenden. + +@menu +* Erstellung aus dem Git:: Das Neueste und Beste. +* Guix vor der Installation ausführen:: Hacker-Tricks. +* Perfekt eingerichtet:: Die richtigen Werkzeuge. +* Code-Stil:: Wie Mitwirkende hygienisch arbeiten. +* Einreichen von Patches:: Teilen Sie Ihre Arbeit. +@end menu + +@node Erstellung aus dem Git +@section Erstellung aus dem Git + +Wenn Sie an Guix selbst hacken wollen, ist es empfehlenswert, dass Sie die +neueste Version aus dem Git-Softwarebestand verwenden: + +@example +git clone https://git.savannah.gnu.org/git/guix.git +@end example + +Wenn Sie Guix aus einem Checkout erstellen, sind außer den bereits in den +Installationsanweisungen genannten Paketen weitere nötig +(@pxref{Voraussetzungen}). + +@itemize +@item @url{http://gnu.org/software/autoconf/, GNU Autoconf}; +@item @url{http://gnu.org/software/automake/, GNU Automake}; +@item @url{http://gnu.org/software/gettext/, GNU Gettext}; +@item @url{http://gnu.org/software/texinfo/, GNU Texinfo}; +@item @url{http://www.graphviz.org/, Graphviz}; +@item @url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}. +@end itemize + +Der einfachste Weg, eine Entwicklungsumgebung für Guix einzurichten, ist +natürlich, Guix zu benutzen! Der folgende Befehl startet eine neue Shell, in +der alle Abhängigkeiten und Umgebungsvariablen bereits eingerichtet sind, um +an Guix zu arbeiten: + +@example +guix environment guix +@end example + +In @xref{Aufruf von guix environment} finden Sie weitere Informationen zu +diesem Befehl. Zusätzliche Abhängigkeiten können mit @option{--ad-hoc} +hinzugefügt werden: + +@example +guix environment guix --ad-hoc help2man git strace +@end example + +Führen Sie @command{./bootstrap} aus, um die Infrastruktur des +Erstellungssystems mit Autoconf und Automake zu erstellen. Möglicherweise +erhalten Sie eine Fehlermeldung wie diese: + +@example +configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES +@end example + +@noindent +Das bedeutet wahrscheinlich, dass Autoconf @file{pkg.m4} nicht finden +konnte, welches von pkg-config bereitgestellt wird. Stellen Sie sicher, dass +@file{pkg.m4} verfügbar ist. Gleiches gilt für den von Guile +bereitgestellten Makrosatz @file{guile.m4}. Wenn Sie beispielsweise Automake +in @file{/usr/local} installiert haben, würde in @file{/usr/share} nicht +nach @file{.m4}-Dateien geschaut. In einem solchen Fall müssen Sie folgenden +Befehl aufrufen: + +@example +export ACLOCAL_PATH=/usr/share/aclocal +@end example + +In @xref{Macro Search Path,,, automake, The GNU Automake Manual} finden Sie +weitere Informationen. + +Dann führen Sie wie gewohnt @command{./configure} aus. Achten Sie darauf, +@code{--localstatedir=@var{Verzeichnis}} zu übergeben, wobei +@var{Verzeichnis} der von Ihrer aktuellen Installation verwendete +@code{localstatedir}-Wert ist (weitere Informationen auf @pxref{Der Store}). + +Zum Schluss müssen Sie @code{make check} aufrufen, um die Tests auszuführen +(@pxref{Die Testsuite laufen lassen}). Falls etwas fehlschlägt, werfen Sie einen +Blick auf die Installationsanweisungen (@pxref{Installation}) oder senden +Sie eine E-Mail an @email{guix-devel@@gnu.org, Mailingliste}. + + +@node Guix vor der Installation ausführen +@section Guix vor der Installation ausführen + +Um eine gesunde Arbeitsumgebung zu behalten, ist es hilfreich, die im +lokalen Quellbaum vorgenommenen Änderungen zunächst zu testen, ohne sie +tatsächlich zu installieren. So können Sie zwischen Ihrem +Endnutzer-»Straßenanzug« und Ihrem »Faschingskostüm« unterscheiden. + +To that end, all the command-line tools can be used even if you have not run +@code{make install}. To do that, you first need to have an environment with +all the dependencies available (@pxref{Erstellung aus dem Git}), and then simply +prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} +script lives in the top build tree of Guix), as in@footnote{The @option{-E} +flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly +set such that @command{guix-daemon} and the tools it uses can find the Guile +modules they need.}: + +@example +$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild +$ ./pre-inst-env guix build hello +@end example + +@noindent +Entsprechend, um eine Guile-Sitzung zu öffnen, die die Guix-Module benutzt: + +@example +$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))' + +;;; ("x86_64-linux") +@end example + +@noindent +@cindex REPL +@cindex Lese-Auswerten-Schreiben-Schleife +@dots{} und auf einer REPL (@pxref{Using Guile Interactively,,, guile, Guile +Reference Manual}): + +@example +$ ./pre-inst-env guile +scheme@@(guile-user)> ,use(guix) +scheme@@(guile-user)> ,use(gnu) +scheme@@(guile-user)> (define snakes + (fold-packages + (lambda (package lst) + (if (string-prefix? "python" + (package-name package)) + (cons package lst) + lst)) + '())) +scheme@@(guile-user)> (length snakes) +$1 = 361 +@end example + +Das @command{pre-inst-env}-Skript richtet alle Umgebungsvariablen ein, die +nötig sind, um dies zu ermöglichen, einschließlich @env{PATH} und +@env{GUILE_LOAD_PATH}. + +Beachten Sie, dass @command{./pre-inst-env guix pull} den lokalen Quellbaum +@emph{nicht} aktualisiert; es aktualisiert lediglich die symbolische +Verknüpfung @file{~/.config/guix/current} (@pxref{Aufruf von guix pull}). Um +Ihren lokalen Quellbaum zu aktualisieren, müssen Sie stattdessen +@command{git pull} benutzen. + + +@node Perfekt eingerichtet +@section Perfekt eingerichtet + +Um perfekt für das Hacken an Guix eingerichtet zu sein, brauchen Sie an sich +dasselbe wie um perfekt für das Hacken mit Guile (@pxref{Using Guile in +Emacs,,, guile, Guile Reference Manual}). Zunächst brauchen Sie mehr als +ein Textverarbeitungsprogramm, Sie brauchen +@url{http://www.gnu.org/software/emacs, Emacs}, ermächtigt vom wunderbaren +@url{http://nongnu.org/geiser/, Geiser}. + +Geiser ermöglicht interaktive und inkrementelle Entwicklung aus Emacs +heraus: Code kann in Puffern kompiliert und ausgewertet werden. Zugang zu +Online-Dokumentation (Docstrings) steht ebenso zur Verfügung wie +kontextabhängige Vervollständigung, @kbd{M-.} um zu einer Objektdefinition +zu springen, eine REPL, um Ihren Code auszuprobieren, und mehr +(@pxref{Einführung,,, geiser, Geiser User Manual}). Zur bequemen +Guix-Entwicklung sollten Sie Guiles Ladepfad so ergänzen, dass die +Quelldateien in Ihrem Checkout gefunden werden. + +@lisp +;; @r{Angenommen das Guix-Checkout ist in ~/src/guix.} +(with-eval-after-load 'geiser-guile + (add-to-list 'geiser-guile-load-path "~/src/guix")) +@end lisp + +Um den Code tatsächlich zu bearbeiten, bietet Emacs schon einen netten +Scheme-Modus. Aber Sie dürfen auch +@url{http://www.emacswiki.org/emacs/ParEdit, Paredit} nicht verpassen. Es +bietet Hilfsmittel, um direkt mit dem Syntaxbaum zu arbeiten, und kann so +zum Beispiel einen S-Ausdruck hochheben oder ihn umhüllen, ihn verschlucken +oder den nachfolgenden S-Ausdruck verwerfen, etc. + +@cindex Code-Schnipsel +@cindex Vorlagen +@cindex Tipparbeit sparen +Wir bieten auch Vorlagen für häufige Git-Commit-Nachrichten und +Paketdefinitionen im Verzeichnis @file{etc/snippets}. Diese Vorlagen können +mit @url{http://joaotavora.github.io/yasnippet/, YASnippet} zusammen benutzt +werden, um kurze Auslöse-Zeichenketten zu interaktiven Textschnipseln +umzuschreiben. Vielleicht möchten Sie das Schnipselverzeichnis zu Ihrer +@var{yas-snippet-dirs}-Variablen in Emacs hinzufügen. + +@lisp +;; @r{Angenommen das Guix-Checkout ist in ~/src/guix.} +(with-eval-after-load 'yasnippet + (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets")) +@end lisp + +The commit message snippets depend on @url{https://magit.vc/, Magit} to +display staged files. When editing a commit message type @code{add} +followed by @kbd{TAB} to insert a commit message template for adding a +package; type @code{update} followed by @kbd{TAB} to insert a template for +updating a package; type @code{https} followed by @kbd{TAB} to insert a +template for changing the home page URI of a package to HTTPS. + +Das Hauptschnipsel für @code{scheme-mode} wird ausgelöst, indem Sie +@code{package...} gefolgt von @kbd{TAB} eintippen. Dieses Snippet fügt auch +die Auslöse-Zeichenkette @code{origin...} ein, die danach weiter +umgeschrieben werden kann. Das @code{origin}-Schnipsel kann wiederum andere +Auslöse-Zeichenketten einfügen, die alle auf @code{...} enden, was selbst +wieder weiter umgeschrieben werden kann. + + +@node Code-Stil +@section Code-Stil + +Im Allgemeinen folgt unser Code den GNU Coding Standards (@pxref{Top,,, +standards, GNU Coding Standards}). Da diese aber nicht viel über Scheme zu +sagen haben, folgen hier einige zusätzliche Regeln. + +@menu +* Programmierparadigmen:: Wie Sie Ihre Elemente zusammenstellen. +* Module:: Wo Sie Ihren Code unterbringen. +* Datentypen und Mustervergleich:: Implementierung von Datenstrukturen. +* Formatierung von Code:: Schreibkonventionen. +@end menu + +@node Programmierparadigmen +@subsection Programmierparadigmen + +Scheme-Code wird in Guix auf rein funktionale Weise geschrieben. Eine +Ausnahme ist Code, der mit Ein- und Ausgabe zu tun hat, und Prozeduren, die +grundlegende Konzepte implementieren, wie zum Beispiel die Prozedur +@code{memoize}. + +@node Module +@subsection Module + +Guile-Module, die beim Erstellen nutzbar sein sollen, müssen im Namensraum +@code{(guix build @dots{})} leben. Sie dürfen auf keine anderen Guix- oder +GNU-Modules Bezug nehmen. Jedoch ist es in Ordnung, wenn ein »wirtsseitiges« +Modul ein erstellungsseitiges Modul benutzt. + +Module, die mit dem weiteren GNU-System zu tun haben, sollten im Namensraum +@code{(gnu @dots{})} und nicht in @code{(guix @dots{})} stehen. + +@node Datentypen und Mustervergleich +@subsection Datentypen und Mustervergleich + +Im klassischen Lisp gibt es die Tendenz, Listen zur Darstellung von allem zu +benutzen, und diese dann »händisch« zu durchlaufen mit @code{car}, +@code{cdr}, @code{cadr} und so weiter. Dieser Stil ist aus verschiedenen +Gründen problematisch, insbesondere wegen der Tatsache, dass er schwer zu +lesen, schnell fehlerbehaftet und ein Hindernis beim Melden von Typfehlern +ist. + +Guix-Code sollte angemessene Datentypen definieren (zum Beispiel mit +@code{define-record-type*}) statt Listen zu missbrauchen. Außerdem sollte er +das @code{(ice-9 match)}-Modul von Guile zum Mustervergleich benutzen, +besonders mit Listen. + +@node Formatierung von Code +@subsection Formatierung von Code + +@cindex Formatierung von Code +@cindex Code-Stil +Beim Schreiben von Scheme-Code halten wir uns an die üblichen +Gepflogenheiten unter Scheme-Programmierern. Im Allgemeinen bedeutet das, +dass wir uns an @url{http://mumble.net/~campbell/scheme/style.txt, +Riastradh's Lisp Style Rules} halten. Es hat sich ergeben, dass dieses +Dokument auch die Konventionen beschreibt, die im Code von Guile +hauptsächlich verwendet werden. Es ist gut durchdacht und schön geschrieben, +also lesen Sie es bitte. + +Ein paar in Guix eingeführte Sonderformen, wie zum Beispiel das +@code{substitute*}-Makro, haben abweichende Regeln für die Einrückung. Diese +sind in der Datei @file{.dir-locals.el} definiert, die Emacs automatisch +benutzt. Beachten Sie auch, dass Emacs-Guix einen Modus namens +@code{guix-devel-mode} bereitstellt, der Guix-Code richtig einrückt und +hervorhebt (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference +Manual}). + +@cindex Einrückung, Code- +@cindex Formatierung, Code- +Falls Sie nicht Emacs verwenden, sollten Sie sicherstellen, dass Ihr Editor +diese Regeln kennt. Um eine Paketdefinition automatisch einzurücken, können +Sie auch Folgendes ausführen: + +@example +./etc/indent-code.el gnu/packages/@var{Datei}.scm @var{Paket} +@end example + +@noindent +Dadurch wird die Definition von @var{Paket} in +@file{gnu/packages/@var{Datei}.scm} automatisch eingerückt, indem Emacs im +Batch-Modus läuft. Um die Einrückung in einer gesamten Datei vorzunehmen, +lassen Sie das zweite Argument weg: + +@example +./etc/indent-code.el gnu/services/@var{Datei}.scm +@end example + +@cindex Vim, zum Editieren von Scheme-Code +Wenn Sie mit Code mit Vim bearbeiten, empfehlen wir, dass Sie @code{:set +autoindent} ausführen, damit Ihr Code automatisch eingerückt wird, während +Sie ihn schreiben. Außerdem könnte Ihnen +@uref{https://www.vim.org/scripts/script.php?script_id=3998, +@code{paredit.vim}} dabei helfen, mit all diesen Klammern fertigzuwerden. + +Wir fordern von allen Prozeduren auf oberster Ebene, dass sie über einen +Docstring verfügen. Diese Voraussetzung kann jedoch bei einfachen, privaten +Prozeduren im Namensraum @code{(guix build @dots{})} aufgeweicht werden. + +Prozeduren sollten nicht mehr als vier positionsbestimmte Parameter +haben. Benutzen Sie Schlüsselwort-Parameter für Prozeduren, die mehr als +vier Parameter entgegennehmen. + + +@node Einreichen von Patches +@section Einreichen von Patches + +Die Entwicklung wird mit Hilfe des verteilten Versionskontrollsystems Git +durchgeführt. Daher ist eine ständige Verbindung zum Repository nicht +unbedingt erforderlich. Wir begrüßen Beiträge in Form von Patches, die +mittels @code{git format-patch} erstellt und an die Mailingliste +@email{guix-patches@@gnu.org} geschickt werden. + +Diese Mailing-Liste setzt auf einer Debbugs-Instanz auf, die zugänglich ist +unter @uref{https://bugs.gnu.org/guix-patches}, wodurch wir den Überblick +über Eingereichtes behalten können. Jede an diese Mailing-Liste gesendete +Nachricht bekommt eine neue Folgenummer zugewiesen, so dass man eine +Folge-Email zur Einreichung an @code{@var{NNN}@@debbugs.gnu.org} senden +kann, wobei @var{NNN} für die Folgenummer steht (@pxref{Senden einer Patch-Reihe}). + +Bitte schreiben Sie Commit-Logs im ChangeLog-Format (@pxref{Change Logs,,, +standards, GNU Coding Standards}); dazu finden Sie Beispiele unter den +bisherigen Commits. + +Bevor Sie einen Patch einreichen, der eine Paketdefinition hinzufügt oder +verändert, gehen Sie bitte diese Prüfliste: + +@enumerate +@item +Wenn die Autoren der verpackten Software eine kryptographische Signatur für +den Tarball der Veröffentlichung anbieten, so machen Sie sich bitte die +Mühe, die Echtheit des Archivs zu überprüfen. Für eine abgetrennte +GPG-Signaturdatei würden Sie das mit dem Befehl @code{gpg --verify} tun. + +@item +Nehmen Sie sich die Zeit, eine passende Zusammenfassung und Beschreibung für +das Paket zu verfassen. Unter @xref{Zusammenfassungen und Beschreibungen} finden Sie +dazu einige Richtlinien. + +@item +Verwenden Sie @code{guix lint @var{Paket}}, wobei @var{Paket} das neue oder +geänderte Paket bezeichnet, und beheben Sie alle gemeldeten Fehler +(@pxref{Aufruf von guix lint}). + +@item +Stellen Sie sicher, dass das Paket auf Ihrer Plattform erstellt werden kann, +indem Sie @code{guix build @var{Paket}} ausführen. + +@item +@cindex gebündelt +Achten Sie darauf, dass im Paket keine Software gebündelt mitgeliefert wird, +die bereits in separaten Paketen zur Verfügung steht. + +Manchmal enthalten Pakete Kopien des Quellcodes ihrer Abhängigkeiten, um +Nutzern die Installation zu erleichtern. Als eine Distribution wollen wir +jedoch sicherstellen, dass für solche Pakete die schon in der Distribution +verfügbare Fassung benutzen, sofern es eine gibt. Dadurch wird sowohl der +Ressourcenverbrauch optimiert (die Abhängigkeit wird so nur einmal erstellt +und gespeichert) als auch der Distribution die Möglichkeit gegeben, +ergänzende Änderungen durchzuführen, um beispielsweise +Sicherheitsaktualisierungen für ein bestimmtes Paket an nur einem Ort +einzuspielen, die das gesamte System betreffen — gebündelt mitgelieferte +Kopien würden dies verhindern. + +@item +Schauen Sie sich das von @command{guix size} ausgegebene Profil an +(@pxref{Aufruf von guix size}). Dadurch können Sie Referenzen auf andere +Pakete finden, die ungewollt vorhanden sind. Dies kann auch dabei helfen, zu +entscheiden, ob das Paket aufgespalten werden sollte (@pxref{Pakete mit mehreren Ausgaben.}) und welche optionalen Abhängigkeiten verwendet werden +sollten. + +@item +Achten Sie bei wichtigen Änderungen darauf, dass abhängige Pakete (falls +vorhanden) nicht von der Änderung beeinträchtigt werden; @code{guix refresh +--list-dependent @var{Paket}} hilft Ihnen dabei (@pxref{Aufruf von guix refresh}). + +@c =========================================================================== +@c +@c This file was generated with po4a. Translate the source file. +@c +@c =========================================================================== +@c See <https://lists.gnu.org/archive/html/guix-devel/2016-10/msg00933.html>. +@cindex Branching-Strategie +@cindex Neuerstellungs-Zeitplan +Je nachdem, wieviele abhängige Pakete es gibt, und entsprechend wieviele +Neuerstellungen dadurch nötig würden, finden Commits auf anderen Branches +statt, nach ungefähr diesen Regeln: + +@table @asis +@item 300 abhängige Pakete oder weniger +@code{master}-Branch (störfreie Änderungen). + +@item zwischen 300 und 1200 abhängige Pakete +@code{staging}-Branch (störfreie Änderungen). Dieser Branch wird circa alle +3 Wochen in @code{master} gemerget. Themenbezogene Änderungen (z.B. eine +Aktualisierung der GNOME-Plattform) können stattdessen auch auf einem +eigenen Branch umgesetzt werden (wie @code{gnome-updates}). + +@item mehr als 1200 abhängige Pakete +@code{core-updates}-Branch (kann auch größere und womöglich andere Software +beeinträchtigende Änderungen umfassen). Dieser Branch wird planmäßig in +@code{master} alle 2,5 Monate oder so gemerget. +@end table + +All diese Branches werden kontinuierlich +@uref{https://hydra.gnu.org/project/gnu, auf unserer Build-Farm} erstellt +und in @code{master} gemerget, sobald alles erfolgreich erstellt worden +ist. Dadurch können wir Probleme beheben, bevor sie bei Nutzern auftreten, +und zudem das Zeitfenster, während dessen noch keine vorerstellten +Binärdateien verfügbar sind, verkürzen. + +@c TODO: It would be good with badges on the website that tracks these +@c branches. Or maybe even a status page. +Im Allgemeinen werden Branches außer @code{master} als @emph{unveränderlich} +angesehen, wenn sie kürzlich ausgewertet wurden oder ein entsprechender +@code{-next}-Branch existiert. Bitte fragen Sie auf der Mailing-Liste oder +IRC, wenn Sie sich nicht sicher sind, wo ein Patch eingespielt werden +sollte. + +@item +@cindex Determinismus, von Erstellungsprozessen +@cindex Reproduzierbare Erstellungen, Überprüfung +Überprüfen Sie, ob der Erstellungsprozess deterministisch ist. Dazu prüfen +Sie typischerweise, ob eine unabhängige Erstellung des Pakets genau dasselbe +Ergebnis wie Ihre Erstellung hat, Bit für Bit. + +Dies können Sie leicht tun, indem Sie dasselbe Paket mehrere Male +hintereinander auf Ihrer Maschine erstellen (@pxref{Aufruf von guix build}): + +@example +guix build --rounds=2 mein-paket +@end example + +Dies reicht aus, um eine ganze Klasse häufiger Ursachen von +Nichtdeterminismus zu finden, wie zum Beispiel Zeitstempel oder +zufallsgenerierte Ausgaben im Ergebnis der Erstellung. + +Eine weitere Möglichkeit ist, @command{guix challenge} (@pxref{Aufruf von guix challenge}) zu benutzen. Sie können es ausführen, sobald ein Paket commitet +und von @code{hydra.gnu.org} erstellt wurde, um zu sehen, ob dort dasselbe +Ergebnis wie bei Ihnen geliefert wurde. Noch besser: Finden Sie eine andere +Maschine, die das Paket erstellen kann, und führen Sie @command{guix +publish} aus. Da sich die entfernte Erstellungsmaschine wahrscheinlich von +Ihrer unterscheidet, können Sie auf diese Weise Probleme durch +Nichtdeterminismus erkennen, die mit der Hardware zu tun haben — zum +Beispiel die Nutzung anderer Befehlssatzerweiterungen — oder mit dem +Betriebssystem-Kernel — zum Beispiel, indem @code{uname} oder +@file{/proc}-Dateien verwendet werden. + +@item +Beim Schreiben von Dokumentation achten Sie bitte auf eine +geschlechtsneutrale Wortwahl, wenn Sie sich auf Personen beziehen, wie +@uref{https://en.wikipedia.org/wiki/Singular_they, »they«@comma{} +»their«@comma{} »them« im Singular}, und so weiter. + +@item +Stelllen Sie sicher, dass Ihr Patch nur einen Satz zusammengehöriger +Änderungen umfasst. Das Zusammenfassen nicht zusammengehöriger Änderungen +erschwert und bremst das Durchsehen Ihres Patches. + +Beispiele für nicht zusammengehörige Änderungen sind das Hinzufügen mehrerer +Pakete auf einmal, oder das Aktualisieren eines Pakets auf eine neue Version +zusammen mit Fehlerbehebungen für das Paket. + +@item +Bitte befolgen Sie unsere Richtlinien für die Code-Formatierung, womöglich +wollen Sie dies automatisch tun lassen durch das Skript +@command{etc/indent-code.el} (@pxref{Formatierung von Code}). + +@item +When possible, use mirrors in the source URL (@pxref{Aufruf von guix download}). Use reliable URLs, not generated ones. For instance, GitHub +archives are not necessarily identical from one generation to the next, so +in this case it's often better to clone the repository. Don't use the +@command{name} field in the URL: it is not very useful and if the name +changes, the URL will probably be wrong. + +@end enumerate + +Bitte benutzen Sie @samp{[PATCH] @dots{}} als Betreff, wenn Sie einen Patch +an die Mailing-Liste schicken. Sie können dazu Ihr E-mail-Programm oder den +Befehl @command{git send-email} benutzen (@pxref{Senden einer Patch-Reihe}). Wir bevorzugen es, Patches als reine Textnachrichten zu erhalten, +entweder eingebettet (inline) oder als MIME-Anhänge. Sie sind dazu +angehalten, zu überprüfen, ob Ihr Mail-Programm solche Dinge wie +Zeilenumbrüche oder die Einrückung verändert, wodurch die Patches womöglich +nicht mehr funktionieren. + +Wenn dadurch ein Fehler behoben wurde, schließen Sie bitte den Thread, indem +Sie eine E-mail an @email{@var{NNN}-done@@debbugs.gnu.org} senden. + +@unnumberedsubsec Senden einer Patch-Reihe +@anchor{Senden einer Patch-Reihe} +@cindex Patch-Reihe +@cindex @code{git send-email} +@cindex @code{git-send-email} + +@c Debbugs bug: https://debbugs.gnu.org/db/15/15361.html +Wenn Sie eine Patch-Reihe senden (z.B. mit @code{git send-email}), schicken +Sie bitte als Erstes eine Nachricht an @email{guix-patches@@gnu.org} und +dann nachfolgende Patches an @email{@var{NNN}@@debbugs.gnu.org}, um +sicherzustellen, dass sie zusammen bearbeitet werden. Siehe +@uref{https://debbugs.gnu.org/Advanced.html, die Debbugs-Dokumentation} für +weitere Informationen. diff --git a/doc/guix.de.texi b/doc/guix.de.texi new file mode 100644 index 0000000000..e2138db864 --- /dev/null +++ b/doc/guix.de.texi @@ -0,0 +1,23978 @@ +\input texinfo +@c =========================================================================== +@c +@c This file was generated with po4a. Translate the source file. +@c +@c =========================================================================== +@c -*-texinfo-*- + +@c %**start of header +@setfilename guix.de.info +@documentencoding UTF-8 +@documentlanguage de +@frenchspacing on +@settitle Referenzhandbuch zu GNU Guix +@c %**end of header + +@include version-de.texi + +@c Identifier of the OpenPGP key used to sign tarballs and such. +@set OPENPGP-SIGNING-KEY-ID 3CE464558A84FDC69DB40CFB090B11993D9AEBB5 + +@copying +Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic +Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright +@copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, +2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* +Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} +2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 +Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo +Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} +2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 +Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright +@copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017, +2018 Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* +Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, +2018 Clément Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* +Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, +2018 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* +Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 +Christopher Allan Webber@* Copyright @copyright{} 2017, 2018 Marius Bakke@* +Copyright @copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 +Maxim Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* +Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 +Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright +@copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* +Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike +Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright +@copyright{} 2018 Gábor Boskovits@* Copyright @copyright{} 2018 Florian +Pelz@* + +Es ist Ihnen gestattet, dieses Dokument zu vervielfältigen, weiterzugeben +und/oder zu verändern, unter den Bedingungen der GNU Free Documentation +License, entweder gemäß Version 1.3 der Lizenz oder (nach Ihrer Option) +einer späteren Version, die von der Free Software Foundation veröffentlicht +wurde, ohne unveränderliche Abschnitte, ohne vorderen Umschlagtext und ohne +hinteren Umschlagtext. Eine Kopie der Lizenz finden Sie im Abschnitt mit dem +Titel »GNU Free Documentation License«. +@end copying + +@dircategory Systemadministration +@direntry +* Guix: (guix.de). Installierte Software und Systemkonfigurationen + verwalten. +* guix package: (guix.de)guix package aufrufen. Pakete installieren, + entfernen und + aktualisieren. +* guix gc: (guix.de)guix gc aufrufen. Unbenutzten Plattenspeicher wieder + freigeben. +* guix pull: (guix.de)guix pull aufrufen. Die Liste verfügbarer Pakete + aktualisieren. +* guix system: (guix.de)guix system aufrufen. Die + Betriebssystemkonfiguration + verwalten. +@end direntry + +@dircategory Softwareentwicklung +@direntry +* guix environment: (guix.de)guix environment aufrufen. Umgebungen für + Entwickler + erstellen +* guix build: (guix.de)guix build aufrufen. Erstellen von Paketen. +* guix pack: (guix.de)guix pack aufrufen. Bündel aus Binärdateien + erstellen. +@end direntry + +@titlepage +@title Referenzhandbuch zu GNU Guix +@subtitle Den funktionalen Paketmanager GNU Guix benutzen +@author Die GNU-Guix-Entwickler + +@page +@vskip 0pt plus 1filll +Edition @value{EDITION} @* @value{UPDATED} @* + +@insertcopying +@end titlepage + +@contents + +@c ********************************************************************* +@node Top +@top GNU Guix + +Dieses Dokument beschreibt GNU Guix, Version @value{VERSION}, ein +funktionales Paketverwaltungswerkzeug, das für das GNU-System geschrieben +wurde. + +@c TRANSLATORS: You can replace the following paragraph with information on +@c how to join your own translation team and how to report issues with the +@c translation. +This manual is also available in French (@pxref{Top,,, guix.fr, Manuel de +référence de GNU Guix}). If you would like to translate it in your native +language, consider joining the +@uref{https://translationproject.org/domain/guix-manual.html, Translation +Project}. + +@menu +* Einführung:: Was ist Guix überhaupt? +* Installation:: Guix installieren. +* Paketverwaltung:: Pakete installieren, aktualisieren usw. +* Programmierschnittstelle:: Guix in Scheme verwenden. +* Zubehör:: Befehle zur Paketverwaltung. +* GNU-Distribution:: Software für Ihr freundliches GNU-System. +* Mitwirken:: Ihre Hilfe ist nötig! + +* Danksagungen:: Danke! +* GNU-Lizenz für freie Dokumentation:: Die Lizenz dieses Handbuchs. +* Konzeptverzeichnis:: Konzepte. +* Programmierverzeichnis:: Datentypen, Funktionen und Variable. + +@detailmenu + --- Detaillierte Liste der Knoten --- + + + +Installation + + + +* Aus Binärdatei installieren:: Guix installieren, ohne Zeit zu verlieren! +* Voraussetzungen:: Zum Erstellen und Benutzen von Guix nötige + Software. +* Die Testsuite laufen lassen:: Guix testen. +* Den Daemon einrichten:: Wie man die Umgebung des Erstellungs-Daemons + einrichtet. +* Aufruf des guix-daemon:: Den Erstellungs-Daemon laufen lassen. +* Anwendungen einrichten:: Anwendungsspezifische Einstellungen. + +Den Daemon einrichten + + + +* Einrichten der Erstellungsumgebung:: Die isolierte Umgebung zum Erstellen + vorbereiten. +* Auslagern des Daemons einrichten:: Erstellungen auf entfernte Maschinen + auslagern. +* SELinux-Unterstützung:: Wie man eine SELinux-Richtlinie für den Daemon + einrichtet. + +Paketverwaltung + + + +* Funktionalitäten:: Wie Guix Ihr Leben schöner machen wird. +* Aufruf von guix package:: Pakete installieren, entfernen usw. +* Substitute:: Vorerstelle Binärdateien herunterladen. +* Pakete mit mehreren Ausgaben.:: Ein Quellpaket, mehrere Ausgaben. +* Aufruf von guix gc:: Den Müllsammler laufen lassen. +* Aufruf von guix pull:: Das neueste Guix samt Distribution laden. +* Channels:: Customizing the package collection. +* Inferiors:: Interacting with another revision of Guix. +* Invoking guix describe:: Display information about your Guix revision. +* Aufruf von guix pack:: Software-Bündel erstellen. +* Aufruf von guix archive:: Import und Export von Store-Dateien. + +Substitute + + + +* Offizieller Substitut-Server:: Eine besondere Quelle von Substituten. +* Substitut-Server autorisieren:: Wie man Substitute an- und abschaltet. +* Substitutauthentifizierung:: Wie Guix Substitute verifiziert. +* Proxy-Einstellungen:: Wie Sie Substitute über einen Proxy beziehen. +* Fehler bei der Substitution:: Was passiert, wenn die Substitution + fehlschlägt. +* Vom Vertrauen gegenüber Binärdateien:: Wie können Sie diesem binären + Blob trauen? + +Programmierschnittstelle + + + +* Pakete definieren:: Wie Sie neue Pakete definieren. +* Erstellungssysteme:: Angeben, wie Pakete erstellt werden. +* Der Store:: Den Paket-Store verändern. +* Ableitungen:: Systemnahe Schnittstelle für Paketableitungen. +* Die Store-Monade:: Rein funktionale Schnittstelle zum Store. +* G-Ausdrücke:: Erstellungsausdrücke verarbeiten. +* Invoking guix repl:: Fiddling with Guix interactively. + +Pakete definieren + + + +* „package“-Referenz:: Der Datentyp für Pakete. +* „origin“-Referenz:: Datentyp für Paketursprünge. + +Zubehör + + + +* Aufruf von guix build:: Pakete aus der Befehlszeile heraus erstellen. +* Aufruf von guix edit:: Paketdefinitionen bearbeiten. +* Aufruf von guix download:: Herunterladen einer Datei und Ausgabe ihres + Hashes. +* Aufruf von guix hash:: Den kryptographischen Hash einer Datei + berechnen. +* Aufruf von guix import:: Paketdefinitionen importieren. +* Aufruf von guix refresh:: Paketdefinitionen aktualisieren. +* Aufruf von guix lint:: Fehler in Paketdefinitionen finden. +* Aufruf von guix size:: Plattenverbrauch profilieren. +* Aufruf von guix graph:: Den Paketgraphen visualisieren. +* Aufruf von guix environment:: Entwicklungsumgebungen einrichten. +* Aufruf von guix publish:: Substitute teilen. +* Aufruf von guix challenge:: Die Substitut-Server anfechten. +* Aufruf von guix copy:: Mit einem entfernten Store Dateien austauschen. +* Aufruf von guix container:: Prozesse isolieren. +* Aufruf von guix weather:: Die Verfügbarkeit von Substituten + einschätzen. +* Invoking guix processes:: Listing client processes. + +Aufruf von @command{guix build} + + + +* Gemeinsame Erstellungsoptionen:: Erstellungsoptionen für die meisten + Befehle. +* Paketumwandlungsoptionen:: Varianten von Paketen erzeugen. +* Zusätzliche Erstellungsoptionen:: Optionen spezifisch für »guix + build«. +* Fehlschläge beim Erstellen untersuchen:: Praxiserfahrung bei der + Paketerstellung. + +GNU-Distribution + + + +* Systeminstallation:: Das ganze Betriebssystem installieren. +* Systemkonfiguration:: Das Betriebssystem konfigurieren. +* Dokumentation:: Wie man Nutzerhandbücher von Software liest. +* Dateien zur Fehlersuche installieren:: Womit man seinen Debugger + füttert. +* Sicherheitsaktualisierungen:: Sicherheits-Patches schnell einspielen. +* Paketmodule:: Pakete aus Sicht des Programmierers. +* Paketrichtlinien:: Die Distribution wachsen lassen. +* Bootstrapping:: GNU/Linux von Grund auf selbst erstellen. +* Portierung:: Guix auf andere Plattformen und Kernels + bringen. + +Systeminstallation + + + +* Einschränkungen:: Was Sie erwarten dürfen. +* Hardware-Überlegungen:: Unterstützte Hardware. +* Installation von USB-Stick oder DVD:: Das Installationsmedium + vorbereiten. +* Vor der Installation:: Netzwerkanbindung, Partitionierung etc. +* Fortfahren mit der Installation:: Die Hauptsache. +* GuixSD in einer VM installieren:: Ein GuixSD-Spielplatz. +* Ein Abbild zur Installation erstellen:: Wie ein solches entsteht. + +Systemkonfiguration + + + +* Das Konfigurationssystems nutzen:: Ihr GNU-System anpassen +* „operating-system“-Referenz:: Details der + Betriebssystem-Deklarationen. +* Dateisysteme:: Die Dateisystemeinbindungen konfigurieren. +* Abgebildete Geräte:: Zusatzverarbeitungsschritte für blockbasierte + Geräte. +* Benutzerkonten:: Benutzerkonten festlegen. +* Locales:: Sprach- und kulturelle + Konventionseinstellungen. +* Dienste:: Systemdienste festlegen. +* Setuid-Programme:: Programme mit Administratorrechten ausführen +* X.509-Zertifikate:: HTTPS-Server authentifizieren. +* Name Service Switch:: Den Name Service Switch von libc konfigurieren. +* Initiale RAM-Disk:: Linux-libre hochfahren. +* Bootloader-Konfiguration:: Den Bootloader konfigurieren. +* Aufruf von guix system:: Instanzierung einer Systemkonfiguration +* GuixSD in einer VM starten:: Wie man GuixSD in einer virtuellen Maschine + startet. +* Dienste definieren:: Neue Dienstdefinitionen hinzufügen. + +Dienste + + + +* Basisdienste:: Essenzielle Systemdienste +* Geplante Auftragsausführung:: Der mcron-Dienst. +* Log-Rotation:: Der rottlog-Dienst. +* Netzwerkdienste:: Netzwerkeinrichtung, SSH-Daemon etc. +* X Window:: Graphische Anzeige. +* Druckdienste:: Unterstützung für lokale und entfernte + Drucker. +* Desktop-Dienste:: D-Bus- und Desktop-Dienste. +* Tondienste:: Dienste für ALSA und Pulseaudio. +* Datenbankdienste:: SQL-Datenbanken, Schlüssel-Wert-Speicher etc. +* Mail-Dienste:: IMAP, POP3, SMTP und so weiter. +* Kurznachrichtendienste:: Dienste für Kurznachrichten. +* Telefondienste:: Telefoniedienste. +* Überwachungsdienste:: Dienste zur Systemüberwachung. +* Kerberos-Dienste:: Kerberos-Dienste. +* Web-Dienste:: Web-Server. +* Zertifikatsdienste:: TLS-Zertifikate via Let’s Encrypt. +* DNS-Dienste:: DNS-Daemons. +* VPN-Dienste:: VPN-Daemons. +* Network File System:: Dienste mit Bezug zum Netzwerkdateisystem. +* Kontinuierliche Integration:: Der Cuirass-Dienst +* Power Management Services:: Extending battery life. +* Audio-Dienste:: Der MPD. +* Virtualisierungsdienste:: Dienste für virtuelle Maschinen. +* Versionskontrolldienste:: Entfernten Zugang zu Git-Repositorys bieten. +* Spieldienste:: Spielserver. +* Verschiedene Dienste:: Andere Dienste. + +Dienste definieren + + + +* Dienstkompositionen:: Wie Dienste zusammengestellt werden. +* Diensttypen und Dienste:: Typen und Dienste. +* Service-Referenz:: Referenz zur Programmierschnittstelle +* Shepherd-Dienste:: Eine spezielle Art von Dienst. + +Paketrichtlinien + + + +* Software-Freiheit:: Was in die Distribution aufgenommen werden + darf. +* Paketbenennung:: Was macht einen Namen aus? +* Versionsnummern:: Wenn der Name noch nicht genug ist. +* Zusammenfassungen und Beschreibungen:: Den Nutzern helfen, das richtige + Paket zu finden. +* Python-Module:: Ein Touch britischer Comedy. +* Perl-Module:: Kleine Perlen. +* Java-Pakete:: Kaffeepause. +* Schriftarten:: Schriften verschriftlicht. + +Mitwirken + + + +* Erstellung aus dem Git:: Das Neueste und Beste. +* Guix vor der Installation ausführen:: Hacker-Tricks. +* Perfekt eingerichtet:: Die richtigen Werkzeuge. +* Code-Stil:: Wie Mitwirkende hygienisch arbeiten. +* Einreichen von Patches:: Teilen Sie Ihre Arbeit. + +Code-Stil + + + +* Programmierparadigmen:: Wie Sie Ihre Elemente zusammenstellen. +* Module:: Wo Sie Ihren Code unterbringen. +* Datentypen und Mustervergleich:: Implementierung von Datenstrukturen. +* Formatierung von Code:: Schreibkonventionen. + +@end detailmenu +@end menu + +@c ********************************************************************* +@node Einführung +@chapter Einführung + +@cindex Zweck +GNU Guix@footnote{»Guix« wird wie »geeks« ausgesprochen, also als »ɡiːks« in +der Notation des Internationalen Phonetischen Alphabets (IPA).} ist ein +Werkzeug zur Paketverwaltung für das GNU-System. Guix macht es +unprivilegierten Nutzern leicht, Pakete zu installieren, zu aktualisieren +oder zu entfernen, zu einem vorherigen Satz von Paketen zurückzuwechseln, +Pakete aus ihrem Quellcode heraus zu erstellen und hilft allgemein bei der +Schöpfung und Wartung von Software-Umgebungen. + +@cindex Benutzeroberflächen +Guix bietet eine kommandozeilenbasierte Paketverwaltungsschnittstelle +(@pxref{Aufruf von guix package}), einen Satz Befehlszeilenwerkzeuge +(@pxref{Zubehör}) sowie Schnittstellen zur Programmierung in Scheme +(@pxref{Programmierschnittstelle}). +@cindex Erstellungs-Daemon +Der @dfn{Erstellungs-Daemon} ist für das Erstellen von Paketen im Auftrag +von Nutzern verantwortlich (@pxref{Den Daemon einrichten}) und für das +Herunterladen vorerstellter Binärdateien aus autorisierten Quellen +(@pxref{Substitute}). + +@cindex Erweiterbarkeit der Distribution +@cindex Anpassung, von Paketen +Guix enthält Paketdefinitionen für viele Pakete, von GNU und nicht von GNU, +die alle @uref{https://www.gnu.org/philosophy/free-sw.html, die Freiheit des +Computernutzers respektieren}. Es ist @emph{erweiterbar}: Nutzer können ihre +eigenen Paketdefinitionen schreiben (@pxref{Pakete definieren}) und sie als +unabhängige Paketmodule verfügbar machen (@pxref{Paketmodule}). Es ist +auch @emph{anpassbar}: Nutzer können spezialisierte Paketdefinitionen aus +bestehenden @emph{ableiten}, auch von der Befehlszeile (@pxref{Paketumwandlungsoptionen}). + +@cindex Guix System Distribution +@cindex GuixSD +Sie können GNU@tie{}Guix auf ein bestehendes GNU/Linux-System aufsetzen, wo +es die bereits verfügbaren Werkzeuge ergänzt, ohne zu stören +(@pxref{Installation}), oder Sie können es eigenständig als Teil der +@dfn{Guix System Distribution}, kurz GuixSD (@pxref{GNU-Distribution}), +verwenden. Mit GNU@tie{}GuixSD @emph{deklarieren} Sie alle Aspekte der +Betriebssystemkonfiguration und Guix kümmert sich darum, die Konfiguration +oft transaktionsbasierte, reproduzierbare und zustandslose Weise zu +instanzieren (@pxref{Systemkonfiguration}). + +@cindex funktionale Paketverwaltung +Intern implementiert Guix die Disziplin der @dfn{funktionalen +Paketverwaltung}, zu der Nix schon die Pionierarbeit geleistet hat +(@pxref{Danksagungen}). In Guix wird der Prozess, ein Paket zu erstellen +und zu installieren, als eine @emph{Funktion} im mathematischen Sinn +aufgefasst. Diese Funktion hat Eingaben, wie zum Beispiel +Erstellungs-Skripts, einen Compiler und Bibliotheken, und liefert ein +installiertes Paket. Als eine reine Funktion hängt sein Ergebnis allein von +seinen Eingaben ab — zum Beispiel kann er nicht auf Software oder Skripts +Bezug nehmen, die nicht ausdrücklich als Eingaben übergeben wurden. Eine +Erstellungsfunktion führt immer zum selben Ergebnis, wenn ihr die gleiche +Menge an Eingaben übergeben wurde. Sie kann die Umgebung des laufenden +Systems auf keine Weise beeinflussen, zum Beispiel kann sie keine Dateien +außerhalb ihrer Erstellungs- und Installationsverzeichnisse verändern. Um +dies zu erreichen, laufen Erstellungsprozesse in isolieren Umgebungen +(sogenannte @dfn{Container}), wo nur ausdrückliche Eingaben sichtbar sind. + +@cindex Store +Das Ergebnis von Paketerstellungsfunktionen wird im Dateisystem +@dfn{zwischengespeichert} in einem besonderen Verzeichnis, was als @dfn{der +Store} bezeichnet wird (@pxref{Der Store}). Jedes Paket wird in sein eigenes +Verzeichnis im Store installiert — standardmäßig ist er unter +@file{/gnu/store} zu finden. Der Verzeichnisname enthält einen Hash aller +Eingaben, anhand derer das Paket erzeugt wurde, somit hat das Ändern einer +Eingabe einen völlig anderen Verzeichnisnamen zur Folge. + +Dieses Vorgehen ist die Grundlage für die Guix auszeichnenden +Funktionalitäten: Unterstützung transaktionsbasierter Paketaktualisierungen +und -rückstufungen, Installation von Paketen als einfacher Nutzer sowie +Garbage Collection für Pakete (@pxref{Funktionalitäten}). + + +@c ********************************************************************* +@node Installation +@chapter Installation + +@cindex Guix installieren +GNU Guix kann von seiner Webseite unter +@url{http://www.gnu.org/software/guix/} heruntergeladen werden. Dieser +Abschnitt beschreibt die Software-Voraussetzungen von Guix und wie man es +installiert, so dass man es benutzen kann. + +Beachten Sie, dass es in diesem Abschnitt um die Installation des +Paketverwaltungswerkzeugs geht, welche auf einem laufenden GNU/Linux-System +vollzogen werden kann. Falls Sie stattdessen das vollständige +GNU-Betriebssystem installieren möchten, werfen Sie einen Blick in den +Abschnitt @pxref{Systeminstallation}. + +@cindex Fremddistribution +Wenn es auf ein bestehendes GNU/Linux-System installiert wird — im Folgenden +als @dfn{Fremddistribution} bezeichnet —, ergänzt GNU@tie{}Guix die +verfügbaren Werkzeuge, ohne dass sie sich gegenseitig stören. Guix’ Daten +befinden sich ausschließlich in zwei Verzeichnissen, üblicherweise +@file{/gnu/store} und @file{/var/guix}; andere Dateien auf Ihrem System wie +@file{/etc} bleiben unberührt. + +Sobald es installiert ist, kann Guix durch Ausführen von @command{guix pull} +aktualisiert werden (@pxref{Aufruf von guix pull}). + +@menu +* Aus Binärdatei installieren:: Guix installieren, ohne Zeit zu verlieren! +* Voraussetzungen:: Zum Erstellen und Benutzen von Guix nötige + Software. +* Die Testsuite laufen lassen:: Guix testen. +* Den Daemon einrichten:: Wie man die Umgebung des Erstellungs-Daemons + einrichtet. +* Aufruf des guix-daemon:: Den Erstellungs-Daemon laufen lassen. +* Anwendungen einrichten:: Anwendungsspezifische Einstellungen. +@end menu + +@node Aus Binärdatei installieren +@section Aus Binärdatei installieren + +@cindex Guix aus Binärdateien installieren +Dieser Abschnitt beschreibt, wie sich Guix auf einem beliebigen System aus +einem alle Komponenten umfassenden Tarball installieren lässt, der +Binärdateien für Guix und all seine Abhängigkeiten liefert. Dies geht in der +Regel schneller, als Guix aus seinen Quelldateien zu installieren, was im +nächsten Abschnitt beschrieben wird. Vorausgesetzt wird hier lediglich, dass +GNU@tie{}tar und Xz verfügbar sind. + +Wir bieten ein +@uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, +Installations-Skript für die Shell}, welches Guix automatisch herunterlädt, +installiert und eine erste Konfiguration von Guix mit sich bringt. Es sollte +als der Administratornutzer (als »root«) ausgeführt werden. + +Die Installation läuft so ab: + +@enumerate +@item +@cindex Guix-Binärdatei herunterladen +Download the binary tarball from +@indicateurl{https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz}, +where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine +already running the kernel Linux, and so on. + +@c The following is somewhat duplicated in ``System Installation''. +Achten Sie darauf, auch die zugehörige @file{.sig}-Datei herunterzuladen und +verifizieren Sie damit die Authentizität des Tarballs, ungefähr so: + +@example +$ wget https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig +$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig +@end example + +Falls dieser Befehl fehlschlägt, weil Sie nicht über den nötigen +öffentlichen Schlüssel verfügen, können Sie ihn mit diesem Befehl +importieren: + +@example +$ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID} +@end example + +@noindent +@c end authentication part +und den Befehl @code{gpg --verify} erneut ausführen. + +@item +Nun müssen Sie zum Administratornutzer @code{root} wechseln. Abhängig von +Ihrer Distribution müssen Sie dazu etwa @code{su -} oder @code{sudo -i} +ausführen. Danach führen Sie als @code{root}-Nutzer aus: + +@example +# cd /tmp +# tar --warning=no-timestamp -xf \ + guix-binary-@value{VERSION}.@var{system}.tar.xz +# mv var/guix /var/ && mv gnu / +@end example + +Dadurch wird @file{/gnu/store} (@pxref{Der Store}) und @file{/var/guix} +erzeugt. Letzteres enthält ein Profil, welches bereit zur Nutzung durch +@code{root} ist (wie im nächsten Schritt beschrieben). + +Entpacken Sie den Tarball @emph{nicht} auf einem schon funktionierenden +Guix-System, denn es würde seine eigenen essenziellen Dateien überschreiben. + +Die Befehlszeilenoption @code{--warning=no-timestamp} stellt sicher, dass +GNU@tie{}tar nicht vor »unplausibel alten Zeitstempeln« warnt (solche +Warnungen traten bei GNU@tie{}tar 1.26 und älter auf, neue Versionen machen +keine Probleme). Sie kommen daher, dass alle Dateien im Archiv als +Änderungszeitpunkt null eingetragen bekommen haben (das bezeichnet den +1. Januar 1970). Das ist Absicht, damit der Inhalt des Archivs nicht davon +abhängt, wann es erstellt wurde, und es somit reproduzierbar wird. + +@item +Machen Sie das Profil von @code{root} verfügbar als +@file{~root/.guix-profile}: + +@example +# ln -sf /var/guix/profiles/per-user/root/guix-profile \ + ~root/.guix-profile +@end example + +»Sourcen« Sie @file{etc/profile}, um @code{PATH} und andere relevante +Umgebungsvariable zu ergänzen: + +@example +# GUIX_PROFILE="`echo ~root`/.guix-profile" ; \ + source $GUIX_PROFILE/etc/profile +@end example + +@item +Erzeugen Sie Nutzergruppe und Nutzerkonten für die Erstellungs-Benutzer wie +folgt (@pxref{Einrichten der Erstellungsumgebung}). + +@item +Führen Sie den Daemon aus, und lassen Sie ihn automatisch bei jedem +Hochfahren starten. + +Wenn Ihre Wirts-Distribution systemd als »init«-System verwendet, können Sie +das mit folgenden Befehlen veranlassen: + +@c Versions of systemd that supported symlinked service files are not +@c yet widely deployed, so we should suggest that users copy the service +@c files into place. +@c +@c See this thread for more information: +@c http://lists.gnu.org/archive/html/guix-devel/2017-01/msg01199.html + +@example +# cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \ + /etc/systemd/system/ +# systemctl start guix-daemon && systemctl enable guix-daemon +@end example + +Wenn Ihre Wirts-Distribution als »init«-System Upstart verwendet: + +@example +# initctl reload-configuration +# cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/ +# start guix-daemon +@end example + +Andernfalls können Sie den Daemon immer noch manuell starten, mit: + +@example +# ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild +@end example + +@item +Stellen Sie den @command{guix}-Befehl auch anderen Nutzern Ihrer Maschine +zur Verfügung, zum Beispiel so: + +@example +# mkdir -p /usr/local/bin +# cd /usr/local/bin +# ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix +@end example + +Es ist auch eine gute Idee, die Info-Version dieses Handbuchs ebenso +verfügbar zu machen: + +@example +# mkdir -p /usr/local/share/info +# cd /usr/local/share/info +# for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ; + do ln -s $i ; done +@end example + +Auf diese Art wird, unter der Annahme, dass bei Ihnen +@file{/usr/local/share/info} im Suchpfad eingetragen ist, das Ausführen von +@command{info guix} dieses Handbuch öffnen (@pxref{Other Info Directories,,, +texinfo, GNU Texinfo} hat weitere Details, wie Sie den Info-Suchpfad ändern +können). + +@item +@cindex Substitute, deren Autorisierung +Um Substitute von @code{hydra.gnu.org} oder einem Spiegelserver davon zu +benutzen (@pxref{Substitute}), müssen sie erst autorisiert werden: + +@example +# guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub +@end example + +@item +Alle Nutzer müssen womöglich ein paar zusätzliche Schritte ausführen, damit +ihre Guix-Umgebung genutzt werden kann, siehe @pxref{Anwendungen einrichten}. +@end enumerate + +Voilà, die installation ist fertig! + +Sie können nachprüfen, dass Guix funktioniert, indem Sie ein Beispielpaket +in das root-Profil installieren: + +@example +# guix package -i hello +@end example + +The @code{guix} package must remain available in @code{root}'s profile, or +it would become subject to garbage collection---in which case you would find +yourself badly handicapped by the lack of the @command{guix} command. In +other words, do not remove @code{guix} by running @code{guix package -r +guix}. + +Der Tarball zur Installation aus einer Binärdatei kann einfach durch +Ausführung des folgenden Befehls im Guix-Quellbaum (re-)produziert und +verifiziert werden: + +@example +make guix-binary.@var{system}.tar.xz +@end example + +@noindent +…was wiederum dies ausführt: + +@example +guix pack -s @var{system} --localstatedir guix +@end example + +Siehe @xref{Aufruf von guix pack} für weitere Informationen zu diesem +praktischen Werkzeug. + +@node Voraussetzungen +@section Voraussetzungen + +Dieser Abschnitt listet Voraussetzungen auf, um Guix aus seinem Quellcode zu +erstellen. Der Erstellungsprozess für Guix ist derselbe wie für andere +GNU-Software und wird hier nicht beschrieben. Bitte lesen Sie die Dateien +@file{README} und @file{INSTALL} im Guix-Quellbaum, um weitere Details zu +erfahren. + +GNU Guix hat folgende Pakete als Abhängigkeiten: + +@itemize +@item @url{http://gnu.org/software/guile/, GNU Guile}, Version 2.0.13 oder +neuer, einschließlich 2.2.x, +@item @url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version +0.1.0 or later; +@item +@uref{http://gnutls.org/, GnuTLS}, im Speziellen dessen Bindungen für Guile +(@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, +gnutls-guile, GnuTLS-Guile}), +@item +@uref{https://notabug.org/civodul/guile-sqlite3, Guile-SQLite3}, version +0.1.0 or later; +@item +@c FIXME: Specify a version number once a release has been made. +@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, vom August 2017 +oder neuer, +@item @url{http://zlib.net, zlib}, +@item @url{http://www.gnu.org/software/make/, GNU Make}. +@end itemize + +Folgende Abhängigkeiten sind optional: + +@itemize +@item +Wenn Sie @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} +installieren, können Sie den Befehl @command{guix import pypi} benutzen +(@pxref{Aufruf von guix import}). Das spielt hauptsächlich für Entwickler und +nicht für Gelegenheitsnutzer eine Rolle. + +@item +@c Note: We need at least 0.10.2 for 'channel-send-eof'. +Unterstützung für das Auslagern von Erstellungen (@pxref{Auslagern des Daemons einrichten}) und @command{guix copy} (@pxref{Aufruf von guix copy}) hängt von +@uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, Version +0.10.2 oder neuer, ab. + +@item +Wenn @url{http://www.bzip.org, libbz2} verfügbar ist, kann +@command{guix-daemon} damit Erstellungsprotokolle komprimieren. +@end itemize + +Sofern nicht @code{--disable-daemon} beim Aufruf von @command{configure} +übergeben wurde, benötigen Sie auch folgende Pakete: + +@itemize +@item @url{http://gnupg.org/, GNU libgcrypt}, +@item @url{http://sqlite.org, SQLite 3}, +@item @url{http://gcc.gnu.org, GCC's g++} mit Unterstützung für den +C++11-Standard. +@end itemize + +@cindex Zustandsverzeichnis +Sollten Sie Guix auf einem System konfigurieren, auf dem Guix bereits +installiert ist, dann stellen Sie sicher, dasselbe Zustandsverzeichnis wie +für die bestehende Installation zu verwenden. Benutzen Sie dazu die +Befehlszeilenoption @code{--localstatedir} des @command{configure}-Skripts +(@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding +Standards}). Das @command{configure}-Skript schützt vor ungewollter +Fehlkonfiguration der @var{localstatedir}, damit sie nicht versehentlich +Ihren Store verfälschen (@pxref{Der Store}). + +@cindex Nix, Kompatibilität +Wenn eine funktionierende Installation of @url{http://nixos.org/nix/, the +Nix package manager} verfügbar ist, können Sie Guix stattdessen mit +@code{--disable-daemon} konfigurieren. In diesem Fall ersetzt Nix die drei +obengenannten Abhängigkeiten. + +Guix ist mit Nix kompatibel, daher ist es möglich, denselben Store für beide +zu verwenden. Dazu müssen Sie an @command{configure} nicht nur denselben +Wert für @code{--with-store-dir} übergeben, sondern auch denselben Wert für +@code{--localstatedir}. Letzterer ist deswegen essenziell, weil er unter +Anderem angibt, wo die Datenbank liegt, in der sich die Metainformationen +über den Store befinden. Für Nix sind die Werte standardmäßig +@code{--with-store-dir=/nix/store} und +@code{--localstatedir=/nix/var}. Beachten Sie, dass @code{--disable-daemon} +nicht erforderlich ist, wenn Sie die Absicht haben, den Store mit Nix zu +teilen. + +@node Die Testsuite laufen lassen +@section Die Testsuite laufen lassen + +@cindex Testkatalog +Nachdem @command{configure} und @code{make} erfolgreich durchgelaufen sind, +ist es ratsam, den Testkatalog auszuführen. Er kann dabei helfen, Probleme +mit der Einrichtung oder Systemumgebung zu finden, oder auch Probleme in +Guix selbst — und Testfehler zu melden ist eine wirklich gute Art und Weise, +bei der Verbesserung von Guix mitzuhelfen. Um den Testkatalog auszuführen, +geben Sie Folgendes ein: + +@example +make check +@end example + +Testfälle können parallel ausgeführt werden. Sie können die +Befehlszeiltenoption @code{-j} von GNU@tie{}make benutzen, damit es +schneller geht. Der erste Durchlauf kann auf neuen Maschinen ein paar +Minuten dauern, nachfolgende Ausführungen werden schneller sein, weil der +für die Tests erstellte Store schon einige Dinge zwischengespeichert haben +wird. + +Es ist auch möglich, eine Teilmenge der Tests laufen zu lassen, indem Sie +die @code{TESTS}-Variable des Makefiles ähnlich wie in diesem Beispiel +definieren: + +@example +make check TESTS="tests/store.scm tests/cpio.scm" +@end example + +Standardmäßig werden Testergebnisse pro Datei angezeigt. Um die Details +jedes einzelnen Testfalls zu sehen, können Sie wie in diesem Beispiel die +@code{SCM_LOG_DRIVER_FLAGS}-Variable des Makefiles definieren: + +@example +make check TESTS="tests/base64.scm" SCM_LOG_DRIVER_FLAGS="--brief=no" +@end example + +Kommt es zum Fehlschlag, senden Sie bitte eine E-mail an +@email{bug-guix@@gnu.org} und fügen Sie die Datei @file{test-suite.log} als +Anhang bei. Bitte geben Sie dabei in Ihrer Nachricht die benutze Version von +Guix an sowie die Versionsnummern der Abhängigkeiten (@pxref{Voraussetzungen}). + +Guix wird auch mit einem Testkatalog für das ganze System ausgeliefert, der +vollständige Instanzen des GuixSD-Betriebssystems testet. Er kann nur auf +Systemen benutzt werden, auf denen Guix bereits installiert ist, mit +folgendem Befehl: + +@example +make check-system +@end example + +@noindent +Oder, auch hier, indem Sie @code{TESTS} definieren, um eine Teilmenge der +auszuführenden Tests anzugeben: + +@example +make check-system TESTS="basic mcron" +@end example + +Diese Systemtests sind in den @code{(gnu tests @dots{})}-Modulen +definiert. Sie funktionieren, indem Sie das getestete Betriebssystem mitsamt +schlichter Instrumentierung in einer virtuellen Maschine (VM) ausführen. Die +Tests können aufwendige Berechnungen durchführen oder sie günstig umgehen, +je nachdem, ob für ihre Abhängigkeiten Substitute zur Verfügung stehen +(@pxref{Substitute}). Manche von ihnen nehmen viel Speicherplatz in +Anspruch, um die VM-Abbilder zu speichern. + +Auch hier gilt: Falls Testfehler auftreten, senden Sie bitte alle Details an +@email{bug-guix@@gnu.org}. + +@node Den Daemon einrichten +@section Den Daemon einrichten + +@cindex Daemon +Operationen wie das Erstellen eines Pakets oder Laufenlassen des +Müllsammlers werden alle durch einen spezialisierten Prozess durchgeführt, +den @dfn{Erstellungs-Daemon}, im Auftrag seiner Kunden (Clients). Nur der +Daemon darf auf den Store und seine zugehörige Datenbank zugreifen. Daher +wird jede den Store verändernde Operation durch den Daemon durchgeführt. Zum +Beispiel kommunizieren Befehlszeilenwerkzeuge wie @command{guix package} und +@command{guix build} mit dem Daemon (mittels entfernter Prozeduraufrufe), um +ihm Anweisungen zu geben, was er tun soll. + +Folgende Abschnitte beschreiben, wie Sie die Umgebung des +Erstellungs-Daemons ausstatten sollten. Siehe auch @ref{Substitute} für +Informationen darüber, wie Sie es dem Daemon ermöglichen, vorerstellte +Binärdateien herunterzuladen. + +@menu +* Einrichten der Erstellungsumgebung:: Die isolierte Umgebung zum Erstellen + vorbereiten. +* Auslagern des Daemons einrichten:: Erstellungen auf entfernte Maschinen + auslagern. +* SELinux-Unterstützung:: Wie man eine SELinux-Richtlinie für den Daemon + einrichtet. +@end menu + +@node Einrichten der Erstellungsumgebung +@subsection Einrichten der Erstellungsumgebung + +@cindex Erstellungsumgebung +In einem normalen Mehrbenutzersystem werden Guix und sein Daemon — das +Programm @command{guix-daemon} — vom Systemadministrator installiert; +@file{/gnu/store} gehört @code{root} und @command{guix-daemon} läuft als +@code{root}. Nicht mit erweiterten Rechten ausgestattete Nutzer können +Guix-Werkzeuge benutzen, um Pakete zu erstellen oder anderweitig auf den +Store zuzugreifen, und der Daemon wird dies für sie erledigen und dabei +sicherstellen, dass der Store in einem konsistenten Zustand verbleibt und +sich die Nutzer erstellte Pakete teilen. + +@cindex Erstellungsbenutzer +Wenn @command{guix-daemon} als Administratornutzer @code{root} läuft, wollen +Sie aber vielleicht dennoch nicht, dass Paketerstellungsprozesse auch als +@code{root} ablaufen, aus offensichtlichen Sicherheitsgründen. Um dies zu +vermeiden, sollte ein besonderer Pool aus @dfn{Erstellungsbenutzern} +geschaffen werden, damit vom Daemon gestartete Erstellungsprozesse ihn +benutzen. Diese Erstellungsbenutzer müssen weder eine Shell noch einen +Persönlichen Ordner zugewiesen bekommen, sie werden lediglich benutzt, wenn +der Daemon @code{root}-Rechte in Erstellungsprozessen ablegt. Mehrere solche +Benutzer zu haben, ermöglicht es dem Daemon, verschiedene +Erstellungsprozessen unter verschiedenen Benutzeridentifikatoren (UIDs) zu +starten, was garantiert, dass sie einander nicht stören — eine essenzielle +Funktionalität, da Erstellungen als reine Funktionen angesehen werden +(@pxref{Einführung}). + +Auf einem GNU/Linux-System kann ein Pool von Erstellungsbenutzern wie folgt +erzeugt werden (mit Bash-Syntax und den Befehlen von @code{shadow}): + +@c See http://lists.gnu.org/archive/html/bug-guix/2013-01/msg00239.html +@c for why `-G' is needed. +@example +# groupadd --system guixbuild +# for i in `seq -w 1 10`; + do + useradd -g guixbuild -G guixbuild \ + -d /var/empty -s `which nologin` \ + -c "Guix-Erstellungsbenutzer $i" --system \ + guixbuilder$i; + done +@end example + +@noindent +Die Anzahl der Erstellungsbenutzer entscheidet, wieviele Erstellungsaufträge +parallel ausgeführt werden können, wie es mit der Befehlszeilenoption +@option{--max-jobs} vorgeben werden kann (@pxref{Aufruf des guix-daemon, +@option{--max-jobs}}). Um @command{guix system vm} und ähnliche Befehle +nutzen zu können, müssen Sie die Erstellungsbenutzer unter Umständen zur +@code{kvm}-Benutzergruppe hinzufügen, damit sie Zugriff auf @file{/dev/kvm} +haben, mit @code{-G guixbuild,kvm} statt @code{-G guixbuild} +(@pxref{Aufruf von guix system}). + +Das Programm @code{guix-daemon} kann mit dem folgenden Befehl als +@code{root} gestartet werden@footnote{Wenn Ihre Maschine systemd als +»init«-System verwendet, genügt es, die Datei +@file{@var{prefix}/lib/systemd/system/guix-daemon.service} in +@file{/etc/systemd/system} zu platzieren, damit @command{guix-daemon} +automatisch gestartet wird. Ebenso können Sie, wenn Ihre Maschine Upstart +als »init«-System benutzt, die Datei +@file{@var{prefix}/lib/upstart/system/guix-daemon.conf} in @file{/etc/init} +platzieren.}: + +@example +# guix-daemon --build-users-group=guixbuild +@end example + +@cindex chroot +@noindent +Auf diese Weise startet der Daemon Erstellungsprozesse in einem chroot als +einer der @code{guixbuilder}-Benutzer. Auf GNU/Linux enthält die +chroot-Umgebung standardmäßig nichts außer: + +@c Keep this list in sync with libstore/build.cc! ----------------------- +@itemize +@item +einem minimalen @code{/dev}-Verzeichnis, was größtenteils vom @code{/dev} +des Wirtssystems unabhängig erstellt wurde@footnote{»Größtenteils«, denn +obwohl die Menge an Dateien, die im @code{/dev} des chroots vorkommen, fest +ist, können die meisten dieser Dateien nur dann erstellt werden, wenn das +Wirtssystem sie auch hat.}, + +@item +dem @code{/proc}-Verzeichnis, es zeigt nur die Prozesse des Containers, weil +ein separater Namensraum für Prozess-IDs (PIDs) benutzt wird, + +@item +@file{/etc/passwd} mit einem Eintrag für den aktuellen Benutzer und einem +Eintrag für den Benutzer @file{nobody}, + +@item +@file{/etc/group} mit einem Eintrag für die Gruppe des Benutzers, + +@item +@file{/etc/hosts} mit einem Eintrag, der @code{localhost} auf +@code{127.0.0.1} abbildet, + +@item +einem @file{/tmp}-Verzeichnis mit Schreibrechten. +@end itemize + +Sie können beeinflussen, in welchem Verzeichnis der Daemon Erstellungsbäume +unterbringt, indem sie den Wert der Umgebungsvariablen @code{TMPDIR} +ändern. Allerdings heißt innerhalb des chroots der Erstellungsbaum immer +@file{/tmp/guix-build-@var{name}.drv-0}, wobei @var{name} der Ableitungsname +ist — z.B. @code{coreutils-8.24}. Dadurch hat der Wert von @code{TMPDIR} +keinen Einfluss auf die Erstellungsumgebung, wodurch Unterschiede vermieden +werden, falls Erstellungsprozesse den Namen ihres Erstellungsbaumes +einfangen. + +@vindex http_proxy +Der Daemon befolgt außerdem den Wert der Umgebungsvariablen +@code{http_proxy} für von ihm durchgeführte HTTP-Downloads, sei es für +Ableitungen mit fester Ausgabe (@pxref{Ableitungen}) oder für Substitute +(@pxref{Substitute}). + +Wenn Sie Guix als ein Benutzer ohne erweiterte Rechte installieren, ist es +dennoch möglich, @command{guix-daemon} auszuführen, sofern Sie +@code{--disable-chroot} übergeben. Allerdings können Erstellungsprozesse +dann nicht voneinander und vom Rest des Systems isoliert werden. Daher +können sich Erstellungsprozesse gegenseitig stören und auf Programme, +Bibliotheken und andere Dateien zugreifen, die dem restlichen System zur +Verfügung stehen — was es deutlich schwerer macht, die als @emph{reine} +Funktionen aufzufassen. + + +@node Auslagern des Daemons einrichten +@subsection Nutzung der Auslagerungsfunktionalität + +@cindex auslagern +@cindex Build-Hook +Wenn erwünscht kann der Erstellungs-Daemon Ableitungserstellungen +@dfn{auslagern} auf andere Maschinen, auf denen Guix läuft, mit Hilfe des +@code{offload}-»@dfn{Build-Hooks}«@footnote{Diese Funktionalität ist nur +verfügbar, wenn @uref{https://github.com/artyom-poptsov/guile-ssh, +Guile-SSH} vorhanden ist.}. Wenn diese Funktionalität aktiviert ist, wird +eine nutzerspezifizierte Liste von Erstellungsmaschinen aus +@file{/etc/guix/machines.scm} gelesen. Wann immer eine Erstellung angefragt +wird, zum Beispiel durch @code{guix build}, versucht der Daemon, sie an eine +der Erstellungsmaschinen auszulagern, die die Einschränkungen der Ableitung +erfüllen, insbesondere ihren Systemtyp — z.B. @file{x86_64-linux}. Fehlende +Voraussetzungen für die Erstellung werden über SSH auf die Zielmaschine +kopiert, welche dann mit der Erstellung weitermacht. Hat sie Erfolg damit, +so werden die Ausgabe oder Ausgaben der Erstellung zurück auf die +ursprüngliche Maschine kopiert. + +Die Datei @file{/etc/guix/machines.scm} sieht normalerweise so aus: + +@example +(list (build-machine + (name "eightysix.example.org") + (system "x86_64-linux") + (host-key "ssh-ed25519 AAAAC3Nza@dots{}") + (user "bob") + (speed 2.)) ;unglaublich schnell! + + (build-machine + (name "meeps.example.org") + (system "mips64el-linux") + (host-key "ssh-rsa AAAAB3Nza@dots{}") + (user "alice") + (private-key + (string-append (getenv "HOME") + "/.ssh/identität-für-guix")))) +@end example + +@noindent +Im obigen Beispiel geben wir eine Liste mit zwei Erstellungsmaschinen vor, +eine für die @code{x86_64}-Architektur und eine für die +@code{mips64el}-Architektur. + +Tatsächlich ist diese Datei — wenig überraschend! — eine Scheme-Datei, die +ausgewertet wird, wenn der @code{offload}-Hook gestartet wird. Der Wert, den +sie zurückliefert, muss eine Liste von @code{build-machine}-Objekten +sein. Obwohl dieses Beispiel eine feste Liste von Erstellungsmaschinen +zeigt, könnte man auch auf die Idee kommen, etwa mit DNS-SD eine Liste +möglicher im lokalen Netzwerk entdeckter Erstellungsmaschinen zu liefern +(@pxref{Einführung, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme +Programs}). Der Datentyp @code{build-machine} wird im Folgenden weiter +ausgeführt. + +@deftp {Datentyp} build-machine +Dieser Datentyp repräsentiert Erstellungsmaschinen, an die der Daemon +Erstellungen auslagern darf. Die wichtigen Felder sind: + +@table @code + +@item name +Der Hostname der entfernten Maschine. + +@item system +Der Systemtyp der entfernten Maschine — z.B. @code{"x86_64-linux"}. + +@item user +Das Benutzerkonto, mit dem eine Verbindung zur entfernten Maschine über SSH +aufgebaut werden soll. Beachten Sie, dass das SSH-Schlüsselpaart +@emph{nicht} durch eine Passphrase geschützt sein darf, damit +nicht-interaktive Anmeldungen möglich sind. + +@item host-key +Dies muss der @dfn{öffentliche SSH-Host-Schlüssel} der Maschine im +OpenSSH-Format sein. Er wird benutzt, um die Identität der Maschine zu +prüfen, wenn wir uns mit ihr verbinden. Er ist eine lange Zeichenkette, die +ungefähr so aussieht: + +@example +ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org +@end example + +Wenn auf der Maschine der OpenSSH-Daemon, @command{sshd}, läuft, ist der +Host-Schlüssel in einer Datei wie @file{/etc/ssh/ssh_host_ed25519_key.pub} +zu finden. + +Wenn auf der Maschine der SSH-Daemon von GNU@tie{}lsh, nämlich +@command{lshd}, läuft, befindet sich der Host-Schlüssel in +@file{/etc/lsh/host-key.pub} oder einer ähnlichen Datei. Er kann ins +OpenSSH-Format umgewandelt werden durch @command{lsh-export-key} +(@pxref{Converting keys,,, lsh, LSH Manual}): + +@example +$ lsh-export-key --openssh < /etc/lsh/host-key.pub +ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{} +@end example + +@end table + +Eine Reihe optionaler Felder kann festgelegt werden: + +@table @asis + +@item @code{port} (Vorgabe: @code{22}) +Portnummer des SSH-Servers auf der Maschine. + +@item @code{private-key} (Vorgabe: @file{~root/.ssh/id_rsa}) +The SSH private key file to use when connecting to the machine, in OpenSSH +format. This key must not be protected with a passphrase. + +Beachten Sie, dass als Vorgabewert der private Schlüssel @emph{des +root-Benutzers} genommen wird. Vergewissern Sie sich, dass er existiert, +wenn Sie die Standardeinstellung verwenden. + +@item @code{compression} (Vorgabe: @code{"zlib@@openssh.com,zlib"}) +@itemx @code{compression-level} (Vorgabe: @code{3}) +Die Kompressionsmethoden auf SSH-Ebene und das angefragte +Kompressionsniveau. + +Beachten Sie, dass Auslagerungen SSH-Kompression benötigen, um beim +Übertragen von Dateien an Erstellungsmaschinen und zurück weniger Bandbreite +zu benutzen. + +@item @code{daemon-socket} (Vorgabe: @code{"/var/guix/daemon-socket/socket"}) +Dateiname des Unix-Sockets, auf dem @command{guix-daemon} auf der Maschine +lauscht. + +@item @code{parallel-builds} (Vorgabe: @code{1}) +Die Anzahl der Erstellungen, die auf der Maschine parallel ausgeführt werden +können. + +@item @code{speed} (Vorgabe: @code{1.0}) +Ein »relativer Geschwindigkeitsfaktor«. Der Auslagerungsplaner gibt +tendenziell Maschinen mit höherem Geschwindigkeitsfaktor den Vorrang. + +@item @code{features} (Vorgabe: @code{'()}) +Eine Liste von Zeichenketten, die besondere von der Maschine unterstützte +Funktionalitäten bezeichnen. Ein Beispiel ist @code{"kvm"} für Maschinen, +die über die KVM-Linux-Module zusammen mit entsprechender +Hardware-Unterstützung verfügen. Ableitungen können Funktionalitäten dem +Namen nach anfragen und werden dann auf passenden Erstellungsmaschinen +eingeplant. + +@end table +@end deftp + +Der Befehl @code{guile} muss sich im Suchpfad der Erstellungsmaschinen +befinden. Zusätzlich müssen die Guix-Module im @code{$GUILE_LOAD_PATH} auf +den Erstellungsmaschinen zu finden sein — um dies nachzuprüfen, können Sie +Folgendes ausführen: + +@example +ssh build-machine guile -c "'(use-modules (guix config))'" +@end example + +Es gibt noch eine weitere Sache zu tun, sobald @file{machines.scm} +eingerichtet ist. Wie zuvor erklärt, werden beim Auslagern Dateien zwischen +den Stores der Maschinen hin- und hergeschickt. Damit das funktioniert, +müssen Sie als Erstes ein Schlüsselpaar auf jeder Maschine erzeugen, damit +der Daemon signierte Archive mit den Dateien aus dem Store versenden kann +(@pxref{Aufruf von guix archive}): + +@example +# guix archive --generate-key +@end example + +@noindent +Jede Erstellungsmaschine muss den Schlüssel der Hauptmaschine autorisieren, +damit diese Store-Objekte von der Hauptmaschine empfangen kann: + +@example +# guix archive --authorize < öffentlicher-schlüssel-hauptmaschine.txt +@end example + +@noindent +Andersherum muss auch die Hauptmaschine den jeweiligen Schlüssel jeder +Erstellungsmaschine autorisieren. + +Der ganze Umstand mit den Schlüsseln soll ausdrücken, dass sich Haupt- und +Erstellungsmaschinen paarweise gegenseitig vertrauen. Konkret kann der +Erstellungs-Daemon auf der Hauptmaschine die Echtheit von den +Erstellungsmaschinen empfangener Dateien gewährleisten (und umgekehrt), und +auch dass sie nicht sabotiert wurden und mit einem autorisierten Schlüssel +signiert wurden. + +@cindex Auslagerung testen +Um zu testen, ob Ihr System funktioniert, führen Sie diesen Befehl auf der +Hauptmaschine aus: + +@example +# guix offload test +@end example + +Dadurch wird versucht, zu jeder Erstellungsmaschine eine Verbindung +herzustellen, die in @file{/etc/guix/machines.scm} angegeben wurde, +sichergestellt, dass auf jeder Guile und die Guix-Module nutzbar sind, und +jeweils versucht, etwas auf die Erstellungsmaschine zu exportieren und von +dort zu imporieren. Dabei auftretende Fehler werden gemeldet. + +Wenn Sie stattdessen eine andere Maschinendatei verwenden möchten, geben Sie +diese einfach auf der Befehlszeile an: + +@example +# guix offload test maschinen-qualif.scm +@end example + +Letztendlich können Sie hiermit nur die Teilmenge der Maschinen testen, +deren Name zu einem regulären Ausdruck passt: + +@example +# guix offload test maschinen.scm '\.gnu\.org$' +@end example + +@cindex Auslagerungs-Lagebericht +Um die momentane Auslastung aller Erstellungs-Hosts anzuzeigen, führen Sie +diesen Befehl auf dem Hauptknoten aus: + +@example +# guix offload status +@end example + + +@node SELinux-Unterstützung +@subsection SELinux-Unterstützung + +@cindex SELinux, Policy für den Daemon +@cindex Mandatory Access Control, SELinux +@cindex Sicherheit, des guix-daemon +Guix enthält eine SELinux-Richtliniendatei (»Policy«) unter +@file{etc/guix-daemon.cil}, die auf einem System installiert werden +kann, auf dem SELinux aktiviert ist, damit Guix-Dateien gekennzeichnet +sind, und um das erwartete Verhalten des Daemons anzugeben. Da GuixSD +keine Grundrichtlinie (»Base Policy«) für SELinux bietet, kann diese +Richtlinie für den Daemon auf GuixSD nicht benutzt werden. + +@subsubsection Installieren der SELinux-Policy +@cindex SELinux, Policy installieren +Um die Richtlinie (Policy) zu installieren, führen Sie folgenden Befehl mit +Administratorrechten aus: + +@example +semodule -i etc/guix-daemon.cil +@end example + +Kennzeichnen Sie dann das Dateisystem neu mit @code{restorecon} oder einem +anderen, von Ihrem System angebotenen Mechanismus. + +Sobald die Richtlinie installiert ist, das Dateisystem neu gekennzeichnet +wurde und der Daemon neugestartet wurde, sollte er im Kontext +@code{guix_daemon_t} laufen. Sie können dies mit dem folgenden Befehl +nachprüfen: + +@example +ps -Zax | grep guix-daemon +@end example + +Beobachten Sie die Protokolldateien von SELinux, wenn Sie einen Befehl wie +@code{guix build hello} ausführen, um sich zu überzeugen, dass SELinux alle +notwendigen Operationen gestattet. + +@subsubsection Einschränkungen +@cindex SELinux, Einschränkungen + +Diese Richtlinie ist nicht perfekt. Im Folgenden finden Sie eine Liste von +Einschränkungen oder merkwürdiger Verhaltensweisen, die bedacht werden +sollten, wenn man die mitgelieferte SELinux-Richtlinie für den Guix-Daemon +einspielt. + +@enumerate +@item +@code{guix_daemon_socket_t} wird nicht wirklich benutzt. Keine der +Socket-Operationen benutzt Kontexte, die irgendetwas mit +@code{guix_daemon_socket_t} zu tun haben. Es schadet nicht, diese ungenutzte +Kennzeichnung zu haben, aber es wäre besser, für die Kennzeichnung auch +Socket-Regeln festzulegen. + +@item +@code{guix gc} kann nicht auf beliebige Verknüpfungen zu Profilen +zugreifen. Die Kennzeichnung des Ziels einer symbolischen Verknüpfung ist +notwendigerweise unabhängig von der Dateikennzeichnung der +Verknüpfung. Obwohl alle Profile unter $localstatedir gekennzeichnet sind, +erben die Verknüpfungen auf diese Profile die Kennzeichnung desjenigen +Verzeichnisses, in dem sie sich befinden. Für Verknüpfungen im Persönlichen +Ordner des Benutzers ist das @code{user_home_t}, aber Verknüpfungen aus dem +Persönlichen Ordner des Administratornutzers, oder @file{/tmp}, oder das +Arbeitsverzeichnis des HTTP-Servers, etc., funktioniert das +nicht. @code{guix gc} würde es nicht gestattet, diese Verknüpfungen +auszulesen oder zu verfolgen. + +@item +Die vom Daemon gebotene Funktionalität, auf TCP-Verbindungen zu lauschen, +könnte nicht mehr funktionieren. Dies könnte zusätzliche Regeln brauchen, +weil SELinux Netzwerk-Sockets anders behandelt als Dateien. + +@item +Derzeit wird allen Dateien mit einem Namen, der zum regulären Ausdruck +@code{/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon} passt, die +Kennzeichnung @code{guix_daemon_exec_t} zugewiesen, wodurch @emph{jedee +beliebigee} Datei mit diesem Namen in irgendeinem Profil gestatttet wäre, in +der Domäne @code{guix_daemon_t} ausgeführt zu werden. Das ist nicht +ideal. Ein Angreifer könnte ein Paket erstellen, dass solch eine ausführbare +Datei enthält, und den Nutzer überzeugen, es zu installieren und +auszuführen. Dadurch käme es in die Domäne @code{guix_daemon_t}. Ab diesem +Punkt könnte SELinux nicht mehr verhindern, dass es auf Dateien zugreift, +auf die Prozesse in dieser Domäne zugreifen dürfen. + +Wir könnten zum Zeitpunkt der Installation eine wesentlich restriktivere +Richtlinie generieren, für die nur @emph{genau derselbe} Dateiname des +gerade installierten @code{guix-daemon}-Programms als +@code{guix_daemon_exec_t} gekennzeichnet würde, statt einen vieles +umfassenden regulären Ausdruck zu benutzen. Aber dann müsste der +Administratornutzer zum Zeitpunkt der Installation jedes Mal die Richtlinie +installieren oder aktualisieren müssen, sobald das Guix-Paket aktualisiert +wird, dass das tatsächlich in Benutzung befindliche +@code{guix-daemon}-Programm enthält. +@end enumerate + +@node Aufruf des guix-daemon +@section Aufruf von @command{guix-daemon} + +Das Programm @command{guix-daemon} implementiert alle Funktionalitäten, um +auf den Store zuzugreifen. Dazu gehört das Starten von Erstellungsprozessen, +das Ausführen des Müllsammlers, das Abfragen, ob ein Erstellungsergebnis +verfügbar ist, etc. Normalerweise wird er so als Administratornutzer +(@code{root}) gestartet: + +@example +# guix-daemon --build-users-group=guixbuild +@end example + +@noindent +Details, wie Sie ihn einrichten, finden Sie im Abschnitt @pxref{Den Daemon einrichten}. + +@cindex chroot +@cindex Container, Erstellungsumgebung +@cindex Erstellungsumgebung +@cindex Reproduzierbare Erstellungen +Standardmäßig führt @command{guix-daemon} Erstellungsprozesse mit +unterschiedlichen UIDs aus, die aus der Erstellungsgruppe stammen, deren +Name mit @code{--build-users-group} übergeben wurde. Außerdem läuft jeder +Erstellungsprozess in einer chroot-Umgebung, die nur die Teilmenge des +Stores enthält, von der der Erstellungsprozess abhängt, entsprechend seiner +Ableitung (@pxref{Programmierschnittstelle, derivation}), und ein paar +bestimmte Systemverzeichnisse, darunter standardmäßig auch @file{/dev} und +@file{/dev/pts}. Zudem ist die Erstellungsumgebung auf GNU/Linux ein +@dfn{Container}: Nicht nur hat er seinen eigenen Dateisystembaum, er hat +auch einen separaten Namensraum zum Einhängen von Dateisystemen, seinen +eigenen Namensraum für PIDs, für Netzwerke, etc. Dies hilft dabei, +reproduzierbare Erstellungen zu garantieren (@pxref{Funktionalitäten}). + +When the daemon performs a build on behalf of the user, it creates a build +directory under @file{/tmp} or under the directory specified by its +@code{TMPDIR} environment variable; this directory is shared with the +container for the duration of the build. Be aware that using a directory +other than @file{/tmp} can affect build results---for example, with a longer +directory name, a build process that uses Unix-domain sockets might hit the +name length limitation for @code{sun_path}, which it would otherwise not +hit. + +Nach Abschluss der Erstellung wird das Erstellungsverzeichnis automatisch +entfernt, außer wenn die Erstellung fehlgeschlagen ist und der Client +@option{--keep-failed} angegeben hat (@pxref{Aufruf von guix build, +@option{--keep-failed}}). + +The daemon listens for connections and spawns one sub-process for each +session started by a client (one of the @command{guix} sub-commands.) The +@command{guix processes} command allows you to get an overview of the +activity on your system by viewing each of the active sessions and clients. +@xref{Invoking guix processes}, for more information. + +Die folgenden Befehlszeilenoptionen werden unterstützt: + +@table @code +@item --build-users-group=@var{Gruppe} +Verwende die Benutzerkonten aus der @var{Gruppe}, um Erstellungsprozesse +auszuführen (@pxref{Den Daemon einrichten, build users}). + +@item --no-substitutes +@cindex Substitute +Benutze keine Substitute für Erstellungsergebnisse. Das heißt, dass alle +Objekte lokal erstellt werden müssen, und kein Herunterladen von vorab +erstellten Binärdateien erlaubt ist (@pxref{Substitute}). + +Wenn der Daemon mit @code{--no-substitutes} ausgeführt wird, können Clients +trotzdem Substitute explizit aktivieren über den entfernten Prozeduraufruf +@code{set-build-options} (@pxref{Der Store}). + +@item --substitute-urls=@var{URLs} +@anchor{daemon-substitute-urls} +Benutze @var{URLs} als standardmäßige, leerzeichengetrennte Liste der +Quell-URLs für Substitute. Wenn diese Befehlszeilenoption nicht angegeben +wird, wird @indicateurl{https://mirror.hydra.gnu.org https://hydra.gnu.org} +verwendet (@code{mirror.hydra.gnu.org} ist ein Spiegelserver für +@code{hydra.gnu.org}). + +Das hat zur Folge, dass Substitute von den @var{URLs} heruntergeladen werden +können, solange sie mit einer Signatur versehen sind, der vertraut wird +(@pxref{Substitute}). + +@cindex Build-Hook +@item --no-build-hook +Den »@dfn{Build-Hook}« nicht benutzen. + +»Build-Hook« ist der Name eines Hilfsprogramms, das der Daemon starten kann +und an das er Erstellungsanfragen übermittelt. Durch diesen Mechanismus +können Erstellungen an andere Maschinen ausgelagert werden (@pxref{Auslagern des Daemons einrichten}). + +@item --cache-failures +Fehler bei der Erstellung zwischenspeichern. Normalerweise werden nur +erfolgreiche Erstellungen gespeichert. + +Wenn diese Befehlszeilenoption benutzt wird, kann @command{guix gc +--list-failures} benutzt werden, um die Menge an Store-Objekten abzufragen, +die als Fehlschläge markiert sind; @command{guix gc --clear-failures} +entfernt Store-Objekte aus der Menge zwischengespeicherter +Fehlschläge. @xref{Aufruf von guix gc}. + +@item --cores=@var{n} +@itemx -c @var{n} +@var{n} CPU-Kerne zum Erstellen jeder Ableitung benutzen; @code{0} heißt, so +viele wie verfügbar sind. + +Der Vorgabewert ist @code{0}, jeder Client kann jedoch eine abweichende +Anzahl vorgeben, zum Beispiel mit der Befehlszeilenoption @code{--cores} von +@command{guix build} (@pxref{Aufruf von guix build}). + +Dadurch wird die Umgebungsvariable @code{NIX_BUILD_CORES} im +Erstellungsprozess definiert, welcher sie benutzen kann, um intern parallele +Ausführungen zuzulassen — zum Beispiel durch Nutzung von @code{make +-j$NIX_BUILD_CORES}. + +@item --max-jobs=@var{n} +@itemx -M @var{n} +Höchstenss @var{n} Erstellungsaufträge parallel bearbeiten. Der Vorgabewert +liegt bei @code{1}. Wird er auf @code{0} gesetzt, werden keine Erstellungen +lokal durchgeführt, stattdessen lagert der Daemon sie nur aus (@pxref{Auslagern des Daemons einrichten}) oder sie schlagen einfach fehl. + +@item --max-silent-time=@var{Sekunden} +Wenn der Erstellungs- oder Substitutionsprozess länger als +@var{Sekunden}-lang keine Ausgabe erzeugt, wird er abgebrochen und ein +Fehler beim Erstellen gemeldet. + +Der Vorgabewert ist @code{0}, was bedeutet, dass es keine Zeitbeschränkung +gibt. + +Clients können einen anderen Wert als den hier angegebenen verwenden lassen +(@pxref{Gemeinsame Erstellungsoptionen, @code{--max-silent-time}}). + +@item --timeout=@var{Sekunden} +Entsprechend wird hier der Erstellungs- oder Substitutionsprozess +abgebrochen und als Fehlschlag gemeldet, wenn er mehr als +@var{Sekunden}-lang dauert. + +Der Vorgabewert ist @code{0}, was bedeutet, dass es keine Zeitbeschränkung +gibt. + +Clients können einen anderen Wert verwenden lassen (@pxref{Gemeinsame Erstellungsoptionen, @code{--timeout}}). + +@item --rounds=@var{N} +Jede Ableitung @var{n}-mal hintereinander erstellen und einen Fehler melden, +wenn nacheinander ausgewertete Erstellungsergebnisse nicht Bit für Bit +identisch sind. Beachten Sie, dass Clients wie @command{guix build} einen +anderen Wert verwenden lassen können (@pxref{Aufruf von guix build}). + +Wenn dies zusammen mit @option{--keep-failed} benutzt wird, bleiben die sich +unterscheidenden Ausgaben im Store unter dem Namen +@file{/gnu/store/@dots{}-check}. Dadurch können Unterschiede zwischen den +beiden Ergebnissen leicht erkannt werden. + +@item --debug +Informationen zur Fehlersuche ausgeben. + +Dies ist nützlich, um Probleme beim Starten des Daemons nachzuvollziehen; +Clients könn aber auch ein abweichenden Wert verwenden lassen, zum Beispiel +mit der Befehlszeilenoption @code{--verbosity} von @command{guix build} +(@pxref{Aufruf von guix build}). + +@item --chroot-directory=@var{Verzeichnis} +Füge das @var{Verzeichnis} zum chroot von Erstellungen hinzu. + +Dadurch kann sich das Ergebnis von Erstellungsprozessen ändern — zum +Beispiel, wenn diese optionale Abhängigkeiten aus dem @var{Verzeichnis} +verwenden, wenn sie verfügbar sind, und nicht, wenn es fehlt. Deshalb ist es +nicht empfohlen, dass Sie diese Befehlszeilenoption besser verwenden, besser +sollten Sie dafür sorgen, dass jede Ableitung alle von ihr benötigten +Eingabgen deklariert. + +@item --disable-chroot +Erstellungen ohne chroot durchführen. + +Diese Befehlszeilenoption zu benutzen, wird nicht empfohlen, denn auch +dadurch bekämen Erstellungsprozesse Zugriff auf nicht deklarierte +Abhängigkeiten. Sie ist allerdings unvermeidlich, wenn @command{guix-daemon} +auf einem Benutzerkonto ohne ausreichende Berechtigungen ausgeführt wird. + +@item --log-compression=@var{Typ} +Erstellungsprotokolle werden entsprechend dem @var{Typ} komprimiert, der +entweder @code{gzip}, @code{bzip2} oder @code{none} (für keine Kompression) +sein muss. + +Sofern nicht @code{--lose-logs} angegeben wurde, werden alle +Erstellungsprotokolle in der @var{localstatedir} gespeichert. Um Platz zu +sparen, komprimiert sie der Daemon standardmäßig automatisch mit bzip2. + +@item --disable-deduplication +@cindex Deduplizieren +Automatische Dateien-»Deduplizierung« im Store ausschalten. + +Standardmäßig werden zum Store hinzugefügte Objekte automatisch +»dedupliziert«: Wenn eine neue Datei mit einer anderen im Store +übereinstimmt, wird die neue Datei stattdessen als harte Verknüpfung auf die +andere Datei angelegt. Dies reduziert den Speicherverbrauch auf der Platte +merklich, jedoch steigt andererseits die Auslastung bei der Ein-/Ausgabe im +Erstellungsprozess geringfügig. Durch diese Option wird keine solche +Optimierung durchgeführt. + +@item --gc-keep-outputs[=yes|no] +Gibt an, ob der Müllsammler (Garbage Collector, GC) die Ausgaben lebendiger +Ableitungen behalten muss (»yes«) oder nicht (»no«). + +@cindex GC-Wurzeln +@cindex Müllsammlerwurzeln +When set to ``yes'', the GC will keep the outputs of any live derivation +available in the store---the @code{.drv} files. The default is ``no'', +meaning that derivation outputs are kept only if they are reachable from a +GC root. @xref{Aufruf von guix gc}, for more on GC roots. + +@item --gc-keep-derivations[=yes|no] +Gibt an, ob der Müllsammler (GC) Ableitungen behalten muss (»yes«), wenn sie +lebendige Ausgaben haben, oder nicht (»no«). + +Für »yes«, den Vorgabewert, behält der Müllsammler Ableitungen — +z.B. @code{.drv}-Dateien —, solange zumindest eine ihrer Ausgaben lebendig +ist. Dadurch können Nutzer den Ursprung der Dateien in ihrem Store +nachvollziehen. Setzt man den Wert auf »no«, wird ein bisschen weniger +Speicher auf der Platte verbraucht. + +In this way, setting @code{--gc-keep-derivations} to ``yes'' causes liveness +to flow from outputs to derivations, and setting @code{--gc-keep-outputs} to +``yes'' causes liveness to flow from derivations to outputs. When both are +set to ``yes'', the effect is to keep all the build prerequisites (the +sources, compiler, libraries, and other build-time tools) of live objects in +the store, regardless of whether these prerequisites are reachable from a GC +root. This is convenient for developers since it saves rebuilds or +downloads. + +@item --impersonate-linux-2.6 +Auf Linux-basierten Systemen wird hiermit vorgetäuscht, dass es sich um +Linux 2.6 handeln würde, indem der Kernel für einen +@code{uname}-Systemaufruf als Version der Veröffentlichung mit 2.6 +antwortet. + +Dies kann hilfreich sein, um Programme zu erstellen, die (normalerweise zu +Unrecht) von der Kernel-Versionsnummer abhängen. + +@item --lose-logs +Keine Protokolle der Erstellungen vorhalten. Normalerweise würden solche in +@code{@var{localstatedir}/guix/log} gespeichert. + +@item --system=@var{System} +Verwende @var{System} als aktuellen Systemtyp. Standardmäßig ist dies das +Paar aus Befehlssatz und Kernel, welches beim Aufruf von @code{configure} +erkannt wurde, wie zum Beispiel @code{x86_64-linux}. + +@item --listen=@var{Endpunkt} +Lausche am @var{Endpunkt} auf Verbindungen. Dabei wird der @var{Endpunkt} +als Dateiname eines Unix-Sockets verstanden, wenn er mit einem @code{/} +(Schrägstrich) beginnt. Andernfalls wird der @var{Endpunkt} als Hostname +oder als Hostname-Port-Paar verstanden, auf dem gelauscht wird. Hier sind +ein paar Beispiele: + +@table @code +@item --listen=/gnu/var/daemon +Lausche auf Verbindungen am Unix-Socket @file{/gnu/var/daemon}, falls nötig +wird er dazu erstellt. + +@item --listen=localhost +@cindex Daemon, Fernzugriff +@cindex Fernzugriff auf den Daemon +@cindex Daemon, Einrichten auf Clustern +@cindex Cluster, Einrichtung des Daemons +Lausche auf TCP-Verbindungen an der Netzwerkschnittstelle, die +@code{localhost} entspricht, auf Port 44146. + +@item --listen=128.0.0.42:1234 +Lausche auf TCP-Verbindungen an der Netzwerkschnittstelle, die +@code{128.0.0.42} entspricht, auf Port 1234. +@end table + +Diese Befehlszeilenoption kann mehrmals wiederholt werden. In diesem Fall +akzeptiert @command{guix-daemon} Verbindungen auf allen angegebenen +Endpunkten. Benutzer können bei Client-Befehlen angeben, mit welchem +Endpunkt sie sich verbinden möchten, indem sie die Umgebungsvariable +@code{GUIX_DAEMON_SOCKET} festlegen (@pxref{Der Store, +@code{GUIX_DAEMON_SOCKET}}). + +@quotation Anmerkung +Das Daemon-Protokoll ist @emph{weder authentifiziert noch +verschlüsselt}. Die Benutzung von @code{--listen=@var{Host}} eignet sich für +lokale Netzwerke, wie z.B. in Rechen-Clustern, wo sich nur solche Knoten mit +dem Daemon verbinden, denen man vertraut. In Situationen, wo ein Fernzugriff +auf den Daemon durchgeführt wird, empfehlen wir, über Unix-Sockets in +Verbindung mit SSH zuzugreifen. +@end quotation + +Wird @code{--listen} nicht angegeben, lauscht @command{guix-daemon} auf +Verbindungen auf dem Unix-Socket, der sich unter +@file{@var{localstatedir}/guix/daemon-socket/socket} befindet. +@end table + + +@node Anwendungen einrichten +@section Anwendungen einrichten + +@cindex Fremddistribution +Läuft Guix aufgesetzt auf einer GNU/Linux-Distribution außer GuixSD — einer +sogenannten @dfn{Fremddistribution} —, so sind ein paar zusätzliche Schritte +bei der Einrichtung nötig. Hier finden Sie manche davon. + +@subsection Locales + +@anchor{locales-and-locpath} +@cindex Locales, nicht auf GuixSD +@vindex LOCPATH +@vindex GUIX_LOCPATH +Über Guix installierte Pakete benutzen nicht die Daten zu Regions- und +Spracheinstellungen (Locales) des Wirtssystems. Stattdessen müssen Sie erst +eines der Locale-Pakete installieren, die für Guix verfügbar sind, und dann +den Wert Ihrer Umgebungsvariablen @code{GUIX_LOCPATH} passend festlegen: + +@example +$ guix package -i glibc-locales +$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale +@end example + +Beachten Sie, dass das Paket @code{glibc-locales} Daten für alle von +GNU@tie{}libc unterstützten Locales enthält und deswegen um die 110@tie{}MiB +wiegt. Alternativ gibt es auch @code{glibc-utf8-locales}, was kleiner, aber +auf ein paar UTF-8-Locales beschränkt ist. + +Die Variable @code{GUIX_LOCPATH} spielt eine ähnliche Rolle wie +@code{LOCPATH} (@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C +Library Reference Manual}). Es gibt jedoch zwei wichtige Unterschiede: + +@enumerate +@item +@code{GUIX_LOCPATH} wird nur von der libc in Guix beachtet und nicht der von +Fremddistributionen bereitgestellten libc. Mit @code{GUIX_LOCPATH} können +Sie daher sicherstellen, dass die Programme der Fremddistribution keine +inkompatiblen Locale-Daten von Guix laden. + +@item +libc hängt an jeden @code{GUIX_LOCPATH}-Eintrag @code{/X.Y} an, wobei +@code{X.Y} die Version von libc ist — z.B. @code{2.22}. Sollte Ihr +Guix-Profil eine Mischung aus Programmen enthalten, die an verschiedene +libc-Versionen gebunden sind, wird jede nur die Locale-Daten im richtigen +Format zu laden versuchen. +@end enumerate + +Das ist wichtig, weil das Locale-Datenformat verschiedener libc-Versionen +inkompatibel sein könnte. + +@subsection Name Service Switch + +@cindex Name Service Switch, glibc +@cindex NSS (Name Service Switch), glibc +@cindex nscd (Name Service Caching Daemon) +@cindex Name Service Caching Daemon (nscd) +Wenn Sie Guix auf einer Fremddistribution verwenden, @emph{empfehlen wir +stärkstens}, dass Sie den @dfn{Name Service Cache Daemon} der +GNU-C-Bibliothek, @command{nscd}, laufen lassen, welcher auf dem Socket +@file{/var/run/nscd/socket} lauschen sollte. Wenn Sie das nicht tun, könnten +mit Guix installierte Anwendungen Probleme beim Auflösen von Hostnamen oder +Benutzerkonten haben, oder sogar abstürzen. Die nächsten Absätze erklären, +warum. + +@cindex @file{nsswitch.conf} +Die GNU-C-Bibliothek implementiert einen @dfn{Name Service Switch} (NSS), +welcher einen erweiterbaren Mechanismus zur allgemeinen »Namensauflösung« +darstellt: Hostnamensauflösung, Benutzerkonten und weiteres (@pxref{Name Service Switch,,, libc, The GNU C Library Reference Manual}). + +@cindex Network Information Service (NIS) +@cindex NIS (Network Information Service) +Für die Erweiterbarkeit unterstützt der NSS @dfn{Plugins}, welche neue +Implementierungen zur Namensauflösung bieten: Zum Beispiel ermöglicht das +Plugin @code{nss-mdns} die Namensauflösung für @code{.local}-Hostnamen, das +Plugin @code{nis} gestattet die Auflösung von Benutzerkonten über den +Network Information Service (NIS) und so weiter. Diese zusätzlichen +»Auflösungsdienste« werden systemweit konfiguriert in +@file{/etc/nsswitch.conf} und alle auf dem System laufenden Programme halten +sich an diese Einstellungen (@pxref{NSS Configuration File,,, libc, The GNU +C Reference Manual}). + +Wenn sie eine Namensauflösung durchführen — zum Beispiel, indem sie die +@code{getaddrinfo}-Funktion in C aufrufen — versuchen die Anwendungen als +Erstes, sich mit dem nscd zu verbinden; ist dies erfolgreich, führt nscd für +sie die weiteren Namensauflösungen durch. Falls nscd nicht läuft, führen sie +selbst die Namensauflösungen durch, indem sie die Namensauflösungsdienste in +ihren eigenen Adressraum laden und ausführen. Diese Namensauflösungsdienste +— die @file{libnss_*.so}-Dateien — werden mit @code{dlopen} geladen, aber +sie kommen von der C-Bibliothek des Wirtssystems und nicht von der +C-Bibliothek, mit der die Anwendung gebunden wurde (also der C-Bibliothek +von Guix). + +Und hier kommt es zum Problem: Wenn die Anwendung mit der C-Bibliothek von +Guix (etwa glibc 2.24) gebunden wurde und die NSS-Plugins von einer anderen +C-Bibliothek (etwa @code{libnss_mdns.so} für glibc 2.22) zu laden versucht, +wird sie vermutlich abstürzen oder die Namensauflösungen werden unerwartet +fehlschlagen. + +Durch das Ausführen von @command{nscd} auf dem System wird, neben anderen +Vorteilen, dieses Problem der binären Inkompatibilität vermieden, weil diese +@code{libnss_*.so}-Dateien vom @command{nscd}-Prozess geladen werden, nicht +in den Anwendungen selbst. + +@subsection X11-Schriftarten + +@cindex Schriftarten +Die Mehrheit der graphischen Anwendungen benutzen Fontconfig zum Finden und +Laden von Schriftarten und für die Darstellung im X11-Client. Im Paket +@code{fontconfig} in Guix werden Schriftarten standardmäßig in +@file{$HOME/.guix-profile} gesucht. Um es graphischen Anwendungen, die mit +Guix installiert wurden, zu ermöglichen, Schriftarten anzuzeigen, müssen Sie +die Schriftarten auch mit Guix installieren. Essenzielle Pakete für +Schriftarten sind unter Anderem @code{gs-fonts}, @code{font-dejavu} und +@code{font-gnu-freefont-ttf}. + +Um auf Chinesisch, Japanisch oder Koreanisch verfassten Text in graphischen +Anwendungen anzeigen zu können, möchten Sie vielleicht +@code{font-adobe-source-han-sans} oder @code{font-wqy-zenhei} +installieren. Ersteres hat mehrere Ausgaben, für jede Sprachfamilie eine +(@pxref{Pakete mit mehreren Ausgaben.}). Zum Beispiel installiert folgender +Befehl Schriftarten für chinesische Sprachen: + +@example +guix package -i font-adobe-source-han-sans:cn +@end example + +@cindex @code{xterm} +Ältere Programme wie @command{xterm} benutzen kein Fontconfig, sondern +X-Server-seitige Schriftartendarstellung. Solche Programme setzen voraus, +dass der volle Name einer Schriftart mit XLFD (X Logical Font Description) +angegeben wird, z.B. so: + +@example +-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1 +@end example + +Um solche vollen Namen für die in Ihrem Guix-Profil installierten +TrueType-Schriftarten zu verwenden, müssen Sie den Pfad für Schriftarten +(Font Path) des X-Servers anpassen: + +@c Note: 'xset' does not accept symlinks so the trick below arranges to +@c get at the real directory. See <https://bugs.gnu.org/30655>. +@example +xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir)) +@end example + +@cindex @code{xlsfonts} +Danach können Sie den Befehl @code{xlsfonts} ausführen (aus dem Paket +@code{xlsfonts}), um sicherzustellen, dass dort Ihre TrueType-Schriftarten +aufgeführt sind. + +@cindex @code{fc-cache} +@cindex Font-Cache +Nach der Installation der Schriftarten müssen Sie unter Umständen den +Schriftarten-Zwischenspeicher (Font-Cache) erneuern, um diese in Anwendungen +benutzen zu können. Gleiches gilt, wenn mit Guix installierte Anwendungen +anscheinend keine Schriftarten finden können. Um das Erneuern des +Font-Caches zu erzwingen, führen Sie @code{fc-cache -f} aus. Der Befehl +@code{fc-cache} wird vom Paket @code{fontconfig} angeboten. + +@subsection X.509-Zertifikate + +@cindex @code{nss-certs} +Das Paket @code{nss-certs} bietet X.509-Zertifikate, womit Programme die +Identität von Web-Servern authentifizieren können, auf die über HTTPS +zugegriffen wird. + +Wenn Sie Guix auf einer Fremddistribution verwenden, können Sie dieses Paket +installieren und die relevanten Umgebungsvariablen festlegen, damit Pakete +wissen, wo sie Zertifikate finden. In @xref{X.509-Zertifikate} stehen +genaue Informationen. + +@subsection Emacs-Pakete + +@cindex @code{emacs} +Wenn Sie mit Guix Pakete für Emacs installieren, werden deren elisp-Dateien +entweder in @file{$HOME/.guix-profile/share/emacs/site-lisp/} oder in +Unterverzeichnissen von +@file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/} +gespeichert. Letzteres Verzeichnis gibt es, weil es Tausende von +Emacs-Paketen gibt und sie alle im selben Verzeichnis zu speichern +vielleicht nicht verlässlich funktioniert (wegen Namenskonflikten). Daher +halten wir es für richtig, für jedes Paket ein anderes Verzeichnis zu +benutzen. Das Emacs-Paketsystem organisiert die Dateistruktur ähnlich +(@pxref{Package Files,,, emacs, The GNU Emacs Manual}). + +Standardmäßig »weiß« Emacs (wenn er mit Guix installiert wurde), wo diese +Pakete liegen, sie müssen also nichts selbst konfigurieren. Wenn Sie aber +aus irgendeinem Grund mit Guix installierte Pakete nicht automatisch laden +lassen möchten, können Sie Emacs mit der Befehlszeilenoption +@code{--no-site-file} starten (@pxref{Init File,,, emacs, The GNU Emacs +Manual}). + +@subsection GCC-Toolchain + +@cindex GCC +@cindex ld-wrapper + +Guix bietet individuelle Compiler-Pakete wie etwa @code{gcc}, aber wenn Sie +einen vollständigen Satz an Werkzeugen zum Kompilieren und Binden von +Quellcode brauchen, werden Sie eigentlich das Paket @code{gcc-toolchain} +haben wollen. Das Paket bietet eine vollständige GCC-Toolchain für die +Entwicklung mit C/C++, einschließlich GCC selbst, der GNU-C-Bibliothek +(Header-Dateien und Binärdateien samt Symbolen zur Fehlersuche/Debugging in +der @code{debug}-Ausgabe), Binutils und einen Wrapper für den Binder/Linker. + +@cindex Versuch, unreine Bibliothek zu benutzen, Fehlermeldung + +Der Zweck des Wrappers ist, die an den Binder übergebenen +Befehlszeilenoptionen mit @code{-L} und @code{-l} zu überprüfen und jeweils +passende Argumente mit @code{-rpath} anzufügen, womit dann der echte Binder +aufgerufen wird. Standardmäßig weigert sich der Binder-Wrapper, mit +Bibliotheken außerhalb des Stores zu binden, um »Reinheit« zu +gewährleisten. Das kann aber stören, wenn man die Toolchain benutzt, um mit +lokalen Bibliotheken zu binden. Um Referenzen auf Bibliotheken außerhalb des +Stores zu erlauben, müssen Sie die Umgebungsvariable +@code{GUIX_LD_WRAPPER_ALLOW_IMPURITIES} setzen. + +@c TODO What else? + +@c ********************************************************************* +@node Paketverwaltung +@chapter Paketverwaltung + +@cindex Pakete +Der Zweck von GNU Guix ist, Benutzern die leichte Installation, +Aktualisierung und Entfernung von Software-Paketen zu ermöglichen, ohne dass +sie ihre Erstellungsprozeduren oder Abhängigkeiten kennen müssen. Guix kann +natürlich noch mehr als diese offensichtlichen Funktionalitäten. + +Dieses Kapitel beschreibt die Hauptfunktionalitäten von Guix, sowie die von +Guix angebotenen Paketverwaltungswerkzeuge. Zusätzlich von den im Folgenden +beschriebenen Befehlszeilen-Benutzerschnittstellen (@pxref{Aufruf von guix package, @code{guix package}}) können Sie auch mit der +Emacs-Guix-Schnittstelle (@pxref{Top,,, emacs-guix, The Emacs-Guix Reference +Manual}) arbeiten, nachdem Sie das Paket @code{emacs-guix} installiert haben +(führen Sie zum Einstieg in Emacs-Guix den Emacs-Befehl @kbd{M-x guix-help} +aus): + +@example +guix package -i emacs-guix +@end example + +@menu +* Funktionalitäten:: Wie Guix Ihr Leben schöner machen wird. +* Aufruf von guix package:: Pakete installieren, entfernen usw. +* Substitute:: Vorerstelle Binärdateien herunterladen. +* Pakete mit mehreren Ausgaben.:: Ein Quellpaket, mehrere Ausgaben. +* Aufruf von guix gc:: Den Müllsammler laufen lassen. +* Aufruf von guix pull:: Das neueste Guix samt Distribution laden. +* Channels:: Customizing the package collection. +* Inferiors:: Interacting with another revision of Guix. +* Invoking guix describe:: Display information about your Guix revision. +* Aufruf von guix pack:: Software-Bündel erstellen. +* Aufruf von guix archive:: Import und Export von Store-Dateien. +@end menu + +@node Funktionalitäten +@section Funktionalitäten + +Wenn Sie Guix benutzen, landet jedes Paket schließlich im @dfn{Paket-Store} +in seinem eigenen Verzeichnis — der Name ist ähnlich wie +@file{/gnu/store/xxx-package-1.2}, wobei @code{xxx} eine Zeichenkette in +Base32-Darstellung ist. + +Statt diese Verzeichnisse direkt anzugeben, haben Nutzer ihr eigenes +@dfn{Profil}, welches auf diejenigen Pakete zeigt, die sie tatsächlich +benutzen wollen. Diese Profile sind im Persönlichen Ordner des jeweiligen +Nutzers gespeichert als @code{$HOME/.guix-profile}. + +Zum Beispiel installiert @code{alice} GCC 4.7.2. Dadurch zeigt dann +@file{/home/alice/.guix-profile/bin/gcc} auf +@file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Auf demselben Rechner hat +@code{bob} bbereits GCC 4.8.0 installiert. Das Profil von @code{bob} zeigt +dann einfach weiterhin auf @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc} — +d.h. beide Versionen von GCC koexistieren auf demselben System, ohne sich zu +stören. + +Der Befehl @command{guix package} ist das zentrale Werkzeug, um Pakete zu +verwalten (@pxref{Aufruf von guix package}). Es arbeitet auf dem eigenen +Profil jedes Nutzers und kann @emph{mit normalen Benutzerrechten} ausgeführt +werden. + +@cindex Transaktionen +Der Befehl stellt die offensichtlichen Installations-, Entfernungs- und +Aktualisierungsoperationen zur Verfügung. Jeder Aufruf ist tatsächlich eine +eigene @emph{Transaktion}: Entweder die angegebene Operation wird +erfolgreich durchgeführt, oder gar nichts passiert. Wenn also der Prozess +von @command{guix package} während der Transaktion beendet wird, oder es zum +Stromausfall während der Transaktion kommt, dann bleibt der alte, nutzbare +Zustands des Nutzerprofils erhalten. + +Zudem kann jede Pakettransaktion @emph{zurückgesetzt} werden +(Rollback). Wenn also zum Beispiel durch eine Aktualisierung eine neue +Version eines Pakets installiert, die einen schwerwiegenden Fehler zur Folge +hat, können Nutzer ihr Profil einfach auf die vorherige Profilinstanz +zurücksetzen, von der sie wissen, dass sie gut lief. Ebenso unterliegt auf +GuixSD auch die globale Systemkonfiguration transaktionellen +Aktualisierungen und Rücksetzungen (@pxref{Das Konfigurationssystems nutzen}). + +Alle Pakete im Paket-Store können vom @emph{Müllsammler} (Garbage Collector) +gelöscht werden. Guix ist in der Lage, festzustellen, welche Pakete noch +durch Benutzerprofile referenziert werden, und entfernt nur diese, die +nachweislich nicht mehr referenziert werden (@pxref{Aufruf von guix gc}). Benutzer können auch ausdrücklich alte Generationen ihres Profils +löschen, damit die zugehörigen Pakete vom Müllsammler gelöscht werden +können. + +@cindex Reproduzierbarkeit +@cindex Reproduzierbare Erstellungen +Guix takes a @dfn{purely functional} approach to package management, as +described in the introduction (@pxref{Einführung}). Each +@file{/gnu/store} package directory name contains a hash of all the inputs +that were used to build that package---compiler, libraries, build scripts, +etc. This direct correspondence allows users to make sure a given package +installation matches the current state of their distribution. It also helps +maximize @dfn{build reproducibility}: thanks to the isolated build +environments that are used, a given build is likely to yield bit-identical +files when performed on different machines (@pxref{Aufruf des guix-daemon, +container}). + +@cindex Substitute +Auf dieser Grundlage kann Guix @dfn{transparent Binär- oder Quelldateien +ausliefern}. Wenn eine vorerstellte Binärdatei für ein +@file{/gnu/store}-Objekt von einer externen Quelle verfügbar ist — ein +@dfn{Substitut} —, lädt Guix sie einfach herunter und entpackt sie, +andernfalls erstellt Guix das Paket lokal aus seinem Quellcode +(@pxref{Substitute}). Weil Erstellungsergebnisse normalerweise Bit für Bit +reproduzierbar sind, müssen die Nutzer den Servern, die Substitute anbieten, +nicht blind vertrauen; sie können eine lokale Erstellung erzwingen und +Substitute @emph{anfechten} (@pxref{Aufruf von guix challenge}). + +Kontrolle über die Erstellungsumgebung ist eine auch für Entwickler +nützliche Funktionalität. Der Befehl @command{guix environment} ermöglicht +es Entwicklern eines Pakets, schnell die richtige Entwicklungsumgebung für +ihr Paket einzurichten, ohne manuell die Abhängigkeiten des Pakets in ihr +Profil installieren zu müssen (@pxref{Aufruf von guix environment}). + +@cindex replication, of software environments +@cindex provenance tracking, of software artifacts +All of Guix and its package definitions is version-controlled, and +@command{guix pull} allows you to ``travel in time'' on the history of Guix +itself (@pxref{Aufruf von guix pull}). This makes it possible to replicate a +Guix instance on a different machine or at a later point in time, which in +turn allows you to @emph{replicate complete software environments}, while +retaining precise @dfn{provenance tracking} of the software. + +@node Aufruf von guix package +@section Invoking @command{guix package} + +@cindex Installieren von Paketen +@cindex Entfernen von Paketen +@cindex Paketinstallation +@cindex Paketentfernung +Der Befehl @command{guix package} ist ein Werkzeug, womit Nutzer Pakete +installieren, aktualisieren, entfernen und auf vorherige Konfigurationen +zurücksetzen können. Dabei wird nur das eigene Profil des Nutzers verwendet, +und es funktioniert mit normalen Benutzerrechten, ohne Administratorrechte +(@pxref{Funktionalitäten}). Die Syntax ist: + +@example +guix package @var{Optionen} +@end example +@cindex Transaktionen +In erster Linie geben die @var{Optionen} an, welche Operationen in der +Transaktion durchgeführt werden sollen. Nach Abschluss wird ein neues Profil +erzeugt, aber vorherige @dfn{Generationen} des Profils bleiben verfügbar, +falls der Benutzer auf sie zurückwechseln will. + +Um zum Beispiel @code{lua} zu entfernen und @code{guile} und +@code{guile-cairo} in einer einzigen Transaktion zu installieren: + +@example +guix package -r lua -i guile guile-cairo +@end example + +@command{guix package} unterstützt auch ein @dfn{deklaratives Vorgehen}, +wobei der Nutzer die genaue Menge an Paketen, die verfügbar sein sollen, +festlegt und über die Befehlszeilenoption @option{--manifest} übergibt +(@pxref{profile-manifest, @option{--manifest}}). + +@cindex Profil +Für jeden Benutzer wird automatisch eine symbolische Verknüpfung zu seinem +Standardprofil angelegt als @file{$HOME/.guix-profile}. Diese symbolische +Verknüpfung zeigt immer auf die aktuelle Generation des Standardprofils des +Benutzers. Somit können Nutzer @file{$HOME/.guix-profile/bin} z.B. zu ihrer +Umgebungsvariablen @code{PATH} hinzufügen. +@cindex Suchpfade +Wenn Sie nicht die Guix System Distribution benutzen, sollten Sie in +Betracht ziehen, folgende Zeilen zu Ihrem @file{~/.bash_profile} +hinzuzufügen (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference +Manual}), damit in neu erzeugten Shells alle Umgebungsvariablen richtig +definiert werden: + +@example +GUIX_PROFILE="$HOME/.guix-profile" ; \ +source "$HOME/.guix-profile/etc/profile" +@end example + +Ist Ihr System für mehrere Nutzer eingerichtet, werden Nutzerprofile an +einem Ort gespeichert, der als @dfn{Müllsammlerwurzel} registriert ist, auf +die @file{$HOME/.guix-profile} zeigt (@pxref{Aufruf von guix gc}). Dieses +Verzeichnis ist normalerweise +@code{@var{localstatedir}/guix/profiles/per-user/@var{Benutzer}}, wobei +@var{localstatedir} der an @code{configure} als @code{--localstatedir} +übergebene Wert ist und @var{Benutzer} für den jeweiligen Benutzernamen +steht. Das @file{per-user}-Verzeichnis wird erstellt, wenn +@command{guix-daemon} gestartet wird, und das Unterverzeichnis +@var{Benutzer} wird durch @command{guix package} erstellt. + +Als @var{Optionen} kann vorkommen: + +@table @code + +@item --install=@var{Paket} @dots{} +@itemx -i @var{Paket} @dots{} +Die angegebenen @var{Paket}e installieren. + +Jedes @var{Paket} kann entweder einfach durch seinen Paketnamen aufgeführt +werden, wie @code{guile}, oder als Paketname gefolgt von einem At-Zeichen @@ +und einer Versionsnummer, wie @code{guile@@1.8.8} oder auch nur +@code{guile@@1.8} (in letzterem Fall wird die neueste Version mit Präfix +@code{1.8} ausgewählt.) + +Wird keine Versionsnummer angegeben, wird die neueste verfügbare Version +ausgewählt. Zudem kann im @var{Paket} ein Doppelpunkt auftauchen, gefolgt +vom Namen einer der Ausgaben des Pakets, wie @code{gcc:doc} oder +@code{binutils@@2.22:lib} (@pxref{Pakete mit mehreren Ausgaben.}). Pakete +mit zugehörigem Namen (und optional der Version) werden unter den Modulen +der GNU-Distribution gesucht (@pxref{Paketmodule}). + +@cindex propagierte Eingaben +Manchmal haben Pakete @dfn{propagierte Eingaben}: Als solche werden +Abhängigkeiten bezeichnet, die automatisch zusammen mit dem angeforderten +Paket installiert werden (im Abschnitt @pxref{package-propagated-inputs, +@code{propagated-inputs} in @code{package} objects} sind weitere +Informationen über propagierte Eingaben in Paketdefinitionen zu finden). + +@anchor{package-cmd-propagated-inputs} +Ein Beispiel ist die GNU-MPC-Bibliothek: Ihre C-Headerdateien verweisen auf +die der GNU-MPFR-Bibliothek, welche wiederum auf die der GMP-Bibliothek +verweisen. Wenn also MPC installiert wird, werden auch die MPFR- und +GMP-Bibliotheken in das Profil installiert; entfernt man MPC, werden auch +MPFR und GMP entfernt — außer sie wurden noch auf andere Art ausdrücklich +vom Nutzer installiert. + +Abgesehen davon setzen Pakete manchmal die Definition von Umgebungsvariablen +für ihre Suchpfade voraus (siehe die Erklärung von @code{--search-paths} +weiter unten). Alle fehlenden oder womöglich falschen Definitionen von +Umgebungsvariablen werden hierbei gemeldet. + +@item --install-from-expression=@var{Ausdruck} +@itemx -e @var{Ausdruck} +Das Paket installieren, zu dem der @var{Ausdruck} ausgewertet wird. + +Beim @var{Ausdruck} muss es sich um einen Scheme-Ausdruck handeln, der zu +einem @code{<package>}-Objekt ausgewertet wird. Diese Option ist besonders +nützlich, um zwischen gleichnamigen Varianten eines Pakets zu unterscheiden, +durch Ausdrücke wie @code{(@@ (gnu packages base) guile-final)}. + +Beachten Sie, dass mit dieser Option die erste Ausgabe des angegebenen +Pakets installiert wird, was unzureichend sein kann, wenn eine bestimmte +Ausgabe eines Pakets mit mehreren Ausgaben gewünscht ist. + +@item --install-from-file=@var{Datei} +@itemx -f @var{Datei} +Das Paket installieren, zu dem der Code in der @var{Datei} ausgewertet wird. + +Zum Beispiel könnte die @var{Datei} eine Definition wie diese enthalten +(@pxref{Pakete definieren}): + +@example +@verbatiminclude package-hello.scm +@end example + +Entwickler könnten es für nützlich erachten, eine solche +@file{guix.scm}-Datei im Quellbaum ihres Projekts abzulegen, mit der +Zwischenstände der Entwicklung getestet und reproduzierbare +Erstellungsumgebungen aufgebaut werden können (@pxref{Aufruf von guix environment}). + +@item --remove=@var{Paket} @dots{} +@itemx -r @var{Paket} @dots{} +Die angegebenen @var{Paket}e entfernen. + +Wie auch bei @code{--install} kann jedes @var{Paket} neben dem Paketnamen +auch eine Versionsnummer und/oder eine Ausgabe benennen. Zum Beispiel würde +@code{-r glibc:debug} die @code{debug}-Ausgabe von @code{glibc} aus dem +Profil entfernen. + +@item --upgrade[=@var{Regexp} @dots{}] +@itemx -u [@var{Regexp} @dots{}] +@cindex Pakete aktualisieren +Alle installierten Pakete aktualisieren. Wenn einer oder mehr reguläre +Ausdrücke (Regexps) angegeben wurden, werden nur diejenigen installierten +Pakete aktualisiert, deren Name zu einer der @var{Regexp}s passt. Siehe auch +weiter unten die Befehlszeilenoption @code{--do-not-upgrade}. + +Beachten Sie, dass das Paket so auf die neueste Version unter den Paketen +gebracht wird, die in der aktuell installierten Distribution vorliegen. Um +jedoch Ihre Distribution zu aktualisieren, sollten Sie regelmäßig +@command{guix pull} ausführen (@pxref{Aufruf von guix pull}). + +@item --do-not-upgrade[=@var{Regexp} @dots{}] +In Verbindung mit der Befehlszeilenoption @code{--upgrade}, führe +@emph{keine} Aktualisierung von Paketen durch, deren Name zum regulären +Ausdruck @var{Regexp} passt. Um zum Beispiel alle Pakete im aktuellen Profil +zu aktualisieren mit Ausnahme derer, die »emacs« im Namen haben: + +@example +$ guix package --upgrade . --do-not-upgrade emacs +@end example + +@item @anchor{profile-manifest}--manifest=@var{Datei} +@itemx -m @var{Datei} +@cindex Profildeklaration +@cindex Profilmanifest +Erstellt eine neue Generation des Profils aus dem vom Scheme-Code in +@var{Datei} gelieferten Manifest-Objekt. + +Dadurch könnrn Sie den Inhalt des Profils @emph{deklarieren}, statt ihn +durch eine Folge von Befehlen wie @code{--install} u.Ä. zu generieren. Der +Vorteil ist, dass die @var{Datei} unter Versionskontrolle gestellt werden +kann, auf andere Maschinen zum Reproduzieren desselben Profils kopiert +werden kann und Ähnliches. + +@c FIXME: Add reference to (guix profile) documentation when available. +Der Code in der @var{Datei} muss ein @dfn{Manifest}-Objekt liefern, was +ungefähr einer Liste von Paketen entspricht: + +@findex packages->manifest +@example +(use-package-modules guile emacs) + +(packages->manifest + (list emacs + guile-2.0 + ;; Eine bestimmte Paketausgabe nutzen. + (list guile-2.0 "debug"))) +@end example + +@findex specifications->manifest +In diesem Beispiel müssen wir wissen, welche Module die Variablen +@code{emacs} und @code{guile-2.0} definieren, um die richtige Angabe mit +@code{use-package-modules} machen zu können, was umständlich sein kann. Wir +können auch normale Paketnamen angeben und sie durch +@code{specifications->manifest} zu den entsprechenden Paketobjekten +auflösen, zum Beispiel so: + +@example +(specifications->manifest + '("emacs" "guile@@2.2" "guile@@2.2:debug")) +@end example + +@item --roll-back +@cindex rücksetzen +@cindex Zurücksetzen von Transaktionen +@cindex Transaktionen, zurücksetzen +Wechselt zur vorherigen @dfn{Generation} des Profils zurück — d.h. mache die +letzte Transaktion rückgängig. + +In Verbindung mit Befehlszeilenoptionen wie @code{--install} wird zuerst +zurückgesetzt, bevor andere Aktionen durchgeführt werden. + +Ein Rücksetzen der ersten Generation, die installierte Pakete enthält, +wechselt das Profil zur @dfn{nullten Generation}, die keinerlei Dateien +enthält, abgesehen von Metadaten über sich selbst. + +Nach dem Zurücksetzen überschreibt das Installieren, Entfernen oder +Aktualisieren von Paketen vormals zukünftige Generationen, d.h. der Verlauf +der Generationen eines Profils ist immer linear. + +@item --switch-generation=@var{Muster} +@itemx -S @var{Muster} +@cindex Generationen +Wechselt zu der bestimmten Generation, die durch das @var{Muster} bezeichnet +wird. + +Als @var{Muster} kann entweder die Nummer einer Generation oder eine Nummer +mit vorangestelltem »+« oder »-« dienen. Letzteres springt die angegebene +Anzahl an Generationen vor oder zurück. Zum Beispiel kehrt +@code{--switch-generation=+1} nach einem Zurücksetzen wieder zur neueren +Generation zurück. + +Der Unterschied zwischen @code{--roll-back} und +@code{--switch-generation=-1} ist, dass @code{--switch-generation} keine +nullte Generation erzeugen wird; existiert die angegebene Generation nicht, +bleibt schlicht die aktuelle Generation erhalten. + +@item --search-paths[=@var{Art}] +@cindex Suchpfade +Führe die Definitionen von Umgebungsvariablen auf, in Bash-Syntax, die nötig +sein könnten, um alle installierten Pakete nutzen zu können. Diese +Umgebungsvariablen werden benutzt, um die @dfn{Suchpfade} für Dateien +festzulegen, die von einigen installierten Paketen benutzt werden. + +Zum Beispiel braucht GCC die Umgebungsvariablen @code{CPATH} und +@code{LIBRARY_PATH}, um zu wissen, wo sich im Benutzerprofil Header und +Bibliotheken befinden (@pxref{Environment Variables,,, gcc, Using the GNU +Compiler Collection (GCC)}). Wenn GCC und, sagen wir, die C-Bibliothek im +Profil installiert sind, schlägt @code{--search-paths} also vor, diese +Variablen jeweils auf @code{@var{profile}/include} und +@code{@var{profile}/lib} verweisen zu lassen. + +Die typische Nutzung ist, in der Shell diese Variablen zu definieren: + +@example +$ eval `guix package --search-paths` +@end example + +Als @var{Art} kann entweder @code{exact}, @code{prefix} oder @code{suffix} +gewählt werden, wodurch die gelieferten Definitionen der Umgebungsvariablen +entweder exakt die Einstellungen für Guix meldet, oder sie als Präfix oder +Suffix an den aktuellen Wert dieser Variablen anhängt. Gibt man keine +@var{Art} an, wird der Vorgabewert @code{exact} verwendet. + +Diese Befehlszeilenoption kann auch benutzt werden, um die +@emph{kombinierten} Suchpfade mehrerer Profile zu berechnen. Betrachten Sie +dieses Beispiel: + +@example +$ guix package -p foo -i guile +$ guix package -p bar -i guile-json +$ guix package -p foo -p bar --search-paths +@end example + +Der letzte Befehl oben meldet auch die Definition der Umgebungsvariablen +@code{GUILE_LOAD_PATH}, obwohl für sich genommen weder @file{foo} noch +@file{bar} zu dieser Empfehlung führen würden. + + +@item --profile=@var{Profil} +@itemx -p @var{Profil} +Auf @var{Profil} anstelle des Standardprofils des Benutzers arbeiten. + +@cindex Kollisionen, in einem Profil +@cindex Paketkollisionen in Profilen +@cindex Profilkollisionen +@item --allow-collisions +Kollidierende Pakete im neuen Profil zulassen. Benutzung auf eigene Gefahr! + +Standardmäßig wird @command{guix package} @dfn{Kollisionen} als Fehler +auffassen und melden. Zu Kollisionen kommt es, wenn zwei oder mehr +verschiedene Versionen oder Varianten desselben Pakets im Profil landen. + +@item --verbose +Erzeugt ausführliche Textausgaben. Insbesondere wird auch das +Erstellungsprotokoll der Umgebung auf dem Standard-Fehler-Port (stderr) +ausgegeben. + +@item --bootstrap +Erstellt das Profil mit dem Bootstrap-Guile. Diese Option ist nur für +Entwickler der Distribution nützlich. + +@end table + +Zusätzlich zu diesen Aktionen unterstützt @command{guix package} folgende +Befehlszeilenoptionen, um den momentanen Zustand eines Profils oder die +Verfügbarkeit von Paketen nachzulesen: + +@table @option + +@item --search=@var{Regexp} +@itemx -s @var{Regexp} +@cindex Suche nach Paketen +Führt alle verfügbaren Pakete aus, deren Name, Zusammenfassung oder +Beschreibung zum regulären Ausdruck @var{Regexp} passt, sortiert nach ihrer +Relevanz. Alle Metadaten passender Pakete werden im @code{recutils}-Format +geliefert (@pxref{Top, GNU recutils databases,, recutils, GNU recutils +manual}). + +So können bestimmte Felder mit dem Befehl @command{recsel} extrahiert +werden, zum Beispiel: + +@example +$ guix package -s malloc | recsel -p name,version,relevance +name: jemalloc +version: 4.5.0 +relevance: 6 + +name: glibc +version: 2.25 +relevance: 1 + +name: libgc +version: 7.6.0 +relevance: 1 +@end example + +Ebenso kann der Name aller zu den Bedingungen der GNU@tie{}LGPL, Version 3, +verfügbaren Pakete ermittelt werden: + +@example +$ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"' +name: elfutils + +name: gmp +@dots{} +@end example + +Es ist auch möglich, Suchergebnisse näher einzuschränken, indem Sie +@code{-s} mehrmals übergeben. Zum Beispiel liefert folgender Befehl eines +Liste von Brettspielen: + +@example +$ guix package -s '\<board\>' -s game | recsel -p name +name: gnubg +@dots{} +@end example + +Würden wir @code{-s game} weglassen, bekämen wir auch Software-Pakete +aufgelistet, die mit »printed circuit boards« (elektronischen Leiterplatten) +zu tun haben; ohne die spitzen Klammern um @code{board} bekämen wir auch +Pakete, die mit »keyboards« (Tastaturen, oder musikalischen Keyboard) zu tun +haben. + +Es ist Zeit für ein komplexeres Beispiel. Folgender Befehl sucht +kryptographische Bibliotheken, filtert Haskell-, Perl-, Python- und +Ruby-Bibliotheken heraus und gibt Namen und Zusammenfassung passender Pakete +aus: + +@example +$ guix package -s crypto -s library | \ + recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis +@end example + +@noindent +@xref{Selection Expressions,,, recutils, GNU recutils manual} enthält +weitere Informationen über @dfn{Auswahlausdrücke} mit @code{recsel -e}. + +@item --show=@var{Paket} +Zeigt Details über das @var{Paket} aus der Liste verfügbarer Pakete, im +@code{recutils}-Format (@pxref{Top, GNU recutils databases,, recutils, GNU +recutils manual}). + +@example +$ guix package --show=python | recsel -p name,version +name: python +version: 2.7.6 + +name: python +version: 3.3.5 +@end example + +Sie können auch den vollständigen Namen eines Pakets angeben, um Details nur +über diese Version angezeigt zu bekommen: +@example +$ guix package --show=python@@3.4 | recsel -p name,version +name: python +version: 3.4.3 +@end example + + + +@item --list-installed[=@var{Regexp}] +@itemx -I [@var{Regexp}] +Listet die derzeit installierten Pakete im angegebenen Profil auf, die +zuletzt installierten Pakete zuletzt. Wenn ein regulärer Ausdruck +@var{Regexp} angegeben wird, werden nur installierte Pakete aufgeführt, +deren Name zu @var{Regexp} passt. + +Zu jedem installierten Paket werden folgende Informationen angezeigt, durch +Tabulatorzeichen getrennt: der Paketname, die Version als Zeichenkette, +welche Teile des Pakets installiert sind (zum Beispiel @code{out}, wenn die +Standard-Paketausgabe installiert ist, @code{include}, wenn seine Header +installiert sind, usw.) und an welchem Pfad das Paket im Store zu finden +ist. + +@item --list-available[=@var{Regexp}] +@itemx -A [@var{Regexp}] +Listet Pakete auf, die in der aktuell installierten Distribution dieses +Systems verfügbar sind (@pxref{GNU-Distribution}). Wenn ein regulärer +Ausdruck @var{Regexp} angegeben wird, werden nur Pakete aufgeführt, deren +Name zum regulären Ausdruck @var{Regexp} passt. + +Zu jedem Paket werden folgende Informationen getrennt durch Tabulatorzeichen +ausgegeben: der Name, die Version als Zeichenkette, die Teile des Programms +(@pxref{Pakete mit mehreren Ausgaben.}) und die Stelle im Quellcode, an der +das Paket definiert ist. + +@item --list-generations[=@var{Muster}] +@itemx -l [@var{Muster}] +@cindex Generationen +Liefert eine Liste der Generationen zusammen mit dem Datum, an dem sie +erzeugt wurden; zu jeder Generation werden zudem die installierten Pakete +angezeigt, zuletzt installierte Pakete zuletzt. Beachten Sie, dass die +nullte Generation niemals angezeigt wird. + +Zu jedem installierten Paket werden folgende Informationen durch +Tabulatorzeichen getrennt angezeigt: der Name des Pakets, die Version als +Zeichenkette, welcher Teil des Pakets installiert ist (@pxref{Pakete mit mehreren Ausgaben.}) und an welcher Stelle sich das Paket im Store befindet. + +Wenn ein @var{Muster} angegeben wird, liefert der Befehl nur dazu passende +Generationen. Gültige Muster sind zum Beispiel: + +@itemize +@item @emph{Ganze Zahlen und kommagetrennte ganze Zahlen}. Beide Muster bezeichnen +Generationsnummern. Zum Beispiel liefert @code{--list-generations=1} die +erste Generation. + +Durch @code{--list-generations=1,8,2} werden drei Generationen in der +angegebenen Reihenfolge angezeigt. Weder Leerzeichen noch ein Komma am +Schluss der Liste ist erlaubt. + +@item @emph{Bereiche}. @code{--list-generations=2..9} gibt die +angegebenen Generationen und alles dazwischen aus. Beachten Sie, dass der +Bereichsanfang eine kleinere Zahl als das Bereichsende sein muss. + +Sie können auch kein Bereichsende angeben, zum Beispiel liefert +@code{--list-generations=2..} alle Generationen ab der zweiten. + +@item @emph{Zeitdauern}. Sie können auch die letzten @emph{N}@tie{}Tage, Wochen +or months by passing an integer along with the first letter of the +duration. For example, @code{--list-generations=20d} lists generations that +are up to 20 days old. +@end itemize + +@item --delete-generations[=@var{Muster}] +@itemx -d [@var{Muster}] +Wird kein @var{Muster} angegeben, werden alle Generationen außer der +aktuellen entfernt. + +Dieser Befehl akzeptiert dieselben Muster wie +@option{--list-generations}. Wenn ein @var{Muster} angegeben wird, werden +die passenden Generationen gelöscht. Wenn das @var{Muster} für eine +Zeitdauer steht, werden diejenigen Generationen gelöscht, die @emph{älter} +als die angegebene Dauer sind. Zum Beispiel löscht +@code{--delete-generations=1m} die Generationen, die mehr als einen Monat +alt sind. + +Falls die aktuelle Generation zum Muster passt, wird sie @emph{nicht} +gelöscht. Auch die nullte Generation wird niemals gelöscht. + +Beachten Sie, dass Sie auf gelöschte Generationen nicht zurückwechseln +können. Dieser Befehl sollte also nur mit Vorsicht benutzt werden. + +@end table + +Zu guter Letzt können Sie, da @command{guix package} Erstellungsprozesse zu +starten vermag, auch alle gemeinsamen Erstellungsoptionen (@pxref{Gemeinsame Erstellungsoptionen}) verwenden. Auch Paketumwandlungsoptionen wie +@option{--with-source} sind möglich (@pxref{Paketumwandlungsoptionen}). Beachten Sie jedoch, dass die verwendeten +Paketumwandlungsoptionen verloren gehen, nachdem Sie die Pakete aktualisiert +haben. Damit Paketumwandlungen über Aktualisierungen hinweg erhalten +bleiben, sollten Sie Ihre eigene Paketvariante in einem Guile-Modul +definieren und zur Umgebungsvariablen @code{GUIX_PACKAGE_PATH} hinzufügen +(@pxref{Pakete definieren}). + +@node Substitute +@section Substitute + +@cindex Substitute +@cindex vorerstellte Binärdateien +Guix kann transparent Binär- oder Quelldateien ausliefern. Das heißt, Dinge +können sowohl lokal erstellt, als auch als vorerstellte Objekte von einem +Server heruntergeladen werden, oder beides gemischt. Wir bezeichnen diese +vorerstellten Objekte als @dfn{Substitute} — sie substituieren lokale +Erstellungsergebnisse. In vielen Fällen geht das Herunterladen eines +Substituts wesentlich schneller, als Dinge lokal zu erstellen. + +Substitute können alles sein, was das Ergebnis einer Ableitungserstellung +ist (@pxref{Ableitungen}). Natürlich sind sie üblicherweise vorerstellte +Paket-Binärdateien, aber wenn zum Beispiel ein Quell-Tarball das Ergebnis +einer Ableitungserstellung ist, kann auch er als Substitut verfügbar sein. + +@menu +* Offizieller Substitut-Server:: Eine besondere Quelle von Substituten. +* Substitut-Server autorisieren:: Wie man Substitute an- und abschaltet. +* Substitutauthentifizierung:: Wie Guix Substitute verifiziert. +* Proxy-Einstellungen:: Wie Sie Substitute über einen Proxy beziehen. +* Fehler bei der Substitution:: Was passiert, wenn die Substitution + fehlschlägt. +* Vom Vertrauen gegenüber Binärdateien:: Wie können Sie diesem binären + Blob trauen? +@end menu + +@node Offizieller Substitut-Server +@subsection Offizieller Substitut-Server + +@cindex Hydra +@cindex Build-Farm +Der Server @code{mirror.hydra.gnu.org} ist die Façade für eine offizielle +»Build-Farm«, ein Erstellungswerk, das kontinuierlich Guix-Pakete für einige +Prozessorarchitekturen erstellt und sie als Substitute zur Verfügung +stellt. Dies ist die standardmäßige Quelle von Substituten; durch Übergeben +der Befehlszeilenoption @option{--substitute-urls} an entweder den +@command{guix-daemon} (@pxref{daemon-substitute-urls,, @code{guix-daemon +--substitute-urls}}) oder Client-Werkzeuge wie @command{guix package} +(@pxref{client-substitute-urls,, client @option{--substitute-urls} option}) +kann eine abweichende Einstellung benutzt werden. + +Substitut-URLs können entweder HTTP oder HTTPS sein. HTTPS wird empfohlen, +weil die Kommunikation verschlüsselt ist; umgekehrt kann bei HTTP die +Kommunikation belauscht werden, wodurch der Angreifer zum Beispiel erfahren +könnte, ob Ihr System über noch nicht behobene Sicherheitsschwachstellen +verfügt. + +Substitute von der offiziellen Build-Farm sind standardmäßig erlaubt, wenn +Sie die Guix System Distribution verwenden (@pxref{GNU-Distribution}). Auf +Fremddistributionen sind sie allerdings standardmäßig ausgeschaltet, solange +Sie sie nicht ausdrücklich in einem der empfohlenen Installationsschritte +erlaubt haben (@pxref{Installation}). Die folgenden Absätze beschreiben, wie +Sie Substitute für die offizielle Build-Farm an- oder ausschalten; dieselbe +Prozedur kann auch benutzt werden, um Substitute für einen beliebigen +anderen Substitutsserver zu erlauben. + +@node Substitut-Server autorisieren +@subsection Substitut-Server autorisieren + +@cindex Sicherheit +@cindex Substitute, deren Autorisierung +@cindex Access Control List (ACL), für Substitute +@cindex ACL (Access Control List), für Substitute +Um es Guix zu gestatten, Substitute von @code{hydra.gnu.org} oder einem +Spiegelserver davon herunterzuladen, müssen Sie den zugehörigen öffentlichen +Schlüssel zur Access Control List (ACL, Zugriffssteuerungsliste) für +Archivimporte hinzufügen, mit Hilfe des Befehls @command{guix archive} +(@pxref{Aufruf von guix archive}). Dies impliziert, dass Sie darauf vertrauen, +dass @code{hydra.gnu.org} nicht kompromittiert wurde und echte Substitute +liefert. + +Der öffentliche Schlüssel für @code{hydra.gnu.org} wird zusammen mit Guix +installiert, in das Verzeichnis +@code{@var{prefix}/share/guix/hydra.gnu.org.pub}, wobei @var{prefix} das +Installationspräfix von Guix ist. Wenn Sie Guix aus seinem Quellcode heraus +installieren, stellen Sie sicher, dass Sie die GPG-Signatur von +@file{guix-@value{VERSION}.tar.gz} prüfen, worin sich dieser öffentliche +Schlüssel befindet. Dann können Sie so etwas wie hier ausführen: + +@example +# guix archive --authorize < @var{prefix}/share/guix/hydra.gnu.org.pub +@end example + +@quotation Anmerkung +Genauso enthält die Datei @file{berlin.guixsd.org.pub} den öffentlichen +Schlüssel für die neue Build-Farm des Guix-Projekts, die unter +@indicateurl{https://berlin.guixsd.org} erreichbar ist. + +Derzeit, als dieser Text geschrieben wurde, wird @code{berlin.guixsd.org} +ausgebaut, um besser skalieren zu können, aber Sie könnten es +ausprobieren. Dahinter stecken 20 x86_64-/i686-Erstellungsknoten, die +Substitute früher anbieten könnten als @code{mirror.hydra.gnu.org}. +@end quotation + +Sobald es eingerichtet wurde, sollte sich die Ausgabe eines Befehls wie +@code{guix build} von so etwas: + +@example +$ guix build emacs --dry-run +The following derivations would be built: + /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv + /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv + /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv + /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv +@dots{} +@end example + +@noindent +in so etwas verwandeln: + +@example +$ guix build emacs --dry-run +112.3 MB would be downloaded: + /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3 + /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d + /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16 + /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7 +@dots{} +@end example + +@noindent +Das zeigt an, dass Substitute von @code{hydra.gnu.org} nutzbar sind und für +zukünftige Erstellungen heruntergeladen, wann immer es möglich ist. + +@cindex Substitute, wie man sie ausschaltet +Der Substitutsmechanismus kann global ausgeschaltet werden, indem Sie dem +@code{guix-daemon} beim Starten die Befehlszeilenoption +@code{--no-substitutes} übergeben (@pxref{Aufruf des guix-daemon}). Er kann +auch temporär ausgeschaltet werden, indem Sie @code{--no-substitutes} an +@command{guix package}, @command{guix build} und andere +Befehlszeilenwerkzeuge übergeben. + +@node Substitutauthentifizierung +@subsection Substitutauthentifizierung + +@cindex digitale Signaturen +Guix erkennt, wenn ein verfälschtes Substitut benutzt würde, und meldet +einen Fehler. Ebenso werden Substitute ignoriert, die nich signiert sind, +oder nicht mit einem in der ACL aufgelisteten Schlüssel signiert sind. + +Es gibt nur eine Ausnahme: Wenn ein unautorisierter Server Substitute +anbietet, die @emph{Bit für Bit identisch} mit denen von einem +authorisierten Server sind, können sie auch vom unautorisierten Server +heruntergeladen werden. Zum Beispiel, angenommen wir haben zwei +Substitutserver mit dieser Befehlszeilenoption ausgewählt: + +@example +--substitute-urls="https://a.example.org https://b.example.org" +@end example + +@noindent +@cindex Reproduzierbare Erstellungen +Wenn in der ACL nur der Schlüssel für @code{b.example.org} aufgeführt wurde, +aber @code{a.example.org} @emph{exakt dieselben} Substitute anbietet, wird +Guix auch Substitute von @code{a.example.org} herunterladen, weil es in der +Liste zuerst kommt und als Spiegelserver für @code{b.example.org} aufgefasst +werden kann. In der Praxis haben unabhängige Maschinen bei der Erstellung +normalerweise dieselben Binärdateien als Ergebnis, dank bit-reproduzierbarer +Erstellungen (siehe unten). + +Wenn Sie HTTPS benutzen, wird das X.509-Zertifikat des Servers @emph{nicht} +validiert (mit anderen Worten, die Identität des Servers wird nicht +authentifiziert), entgegen dem, was HTTPS-Clients wie Web-Browser +normalerweise tun. Da Guix Substitutinformationen selbst überprüft, wie oben +erklärt, wäre es unnötig (wohingegen mit X.509-Zertifikaten geprüft wird, ob +ein Domain-Name zu öffentlichen Schlüsseln passt). + +@node Proxy-Einstellungen +@subsection Proxy-Einstellungen + +@vindex http_proxy +Substitute werden über HTTP oder HTTPS heruntergeladen. Die +Umgebungsvariable @code{http_proxy} kann in der Umgebung von +@command{guix-daemon} definiert werden und wirkt sich dann auf das +Herunterladen von Substituten aus. Beachten Sie, dass der Wert von +@code{http_proxy} in der Umgebung, in der @command{guix build}, +@command{guix package} und andere Client-Befehle ausgeführt werden, +@emph{keine Rolle spielt}. + +@node Fehler bei der Substitution +@subsection Fehler bei der Substitution + +Selbst wenn ein Substitut für eine Ableitung verfügbar ist, schlägt die +versuchte Substitution manchmal fehl. Das kann aus vielen Gründen geschehen: +die Substitutsserver könnten offline sein, das Substitut könnte kürzlich +gelöscht worden sein, die Netzwerkverbindunge könnte unterbrochen worden +sein, usw. + +Wenn Substitute aktiviert sind und ein Substitut für eine Ableitung zwar +verfügbar ist, aber die versuchte Substitution fehlschlägt, kann Guix +versuchen, die Ableitung lokal zu erstellen, je nachdem, ob +@code{--fallback} übergeben wurde (@pxref{fallback-option,, common build +option @code{--fallback}}). Genauer gesagt, wird keine lokale Erstellung +durchgeführt, solange kein @code{--fallback} angegeben wurde, und die +Ableitung wird als Fehlschlag angesehen. Wenn @code{--fallback} übergeben +wurde, wird Guix versuchen, die Ableitung lokal zu erstellen, und ob die +Ableitung erfolgreich ist oder nicht, hängt davon ab, ob die lokale +Erstellung erfolgreich ist oder nicht. Beachten Sie, dass, falls Substitute +ausgeschaltet oder erst gar kein Substitut verfügbar ist, @emph{immer} eine +lokale Erstellung durchgeführt wird, egal ob @code{--fallback} übergeben +wurde oder nicht. + +Um eine Vorstellung zu bekommen, wieviele Substitute gerade verfügbar sind, +können Sie den Befehl @command{guix weather} benutzen (@pxref{Aufruf von guix weather}). Dieser Befehl zeigt Statistiken darüber an, wie es um die von +einem Server verfügbaren Substitute steht. + +@node Vom Vertrauen gegenüber Binärdateien +@subsection Vom Vertrauen gegenüber Binärdateien + +@cindex Vertrauen, gegenüber vorerstellten Binärdateien +Derzeit hängt die Kontrolle jedes Individuums über seine Rechner von +Institutionen, Unternehmen undsolchen Gruppierungen ab, die über genug Macht +und Entschlusskraft verfügen, die Rechnerinfrastruktur zu sabotieren und +ihre Schwachstellen auszunutzen. Auch wenn es bequem ist, Substitute von +@code{hydra.gnu.org} zu benutzen, ermuntern wir Nutzer, auch selbst +Erstellungen durchzuführen oder gar ihre eigene Build-Farm zu betreiben, +damit @code{hydra.gnu.org} ein weniger interessantes Ziel wird. Eine Art, +uns zu helfen, ist, die von Ihnen erstellte Software mit dem Befehl +@command{guix publish} zu veröffentlichen, damit andere eine größere Auswahl +haben, von welchem Server sie Substitute beziehen möchten (@pxref{Aufruf von guix publish}). + +Guix hat die richtigen Grundlagen, um die Reproduzierbarkeit von +Erstellungen zu maximieren (@pxref{Funktionalitäten}). In den meisten Fällen sollten +unabhängige Erstellungen eines bestimmten Pakets zu bitweise identischen +Ergebnissen führen. Wir können also mit Hilfe einer vielschichtigen Menge an +unabhängigen Paketerstellungen die Integrität unseres Systems besser +gewährleisten. Der Befehl @command{guix challenge} hat das Ziel, Nutzern zu +ermöglichen, Substitutserver zu beurteilen, und Entwicklern zu ermöglichen, +nichtdeterministische Paketerstellungen zu finden (@pxref{Aufruf von guix challenge}). Ebenso ermöglicht es die Befehlszeilenoption @option{--check} +von @command{guix build}, dass Nutzer bereits installierte Substitute auf +Echtheit zu prüfen, indem sie lokal nachgebaut werden (@pxref{build-check, +@command{guix build --check}}). + +In Zukunft wollen wir, dass Guix Binärdateien an und von Nutzern in einem +Peer-to-Peer veröffentlichen kann. Wenn Sie mit uns dieses Projekt +diskuttieren möchten, kommen Sie auf unsere Mailing-Liste +@email{guix-devel@@gnu.org}. + +@node Pakete mit mehreren Ausgaben. +@section Pakete mit mehreren Ausgaben. + +@cindex mehrere Ausgaben, bei Paketen +@cindex Paketausgaben +@cindex Ausgaben + +Oft haben in Guix definierte Pakete eine einzige @dfn{Ausgabe} — d.h. aus +dem Quellpaket entsteht genau ein Verzeichnis im Store. Wenn Sie +@command{guix package -i glibc} ausführen, wird die Standard-Paketausgabe +des GNU-libc-Pakets installiert; die Standardausgabe wird @code{out} +genannt, aber ihr Name kann weggelassen werden, wie sie an obigem Befehl +sehen. In diesem speziellen Fall enthält die Standard-Paketausgabe von +@code{glibc} alle C-Headerdateien, gemeinsamen Bibliotheken (»Shared +Libraries«), statische Bibliotheken (»Static Libraries«), Dokumentation für +Info sowie andere zusätzliche Dateien. + +Manchmal ist es besser, die verschiedenen Arten von Dateien, die aus einem +einzelnen Quellpaket hervorgehen, in getrennte Ausgaben zu unterteilen. Zum +Beispiel installiert die GLib-C-Bibliothek (die von GTK+ und damit +zusammenhängenden Paketen benutzt wird) mehr als 20 MiB an HTML-Seiten mit +Referenzdokumentation. Um den Nutzern, die das nicht brauchen, Platz zu +sparen, wird die Dokumentation in einer separaten Ausgabe abgelegt, genannt +@code{doc}. Um also die Hauptausgabe von GLib zu installieren, zu der alles +außer der Dokumentation gehört, ist der Befehl: + +@example +guix package -i glib +@end example + +@cindex Dokumentation +Der Befehl, um die Dokumentation zu installieren, ist: + +@example +guix package -i glib:doc +@end example + +Manche Pakete installieren Programme mit unterschiedlich großem +»Abhängigkeiten-Fußabdruck«. Zum Beispiel installiert das Paket WordNet +sowohl Befehlszeilenwerkzeuge als auch grafische Benutzerschnittstellen +(GUIs). Erstere hängen nur von der C-Bibliothek ab, während Letztere auch +von Tcl/Tk und den zu Grunde liegenden X-Bibliotheken abhängen. Jedenfalls +belassen wir deshalb die Befehlszeilenwerkzeuge in der +Standard-Paketausgabe, während sich die GUIs in einer separaten Ausgabe +befinden. So können Benutzer, die die GUIs nicht brauchen, Platz sparen. Der +Befehl @command{guix size} kann dabei helfen, solche Situationen zu erkennen +(@pxref{Aufruf von guix size}). @command{guix graph} kann auch helfen +(@pxref{Aufruf von guix graph}). + +In der GNU-Distribution gibt es viele solche Pakete mit mehreren +Ausgaben. Andere Konventionen für Ausgabenamen sind zum Beispiel @code{lib} +für Bibliotheken und eventuell auch ihre Header-Dateien,, @code{bin} für +eigenständige Programme und @code{debug} für Informationen zur +Fehlerbehandlung (@pxref{Dateien zur Fehlersuche installieren}). Die Ausgaben eines +Pakets stehen in der dritten Spalte der Anzeige von @command{guix package +--list-available} (@pxref{Aufruf von guix package}). + + +@node Aufruf von guix gc +@section @command{guix gc} aufrufen + +@cindex Müllsammler +@cindex Plattenspeicher +Pakete, die zwar installiert sind, aber nicht benutzt werden, können vom +@dfn{Müllsammler} entfernt werden. Mit dem Befehl @command{guix gc} können +Benutzer den Müllsammler ausdrücklich aufrufen, um Speicher im Verzeichnis +@file{/gnu/store} freizugeben. Dies ist der @emph{einzige} Weg, Dateien aus +@file{/gnu/store} zu entfernen — das manuelle Entfernen von Dateien kann den +Store irreparabel beschädigen! + +@cindex GC-Wurzeln +@cindex Müllsammlerwurzeln +Der Müllsammler kennt eine Reihe von @dfn{Wurzeln}: Jede Datei in +@file{/gnu/store}, die von einer Wurzel aus erreichbar ist, gilt als +@dfn{lebendig} und kann nicht entfernt werden; jede andere Datei gilt als +@dfn{tot} und ist ein Kandidat, gelöscht zu werden. Die Reihe der +Müllsammlerwurzeln (kurz auch »GC-Wurzeln«, von englisch »Garbage +Collector«) umfasst Standard-Benutzerprofile; standardmäßig werden diese +Müllsammlerwurzeln durch symbolische Verknüpfungen in +@file{/var/guix/gcroots} dargestellt. Neue Müllsammlerwurzeln können zum +Beispiel mit @command{guix build --root} festgelegt werden (@pxref{Aufruf von guix build}). + +Bevor Sie mit @code{guix gc --collect-garbage} Speicher freimachen, wollen +Sie vielleicht alte Generationen von Benutzerprofilen löschen, damit alte +Paketerstellungen von diesen Generationen entfernt werden können. Führen Sie +dazu @code{guix package --delete-generations} aus (@pxref{Aufruf von guix package}). + +Unsere Empfehlung ist, dass Sie den Müllsammler regelmäßig laufen lassen und +wenn Sie wenig freien Speicherplatz zur Verfügung haben. Um zum Beispiel +sicherzustellen, dass Sie mindestens 5@tie{}GB are auf Ihrer Platte zur +Verfügung haben, benutzen Sie einfach: + +@example +guix gc -F 5G +@end example + +Es ist völlig sicher, dafür eine nicht interaktive, regelmäßige +Auftragsausführung vorzugeben (@pxref{Geplante Auftragsausführung}, für eine +Erklärung, wie man das in GuixSD tun kann). @command{guix gc} ohne +Befehlszeilenargumente auszuführen, lässt so viel Müll wie möglich sammeln, +aber das ist oft nicht, was man will, denn so muss man unter Umständen +Software erneut erstellen oder erneut herunterladen, weil der Müllsammler +sie als »tot« ansieht, sie aber zur Erstellung anderer Software wiedeer +gebraucht wird — das trifft zum Beispiel auf die Compiler-Toolchain zu. + +Der Befehl @command{guix gc} hat drei Arbeitsmodi: Er kann benutzt werden, +um als Müllsammler tote Dateien zu entfernen (das Standardverhalten), um +ganz bestimmte, angegebene Datein zu löschen (mit der Befehlszeilenoption +@code{--delete}), um Müllsammlerinformationen auszugeben oder +fortgeschrittenere Anfragen zu verarbeiten. Die +Müllsammler-Befehlszeilenoptionen sind wie folgt: + +@table @code +@item --collect-garbage[=@var{Minimum}] +@itemx -C [@var{Minimum}] +Lässt Müll sammeln — z.B. nicht erreichbare Dateien in @file{/gnu/store} und +seinen Unterverzeichnissen. Wird keine andere Befehlszeilenoption angegeben, +wird standardmäßig diese durchgeführt. + +Wenn ein @var{Minimum} angegeben wurde, hört der Müllsammler auf, sobald +@var{Minimum} Bytes gesammelt wurden. Das @var{Minimum} kann die Anzahl der +Bytes bezeichnen oder mit einer Einheit als Suffix versehen sein, wie etwa +@code{MiB} für Mebibytes und @code{GB} für Gigabytes (@pxref{Block size, +size specifications,, coreutils, GNU Coreutils}). + +Wird kein @var{Minimum} angegeben, sammelt der Müllsammler allen Müll. + +@item --free-space=@var{Menge} +@itemx -F @var{Menge} +Sammelt Müll, bis die angegebene @var{Menge} an freiem Speicher in +@file{/gnu/store} zur Verfügung steht, falls möglich; die @var{Menge} ist +eine Speichergröße wie @code{500MiB}, wie oben beschrieben. + +Wenn die angegebene @var{Menge} oder mehr bereits in @file{/gnu/store} frei +verfügbar ist, passiert nichts. + +@item --delete +@itemx -d +Versucht, alle als Argumente angegebenen Dateien oder Verzeichnisse im Store +zu löschen. Dies schlägt fehl, wenn manche der Dateien oder Verzeichnisse +nicht im Store oder noch immer lebendig sind. + +@item --list-failures +Store-Objekte auflisten, die zwischengespeicherten Erstellungsfehlern +entsprechen. + +Hierbei wird nichts ausgegeben, sofern der Daemon nicht mit +@option{--cache-failures} gestartet wurde (@pxref{Aufruf des guix-daemon, +@option{--cache-failures}}). + +@item --clear-failures +Die angegebenen Store-Objekte aus dem Zwischenspeicher für fehlgeschlagene +Erstellungen entfernen. + +Auch diese Option macht nur Sinn, wenn der Daemon mit +@option{--cache-failures} gestartet wurde. Andernfalls passiert nichts. + +@item --list-dead +Zeigt die Liste toter Dateien und Verzeichnisse an, die sich noch im Store +befinden — das heißt, Dateien, die von keiner Wurzel mehr erreichbar sind. + +@item --list-live +Zeige die Liste lebendiger Store-Dateien und -Verzeichnisse. + +@end table + +Außerdem können Referenzen unter bestehenden Store-Dateien gefunden werden: + +@table @code + +@item --references +@itemx --referrers +@cindex Paketabhängigkeiten +Listet die referenzierten bzw. sie referenzierenden Objekte der angegebenen +Store-Dateien auf. + +@item --requisites +@itemx -R +@cindex Abschluss +Listet alle Voraussetzungen der als Argumente übergebenen Store-Dateien +auf. Voraussetzungen sind die Store-Dateien selbst, ihre Referenzen sowie +die Referenzen davon, rekursiv. Mit anderen Worten, die zurückgelieferte +Liste ist der @dfn{transitive Abschluss} dieser Store-Dateien. + +Der Abschnitt @xref{Aufruf von guix size} erklärt ein Werkzeug, um den +Speicherbedarf des Abschlusses eines Elements zu ermitteln. Siehe +@xref{Aufruf von guix graph} für ein Werkzeug, um den Referenzgraph zu +veranschaulichen. + +@item --derivers +@cindex Ableitung +Liefert die Ableitung(en), die zu den angegebenen Store-Objekten führen +(@pxref{Ableitungen}). + +Zum Beispiel liefert dieser Befehl: + +@example +guix gc --derivers `guix package -I ^emacs$ | cut -f4` +@end example + +@noindent +die @file{.drv}-Datei(en), die zum in Ihrem Profil installierten +@code{emacs}-Paket führen. + +Beachten Sie, dass es auch sein kann, dass keine passenden +@file{.drv}-Dateien existieren, zum Beispiel wenn diese Dateien bereits dem +Müllsammler zum Opfer gefallen sind. Es kann auch passieren, dass es mehr +als eine passende @file{.drv} gibt, bei Ableitungen mit fester Ausgabe. +@end table + +Zuletzt können Sie mit folgenden Befehlszeilenoptionen die Integrität des +Stores prüfen und den Plattenspeicherverbrauch im Zaum halten. + +@table @option + +@item --verify[=@var{Optionen}] +@cindex Integrität, des Stores +@cindex Integritätsprüfung +Die Integrität des Stores verifizieren + +Standardmäßig wird sichergestellt, dass alle Store-Objekte, die in der +Datenbank des Daemons als gültig markiert wurden, auch tatsächlich in +@file{/gnu/store} existieren. + +Wenn angegeben, müssen die @var{Optionen} eine kommagetrennte Liste aus +mindestens einem der Worte @code{contents} und @code{repair} sein. + +Wenn Sie @option{--verify=contents} übergeben, berechnet der Daemon den Hash +des Inhalts jedes Store-Objekts und vergleicht ihn mit dem Hash in der +Datenbank. Sind die Hashes ungleich, wird eine Datenbeschädigung +gemeldet. Weil dabei @emph{alle Dateien im Store} durchlaufen werden, kann +der Befehl viel Zeit brauchen, besonders auf Systemen mit langsamer Platte. + +@cindex Store, reparieren +@cindex Datenbeschädigung, Behebung +Mit @option{--verify=repair} oder @option{--verify=contents,repair} versucht +der Daemon, beschädigte Store-Objekte zu reparieren, indem er Substitute für +selbige herunterlädt (@pxref{Substitute}). Weil die Reparatur nicht atomar +und daher womöglich riskant ist, kann nur der Systemadministrator den Befehl +benutzen. Eine weniger aufwendige Alternative, wenn Sie wissen, welches +Objekt beschädigt ist, ist, @command{guix build --repair} zu benutzen +(@pxref{Aufruf von guix build}). + +@item --optimize +@cindex Deduplizieren +Den Store durch Nutzung harter Verknüpfungen für identische Dateien +optimieren — mit anderen Worten wird der Store @dfn{dedupliziert}. + +Der Daemon führt Deduplizierung automatisch nach jeder erfolgreichen +Erstellung und jedem Importieren eines Archivs durch, sofern er nicht mit +@code{--disable-deduplication} (@pxref{Aufruf des guix-daemon, +@code{--disable-deduplication}}) gestartet wurde. Diese Befehlszeilenoption +brauchen Sie also in erster Linie dann, wenn der Daemon zuvor mit +@code{--disable-deduplication} gestartet worden ist. + +@end table + +@node Aufruf von guix pull +@section @command{guix pull} aufrufen + +@cindex Aktualisieren von Guix +@cindex Updaten von Guix +@cindex @command{guix pull} +@cindex pull +Packages are installed or upgraded to the latest version available in the +distribution currently available on your local machine. To update that +distribution, along with the Guix tools, you must run @command{guix pull}: +the command downloads the latest Guix source code and package descriptions, +and deploys it. Source code is downloaded from a @uref{https://git-scm.com, +Git} repository, by default the official GNU@tie{}Guix repository, though +this can be customized. + +Danach wird @command{guix package} Pakete und ihre Versionen entsprechend +der gerade heruntergeladenen Kopie von Guix benutzen. Nicht nur das, auch +alle Guix-Befehle und Scheme-Module werden aus der neuesten Version von Guix +kommen. Neue @command{guix}-Unterbefehle, die durch die Aktualisierung +hinzugekommen sind, werden also auch verfügbar. + +Jeder Nutzer kann seine Kopie von Guix mittels @command{guix pull} +aktualisieren, wodurch sich nur für den Nutzer etwas verändert, der +@command{guix pull} ausgeführt hat. Wenn also zum Beispiel der +Administratornutzer @code{root} den Befehl @command{guix pull} ausführt, hat +das keine Auswirkungen, auf die für den Benutzer @code{alice} sichtbare +Guix-Version, und umgekehrt. + +Das Ergebnis von @command{guix pull} ist ein als +@file{~/.config/guix/current} verfügbares @dfn{Profil} mit dem neuesten +Guix. Stellen Sie sicher, dass es am Anfang Ihres Suchpfades steht, damit +Sie auch wirklich das neueste Guix und sein Info-Handbuch sehen +(@pxref{Dokumentation}): + +@example +export PATH="$HOME/.config/guix/current/bin:$PATH" +export INFOPATH="$HOME/.config/guix/current/share/info:$INFOPATH" +@end example + +Die Befehlszeilenoption @code{--list-generations} oder kurz @code{-l} listet +ältere von @command{guix pull} erzeugte Generationen auf, zusammen mit +Informationen zu deren Provenienz. + +@example +$ guix pull -l +Generation 1 Jun 10 2018 00:18:18 + guix 65956ad + repository URL: https://git.savannah.gnu.org/git/guix.git + branch: origin/master + commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe + +Generation 2 Jun 11 2018 11:02:49 + guix e0cc7f6 + repository URL: https://git.savannah.gnu.org/git/guix.git + branch: origin/master + commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d + 2 new packages: keepalived, libnfnetlink + 6 packages upgraded: emacs-nix-mode@@2.0.4, + guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac, + heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4 + +Generation 3 Jun 13 2018 23:31:07 (current) + guix 844cc1c + repository URL: https://git.savannah.gnu.org/git/guix.git + branch: origin/master + commit: 844cc1c8f394f03b404c5bb3aee086922373490c + 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{} + 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{} +@end example + +@ref{Invoking guix describe, @command{guix describe}}, for other ways to +describe the current status of Guix. + +Das Profil @code{~/.config/guix/current} verhält sich genau wie jedes andere +Profil, das von @command{guix package} erzeugt wurde (@pxref{Aufruf von guix package}). Das bedeutet, Sie können seine Generationen auflisten und es auf +die vorherige Generation — also das vorherige Guix — zurücksetzen und so +weiter: + +@example +$ guix package -p ~/.config/guix/current --roll-back +switched from generation 3 to 2 +$ guix package -p ~/.config/guix/current --delete-generations=1 +deleting /var/guix/profiles/per-user/charlie/current-guix-1-link +@end example + +Der Befehl @command{guix pull} wird in der Regel ohne Befehlszeilenargumente +aufgerufen, aber er versteht auch folgende Befehlszeilenoptionen: + +@table @code +@item --verbose +Ausführliche Informationen ausgeben und Erstellungsprotokolle auf der +Standardfehlerausgabe ausgeben. + +@item --url=@var{URL} +@itemx --commit=@var{Commit} +@itemx --branch=@var{Branch} +Download code from the specified @var{url}, at the given @var{commit} (a +valid Git commit ID represented as a hexadecimal string), or @var{branch}. + +@cindex @file{channels.scm}, configuration file +@cindex configuration file for channels +These options are provided for convenience, but you can also specify your +configuration in the @file{~/.config/guix/channels.scm} file or using the +@option{--channels} option (see below). + +@item --channels=@var{file} +@itemx -C @var{file} +Read the list of channels from @var{file} instead of +@file{~/.config/guix/channels.scm}. @var{file} must contain Scheme code +that evaluates to a list of channel objects. @xref{Channels}, for more +information. + +@item --list-generations[=@var{Muster}] +@itemx -l [@var{Muster}] +List all the generations of @file{~/.config/guix/current} or, if +@var{pattern} is provided, the subset of generations that match +@var{pattern}. The syntax of @var{pattern} is the same as with @code{guix +package --list-generations} (@pxref{Aufruf von guix package}). + +@ref{Invoking guix describe}, for a way to display information about the +current generation only. + +@item --profile=@var{Profil} +@itemx -p @var{Profil} +Use @var{profile} instead of @file{~/.config/guix/current}. + +@item --bootstrap +Use the bootstrap Guile to build the latest Guix. This option is only +useful to Guix developers. +@end table + +The @dfn{channel} mechanism allows you to instruct @command{guix pull} which +repository and branch to pull from, as well as @emph{additional} +repositories containing package modules that should be deployed. +@xref{Channels}, for more information. + +In addition, @command{guix pull} supports all the common build options +(@pxref{Gemeinsame Erstellungsoptionen}). + +@node Channels +@section Channels + +@cindex channels +@cindex @file{channels.scm}, configuration file +@cindex configuration file for channels +@cindex @command{guix pull}, configuration file +@cindex configuration of @command{guix pull} +Guix and its package collection are updated by running @command{guix pull} +(@pxref{Aufruf von guix pull}). By default @command{guix pull} downloads and +deploys Guix itself from the official GNU@tie{}Guix repository. This can be +customized by defining @dfn{channels} in the +@file{~/.config/guix/channels.scm} file. A channel specifies a URL and +branch of a Git repository to be deployed, and @command{guix pull} can be +instructed to pull from one or more channels. In other words, channels can +be used to @emph{customize} and to @emph{extend} Guix, as we will see below. + +@subsection Using a Custom Guix Channel + +The channel called @code{guix} specifies where Guix itself---its +command-line tools as well as its package collection---should be +downloaded. For instance, suppose you want to update from your own copy of +the Guix repository at @code{example.org}, and specifically the +@code{super-hacks} branch, you can write in +@code{~/.config/guix/channels.scm} this specification: + +@lisp +;; Tell 'guix pull' to use my own repo. +(list (channel + (name 'guix) + (url "https://example.org/my-guix.git") + (branch "super-hacks"))) +@end lisp + +@noindent +From there on, @command{guix pull} will fetch code from the +@code{super-hacks} branch of the repository at @code{example.org}. + +@subsection Specifying Additional Channels + +@cindex extending the package collection (channels) +@cindex personal packages (channels) +@cindex channels, for personal packages +You can also specify @emph{additional channels} to pull from. Let's say you +have a bunch of custom package variants or personal packages that you think +would make little sense to contribute to the Guix project, but would like to +have these packages transparently available to you at the command line. You +would first write modules containing those package definitions +(@pxref{Paketmodule}), maintain them in a Git repository, and then you +and anyone else can use it as an additional channel to get packages from. +Neat, no? + +@c What follows stems from discussions at +@c <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=22629#134> as well as +@c earlier discussions on guix-devel@gnu.org. +@quotation Warning +Before you, dear user, shout---``woow this is @emph{soooo coool}!''---and +publish your personal channel to the world, we would like to share a few +words of caution: + +@itemize +@item +Before publishing a channel, please consider contributing your package +definitions to Guix proper (@pxref{Mitwirken}). Guix as a project is +open to free software of all sorts, and packages in Guix proper are readily +available to all Guix users and benefit from the project's quality assurance +process. + +@item +When you maintain package definitions outside Guix, we, Guix developers, +consider that @emph{the compatibility burden is on you}. Remember that +package modules and package definitions are just Scheme code that uses +various programming interfaces (APIs). We want to remain free to change +these APIs to keep improving Guix, possibly in ways that break your +channel. We never change APIs gratuitously, but we will @emph{not} commit +to freezing APIs either. + +@item +Corollary: if you're using an external channel and that channel breaks, +please @emph{report the issue to the channel authors}, not to the Guix +project. +@end itemize + +You've been warned! Having said this, we believe external channels are a +practical way to exert your freedom to augment Guix' package collection and +to share your improvements, which are basic tenets of +@uref{https://www.gnu.org/philosophy/free-sw.html, free software}. Please +email us at @email{guix-devel@@gnu.org} if you'd like to discuss this. +@end quotation + +Once you have a Git repository containing your own package modules, you can +write @code{~/.config/guix/channels.scm} to instruct @command{guix pull} to +pull from your personal channel @emph{in addition} to the default Guix +channel(s): + +@vindex %default-channels +@lisp +;; Add my personal packages to those Guix provides. +(cons (channel + (name 'my-personal-packages) + (url "https://example.org/personal-packages.git")) + %default-channels) +@end lisp + +@noindent +Note that the snippet above is (as always!) Scheme code; we use @code{cons} +to add a channel the list of channels that the variable +@code{%default-channels} is bound to (@pxref{Pairs, @code{cons} and lists,, +guile, GNU Guile Reference Manual}). With this file in place, @command{guix +pull} builds not only Guix but also the package modules from your own +repository. The result in @file{~/.config/guix/current} is the union of +Guix with your own package modules: + +@example +$ guix pull --list-generations +@dots{} +Generation 19 Aug 27 2018 16:20:48 + guix d894ab8 + repository URL: https://git.savannah.gnu.org/git/guix.git + branch: master + commit: d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300 + my-personal-packages dd3df5e + repository URL: https://example.org/personal-packages.git + branch: master + commit: dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb + 11 new packages: my-gimp, my-emacs-with-cool-features, @dots{} + 4 packages upgraded: emacs-racket-mode@@0.0.2-2.1b78827, @dots{} +@end example + +@noindent +The output of @command{guix pull} above shows that Generation@tie{}19 +includes both Guix and packages from the @code{my-personal-packages} +channel. Among the new and upgraded packages that are listed, some like +@code{my-gimp} and @code{my-emacs-with-cool-features} might come from +@code{my-personal-packages}, while others come from the Guix default +channel. + +@subsection Replicating Guix + +@cindex pinning, channels +@cindex replicating Guix +@cindex reproducibility, of Guix +The @command{guix pull --list-generations} output above shows precisely +which commits were used to build this instance of Guix. We can thus +replicate it, say, on another machine, by providing a channel specification +in @file{~/.config/guix/channels.scm} that is ``pinned'' to these commits: + +@lisp +;; Deploy specific commits of my channels of interest. +(list (channel + (name 'guix) + (url "https://git.savannah.gnu.org/git/guix.git") + (commit "d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300")) + (channel + (name 'my-personal-packages) + (url "https://example.org/personal-packages.git") + (branch "dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb"))) +@end lisp + +The @command{guix describe --format=channels} command can even generate this +list of channels directly (@pxref{Invoking guix describe}). + +At this point the two machines run the @emph{exact same Guix}, with access +to the @emph{exact same packages}. The output of @command{guix build gimp} +on one machine will be exactly the same, bit for bit, as the output of the +same command on the other machine. It also means both machines have access +to all the source code of Guix and, transitively, to all the source code of +every package it defines. + +This gives you super powers, allowing you to track the provenance of binary +artifacts with very fine grain, and to reproduce software environments at +will---some sort of ``meta reproducibility'' capabilities, if you will. +@xref{Inferiors}, for another way to take advantage of these super powers. + +@node Inferiors +@section Inferiors + +@c TODO: Remove this once we're more confident about API stability. +@quotation Anmerkung +The functionality described here is a ``technology preview'' as of version +@value{VERSION}. As such, the interface is subject to change. +@end quotation + +@cindex inferiors +@cindex composition of Guix revisions +Sometimes you might need to mix packages from the revision of Guix you're +currently running with packages available in a different revision of Guix. +Guix @dfn{inferiors} allow you to achieve that by composing different Guix +revisions in arbitrary ways. + +@cindex inferior packages +Technically, an ``inferior'' is essentially a separate Guix process +connected to your main Guix process through a REPL (@pxref{Invoking guix +repl}). The @code{(guix inferior)} module allows you to create inferiors +and to communicate with them. It also provides a high-level interface to +browse and manipulate the packages that an inferior provides---@dfn{inferior +packages}. + +When combined with channels (@pxref{Channels}), inferiors provide a simple +way to interact with a separate revision of Guix. For example, let's assume +you want to install in your profile the current @code{guile} package, along +with the @code{guile-json} as it existed in an older revision of +Guix---perhaps because the newer @code{guile-json} has an incompatible API +and you want to run your code against the old API@. To do that, you could +write a manifest for use by @code{guix package --manifest} (@pxref{Aufruf von guix package}); in that manifest, you would create an inferior for that old +Guix revision you care about, and you would look up the @code{guile-json} +package in the inferior: + +@lisp +(use-modules (guix inferior) (guix channels) + (srfi srfi-1)) ;for 'first' + +(define channels + ;; This is the old revision from which we want to + ;; extract guile-json. + (list (channel + (name 'guix) + (url "https://git.savannah.gnu.org/git/guix.git") + (commit + "65956ad3526ba09e1f7a40722c96c6ef7c0936fe")))) + +(define inferior + ;; An inferior representing the above revision. + (inferior-for-channels channels)) + +;; Now create a manifest with the current "guile" package +;; and the old "guile-json" package. +(packages->manifest + (list (first (lookup-inferior-packages inferior "guile-json")) + (specification->package "guile"))) +@end lisp + +On its first run, @command{guix package --manifest} might have to build the +channel you specified before it can create the inferior; subsequent runs +will be much faster because the Guix revision will be cached. + +The @code{(guix inferior)} module provides the following procedures to open +an inferior: + +@deffn {Scheme Procedure} inferior-for-channels @var{channels} @ + [#:cache-directory] [#:ttl] Return an inferior for @var{channels}, a list of +channels. Use the cache at @var{cache-directory}, where entries can be +reclaimed after @var{ttl} seconds. This procedure opens a new connection to +the build daemon. + +As a side effect, this procedure may build or substitute binaries for +@var{channels}, which can take time. +@end deffn + +@deffn {Scheme Procedure} open-inferior @var{directory} @ + [#:command "bin/guix"] Open the inferior Guix in @var{directory}, running +@code{@var{directory}/@var{command} repl} or equivalent. Return @code{#f} +if the inferior could not be launched. +@end deffn + +@cindex inferior packages +The procedures listed below allow you to obtain and manipulate inferior +packages. + +@deffn {Scheme Procedure} inferior-packages @var{inferior} +Return the list of packages known to @var{inferior}. +@end deffn + +@deffn {Scheme Procedure} lookup-inferior-packages @var{inferior} @var{name} @ + [@var{version}] Return the sorted list of inferior packages matching +@var{name} in @var{inferior}, with highest version numbers first. If +@var{version} is true, return only packages with a version number prefixed +by @var{version}. +@end deffn + +@deffn {Scheme Procedure} inferior-package? @var{obj} +Return true if @var{obj} is an inferior package. +@end deffn + +@deffn {Scheme Procedure} inferior-package-name @var{package} +@deffnx {Scheme Procedure} inferior-package-version @var{package} +@deffnx {Scheme Procedure} inferior-package-synopsis @var{package} +@deffnx {Scheme Procedure} inferior-package-description @var{package} +@deffnx {Scheme Procedure} inferior-package-home-page @var{package} +@deffnx {Scheme Procedure} inferior-package-location @var{package} +@deffnx {Scheme Procedure} inferior-package-inputs @var{package} +@deffnx {Scheme Procedure} inferior-package-native-inputs @var{package} +@deffnx {Scheme Procedure} inferior-package-propagated-inputs @var{package} +@deffnx {Scheme Procedure} inferior-package-transitive-propagated-inputs @var{package} +@deffnx {Scheme Procedure} inferior-package-native-search-paths @var{package} +@deffnx {Scheme Procedure} inferior-package-transitive-native-search-paths @var{package} +@deffnx {Scheme Procedure} inferior-package-search-paths @var{package} +These procedures are the counterpart of package record accessors +(@pxref{„package“-Referenz}). Most of them work by querying the inferior +@var{package} comes from, so the inferior must still be live when you call +these procedures. +@end deffn + +Inferior packages can be used transparently like any other package or +file-like object in G-expressions (@pxref{G-Ausdrücke}). They are also +transparently handled by the @code{packages->manifest} procedure, which is +commonly use in manifests (@pxref{Aufruf von guix package, the +@option{--manifest} option of @command{guix package}}). Thus you can insert +an inferior package pretty much anywhere you would insert a regular package: +in manifests, in the @code{packages} field of your @code{operating-system} +declaration, and so on. + +@node Invoking guix describe +@section Invoking @command{guix describe} + +@cindex Reproduzierbarkeit +@cindex replicating Guix +Often you may want to answer questions like: ``Which revision of Guix am I +using?'' or ``Which channels am I using?'' This is useful information in +many situations: if you want to @emph{replicate} an environment on a +different machine or user account, if you want to report a bug or to +determine what change in the channels you are using caused it, or if you +want to record your system state for reproducibility purposes. The +@command{guix describe} command answers these questions. + +When run from a @command{guix pull}ed @command{guix}, @command{guix +describe} displays the channel(s) that it was built from, including their +repository URL and commit IDs (@pxref{Channels}): + +@example +$ guix describe +Generation 10 Sep 03 2018 17:32:44 (current) + guix e0fa68c + repository URL: https://git.savannah.gnu.org/git/guix.git + branch: master + commit: e0fa68c7718fffd33d81af415279d6ddb518f727 +@end example + +If you're familiar with the Git version control system, this is similar in +spirit to @command{git describe}; the output is also similar to that of +@command{guix pull --list-generations}, but limited to the current +generation (@pxref{Aufruf von guix pull, the @option{--list-generations} +option}). Because the Git commit ID shown above unambiguously refers to a +snapshot of Guix, this information is all it takes to describe the revision +of Guix you're using, and also to replicate it. + +To make it easier to replicate Guix, @command{guix describe} can also be +asked to return a list of channels instead of the human-readable description +above: + +@example +$ guix describe -f channels +(list (channel + (name 'guix) + (url "https://git.savannah.gnu.org/git/guix.git") + (commit + "e0fa68c7718fffd33d81af415279d6ddb518f727"))) +@end example + +@noindent +You can save this to a file and feed it to @command{guix pull -C} on some +other machine or at a later point in time, which will instantiate @emph{this +exact Guix revision} (@pxref{Aufruf von guix pull, the @option{-C} option}). +From there on, since you're able to deploy the same revision of Guix, you +can just as well @emph{replicate a complete software environment}. We +humbly think that this is @emph{awesome}, and we hope you'll like it too! + +The details of the options supported by @command{guix describe} are as +follows: + +@table @code +@item --format=@var{format} +@itemx -f @var{format} +Produce output in the specified @var{format}, one of: + +@table @code +@item human +produce human-readable output; +@item channels +produce a list of channel specifications that can be passed to @command{guix +pull -C} or installed as @file{~/.config/guix/channels.scm} (@pxref{Aufruf von guix pull}). +@end table +@end table + +@node Aufruf von guix pack +@section Invoking @command{guix pack} + +Occasionally you want to pass software to people who are not (yet!) lucky +enough to be using Guix. You'd tell them to run @command{guix package -i +@var{something}}, but that's not possible in this case. This is where +@command{guix pack} comes in. + +@quotation Anmerkung +If you are looking for ways to exchange binaries among machines that already +run Guix, @pxref{Aufruf von guix copy}, @ref{Aufruf von guix publish}, and +@ref{Aufruf von guix archive}. +@end quotation + +@cindex pack +@cindex bundle +@cindex application bundle +@cindex software bundle +The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or +@dfn{software bundle}: it creates a tarball or some other archive containing +the binaries of the software you're interested in, and all its +dependencies. The resulting archive can be used on any machine that does +not have Guix, and people can run the exact same binaries as those you have +with Guix. The pack itself is created in a bit-reproducible fashion, so +anyone can verify that it really contains the build results that you pretend +to be shipping. + +For example, to create a bundle containing Guile, Emacs, Geiser, and all +their dependencies, you can run: + +@example +$ guix pack guile emacs geiser +@dots{} +/gnu/store/@dots{}-pack.tar.gz +@end example + +The result here is a tarball containing a @file{/gnu/store} directory with +all the relevant packages. The resulting tarball contains a @dfn{profile} +with the three packages of interest; the profile is the same as would be +created by @command{guix package -i}. It is this mechanism that is used to +create Guix's own standalone binary tarball (@pxref{Aus Binärdatei installieren}). + +Users of this pack would have to run +@file{/gnu/store/@dots{}-profile/bin/guile} to run Guile, which you may find +inconvenient. To work around it, you can create, say, a @file{/opt/gnu/bin} +symlink to the profile: + +@example +guix pack -S /opt/gnu/bin=bin guile emacs geiser +@end example + +@noindent +That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy. + +@cindex relocatable binaries, with @command{guix pack} +What if the recipient of your pack does not have root privileges on their +machine, and thus cannot unpack it in the root file system? In that case, +you will want to use the @code{--relocatable} option (see below). This +option produces @dfn{relocatable binaries}, meaning they they can be placed +anywhere in the file system hierarchy: in the example above, users can +unpack your tarball in their home directory and directly run +@file{./opt/gnu/bin/guile}. + +@cindex Docker, build an image with guix pack +Alternatively, you can produce a pack in the Docker image format using the +following command: + +@example +guix pack -f docker guile emacs geiser +@end example + +@noindent +The result is a tarball that can be passed to the @command{docker load} +command. See the +@uref{https://docs.docker.com/engine/reference/commandline/load/, Docker +documentation} for more information. + +@cindex Singularity, build an image with guix pack +@cindex SquashFS, build an image with guix pack +Yet another option is to produce a SquashFS image with the following +command: + +@example +guix pack -f squashfs guile emacs geiser +@end example + +@noindent +The result is a SquashFS file system image that can either be mounted or +directly be used as a file system container image with the +@uref{http://singularity.lbl.gov, Singularity container execution +environment}, using commands like @command{singularity shell} or +@command{singularity exec}. + +Several command-line options allow you to customize your pack: + +@table @code +@item --format=@var{format} +@itemx -f @var{format} +Produce a pack in the given @var{format}. + +The available formats are: + +@table @code +@item tarball +This is the default format. It produces a tarball containing all the +specified binaries and symlinks. + +@item docker +This produces a tarball that follows the +@uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, +Docker Image Specification}. + +@item squashfs +This produces a SquashFS image containing all the specified binaries and +symlinks, as well as empty mount points for virtual file systems like +procfs. +@end table + +@item --relocatable +@itemx -R +Produce @dfn{relocatable binaries}---i.e., binaries that can be placed +anywhere in the file system hierarchy and run from there. For example, if +you create a pack containing Bash with: + +@example +guix pack -R -S /mybin=bin bash +@end example + +@noindent +... you can copy that pack to a machine that lacks Guix, and from your home +directory as a normal user, run: + +@example +tar xf pack.tar.gz +./mybin/sh +@end example + +@noindent +In that shell, if you type @code{ls /gnu/store}, you'll notice that +@file{/gnu/store} shows up and contains all the dependencies of @code{bash}, +even though the machine actually lacks @file{/gnu/store} altogether! That is +probably the simplest way to deploy Guix-built software on a non-Guix +machine. + +There's a gotcha though: this technique relies on the @dfn{user namespace} +feature of the kernel Linux, which allows unprivileged users to mount or +change root. Old versions of Linux did not support it, and some GNU/Linux +distributions turn it off; on these systems, programs from the pack +@emph{will fail to run}, unless they are unpacked in the root file system. + +@item --expression=@var{expr} +@itemx -e @var{expr} +Consider the package @var{expr} evaluates to. + +This has the same purpose as the same-named option in @command{guix build} +(@pxref{Zusätzliche Erstellungsoptionen, @code{--expression} in @command{guix +build}}). + +@item --manifest=@var{Datei} +@itemx -m @var{Datei} +Use the packages contained in the manifest object returned by the Scheme +code in @var{file}. + +This has a similar purpose as the same-named option in @command{guix +package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same +manifest files. It allows you to define a collection of packages once and +use it both for creating profiles and for creating archives for use on +machines that do not have Guix installed. Note that you can specify +@emph{either} a manifest file @emph{or} a list of packages, but not both. + +@item --system=@var{System} +@itemx -s @var{system} +Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the +system type of the build host. + +@item --target=@var{triplet} +@cindex cross-compilation +Cross-build for @var{triplet}, which must be a valid GNU triplet, such as +@code{"mips64el-linux-gnu"} (@pxref{Specifying target triplets, GNU +configuration triplets,, autoconf, Autoconf}). + +@item --compression=@var{tool} +@itemx -C @var{tool} +Compress the resulting tarball using @var{tool}---one of @code{gzip}, +@code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression. + +@item --symlink=@var{spec} +@itemx -S @var{spec} +Add the symlinks specified by @var{spec} to the pack. This option can +appear several times. + +@var{spec} has the form @code{@var{source}=@var{target}}, where @var{source} +is the symlink that will be created and @var{target} is the symlink target. + +For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} +symlink pointing to the @file{bin} sub-directory of the profile. + +@item --localstatedir +Include the ``local state directory'', @file{/var/guix}, in the resulting +pack. + +@file{/var/guix} contains the store database (@pxref{Der Store}) as well as +garbage-collector roots (@pxref{Aufruf von guix gc}). Providing it in the +pack means that the store is ``complete'' and manageable by Guix; not +providing it pack means that the store is ``dead'': items cannot be added to +it or removed from it after extraction of the pack. + +One use case for this is the Guix self-contained binary tarball +(@pxref{Aus Binärdatei installieren}). + +@item --bootstrap +Use the bootstrap binaries to build the pack. This option is only useful to +Guix developers. +@end table + +In addition, @command{guix pack} supports all the common build options +(@pxref{Gemeinsame Erstellungsoptionen}) and all the package transformation options +(@pxref{Paketumwandlungsoptionen}). + + +@node Aufruf von guix archive +@section Invoking @command{guix archive} + +@cindex @command{guix archive} +@cindex archive +The @command{guix archive} command allows users to @dfn{export} files from +the store into a single archive, and to later @dfn{import} them on a machine +that runs Guix. In particular, it allows store files to be transferred from +one machine to the store on another machine. + +@quotation Anmerkung +If you're looking for a way to produce archives in a format suitable for +tools other than Guix, @pxref{Aufruf von guix pack}. +@end quotation + +@cindex exporting store items +To export store files as an archive to standard output, run: + +@example +guix archive --export @var{options} @var{specifications}... +@end example + +@var{specifications} may be either store file names or package +specifications, as for @command{guix package} (@pxref{Aufruf von guix package}). For instance, the following command creates an archive +containing the @code{gui} output of the @code{git} package and the main +output of @code{emacs}: + +@example +guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar +@end example + +If the specified packages are not built yet, @command{guix archive} +automatically builds them. The build process may be controlled with the +common build options (@pxref{Gemeinsame Erstellungsoptionen}). + +To transfer the @code{emacs} package to a machine connected over SSH, one +would run: + +@example +guix archive --export -r emacs | ssh the-machine guix archive --import +@end example + +@noindent +Similarly, a complete user profile may be transferred from one machine to +another like this: + +@example +guix archive --export -r $(readlink -f ~/.guix-profile) | \ + ssh the-machine guix-archive --import +@end example + +@noindent +However, note that, in both examples, all of @code{emacs} and the profile as +well as all of their dependencies are transferred (due to @code{-r}), +regardless of what is already available in the store on the target machine. +The @code{--missing} option can help figure out which items are missing from +the target store. The @command{guix copy} command simplifies and optimizes +this whole process, so this is probably what you should use in this case +(@pxref{Aufruf von guix copy}). + +@cindex nar, archive format +@cindex normalized archive (nar) +Archives are stored in the ``normalized archive'' or ``nar'' format, which +is comparable in spirit to `tar', but with differences that make it more +appropriate for our purposes. First, rather than recording all Unix +metadata for each file, the nar format only mentions the file type (regular, +directory, or symbolic link); Unix permissions and owner/group are +dismissed. Second, the order in which directory entries are stored always +follows the order of file names according to the C locale collation order. +This makes archive production fully deterministic. + +@c FIXME: Add xref to daemon doc about signatures. +When exporting, the daemon digitally signs the contents of the archive, and +that digital signature is appended. When importing, the daemon verifies the +signature and rejects the import in case of an invalid signature or if the +signing key is not authorized. + +The main options are: + +@table @code +@item --export +Export the specified store files or packages (see below.) Write the +resulting archive to the standard output. + +Dependencies are @emph{not} included in the output, unless +@code{--recursive} is passed. + +@item -r +@itemx --recursive +When combined with @code{--export}, this instructs @command{guix archive} to +include dependencies of the given items in the archive. Thus, the resulting +archive is self-contained: it contains the closure of the exported store +items. + +@item --import +Read an archive from the standard input, and import the files listed therein +into the store. Abort if the archive has an invalid digital signature, or +if it is signed by a public key not among the authorized keys (see +@code{--authorize} below.) + +@item --missing +Read a list of store file names from the standard input, one per line, and +write on the standard output the subset of these files missing from the +store. + +@item --generate-key[=@var{parameters}] +@cindex signing, archives +Generate a new key pair for the daemon. This is a prerequisite before +archives can be exported with @code{--export}. Note that this operation +usually takes time, because it needs to gather enough entropy to generate +the key pair. + +The generated key pair is typically stored under @file{/etc/guix}, in +@file{signing-key.pub} (public key) and @file{signing-key.sec} (private key, +which must be kept secret.) When @var{parameters} is omitted, an ECDSA key +using the Ed25519 curve is generated, or, for Libgcrypt versions before +1.6.0, it is a 4096-bit RSA key. Alternatively, @var{parameters} can +specify @code{genkey} parameters suitable for Libgcrypt (@pxref{General +public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The Libgcrypt +Reference Manual}). + +@item --authorize +@cindex authorizing, archives +Authorize imports signed by the public key passed on standard input. The +public key must be in ``s-expression advanced format''---i.e., the same +format as the @file{signing-key.pub} file. + +The list of authorized keys is kept in the human-editable file +@file{/etc/guix/acl}. The file contains +@url{http://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format +s-expressions''} and is structured as an access-control list in the +@url{http://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure +(SPKI)}. + +@item --extract=@var{directory} +@itemx -x @var{directory} +Read a single-item archive as served by substitute servers +(@pxref{Substitute}) and extract it to @var{directory}. This is a +low-level operation needed in only very narrow use cases; see below. + +For example, the following command extracts the substitute for Emacs served +by @code{hydra.gnu.org} to @file{/tmp/emacs}: + +@example +$ wget -O - \ + https://hydra.gnu.org/nar/@dots{}-emacs-24.5 \ + | bunzip2 | guix archive -x /tmp/emacs +@end example + +Single-item archives are different from multiple-item archives produced by +@command{guix archive --export}; they contain a single store item, and they +do @emph{not} embed a signature. Thus this operation does @emph{no} +signature verification and its output should be considered unsafe. + +The primary purpose of this operation is to facilitate inspection of archive +contents coming from possibly untrusted substitute servers. + +@end table + +@c ********************************************************************* +@node Programmierschnittstelle +@chapter Programmierschnittstelle + +GNU Guix provides several Scheme programming interfaces (APIs) to define, +build, and query packages. The first interface allows users to write +high-level package definitions. These definitions refer to familiar +packaging concepts, such as the name and version of a package, its build +system, and its dependencies. These definitions can then be turned into +concrete build actions. + +Build actions are performed by the Guix daemon, on behalf of users. In a +standard setup, the daemon has write access to the store---the +@file{/gnu/store} directory---whereas users do not. The recommended setup +also has the daemon perform builds in chroots, under a specific build users, +to minimize interference with the rest of the system. + +@cindex Ableitung +Lower-level APIs are available to interact with the daemon and the store. +To instruct the daemon to perform a build action, users actually provide it +with a @dfn{derivation}. A derivation is a low-level representation of the +build actions to be taken, and the environment in which they should +occur---derivations are to package definitions what assembly is to C +programs. The term ``derivation'' comes from the fact that build results +@emph{derive} from them. + +This chapter describes all these APIs in turn, starting from high-level +package definitions. + +@menu +* Pakete definieren:: Wie Sie neue Pakete definieren. +* Erstellungssysteme:: Angeben, wie Pakete erstellt werden. +* Der Store:: Den Paket-Store verändern. +* Ableitungen:: Systemnahe Schnittstelle für Paketableitungen. +* Die Store-Monade:: Rein funktionale Schnittstelle zum Store. +* G-Ausdrücke:: Erstellungsausdrücke verarbeiten. +* Invoking guix repl:: Fiddling with Guix interactively. +@end menu + +@node Pakete definieren +@section Pakete definieren + +The high-level interface to package definitions is implemented in the +@code{(guix packages)} and @code{(guix build-system)} modules. As an +example, the package definition, or @dfn{recipe}, for the GNU Hello package +looks like this: + +@example +(define-module (gnu packages hello) + #:use-module (guix packages) + #:use-module (guix download) + #:use-module (guix build-system gnu) + #:use-module (guix licenses) + #:use-module (gnu packages gawk)) + +(define-public hello + (package + (name "hello") + (version "2.10") + (source (origin + (method url-fetch) + (uri (string-append "mirror://gnu/hello/hello-" version + ".tar.gz")) + (sha256 + (base32 + "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) + (build-system gnu-build-system) + (arguments '(#:configure-flags '("--enable-silent-rules"))) + (inputs `(("gawk" ,gawk))) + (synopsis "Hello, GNU world: An example GNU package") + (description "Guess what GNU Hello prints!") + (home-page "http://www.gnu.org/software/hello/") + (license gpl3+))) +@end example + +@noindent +Without being a Scheme expert, the reader may have guessed the meaning of +the various fields here. This expression binds the variable @code{hello} to +a @code{<package>} object, which is essentially a record (@pxref{SRFI-9, +Scheme records,, guile, GNU Guile Reference Manual}). This package object +can be inspected using procedures found in the @code{(guix packages)} +module; for instance, @code{(package-name hello)} +returns---surprise!---@code{"hello"}. + +With luck, you may be able to import part or all of the definition of the +package you are interested in from another repository, using the @code{guix +import} command (@pxref{Aufruf von guix import}). + +In the example above, @var{hello} is defined in a module of its own, +@code{(gnu packages hello)}. Technically, this is not strictly necessary, +but it is convenient to do so: all the packages defined in modules under +@code{(gnu packages @dots{})} are automatically known to the command-line +tools (@pxref{Paketmodule}). + +There are a few points worth noting in the above package definition: + +@itemize +@item +The @code{source} field of the package is an @code{<origin>} object +(@pxref{„origin“-Referenz}, for the complete reference). Here, the +@code{url-fetch} method from @code{(guix download)} is used, meaning that +the source is a file to be downloaded over FTP or HTTP. + +The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the +GNU mirrors defined in @code{(guix download)}. + +The @code{sha256} field specifies the expected SHA256 hash of the file being +downloaded. It is mandatory, and allows Guix to check the integrity of the +file. The @code{(base32 @dots{})} form introduces the base32 representation +of the hash. You can obtain this information with @code{guix download} +(@pxref{Aufruf von guix download}) and @code{guix hash} (@pxref{Aufruf von guix hash}). + +@cindex patches +When needed, the @code{origin} form can also have a @code{patches} field +listing patches to be applied, and a @code{snippet} field giving a Scheme +expression to modify the source code. + +@item +@cindex GNU-Erstellungssystem +The @code{build-system} field specifies the procedure to build the package +(@pxref{Erstellungssysteme}). Here, @var{gnu-build-system} represents the +familiar GNU Build System, where packages may be configured, built, and +installed with the usual @code{./configure && make && make check && make +install} command sequence. + +@item +The @code{arguments} field specifies options for the build system +(@pxref{Erstellungssysteme}). Here it is interpreted by @var{gnu-build-system} +as a request run @file{configure} with the @code{--enable-silent-rules} +flag. + +@cindex quote +@cindex quoting +@findex ' +@findex quote +What about these quote (@code{'}) characters? They are Scheme syntax to +introduce a literal list; @code{'} is synonymous with @code{quote}. +@xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, for +details. Here the value of the @code{arguments} field is a list of +arguments passed to the build system down the road, as with @code{apply} +(@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference Manual}). + +The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} +(@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and +@code{#:configure-flags} is a keyword used to pass a keyword argument to the +build system (@pxref{Coding With Keywords,,, guile, GNU Guile Reference +Manual}). + +@item +The @code{inputs} field specifies inputs to the build process---i.e., +build-time or run-time dependencies of the package. Here, we define an +input called @code{"gawk"} whose value is that of the @var{gawk} variable; +@var{gawk} is itself bound to a @code{<package>} object. + +@cindex backquote (quasiquote) +@findex ` +@findex quasiquote +@cindex comma (unquote) +@findex , +@findex unquote +@findex ,@@ +@findex unquote-splicing +Again, @code{`} (a backquote, synonymous with @code{quasiquote}) allows us +to introduce a literal list in the @code{inputs} field, while @code{,} (a +comma, synonymous with @code{unquote}) allows us to insert a value in that +list (@pxref{Expression Syntax, unquote,, guile, GNU Guile Reference +Manual}). + +Note that GCC, Coreutils, Bash, and other essential tools do not need to be +specified as inputs here. Instead, @var{gnu-build-system} takes care of +ensuring that they are present (@pxref{Erstellungssysteme}). + +However, any other dependencies need to be specified in the @code{inputs} +field. Any dependency not specified here will simply be unavailable to the +build process, possibly leading to a build failure. +@end itemize + +@xref{„package“-Referenz}, for a full description of possible fields. + +Once a package definition is in place, the package may actually be built +using the @code{guix build} command-line tool (@pxref{Aufruf von guix build}), +troubleshooting any build failures you encounter (@pxref{Fehlschläge beim Erstellen untersuchen}). You can easily jump back to the package definition using the +@command{guix edit} command (@pxref{Aufruf von guix edit}). @xref{Paketrichtlinien}, for more information on how to test package definitions, and +@ref{Aufruf von guix lint}, for information on how to check a definition for +style conformance. +@vindex GUIX_PACKAGE_PATH +Lastly, @pxref{Channels}, for information on how to extend the distribution +by adding your own package definitions in a ``channel''. + +Finally, updating the package definition to a new upstream version can be +partly automated by the @command{guix refresh} command (@pxref{Aufruf von guix refresh}). + +Behind the scenes, a derivation corresponding to the @code{<package>} object +is first computed by the @code{package-derivation} procedure. That +derivation is stored in a @code{.drv} file under @file{/gnu/store}. The +build actions it prescribes may then be realized by using the +@code{build-derivations} procedure (@pxref{Der Store}). + +@deffn {Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}] +Return the @code{<derivation>} object of @var{package} for @var{system} +(@pxref{Ableitungen}). + +@var{package} must be a valid @code{<package>} object, and @var{system} must +be a string denoting the target system type---e.g., @code{"x86_64-linux"} +for an x86_64 Linux-based GNU system. @var{store} must be a connection to +the daemon, which operates on the store (@pxref{Der Store}). +@end deffn + +@noindent +@cindex cross-compilation +Similarly, it is possible to compute a derivation that cross-builds a +package for some other system: + +@deffn {Scheme Procedure} package-cross-derivation @var{store} @ + @var{package} @var{target} [@var{system}] Return the @code{<derivation>} +object of @var{package} cross-built from @var{system} to @var{target}. + +@var{target} must be a valid GNU triplet denoting the target hardware and +operating system, such as @code{"mips64el-linux-gnu"} (@pxref{Configuration +Names, GNU configuration triplets,, configure, GNU Configure and Build +System}). +@end deffn + +@cindex package transformations +@cindex input rewriting +@cindex dependency tree rewriting +Packages can be manipulated in arbitrary ways. An example of a useful +transformation is @dfn{input rewriting}, whereby the dependency tree of a +package is rewritten by replacing specific inputs by others: + +@deffn {Scheme Procedure} package-input-rewriting @var{replacements} @ + [@var{rewrite-name}] Return a procedure that, when passed a package, +replaces its direct and indirect dependencies (but not its implicit inputs) +according to @var{replacements}. @var{replacements} is a list of package +pairs; the first element of each pair is the package to replace, and the +second one is the replacement. + +Optionally, @var{rewrite-name} is a one-argument procedure that takes the +name of a package and returns its new name after rewrite. +@end deffn + +@noindent +Consider this example: + +@example +(define libressl-instead-of-openssl + ;; This is a procedure to replace OPENSSL by LIBRESSL, + ;; recursively. + (package-input-rewriting `((,openssl . ,libressl)))) + +(define git-with-libressl + (libressl-instead-of-openssl git)) +@end example + +@noindent +Here we first define a rewriting procedure that replaces @var{openssl} with +@var{libressl}. Then we use it to define a @dfn{variant} of the @var{git} +package that uses @var{libressl} instead of @var{openssl}. This is exactly +what the @option{--with-input} command-line option does (@pxref{Paketumwandlungsoptionen, @option{--with-input}}). + +A more generic procedure to rewrite a package dependency graph is +@code{package-mapping}: it supports arbitrary changes to nodes in the graph. + +@deffn {Scheme Procedure} package-mapping @var{proc} [@var{cut?}] +Return a procedure that, given a package, applies @var{proc} to all the +packages depended on and returns the resulting package. The procedure stops +recursion when @var{cut?} returns true for a given package. +@end deffn + +@menu +* „package“-Referenz:: Der Datentyp für Pakete. +* „origin“-Referenz:: Datentyp für Paketursprünge. +@end menu + + +@node „package“-Referenz +@subsection @code{package} Reference + +This section summarizes all the options available in @code{package} +declarations (@pxref{Pakete definieren}). + +@deftp {Data Type} package +This is the data type representing a package recipe. + +@table @asis +@item @code{name} +The name of the package, as a string. + +@item @code{version} +The version of the package, as a string. + +@item @code{source} +An object telling how the source code for the package should be acquired. +Most of the time, this is an @code{origin} object, which denotes a file +fetched from the Internet (@pxref{„origin“-Referenz}). It can also be any +other ``file-like'' object such as a @code{local-file}, which denotes a file +from the local file system (@pxref{G-Ausdrücke, @code{local-file}}). + +@item @code{build-system} +The build system that should be used to build the package (@pxref{Erstellungssysteme}). + +@item @code{arguments} (default: @code{'()}) +The arguments that should be passed to the build system. This is a list, +typically containing sequential keyword-value pairs. + +@item @code{inputs} (default: @code{'()}) +@itemx @code{native-inputs} (default: @code{'()}) +@itemx @code{propagated-inputs} (default: @code{'()}) +@cindex inputs, of packages +These fields list dependencies of the package. Each one is a list of +tuples, where each tuple has a label for the input (a string) as its first +element, a package, origin, or derivation as its second element, and +optionally the name of the output thereof that should be used, which +defaults to @code{"out"} (@pxref{Pakete mit mehreren Ausgaben.}, for more +on package outputs). For example, the list below specifies three inputs: + +@example +`(("libffi" ,libffi) + ("libunistring" ,libunistring) + ("glib:bin" ,glib "bin")) ;the "bin" output of Glib +@end example + +@cindex cross compilation, package dependencies +The distinction between @code{native-inputs} and @code{inputs} is necessary +when considering cross-compilation. When cross-compiling, dependencies +listed in @code{inputs} are built for the @emph{target} architecture; +conversely, dependencies listed in @code{native-inputs} are built for the +architecture of the @emph{build} machine. + +@code{native-inputs} is typically used to list tools needed at build time, +but not at run time, such as Autoconf, Automake, pkg-config, Gettext, or +Bison. @command{guix lint} can report likely mistakes in this area +(@pxref{Aufruf von guix lint}). + +@anchor{package-propagated-inputs} +Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the +specified packages will be automatically installed alongside the package +they belong to (@pxref{package-cmd-propagated-inputs, @command{guix +package}}, for information on how @command{guix package} deals with +propagated inputs.) + +For example this is necessary when a C/C++ library needs headers of another +library to compile, or when a pkg-config file refers to another one @i{via} +its @code{Requires} field. + +Another example where @code{propagated-inputs} is useful is for languages +that lack a facility to record the run-time search path akin to the +@code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. +To ensure that libraries written in those languages can find library code +they depend on at run time, run-time dependencies must be listed in +@code{propagated-inputs} rather than @code{inputs}. + +@item @code{self-native-input?} (default: @code{#f}) +This is a Boolean field telling whether the package should use itself as a +native input when cross-compiling. + +@item @code{outputs} (default: @code{'("out")}) +The list of output names of the package. @xref{Pakete mit mehreren Ausgaben.}, for typical uses of additional outputs. + +@item @code{native-search-paths} (default: @code{'()}) +@itemx @code{search-paths} (default: @code{'()}) +A list of @code{search-path-specification} objects describing search-path +environment variables honored by the package. + +@item @code{replacement} (default: @code{#f}) +This must be either @code{#f} or a package object that will be used as a +@dfn{replacement} for this package. @xref{Sicherheitsaktualisierungen, grafts}, for +details. + +@item @code{synopsis} +Eine einzeilige Beschreibung des Pakets. + +@item @code{description} +Eine ausführlichere Beschreibung des Pakets. + +@item @code{license} +@cindex license, of packages +The license of the package; a value from @code{(guix licenses)}, or a list +of such values. + +@item @code{home-page} +The URL to the home-page of the package, as a string. + +@item @code{supported-systems} (default: @var{%supported-systems}) +The list of systems supported by the package, as strings of the form +@code{architecture-kernel}, for example @code{"x86_64-linux"}. + +@item @code{maintainers} (default: @code{'()}) +The list of maintainers of the package, as @code{maintainer} objects. + +@item @code{location} (default: source location of the @code{package} form) +The source location of the package. It is useful to override this when +inheriting from another package, in which case this field is not +automatically corrected. +@end table +@end deftp + + +@node „origin“-Referenz +@subsection @code{origin} Reference + +This section summarizes all the options available in @code{origin} +declarations (@pxref{Pakete definieren}). + +@deftp {Data Type} origin +This is the data type representing a source code origin. + +@table @asis +@item @code{uri} +An object containing the URI of the source. The object type depends on the +@code{method} (see below). For example, when using the @var{url-fetch} +method of @code{(guix download)}, the valid @code{uri} values are: a URL +represented as a string, or a list thereof. + +@item @code{method} +A procedure that handles the URI. + +Examples include: + +@table @asis +@item @var{url-fetch} from @code{(guix download)} +download a file from the HTTP, HTTPS, or FTP URL specified in the @code{uri} +field; + +@vindex git-fetch +@item @var{git-fetch} from @code{(guix git-download)} +clone the Git version control repository, and check out the revision +specified in the @code{uri} field as a @code{git-reference} object; a +@code{git-reference} looks like this: + +@example +(git-reference + (url "git://git.debian.org/git/pkg-shadow/shadow") + (commit "v4.1.5.1")) +@end example +@end table + +@item @code{sha256} +A bytevector containing the SHA-256 hash of the source. Typically the +@code{base32} form is used here to generate the bytevector from a base-32 +string. + +You can obtain this information using @code{guix download} (@pxref{Aufruf von guix download}) or @code{guix hash} (@pxref{Aufruf von guix hash}). + +@item @code{file-name} (default: @code{#f}) +The file name under which the source code should be saved. When this is +@code{#f}, a sensible default value will be used in most cases. In case the +source is fetched from a URL, the file name from the URL will be used. For +version control checkouts, it is recommended to provide the file name +explicitly because the default is not very descriptive. + +@item @code{patches} (default: @code{'()}) +A list of file names, origins, or file-like objects (@pxref{G-Ausdrücke, +file-like objects}) pointing to patches to be applied to the source. + +This list of patches must be unconditional. In particular, it cannot depend +on the value of @code{%current-system} or @code{%current-target-system}. + +@item @code{snippet} (default: @code{#f}) +A G-expression (@pxref{G-Ausdrücke}) or S-expression that will be run in +the source directory. This is a convenient way to modify the source, +sometimes more convenient than a patch. + +@item @code{patch-flags} (default: @code{'("-p1")}) +A list of command-line flags that should be passed to the @code{patch} +command. + +@item @code{patch-inputs} (default: @code{#f}) +Input packages or derivations to the patching process. When this is +@code{#f}, the usual set of inputs necessary for patching are provided, such +as GNU@tie{}Patch. + +@item @code{modules} (default: @code{'()}) +A list of Guile modules that should be loaded during the patching process +and while running the code in the @code{snippet} field. + +@item @code{patch-guile} (default: @code{#f}) +The Guile package that should be used in the patching process. When this is +@code{#f}, a sensible default is used. +@end table +@end deftp + + +@node Erstellungssysteme +@section Erstellungssysteme + +@cindex build system +Each package definition specifies a @dfn{build system} and arguments for +that build system (@pxref{Pakete definieren}). This @code{build-system} +field represents the build procedure of the package, as well as implicit +dependencies of that build procedure. + +Build systems are @code{<build-system>} objects. The interface to create +and manipulate them is provided by the @code{(guix build-system)} module, +and actual build systems are exported by specific modules. + +@cindex bag (low-level package representation) +Under the hood, build systems first compile package objects to @dfn{bags}. +A @dfn{bag} is like a package, but with less ornamentation---in other words, +a bag is a lower-level representation of a package, which includes all the +inputs of that package, including some that were implicitly added by the +build system. This intermediate representation is then compiled to a +derivation (@pxref{Ableitungen}). + +Build systems accept an optional list of @dfn{arguments}. In package +definitions, these are passed @i{via} the @code{arguments} field +(@pxref{Pakete definieren}). They are typically keyword arguments +(@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU Guile +Reference Manual}). The value of these arguments is usually evaluated in +the @dfn{build stratum}---i.e., by a Guile process launched by the daemon +(@pxref{Ableitungen}). + +The main build system is @var{gnu-build-system}, which implements the +standard build procedure for GNU and many other packages. It is provided by +the @code{(guix build-system gnu)} module. + +@defvr {Scheme Variable} gnu-build-system +@var{gnu-build-system} represents the GNU Build System, and variants thereof +(@pxref{Configuration, configuration and makefile conventions,, standards, +GNU Coding Standards}). + +@cindex build phases +In a nutshell, packages using it are configured, built, and installed with +the usual @code{./configure && make && make check && make install} command +sequence. In practice, a few additional steps are often needed. All these +steps are split up in separate @dfn{phases}, notably@footnote{Please see the +@code{(guix build gnu-build-system)} modules for more details about the +build phases.}: + +@table @code +@item unpack +Unpack the source tarball, and change the current directory to the extracted +source tree. If the source is actually a directory, copy it to the build +tree, and enter that directory. + +@item patch-source-shebangs +Patch shebangs encountered in source files so they refer to the right store +file names. For instance, this changes @code{#!/bin/sh} to +@code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}. + +@item configure +Run the @file{configure} script with a number of default options, such as +@code{--prefix=/gnu/store/@dots{}}, as well as the options specified by the +@code{#:configure-flags} argument. + +@item build +Run @code{make} with the list of flags specified with @code{#:make-flags}. +If the @code{#:parallel-build?} argument is true (the default), build with +@code{make -j}. + +@item check +Run @code{make check}, or some other target specified with +@code{#:test-target}, unless @code{#:tests? #f} is passed. If the +@code{#:parallel-tests?} argument is true (the default), run @code{make +check -j}. + +@item install +Run @code{make install} with the flags listed in @code{#:make-flags}. + +@item patch-shebangs +Patch shebangs on the installed executable files. + +@item strip +Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} is +false), copying them to the @code{debug} output when available +(@pxref{Dateien zur Fehlersuche installieren}). +@end table + +@vindex %standard-phases +The build-side module @code{(guix build gnu-build-system)} defines +@var{%standard-phases} as the default list of build phases. +@var{%standard-phases} is a list of symbol/procedure pairs, where the +procedure implements the actual phase. + +The list of phases used for a particular package can be changed with the +@code{#:phases} parameter. For instance, passing: + +@example +#:phases (modify-phases %standard-phases (delete 'configure)) +@end example + +means that all the phases described above will be used, except the +@code{configure} phase. + +In addition, this build system ensures that the ``standard'' environment for +GNU packages is available. This includes tools such as GCC, libc, +Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix +build-system gnu)} module for a complete list). We call these the +@dfn{implicit inputs} of a package, because package definitions do not have +to mention them. +@end defvr + +Other @code{<build-system>} objects are defined to support other conventions +and tools used by free software packages. They inherit most of +@var{gnu-build-system}, and differ mainly in the set of inputs implicitly +added to the build process, and in the list of phases executed. Some of +these build systems are listed below. + +@defvr {Scheme Variable} ant-build-system +This variable is exported by @code{(guix build-system ant)}. It implements +the build procedure for Java packages that can be built with +@url{http://ant.apache.org/, Ant build tool}. + +It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as provided +by the @code{icedtea} package to the set of inputs. Different packages can +be specified with the @code{#:ant} and @code{#:jdk} parameters, +respectively. + +When the original package does not provide a suitable Ant build file, the +parameter @code{#:jar-name} can be used to generate a minimal Ant build file +@file{build.xml} with tasks to build the specified jar archive. In this +case the parameter @code{#:source-dir} can be used to specify the source +sub-directory, defaulting to ``src''. + +The @code{#:main-class} parameter can be used with the minimal ant buildfile +to specify the main class of the resulting jar. This makes the jar file +executable. The @code{#:test-include} parameter can be used to specify the +list of junit tests to run. It defaults to @code{(list "**/*Test.java")}. +The @code{#:test-exclude} can be used to disable some tests. It defaults to +@code{(list "**/Abstract*.java")}, because abstract classes cannot be run as +tests. + +The parameter @code{#:build-target} can be used to specify the Ant task that +should be run during the @code{build} phase. By default the ``jar'' task +will be run. + +@end defvr + +@defvr {Scheme Variable} android-ndk-build-system +@cindex Android distribution +@cindex Android NDK build system +This variable is exported by @code{(guix build-system android-ndk)}. It +implements a build procedure for Android NDK (native development kit) +packages using a Guix-specific build process. + +The build system assumes that packages install their public interface +(header) files to the subdirectory "include" of the "out" output and their +libraries to the subdirectory "lib" of the "out" output. + +It's also assumed that the union of all the dependencies of a package has no +conflicting files. + +For the time being, cross-compilation is not supported - so right now the +libraries and header files are assumed to be host tools. + +@end defvr + +@defvr {Scheme Variable} asdf-build-system/source +@defvrx {Scheme Variable} asdf-build-system/sbcl +@defvrx {Scheme Variable} asdf-build-system/ecl + +These variables, exported by @code{(guix build-system asdf)}, implement +build procedures for Common Lisp packages using +@url{https://common-lisp.net/project/asdf/, ``ASDF''}. ASDF is a system +definition facility for Common Lisp programs and libraries. + +The @code{asdf-build-system/source} system installs the packages in source +form, and can be loaded using any common lisp implementation, via ASDF. The +others, such as @code{asdf-build-system/sbcl}, install binary systems in the +format which a particular implementation understands. These build systems +can also be used to produce executable programs, or lisp images which +contain a set of packages pre-loaded. + +The build system uses naming conventions. For binary packages, the package +name should be prefixed with the lisp implementation, such as @code{sbcl-} +for @code{asdf-build-system/sbcl}. + +Additionally, the corresponding source package should be labeled using the +same convention as python packages (see @ref{Python-Module}), using the +@code{cl-} prefix. + +For binary packages, each system should be defined as a Guix package. If +one package @code{origin} contains several systems, package variants can be +created in order to build all the systems. Source packages, which use +@code{asdf-build-system/source}, may contain several systems. + +In order to create executable programs and images, the build-side procedures +@code{build-program} and @code{build-image} can be used. They should be +called in a build phase after the @code{create-symlinks} phase, so that the +system which was just built can be used within the resulting image. +@code{build-program} requires a list of Common Lisp expressions to be passed +as the @code{#:entry-program} argument. + +If the system is not defined within its own @code{.asd} file of the same +name, then the @code{#:asd-file} parameter should be used to specify which +file the system is defined in. Furthermore, if the package defines a system +for its tests in a separate file, it will be loaded before the tests are run +if it is specified by the @code{#:test-asd-file} parameter. If it is not +set, the files @code{<system>-tests.asd}, @code{<system>-test.asd}, +@code{tests.asd}, and @code{test.asd} will be tried if they exist. + +If for some reason the package must be named in a different way than the +naming conventions suggest, the @code{#:asd-system-name} parameter can be +used to specify the name of the system. + +@end defvr + +@defvr {Scheme Variable} cargo-build-system +@cindex Rust programming language +@cindex Cargo (Rust build system) +This variable is exported by @code{(guix build-system cargo)}. It supports +builds of packages using Cargo, the build tool of the +@uref{https://www.rust-lang.org, Rust programming language}. + +In its @code{configure} phase, this build system replaces dependencies +specified in the @file{Carto.toml} file with inputs to the Guix package. +The @code{install} phase installs the binaries, and it also installs the +source code and @file{Cargo.toml} file. +@end defvr + +@defvr {Scheme Variable} cmake-build-system +This variable is exported by @code{(guix build-system cmake)}. It +implements the build procedure for packages using the +@url{http://www.cmake.org, CMake build tool}. + +It automatically adds the @code{cmake} package to the set of inputs. Which +package is used can be specified with the @code{#:cmake} parameter. + +The @code{#:configure-flags} parameter is taken as a list of flags passed to +the @command{cmake} command. The @code{#:build-type} parameter specifies in +abstract terms the flags passed to the compiler; it defaults to +@code{"RelWithDebInfo"} (short for ``release mode with debugging +information''), which roughly means that code is compiled with @code{-O2 +-g}, as is the case for Autoconf-based packages by default. +@end defvr + +@defvr {Scheme Variable} go-build-system +This variable is exported by @code{(guix build-system go)}. It implements a +build procedure for Go packages using the standard +@url{https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies, Go +build mechanisms}. + +The user is expected to provide a value for the key @code{#:import-path} +and, in some cases, @code{#:unpack-path}. The +@url{https://golang.org/doc/code.html#ImportPaths, import path} corresponds +to the file system path expected by the package's build scripts and any +referring packages, and provides a unique way to refer to a Go package. It +is typically based on a combination of the package source code's remote URI +and file system hierarchy structure. In some cases, you will need to unpack +the package's source code to a different directory structure than the one +indicated by the import path, and @code{#:unpack-path} should be used in +such cases. + +Packages that provide Go libraries should be installed along with their +source code. The key @code{#:install-source?}, which defaults to @code{#t}, +controls whether or not the source code is installed. It can be set to +@code{#f} for packages that only provide executable files. +@end defvr + +@defvr {Scheme Variable} glib-or-gtk-build-system +This variable is exported by @code{(guix build-system glib-or-gtk)}. It is +intended for use with packages making use of GLib or GTK+. + +This build system adds the following two phases to the ones defined by +@var{gnu-build-system}: + +@table @code +@item glib-or-gtk-wrap +The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are +able to find GLib ``schemas'' and +@uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ +modules}. This is achieved by wrapping the programs in launch scripts that +appropriately set the @code{XDG_DATA_DIRS} and @code{GTK_PATH} environment +variables. + +It is possible to exclude specific package outputs from that wrapping +process by listing their names in the +@code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful when +an output is known not to contain any GLib or GTK+ binaries, and where +wrapping would gratuitously add a dependency of that output on GLib and +GTK+. + +@item glib-or-gtk-compile-schemas +The phase @code{glib-or-gtk-compile-schemas} makes sure that all +@uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, +GSettings schemas} of GLib are compiled. Compilation is performed by the +@command{glib-compile-schemas} program. It is provided by the package +@code{glib:bin} which is automatically imported by the build system. The +@code{glib} package providing @command{glib-compile-schemas} can be +specified with the @code{#:glib} parameter. +@end table + +Both phases are executed after the @code{install} phase. +@end defvr + +@defvr {Scheme Variable} guile-build-system +This build system is for Guile packages that consist exclusively of Scheme +code and that are so lean that they don't even have a makefile, let alone a +@file{configure} script. It compiles Scheme code using @command{guild +compile} (@pxref{Compilation,,, guile, GNU Guile Reference Manual}) and +installs the @file{.scm} and @file{.go} files in the right place. It also +installs documentation. + +This build system supports cross-compilation by using the @code{--target} +option of @command{guild compile}. + +Packages built with @code{guile-build-system} must provide a Guile package +in their @code{native-inputs} field. +@end defvr + +@defvr {Scheme Variable} minify-build-system +This variable is exported by @code{(guix build-system minify)}. It +implements a minification procedure for simple JavaScript packages. + +It adds @code{uglify-js} to the set of inputs and uses it to compress all +JavaScript files in the @file{src} directory. A different minifier package +can be specified with the @code{#:uglify-js} parameter, but it is expected +that the package writes the minified code to the standard output. + +When the input JavaScript files are not all located in the @file{src} +directory, the parameter @code{#:javascript-files} can be used to specify a +list of file names to feed to the minifier. +@end defvr + +@defvr {Scheme Variable} ocaml-build-system +This variable is exported by @code{(guix build-system ocaml)}. It +implements a build procedure for @uref{https://ocaml.org, OCaml} packages, +which consists of choosing the correct set of commands to run for each +package. OCaml packages can expect many different commands to be run. This +build system will try some of them. + +When the package has a @file{setup.ml} file present at the top-level, it +will run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and +@code{ocaml setup.ml -install}. The build system will assume that this file +was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will +take care of setting the prefix and enabling tests if they are not +disabled. You can pass configure and build flags with the +@code{#:configure-flags} and @code{#:build-flags}. The @code{#:test-flags} +key can be passed to change the set of flags used to enable tests. The +@code{#:use-make?} key can be used to bypass this system in the build and +install phases. + +When the package has a @file{configure} file, it is assumed that it is a +hand-made configure script that requires a different argument format than in +the @code{gnu-build-system}. You can add more flags with the +@code{#:configure-flags} key. + +When the package has a @file{Makefile} file (or @code{#:use-make?} is +@code{#t}), it will be used and more flags can be passed to the build and +install phases with the @code{#:make-flags} key. + +Finally, some packages do not have these files and use a somewhat standard +location for its build system. In that case, the build system will run +@code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of +providing the path to the required findlib module. Additional flags can be +passed via the @code{#:build-flags} key. Install is taken care of by +@command{opam-installer}. In this case, the @code{opam} package must be +added to the @code{native-inputs} field of the package definition. + +Note that most OCaml packages assume they will be installed in the same +directory as OCaml, which is not what we want in guix. In particular, they +will install @file{.so} files in their module's directory, which is usually +fine because it is in the OCaml compiler directory. In guix though, these +libraries cannot be found and we use @code{CAML_LD_LIBRARY_PATH}. This +variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where +@file{.so} libraries should be installed. +@end defvr + +@defvr {Scheme Variable} python-build-system +This variable is exported by @code{(guix build-system python)}. It +implements the more or less standard build procedure used by Python +packages, which consists in running @code{python setup.py build} and then +@code{python setup.py install --prefix=/gnu/store/@dots{}}. + +For packages that install stand-alone Python programs under @code{bin/}, it +takes care of wrapping these programs so that their @code{PYTHONPATH} +environment variable points to all the Python libraries they depend on. + +Which Python package is used to perform the build can be specified with the +@code{#:python} parameter. This is a useful way to force a package to be +built for a specific version of the Python interpreter, which might be +necessary if the package is only compatible with a single interpreter +version. + +By default guix calls @code{setup.py} under control of @code{setuptools}, +much like @command{pip} does. Some packages are not compatible with +setuptools (and pip), thus you can disable this by setting the +@code{#:use-setuptools} parameter to @code{#f}. +@end defvr + +@defvr {Scheme Variable} perl-build-system +This variable is exported by @code{(guix build-system perl)}. It implements +the standard build procedure for Perl packages, which either consists in +running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, followed by +@code{Build} and @code{Build install}; or in running @code{perl Makefile.PL +PREFIX=/gnu/store/@dots{}}, followed by @code{make} and @code{make install}, +depending on which of @code{Build.PL} or @code{Makefile.PL} is present in +the package distribution. Preference is given to the former if both +@code{Build.PL} and @code{Makefile.PL} exist in the package distribution. +This preference can be reversed by specifying @code{#t} for the +@code{#:make-maker?} parameter. + +The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation +passes flags specified by the @code{#:make-maker-flags} or +@code{#:module-build-flags} parameter, respectively. + +Which Perl package is used can be specified with @code{#:perl}. +@end defvr + +@defvr {Scheme Variable} r-build-system +This variable is exported by @code{(guix build-system r)}. It implements +the build procedure used by @uref{http://r-project.org, R} packages, which +essentially is little more than running @code{R CMD INSTALL +--library=/gnu/store/@dots{}} in an environment where @code{R_LIBS_SITE} +contains the paths to all R package inputs. Tests are run after +installation using the R function @code{tools::testInstalledPackage}. +@end defvr + +@defvr {Scheme Variable} texlive-build-system +This variable is exported by @code{(guix build-system texlive)}. It is used +to build TeX packages in batch mode with a specified engine. The build +system sets the @code{TEXINPUTS} variable to find all TeX source files in +the inputs. + +By default it runs @code{luatex} on all files ending on @code{ins}. A +different engine and format can be specified with the @code{#:tex-format} +argument. Different build targets can be specified with the +@code{#:build-targets} argument, which expects a list of file names. The +build system adds only @code{texlive-bin} and @code{texlive-latex-base} +(both from @code{(gnu packages tex}) to the inputs. Both can be overridden +with the arguments @code{#:texlive-bin} and @code{#:texlive-latex-base}, +respectively. + +The @code{#:tex-directory} parameter tells the build system where to install +the built files under the texmf tree. +@end defvr + +@defvr {Scheme Variable} ruby-build-system +This variable is exported by @code{(guix build-system ruby)}. It implements +the RubyGems build procedure used by Ruby packages, which involves running +@code{gem build} followed by @code{gem install}. + +The @code{source} field of a package that uses this build system typically +references a gem archive, since this is the format that Ruby developers use +when releasing their software. The build system unpacks the gem archive, +potentially patches the source, runs the test suite, repackages the gem, and +installs it. Additionally, directories and tarballs may be referenced to +allow building unreleased gems from Git or a traditional source release +tarball. + +Which Ruby package is used can be specified with the @code{#:ruby} +parameter. A list of additional flags to be passed to the @command{gem} +command can be specified with the @code{#:gem-flags} parameter. +@end defvr + +@defvr {Scheme Variable} waf-build-system +This variable is exported by @code{(guix build-system waf)}. It implements +a build procedure around the @code{waf} script. The common +phases---@code{configure}, @code{build}, and @code{install}---are +implemented by passing their names as arguments to the @code{waf} script. + +The @code{waf} script is executed by the Python interpreter. Which Python +package is used to run the script can be specified with the @code{#:python} +parameter. +@end defvr + +@defvr {Scheme Variable} scons-build-system +This variable is exported by @code{(guix build-system scons)}. It +implements the build procedure used by the SCons software construction +tool. This build system runs @code{scons} to build the package, @code{scons +test} to run tests, and then @code{scons install} to install the package. + +Additional flags to be passed to @code{scons} can be specified with the +@code{#:scons-flags} parameter. The version of Python used to run SCons can +be specified by selecting the appropriate SCons package with the +@code{#:scons} parameter. +@end defvr + +@defvr {Scheme Variable} haskell-build-system +This variable is exported by @code{(guix build-system haskell)}. It +implements the Cabal build procedure used by Haskell packages, which +involves running @code{runhaskell Setup.hs configure +--prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. Instead +of installing the package by running @code{runhaskell Setup.hs install}, to +avoid trying to register libraries in the read-only compiler store +directory, the build system uses @code{runhaskell Setup.hs copy}, followed +by @code{runhaskell Setup.hs register}. In addition, the build system +generates the package documentation by running @code{runhaskell Setup.hs +haddock}, unless @code{#:haddock? #f} is passed. Optional Haddock +parameters can be passed with the help of the @code{#:haddock-flags} +parameter. If the file @code{Setup.hs} is not found, the build system looks +for @code{Setup.lhs} instead. + +Which Haskell compiler is used can be specified with the @code{#:haskell} +parameter which defaults to @code{ghc}. +@end defvr + +@defvr {Scheme Variable} dub-build-system +This variable is exported by @code{(guix build-system dub)}. It implements +the Dub build procedure used by D packages, which involves running @code{dub +build} and @code{dub run}. Installation is done by copying the files +manually. + +Which D compiler is used can be specified with the @code{#:ldc} parameter +which defaults to @code{ldc}. +@end defvr + +@defvr {Scheme Variable} emacs-build-system +This variable is exported by @code{(guix build-system emacs)}. It +implements an installation procedure similar to the packaging system of +Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual}). + +It first creates the @code{@var{package}-autoloads.el} file, then it byte +compiles all Emacs Lisp files. Differently from the Emacs packaging system, +the Info documentation files are moved to the standard documentation +directory and the @file{dir} file is deleted. Each package is installed in +its own directory under @file{share/emacs/site-lisp/guix.d}. +@end defvr + +@defvr {Scheme Variable} font-build-system +This variable is exported by @code{(guix build-system font)}. It implements +an installation procedure for font packages where upstream provides +pre-compiled TrueType, OpenType, etc. font files that merely need to be +copied into place. It copies font files to standard locations in the output +directory. +@end defvr + +@defvr {Scheme Variable} meson-build-system +This variable is exported by @code{(guix build-system meson)}. It +implements the build procedure for packages that use +@url{http://mesonbuild.com, Meson} as their build system. + +It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set of +inputs, and they can be changed with the parameters @code{#:meson} and +@code{#:ninja} if needed. The default Meson is @code{meson-for-build}, +which is special because it doesn't clear the @code{RUNPATH} of binaries and +libraries when they are installed. + +This build system is an extension of @var{gnu-build-system}, but with the +following phases changed to some specific for Meson: + +@table @code + +@item configure +The phase runs @code{meson} with the flags specified in +@code{#:configure-flags}. The flag @code{--build-type} is always set to +@code{plain} unless something else is specified in @code{#:build-type}. + +@item build +The phase runs @code{ninja} to build the package in parallel by default, but +this can be changed with @code{#:parallel-build?}. + +@item check +The phase runs @code{ninja} with the target specified in +@code{#:test-target}, which is @code{"test"} by default. + +@item install +The phase runs @code{ninja install} and can not be changed. +@end table + +Apart from that, the build system also adds the following phases: + +@table @code + +@item fix-runpath +This phase ensures that all binaries can find the libraries they need. It +searches for required libraries in subdirectories of the package being +built, and adds those to @code{RUNPATH} where needed. It also removes +references to libraries left over from the build phase by +@code{meson-for-build}, such as test dependencies, that aren't actually +required for the program to run. + +@item glib-or-gtk-wrap +This phase is the phase provided by @code{glib-or-gtk-build-system}, and it +is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}. + +@item glib-or-gtk-compile-schemas +This phase is the phase provided by @code{glib-or-gtk-build-system}, and it +is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}. +@end table +@end defvr + +Lastly, for packages that do not need anything as sophisticated, a +``trivial'' build system is provided. It is trivial in the sense that it +provides basically no support: it does not pull any implicit inputs, and +does not have a notion of build phases. + +@defvr {Scheme Variable} trivial-build-system +This variable is exported by @code{(guix build-system trivial)}. + +This build system requires a @code{#:builder} argument. This argument must +be a Scheme expression that builds the package output(s)---as with +@code{build-expression->derivation} (@pxref{Ableitungen, +@code{build-expression->derivation}}). +@end defvr + +@node Der Store +@section Der Store + +@cindex Store +@cindex store items +@cindex store paths + +Conceptually, the @dfn{store} is the place where derivations that have been +built successfully are stored---by default, @file{/gnu/store}. +Sub-directories in the store are referred to as @dfn{store items} or +sometimes @dfn{store paths}. The store has an associated database that +contains information such as the store paths referred to by each store path, +and the list of @emph{valid} store items---results of successful builds. +This database resides in @file{@var{localstatedir}/guix/db}, where +@var{localstatedir} is the state directory specified @i{via} +@option{--localstatedir} at configure time, usually @file{/var}. + +The store is @emph{always} accessed by the daemon on behalf of its clients +(@pxref{Aufruf des guix-daemon}). To manipulate the store, clients connect to +the daemon over a Unix-domain socket, send requests to it, and read the +result---these are remote procedure calls, or RPCs. + +@quotation Anmerkung +Users must @emph{never} modify files under @file{/gnu/store} directly. This +would lead to inconsistencies and break the immutability assumptions of +Guix's functional model (@pxref{Einführung}). + +@xref{Aufruf von guix gc, @command{guix gc --verify}}, for information on how +to check the integrity of the store and attempt recovery from accidental +modifications. +@end quotation + +The @code{(guix store)} module provides procedures to connect to the daemon, +and to perform RPCs. These are described below. By default, +@code{open-connection}, and thus all the @command{guix} commands, connect to +the local daemon or to the URI specified by the @code{GUIX_DAEMON_SOCKET} +environment variable. + +@defvr {Environment Variable} GUIX_DAEMON_SOCKET +When set, the value of this variable should be a file name or a URI +designating the daemon endpoint. When it is a file name, it denotes a +Unix-domain socket to connect to. In addition to file names, the supported +URI schemes are: + +@table @code +@item file +@itemx unix +These are for Unix-domain sockets. +@code{file:///var/guix/daemon-socket/socket} is equivalent to +@file{/var/guix/daemon-socket/socket}. + +@item guix +@cindex Daemon, Fernzugriff +@cindex Fernzugriff auf den Daemon +@cindex Daemon, Einrichten auf Clustern +@cindex Cluster, Einrichtung des Daemons +These URIs denote connections over TCP/IP, without encryption nor +authentication of the remote host. The URI must specify the host name and +optionally a port number (by default port 44146 is used): + +@example +guix://master.guix.example.org:1234 +@end example + +This setup is suitable on local networks, such as clusters, where only +trusted nodes may connect to the build daemon at +@code{master.guix.example.org}. + +The @code{--listen} option of @command{guix-daemon} can be used to instruct +it to listen for TCP connections (@pxref{Aufruf des guix-daemon, +@code{--listen}}). + +@item ssh +@cindex SSH access to build daemons +These URIs allow you to connect to a remote daemon over SSH@footnote{This +feature requires Guile-SSH (@pxref{Voraussetzungen}).}. A typical URL might +look like this: + +@example +ssh://charlie@@guix.example.org:22 +@end example + +As for @command{guix copy}, the usual OpenSSH client configuration files are +honored (@pxref{Aufruf von guix copy}). +@end table + +Additional URI schemes may be supported in the future. + +@c XXX: Remove this note when the protocol incurs fewer round trips +@c and when (guix derivations) no longer relies on file system access. +@quotation Anmerkung +The ability to connect to remote build daemons is considered experimental as +of @value{VERSION}. Please get in touch with us to share any problems or +suggestions you may have (@pxref{Mitwirken}). +@end quotation +@end defvr + +@deffn {Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t] +Connect to the daemon over the Unix-domain socket at @var{uri} (a string). +When @var{reserve-space?} is true, instruct it to reserve a little bit of +extra space on the file system so that the garbage collector can still +operate should the disk become full. Return a server object. + +@var{file} defaults to @var{%default-socket-path}, which is the normal +location given the options that were passed to @command{configure}. +@end deffn + +@deffn {Scheme Procedure} close-connection @var{server} +Close the connection to @var{server}. +@end deffn + +@defvr {Scheme Variable} current-build-output-port +This variable is bound to a SRFI-39 parameter, which refers to the port +where build and error logs sent by the daemon should be written. +@end defvr + +Procedures that make RPCs all take a server object as their first argument. + +@deffn {Scheme Procedure} valid-path? @var{server} @var{path} +@cindex invalid store items +Return @code{#t} when @var{path} designates a valid store item and @code{#f} +otherwise (an invalid item may exist on disk but still be invalid, for +instance because it is the result of an aborted or failed build.) + +A @code{&nix-protocol-error} condition is raised if @var{path} is not +prefixed by the store directory (@file{/gnu/store}). +@end deffn + +@deffn {Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}] +Add @var{text} under file @var{name} in the store, and return its store +path. @var{references} is the list of store paths referred to by the +resulting store path. +@end deffn + +@deffn {Scheme Procedure} build-derivations @var{server} @var{derivations} +Build @var{derivations} (a list of @code{<derivation>} objects or derivation +paths), and return when the worker is done building them. Return @code{#t} +on success. +@end deffn + +Note that the @code{(guix monads)} module provides a monad as well as +monadic versions of the above procedures, with the goal of making it more +convenient to work with code that accesses the store (@pxref{Die Store-Monade}). + +@c FIXME +@i{This section is currently incomplete.} + +@node Ableitungen +@section Ableitungen + +@cindex derivations +Low-level build actions and the environment in which they are performed are +represented by @dfn{derivations}. A derivation contains the following +pieces of information: + +@itemize +@item +The outputs of the derivation---derivations produce at least one file or +directory in the store, but may produce more. + +@item +The inputs of the derivations, which may be other derivations or plain files +in the store (patches, build scripts, etc.) + +@item +The system type targeted by the derivation---e.g., @code{x86_64-linux}. + +@item +The file name of a build script in the store, along with the arguments to be +passed. + +@item +A list of environment variables to be defined. + +@end itemize + +@cindex derivation path +Derivations allow clients of the daemon to communicate build actions to the +store. They exist in two forms: as an in-memory representation, both on the +client- and daemon-side, and as files in the store whose name end in +@code{.drv}---these files are referred to as @dfn{derivation paths}. +Derivations paths can be passed to the @code{build-derivations} procedure to +perform the build actions they prescribe (@pxref{Der Store}). + +@cindex fixed-output derivations +Operations such as file downloads and version-control checkouts for which +the expected content hash is known in advance are modeled as +@dfn{fixed-output derivations}. Unlike regular derivations, the outputs of +a fixed-output derivation are independent of its inputs---e.g., a source +code download produces the same result regardless of the download method and +tools being used. + +The @code{(guix derivations)} module provides a representation of +derivations as Scheme objects, along with procedures to create and otherwise +manipulate derivations. The lowest-level primitive to create a derivation +is the @code{derivation} procedure: + +@deffn {Scheme Procedure} derivation @var{store} @var{name} @var{builder} @ + @var{args} [#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? +#f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-system)] +[#:references-graphs #f] @ [#:allowed-references #f] +[#:disallowed-references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ +[#:substitutable? #t] Build a derivation with the given arguments, and +return the resulting @code{<derivation>} object. + +When @var{hash} and @var{hash-algo} are given, a @dfn{fixed-output +derivation} is created---i.e., one whose result is known in advance, such as +a file download. If, in addition, @var{recursive?} is true, then that fixed +output may be an executable file or a directory and @var{hash} must be the +hash of an archive containing this output. + +When @var{references-graphs} is true, it must be a list of file name/store +path pairs. In that case, the reference graph of each store path is +exported in the build environment in the corresponding file, in a simple +text format. + +When @var{allowed-references} is true, it must be a list of store items or +outputs that the derivation's output may refer to. Likewise, +@var{disallowed-references}, if true, must be a list of things the outputs +may @emph{not} refer to. + +When @var{leaked-env-vars} is true, it must be a list of strings denoting +environment variables that are allowed to ``leak'' from the daemon's +environment to the build environment. This is only applicable to +fixed-output derivations---i.e., when @var{hash} is true. The main use is +to allow variables such as @code{http_proxy} to be passed to derivations +that download files. + +When @var{local-build?} is true, declare that the derivation is not a good +candidate for offloading and should rather be built locally (@pxref{Auslagern des Daemons einrichten}). This is the case for small derivations where the costs of +data transfers would outweigh the benefits. + +When @var{substitutable?} is false, declare that substitutes of the +derivation's output should not be used (@pxref{Substitute}). This is +useful, for instance, when building packages that capture details of the +host CPU instruction set. +@end deffn + +@noindent +Here's an example with a shell script as its builder, assuming @var{store} +is an open connection to the daemon, and @var{bash} points to a Bash +executable in the store: + +@lisp +(use-modules (guix utils) + (guix store) + (guix derivations)) + +(let ((builder ; add the Bash script to the store + (add-text-to-store store "my-builder.sh" + "echo hello world > $out\n" '()))) + (derivation store "foo" + bash `("-e" ,builder) + #:inputs `((,bash) (,builder)) + #:env-vars '(("HOME" . "/homeless")))) +@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo> +@end lisp + +As can be guessed, this primitive is cumbersome to use directly. A better +approach is to write build scripts in Scheme, of course! The best course of +action for that is to write the build code as a ``G-expression'', and to +pass it to @code{gexp->derivation}. For more information, +@pxref{G-Ausdrücke}. + +Once upon a time, @code{gexp->derivation} did not exist and constructing +derivations with build code written in Scheme was achieved with +@code{build-expression->derivation}, documented below. This procedure is +now deprecated in favor of the much nicer @code{gexp->derivation}. + +@deffn {Scheme Procedure} build-expression->derivation @var{store} @ + @var{name} @var{exp} @ [#:system (%current-system)] [#:inputs '()] @ +[#:outputs '("out")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] +[#:env-vars '()] [#:modules '()] @ [#:references-graphs #f] +[#:allowed-references #f] @ [#:disallowed-references #f] @ [#:local-build? +#f] [#:substitutable? #t] [#:guile-for-build #f] Return a derivation that +executes Scheme expression @var{exp} as a builder for derivation +@var{name}. @var{inputs} must be a list of @code{(name drv-path sub-drv)} +tuples; when @var{sub-drv} is omitted, @code{"out"} is assumed. +@var{modules} is a list of names of Guile modules from the current search +path to be copied in the store, compiled, and made available in the load +path during the execution of @var{exp}---e.g., @code{((guix build utils) +(guix build gnu-build-system))}. + +@var{exp} is evaluated in an environment where @code{%outputs} is bound to a +list of output/path pairs, and where @code{%build-inputs} is bound to a list +of string/output-path pairs made from @var{inputs}. Optionally, +@var{env-vars} is a list of string pairs specifying the name and value of +environment variables visible to the builder. The builder terminates by +passing the result of @var{exp} to @code{exit}; thus, when @var{exp} returns +@code{#f}, the build is considered to have failed. + +@var{exp} is built using @var{guile-for-build} (a derivation). When +@var{guile-for-build} is omitted or is @code{#f}, the value of the +@code{%guile-for-build} fluid is used instead. + +See the @code{derivation} procedure for the meaning of +@var{references-graphs}, @var{allowed-references}, +@var{disallowed-references}, @var{local-build?}, and @var{substitutable?}. +@end deffn + +@noindent +Here's an example of a single-output derivation that creates a directory +containing one file: + +@lisp +(let ((builder '(let ((out (assoc-ref %outputs "out"))) + (mkdir out) ; create /gnu/store/@dots{}-goo + (call-with-output-file (string-append out "/test") + (lambda (p) + (display '(hello guix) p)))))) + (build-expression->derivation store "goo" builder)) + +@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}> +@end lisp + + +@node Die Store-Monade +@section Die Store-Monade + +@cindex monad + +The procedures that operate on the store described in the previous sections +all take an open connection to the build daemon as their first argument. +Although the underlying model is functional, they either have side effects +or depend on the current state of the store. + +The former is inconvenient: the connection to the build daemon has to be +carried around in all those functions, making it impossible to compose +functions that do not take that parameter with functions that do. The +latter can be problematic: since store operations have side effects and/or +depend on external state, they have to be properly sequenced. + +@cindex monadic values +@cindex monadic functions +This is where the @code{(guix monads)} module comes in. This module +provides a framework for working with @dfn{monads}, and a particularly +useful monad for our uses, the @dfn{store monad}. Monads are a construct +that allows two things: associating ``context'' with values (in our case, +the context is the store), and building sequences of computations (here +computations include accesses to the store). Values in a monad---values +that carry this additional context---are called @dfn{monadic values}; +procedures that return such values are called @dfn{monadic procedures}. + +Consider this ``normal'' procedure: + +@example +(define (sh-symlink store) + ;; Return a derivation that symlinks the 'bash' executable. + (let* ((drv (package-derivation store bash)) + (out (derivation->output-path drv)) + (sh (string-append out "/bin/bash"))) + (build-expression->derivation store "sh" + `(symlink ,sh %output)))) +@end example + +Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a +monadic function: + +@example +(define (sh-symlink) + ;; Same, but return a monadic value. + (mlet %store-monad ((drv (package->derivation bash))) + (gexp->derivation "sh" + #~(symlink (string-append #$drv "/bin/bash") + #$output)))) +@end example + +There are several things to note in the second version: the @code{store} +parameter is now implicit and is ``threaded'' in the calls to the +@code{package->derivation} and @code{gexp->derivation} monadic procedures, +and the monadic value returned by @code{package->derivation} is @dfn{bound} +using @code{mlet} instead of plain @code{let}. + +As it turns out, the call to @code{package->derivation} can even be omitted +since it will take place implicitly, as we will see later +(@pxref{G-Ausdrücke}): + +@example +(define (sh-symlink) + (gexp->derivation "sh" + #~(symlink (string-append #$bash "/bin/bash") + #$output))) +@end example + +@c See +@c <https://syntaxexclamation.wordpress.com/2014/06/26/escaping-continuations/> +@c for the funny quote. +Calling the monadic @code{sh-symlink} has no effect. As someone once said, +``you exit a monad like you exit a building on fire: by running''. So, to +exit the monad and get the desired effect, one must use +@code{run-with-store}: + +@example +(run-with-store (open-connection) (sh-symlink)) +@result{} /gnu/store/...-sh-symlink +@end example + +Note that the @code{(guix monad-repl)} module extends the Guile REPL with +new ``meta-commands'' to make it easier to deal with monadic procedures: +@code{run-in-store}, and @code{enter-store-monad}. The former is used to +``run'' a single monadic value through the store: + +@example +scheme@@(guile-user)> ,run-in-store (package->derivation hello) +$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> +@end example + +The latter enters a recursive REPL, where all the return values are +automatically run through the store: + +@example +scheme@@(guile-user)> ,enter-store-monad +store-monad@@(guile-user) [1]> (package->derivation hello) +$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}> +store-monad@@(guile-user) [1]> (text-file "foo" "Hello!") +$3 = "/gnu/store/@dots{}-foo" +store-monad@@(guile-user) [1]> ,q +scheme@@(guile-user)> +@end example + +@noindent +Note that non-monadic values cannot be returned in the @code{store-monad} +REPL. + +The main syntactic forms to deal with monads in general are provided by the +@code{(guix monads)} module and are described below. + +@deffn {Scheme Syntax} with-monad @var{monad} @var{body} ... +Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in +@var{monad}. +@end deffn + +@deffn {Scheme Syntax} return @var{val} +Return a monadic value that encapsulates @var{val}. +@end deffn + +@deffn {Scheme Syntax} >>= @var{mval} @var{mproc} ... +@dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic +procedures @var{mproc}@dots{}@footnote{This operation is commonly referred +to as ``bind'', but that name denotes an unrelated procedure in Guile. Thus +we use this somewhat cryptic symbol inherited from the Haskell language.}. +There can be one @var{mproc} or several of them, as in this example: + +@example +(run-with-state + (with-monad %state-monad + (>>= (return 1) + (lambda (x) (return (+ 1 x))) + (lambda (x) (return (* 2 x))))) + 'some-state) + +@result{} 4 +@result{} some-state +@end example +@end deffn + +@deffn {Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @ + @var{body} ... +@deffnx {Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @ + @var{body} ... Bind the variables @var{var} to the monadic values +@var{mval} in @var{body}, which is a sequence of expressions. As with the +bind operator, this can be thought of as ``unpacking'' the raw, non-monadic +value ``contained'' in @var{mval} and making @var{var} refer to that raw, +non-monadic value within the scope of the @var{body}. The form (@var{var} +-> @var{val}) binds @var{var} to the ``normal'' value @var{val}, as per +@code{let}. The binding operations occur in sequence from left to right. +The last expression of @var{body} must be a monadic expression, and its +result will become the result of the @code{mlet} or @code{mlet*} when run in +the @var{monad}. + +@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} +(@pxref{Local Bindings,,, guile, GNU Guile Reference Manual}). +@end deffn + +@deffn {Scheme System} mbegin @var{monad} @var{mexp} ... +Bind @var{mexp} and the following monadic expressions in sequence, returning +the result of the last expression. Every expression in the sequence must be +a monadic expression. + +This is akin to @code{mlet}, except that the return values of the monadic +expressions are ignored. In that sense, it is analogous to @code{begin}, +but applied to monadic expressions. +@end deffn + +@deffn {Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ... +When @var{condition} is true, evaluate the sequence of monadic expressions +@var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is +false, return @code{*unspecified*} in the current monad. Every expression +in the sequence must be a monadic expression. +@end deffn + +@deffn {Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ... +When @var{condition} is false, evaluate the sequence of monadic expressions +@var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is +true, return @code{*unspecified*} in the current monad. Every expression in +the sequence must be a monadic expression. +@end deffn + +@cindex state monad +The @code{(guix monads)} module provides the @dfn{state monad}, which allows +an additional value---the state---to be @emph{threaded} through monadic +procedure calls. + +@defvr {Scheme Variable} %state-monad +The state monad. Procedures in the state monad can access and change the +state that is threaded. + +Consider the example below. The @code{square} procedure returns a value in +the state monad. It returns the square of its argument, but also increments +the current state value: + +@example +(define (square x) + (mlet %state-monad ((count (current-state))) + (mbegin %state-monad + (set-current-state (+ 1 count)) + (return (* x x))))) + +(run-with-state (sequence %state-monad (map square (iota 3))) 0) +@result{} (0 1 4) +@result{} 3 +@end example + +When ``run'' through @var{%state-monad}, we obtain that additional state +value, which is the number of @code{square} calls. +@end defvr + +@deffn {Monadic Procedure} current-state +Return the current state as a monadic value. +@end deffn + +@deffn {Monadic Procedure} set-current-state @var{value} +Set the current state to @var{value} and return the previous state as a +monadic value. +@end deffn + +@deffn {Monadic Procedure} state-push @var{value} +Push @var{value} to the current state, which is assumed to be a list, and +return the previous state as a monadic value. +@end deffn + +@deffn {Monadic Procedure} state-pop +Pop a value from the current state and return it as a monadic value. The +state is assumed to be a list. +@end deffn + +@deffn {Scheme Procedure} run-with-state @var{mval} [@var{state}] +Run monadic value @var{mval} starting with @var{state} as the initial +state. Return two values: the resulting value, and the resulting state. +@end deffn + +The main interface to the store monad, provided by the @code{(guix store)} +module, is as follows. + +@defvr {Scheme Variable} %store-monad +The store monad---an alias for @var{%state-monad}. + +Values in the store monad encapsulate accesses to the store. When its +effect is needed, a value of the store monad must be ``evaluated'' by +passing it to the @code{run-with-store} procedure (see below.) +@end defvr + +@deffn {Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)] +Run @var{mval}, a monadic value in the store monad, in @var{store}, an open +store connection. +@end deffn + +@deffn {Monadic Procedure} text-file @var{name} @var{text} [@var{references}] +Return as a monadic value the absolute file name in the store of the file +containing @var{text}, a string. @var{references} is a list of store items +that the resulting text file refers to; it defaults to the empty list. +@end deffn + +@deffn {Monadic Procedure} binary-file @var{name} @var{data} [@var{references}] +Return as a monadic value the absolute file name in the store of the file +containing @var{data}, a bytevector. @var{references} is a list of store +items that the resulting binary file refers to; it defaults to the empty +list. +@end deffn + +@deffn {Monadic Procedure} interned-file @var{file} [@var{name}] @ + [#:recursive? #t] [#:select? (const #t)] Return the name of @var{file} once +interned in the store. Use @var{name} as its store name, or the basename of +@var{file} if @var{name} is omitted. + +When @var{recursive?} is true, the contents of @var{file} are added +recursively; if @var{file} designates a flat file and @var{recursive?} is +true, its contents are added, and its permission bits are kept. + +When @var{recursive?} is true, call @code{(@var{select?} @var{file} +@var{stat})} for each directory entry, where @var{file} is the entry's +absolute file name and @var{stat} is the result of @code{lstat}; exclude +entries for which @var{select?} does not return true. + +The example below adds a file to the store, under two different names: + +@example +(run-with-store (open-connection) + (mlet %store-monad ((a (interned-file "README")) + (b (interned-file "README" "LEGU-MIN"))) + (return (list a b)))) + +@result{} ("/gnu/store/rwm@dots{}-README" "/gnu/store/44i@dots{}-LEGU-MIN") +@end example + +@end deffn + +The @code{(guix packages)} module exports the following package-related +monadic procedures: + +@deffn {Monadic Procedure} package-file @var{package} [@var{file}] @ + [#:system (%current-system)] [#:target #f] @ [#:output "out"] Return as a +monadic value in the absolute file name of @var{file} within the +@var{output} directory of @var{package}. When @var{file} is omitted, return +the name of the @var{output} directory of @var{package}. When @var{target} +is true, use it as a cross-compilation target triplet. +@end deffn + +@deffn {Monadic Procedure} package->derivation @var{package} [@var{system}] +@deffnx {Monadic Procedure} package->cross-derivation @var{package} @ + @var{target} [@var{system}] Monadic version of @code{package-derivation} and +@code{package-cross-derivation} (@pxref{Pakete definieren}). +@end deffn + + +@node G-Ausdrücke +@section G-Ausdrücke + +@cindex G-expression +@cindex build code quoting +So we have ``derivations'', which represent a sequence of build actions to +be performed to produce an item in the store (@pxref{Ableitungen}). These +build actions are performed when asking the daemon to actually build the +derivations; they are run by the daemon in a container (@pxref{Aufruf des guix-daemon}). + +@cindex strata of code +It should come as no surprise that we like to write these build actions in +Scheme. When we do that, we end up with two @dfn{strata} of Scheme +code@footnote{The term @dfn{stratum} in this context was coined by Manuel +Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who +has written insightful +@url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code on +this topic}, refers to this kind of code generation as @dfn{staging}.}: the +``host code''---code that defines packages, talks to the daemon, etc.---and +the ``build code''---code that actually performs build actions, such as +making directories, invoking @command{make}, etc. + +To describe a derivation and its build actions, one typically needs to embed +build code inside host code. It boils down to manipulating build code as +data, and the homoiconicity of Scheme---code has a direct representation as +data---comes in handy for that. But we need more than the normal +@code{quasiquote} mechanism in Scheme to construct build expressions. + +The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of +S-expressions adapted to build expressions. G-expressions, or @dfn{gexps}, +consist essentially of three syntactic forms: @code{gexp}, @code{ungexp}, +and @code{ungexp-splicing} (or simply: @code{#~}, @code{#$}, and +@code{#$@@}), which are comparable to @code{quasiquote}, @code{unquote}, and +@code{unquote-splicing}, respectively (@pxref{Expression Syntax, +@code{quasiquote},, guile, GNU Guile Reference Manual}). However, there are +major differences: + +@itemize +@item +Gexps are meant to be written to a file and run or manipulated by other +processes. + +@item +When a high-level object such as a package or derivation is unquoted inside +a gexp, the result is as if its output file name had been introduced. + +@item +Gexps carry information about the packages or derivations they refer to, and +these dependencies are automatically added as inputs to the build processes +that use them. +@end itemize + +@cindex lowering, of high-level objects in gexps +This mechanism is not limited to package and derivation objects: +@dfn{compilers} able to ``lower'' other high-level objects to derivations or +files in the store can be defined, such that these objects can also be +inserted into gexps. For example, a useful type of high-level objects that +can be inserted in a gexp is ``file-like objects'', which make it easy to +add files to the store and to refer to them in derivations and such (see +@code{local-file} and @code{plain-file} below.) + +To illustrate the idea, here is an example of a gexp: + +@example +(define build-exp + #~(begin + (mkdir #$output) + (chdir #$output) + (symlink (string-append #$coreutils "/bin/ls") + "list-files"))) +@end example + +This gexp can be passed to @code{gexp->derivation}; we obtain a derivation +that builds a directory containing exactly one symlink to +@file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}: + +@example +(gexp->derivation "the-thing" build-exp) +@end example + +As one would expect, the @code{"/gnu/store/@dots{}-coreutils-8.22"} string +is substituted to the reference to the @var{coreutils} package in the actual +build code, and @var{coreutils} is automatically made an input to the +derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp +output)}) is replaced by a string containing the directory name of the +output of the derivation. + +@cindex cross compilation +In a cross-compilation context, it is useful to distinguish between +references to the @emph{native} build of a package---that can run on the +host---versus references to cross builds of a package. To that end, the +@code{#+} plays the same role as @code{#$}, but is a reference to a native +package build: + +@example +(gexp->derivation "vi" + #~(begin + (mkdir #$output) + (system* (string-append #+coreutils "/bin/ln") + "-s" + (string-append #$emacs "/bin/emacs") + (string-append #$output "/bin/vi"))) + #:target "mips64el-linux-gnu") +@end example + +@noindent +In the example above, the native build of @var{coreutils} is used, so that +@command{ln} can actually run on the host; but then the cross-compiled build +of @var{emacs} is referenced. + +@cindex imported modules, for gexps +@findex with-imported-modules +Another gexp feature is @dfn{imported modules}: sometimes you want to be +able to use certain Guile modules from the ``host environment'' in the gexp, +so those modules should be imported in the ``build environment''. The +@code{with-imported-modules} form allows you to express that: + +@example +(let ((build (with-imported-modules '((guix build utils)) + #~(begin + (use-modules (guix build utils)) + (mkdir-p (string-append #$output "/bin")))))) + (gexp->derivation "empty-dir" + #~(begin + #$build + (display "success!\n") + #t))) +@end example + +@noindent +In this example, the @code{(guix build utils)} module is automatically +pulled into the isolated build environment of our gexp, such that +@code{(use-modules (guix build utils))} works as expected. + +@cindex module closure +@findex source-module-closure +Usually you want the @emph{closure} of the module to be imported---i.e., the +module itself and all the modules it depends on---rather than just the +module; failing to do that, attempts to use the module will fail because of +missing dependent modules. The @code{source-module-closure} procedure +computes the closure of a module by looking at its source file headers, +which comes in handy in this case: + +@example +(use-modules (guix modules)) ;for 'source-module-closure' + +(with-imported-modules (source-module-closure + '((guix build utils) + (gnu build vm))) + (gexp->derivation "something-with-vms" + #~(begin + (use-modules (guix build utils) + (gnu build vm)) + @dots{}))) +@end example + +@cindex extensions, for gexps +@findex with-extensions +In the same vein, sometimes you want to import not just pure-Scheme modules, +but also ``extensions'' such as Guile bindings to C libraries or other +``full-blown'' packages. Say you need the @code{guile-json} package +available on the build side, here's how you would do it: + +@example +(use-modules (gnu packages guile)) ;for 'guile-json' + +(with-extensions (list guile-json) + (gexp->derivation "something-with-json" + #~(begin + (use-modules (json)) + @dots{}))) +@end example + +The syntactic form to construct gexps is summarized below. + +@deffn {Scheme Syntax} #~@var{exp} +@deffnx {Scheme Syntax} (gexp @var{exp}) +Return a G-expression containing @var{exp}. @var{exp} may contain one or +more of the following forms: + +@table @code +@item #$@var{obj} +@itemx (ungexp @var{obj}) +Introduce a reference to @var{obj}. @var{obj} may have one of the supported +types, for example a package or a derivation, in which case the +@code{ungexp} form is replaced by its output file name---e.g., +@code{"/gnu/store/@dots{}-coreutils-8.22}. + +If @var{obj} is a list, it is traversed and references to supported objects +are substituted similarly. + +If @var{obj} is another gexp, its contents are inserted and its dependencies +are added to those of the containing gexp. + +If @var{obj} is another kind of object, it is inserted as is. + +@item #$@var{obj}:@var{output} +@itemx (ungexp @var{obj} @var{output}) +This is like the form above, but referring explicitly to the @var{output} of +@var{obj}---this is useful when @var{obj} produces multiple outputs +(@pxref{Pakete mit mehreren Ausgaben.}). + +@item #+@var{obj} +@itemx #+@var{obj}:output +@itemx (ungexp-native @var{obj}) +@itemx (ungexp-native @var{obj} @var{output}) +Same as @code{ungexp}, but produces a reference to the @emph{native} build +of @var{obj} when used in a cross compilation context. + +@item #$output[:@var{output}] +@itemx (ungexp output [@var{output}]) +Insert a reference to derivation output @var{output}, or to the main output +when @var{output} is omitted. + +This only makes sense for gexps passed to @code{gexp->derivation}. + +@item #$@@@var{lst} +@itemx (ungexp-splicing @var{lst}) +Like the above, but splices the contents of @var{lst} inside the containing +list. + +@item #+@@@var{lst} +@itemx (ungexp-native-splicing @var{lst}) +Like the above, but refers to native builds of the objects listed in +@var{lst}. + +@end table + +G-expressions created by @code{gexp} or @code{#~} are run-time objects of +the @code{gexp?} type (see below.) +@end deffn + +@deffn {Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{} +Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in +their execution environment. + +Each item in @var{modules} can be the name of a module, such as @code{(guix +build utils)}, or it can be a module name, followed by an arrow, followed by +a file-like object: + +@example +`((guix build utils) + (guix gcrypt) + ((guix config) => ,(scheme-file "config.scm" + #~(define-module @dots{})))) +@end example + +@noindent +In the example above, the first two modules are taken from the search path, +and the last one is created from the given file-like object. + +This form has @emph{lexical} scope: it has an effect on the gexps directly +defined in @var{body}@dots{}, but not on those defined, say, in procedures +called from @var{body}@dots{}. +@end deffn + +@deffn {Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{} +Mark the gexps defined in @var{body}@dots{} as requiring @var{extensions} in +their build and execution environment. @var{extensions} is typically a list +of package objects such as those defined in the @code{(gnu packages guile)} +module. + +Concretely, the packages listed in @var{extensions} are added to the load +path while compiling imported modules in @var{body}@dots{}; they are also +added to the load path of the gexp returned by @var{body}@dots{}. +@end deffn + +@deffn {Scheme Procedure} gexp? @var{obj} +Return @code{#t} if @var{obj} is a G-expression. +@end deffn + +G-expressions are meant to be written to disk, either as code building some +derivation, or as plain files in the store. The monadic procedures below +allow you to do that (@pxref{Die Store-Monade}, for more information about +monads.) + +@deffn {Monadic Procedure} gexp->derivation @var{name} @var{exp} @ + [#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] +[#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ +[#:module-path @var{%load-path}] @ [#:effective-version "2.2"] @ +[#:references-graphs #f] [#:allowed-references #f] @ +[#:disallowed-references #f] @ [#:leaked-env-vars #f] @ [#:script-name +(string-append @var{name} "-builder")] @ [#:deprecation-warnings #f] @ +[#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] Return a +derivation @var{name} that runs @var{exp} (a gexp) with +@var{guile-for-build} (a derivation) on @var{system}; @var{exp} is stored in +a file called @var{script-name}. When @var{target} is true, it is used as +the cross-compilation target triplet for packages referred to by @var{exp}. + +@var{modules} is deprecated in favor of @code{with-imported-modules}. Its +meaning is to make @var{modules} available in the evaluation context of +@var{exp}; @var{modules} is a list of names of Guile modules searched in +@var{module-path} to be copied in the store, compiled, and made available in +the load path during the execution of @var{exp}---e.g., @code{((guix build +utils) (guix build gnu-build-system))}. + +@var{effective-version} determines the string to use when adding extensions +of @var{exp} (see @code{with-extensions}) to the search path---e.g., +@code{"2.2"}. + +@var{graft?} determines whether packages referred to by @var{exp} should be +grafted when applicable. + +When @var{references-graphs} is true, it must be a list of tuples of one of +the following forms: + +@example +(@var{file-name} @var{package}) +(@var{file-name} @var{package} @var{output}) +(@var{file-name} @var{derivation}) +(@var{file-name} @var{derivation} @var{output}) +(@var{file-name} @var{store-item}) +@end example + +The right-hand-side of each element of @var{references-graphs} is +automatically made an input of the build process of @var{exp}. In the build +environment, each @var{file-name} contains the reference graph of the +corresponding item, in a simple text format. + +@var{allowed-references} must be either @code{#f} or a list of output names +and packages. In the latter case, the list denotes store items that the +result is allowed to refer to. Any reference to another store item will +lead to a build error. Similarly for @var{disallowed-references}, which can +list items that must not be referenced by the outputs. + +@var{deprecation-warnings} determines whether to show deprecation warnings +while compiling modules. It can be @code{#f}, @code{#t}, or +@code{'detailed}. + +The other arguments are as for @code{derivation} (@pxref{Ableitungen}). +@end deffn + +@cindex file-like objects +The @code{local-file}, @code{plain-file}, @code{computed-file}, +@code{program-file}, and @code{scheme-file} procedures below return +@dfn{file-like objects}. That is, when unquoted in a G-expression, these +objects lead to a file in the store. Consider this G-expression: + +@example +#~(system* #$(file-append glibc "/sbin/nscd") "-f" + #$(local-file "/tmp/my-nscd.conf")) +@end example + +The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it to +the store. Once expanded, for instance @i{via} @code{gexp->derivation}, the +G-expression refers to that copy under @file{/gnu/store}; thus, modifying or +removing the file in @file{/tmp} does not have any effect on what the +G-expression does. @code{plain-file} can be used similarly; it differs in +that the file content is directly passed as a string. + +@deffn {Scheme Procedure} local-file @var{file} [@var{name}] @ + [#:recursive? #f] [#:select? (const #t)] Return an object representing local +file @var{file} to add to the store; this object can be used in a gexp. If +@var{file} is a relative file name, it is looked up relative to the source +file where this form appears. @var{file} will be added to the store under +@var{name}--by default the base name of @var{file}. + +When @var{recursive?} is true, the contents of @var{file} are added +recursively; if @var{file} designates a flat file and @var{recursive?} is +true, its contents are added, and its permission bits are kept. + +When @var{recursive?} is true, call @code{(@var{select?} @var{file} +@var{stat})} for each directory entry, where @var{file} is the entry's +absolute file name and @var{stat} is the result of @code{lstat}; exclude +entries for which @var{select?} does not return true. + +This is the declarative counterpart of the @code{interned-file} monadic +procedure (@pxref{Die Store-Monade, @code{interned-file}}). +@end deffn + +@deffn {Scheme Procedure} plain-file @var{name} @var{content} +Return an object representing a text file called @var{name} with the given +@var{content} (a string or a bytevector) to be added to the store. + +This is the declarative counterpart of @code{text-file}. +@end deffn + +@deffn {Scheme Procedure} computed-file @var{name} @var{gexp} @ + [#:options '(#:local-build? #t)] Return an object representing the store +item @var{name}, a file or directory computed by @var{gexp}. @var{options} +is a list of additional arguments to pass to @code{gexp->derivation}. + +This is the declarative counterpart of @code{gexp->derivation}. +@end deffn + +@deffn {Monadic Procedure} gexp->script @var{name} @var{exp} @ + [#:guile (default-guile)] [#:module-path %load-path] Return an executable +script @var{name} that runs @var{exp} using @var{guile}, with @var{exp}'s +imported modules in its search path. Look up @var{exp}'s modules in +@var{module-path}. + +The example below builds a script that simply invokes the @command{ls} +command: + +@example +(use-modules (guix gexp) (gnu packages base)) + +(gexp->script "list-files" + #~(execl #$(file-append coreutils "/bin/ls") + "ls")) +@end example + +When ``running'' it through the store (@pxref{Die Store-Monade, +@code{run-with-store}}), we obtain a derivation that produces an executable +file @file{/gnu/store/@dots{}-list-files} along these lines: + +@example +#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds +!# +(execl "/gnu/store/@dots{}-coreutils-8.22"/bin/ls" "ls") +@end example +@end deffn + +@deffn {Scheme Procedure} program-file @var{name} @var{exp} @ + [#:guile #f] [#:module-path %load-path] Return an object representing the +executable store item @var{name} that runs @var{gexp}. @var{guile} is the +Guile package used to execute that script. Imported modules of @var{gexp} +are looked up in @var{module-path}. + +This is the declarative counterpart of @code{gexp->script}. +@end deffn + +@deffn {Monadic Procedure} gexp->file @var{name} @var{exp} @ + [#:set-load-path? #t] [#:module-path %load-path] @ [#:splice? #f] @ [#:guile +(default-guile)] Return a derivation that builds a file @var{name} +containing @var{exp}. When @var{splice?} is true, @var{exp} is considered +to be a list of expressions that will be spliced in the resulting file. + +When @var{set-load-path?} is true, emit code in the resulting file to set +@code{%load-path} and @code{%load-compiled-path} to honor @var{exp}'s +imported modules. Look up @var{exp}'s modules in @var{module-path}. + +The resulting file holds references to all the dependencies of @var{exp} or +a subset thereof. +@end deffn + +@deffn {Scheme Procedure} scheme-file @var{name} @var{exp} [#:splice? #f] +Return an object representing the Scheme file @var{name} that contains +@var{exp}. + +This is the declarative counterpart of @code{gexp->file}. +@end deffn + +@deffn {Monadic Procedure} text-file* @var{name} @var{text} @dots{} +Return as a monadic value a derivation that builds a text file containing +all of @var{text}. @var{text} may list, in addition to strings, objects of +any type that can be used in a gexp: packages, derivations, local file +objects, etc. The resulting store file holds references to all these. + +This variant should be preferred over @code{text-file} anytime the file to +create will reference items from the store. This is typically the case when +building a configuration file that embeds store file names, like this: + +@example +(define (profile.sh) + ;; Return the name of a shell script in the store that + ;; initializes the 'PATH' environment variable. + (text-file* "profile.sh" + "export PATH=" coreutils "/bin:" + grep "/bin:" sed "/bin\n")) +@end example + +In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file +will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby +preventing them from being garbage-collected during its lifetime. +@end deffn + +@deffn {Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{} +Return an object representing store file @var{name} containing @var{text}. +@var{text} is a sequence of strings and file-like objects, as in: + +@example +(mixed-text-file "profile" + "export PATH=" coreutils "/bin:" grep "/bin") +@end example + +This is the declarative counterpart of @code{text-file*}. +@end deffn + +@deffn {Scheme Procedure} file-union @var{name} @var{files} +Return a @code{<computed-file>} that builds a directory containing all of +@var{files}. Each item in @var{files} must be a two-element list where the +first element is the file name to use in the new directory, and the second +element is a gexp denoting the target file. Here's an example: + +@example +(file-union "etc" + `(("hosts" ,(plain-file "hosts" + "127.0.0.1 localhost")) + ("bashrc" ,(plain-file "bashrc" + "alias ls='ls --color=auto'")))) +@end example + +This yields an @code{etc} directory containing these two files. +@end deffn + +@deffn {Scheme Procedure} directory-union @var{name} @var{things} +Return a directory that is the union of @var{things}, where @var{things} is +a list of file-like objects denoting directories. For example: + +@example +(directory-union "guile+emacs" (list guile emacs)) +@end example + +yields a directory that is the union of the @code{guile} and @code{emacs} +packages. +@end deffn + +@deffn {Scheme Procedure} file-append @var{obj} @var{suffix} @dots{} +Return a file-like object that expands to the concatenation of @var{obj} and +@var{suffix}, where @var{obj} is a lowerable object and each @var{suffix} is +a string. + +As an example, consider this gexp: + +@example +(gexp->script "run-uname" + #~(system* #$(file-append coreutils + "/bin/uname"))) +@end example + +The same effect could be achieved with: + +@example +(gexp->script "run-uname" + #~(system* (string-append #$coreutils + "/bin/uname"))) +@end example + +There is one difference though: in the @code{file-append} case, the +resulting script contains the absolute file name as a string, whereas in the +second case, the resulting script contains a @code{(string-append @dots{})} +expression to construct the file name @emph{at run time}. +@end deffn + + +Of course, in addition to gexps embedded in ``host'' code, there are also +modules containing build tools. To make it clear that they are meant to be +used in the build stratum, these modules are kept in the @code{(guix build +@dots{})} name space. + +@cindex lowering, of high-level objects in gexps +Internally, high-level objects are @dfn{lowered}, using their compiler, to +either derivations or store items. For instance, lowering a package yields +a derivation, and lowering a @code{plain-file} yields a store item. This is +achieved using the @code{lower-object} monadic procedure. + +@deffn {Monadic Procedure} lower-object @var{obj} [@var{system}] @ + [#:target #f] Return as a value in @var{%store-monad} the derivation or +store item corresponding to @var{obj} for @var{system}, cross-compiling for +@var{target} if @var{target} is true. @var{obj} must be an object that has +an associated gexp compiler, such as a @code{<package>}. +@end deffn + +@node Invoking guix repl +@section Invoking @command{guix repl} + +@cindex REPL, read-eval-print loop +The @command{guix repl} command spawns a Guile @dfn{read-eval-print loop} +(REPL) for interactive programming (@pxref{Using Guile Interactively,,, +guile, GNU Guile Reference Manual}). Compared to just launching the +@command{guile} command, @command{guix repl} guarantees that all the Guix +modules and all its dependencies are available in the search path. You can +use it this way: + +@example +$ guix repl +scheme@@(guile-user)> ,use (gnu packages base) +scheme@@(guile-user)> coreutils +$1 = #<package coreutils@@8.29 gnu/packages/base.scm:327 3e28300> +@end example + +@cindex inferiors +In addition, @command{guix repl} implements a simple machine-readable REPL +protocol for use by @code{(guix inferior)}, a facility to interact with +@dfn{inferiors}, separate processes running a potentially different revision +of Guix. + +The available options are as follows: + +@table @code +@item --type=@var{type} +@itemx -t @var{type} +Start a REPL of the given @var{TYPE}, which can be one of the following: + +@table @code +@item guile +This is default, and it spawns a standard full-featured Guile REPL. +@item machine +Spawn a REPL that uses the machine-readable protocol. This is the protocol +that the @code{(guix inferior)} module speaks. +@end table + +@item --listen=@var{Endpunkt} +By default, @command{guix repl} reads from standard input and writes to +standard output. When this option is passed, it will instead listen for +connections on @var{endpoint}. Here are examples of valid options: + +@table @code +@item --listen=tcp:37146 +Accept connections on localhost on port 37146. + +@item --listen=unix:/tmp/socket +Accept connections on the Unix-domain socket @file{/tmp/socket}. +@end table +@end table + +@c ********************************************************************* +@node Zubehör +@chapter Zubehör + +This section describes Guix command-line utilities. Some of them are +primarily targeted at developers and users who write new package +definitions, while others are more generally useful. They complement the +Scheme programming interface of Guix in a convenient way. + +@menu +* Aufruf von guix build:: Pakete aus der Befehlszeile heraus erstellen. +* Aufruf von guix edit:: Paketdefinitionen bearbeiten. +* Aufruf von guix download:: Herunterladen einer Datei und Ausgabe ihres + Hashes. +* Aufruf von guix hash:: Den kryptographischen Hash einer Datei + berechnen. +* Aufruf von guix import:: Paketdefinitionen importieren. +* Aufruf von guix refresh:: Paketdefinitionen aktualisieren. +* Aufruf von guix lint:: Fehler in Paketdefinitionen finden. +* Aufruf von guix size:: Plattenverbrauch profilieren. +* Aufruf von guix graph:: Den Paketgraphen visualisieren. +* Aufruf von guix environment:: Entwicklungsumgebungen einrichten. +* Aufruf von guix publish:: Substitute teilen. +* Aufruf von guix challenge:: Die Substitut-Server anfechten. +* Aufruf von guix copy:: Mit einem entfernten Store Dateien austauschen. +* Aufruf von guix container:: Prozesse isolieren. +* Aufruf von guix weather:: Die Verfügbarkeit von Substituten + einschätzen. +* Invoking guix processes:: Listing client processes. +@end menu + +@node Aufruf von guix build +@section Aufruf von @command{guix build} + +@cindex package building +@cindex @command{guix build} +The @command{guix build} command builds packages or derivations and their +dependencies, and prints the resulting store paths. Note that it does not +modify the user's profile---this is the job of the @command{guix package} +command (@pxref{Aufruf von guix package}). Thus, it is mainly useful for +distribution developers. + +The general syntax is: + +@example +guix build @var{options} @var{package-or-derivation}@dots{} +@end example + +As an example, the following command builds the latest versions of Emacs and +of Guile, displays their build logs, and finally displays the resulting +directories: + +@example +guix build emacs guile +@end example + +Similarly, the following command builds all the available packages: + +@example +guix build --quiet --keep-going \ + `guix package -A | cut -f1,2 --output-delimiter=@@` +@end example + +@var{package-or-derivation} may be either the name of a package found in the +software distribution such as @code{coreutils} or @code{coreutils@@8.20}, or +a derivation such as @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the +former case, a package with the corresponding name (and optionally version) +is searched for among the GNU distribution modules (@pxref{Paketmodule}). + +Alternatively, the @code{--expression} option may be used to specify a +Scheme expression that evaluates to a package; this is useful when +disambiguating among several same-named packages or package variants is +needed. + +There may be zero or more @var{options}. The available options are +described in the subsections below. + +@menu +* Gemeinsame Erstellungsoptionen:: Erstellungsoptionen für die meisten + Befehle. +* Paketumwandlungsoptionen:: Varianten von Paketen erzeugen. +* Zusätzliche Erstellungsoptionen:: Optionen spezifisch für »guix + build«. +* Fehlschläge beim Erstellen untersuchen:: Praxiserfahrung bei der + Paketerstellung. +@end menu + +@node Gemeinsame Erstellungsoptionen +@subsection Gemeinsame Erstellungsoptionen + +A number of options that control the build process are common to +@command{guix build} and other commands that can spawn builds, such as +@command{guix package} or @command{guix archive}. These are the following: + +@table @code + +@item --load-path=@var{directory} +@itemx -L @var{directory} +Add @var{directory} to the front of the package module search path +(@pxref{Paketmodule}). + +This allows users to define their own packages and make them visible to the +command-line tools. + +@item --keep-failed +@itemx -K +Keep the build tree of failed builds. Thus, if a build fails, its build +tree is kept under @file{/tmp}, in a directory whose name is shown at the +end of the build log. This is useful when debugging build issues. +@xref{Fehlschläge beim Erstellen untersuchen}, for tips and tricks on how to debug build +issues. + +@item --keep-going +@itemx -k +Keep going when some of the derivations fail to build; return only once all +the builds have either completed or failed. + +The default behavior is to stop as soon as one of the specified derivations +has failed. + +@item --dry-run +@itemx -n +Do not build the derivations. + +@anchor{fallback-option} +@item --fallback +When substituting a pre-built binary fails, fall back to building packages +locally (@pxref{Fehler bei der Substitution}). + +@item --substitute-urls=@var{URLs} +@anchor{client-substitute-urls} +Consider @var{urls} the whitespace-separated list of substitute source URLs, +overriding the default list of URLs of @command{guix-daemon} +(@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs}). + +This means that substitutes may be downloaded from @var{urls}, provided they +are signed by a key authorized by the system administrator +(@pxref{Substitute}). + +When @var{urls} is the empty string, substitutes are effectively disabled. + +@item --no-substitutes +Benutze keine Substitute für Erstellungsergebnisse. Das heißt, dass alle +Objekte lokal erstellt werden müssen, und kein Herunterladen von vorab +erstellten Binärdateien erlaubt ist (@pxref{Substitute}). + +@item --no-grafts +Do not ``graft'' packages. In practice, this means that package updates +available as grafts are not applied. @xref{Sicherheitsaktualisierungen}, for more +information on grafts. + +@item --rounds=@var{n} +Build each derivation @var{n} times in a row, and raise an error if +consecutive build results are not bit-for-bit identical. + +This is a useful way to detect non-deterministic builds processes. +Non-deterministic build processes are a problem because they make it +practically impossible for users to @emph{verify} whether third-party +binaries are genuine. @xref{Aufruf von guix challenge}, for more. + +Note that, currently, the differing build results are not kept around, so +you will have to manually investigate in case of an error---e.g., by +stashing one of the build results with @code{guix archive --export} +(@pxref{Aufruf von guix archive}), then rebuilding, and finally comparing the +two results. + +@item --no-build-hook +Nicht versuchen, Erstellungen über den »Build-Hook« des Daemons auszulagern +(@pxref{Auslagern des Daemons einrichten}). Somit wird lokal erstellt, statt +Erstellungen auf entfernte Maschinen auszulagern. + +@item --max-silent-time=@var{Sekunden} +Wenn der Erstellungs- oder Substitutionsprozess länger als +@var{Sekunden}-lang keine Ausgabe erzeugt, wird er abgebrochen und ein +Fehler beim Erstellen gemeldet. + +By default, the daemon's setting is honored (@pxref{Aufruf des guix-daemon, +@code{--max-silent-time}}). + +@item --timeout=@var{Sekunden} +Entsprechend wird hier der Erstellungs- oder Substitutionsprozess +abgebrochen und als Fehlschlag gemeldet, wenn er mehr als +@var{Sekunden}-lang dauert. + +By default, the daemon's setting is honored (@pxref{Aufruf des guix-daemon, +@code{--timeout}}). + +@item --verbosity=@var{level} +Use the given verbosity level. @var{level} must be an integer between 0 and +5; higher means more verbose output. Setting a level of 4 or more may be +helpful when debugging setup issues with the build daemon. + +@item --cores=@var{n} +@itemx -c @var{n} +Allow the use of up to @var{n} CPU cores for the build. The special value +@code{0} means to use as many CPU cores as available. + +@item --max-jobs=@var{n} +@itemx -M @var{n} +Allow at most @var{n} build jobs in parallel. @xref{Aufruf des guix-daemon, +@code{--max-jobs}}, for details about this option and the equivalent +@command{guix-daemon} option. + +@end table + +Behind the scenes, @command{guix build} is essentially an interface to the +@code{package-derivation} procedure of the @code{(guix packages)} module, +and to the @code{build-derivations} procedure of the @code{(guix +derivations)} module. + +In addition to options explicitly passed on the command line, @command{guix +build} and other @command{guix} commands that support building honor the +@code{GUIX_BUILD_OPTIONS} environment variable. + +@defvr {Environment Variable} GUIX_BUILD_OPTIONS +Users can define this variable to a list of command line options that will +automatically be used by @command{guix build} and other @command{guix} +commands that can perform builds, as in the example below: + +@example +$ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /foo/bar" +@end example + +These options are parsed independently, and the result is appended to the +parsed command-line options. +@end defvr + + +@node Paketumwandlungsoptionen +@subsection Paketumwandlungsoptionen + +@cindex package variants +Another set of command-line options supported by @command{guix build} and +also @command{guix package} are @dfn{package transformation options}. These +are options that make it possible to define @dfn{package variants}---for +instance, packages built from different source code. This is a convenient +way to create customized packages on the fly without having to type in the +definitions of package variants (@pxref{Pakete definieren}). + +@table @code + +@item --with-source=@var{source} +@itemx --with-source=@var{package}=@var{source} +@itemx --with-source=@var{package}@@@var{version}=@var{source} +Use @var{source} as the source of @var{package}, and @var{version} as its +version number. @var{source} must be a file name or a URL, as for +@command{guix download} (@pxref{Aufruf von guix download}). + +When @var{package} is omitted, it is taken to be the package name specified +on the command line that matches the base of @var{source}---e.g., if +@var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding package +is @code{guile}. + +Likewise, when @var{version} is omitted, the version string is inferred from +@var{source}; in the previous example, it is @code{2.0.10}. + +This option allows users to try out versions of packages other than the one +provided by the distribution. The example below downloads +@file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for the +@code{ed} package: + +@example +guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz +@end example + +As a developer, @code{--with-source} makes it easy to test release +candidates: + +@example +guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz +@end example + +@dots{} or to build from a checkout in a pristine environment: + +@example +$ git clone git://git.sv.gnu.org/guix.git +$ guix build guix --with-source=guix@@1.0=./guix +@end example + +@item --with-input=@var{package}=@var{replacement} +Replace dependency on @var{package} by a dependency on @var{replacement}. +@var{package} must be a package name, and @var{replacement} must be a +package specification such as @code{guile} or @code{guile@@1.8}. + +For instance, the following command builds Guix, but replaces its dependency +on the current stable version of Guile with a dependency on the legacy +version of Guile, @code{guile@@2.0}: + +@example +guix build --with-input=guile=guile@@2.0 guix +@end example + +This is a recursive, deep replacement. So in this example, both @code{guix} +and its dependency @code{guile-json} (which also depends on @code{guile}) +get rebuilt against @code{guile@@2.0}. + +This is implemented using the @code{package-input-rewriting} Scheme +procedure (@pxref{Pakete definieren, @code{package-input-rewriting}}). + +@item --with-graft=@var{package}=@var{replacement} +This is similar to @code{--with-input} but with an important difference: +instead of rebuilding the whole dependency chain, @var{replacement} is built +and then @dfn{grafted} onto the binaries that were initially referring to +@var{package}. @xref{Sicherheitsaktualisierungen}, for more information on grafts. + +For example, the command below grafts version 3.5.4 of GnuTLS onto Wget and +all its dependencies, replacing references to the version of GnuTLS they +currently refer to: + +@example +guix build --with-graft=gnutls=gnutls@@3.5.4 wget +@end example + +This has the advantage of being much faster than rebuilding everything. But +there is a caveat: it works if and only if @var{package} and +@var{replacement} are strictly compatible---for example, if they provide a +library, the application binary interface (ABI) of those libraries must be +compatible. If @var{replacement} is somehow incompatible with +@var{package}, then the resulting package may be unusable. Use with care! + +@end table + +@node Zusätzliche Erstellungsoptionen +@subsection Zusätzliche Erstellungsoptionen + +The command-line options presented below are specific to @command{guix +build}. + +@table @code + +@item --quiet +@itemx -q +Build quietly, without displaying the build log. Upon completion, the build +log is kept in @file{/var} (or similar) and can always be retrieved using +the @option{--log-file} option. + +@item --file=@var{file} +@itemx -f @var{Datei} +Build the package, derivation, or other file-like object that the code +within @var{file} evaluates to (@pxref{G-Ausdrücke, file-like objects}). + +As an example, @var{file} might contain a package definition like this +(@pxref{Pakete definieren}): + +@example +@verbatiminclude package-hello.scm +@end example + +@item --expression=@var{expr} +@itemx -e @var{expr} +Build the package or derivation @var{expr} evaluates to. + +For example, @var{expr} may be @code{(@@ (gnu packages guile) guile-1.8)}, +which unambiguously designates this specific variant of version 1.8 of +Guile. + +Alternatively, @var{expr} may be a G-expression, in which case it is used as +a build program passed to @code{gexp->derivation} (@pxref{G-Ausdrücke}). + +Lastly, @var{expr} may refer to a zero-argument monadic procedure +(@pxref{Die Store-Monade}). The procedure must return a derivation as a +monadic value, which is then passed through @code{run-with-store}. + +@item --source +@itemx -S +Build the source derivations of the packages, rather than the packages +themselves. + +For instance, @code{guix build -S gcc} returns something like +@file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC source +tarball. + +The returned source tarball is the result of applying any patches and code +snippets specified in the package @code{origin} (@pxref{Pakete definieren}). + +@item --sources +Fetch and return the source of @var{package-or-derivation} and all their +dependencies, recursively. This is a handy way to obtain a local copy of +all the source code needed to build @var{packages}, allowing you to +eventually build them even without network access. It is an extension of +the @code{--source} option and can accept one of the following optional +argument values: + +@table @code +@item package +This value causes the @code{--sources} option to behave in the same way as +the @code{--source} option. + +@item all +Build the source derivations of all packages, including any source that +might be listed as @code{inputs}. This is the default value. + +@example +$ guix build --sources tzdata +The following derivations will be built: + /gnu/store/@dots{}-tzdata2015b.tar.gz.drv + /gnu/store/@dots{}-tzcode2015b.tar.gz.drv +@end example + +@item transitive +Build the source derivations of all packages, as well of all transitive +inputs to the packages. This can be used e.g. to prefetch package source +for later offline building. + +@example +$ guix build --sources=transitive tzdata +The following derivations will be built: + /gnu/store/@dots{}-tzcode2015b.tar.gz.drv + /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv + /gnu/store/@dots{}-grep-2.21.tar.xz.drv + /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv + /gnu/store/@dots{}-make-4.1.tar.xz.drv + /gnu/store/@dots{}-bash-4.3.tar.xz.drv +@dots{} +@end example + +@end table + +@item --system=@var{System} +@itemx -s @var{system} +Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the +system type of the build host. + +@quotation Anmerkung +The @code{--system} flag is for @emph{native} compilation and must not be +confused with cross-compilation. See @code{--target} below for information +on cross-compilation. +@end quotation + +An example use of this is on Linux-based systems, which can emulate +different personalities. For instance, passing @code{--system=i686-linux} +on an @code{x86_64-linux} system or @code{--system=armhf-linux} on an +@code{aarch64-linux} system allows you to build packages in a complete +32-bit environment. + +@quotation Anmerkung +Building for an @code{armhf-linux} system is unconditionally enabled on +@code{aarch64-linux} machines, although certain aarch64 chipsets do not +allow for this functionality, notably the ThunderX. +@end quotation + +Similarly, when transparent emulation with QEMU and @code{binfmt_misc} is +enabled (@pxref{Virtualisierungsdienste, @code{qemu-binfmt-service-type}}), +you can build for any system for which a QEMU @code{binfmt_misc} handler is +installed. + +Builds for a system other than that of the machine you are using can also be +offloaded to a remote machine of the right architecture. @xref{Auslagern des Daemons einrichten}, for more information on offloading. + +@item --target=@var{triplet} +@cindex cross-compilation +Cross-build for @var{triplet}, which must be a valid GNU triplet, such as +@code{"mips64el-linux-gnu"} (@pxref{Specifying target triplets, GNU +configuration triplets,, autoconf, Autoconf}). + +@anchor{build-check} +@item --check +@cindex determinism, checking +@cindex reproducibility, checking +Rebuild @var{package-or-derivation}, which are already available in the +store, and raise an error if the build results are not bit-for-bit +identical. + +This mechanism allows you to check whether previously installed substitutes +are genuine (@pxref{Substitute}), or whether the build result of a package +is deterministic. @xref{Aufruf von guix challenge}, for more background +information and tools. + +Wenn dies zusammen mit @option{--keep-failed} benutzt wird, bleiben die sich +unterscheidenden Ausgaben im Store unter dem Namen +@file{/gnu/store/@dots{}-check}. Dadurch können Unterschiede zwischen den +beiden Ergebnissen leicht erkannt werden. + +@item --repair +@cindex repairing store items +@cindex Datenbeschädigung, Behebung +Attempt to repair the specified store items, if they are corrupt, by +re-downloading or rebuilding them. + +This operation is not atomic and thus restricted to @code{root}. + +@item --derivations +@itemx -d +Return the derivation paths, not the output paths, of the given packages. + +@item --root=@var{file} +@itemx -r @var{file} +@cindex GC roots, adding +@cindex garbage collector roots, adding +Make @var{file} a symlink to the result, and register it as a garbage +collector root. + +Consequently, the results of this @command{guix build} invocation are +protected from garbage collection until @var{file} is removed. When that +option is omitted, build results are eligible for garbage collection as soon +as the build completes. @xref{Aufruf von guix gc}, for more on GC roots. + +@item --log-file +@cindex build logs, access +Return the build log file names or URLs for the given +@var{package-or-derivation}, or raise an error if build logs are missing. + +This works regardless of how packages or derivations are specified. For +instance, the following invocations are equivalent: + +@example +guix build --log-file `guix build -d guile` +guix build --log-file `guix build guile` +guix build --log-file guile +guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)' +@end example + +If a log is unavailable locally, and unless @code{--no-substitutes} is +passed, the command looks for a corresponding log on one of the substitute +servers (as specified with @code{--substitute-urls}.) + +So for instance, imagine you want to see the build log of GDB on MIPS, but +you are actually on an @code{x86_64} machine: + +@example +$ guix build --log-file gdb -s mips64el-linux +https://hydra.gnu.org/log/@dots{}-gdb-7.10 +@end example + +You can freely access a huge library of build logs! +@end table + +@node Fehlschläge beim Erstellen untersuchen +@subsection Fehlschläge beim Erstellen untersuchen + +@cindex build failures, debugging +When defining a new package (@pxref{Pakete definieren}), you will probably +find yourself spending some time debugging and tweaking the build until it +succeeds. To do that, you need to operate the build commands yourself in an +environment as close as possible to the one the build daemon uses. + +To that end, the first thing to do is to use the @option{--keep-failed} or +@option{-K} option of @command{guix build}, which will keep the failed build +tree in @file{/tmp} or whatever directory you specified as @code{TMPDIR} +(@pxref{Aufruf von guix build, @code{--keep-failed}}). + +From there on, you can @command{cd} to the failed build tree and source the +@file{environment-variables} file, which contains all the environment +variable definitions that were in place when the build failed. So let's say +you're debugging a build failure in package @code{foo}; a typical session +would look like this: + +@example +$ guix build foo -K +@dots{} @i{build fails} +$ cd /tmp/guix-build-foo.drv-0 +$ source ./environment-variables +$ cd foo-1.2 +@end example + +Now, you can invoke commands as if you were the daemon (almost) and +troubleshoot your build process. + +Sometimes it happens that, for example, a package's tests pass when you run +them manually but they fail when the daemon runs them. This can happen +because the daemon runs builds in containers where, unlike in our +environment above, network access is missing, @file{/bin/sh} does not exist, +etc. (@pxref{Einrichten der Erstellungsumgebung}). + +In such cases, you may need to run inspect the build process from within a +container similar to the one the build daemon creates: + +@example +$ guix build -K foo +@dots{} +$ cd /tmp/guix-build-foo.drv-0 +$ guix environment --no-grafts -C foo --ad-hoc strace gdb +[env]# source ./environment-variables +[env]# cd foo-1.2 +@end example + +Here, @command{guix environment -C} creates a container and spawns a new +shell in it (@pxref{Aufruf von guix environment}). The @command{--ad-hoc +strace gdb} part adds the @command{strace} and @command{gdb} commands to the +container, which would may find handy while debugging. The +@option{--no-grafts} option makes sure we get the exact same environment, +with ungrafted packages (@pxref{Sicherheitsaktualisierungen}, for more info on grafts). + +To get closer to a container like that used by the build daemon, we can +remove @file{/bin/sh}: + +@example +[env]# rm /bin/sh +@end example + +(Don't worry, this is harmless: this is all happening in the throw-away +container created by @command{guix environment}.) + +The @command{strace} command is probably not in the search path, but we can +run: + +@example +[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check +@end example + +In this way, not only you will have reproduced the environment variables the +daemon uses, you will also be running the build process in a container +similar to the one the daemon uses. + + +@node Aufruf von guix edit +@section Invoking @command{guix edit} + +@cindex @command{guix edit} +@cindex package definition, editing +So many packages, so many source files! The @command{guix edit} command +facilitates the life of users and packagers by pointing their editor at the +source file containing the definition of the specified packages. For +instance: + +@example +guix edit gcc@@4.9 vim +@end example + +@noindent +launches the program specified in the @code{VISUAL} or in the @code{EDITOR} +environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim. + +If you are using a Guix Git checkout (@pxref{Erstellung aus dem Git}), or have +created your own packages on @code{GUIX_PACKAGE_PATH} (@pxref{Paketmodule}), you will be able to edit the package recipes. In other cases, +you will be able to examine the read-only recipes for packages currently in +the store. + + +@node Aufruf von guix download +@section Invoking @command{guix download} + +@cindex @command{guix download} +@cindex downloading package sources +When writing a package definition, developers typically need to download a +source tarball, compute its SHA256 hash, and write that hash in the package +definition (@pxref{Pakete definieren}). The @command{guix download} tool +helps with this task: it downloads a file from the given URI, adds it to the +store, and prints both its file name in the store and its SHA256 hash. + +The fact that the downloaded file is added to the store saves bandwidth: +when the developer eventually tries to build the newly defined package with +@command{guix build}, the source tarball will not have to be downloaded +again because it is already in the store. It is also a convenient way to +temporarily stash files, which may be deleted eventually (@pxref{Aufruf von guix gc}). + +The @command{guix download} command supports the same URIs as used in +package definitions. In particular, it supports @code{mirror://} URIs. +@code{https} URIs (HTTP over TLS) are supported @emph{provided} the Guile +bindings for GnuTLS are available in the user's environment; when they are +not available, an error is raised. @xref{Guile Preparations, how to install +the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}, for more +information. + +@command{guix download} verifies HTTPS server certificates by loading the +certificates of X.509 authorities from the directory pointed to by the +@code{SSL_CERT_DIR} environment variable (@pxref{X.509-Zertifikate}), +unless @option{--no-check-certificate} is used. + +The following options are available: + +@table @code +@item --format=@var{fmt} +@itemx -f @var{fmt} +Write the hash in the format specified by @var{fmt}. For more information +on the valid values for @var{fmt}, @pxref{Aufruf von guix hash}. + +@item --no-check-certificate +Do not validate the X.509 certificates of HTTPS servers. + +When using this option, you have @emph{absolutely no guarantee} that you are +communicating with the authentic server responsible for the given URL, which +makes you vulnerable to ``man-in-the-middle'' attacks. + +@item --output=@var{file} +@itemx -o @var{file} +Save the downloaded file to @var{file} instead of adding it to the store. +@end table + +@node Aufruf von guix hash +@section Invoking @command{guix hash} + +@cindex @command{guix hash} +The @command{guix hash} command computes the SHA256 hash of a file. It is +primarily a convenience tool for anyone contributing to the distribution: it +computes the cryptographic hash of a file, which can be used in the +definition of a package (@pxref{Pakete definieren}). + +The general syntax is: + +@example +guix hash @var{option} @var{file} +@end example + +When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the +hash of data read from standard input. @command{guix hash} has the +following options: + +@table @code + +@item --format=@var{fmt} +@itemx -f @var{fmt} +Write the hash in the format specified by @var{fmt}. + +Supported formats: @code{nix-base32}, @code{base32}, @code{base16} +(@code{hex} and @code{hexadecimal} can be used as well). + +If the @option{--format} option is not specified, @command{guix hash} will +output the hash in @code{nix-base32}. This representation is used in the +definitions of packages. + +@item --recursive +@itemx -r +Compute the hash on @var{file} recursively. + +@c FIXME: Replace xref above with xref to an ``Archive'' section when +@c it exists. +In this case, the hash is computed on an archive containing @var{file}, +including its children if it is a directory. Some of the metadata of +@var{file} is part of the archive; for instance, when @var{file} is a +regular file, the hash is different depending on whether @var{file} is +executable or not. Metadata such as time stamps has no impact on the hash +(@pxref{Aufruf von guix archive}). + +@item --exclude-vcs +@itemx -x +When combined with @option{--recursive}, exclude version control system +directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.) + +@vindex git-fetch +As an example, here is how you would compute the hash of a Git checkout, +which is useful when using the @code{git-fetch} method (@pxref{„origin“-Referenz}): + +@example +$ git clone http://example.org/foo.git +$ cd foo +$ guix hash -rx . +@end example +@end table + +@node Aufruf von guix import +@section Invoking @command{guix import} + +@cindex importing packages +@cindex package import +@cindex package conversion +@cindex Invoking @command{guix import} +The @command{guix import} command is useful for people who would like to add +a package to the distribution with as little work as possible---a legitimate +demand. The command knows of a few repositories from which it can +``import'' package metadata. The result is a package definition, or a +template thereof, in the format we know (@pxref{Pakete definieren}). + +The general syntax is: + +@example +guix import @var{importer} @var{options}@dots{} +@end example + +@var{importer} specifies the source from which to import package metadata, +and @var{options} specifies a package identifier and other options specific +to @var{importer}. Currently, the available ``importers'' are: + +@table @code +@item gnu +Import metadata for the given GNU package. This provides a template for the +latest version of that GNU package, including the hash of its source +tarball, and its canonical synopsis and description. + +Additional information such as the package dependencies and its license +needs to be figured out manually. + +For example, the following command returns a package definition for +GNU@tie{}Hello: + +@example +guix import gnu hello +@end example + +Specific command-line options are: + +@table @code +@item --key-download=@var{policy} +As for @code{guix refresh}, specify the policy to handle missing OpenPGP +keys when verifying the package signature. @xref{Aufruf von guix refresh, +@code{--key-download}}. +@end table + +@item pypi +@cindex pypi +Import metadata from the @uref{https://pypi.python.org/, Python Package +Index}@footnote{This functionality requires Guile-JSON to be installed. +@xref{Voraussetzungen}.}. Information is taken from the JSON-formatted +description available at @code{pypi.python.org} and usually includes all the +relevant information, including package dependencies. For maximum +efficiency, it is recommended to install the @command{unzip} utility, so +that the importer can unzip Python wheels and gather data from them. + +The command below imports metadata for the @code{itsdangerous} Python +package: + +@example +guix import pypi itsdangerous +@end example + +@table @code +@item --recursive +@itemx -r +Traverse the dependency graph of the given upstream package recursively and +generate package expressions for all those packages that are not yet in +Guix. +@end table + +@item gem +@cindex gem +Import metadata from @uref{https://rubygems.org/, RubyGems}@footnote{This +functionality requires Guile-JSON to be installed. @xref{Voraussetzungen}.}. +Information is taken from the JSON-formatted description available at +@code{rubygems.org} and includes most relevant information, including +runtime dependencies. There are some caveats, however. The metadata +doesn't distinguish between synopses and descriptions, so the same string is +used for both fields. Additionally, the details of non-Ruby dependencies +required to build native extensions is unavailable and left as an exercise +to the packager. + +The command below imports metadata for the @code{rails} Ruby package: + +@example +guix import gem rails +@end example + +@table @code +@item --recursive +@itemx -r +Traverse the dependency graph of the given upstream package recursively and +generate package expressions for all those packages that are not yet in +Guix. +@end table + +@item cpan +@cindex CPAN +Import metadata from @uref{https://www.metacpan.org/, +MetaCPAN}@footnote{This functionality requires Guile-JSON to be installed. +@xref{Voraussetzungen}.}. Information is taken from the JSON-formatted +metadata provided through @uref{https://fastapi.metacpan.org/, MetaCPAN's +API} and includes most relevant information, such as module dependencies. +License information should be checked closely. If Perl is available in the +store, then the @code{corelist} utility will be used to filter core modules +out of the list of dependencies. + +The command command below imports metadata for the @code{Acme::Boolean} Perl +module: + +@example +guix import cpan Acme::Boolean +@end example + +@item cran +@cindex CRAN +@cindex Bioconductor +Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central +repository for the @uref{http://r-project.org, GNU@tie{}R statistical and +graphical environment}. + +Information is extracted from the @code{DESCRIPTION} file of the package. + +The command command below imports metadata for the @code{Cairo} R package: + +@example +guix import cran Cairo +@end example + +When @code{--recursive} is added, the importer will traverse the dependency +graph of the given upstream package recursively and generate package +expressions for all those packages that are not yet in Guix. + +When @code{--archive=bioconductor} is added, metadata is imported from +@uref{https://www.bioconductor.org/, Bioconductor}, a repository of R +packages for for the analysis and comprehension of high-throughput genomic +data in bioinformatics. + +Information is extracted from the @code{DESCRIPTION} file of a package +published on the web interface of the Bioconductor SVN repository. + +The command below imports metadata for the @code{GenomicRanges} R package: + +@example +guix import cran --archive=bioconductor GenomicRanges +@end example + +@item texlive +@cindex TeX Live +@cindex CTAN +Import metadata from @uref{http://www.ctan.org/, CTAN}, the comprehensive +TeX archive network for TeX packages that are part of the +@uref{https://www.tug.org/texlive/, TeX Live distribution}. + +Information about the package is obtained through the XML API provided by +CTAN, while the source code is downloaded from the SVN repository of the Tex +Live project. This is done because the CTAN does not keep versioned +archives. + +The command command below imports metadata for the @code{fontspec} TeX +package: + +@example +guix import texlive fontspec +@end example + +When @code{--archive=DIRECTORY} is added, the source code is downloaded not +from the @file{latex} sub-directory of the @file{texmf-dist/source} tree in +the TeX Live SVN repository, but from the specified sibling directory under +the same root. + +The command below imports metadata for the @code{ifxetex} package from CTAN +while fetching the sources from the directory @file{texmf/source/generic}: + +@example +guix import texlive --archive=generic ifxetex +@end example + +@item json +@cindex JSON, import +Import package metadata from a local JSON file@footnote{This functionality +requires Guile-JSON to be installed. @xref{Voraussetzungen}.}. Consider the +following example package definition in JSON format: + +@example +@{ + "name": "hello", + "version": "2.10", + "source": "mirror://gnu/hello/hello-2.10.tar.gz", + "build-system": "gnu", + "home-page": "https://www.gnu.org/software/hello/", + "synopsis": "Hello, GNU world: An example GNU package", + "description": "GNU Hello prints a greeting.", + "license": "GPL-3.0+", + "native-inputs": ["gcc@@6"] +@} +@end example + +The field names are the same as for the @code{<package>} record +(@xref{Pakete definieren}). References to other packages are provided as +JSON lists of quoted package specification strings such as @code{guile} or +@code{guile@@2.0}. + +The importer also supports a more explicit source definition using the +common fields for @code{<origin>} records: + +@example +@{ + @dots{} + "source": @{ + "method": "url-fetch", + "uri": "mirror://gnu/hello/hello-2.10.tar.gz", + "sha256": @{ + "base32": "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i" + @} + @} + @dots{} +@} +@end example + +The command below reads metadata from the JSON file @code{hello.json} and +outputs a package expression: + +@example +guix import json hello.json +@end example + +@item nix +Import metadata from a local copy of the source of the +@uref{http://nixos.org/nixpkgs/, Nixpkgs distribution}@footnote{This relies +on the @command{nix-instantiate} command of @uref{http://nixos.org/nix/, +Nix}.}. Package definitions in Nixpkgs are typically written in a mixture +of Nix-language and Bash code. This command only imports the high-level +package structure that is written in the Nix language. It normally includes +all the basic fields of a package definition. + +When importing a GNU package, the synopsis and descriptions are replaced by +their canonical upstream variant. + +Usually, you will first need to do: + +@example +export NIX_REMOTE=daemon +@end example + +@noindent +so that @command{nix-instantiate} does not try to open the Nix database. + +As an example, the command below imports the package definition of +LibreOffice (more precisely, it imports the definition of the package bound +to the @code{libreoffice} top-level attribute): + +@example +guix import nix ~/path/to/nixpkgs libreoffice +@end example + +@item hackage +@cindex hackage +Import metadata from the Haskell community's central package archive +@uref{https://hackage.haskell.org/, Hackage}. Information is taken from +Cabal files and includes all the relevant information, including package +dependencies. + +Specific command-line options are: + +@table @code +@item --stdin +@itemx -s +Read a Cabal file from standard input. +@item --no-test-dependencies +@itemx -t +Do not include dependencies required only by the test suites. +@item --cabal-environment=@var{alist} +@itemx -e @var{alist} +@var{alist} is a Scheme alist defining the environment in which the Cabal +conditionals are evaluated. The accepted keys are: @code{os}, @code{arch}, +@code{impl} and a string representing the name of a flag. The value +associated with a flag has to be either the symbol @code{true} or +@code{false}. The value associated with other keys has to conform to the +Cabal file format definition. The default value associated with the keys +@code{os}, @code{arch} and @code{impl} is @samp{linux}, @samp{x86_64} and +@samp{ghc}, respectively. +@item --recursive +@itemx -r +Traverse the dependency graph of the given upstream package recursively and +generate package expressions for all those packages that are not yet in +Guix. +@end table + +The command below imports metadata for the latest version of the @code{HTTP} +Haskell package without including test dependencies and specifying the value +of the flag @samp{network-uri} as @code{false}: + +@example +guix import hackage -t -e "'((\"network-uri\" . false))" HTTP +@end example + +A specific package version may optionally be specified by following the +package name by an at-sign and a version number as in the following example: + +@example +guix import hackage mtl@@2.1.3.1 +@end example + +@item stackage +@cindex stackage +The @code{stackage} importer is a wrapper around the @code{hackage} one. It +takes a package name, looks up the package version included in a long-term +support (LTS) @uref{https://www.stackage.org, Stackage} release and uses the +@code{hackage} importer to retrieve its metadata. Note that it is up to you +to select an LTS release compatible with the GHC compiler used by Guix. + +Specific command-line options are: + +@table @code +@item --no-test-dependencies +@itemx -t +Do not include dependencies required only by the test suites. +@item --lts-version=@var{version} +@itemx -l @var{version} +@var{version} is the desired LTS release version. If omitted the latest +release is used. +@item --recursive +@itemx -r +Traverse the dependency graph of the given upstream package recursively and +generate package expressions for all those packages that are not yet in +Guix. +@end table + +The command below imports metadata for the @code{HTTP} Haskell package +included in the LTS Stackage release version 7.18: + +@example +guix import stackage --lts-version=7.18 HTTP +@end example + +@item elpa +@cindex elpa +Import metadata from an Emacs Lisp Package Archive (ELPA) package repository +(@pxref{Packages,,, emacs, The GNU Emacs Manual}). + +Specific command-line options are: + +@table @code +@item --archive=@var{repo} +@itemx -a @var{repo} +@var{repo} identifies the archive repository from which to retrieve the +information. Currently the supported repositories and their identifiers +are: +@itemize - +@item +@uref{http://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} +identifier. This is the default. + +Packages from @code{elpa.gnu.org} are signed with one of the keys contained +in the GnuPG keyring at @file{share/emacs/25.1/etc/package-keyring.gpg} (or +similar) in the @code{emacs} package (@pxref{Package Installation, ELPA +package signatures,, emacs, The GNU Emacs Manual}). + +@item +@uref{http://stable.melpa.org/packages, MELPA-Stable}, selected by the +@code{melpa-stable} identifier. + +@item +@uref{http://melpa.org/packages, MELPA}, selected by the @code{melpa} +identifier. +@end itemize + +@item --recursive +@itemx -r +Traverse the dependency graph of the given upstream package recursively and +generate package expressions for all those packages that are not yet in +Guix. +@end table + +@item crate +@cindex crate +Import metadata from the crates.io Rust package repository +@uref{https://crates.io, crates.io}. + +@item opam +@cindex OPAM +@cindex OCaml +Import metadata from the @uref{https://opam.ocaml.org/, OPAM} package +repository used by the OCaml community. +@end table + +The structure of the @command{guix import} code is modular. It would be +useful to have more importers for other package formats, and your help is +welcome here (@pxref{Mitwirken}). + +@node Aufruf von guix refresh +@section Invoking @command{guix refresh} + +@cindex @command{guix refresh} +The primary audience of the @command{guix refresh} command is developers of +the GNU software distribution. By default, it reports any packages provided +by the distribution that are outdated compared to the latest upstream +version, like this: + +@example +$ guix refresh +gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1 +gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0 +@end example + +Alternately, one can specify packages to consider, in which case a warning +is emitted for packages that lack an updater: + +@example +$ guix refresh coreutils guile guile-ssh +gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh +gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13 +@end example + +@command{guix refresh} browses the upstream repository of each package and +determines the highest version number of the releases therein. The command +knows how to update specific types of packages: GNU packages, ELPA packages, +etc.---see the documentation for @option{--type} below. There are many +packages, though, for which it lacks a method to determine whether a new +upstream release is available. However, the mechanism is extensible, so +feel free to get in touch with us to add a new method! + +Sometimes the upstream name differs from the package name used in Guix, and +@command{guix refresh} needs a little help. Most updaters honor the +@code{upstream-name} property in package definitions, which can be used to +that effect: + +@example +(define-public network-manager + (package + (name "network-manager") + ;; @dots{} + (properties '((upstream-name . "NetworkManager"))))) +@end example + +When passed @code{--update}, it modifies distribution source files to update +the version numbers and source tarball hashes of those package recipes +(@pxref{Pakete definieren}). This is achieved by downloading each package's +latest source tarball and its associated OpenPGP signature, authenticating +the downloaded tarball against its signature using @command{gpg}, and +finally computing its hash. When the public key used to sign the tarball is +missing from the user's keyring, an attempt is made to automatically +retrieve it from a public key server; when this is successful, the key is +added to the user's keyring; otherwise, @command{guix refresh} reports an +error. + +The following options are supported: + +@table @code + +@item --expression=@var{expr} +@itemx -e @var{expr} +Consider the package @var{expr} evaluates to. + +This is useful to precisely refer to a package, as in this example: + +@example +guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)' +@end example + +This command lists the dependents of the ``final'' libc (essentially all the +packages.) + +@item --update +@itemx -u +Update distribution source files (package recipes) in place. This is +usually run from a checkout of the Guix source tree (@pxref{Guix vor der Installation ausführen}): + +@example +$ ./pre-inst-env guix refresh -s non-core -u +@end example + +@xref{Pakete definieren}, for more information on package definitions. + +@item --select=[@var{subset}] +@itemx -s @var{subset} +Select all the packages in @var{subset}, one of @code{core} or +@code{non-core}. + +The @code{core} subset refers to all the packages at the core of the +distribution---i.e., packages that are used to build ``everything else''. +This includes GCC, libc, Binutils, Bash, etc. Usually, changing one of +these packages in the distribution entails a rebuild of all the others. +Thus, such updates are an inconvenience to users in terms of build time or +bandwidth used to achieve the upgrade. + +The @code{non-core} subset refers to the remaining packages. It is +typically useful in cases where an update of the core packages would be +inconvenient. + +@item --manifest=@var{Datei} +@itemx -m @var{Datei} +Select all the packages from the manifest in @var{file}. This is useful to +check if any packages of the user manifest can be updated. + +@item --type=@var{updater} +@itemx -t @var{updater} +Select only packages handled by @var{updater} (may be a comma-separated list +of updaters). Currently, @var{updater} may be one of: + +@table @code +@item gnu +the updater for GNU packages; +@item gnome +the updater for GNOME packages; +@item kde +the updater for KDE packages; +@item xorg +the updater for X.org packages; +@item kernel.org +the updater for packages hosted on kernel.org; +@item elpa +the updater for @uref{http://elpa.gnu.org/, ELPA} packages; +@item cran +the updater for @uref{https://cran.r-project.org/, CRAN} packages; +@item bioconductor +the updater for @uref{https://www.bioconductor.org/, Bioconductor} R +packages; +@item cpan +the updater for @uref{http://www.cpan.org/, CPAN} packages; +@item pypi +the updater for @uref{https://pypi.python.org, PyPI} packages. +@item gem +the updater for @uref{https://rubygems.org, RubyGems} packages. +@item github +the updater for @uref{https://github.com, GitHub} packages. +@item hackage +the updater for @uref{https://hackage.haskell.org, Hackage} packages. +@item stackage +the updater for @uref{https://www.stackage.org, Stackage} packages. +@item crate +the updater for @uref{https://crates.io, Crates} packages. +@end table + +For instance, the following command only checks for updates of Emacs +packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages: + +@example +$ guix refresh --type=elpa,cran +gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0 +gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9 +@end example + +@end table + +In addition, @command{guix refresh} can be passed one or more package names, +as in this example: + +@example +$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8 +@end example + +@noindent +The command above specifically updates the @code{emacs} and @code{idutils} +packages. The @code{--select} option would have no effect in this case. + +When considering whether to upgrade a package, it is sometimes convenient to +know which packages would be affected by the upgrade and should be checked +for compatibility. For this the following option may be used when passing +@command{guix refresh} one or more package names: + +@table @code + +@item --list-updaters +@itemx -L +List available updaters and exit (see @option{--type} above.) + +For each updater, display the fraction of packages it covers; at the end, +display the fraction of packages covered by all these updaters. + +@item --list-dependent +@itemx -l +List top-level dependent packages that would need to be rebuilt as a result +of upgrading one or more packages. + +@xref{Aufruf von guix graph, the @code{reverse-package} type of @command{guix +graph}}, for information on how to visualize the list of dependents of a +package. + +@end table + +Be aware that the @code{--list-dependent} option only @emph{approximates} +the rebuilds that would be required as a result of an upgrade. More +rebuilds might be required under some circumstances. + +@example +$ guix refresh --list-dependent flex +Building the following 120 packages would ensure 213 dependent packages are rebuilt: +hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{} +@end example + +The command above lists a set of packages that could be built to check for +compatibility with an upgraded @code{flex} package. + +The following options can be used to customize GnuPG operation: + +@table @code + +@item --gpg=@var{command} +Use @var{command} as the GnuPG 2.x command. @var{command} is searched for +in @code{$PATH}. + +@item --keyring=@var{file} +Use @var{file} as the keyring for upstream keys. @var{file} must be in the +@dfn{keybox format}. Keybox files usually have a name ending in @file{.kbx} +and the GNU@tie{}Privacy Guard (GPG) can manipulate these files +(@pxref{kbxutil, @command{kbxutil},, gnupg, Using the GNU Privacy Guard}, +for information on a tool to manipulate keybox files). + +When this option is omitted, @command{guix refresh} uses +@file{~/.config/guix/upstream/trustedkeys.kbx} as the keyring for upstream +signing keys. OpenPGP signatures are checked against keys from this +keyring; missing keys are downloaded to this keyring as well (see +@option{--key-download} below.) + +You can export keys from your default GPG keyring into a keybox file using +commands like this one: + +@example +gpg --export rms@@gnu.org | kbxutil --import-openpgp >> mykeyring.kbx +@end example + +Likewise, you can fetch keys to a specific keybox file like this: + +@example +gpg --no-default-keyring --keyring mykeyring.kbx \ + --recv-keys @value{OPENPGP-SIGNING-KEY-ID} +@end example + +@ref{GPG Configuration Options, @option{--keyring},, gnupg, Using the GNU +Privacy Guard}, for more information on GPG's @option{--keyring} option. + +@item --key-download=@var{policy} +Handle missing OpenPGP keys according to @var{policy}, which may be one of: + +@table @code +@item always +Always download missing OpenPGP keys from the key server, and add them to +the user's GnuPG keyring. + +@item never +Never try to download missing OpenPGP keys. Instead just bail out. + +@item interactive +When a package signed with an unknown OpenPGP key is encountered, ask the +user whether to download it or not. This is the default behavior. +@end table + +@item --key-server=@var{host} +Use @var{host} as the OpenPGP key server when importing a public key. + +@end table + +The @code{github} updater uses the @uref{https://developer.github.com/v3/, +GitHub API} to query for new releases. When used repeatedly e.g. when +refreshing all packages, GitHub will eventually refuse to answer any further +API requests. By default 60 API requests per hour are allowed, and a full +refresh on all GitHub packages in Guix requires more than this. +Authentication with GitHub through the use of an API token alleviates these +limits. To use an API token, set the environment variable +@code{GUIX_GITHUB_TOKEN} to a token procured from +@uref{https://github.com/settings/tokens} or otherwise. + + +@node Aufruf von guix lint +@section Invoking @command{guix lint} + +@cindex @command{guix lint} +@cindex package, checking for errors +The @command{guix lint} command is meant to help package developers avoid +common errors and use a consistent style. It runs a number of checks on a +given set of packages in order to find common mistakes in their +definitions. Available @dfn{checkers} include (see @code{--list-checkers} +for a complete list): + +@table @code +@item synopsis +@itemx description +Validate certain typographical and stylistic rules about package +descriptions and synopses. + +@item inputs-should-be-native +Identify inputs that should most likely be native inputs. + +@item source +@itemx home-page +@itemx mirror-url +@itemx source-file-name +Probe @code{home-page} and @code{source} URLs and report those that are +invalid. Suggest a @code{mirror://} URL when applicable. Check that the +source file name is meaningful, e.g. is not just a version number or +``git-checkout'', without a declared @code{file-name} (@pxref{„origin“-Referenz}). + +@item cve +@cindex security vulnerabilities +@cindex CVE, Common Vulnerabilities and Exposures +Report known vulnerabilities found in the Common Vulnerabilities and +Exposures (CVE) databases of the current and past year +@uref{https://nvd.nist.gov/download.cfm#CVE_FEED, published by the US NIST}. + +To view information about a particular vulnerability, visit pages such as: + +@itemize +@item +@indicateurl{https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD} +@item +@indicateurl{https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD} +@end itemize + +@noindent +where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., +@code{CVE-2015-7554}. + +Package developers can specify in package recipes the +@uref{https://nvd.nist.gov/cpe.cfm,Common Platform Enumeration (CPE)} name +and version of the package when they differ from the name or version that +Guix uses, as in this example: + +@example +(package + (name "grub") + ;; @dots{} + ;; CPE calls this package "grub2". + (properties '((cpe-name . "grub2") + (cpe-version . "2.3"))) +@end example + +@c See <http://www.openwall.com/lists/oss-security/2017/03/15/3>. +Some entries in the CVE database do not specify which version of a package +they apply to, and would thus ``stick around'' forever. Package developers +who found CVE alerts and verified they can be ignored can declare them as in +this example: + +@example +(package + (name "t1lib") + ;; @dots{} + ;; These CVEs no longer apply and can be safely ignored. + (properties `((lint-hidden-cve . ("CVE-2011-0433" + "CVE-2011-1553" + "CVE-2011-1554" + "CVE-2011-5244"))))) +@end example + +@item formatting +Warn about obvious source code formatting issues: trailing white space, use +of tabulations, etc. +@end table + +The general syntax is: + +@example +guix lint @var{options} @var{package}@dots{} +@end example + +If no package is given on the command line, then all packages are checked. +The @var{options} may be zero or more of the following: + +@table @code +@item --list-checkers +@itemx -l +List and describe all the available checkers that will be run on packages +and exit. + +@item --checkers +@itemx -c +Only enable the checkers specified in a comma-separated list using the names +returned by @code{--list-checkers}. + +@end table + +@node Aufruf von guix size +@section Invoking @command{guix size} + +@cindex size +@cindex package size +@cindex Abschluss +@cindex @command{guix size} +The @command{guix size} command helps package developers profile the disk +usage of packages. It is easy to overlook the impact of an additional +dependency added to a package, or the impact of using a single output for a +package that could easily be split (@pxref{Pakete mit mehreren Ausgaben.}). Such are the typical issues that @command{guix size} can +highlight. + +The command can be passed one or more package specifications such as +@code{gcc@@4.8} or @code{guile:debug}, or a file name in the store. +Consider this example: + +@example +$ guix size coreutils +store item total self +/gnu/store/@dots{}-gcc-5.5.0-lib 60.4 30.1 38.1% +/gnu/store/@dots{}-glibc-2.27 30.3 28.8 36.6% +/gnu/store/@dots{}-coreutils-8.28 78.9 15.0 19.0% +/gnu/store/@dots{}-gmp-6.1.2 63.1 2.7 3.4% +/gnu/store/@dots{}-bash-static-4.4.12 1.5 1.5 1.9% +/gnu/store/@dots{}-acl-2.2.52 61.1 0.4 0.5% +/gnu/store/@dots{}-attr-2.4.47 60.6 0.2 0.3% +/gnu/store/@dots{}-libcap-2.25 60.5 0.2 0.2% +total: 78.9 MiB +@end example + +@cindex Abschluss +The store items listed here constitute the @dfn{transitive closure} of +Coreutils---i.e., Coreutils and all its dependencies, recursively---as would +be returned by: + +@example +$ guix gc -R /gnu/store/@dots{}-coreutils-8.23 +@end example + +Here the output shows three columns next to store items. The first column, +labeled ``total'', shows the size in mebibytes (MiB) of the closure of the +store item---that is, its own size plus the size of all its dependencies. +The next column, labeled ``self'', shows the size of the item itself. The +last column shows the ratio of the size of the item itself to the space +occupied by all the items listed here. + +In this example, we see that the closure of Coreutils weighs in at +79@tie{}MiB, most of which is taken by libc and GCC's run-time support +libraries. (That libc and GCC's libraries represent a large fraction of the +closure is not a problem @i{per se} because they are always available on the +system anyway.) + +When the package(s) passed to @command{guix size} are available in the +store@footnote{More precisely, @command{guix size} looks for the +@emph{ungrafted} variant of the given package(s), as returned by @code{guix +build @var{package} --no-grafts}. @xref{Sicherheitsaktualisierungen}, for information +on grafts.}, @command{guix size} queries the daemon to determine its +dependencies, and measures its size in the store, similar to @command{du -ms +--apparent-size} (@pxref{du invocation,,, coreutils, GNU Coreutils}). + +When the given packages are @emph{not} in the store, @command{guix size} +reports information based on the available substitutes +(@pxref{Substitute}). This makes it possible it to profile disk usage of +store items that are not even on disk, only available remotely. + +You can also specify several package names: + +@example +$ guix size coreutils grep sed bash +store item total self +/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4% +/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8% +/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6% +/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2% +@dots{} +total: 102.3 MiB +@end example + +@noindent +In this example we see that the combination of the four packages takes +102.3@tie{}MiB in total, which is much less than the sum of each closure +since they have a lot of dependencies in common. + +The available options are: + +@table @option + +@item --substitute-urls=@var{URLs} +Use substitute information from @var{urls}. @xref{client-substitute-urls, +the same option for @code{guix build}}. + +@item --sort=@var{key} +Sort lines according to @var{key}, one of the following options: + +@table @code +@item self +the size of each item (the default); +@item Abschluss +the total size of the item's closure. +@end table + +@item --map-file=@var{file} +Write a graphical map of disk usage in PNG format to @var{file}. + +For the example above, the map looks like this: + +@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced +by @command{guix size}} + +This option requires that +@uref{http://wingolog.org/software/guile-charting/, Guile-Charting} be +installed and visible in Guile's module search path. When that is not the +case, @command{guix size} fails as it tries to load it. + +@item --system=@var{System} +@itemx -s @var{system} +Consider packages for @var{system}---e.g., @code{x86_64-linux}. + +@end table + +@node Aufruf von guix graph +@section Invoking @command{guix graph} + +@cindex DAG +@cindex @command{guix graph} +@cindex Paketabhängigkeiten +Packages and their dependencies form a @dfn{graph}, specifically a directed +acyclic graph (DAG). It can quickly become difficult to have a mental model +of the package DAG, so the @command{guix graph} command provides a visual +representation of the DAG. By default, @command{guix graph} emits a DAG +representation in the input format of @uref{http://www.graphviz.org/, +Graphviz}, so its output can be passed directly to the @command{dot} command +of Graphviz. It can also emit an HTML page with embedded JavaScript code to +display a ``chord diagram'' in a Web browser, using the +@uref{https://d3js.org/, d3.js} library, or emit Cypher queries to construct +a graph in a graph database supporting the @uref{http://www.opencypher.org/, +openCypher} query language. The general syntax is: + +@example +guix graph @var{options} @var{package}@dots{} +@end example + +For example, the following command generates a PDF file representing the +package DAG for the GNU@tie{}Core Utilities, showing its build-time +dependencies: + +@example +guix graph coreutils | dot -Tpdf > dag.pdf +@end example + +The output looks like this: + +@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils} + +Nice little graph, no? + +But there is more than one graph! The one above is concise: it is the graph +of package objects, omitting implicit inputs such as GCC, libc, grep, etc. +It is often useful to have such a concise graph, but sometimes one may want +to see more details. @command{guix graph} supports several types of graphs, +allowing you to choose the level of detail: + +@table @code +@item package +This is the default type used in the example above. It shows the DAG of +package objects, excluding implicit dependencies. It is concise, but +filters out many details. + +@item reverse-package +This shows the @emph{reverse} DAG of packages. For example: + +@example +guix graph --type=reverse-package ocaml +@end example + +... yields the graph of packages that depend on OCaml. + +Note that for core packages this can yield huge graphs. If all you want is +to know the number of packages that depend on a given package, use +@command{guix refresh --list-dependent} (@pxref{Aufruf von guix refresh, +@option{--list-dependent}}). + +@item bag-emerged +This is the package DAG, @emph{including} implicit inputs. + +For instance, the following command: + +@example +guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf +@end example + +... yields this bigger graph: + +@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU +Coreutils} + +At the bottom of the graph, we see all the implicit inputs of +@var{gnu-build-system} (@pxref{Erstellungssysteme, @code{gnu-build-system}}). + +Now, note that the dependencies of these implicit inputs---that is, the +@dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, +for conciseness. + +@item bag +Similar to @code{bag-emerged}, but this time including all the bootstrap +dependencies. + +@item bag-with-origins +Similar to @code{bag}, but also showing origins and their dependencies. + +@item Ableitung +This is the most detailed representation: It shows the DAG of derivations +(@pxref{Ableitungen}) and plain store items. Compared to the above +representation, many additional nodes are visible, including build scripts, +patches, Guile modules, etc. + +For this type of graph, it is also possible to pass a @file{.drv} file name +instead of a package name, as in: + +@example +guix graph -t derivation `guix system build -d my-config.scm` +@end example + +@item module +This is the graph of @dfn{package modules} (@pxref{Paketmodule}). For +example, the following command shows the graph for the package module that +defines the @code{guile} package: + +@example +guix graph -t module guile | dot -Tpdf > module-graph.pdf +@end example +@end table + +All the types above correspond to @emph{build-time dependencies}. The +following graph type represents the @emph{run-time dependencies}: + +@table @code +@item references +This is the graph of @dfn{references} of a package output, as returned by +@command{guix gc --references} (@pxref{Aufruf von guix gc}). + +If the given package output is not available in the store, @command{guix +graph} attempts to obtain dependency information from substitutes. + +Here you can also pass a store file name instead of a package name. For +example, the command below produces the reference graph of your profile +(which can be big!): + +@example +guix graph -t references `readlink -f ~/.guix-profile` +@end example + +@item referrers +This is the graph of the @dfn{referrers} of a store item, as returned by +@command{guix gc --referrers} (@pxref{Aufruf von guix gc}). + +This relies exclusively on local information from your store. For instance, +let us suppose that the current Inkscape is available in 10 profiles on your +machine; @command{guix graph -t referrers inkscape} will show a graph rooted +at Inkscape and with those 10 profiles linked to it. + +It can help determine what is preventing a store item from being garbage +collected. + +@end table + +The available options are the following: + +@table @option +@item --type=@var{type} +@itemx -t @var{type} +Produce a graph output of @var{type}, where @var{type} must be one of the +values listed above. + +@item --list-types +List the supported graph types. + +@item --backend=@var{backend} +@itemx -b @var{backend} +Produce a graph using the selected @var{backend}. + +@item --list-backends +List the supported graph backends. + +Currently, the available backends are Graphviz and d3.js. + +@item --expression=@var{expr} +@itemx -e @var{expr} +Consider the package @var{expr} evaluates to. + +This is useful to precisely refer to a package, as in this example: + +@example +guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)' +@end example + +@item --system=@var{System} +@itemx -s @var{system} +Display the graph for @var{system}---e.g., @code{i686-linux}. + +The package dependency graph is largely architecture-independent, but there +are some architecture-dependent bits that this option allows you to +visualize. +@end table + + +@node Aufruf von guix environment +@section Invoking @command{guix environment} + +@cindex reproducible build environments +@cindex development environments +@cindex @command{guix environment} +@cindex environment, package build environment +The purpose of @command{guix environment} is to assist hackers in creating +reproducible development environments without polluting their package +profile. The @command{guix environment} tool takes one or more packages, +builds all of their inputs, and creates a shell environment to use them. + +The general syntax is: + +@example +guix environment @var{options} @var{package}@dots{} +@end example + +The following example spawns a new shell set up for the development of +GNU@tie{}Guile: + +@example +guix environment guile +@end example + +If the needed dependencies are not built yet, @command{guix environment} +automatically builds them. The environment of the new shell is an augmented +version of the environment that @command{guix environment} was run in. It +contains the necessary search paths for building the given package added to +the existing environment variables. To create a ``pure'' environment, in +which the original environment variables have been unset, use the +@code{--pure} option@footnote{Users sometimes wrongfully augment environment +variables such as @code{PATH} in their @file{~/.bashrc} file. As a +consequence, when @code{guix environment} launches it, Bash may read +@file{~/.bashrc}, thereby introducing ``impurities'' in these environment +variables. It is an error to define such environment variables in +@file{.bashrc}; instead, they should be defined in @file{.bash_profile}, +which is sourced only by log-in shells. @xref{Bash Startup Files,,, bash, +The GNU Bash Reference Manual}, for details on Bash start-up files.}. + +@vindex GUIX_ENVIRONMENT +@command{guix environment} defines the @code{GUIX_ENVIRONMENT} variable in +the shell it spawns; its value is the file name of the profile of this +environment. This allows users to, say, define a specific prompt for +development environments in their @file{.bashrc} (@pxref{Bash Startup +Files,,, bash, The GNU Bash Reference Manual}): + +@example +if [ -n "$GUIX_ENVIRONMENT" ] +then + export PS1="\u@@\h \w [dev]\$ " +fi +@end example + +@noindent +... or to browse the profile: + +@example +$ ls "$GUIX_ENVIRONMENT/bin" +@end example + +Additionally, more than one package may be specified, in which case the +union of the inputs for the given packages are used. For example, the +command below spawns a shell where all of the dependencies of both Guile and +Emacs are available: + +@example +guix environment guile emacs +@end example + +Sometimes an interactive shell session is not desired. An arbitrary command +may be invoked by placing the @code{--} token to separate the command from +the rest of the arguments: + +@example +guix environment guile -- make -j4 +@end example + +In other situations, it is more convenient to specify the list of packages +needed in the environment. For example, the following command runs +@command{python} from an environment containing Python@tie{}2.7 and NumPy: + +@example +guix environment --ad-hoc python2-numpy python-2.7 -- python +@end example + +Furthermore, one might want the dependencies of a package and also some +additional packages that are not build-time or runtime dependencies, but are +useful when developing nonetheless. Because of this, the @code{--ad-hoc} +flag is positional. Packages appearing before @code{--ad-hoc} are +interpreted as packages whose dependencies will be added to the +environment. Packages appearing after are interpreted as packages that will +be added to the environment directly. For example, the following command +creates a Guix development environment that additionally includes Git and +strace: + +@example +guix environment guix --ad-hoc git strace +@end example + +Sometimes it is desirable to isolate the environment as much as possible, +for maximal purity and reproducibility. In particular, when using Guix on a +host distro that is not GuixSD, it is desirable to prevent access to +@file{/usr/bin} and other system-wide resources from the development +environment. For example, the following command spawns a Guile REPL in a +``container'' where only the store and the current working directory are +mounted: + +@example +guix environment --ad-hoc --container guile -- guile +@end example + +@quotation Anmerkung +The @code{--container} option requires Linux-libre 3.19 or newer. +@end quotation + +The available options are summarized below. + +@table @code +@item --root=@var{file} +@itemx -r @var{file} +@cindex persistent environment +@cindex garbage collector root, for environments +Make @var{file} a symlink to the profile for this environment, and register +it as a garbage collector root. + +This is useful if you want to protect your environment from garbage +collection, to make it ``persistent''. + +When this option is omitted, the environment is protected from garbage +collection only for the duration of the @command{guix environment} session. +This means that next time you recreate the same environment, you could have +to rebuild or re-download packages. @xref{Aufruf von guix gc}, for more on GC +roots. + +@item --expression=@var{expr} +@itemx -e @var{expr} +Create an environment for the package or list of packages that @var{expr} +evaluates to. + +For example, running: + +@example +guix environment -e '(@@ (gnu packages maths) petsc-openmpi)' +@end example + +starts a shell with the environment for this specific variant of the PETSc +package. + +Running: + +@example +guix environment --ad-hoc -e '(@@ (gnu) %base-packages)' +@end example + +starts a shell with all the GuixSD base packages available. + +The above commands only use the default output of the given packages. To +select other outputs, two element tuples can be specified: + +@example +guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) "include")' +@end example + +@item --load=@var{file} +@itemx -l @var{file} +Create an environment for the package or list of packages that the code +within @var{file} evaluates to. + +Zum Beispiel könnte die @var{Datei} eine Definition wie diese enthalten +(@pxref{Pakete definieren}): + +@example +@verbatiminclude environment-gdb.scm +@end example + +@item --manifest=@var{Datei} +@itemx -m @var{Datei} +Create an environment for the packages contained in the manifest object +returned by the Scheme code in @var{file}. + +This is similar to the same-named option in @command{guix package} +(@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest +files. + +@item --ad-hoc +Include all specified packages in the resulting environment, as if an @i{ad +hoc} package were defined with them as inputs. This option is useful for +quickly creating an environment without having to write a package expression +to contain the desired inputs. + +For instance, the command: + +@example +guix environment --ad-hoc guile guile-sdl -- guile +@end example + +runs @command{guile} in an environment where Guile and Guile-SDL are +available. + +Note that this example implicitly asks for the default output of +@code{guile} and @code{guile-sdl}, but it is possible to ask for a specific +output---e.g., @code{glib:bin} asks for the @code{bin} output of @code{glib} +(@pxref{Pakete mit mehreren Ausgaben.}). + +This option may be composed with the default behavior of @command{guix +environment}. Packages appearing before @code{--ad-hoc} are interpreted as +packages whose dependencies will be added to the environment, the default +behavior. Packages appearing after are interpreted as packages that will be +added to the environment directly. + +@item --pure +Unset existing environment variables when building the new environment. +This has the effect of creating an environment in which search paths only +contain package inputs. + +@item --search-paths +Display the environment variable definitions that make up the environment. + +@item --system=@var{System} +@itemx -s @var{system} +Attempt to build for @var{system}---e.g., @code{i686-linux}. + +@item --container +@itemx -C +@cindex container +Run @var{command} within an isolated container. The current working +directory outside the container is mapped inside the container. +Additionally, unless overridden with @code{--user}, a dummy home directory +is created that matches the current user's home directory, and +@file{/etc/passwd} is configured accordingly. The spawned process runs as +the current user outside the container, but has root privileges in the +context of the container. + +@item --network +@itemx -N +For containers, share the network namespace with the host system. +Containers created without this flag only have access to the loopback +device. + +@item --link-profile +@itemx -P +For containers, link the environment profile to @file{~/.guix-profile} +within the container. This is equivalent to running the command @command{ln +-s $GUIX_ENVIRONMENT ~/.guix-profile} within the container. Linking will +fail and abort the environment if the directory already exists, which will +certainly be the case if @command{guix environment} was invoked in the +user's home directory. + +Certain packages are configured to look in @code{~/.guix-profile} for +configuration files and data;@footnote{For example, the @code{fontconfig} +package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} +@code{--link-profile} allows these programs to behave as expected within the +environment. + +@item --user=@var{user} +@itemx -u @var{user} +For containers, use the username @var{user} in place of the current user. +The generated @file{/etc/passwd} entry within the container will contain the +name @var{user}; the home directory will be @file{/home/USER}; and no user +GECOS data will be copied. @var{user} need not exist on the system. + +Additionally, any shared or exposed path (see @code{--share} and +@code{--expose} respectively) whose target is within the current user's home +directory will be remapped relative to @file{/home/USER}; this includes the +automatic mapping of the current working directory. + +@example +# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target +cd $HOME/wd +guix environment --container --user=foo \ + --expose=$HOME/test \ + --expose=/tmp/target=$HOME/target +@end example + +While this will limit the leaking of user identity through home paths and +each of the user fields, this is only one useful component of a broader +privacy/anonymity solution---not one in and of itself. + +@item --expose=@var{source}[=@var{target}] +For containers, expose the file system @var{source} from the host system as +the read-only file system @var{target} within the container. If +@var{target} is not specified, @var{source} is used as the target mount +point in the container. + +The example below spawns a Guile REPL in a container in which the user's +home directory is accessible read-only via the @file{/exchange} directory: + +@example +guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile +@end example + +@item --share=@var{source}[=@var{target}] +For containers, share the file system @var{source} from the host system as +the writable file system @var{target} within the container. If @var{target} +is not specified, @var{source} is used as the target mount point in the +container. + +The example below spawns a Guile REPL in a container in which the user's +home directory is accessible for both reading and writing via the +@file{/exchange} directory: + +@example +guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile +@end example +@end table + +@command{guix environment} also supports all of the common build options +that @command{guix build} supports (@pxref{Gemeinsame Erstellungsoptionen}). + + +@node Aufruf von guix publish +@section Invoking @command{guix publish} + +@cindex @command{guix publish} +The purpose of @command{guix publish} is to enable users to easily share +their store with others, who can then use it as a substitute server +(@pxref{Substitute}). + +When @command{guix publish} runs, it spawns an HTTP server which allows +anyone with network access to obtain substitutes from it. This means that +any machine running Guix can also act as if it were a build farm, since the +HTTP interface is compatible with Hydra, the software behind the +@code{hydra.gnu.org} build farm. + +For security, each substitute is signed, allowing recipients to check their +authenticity and integrity (@pxref{Substitute}). Because @command{guix +publish} uses the signing key of the system, which is only readable by the +system administrator, it must be started as root; the @code{--user} option +makes it drop root privileges early on. + +The signing key pair must be generated before @command{guix publish} is +launched, using @command{guix archive --generate-key} (@pxref{Aufruf von guix archive}). + +The general syntax is: + +@example +guix publish @var{options}@dots{} +@end example + +Running @command{guix publish} without any additional arguments will spawn +an HTTP server on port 8080: + +@example +guix publish +@end example + +Once a publishing server has been authorized (@pxref{Aufruf von guix archive}), the daemon may download substitutes from it: + +@example +guix-daemon --substitute-urls=http://example.org:8080 +@end example + +By default, @command{guix publish} compresses archives on the fly as it +serves them. This ``on-the-fly'' mode is convenient in that it requires no +setup and is immediately available. However, when serving lots of clients, +we recommend using the @option{--cache} option, which enables caching of the +archives before they are sent to clients---see below for details. The +@command{guix weather} command provides a handy way to check what a server +provides (@pxref{Aufruf von guix weather}). + +As a bonus, @command{guix publish} also serves as a content-addressed mirror +for source files referenced in @code{origin} records (@pxref{„origin“-Referenz}). For instance, assuming @command{guix publish} is running on +@code{example.org}, the following URL returns the raw +@file{hello-2.10.tar.gz} file with the given SHA256 hash (represented in +@code{nix-base32} format, @pxref{Aufruf von guix hash}): + +@example +http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i +@end example + +Obviously, these URLs only work for files that are in the store; in other +cases, they return 404 (``Not Found''). + +@cindex build logs, publication +Build logs are available from @code{/log} URLs like: + +@example +http://example.org/log/gwspk@dots{}-guile-2.2.3 +@end example + +@noindent +When @command{guix-daemon} is configured to save compressed build logs, as +is the case by default (@pxref{Aufruf des guix-daemon}), @code{/log} URLs +return the compressed log as-is, with an appropriate @code{Content-Type} +and/or @code{Content-Encoding} header. We recommend running +@command{guix-daemon} with @code{--log-compression=gzip} since Web browsers +can automatically decompress it, which is not the case with bzip2 +compression. + +The following options are available: + +@table @code +@item --port=@var{port} +@itemx -p @var{port} +Listen for HTTP requests on @var{port}. + +@item --listen=@var{host} +Listen on the network interface for @var{host}. The default is to accept +connections from any interface. + +@item --user=@var{user} +@itemx -u @var{user} +Change privileges to @var{user} as soon as possible---i.e., once the server +socket is open and the signing key has been read. + +@item --compression[=@var{level}] +@itemx -C [@var{level}] +Compress data using the given @var{level}. When @var{level} is zero, +disable compression. The range 1 to 9 corresponds to different gzip +compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). +The default is 3. + +Unless @option{--cache} is used, compression occurs on the fly and the +compressed streams are not cached. Thus, to reduce load on the machine that +runs @command{guix publish}, it may be a good idea to choose a low +compression level, to run @command{guix publish} behind a caching proxy, or +to use @option{--cache}. Using @option{--cache} has the advantage that it +allows @command{guix publish} to add @code{Content-Length} HTTP header to +its responses. + +@item --cache=@var{directory} +@itemx -c @var{directory} +Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and +only serve archives that are in cache. + +When this option is omitted, archives and meta-data are created on-the-fly. +This can reduce the available bandwidth, especially when compression is +enabled, since this may become CPU-bound. Another drawback of the default +mode is that the length of archives is not known in advance, so +@command{guix publish} does not add a @code{Content-Length} HTTP header to +its responses, which in turn prevents clients from knowing the amount of +data being downloaded. + +Conversely, when @option{--cache} is used, the first request for a store +item (@i{via} a @code{.narinfo} URL) returns 404 and triggers a background +process to @dfn{bake} the archive---computing its @code{.narinfo} and +compressing the archive, if needed. Once the archive is cached in +@var{directory}, subsequent requests succeed and are served directly from +the cache, which guarantees that clients get the best possible bandwidth. + +The ``baking'' process is performed by worker threads. By default, one +thread per CPU core is created, but this can be customized. See +@option{--workers} below. + +When @option{--ttl} is used, cached entries are automatically deleted when +they have expired. + +@item --workers=@var{N} +When @option{--cache} is used, request the allocation of @var{N} worker +threads to ``bake'' archives. + +@item --ttl=@var{ttl} +Produce @code{Cache-Control} HTTP headers that advertise a time-to-live +(TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 +days, @code{1m} means 1 month, and so on. + +This allows the user's Guix to keep substitute information in cache for +@var{ttl}. However, note that @code{guix publish} does not itself guarantee +that the store items it provides will indeed remain available for as long as +@var{ttl}. + +Additionally, when @option{--cache} is used, cached entries that have not +been accessed for @var{ttl} and that no longer have a corresponding item in +the store, may be deleted. + +@item --nar-path=@var{path} +Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Aufruf von guix archive, normalized archives}). + +By default, nars are served at a URL such as +@code{/nar/gzip/@dots{}-coreutils-8.25}. This option allows you to change +the @code{/nar} part to @var{path}. + +@item --public-key=@var{file} +@itemx --private-key=@var{file} +Use the specific @var{file}s as the public/private key pair used to sign the +store items being published. + +The files must correspond to the same key pair (the private key is used for +signing and the public key is merely advertised in the signature metadata). +They must contain keys in the canonical s-expression format as produced by +@command{guix archive --generate-key} (@pxref{Aufruf von guix archive}). By +default, @file{/etc/guix/signing-key.pub} and +@file{/etc/guix/signing-key.sec} are used. + +@item --repl[=@var{port}] +@itemx -r [@var{port}] +Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile Reference +Manual}) on @var{port} (37146 by default). This is used primarily for +debugging a running @command{guix publish} server. +@end table + +Enabling @command{guix publish} on a GuixSD system is a one-liner: just +instantiate a @code{guix-publish-service-type} service in the +@code{services} field of the @code{operating-system} declaration +(@pxref{guix-publish-service-type, @code{guix-publish-service-type}}). + +If you are instead running Guix on a ``foreign distro'', follow these +instructions:” + +@itemize +@item +If your host distro uses the systemd init system: + +@example +# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \ + /etc/systemd/system/ +# systemctl start guix-publish && systemctl enable guix-publish +@end example + +@item +Wenn Ihre Wirts-Distribution als »init«-System Upstart verwendet: + +@example +# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/ +# start guix-publish +@end example + +@item +Otherwise, proceed similarly with your distro's init system. +@end itemize + +@node Aufruf von guix challenge +@section Invoking @command{guix challenge} + +@cindex Reproduzierbare Erstellungen +@cindex verifiable builds +@cindex @command{guix challenge} +@cindex challenge +Do the binaries provided by this server really correspond to the source code +it claims to build? Is a package build process deterministic? These are the +questions the @command{guix challenge} command attempts to answer. + +The former is obviously an important question: Before using a substitute +server (@pxref{Substitute}), one had better @emph{verify} that it provides +the right binaries, and thus @emph{challenge} it. The latter is what +enables the former: If package builds are deterministic, then independent +builds of the package should yield the exact same result, bit for bit; if a +server provides a binary different from the one obtained locally, it may be +either corrupt or malicious. + +We know that the hash that shows up in @file{/gnu/store} file names is the +hash of all the inputs of the process that built the file or +directory---compilers, libraries, build scripts, +etc. (@pxref{Einführung}). Assuming deterministic build processes, one +store file name should map to exactly one build output. @command{guix +challenge} checks whether there is, indeed, a single mapping by comparing +the build outputs of several independent builds of any given store item. + +The command output looks like this: + +@smallexample +$ guix challenge --substitute-urls="https://hydra.gnu.org https://guix.example.org" +updating list of substitutes from 'https://hydra.gnu.org'... 100.0% +updating list of substitutes from 'https://guix.example.org'... 100.0% +/gnu/store/@dots{}-openssl-1.0.2d contents differ: + local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q + https://hydra.gnu.org/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q + https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim +/gnu/store/@dots{}-git-2.5.0 contents differ: + local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha + https://hydra.gnu.org/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f + https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73 +/gnu/store/@dots{}-pius-2.1.1 contents differ: + local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax + https://hydra.gnu.org/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax + https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs + +@dots{} + +6,406 store items were analyzed: + - 4,749 (74.1%) were identical + - 525 (8.2%) differed + - 1,132 (17.7%) were inconclusive +@end smallexample + +@noindent +In this example, @command{guix challenge} first scans the store to determine +the set of locally-built derivations---as opposed to store items that were +downloaded from a substitute server---and then queries all the substitute +servers. It then reports those store items for which the servers obtained a +result different from the local build. + +@cindex non-determinism, in package builds +As an example, @code{guix.example.org} always gets a different answer. +Conversely, @code{hydra.gnu.org} agrees with local builds, except in the +case of Git. This might indicate that the build process of Git is +non-deterministic, meaning that its output varies as a function of various +things that Guix does not fully control, in spite of building packages in +isolated environments (@pxref{Funktionalitäten}). Most common sources of +non-determinism include the addition of timestamps in build results, the +inclusion of random numbers, and directory listings sorted by inode number. +See @uref{https://reproducible-builds.org/docs/}, for more information. + +To find out what is wrong with this Git binary, we can do something along +these lines (@pxref{Aufruf von guix archive}): + +@example +$ wget -q -O - https://hydra.gnu.org/nar/@dots{}-git-2.5.0 \ + | guix archive -x /tmp/git +$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git +@end example + +This command shows the difference between the files resulting from the local +build, and the files resulting from the build on @code{hydra.gnu.org} +(@pxref{Overview, Comparing and Merging Files,, diffutils, Comparing and +Merging Files}). The @command{diff} command works great for text files. +When binary files differ, a better option is @uref{https://diffoscope.org/, +Diffoscope}, a tool that helps visualize differences for all kinds of files. + +Once you have done that work, you can tell whether the differences are due +to a non-deterministic build process or to a malicious server. We try hard +to remove sources of non-determinism in packages to make it easier to verify +substitutes, but of course, this is a process that involves not just Guix, +but a large part of the free software community. In the meantime, +@command{guix challenge} is one tool to help address the problem. + +If you are writing packages for Guix, you are encouraged to check whether +@code{hydra.gnu.org} and other substitute servers obtain the same build +result as you did with: + +@example +$ guix challenge @var{package} +@end example + +@noindent +where @var{package} is a package specification such as @code{guile@@2.0} or +@code{glibc:debug}. + +The general syntax is: + +@example +guix challenge @var{options} [@var{packages}@dots{}] +@end example + +When a difference is found between the hash of a locally-built item and that +of a server-provided substitute, or among substitutes provided by different +servers, the command displays it as in the example above and its exit code +is 2 (other non-zero exit codes denote other kinds of errors.) + +The one option that matters is: + +@table @code + +@item --substitute-urls=@var{URLs} +Consider @var{urls} the whitespace-separated list of substitute source URLs +to compare to. + +@item --verbose +@itemx -v +Show details about matches (identical contents) in addition to information +about mismatches. + +@end table + +@node Aufruf von guix copy +@section Invoking @command{guix copy} + +@cindex copy, of store items, over SSH +@cindex SSH, copy of store items +@cindex sharing store items across machines +@cindex transferring store items across machines +The @command{guix copy} command copies items from the store of one machine +to that of another machine over a secure shell (SSH) +connection@footnote{This command is available only when Guile-SSH was +found. @xref{Voraussetzungen}, for details.}. For example, the following +command copies the @code{coreutils} package, the user's profile, and all +their dependencies over to @var{host}, logged in as @var{user}: + +@example +guix copy --to=@var{user}@@@var{host} \ + coreutils `readlink -f ~/.guix-profile` +@end example + +If some of the items to be copied are already present on @var{host}, they +are not actually sent. + +The command below retrieves @code{libreoffice} and @code{gimp} from +@var{host}, assuming they are available there: + +@example +guix copy --from=@var{host} libreoffice gimp +@end example + +The SSH connection is established using the Guile-SSH client, which is +compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and +@file{~/.ssh/config}, and uses the SSH agent for authentication. + +The key used to sign items that are sent must be accepted by the remote +machine. Likewise, the key used by the remote machine to sign items you are +retrieving must be in @file{/etc/guix/acl} so it is accepted by your own +daemon. @xref{Aufruf von guix archive}, for more information about store item +authentication. + +The general syntax is: + +@example +guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{} +@end example + +You must always specify one of the following options: + +@table @code +@item --to=@var{spec} +@itemx --from=@var{spec} +Specify the host to send to or receive from. @var{spec} must be an SSH spec +such as @code{example.org}, @code{charlie@@example.org}, or +@code{charlie@@example.org:2222}. +@end table + +The @var{items} can be either package names, such as @code{gimp}, or store +items, such as @file{/gnu/store/@dots{}-idutils-4.6}. + +When specifying the name of a package to send, it is first built if needed, +unless @option{--dry-run} was specified. Common build options are supported +(@pxref{Gemeinsame Erstellungsoptionen}). + + +@node Aufruf von guix container +@section Invoking @command{guix container} +@cindex container +@cindex @command{guix container} +@quotation Anmerkung +As of version @value{VERSION}, this tool is experimental. The interface is +subject to radical change in the future. +@end quotation + +The purpose of @command{guix container} is to manipulate processes running +within an isolated environment, commonly known as a ``container'', typically +created by the @command{guix environment} (@pxref{Aufruf von guix environment}) and @command{guix system container} (@pxref{Aufruf von guix system}) commands. + +The general syntax is: + +@example +guix container @var{action} @var{options}@dots{} +@end example + +@var{action} specifies the operation to perform with a container, and +@var{options} specifies the context-specific arguments for the action. + +The following actions are available: + +@table @code +@item exec +Execute a command within the context of a running container. + +The syntax is: + +@example +guix container exec @var{pid} @var{program} @var{arguments}@dots{} +@end example + +@var{pid} specifies the process ID of the running container. @var{program} +specifies an executable file name within the root file system of the +container. @var{arguments} are the additional options that will be passed +to @var{program}. + +The following command launches an interactive login shell inside a GuixSD +container, started by @command{guix system container}, and whose process ID +is 9001: + +@example +guix container exec 9001 /run/current-system/profile/bin/bash --login +@end example + +Note that the @var{pid} cannot be the parent process of a container. It +must be PID 1 of the container or one of its child processes. + +@end table + +@node Aufruf von guix weather +@section Invoking @command{guix weather} + +Occasionally you're grumpy because substitutes are lacking and you end up +building packages by yourself (@pxref{Substitute}). The @command{guix +weather} command reports on substitute availability on the specified servers +so you can have an idea of whether you'll be grumpy today. It can sometimes +be useful info as a user, but it is primarily useful to people running +@command{guix publish} (@pxref{Aufruf von guix publish}). + +@cindex statistics, for substitutes +@cindex availability of substitutes +@cindex substitute availability +@cindex weather, substitute availability +Here's a sample run: + +@example +$ guix weather --substitute-urls=https://guix.example.org +computing 5,872 package derivations for x86_64-linux... +looking for 6,128 store items on https://guix.example.org.. +updating list of substitutes from 'https://guix.example.org'... 100.0% +https://guix.example.org + 43.4% substitutes available (2,658 out of 6,128) + 7,032.5 MiB of nars (compressed) + 19,824.2 MiB on disk (uncompressed) + 0.030 seconds per request (182.9 seconds in total) + 33.5 requests per second + + 9.8% (342 out of 3,470) of the missing items are queued + 867 queued builds + x86_64-linux: 518 (59.7%) + i686-linux: 221 (25.5%) + aarch64-linux: 128 (14.8%) + build rate: 23.41 builds per hour + x86_64-linux: 11.16 builds per hour + i686-linux: 6.03 builds per hour + aarch64-linux: 6.41 builds per hour +@end example + +@cindex continuous integration, statistics +As you can see, it reports the fraction of all the packages for which +substitutes are available on the server---regardless of whether substitutes +are enabled, and regardless of whether this server's signing key is +authorized. It also reports the size of the compressed archives (``nars'') +provided by the server, the size the corresponding store items occupy in the +store (assuming deduplication is turned off), and the server's throughput. +The second part gives continuous integration (CI) statistics, if the server +supports it. + +To achieve that, @command{guix weather} queries over HTTP(S) meta-data +(@dfn{narinfos}) for all the relevant store items. Like @command{guix +challenge}, it ignores signatures on those substitutes, which is innocuous +since the command only gathers statistics and cannot install those +substitutes. + +Among other things, it is possible to query specific system types and +specific package sets. The available options are listed below. + +@table @code +@item --substitute-urls=@var{URLs} +@var{urls} is the space-separated list of substitute server URLs to query. +When this option is omitted, the default set of substitute servers is +queried. + +@item --system=@var{System} +@itemx -s @var{system} +Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This +option can be repeated, in which case @command{guix weather} will query +substitutes for several system types. + +@item --manifest=@var{Datei} +Instead of querying substitutes for all the packages, only ask for those +specified in @var{file}. @var{file} must contain a @dfn{manifest}, as with +the @code{-m} option of @command{guix package} (@pxref{Aufruf von guix package}). +@end table + +@node Invoking guix processes +@section Invoking @command{guix processes} + +The @command{guix processes} command can be useful to developers and system +administrators, especially on multi-user machines and on build farms: it +lists the current sessions (connections to the daemon), as well as +information about the processes involved@footnote{Remote sessions, when +@command{guix-daemon} is started with @option{--listen} specifying a TCP +endpoint, are @emph{not} listed.}. Here's an example of the information it +returns: + +@example +$ sudo guix processes +SessionPID: 19002 +ClientPID: 19090 +ClientCommand: guix environment --ad-hoc python + +SessionPID: 19402 +ClientPID: 19367 +ClientCommand: guix publish -u guix-publish -p 3000 -C 9 @dots{} + +SessionPID: 19444 +ClientPID: 19419 +ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{} +LockHeld: /gnu/store/@dots{}-perl-ipc-cmd-0.96.lock +LockHeld: /gnu/store/@dots{}-python-six-bootstrap-1.11.0.lock +LockHeld: /gnu/store/@dots{}-libjpeg-turbo-2.0.0.lock +ChildProcess: 20495: guix offload x86_64-linux 7200 1 28800 +ChildProcess: 27733: guix offload x86_64-linux 7200 1 28800 +ChildProcess: 27793: guix offload x86_64-linux 7200 1 28800 +@end example + +In this example we see that @command{guix-daemon} has three clients: +@command{guix environment}, @command{guix publish}, and the Cuirass +continuous integration tool; their process identifier (PID) is given by the +@code{ClientPID} field. The @code{SessionPID} field gives the PID of the +@command{guix-daemon} sub-process of this particular session. + +The @code{LockHeld} fields show which store items are currently locked by +this session, which corresponds to store items being built or substituted +(the @code{LockHeld} field is not displayed when @command{guix processes} is +not running as root.) Last, by looking at the @code{ChildProcess} field, we +understand that these three builds are being offloaded (@pxref{Auslagern des Daemons einrichten}). + +The output is in Recutils format so we can use the handy @command{recsel} +command to select sessions of interest (@pxref{Selection Expressions,,, +recutils, GNU recutils manual}). As an example, the command shows the +command line and PID of the client that triggered the build of a Perl +package: + +@example +$ sudo guix processes | \ + recsel -p ClientPID,ClientCommand -e 'LockHeld ~ "perl"' +ClientPID: 19419 +ClientCommand: cuirass --cache-directory /var/cache/cuirass @dots{} +@end example + +@c ********************************************************************* +@node GNU-Distribution +@chapter GNU-Distribution + +@cindex Guix System Distribution +@cindex GuixSD +Guix comes with a distribution of the GNU system consisting entirely of free +software@footnote{The term ``free'' here refers to the +@url{http://www.gnu.org/philosophy/free-sw.html,freedom provided to users of +that software}.}. The distribution can be installed on its own +(@pxref{Systeminstallation}), but it is also possible to install Guix as a +package manager on top of an installed GNU/Linux system +(@pxref{Installation}). To distinguish between the two, we refer to the +standalone distribution as the Guix System Distribution, or GuixSD. + +The distribution provides core GNU packages such as GNU libc, GCC, and +Binutils, as well as many GNU and non-GNU applications. The complete list +of available packages can be browsed +@url{http://www.gnu.org/software/guix/packages,on-line} or by running +@command{guix package} (@pxref{Aufruf von guix package}): + +@example +guix package --list-available +@end example + +Our goal is to provide a practical 100% free software distribution of +Linux-based and other variants of GNU, with a focus on the promotion and +tight integration of GNU components, and an emphasis on programs and tools +that help users exert that freedom. + +Packages are currently available on the following platforms: + +@table @code + +@item x86_64-linux +Intel/AMD @code{x86_64} architecture, Linux-Libre kernel; + +@item i686-linux +Intel 32-bit architecture (IA32), Linux-Libre kernel; + +@item armhf-linux +ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI +hard-float application binary interface (ABI), and Linux-Libre kernel. + +@item aarch64-linux +little-endian 64-bit ARMv8-A processors, Linux-Libre kernel. This is +currently in an experimental stage, with limited support. +@xref{Mitwirken}, for how to help! + +@item mips64el-linux +little-endian 64-bit MIPS processors, specifically the Loongson series, n32 +ABI, and Linux-Libre kernel. + +@end table + +GuixSD itself is currently only available on @code{i686} and @code{x86_64}. + +@noindent +For information on porting to other architectures or kernels, +@pxref{Portierung}. + +@menu +* Systeminstallation:: Das ganze Betriebssystem installieren. +* Systemkonfiguration:: Das Betriebssystem konfigurieren. +* Dokumentation:: Wie man Nutzerhandbücher von Software liest. +* Dateien zur Fehlersuche installieren:: Womit man seinen Debugger + füttert. +* Sicherheitsaktualisierungen:: Sicherheits-Patches schnell einspielen. +* Paketmodule:: Pakete aus Sicht des Programmierers. +* Paketrichtlinien:: Die Distribution wachsen lassen. +* Bootstrapping:: GNU/Linux von Grund auf selbst erstellen. +* Portierung:: Guix auf andere Plattformen und Kernels + bringen. +@end menu + +Building this distribution is a cooperative effort, and you are invited to +join! @xref{Mitwirken}, for information about how you can help. + +@node Systeminstallation +@section Systeminstallation + +@cindex installing GuixSD +@cindex Guix System Distribution +This section explains how to install the Guix System Distribution (GuixSD) +on a machine. The Guix package manager can also be installed on top of a +running GNU/Linux system, @pxref{Installation}. + +@ifinfo +@quotation Anmerkung +@c This paragraph is for people reading this from tty2 of the +@c installation image. +You are reading this documentation with an Info reader. For details on how +to use it, hit the @key{RET} key (``return'' or ``enter'') on the link that +follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}. Hit +@kbd{l} afterwards to come back here. + +Alternately, run @command{info info} in another tty to keep the manual +available. +@end quotation +@end ifinfo + +@menu +* Einschränkungen:: Was Sie erwarten dürfen. +* Hardware-Überlegungen:: Unterstützte Hardware. +* Installation von USB-Stick oder DVD:: Das Installationsmedium + vorbereiten. +* Vor der Installation:: Netzwerkanbindung, Partitionierung etc. +* Fortfahren mit der Installation:: Die Hauptsache. +* GuixSD in einer VM installieren:: Ein GuixSD-Spielplatz. +* Ein Abbild zur Installation erstellen:: Wie ein solches entsteht. +@end menu + +@node Einschränkungen +@subsection Einschränkungen + +As of version @value{VERSION}, the Guix System Distribution (GuixSD) is not +production-ready. It may contain bugs and lack important features. Thus, +if you are looking for a stable production system that respects your freedom +as a computer user, a good solution at this point is to consider +@url{http://www.gnu.org/distros/free-distros.html, one of the more +established GNU/Linux distributions}. We hope you can soon switch to the +GuixSD without fear, of course. In the meantime, you can also keep using +your distribution and try out the package manager on top of it +(@pxref{Installation}). + +Before you proceed with the installation, be aware of the following +noteworthy limitations applicable to version @value{VERSION}: + +@itemize +@item +The installation process does not include a graphical user interface and +requires familiarity with GNU/Linux (see the following subsections to get a +feel of what that means.) + +@item +Support for the Logical Volume Manager (LVM) is missing. + +@item +More and more system services are provided (@pxref{Dienste}), but some may +be missing. + +@item +More than 7,500 packages are available, but you might occasionally find that +a useful package is missing. + +@item +GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop-Dienste}), as well as a number of X11 window managers. However, some +graphical applications may be missing, as well as KDE. +@end itemize + +You have been warned! But more than a disclaimer, this is an invitation to +report issues (and success stories!), and to join us in improving it. +@xref{Mitwirken}, for more info. + + +@node Hardware-Überlegungen +@subsection Hardware-Überlegungen + +@cindex hardware support on GuixSD +GNU@tie{}GuixSD focuses on respecting the user's computing freedom. It +builds around the kernel Linux-libre, which means that only hardware for +which free software drivers and firmware exist is supported. Nowadays, a +wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from +keyboards to graphics cards to scanners and Ethernet controllers. +Unfortunately, there are still areas where hardware vendors deny users +control over their own computing, and such hardware is not supported on +GuixSD. + +@cindex WiFi, hardware support +One of the main areas where free drivers or firmware are lacking is WiFi +devices. WiFi devices known to work include those using Atheros chips +(AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre +driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core +Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. +Free firmware exists for both and is available out-of-the-box on GuixSD, as +part of @var{%base-firmware} (@pxref{„operating-system“-Referenz, +@code{firmware}}). + +@cindex RYF, Respects Your Freedom +The @uref{https://www.fsf.org/, Free Software Foundation} runs +@uref{https://www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a +certification program for hardware products that respect your freedom and +your privacy and ensure that you have control over your device. We +encourage you to check the list of RYF-certified devices. + +Another useful resource is the @uref{https://www.h-node.org/, H-Node} web +site. It contains a catalog of hardware devices with information about +their support in GNU/Linux. + + +@node Installation von USB-Stick oder DVD +@subsection Installation von USB-Stick oder DVD + +An ISO-9660 installation image that can be written to a USB stick or burnt +to a DVD can be downloaded from +@indicateurl{https://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.iso.xz}, +where @var{system} is one of: + +@table @code +@item x86_64-linux +for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs; + +@item i686-linux +for a 32-bit GNU/Linux system on Intel-compatible CPUs. +@end table + +@c start duplication of authentication part from ``Binary Installation'' +Make sure to download the associated @file{.sig} file and to verify the +authenticity of the image against it, along these lines: + +@example +$ wget https://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig +$ gpg --verify guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig +@end example + +Falls dieser Befehl fehlschlägt, weil Sie nicht über den nötigen +öffentlichen Schlüssel verfügen, können Sie ihn mit diesem Befehl +importieren: + +@example +$ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID} +@end example + +@noindent +@c end duplication +und den Befehl @code{gpg --verify} erneut ausführen. + +This image contains the tools necessary for an installation. It is meant to +be copied @emph{as is} to a large-enough USB stick or DVD. + +@unnumberedsubsubsec Copying to a USB Stick + +To copy the image to a USB stick, follow these steps: + +@enumerate +@item +Decompress the image using the @command{xz} command: + +@example +xz -d guixsd-install-@value{VERSION}.@var{system}.iso.xz +@end example + +@item +Insert a USB stick of 1@tie{}GiB or more into your machine, and determine +its device name. Assuming that the USB stick is known as @file{/dev/sdX}, +copy the image with: + +@example +dd if=guixsd-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX +sync +@end example + +Access to @file{/dev/sdX} usually requires root privileges. +@end enumerate + +@unnumberedsubsubsec Burning on a DVD + +To copy the image to a DVD, follow these steps: + +@enumerate +@item +Decompress the image using the @command{xz} command: + +@example +xz -d guixsd-install-@value{VERSION}.@var{system}.iso.xz +@end example + +@item +Insert a blank DVD into your machine, and determine its device name. +Assuming that the DVD drive is known as @file{/dev/srX}, copy the image +with: + +@example +growisofs -dvd-compat -Z /dev/srX=guixsd-install-@value{VERSION}.x86_64.iso +@end example + +Access to @file{/dev/srX} usually requires root privileges. +@end enumerate + +@unnumberedsubsubsec Booting + +Once this is done, you should be able to reboot the system and boot from the +USB stick or DVD. The latter usually requires you to get in the BIOS or +UEFI boot menu, where you can choose to boot from the USB stick. + +@xref{GuixSD in einer VM installieren}, if, instead, you would like to install +GuixSD in a virtual machine (VM). + + +@node Vor der Installation +@subsection Vor der Installation + +Once you have successfully booted your computer using the installation +medium, you should end up with a root prompt. Several console TTYs are +configured and can be used to run commands as root. TTY2 shows this +documentation, browsable using the Info reader commands (@pxref{Top,,, +info-stnd, Stand-alone GNU Info}). The installation system runs the GPM +mouse daemon, which allows you to select text with the left mouse button and +to paste it with the middle button. + +@quotation Anmerkung +Installation requires access to the Internet so that any missing +dependencies of your system configuration can be downloaded. See the +``Networking'' section below. +@end quotation + +The installation system includes many common tools needed for this task. +But it is also a full-blown GuixSD system, which means that you can install +additional packages, should you need it, using @command{guix package} +(@pxref{Aufruf von guix package}). + +@subsubsection Keyboard Layout + +@cindex keyboard layout +The installation image uses the US qwerty keyboard layout. If you want to +change it, you can use the @command{loadkeys} command. For example, the +following command selects the Dvorak keyboard layout: + +@example +loadkeys dvorak +@end example + +See the files under @file{/run/current-system/profile/share/keymaps} for a +list of available keyboard layouts. Run @command{man loadkeys} for more +information. + +@subsubsection Networking + +Run the following command to see what your network interfaces are called: + +@example +ifconfig -a +@end example + +@noindent +@dots{} or, using the GNU/Linux-specific @command{ip} command: + +@example +ip a +@end example + +@c http://cgit.freedesktop.org/systemd/systemd/tree/src/udev/udev-builtin-net_id.c#n20 +Wired interfaces have a name starting with @samp{e}; for example, the +interface corresponding to the first on-board Ethernet controller is called +@samp{eno1}. Wireless interfaces have a name starting with @samp{w}, like +@samp{w1p2s0}. + +@table @asis +@item Wired connection +To configure a wired network run the following command, substituting +@var{interface} with the name of the wired interface you want to use. + +@example +ifconfig @var{interface} up +@end example + +@item Wireless connection +@cindex wireless +@cindex WiFi +To configure wireless networking, you can create a configuration file for +the @command{wpa_supplicant} configuration tool (its location is not +important) using one of the available text editors such as @command{nano}: + +@example +nano wpa_supplicant.conf +@end example + +As an example, the following stanza can go to this file and will work for +many wireless networks, provided you give the actual SSID and passphrase for +the network you are connecting to: + +@example +network=@{ + ssid="@var{my-ssid}" + key_mgmt=WPA-PSK + psk="the network's secret passphrase" +@} +@end example + +Start the wireless service and run it in the background with the following +command (substitute @var{interface} with the name of the network interface +you want to use): + +@example +wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B +@end example + +Run @command{man wpa_supplicant} for more information. +@end table + +@cindex DHCP +At this point, you need to acquire an IP address. On a network where IP +addresses are automatically assigned @i{via} DHCP, you can run: + +@example +dhclient -v @var{interface} +@end example + +Try to ping a server to see if networking is up and running: + +@example +ping -c 3 gnu.org +@end example + +Setting up network access is almost always a requirement because the image +does not contain all the software and tools that may be needed. + +@cindex installing over SSH +If you want to, you can continue the installation remotely by starting an +SSH server: + +@example +herd start ssh-daemon +@end example + +Make sure to either set a password with @command{passwd}, or configure +OpenSSH public key authentication before logging in. + +@subsubsection Disk Partitioning + +Unless this has already been done, the next step is to partition, and then +format the target partition(s). + +The installation image includes several partitioning tools, including Parted +(@pxref{Overview,,, parted, GNU Parted User Manual}), @command{fdisk}, and +@command{cfdisk}. Run it and set up your disk with the partition layout you +want: + +@example +cfdisk +@end example + +If your disk uses the GUID Partition Table (GPT) format and you plan to +install BIOS-based GRUB (which is the default), make sure a BIOS Boot +Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB manual}). + +@cindex EFI, installation +@cindex UEFI, installation +@cindex ESP, EFI system partition +If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System +Partition} (ESP) is required. This partition should be mounted at +@file{/boot/efi} and must have the @code{esp} flag set. E.g., for +@command{parted}: + +@example +parted /dev/sda set 1 esp on +@end example + +@quotation Anmerkung +@vindex grub-bootloader +@vindex grub-efi-bootloader +Unsure whether to use EFI- or BIOS-based GRUB? If the directory +@file{/sys/firmware/efi} exists in the installation image, then you should +probably perform an EFI installation, using @code{grub-efi-bootloader}. +Otherwise you should use the BIOS-based GRUB, known as +@code{grub-bootloader}. @xref{Bootloader-Konfiguration}, for more info on +bootloaders. +@end quotation + +Once you are done partitioning the target hard disk drive, you have to +create a file system on the relevant partition(s)@footnote{Currently GuixSD +only supports ext4 and btrfs file systems. In particular, code that reads +file system UUIDs and labels only works for these file system types.}. For +the ESP, if you have one and assuming it is @file{/dev/sda1}, run: + +@example +mkfs.fat -F32 /dev/sda1 +@end example + +Preferably, assign file systems a label so that you can easily and reliably +refer to them in @code{file-system} declarations (@pxref{Dateisysteme}). +This is typically done using the @code{-L} option of @command{mkfs.ext4} and +related commands. So, assuming the target root partition lives at +@file{/dev/sda2}, a file system with the label @code{my-root} can be created +with: + +@example +mkfs.ext4 -L my-root /dev/sda2 +@end example + +@cindex encrypted disk +If you are instead planning to encrypt the root partition, you can use the +Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, +@uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, +@code{man cryptsetup}} for more information.) Assuming you want to store +the root partition on @file{/dev/sda2}, the command sequence would be along +these lines: + +@example +cryptsetup luksFormat /dev/sda2 +cryptsetup open --type luks /dev/sda2 my-partition +mkfs.ext4 -L my-root /dev/mapper/my-partition +@end example + +Once that is done, mount the target file system under @file{/mnt} with a +command like (again, assuming @code{my-root} is the label of the root file +system): + +@example +mount LABEL=my-root /mnt +@end example + +Also mount any other file systems you would like to use on the target system +relative to this path. If you have @file{/boot} on a separate partition for +example, mount it at @file{/mnt/boot} now so it is found by @code{guix +system init} afterwards. + +Finally, if you plan to use one or more swap partitions (@pxref{Memory +Concepts, swap space,, libc, The GNU C Library Reference Manual}), make sure +to initialize them with @command{mkswap}. Assuming you have one swap +partition on @file{/dev/sda3}, you would run: + +@example +mkswap /dev/sda3 +swapon /dev/sda3 +@end example + +Alternatively, you may use a swap file. For example, assuming that in the +new system you want to use the file @file{/swapfile} as a swap file, you +would run@footnote{This example will work for many types of file systems +(e.g., ext4). However, for copy-on-write file systems (e.g., btrfs), the +required steps may be different. For details, see the manual pages for +@command{mkswap} and @command{swapon}.}: + +@example +# This is 10 GiB of swap space. Adjust "count" to change the size. +dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240 +# For security, make the file readable and writable only by root. +chmod 600 /mnt/swapfile +mkswap /mnt/swapfile +swapon /mnt/swapfile +@end example + +Note that if you have encrypted the root partition and created a swap file +in its file system as described above, then the encryption also protects the +swap file, just like any other file in that file system. + +@node Fortfahren mit der Installation +@subsection Fortfahren mit der Installation + +With the target partitions ready and the target root mounted on @file{/mnt}, +we're ready to go. First, run: + +@example +herd start cow-store /mnt +@end example + +This makes @file{/gnu/store} copy-on-write, such that packages added to it +during the installation phase are written to the target disk on @file{/mnt} +rather than kept in memory. This is necessary because the first phase of +the @command{guix system init} command (see below) entails downloads or +builds to @file{/gnu/store} which, initially, is an in-memory file system. + +Next, you have to edit a file and provide the declaration of the operating +system to be installed. To that end, the installation system comes with +three text editors. We recommend GNU nano (@pxref{Top,,, nano, GNU nano +Manual}), which supports syntax highlighting and parentheses matching; other +editors include GNU Zile (an Emacs clone), and nvi (a clone of the original +BSD @command{vi} editor). We strongly recommend storing that file on the +target root file system, say, as @file{/mnt/etc/config.scm}. Failing to do +that, you will have lost your configuration file once you have rebooted into +the newly-installed system. + +@xref{Das Konfigurationssystems nutzen}, for an overview of the configuration +file. The example configurations discussed in that section are available +under @file{/etc/configuration} in the installation image. Thus, to get +started with a system configuration providing a graphical display server (a +``desktop'' system), you can run something along these lines: + +@example +# mkdir /mnt/etc +# cp /etc/configuration/desktop.scm /mnt/etc/config.scm +# nano /mnt/etc/config.scm +@end example + +You should pay attention to what your configuration file contains, and in +particular: + +@itemize +@item +Make sure the @code{bootloader-configuration} form refers to the target you +want to install GRUB on. It should mention @code{grub-bootloader} if you +are installing GRUB in the legacy way, or @code{grub-efi-bootloader} for +newer UEFI systems. For legacy systems, the @code{target} field names a +device, like @code{/dev/sda}; for UEFI systems it names a path to a mounted +EFI partition, like @code{/boot/efi}, and do make sure the path is actually +mounted. + +@item +Be sure that your file system labels match the value of their respective +@code{device} fields in your @code{file-system} configuration, assuming your +@code{file-system} configuration uses the @code{file-system-label} procedure +in its @code{device} field. + +@item +If there are encrypted or RAID partitions, make sure to add a +@code{mapped-devices} field to describe them (@pxref{Abgebildete Geräte}). +@end itemize + +Once you are done preparing the configuration file, the new system must be +initialized (remember that the target root file system is mounted under +@file{/mnt}): + +@example +guix system init /mnt/etc/config.scm /mnt +@end example + +@noindent +This copies all the necessary files and installs GRUB on @file{/dev/sdX}, +unless you pass the @option{--no-bootloader} option. For more information, +@pxref{Aufruf von guix system}. This command may trigger downloads or builds +of missing packages, which can take some time. + +Once that command has completed---and hopefully succeeded!---you can run +@command{reboot} and boot into the new system. The @code{root} password in +the new system is initially empty; other users' passwords need to be +initialized by running the @command{passwd} command as @code{root}, unless +your configuration specifies otherwise (@pxref{user-account-password, user +account passwords}). + +@cindex upgrading GuixSD +From then on, you can update GuixSD whenever you want by running +@command{guix pull} as @code{root} (@pxref{Aufruf von guix pull}), and then +running @command{guix system reconfigure} to build a new system generation +with the latest packages and services (@pxref{Aufruf von guix system}). We +recommend doing that regularly so that your system includes the latest +security updates (@pxref{Sicherheitsaktualisierungen}). + +Join us on @code{#guix} on the Freenode IRC network or on +@file{guix-devel@@gnu.org} to share your experience---good or not so good. + +@node GuixSD in einer VM installieren +@subsection Installing GuixSD in a Virtual Machine + +@cindex virtual machine, GuixSD installation +@cindex virtual private server (VPS) +@cindex VPS (virtual private server) +If you'd like to install GuixSD in a virtual machine (VM) or on a virtual +private server (VPS) rather than on your beloved machine, this section is +for you. + +To boot a @uref{http://qemu.org/,QEMU} VM for installing GuixSD in a disk +image, follow these steps: + +@enumerate +@item +First, retrieve and decompress the GuixSD installation image as described +previously (@pxref{Installation von USB-Stick oder DVD}). + +@item +Create a disk image that will hold the installed system. To make a +qcow2-formatted disk image, use the @command{qemu-img} command: + +@example +qemu-img create -f qcow2 guixsd.img 50G +@end example + +The resulting file will be much smaller than 50 GB (typically less than 1 +MB), but it will grow as the virtualized storage device is filled up. + +@item +Boot the USB installation image in an VM: + +@example +qemu-system-x86_64 -m 1024 -smp 1 \ + -net user -net nic,model=virtio -boot menu=on \ + -drive file=guixsd-install-@value{VERSION}.@var{system}.iso \ + -drive file=guixsd.img +@end example + +The ordering of the drives matters. + +In the VM console, quickly press the @kbd{F12} key to enter the boot menu. +Then press the @kbd{2} key and the @kbd{RET} key to validate your selection. + +@item +You're now root in the VM, proceed with the installation process. +@xref{Vor der Installation}, and follow the instructions. +@end enumerate + +Once installation is complete, you can boot the system that's on your +@file{guixsd.img} image. @xref{GuixSD in einer VM starten}, for how to do that. + +@node Ein Abbild zur Installation erstellen +@subsection Ein Abbild zur Installation erstellen + +@cindex installation image +The installation image described above was built using the @command{guix +system} command, specifically: + +@example +guix system disk-image gnu/system/install.scm +@end example + +Have a look at @file{gnu/system/install.scm} in the source tree, and see +also @ref{Aufruf von guix system} for more information about the installation +image. + +@subsection Building the Installation Image for ARM Boards + +Many ARM boards require a specific variant of the +@uref{http://www.denx.de/wiki/U-Boot/, U-Boot} bootloader. + +If you build a disk image and the bootloader is not available otherwise (on +another boot drive etc), it's advisable to build an image that includes the +bootloader, specifically: + +@example +guix system disk-image --system=armhf-linux -e '((@@ (gnu system install) os-with-u-boot) (@@ (gnu system install) installation-os) "A20-OLinuXino-Lime2")' +@end example + +@code{A20-OLinuXino-Lime2} is the name of the board. If you specify an +invalid board, a list of possible boards will be printed. + +@node Systemkonfiguration +@section Systemkonfiguration + +@cindex system configuration +The Guix System Distribution supports a consistent whole-system +configuration mechanism. By that we mean that all aspects of the global +system configuration---such as the available system services, timezone and +locale settings, user accounts---are declared in a single place. Such a +@dfn{system configuration} can be @dfn{instantiated}---i.e., effected. + +@c Yes, we're talking of Puppet, Chef, & co. here. ↑ +One of the advantages of putting all the system configuration under the +control of Guix is that it supports transactional system upgrades, and makes +it possible to roll back to a previous system instantiation, should +something go wrong with the new one (@pxref{Funktionalitäten}). Another advantage +is that it makes it easy to replicate the exact same configuration across +different machines, or at different points in time, without having to resort +to additional administration tools layered on top of the own tools of the +system. + +This section describes this mechanism. First we focus on the system +administrator's viewpoint---explaining how the system is configured and +instantiated. Then we show how this mechanism can be extended, for instance +to support new system services. + +@menu +* Das Konfigurationssystems nutzen:: Ihr GNU-System anpassen +* „operating-system“-Referenz:: Details der + Betriebssystem-Deklarationen. +* Dateisysteme:: Die Dateisystemeinbindungen konfigurieren. +* Abgebildete Geräte:: Zusatzverarbeitungsschritte für blockbasierte + Geräte. +* Benutzerkonten:: Benutzerkonten festlegen. +* Locales:: Sprach- und kulturelle + Konventionseinstellungen. +* Dienste:: Systemdienste festlegen. +* Setuid-Programme:: Programme mit Administratorrechten ausführen +* X.509-Zertifikate:: HTTPS-Server authentifizieren. +* Name Service Switch:: Den Name Service Switch von libc konfigurieren. +* Initiale RAM-Disk:: Linux-libre hochfahren. +* Bootloader-Konfiguration:: Den Bootloader konfigurieren. +* Aufruf von guix system:: Instanzierung einer Systemkonfiguration +* GuixSD in einer VM starten:: Wie man GuixSD in einer virtuellen Maschine + startet. +* Dienste definieren:: Neue Dienstdefinitionen hinzufügen. +@end menu + +@node Das Konfigurationssystems nutzen +@subsection Das Konfigurationssystems nutzen + +The operating system is configured by providing an @code{operating-system} +declaration in a file that can then be passed to the @command{guix system} +command (@pxref{Aufruf von guix system}). A simple setup, with the default +system services, the default Linux-Libre kernel, initial RAM disk, and boot +loader looks like this: + +@findex operating-system +@lisp +@include os-config-bare-bones.texi +@end lisp + +This example should be self-describing. Some of the fields defined above, +such as @code{host-name} and @code{bootloader}, are mandatory. Others, such +as @code{packages} and @code{services}, can be omitted, in which case they +get a default value. + +Below we discuss the effect of some of the most important fields +(@pxref{„operating-system“-Referenz}, for details about all the available +fields), and how to @dfn{instantiate} the operating system using +@command{guix system}. + +@unnumberedsubsubsec Bootloader + +@cindex legacy boot, on Intel machines +@cindex BIOS boot, on Intel machines +@cindex UEFI boot +@cindex EFI boot +The @code{bootloader} field describes the method that will be used to boot +your system. Machines based on Intel processors can boot in ``legacy'' BIOS +mode, as in the example above. However, more recent machines rely instead +on the @dfn{Unified Extensible Firmware Interface} (UEFI) to boot. In that +case, the @code{bootloader} field should contain something along these +lines: + +@example +(bootloader-configuration + (bootloader grub-efi-bootloader) + (target "/boot/efi")) +@end example + +@xref{Bootloader-Konfiguration}, for more information on the available +configuration options. + +@unnumberedsubsubsec Globally-Visible Packages + +@vindex %base-packages +The @code{packages} field lists packages that will be globally visible on +the system, for all user accounts---i.e., in every user's @code{PATH} +environment variable---in addition to the per-user profiles (@pxref{Aufruf von guix package}). The @var{%base-packages} variable provides all the tools +one would expect for basic user and administrator tasks---including the GNU +Core Utilities, the GNU Networking Utilities, the GNU Zile lightweight text +editor, @command{find}, @command{grep}, etc. The example above adds +GNU@tie{}Screen and OpenSSH to those, taken from the @code{(gnu packages +screen)} and @code{(gnu packages ssh)} modules (@pxref{Paketmodule}). +The @code{(list package output)} syntax can be used to add a specific output +of a package: + +@lisp +(use-modules (gnu packages)) +(use-modules (gnu packages dns)) + +(operating-system + ;; ... + (packages (cons (list bind "utils") + %base-packages))) +@end lisp + +@findex specification->package +Referring to packages by variable name, like @code{bind} above, has the +advantage of being unambiguous; it also allows typos and such to be +diagnosed right away as ``unbound variables''. The downside is that one +needs to know which module defines which package, and to augment the +@code{use-package-modules} line accordingly. To avoid that, one can use the +@code{specification->package} procedure of the @code{(gnu packages)} module, +which returns the best package for a given name or name and version: + +@lisp +(use-modules (gnu packages)) + +(operating-system + ;; ... + (packages (append (map specification->package + '("tcpdump" "htop" "gnupg@@2.0")) + %base-packages))) +@end lisp + +@unnumberedsubsubsec System Services + +@cindex services +@vindex %base-services +The @code{services} field lists @dfn{system services} to be made available +when the system starts (@pxref{Dienste}). The @code{operating-system} +declaration above specifies that, in addition to the basic services, we want +the @command{lshd} secure shell daemon listening on port 2222 +(@pxref{Netzwerkdienste, @code{lsh-service}}). Under the hood, +@code{lsh-service} arranges so that @code{lshd} is started with the right +command-line options, possibly with supporting configuration files generated +as needed (@pxref{Dienste definieren}). + +@cindex customization, of services +@findex modify-services +Occasionally, instead of using the base services as is, you will want to +customize them. To do this, use @code{modify-services} (@pxref{Service-Referenz, @code{modify-services}}) to modify the list. + +For example, suppose you want to modify @code{guix-daemon} and Mingetty (the +console log-in) in the @var{%base-services} list (@pxref{Basisdienste, +@code{%base-services}}). To do that, you can write the following in your +operating system declaration: + +@lisp +(define %my-services + ;; My very own list of services. + (modify-services %base-services + (guix-service-type config => + (guix-configuration + (inherit config) + (use-substitutes? #f) + (extra-options '("--gc-keep-derivations")))) + (mingetty-service-type config => + (mingetty-configuration + (inherit config))))) + +(operating-system + ;; @dots{} + (services %my-services)) +@end lisp + +This changes the configuration---i.e., the service parameters---of the +@code{guix-service-type} instance, and that of all the +@code{mingetty-service-type} instances in the @var{%base-services} list. +Observe how this is accomplished: first, we arrange for the original +configuration to be bound to the identifier @code{config} in the @var{body}, +and then we write the @var{body} so that it evaluates to the desired +configuration. In particular, notice how we use @code{inherit} to create a +new configuration which has the same values as the old configuration, but +with a few modifications. + +@cindex encrypted disk +The configuration for a typical ``desktop'' usage, with an encrypted root +partition, the X11 display server, GNOME and Xfce (users can choose which of +these desktop environments to use at the log-in screen by pressing +@kbd{F1}), network management, power management, and more, would look like +this: + +@lisp +@include os-config-desktop.texi +@end lisp + +A graphical system with a choice of lightweight window managers instead of +full-blown desktop environments would look like this: + +@lisp +@include os-config-lightweight-desktop.texi +@end lisp + +This example refers to the @file{/boot/efi} file system by its UUID, +@code{1234-ABCD}. Replace this UUID with the right UUID on your system, as +returned by the @command{blkid} command. + +@xref{Desktop-Dienste}, for the exact list of services provided by +@var{%desktop-services}. @xref{X.509-Zertifikate}, for background +information about the @code{nss-certs} package that is used here. + +Again, @var{%desktop-services} is just a list of service objects. If you +want to remove services from there, you can do so using the procedures for +list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile +Reference Manual}). For instance, the following expression returns a list +that contains all the services in @var{%desktop-services} minus the Avahi +service: + +@example +(remove (lambda (service) + (eq? (service-kind service) avahi-service-type)) + %desktop-services) +@end example + +@unnumberedsubsubsec Instantiating the System + +Assuming the @code{operating-system} declaration is stored in the +@file{my-system-config.scm} file, the @command{guix system reconfigure +my-system-config.scm} command instantiates that configuration, and makes it +the default GRUB boot entry (@pxref{Aufruf von guix system}). + +The normal way to change the system configuration is by updating this file +and re-running @command{guix system reconfigure}. One should never have to +touch files in @file{/etc} or to run commands that modify the system state +such as @command{useradd} or @command{grub-install}. In fact, you must +avoid that since that would not only void your warranty but also prevent you +from rolling back to previous versions of your system, should you ever need +to. + +@cindex roll-back, of the operating system +Speaking of roll-back, each time you run @command{guix system reconfigure}, +a new @dfn{generation} of the system is created---without modifying or +deleting previous generations. Old system generations get an entry in the +bootloader boot menu, allowing you to boot them in case something went wrong +with the latest generation. Reassuring, no? The @command{guix system +list-generations} command lists the system generations available on disk. +It is also possible to roll back the system via the commands @command{guix +system roll-back} and @command{guix system switch-generation}. + +Although the @command{guix system reconfigure} command will not modify +previous generations, you must take care when the current generation is not +the latest (e.g., after invoking @command{guix system roll-back}), since the +operation might overwrite a later generation (@pxref{Aufruf von guix system}). + +@unnumberedsubsubsec The Programming Interface + +At the Scheme level, the bulk of an @code{operating-system} declaration is +instantiated with the following monadic procedure (@pxref{Die Store-Monade}): + +@deffn {Monadic Procedure} operating-system-derivation os +Return a derivation that builds @var{os}, an @code{operating-system} object +(@pxref{Ableitungen}). + +The output of the derivation is a single directory that refers to all the +packages, configuration files, and other supporting files needed to +instantiate @var{os}. +@end deffn + +This procedure is provided by the @code{(gnu system)} module. Along with +@code{(gnu services)} (@pxref{Dienste}), this module contains the guts of +GuixSD. Make sure to visit it! + + +@node „operating-system“-Referenz +@subsection @code{operating-system} Reference + +This section summarizes all the options available in @code{operating-system} +declarations (@pxref{Das Konfigurationssystems nutzen}). + +@deftp {Data Type} operating-system +This is the data type representing an operating system configuration. By +that, we mean all the global system configuration, not per-user +configuration (@pxref{Das Konfigurationssystems nutzen}). + +@table @asis +@item @code{kernel} (default: @var{linux-libre}) +The package object of the operating system kernel to use@footnote{Currently +only the Linux-libre kernel is supported. In the future, it will be +possible to use the GNU@tie{}Hurd.}. + +@item @code{kernel-arguments} (default: @code{'()}) +List of strings or gexps representing additional arguments to pass on the +command-line of the kernel---e.g., @code{("console=ttyS0")}. + +@item @code{bootloader} +The system bootloader configuration object. @xref{Bootloader-Konfiguration}. + +@item @code{initrd-modules} (default: @code{%base-initrd-modules}) +@cindex initrd +@cindex initial RAM disk +The list of Linux kernel modules that need to be available in the initial +RAM disk. @xref{Initiale RAM-Disk}. + +@item @code{initrd} (default: @code{base-initrd}) +A monadic procedure that returns an initial RAM disk for the Linux kernel. +This field is provided to support low-level customization and should rarely +be needed for casual use. @xref{Initiale RAM-Disk}. + +@item @code{firmware} (default: @var{%base-firmware}) +@cindex firmware +List of firmware packages loadable by the operating system kernel. + +The default includes firmware needed for Atheros- and Broadcom-based WiFi +devices (Linux-libre modules @code{ath9k} and @code{b43-open}, +respectively). @xref{Hardware-Überlegungen}, for more info on supported +hardware. + +@item @code{host-name} +The host name. + +@item @code{hosts-file} +@cindex hosts file +A file-like object (@pxref{G-Ausdrücke, file-like objects}) for use as +@file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference +Manual}). The default is a file with entries for @code{localhost} and +@var{host-name}. + +@item @code{mapped-devices} (default: @code{'()}) +A list of mapped devices. @xref{Abgebildete Geräte}. + +@item @code{file-systems} +A list of file systems. @xref{Dateisysteme}. + +@item @code{swap-devices} (default: @code{'()}) +@cindex swap devices +A list of strings identifying devices or files to be used for ``swap space'' +(@pxref{Memory Concepts,,, libc, The GNU C Library Reference Manual}). For +example, @code{'("/dev/sda3")} or @code{'("/swapfile")}. It is possible to +specify a swap file in a file system on a mapped device, provided that the +necessary device mapping and file system are also specified. @xref{Abgebildete Geräte} and @ref{Dateisysteme}. + +@item @code{users} (default: @code{%base-user-accounts}) +@itemx @code{groups} (default: @var{%base-groups}) +List of user accounts and groups. @xref{Benutzerkonten}. + +If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' +account with UID@tie{}0 is automatically added. + +@item @code{skeletons} (default: @code{(default-skeletons)}) +A list target file name/file-like object tuples (@pxref{G-Ausdrücke, +file-like objects}). These are the skeleton files that will be added to the +home directory of newly-created user accounts. + +For instance, a valid value may look like this: + +@example +`((".bashrc" ,(plain-file "bashrc" "echo Hello\n")) + (".guile" ,(plain-file "guile" + "(use-modules (ice-9 readline)) + (activate-readline)"))) +@end example + +@item @code{issue} (default: @var{%default-issue}) +A string denoting the contents of the @file{/etc/issue} file, which is +displayed when users log in on a text console. + +@item @code{packages} (default: @var{%base-packages}) +The set of packages installed in the global profile, which is accessible at +@file{/run/current-system/profile}. + +The default set includes core utilities and it is good practice to install +non-core utilities in user profiles (@pxref{Aufruf von guix package}). + +@item @code{timezone} +A timezone identifying string---e.g., @code{"Europe/Paris"}. + +You can run the @command{tzselect} command to find out which timezone string +corresponds to your region. Choosing an invalid timezone name causes +@command{guix system} to fail. + +@item @code{locale} (default: @code{"en_US.utf8"}) +The name of the default locale (@pxref{Locale Names,,, libc, The GNU C +Library Reference Manual}). @xref{Locales}, for more information. + +@item @code{locale-definitions} (default: @var{%default-locale-definitions}) +The list of locale definitions to be compiled and that may be used at run +time. @xref{Locales}. + +@item @code{locale-libcs} (default: @code{(list @var{glibc})}) +The list of GNU@tie{}libc packages whose locale data and tools are used to +build the locale definitions. @xref{Locales}, for compatibility +considerations that justify this option. + +@item @code{name-service-switch} (default: @var{%default-nss}) +Configuration of the libc name service switch (NSS)---a +@code{<name-service-switch>} object. @xref{Name Service Switch}, for +details. + +@item @code{services} (default: @var{%base-services}) +A list of service objects denoting system services. @xref{Dienste}. + +@item @code{pam-services} (default: @code{(base-pam-services)}) +@cindex PAM +@cindex pluggable authentication modules +@c FIXME: Add xref to PAM services section. +Linux @dfn{pluggable authentication module} (PAM) services. + +@item @code{setuid-programs} (default: @var{%setuid-programs}) +List of string-valued G-expressions denoting setuid programs. @xref{Setuid-Programme}. + +@item @code{sudoers-file} (default: @var{%sudoers-specification}) +@cindex sudoers file +The contents of the @file{/etc/sudoers} file as a file-like object +(@pxref{G-Ausdrücke, @code{local-file} and @code{plain-file}}). + +This file specifies which users can use the @command{sudo} command, what +they are allowed to do, and what privileges they may gain. The default is +that only @code{root} and members of the @code{wheel} group may use +@code{sudo}. + +@end table +@end deftp + +@node Dateisysteme +@subsection Dateisysteme + +The list of file systems to be mounted is specified in the +@code{file-systems} field of the operating system declaration (@pxref{Das Konfigurationssystems nutzen}). Each file system is declared using the +@code{file-system} form, like this: + +@example +(file-system + (mount-point "/home") + (device "/dev/sda3") + (type "ext4")) +@end example + +As usual, some of the fields are mandatory---those shown in the example +above---while others can be omitted. These are described below. + +@deftp {Data Type} file-system +Objects of this type represent file systems to be mounted. They contain the +following members: + +@table @asis +@item @code{type} +This is a string specifying the type of the file system---e.g., +@code{"ext4"}. + +@item @code{mount-point} +This designates the place where the file system is to be mounted. + +@item @code{device} +This names the ``source'' of the file system. It can be one of three +things: a file system label, a file system UUID, or the name of a +@file{/dev} node. Labels and UUIDs offer a way to refer to file systems +without having to hard-code their actual device name@footnote{Note that, +while it is tempting to use @file{/dev/disk/by-uuid} and similar device +names to achieve the same result, this is not recommended: These special +device nodes are created by the udev daemon and may be unavailable at the +time the device is mounted.}. + +@findex file-system-label +File system labels are created using the @code{file-system-label} procedure, +UUIDs are created using @code{uuid}, and @file{/dev} node are plain +strings. Here's an example of a file system referred to by its label, as +shown by the @command{e2label} command: + +@example +(file-system + (mount-point "/home") + (type "ext4") + (device (file-system-label "my-home"))) +@end example + +@findex uuid +UUIDs are converted from their string representation (as shown by the +@command{tune2fs -l} command) using the @code{uuid} form@footnote{The +@code{uuid} form expects 16-byte UUIDs as defined in +@uref{https://tools.ietf.org/html/rfc4122, RFC@tie{}4122}. This is the form +of UUID used by the ext2 family of file systems and others, but it is +different from ``UUIDs'' found in FAT file systems, for instance.}, like +this: + +@example +(file-system + (mount-point "/home") + (type "ext4") + (device (uuid "4dab5feb-d176-45de-b287-9b0a6e4c01cb"))) +@end example + +When the source of a file system is a mapped device (@pxref{Abgebildete Geräte}), its @code{device} field @emph{must} refer to the mapped device +name---e.g., @file{"/dev/mapper/root-partition"}. This is required so that +the system knows that mounting the file system depends on having the +corresponding device mapping established. + +@item @code{flags} (default: @code{'()}) +This is a list of symbols denoting mount flags. Recognized flags include +@code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to +special files), @code{no-suid} (ignore setuid and setgid bits), and +@code{no-exec} (disallow program execution.) + +@item @code{options} (default: @code{#f}) +This is either @code{#f}, or a string denoting mount options. + +@item @code{mount?} (default: @code{#t}) +This value indicates whether to automatically mount the file system when the +system is brought up. When set to @code{#f}, the file system gets an entry +in @file{/etc/fstab} (read by the @command{mount} command) but is not +automatically mounted. + +@item @code{needed-for-boot?} (default: @code{#f}) +This Boolean value indicates whether the file system is needed when +booting. If that is true, then the file system is mounted when the initial +RAM disk (initrd) is loaded. This is always the case, for instance, for the +root file system. + +@item @code{check?} (default: @code{#t}) +This Boolean indicates whether the file system needs to be checked for +errors before being mounted. + +@item @code{create-mount-point?} (default: @code{#f}) +When true, the mount point is created if it does not exist yet. + +@item @code{dependencies} (default: @code{'()}) +This is a list of @code{<file-system>} or @code{<mapped-device>} objects +representing file systems that must be mounted or mapped devices that must +be opened before (and unmounted or closed after) this one. + +As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is a +dependency of @file{/sys/fs/cgroup/cpu} and @file{/sys/fs/cgroup/memory}. + +Another example is a file system that depends on a mapped device, for +example for an encrypted partition (@pxref{Abgebildete Geräte}). +@end table +@end deftp + +The @code{(gnu system file-systems)} exports the following useful variables. + +@defvr {Scheme Variable} %base-file-systems +These are essential file systems that are required on normal systems, such +as @var{%pseudo-terminal-file-system} and @var{%immutable-store} (see +below.) Operating system declarations should always contain at least these. +@end defvr + +@defvr {Scheme Variable} %pseudo-terminal-file-system +This is the file system to be mounted as @file{/dev/pts}. It supports +@dfn{pseudo-terminals} created @i{via} @code{openpty} and similar functions +(@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference Manual}). +Pseudo-terminals are used by terminal emulators such as @command{xterm}. +@end defvr + +@defvr {Scheme Variable} %shared-memory-file-system +This file system is mounted as @file{/dev/shm} and is used to support memory +sharing across processes (@pxref{Memory-mapped I/O, @code{shm_open},, libc, +The GNU C Library Reference Manual}). +@end defvr + +@defvr {Scheme Variable} %immutable-store +This file system performs a read-only ``bind mount'' of @file{/gnu/store}, +making it read-only for all the users including @code{root}. This prevents +against accidental modification by software running as @code{root} or by +system administrators. + +The daemon itself is still able to write to the store: it remounts it +read-write in its own ``name space.'' +@end defvr + +@defvr {Scheme Variable} %binary-format-file-system +The @code{binfmt_misc} file system, which allows handling of arbitrary +executable file types to be delegated to user space. This requires the +@code{binfmt.ko} kernel module to be loaded. +@end defvr + +@defvr {Scheme Variable} %fuse-control-file-system +The @code{fusectl} file system, which allows unprivileged users to mount and +unmount user-space FUSE file systems. This requires the @code{fuse.ko} +kernel module to be loaded. +@end defvr + +@node Abgebildete Geräte +@subsection Abgebildete Geräte + +@cindex device mapping +@cindex mapped devices +The Linux kernel has a notion of @dfn{device mapping}: a block device, such +as a hard disk partition, can be @dfn{mapped} into another device, usually +in @code{/dev/mapper/}, with additional processing over the data that flows +through it@footnote{Note that the GNU@tie{}Hurd makes no difference between +the concept of a ``mapped device'' and that of a file system: both boil down +to @emph{translating} input/output operations made on a file to operations +on its backing store. Thus, the Hurd implements mapped devices, like file +systems, using the generic @dfn{translator} mechanism (@pxref{Translators,,, +hurd, The GNU Hurd Reference Manual}).}. A typical example is encryption +device mapping: all writes to the mapped device are encrypted, and all reads +are deciphered, transparently. Guix extends this notion by considering any +device or set of devices that are @dfn{transformed} in some way to create a +new device; for instance, RAID devices are obtained by @dfn{assembling} +several other devices, such as hard disks or partitions, into a new one that +behaves as one partition. Other examples, not yet implemented, are LVM +logical volumes. + +Mapped devices are declared using the @code{mapped-device} form, defined as +follows; for examples, see below. + +@deftp {Data Type} mapped-device +Objects of this type represent device mappings that will be made when the +system boots up. + +@table @code +@item source +This is either a string specifying the name of the block device to be +mapped, such as @code{"/dev/sda3"}, or a list of such strings when several +devices need to be assembled for creating a new one. + +@item target +This string specifies the name of the resulting mapped device. For kernel +mappers such as encrypted devices of type @code{luks-device-mapping}, +specifying @code{"my-partition"} leads to the creation of the +@code{"/dev/mapper/my-partition"} device. For RAID devices of type +@code{raid-device-mapping}, the full device name such as @code{"/dev/md0"} +needs to be given. + +@item type +This must be a @code{mapped-device-kind} object, which specifies how +@var{source} is mapped to @var{target}. +@end table +@end deftp + +@defvr {Scheme Variable} luks-device-mapping +This defines LUKS block device encryption using the @command{cryptsetup} +command from the package with the same name. It relies on the +@code{dm-crypt} Linux kernel module. +@end defvr + +@defvr {Scheme Variable} raid-device-mapping +This defines a RAID device, which is assembled using the @code{mdadm} +command from the package with the same name. It requires a Linux kernel +module for the appropriate RAID level to be loaded, such as @code{raid456} +for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10. +@end defvr + +@cindex disk encryption +@cindex LUKS +The following example specifies a mapping from @file{/dev/sda3} to +@file{/dev/mapper/home} using LUKS---the +@url{https://gitlab.com/cryptsetup/cryptsetup,Linux Unified Key Setup}, a +standard mechanism for disk encryption. The @file{/dev/mapper/home} device +can then be used as the @code{device} of a @code{file-system} declaration +(@pxref{Dateisysteme}). + +@example +(mapped-device + (source "/dev/sda3") + (target "home") + (type luks-device-mapping)) +@end example + +Alternatively, to become independent of device numbering, one may obtain the +LUKS UUID (@dfn{unique identifier}) of the source device by a command like: + +@example +cryptsetup luksUUID /dev/sda3 +@end example + +and use it as follows: + +@example +(mapped-device + (source (uuid "cb67fc72-0d54-4c88-9d4b-b225f30b0f44")) + (target "home") + (type luks-device-mapping)) +@end example + +@cindex swap encryption +It is also desirable to encrypt swap space, since swap space may contain +sensitive data. One way to accomplish that is to use a swap file in a file +system on a device mapped via LUKS encryption. In this way, the swap file +is encrypted because the entire device is encrypted. @xref{Vor der Installation,,Disk Partitioning}, for an example. + +A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} +may be declared as follows: + +@example +(mapped-device + (source (list "/dev/sda1" "/dev/sdb1")) + (target "/dev/md0") + (type raid-device-mapping)) +@end example + +The @file{/dev/md0} device can then be used as the @code{device} of a +@code{file-system} declaration (@pxref{Dateisysteme}). Note that the RAID +level need not be given; it is chosen during the initial creation and +formatting of the RAID device and is determined automatically later. + + +@node Benutzerkonten +@subsection Benutzerkonten + +@cindex users +@cindex accounts +@cindex user accounts +User accounts and groups are entirely managed through the +@code{operating-system} declaration. They are specified with the +@code{user-account} and @code{user-group} forms: + +@example +(user-account + (name "alice") + (group "users") + (supplementary-groups '("wheel" ;allow use of sudo, etc. + "audio" ;sound card + "video" ;video devices such as webcams + "cdrom")) ;the good ol' CD-ROM + (comment "Bob's sister") + (home-directory "/home/alice")) +@end example + +When booting or upon completion of @command{guix system reconfigure}, the +system ensures that only the user accounts and groups specified in the +@code{operating-system} declaration exist, and with the specified +properties. Thus, account or group creations or modifications made by +directly invoking commands such as @command{useradd} are lost upon +reconfiguration or reboot. This ensures that the system remains exactly as +declared. + +@deftp {Data Type} user-account +Objects of this type represent user accounts. The following members may be +specified: + +@table @asis +@item @code{name} +The name of the user account. + +@item @code{group} +@cindex groups +This is the name (a string) or identifier (a number) of the user group this +account belongs to. + +@item @code{supplementary-groups} (default: @code{'()}) +Optionally, this can be defined as a list of group names that this account +belongs to. + +@item @code{uid} (default: @code{#f}) +This is the user ID for this account (a number), or @code{#f}. In the +latter case, a number is automatically chosen by the system when the account +is created. + +@item @code{comment} (default: @code{""}) +A comment about the account, such as the account owner's full name. + +@item @code{home-directory} +This is the name of the home directory for the account. + +@item @code{create-home-directory?} (default: @code{#t}) +Indicates whether the home directory of this account should be created if it +does not exist yet. + +@item @code{shell} (default: Bash) +This is a G-expression denoting the file name of a program to be used as the +shell (@pxref{G-Ausdrücke}). + +@item @code{system?} (default: @code{#f}) +This Boolean value indicates whether the account is a ``system'' account. +System accounts are sometimes treated specially; for instance, graphical +login managers do not list them. + +@anchor{user-account-password} +@item @code{password} (default: @code{#f}) +You would normally leave this field to @code{#f}, initialize user passwords +as @code{root} with the @command{passwd} command, and then let users change +it with @command{passwd}. Passwords set with @command{passwd} are of course +preserved across reboot and reconfiguration. + +If you @emph{do} want to have a preset password for an account, then this +field must contain the encrypted password, as a string. @xref{crypt,,, +libc, The GNU C Library Reference Manual}, for more information on password +encryption, and @ref{Encryption,,, guile, GNU Guile Reference Manual}, for +information on Guile's @code{crypt} procedure. + +@end table +@end deftp + +@cindex groups +User group declarations are even simpler: + +@example +(user-group (name "students")) +@end example + +@deftp {Data Type} user-group +This type is for, well, user groups. There are just a few fields: + +@table @asis +@item @code{name} +The name of the group. + +@item @code{id} (default: @code{#f}) +The group identifier (a number). If @code{#f}, a new number is +automatically allocated when the group is created. + +@item @code{system?} (default: @code{#f}) +This Boolean value indicates whether the group is a ``system'' group. +System groups have low numerical IDs. + +@item @code{password} (default: @code{#f}) +What, user groups can have a password? Well, apparently yes. Unless +@code{#f}, this field specifies the password of the group. + +@end table +@end deftp + +For convenience, a variable lists all the basic user groups one may expect: + +@defvr {Scheme Variable} %base-groups +This is the list of basic user groups that users and/or packages expect to +be present on the system. This includes groups such as ``root'', ``wheel'', +and ``users'', as well as groups used to control access to specific devices +such as ``audio'', ``disk'', and ``cdrom''. +@end defvr + +@defvr {Scheme Variable} %base-user-accounts +This is the list of basic system accounts that programs may expect to find +on a GNU/Linux system, such as the ``nobody'' account. + +Note that the ``root'' account is not included here. It is a special-case +and is automatically added whether or not it is specified. +@end defvr + +@node Locales +@subsection Locales + +@cindex locale +A @dfn{locale} defines cultural conventions for a particular language and +region of the world (@pxref{Locales,,, libc, The GNU C Library Reference +Manual}). Each locale has a name that typically has the form +@code{@var{language}_@var{territory}.@var{codeset}}---e.g., +@code{fr_LU.utf8} designates the locale for the French language, with +cultural conventions from Luxembourg, and using the UTF-8 encoding. + +@cindex locale definition +Usually, you will want to specify the default locale for the machine using +the @code{locale} field of the @code{operating-system} declaration +(@pxref{„operating-system“-Referenz, @code{locale}}). + +The selected locale is automatically added to the @dfn{locale definitions} +known to the system if needed, with its codeset inferred from its +name---e.g., @code{bo_CN.utf8} will be assumed to use the @code{UTF-8} +codeset. Additional locale definitions can be specified in the +@code{locale-definitions} slot of @code{operating-system}---this is useful, +for instance, if the codeset could not be inferred from the locale name. +The default set of locale definitions includes some widely used locales, but +not all the available locales, in order to save space. + +For instance, to add the North Frisian locale for Germany, the value of that +field may be: + +@example +(cons (locale-definition + (name "fy_DE.utf8") (source "fy_DE")) + %default-locale-definitions) +@end example + +Likewise, to save space, one might want @code{locale-definitions} to list +only the locales that are actually used, as in: + +@example +(list (locale-definition + (name "ja_JP.eucjp") (source "ja_JP") + (charset "EUC-JP"))) +@end example + +@vindex LOCPATH +The compiled locale definitions are available at +@file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc version, +which is the default location where the GNU@tie{}libc provided by Guix looks +for locale data. This can be overridden using the @code{LOCPATH} +environment variable (@pxref{locales-and-locpath, @code{LOCPATH} and locale +packages}). + +The @code{locale-definition} form is provided by the @code{(gnu system +locale)} module. Details are given below. + +@deftp {Data Type} locale-definition +This is the data type of a locale definition. + +@table @asis + +@item @code{name} +The name of the locale. @xref{Locale Names,,, libc, The GNU C Library +Reference Manual}, for more information on locale names. + +@item @code{source} +The name of the source for that locale. This is typically the +@code{@var{language}_@var{territory}} part of the locale name. + +@item @code{charset} (default: @code{"UTF-8"}) +The ``character set'' or ``code set'' for that locale, +@uref{http://www.iana.org/assignments/character-sets, as defined by IANA}. + +@end table +@end deftp + +@defvr {Scheme Variable} %default-locale-definitions +A list of commonly used UTF-8 locales, used as the default value of the +@code{locale-definitions} field of @code{operating-system} declarations. + +@cindex locale name +@cindex normalized codeset in locale names +These locale definitions use the @dfn{normalized codeset} for the part that +follows the dot in the name (@pxref{Using gettextized software, normalized +codeset,, libc, The GNU C Library Reference Manual}). So for instance it +has @code{uk_UA.utf8} but @emph{not}, say, @code{uk_UA.UTF-8}. +@end defvr + +@subsubsection Locale Data Compatibility Considerations + +@cindex incompatibility, of locale data +@code{operating-system} declarations provide a @code{locale-libcs} field to +specify the GNU@tie{}libc packages that are used to compile locale +declarations (@pxref{„operating-system“-Referenz}). ``Why would I care?'', +you may ask. Well, it turns out that the binary format of locale data is +occasionally incompatible from one libc version to another. + +@c See <https://sourceware.org/ml/libc-alpha/2015-09/msg00575.html> +@c and <https://lists.gnu.org/archive/html/guix-devel/2015-08/msg00737.html>. +For instance, a program linked against libc version 2.21 is unable to read +locale data produced with libc 2.22; worse, that program @emph{aborts} +instead of simply ignoring the incompatible locale data@footnote{Versions +2.23 and later of GNU@tie{}libc will simply skip the incompatible locale +data, which is already an improvement.}. Similarly, a program linked +against libc 2.22 can read most, but not all, of the locale data from libc +2.21 (specifically, @code{LC_COLLATE} data is incompatible); thus calls to +@code{setlocale} may fail, but programs will not abort. + +The ``problem'' in GuixSD is that users have a lot of freedom: They can +choose whether and when to upgrade software in their profiles, and might be +using a libc version different from the one the system administrator used to +build the system-wide locale data. + +Fortunately, unprivileged users can also install their own locale data and +define @var{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, +@code{GUIX_LOCPATH} and locale packages}). + +Still, it is best if the system-wide locale data at +@file{/run/current-system/locale} is built for all the libc versions +actually in use on the system, so that all the programs can access it---this +is especially crucial on a multi-user system. To do that, the administrator +can specify several libc packages in the @code{locale-libcs} field of +@code{operating-system}: + +@example +(use-package-modules base) + +(operating-system + ;; @dots{} + (locale-libcs (list glibc-2.21 (canonical-package glibc)))) +@end example + +This example would lead to a system containing locale definitions for both +libc 2.21 and the current version of libc in +@file{/run/current-system/locale}. + + +@node Dienste +@subsection Dienste + +@cindex system services +An important part of preparing an @code{operating-system} declaration is +listing @dfn{system services} and their configuration (@pxref{Das Konfigurationssystems nutzen}). System services are typically daemons launched when +the system boots, or other actions needed at that time---e.g., configuring +network access. + +GuixSD has a broad definition of ``service'' (@pxref{Dienstkompositionen}), +but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd-Dienste}). On a running system, the @command{herd} command allows you to +list the available services, show their status, start and stop them, or do +other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd +Manual}). For example: + +@example +# herd status +@end example + +The above command, run as @code{root}, lists the currently defined +services. The @command{herd doc} command shows a synopsis of the given +service: + +@example +# herd doc nscd +Run libc's name service cache daemon (nscd). +@end example + +The @command{start}, @command{stop}, and @command{restart} sub-commands have +the effect you would expect. For instance, the commands below stop the nscd +service and restart the Xorg display server: + +@example +# herd stop nscd +Service nscd has been stopped. +# herd restart xorg-server +Service xorg-server has been stopped. +Service xorg-server has been started. +@end example + +The following sections document the available services, starting with the +core services, that may be used in an @code{operating-system} declaration. + +@menu +* Basisdienste:: Essenzielle Systemdienste +* Geplante Auftragsausführung:: Der mcron-Dienst. +* Log-Rotation:: Der rottlog-Dienst. +* Netzwerkdienste:: Netzwerkeinrichtung, SSH-Daemon etc. +* X Window:: Graphische Anzeige. +* Druckdienste:: Unterstützung für lokale und entfernte + Drucker. +* Desktop-Dienste:: D-Bus- und Desktop-Dienste. +* Tondienste:: Dienste für ALSA und Pulseaudio. +* Datenbankdienste:: SQL-Datenbanken, Schlüssel-Wert-Speicher etc. +* Mail-Dienste:: IMAP, POP3, SMTP und so weiter. +* Kurznachrichtendienste:: Dienste für Kurznachrichten. +* Telefondienste:: Telefoniedienste. +* Überwachungsdienste:: Dienste zur Systemüberwachung. +* Kerberos-Dienste:: Kerberos-Dienste. +* Web-Dienste:: Web-Server. +* Zertifikatsdienste:: TLS-Zertifikate via Let’s Encrypt. +* DNS-Dienste:: DNS-Daemons. +* VPN-Dienste:: VPN-Daemons. +* Network File System:: Dienste mit Bezug zum Netzwerkdateisystem. +* Kontinuierliche Integration:: Der Cuirass-Dienst +* Power Management Services:: Extending battery life. +* Audio-Dienste:: Der MPD. +* Virtualisierungsdienste:: Dienste für virtuelle Maschinen. +* Versionskontrolldienste:: Entfernten Zugang zu Git-Repositorys bieten. +* Spieldienste:: Spielserver. +* Verschiedene Dienste:: Andere Dienste. +@end menu + +@node Basisdienste +@subsubsection Basisdienste + +The @code{(gnu services base)} module provides definitions for the basic +services that one expects from the system. The services exported by this +module are listed below. + +@defvr {Scheme Variable} %base-services +This variable contains a list of basic services (@pxref{Diensttypen und Dienste}, for more information on service objects) one would expect from +the system: a login service (mingetty) on each tty, syslogd, the libc name +service cache daemon (nscd), the udev device manager, and more. + +This is the default value of the @code{services} field of +@code{operating-system} declarations. Usually, when customizing a system, +you will want to append services to @var{%base-services}, like this: + +@example +(cons* (avahi-service) (lsh-service) %base-services) +@end example +@end defvr + +@defvr {Scheme Variable} special-files-service-type +This is the service that sets up ``special files'' such as @file{/bin/sh}; +an instance of it is part of @code{%base-services}. + +The value associated with @code{special-files-service-type} services must be +a list of tuples where the first element is the ``special file'' and the +second element is its target. By default it is: + +@cindex @file{/bin/sh} +@cindex @file{sh}, in @file{/bin} +@example +`(("/bin/sh" ,(file-append @var{bash} "/bin/sh"))) +@end example + +@cindex @file{/usr/bin/env} +@cindex @file{env}, in @file{/usr/bin} +If you want to add, say, @code{/usr/bin/env} to your system, you can change +it to: + +@example +`(("/bin/sh" ,(file-append @var{bash} "/bin/sh")) + ("/usr/bin/env" ,(file-append @var{coreutils} "/bin/env"))) +@end example + +Since this is part of @code{%base-services}, you can use +@code{modify-services} to customize the set of special files (@pxref{Service-Referenz, @code{modify-services}}). But the simple way to add a special +file is @i{via} the @code{extra-special-file} procedure (see below.) +@end defvr + +@deffn {Scheme Procedure} extra-special-file @var{file} @var{target} +Use @var{target} as the ``special file'' @var{file}. + +For example, adding the following lines to the @code{services} field of your +operating system declaration leads to a @file{/usr/bin/env} symlink: + +@example +(extra-special-file "/usr/bin/env" + (file-append coreutils "/bin/env")) +@end example +@end deffn + +@deffn {Scheme Procedure} host-name-service @var{name} +Return a service that sets the host name to @var{name}. +@end deffn + +@deffn {Scheme Procedure} login-service @var{config} +Return a service to run login according to @var{config}, a +@code{<login-configuration>} object, which specifies the message of the day, +among other things. +@end deffn + +@deftp {Data Type} login-configuration +This is the data type representing the configuration of login. + +@table @asis + +@item @code{motd} +@cindex message of the day +A file-like object containing the ``message of the day''. + +@item @code{allow-empty-passwords?} (default: @code{#t}) +Allow empty passwords by default so that first-time users can log in when +the 'root' account has just been created. + +@end table +@end deftp + +@deffn {Scheme Procedure} mingetty-service @var{config} +Return a service to run mingetty according to @var{config}, a +@code{<mingetty-configuration>} object, which specifies the tty to run, +among other things. +@end deffn + +@deftp {Data Type} mingetty-configuration +This is the data type representing the configuration of Mingetty, which +provides the default implementation of virtual console log-in. + +@table @asis + +@item @code{tty} +The name of the console this Mingetty runs on---e.g., @code{"tty1"}. + +@item @code{auto-login} (default: @code{#f}) +When true, this field must be a string denoting the user name under which +the system automatically logs in. When it is @code{#f}, a user name and +password must be entered to log in. + +@item @code{login-program} (default: @code{#f}) +This must be either @code{#f}, in which case the default log-in program is +used (@command{login} from the Shadow tool suite), or a gexp denoting the +name of the log-in program. + +@item @code{login-pause?} (default: @code{#f}) +When set to @code{#t} in conjunction with @var{auto-login}, the user will +have to press a key before the log-in shell is launched. + +@item @code{mingetty} (default: @var{mingetty}) +The Mingetty package to use. + +@end table +@end deftp + +@deffn {Scheme Procedure} agetty-service @var{config} +Return a service to run agetty according to @var{config}, an +@code{<agetty-configuration>} object, which specifies the tty to run, among +other things. +@end deffn + +@deftp {Data Type} agetty-configuration +This is the data type representing the configuration of agetty, which +implements virtual and serial console log-in. See the @code{agetty(8)} man +page for more information. + +@table @asis + +@item @code{tty} +The name of the console this agetty runs on, as a string---e.g., +@code{"ttyS0"}. This argument is optional, it will default to a reasonable +default serial port used by the kernel Linux. + +For this, if there is a value for an option @code{agetty.tty} in the kernel +command line, agetty will extract the device name of the serial port from it +and use that. + +If not and if there is a value for an option @code{console} with a tty in +the Linux command line, agetty will extract the device name of the serial +port from it and use that. + +In both cases, agetty will leave the other serial device settings (baud rate +etc.) alone---in the hope that Linux pinned them to the correct values. + +@item @code{baud-rate} (default: @code{#f}) +A string containing a comma-separated list of one or more baud rates, in +descending order. + +@item @code{term} (default: @code{#f}) +A string containing the value used for the @code{TERM} environment variable. + +@item @code{eight-bits?} (default: @code{#f}) +When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection +is disabled. + +@item @code{auto-login} (default: @code{#f}) +When passed a login name, as a string, the specified user will be logged in +automatically without prompting for their login name or password. + +@item @code{no-reset?} (default: @code{#f}) +When @code{#t}, don't reset terminal cflags (control modes). + +@item @code{host} (default: @code{#f}) +This accepts a string containing the "login_host", which will be written +into the @file{/var/run/utmpx} file. + +@item @code{remote?} (default: @code{#f}) +When set to @code{#t} in conjunction with @var{host}, this will add an +@code{-r} fakehost option to the command line of the login program specified +in @var{login-program}. + +@item @code{flow-control?} (default: @code{#f}) +When set to @code{#t}, enable hardware (RTS/CTS) flow control. + +@item @code{no-issue?} (default: @code{#f}) +When set to @code{#t}, the contents of the @file{/etc/issue} file will not +be displayed before presenting the login prompt. + +@item @code{init-string} (default: @code{#f}) +This accepts a string that will be sent to the tty or modem before sending +anything else. It can be used to initialize a modem. + +@item @code{no-clear?} (default: @code{#f}) +When set to @code{#t}, agetty will not clear the screen before showing the +login prompt. + +@item @code{login-program} (default: (file-append shadow "/bin/login")) +This must be either a gexp denoting the name of a log-in program, or unset, +in which case the default value is the @command{login} from the Shadow tool +suite. + +@item @code{local-line} (default: @code{#f}) +Control the CLOCAL line flag. This accepts one of three symbols as +arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, the +default value chosen by agetty is @code{'auto}. + +@item @code{extract-baud?} (default: @code{#f}) +When set to @code{#t}, instruct agetty to try to extract the baud rate from +the status messages produced by certain types of modems. + +@item @code{skip-login?} (default: @code{#f}) +When set to @code{#t}, do not prompt the user for a login name. This can be +used with @var{login-program} field to use non-standard login systems. + +@item @code{no-newline?} (default: @code{#f}) +When set to @code{#t}, do not print a newline before printing the +@file{/etc/issue} file. + +@c Is this dangerous only when used with login-program, or always? +@item @code{login-options} (default: @code{#f}) +This option accepts a string containing options that are passed to the login +program. When used with the @var{login-program}, be aware that a malicious +user could try to enter a login name containing embedded options that could +be parsed by the login program. + +@item @code{login-pause} (default: @code{#f}) +When set to @code{#t}, wait for any key before showing the login prompt. +This can be used in conjunction with @var{auto-login} to save memory by +lazily spawning shells. + +@item @code{chroot} (default: @code{#f}) +Change root to the specified directory. This option accepts a directory +path as a string. + +@item @code{hangup?} (default: @code{#f}) +Use the Linux system call @code{vhangup} to do a virtual hangup of the +specified terminal. + +@item @code{keep-baud?} (default: @code{#f}) +When set to @code{#t}, try to keep the existing baud rate. The baud rates +from @var{baud-rate} are used when agetty receives a @key{BREAK} character. + +@item @code{timeout} (default: @code{#f}) +When set to an integer value, terminate if no user name could be read within +@var{timeout} seconds. + +@item @code{detect-case?} (default: @code{#f}) +When set to @code{#t}, turn on support for detecting an uppercase-only +terminal. This setting will detect a login name containing only uppercase +letters as indicating an uppercase-only terminal and turn on some +upper-to-lower case conversions. Note that this will not support Unicode +characters. + +@item @code{wait-cr?} (default: @code{#f}) +When set to @code{#t}, wait for the user or modem to send a carriage-return +or linefeed character before displaying @file{/etc/issue} or login prompt. +This is typically used with the @var{init-string} option. + +@item @code{no-hints?} (default: @code{#f}) +When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks. + +@item @code{no-hostname?} (default: @code{#f}) +By default, the hostname is printed. When this option is set to @code{#t}, +no hostname will be shown at all. + +@item @code{long-hostname?} (default: @code{#f}) +By default, the hostname is only printed until the first dot. When this +option is set to @code{#t}, the fully qualified hostname by +@code{gethostname} or @code{getaddrinfo} is shown. + +@item @code{erase-characters} (default: @code{#f}) +This option accepts a string of additional characters that should be +interpreted as backspace when the user types their login name. + +@item @code{kill-characters} (default: @code{#f}) +This option accepts a string that should be interpreted to mean "ignore all +previous characters" (also called a "kill" character) when the types their +login name. + +@item @code{chdir} (default: @code{#f}) +This option accepts, as a string, a directory path that will be changed to +before login. + +@item @code{delay} (default: @code{#f}) +This options accepts, as an integer, the number of seconds to sleep before +opening the tty and displaying the login prompt. + +@item @code{nice} (default: @code{#f}) +This option accepts, as an integer, the nice value with which to run the +@command{login} program. + +@item @code{extra-options} (default: @code{'()}) +This option provides an "escape hatch" for the user to provide arbitrary +command-line arguments to @command{agetty} as a list of strings. + +@end table +@end deftp + +@deffn {Scheme Procedure} kmscon-service-type @var{config} +Return a service to run +@uref{https://www.freedesktop.org/wiki/Software/kmscon,kmscon} according to +@var{config}, a @code{<kmscon-configuration>} object, which specifies the +tty to run, among other things. +@end deffn + +@deftp {Data Type} kmscon-configuration +This is the data type representing the configuration of Kmscon, which +implements virtual console log-in. + +@table @asis + +@item @code{virtual-terminal} +The name of the console this Kmscon runs on---e.g., @code{"tty1"}. + +@item @code{login-program} (default: @code{#~(string-append #$shadow "/bin/login")}) +A gexp denoting the name of the log-in program. The default log-in program +is @command{login} from the Shadow tool suite. + +@item @code{login-arguments} (default: @code{'("-p")}) +A list of arguments to pass to @command{login}. + +@item @code{hardware-acceleration?} (default: #f) +Whether to use hardware acceleration. + +@item @code{kmscon} (default: @var{kmscon}) +The Kmscon package to use. + +@end table +@end deftp + +@cindex name service cache daemon +@cindex nscd +@deffn {Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @ + [#:name-services '()] Return a service that runs the libc name service cache +daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} +object. @xref{Name Service Switch}, for an example. +@end deffn + +@defvr {Scheme Variable} %nscd-default-configuration +This is the default @code{<nscd-configuration>} value (see below) used by +@code{nscd-service}. It uses the caches defined by +@var{%nscd-default-caches}; see below. +@end defvr + +@deftp {Data Type} nscd-configuration +This is the data type representing the name service cache daemon (nscd) +configuration. + +@table @asis + +@item @code{name-services} (default: @code{'()}) +List of packages denoting @dfn{name services} that must be visible to the +nscd---e.g., @code{(list @var{nss-mdns})}. + +@item @code{glibc} (default: @var{glibc}) +Package object denoting the GNU C Library providing the @command{nscd} +command. + +@item @code{log-file} (default: @code{"/var/log/nscd.log"}) +Name of the nscd log file. This is where debugging output goes when +@code{debug-level} is strictly positive. + +@item @code{debug-level} (default: @code{0}) +Integer denoting the debugging levels. Higher numbers mean that more +debugging output is logged. + +@item @code{caches} (default: @var{%nscd-default-caches}) +List of @code{<nscd-cache>} objects denoting things to be cached; see below. + +@end table +@end deftp + +@deftp {Data Type} nscd-cache +Data type representing a cache database of nscd and its parameters. + +@table @asis + +@item @code{database} +This is a symbol representing the name of the database to be cached. Valid +values are @code{passwd}, @code{group}, @code{hosts}, and @code{services}, +which designate the corresponding NSS database (@pxref{NSS Basics,,, libc, +The GNU C Library Reference Manual}). + +@item @code{positive-time-to-live} +@itemx @code{negative-time-to-live} (default: @code{20}) +A number representing the number of seconds during which a positive or +negative lookup result remains in cache. + +@item @code{check-files?} (default: @code{#t}) +Whether to check for updates of the files corresponding to @var{database}. + +For instance, when @var{database} is @code{hosts}, setting this flag +instructs nscd to check for updates in @file{/etc/hosts} and to take them +into account. + +@item @code{persistent?} (default: @code{#t}) +Whether the cache should be stored persistently on disk. + +@item @code{shared?} (default: @code{#t}) +Whether the cache should be shared among users. + +@item @code{max-database-size} (default: 32@tie{}MiB) +Maximum size in bytes of the database cache. + +@c XXX: 'suggested-size' and 'auto-propagate?' seem to be expert +@c settings, so leave them out. + +@end table +@end deftp + +@defvr {Scheme Variable} %nscd-default-caches +List of @code{<nscd-cache>} objects used by default by +@code{nscd-configuration} (see above). + +It enables persistent and aggressive caching of service and host name +lookups. The latter provides better host name lookup performance, +resilience in the face of unreliable name servers, and also better +privacy---often the result of host name lookups is in local cache, so +external name servers do not even need to be queried. +@end defvr + +@anchor{syslog-configuration-type} +@cindex syslog +@cindex logging +@deftp {Data Type} syslog-configuration +This data type represents the configuration of the syslog daemon. + +@table @asis +@item @code{syslogd} (default: @code{#~(string-append #$inetutils "/libexec/syslogd")}) +The syslog daemon to use. + +@item @code{config-file} (default: @code{%default-syslog.conf}) +The syslog configuration file to use. + +@end table +@end deftp + +@anchor{syslog-service} +@cindex syslog +@deffn {Scheme Procedure} syslog-service @var{config} +Return a service that runs a syslog daemon according to @var{config}. + +@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information +on the configuration file syntax. +@end deffn + +@defvr {Scheme Variable} guix-service-type +This is the type of the service that runs the build daemon, +@command{guix-daemon} (@pxref{Aufruf des guix-daemon}). Its value must be a +@code{guix-configuration} record as described below. +@end defvr + +@anchor{guix-configuration-type} +@deftp {Data Type} guix-configuration +This data type represents the configuration of the Guix build daemon. +@xref{Aufruf des guix-daemon}, for more information. + +@table @asis +@item @code{guix} (default: @var{guix}) +The Guix package to use. + +@item @code{build-group} (default: @code{"guixbuild"}) +Name of the group for build user accounts. + +@item @code{build-accounts} (default: @code{10}) +Number of build user accounts to create. + +@item @code{authorize-key?} (default: @code{#t}) +@cindex Substitute, deren Autorisierung +Whether to authorize the substitute keys listed in +@code{authorized-keys}---by default that of @code{hydra.gnu.org} +(@pxref{Substitute}). + +@vindex %default-authorized-guix-keys +@item @code{authorized-keys} (default: @var{%default-authorized-guix-keys}) +The list of authorized key files for archive imports, as a list of +string-valued gexps (@pxref{Aufruf von guix archive}). By default, it +contains that of @code{hydra.gnu.org} (@pxref{Substitute}). + +@item @code{use-substitutes?} (default: @code{#t}) +Whether to use substitutes. + +@item @code{substitute-urls} (default: @var{%default-substitute-urls}) +The list of URLs where to look for substitutes by default. + +@item @code{max-silent-time} (default: @code{0}) +@itemx @code{timeout} (default: @code{0}) +The number of seconds of silence and the number of seconds of activity, +respectively, after which a build process times out. A value of zero +disables the timeout. + +@item @code{log-compression} (default: @code{'bzip2}) +The type of compression used for build logs---one of @code{gzip}, +@code{bzip2}, or @code{none}. + +@item @code{extra-options} (default: @code{'()}) +List of extra command-line options for @command{guix-daemon}. + +@item @code{log-file} (default: @code{"/var/log/guix-daemon.log"}) +File where @command{guix-daemon}'s standard output and standard error are +written. + +@item @code{http-proxy} (default: @code{#f}) +The HTTP proxy used for downloading fixed-output derivations and +substitutes. + +@item @code{tmpdir} (default: @code{#f}) +A directory path where the @command{guix-daemon} will perform builds. + +@end table +@end deftp + +@deffn {Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}] +Run @var{udev}, which populates the @file{/dev} directory dynamically. udev +rules can be provided as a list of files through the @var{rules} variable. +The procedures @var{udev-rule} and @var{file->udev-rule} from @code{(gnu +services base)} simplify the creation of such rule files. + +@deffn {Scheme Procedure} udev-rule [@var{file-name} @var{contents}] +Return a udev-rule file named @var{file-name} containing the rules defined +by the @var{contents} literal. + +In the following example, a rule for a USB device is defined to be stored in +the file @file{90-usb-thing.rules}. The rule runs a script upon detecting a +USB device with a given product identifier. + +@example +(define %example-udev-rule + (udev-rule + "90-usb-thing.rules" + (string-append "ACTION==\"add\", SUBSYSTEM==\"usb\", " + "ATTR@{product@}==\"Example\", " + "RUN+=\"/path/to/script\""))) +@end example +@end deffn + +Here we show how the default @var{udev-service} can be extended with it. + +@example +(operating-system + ;; @dots{} + (services + (modify-services %desktop-services + (udev-service-type config => + (udev-configuration (inherit config) + (rules (append (udev-configuration-rules config) + (list %example-udev-rule)))))))) +@end example + +@deffn {Scheme Procedure} file->udev-rule [@var{file-name} @var{file}] +Return a udev file named @var{file-name} containing the rules defined within +@var{file}, a file-like object. + +The following example showcases how we can use an existing rule file. + +@example +(use-modules (guix download) ;for url-fetch + (guix packages) ;for origin + ;; @dots{}) + +(define %android-udev-rules + (file->udev-rule + "51-android-udev.rules" + (let ((version "20170910")) + (origin + (method url-fetch) + (uri (string-append "https://raw.githubusercontent.com/M0Rf30/" + "android-udev-rules/" version "/51-android.rules")) + (sha256 + (base32 "0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003")))))) +@end example +@end deffn + +Additionally, Guix package definitions can be included in @var{rules} in +order to extend the udev rules with the definitions found under their +@file{lib/udev/rules.d} sub-directory. In lieu of the previous +@var{file->udev-rule} example, we could have used the +@var{android-udev-rules} package which exists in Guix in the @code{(gnu +packages android)} module. + +The following example shows how to use the @var{android-udev-rules} package +so that the Android tool @command{adb} can detect devices without root +privileges. It also details how to create the @code{adbusers} group, which +is required for the proper functioning of the rules defined within the +@var{android-udev-rules} package. To create such a group, we must define it +both as part of the @var{supplementary-groups} of our @var{user-account} +declaration, as well as in the @var{groups} field of the +@var{operating-system} record. + +@example +(use-modules (gnu packages android) ;for android-udev-rules + (gnu system shadow) ;for user-group + ;; @dots{}) + +(operating-system + ;; @dots{} + (users (cons (user-acount + ;; @dots{} + (supplementary-groups + '("adbusers" ;for adb + "wheel" "netdev" "audio" "video")) + ;; @dots{}))) + + (groups (cons (user-group (system? #t) (name "adbusers")) + %base-groups)) + + ;; @dots{} + + (services + (modify-services %desktop-services + (udev-service-type config => + (udev-configuration (inherit config) + (rules (cons* android-udev-rules + (udev-configuration-rules config)))))))) +@end example +@end deffn + +@defvr {Scheme Variable} urandom-seed-service-type +Save some entropy in @var{%random-seed-file} to seed @file{/dev/urandom} +when rebooting. It also tries to seed @file{/dev/urandom} from +@file{/dev/hwrng} while booting, if @file{/dev/hwrng} exists and is +readable. +@end defvr + +@defvr {Scheme Variable} %random-seed-file +This is the name of the file where some random bytes are saved by +@var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. It +defaults to @file{/var/lib/random-seed}. +@end defvr + +@cindex keymap +@cindex keyboard +@deffn {Scheme Procedure} console-keymap-service @var{files} ... +@cindex keyboard layout +Return a service to load console keymaps from @var{files} using +@command{loadkeys} command. Most likely, you want to load some default +keymap, which can be done like this: + +@example +(console-keymap-service "dvorak") +@end example + +Or, for example, for a Swedish keyboard, you may need to combine the +following keymaps: +@example +(console-keymap-service "se-lat6" "se-fi-lat6") +@end example + +Also you can specify a full file name (or file names) of your keymap(s). +See @code{man loadkeys} for details. + +@end deffn + +@cindex mouse +@cindex gpm +@defvr {Scheme Variable} gpm-service-type +This is the type of the service that runs GPM, the @dfn{general-purpose +mouse daemon}, which provides mouse support to the Linux console. GPM +allows users to use the mouse in the console, notably to select, copy, and +paste text. + +The value for services of this type must be a @code{gpm-configuration} (see +below). This service is not part of @var{%base-services}. +@end defvr + +@deftp {Data Type} gpm-configuration +Data type representing the configuration of GPM. + +@table @asis +@item @code{options} (default: @code{%default-gpm-options}) +Command-line options passed to @command{gpm}. The default set of options +instruct @command{gpm} to listen to mouse events on @file{/dev/input/mice}. +@xref{Command Line,,, gpm, gpm manual}, for more information. + +@item @code{gpm} (default: @code{gpm}) +The GPM package to use. + +@end table +@end deftp + +@anchor{guix-publish-service-type} +@deffn {Scheme Variable} guix-publish-service-type +This is the service type for @command{guix publish} (@pxref{Aufruf von guix publish}). Its value must be a @code{guix-configuration} object, as +described below. + +This assumes that @file{/etc/guix} already contains a signing key pair as +created by @command{guix archive --generate-key} (@pxref{Aufruf von guix archive}). If that is not the case, the service will fail to start. +@end deffn + +@deftp {Data Type} guix-publish-configuration +Data type representing the configuration of the @code{guix publish} service. + +@table @asis +@item @code{guix} (default: @code{guix}) +The Guix package to use. + +@item @code{port} (default: @code{80}) +The TCP port to listen for connections. + +@item @code{host} (default: @code{"localhost"}) +The host (and thus, network interface) to listen to. Use @code{"0.0.0.0"} +to listen on all the network interfaces. + +@item @code{compression-level} (Vorgabe: @code{3}) +The gzip compression level at which substitutes are compressed. Use +@code{0} to disable compression altogether, and @code{9} to get the best +compression ratio at the expense of increased CPU usage. + +@item @code{nar-path} (default: @code{"nar"}) +The URL path at which ``nars'' can be fetched. @xref{Aufruf von guix publish, +@code{--nar-path}}, for details. + +@item @code{cache} (default: @code{#f}) +When it is @code{#f}, disable caching and instead generate archives on +demand. Otherwise, this should be the name of a directory---e.g., +@code{"/var/cache/guix/publish"}---where @command{guix publish} caches +archives and meta-data ready to be sent. @xref{Aufruf von guix publish, +@option{--cache}}, for more information on the tradeoffs involved. + +@item @code{workers} (default: @code{#f}) +When it is an integer, this is the number of worker threads used for +caching; when @code{#f}, the number of processors is used. @xref{Aufruf von guix publish, @option{--workers}}, for more information. + +@item @code{ttl} (default: @code{#f}) +When it is an integer, this denotes the @dfn{time-to-live} in seconds of the +published archives. @xref{Aufruf von guix publish, @option{--ttl}}, for more +information. +@end table +@end deftp + +@anchor{rngd-service} +@deffn {Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @ + [#:device "/dev/hwrng"] Return a service that runs the @command{rngd} +program from @var{rng-tools} to add @var{device} to the kernel's entropy +pool. The service will fail if @var{device} does not exist. +@end deffn + +@anchor{pam-limits-service} +@cindex session limits +@cindex ulimit +@cindex priority +@cindex realtime +@cindex jackd +@deffn {Scheme Procedure} pam-limits-service [#:limits @code{'()}] + +Return a service that installs a configuration file for the +@uref{http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html, +@code{pam_limits} module}. The procedure optionally takes a list of +@code{pam-limits-entry} values, which can be used to specify @code{ulimit} +limits and nice priority limits to user sessions. + +The following limits definition sets two hard and soft limits for all login +sessions of users in the @code{realtime} group: + +@example +(pam-limits-service + (list + (pam-limits-entry "@@realtime" 'both 'rtprio 99) + (pam-limits-entry "@@realtime" 'both 'memlock 'unlimited))) +@end example + +The first entry increases the maximum realtime priority for non-privileged +processes; the second entry lifts any restriction of the maximum address +space that can be locked in memory. These settings are commonly used for +real-time audio systems. +@end deffn + +@node Geplante Auftragsausführung +@subsubsection Geplante Auftragsausführung + +@cindex cron +@cindex mcron +@cindex scheduling jobs +The @code{(gnu services mcron)} module provides an interface to +GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, +mcron, GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional Unix +@command{cron} daemon; the main difference is that it is implemented in +Guile Scheme, which provides a lot of flexibility when specifying the +scheduling of jobs and their actions. + +The example below defines an operating system that runs the +@command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) and +the @command{guix gc} commands (@pxref{Aufruf von guix gc}) daily, as well as +the @command{mkid} command on behalf of an unprivileged user (@pxref{mkid +invocation,,, idutils, ID Database Utilities}). It uses gexps to introduce +job definitions that are passed to mcron (@pxref{G-Ausdrücke}). + +@lisp +(use-modules (guix) (gnu) (gnu services mcron)) +(use-package-modules base idutils) + +(define updatedb-job + ;; Run 'updatedb' at 3AM every day. Here we write the + ;; job's action as a Scheme procedure. + #~(job '(next-hour '(3)) + (lambda () + (execl (string-append #$findutils "/bin/updatedb") + "updatedb" + "--prunepaths=/tmp /var/tmp /gnu/store")))) + +(define garbage-collector-job + ;; Collect garbage 5 minutes after midnight every day. + ;; The job's action is a shell command. + #~(job "5 0 * * *" ;Vixie cron syntax + "guix gc -F 1G")) + +(define idutils-job + ;; Update the index database as user "charlie" at 12:15PM + ;; and 19:15PM. This runs from the user's home directory. + #~(job '(next-minute-from (next-hour '(12 19)) '(15)) + (string-append #$idutils "/bin/mkid src") + #:user "charlie")) + +(operating-system + ;; @dots{} + (services (cons (mcron-service (list garbage-collector-job + updatedb-job + idutils-job)) + %base-services))) +@end lisp + +@xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, for +more information on mcron job specifications. Below is the reference of the +mcron service. + +On a running system, you can use the @code{schedule} action of the service +to visualize the mcron jobs that will be executed next: + +@example +# herd schedule mcron +@end example + +@noindent +The example above lists the next five tasks that will be executed, but you +can also specify the number of tasks to display: + +@example +# herd schedule mcron 10 +@end example + +@deffn {Scheme Procedure} mcron-service @var{jobs} [#:mcron @var{mcron}] +Return an mcron service running @var{mcron} that schedules @var{jobs}, a +list of gexps denoting mcron job specifications. + +This is a shorthand for: +@example +(service mcron-service-type + (mcron-configuration (mcron mcron) (jobs jobs))) +@end example +@end deffn + +@defvr {Scheme Variable} mcron-service-type +This is the type of the @code{mcron} service, whose value is an +@code{mcron-configuration} object. + +This service type can be the target of a service extension that provides it +additional job specifications (@pxref{Dienstkompositionen}). In other +words, it is possible to define services that provide additional mcron jobs +to run. +@end defvr + +@deftp {Data Type} mcron-configuration +Data type representing the configuration of mcron. + +@table @asis +@item @code{mcron} (default: @var{mcron}) +The mcron package to use. + +@item @code{jobs} +This is a list of gexps (@pxref{G-Ausdrücke}), where each gexp corresponds +to an mcron job specification (@pxref{Syntax, mcron job specifications,, +mcron, GNU@tie{}mcron}). +@end table +@end deftp + + +@node Log-Rotation +@subsubsection Log-Rotation + +@cindex rottlog +@cindex log rotation +@cindex logging +Log files such as those found in @file{/var/log} tend to grow endlessly, so +it's a good idea to @dfn{rotate} them once in a while---i.e., archive their +contents in separate files, possibly compressed. The @code{(gnu services +admin)} module provides an interface to GNU@tie{}Rot[t]log, a log rotation +tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual}). + +The example below defines an operating system that provides log rotation +with the default settings, for commonly encountered log files. + +@lisp +(use-modules (guix) (gnu)) +(use-service-modules admin mcron) +(use-package-modules base idutils) + +(operating-system + ;; @dots{} + (services (cons (service rottlog-service-type) + %base-services))) +@end lisp + +@defvr {Scheme Variable} rottlog-service-type +This is the type of the Rottlog service, whose value is a +@code{rottlog-configuration} object. + +Other services can extend this one with new @code{log-rotation} objects (see +below), thereby augmenting the set of files to be rotated. + +This service type can define mcron jobs (@pxref{Geplante Auftragsausführung}) to +run the rottlog service. +@end defvr + +@deftp {Data Type} rottlog-configuration +Data type representing the configuration of rottlog. + +@table @asis +@item @code{rottlog} (default: @code{rottlog}) +The Rottlog package to use. + +@item @code{rc-file} (default: @code{(file-append rottlog "/etc/rc")}) +The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, +rottlog, GNU Rot[t]log Manual}). + +@item @code{rotations} (default: @code{%default-rotations}) +A list of @code{log-rotation} objects as defined below. + +@item @code{jobs} +This is a list of gexps where each gexp corresponds to an mcron job +specification (@pxref{Geplante Auftragsausführung}). +@end table +@end deftp + +@deftp {Data Type} log-rotation +Data type representing the rotation of a group of log files. + +Taking an example from the Rottlog manual (@pxref{Period Related File +Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be defined +like this: + +@example +(log-rotation + (frequency 'daily) + (files '("/var/log/apache/*")) + (options '("storedir apache-archives" + "rotate 6" + "notifempty" + "nocompress"))) +@end example + +The list of fields is as follows: + +@table @asis +@item @code{frequency} (default: @code{'weekly}) +The log rotation frequency, a symbol. + +@item @code{files} +The list of files or file glob patterns to rotate. + +@item @code{options} (default: @code{'()}) +The list of rottlog options for this rotation (@pxref{Configuration +parameters,,, rottlog, GNU Rot[t]lg Manual}). + +@item @code{post-rotate} (default: @code{#f}) +Either @code{#f} or a gexp to execute once the rotation has completed. +@end table +@end deftp + +@defvr {Scheme Variable} %default-rotations +Specifies weekly rotation of @var{%rotated-files} and a couple of other +files. +@end defvr + +@defvr {Scheme Variable} %rotated-files +The list of syslog-controlled files to be rotated. By default it is: +@code{'("/var/log/messages" "/var/log/secure")}. +@end defvr + +@node Netzwerkdienste +@subsubsection Netzwerkdienste + +The @code{(gnu services networking)} module provides services to configure +the network interface. + +@cindex DHCP, networking service +@defvr {Scheme Variable} dhcp-client-service-type +This is the type of services that run @var{dhcp}, a Dynamic Host +Configuration Protocol (DHCP) client, on all the non-loopback network +interfaces. Its value is the DHCP client package to use, @code{isc-dhcp} by +default. +@end defvr + +@deffn {Scheme Procedure} dhcpd-service-type +This type defines a service that runs a DHCP daemon. To create a service of +this type, you must supply a @code{<dhcpd-configuration>}. For example: + +@example +(service dhcpd-service-type + (dhcpd-configuration + (config-file (local-file "my-dhcpd.conf")) + (interfaces '("enp0s25")))) +@end example +@end deffn + +@deftp {Data Type} dhcpd-configuration +@table @asis +@item @code{package} (default: @code{isc-dhcp}) +The package that provides the DHCP daemon. This package is expected to +provide the daemon at @file{sbin/dhcpd} relative to its output directory. +The default package is the @uref{http://www.isc.org/products/DHCP, ISC's +DHCP server}. +@item @code{config-file} (default: @code{#f}) +The configuration file to use. This is required. It will be passed to +@code{dhcpd} via its @code{-cf} option. This may be any ``file-like'' +object (@pxref{G-Ausdrücke, file-like objects}). See @code{man +dhcpd.conf} for details on the configuration file syntax. +@item @code{version} (default: @code{"4"}) +The DHCP version to use. The ISC DHCP server supports the values ``4'', +``6'', and ``4o6''. These correspond to the @code{dhcpd} program options +@code{-4}, @code{-6}, and @code{-4o6}. See @code{man dhcpd} for details. +@item @code{run-directory} (default: @code{"/run/dhcpd"}) +The run directory to use. At service activation time, this directory will +be created if it does not exist. +@item @code{pid-file} (default: @code{"/run/dhcpd/dhcpd.pid"}) +The PID file to use. This corresponds to the @code{-pf} option of +@code{dhcpd}. See @code{man dhcpd} for details. +@item @code{interfaces} (default: @code{'()}) +The names of the network interfaces on which dhcpd should listen for +broadcasts. If this list is not empty, then its elements (which must be +strings) will be appended to the @code{dhcpd} invocation when starting the +daemon. It may not be necessary to explicitly specify any interfaces here; +see @code{man dhcpd} for details. +@end table +@end deftp + +@defvr {Scheme Variable} static-networking-service-type +@c TODO Document <static-networking> data structures. +This is the type for statically-configured network interfaces. +@end defvr + +@deffn {Scheme Procedure} static-networking-service @var{interface} @var{ip} @ + [#:netmask #f] [#:gateway #f] [#:name-servers @code{'()}] @ [#:requirement +@code{'(udev)}] Return a service that starts @var{interface} with address +@var{ip}. If @var{netmask} is true, use it as the network mask. If +@var{gateway} is true, it must be a string specifying the default network +gateway. @var{requirement} can be used to declare a dependency on another +service before configuring the interface. + +This procedure can be called several times, one for each network interface +of interest. Behind the scenes what it does is extend +@code{static-networking-service-type} with additional network interfaces to +handle. + +For example: + +@example +(static-networking-service "eno1" "192.168.1.82" + #:gateway "192.168.1.2" + #:name-servers '("192.168.1.2")) +@end example +@end deffn + +@cindex wicd +@cindex wireless +@cindex WiFi +@cindex network management +@deffn {Scheme Procedure} wicd-service [#:wicd @var{wicd}] +Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network +management daemon that aims to simplify wired and wireless networking. + +This service adds the @var{wicd} package to the global profile, providing +several commands to interact with the daemon and configure networking: +@command{wicd-client}, a graphical user interface, and the +@command{wicd-cli} and @command{wicd-curses} user interfaces. +@end deffn + +@cindex ModemManager + +@defvr {Scheme Variable} modem-manager-service-type +This is the service type for the +@uref{https://wiki.gnome.org/Projects/ModemManager, ModemManager} +service. The value for this service type is a +@code{modem-manager-configuration} record. + +This service is part of @code{%desktop-services} (@pxref{Desktop-Dienste}). +@end defvr + +@deftp {Data Type} modem-manager-configuration +Data type representing the configuration of ModemManager. + +@table @asis +@item @code{modem-manager} (default: @code{modem-manager}) +The ModemManager package to use. + +@end table +@end deftp + +@cindex NetworkManager + +@defvr {Scheme Variable} network-manager-service-type +This is the service type for the +@uref{https://wiki.gnome.org/Projects/NetworkManager, NetworkManager} +service. The value for this service type is a +@code{network-manager-configuration} record. + +This service is part of @code{%desktop-services} (@pxref{Desktop-Dienste}). +@end defvr + +@deftp {Data Type} network-manager-configuration +Data type representing the configuration of NetworkManager. + +@table @asis +@item @code{network-manager} (default: @code{network-manager}) +The NetworkManager package to use. + +@item @code{dns} (default: @code{"default"}) +Processing mode for DNS, which affects how NetworkManager uses the +@code{resolv.conf} configuration file. + +@table @samp +@item default +NetworkManager will update @code{resolv.conf} to reflect the nameservers +provided by currently active connections. + +@item dnsmasq +NetworkManager will run @code{dnsmasq} as a local caching nameserver, using +a "split DNS" configuration if you are connected to a VPN, and then update +@code{resolv.conf} to point to the local nameserver. + +@item none +NetworkManager will not modify @code{resolv.conf}. +@end table + +@item @code{vpn-plugins} (default: @code{'()}) +This is the list of available plugins for virtual private networks (VPNs). +An example of this is the @code{network-manager-openvpn} package, which +allows NetworkManager to manage VPNs @i{via} OpenVPN. + +@end table +@end deftp + +@cindex Connman +@deffn {Scheme Variable} connman-service-type +This is the service type to run @url{https://01.org/connman,Connman}, a +network connection manager. + +Its value must be an @code{connman-configuration} record as in this example: + +@example +(service connman-service-type + (connman-configuration + (disable-vpn? #t))) +@end example + +See below for details about @code{connman-configuration}. +@end deffn + +@deftp {Data Type} connman-configuration +Data Type representing the configuration of connman. + +@table @asis +@item @code{connman} (default: @var{connman}) +The connman package to use. + +@item @code{disable-vpn?} (default: @code{#f}) +When true, enable connman's vpn plugin. +@end table +@end deftp + +@cindex WPA Supplicant +@defvr {Scheme Variable} wpa-supplicant-service-type +This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA +supplicant}, an authentication daemon required to authenticate against +encrypted WiFi or ethernet networks. +@end defvr + +@deftp {Data Type} wpa-supplicant-configuration +Data type representing the configuration of WPA Supplicant. + +It takes the following parameters: + +@table @asis +@item @code{wpa-supplicant} (default: @code{wpa-supplicant}) +The WPA Supplicant package to use. + +@item @code{dbus?} (default: @code{#t}) +Whether to listen for requests on D-Bus. + +@item @code{pid-file} (default: @code{"/var/run/wpa_supplicant.pid"}) +Where to store the PID file. + +@item @code{interface} (default: @code{#f}) +If this is set, it must specify the name of a network interface that WPA +supplicant will control. + +@item @code{config-file} (default: @code{#f}) +Optional configuration file to use. + +@item @code{extra-options} (default: @code{'()}) +List of additional command-line arguments to pass to the daemon. +@end table +@end deftp + +@cindex iptables +@defvr {Scheme Variable} iptables-service-type +This is the service type to set up an iptables configuration. iptables is a +packet filtering framework supported by the Linux kernel. This service +supports configuring iptables for both IPv4 and IPv6. A simple example +configuration rejecting all incoming connections except those to the ssh +port 22 is shown below. + +@lisp +(service iptables-service-type + (iptables-configuration + (ipv4-rules (plain-file "iptables.rules" "*filter +:INPUT ACCEPT +:FORWARD ACCEPT +:OUTPUT ACCEPT +-A INPUT -p tcp --dport 22 -j ACCEPT +-A INPUT -j REJECT --reject-with icmp-port-unreachable +COMMIT +")) + (ipv6-rules (plain-file "ip6tables.rules" "*filter +:INPUT ACCEPT +:FORWARD ACCEPT +:OUTPUT ACCEPT +-A INPUT -p tcp --dport 22 -j ACCEPT +-A INPUT -j REJECT --reject-with icmp6-port-unreachable +COMMIT +")))) +@end lisp +@end defvr + +@deftp {Data Type} iptables-configuration +The data type representing the configuration of iptables. + +@table @asis +@item @code{iptables} (default: @code{iptables}) +The iptables package that provides @code{iptables-restore} and +@code{ip6tables-restore}. +@item @code{ipv4-rules} (default: @code{%iptables-accept-all-rules}) +The iptables rules to use. It will be passed to @code{iptables-restore}. +This may be any ``file-like'' object (@pxref{G-Ausdrücke, file-like +objects}). +@item @code{ipv6-rules} (default: @code{%iptables-accept-all-rules}) +The ip6tables rules to use. It will be passed to @code{ip6tables-restore}. +This may be any ``file-like'' object (@pxref{G-Ausdrücke, file-like +objects}). +@end table +@end deftp + +@cindex NTP (Network Time Protocol), service +@cindex real time clock +@defvr {Scheme Variable} ntp-service-type +This is the type of the service running the the @uref{http://www.ntp.org, +Network Time Protocol (NTP)} daemon, @command{ntpd}. The daemon will keep +the system clock synchronized with that of the specified NTP servers. + +The value of this service is an @code{ntpd-configuration} object, as +described below. +@end defvr + +@deftp {Data Type} ntp-configuration +This is the data type for the NTP service configuration. + +@table @asis +@item @code{servers} (default: @code{%ntp-servers}) +This is the list of servers (host names) with which @command{ntpd} will be +synchronized. + +@item @code{allow-large-adjustment?} (default: @code{#f}) +This determines whether @command{ntpd} is allowed to make an initial +adjustment of more than 1,000 seconds. + +@item @code{ntp} (default: @code{ntp}) +The NTP package to use. +@end table +@end deftp + +@defvr {Scheme Variable} %ntp-servers +List of host names used as the default NTP servers. These are servers of +the @uref{https://www.ntppool.org/en/, NTP Pool Project}. +@end defvr + +@cindex OpenNTPD +@deffn {Scheme Procedure} openntpd-service-type +Run the @command{ntpd}, the Network Time Protocol (NTP) daemon, as +implemented by @uref{http://www.openntpd.org, OpenNTPD}. The daemon will +keep the system clock synchronized with that of the given servers. + +@example +(service + openntpd-service-type + (openntpd-configuration + (listen-on '("127.0.0.1" "::1")) + (sensor '("udcf0 correction 70000")) + (constraint-from '("www.gnu.org")) + (constraints-from '("https://www.google.com/")) + (allow-large-adjustment? #t))) + +@end example +@end deffn + +@deftp {Data Type} openntpd-configuration +@table @asis +@item @code{openntpd} (default: @code{(file-append openntpd "/sbin/ntpd")}) +The openntpd executable to use. +@item @code{listen-on} (default: @code{'("127.0.0.1" "::1")}) +A list of local IP addresses or hostnames the ntpd daemon should listen on. +@item @code{query-from} (default: @code{'()}) +A list of local IP address the ntpd daemon should use for outgoing queries. +@item @code{sensor} (default: @code{'()}) +Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} +will listen to each sensor that acutally exists and ignore non-existant +ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} +for more information. +@item @code{server} (default: @var{%ntp-servers}) +Specify a list of IP addresses or hostnames of NTP servers to synchronize +to. +@item @code{servers} (default: @code{'()}) +Specify a list of IP addresses or hostnames of NTP pools to synchronize to. +@item @code{constraint-from} (default: @code{'()}) +@code{ntpd} can be configured to query the ‘Date’ from trusted HTTPS servers +via TLS. This time information is not used for precision but acts as an +authenticated constraint, thereby reducing the impact of unauthenticated NTP +man-in-the-middle attacks. Specify a list of URLs, IP addresses or +hostnames of HTTPS servers to provide a constraint. +@item @code{constraints-from} (default: @code{'()}) +As with constraint from, specify a list of URLs, IP addresses or hostnames +of HTTPS servers to provide a constraint. Should the hostname resolve to +multiple IP addresses, @code{ntpd} will calculate a median constraint from +all of them. +@item @code{allow-large-adjustment?} (default: @code{#f}) +Determines if @code{ntpd} is allowed to make an initial adjustment of more +than 180 seconds. +@end table +@end deftp + +@cindex inetd +@deffn {Scheme variable} inetd-service-type +This service runs the @command{inetd} (@pxref{inetd invocation,,, inetutils, +GNU Inetutils}) daemon. @command{inetd} listens for connections on internet +sockets, and lazily starts the specified server program when a connection is +made on one of these sockets. + +The value of this service is an @code{inetd-configuration} object. The +following example configures the @command{inetd} daemon to provide the +built-in @command{echo} service, as well as an smtp service which forwards +smtp traffic over ssh to a server @code{smtp-server} behind a gateway +@code{hostname}: + +@example +(service + inetd-service-type + (inetd-configuration + (entries (list + (inetd-entry + (name "echo") + (socket-type 'stream) + (protocol "tcp") + (wait? #f) + (user "root")) + (inetd-entry + (node "127.0.0.1") + (name "smtp") + (socket-type 'stream) + (protocol "tcp") + (wait? #f) + (user "root") + (program (file-append openssh "/bin/ssh")) + (arguments + '("ssh" "-qT" "-i" "/path/to/ssh_key" + "-W" "smtp-server:25" "user@@hostname"))))) +@end example + +See below for more details about @code{inetd-configuration}. +@end deffn + +@deftp {Data Type} inetd-configuration +Data type representing the configuration of @command{inetd}. + +@table @asis +@item @code{program} (default: @code{(file-append inetutils "/libexec/inetd")}) +The @command{inetd} executable to use. + +@item @code{entries} (default: @code{'()}) +A list of @command{inetd} service entries. Each entry should be created by +the @code{inetd-entry} constructor. +@end table +@end deftp + +@deftp {Data Type} inetd-entry +Data type representing an entry in the @command{inetd} configuration. Each +entry corresponds to a socket where @command{inetd} will listen for +requests. + +@table @asis +@item @code{node} (Vorgabe: @code{#f}) +Optional string, a comma-separated list of local addresses @command{inetd} +should use when listening for this service. @xref{Configuration file,,, +inetutils, GNU Inetutils} for a complete description of all options. +@item @code{name} +A string, the name must correspond to an entry in @code{/etc/services}. +@item @code{socket-type} +One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or +@code{'seqpacket}. +@item @code{protocol} +A string, must correspond to an entry in @code{/etc/protocols}. +@item @code{wait?} (Vorgabe: @code{#t}) +Whether @command{inetd} should wait for the server to exit before listening +to new service requests. +@item @code{user} +A string containing the user (and, optionally, group) name of the user as +whom the server should run. The group name can be specified in a suffix, +separated by a colon or period, i.e. @code{"user"}, @code{"user:group"} or +@code{"user.group"}. +@item @code{program} (default: @code{"internal"}) +The server program which will serve the requests, or @code{"internal"} if +@command{inetd} should use a built-in service. +@item @code{arguments} (default: @code{'()}) +A list strings or file-like objects, which are the server program's +arguments, starting with the zeroth argument, i.e. the name of the program +itself. For @command{inetd}'s internal services, this entry must be +@code{'()} or @code{'("internal")}. +@end table + +@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed +discussion of each configuration field. +@end deftp + +@cindex Tor +@defvr {Scheme Variable} tor-service-type +This is the type for a service that runs the @uref{https://torproject.org, +Tor} anonymous networking daemon. The service is configured using a +@code{<tor-configuration>} record. By default, the Tor daemon runs as the +@code{tor} unprivileged user, which is a member of the @code{tor} group. + +@end defvr + +@deffn {Scheme Procedure} tor-service [@var{config-file}] [#:tor @var{tor}] +This procedure is deprecated and will be removed in a future release. +Return a service of the @code{tor-service-type} type. @var{config-file} and +@var{tor} have the same meaning as in @code{<tor-configuration>}. +@end deffn + +@deftp {Data Type} tor-configuration +@table @asis +@item @code{tor} (default: @code{tor}) +The package that provides the Tor daemon. This package is expected to +provide the daemon at @file{bin/tor} relative to its output directory. The +default package is the @uref{https://www.torproject.org, Tor Project's} +implementation. + +@item @code{config-file} (default: @code{(plain-file "empty" "")}) +The configuration file to use. It will be appended to a default +configuration file, and the final configuration file will be passed to +@code{tor} via its @code{-f} option. This may be any ``file-like'' object +(@pxref{G-Ausdrücke, file-like objects}). See @code{man tor} for details +on the configuration file syntax. + +@item @code{hidden-services} (default: @code{'()}) +The list of @code{<hidden-service>} records to use. For any hidden service +you include in this list, appropriate configuration to enable the hidden +service will be automatically added to the default configuration file. You +may conveniently create @code{<hidden-service>} records using the +@code{tor-hidden-service} procedure described below. + +@item @code{socks-socket-type} (default: @code{'tcp}) +The default socket type that Tor should use for its SOCKS socket. This must +be either @code{'tcp} or @code{'unix}. If it is @code{'tcp}, then by +default Tor will listen on TCP port 9050 on the loopback interface (i.e., +localhost). If it is @code{'unix}, then Tor will listen on the UNIX domain +socket @file{/var/run/tor/socks-sock}, which will be made writable by +members of the @code{tor} group. + +If you want to customize the SOCKS socket in more detail, leave +@code{socks-socket-type} at its default value of @code{'tcp} and use +@code{config-file} to override the default by providing your own +@code{SocksPort} option. +@end table +@end deftp + +@cindex hidden service +@deffn {Scheme Procedure} tor-hidden-service @var{name} @var{mapping} +Define a new Tor @dfn{hidden service} called @var{name} and implementing +@var{mapping}. @var{mapping} is a list of port/host tuples, such as: + +@example + '((22 "127.0.0.1:22") + (80 "127.0.0.1:8080")) +@end example + +In this example, port 22 of the hidden service is mapped to local port 22, +and port 80 is mapped to local port 8080. + +This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, +where the @file{hostname} file contains the @code{.onion} host name for the +hidden service. + +See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the +Tor project's documentation} for more information. +@end deffn + +The @code{(gnu services rsync)} module provides the following services: + +You might want an rsync daemon if you have files that you want available so +anyone (or just yourself) can download existing files or upload new files. + +@deffn {Scheme Variable} rsync-service-type +This is the type for the @uref{https://rsync.samba.org, rsync} rsync daemon, +@command{rsync-configuration} record as in this example: + +@example +(service rsync-service-type) +@end example + +See below for details about @code{rsync-configuration}. +@end deffn + +@deftp {Data Type} rsync-configuration +Data type representing the configuration for @code{rsync-service}. + +@table @asis +@item @code{package} (default: @var{rsync}) +@code{rsync} package to use. + +@item @code{port-number} (default: @code{873}) +TCP port on which @command{rsync} listens for incoming connections. If port +is less than @code{1024} @command{rsync} needs to be started as the +@code{root} user and group. + +@item @code{pid-file} (default: @code{"/var/run/rsyncd/rsyncd.pid"}) +Name of the file where @command{rsync} writes its PID. + +@item @code{lock-file} (default: @code{"/var/run/rsyncd/rsyncd.lock"}) +Name of the file where @command{rsync} writes its lock file. + +@item @code{log-file} (default: @code{"/var/log/rsyncd.log"}) +Name of the file where @command{rsync} writes its log file. + +@item @code{use-chroot?} (default: @var{#t}) +Whether to use chroot for @command{rsync} shared directory. + +@item @code{share-path} (default: @file{/srv/rsync}) +Location of the @command{rsync} shared directory. + +@item @code{share-comment} (default: @code{"Rsync share"}) +Comment of the @command{rsync} shared directory. + +@item @code{read-only?} (default: @var{#f}) +Read-write permissions to shared directory. + +@item @code{timeout} (default: @code{300}) +I/O timeout in seconds. + +@item @code{user} (default: @var{"root"}) +Owner of the @code{rsync} process. + +@item @code{group} (default: @var{"root"}) +Group of the @code{rsync} process. + +@item @code{uid} (default: @var{"rsyncd"}) +User name or user ID that file transfers to and from that module should take +place as when the daemon was run as @code{root}. + +@item @code{gid} (default: @var{"rsyncd"}) +Group name or group ID that will be used when accessing the module. + +@end table +@end deftp + +Furthermore, @code{(gnu services ssh)} provides the following services. +@cindex SSH +@cindex SSH server + +@deffn {Scheme Procedure} lsh-service [#:host-key "/etc/lsh/host-key"] @ + [#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ +[#:allow-empty-passwords? #f] [#:root-login? #f] @ [#:syslog-output? #t] +[#:x11-forwarding? #t] @ [#:tcp/ip-forwarding? #t] +[#:password-authentication? #t] @ [#:public-key-authentication? #t] +[#:initialize? #t] Run the @command{lshd} program from @var{lsh} to listen +on port @var{port-number}. @var{host-key} must designate a file containing +the host key, and readable only by root. + +When @var{daemonic?} is true, @command{lshd} will detach from the +controlling terminal and log its output to syslogd, unless one sets +@var{syslog-output?} to false. Obviously, it also makes lsh-service depend +on existence of syslogd service. When @var{pid-file?} is true, +@command{lshd} writes its PID to the file called @var{pid-file}. + +When @var{initialize?} is true, automatically create the seed and host key +upon service activation if they do not exist yet. This may take long and +require interaction. + +When @var{initialize?} is false, it is up to the user to initialize the +randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to +create a key pair with the private key stored in file @var{host-key} +(@pxref{lshd basics,,, lsh, LSH Manual}). + +When @var{interfaces} is empty, lshd listens for connections on all the +network interfaces; otherwise, @var{interfaces} must be a list of host names +or addresses. + +@var{allow-empty-passwords?} specifies whether to accept log-ins with empty +passwords, and @var{root-login?} specifies whether to accept log-ins as +root. + +The other options should be self-descriptive. +@end deffn + +@cindex SSH +@cindex SSH server +@deffn {Scheme Variable} openssh-service-type +This is the type for the @uref{http://www.openssh.org, OpenSSH} secure shell +daemon, @command{sshd}. Its value must be an @code{openssh-configuration} +record as in this example: + +@example +(service openssh-service-type + (openssh-configuration + (x11-forwarding? #t) + (permit-root-login 'without-password) + (authorized-keys + `(("alice" ,(local-file "alice.pub")) + ("bob" ,(local-file "bob.pub")))))) +@end example + +See below for details about @code{openssh-configuration}. + +This service can be extended with extra authorized keys, as in this example: + +@example +(service-extension openssh-service-type + (const `(("charlie" + ,(local-file "charlie.pub"))))) +@end example +@end deffn + +@deftp {Data Type} openssh-configuration +This is the configuration record for OpenSSH's @command{sshd}. + +@table @asis +@item @code{pid-file} (default: @code{"/var/run/sshd.pid"}) +Name of the file where @command{sshd} writes its PID. + +@item @code{port-number} (default: @code{22}) +TCP port on which @command{sshd} listens for incoming connections. + +@item @code{permit-root-login} (default: @code{#f}) +This field determines whether and when to allow logins as root. If +@code{#f}, root logins are disallowed; if @code{#t}, they are allowed. If +it's the symbol @code{'without-password}, then root logins are permitted but +not with password-based authentication. + +@item @code{allow-empty-passwords?} (default: @code{#f}) +When true, users with empty passwords may log in. When false, they may not. + +@item @code{password-authentication?} (default: @code{#t}) +When true, users may log in with their password. When false, they have +other authentication methods. + +@item @code{public-key-authentication?} (default: @code{#t}) +When true, users may log in using public key authentication. When false, +users have to use other authentication method. + +Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is +used only by protocol version 2. + +@item @code{x11-forwarding?} (default: @code{#f}) +When true, forwarding of X11 graphical client connections is enabled---in +other words, @command{ssh} options @option{-X} and @option{-Y} will work. + +@item @code{allow-agent-forwarding?} (default: @code{#t}) +Whether to allow agent forwarding. + +@item @code{allow-tcp-forwarding?} (default: @code{#t}) +Whether to allow TCP forwarding. + +@item @code{gateway-ports?} (default: @code{#f}) +Whether to allow gateway ports. + +@item @code{challenge-response-authentication?} (default: @code{#f}) +Specifies whether challenge response authentication is allowed (e.g. via +PAM). + +@item @code{use-pam?} (default: @code{#t}) +Enables the Pluggable Authentication Module interface. If set to @code{#t}, +this will enable PAM authentication using +@code{challenge-response-authentication?} and +@code{password-authentication?}, in addition to PAM account and session +module processing for all authentication types. + +Because PAM challenge response authentication usually serves an equivalent +role to password authentication, you should disable either +@code{challenge-response-authentication?} or +@code{password-authentication?}. + +@item @code{print-last-log?} (default: @code{#t}) +Specifies whether @command{sshd} should print the date and time of the last +user login when a user logs in interactively. + +@item @code{subsystems} (default: @code{'(("sftp" "internal-sftp"))}) +Configures external subsystems (e.g. file transfer daemon). + +This is a list of two-element lists, each of which containing the subsystem +name and a command (with optional arguments) to execute upon subsystem +request. + +The command @command{internal-sftp} implements an in-process SFTP server. +Alternately, one can specify the @command{sftp-server} command: +@example +(service openssh-service-type + (openssh-configuration + (subsystems + `(("sftp" ,(file-append openssh "/libexec/sftp-server")))))) +@end example + +@item @code{accepted-environment} (default: @code{'()}) +List of strings describing which environment variables may be exported. + +Each string gets on its own line. See the @code{AcceptEnv} option in +@code{man sshd_config}. + +This example allows ssh-clients to export the @code{COLORTERM} variable. It +is set by terminal emulators, which support colors. You can use it in your +shell's ressource file to enable colors for the prompt and commands if this +variable is set. + +@example +(service openssh-service-type + (openssh-configuration + (accepted-environment '("COLORTERM")))) +@end example + +@item @code{authorized-keys} (default: @code{'()}) +@cindex authorized keys, SSH +@cindex SSH authorized keys +This is the list of authorized keys. Each element of the list is a user +name followed by one or more file-like objects that represent SSH public +keys. For example: + +@example +(openssh-configuration + (authorized-keys + `(("rekado" ,(local-file "rekado.pub")) + ("chris" ,(local-file "chris.pub")) + ("root" ,(local-file "rekado.pub") ,(local-file "chris.pub"))))) +@end example + +@noindent +registers the specified public keys for user accounts @code{rekado}, +@code{chris}, and @code{root}. + +Additional authorized keys can be specified @i{via} +@code{service-extension}. + +Note that this does @emph{not} interfere with the use of +@file{~/.ssh/authorized_keys}. + +@item @code{log-level} (default: @code{'info}) +This is a symbol specifying the logging level: @code{quiet}, @code{fatal}, +@code{error}, @code{info}, @code{verbose}, @code{debug}, etc. See the man +page for @file{sshd_config} for the full list of level names. + +@end table +@end deftp + +@deffn {Scheme Procedure} dropbear-service [@var{config}] +Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH +daemon} with the given @var{config}, a @code{<dropbear-configuration>} +object. + +For example, to specify a Dropbear service listening on port 1234, add this +call to the operating system's @code{services} field: + +@example +(dropbear-service (dropbear-configuration + (port-number 1234))) +@end example +@end deffn + +@deftp {Data Type} dropbear-configuration +This data type represents the configuration of a Dropbear SSH daemon. + +@table @asis +@item @code{dropbear} (default: @var{dropbear}) +The Dropbear package to use. + +@item @code{port-number} (default: 22) +The TCP port where the daemon waits for incoming connections. + +@item @code{syslog-output?} (default: @code{#t}) +Whether to enable syslog output. + +@item @code{pid-file} (default: @code{"/var/run/dropbear.pid"}) +File name of the daemon's PID file. + +@item @code{root-login?} (default: @code{#f}) +Whether to allow @code{root} logins. + +@item @code{allow-empty-passwords?} (default: @code{#f}) +Whether to allow empty passwords. + +@item @code{password-authentication?} (default: @code{#t}) +Whether to enable password-based authentication. +@end table +@end deftp + +@defvr {Scheme Variable} %facebook-host-aliases +This variable contains a string for use in @file{/etc/hosts} (@pxref{Host +Names,,, libc, The GNU C Library Reference Manual}). Each line contains a +entry that maps a known server name of the Facebook on-line service---e.g., +@code{www.facebook.com}---to the local host---@code{127.0.0.1} or its IPv6 +equivalent, @code{::1}. + +This variable is typically used in the @code{hosts-file} field of an +@code{operating-system} declaration (@pxref{„operating-system“-Referenz, +@file{/etc/hosts}}): + +@example +(use-modules (gnu) (guix)) + +(operating-system + (host-name "mymachine") + ;; ... + (hosts-file + ;; Create a /etc/hosts file with aliases for "localhost" + ;; and "mymachine", as well as for Facebook servers. + (plain-file "hosts" + (string-append (local-host-aliases host-name) + %facebook-host-aliases)))) +@end example + +This mechanism can prevent programs running locally, such as Web browsers, +from accessing Facebook. +@end defvr + +The @code{(gnu services avahi)} provides the following definition. + +@deffn {Scheme Procedure} avahi-service [#:avahi @var{avahi}] @ + [#:host-name #f] [#:publish? #t] [#:ipv4? #t] @ [#:ipv6? #t] [#:wide-area? +#f] @ [#:domains-to-browse '()] [#:debug? #f] Return a service that runs +@command{avahi-daemon}, a system-wide mDNS/DNS-SD responder that allows for +service discovery and "zero-configuration" host name lookups (see +@uref{http://avahi.org/}), and extends the name service cache daemon (nscd) +so that it can resolve @code{.local} host names using +@uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. +Additionally, add the @var{avahi} package to the system profile so that +commands such as @command{avahi-browse} are directly usable. + +If @var{host-name} is different from @code{#f}, use that as the host name to +publish for this machine; otherwise, use the machine's actual host name. + +When @var{publish?} is true, publishing of host names and services is +allowed; in particular, avahi-daemon will publish the machine's host name +and IP address via mDNS on the local network. + +When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled. + +Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use +IPv4/IPv6 sockets. +@end deffn + +@deffn {Scheme Variable} openvswitch-service-type +This is the type of the @uref{http://www.openvswitch.org, Open vSwitch} +service, whose value should be an @code{openvswitch-configuration} object. +@end deffn + +@deftp {Data Type} openvswitch-configuration +Data type representing the configuration of Open vSwitch, a multilayer +virtual switch which is designed to enable massive network automation +through programmatic extension. + +@table @asis +@item @code{package} (default: @var{openvswitch}) +Package object of the Open vSwitch. + +@end table +@end deftp + +@node X Window +@subsubsection X Window + +@cindex X11 +@cindex X Window System +@cindex login manager +Support for the X Window graphical display system---specifically Xorg---is +provided by the @code{(gnu services xorg)} module. Note that there is no +@code{xorg-service} procedure. Instead, the X server is started by the +@dfn{login manager}, by default SLiM. + +@cindex window manager +To use X11, you must install at least one @dfn{window manager}---for example +the @code{windowmaker} or @code{openbox} packages---preferably by adding it +to the @code{packages} field of your operating system definition +(@pxref{„operating-system“-Referenz, system-wide packages}). + +@defvr {Scheme Variable} slim-service-type +This is the type for the SLiM graphical login manager for X11. + +@cindex session types (X11) +@cindex X11 session types +SLiM looks for @dfn{session types} described by the @file{.desktop} files in +@file{/run/current-system/profile/share/xsessions} and allows users to +choose a session from the log-in screen using @kbd{F1}. Packages such as +@code{xfce}, @code{sawfish}, and @code{ratpoison} provide @file{.desktop} +files; adding them to the system-wide set of packages automatically makes +them available at the log-in screen. + +In addition, @file{~/.xsession} files are honored. When available, +@file{~/.xsession} must be an executable that starts a window manager and/or +other X clients. +@end defvr + +@deftp {Data Type} slim-configuration +Data type representing the configuration of @code{slim-service-type}. + +@table @asis +@item @code{allow-empty-passwords?} (default: @code{#t}) +Whether to allow logins with empty passwords. + +@item @code{auto-login?} (default: @code{#f}) +@itemx @code{default-user} (default: @code{""}) +When @code{auto-login?} is false, SLiM presents a log-in screen. + +When @code{auto-login?} is true, SLiM logs in directly as +@code{default-user}. + +@item @code{theme} (default: @code{%default-slim-theme}) +@itemx @code{theme-name} (default: @code{%default-slim-theme-name}) +The graphical theme to use and its name. + +@item @code{auto-login-session} (default: @code{#f}) +If true, this must be the name of the executable to start as the default +session---e.g., @code{(file-append windowmaker "/bin/windowmaker")}. + +If false, a session described by one of the available @file{.desktop} files +in @code{/run/current-system/profile} and @code{~/.guix-profile} will be +used. + +@quotation Anmerkung +You must install at least one window manager in the system profile or in +your user profile. Failing to do that, if @code{auto-login-session} is +false, you will be unable to log in. +@end quotation + +@item @code{startx} (default: @code{(xorg-start-command)}) +The command used to start the X11 graphical server. + +@item @code{xauth} (default: @code{xauth}) +The XAuth package to use. + +@item @code{shepherd} (default: @code{shepherd}) +The Shepherd package used when invoking @command{halt} and @command{reboot}. + +@item @code{sessreg} (default: @code{sessreg}) +The sessreg package used in order to register the session. + +@item @code{slim} (default: @code{slim}) +The SLiM package to use. +@end table +@end deftp + +@defvr {Scheme Variable} %default-theme +@defvrx {Scheme Variable} %default-theme-name +The default SLiM theme and its name. +@end defvr + + +@deftp {Data Type} sddm-configuration +This is the data type representing the sddm service configuration. + +@table @asis +@item @code{display-server} (default: "x11") +Select display server to use for the greeter. Valid values are "x11" or +"wayland". + +@item @code{numlock} (default: "on") +Valid values are "on", "off" or "none". + +@item @code{halt-command} (default @code{#~(string-apppend #$shepherd "/sbin/halt")}) +Command to run when halting. + +@item @code{reboot-command} (default @code{#~(string-append #$shepherd "/sbin/reboot")}) +Command to run when rebooting. + +@item @code{theme} (default "maldives") +Theme to use. Default themes provided by SDDM are "elarun" or "maldives". + +@item @code{themes-directory} (default "/run/current-system/profile/share/sddm/themes") +Directory to look for themes. + +@item @code{faces-directory} (default "/run/current-system/profile/share/sddm/faces") +Directory to look for faces. + +@item @code{default-path} (default "/run/current-system/profile/bin") +Default PATH to use. + +@item @code{minimum-uid} (default 1000) +Minimum UID to display in SDDM. + +@item @code{maximum-uid} (default 2000) +Maximum UID to display in SDDM + +@item @code{remember-last-user?} (default #t) +Remember last user. + +@item @code{remember-last-session?} (default #t) +Remember last session. + +@item @code{hide-users} (default "") +Usernames to hide from SDDM greeter. + +@item @code{hide-shells} (default @code{#~(string-append #$shadow "/sbin/nologin")}) +Users with shells listed will be hidden from the SDDM greeter. + +@item @code{session-command} (default @code{#~(string-append #$sddm "/share/sddm/scripts/wayland-session")}) +Script to run before starting a wayland session. + +@item @code{sessions-directory} (default "/run/current-system/profile/share/wayland-sessions") +Directory to look for desktop files starting wayland sessions. + +@item @code{xorg-server-path} (default @code{xorg-start-command}) +Path to xorg-server. + +@item @code{xauth-path} (default @code{#~(string-append #$xauth "/bin/xauth")}) +Path to xauth. + +@item @code{xephyr-path} (default @code{#~(string-append #$xorg-server "/bin/Xephyr")}) +Path to Xephyr. + +@item @code{xdisplay-start} (default @code{#~(string-append #$sddm "/share/sddm/scripts/Xsetup")}) +Script to run after starting xorg-server. + +@item @code{xdisplay-stop} (default @code{#~(string-append #$sddm "/share/sddm/scripts/Xstop")}) +Script to run before stopping xorg-server. + +@item @code{xsession-command} (default: @code{xinitrc}) +Script to run before starting a X session. + +@item @code{xsessions-directory} (default: "/run/current-system/profile/share/xsessions") +Directory to look for desktop files starting X sessions. + +@item @code{minimum-vt} (default: 7) +Minimum VT to use. + +@item @code{xserver-arguments} (default "-nolisten tcp") +Arguments to pass to xorg-server. + +@item @code{auto-login-user} (default "") +User to use for auto-login. + +@item @code{auto-login-session} (default "") +Desktop file to use for auto-login. + +@item @code{relogin?} (default #f) +Relogin after logout. + +@end table +@end deftp + +@cindex login manager +@cindex X11 login +@deffn {Scheme Procedure} sddm-service config +Return a service that spawns the SDDM graphical login manager for config of +type @code{<sddm-configuration>}. + +@example + (sddm-service (sddm-configuration + (auto-login-user "Alice") + (auto-login-session "xfce.desktop"))) +@end example +@end deffn + +@deffn {Scheme Procedure} xorg-start-command [#:guile] @ + [#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ +[#:configuration-file (xorg-configuration-file @dots{})] @ [#:xorg-server +@var{xorg-server}] Return a @code{startx} script in which @var{modules}, a +list of X module packages, and @var{fonts}, a list of X font directories, +are available. See @code{xorg-wrapper} for more details on the arguments. +The result should be used in place of @code{startx}. + +Usually the X server is started by a login manager. +@end deffn + +@deffn {Scheme Procedure} xorg-configuration-file @ + [#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ +[#:drivers '()] [#:resolutions '()] [#:extra-config '()] Return a +configuration file for the Xorg server containing search paths for all the +common drivers. + +@var{modules} must be a list of @dfn{module packages} loaded by the Xorg +server---e.g., @code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so +on. @var{fonts} must be a list of font directories to add to the server's +@dfn{font path}. + +@var{drivers} must be either the empty list, in which case Xorg chooses a +graphics driver automatically, or a list of driver names that will be tried +in this order---e.g., @code{("modesetting" "vesa")}. + +Likewise, when @var{resolutions} is the empty list, Xorg chooses an +appropriate screen resolution; otherwise, it must be a list of +resolutions---e.g., @code{((1024 768) (640 480))}. + +Last, @var{extra-config} is a list of strings or objects appended to the +configuration file. It is used to pass extra text to be added verbatim to +the configuration file. + +@cindex keymap +@cindex keyboard layout +This procedure is especially useful to configure a different keyboard layout +than the default US keymap. For instance, to use the ``bépo'' keymap by +default on the display manager: + +@example +(define bepo-evdev + "Section \"InputClass\" + Identifier \"evdev keyboard catchall\" + Driver \"evdev\" + MatchIsKeyboard \"on\" + Option \"xkb_layout\" \"fr\" + Option \"xkb_variant\" \"bepo\" +EndSection") + +(operating-system + ... + (services + (modify-services %desktop-services + (slim-service-type config => + (slim-configuration + (inherit config) + (startx (xorg-start-command + #:configuration-file + (xorg-configuration-file + #:extra-config + (list bepo-evdev))))))))) +@end example + +The @code{MatchIsKeyboard} line specifies that we only apply the +configuration to keyboards. Without this line, other devices such as +touchpad may not work correctly because they will be attached to the wrong +driver. In this example, the user typically used @code{setxkbmap fr bepo} +to set their favorite keymap once logged in. The first argument corresponds +to the layout, while the second argument corresponds to the variant. The +@code{xkb_variant} line can be omitted to select the default variant. +@end deffn + +@deffn {Scheme Procedure} screen-locker-service @var{package} [@var{program}] +Add @var{package}, a package for a screen locker or screen saver whose +command is @var{program}, to the set of setuid programs and add a PAM entry +for it. For example: + +@lisp +(screen-locker-service xlockmore "xlock") +@end lisp + +makes the good ol' XlockMore usable. +@end deffn + + +@node Druckdienste +@subsubsection Druckdienste + +@cindex printer support with CUPS +The @code{(gnu services cups)} module provides a Guix service definition for +the CUPS printing service. To add printer support to a GuixSD system, add a +@code{cups-service} to the operating system definition: + +@deffn {Scheme Variable} cups-service-type +The service type for the CUPS print server. Its value should be a valid +CUPS configuration (see below). To use the default settings, simply write: +@example +(service cups-service-type) +@end example +@end deffn + +The CUPS configuration controls the basic things about your CUPS +installation: what interfaces it listens on, what to do if a print job +fails, how much logging to do, and so on. To actually add a printer, you +have to visit the @url{http://localhost:631} URL, or use a tool such as +GNOME's printer configuration services. By default, configuring a CUPS +service will generate a self-signed certificate if needed, for secure +connections to the print server. + +Suppose you want to enable the Web interface of CUPS and also add support +for Epson printers @i{via} the @code{escpr} package and for HP printers +@i{via} the @code{hplip-minimal} package. You can do that directly, like +this (you need to use the @code{(gnu packages cups)} module): + +@example +(service cups-service-type + (cups-configuration + (web-interface? #t) + (extensions + (list cups-filters escpr hplip-minimal)))) +@end example + +Note: If you wish to use the Qt5 based GUI which comes with the hplip +package then it is suggested that you install the @code{hplip} package, +either in your OS configuration file or as your user. + +The available configuration parameters follow. Each parameter definition is +preceded by its type; for example, @samp{string-list foo} indicates that the +@code{foo} parameter should be specified as a list of strings. There is +also a way to specify the configuration as a string, if you have an old +@code{cupsd.conf} file that you want to port over from some other system; +see the end for more details. + +@c The following documentation was initially generated by +@c (generate-documentation) in (gnu services cups). Manually maintained +@c documentation is better, so we shouldn't hesitate to edit below as +@c needed. However if the change you want to make to this documentation +@c can be done in an automated way, it's probably easier to change +@c (generate-documentation) than to make it below and have to deal with +@c the churn as CUPS updates. + + +Available @code{cups-configuration} fields are: + +@deftypevr {@code{cups-configuration} parameter} package cups +The CUPS package. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} package-list extensions +Drivers and other extensions to the CUPS package. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} files-configuration files-configuration +Configuration of where to write logs, what directories to use for print +spools, and related privileged configuration parameters. + +Available @code{files-configuration} fields are: + +@deftypevr {@code{files-configuration} parameter} log-location access-log +Defines the access log filename. Specifying a blank filename disables +access log generation. The value @code{stderr} causes log entries to be +sent to the standard error file when the scheduler is running in the +foreground, or to the system log daemon when run in the background. The +value @code{syslog} causes log entries to be sent to the system log daemon. +The server name may be included in filenames using the string @code{%s}, as +in @code{/var/log/cups/%s-access_log}. + +Defaults to @samp{"/var/log/cups/access_log"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} file-name cache-dir +Where CUPS should cache data. + +Defaults to @samp{"/var/cache/cups"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string config-file-perm +Specifies the permissions for all configuration files that the scheduler +writes. + +Note that the permissions for the printers.conf file are currently masked to +only allow access from the scheduler user (typically root). This is done +because printer device URIs sometimes contain sensitive authentication +information that should not be generally known on the system. There is no +way to disable this security feature. + +Defaults to @samp{"0640"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} log-location error-log +Defines the error log filename. Specifying a blank filename disables access +log generation. The value @code{stderr} causes log entries to be sent to +the standard error file when the scheduler is running in the foreground, or +to the system log daemon when run in the background. The value +@code{syslog} causes log entries to be sent to the system log daemon. The +server name may be included in filenames using the string @code{%s}, as in +@code{/var/log/cups/%s-error_log}. + +Defaults to @samp{"/var/log/cups/error_log"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string fatal-errors +Specifies which errors are fatal, causing the scheduler to exit. The kind +strings are: + +@table @code +@item none +No errors are fatal. + +@item all +All of the errors below are fatal. + +@item browse +Browsing initialization errors are fatal, for example failed connections to +the DNS-SD daemon. + +@item config +Configuration file syntax errors are fatal. + +@item listen +Listen or Port errors are fatal, except for IPv6 failures on the loopback or +@code{any} addresses. + +@item log +Log file creation or write errors are fatal. + +@item permissions +Bad startup file permissions are fatal, for example shared TLS certificate +and key files with world-read permissions. +@end table + +Defaults to @samp{"all -browse"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} boolean file-device? +Specifies whether the file pseudo-device can be used for new printer +queues. The URI @uref{file:///dev/null} is always allowed. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string group +Specifies the group name or ID that will be used when executing external +programs. + +Defaults to @samp{"lp"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string log-file-perm +Specifies the permissions for all log files that the scheduler writes. + +Defaults to @samp{"0644"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} log-location page-log +Defines the page log filename. Specifying a blank filename disables access +log generation. The value @code{stderr} causes log entries to be sent to +the standard error file when the scheduler is running in the foreground, or +to the system log daemon when run in the background. The value +@code{syslog} causes log entries to be sent to the system log daemon. The +server name may be included in filenames using the string @code{%s}, as in +@code{/var/log/cups/%s-page_log}. + +Defaults to @samp{"/var/log/cups/page_log"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string remote-root +Specifies the username that is associated with unauthenticated accesses by +clients claiming to be the root user. The default is @code{remroot}. + +Defaults to @samp{"remroot"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} file-name request-root +Specifies the directory that contains print jobs and other HTTP request +data. + +Defaults to @samp{"/var/spool/cups"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} sandboxing sandboxing +Specifies the level of security sandboxing that is applied to print filters, +backends, and other child processes of the scheduler; either @code{relaxed} +or @code{strict}. This directive is currently only used/supported on macOS. + +Defaults to @samp{strict}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} file-name server-keychain +Specifies the location of TLS certificates and private keys. CUPS will look +for public and private keys in this directory: a @code{.crt} files for +PEM-encoded certificates and corresponding @code{.key} files for PEM-encoded +private keys. + +Defaults to @samp{"/etc/cups/ssl"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} file-name server-root +Specifies the directory containing the server configuration files. + +Defaults to @samp{"/etc/cups"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} boolean sync-on-close? +Specifies whether the scheduler calls fsync(2) after writing configuration +or state files. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} space-separated-string-list system-group +Specifies the group(s) to use for @code{@@SYSTEM} group authentication. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} file-name temp-dir +Specifies the directory where temporary files are stored. + +Defaults to @samp{"/var/spool/cups/tmp"}. +@end deftypevr + +@deftypevr {@code{files-configuration} parameter} string user +Specifies the user name or ID that is used when running external programs. + +Defaults to @samp{"lp"}. +@end deftypevr +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} access-log-level access-log-level +Specifies the logging level for the AccessLog file. The @code{config} level +logs when printers and classes are added, deleted, or modified and when +configuration files are accessed or updated. The @code{actions} level logs +when print jobs are submitted, held, released, modified, or canceled, and +any of the conditions for @code{config}. The @code{all} level logs all +requests. + +Defaults to @samp{actions}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean auto-purge-jobs? +Specifies whether to purge job history data automatically when it is no +longer required for quotas. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols +Specifies which protocols to use for local printer sharing. + +Defaults to @samp{dnssd}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean browse-web-if? +Specifies whether the CUPS web interface is advertised. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean browsing? +Specifies whether shared printers are advertised. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string classification +Specifies the security classification of the server. Any valid banner name +can be used, including "classified", "confidential", "secret", "topsecret", +and "unclassified", or the banner can be omitted to disable secure printing +functions. + +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean classify-override? +Specifies whether users may override the classification (cover page) of +individual print jobs using the @code{job-sheets} option. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} default-auth-type default-auth-type +Specifies the default type of authentication to use. + +Defaults to @samp{Basic}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} default-encryption default-encryption +Specifies whether encryption will be used for authenticated requests. + +Defaults to @samp{Required}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string default-language +Specifies the default language to use for text and web content. + +Defaults to @samp{"en"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string default-paper-size +Specifies the default paper size for new print queues. @samp{"Auto"} uses a +locale-specific default, while @samp{"None"} specifies there is no default +paper size. Specific size names are typically @samp{"Letter"} or +@samp{"A4"}. + +Defaults to @samp{"Auto"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string default-policy +Specifies the default access policy to use. + +Defaults to @samp{"default"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean default-shared? +Specifies whether local printers are shared by default. + +Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval +Specifies the delay for updating of configuration and state files, in +seconds. A value of 0 causes the update to happen as soon as possible, +typically within a few milliseconds. + +Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} error-policy error-policy +Specifies what to do when an error occurs. Possible values are +@code{abort-job}, which will discard the failed print job; @code{retry-job}, +which will retry the job at a later time; @code{retry-this-job}, which +retries the failed job immediately; and @code{stop-printer}, which stops the +printer. + +Defaults to @samp{stop-printer}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer filter-limit +Specifies the maximum cost of filters that are run concurrently, which can +be used to minimize disk, memory, and CPU resource problems. A limit of 0 +disables filter limiting. An average print to a non-PostScript printer +needs a filter limit of about 200. A PostScript printer needs about half +that (100). Setting the limit below these thresholds will effectively limit +the scheduler to printing a single job at any time. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer filter-nice +Specifies the scheduling priority of filters that are run to print a job. +The nice value ranges from 0, the highest priority, to 19, the lowest +priority. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} host-name-lookups host-name-lookups +Specifies whether to do reverse lookups on connecting clients. The +@code{double} setting causes @code{cupsd} to verify that the hostname +resolved from the address matches one of the addresses returned for that +hostname. Double lookups also prevent clients with unregistered addresses +from connecting to your server. Only set this option to @code{#t} or +@code{double} if absolutely required. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer job-kill-delay +Specifies the number of seconds to wait before killing the filters and +backend associated with a canceled or held job. + +Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer job-retry-interval +Specifies the interval between retries of jobs in seconds. This is +typically used for fax queues but can also be used with normal print queues +whose error policy is @code{retry-job} or @code{retry-current-job}. + +Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer job-retry-limit +Specifies the number of retries that are done for jobs. This is typically +used for fax queues but can also be used with normal print queues whose +error policy is @code{retry-job} or @code{retry-current-job}. + +Defaults to @samp{5}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean keep-alive? +Specifies whether to support HTTP keep-alive connections. + +Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout +Specifies how long an idle client connection remains open, in seconds. + +Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer limit-request-body +Specifies the maximum size of print files, IPP requests, and HTML form +data. A limit of 0 disables the limit check. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} multiline-string-list listen +Listens on the specified interfaces for connections. Valid values are of +the form @var{address}:@var{port}, where @var{address} is either an IPv6 +address enclosed in brackets, an IPv4 address, or @code{*} to indicate all +addresses. Values can also be file names of local UNIX domain sockets. The +Listen directive is similar to the Port directive but allows you to restrict +access to specific interfaces or networks. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer listen-back-log +Specifies the number of pending connections that will be allowed. This +normally only affects very busy servers that have reached the MaxClients +limit, but can also be triggered by large numbers of simultaneous +connections. When the limit is reached, the operating system will refuse +additional connections until the scheduler can accept the pending ones. + +Defaults to @samp{128}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} location-access-control-list location-access-controls +Specifies a set of additional access controls. + +Available @code{location-access-controls} fields are: + +@deftypevr {@code{location-access-controls} parameter} file-name path +Specifies the URI path to which the access control applies. +@end deftypevr + +@deftypevr {@code{location-access-controls} parameter} access-control-list access-controls +Access controls for all access to this path, in the same format as the +@code{access-controls} of @code{operation-access-control}. + +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{location-access-controls} parameter} method-access-control-list method-access-controls +Access controls for method-specific access to this path. + +Defaults to @samp{()}. + +Available @code{method-access-controls} fields are: + +@deftypevr {@code{method-access-controls} parameter} boolean reverse? +If @code{#t}, apply access controls to all methods except the listed +methods. Otherwise apply to only the listed methods. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{method-access-controls} parameter} method-list methods +Methods to which this access control applies. + +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{method-access-controls} parameter} access-control-list access-controls +Access control directives, as a list of strings. Each string should be one +directive, such as "Order allow,deny". + +Defaults to @samp{()}. +@end deftypevr +@end deftypevr +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer log-debug-history +Specifies the number of debugging messages that are retained for logging if +an error occurs in a print job. Debug messages are logged regardless of the +LogLevel setting. + +Defaults to @samp{100}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} log-level log-level +Specifies the level of logging for the ErrorLog file. The value @code{none} +stops all logging while @code{debug2} logs everything. + +Defaults to @samp{info}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} log-time-format log-time-format +Specifies the format of the date and time in the log files. The value +@code{standard} logs whole seconds while @code{usecs} logs microseconds. + +Defaults to @samp{standard}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-clients +Specifies the maximum number of simultaneous clients that are allowed by the +scheduler. + +Defaults to @samp{100}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-clients-per-host +Specifies the maximum number of simultaneous clients that are allowed from a +single address. + +Defaults to @samp{100}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-copies +Specifies the maximum number of copies that a user can print of each job. + +Defaults to @samp{9999}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-hold-time +Specifies the maximum time a job may remain in the @code{indefinite} hold +state before it is canceled. A value of 0 disables cancellation of held +jobs. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs +Specifies the maximum number of simultaneous jobs that are allowed. Set to +0 to allow an unlimited number of jobs. + +Defaults to @samp{500}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer +Specifies the maximum number of simultaneous jobs that are allowed per +printer. A value of 0 allows up to MaxJobs jobs per printer. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user +Specifies the maximum number of simultaneous jobs that are allowed per +user. A value of 0 allows up to MaxJobs jobs per user. + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-job-time +Specifies the maximum time a job may take to print before it is canceled, in +seconds. Set to 0 to disable cancellation of "stuck" jobs. + +Defaults to @samp{10800}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer max-log-size +Specifies the maximum size of the log files before they are rotated, in +bytes. The value 0 disables log rotation. + +Defaults to @samp{1048576}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout +Specifies the maximum amount of time to allow between files in a multiple +file print job, in seconds. + +Defaults to @samp{300}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string page-log-format +Specifies the format of PageLog lines. Sequences beginning with percent +(@samp{%}) characters are replaced with the corresponding information, while +all other characters are copied literally. The following percent sequences +are recognized: + +@table @samp +@item %% +insert a single percent character + +@item %@{name@} +insert the value of the specified IPP attribute + +@item %C +insert the number of copies for the current page + +@item %P +insert the current page number + +@item %T +insert the current date and time in common log format + +@item %j +insert the job ID + +@item %p +insert the printer name + +@item %u +insert the username +@end table + +A value of the empty string disables page logging. The string @code{%p %u +%j %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@} +%@{media@} %@{sides@}} creates a page log with the standard items. + +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} environment-variables environment-variables +Passes the specified environment variable(s) to child processes; a list of +strings. + +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} policy-configuration-list policies +Specifies named access control policies. + +Available @code{policy-configuration} fields are: + +@deftypevr {@code{policy-configuration} parameter} string name +Name of the policy. +@end deftypevr + +@deftypevr {@code{policy-configuration} parameter} string job-private-access +Specifies an access list for a job's private values. @code{@@ACL} maps to +the printer's requesting-user-name-allowed or requesting-user-name-denied +values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to +the groups listed for the @code{system-group} field of the +@code{files-config} configuration, which is reified into the +@code{cups-files.conf(5)} file. Other possible elements of the access list +include specific user names, and @code{@@@var{group}} to indicate members of +a specific group. The access list may also be simply @code{all} or +@code{default}. + +Defaults to @samp{"@@OWNER @@SYSTEM"}. +@end deftypevr + +@deftypevr {@code{policy-configuration} parameter} string job-private-values +Specifies the list of job values to make private, or @code{all}, +@code{default}, or @code{none}. + +Defaults to @samp{"job-name job-originating-host-name +job-originating-user-name phone"}. +@end deftypevr + +@deftypevr {@code{policy-configuration} parameter} string subscription-private-access +Specifies an access list for a subscription's private values. @code{@@ACL} +maps to the printer's requesting-user-name-allowed or +requesting-user-name-denied values. @code{@@OWNER} maps to the job's +owner. @code{@@SYSTEM} maps to the groups listed for the +@code{system-group} field of the @code{files-config} configuration, which is +reified into the @code{cups-files.conf(5)} file. Other possible elements of +the access list include specific user names, and @code{@@@var{group}} to +indicate members of a specific group. The access list may also be simply +@code{all} or @code{default}. + +Defaults to @samp{"@@OWNER @@SYSTEM"}. +@end deftypevr + +@deftypevr {@code{policy-configuration} parameter} string subscription-private-values +Specifies the list of job values to make private, or @code{all}, +@code{default}, or @code{none}. + +Defaults to @samp{"notify-events notify-pull-method notify-recipient-uri +notify-subscriber-user-name notify-user-data"}. +@end deftypevr + +@deftypevr {@code{policy-configuration} parameter} operation-access-control-list access-controls +Access control by IPP operation. + +Defaults to @samp{()}. +@end deftypevr +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files +Specifies whether job files (documents) are preserved after a job is +printed. If a numeric value is specified, job files are preserved for the +indicated number of seconds after printing. Otherwise a boolean value +applies indefinitely. + +Defaults to @samp{86400}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history +Specifies whether the job history is preserved after a job is printed. If a +numeric value is specified, the job history is preserved for the indicated +number of seconds after printing. If @code{#t}, the job history is +preserved until the MaxJobs limit is reached. + +Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer reload-timeout +Specifies the amount of time to wait for job completion before restarting +the scheduler. + +Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string rip-cache +Specifies the maximum amount of memory to use when converting documents into +bitmaps for a printer. + +Defaults to @samp{"128m"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string server-admin +Specifies the email address of the server administrator. + +Defaults to @samp{"root@@localhost.localdomain"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} host-name-list-or-* server-alias +The ServerAlias directive is used for HTTP Host header validation when +clients connect to the scheduler from external interfaces. Using the +special name @code{*} can expose your system to known browser-based DNS +rebinding attacks, even when accessing sites through a firewall. If the +auto-discovery of alternate names does not work, we recommend listing each +alternate name with a ServerAlias directive instead of using @code{*}. + +Defaults to @samp{*}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string server-name +Specifies the fully-qualified host name of the server. + +Defaults to @samp{"localhost"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} server-tokens server-tokens +Specifies what information is included in the Server header of HTTP +responses. @code{None} disables the Server header. @code{ProductOnly} +reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} +reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. +@code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the +output of the @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 +(@var{uname}) IPP/2.0}. + +Defaults to @samp{Minimal}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} string set-env +Set the specified environment variable to be passed to child processes. + +Defaults to @samp{"variable value"}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} multiline-string-list ssl-listen +Listens on the specified interfaces for encrypted connections. Valid values +are of the form @var{address}:@var{port}, where @var{address} is either an +IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate +all addresses. + +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} ssl-options ssl-options +Sets encryption options. By default, CUPS only supports encryption using +TLS v1.0 or higher using known secure cipher suites. The @code{AllowRC4} +option enables the 128-bit RC4 cipher suites, which are required for some +older clients that do not implement newer ones. The @code{AllowSSL3} option +enables SSL v3.0, which is required for some older clients that do not +support TLS v1.0. + +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean strict-conformance? +Specifies whether the scheduler requires clients to strictly adhere to the +IPP specifications. + +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} non-negative-integer timeout +Specifies the HTTP request timeout, in seconds. + +Defaults to @samp{300}. + +@end deftypevr + +@deftypevr {@code{cups-configuration} parameter} boolean web-interface? +Specifies whether the web interface is enabled. + +Defaults to @samp{#f}. +@end deftypevr + +At this point you're probably thinking ``oh dear, Guix manual, I like you +but you can stop already with the configuration options''. Indeed. +However, one more point: it could be that you have an existing +@code{cupsd.conf} that you want to use. In that case, you can pass an +@code{opaque-cups-configuration} as the configuration of a +@code{cups-service-type}. + +Available @code{opaque-cups-configuration} fields are: + +@deftypevr {@code{opaque-cups-configuration} parameter} package cups +The CUPS package. +@end deftypevr + +@deftypevr {@code{opaque-cups-configuration} parameter} string cupsd.conf +The contents of the @code{cupsd.conf}, as a string. +@end deftypevr + +@deftypevr {@code{opaque-cups-configuration} parameter} string cups-files.conf +The contents of the @code{cups-files.conf} file, as a string. +@end deftypevr + +For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in +strings of the same name, you could instantiate a CUPS service like this: + +@example +(service cups-service-type + (opaque-cups-configuration + (cupsd.conf cupsd.conf) + (cups-files.conf cups-files.conf))) +@end example + + +@node Desktop-Dienste +@subsubsection Desktop-Dienste + +The @code{(gnu services desktop)} module provides services that are usually +useful in the context of a ``desktop'' setup---that is, on a machine running +a graphical display server, possibly with graphical user interfaces, etc. +It also defines services that provide specific desktop environments like +GNOME, XFCE or MATE. + +To simplify things, the module defines a variable containing the set of +services that users typically expect on a machine with a graphical +environment and networking: + +@defvr {Scheme Variable} %desktop-services +This is a list of services that builds upon @var{%base-services} and adds or +adjusts services for a typical ``desktop'' setup. + +In particular, it adds a graphical login manager (@pxref{X Window, +@code{slim-service}}), screen lockers, a network management tool +(@pxref{Netzwerkdienste, @code{network-manager-service-type}}), energy +and color management services, the @code{elogind} login and seat manager, +the Polkit privilege service, the GeoClue location service, the +AccountsService daemon that allows authorized users change system passwords, +an NTP client (@pxref{Netzwerkdienste}), the Avahi daemon, and has the +name service switch service configured to be able to use @code{nss-mdns} +(@pxref{Name Service Switch, mDNS}). +@end defvr + +The @var{%desktop-services} variable can be used as the @code{services} +field of an @code{operating-system} declaration (@pxref{„operating-system“-Referenz, @code{services}}). + +Additionally, the @code{gnome-desktop-service}, @code{xfce-desktop-service}, +@code{mate-desktop-service} and @code{enlightenment-desktop-service-type} +procedures can add GNOME, XFCE, MATE and/or Enlightenment to a system. To +``add GNOME'' means that system-level services like the backlight adjustment +helpers and the power management utilities are added to the system, +extending @code{polkit} and @code{dbus} appropriately, allowing GNOME to +operate with elevated privileges on a limited number of special-purpose +system interfaces. Additionally, adding a service made by +@code{gnome-desktop-service} adds the GNOME metapackage to the system +profile. Likewise, adding the XFCE service not only adds the @code{xfce} +metapackage to the system profile, but it also gives the Thunar file manager +the ability to open a ``root-mode'' file management window, if the user +authenticates using the administrator's password via the standard polkit +graphical interface. To ``add MATE'' means that @code{polkit} and +@code{dbus} are extended appropriately, allowing MATE to operate with +elevated privileges on a limited number of special-purpose system +interfaces. Additionally, adding a service made by +@code{mate-desktop-service} adds the MATE metapackage to the system +profile. ``Adding ENLIGHTENMENT'' means that @code{dbus} is extended +appropriately, and several of Enlightenment's binaries are set as setuid, +allowing Enlightenment's screen locker and other functionality to work as +expetected. + +The desktop environments in Guix use the Xorg display server by default. If +you'd like to use the newer display server protocol called Wayland, you need +to use the @code{sddm-service} instead of the @code{slim-service} for the +graphical login manager. You should then select the ``GNOME (Wayland)'' +session in SDDM. Alternatively you can also try starting GNOME on Wayland +manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec +dbus-run-session gnome-session``. Currently only GNOME has support for +Wayland. + +@deffn {Scheme Procedure} gnome-desktop-service +Return a service that adds the @code{gnome} package to the system profile, +and extends polkit with the actions from @code{gnome-settings-daemon}. +@end deffn + +@deffn {Scheme Procedure} xfce-desktop-service +Return a service that adds the @code{xfce} package to the system profile, +and extends polkit with the ability for @code{thunar} to manipulate the file +system as root from within a user session, after the user has authenticated +with the administrator's password. +@end deffn + +@deffn {Scheme Procedure} mate-desktop-service +Return a service that adds the @code{mate} package to the system profile, +and extends polkit with the actions from @code{mate-settings-daemon}. +@end deffn + +@deffn {Scheme Procedure} enlightenment-desktop-service-type +Return a service that adds the @code{enlightenment} package to the system +profile, and extends dbus with actions from @code{efl}. +@end deffn + +@deftp {Data Type} enlightenment-desktop-service-configuration +@table @asis +@item @code{enlightenment} (default @code{enlightenment}) +The enlightenment package to use. +@end table +@end deftp + +Because the GNOME, XFCE and MATE desktop services pull in so many packages, +the default @code{%desktop-services} variable doesn't include any of them by +default. To add GNOME, XFCE or MATE, just @code{cons} them onto +@code{%desktop-services} in the @code{services} field of your +@code{operating-system}: + +@example +(use-modules (gnu)) +(use-service-modules desktop) +(operating-system + ... + ;; cons* adds items to the list given as its last argument. + (services (cons* (gnome-desktop-service) + (xfce-desktop-service) + %desktop-services)) + ...) +@end example + +These desktop environments will then be available as options in the +graphical login window. + +The actual service definitions included in @code{%desktop-services} and +provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} are +described below. + +@deffn {Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()] +Return a service that runs the ``system bus'', using @var{dbus}, with +support for @var{services}. + +@uref{http://dbus.freedesktop.org/, D-Bus} is an inter-process communication +facility. Its system bus is used to allow system services to communicate +and to be notified of system-wide events. + +@var{services} must be a list of packages that provide an +@file{etc/dbus-1/system.d} directory containing additional D-Bus +configuration and policy files. For example, to allow avahi-daemon to use +the system bus, @var{services} must be equal to @code{(list avahi)}. +@end deffn + +@deffn {Scheme Procedure} elogind-service [#:config @var{config}] +Return a service that runs the @code{elogind} login and seat management +daemon. @uref{https://github.com/elogind/elogind, Elogind} exposes a D-Bus +interface that can be used to know which users are logged in, know what kind +of sessions they have open, suspend the system, inhibit system suspend, +reboot the system, and other tasks. + +Elogind handles most system-level power events for a computer, for example +suspending the system when a lid is closed, or shutting it down when the +power button is pressed. + +The @var{config} keyword argument specifies the configuration for elogind, +and should be the result of an @code{(elogind-configuration (@var{parameter} +@var{value})...)} invocation. Available parameters and their default values +are: + +@table @code +@item kill-user-processes? +@code{#f} +@item kill-only-users +@code{()} +@item kill-exclude-users +@code{("root")} +@item inhibit-delay-max-seconds +@code{5} +@item handle-power-key +@code{poweroff} +@item handle-suspend-key +@code{suspend} +@item handle-hibernate-key +@code{hibernate} +@item handle-lid-switch +@code{suspend} +@item handle-lid-switch-docked +@code{ignore} +@item power-key-ignore-inhibited? +@code{#f} +@item suspend-key-ignore-inhibited? +@code{#f} +@item hibernate-key-ignore-inhibited? +@code{#f} +@item lid-switch-ignore-inhibited? +@code{#t} +@item holdoff-timeout-seconds +@code{30} +@item idle-action +@code{ignore} +@item idle-action-seconds +@code{(* 30 60)} +@item runtime-directory-size-percent +@code{10} +@item runtime-directory-size +@code{#f} +@item remove-ipc? +@code{#t} +@item suspend-state +@code{("mem" "standby" "freeze")} +@item suspend-mode +@code{()} +@item hibernate-state +@code{("disk")} +@item hibernate-mode +@code{("platform" "shutdown")} +@item hybrid-sleep-state +@code{("disk")} +@item hybrid-sleep-mode +@code{("suspend" "platform" "shutdown")} +@end table +@end deffn + +@deffn {Scheme Procedure} accountsservice-service @ + [#:accountsservice @var{accountsservice}] Return a service that runs +AccountsService, a system service that can list available accounts, change +their passwords, and so on. AccountsService integrates with PolicyKit to +enable unprivileged users to acquire the capability to modify their system +configuration. +@uref{https://www.freedesktop.org/wiki/Software/AccountsService/, the +accountsservice web site} for more information. + +The @var{accountsservice} keyword argument is the @code{accountsservice} +package to expose as a service. +@end deffn + +@deffn {Scheme Procedure} polkit-service @ + [#:polkit @var{polkit}] Return a service that runs the +@uref{http://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege +management service}, which allows system administrators to grant access to +privileged operations in a structured way. By querying the Polkit service, +a privileged system component can know when it should grant additional +capabilities to ordinary users. For example, an ordinary user can be +granted the capability to suspend the system if the user is logged in +locally. +@end deffn + +@deffn {Scheme Procedure} upower-service [#:upower @var{upower}] @ + [#:watts-up-pro? #f] @ [#:poll-batteries? #t] @ [#:ignore-lid? #f] @ +[#:use-percentage-for-policy? #f] @ [#:percentage-low 10] @ +[#:percentage-critical 3] @ [#:percentage-action 2] @ [#:time-low 1200] @ +[#:time-critical 300] @ [#:time-action 120] @ [#:critical-power-action +'hybrid-sleep] Return a service that runs +@uref{http://upower.freedesktop.org/, @command{upowerd}}, a system-wide +monitor for power consumption and battery levels, with the given +configuration settings. It implements the @code{org.freedesktop.UPower} +D-Bus interface, and is notably used by GNOME. +@end deffn + +@deffn {Scheme Procedure} udisks-service [#:udisks @var{udisks}] +Return a service for @uref{http://udisks.freedesktop.org/docs/latest/, +UDisks}, a @dfn{disk management} daemon that provides user interfaces with +notifications and ways to mount/unmount disks. Programs that talk to UDisks +include the @command{udisksctl} command, part of UDisks, and GNOME Disks. +@end deffn + +@deffn {Scheme Procedure} colord-service [#:colord @var{colord}] +Return a service that runs @command{colord}, a system service with a D-Bus +interface to manage the color profiles of input and output devices such as +screens and scanners. It is notably used by the GNOME Color Manager +graphical tool. See @uref{http://www.freedesktop.org/software/colord/, the +colord web site} for more information. +@end deffn + +@deffn {Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()] +Return a configuration allowing an application to access GeoClue location +data. @var{name} is the Desktop ID of the application, without the +@code{.desktop} part. If @var{allowed?} is true, the application will have +access to location information by default. The boolean @var{system?} value +indicates whether an application is a system component or not. Finally +@var{users} is a list of UIDs of all users for which this application is +allowed location info access. An empty users list means that all users are +allowed. +@end deffn + +@defvr {Scheme Variable} %standard-geoclue-applications +The standard list of well-known GeoClue application configurations, granting +authority to the GNOME date-and-time utility to ask for the current location +in order to set the time zone, and allowing the IceCat and Epiphany web +browsers to request location information. IceCat and Epiphany both query +the user before allowing a web page to know the user's location. +@end defvr + +@deffn {Scheme Procedure} geoclue-service [#:colord @var{colord}] @ + [#:whitelist '()] @ [#:wifi-geolocation-url +"https://location.services.mozilla.com/v1/geolocate?key=geoclue"] @ +[#:submit-data? #f] [#:wifi-submission-url +"https://location.services.mozilla.com/v1/submit?key=geoclue"] @ +[#:submission-nick "geoclue"] @ [#:applications +%standard-geoclue-applications] Return a service that runs the GeoClue +location service. This service provides a D-Bus interface to allow +applications to request access to a user's physical location, and optionally +to add information to online location databases. See +@uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue web +site} for more information. +@end deffn + +@deffn {Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @ + [@w{#:auto-enable? #f}] Return a service that runs the @command{bluetoothd} +daemon, which manages all the Bluetooth devices and provides a number of +D-Bus interfaces. When AUTO-ENABLE? is true, the bluetooth controller is +powered automatically at boot, which can be useful when using a bluetooth +keyboard or mouse. + +Users need to be in the @code{lp} group to access the D-Bus service. +@end deffn + +@node Tondienste +@subsubsection Tondienste + +@cindex sound support +@cindex ALSA +@cindex PulseAudio, sound support + +The @code{(gnu services sound)} module provides a service to configure the +Advanced Linux Sound Architecture (ALSA) system, which making PulseAudio the +preferred ALSA output driver. + +@deffn {Scheme Variable} alsa-service-type +This is the type for the @uref{https://alsa-project.org/, Advanced Linux +Sound Architecture} (ALSA) system, which generates the +@file{/etc/asound.conf} configuration file. The value for this type is a +@command{alsa-configuration} record as in this example: + +@example +(service alsa-service-type) +@end example + +See below for details about @code{alsa-configuration}. +@end deffn + +@deftp {Data Type} alsa-configuration +Data type representing the configuration for @code{alsa-service}. + +@table @asis +@item @code{alsa-plugins} (default: @var{alsa-plugins}) +@code{alsa-plugins} package to use. + +@item @code{pulseaudio?} (default: @var{#t}) +Whether ALSA applications should transparently be made to use the +@uref{http://www.pulseaudio.org/, PulseAudio} sound server. + +Using PulseAudio allows you to run several sound-producing applications at +the same time and to individual control them @i{via} @command{pavucontrol}, +among other things. + +@item @code{extra-options} (default: @var{""}) +String to append to the @file{/etc/asound.conf} file. + +@end table +@end deftp + +Individual users who want to override the system configuration of ALSA can +do it with the @file{~/.asoundrc} file: + +@example +# In guix, we have to specify the absolute path for plugins. +pcm_type.jack @{ + lib "/home/alice/.guix-profile/lib/alsa-lib/libasound_module_pcm_jack.so" +@} + +# Routing ALSA to jack: +# <http://jackaudio.org/faq/routing_alsa.html>. +pcm.rawjack @{ + type jack + playback_ports @{ + 0 system:playback_1 + 1 system:playback_2 + @} + + capture_ports @{ + 0 system:capture_1 + 1 system:capture_2 + @} +@} + +pcm.!default @{ + type plug + slave @{ + pcm "rawjack" + @} +@} +@end example + +See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the +details. + + +@node Datenbankdienste +@subsubsection Datenbankdienste + +@cindex database +@cindex SQL +The @code{(gnu services databases)} module provides the following services. + +@deffn {Scheme Procedure} postgresql-service [#:postgresql postgresql] @ + [#:config-file] [#:data-directory ``/var/lib/postgresql/data''] @ [#:port +5432] [#:locale ``en_US.utf8''] Return a service that runs @var{postgresql}, +the PostgreSQL database server. + +The PostgreSQL daemon loads its runtime configuration from +@var{config-file}, creates a database cluster with @var{locale} as the +default locale, stored in @var{data-directory}. It then listens on +@var{port}. +@end deffn + +@deffn {Scheme Procedure} mysql-service [#:config (mysql-configuration)] +Return a service that runs @command{mysqld}, the MySQL or MariaDB database +server. + +The optional @var{config} argument specifies the configuration for +@command{mysqld}, which should be a @code{<mysql-configuration>} object. +@end deffn + +@deftp {Data Type} mysql-configuration +Data type representing the configuration of @var{mysql-service}. + +@table @asis +@item @code{mysql} (default: @var{mariadb}) +Package object of the MySQL database server, can be either @var{mariadb} or +@var{mysql}. + +For MySQL, a temporary root password will be displayed at activation time. +For MariaDB, the root password is empty. + +@item @code{port} (default: @code{3306}) +TCP port on which the database server listens for incoming connections. +@end table +@end deftp + +@defvr {Scheme Variable} memcached-service-type +This is the service type for the @uref{https://memcached.org/, Memcached} +service, which provides a distributed in memory cache. The value for the +service type is a @code{memcached-configuration} object. +@end defvr + +@example +(service memcached-service-type) +@end example + +@deftp {Data Type} memcached-configuration +Data type representing the configuration of memcached. + +@table @asis +@item @code{memcached} (default: @code{memcached}) +The Memcached package to use. + +@item @code{interfaces} (default: @code{'("0.0.0.0")}) +Network interfaces on which to listen. + +@item @code{tcp-port} (default: @code{11211}) +Port on which to accept connections on, + +@item @code{udp-port} (default: @code{11211}) +Port on which to accept UDP connections on, a value of 0 will disable +listening on a UDP socket. + +@item @code{additional-options} (default: @code{'()}) +Additional command line options to pass to @code{memcached}. +@end table +@end deftp + +@defvr {Scheme Variable} mongodb-service-type +This is the service type for @uref{https://www.mongodb.com/, MongoDB}. The +value for the service type is a @code{mongodb-configuration} object. +@end defvr + +@example +(service mongodb-service-type) +@end example + +@deftp {Data Type} mongodb-configuration +Data type representing the configuration of mongodb. + +@table @asis +@item @code{mongodb} (default: @code{mongodb}) +The MongoDB package to use. + +@item @code{config-file} (default: @code{%default-mongodb-configuration-file}) +The configuration file for MongoDB. + +@item @code{data-directory} (default: @code{"/var/lib/mongodb"}) +This value is used to create the directory, so that it exists and is owned +by the mongodb user. It should match the data-directory which MongoDB is +configured to use through the configuration file. +@end table +@end deftp + +@defvr {Scheme Variable} redis-service-type +This is the service type for the @uref{https://redis.io/, Redis} key/value +store, whose value is a @code{redis-configuration} object. +@end defvr + +@deftp {Data Type} redis-configuration +Data type representing the configuration of redis. + +@table @asis +@item @code{redis} (default: @code{redis}) +The Redis package to use. + +@item @code{bind} (default: @code{"127.0.0.1"}) +Network interface on which to listen. + +@item @code{port} (default: @code{6379}) +Port on which to accept connections on, a value of 0 will disable listening +on a TCP socket. + +@item @code{working-directory} (default: @code{"/var/lib/redis"}) +Directory in which to store the database and related files. +@end table +@end deftp + +@node Mail-Dienste +@subsubsection Mail-Dienste + +@cindex mail +@cindex email +The @code{(gnu services mail)} module provides Guix service definitions for +email services: IMAP, POP3, and LMTP servers, as well as mail transport +agents (MTAs). Lots of acronyms! These services are detailed in the +subsections below. + +@subsubheading Dovecot Service + +@deffn {Scheme Procedure} dovecot-service [#:config (dovecot-configuration)] +Return a service that runs the Dovecot IMAP/POP3/LMTP mail server. +@end deffn + +By default, Dovecot does not need much configuration; the default +configuration object created by @code{(dovecot-configuration)} will suffice +if your mail is delivered to @code{~/Maildir}. A self-signed certificate +will be generated for TLS-protected connections, though Dovecot will also +listen on cleartext ports by default. There are a number of options, +though, which mail administrators might need to change, and as is the case +with other services, Guix allows the system administrator to specify these +parameters via a uniform Scheme interface. + +For example, to specify that mail is located at @code{maildir~/.mail}, one +would instantiate the Dovecot service like this: + +@example +(dovecot-service #:config + (dovecot-configuration + (mail-location "maildir:~/.mail"))) +@end example + +The available configuration parameters follow. Each parameter definition is +preceded by its type; for example, @samp{string-list foo} indicates that the +@code{foo} parameter should be specified as a list of strings. There is +also a way to specify the configuration as a string, if you have an old +@code{dovecot.conf} file that you want to port over from some other system; +see the end for more details. + +@c The following documentation was initially generated by +@c (generate-documentation) in (gnu services mail). Manually maintained +@c documentation is better, so we shouldn't hesitate to edit below as +@c needed. However if the change you want to make to this documentation +@c can be done in an automated way, it's probably easier to change +@c (generate-documentation) than to make it below and have to deal with +@c the churn as dovecot updates. + +Available @code{dovecot-configuration} fields are: + +@deftypevr {@code{dovecot-configuration} parameter} package dovecot +The dovecot package. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} comma-separated-string-list listen +A list of IPs or hosts where to listen for connections. @samp{*} listens on +all IPv4 interfaces, @samp{::} listens on all IPv6 interfaces. If you want +to specify non-default ports or anything more complex, customize the address +and port fields of the @samp{inet-listener} of the specific services you are +interested in. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} protocol-configuration-list protocols +List of protocols we want to serve. Available protocols include +@samp{imap}, @samp{pop3}, and @samp{lmtp}. + +Available @code{protocol-configuration} fields are: + +@deftypevr {@code{protocol-configuration} parameter} string name +The name of the protocol. +@end deftypevr + +@deftypevr {@code{protocol-configuration} parameter} string auth-socket-path +UNIX socket path to the master authentication server to find users. This is +used by imap (for shared users) and lda. It defaults to +@samp{"/var/run/dovecot/auth-userdb"}. +@end deftypevr + +@deftypevr {@code{protocol-configuration} parameter} space-separated-string-list mail-plugins +Space separated list of plugins to load. +@end deftypevr + +@deftypevr {@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections +Maximum number of IMAP connections allowed for a user from each IP address. +NOTE: The username is compared case-sensitively. Defaults to @samp{10}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} service-configuration-list services +List of services to enable. Available services include @samp{imap}, +@samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and +@samp{lmtp}. + +Available @code{service-configuration} fields are: + +@deftypevr {@code{service-configuration} parameter} string kind +The service kind. Valid values include @code{director}, @code{imap-login}, +@code{pop3-login}, @code{lmtp}, @code{imap}, @code{pop3}, @code{auth}, +@code{auth-worker}, @code{dict}, @code{tcpwrap}, @code{quota-warning}, or +anything else. +@end deftypevr + +@deftypevr {@code{service-configuration} parameter} listener-configuration-list listeners +Listeners for the service. A listener is either a +@code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or +an @code{inet-listener-configuration}. Defaults to @samp{()}. + +Available @code{unix-listener-configuration} fields are: + +@deftypevr {@code{unix-listener-configuration} parameter} string path +Path to the file, relative to @code{base-dir} field. This is also used as +the section name. +@end deftypevr + +@deftypevr {@code{unix-listener-configuration} parameter} string mode +The access mode for the socket. Defaults to @samp{"0600"}. +@end deftypevr + +@deftypevr {@code{unix-listener-configuration} parameter} string user +The user to own the socket. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{unix-listener-configuration} parameter} string group +The group to own the socket. Defaults to @samp{""}. +@end deftypevr + + +Available @code{fifo-listener-configuration} fields are: + +@deftypevr {@code{fifo-listener-configuration} parameter} string path +Path to the file, relative to @code{base-dir} field. This is also used as +the section name. +@end deftypevr + +@deftypevr {@code{fifo-listener-configuration} parameter} string mode +The access mode for the socket. Defaults to @samp{"0600"}. +@end deftypevr + +@deftypevr {@code{fifo-listener-configuration} parameter} string user +The user to own the socket. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{fifo-listener-configuration} parameter} string group +The group to own the socket. Defaults to @samp{""}. +@end deftypevr + + +Available @code{inet-listener-configuration} fields are: + +@deftypevr {@code{inet-listener-configuration} parameter} string protocol +The protocol to listen for. +@end deftypevr + +@deftypevr {@code{inet-listener-configuration} parameter} string address +The address on which to listen, or empty for all addresses. Defaults to +@samp{""}. +@end deftypevr + +@deftypevr {@code{inet-listener-configuration} parameter} non-negative-integer port +The port on which to listen. +@end deftypevr + +@deftypevr {@code{inet-listener-configuration} parameter} boolean ssl? +Whether to use SSL for this service; @samp{yes}, @samp{no}, or +@samp{required}. Defaults to @samp{#t}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{service-configuration} parameter} non-negative-integer service-count +Number of connections to handle before starting a new process. Typically +the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 is +faster. <doc/wiki/LoginProcess.txt>. Defaults to @samp{1}. +@end deftypevr + +@deftypevr {@code{service-configuration} parameter} non-negative-integer process-min-avail +Number of processes to always keep waiting for more connections. Defaults +to @samp{0}. +@end deftypevr + +@deftypevr {@code{service-configuration} parameter} non-negative-integer vsz-limit +If you set @samp{service-count 0}, you probably need to grow this. Defaults +to @samp{256000000}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} dict-configuration dict +Dict configuration, as created by the @code{dict-configuration} constructor. + +Available @code{dict-configuration} fields are: + +@deftypevr {@code{dict-configuration} parameter} free-form-fields entries +A list of key-value pairs that this dict should hold. Defaults to +@samp{()}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} passdb-configuration-list passdbs +A list of passdb configurations, each one created by the +@code{passdb-configuration} constructor. + +Available @code{passdb-configuration} fields are: + +@deftypevr {@code{passdb-configuration} parameter} string driver +The driver that the passdb should use. Valid values include @samp{pam}, +@samp{passwd}, @samp{shadow}, @samp{bsdauth}, and @samp{static}. Defaults +to @samp{"pam"}. +@end deftypevr + +@deftypevr {@code{passdb-configuration} parameter} space-separated-string-list args +Space separated list of arguments to the passdb driver. Defaults to +@samp{""}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} userdb-configuration-list userdbs +List of userdb configurations, each one created by the +@code{userdb-configuration} constructor. + +Available @code{userdb-configuration} fields are: + +@deftypevr {@code{userdb-configuration} parameter} string driver +The driver that the userdb should use. Valid values include @samp{passwd} +and @samp{static}. Defaults to @samp{"passwd"}. +@end deftypevr + +@deftypevr {@code{userdb-configuration} parameter} space-separated-string-list args +Space separated list of arguments to the userdb driver. Defaults to +@samp{""}. +@end deftypevr + +@deftypevr {@code{userdb-configuration} parameter} free-form-args override-fields +Override fields from passwd. Defaults to @samp{()}. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration +Plug-in configuration, created by the @code{plugin-configuration} +constructor. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces +List of namespaces. Each item in the list is created by the +@code{namespace-configuration} constructor. + +Available @code{namespace-configuration} fields are: + +@deftypevr {@code{namespace-configuration} parameter} string name +Name for this namespace. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} string type +Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to +@samp{"private"}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} string separator +Hierarchy separator to use. You should use the same separator for all +namespaces or some clients get confused. @samp{/} is usually a good one. +The default however depends on the underlying mail storage format. Defaults +to @samp{""}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} string prefix +Prefix required to access this namespace. This needs to be different for +all namespaces. For example @samp{Public/}. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} string location +Physical location of the mailbox. This is in the same format as +mail_location, which is also the default for it. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} boolean inbox? +There can be only one INBOX, and this setting defines which namespace has +it. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} boolean hidden? +If namespace is hidden, it's not advertised to clients via NAMESPACE +extension. You'll most likely also want to set @samp{list? #f}. This is +mostly useful when converting from another server with different namespaces +which you want to deprecate but still keep working. For example you can +create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} and +@samp{mail/}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} boolean list? +Show the mailboxes under this namespace with the LIST command. This makes +the namespace visible for clients that do not support the NAMESPACE +extension. The special @code{children} value lists child mailboxes, but +hides the namespace prefix. Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} boolean subscriptions? +Namespace handles its own subscriptions. If set to @code{#f}, the parent +namespace handles them. The empty prefix should always have this as +@code{#t}). Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes +List of predefined mailboxes in this namespace. Defaults to @samp{()}. + +Available @code{mailbox-configuration} fields are: + +@deftypevr {@code{mailbox-configuration} parameter} string name +Name for this mailbox. +@end deftypevr + +@deftypevr {@code{mailbox-configuration} parameter} string auto +@samp{create} will automatically create this mailbox. @samp{subscribe} will +both create and subscribe to the mailbox. Defaults to @samp{"no"}. +@end deftypevr + +@deftypevr {@code{mailbox-configuration} parameter} space-separated-string-list special-use +List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. Valid +values are @code{\All}, @code{\Archive}, @code{\Drafts}, @code{\Flagged}, +@code{\Junk}, @code{\Sent}, and @code{\Trash}. Defaults to @samp{()}. +@end deftypevr + +@end deftypevr + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name base-dir +Base directory where to store runtime data. Defaults to +@samp{"/var/run/dovecot/"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string login-greeting +Greeting message for clients. Defaults to @samp{"Dovecot ready."}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks +List of trusted network ranges. Connections from these IPs are allowed to +override their IP addresses and ports (for logging and for authentication +checks). @samp{disable-plaintext-auth} is also ignored for these networks. +Typically you would specify your IMAP proxy servers here. Defaults to +@samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets +List of login access check sockets (e.g. tcpwrap). Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean verbose-proctitle? +Show more verbose process titles (in ps). Currently shows user name and IP +address. Useful for seeing who is actually using the IMAP processes +(e.g. shared mailboxes or if the same uid is used for multiple accounts). +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean shutdown-clients? +Should all processes be killed when Dovecot master process shuts down. +Setting this to @code{#f} means that Dovecot can be upgraded without forcing +existing client connections to close (although that could also be a problem +if the upgrade is e.g. due to a security fix). Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count +If non-zero, run mail commands via this many connections to doveadm server, +instead of running them directly in the same process. Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string doveadm-socket-path +UNIX socket or host:port used for connecting to doveadm server. Defaults to +@samp{"doveadm-server"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list import-environment +List of environment variables that are preserved on Dovecot startup and +passed down to all of its child processes. You can also give key=value +pairs to always set specific settings. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean disable-plaintext-auth? +Disable LOGIN command and all other plaintext authentications unless SSL/TLS +is used (LOGINDISABLED capability). Note that if the remote IP matches the +local IP (i.e. you're connecting from the same computer), the connection is +considered secure and plaintext authentication is allowed. See also +ssl=required setting. Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size +Authentication cache size (e.g. @samp{#e10e6}). 0 means it's disabled. +Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set for +caching to be used. Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-cache-ttl +Time to live for cached data. After TTL expires the cached record is no +longer used, *except* if the main database lookup returns internal failure. +We also try to handle password changes automatically: If user's previous +authentication was successful, but this one wasn't, the cache isn't used. +For now this works only with plaintext authentication. Defaults to @samp{"1 +hour"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-cache-negative-ttl +TTL for negative hits (user not found, password mismatch). 0 disables +caching them completely. Defaults to @samp{"1 hour"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-realms +List of realms for SASL authentication mechanisms that need them. You can +leave it empty if you don't want to support multiple realms. Many clients +simply use the first one listed here, so keep the default realm first. +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-default-realm +Default realm/domain to use if none was specified. This is used for both +SASL realms and appending @@domain to username in plaintext logins. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-username-chars +List of allowed characters in username. If the user-given username contains +a character not listed in here, the login automatically fails. This is just +an extra check to make sure user can't exploit any potential quote escaping +vulnerabilities with SQL/LDAP databases. If you want to allow all +characters, set this value to empty. Defaults to +@samp{"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-username-translation +Username character translations before it's looked up from databases. The +value contains series of from -> to characters. For example @samp{#@@/@@} +means that @samp{#} and @samp{/} characters are translated to @samp{@@}. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-username-format +Username formatting before it's looked up from databases. You can use the +standard variables here, e.g. %Lu would lowercase the username, %n would +drop away the domain if it was given, or @samp{%n-AT-%d} would change the +@samp{@@} into @samp{-AT-}. This translation is done after +@samp{auth-username-translation} changes. Defaults to @samp{"%Lu"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-master-user-separator +If you want to allow master users to log in by specifying the master +username within the normal username string (i.e. not using SASL mechanism's +support for it), you can specify the separator character here. The format +is then <username><separator><master username>. UW-IMAP uses @samp{*} as +the separator, so that could be a good choice. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-anonymous-username +Username to use for users logging in with ANONYMOUS SASL mechanism. +Defaults to @samp{"anonymous"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count +Maximum number of dovecot-auth worker processes. They're used to execute +blocking passdb and userdb queries (e.g. MySQL and PAM). They're +automatically created and destroyed as needed. Defaults to @samp{30}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-gssapi-hostname +Host name to use in GSSAPI principal names. The default is to use the name +returned by gethostname(). Use @samp{$ALL} (with quotes) to allow all +keytab entries. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-krb5-keytab +Kerberos keytab to use for the GSSAPI mechanism. Will use the system +default (usually @file{/etc/krb5.keytab}) if not specified. You may need to +change the auth service to run as root to be able to read this file. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-use-winbind? +Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and +@samp{ntlm-auth} helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path +Path for Samba's @samp{ntlm-auth} helper binary. Defaults to +@samp{"/usr/bin/ntlm_auth"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string auth-failure-delay +Time to delay before replying to failed authentications. Defaults to +@samp{"2 secs"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert? +Require a valid SSL client certificate or the authentication fails. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert? +Take the username from client's SSL certificate, using +@code{X509_NAME_get_text_by_NID()} which returns the subject's DN's +CommonName. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms +List of wanted authentication mechanisms. Supported mechanisms are: +@samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, +@samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, @samp{otp}, +@samp{skey}, and @samp{gss-spnego}. NOTE: See also +@samp{disable-plaintext-auth} setting. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-servers +List of IPs or hostnames to all director servers, including ourself. Ports +can be specified as ip:port. The default port is the same as what director +service's @samp{inet-listener} is using. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers +List of IPs or hostnames to all backend mail servers. Ranges are allowed +too, like 10.0.0.10-10.0.0.30. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string director-user-expire +How long to redirect users to a specific server after it no longer has any +connections. Defaults to @samp{"15 min"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string director-username-hash +How the username is translated before being hashed. Useful values include +%Ln if user can log in with or without @@domain, %Ld if mailboxes are shared +within domain. Defaults to @samp{"%Lu"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string log-path +Log file to use for error messages. @samp{syslog} logs to syslog, +@samp{/dev/stderr} logs to stderr. Defaults to @samp{"syslog"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string info-log-path +Log file to use for informational messages. Defaults to @samp{log-path}. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string debug-log-path +Log file to use for debug messages. Defaults to @samp{info-log-path}. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string syslog-facility +Syslog facility to use if you're logging to syslog. Usually if you don't +want to use @samp{mail}, you'll use local0..local7. Also other standard +facilities are supported. Defaults to @samp{"mail"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose? +Log unsuccessful authentication attempts and the reasons why they failed. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-verbose-passwords? +In case of password mismatches, log the attempted password. Valid values +are no, plain and sha1. sha1 can be useful for detecting brute force +password attempts vs. user simply trying the same password over and over +again. You can also truncate the value to n chars by appending ":n" +(e.g. sha1:6). Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug? +Even more verbose logging for debugging purposes. Shows for example SQL +queries. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean auth-debug-passwords? +In case of password mismatches, log the passwords and used scheme so the +problem can be debugged. Enabling this also enables @samp{auth-debug}. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mail-debug? +Enable mail process debugging. This can help you figure out why Dovecot +isn't finding your mails. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean verbose-ssl? +Show protocol level SSL errors. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string log-timestamp +Prefix for each line written to log file. % codes are in strftime(3) +format. Defaults to @samp{"\"%b %d %H:%M:%S \""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements +List of elements we want to log. The elements which have a non-empty +variable value are joined together to form a comma-separated string. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string login-log-format +Login log format. %s contains @samp{login-log-format-elements} string, %$ +contains the data we want to log. Defaults to @samp{"%$: %s"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-log-prefix +Log prefix for mail processes. See doc/wiki/Variables.txt for list of +possible variables you can use. Defaults to +@samp{"\"%s(%u)<%@{pid@}><%@{session@}>: \""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string deliver-log-format +Format to use for logging mail deliveries. You can use variables: +@table @code +@item %$ +Delivery status message (e.g. @samp{saved to INBOX}) +@item %m +Message-ID +@item %s +Subject +@item %f +From address +@item %p +Physical size +@item %w +Virtual size. +@end table +Defaults to @samp{"msgid=%m: %$"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-location +Location for users' mailboxes. The default is empty, which means that +Dovecot tries to find the mailboxes automatically. This won't work if the +user doesn't yet have any mail, so you should explicitly tell Dovecot the +full location. + +If you're using mbox, giving a path to the INBOX file (e.g. /var/mail/%u) +isn't enough. You'll also need to tell Dovecot where the other mailboxes +are kept. This is called the "root mail directory", and it must be the +first path given in the @samp{mail-location} setting. + +There are a few special variables you can use, eg.: + +@table @samp +@item %u +username +@item %n +user part in user@@domain, same as %u if there's no domain +@item %d +domain part in user@@domain, empty if there's no domain +@item %h +home director +@end table + +See doc/wiki/Variables.txt for full list. Some examples: +@table @samp +@item maildir:~/Maildir +@item mbox:~/mail:INBOX=/var/mail/%u +@item mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/% +@end table +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-uid +System user and group used to access mails. If you use multiple, userdb can +override these by returning uid or gid fields. You can use either numbers +or names. <doc/wiki/UserIds.txt>. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-gid + +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-privileged-group +Group to enable temporarily for privileged operations. Currently this is +used only with INBOX when either its initial creation or dotlocking fails. +Typically this is set to "mail" to give access to /var/mail. Defaults to +@samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-access-groups +Grant access to these supplementary groups for mail processes. Typically +these are used to set up access to shared mailboxes. Note that it may be +dangerous to set these if users can create symlinks (e.g. if "mail" group is +set here, ln -s /var/mail ~/mail/var could allow a user to delete others' +mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading +it). Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access? +Allow full file system access to clients. There's no access checks other +than what the operating system does for the active UID/GID. It works with +both maildir and mboxes, allowing you to prefix mailboxes names with +e.g. /path/ or ~user/. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mmap-disable? +Don't use mmap() at all. This is required if you store indexes to shared +file systems (NFS or clustered file system). Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean dotlock-use-excl? +Rely on @samp{O_EXCL} to work when creating dotlock files. NFS supports +@samp{O_EXCL} since version 3, so this should be safe to use nowadays by +default. Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-fsync +When to use fsync() or fdatasync() calls: +@table @code +@item optimized +Whenever necessary to avoid losing important data +@item always +Useful with e.g. NFS when write()s are delayed +@item never +Never use it (best performance, but crashes can lose data). +@end table +Defaults to @samp{"optimized"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-storage? +Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS +caches whenever needed. If you're using only a single mail server this +isn't needed. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mail-nfs-index? +Mail index files also exist in NFS. Setting this to yes requires +@samp{mmap-disable? #t} and @samp{fsync-disable? #f}. Defaults to +@samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string lock-method +Locking method for index files. Alternatives are fcntl, flock and dotlock. +Dotlocking uses some tricks which may create more disk I/O than other +locking methods. NFS users: flock doesn't work, remember to change +@samp{mmap-disable}. Defaults to @samp{"fcntl"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name mail-temp-dir +Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. +Defaults to @samp{"/tmp"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid +Valid UID range for users. This is mostly to make sure that users can't log +in as daemons or other system users. Note that denying root logins is +hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} +is set to 0. Defaults to @samp{500}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid +Valid GID range for users. Users having non-valid GID as primary group ID +aren't allowed to log in. If user belongs to supplementary groups with +non-valid GIDs, those groups are not set. Defaults to @samp{1}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid + +Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length +Maximum allowed length for mail keyword name. It's only forced when trying +to create new keywords. Defaults to @samp{50}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs +List of directories under which chrooting is allowed for mail processes +(i.e. /var/mail will allow chrooting to /var/mail/foo/bar too). This +setting doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth chroot +settings. If this setting is empty, "/./" in home dirs are ignored. +WARNING: Never add directories here which local users can modify, that may +lead to root exploit. Usually this should be done only if you don't allow +shell access for users. <doc/wiki/Chrooting.txt>. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-chroot +Default chroot directory for mail processes. This can be overridden for +specific users in user database by giving /./ in user's home directory +(e.g. /home/./user chroots into /home). Note that usually there is no real +need to do chrooting, Dovecot doesn't allow users to access files outside +their mail directory anyway. If your home directories are prefixed with the +chroot directory, append "/." to @samp{mail-chroot}. +<doc/wiki/Chrooting.txt>. Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name auth-socket-path +UNIX socket path to master authentication server to find users. This is +used by imap (for shared users) and lda. Defaults to +@samp{"/var/run/dovecot/auth-userdb"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name mail-plugin-dir +Directory where to look up mail plugins. Defaults to +@samp{"/usr/lib/dovecot"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins +List of plugins to load for all services. Plugins specific to IMAP, LDA, +etc. are added to this list in their own .conf files. Defaults to +@samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count +The minimum number of mails in a mailbox before updates are done to cache +file. This allows optimizing Dovecot's behavior to do less disk writes at +the cost of more disk reads. Defaults to @samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mailbox-idle-check-interval +When IDLE command is running, mailbox is checked once in a while to see if +there are any new mails or other changes. This setting defines the minimum +time to wait between those checks. Dovecot can also use dnotify, inotify +and kqueue to find out immediately when changes occur. Defaults to +@samp{"30 secs"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mail-save-crlf? +Save mails with CR+LF instead of plain LF. This makes sending those mails +take less CPU, especially with sendfile() syscall with Linux and FreeBSD. +But it also creates a bit more disk I/O which may just make it slower. Also +note that if other software reads the mboxes/maildirs, they may handle the +extra CRs wrong and cause problems. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean maildir-stat-dirs? +By default LIST command returns all entries in maildir beginning with a +dot. Enabling this option makes Dovecot return only entries which are +directories. This is done by stat()ing each entry, so it causes more disk +I/O. (For systems setting struct @samp{dirent->d_type} this check is free +and it's done always regardless of this setting). Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks? +When copying a message, do it with hard links whenever possible. This makes +the performance much better, and it's unlikely to have any side effects. +Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs? +Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only +when its mtime changes unexpectedly or when we can't find the mail +otherwise. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks +Which locking methods to use for locking mbox. There are four available: + +@table @code +@item dotlock +Create <mailbox>.lock file. This is the oldest and most NFS-safe solution. +If you want to use /var/mail/ like directory, the users will need write +access to that directory. +@item dotlock-try +Same as dotlock, but if it fails because of permissions or because there +isn't enough disk space, just skip it. +@item fcntl +Use this if possible. Works with NFS too if lockd is used. +@item flock +May not exist in all systems. Doesn't work with NFS. +@item lockf +May not exist in all systems. Doesn't work with NFS. +@end table + +You can use multiple locking methods; if you do the order they're declared +in is important to avoid deadlocks if other MTAs/MUAs are using multiple +locking methods as well. Some operating systems don't allow using some of +them simultaneously. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks + +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mbox-lock-timeout +Maximum time to wait for lock (all of them) before aborting. Defaults to +@samp{"5 mins"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout +If dotlock exists but the mailbox isn't modified in any way, override the +lock file after this much time. Defaults to @samp{"2 mins"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs? +When mbox changes unexpectedly we have to fully read it to find out what +changed. If the mbox is large this can take a long time. Since the change +is usually just a newly appended mail, it'd be faster to simply read the new +mails. If this setting is enabled, Dovecot does this but still safely +fallbacks to re-reading the whole mbox file whenever something in mbox isn't +how it's expected to be. The only real downside to this setting is that if +some other MUA changes message flags, Dovecot doesn't notice it +immediately. Note that a full sync is done with SELECT, EXAMINE, EXPUNGE +and CHECK commands. Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs? +Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, +EXAMINE, EXPUNGE or CHECK commands. If this is set, @samp{mbox-dirty-syncs} +is ignored. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mbox-lazy-writes? +Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK +commands and when closing the mailbox). This is especially useful for POP3 +where clients often delete all mails. The downside is that our changes +aren't immediately visible to other MUAs. Defaults to @samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size +If mbox size is smaller than this (e.g. 100k), don't write index files. If +an index file already exists it's still read, just not updated. Defaults to +@samp{0}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size +Maximum dbox file size until it's rotated. Defaults to @samp{10000000}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mdbox-rotate-interval +Maximum dbox file age until it's rotated. Typically in days. Day begins +from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. +Defaults to @samp{"1d"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space? +When creating new mdbox files, immediately preallocate their size to +@samp{mdbox-rotate-size}. This setting currently works only in Linux with +some file systems (ext4, xfs). Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-dir +sdbox and mdbox support saving mail attachments to external files, which +also allows single instance storage for them. Other backends don't support +this for now. + +WARNING: This feature hasn't been tested much yet. Use at your own risk. + +Directory root where to store mail attachments. Disabled, if empty. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size +Attachments smaller than this aren't saved externally. It's also possible +to write a plugin to disable saving specific attachments externally. +Defaults to @samp{128000}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-fs +File system backend to use for saving attachments: +@table @code +@item posix +No SiS done by Dovecot (but this might help FS's own deduplication) +@item sis posix +SiS with immediate byte-by-byte comparison during saving +@item sis-queue posix +SiS with delayed comparison and deduplication. +@end table +Defaults to @samp{"sis posix"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string mail-attachment-hash +Hash format to use in attachment filenames. You can add any text and +variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, +@code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be +truncated, e.g. @code{%@{sha256:80@}} returns only first 80 bits. Defaults +to @samp{"%@{sha1@}"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-process-limit + +Defaults to @samp{100}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-client-limit + +Defaults to @samp{1000}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit +Default VSZ (virtual memory size) limit for service processes. This is +mainly intended to catch and kill processes that leak memory before they eat +up everything. Defaults to @samp{256000000}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string default-login-user +Login user is internally used by login processes. This is the most +untrusted user in Dovecot system. It shouldn't have access to anything at +all. Defaults to @samp{"dovenull"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string default-internal-user +Internal user is used by unprivileged processes. It should be separate from +login user, so that login processes can't disturb other processes. Defaults +to @samp{"dovecot"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl? +SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to +@samp{"required"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-cert +PEM encoded X.509 SSL/TLS certificate (public key). Defaults to +@samp{"</etc/dovecot/default.pem"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-key +PEM encoded SSL/TLS private key. The key is opened before dropping root +privileges, so keep the key file unreadable by anyone but root. Defaults to +@samp{"</etc/dovecot/private/default.pem"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-key-password +If key file is password protected, give the password here. Alternatively +give it when starting dovecot with -p parameter. Since this file is often +world-readable, you may want to place this setting instead to a different. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-ca +PEM encoded trusted certificate authority. Set this only if you intend to +use @samp{ssl-verify-client-cert? #t}. The file should contain the CA +certificate(s) followed by the matching CRL(s). (e.g. @samp{ssl-ca +</etc/ssl/certs/ca.pem}). Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean ssl-require-crl? +Require that CRL check succeeds for client certificates. Defaults to +@samp{#t}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert? +Request client to send a certificate. If you also want to require it, set +@samp{auth-ssl-require-client-cert? #t} in auth section. Defaults to +@samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-cert-username-field +Which field from certificate to use for username. commonName and +x500UniqueIdentifier are the usual choices. You'll also need to set +@samp{auth-ssl-username-from-cert? #t}. Defaults to @samp{"commonName"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-min-protocol +Minimum SSL protocol version to accept. Defaults to @samp{"TLSv1"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-cipher-list +SSL ciphers to use. Defaults to +@samp{"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string ssl-crypto-device +SSL crypto device to use, for valid values run "openssl engine". Defaults +to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string postmaster-address +Address to use when sending rejection mails. %d expands to recipient +domain. Defaults to @samp{"postmaster@@%d"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string hostname +Hostname to use in various parts of sent mails (e.g. in Message-Id) and in +LMTP replies. Default is the system's real hostname@@domain. Defaults to +@samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean quota-full-tempfail? +If user is over quota, return with temporary failure instead of bouncing the +mail. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} file-name sendmail-path +Binary to use for sending mails. Defaults to @samp{"/usr/sbin/sendmail"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string submission-host +If non-empty, send mails via this SMTP host[:port] instead of sendmail. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string rejection-subject +Subject: header to use for rejection mails. You can use the same variables +as for @samp{rejection-reason} below. Defaults to @samp{"Rejected: %s"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string rejection-reason +Human readable error message for rejection mails. You can use variables: + +@table @code +@item %n +CRLF +@item %r +reason +@item %s +original subject +@item %t +recipient +@end table +Defaults to @samp{"Your message to <%t> was automatically rejected:%n%r"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string recipient-delimiter +Delimiter character between local-part and detail in email address. +Defaults to @samp{"+"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string lda-original-recipient-header +Header where the original recipient address (SMTP's RCPT TO: address) is +taken from if not available elsewhere. With dovecot-lda -a parameter +overrides this. A commonly used header for this is X-Original-To. Defaults +to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate? +Should saving a mail to a nonexistent mailbox automatically create it?. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe? +Should automatically created mailboxes be also automatically subscribed?. +Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length +Maximum IMAP command line length. Some clients generate very long command +lines with huge mailboxes, so you may need to raise this if you get "Too +long argument" or "IMAP command line too large" errors often. Defaults to +@samp{64000}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-logout-format +IMAP logout format string: +@table @code +@item %i +total number of bytes read from client +@item %o +total number of bytes sent to client. +@end table +See @file{doc/wiki/Variables.txt} for a list of all the variables you can +use. Defaults to @samp{"in=%i out=%o deleted=%@{deleted@} +expunged=%@{expunged@} trashed=%@{trashed@} hdr_count=%@{fetch_hdr_count@} +hdr_bytes=%@{fetch_hdr_bytes@} body_count=%@{fetch_body_count@} +body_bytes=%@{fetch_body_bytes@}"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-capability +Override the IMAP CAPABILITY response. If the value begins with '+', add +the given capabilities on top of the defaults (e.g. +XFOO XBAR). Defaults +to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-idle-notify-interval +How long to wait between "OK Still here" notifications when client is +IDLEing. Defaults to @samp{"2 mins"}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-id-send +ID field names and values to send to clients. Using * as the value makes +Dovecot use the default value. The following fields have default values +currently: name, version, os, os-version, support-url, support-email. +Defaults to @samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-id-log +ID fields sent by client to log. * means everything. Defaults to +@samp{""}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds +Workarounds for various client bugs: + +@table @code +@item delay-newmail +Send EXISTS/RECENT new mail notifications only when replying to NOOP and +CHECK commands. Some clients ignore them otherwise, for example OSX Mail +(<v2.1). Outlook Express breaks more badly though, without this it may show +user "Message no longer in server" errors. Note that OE6 still breaks even +with this workaround if synchronization is set to "Headers Only". + +@item tb-extra-mailbox-sep +Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds +extra @samp{/} suffixes to mailbox names. This option causes Dovecot to +ignore the extra @samp{/} instead of treating it as invalid mailbox name. + +@item tb-lsub-flags +Show \Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox). This +makes Thunderbird realize they aren't selectable and show them greyed out, +instead of only later giving "not selectable" popup error. +@end table +Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{dovecot-configuration} parameter} string imap-urlauth-host +Host allowed in URLAUTH URLs sent by client. "*" allows all. Defaults to +@samp{""}. +@end deftypevr + + +Whew! Lots of configuration options. The nice thing about it though is that +GuixSD has a complete interface to Dovecot's configuration language. This +allows not only a nice way to declare configurations, but also offers +reflective capabilities as well: users can write code to inspect and +transform configurations from within Scheme. + +However, it could be that you just want to get a @code{dovecot.conf} up and +running. In that case, you can pass an @code{opaque-dovecot-configuration} +as the @code{#:config} parameter to @code{dovecot-service}. As its name +indicates, an opaque configuration does not have easy reflective +capabilities. + +Available @code{opaque-dovecot-configuration} fields are: + +@deftypevr {@code{opaque-dovecot-configuration} parameter} package dovecot +The dovecot package. +@end deftypevr + +@deftypevr {@code{opaque-dovecot-configuration} parameter} string string +The contents of the @code{dovecot.conf}, as a string. +@end deftypevr + +For example, if your @code{dovecot.conf} is just the empty string, you could +instantiate a dovecot service like this: + +@example +(dovecot-service #:config + (opaque-dovecot-configuration + (string ""))) +@end example + +@subsubheading OpenSMTPD Service + +@deffn {Scheme Variable} opensmtpd-service-type +This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} service, +whose value should be an @code{opensmtpd-configuration} object as in this +example: + +@example +(service opensmtpd-service-type + (opensmtpd-configuration + (config-file (local-file "./my-smtpd.conf")))) +@end example +@end deffn + +@deftp {Data Type} opensmtpd-configuration +Data type representing the configuration of opensmtpd. + +@table @asis +@item @code{package} (default: @var{opensmtpd}) +Package object of the OpenSMTPD SMTP server. + +@item @code{config-file} (default: @var{%default-opensmtpd-file}) +File-like object of the OpenSMTPD configuration file to use. By default it +listens on the loopback network interface, and allows for mail from users +and daemons on the local machine, as well as permitting email to remote +servers. Run @command{man smtpd.conf} for more information. + +@end table +@end deftp + +@subsubheading Exim Service + +@cindex mail transfer agent (MTA) +@cindex MTA (mail transfer agent) +@cindex SMTP + +@deffn {Scheme Variable} exim-service-type +This is the type of the @uref{https://exim.org, Exim} mail transfer agent +(MTA), whose value should be an @code{exim-configuration} object as in this +example: + +@example +(service exim-service-type + (exim-configuration + (config-file (local-file "./my-exim.conf")))) +@end example +@end deffn + +In order to use an @code{exim-service-type} service you must also have a +@code{mail-aliases-service-type} service present in your +@code{operating-system} (even if it has no aliases). + +@deftp {Data Type} exim-configuration +Data type representing the configuration of exim. + +@table @asis +@item @code{package} (default: @var{exim}) +Package object of the Exim server. + +@item @code{config-file} (default: @code{#f}) +File-like object of the Exim configuration file to use. If its value is +@code{#f} then use the default configuration file from the package provided +in @code{package}. The resulting configuration file is loaded after setting +the @code{exim_user} and @code{exim_group} configuration variables. + +@end table +@end deftp + +@subsubheading Mail Aliases Service + +@cindex email aliases +@cindex aliases, for email addresses + +@deffn {Scheme Variable} mail-aliases-service-type +This is the type of the service which provides @code{/etc/aliases}, +specifying how to deliver mail to users on this system. + +@example +(service mail-aliases-service-type + '(("postmaster" "bob") + ("bob" "bob@@example.com" "bob@@example2.com"))) +@end example +@end deffn + +The configuration for a @code{mail-aliases-service-type} service is an +association list denoting how to deliver mail that comes to this +system. Each entry is of the form @code{(alias addresses ...)}, with +@code{alias} specifying the local alias and @code{addresses} specifying +where to deliver this user's mail. + +The aliases aren't required to exist as users on the local system. In the +above example, there doesn't need to be a @code{postmaster} entry in the +@code{operating-system}'s @code{user-accounts} in order to deliver the +@code{postmaster} mail to @code{bob} (which subsequently would deliver mail +to @code{bob@@example.com} and @code{bob@@example2.com}). + +@node Kurznachrichtendienste +@subsubsection Kurznachrichtendienste + +@cindex messaging +@cindex jabber +@cindex XMPP +The @code{(gnu services messaging)} module provides Guix service definitions +for messaging services: currently only Prosody is supported. + +@subsubheading Prosody Service + +@deffn {Scheme Variable} prosody-service-type +This is the type for the @uref{https://prosody.im, Prosody XMPP +communication server}. Its value must be a @code{prosody-configuration} +record as in this example: + +@example +(service prosody-service-type + (prosody-configuration + (modules-enabled (cons "groups" "mam" %default-modules-enabled)) + (int-components + (list + (int-component-configuration + (hostname "conference.example.net") + (plugin "muc") + (mod-muc (mod-muc-configuration))))) + (virtualhosts + (list + (virtualhost-configuration + (domain "example.net")))))) +@end example + +See below for details about @code{prosody-configuration}. + +@end deffn + +By default, Prosody does not need much configuration. Only one +@code{virtualhosts} field is needed: it specifies the domain you wish +Prosody to serve. + +You can perform various sanity checks on the generated configuration with +the @code{prosodyctl check} command. + +Prosodyctl will also help you to import certificates from the +@code{letsencrypt} directory so that the @code{prosody} user can access +them. See @url{https://prosody.im/doc/letsencrypt}. + +@example +prosodyctl --root cert import /etc/letsencrypt/live +@end example + +The available configuration parameters follow. Each parameter definition is +preceded by its type; for example, @samp{string-list foo} indicates that the +@code{foo} parameter should be specified as a list of strings. Types +starting with @code{maybe-} denote parameters that won't show up in +@code{prosody.cfg.lua} when their value is @code{'disabled}. + +There is also a way to specify the configuration as a string, if you have an +old @code{prosody.cfg.lua} file that you want to port over from some other +system; see the end for more details. + +The @code{file-object} type designates either a file-like object +(@pxref{G-Ausdrücke, file-like objects}) or a file name. + +@c The following documentation was initially generated by +@c (generate-documentation) in (gnu services messaging). Manually maintained +@c documentation is better, so we shouldn't hesitate to edit below as +@c needed. However if the change you want to make to this documentation +@c can be done in an automated way, it's probably easier to change +@c (generate-documentation) than to make it below and have to deal with +@c the churn as Prosody updates. + +Available @code{prosody-configuration} fields are: + +@deftypevr {@code{prosody-configuration} parameter} package prosody +The Prosody package. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} file-name data-path +Location of the Prosody data storage directory. See +@url{https://prosody.im/doc/configure}. Defaults to +@samp{"/var/lib/prosody"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} file-object-list plugin-paths +Additional plugin directories. They are searched in all the specified paths +in order. See @url{https://prosody.im/doc/plugins_directory}. Defaults to +@samp{()}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} file-name certificates +Every virtual host and component needs a certificate so that clients and +servers can securely verify its identity. Prosody will automatically load +certificates/keys from the directory specified here. Defaults to +@samp{"/etc/prosody/certs"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string-list admins +This is a list of accounts that are admins for the server. Note that you +must create the accounts separately. See +@url{https://prosody.im/doc/admins} and +@url{https://prosody.im/doc/creating_accounts}. Example: @code{(admins +'("user1@@example.com" "user2@@example.net"))} Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} boolean use-libevent? +Enable use of libevent for better performance under high load. See +@url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} module-list modules-enabled +This is the list of modules Prosody will load on startup. It looks for +@code{mod_modulename.lua} in the plugins folder, so make sure that exists +too. Documentation on modules can be found at: +@url{https://prosody.im/doc/modules}. Defaults to @samp{("roster" +"saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" +"version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string-list modules-disabled +@samp{"offline"}, @samp{"c2s"} and @samp{"s2s"} are auto-loaded, but should +you want to disable them then add them to this list. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} file-object groups-file +Path to a text file where the shared groups are defined. If this path is +empty then @samp{mod_groups} does nothing. See +@url{https://prosody.im/doc/modules/mod_groups}. Defaults to +@samp{"/var/lib/prosody/sharedgroups.txt"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} boolean allow-registration? +Disable account creation by default, for security. See +@url{https://prosody.im/doc/creating_accounts}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} maybe-ssl-configuration ssl +These are the SSL/TLS-related settings. Most of them are disabled so to use +Prosody's defaults. If you do not completely understand these options, do +not add them to your config, it is easy to lower the security of your server +using them. See @url{https://prosody.im/doc/advanced_ssl_config}. + +Available @code{ssl-configuration} fields are: + +@deftypevr {@code{ssl-configuration} parameter} maybe-string protocol +This determines what handshake to use. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-file-name key +Path to your private key file. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-file-name certificate +Path to your certificate file. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} file-object capath +Path to directory containing root certificates that you wish Prosody to +trust when verifying the certificates of remote servers. Defaults to +@samp{"/etc/ssl/certs"}. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-file-object cafile +Path to a file containing root certificates that you wish Prosody to trust. +Similar to @code{capath} but with all certificates concatenated together. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string-list verify +A list of verification options (these mostly map to OpenSSL's +@code{set_verify()} flags). +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string-list options +A list of general options relating to SSL/TLS. These map to OpenSSL's +@code{set_options()}. For a full list of options available in LuaSec, see +the LuaSec source. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-non-negative-integer depth +How long a chain of certificate authorities to check when looking for a +trusted root certificate. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string ciphers +An OpenSSL cipher string. This selects what ciphers Prosody will offer to +clients, and in what order. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-file-name dhparam +A path to a file containing parameters for Diffie-Hellman key exchange. You +can create such a file with: @code{openssl dhparam -out +/etc/prosody/certs/dh-2048.pem 2048} +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string curve +Curve for Elliptic curve Diffie-Hellman. Prosody's default is +@samp{"secp384r1"}. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string-list verifyext +A list of "extra" verification options. +@end deftypevr + +@deftypevr {@code{ssl-configuration} parameter} maybe-string password +Password for encrypted private keys. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} boolean c2s-require-encryption? +Whether to force all client-to-server connections to be encrypted or not. +See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms +Set of mechanisms that will never be offered. See +@url{https://prosody.im/doc/modules/mod_saslauth}. Defaults to +@samp{("DIGEST-MD5")}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} boolean s2s-require-encryption? +Whether to force all server-to-server connections to be encrypted or not. +See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} boolean s2s-secure-auth? +Whether to require encryption and certificate authentication. This provides +ideal security, but requires servers you communicate with to support +encryption AND present valid, trusted certificates. See +@url{https://prosody.im/doc/s2s#security}. Defaults to @samp{#f}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string-list s2s-insecure-domains +Many servers don't support encryption or have invalid or self-signed +certificates. You can list domains here that will not be required to +authenticate using certificates. They will be authenticated using DNS. See +@url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string-list s2s-secure-domains +Even if you leave @code{s2s-secure-auth?} disabled, you can still require +valid certificates for some domains by specifying a list here. See +@url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string authentication +Select the authentication backend to use. The default provider stores +passwords in plaintext and uses Prosody's configured data storage to store +the authentication data. If you do not trust your server please see +@url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for +information about using the hashed backend. See also +@url{https://prosody.im/doc/authentication} Defaults to +@samp{"internal_plain"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} maybe-string log +Set logging options. Advanced logging configuration is not yet supported by +the GuixSD Prosody Service. See @url{https://prosody.im/doc/logging}. +Defaults to @samp{"*syslog"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} file-name pidfile +File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. +Defaults to @samp{"/var/run/prosody/prosody.pid"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size +Maximum allowed size of the HTTP body (in bytes). +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} maybe-string http-external-url +Some modules expose their own URL in various ways. This URL is built from +the protocol, host and port used. If Prosody sits behind a proxy, the +public URL will be @code{http-external-url} instead. See +@url{https://prosody.im/doc/http#external_url}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts +A host in Prosody is a domain on which user accounts can be created. For +example if you want your users to have addresses like +@samp{"john.smith@@example.com"} then you need to add a host +@samp{"example.com"}. All options in this list will apply only to this +host. + +Note: the name "virtual" host is used in configuration to avoid confusion +with the actual physical host that Prosody is installed on. A single +Prosody instance can serve many domains, each one defined as a VirtualHost +entry in Prosody's configuration. Conversely a server that hosts a single +domain would have just one VirtualHost entry. + +See @url{https://prosody.im/doc/configure#virtual_host_settings}. + +Available @code{virtualhost-configuration} fields are: + +all these @code{prosody-configuration} fields: @code{admins}, +@code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, +@code{groups-file}, @code{allow-registration?}, @code{ssl}, +@code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, +@code{s2s-require-encryption?}, @code{s2s-secure-auth?}, +@code{s2s-insecure-domains}, @code{s2s-secure-domains}, +@code{authentication}, @code{log}, @code{http-max-content-size}, +@code{http-external-url}, @code{raw-content}, plus: +@deftypevr {@code{virtualhost-configuration} parameter} string domain +Domain you wish Prosody to serve. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} int-component-configuration-list int-components +Components are extra services on a server which are available to clients, +usually on a subdomain of the main server (such as +@samp{"mycomponent.example.com"}). Example components might be chatroom +servers, user directories, or gateways to other protocols. + +Internal components are implemented with Prosody-specific plugins. To add +an internal component, you simply fill the hostname field, and the plugin +you wish to use for the component. + +See @url{https://prosody.im/doc/components}. Defaults to @samp{()}. + +Available @code{int-component-configuration} fields are: + +all these @code{prosody-configuration} fields: @code{admins}, +@code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, +@code{groups-file}, @code{allow-registration?}, @code{ssl}, +@code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, +@code{s2s-require-encryption?}, @code{s2s-secure-auth?}, +@code{s2s-insecure-domains}, @code{s2s-secure-domains}, +@code{authentication}, @code{log}, @code{http-max-content-size}, +@code{http-external-url}, @code{raw-content}, plus: +@deftypevr {@code{int-component-configuration} parameter} string hostname +Hostname of the component. +@end deftypevr + +@deftypevr {@code{int-component-configuration} parameter} string plugin +Plugin you wish to use for the component. +@end deftypevr + +@deftypevr {@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc +Multi-user chat (MUC) is Prosody's module for allowing you to create hosted +chatrooms/conferences for XMPP users. + +General information on setting up and using multi-user chatrooms can be +found in the "Chatrooms" documentation +(@url{https://prosody.im/doc/chatrooms}), which you should read if you are +new to XMPP chatrooms. + +See also @url{https://prosody.im/doc/modules/mod_muc}. + +Available @code{mod-muc-configuration} fields are: + +@deftypevr {@code{mod-muc-configuration} parameter} string name +The name to return in service discovery responses. Defaults to +@samp{"Prosody Chatrooms"}. +@end deftypevr + +@deftypevr {@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation +If @samp{#t}, this will only allow admins to create new chatrooms. +Otherwise anyone can create a room. The value @samp{"local"} restricts room +creation to users on the service's parent domain. +E.g. @samp{user@@example.com} can create rooms on @samp{rooms.example.com}. +The value @samp{"admin"} restricts to service administrators only. Defaults +to @samp{#f}. +@end deftypevr + +@deftypevr {@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages +Maximum number of history messages that will be sent to the member that has +just joined the room. Defaults to @samp{20}. +@end deftypevr + +@end deftypevr + +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} ext-component-configuration-list ext-components +External components use XEP-0114, which most standalone components support. +To add an external component, you simply fill the hostname field. See +@url{https://prosody.im/doc/components}. Defaults to @samp{()}. + +Available @code{ext-component-configuration} fields are: + +all these @code{prosody-configuration} fields: @code{admins}, +@code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, +@code{groups-file}, @code{allow-registration?}, @code{ssl}, +@code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, +@code{s2s-require-encryption?}, @code{s2s-secure-auth?}, +@code{s2s-insecure-domains}, @code{s2s-secure-domains}, +@code{authentication}, @code{log}, @code{http-max-content-size}, +@code{http-external-url}, @code{raw-content}, plus: +@deftypevr {@code{ext-component-configuration} parameter} string component-secret +Password which the component will use to log in. +@end deftypevr + +@deftypevr {@code{ext-component-configuration} parameter} string hostname +Hostname of the component. +@end deftypevr + +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} non-negative-integer-list component-ports +Port(s) Prosody listens on for component connections. Defaults to +@samp{(5347)}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} string component-interface +Interface Prosody listens on for component connections. Defaults to +@samp{"127.0.0.1"}. +@end deftypevr + +@deftypevr {@code{prosody-configuration} parameter} maybe-raw-content raw-content +Raw content that will be added to the configuration file. +@end deftypevr + +It could be that you just want to get a @code{prosody.cfg.lua} up and +running. In that case, you can pass an @code{opaque-prosody-configuration} +record as the value of @code{prosody-service-type}. As its name indicates, +an opaque configuration does not have easy reflective capabilities. +Available @code{opaque-prosody-configuration} fields are: + +@deftypevr {@code{opaque-prosody-configuration} parameter} package prosody +The prosody package. +@end deftypevr + +@deftypevr {@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua +The contents of the @code{prosody.cfg.lua} to use. +@end deftypevr + +For example, if your @code{prosody.cfg.lua} is just the empty string, you +could instantiate a prosody service like this: + +@example +(service prosody-service-type + (opaque-prosody-configuration + (prosody.cfg.lua ""))) +@end example + +@c end of Prosody auto-generated documentation + +@subsubheading BitlBee Service + +@cindex IRC (Internet Relay Chat) +@cindex IRC gateway +@url{http://bitlbee.org,BitlBee} is a gateway that provides an IRC interface +to a variety of messaging protocols such as XMPP. + +@defvr {Scheme Variable} bitlbee-service-type +This is the service type for the @url{http://bitlbee.org,BitlBee} IRC +gateway daemon. Its value is a @code{bitlbee-configuration} (see below). + +To have BitlBee listen on port 6667 on localhost, add this line to your +services: + +@example +(service bitlbee-service-type) +@end example +@end defvr + +@deftp {Data Type} bitlbee-configuration +This is the configuration for BitlBee, with the following fields: + +@table @asis +@item @code{interface} (default: @code{"127.0.0.1"}) +@itemx @code{port} (default: @code{6667}) +Listen on the network interface corresponding to the IP address specified in +@var{interface}, on @var{port}. + +When @var{interface} is @code{127.0.0.1}, only local clients can connect; +when it is @code{0.0.0.0}, connections can come from any networking +interface. + +@item @code{package} (default: @code{bitlbee}) +The BitlBee package to use. + +@item @code{plugins} (default: @code{'()}) +List of plugin packages to use---e.g., @code{bitlbee-discord}. + +@item @code{extra-settings} (default: @code{""}) +Configuration snippet added as-is to the BitlBee configuration file. +@end table +@end deftp + + +@node Telefondienste +@subsubsection Telefondienste + +@cindex Murmur (VoIP server) +@cindex VoIP server +This section describes how to set up and run a Murmur server. Murmur is the +server of the @uref{https://mumble.info, Mumble} voice-over-IP (VoIP) suite. + +@deftp {Data Type} murmur-configuration +The service type for the Murmur server. An example configuration can look +like this: + +@example +(service murmur-service-type + (murmur-configuration + (welcome-text + "Welcome to this Mumble server running on GuixSD!") + (cert-required? #t) ;disallow text password logins + (ssl-cert "/etc/letsencrypt/live/mumble.example.com/fullchain.pem") + (ssl-key "/etc/letsencrypt/live/mumble.example.com/privkey.pem"))) +@end example + +After reconfiguring your system, you can manually set the murmur +@code{SuperUser} password with the command that is printed during the +activation phase. + +It is recommended to register a normal Mumble user account and grant it +admin or moderator rights. You can use the @code{mumble} client to login as +new normal user, register yourself, and log out. For the next step login +with the name @code{SuperUser} use the @code{SuperUser} password that you +set previously, and grant your newly registered mumble user administrator or +moderator rights and create some channels. + +Available @code{murmur-configuration} fields are: + +@table @asis +@item @code{package} (default: @code{mumble}) +Package that contains @code{bin/murmurd}. + +@item @code{user} (default: @code{"murmur"}) +User who will run the Murmur server. + +@item @code{group} (default: @code{"murmur"}) +Group of the user who will run the murmur server. + +@item @code{port} (default: @code{64738}) +Port on which the server will listen. + +@item @code{welcome-text} (default: @code{""}) +Welcome text sent to clients when they connect. + +@item @code{server-password} (default: @code{""}) +Password the clients have to enter in order to connect. + +@item @code{max-users} (default: @code{100}) +Maximum of users that can be connected to the server at once. + +@item @code{max-user-bandwidth} (default: @code{#f}) +Maximum voice traffic a user can send per second. + +@item @code{database-file} (default: @code{"/var/lib/murmur/db.sqlite"}) +File name of the sqlite database. The service's user will become the owner +of the directory. + +@item @code{log-file} (default: @code{"/var/log/murmur/murmur.log"}) +File name of the log file. The service's user will become the owner of the +directory. + +@item @code{autoban-attempts} (default: @code{10}) +Maximum number of logins a user can make in @code{autoban-timeframe} without +getting auto banned for @code{autoban-time}. + +@item @code{autoban-timeframe} (default: @code{120}) +Timeframe for autoban in seconds. + +@item @code{autoban-time} (default: @code{300}) +Amount of time in seconds for which a client gets banned when violating the +autoban limits. + +@item @code{opus-threshold} (default: @code{100}) +Percentage of clients that need to support opus before switching over to +opus audio codec. + +@item @code{channel-nesting-limit} (default: @code{10}) +How deep channels can be nested at maximum. + +@item @code{channelname-regex} (default: @code{#f}) +A string in from of a Qt regular expression that channel names must conform +to. + +@item @code{username-regex} (default: @code{#f}) +A string in from of a Qt regular expression that user names must conform to. + +@item @code{text-message-length} (default: @code{5000}) +Maximum size in bytes that a user can send in one text chat message. + +@item @code{image-message-length} (default: @code{(* 128 1024)}) +Maximum size in bytes that a user can send in one image message. + +@item @code{cert-required?} (default: @code{#f}) +If it is set to @code{#t} clients that use weak password authentification +will not be accepted. Users must have completed the certificate wizard to +join. + +@item @code{remember-channel?} (defualt @code{#f}) +Should murmur remember the last channel each user was in when they +disconnected and put them into the remembered channel when they rejoin. + +@item @code{allow-html?} (default: @code{#f}) +Should html be allowed in text messages, user comments, and channel +descriptions. + +@item @code{allow-ping?} (default: @code{#f}) +Setting to true exposes the current user count, the maximum user count, and +the server's maximum bandwidth per client to unauthenticated users. In the +Mumble client, this information is shown in the Connect dialog. + +Disabling this setting will prevent public listing of the server. + +@item @code{bonjour?} (default: @code{#f}) +Should the server advertise itself in the local network through the bonjour +protocol. + +@item @code{send-version?} (default: @code{#f}) +Should the murmur server version be exposed in ping requests. + +@item @code{log-days} (default: @code{31}) +Murmur also stores logs in the database, which are accessible via RPC. The +default is 31 days of months, but you can set this setting to 0 to keep logs +forever, or -1 to disable logging to the database. + +@item @code{obfuscate-ips?} (default @code{#t}) +Should logged ips be obfuscated to protect the privacy of users. + +@item @code{ssl-cert} (default: @code{#f}) +File name of the SSL/TLS certificate used for encrypted connections. + +@example +(ssl-cert "/etc/letsencrypt/live/example.com/fullchain.pem") +@end example +@item @code{ssl-key} (default: @code{#f}) +Filepath to the ssl private key used for encrypted connections. +@example +(ssl-key "/etc/letsencrypt/live/example.com/privkey.pem") +@end example + +@item @code{ssl-dh-params} (default: @code{#f}) +File name of a PEM-encoded file with Diffie-Hellman parameters for the +SSL/TLS encryption. Alternatively you set it to @code{"@@ffdhe2048"}, +@code{"@@ffdhe3072"}, @code{"@@ffdhe4096"}, @code{"@@ffdhe6144"} or +@code{"@@ffdhe8192"} to use bundled parameters from RFC 7919. + +@item @code{ssl-ciphers} (default: @code{#f}) +The @code{ssl-ciphers} option chooses the cipher suites to make available +for use in SSL/TLS. + +This option is specified using +@uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, +OpenSSL cipher list notation}. + +It is recommended that you try your cipher string using 'openssl ciphers +<string>' before setting it here, to get a feel for which cipher suites you +will get. After setting this option, it is recommend that you inspect your +Murmur log to ensure that Murmur is using the cipher suites that you +expected it to. + +Note: Changing this option may impact the backwards compatibility of your +Murmur server, and can remove the ability for older Mumble clients to be +able to connect to it. + +@item @code{public-registration} (default: @code{#f}) +Must be a @code{<murmur-public-registration-configuration>} record or +@code{#f}. + +You can optionally register your server in the public server list that the +@code{mumble} client shows on startup. You cannot register your server if +you have set a @code{server-password}, or set @code{allow-ping} to +@code{#f}. + +It might take a few hours until it shows up in the public list. + +@item @code{file} (default: @code{#f}) +Optional alternative override for this configuration. +@end table +@end deftp + +@deftp {Data Type} murmur-public-registration-configuration +Configuration for public registration of a murmur service. + +@table @asis +@item @code{name} +This is a display name for your server. Not to be confused with the +hostname. + +@item @code{password} +A password to identify your registration. Subsequent updates will need the +same password. Don't lose your password. + +@item @code{url} +This should be a @code{http://} or @code{https://} link to your web site. + +@item @code{hostname} (default: @code{#f}) +By default your server will be listed by its IP address. If it is set your +server will be linked by this host name instead. +@end table +@end deftp + + + +@node Überwachungsdienste +@subsubsection Überwachungsdienste + +@subsubheading Tailon Service + +@uref{https://tailon.readthedocs.io/, Tailon} is a web application for +viewing and searching log files. + +The following example will configure the service with default values. By +default, Tailon can be accessed on port 8080 (@code{http://localhost:8080}). + +@example +(service tailon-service-type) +@end example + +The following example customises more of the Tailon configuration, adding +@command{sed} to the list of allowed commands. + +@example +(service tailon-service-type + (tailon-configuration + (config-file + (tailon-configuration-file + (allowed-commands '("tail" "grep" "awk" "sed")))))) +@end example + + +@deftp {Data Type} tailon-configuration +Data type representing the configuration of Tailon. This type has the +following parameters: + +@table @asis +@item @code{config-file} (default: @code{(tailon-configuration-file)}) +The configuration file to use for Tailon. This can be set to a +@dfn{tailon-configuration-file} record value, or any gexp +(@pxref{G-Ausdrücke}). + +For example, to instead use a local file, the @code{local-file} function can +be used: + +@example +(service tailon-service-type + (tailon-configuration + (config-file (local-file "./my-tailon.conf")))) +@end example + +@item @code{package} (default: @code{tailon}) +The tailon package to use. + +@end table +@end deftp + +@deftp {Data Type} tailon-configuration-file +Data type representing the configuration options for Tailon. This type has +the following parameters: + +@table @asis +@item @code{files} (default: @code{(list "/var/log")}) +List of files to display. The list can include strings for a single file or +directory, or a list, where the first item is the name of a subsection, and +the remaining items are the files or directories in that subsection. + +@item @code{bind} (default: @code{"localhost:8080"}) +Address and port to which Tailon should bind on. + +@item @code{relative-root} (default: @code{#f}) +URL path to use for Tailon, set to @code{#f} to not use a path. + +@item @code{allow-transfers?} (default: @code{#t}) +Allow downloading the log files in the web interface. + +@item @code{follow-names?} (default: @code{#t}) +Allow tailing of not-yet existent files. + +@item @code{tail-lines} (default: @code{200}) +Number of lines to read initially from each file. + +@item @code{allowed-commands} (default: @code{(list "tail" "grep" "awk")}) +Commands to allow running. By default, @code{sed} is disabled. + +@item @code{debug?} (default: @code{#f}) +Set @code{debug?} to @code{#t} to show debug messages. + +@item @code{wrap-lines} (default: @code{#t}) +Initial line wrapping state in the web interface. Set to @code{#t} to +initially wrap lines (the default), or to @code{#f} to initially not wrap +lines. + +@item @code{http-auth} (default: @code{#f}) +HTTP authentication type to use. Set to @code{#f} to disable authentication +(the default). Supported values are @code{"digest"} or @code{"basic"}. + +@item @code{users} (default: @code{#f}) +If HTTP authentication is enabled (see @code{http-auth}), access will be +restricted to the credentials provided here. To configure users, use a list +of pairs, where the first element of the pair is the username, and the 2nd +element of the pair is the password. + +@example +(tailon-configuration-file + (http-auth "basic") + (users '(("user1" . "password1") + ("user2" . "password2")))) +@end example + +@end table +@end deftp + + +@subsubheading Darkstat Service +@cindex darkstat +Darkstat is a packet sniffer that captures network traffic, calculates +statistics about usage, and serves reports over HTTP. + +@defvar {Scheme Variable} darkstat-service-type +This is the service type for the @uref{https://unix4lyfe.org/darkstat/, +darkstat} service, its value must be a @code{darkstat-configuration} record +as in this example: + +@example +(service darkstat-service-type + (darkstat-configuration + (interface "eno1"))) +@end example +@end defvar + +@deftp {Data Type} darkstat-configuration +Data type representing the configuration of @command{darkstat}. + +@table @asis +@item @code{package} (default: @code{darkstat}) +The darkstat package to use. + +@item @code{interface} +Capture traffic on the specified network interface. + +@item @code{port} (default: @code{"667"}) +Bind the web interface to the specified port. + +@item @code{bind-address} (default: @code{"127.0.0.1"}) +Bind the web interface to the specified address. + +@item @code{base} (default: @code{"/"}) +Specify the path of the base URL. This can be useful if @command{darkstat} +is accessed via a reverse proxy. + +@end table +@end deftp + +@subsubheading Prometheus Node Exporter Service + +@cindex prometheus-node-exporter +The Prometheus ``node exporter'' makes hardware and operating system +statistics provided by the Linux kernel available for the Prometheus +monitoring system. This service should be deployed on all physical nodes +and virtual machines, where monitoring these statistics is desirable. + +@defvar {Scheme variable} prometheus-node-exporter-service-type +This is the service type for the +@uref{https://github.com/prometheus/node_exporter/, +prometheus-node-exporter} service, its value must be a +@code{prometheus-node-exporter-configuration} record as in this example: + +@example +(service prometheus-node-exporter-service-type + (prometheus-node-exporter-configuration + (web-listen-address ":9100"))) +@end example +@end defvar + +@deftp {Data Type} prometheus-node-exporter-configuration +Data type representing the configuration of @command{node_exporter}. + +@table @asis +@item @code{package} (default: @code{go-github-com-prometheus-node-exporter}) +The prometheus-node-exporter package to use. + +@item @code{web-listen-address} (default: @code{":9100"}) +Bind the web interface to the specified address. + +@end table +@end deftp + +@node Kerberos-Dienste +@subsubsection Kerberos-Dienste +@cindex Kerberos + +The @code{(gnu services kerberos)} module provides services relating to the +authentication protocol @dfn{Kerberos}. + +@subsubheading Krb5 Service + +Programs using a Kerberos client library normally expect a configuration +file in @file{/etc/krb5.conf}. This service generates such a file from a +definition provided in the operating system declaration. It does not cause +any daemon to be started. + +No ``keytab'' files are provided by this service---you must explicitly +create them. This service is known to work with the MIT client library, +@code{mit-krb5}. Other implementations have not been tested. + +@defvr {Scheme Variable} krb5-service-type +A service type for Kerberos 5 clients. +@end defvr + +@noindent +Here is an example of its use: +@lisp +(service krb5-service-type + (krb5-configuration + (default-realm "EXAMPLE.COM") + (allow-weak-crypto? #t) + (realms (list + (krb5-realm + (name "EXAMPLE.COM") + (admin-server "groucho.example.com") + (kdc "karl.example.com")) + (krb5-realm + (name "ARGRX.EDU") + (admin-server "kerb-admin.argrx.edu") + (kdc "keys.argrx.edu")))))) +@end lisp + +@noindent +This example provides a Kerberos@tie{}5 client configuration which: +@itemize +@item Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both +of which have distinct administration servers and key distribution centers; +@item Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly +specified by clients; +@item Accepts services which only support encryption types known to be weak. +@end itemize + +The @code{krb5-realm} and @code{krb5-configuration} types have many fields. +Only the most commonly used ones are described here. For a full list, and +more detailed explanation of each, see the MIT +@uref{http://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} +documentation. + + +@deftp {Data Type} krb5-realm +@cindex realm, kerberos +@table @asis +@item @code{name} +This field is a string identifying the name of the realm. A common +convention is to use the fully qualified DNS name of your organization, +converted to upper case. + +@item @code{admin-server} +This field is a string identifying the host where the administration server +is running. + +@item @code{kdc} +This field is a string identifying the key distribution center for the +realm. +@end table +@end deftp + +@deftp {Data Type} krb5-configuration + +@table @asis +@item @code{allow-weak-crypto?} (default: @code{#f}) +If this flag is @code{#t} then services which only offer encryption +algorithms known to be weak will be accepted. + +@item @code{default-realm} (default: @code{#f}) +This field should be a string identifying the default Kerberos realm for the +client. You should set this field to the name of your Kerberos realm. If +this value is @code{#f} then a realm must be specified with every Kerberos +principal when invoking programs such as @command{kinit}. + +@item @code{realms} +This should be a non-empty list of @code{krb5-realm} objects, which clients +may access. Normally, one of them will have a @code{name} field matching +the @code{default-realm} field. +@end table +@end deftp + + +@subsubheading PAM krb5 Service +@cindex pam-krb5 + +The @code{pam-krb5} service allows for login authentication and password +management via Kerberos. You will need this service if you want PAM enabled +applications to authenticate users using Kerberos. + +@defvr {Scheme Variable} pam-krb5-service-type +A service type for the Kerberos 5 PAM module. +@end defvr + +@deftp {Data Type} pam-krb5-configuration +Data type representing the configuration of the Kerberos 5 PAM module This +type has the following parameters: +@table @asis +@item @code{pam-krb5} (default: @code{pam-krb5}) +The pam-krb5 package to use. + +@item @code{minimum-uid} (default: @code{1000}) +The smallest user ID for which Kerberos authentications should be +attempted. Local accounts with lower values will silently fail to +authenticate. +@end table +@end deftp + + +@node Web-Dienste +@subsubsection Web-Dienste + +@cindex web +@cindex www +@cindex HTTP +The @code{(gnu services web)} module provides the Apache HTTP Server, the +nginx web server, and also a fastcgi wrapper daemon. + +@subsubheading Apache HTTP Server + +@deffn {Scheme Variable} httpd-service-type +Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server +(@dfn{httpd}). The value for this service type is a +@code{https-configuration} record. + +A simple example configuration is given below. + +@example +(service httpd-service-type + (httpd-configuration + (config + (httpd-config-file + (server-name "www.example.com") + (document-root "/srv/http/www.example.com"))))) +@end example + +Other services can also extend the @code{httpd-service-type} to add to the +configuration. + +@example +(simple-service 'my-extra-server httpd-service-type + (list + (httpd-virtualhost + "*:80" + (list (string-append + "ServerName "www.example.com + DocumentRoot \"/srv/http/www.example.com\""))))) +@end example +@end deffn + +The details for the @code{httpd-configuration}, @code{httpd-module}, +@code{httpd-config-file} and @code{httpd-virtualhost} record types are given +below. + +@deffn {Data Type} httpd-configuration +This data type represents the configuration for the httpd service. + +@table @asis +@item @code{package} (default: @code{httpd}) +The httpd package to use. + +@item @code{pid-file} (default: @code{"/var/run/httpd"}) +The pid file used by the shepherd-service. + +@item @code{config} (default: @code{(httpd-config-file)}) +The configuration file to use with the httpd service. The default value is a +@code{httpd-config-file} record, but this can also be a different +G-expression that generates a file, for example a @code{plain-file}. A file +outside of the store can also be specified through a string. + +@end table +@end deffn + +@deffn {Data Type} httpd-module +This data type represents a module for the httpd service. + +@table @asis +@item @code{name} +The name of the module. + +@item @code{file} +The file for the module. This can be relative to the httpd package being +used, the absolute location of a file, or a G-expression for a file within +the store, for example @code{(file-append mod-wsgi "/modules/mod_wsgi.so")}. + +@end table +@end deffn + +@defvr {Scheme Variable} %default-httpd-modules +A default list of @code{httpd-module} objects. +@end defvr + +@deffn {Data Type} httpd-config-file +This data type represents a configuration file for the httpd service. + +@table @asis +@item @code{modules} (default: @code{%default-httpd-modules}) +The modules to load. Additional modules can be added here, or loaded by +additional configuration. + +For example, in order to handle requests for PHP files, you can use Apache’s +@code{mod_proxy_fcgi} module along with @code{php-fpm-service-type}: + +@example +(service httpd-service-type + (httpd-configuration + (config + (httpd-config-file + (modules (cons* + (httpd-module + (name "proxy_module") + (file "modules/mod_proxy.so")) + (httpd-module + (name "proxy_fcgi_module") + (file "modules/mod_proxy_fcgi.so")) + %default-httpd-modules)) + (extra-config (list "\ +<FilesMatch \\.php$> + SetHandler \"proxy:unix:/var/run/php-fpm.sock|fcgi://localhost/\" +</FilesMatch>")))))) +(service php-fpm-service-type + (php-fpm-configuration + (socket "/var/run/php-fpm.sock") + (socket-group "httpd"))) +@end example + +@item @code{server-root} (default: @code{httpd}) +The @code{ServerRoot} in the configuration file, defaults to the httpd +package. Directives including @code{Include} and @code{LoadModule} are taken +as relative to the server root. + +@item @code{server-name} (default: @code{#f}) +The @code{ServerName} in the configuration file, used to specify the request +scheme, hostname and port that the server uses to identify itself. + +This doesn't need to be set in the server config, and can be specifyed in +virtual hosts. The default is @code{#f} to not specify a @code{ServerName}. + +@item @code{document-root} (default: @code{"/srv/http"}) +The @code{DocumentRoot} from which files will be served. + +@item @code{listen} (default: @code{'("80")}) +The list of values for the @code{Listen} directives in the config file. The +value should be a list of strings, when each string can specify the port +number to listen on, and optionally the IP address and protocol to use. + +@item @code{pid-file} (default: @code{"/var/run/httpd"}) +The @code{PidFile} to use. This should match the @code{pid-file} set in the +@code{httpd-configuration} so that the Shepherd service is configured +correctly. + +@item @code{error-log} (default: @code{"/var/log/httpd/error_log"}) +The @code{ErrorLog} to which the server will log errors. + +@item @code{user} (default: @code{"httpd"}) +The @code{User} which the server will answer requests as. + +@item @code{group} (default: @code{"httpd"}) +The @code{Group} which the server will answer requests as. + +@item @code{extra-config} (default: @code{(list "TypesConfig etc/httpd/mime.types")}) +A flat list of strings and G-expressions which will be added to the end of +the configuration file. + +Any values which the service is extended with will be appended to this list. + +@end table +@end deffn + +@deffn {Data Type} httpd-virtualhost +This data type represents a virtualhost configuration block for the httpd +service. + +These should be added to the extra-config for the httpd-service. + +@example +(simple-service 'my-extra-server httpd-service-type + (list + (httpd-virtualhost + "*:80" + (list (string-append + "ServerName "www.example.com + DocumentRoot \"/srv/http/www.example.com\""))))) +@end example + +@table @asis +@item @code{addresses-and-ports} +The addresses and ports for the @code{VirtualHost} directive. + +@item @code{contents} +The contents of the @code{VirtualHost} directive, this should be a list of +strings and G-expressions. + +@end table +@end deffn + +@subsubheading NGINX + +@deffn {Scheme Variable} nginx-service-type +Service type for the @uref{https://nginx.org/,NGinx} web server. The value +for this service type is a @code{<nginx-configuration>} record. + +A simple example configuration is given below. + +@example +(service nginx-service-type + (nginx-configuration + (server-blocks + (list (nginx-server-configuration + (server-name '("www.example.com")) + (root "/srv/http/www.example.com")))))) +@end example + +In addition to adding server blocks to the service configuration directly, +this service can be extended by other services to add server blocks, as in +this example: + +@example +(simple-service 'my-extra-server nginx-service-type + (list (nginx-server-configuration + (root "/srv/http/extra-website") + (try-files (list "$uri" "$uri/index.html"))))) +@end example +@end deffn + +At startup, @command{nginx} has not yet read its configuration file, so it +uses a default file to log error messages. If it fails to load its +configuration file, that is where error messages are logged. After the +configuration file is loaded, the default error log file changes as per +configuration. In our case, startup error messages can be found in +@file{/var/run/nginx/logs/error.log}, and after configuration in +@file{/var/log/nginx/error.log}. The second location can be changed with +the @var{log-directory} configuration option. + +@deffn {Data Type} nginx-configuration +This data type represents the configuration for NGinx. Some configuration +can be done through this and the other provided record types, or +alternatively, a config file can be provided. + +@table @asis +@item @code{nginx} (default: @code{nginx}) +The nginx package to use. + +@item @code{log-directory} (default: @code{"/var/log/nginx"}) +The directory to which NGinx will write log files. + +@item @code{run-directory} (default: @code{"/var/run/nginx"}) +The directory in which NGinx will create a pid file, and write temporary +files. + +@item @code{server-blocks} (default: @code{'()}) +A list of @dfn{server blocks} to create in the generated configuration file, +the elements should be of type @code{<nginx-server-configuration>}. + +The following example would setup NGinx to serve @code{www.example.com} from +the @code{/srv/http/www.example.com} directory, without using HTTPS. +@example +(service nginx-service-type + (nginx-configuration + (server-blocks + (list (nginx-server-configuration + (server-name '("www.example.com")) + (root "/srv/http/www.example.com")))))) +@end example + +@item @code{upstream-blocks} (default: @code{'()}) +A list of @dfn{upstream blocks} to create in the generated configuration +file, the elements should be of type @code{<nginx-upstream-configuration>}. + +Configuring upstreams through the @code{upstream-blocks} can be useful when +combined with @code{locations} in the @code{<nginx-server-configuration>} +records. The following example creates a server configuration with one +location configuration, that will proxy requests to a upstream +configuration, which will handle requests with two servers. + +@example +(service + nginx-service-type + (nginx-configuration + (server-blocks + (list (nginx-server-configuration + (server-name '("www.example.com")) + (root "/srv/http/www.example.com") + (locations + (list + (nginx-location-configuration + (uri "/path1") + (body '("proxy_pass http://server-proxy;")))))))) + (upstream-blocks + (list (nginx-upstream-configuration + (name "server-proxy") + (servers (list "server1.example.com" + "server2.example.com"))))))) +@end example + +@item @code{file} (default: @code{#f}) +If a configuration @var{file} is provided, this will be used, rather than +generating a configuration file from the provided @code{log-directory}, +@code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For +proper operation, these arguments should match what is in @var{file} to +ensure that the directories are created when the service is activated. + +This can be useful if you have an existing configuration file, or it's not +possible to do what is required through the other parts of the +nginx-configuration record. + +@item @code{server-names-hash-bucket-size} (default: @code{#f}) +Bucket size for the server names hash tables, defaults to @code{#f} to use +the size of the processors cache line. + +@item @code{server-names-hash-bucket-max-size} (default: @code{#f}) +Maximum bucket size for the server names hash tables. + +@item @code{extra-content} (default: @code{""}) +Extra content for the @code{http} block. Should be string or a string +valued G-expression. + +@end table +@end deffn + +@deftp {Data Type} nginx-server-configuration +Data type representing the configuration of an nginx server block. This +type has the following parameters: + +@table @asis +@item @code{listen} (default: @code{'("80" "443 ssl")}) +Each @code{listen} directive sets the address and port for IP, or the path +for a UNIX-domain socket on which the server will accept requests. Both +address and port, or only address or only port can be specified. An address +may also be a hostname, for example: + +@example +'("127.0.0.1:8000" "127.0.0.1" "8000" "*:8000" "localhost:8000") +@end example + +@item @code{server-name} (default: @code{(list 'default)}) +A list of server names this server represents. @code{'default} represents +the default server for connections matching no other server. + +@item @code{root} (default: @code{"/srv/http"}) +Root of the website nginx will serve. + +@item @code{locations} (default: @code{'()}) +A list of @dfn{nginx-location-configuration} or +@dfn{nginx-named-location-configuration} records to use within this server +block. + +@item @code{index} (default: @code{(list "index.html")}) +Index files to look for when clients ask for a directory. If it cannot be +found, Nginx will send the list of files in the directory. + +@item @code{try-files} (default: @code{'()}) +A list of files whose existence is checked in the specified order. +@code{nginx} will use the first file it finds to process the request. + +@item @code{ssl-certificate} (default: @code{#f}) +Where to find the certificate for secure connections. Set it to @code{#f} +if you don't have a certificate or you don't want to use HTTPS. + +@item @code{ssl-certificate-key} (default: @code{#f}) +Where to find the private key for secure connections. Set it to @code{#f} +if you don't have a key or you don't want to use HTTPS. + +@item @code{server-tokens?} (default: @code{#f}) +Whether the server should add its configuration to response. + +@item @code{raw-content} (default: @code{'()}) +A list of raw lines added to the server block. + +@end table +@end deftp + +@deftp {Data Type} nginx-upstream-configuration +Data type representing the configuration of an nginx @code{upstream} block. +This type has the following parameters: + +@table @asis +@item @code{name} +Name for this group of servers. + +@item @code{servers} +Specify the addresses of the servers in the group. The address can be +specified as a IP address (e.g. @samp{127.0.0.1}), domain name +(e.g. @samp{backend1.example.com}) or a path to a UNIX socket using the +prefix @samp{unix:}. For addresses using an IP address or domain name, the +default port is 80, and a different port can be specified explicitly. + +@end table +@end deftp + +@deftp {Data Type} nginx-location-configuration +Data type representing the configuration of an nginx @code{location} block. +This type has the following parameters: + +@table @asis +@item @code{uri} +URI which this location block matches. + +@anchor{nginx-location-configuration body} +@item @code{body} +Body of the location block, specified as a list of strings. This can contain +many configuration directives. For example, to pass requests to a upstream +server group defined using an @code{nginx-upstream-configuration} block, the +following directive would be specified in the body @samp{(list "proxy_pass +http://upstream-name;")}. + +@end table +@end deftp + +@deftp {Data Type} nginx-named-location-configuration +Data type representing the configuration of an nginx named location block. +Named location blocks are used for request redirection, and not used for +regular request processing. This type has the following parameters: + +@table @asis +@item @code{name} +Name to identify this location block. + +@item @code{body} +@xref{nginx-location-configuration body}, as the body for named location +blocks can be used in a similar way to the +@code{nginx-location-configuration body}. One restriction is that the body +of a named location block cannot contain location blocks. + +@end table +@end deftp + +@subsubheading Varnish Cache +@cindex Varnish +Varnish is a fast cache server that sits in between web applications and end +users. It proxies requests from clients and caches the accessed URLs such +that multiple requests for the same resource only creates one request to the +back-end. + +@defvr {Scheme Variable} varnish-service-type +Service type for the Varnish daemon. +@end defvr + +@deftp {Data Type} varnish-configuration +Data type representing the @code{varnish} service configuration. This type +has the following parameters: + +@table @asis +@item @code{package} (default: @code{varnish}) +The Varnish package to use. + +@item @code{name} (default: @code{"default"}) +A name for this Varnish instance. Varnish will create a directory in +@file{/var/varnish/} with this name and keep temporary files there. If the +name starts with a forward slash, it is interpreted as an absolute directory +name. + +Pass the @code{-n} argument to other Varnish programs to connect to the +named instance, e.g. @command{varnishncsa -n default}. + +@item @code{backend} (default: @code{"localhost:8080"}) +The backend to use. This option has no effect if @code{vcl} is set. + +@item @code{vcl} (default: #f) +The @dfn{VCL} (Varnish Configuration Language) program to run. If this is +@code{#f}, Varnish will proxy @code{backend} using the default +configuration. Otherwise this must be a file-like object with valid VCL +syntax. + +@c Varnish does not support HTTPS, so keep this URL to avoid confusion. +For example, to mirror @url{http://www.gnu.org,www.gnu.org} with VCL you can +do something along these lines: + +@example +(define %gnu-mirror + (plain-file + "gnu.vcl" + "vcl 4.1; +backend gnu @{ .host = "www.gnu.org"; @}")) + +(operating-system + ... + (services (cons (service varnish-service-type + (varnish-configuration + (listen '(":80")) + (vcl %gnu-mirror))) + %base-services))) +@end example + +The configuration of an already running Varnish instance can be inspected +and changed using the @command{varnishadm} program. + +Consult the @url{https://varnish-cache.org/docs/,Varnish User Guide} and +@url{https://book.varnish-software.com/4.0/,Varnish Book} for comprehensive +documentation on Varnish and its configuration language. + +@item @code{listen} (default: @code{'("localhost:80")}) +List of addresses Varnish will listen on. + +@item @code{storage} (default: @code{'("malloc,128m")}) +List of storage backends that will be available in VCL. + +@item @code{parameters} (default: @code{'()}) +List of run-time parameters in the form @code{'(("parameter" . "value"))}. + +@item @code{extra-options} (default: @code{'()}) +Additional arguments to pass to the @command{varnishd} process. + +@end table +@end deftp + +@subsubheading FastCGI +@cindex fastcgi +@cindex fcgiwrap +FastCGI is an interface between the front-end and the back-end of a web +service. It is a somewhat legacy facility; new web services should +generally just talk HTTP between the front-end and the back-end. However +there are a number of back-end services such as PHP or the optimized HTTP +Git repository access that use FastCGI, so we have support for it in Guix. + +To use FastCGI, you configure the front-end web server (e.g., nginx) to +dispatch some subset of its requests to the fastcgi backend, which listens +on a local TCP or UNIX socket. There is an intermediary @code{fcgiwrap} +program that sits between the actual backend process and the web server. +The front-end indicates which backend program to run, passing that +information to the @code{fcgiwrap} process. + +@defvr {Scheme Variable} fcgiwrap-service-type +A service type for the @code{fcgiwrap} FastCGI proxy. +@end defvr + +@deftp {Data Type} fcgiwrap-configuration +Data type representing the configuration of the @code{fcgiwrap} serice. +This type has the following parameters: +@table @asis +@item @code{package} (default: @code{fcgiwrap}) +The fcgiwrap package to use. + +@item @code{socket} (default: @code{tcp:127.0.0.1:9000}) +The socket on which the @code{fcgiwrap} process should listen, as a string. +Valid @var{socket} values include @code{unix:@var{/path/to/unix/socket}}, +@code{tcp:@var{dot.ted.qu.ad}:@var{port}} and +@code{tcp6:[@var{ipv6_addr}]:port}. + +@item @code{user} (default: @code{fcgiwrap}) +@itemx @code{group} (default: @code{fcgiwrap}) +The user and group names, as strings, under which to run the @code{fcgiwrap} +process. The @code{fastcgi} service will ensure that if the user asks for +the specific user or group names @code{fcgiwrap} that the corresponding user +and/or group is present on the system. + +It is possible to configure a FastCGI-backed web service to pass HTTP +authentication information from the front-end to the back-end, and to allow +@code{fcgiwrap} to run the back-end process as a corresponding local user. +To enable this capability on the back-end., run @code{fcgiwrap} as the +@code{root} user and group. Note that this capability also has to be +configured on the front-end as well. +@end table +@end deftp + +@cindex php-fpm +PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI +implementation with some additional features useful for sites of any size. + +These features include: +@itemize @bullet +@item Adaptive process spawning +@item Basic statistics (similar to Apache's mod_status) +@item Advanced process management with graceful stop/start +@item Ability to start workers with different uid/gid/chroot/environment +and different php.ini (replaces safe_mode) +@item Stdout & stderr logging +@item Emergency restart in case of accidental opcode cache destruction +@item Accelerated upload support +@item Support for a "slowlog" +@item Enhancements to FastCGI, such as fastcgi_finish_request() - +a special function to finish request & flush all data while continuing to do +something time-consuming (video converting, stats processing, etc.) +@end itemize +... and much more. + +@defvr {Scheme Variable} php-fpm-service-type +A Service type for @code{php-fpm}. +@end defvr + +@deftp {Data Type} php-fpm-configuration +Data Type for php-fpm service configuration. +@table @asis +@item @code{php} (default: @code{php}) +The php package to use. +@item @code{socket} (default: @code{(string-append "/var/run/php" (version-major (package-version php)) "-fpm.sock")}) +The address on which to accept FastCGI requests. Valid syntaxes are: +@table @asis +@item @code{"ip.add.re.ss:port"} +Listen on a TCP socket to a specific address on a specific port. +@item @code{"port"} +Listen on a TCP socket to all addresses on a specific port. +@item @code{"/path/to/unix/socket"} +Listen on a unix socket. +@end table + +@item @code{user} (default: @code{php-fpm}) +User who will own the php worker processes. +@item @code{group} (default: @code{php-fpm}) +Group of the worker processes. +@item @code{socket-user} (default: @code{php-fpm}) +User who can speak to the php-fpm socket. +@item @code{socket-group} (default: @code{php-fpm}) +Group that can speak to the php-fpm socket. +@item @code{pid-file} (default: @code{(string-append "/var/run/php" (version-major (package-version php)) "-fpm.pid")}) +The process id of the php-fpm process is written to this file once the +service has started. +@item @code{log-file} (default: @code{(string-append "/var/log/php" (version-major (package-version php)) "-fpm.log")}) +Log for the php-fpm master process. +@item @code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)}) +Detailed settings for the php-fpm process manager. Must be either: +@table @asis +@item @code{<php-fpm-dynamic-process-manager-configuration>} +@item @code{<php-fpm-static-process-manager-configuration>} +@item @code{<php-fpm-on-demand-process-manager-configuration>} +@end table +@item @code{display-errors} (default @code{#f}) +Determines whether php errors and warning should be sent to clients and +displayed in their browsers. This is useful for local php development, but +a security risk for public sites, as error messages can reveal passwords and +personal data. +@item @code{workers-logfile} (default @code{(string-append "/var/log/php" (version-major (package-version php)) "-fpm.www.log")}) +This file will log the @code{stderr} outputs of php worker processes. Can +be set to @code{#f} to disable logging. +@item @code{file} (default @code{#f}) +An optional override of the whole configuration. You can use the +@code{mixed-text-file} function or an absolute filepath for it. +@end table +@end deftp + +@deftp {Data type} php-fpm-dynamic-process-manager-configuration +Data Type for the @code{dynamic} php-fpm process manager. With the +@code{dynamic} process manager, spare worker processes are kept around based +on it's configured limits. +@table @asis +@item @code{max-children} (default: @code{5}) +Maximum of worker processes. +@item @code{start-servers} (default: @code{2}) +How many worker processes should be started on start-up. +@item @code{min-spare-servers} (default: @code{1}) +How many spare worker processes should be kept around at minimum. +@item @code{max-spare-servers} (default: @code{3}) +How many spare worker processes should be kept around at maximum. +@end table +@end deftp + +@deftp {Data type} php-fpm-static-process-manager-configuration +Data Type for the @code{static} php-fpm process manager. With the +@code{static} process manager, an unchanging number of worker processes are +created. +@table @asis +@item @code{max-children} (default: @code{5}) +Maximum of worker processes. +@end table +@end deftp + +@deftp {Data type} php-fpm-on-demand-process-manager-configuration +Data Type for the @code{on-demand} php-fpm process manager. With the +@code{on-demand} process manager, worker processes are only created as +requests arrive. +@table @asis +@item @code{max-children} (default: @code{5}) +Maximum of worker processes. +@item @code{process-idle-timeout} (default: @code{10}) +The time in seconds after which a process with no requests is killed. +@end table +@end deftp + + +@deffn {Scheme Procedure} nginx-php-fpm-location @ + [#:nginx-package nginx] @ [socket (string-append "/var/run/php" @ +(version-major (package-version php)) @ "-fpm.sock")] A helper function to +quickly add php to an @code{nginx-server-configuration}. +@end deffn + +A simple services setup for nginx with php can look like this: +@example +(services (cons* (service dhcp-client-service-type) + (service php-fpm-service-type) + (service nginx-service-type + (nginx-server-configuration + (server-name '("example.com")) + (root "/srv/http/") + (locations + (list (nginx-php-location))) + (https-port #f) + (ssl-certificate #f) + (ssl-certificate-key #f))) + %base-services)) +@end example + +@cindex cat-avatar-generator +The cat avatar generator is a simple service to demonstrate the use of +php-fpm in @code{Nginx}. It is used to generate cat avatar from a seed, for +instance the hash of a user's email address. + +@deffn {Scheme Procedure} cat-avatar-generator-serice @ + [#:cache-dir "/var/cache/cat-avatar-generator"] @ [#:package +cat-avatar-generator] @ [#:configuration (nginx-server-configuration)] +Returns an nginx-server-configuration that inherits @code{configuration}. +It extends the nginx configuration to add a server block that serves +@code{package}, a version of cat-avatar-generator. During execution, +cat-avatar-generator will be able to use @code{cache-dir} as its cache +directory. +@end deffn + +A simple setup for cat-avatar-generator can look like this: +@example +(services (cons* (cat-avatar-generator-service + #:configuration + (nginx-server-configuration + (server-name '("example.com")))) + ... + %base-services)) +@end example + +@subsubheading Hpcguix-web + +@cindex hpcguix-web +The @uref{hpcguix-web, https://github.com/UMCUGenetics/hpcguix-web/} program +is a customizable web interface to browse Guix packages, initially designed +for users of high-performance computing (HPC) clusters. + +@defvr {Scheme Variable} hpcguix-web-service-type +The service type for @code{hpcguix-web}. +@end defvr + +@deftp {Data Type} hpcguix-web-configuration +Data type for the hpcguix-web service configuration. + +@table @asis +@item @code{specs} +A gexp (@pxref{G-Ausdrücke}) specifying the hpcguix-web service +configuration. The main items available in this spec are: + +@table @asis +@item @code{title-prefix} (default: @code{"hpcguix | "}) +The page title prefix. + +@item @code{guix-command} (default: @code{"guix"}) +The @command{guix} command. + +@item @code{package-filter-proc} (default: @code{(const #t)}) +A procedure specifying how to filter packages that are displayed. + +@item @code{package-page-extension-proc} (default: @code{(const '())}) +Extension package for @code{hpcguix-web}. + +@item @code{menu} (default: @code{'()}) +Additional entry in page @code{menu}. + +@item @code{channels} (default: @code{%default-channels}) +List of channels from which the package list is built (@pxref{Channels}). + +@item @code{package-list-expiration} (default: @code{(* 12 3600)}) +The expiration time, in seconds, after which the package list is rebuilt +from the latest instances of the given channels. +@end table + +See the hpcguix-web repository for a +@uref{https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm, +complete example}. + +@item @code{package} (default: @code{hpcguix-web}) +The hpcguix-web package to use. +@end table +@end deftp + +A typical hpcguix-web service declaration looks like this: + +@example +(service hpcguix-web-service-type + (hpcguix-web-configuration + (specs + #~(define site-config + (hpcweb-configuration + (title-prefix "Guix-HPC - ") + (menu '(("/about" "ABOUT")))))))) +@end example + +@quotation Anmerkung +The hpcguix-web service periodically updates the package list it publishes +by pulling channels from Git. To that end, it needs to access X.509 +certificates so that it can authenticate Git servers when communicating over +HTTPS, and it assumes that @file{/etc/ssl/certs} contains those +certificates. + +Thus, make sure to add @code{nss-certs} or another certificate package to +the @code{packages} field of your configuration. @ref{X.509-Zertifikate}, +for more information on X.509 certificates. +@end quotation + +@node Zertifikatsdienste +@subsubsection Zertifikatsdienste + +@cindex Web +@cindex HTTP, HTTPS +@cindex Let's Encrypt +@cindex TLS certificates +The @code{(gnu services certbot)} module provides a service to automatically +obtain a valid TLS certificate from the Let's Encrypt certificate +authority. These certificates can then be used to serve content securely +over HTTPS or other TLS-based protocols, with the knowledge that the client +will be able to verify the server's authenticity. + +@url{https://letsencrypt.org/, Let's Encrypt} provides the @code{certbot} +tool to automate the certification process. This tool first securely +generates a key on the server. It then makes a request to the Let's Encrypt +certificate authority (CA) to sign the key. The CA checks that the request +originates from the host in question by using a challenge-response protocol, +requiring the server to provide its response over HTTP. If that protocol +completes successfully, the CA signs the key, resulting in a certificate. +That certificate is valid for a limited period of time, and therefore to +continue to provide TLS services, the server needs to periodically ask the +CA to renew its signature. + +The certbot service automates this process: the initial key generation, the +initial certification request to the Let's Encrypt service, the web server +challenge/response integration, writing the certificate to disk, the +automated periodic renewals, and the deployment tasks associated with the +renewal (e.g. reloading services, copying keys with different permissions). + +Certbot is run twice a day, at a random minute within the hour. It won't do +anything until your certificates are due for renewal or revoked, but running +it regularly would give your service a chance of staying online in case a +Let's Encrypt-initiated revocation happened for some reason. + +By using this service, you agree to the ACME Subscriber Agreement, which can +be found there: @url{https://acme-v01.api.letsencrypt.org/directory}. + +@defvr {Scheme Variable} certbot-service-type +A service type for the @code{certbot} Let's Encrypt client. Its value must +be a @code{certbot-configuration} record as in this example: + +@example +(define %nginx-deploy-hook + (program-file + "nginx-deploy-hook" + #~(let ((pid (call-with-input-file "/var/run/nginx/pid" read))) + (kill pid SIGHUP)))) + +(service certbot-service-type + (certbot-configuration + (email "foo@@example.net") + (certificates + (list + (certificate-configuration + (domains '("example.net" "www.example.net")) + (deploy-hook %nginx-deploy-hook)) + (certificate-configuration + (domains '("bar.example.net"))))))) +@end example + +See below for details about @code{certbot-configuration}. +@end defvr + +@deftp {Data Type} certbot-configuration +Data type representing the configuration of the @code{certbot} service. +This type has the following parameters: + +@table @asis +@item @code{package} (default: @code{certbot}) +The certbot package to use. + +@item @code{webroot} (default: @code{/var/www}) +The directory from which to serve the Let's Encrypt challenge/response +files. + +@item @code{certificates} (default: @code{()}) +A list of @code{certificates-configuration}s for which to generate +certificates and request signatures. Each certificate has a @code{name} and +several @code{domains}. + +@item @code{email} +Mandatory email used for registration, recovery contact, and important +account notifications. + +@item @code{rsa-key-size} (default: @code{2048}) +Size of the RSA key. + +@item @code{default-location} (default: @i{see below}) +The default @code{nginx-location-configuration}. Because @code{certbot} +needs to be able to serve challenges and responses, it needs to be able to +run a web server. It does so by extending the @code{nginx} web service with +an @code{nginx-server-configuration} listening on the @var{domains} on port +80, and which has a @code{nginx-location-configuration} for the +@code{/.well-known/} URI path subspace used by Let's Encrypt. @xref{Web-Dienste}, for more on these nginx configuration data types. + +Requests to other URL paths will be matched by the @code{default-location}, +which if present is added to all @code{nginx-server-configuration}s. + +By default, the @code{default-location} will issue a redirect from +@code{http://@var{domain}/...} to @code{https://@var{domain}/...}, leaving +you to define what to serve on your site via @code{https}. + +Pass @code{#f} to not issue a default location. +@end table +@end deftp + +@deftp {Data Type} certificate-configuration +Data type representing the configuration of a certificate. This type has +the following parameters: + +@table @asis +@item @code{name} (default: @i{see below}) +This name is used by Certbot for housekeeping and in file paths; it doesn't +affect the content of the certificate itself. To see certificate names, run +@code{certbot certificates}. + +Its default is the first provided domain. + +@item @code{domains} (default: @code{()}) +The first domain provided will be the subject CN of the certificate, and all +domains will be Subject Alternative Names on the certificate. + +@item @code{deploy-hook} (default: @code{#f}) +Command to be run in a shell once for each successfully issued certificate. +For this command, the shell variable @code{$RENEWED_LINEAGE} will point to +the config live subdirectory (for example, +@samp{"/etc/letsencrypt/live/example.com"}) containing the new certificates +and keys; the shell variable @code{$RENEWED_DOMAINS} will contain a +space-delimited list of renewed certificate domains (for example, +@samp{"example.com www.example.com"}. + +@end table +@end deftp + +For each @code{certificate-configuration}, the certificate is saved to +@code{/etc/letsencrypt/live/@var{name}/fullchain.pem} and the key is saved +to @code{/etc/letsencrypt/live/@var{name}/privkey.pem}. +@node DNS-Dienste +@subsubsection DNS-Dienste +@cindex DNS (domain name system) +@cindex domain name system (DNS) + +The @code{(gnu services dns)} module provides services related to the +@dfn{domain name system} (DNS). It provides a server service for hosting an +@emph{authoritative} DNS server for multiple zones, slave or master. This +service uses @uref{https://www.knot-dns.cz/, Knot DNS}. And also a caching +and forwarding DNS server for the LAN, which uses +@uref{http://www.thekelleys.org.uk/dnsmasq/doc.html, dnsmasq}. + +@subsubheading Knot Service + +An example configuration of an authoritative server for two zones, one +master and one slave, is: + +@lisp +(define-zone-entries example.org.zone +;; Name TTL Class Type Data + ("@@" "" "IN" "A" "127.0.0.1") + ("@@" "" "IN" "NS" "ns") + ("ns" "" "IN" "A" "127.0.0.1")) + +(define master-zone + (knot-zone-configuration + (domain "example.org") + (zone (zone-file + (origin "example.org") + (entries example.org.zone))))) + +(define slave-zone + (knot-zone-configuration + (domain "plop.org") + (dnssec-policy "default") + (master (list "plop-master")))) + +(define plop-master + (knot-remote-configuration + (id "plop-master") + (address (list "208.76.58.171")))) + +(operating-system + ;; ... + (services (cons* (service knot-service-type + (knot-configuration + (remotes (list plop-master)) + (zones (list master-zone slave-zone)))) + ;; ... + %base-services))) +@end lisp + +@deffn {Scheme Variable} knot-service-type +This is the type for the Knot DNS server. + +Knot DNS is an authoritative DNS server, meaning that it can serve multiple +zones, that is to say domain names you would buy from a registrar. This +server is not a resolver, meaning that it can only resolve names for which +it is authoritative. This server can be configured to serve zones as a +master server or a slave server as a per-zone basis. Slave zones will get +their data from masters, and will serve it as an authoritative server. From +the point of view of a resolver, there is no difference between master and +slave. + +The following data types are used to configure the Knot DNS server: +@end deffn + +@deftp {Data Type} knot-key-configuration +Data type representing a key. This type has the following parameters: + +@table @asis +@item @code{id} (default: @code{""}) +An identifier for other configuration fields to refer to this key. IDs must +be unique and must not be empty. + +@item @code{algorithm} (default: @code{#f}) +The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, +@code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, +@code{'hmac-sha384} and @code{'hmac-sha512}. + +@item @code{secret} (default: @code{""}) +The secret key itself. + +@end table +@end deftp + +@deftp {Data Type} knot-acl-configuration +Data type representing an Access Control List (ACL) configuration. This +type has the following parameters: + +@table @asis +@item @code{id} (default: @code{""}) +An identifier for ether configuration fields to refer to this key. IDs must +be unique and must not be empty. + +@item @code{address} (default: @code{'()}) +An ordered list of IP addresses, network subnets, or network ranges +represented with strings. The query must match one of them. Empty value +means that address match is not required. + +@item @code{key} (default: @code{'()}) +An ordered list of references to keys represented with strings. The string +must match a key ID defined in a @code{knot-key-configuration}. No key +means that a key is not require to match that ACL. + +@item @code{action} (default: @code{'()}) +An ordered list of actions that are permitted or forbidden by this ACL. +Possible values are lists of zero or more elements from @code{'transfer}, +@code{'notify} and @code{'update}. + +@item @code{deny?} (default: @code{#f}) +When true, the ACL defines restrictions. Listed actions are forbidden. +When false, listed actions are allowed. + +@end table +@end deftp + +@deftp {Data Type} zone-entry +Data type represnting a record entry in a zone file. This type has the +following parameters: + +@table @asis +@item @code{name} (default: @code{"@@"}) +The name of the record. @code{"@@"} refers to the origin of the zone. +Names are relative to the origin of the zone. For example, in the +@code{example.org} zone, @code{"ns.example.org"} actually refers to +@code{ns.example.org.example.org}. Names ending with a dot are absolute, +which means that @code{"ns.example.org."} refers to @code{ns.example.org}. + +@item @code{ttl} (default: @code{""}) +The Time-To-Live (TTL) of this record. If not set, the default TTL is used. + +@item @code{class} (default: @code{"IN"}) +The class of the record. Knot currently supports only @code{"IN"} and +partially @code{"CH"}. + +@item @code{type} (default: @code{"A"}) +The type of the record. Common types include A (IPv4 address), AAAA (IPv6 +address), NS (Name Server) and MX (Mail eXchange). Many other types are +defined. + +@item @code{data} (default: @code{""}) +The data contained in the record. For instance an IP address associated +with an A record, or a domain name associated with an NS record. Remember +that domain names are relative to the origin unless they end with a dot. + +@end table +@end deftp + +@deftp {Data Type} zone-file +Data type representing the content of a zone file. This type has the +following parameters: + +@table @asis +@item @code{entries} (default: @code{'()}) +The list of entries. The SOA record is taken care of, so you don't need to +put it in the list of entries. This list should probably contain an entry +for your primary authoritative DNS server. Other than using a list of +entries directly, you can use @code{define-zone-entries} to define a object +containing the list of entries more easily, that you can later pass to the +@code{entries} field of the @code{zone-file}. + +@item @code{origin} (default: @code{""}) +The name of your zone. This parameter cannot be empty. + +@item @code{ns} (default: @code{"ns"}) +The domain of your primary authoritative DNS server. The name is relative +to the origin, unless it ends with a dot. It is mandatory that this primary +DNS server corresponds to an NS record in the zone and that it is associated +to an IP address in the list of entries. + +@item @code{mail} (default: @code{"hostmaster"}) +An email address people can contact you at, as the owner of the zone. This +is translated as @code{<mail>@@<origin>}. + +@item @code{serial} (default: @code{1}) +The serial number of the zone. As this is used to keep track of changes by +both slaves and resolvers, it is mandatory that it @emph{never} decreases. +Always increment it when you make a change in your zone. + +@item @code{refresh} (default: @code{(* 2 24 3600)}) +The frequency at which slaves will do a zone transfer. This value is a +number of seconds. It can be computed by multiplications or with +@code{(string->duration)}. + +@item @code{retry} (default: @code{(* 15 60)}) +The period after which a slave will retry to contact its master when it +fails to do so a first time. + +@item @code{expiry} (default: @code{(* 14 24 3600)}) +Default TTL of records. Existing records are considered correct for at most +this amount of time. After this period, resolvers will invalidate their +cache and check again that it still exists. + +@item @code{nx} (default: @code{3600}) +Default TTL of inexistant records. This delay is usually short because you +want your new domains to reach everyone quickly. + +@end table +@end deftp + +@deftp {Data Type} knot-remote-configuration +Data type representing a remote configuration. This type has the following +parameters: + +@table @asis +@item @code{id} (default: @code{""}) +An identifier for other configuration fields to refer to this remote. IDs +must be unique and must not be empty. + +@item @code{address} (default: @code{'()}) +An ordered list of destination IP addresses. Addresses are tried in +sequence. An optional port can be given with the @@ separator. For +instance: @code{(list "1.2.3.4" "2.3.4.5@@53")}. Default port is 53. + +@item @code{via} (default: @code{'()}) +An ordered list of source IP addresses. An empty list will have Knot choose +an appropriate source IP. An optional port can be given with the @@ +separator. The default is to choose at random. + +@item @code{key} (default: @code{#f}) +A reference to a key, that is a string containing the identifier of a key +defined in a @code{knot-key-configuration} field. + +@end table +@end deftp + +@deftp {Data Type} knot-keystore-configuration +Data type representing a keystore to hold dnssec keys. This type has the +following parameters: + +@table @asis +@item @code{id} (default: @code{""}) +The id of the keystore. It must not be empty. + +@item @code{backend} (default: @code{'pem}) +The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}. + +@item @code{config} (default: @code{"/var/lib/knot/keys/keys"}) +The configuration string of the backend. An example for the PKCS#11 is: +@code{"pkcs11:token=knot;pin-value=1234 +/gnu/store/.../lib/pkcs11/libsofthsm2.so"}. For the pem backend, the string +reprensents a path in the file system. + +@end table +@end deftp + +@deftp {Data Type} knot-policy-configuration +Data type representing a dnssec policy. Knot DNS is able to automatically +sign your zones. It can either generate and manage your keys automatically +or use keys that you generate. + +Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that +is used to sign the second, and a Zone Signing Key (ZSK) that is used to +sign the zone. In order to be trusted, the KSK needs to be present in the +parent zone (usually a top-level domain). If your registrar supports +dnssec, you will have to send them your KSK's hash so they can add a DS +record in their zone. This is not automated and need to be done each time +you change your KSK. + +The policy also defines the lifetime of keys. Usually, ZSK can be changed +easily and use weaker cryptographic functions (they use lower parameters) in +order to sign records quickly, so they are changed often. The KSK however +requires manual interaction with the registrar, so they are changed less +often and use stronger parameters because they sign only one record. + +This type has the following parameters: + +@table @asis +@item @code{id} (default: @code{""}) +The id of the policy. It must not be empty. + +@item @code{keystore} (default: @code{"default"}) +A reference to a keystore, that is a string containing the identifier of a +keystore defined in a @code{knot-keystore-configuration} field. The +@code{"default"} identifier means the default keystore (a kasp database that +was setup by this service). + +@item @code{manual?} (default: @code{#f}) +Whether the key management is manual or automatic. + +@item @code{single-type-signing?} (default: @code{#f}) +When @code{#t}, use the Single-Type Signing Scheme. + +@item @code{algorithm} (default: @code{"ecdsap256sha256"}) +An algorithm of signing keys and issued signatures. + +@item @code{ksk-size} (default: @code{256}) +The length of the KSK. Note that this value is correct for the default +algorithm, but would be unsecure for other algorithms. + +@item @code{zsk-size} (default: @code{256}) +The length of the ZSK. Note that this value is correct for the default +algorithm, but would be unsecure for other algorithms. + +@item @code{dnskey-ttl} (default: @code{'default}) +The TTL value for DNSKEY records added into zone apex. The special +@code{'default} value means same as the zone SOA TTL. + +@item @code{zsk-lifetime} (default: @code{(* 30 24 3600)}) +The period between ZSK publication and the next rollover initiation. + +@item @code{propagation-delay} (default: @code{(* 24 3600)}) +An extra delay added for each key rollover step. This value should be high +enough to cover propagation of data from the master server to all slaves. + +@item @code{rrsig-lifetime} (default: @code{(* 14 24 3600)}) +A validity period of newly issued signatures. + +@item @code{rrsig-refresh} (default: @code{(* 7 24 3600)}) +A period how long before a signature expiration the signature will be +refreshed. + +@item @code{nsec3?} (default: @code{#f}) +When @code{#t}, NSEC3 will be used instead of NSEC. + +@item @code{nsec3-iterations} (default: @code{5}) +The number of additional times the hashing is performed. + +@item @code{nsec3-salt-length} (default: @code{8}) +The length of a salt field in octets, which is appended to the original +owner name before hashing. + +@item @code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)}) +The validity period of newly issued salt field. + +@end table +@end deftp + +@deftp {Data Type} knot-zone-configuration +Data type representing a zone served by Knot. This type has the following +parameters: + +@table @asis +@item @code{domain} (default: @code{""}) +The domain served by this configuration. It must not be empty. + +@item @code{file} (default: @code{""}) +The file where this zone is saved. This parameter is ignored by master +zones. Empty means default location that depends on the domain name. + +@item @code{zone} (default: @code{(zone-file)}) +The content of the zone file. This parameter is ignored by slave zones. It +must contain a zone-file record. + +@item @code{master} (default: @code{'()}) +A list of master remotes. When empty, this zone is a master. When set, +this zone is a slave. This is a list of remotes identifiers. + +@item @code{ddns-master} (default: @code{#f}) +The main master. When empty, it defaults to the first master in the list of +masters. + +@item @code{notify} (default: @code{'()}) +A list of slave remote identifiers. + +@item @code{acl} (default: @code{'()}) +A list of acl identifiers. + +@item @code{semantic-checks?} (default: @code{#f}) +When set, this adds more semantic checks to the zone. + +@item @code{disable-any?} (default: @code{#f}) +When set, this forbids queries of the ANY type. + +@item @code{zonefile-sync} (default: @code{0}) +The delay between a modification in memory and on disk. 0 means immediate +synchronization. + +@item @code{serial-policy} (default: @code{'increment}) +A policy between @code{'increment} and @code{'unixtime}. + +@end table +@end deftp + +@deftp {Data Type} knot-configuration +Data type representing the Knot configuration. This type has the following +parameters: + +@table @asis +@item @code{knot} (default: @code{knot}) +The Knot package. + +@item @code{run-directory} (default: @code{"/var/run/knot"}) +The run directory. This directory will be used for pid file and sockets. + +@item @code{listen-v4} (default: @code{"0.0.0.0"}) +An ip address on which to listen. + +@item @code{listen-v6} (default: @code{"::"}) +An ip address on which to listen. + +@item @code{listen-port} (default: @code{53}) +A port on which to listen. + +@item @code{keys} (default: @code{'()}) +The list of knot-key-configuration used by this configuration. + +@item @code{acls} (default: @code{'()}) +The list of knot-acl-configuration used by this configuration. + +@item @code{remotes} (default: @code{'()}) +The list of knot-remote-configuration used by this configuration. + +@item @code{zones} (default: @code{'()}) +The list of knot-zone-configuration used by this configuration. + +@end table +@end deftp + +@subsubheading Dnsmasq Service + +@deffn {Scheme Variable} dnsmasq-service-type +This is the type of the dnsmasq service, whose value should be an +@code{dnsmasq-configuration} object as in this example: + +@example +(service dnsmasq-service-type + (dnsmasq-configuration + (no-resolv? #t) + (servers '("192.168.1.1")))) +@end example +@end deffn + +@deftp {Data Type} dnsmasq-configuration +Data type representing the configuration of dnsmasq. + +@table @asis +@item @code{package} (default: @var{dnsmasq}) +Package object of the dnsmasq server. + +@item @code{no-hosts?} (default: @code{#f}) +When true, don't read the hostnames in /etc/hosts. + +@item @code{port} (default: @code{53}) +The port to listen on. Setting this to zero completely disables DNS +responses, leaving only DHCP and/or TFTP functions. + +@item @code{local-service?} (default: @code{#t}) +Accept DNS queries only from hosts whose address is on a local subnet, ie a +subnet for which an interface exists on the server. + +@item @code{listen-addresses} (default: @code{'()}) +Listen on the given IP addresses. + +@item @code{resolv-file} (default: @code{"/etc/resolv.conf"}) +The file to read the IP address of the upstream nameservers from. + +@item @code{no-resolv?} (default: @code{#f}) +When true, don't read @var{resolv-file}. + +@item @code{servers} (default: @code{'()}) +Specify IP address of upstream servers directly. + +@item @code{cache-size} (default: @code{150}) +Set the size of dnsmasq's cache. Setting the cache size to zero disables +caching. + +@item @code{negative-cache?} (default: @code{#t}) +When false, disable negative caching. + +@end table +@end deftp + +@subsubheading ddclient Service + +@cindex ddclient +The ddclient service described below runs the ddclient daemon, which takes +care of automatically updating DNS entries for service providers such as +@uref{https://dyn.com/dns/, Dyn}. + +The following example show instantiates the service with its default +configuration: + +@example +(service ddclient-service-type) +@end example + +Note that ddclient needs to access credentials that are stored in a +@dfn{secret file}, by default @file{/etc/ddclient/secrets} (see +@code{secret-file} below.) You are expected to create this file manually, +in an ``out-of-band'' fashion (you @emph{could} make this file part of the +service configuration, for instance by using @code{plain-file}, but it will +be world-readable @i{via} @file{/gnu/store}.) See the examples in the +@file{share/ddclient} directory of the @code{ddclient} package. + +@c %start of fragment + +Available @code{ddclient-configuration} fields are: + +@deftypevr {@code{ddclient-configuration} parameter} package ddclient +The ddclient package. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} integer daemon +The period after which ddclient will retry to check IP and domain name. + +Defaults to @samp{300}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} boolean syslog +Use syslog for the output. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string mail +Mail to user. + +Defaults to @samp{"root"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string mail-failure +Mail failed update to user. + +Defaults to @samp{"root"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string pid +The ddclient PID file. + +Defaults to @samp{"/var/run/ddclient/ddclient.pid"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} boolean ssl +Enable SSL support. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string user +Specifies the user name or ID that is used when running ddclient program. + +Defaults to @samp{"ddclient"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string group +Group of the user who will run the ddclient program. + +Defaults to @samp{"ddclient"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} string secret-file +Secret file which will be appended to @file{ddclient.conf} file. This file +contains credentials for use by ddclient. You are expected to create it +manually. + +Defaults to @samp{"/etc/ddclient/secrets.conf"}. + +@end deftypevr + +@deftypevr {@code{ddclient-configuration} parameter} list extra-options +Extra options will be appended to @file{ddclient.conf} file. + +Defaults to @samp{()}. + +@end deftypevr + + +@c %end of fragment + + +@node VPN-Dienste +@subsubsection VPN-Dienste +@cindex VPN (virtual private network) +@cindex virtual private network (VPN) + +The @code{(gnu services vpn)} module provides services related to +@dfn{virtual private networks} (VPNs). It provides a @emph{client} service +for your machine to connect to a VPN, and a @emph{servire} service for your +machine to host a VPN. Both services use @uref{https://openvpn.net/, +OpenVPN}. + +@deffn {Scheme Procedure} openvpn-client-service @ + [#:config (openvpn-client-configuration)] + +Return a service that runs @command{openvpn}, a VPN daemon, as a client. +@end deffn + +@deffn {Scheme Procedure} openvpn-server-service @ + [#:config (openvpn-server-configuration)] + +Return a service that runs @command{openvpn}, a VPN daemon, as a server. + +Both can be run simultaneously. +@end deffn + +@c %automatically generated documentation + +Available @code{openvpn-client-configuration} fields are: + +@deftypevr {@code{openvpn-client-configuration} parameter} package openvpn +The OpenVPN package. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} string pid-file +The OpenVPN pid file. + +Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} proto proto +The protocol (UDP or TCP) used to open a channel between clients and +servers. + +Defaults to @samp{udp}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} dev dev +The device type used to represent the VPN connection. + +Defaults to @samp{tun}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} string ca +The certificate authority to check connections against. + +Defaults to @samp{"/etc/openvpn/ca.crt"}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} string cert +The certificate of the machine the daemon is running on. It should be +signed by the authority given in @code{ca}. + +Defaults to @samp{"/etc/openvpn/client.crt"}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} string key +The key of the machine the daemon is running on. It must be the key whose +certificate is @code{cert}. + +Defaults to @samp{"/etc/openvpn/client.key"}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} boolean comp-lzo? +Whether to use the lzo compression algorithm. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-key? +Don't re-read key files across SIGUSR1 or --ping-restart. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} boolean persist-tun? +Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 +or --ping-restart restarts. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} number verbosity +Verbosity level. + +Defaults to @samp{3}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth +Add an additional layer of HMAC authentication on top of the TLS control +channel to protect against DoS attacks. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} key-usage verify-key-usage? +Whether to check the server certificate has server usage extension. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} bind bind? +Bind to a specific local port number. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry? +Retry resolving server address. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-client-configuration} parameter} openvpn-remote-list remote +A list of remote servers to connect to. + +Defaults to @samp{()}. + +Available @code{openvpn-remote-configuration} fields are: + +@deftypevr {@code{openvpn-remote-configuration} parameter} string name +Server name. + +Defaults to @samp{"my-server"}. + +@end deftypevr + +@deftypevr {@code{openvpn-remote-configuration} parameter} number port +Port number the server listens to. + +Defaults to @samp{1194}. + +@end deftypevr + +@end deftypevr +@c %end of automatic openvpn-client documentation + +@c %automatically generated documentation + +Available @code{openvpn-server-configuration} fields are: + +@deftypevr {@code{openvpn-server-configuration} parameter} package openvpn +The OpenVPN package. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string pid-file +The OpenVPN pid file. + +Defaults to @samp{"/var/run/openvpn/openvpn.pid"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} proto proto +The protocol (UDP or TCP) used to open a channel between clients and +servers. + +Defaults to @samp{udp}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} dev dev +The device type used to represent the VPN connection. + +Defaults to @samp{tun}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string ca +The certificate authority to check connections against. + +Defaults to @samp{"/etc/openvpn/ca.crt"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string cert +The certificate of the machine the daemon is running on. It should be +signed by the authority given in @code{ca}. + +Defaults to @samp{"/etc/openvpn/client.crt"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string key +The key of the machine the daemon is running on. It must be the key whose +certificate is @code{cert}. + +Defaults to @samp{"/etc/openvpn/client.key"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} boolean comp-lzo? +Whether to use the lzo compression algorithm. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-key? +Don't re-read key files across SIGUSR1 or --ping-restart. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} boolean persist-tun? +Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 +or --ping-restart restarts. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} number verbosity +Verbosity level. + +Defaults to @samp{3}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth +Add an additional layer of HMAC authentication on top of the TLS control +channel to protect against DoS attacks. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} number port +Specifies the port number on which the server listens. + +Defaults to @samp{1194}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} ip-mask server +An ip and mask specifying the subnet inside the virtual network. + +Defaults to @samp{"10.8.0.0 255.255.255.0"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} cidr6 server-ipv6 +A CIDR notation specifying the IPv6 subnet inside the virtual network. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string dh +The Diffie-Hellman parameters file. + +Defaults to @samp{"/etc/openvpn/dh2048.pem"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist +The file that records client IPs. + +Defaults to @samp{"/etc/openvpn/ipp.txt"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} gateway redirect-gateway? +When true, the server will act as a gateway for its clients. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} boolean client-to-client? +When true, clients are allowed to talk to each other inside the VPN. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} keepalive keepalive +Causes ping-like messages to be sent back and forth over the link so that +each side knows when the other side has gone down. @code{keepalive} +requires a pair. The first element is the period of the ping sending, and +the second element is the timeout before considering the other side down. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} number max-clients +The maximum number of clients. + +Defaults to @samp{100}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} string status +The status file. This file shows a small report on current connection. It +is truncated and rewritten every minute. + +Defaults to @samp{"/var/run/openvpn/status"}. + +@end deftypevr + +@deftypevr {@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir +The list of configuration for some clients. + +Defaults to @samp{()}. + +Available @code{openvpn-ccd-configuration} fields are: + +@deftypevr {@code{openvpn-ccd-configuration} parameter} string name +Client name. + +Defaults to @samp{"client"}. + +@end deftypevr + +@deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask iroute +Client own network + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push +Client VPN IP. + +Defaults to @samp{#f}. + +@end deftypevr + +@end deftypevr + + +@c %end of automatic openvpn-server documentation + + +@node Network File System +@subsubsection Network File System +@cindex NFS + +The @code{(gnu services nfs)} module provides the following services, which +are most commonly used in relation to mounting or exporting directory trees +as @dfn{network file systems} (NFS). + +@subsubheading RPC Bind Service +@cindex rpcbind + +The RPC Bind service provides a facility to map program numbers into +universal addresses. Many NFS related services use this facility. Hence it +is automatically started when a dependent service starts. + +@defvr {Scheme Variable} rpcbind-service-type +A service type for the RPC portmapper daemon. +@end defvr + + +@deftp {Data Type} rpcbind-configuration +Data type representing the configuration of the RPC Bind Service. This type +has the following parameters: +@table @asis +@item @code{rpcbind} (default: @code{rpcbind}) +The rpcbind package to use. + +@item @code{warm-start?} (default: @code{#t}) +If this parameter is @code{#t}, then the daemon will read a state file on +startup thus reloading state information saved by a previous instance. +@end table +@end deftp + + +@subsubheading Pipefs Pseudo File System +@cindex pipefs +@cindex rpc_pipefs + +The pipefs file system is used to transfer NFS related data between the +kernel and user space programs. + +@defvr {Scheme Variable} pipefs-service-type +A service type for the pipefs pseudo file system. +@end defvr + +@deftp {Data Type} pipefs-configuration +Data type representing the configuration of the pipefs pseudo file system +service. This type has the following parameters: +@table @asis +@item @code{mount-point} (default: @code{"/var/lib/nfs/rpc_pipefs"}) +The directory to which the file system is to be attached. +@end table +@end deftp + + +@subsubheading GSS Daemon Service +@cindex GSSD +@cindex GSS +@cindex global security system + +The @dfn{global security system} (GSS) daemon provides strong security for +RPC based protocols. Before exchanging RPC requests an RPC client must +establish a security context. Typically this is done using the Kerberos +command @command{kinit} or automatically at login time using PAM services +(@pxref{Kerberos-Dienste}). + +@defvr {Scheme Variable} gss-service-type +A service type for the Global Security System (GSS) daemon. +@end defvr + +@deftp {Data Type} gss-configuration +Data type representing the configuration of the GSS daemon service. This +type has the following parameters: +@table @asis +@item @code{nfs-utils} (default: @code{nfs-utils}) +The package in which the @command{rpc.gssd} command is to be found. + +@item @code{pipefs-directory} (default: @code{"/var/lib/nfs/rpc_pipefs"}) +The directory where the pipefs file system is mounted. + +@end table +@end deftp + + +@subsubheading IDMAP Daemon Service +@cindex idmapd +@cindex name mapper + +The idmap daemon service provides mapping between user IDs and user names. +Typically it is required in order to access file systems mounted via NFSv4. + +@defvr {Scheme Variable} idmap-service-type +A service type for the Identity Mapper (IDMAP) daemon. +@end defvr + +@deftp {Data Type} idmap-configuration +Data type representing the configuration of the IDMAP daemon service. This +type has the following parameters: +@table @asis +@item @code{nfs-utils} (default: @code{nfs-utils}) +The package in which the @command{rpc.idmapd} command is to be found. + +@item @code{pipefs-directory} (default: @code{"/var/lib/nfs/rpc_pipefs"}) +The directory where the pipefs file system is mounted. + +@item @code{domain} (default: @code{#f}) +The local NFSv4 domain name. This must be a string or @code{#f}. If it is +@code{#f} then the daemon will use the host's fully qualified domain name. + +@end table +@end deftp + +@node Kontinuierliche Integration +@subsubsection Kontinuierliche Integration + +@cindex continuous integration +@uref{https://git.savannah.gnu.org/cgit/guix/guix-cuirass.git, Cuirass} is a +continuous integration tool for Guix. It can be used both for development +and for providing substitutes to others (@pxref{Substitute}). + +The @code{(gnu services cuirass)} module provides the following service. + +@defvr {Scheme Procedure} cuirass-service-type +The type of the Cuirass service. Its value must be a +@code{cuirass-configuration} object, as described below. +@end defvr + +To add build jobs, you have to set the @code{specifications} field of the +configuration. Here is an example of a service that polls the Guix +repository and builds the packages from a manifest. Some of the packages +are defined in the @code{"custom-packages"} input, which is the equivalent +of @code{GUIX_PACKAGE_PATH}. + +@example +(define %cuirass-specs + #~(list + '((#:name . "my-manifest") + (#:load-path-inputs . ("guix")) + (#:package-path-inputs . ("custom-packages")) + (#:proc-input . "guix") + (#:proc-file . "build-aux/cuirass/gnu-system.scm") + (#:proc . cuirass-jobs) + (#:proc-args . ((subset . "manifests") + (systems . ("x86_64-linux")) + (manifests . (("config" . "guix/manifest.scm"))))) + (#:inputs . (((#:name . "guix") + (#:url . "git://git.savannah.gnu.org/guix.git") + (#:load-path . ".") + (#:branch . "master") + (#:no-compile? . #t)) + ((#:name . "config") + (#:url . "git://git.example.org/config.git") + (#:load-path . ".") + (#:branch . "master") + (#:no-compile? . #t)) + ((#:name . "custom-packages") + (#:url . "git://git.example.org/custom-packages.git") + (#:load-path . ".") + (#:branch . "master") + (#:no-compile? . #t))))))) + +(service cuirass-service-type + (cuirass-configuration + (specifications %cuirass-specs))) +@end example + +While information related to build jobs is located directly in the +specifications, global settings for the @command{cuirass} process are +accessible in other @code{cuirass-configuration} fields. + +@deftp {Data Type} cuirass-configuration +Data type representing the configuration of Cuirass. + +@table @asis +@item @code{log-file} (default: @code{"/var/log/cuirass.log"}) +Location of the log file. + +@item @code{cache-directory} (default: @code{"/var/cache/cuirass"}) +Location of the repository cache. + +@item @code{user} (default: @code{"cuirass"}) +Owner of the @code{cuirass} process. + +@item @code{group} (default: @code{"cuirass"}) +Owner's group of the @code{cuirass} process. + +@item @code{interval} (default: @code{60}) +Number of seconds between the poll of the repositories followed by the +Cuirass jobs. + +@item @code{database} (default: @code{"/var/lib/cuirass/cuirass.db"}) +Location of sqlite database which contains the build results and previously +added specifications. + +@item @code{port} (default: @code{8081}) +Port number used by the HTTP server. + +@item --listen=@var{host} +Listen on the network interface for @var{host}. The default is to accept +connections from localhost. + +@item @code{specifications} (default: @code{#~'()}) +A gexp (@pxref{G-Ausdrücke}) that evaluates to a list of specifications, +where a specification is an association list (@pxref{Associations Lists,,, +guile, GNU Guile Reference Manual}) whose keys are keywords +(@code{#:keyword-example}) as shown in the example above. + +@item @code{use-substitutes?} (default: @code{#f}) +This allows using substitutes to avoid building every dependencies of a job +from source. + +@item @code{one-shot?} (default: @code{#f}) +Only evaluate specifications and build derivations once. + +@item @code{fallback?} (default: @code{#f}) +When substituting a pre-built binary fails, fall back to building packages +locally. + +@item @code{cuirass} (default: @code{cuirass}) +The Cuirass package to use. +@end table +@end deftp + +@node Power Management Services +@subsubsection Power Management Services + +@cindex tlp +@cindex power management with TLP +@subsubheading TLP daemon + +The @code{(gnu services pm)} module provides a Guix service definition for +the Linux power management tool TLP. + +TLP enables various powersaving modes in userspace and kernel. Contrary to +@code{upower-service}, it is not a passive, monitoring tool, as it will +apply custom settings each time a new power source is detected. More +information can be found at @uref{http://linrunner.de/en/tlp/tlp.html, TLP +home page}. + +@deffn {Scheme Variable} tlp-service-type +The service type for the TLP tool. Its value should be a valid TLP +configuration (see below). To use the default settings, simply write: +@example +(service tlp-service-type) +@end example +@end deffn + +By default TLP does not need much configuration but most TLP parameters can +be tweaked using @code{tlp-configuration}. + +Each parameter definition is preceded by its type; for example, +@samp{boolean foo} indicates that the @code{foo} parameter should be +specified as a boolean. Types starting with @code{maybe-} denote parameters +that won't show up in TLP config file when their value is @code{'disabled}. + +@c The following documentation was initially generated by +@c (generate-tlp-documentation) in (gnu services pm). Manually maintained +@c documentation is better, so we shouldn't hesitate to edit below as +@c needed. However if the change you want to make to this documentation +@c can be done in an automated way, it's probably easier to change +@c (generate-documentation) than to make it below and have to deal with +@c the churn as TLP updates. + +Available @code{tlp-configuration} fields are: + +@deftypevr {@code{tlp-configuration} parameter} package tlp +The TLP package. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean tlp-enable? +Set to true if you wish to enable TLP. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string tlp-default-mode +Default mode when no power supply can be detected. Alternatives are AC and +BAT. + +Defaults to @samp{"AC"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac +Number of seconds Linux kernel has to wait after the disk goes idle, before +syncing on AC. + +Defaults to @samp{0}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat +Same as @code{disk-idle-ac} but on BAT mode. + +Defaults to @samp{2}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac +Dirty pages flushing periodicity, expressed in seconds. + +Defaults to @samp{15}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat +Same as @code{max-lost-work-secs-on-ac} but on BAT mode. + +Defaults to @samp{60}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac +CPU frequency scaling governor on AC mode. With intel_pstate driver, +alternatives are powersave and performance. With acpi-cpufreq driver, +alternatives are ondemand, powersave, performance and conservative. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat +Same as @code{cpu-scaling-governor-on-ac} but on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac +Set the min available frequency for the scaling governor on AC. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac +Set the max available frequency for the scaling governor on AC. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat +Set the min available frequency for the scaling governor on BAT. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat +Set the max available frequency for the scaling governor on BAT. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac +Limit the min P-state to control the power dissipation of the CPU, in AC +mode. Values are stated as a percentage of the available performance. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac +Limit the max P-state to control the power dissipation of the CPU, in AC +mode. Values are stated as a percentage of the available performance. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat +Same as @code{cpu-min-perf-on-ac} on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat +Same as @code{cpu-max-perf-on-ac} on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac? +Enable CPU turbo boost feature on AC mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat? +Same as @code{cpu-boost-on-ac?} on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean sched-powersave-on-ac? +Allow Linux kernel to minimize the number of CPU cores/hyper-threads used +under light load conditions. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean sched-powersave-on-bat? +Same as @code{sched-powersave-on-ac?} but on BAT mode. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean nmi-watchdog? +Enable Linux kernel NMI watchdog. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-string phc-controls +For Linux kernels with PHC patch applied, change CPU voltages. An example +value would be @samp{"F:V F:V F:V F:V"}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string energy-perf-policy-on-ac +Set CPU performance versus energy saving policy on AC. Alternatives are +performance, normal, powersave. + +Defaults to @samp{"performance"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string energy-perf-policy-on-bat +Same as @code{energy-perf-policy-ac} but on BAT mode. + +Defaults to @samp{"powersave"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disks-devices +Hard disk devices. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac +Hard disk advanced power management level. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat +Same as @code{disk-apm-bat} but on BAT mode. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac +Hard disk spin down timeout. One value has to be specified for each +declared hard disk. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat +Same as @code{disk-spindown-timeout-on-ac} but on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched +Select IO scheduler for disk devices. One value has to be specified for +each declared hard disk. Example alternatives are cfq, deadline and noop. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string sata-linkpwr-on-ac +SATA aggressive link power management (ALPM) level. Alternatives are +min_power, medium_power, max_performance. + +Defaults to @samp{"max_performance"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string sata-linkpwr-on-bat +Same as @code{sata-linkpwr-ac} but on BAT mode. + +Defaults to @samp{"min_power"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist +Exclude specified SATA host devices for link power management. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac? +Enable Runtime Power Management for AHCI controller and disks on AC mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat? +Same as @code{ahci-runtime-pm-on-ac} on BAT mode. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout +Seconds of inactivity before disk is suspended. + +Defaults to @samp{15}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string pcie-aspm-on-ac +PCI Express Active State Power Management level. Alternatives are default, +performance, powersave. + +Defaults to @samp{"performance"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string pcie-aspm-on-bat +Same as @code{pcie-aspm-ac} but on BAT mode. + +Defaults to @samp{"powersave"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-power-profile-on-ac +Radeon graphics clock speed level. Alternatives are low, mid, high, auto, +default. + +Defaults to @samp{"high"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-power-profile-on-bat +Same as @code{radeon-power-ac} but on BAT mode. + +Defaults to @samp{"low"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac +Radeon dynamic power management method (DPM). Alternatives are battery, +performance. + +Defaults to @samp{"performance"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat +Same as @code{radeon-dpm-state-ac} but on BAT mode. + +Defaults to @samp{"battery"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac +Radeon DPM performance level. Alternatives are auto, low, high. + +Defaults to @samp{"auto"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat +Same as @code{radeon-dpm-perf-ac} but on BAT mode. + +Defaults to @samp{"auto"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac? +Wifi power saving mode. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat? +Same as @code{wifi-power-ac?} but on BAT mode. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} y-n-boolean wol-disable? +Disable wake on LAN. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac +Timeout duration in seconds before activating audio power saving on Intel +HDA and AC97 devices. A value of 0 disables power saving. + +Defaults to @samp{0}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat +Same as @code{sound-powersave-ac} but on BAT mode. + +Defaults to @samp{1}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller? +Disable controller in powersaving mode on Intel HDA devices. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat? +Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be powered +on again by releasing (and reinserting) the eject lever or by pressing the +disc eject button on newer models. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string bay-device +Name of the optical drive device to power off. + +Defaults to @samp{"sr0"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string runtime-pm-on-ac +Runtime Power Management for PCI(e) bus devices. Alternatives are on and +auto. + +Defaults to @samp{"on"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} string runtime-pm-on-bat +Same as @code{runtime-pm-ac} but on BAT mode. + +Defaults to @samp{"auto"}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean runtime-pm-all? +Runtime Power Management for all PCI(e) bus devices, except blacklisted +ones. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist +Exclude specified PCI(e) device addresses from Runtime Power Management. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist +Exclude PCI(e) devices assigned to the specified drivers from Runtime Power +Management. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean usb-autosuspend? +Enable USB autosuspend feature. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-string usb-blacklist +Exclude specified devices from USB autosuspend. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean usb-blacklist-wwan? +Exclude WWAN devices from USB autosuspend. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-string usb-whitelist +Include specified devices into USB autosuspend, even if they are already +excluded by the driver or via @code{usb-blacklist-wwan?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown? +Enable USB autosuspend before shutdown. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{tlp-configuration} parameter} boolean restore-device-state-on-startup? +Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on +system startup. + +Defaults to @samp{#f}. + +@end deftypevr + +@cindex thermald +@cindex CPU frequency scaling with thermald +@subsubheading Thermald daemon + +The @code{(gnu services pm)} module provides an interface to thermald, a CPU +frequency scaling service which helps prevent overheating. + +@defvr {Scheme Variable} thermald-service-type +This is the service type for @uref{https://01.org/linux-thermal-daemon/, +thermald}, the Linux Thermal Daemon, which is responsible for controlling +the thermal state of processors and preventing overheating. +@end defvr + +@deftp {Data Type} thermald-configuration +Data type representing the configuration of @code{thermald-service-type}. + +@table @asis +@item @code{ignore-cpuid-check?} (default: @code{#f}) +Ignore cpuid check for supported CPU models. + +@item @code{thermald} (default: @var{thermald}) +Package object of thermald. + +@end table +@end deftp + +@node Audio-Dienste +@subsubsection Audio-Dienste + +The @code{(gnu services audio)} module provides a service to start MPD (the +Music Player Daemon). + +@cindex mpd +@subsubheading Music Player Daemon + +The Music Player Daemon (MPD) is a service that can play music while being +controlled from the local machine or over the network by a variety of +clients. + +The following example shows how one might run @code{mpd} as user +@code{"bob"} on port @code{6666}. It uses pulseaudio for output. + +@example +(service mpd-service-type + (mpd-configuration + (user "bob") + (port "6666"))) +@end example + +@defvr {Scheme Variable} mpd-service-type +The service type for @command{mpd} +@end defvr + +@deftp {Data Type} mpd-configuration +Data type representing the configuration of @command{mpd}. + +@table @asis +@item @code{user} (default: @code{"mpd"}) +The user to run mpd as. + +@item @code{music-dir} (default: @code{"~/Music"}) +The directory to scan for music files. + +@item @code{playlist-dir} (default: @code{"~/.mpd/playlists"}) +The directory to store playlists. + +@item @code{port} (default: @code{"6600"}) +The port to run mpd on. + +@item @code{address} (default: @code{"any"}) +The address that mpd will bind to. To use a Unix domain socket, an absolute +path can be specified here. + +@end table +@end deftp + +@node Virtualisierungsdienste +@subsubsection Virtualization services + +The @code{(gnu services virtualization)} module provides services for the +libvirt and virtlog daemons, as well as other virtualization-related +services. + +@subsubheading Libvirt daemon +@code{libvirtd} is the server side daemon component of the libvirt +virtualization management system. This daemon runs on host servers and +performs required management tasks for virtualized guests. + +@deffn {Scheme Variable} libvirt-service-type +This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its +value must be a @code{libvirt-configuration}. + +@example +(service libvirt-service-type + (libvirt-configuration + (unix-sock-group "libvirt") + (tls-port "16555"))) +@end example +@end deffn + +@c Auto-generated with (generate-libvirt-documentation) +Available @code{libvirt-configuration} fields are: + +@deftypevr {@code{libvirt-configuration} parameter} package libvirt +Libvirt package. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean listen-tls? +Flag listening for secure TLS connections on the public TCP/IP port. must +set @code{listen} for this to have any effect. + +It is necessary to setup a CA and issue server certificates before using +this capability. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean listen-tcp? +Listen for unencrypted TCP connections on the public TCP/IP port. must set +@code{listen} for this to have any effect. + +Using the TCP socket requires SASL authentication by default. Only SASL +mechanisms which support data encryption are allowed. This is DIGEST_MD5 +and GSSAPI (Kerberos5) + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string tls-port +Port for accepting secure TLS connections This can be a port number, or +service name + +Defaults to @samp{"16514"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string tcp-port +Port for accepting insecure TCP connections This can be a port number, or +service name + +Defaults to @samp{"16509"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string listen-addr +IP address or hostname used for client connections. + +Defaults to @samp{"0.0.0.0"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean mdns-adv? +Flag toggling mDNS advertisement of the libvirt service. + +Alternatively can disable for all services on a host by stopping the Avahi +daemon. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string mdns-name +Default mDNS advertisement name. This must be unique on the immediate +broadcast network. + +Defaults to @samp{"Virtualization Host <hostname>"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string unix-sock-group +UNIX domain socket group ownership. This can be used to allow a 'trusted' +set of users access to management capabilities without becoming root. + +Defaults to @samp{"root"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string unix-sock-ro-perms +UNIX socket permissions for the R/O socket. This is used for monitoring VM +status only. + +Defaults to @samp{"0777"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string unix-sock-rw-perms +UNIX socket permissions for the R/W socket. Default allows only root. If +PolicyKit is enabled on the socket, the default will change to allow +everyone (eg, 0777) + +Defaults to @samp{"0770"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string unix-sock-admin-perms +UNIX socket permissions for the admin socket. Default allows only owner +(root), do not change it unless you are sure to whom you are exposing the +access to. + +Defaults to @samp{"0777"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string unix-sock-dir +The directory in which sockets will be found/created. + +Defaults to @samp{"/var/run/libvirt"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string auth-unix-ro +Authentication scheme for UNIX read-only sockets. By default socket +permissions allow anyone to connect + +Defaults to @samp{"polkit"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string auth-unix-rw +Authentication scheme for UNIX read-write sockets. By default socket +permissions only allow root. If PolicyKit support was compiled into +libvirt, the default will be to use 'polkit' auth. + +Defaults to @samp{"polkit"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string auth-tcp +Authentication scheme for TCP sockets. If you don't enable SASL, then all +TCP traffic is cleartext. Don't do this outside of a dev/test scenario. + +Defaults to @samp{"sasl"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string auth-tls +Authentication scheme for TLS sockets. TLS sockets already have encryption +provided by the TLS layer, and limited authentication is done by +certificates. + +It is possible to make use of any SASL authentication mechanism as well, by +using 'sasl' for this option + +Defaults to @samp{"none"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} optional-list access-drivers +API access control scheme. + +By default an authenticated user is allowed access to all APIs. Access +drivers can place restrictions on this. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string key-file +Server key file path. If set to an empty string, then no private key is +loaded. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string cert-file +Server key file path. If set to an empty string, then no certificate is +loaded. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string ca-file +Server key file path. If set to an empty string, then no CA certificate is +loaded. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string crl-file +Certificate revocation list path. If set to an empty string, then no CRL is +loaded. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert +Disable verification of our own server certificates. + +When libvirtd starts it performs some sanity checks against its own +certificates. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean tls-no-verify-cert +Disable verification of client certificates. + +Client certificate verification is the primary authentication mechanism. +Any client which does not present a certificate signed by the CA will be +rejected. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list +Whitelist of allowed x509 Distinguished Name. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames +Whitelist of allowed SASL usernames. The format for username depends on the +SASL authentication mechanism. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string tls-priority +Override the compile time default TLS priority string. The default is +usually "NORMAL" unless overridden at build time. Only set this is it is +desired for libvirt to deviate from the global default settings. + +Defaults to @samp{"NORMAL"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-clients +Maximum number of concurrent client connections to allow over all sockets +combined. + +Defaults to @samp{5000}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-queued-clients +Maximum length of queue of connections waiting to be accepted by the +daemon. Note, that some protocols supporting retransmission may obey this +so that a later reattempt at connection succeeds. + +Defaults to @samp{1000}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-anonymous-clients +Maximum length of queue of accepted but not yet authenticated clients. Set +this to zero to turn this feature off + +Defaults to @samp{20}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer min-workers +Number of workers to start up initially. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-workers +Maximum number of worker threads. + +If the number of active clients exceeds @code{min-workers}, then more +threads are spawned, up to max_workers limit. Typically you'd want +max_workers to equal maximum number of clients allowed. + +Defaults to @samp{20}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer prio-workers +Number of priority workers. If all workers from above pool are stuck, some +calls marked as high priority (notably domainDestroy) can be executed in +this pool. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-requests +Total global limit on concurrent RPC calls. + +Defaults to @samp{20}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer max-client-requests +Limit on concurrent requests from a single client connection. To avoid one +client monopolizing the server this should be a small fraction of the global +max_requests and max_workers parameter. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-min-workers +Same as @code{min-workers} but for the admin interface. + +Defaults to @samp{1}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-max-workers +Same as @code{max-workers} but for the admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-max-clients +Same as @code{max-clients} but for the admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-max-queued-clients +Same as @code{max-queued-clients} but for the admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-max-client-requests +Same as @code{max-client-requests} but for the admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer log-level +Logging level. 4 errors, 3 warnings, 2 information, 1 debug. + +Defaults to @samp{3}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string log-filters +Logging filters. + +A filter allows to select a different logging level for a given category of +logs The format for a filter is one of: + +@itemize @bullet +@item +x:name + +@item +x:+name + +@end itemize + +where @code{name} is a string which is matched against the category given in +the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., +"remote", "qemu", or "util.json" (the name in the filter can be a substring +of the full category name, in order to match multiple similar categories), +the optional "+" prefix tells libvirt to log stack trace for each message +matching name, and @code{x} is the minimal level where matching messages +should be logged: + +@itemize @bullet +@item +1: DEBUG + +@item +2: INFO + +@item +3: WARNING + +@item +4: ERROR + +@end itemize + +Multiple filters can be defined in a single filters statement, they just +need to be separated by spaces. + +Defaults to @samp{"3:remote 4:event"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string log-outputs +Logging outputs. + +An output is one of the places to save logging information The format for an +output can be: + +@table @code +@item x:stderr +output goes to stderr + +@item x:syslog:name +use syslog for the output and use the given name as the ident + +@item x:file:file_path +output to a file, with the given filepath + +@item x:journald +output to journald logging system + +@end table + +In all case the x prefix is the minimal level, acting as a filter + +@itemize @bullet +@item +1: DEBUG + +@item +2: INFO + +@item +3: WARNING + +@item +4: ERROR + +@end itemize + +Multiple outputs can be defined, they just need to be separated by spaces. + +Defaults to @samp{"3:stderr"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer audit-level +Allows usage of the auditing subsystem to be altered + +@itemize @bullet +@item +0: disable all auditing + +@item +1: enable auditing, only if enabled on host + +@item +2: enable auditing, and exit if disabled on host. + +@end itemize + +Defaults to @samp{1}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} boolean audit-logging +Send audit messages via libvirt logging infrastructure. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} optional-string host-uuid +Host UUID. UUID must not have all digits be the same. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} string host-uuid-source +Source to read host UUID. + +@itemize @bullet +@item +@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid} + +@item +@code{machine-id}: fetch the UUID from @code{/etc/machine-id} + +@end itemize + +If @code{dmidecode} does not provide a valid UUID a temporary UUID will be +generated. + +Defaults to @samp{"smbios"}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer keepalive-interval +A keepalive message is sent to a client after @code{keepalive_interval} +seconds of inactivity to check if the client is still responding. If set to +-1, libvirtd will never send keepalive requests; however clients can still +send them and the daemon will send responses. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer keepalive-count +Maximum number of keepalive messages that are allowed to be sent to the +client without getting any response before the connection is considered +broken. + +In other words, the connection is automatically closed approximately after +@code{keepalive_interval * (keepalive_count + 1)} seconds since the last +message received from the client. When @code{keepalive-count} is set to 0, +connections will be automatically closed after @code{keepalive-interval} +seconds of inactivity without sending any keepalive messages. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-keepalive-interval +Same as above but for admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer admin-keepalive-count +Same as above but for admin interface. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{libvirt-configuration} parameter} integer ovs-timeout +Timeout for Open vSwitch calls. + +The @code{ovs-vsctl} utility is used for the configuration and its timeout +option is set by default to 5 seconds to avoid potential infinite waits +blocking libvirt. + +Defaults to @samp{5}. + +@end deftypevr + +@c %end of autogenerated docs + +@subsubheading Virtlog daemon +The virtlogd service is a server side daemon component of libvirt that is +used to manage logs from virtual machine consoles. + +This daemon is not used directly by libvirt client applications, rather it +is called on their behalf by @code{libvirtd}. By maintaining the logs in a +standalone daemon, the main @code{libvirtd} daemon can be restarted without +risk of losing logs. The @code{virtlogd} daemon has the ability to re-exec() +itself upon receiving @code{SIGUSR1}, to allow live upgrades without +downtime. + +@deffn {Scheme Variable} virtlog-service-type +This is the type of the virtlog daemon. Its value must be a +@code{virtlog-configuration}. + +@example +(service virtlog-service-type + (virtlog-configuration + (max-clients 1000))) +@end example +@end deffn + +@deftypevr {@code{virtlog-configuration} parameter} integer log-level +Logging level. 4 errors, 3 warnings, 2 information, 1 debug. + +Defaults to @samp{3}. + +@end deftypevr + +@deftypevr {@code{virtlog-configuration} parameter} string log-filters +Logging filters. + +A filter allows to select a different logging level for a given category of +logs The format for a filter is one of: + +@itemize @bullet +@item +x:name + +@item +x:+name + +@end itemize + +where @code{name} is a string which is matched against the category given in +the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., +"remote", "qemu", or "util.json" (the name in the filter can be a substring +of the full category name, in order to match multiple similar categories), +the optional "+" prefix tells libvirt to log stack trace for each message +matching name, and @code{x} is the minimal level where matching messages +should be logged: + +@itemize @bullet +@item +1: DEBUG + +@item +2: INFO + +@item +3: WARNING + +@item +4: ERROR + +@end itemize + +Multiple filters can be defined in a single filters statement, they just +need to be separated by spaces. + +Defaults to @samp{"3:remote 4:event"}. + +@end deftypevr + +@deftypevr {@code{virtlog-configuration} parameter} string log-outputs +Logging outputs. + +An output is one of the places to save logging information The format for an +output can be: + +@table @code +@item x:stderr +output goes to stderr + +@item x:syslog:name +use syslog for the output and use the given name as the ident + +@item x:file:file_path +output to a file, with the given filepath + +@item x:journald +output to journald logging system + +@end table + +In all case the x prefix is the minimal level, acting as a filter + +@itemize @bullet +@item +1: DEBUG + +@item +2: INFO + +@item +3: WARNING + +@item +4: ERROR + +@end itemize + +Multiple outputs can be defined, they just need to be separated by spaces. + +Defaults to @samp{"3:stderr"}. + +@end deftypevr + +@deftypevr {@code{virtlog-configuration} parameter} integer max-clients +Maximum number of concurrent client connections to allow over all sockets +combined. + +Defaults to @samp{1024}. + +@end deftypevr + +@deftypevr {@code{virtlog-configuration} parameter} integer max-size +Maximum file size before rolling over. + +Defaults to @samp{2MB} + +@end deftypevr + +@deftypevr {@code{virtlog-configuration} parameter} integer max-backups +Maximum number of backup files to keep. + +Defaults to @samp{3} + +@end deftypevr + +@subsubheading Transparent Emulation with QEMU + +@cindex emulation +@cindex @code{binfmt_misc} +@code{qemu-binfmt-service-type} provides support for transparent emulation +of program binaries built for different architectures---e.g., it allows you +to transparently execute an ARMv7 program on an x86_64 machine. It achieves +this by combining the @uref{https://www.qemu.org, QEMU} emulator and the +@code{binfmt_misc} feature of the kernel Linux. + +@defvr {Scheme Variable} qemu-binfmt-service-type +This is the type of the QEMU/binfmt service for transparent emulation. Its +value must be a @code{qemu-binfmt-configuration} object, which specifies the +QEMU package to use as well as the architecture we want to emulated: + +@example +(service qemu-binfmt-service-type + (qemu-binfmt-configuration + (platforms (lookup-qemu-platforms "arm" "aarch64" "ppc")))) +@end example + +In this example, we enable transparent emulation for the ARM and aarch64 +platforms. Running @code{herd stop qemu-binfmt} turns it off, and running +@code{herd start qemu-binfmt} turns it back on (@pxref{Invoking herd, the +@command{herd} command,, shepherd, The GNU Shepherd Manual}). +@end defvr + +@deftp {Data Type} qemu-binfmt-configuration +This is the configuration for the @code{qemu-binfmt} service. + +@table @asis +@item @code{platforms} (default: @code{'()}) +The list of emulated QEMU platforms. Each item must be a @dfn{platform +object} as returned by @code{lookup-qemu-platforms} (see below). + +@item @code{guix-support?} (default: @code{#f}) +When it is true, QEMU and all its dependencies are added to the build +environment of @command{guix-daemon} (@pxref{Aufruf des guix-daemon, +@code{--chroot-directory} option}). This allows the @code{binfmt_misc} +handlers to be used within the build environment, which in turn means that +you can transparently build programs for another architecture. + +For example, let's suppose you're on an x86_64 machine and you have this +service: + +@example +(service qemu-binfmt-service-type + (qemu-binfmt-configuration + (platforms (lookup-qemu-platforms "arm")) + (guix-support? #t))) +@end example + +You can run: + +@example +guix build -s armhf-linux inkscape +@end example + +@noindent +and it will build Inkscape for ARMv7 @emph{as if it were a native build}, +transparently using QEMU to emulate the ARMv7 CPU. Pretty handy if you'd +like to test a package build for an architecture you don't have access to! + +@item @code{qemu} (default: @code{qemu}) +The QEMU package to use. +@end table +@end deftp + +@deffn {Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{} +Return the list of QEMU platform objects corresponding to +@var{platforms}@dots{}. @var{platforms} must be a list of strings +corresponding to platform names, such as @code{"arm"}, @code{"sparc"}, +@code{"mips64el"}, and so on. +@end deffn + +@deffn {Scheme Procedure} qemu-platform? @var{obj} +Return true if @var{obj} is a platform object. +@end deffn + +@deffn {Scheme Procedure} qemu-platform-name @var{platform} +Return the name of @var{platform}---a string such as @code{"arm"}. +@end deffn + +@node Versionskontrolldienste +@subsubsection Versionskontrolldienste + +The @code{(gnu services version-control)} module provides a service to allow +remote access to local Git repositories. There are three options: the +@code{git-daemon-service}, which provides access to repositories via the +@code{git://} unsecured TCP-based protocol, extending the @code{nginx} web +server to proxy some requests to @code{git-http-backend}, or providing a web +interface with @code{cgit-service-type}. + +@deffn {Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)] + +Return a service that runs @command{git daemon}, a simple TCP server to +expose repositories over the Git protocol for anonymous access. + +The optional @var{config} argument should be a +@code{<git-daemon-configuration>} object, by default it allows read-only +access to exported@footnote{By creating the magic file +"git-daemon-export-ok" in the repository directory.} repositories under +@file{/srv/git}. + +@end deffn + +@deftp {Data Type} git-daemon-configuration +Data type representing the configuration for @code{git-daemon-service}. + +@table @asis +@item @code{package} (default: @var{git}) +Package object of the Git distributed version control system. + +@item @code{export-all?} (default: @var{#f}) +Whether to allow access for all Git repositories, even if they do not have +the @file{git-daemon-export-ok} file. + +@item @code{base-path} (default: @file{/srv/git}) +Whether to remap all the path requests as relative to the given path. If +you run git daemon with @var{(base-path "/srv/git")} on example.com, then if +you later try to pull @code{git://example.com/hello.git}, git daemon will +interpret the path as @code{/srv/git/hello.git}. + +@item @code{user-path} (default: @var{#f}) +Whether to allow @code{~user} notation to be used in requests. When +specified with empty string, requests to @code{git://host/~alice/foo} is +taken as a request to access @code{foo} repository in the home directory of +user @code{alice}. If @var{(user-path "path")} is specified, the same +request is taken as a request to access @code{path/foo} repository in the +home directory of user @code{alice}. + +@item @code{listen} (default: @var{'()}) +Whether to listen on specific IP addresses or hostnames, defaults to all. + +@item @code{port} (default: @var{#f}) +Whether to listen on an alternative port, which defaults to 9418. + +@item @code{whitelist} (default: @var{'()}) +If not empty, only allow access to this list of directories. + +@item @code{extra-options} (default: @var{'()}) +Extra options will be passed to @code{git daemon}, please run @command{man +git-daemon} for more information. + +@end table +@end deftp + +The @code{git://} protocol lacks authentication. When you pull from a +repository fetched via @code{git://}, you don't know that the data you +receive was modified is really coming from the specified host, and you have +your connection is subject to eavesdropping. It's better to use an +authenticated and encrypted transport, such as @code{https}. Although Git +allows you to serve repositories using unsophisticated file-based web +servers, there is a faster protocol implemented by the +@code{git-http-backend} program. This program is the back-end of a proper +Git web service. It is designed to sit behind a FastCGI proxy. @xref{Web-Dienste}, for more on running the necessary @code{fcgiwrap} daemon. + +Guix has a separate configuration data type for serving Git repositories +over HTTP. + +@deftp {Data Type} git-http-configuration +Data type representing the configuration for @code{git-http-service}. + +@table @asis +@item @code{package} (default: @var{git}) +Package object of the Git distributed version control system. + +@item @code{git-root} (default: @file{/srv/git}) +Directory containing the Git repositories to expose to the world. + +@item @code{export-all?} (default: @var{#f}) +Whether to expose access for all Git repositories in @var{git-root}, even if +they do not have the @file{git-daemon-export-ok} file. + +@item @code{uri-path} (default: @file{/git/}) +Path prefix for Git access. With the default @code{/git/} prefix, this will +map @code{http://@var{server}/git/@var{repo}.git} to +@code{/srv/git/@var{repo}.git}. Requests whose URI paths do not begin with +this prefix are not passed on to this Git instance. + +@item @code{fcgiwrap-socket} (default: @code{127.0.0.1:9000}) +The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web-Dienste}. +@end table +@end deftp + +There is no @code{git-http-service-type}, currently; instead you can create +an @code{nginx-location-configuration} from a @code{git-http-configuration} +and then add that location to a web server. + +@deffn {Scheme Procedure} git-http-nginx-location-configuration @ + [config=(git-http-configuration)] Compute an +@code{nginx-location-configuration} that corresponds to the given Git http +configuration. An example nginx service definition to serve the default +@file{/srv/git} over HTTPS might be: + +@example +(service nginx-service-type + (nginx-configuration + (server-blocks + (list + (nginx-server-configuration + (listen '("443 ssl")) + (server-name "git.my-host.org") + (ssl-certificate + "/etc/letsencrypt/live/git.my-host.org/fullchain.pem") + (ssl-certificate-key + "/etc/letsencrypt/live/git.my-host.org/privkey.pem") + (locations + (list + (git-http-nginx-location-configuration + (git-http-configuration (uri-path "/")))))))))) +@end example + +This example assumes that you are using Let's Encrypt to get your TLS +certificate. @xref{Zertifikatsdienste}. The default @code{certbot} +service will redirect all HTTP traffic on @code{git.my-host.org} to HTTPS. +You will also need to add an @code{fcgiwrap} proxy to your system services. +@xref{Web-Dienste}. +@end deffn + +@subsubheading Cgit Service + +@cindex Cgit service +@cindex Git, web interface +@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git +repositories written in C. + +The following example will configure the service with default values. By +default, Cgit can be accessed on port 80 (@code{http://localhost:80}). + +@example +(service cgit-service-type) +@end example + +The @code{file-object} type designates either a file-like object +(@pxref{G-Ausdrücke, file-like objects}) or a string. + +@c %start of fragment + +Available @code{cgit-configuration} fields are: + +@deftypevr {@code{cgit-configuration} parameter} package package +The CGIT package. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} nginx-server-configuration-list nginx +NGINX configuration. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object about-filter +Specifies a command which will be invoked to format the content of about +pages (both top-level and for each repository). + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string agefile +Specifies a path, relative to each repository path, which can be used to +specify the date and time of the youngest commit in the repository. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object auth-filter +Specifies a command that will be invoked for authenticating repository +access. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string branch-sort +Flag which, when set to @samp{age}, enables date ordering in the branch ref +list, and when set @samp{name} enables ordering by branch name. + +Defaults to @samp{"name"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string cache-root +Path used to store the cgit cache entries. + +Defaults to @samp{"/var/cache/cgit"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-static-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of repository pages accessed with a fixed SHA1. + +Defaults to @samp{-1}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-dynamic-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of repository pages accessed without a fixed SHA1. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-repo-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of the repository summary page. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-root-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of the repository index page. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-scanrc-ttl +Number which specifies the time-to-live, in minutes, for the result of +scanning a path for Git repositories. + +Defaults to @samp{15}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-about-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of the repository about page. + +Defaults to @samp{15}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-snapshot-ttl +Number which specifies the time-to-live, in minutes, for the cached version +of snapshots. + +Defaults to @samp{5}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer cache-size +The maximum number of entries in the cgit cache. When set to @samp{0}, +caching is disabled. + +Defaults to @samp{0}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean case-sensitive-sort? +Sort items in the repo list case sensitively. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} list clone-prefix +List of common prefixes which, when combined with a repository URL, +generates valid clone URLs for the repository. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} list clone-url +List of @code{clone-url} templates. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object commit-filter +Command which will be invoked to format commit messages. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string commit-sort +Flag which, when set to @samp{date}, enables strict date ordering in the +commit log, and when set to @samp{topo} enables strict topological ordering. + +Defaults to @samp{"git log"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object css +URL which specifies the css document to include in all cgit pages. + +Defaults to @samp{"/share/cgit/cgit.css"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object email-filter +Specifies a command which will be invoked to format names and email address +of committers, authors, and taggers, as represented in various places +throughout the cgit interface. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean embedded? +Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment +suitable for embedding in other HTML pages. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-commit-graph? +Flag which, when set to @samp{#t}, will make cgit print an ASCII-art commit +history graph to the left of the commit messages in the repository log page. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-filter-overrides? +Flag which, when set to @samp{#t}, allows all filter settings to be +overridden in repository-specific cgitrc files. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-follow-links? +Flag which, when set to @samp{#t}, allows users to follow a file in the log +view. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-http-clone? +If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-index-links? +Flag which, when set to @samp{#t}, will make cgit generate extra links +"summary", "commit", "tree" for each repo in the repository index. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-index-owner? +Flag which, when set to @samp{#t}, will make cgit display the owner of each +repo in the repository index. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-log-filecount? +Flag which, when set to @samp{#t}, will make cgit print the number of +modified files for each commit on the repository log page. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-log-linecount? +Flag which, when set to @samp{#t}, will make cgit print the number of added +and removed lines for each commit on the repository log page. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-remote-branches? +Flag which, when set to @code{#t}, will make cgit display remote branches in +the summary and refs views. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-subject-links? +Flag which, when set to @code{1}, will make cgit use the subject of the +parent commit as link text when generating links to parent commits in commit +view. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-html-serving? +Flag which, when set to @samp{#t}, will make cgit use the subject of the +parent commit as link text when generating links to parent commits in commit +view. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-tree-linenumbers? +Flag which, when set to @samp{#t}, will make cgit generate linenumber links +for plaintext blobs printed in the tree view. + +Defaults to @samp{#t}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean enable-git-config? +Flag which, when set to @samp{#f}, will allow cgit to use Git config to set +any repo specific settings. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object favicon +URL used as link to a shortcut icon for cgit. + +Defaults to @samp{"/favicon.ico"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string footer +The content of the file specified with this option will be included verbatim +at the bottom of all pages (i.e. it replaces the standard "generated by..." +message). + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string head-include +The content of the file specified with this option will be included verbatim +in the HTML HEAD section on all pages. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string header +The content of the file specified with this option will be included verbatim +at the top of all pages. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object include +Name of a configfile to include before the rest of the current config- file +is parsed. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string index-header +The content of the file specified with this option will be included verbatim +above the repository index. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string index-info +The content of the file specified with this option will be included verbatim +below the heading on the repository index page. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean local-time? +Flag which, if set to @samp{#t}, makes cgit print commit and tag times in +the servers timezone. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object logo +URL which specifies the source of an image which will be used as a logo on +all cgit pages. + +Defaults to @samp{"/share/cgit/cgit.png"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string logo-link +URL loaded when clicking on the cgit logo image. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object owner-filter +Command which will be invoked to format the Owner column of the main page. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-atom-items +Number of items to display in atom feeds view. + +Defaults to @samp{10}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-commit-count +Number of entries to list per page in "log" view. + +Defaults to @samp{50}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-message-length +Number of commit message characters to display in "log" view. + +Defaults to @samp{80}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-repo-count +Specifies the number of entries to list per page on the repository index +page. + +Defaults to @samp{50}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-repodesc-length +Specifies the maximum number of repo description characters to display on +the repository index page. + +Defaults to @samp{80}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer max-blob-size +Specifies the maximum size of a blob to display HTML for in KBytes. + +Defaults to @samp{0}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string max-stats +Maximum statistics period. Valid values are @samp{week},@samp{month}, +@samp{quarter} and @samp{year}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} mimetype-alist mimetype +Mimetype for the specified filename extension. + +Defaults to @samp{((gif "image/gif") (html "text/html") (jpg "image/jpeg") +(jpeg "image/jpeg") (pdf "application/pdf") (png "image/png") (svg +"image/svg+xml"))}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object mimetype-file +Specifies the file to use for automatic mimetype lookup. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string module-link +Text which will be used as the formatstring for a hyperlink when a submodule +is printed in a directory listing. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean nocache? +If set to the value @samp{#t} caching will be disabled. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean noplainemail? +If set to @samp{#t} showing full author email addresses will be disabled. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean noheader? +Flag which, when set to @samp{#t}, will make cgit omit the standard header +on all pages. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} project-list project-list +A list of subdirectories inside of @code{repository-directory}, relative to +it, that should loaded as Git repositories. An empty list means that all +subdirectories will be loaded. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object readme +Text which will be used as default value for @code{cgit-repo-readme}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean remove-suffix? +If set to @code{#t} and @code{repository-directory} is enabled, if any +repositories are found with a suffix of @code{.git}, this suffix will be +removed for the URL and name. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer renamelimit +Maximum number of files to consider when detecting renames. + +Defaults to @samp{-1}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string repository-sort +The way in which repositories in each section are sorted. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} robots-list robots +Text used as content for the @code{robots} meta-tag. + +Defaults to @samp{("noindex" "nofollow")}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string root-desc +Text printed below the heading on the repository index page. + +Defaults to @samp{"a fast webinterface for the git dscm"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string root-readme +The content of the file specified with this option will be included verbatim +below thef "about" link on the repository index page. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string root-title +Text printed as heading on the repository index page. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean scan-hidden-path +If set to @samp{#t} and repository-directory is enabled, +repository-directory will recurse into directories whose name starts with a +period. Otherwise, repository-directory will stay away from such +directories, considered as "hidden". Note that this does not apply to the +".git" directory in non-bare repos. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} list snapshots +Text which specifies the default set of snapshot formats that cgit generates +links for. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} repository-directory repository-directory +Name of the directory to scan for repositories (represents +@code{scan-path}). + +Defaults to @samp{"/srv/git"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string section +The name of the current repository section - all repositories defined after +this option will inherit the current section name. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string section-sort +Flag which, when set to @samp{1}, will sort the sections on the repository +listing by name. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer section-from-path +A number which, if defined prior to repository-directory, specifies how many +path elements from each repo path to use as a default section name. + +Defaults to @samp{0}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} boolean side-by-side-diffs? +If set to @samp{#t} shows side-by-side diffs instead of unidiffs per +default. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} file-object source-filter +Specifies a command which will be invoked to format plaintext blobs in the +tree view. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer summary-branches +Specifies the number of branches to display in the repository "summary" +view. + +Defaults to @samp{10}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer summary-log +Specifies the number of log entries to display in the repository "summary" +view. + +Defaults to @samp{10}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} integer summary-tags +Specifies the number of tags to display in the repository "summary" view. + +Defaults to @samp{10}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string strict-export +Filename which, if specified, needs to be present within the repository for +cgit to allow access to that repository. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} string virtual-root +URL which, if specified, will be used as root for all cgit links. + +Defaults to @samp{"/"}. + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories +A list of @dfn{cgit-repo} records to use with config. + +Defaults to @samp{()}. + +Available @code{repository-cgit-configuration} fields are: + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-list snapshots +A mask of snapshot formats for this repo that cgit generates links for, +restricted by the global @code{snapshots} setting. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object source-filter +Override the default @code{source-filter}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string url +The relative URL used to access the repository. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object about-filter +Override the default @code{about-filter}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string branch-sort +Flag which, when set to @samp{age}, enables date ordering in the branch ref +list, and when set to @samp{name} enables ordering by branch name. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-list clone-url +A list of URLs which can be used to clone repo. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object commit-filter +Override the default @code{commit-filter}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string commit-sort +Flag which, when set to @samp{date}, enables strict date ordering in the +commit log, and when set to @samp{topo} enables strict topological ordering. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string defbranch +The name of the default branch for this repository. If no such branch +exists in the repository, the first branch name (when sorted) is used as +default instead. By default branch pointed to by HEAD, or "master" if there +is no suitable HEAD. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string desc +The value to show as repository description. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string homepage +The value to show as repository homepage. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object email-filter +Override the default @code{email-filter}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-commit-graph? +A flag which can be used to disable the global setting +@code{enable-commit-graph?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-filecount? +A flag which can be used to disable the global setting +@code{enable-log-filecount?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-log-linecount? +A flag which can be used to disable the global setting +@code{enable-log-linecount?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-remote-branches? +Flag which, when set to @code{#t}, will make cgit display remote branches in +the summary and refs views. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-subject-links? +A flag which can be used to override the global setting +@code{enable-subject-links?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} maybe-repo-boolean enable-html-serving? +A flag which can be used to override the global setting +@code{enable-html-serving?}. + +Defaults to @samp{disabled}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-boolean hide? +Flag which, when set to @code{#t}, hides the repository from the repository +index. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-boolean ignore? +Flag which, when set to @samp{#t}, ignores the repository. + +Defaults to @samp{#f}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object logo +URL which specifies the source of an image which will be used as a logo on +this repo’s pages. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string logo-link +URL loaded when clicking on the cgit logo image. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-file-object owner-filter +Override the default @code{owner-filter}. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string module-link +Text which will be used as the formatstring for a hyperlink when a submodule +is printed in a directory listing. The arguments for the formatstring are +the path and SHA1 of the submodule commit. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} module-link-path module-link-path +Text which will be used as the formatstring for a hyperlink when a submodule +with the specified subdirectory path is printed in a directory listing. + +Defaults to @samp{()}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string max-stats +Override the default maximum statistics period. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string name +The value to show as repository name. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string owner +A value used to identify the owner of the repository. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string path +An absolute path to the repository directory. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string readme +A path (relative to repo) which specifies a file to include verbatim as the +"About" page for this repo. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-string section +The name of the current repository section - all repositories defined after +this option will inherit the current section name. + +Defaults to @samp{""}. + +@end deftypevr + +@deftypevr {@code{repository-cgit-configuration} parameter} repo-list extra-options +Extra options will be appended to cgitrc file. + +Defaults to @samp{()}. + +@end deftypevr + +@end deftypevr + +@deftypevr {@code{cgit-configuration} parameter} list extra-options +Extra options will be appended to cgitrc file. + +Defaults to @samp{()}. + +@end deftypevr + + +@c %end of fragment + +However, it could be that you just want to get a @code{cgitrc} up and +running. In that case, you can pass an @code{opaque-cgit-configuration} as +a record to @code{cgit-service-type}. As its name indicates, an opaque +configuration does not have easy reflective capabilities. + +Available @code{opaque-cgit-configuration} fields are: + +@deftypevr {@code{opaque-cgit-configuration} parameter} package cgit +The cgit package. +@end deftypevr + +@deftypevr {@code{opaque-cgit-configuration} parameter} string string +The contents of the @code{cgitrc}, as a string. +@end deftypevr + +For example, if your @code{cgitrc} is just the empty string, you could +instantiate a cgit service like this: + +@example +(service cgit-service-type + (opaque-cgit-configuration + (cgitrc ""))) +@end example + +@subsubheading Gitolite Service + +@cindex Gitolite service +@cindex Git, hosting +@uref{http://gitolite.com/gitolite/, Gitolite} is a tool for hosting Git +repositories on a central server. + +Gitolite can handle multiple repositories and users, and supports flexible +configuration of the permissions for the users on the repositories. + +The following example will configure Gitolite using the default @code{git} +user, and the provided SSH public key. + +@example +(service gitolite-service-type + (gitolite-configuration + (admin-pubkey (plain-file + "yourname.pub" + "ssh-rsa AAAA... guix@@example.com")))) +@end example + +Gitolite is configured through a special admin repository which you can +clone, for example, if you setup Gitolite on @code{example.com}, you would +run the following command to clone the admin repository. + +@example +git clone git@@example.com:gitolite-admin +@end example + +When the Gitolite service is activated, the provided @code{admin-pubkey} +will be inserted in to the @file{keydir} directory in the gitolite-admin +repository. If this results in a change in the repository, it will be +committed using the message ``gitolite setup by GNU Guix''. + +@deftp {Data Type} gitolite-configuration +Data type representing the configuration for @code{gitolite-service-type}. + +@table @asis +@item @code{package} (default: @var{gitolite}) +Gitolite package to use. + +@item @code{user} (default: @var{git}) +User to use for Gitolite. This will be user that you use when accessing +Gitolite over SSH. + +@item @code{group} (default: @var{git}) +Group to use for Gitolite. + +@item @code{home-directory} (default: @var{"/var/lib/gitolite"}) +Directory in which to store the Gitolite configuration and repositories. + +@item @code{rc-file} (default: @var{(gitolite-rc-file)}) +A ``file-like'' object (@pxref{G-Ausdrücke, file-like objects}), +representing the configuration for Gitolite. + +@item @code{admin-pubkey} (default: @var{#f}) +A ``file-like'' object (@pxref{G-Ausdrücke, file-like objects}) used to +setup Gitolite. This will be inserted in to the @file{keydir} directory +within the gitolite-admin repository. + +To specify the SSH key as a string, use the @code{plain-file} function. + +@example +(plain-file "yourname.pub" "ssh-rsa AAAA... guix@@example.com") +@end example + +@end table +@end deftp + +@deftp {Data Type} gitolite-rc-file +Data type representing the Gitolite RC file. + +@table @asis +@item @code{umask} (default: @code{#o0077}) +This controls the permissions Gitolite sets on the repositories and their +contents. + +A value like @code{#o0027} will give read access to the group used by +Gitolite (by default: @code{git}). This is necessary when using Gitolite +with software like cgit or gitweb. + +@item @code{git-config-keys} (default: @code{""}) +Gitolite allows you to set git config values using the "config" +keyword. This setting allows control over the config keys to accept. + +@item @code{roles} (default: @code{'(("READERS" . 1) ("WRITERS" . ))}) +Set the role names allowed to be used by users running the perms command. + +@item @code{enable} (default: @code{'("help" "desc" "info" "perms" "writable" "ssh-authkeys" "git-config" "daemon" "gitweb")}) +This setting controls the commands and features to enable within Gitolite. + +@end table +@end deftp + + +@node Spieldienste +@subsubsection Spieldienste + +@subsubheading The Battle for Wesnoth Service +@cindex wesnothd +@uref{https://wesnoth.org, The Battle for Wesnoth} is a fantasy, turn based +tactical strategy game, with several single player campaigns, and +multiplayer games (both networked and local). + +@defvar {Scheme Variable} wesnothd-service-type +Service type for the wesnothd service. Its value must be a +@code{wesnothd-configuration} object. To run wesnothd in the default +configuration, instantiate it as: + +@example +(service wesnothd-service-type) +@end example +@end defvar + +@deftp {Data Type} wesnothd-configuration +Data type representing the configuration of @command{wesnothd}. + +@table @asis +@item @code{package} (default: @code{wesnoth-server}) +The wesnoth server package to use. + +@item @code{port} (default: @code{15000}) +The port to bind the server to. +@end table +@end deftp + +@node Verschiedene Dienste +@subsubsection Verschiedene Dienste + +@cindex fingerprint +@subsubheading Fingerprint Service + +The @code{(gnu services fingerprint)} module provides a DBus service to read +and identify fingerprints via a fingerprint sensor. + +@defvr {Scheme Variable} fprintd-service-type +The service type for @command{fprintd}, which provides the fingerprint +reading capability. + +@example +(service fprintd-service-type) +@end example +@end defvr + +@cindex sysctl +@subsubheading System Control Service + +The @code{(gnu services sysctl)} provides a service to configure kernel +parameters at boot. + +@defvr {Scheme Variable} sysctl-service-type +The service type for @command{sysctl}, which modifies kernel parameters +under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated +as: + +@example +(service sysctl-service-type + (sysctl-configuration + (settings '(("net.ipv4.ip_forward" . "1"))))) +@end example +@end defvr + +@deftp {Data Type} sysctl-configuration +The data type representing the configuration of @command{sysctl}. + +@table @asis +@item @code{sysctl} (default: @code{(file-append procps "/sbin/sysctl"}) +The @command{sysctl} executable to use. + +@item @code{settings} (default: @code{'()}) +An association list specifies kernel parameters and their values. +@end table +@end deftp + +@cindex pcscd +@subsubheading PC/SC Smart Card Daemon Service + +The @code{(gnu services security-token)} module provides the following +service to run @command{pcscd}, the PC/SC Smart Card Daemon. +@command{pcscd} is the daemon program for pcsc-lite and the MuscleCard +framework. It is a resource manager that coordinates communications with +smart card readers, smart cards and cryptographic tokens that are connected +to the system. + +@defvr {Scheme Variable} pcscd-service-type +Service type for the @command{pcscd} service. Its value must be a +@code{pcscd-configuration} object. To run pcscd in the default +configuration, instantiate it as: + +@example +(service pcscd-service-type) +@end example +@end defvr + +@deftp {Data Type} pcscd-configuration +The data type representing the configuration of @command{pcscd}. + +@table @asis +@item @code{pcsc-lite} (default: @code{pcsc-lite}) +The pcsc-lite package that provides pcscd. +@item @code{usb-drivers} (default: @code{(list ccid)}) +List of packages that provide USB drivers to pcscd. Drivers are expected to +be under @file{pcsc/drivers} in the store directory of the package. +@end table +@end deftp + +@cindex lirc +@subsubheading Lirc Service + +The @code{(gnu services lirc)} module provides the following service. + +@deffn {Scheme Procedure} lirc-service [#:lirc lirc] @ + [#:device #f] [#:driver #f] [#:config-file #f] @ [#:extra-options '()] +Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that +decodes infrared signals from remote controls. + +Optionally, @var{device}, @var{driver} and @var{config-file} (configuration +file name) may be specified. See @command{lircd} manual for details. + +Finally, @var{extra-options} is a list of additional command-line options +passed to @command{lircd}. +@end deffn + +@cindex spice +@subsubheading Spice Service + +The @code{(gnu services spice)} module provides the following service. + +@deffn {Scheme Procedure} spice-vdagent-service [#:spice-vdagent] +Returns a service that runs @url{http://www.spice-space.org,VDAGENT}, a +daemon that enables sharing the clipboard with a vm and setting the guest +display resolution when the graphical console window resizes. +@end deffn + +@subsubsection Dictionary Services +@cindex dictionary +The @code{(gnu services dict)} module provides the following service: + +@deffn {Scheme Procedure} dicod-service [#:config (dicod-configuration)] +Return a service that runs the @command{dicod} daemon, an implementation of +DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}). + +The optional @var{config} argument specifies the configuration for +@command{dicod}, which should be a @code{<dicod-configuration>} object, by +default it serves the GNU Collaborative International Dictonary of English. + +You can add @command{open localhost} to your @file{~/.dico} file to make +@code{localhost} the default server for @command{dico} client +(@pxref{Initialization File,,, dico, GNU Dico Manual}). +@end deffn + +@deftp {Data Type} dicod-configuration +Data type representing the configuration of dicod. + +@table @asis +@item @code{dico} (default: @var{dico}) +Package object of the GNU Dico dictionary server. + +@item @code{interfaces} (default: @var{'("localhost")}) +This is the list of IP addresses and ports and possibly socket file names to +listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico +Manual}). + +@item @code{handlers} (default: @var{'()}) +List of @code{<dicod-handler>} objects denoting handlers (module instances). + +@item @code{databases} (default: @var{(list %dicod-database:gcide)}) +List of @code{<dicod-database>} objects denoting dictionaries to be served. +@end table +@end deftp + +@deftp {Data Type} dicod-handler +Data type representing a dictionary handler (module instance). + +@table @asis +@item @code{name} +Name of the handler (module instance). + +@item @code{module} (default: @var{#f}) +Name of the dicod module of the handler (instance). If it is @code{#f}, the +module has the same name as the handler. (@pxref{Module,,, dico, GNU Dico +Manual}). + +@item @code{options} +List of strings or gexps representing the arguments for the module handler +@end table +@end deftp + +@deftp {Data Type} dicod-database +Data type representing a dictionary database. + +@table @asis +@item @code{name} +Name of the database, will be used in DICT commands. + +@item @code{handler} +Name of the dicod handler (module instance) used by this database +(@pxref{Handlers,,, dico, GNU Dico Manual}). + +@item @code{complex?} (default: @var{#f}) +Whether the database configuration complex. The complex configuration will +need a corresponding @code{<dicod-handler>} object, otherwise not. + +@item @code{options} +List of strings or gexps representing the arguments for the database +(@pxref{Databases,,, dico, GNU Dico Manual}). +@end table +@end deftp + +@defvr {Scheme Variable} %dicod-database:gcide +A @code{<dicod-database>} object serving the GNU Collaborative International +Dictionary of English using the @code{gcide} package. +@end defvr + +The following is an example @code{dicod-service} configuration. + +@example +(dicod-service #:config + (dicod-configuration + (handlers (list (dicod-handler + (name "wordnet") + (module "dictorg") + (options + (list #~(string-append "dbdir=" #$wordnet)))))) + (databases (list (dicod-database + (name "wordnet") + (complex? #t) + (handler "wordnet") + (options '("database=wn"))) + %dicod-database:gcide)))) +@end example + +@node Setuid-Programme +@subsection Setuid-Programme + +@cindex setuid programs +Some programs need to run with ``root'' privileges, even when they are +launched by unprivileged users. A notorious example is the @command{passwd} +program, which users can run to change their password, and which needs to +access the @file{/etc/passwd} and @file{/etc/shadow} files---something +normally restricted to root, for obvious security reasons. To address that, +these executables are @dfn{setuid-root}, meaning that they always run with +root privileges (@pxref{How Change Persona,,, libc, The GNU C Library +Reference Manual}, for more info about the setuid mechanism.) + +The store itself @emph{cannot} contain setuid programs: that would be a +security issue since any user on the system can write derivations that +populate the store (@pxref{Der Store}). Thus, a different mechanism is +used: instead of changing the setuid bit directly on files that are in the +store, we let the system administrator @emph{declare} which programs should +be setuid root. + +The @code{setuid-programs} field of an @code{operating-system} declaration +contains a list of G-expressions denoting the names of programs to be +setuid-root (@pxref{Das Konfigurationssystems nutzen}). For instance, the +@command{passwd} program, which is part of the Shadow package, can be +designated by this G-expression (@pxref{G-Ausdrücke}): + +@example +#~(string-append #$shadow "/bin/passwd") +@end example + +A default set of setuid programs is defined by the @code{%setuid-programs} +variable of the @code{(gnu system)} module. + +@defvr {Scheme Variable} %setuid-programs +A list of G-expressions denoting common programs that are setuid-root. + +The list includes commands such as @command{passwd}, @command{ping}, +@command{su}, and @command{sudo}. +@end defvr + +Under the hood, the actual setuid programs are created in the +@file{/run/setuid-programs} directory at system activation time. The files +in this directory refer to the ``real'' binaries, which are in the store. + +@node X.509-Zertifikate +@subsection X.509-Zertifikate + +@cindex HTTPS, certificates +@cindex X.509 certificates +@cindex TLS +Web servers available over HTTPS (that is, HTTP over the transport-layer +security mechanism, TLS) send client programs an @dfn{X.509 certificate} +that the client can then use to @emph{authenticate} the server. To do that, +clients verify that the server's certificate is signed by a so-called +@dfn{certificate authority} (CA). But to verify the CA's signature, clients +must have first acquired the CA's certificate. + +Web browsers such as GNU@tie{}IceCat include their own set of CA +certificates, such that they are able to verify CA signatures +out-of-the-box. + +However, most other programs that can talk HTTPS---@command{wget}, +@command{git}, @command{w3m}, etc.---need to be told where CA certificates +can be found. + +@cindex @code{nss-certs} +In GuixSD, this is done by adding a package that provides certificates to +the @code{packages} field of the @code{operating-system} declaration +(@pxref{„operating-system“-Referenz}). GuixSD includes one such package, +@code{nss-certs}, which is a set of CA certificates provided as part of +Mozilla's Network Security Services. + +Note that it is @emph{not} part of @var{%base-packages}, so you need to +explicitly add it. The @file{/etc/ssl/certs} directory, which is where most +applications and libraries look for certificates by default, points to the +certificates installed globally. + +Unprivileged users, including users of Guix on a foreign distro, can also +install their own certificate package in their profile. A number of +environment variables need to be defined so that applications and libraries +know where to find them. Namely, the OpenSSL library honors the +@code{SSL_CERT_DIR} and @code{SSL_CERT_FILE} variables. Some applications +add their own environment variables; for instance, the Git version control +system honors the certificate bundle pointed to by the @code{GIT_SSL_CAINFO} +environment variable. Thus, you would typically run something like: + +@example +$ guix package -i nss-certs +$ export SSL_CERT_DIR="$HOME/.guix-profile/etc/ssl/certs" +$ export SSL_CERT_FILE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt" +$ export GIT_SSL_CAINFO="$SSL_CERT_FILE" +@end example + +As another example, R requires the @code{CURL_CA_BUNDLE} environment +variable to point to a certificate bundle, so you would have to run +something like this: + +@example +$ guix package -i nss-certs +$ export CURL_CA_BUNDLE="$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt" +@end example + +For other applications you may want to look up the required environment +variable in the relevant documentation. + + +@node Name Service Switch +@subsection Name Service Switch + +@cindex name service switch +@cindex NSS +The @code{(gnu system nss)} module provides bindings to the configuration +file of the libc @dfn{name service switch} or @dfn{NSS} (@pxref{NSS +Configuration File,,, libc, The GNU C Library Reference Manual}). In a +nutshell, the NSS is a mechanism that allows libc to be extended with new +``name'' lookup methods for system databases, which includes host names, +service names, user accounts, and more (@pxref{Name Service Switch, System +Databases and Name Service Switch,, libc, The GNU C Library Reference +Manual}). + +The NSS configuration specifies, for each system database, which lookup +method is to be used, and how the various methods are chained together---for +instance, under which circumstances NSS should try the next method in the +list. The NSS configuration is given in the @code{name-service-switch} +field of @code{operating-system} declarations (@pxref{„operating-system“-Referenz, @code{name-service-switch}}). + +@cindex nss-mdns +@cindex .local, host name lookup +As an example, the declaration below configures the NSS to use the +@uref{http://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} +back-end}, which supports host name lookups over multicast DNS (mDNS) for +host names ending in @code{.local}: + +@example +(name-service-switch + (hosts (list %files ;first, check /etc/hosts + + ;; If the above did not succeed, try + ;; with 'mdns_minimal'. + (name-service + (name "mdns_minimal") + + ;; 'mdns_minimal' is authoritative for + ;; '.local'. When it returns "not found", + ;; no need to try the next methods. + (reaction (lookup-specification + (not-found => return)))) + + ;; Then fall back to DNS. + (name-service + (name "dns")) + + ;; Finally, try with the "full" 'mdns'. + (name-service + (name "mdns"))))) +@end example + +Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) +contains this configuration, so you will not have to type it if all you want +is to have @code{.local} host lookup working. + +Note that, in this case, in addition to setting the +@code{name-service-switch} of the @code{operating-system} declaration, you +also need to use @code{avahi-service} (@pxref{Netzwerkdienste, +@code{avahi-service}}), or @var{%desktop-services}, which includes it +(@pxref{Desktop-Dienste}). Doing this makes @code{nss-mdns} accessible to +the name service cache daemon (@pxref{Basisdienste, @code{nscd-service}}). + +For convenience, the following variables provide typical NSS configurations. + +@defvr {Scheme Variable} %default-nss +This is the default name service switch configuration, a +@code{name-service-switch} object. +@end defvr + +@defvr {Scheme Variable} %mdns-host-lookup-nss +This is the name service switch configuration with support for host name +lookup over multicast DNS (mDNS) for host names ending in @code{.local}. +@end defvr + +The reference for name service switch configuration is given below. It is a +direct mapping of the configuration file format of the C library , so please +refer to the C library manual for more information (@pxref{NSS Configuration +File,,, libc, The GNU C Library Reference Manual}). Compared to the +configuration file format of libc NSS, it has the advantage not only of +adding this warm parenthetic feel that we like, but also static checks: you +will know about syntax errors and typos as soon as you run @command{guix +system}. + +@deftp {Data Type} name-service-switch + +This is the data type representation the configuration of libc's name +service switch (NSS). Each field below represents one of the supported +system databases. + +@table @code +@item aliases +@itemx ethers +@itemx group +@itemx gshadow +@itemx hosts +@itemx initgroups +@itemx netgroup +@itemx networks +@itemx password +@itemx public-key +@itemx rpc +@itemx services +@itemx shadow +The system databases handled by the NSS. Each of these fields must be a +list of @code{<name-service>} objects (see below). +@end table +@end deftp + +@deftp {Data Type} name-service + +This is the data type representing an actual name service and the associated +lookup action. + +@table @code +@item name +A string denoting the name service (@pxref{Services in the NSS +configuration,,, libc, The GNU C Library Reference Manual}). + +Note that name services listed here must be visible to nscd. This is +achieved by passing the @code{#:name-services} argument to +@code{nscd-service} the list of packages providing the needed name services +(@pxref{Basisdienste, @code{nscd-service}}). + +@item reaction +An action specified using the @code{lookup-specification} macro +(@pxref{Actions in the NSS configuration,,, libc, The GNU C Library +Reference Manual}). For example: + +@example +(lookup-specification (unavailable => continue) + (success => return)) +@end example +@end table +@end deftp + +@node Initiale RAM-Disk +@subsection Initiale RAM-Disk + +@cindex initrd +@cindex initial RAM disk +For bootstrapping purposes, the Linux-Libre kernel is passed an @dfn{initial +RAM disk}, or @dfn{initrd}. An initrd contains a temporary root file system +as well as an initialization script. The latter is responsible for mounting +the real root file system, and for loading any kernel modules that may be +needed to achieve that. + +The @code{initrd-modules} field of an @code{operating-system} declaration +allows you to specify Linux-libre kernel modules that must be available in +the initrd. In particular, this is where you would list modules needed to +actually drive the hard disk where your root partition is---although the +default value of @code{initrd-modules} should cover most use cases. For +example, assuming you need the @code{megaraid_sas} module in addition to the +default modules to be able to access your root file system, you would write: + +@example +(operating-system + ;; @dots{} + (initrd-modules (cons "megaraid_sas" %base-initrd-modules))) +@end example + +@defvr {Scheme Variable} %base-initrd-modules +This is the list of kernel modules included in the initrd by default. +@end defvr + +Furthermore, if you need lower-level customization, the @code{initrd} field +of an @code{operating-system} declaration allows you to specify which initrd +you would like to use. The @code{(gnu system linux-initrd)} module provides +three ways to build an initrd: the high-level @code{base-initrd} procedure +and the low-level @code{raw-initrd} and @code{expression->initrd} +procedures. + +The @code{base-initrd} procedure is intended to cover most common uses. For +example, if you want to add a bunch of kernel modules to be loaded at boot +time, you can define the @code{initrd} field of the operating system +declaration like this: + +@example +(initrd (lambda (file-systems . rest) + ;; Create a standard initrd but set up networking + ;; with the parameters QEMU expects by default. + (apply base-initrd file-systems + #:qemu-networking? #t + rest))) +@end example + +The @code{base-initrd} procedure also handles common use cases that involves +using the system as a QEMU guest, or as a ``live'' system with volatile root +file system. + +The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. +Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, +such as trying to guess which kernel modules and packages should be included +to the initrd. An example use of @code{raw-initrd} is when a user has a +custom Linux kernel configuration and default kernel modules included by +@code{base-initrd} are not available. + +The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} +honors several options passed on the Linux kernel command line (that is, +arguments passed @i{via} the @code{linux} command of GRUB, or the +@code{-append} option of QEMU), notably: + +@table @code +@item --load=@var{boot} +Tell the initial RAM disk to load @var{boot}, a file containing a Scheme +program, once it has mounted the root file system. + +GuixSD uses this option to yield control to a boot program that runs the +service activation programs and then spawns the GNU@tie{}Shepherd, the +initialization system. + +@item --root=@var{root} +Mount @var{root} as the root file system. @var{root} can be a device name +like @code{/dev/sda1}, a file system label, or a file system UUID. + +@item --system=@var{System} +Have @file{/run/booted-system} and @file{/run/current-system} point to +@var{system}. + +@item modprobe.blacklist=@var{modules}@dots{} +@cindex module, black-listing +@cindex black list, of kernel modules +Instruct the initial RAM disk as well as the @command{modprobe} command +(from the kmod package) to refuse to load @var{modules}. @var{modules} must +be a comma-separated list of module names---e.g., @code{usbkbd,9pnet}. + +@item --repl +Start a read-eval-print loop (REPL) from the initial RAM disk before it +tries to load kernel modules and to mount the root file system. Our +marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will love +it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}, +for more information on Guile's REPL. + +@end table + +Now that you know all the features that initial RAM disks produced by +@code{base-initrd} and @code{raw-initrd} provide, here is how to use it and +customize it further. + +@cindex initrd +@cindex initial RAM disk +@deffn {Monadic Procedure} raw-initrd @var{file-systems} @ + [#:linux-modules '()] [#:mapped-devices '()] @ [#:helper-packages '()] +[#:qemu-networking? #f] [#:volatile-root? #f] Return a monadic derivation +that builds a raw initrd. @var{file-systems} is a list of file systems to +be mounted by the initrd, possibly in addition to the root file system +specified on the kernel command line via @code{--root}. @var{linux-modules} +is a list of kernel modules to be loaded at boot time. @var{mapped-devices} +is a list of device mappings to realize before @var{file-systems} are +mounted (@pxref{Abgebildete Geräte}). @var{helper-packages} is a list of +packages to be copied in the initrd. It may include @code{e2fsck/static} or +other packages needed by the initrd to check the root file system. + +When @var{qemu-networking?} is true, set up networking with the standard +QEMU parameters. When @var{virtio?} is true, load additional modules so +that the initrd can be used as a QEMU guest with para-virtualized I/O +drivers. + +When @var{volatile-root?} is true, the root file system is writable but any +changes to it are lost. +@end deffn + +@deffn {Monadic Procedure} base-initrd @var{file-systems} @ + [#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]@ +[#:linux-modules '()] Return a monadic derivation that builds a generic +initrd, with kernel modules taken from @var{linux}. @var{file-systems} is a +list of file-systems to be mounted by the initrd, possibly in addition to +the root file system specified on the kernel command line via +@code{--root}. @var{mapped-devices} is a list of device mappings to realize +before @var{file-systems} are mounted. + +@var{qemu-networking?} and @var{volatile-root?} behaves as in +@code{raw-initrd}. + +The initrd is automatically populated with all the kernel modules necessary +for @var{file-systems} and for the given options. Additional kernel modules +can be listed in @var{linux-modules}. They will be added to the initrd, and +loaded at boot time in the order in which they appear. +@end deffn + +Needless to say, the initrds we produce and use embed a statically-linked +Guile, and the initialization program is a Guile program. That gives a lot +of flexibility. The @code{expression->initrd} procedure builds such an +initrd, given the program to run in that initrd. + +@deffn {Monadic Procedure} expression->initrd @var{exp} @ + [#:guile %guile-static-stripped] [#:name "guile-initrd"] Return a derivation +that builds a Linux initrd (a gzipped cpio archive) containing @var{guile} +and that evaluates @var{exp}, a G-expression, upon booting. All the +derivations referenced by @var{exp} are automatically copied to the initrd. +@end deffn + +@node Bootloader-Konfiguration +@subsection Bootloader-Konfiguration + +@cindex bootloader +@cindex boot loader + +The operating system supports multiple bootloaders. The bootloader is +configured using @code{bootloader-configuration} declaration. All the +fields of this structure are bootloader agnostic except for one field, +@code{bootloader} that indicates the bootloader to be configured and +installed. + +Some of the bootloaders do not honor every field of +@code{bootloader-configuration}. For instance, the extlinux bootloader does +not support themes and thus ignores the @code{theme} field. + +@deftp {Data Type} bootloader-configuration +The type of a bootloader configuration declaration. + +@table @asis + +@item @code{bootloader} +@cindex EFI, bootloader +@cindex UEFI, bootloader +@cindex BIOS, bootloader +The bootloader to use, as a @code{bootloader} object. For now +@code{grub-bootloader}, @code{grub-efi-bootloader}, +@code{extlinux-bootloader} and @code{u-boot-bootloader} are supported. + +@vindex grub-efi-bootloader +@code{grub-efi-bootloader} allows to boot on modern systems using the +@dfn{Unified Extensible Firmware Interface} (UEFI). This is what you should +use if the installation image contains a @file{/sys/firmware/efi} directory +when you boot it on your system. + +@vindex grub-bootloader +@code{grub-bootloader} allows you to boot in particular Intel-based machines +in ``legacy'' BIOS mode. + +@cindex ARM, bootloaders +@cindex AArch64, bootloaders +Available bootloaders are described in @code{(gnu bootloader @dots{})} +modules. In particular, @code{(gnu bootloader u-boot)} contains definitions +of bootloaders for a wide range of ARM and AArch64 systems, using the +@uref{http://www.denx.de/wiki/U-Boot/, U-Boot bootloader}. + +@item @code{target} +This is a string denoting the target onto which to install the bootloader. + +The interpretation depends on the bootloader in question. For +@code{grub-bootloader}, for example, it should be a device name understood +by the bootloader @command{installer} command, such as @code{/dev/sda} or +@code{(hd0)} (@pxref{Invoking grub-install,,, grub, GNU GRUB Manual}). For +@code{grub-efi-bootloader}, it should be the mount point of the EFI file +system, usually @file{/boot/efi}. + +@item @code{menu-entries} (default: @code{()}) +A possibly empty list of @code{menu-entry} objects (see below), denoting +entries to appear in the bootloader menu, in addition to the current system +entry and the entry pointing to previous system generations. + +@item @code{default-entry} (default: @code{0}) +The index of the default boot menu entry. Index 0 is for the entry of the +current system. + +@item @code{timeout} (default: @code{5}) +The number of seconds to wait for keyboard input before booting. Set to 0 +to boot immediately, and to -1 to wait indefinitely. + +@item @code{theme} (default: @var{#f}) +The bootloader theme object describing the theme to use. If no theme is +provided, some bootloaders might use a default theme, that's true for GRUB. + +@item @code{terminal-outputs} (default: @code{'gfxterm}) +The output terminals used for the bootloader boot menu, as a list of +symbols. GRUB accepts the values: @code{console}, @code{serial}, +@code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, +@code{morse}, and @code{pkmodem}. This field corresponds to the GRUB +variable @code{GRUB_TERMINAL_OUTPUT} (@pxref{Simple configuration,,, +grub,GNU GRUB manual}). + +@item @code{terminal-inputs} (default: @code{'()}) +The input terminals used for the bootloader boot menu, as a list of +symbols. For GRUB, the default is the native platform terminal as +determined at run-time. GRUB accepts the values: @code{console}, +@code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and +@code{usb_keyboard}. This field corresponds to the GRUB variable +@code{GRUB_TERMINAL_INPUT} (@pxref{Simple configuration,,, grub,GNU GRUB +manual}). + +@item @code{serial-unit} (default: @code{#f}) +The serial unit used by the bootloader, as an integer from 0 to 3. For +GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds +to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual}). + +@item @code{serial-speed} (default: @code{#f}) +The speed of the serial interface, as an integer. For GRUB, the default +value is chosen at run-time; currently GRUB chooses 9600@tie{}bps +(@pxref{Serial terminal,,, grub,GNU GRUB manual}). +@end table + +@end deftp + +@cindex dual boot +@cindex boot menu +Should you want to list additional boot menu entries @i{via} the +@code{menu-entries} field above, you will need to create them with the +@code{menu-entry} form. For example, imagine you want to be able to boot +another distro (hard to imagine!), you can define a menu entry along these +lines: + +@example +(menu-entry + (label "The Other Distro") + (linux "/boot/old/vmlinux-2.6.32") + (linux-arguments '("root=/dev/sda2")) + (initrd "/boot/old/initrd")) +@end example + +Details below. + +@deftp {Data Type} menu-entry +The type of an entry in the bootloader menu. + +@table @asis + +@item @code{label} +The label to show in the menu---e.g., @code{"GNU"}. + +@item @code{linux} +The Linux kernel image to boot, for example: + +@example +(file-append linux-libre "/bzImage") +@end example + +For GRUB, it is also possible to specify a device explicitly in the file +path using GRUB's device naming convention (@pxref{Naming convention,,, +grub, GNU GRUB manual}), for example: + +@example +"(hd0,msdos1)/boot/vmlinuz" +@end example + +If the device is specified explicitly as above, then the @code{device} field +is ignored entirely. + +@item @code{linux-arguments} (default: @code{()}) +The list of extra Linux kernel command-line arguments---e.g., +@code{("console=ttyS0")}. + +@item @code{initrd} +A G-Expression or string denoting the file name of the initial RAM disk to +use (@pxref{G-Ausdrücke}). +@item @code{device} (default: @code{#f}) +The device where the kernel and initrd are to be found---i.e., for GRUB, +@dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual}). + +This may be a file system label (a string), a file system UUID (a +bytevector, @pxref{Dateisysteme}), or @code{#f}, in which case the +bootloader will search the device containing the file specified by the +@code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It must +@emph{not} be an OS device name such as @file{/dev/sda1}. + +@end table +@end deftp + +@c FIXME: Write documentation once it's stable. +Fow now only GRUB has theme support. GRUB themes are created using the +@code{grub-theme} form, which is not documented yet. + +@defvr {Scheme Variable} %default-theme +This is the default GRUB theme used by the operating system if no +@code{theme} field is specified in @code{bootloader-configuration} record. + +It comes with a fancy background image displaying the GNU and Guix logos. +@end defvr + + +@node Aufruf von guix system +@subsection Invoking @code{guix system} + +Once you have written an operating system declaration as seen in the +previous section, it can be @dfn{instantiated} using the @command{guix +system} command. The synopsis is: + +@example +guix system @var{options}@dots{} @var{action} @var{file} +@end example + +@var{file} must be the name of a file containing an @code{operating-system} +declaration. @var{action} specifies how the operating system is +instantiated. Currently the following values are supported: + +@table @code +@item search +Display available service type definitions that match the given regular +expressions, sorted by relevance: + +@example +$ guix system search console font +name: console-fonts +location: gnu/services/base.scm:729:2 +extends: shepherd-root +description: Install the given fonts on the specified ttys (fonts are ++ per virtual console on GNU/Linux). The value of this service is a list ++ of tty/font pairs like: ++ ++ '(("tty1" . "LatGrkCyr-8x16")) +relevance: 20 + +name: mingetty +location: gnu/services/base.scm:1048:2 +extends: shepherd-root +description: Provide console login using the `mingetty' program. +relevance: 2 + +name: login +location: gnu/services/base.scm:775:2 +extends: pam +description: Provide a console log-in service as specified by its ++ configuration value, a `login-configuration' object. +relevance: 2 + +@dots{} +@end example + +As for @command{guix package --search}, the result is written in +@code{recutils} format, which makes it easy to filter the output +(@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual}). + +@item reconfigure +Build the operating system described in @var{file}, activate it, and switch +to it@footnote{This action (and the related actions @code{switch-generation} +and @code{roll-back}) are usable only on systems already running GuixSD.}. + +This effects all the configuration specified in @var{file}: user accounts, +system services, global package list, setuid programs, etc. The command +starts system services specified in @var{file} that are not currently +running; if a service is currently running this command will arrange for it +to be upgraded the next time it is stopped (eg. by @code{herd stop X} or +@code{herd restart X}). + +This command creates a new generation whose number is one greater than the +current generation (as reported by @command{guix system list-generations}). +If that generation already exists, it will be overwritten. This behavior +mirrors that of @command{guix package} (@pxref{Aufruf von guix package}). + +It also adds a bootloader menu entry for the new OS configuration, ---unless +@option{--no-bootloader} is passed. For GRUB, it moves entries for older +configurations to a submenu, allowing you to choose an older system +generation at boot time should you need it. + +@quotation Anmerkung +@c The paragraph below refers to the problem discussed at +@c <http://lists.gnu.org/archive/html/guix-devel/2014-08/msg00057.html>. +It is highly recommended to run @command{guix pull} once before you run +@command{guix system reconfigure} for the first time (@pxref{Aufruf von guix pull}). Failing to do that you would see an older version of Guix once +@command{reconfigure} has completed. +@end quotation + +@item switch-generation +@cindex Generationen +Switch to an existing system generation. This action atomically switches +the system profile to the specified system generation. It also rearranges +the system's existing bootloader menu entries. It makes the menu entry for +the specified system generation the default, and it moves the entries for +the other generatiors to a submenu, if supported by the bootloader being +used. The next time the system boots, it will use the specified system +generation. + +The bootloader itself is not being reinstalled when using this command. +Thus, the installed bootloader is used with an updated configuration file. + +The target generation can be specified explicitly by its generation number. +For example, the following invocation would switch to system generation 7: + +@example +guix system switch-generation 7 +@end example + +The target generation can also be specified relative to the current +generation with the form @code{+N} or @code{-N}, where @code{+3} means ``3 +generations ahead of the current generation,'' and @code{-1} means ``1 +generation prior to the current generation.'' When specifying a negative +value such as @code{-1}, you must precede it with @code{--} to prevent it +from being parsed as an option. For example: + +@example +guix system switch-generation -- -1 +@end example + +Currently, the effect of invoking this action is @emph{only} to switch the +system profile to an existing generation and rearrange the bootloader menu +entries. To actually start using the target system generation, you must +reboot after running this action. In the future, it will be updated to do +the same things as @command{reconfigure}, like activating and deactivating +services. + +This action will fail if the specified generation does not exist. + +@item roll-back +@cindex rücksetzen +Switch to the preceding system generation. The next time the system boots, +it will use the preceding system generation. This is the inverse of +@command{reconfigure}, and it is exactly the same as invoking +@command{switch-generation} with an argument of @code{-1}. + +Currently, as with @command{switch-generation}, you must reboot after +running this action to actually start using the preceding system generation. + +@item build +Build the derivation of the operating system, which includes all the +configuration files and programs needed to boot and run the system. This +action does not actually install anything. + +@item init +Populate the given directory with all the files necessary to run the +operating system specified in @var{file}. This is useful for first-time +installations of GuixSD. For instance: + +@example +guix system init my-os-config.scm /mnt +@end example + +copies to @file{/mnt} all the store items required by the configuration +specified in @file{my-os-config.scm}. This includes configuration files, +packages, and so on. It also creates other essential files needed for the +system to operate correctly---e.g., the @file{/etc}, @file{/var}, and +@file{/run} directories, and the @file{/bin/sh} file. + +This command also installs bootloader on the target specified in +@file{my-os-config}, unless the @option{--no-bootloader} option was passed. + +@item vm +@cindex virtual machine +@cindex VM +@anchor{guix system vm} +Build a virtual machine that contains the operating system declared in +@var{file}, and return a script to run that virtual machine (VM). Arguments +given to the script are passed to QEMU as in the example below, which +enables networking and requests 1@tie{}GiB of RAM for the emulated machine: + +@example +$ /gnu/store/@dots{}-run-vm.sh -m 1024 -net user +@end example + +The VM shares its store with the host system. + +Additional file systems can be shared between the host and the VM using the +@code{--share} and @code{--expose} command-line options: the former +specifies a directory to be shared with write access, while the latter +provides read-only access to the shared directory. + +The example below creates a VM in which the user's home directory is +accessible read-only, and where the @file{/exchange} directory is a +read-write mapping of @file{$HOME/tmp} on the host: + +@example +guix system vm my-config.scm \ + --expose=$HOME --share=$HOME/tmp=/exchange +@end example + +On GNU/Linux, the default is to boot directly to the kernel; this has the +advantage of requiring only a very tiny root disk image since the store of +the host can then be mounted. + +The @code{--full-boot} option forces a complete boot sequence, starting with +the bootloader. This requires more disk space since a root image containing +at least the kernel, initrd, and bootloader data files must be created. The +@code{--image-size} option can be used to specify the size of the image. + +@cindex System images, creation in various formats +@cindex Creating system images in various formats +@item vm-image +@itemx disk-image +@itemx docker-image +Return a virtual machine, disk image, or Docker image of the operating +system declared in @var{file} that stands alone. By default, @command{guix +system} estimates the size of the image needed to store the system, but you +can use the @option{--image-size} option to specify a value. Docker images +are built to contain exactly what they need, so the @option{--image-size} +option is ignored in the case of @code{docker-image}. + +You can specify the root file system type by using the +@option{--file-system-type} option. It defaults to @code{ext4}. + +When using @code{vm-image}, the returned image is in qcow2 format, which the +QEMU emulator can efficiently use. @xref{GuixSD in einer VM starten}, for more +information on how to run the image in a virtual machine. + +When using @code{disk-image}, a raw disk image is produced; it can be copied +as is to a USB stick, for instance. Assuming @code{/dev/sdc} is the device +corresponding to a USB stick, one can copy the image to it using the +following command: + +@example +# dd if=$(guix system disk-image my-os.scm) of=/dev/sdc +@end example + +When using @code{docker-image}, a Docker image is produced. Guix builds the +image from scratch, not from a pre-existing Docker base image. As a result, +it contains @emph{exactly} what you define in the operating system +configuration file. You can then load the image and launch a Docker +container using commands like the following: + +@example +image_id="$(docker load < guixsd-docker-image.tar.gz)" +docker run -e GUIX_NEW_SYSTEM=/var/guix/profiles/system \\ + --entrypoint /var/guix/profiles/system/profile/bin/guile \\ + $image_id /var/guix/profiles/system/boot +@end example + +This command starts a new Docker container from the specified image. It +will boot the GuixSD system in the usual manner, which means it will start +any services you have defined in the operating system configuration. +Depending on what you run in the Docker container, it may be necessary to +give the container additional permissions. For example, if you intend to +build software using Guix inside of the Docker container, you may need to +pass the @option{--privileged} option to @code{docker run}. + +@item container +Return a script to run the operating system declared in @var{file} within a +container. Containers are a set of lightweight isolation mechanisms +provided by the kernel Linux-libre. Containers are substantially less +resource-demanding than full virtual machines since the kernel, shared +objects, and other resources can be shared with the host system; this also +means they provide thinner isolation. + +Currently, the script must be run as root in order to support more than a +single user and group. The container shares its store with the host system. + +As with the @code{vm} action (@pxref{guix system vm}), additional file +systems to be shared between the host and container can be specified using +the @option{--share} and @option{--expose} options: + +@example +guix system container my-config.scm \ + --expose=$HOME --share=$HOME/tmp=/exchange +@end example + +@quotation Anmerkung +This option requires Linux-libre 3.19 or newer. +@end quotation + +@end table + +@var{options} can contain any of the common build options (@pxref{Gemeinsame Erstellungsoptionen}). In addition, @var{options} can contain one of the +following: + +@table @option +@item --expression=@var{expr} +@itemx -e @var{expr} +Consider the operating-system @var{expr} evaluates to. This is an +alternative to specifying a file which evaluates to an operating system. +This is used to generate the GuixSD installer @pxref{Ein Abbild zur Installation erstellen}). + +@item --system=@var{System} +@itemx -s @var{system} +Attempt to build for @var{system} instead of the host system type. This +works as per @command{guix build} (@pxref{Aufruf von guix build}). + +@item --derivation +@itemx -d +Return the derivation file name of the given operating system without +building anything. + +@item --file-system-type=@var{type} +@itemx -t @var{type} +For the @code{disk-image} action, create a file system of the given +@var{type} on the image. + +When this option is omitted, @command{guix system} uses @code{ext4}. + +@cindex ISO-9660 format +@cindex CD image format +@cindex DVD image format +@code{--file-system-type=iso9660} produces an ISO-9660 image, suitable for +burning on CDs and DVDs. + +@item --image-size=@var{size} +For the @code{vm-image} and @code{disk-image} actions, create an image of +the given @var{size}. @var{size} may be a number of bytes, or it may +include a unit as a suffix (@pxref{Block size, size specifications,, +coreutils, GNU Coreutils}). + +When this option is omitted, @command{guix system} computes an estimate of +the image size as a function of the size of the system declared in +@var{file}. + +@item --root=@var{file} +@itemx -r @var{file} +Make @var{file} a symlink to the result, and register it as a garbage +collector root. + +@item --skip-checks +Skip pre-installation safety checks. + +By default, @command{guix system init} and @command{guix system reconfigure} +perform safety checks: they make sure the file systems that appear in the +@code{operating-system} declaration actually exist (@pxref{Dateisysteme}), +and that any Linux kernel modules that may be needed at boot time are listed +in @code{initrd-modules} (@pxref{Initiale RAM-Disk}). Passing this option +skips these tests altogether. + +@item --on-error=@var{strategy} +Apply @var{strategy} when an error occurs when reading @var{file}. +@var{strategy} may be one of the following: + +@table @code +@item nothing-special +Report the error concisely and exit. This is the default strategy. + +@item backtrace +Likewise, but also display a backtrace. + +@item debug +Report the error and enter Guile's debugger. From there, you can run +commands such as @code{,bt} to get a backtrace, @code{,locals} to display +local variable values, and more generally inspect the state of the program. +@xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for a list of +available debugging commands. +@end table +@end table + +@quotation Anmerkung +All the actions above, except @code{build} and @code{init}, can use KVM +support in the Linux-libre kernel. Specifically, if the machine has +hardware virtualization support, the corresponding KVM kernel module should +be loaded, and the @file{/dev/kvm} device node must exist and be readable +and writable by the user and by the build users of the daemon (@pxref{Einrichten der Erstellungsumgebung}). +@end quotation + +Once you have built, configured, re-configured, and re-re-configured your +GuixSD installation, you may find it useful to list the operating system +generations available on disk---and that you can choose from the bootloader +boot menu: + +@table @code + +@item list-generations +List a summary of each generation of the operating system available on disk, +in a human-readable way. This is similar to the @option{--list-generations} +option of @command{guix package} (@pxref{Aufruf von guix package}). + +Optionally, one can specify a pattern, with the same syntax that is used in +@command{guix package --list-generations}, to restrict the list of +generations displayed. For instance, the following command displays +generations that are up to 10 days old: + +@example +$ guix system list-generations 10d +@end example + +@end table + +The @command{guix system} command has even more to offer! The following +sub-commands allow you to visualize how your system services relate to each +other: + +@anchor{system-extension-graph} +@table @code + +@item extension-graph +Emit in Dot/Graphviz format to standard output the @dfn{service extension +graph} of the operating system defined in @var{file} (@pxref{Dienstkompositionen}, for more information on service extensions.) + +The command: + +@example +$ guix system extension-graph @var{file} | dot -Tpdf > services.pdf +@end example + +produces a PDF file showing the extension relations among services. + +@anchor{system-shepherd-graph} +@item shepherd-graph +Emit in Dot/Graphviz format to standard output the @dfn{dependency graph} of +shepherd services of the operating system defined in @var{file}. +@xref{Shepherd-Dienste}, for more information and for an example graph. + +@end table + +@node GuixSD in einer VM starten +@subsection Running GuixSD in a Virtual Machine + +@cindex virtual machine +To run GuixSD in a virtual machine (VM), one can either use the pre-built +GuixSD VM image distributed at +@indicateurl{https://alpha.gnu.org/gnu/guix/guixsd-vm-image-@value{VERSION}.@var{system}.xz} +, or build their own virtual machine image using @command{guix system +vm-image} (@pxref{Aufruf von guix system}). The returned image is in qcow2 +format, which the @uref{http://qemu.org/, QEMU emulator} can efficiently +use. + +@cindex QEMU +If you built your own image, you must copy it out of the store (@pxref{Der Store}) and give yourself permission to write to the copy before you can use +it. When invoking QEMU, you must choose a system emulator that is suitable +for your hardware platform. Here is a minimal QEMU invocation that will +boot the result of @command{guix system vm-image} on x86_64 hardware: + +@example +$ qemu-system-x86_64 \ + -net user -net nic,model=virtio \ + -enable-kvm -m 256 /tmp/qemu-image +@end example + +Here is what each of these options means: + +@table @code +@item qemu-system-x86_64 +This specifies the hardware platform to emulate. This should match the +host. + +@item -net user +Enable the unprivileged user-mode network stack. The guest OS can access +the host but not vice versa. This is the simplest way to get the guest OS +online. + +@item -net nic,model=virtio +You must create a network interface of a given model. If you do not create +a NIC, the boot will fail. Assuming your hardware platform is x86_64, you +can get a list of available NIC models by running +@command{qemu-system-x86_64 -net nic,model=help}. + +@item -enable-kvm +If your system has hardware virtualization extensions, enabling the virtual +machine support (KVM) of the Linux kernel will make things run faster. + +@item -m 256 +RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, +which may be insufficient for some operations. + +@item /tmp/qemu-image +The file name of the qcow2 image. +@end table + +The default @command{run-vm.sh} script that is returned by an invocation of +@command{guix system vm} does not add a @command{-net user} flag by +default. To get network access from within the vm add the +@code{(dhcp-client-service)} to your system definition and start the VM +using @command{`guix system vm config.scm` -net user}. An important caveat +of using @command{-net user} for networking is that @command{ping} will not +work, because it uses the ICMP protocol. You'll have to use a different +command to check for network connectivity, for example @command{guix +download}. + +@subsubsection Connecting Through SSH + +@cindex SSH +@cindex SSH server +To enable SSH inside a VM you need to add a SSH server like +@code{(dropbear-service)} or @code{(lsh-service)} to your VM. The +@code{(lsh-service}) doesn't currently boot unsupervised. It requires you +to type some characters to initialize the randomness generator. In addition +you need to forward the SSH port, 22 by default, to the host. You can do +this with + +@example +`guix system vm config.scm` -net user,hostfwd=tcp::10022-:22 +@end example + +To connect to the VM you can run + +@example +ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022 +@end example + +The @command{-p} tells @command{ssh} the port you want to connect to. +@command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from +complaining every time you modify your @command{config.scm} file and the +@command{-o StrictHostKeyChecking=no} prevents you from having to allow a +connection to an unknown host every time you connect. + +@subsubsection Using @command{virt-viewer} with Spice + +As an alternative to the default @command{qemu} graphical client you can use +the @command{remote-viewer} from the @command{virt-viewer} package. To +connect pass the @command{-spice port=5930,disable-ticketing} flag to +@command{qemu}. See previous section for further information on how to do +this. + +Spice also allows you to do some nice stuff like share your clipboard with +your VM. To enable that you'll also have to pass the following flags to +@command{qemu}: + +@example +-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5 +-chardev spicevmc,name=vdagent,id=vdagent +-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent, +name=com.redhat.spice.0 +@end example + +You'll also need to add the @pxref{Verschiedene Dienste, Spice service}. + +@node Dienste definieren +@subsection Dienste definieren + +The previous sections show the available services and how one can combine +them in an @code{operating-system} declaration. But how do we define them +in the first place? And what is a service anyway? + +@menu +* Dienstkompositionen:: Wie Dienste zusammengestellt werden. +* Diensttypen und Dienste:: Typen und Dienste. +* Service-Referenz:: Referenz zur Programmierschnittstelle +* Shepherd-Dienste:: Eine spezielle Art von Dienst. +@end menu + +@node Dienstkompositionen +@subsubsection Dienstkompositionen + +@cindex services +@cindex daemons +Here we define a @dfn{service} as, broadly, something that extends the +functionality of the operating system. Often a service is a process---a +@dfn{daemon}---started when the system boots: a secure shell server, a Web +server, the Guix build daemon, etc. Sometimes a service is a daemon whose +execution can be triggered by another daemon---e.g., an FTP server started +by @command{inetd} or a D-Bus service activated by @command{dbus-daemon}. +Occasionally, a service does not map to a daemon. For instance, the +``account'' service collects user accounts and makes sure they exist when +the system runs; the ``udev'' service collects device management rules and +makes them available to the eudev daemon; the @file{/etc} service populates +the @file{/etc} directory of the system. + +@cindex service extensions +GuixSD services are connected by @dfn{extensions}. For instance, the secure +shell service @emph{extends} the Shepherd---the GuixSD initialization +system, running as PID@tie{}1---by giving it the command lines to start and +stop the secure shell daemon (@pxref{Netzwerkdienste, +@code{lsh-service}}); the UPower service extends the D-Bus service by +passing it its @file{.service} specification, and extends the udev service +by passing it device management rules (@pxref{Desktop-Dienste, +@code{upower-service}}); the Guix daemon service extends the Shepherd by +passing it the command lines to start and stop the daemon, and extends the +account service by passing it a list of required build user accounts +(@pxref{Basisdienste}). + +All in all, services and their ``extends'' relations form a directed acyclic +graph (DAG). If we represent services as boxes and extensions as arrows, a +typical system might provide something like this: + +@image{images/service-graph,,5in,Typical service extension graph.} + +@cindex system service +At the bottom, we see the @dfn{system service}, which produces the directory +containing everything to run and boot the system, as returned by the +@command{guix system build} command. @xref{Service-Referenz}, to learn +about the other service types shown here. @xref{system-extension-graph, the +@command{guix system extension-graph} command}, for information on how to +generate this representation for a particular operating system definition. + +@cindex service types +Technically, developers can define @dfn{service types} to express these +relations. There can be any number of services of a given type on the +system---for instance, a system running two instances of the GNU secure +shell server (lsh) has two instances of @var{lsh-service-type}, with +different parameters. + +The following section describes the programming interface for service types +and services. + +@node Diensttypen und Dienste +@subsubsection Diensttypen und Dienste + +A @dfn{service type} is a node in the DAG described above. Let us start +with a simple example, the service type for the Guix build daemon +(@pxref{Aufruf des guix-daemon}): + +@example +(define guix-service-type + (service-type + (name 'guix) + (extensions + (list (service-extension shepherd-root-service-type guix-shepherd-service) + (service-extension account-service-type guix-accounts) + (service-extension activation-service-type guix-activation))) + (default-value (guix-configuration)))) +@end example + +@noindent +It defines three things: + +@enumerate +@item +A name, whose sole purpose is to make inspection and debugging easier. + +@item +A list of @dfn{service extensions}, where each extension designates the +target service type and a procedure that, given the parameters of the +service, returns a list of objects to extend the service of that type. + +Every service type has at least one service extension. The only exception +is the @dfn{boot service type}, which is the ultimate service. + +@item +Optionally, a default value for instances of this type. +@end enumerate + +In this example, @var{guix-service-type} extends three services: + +@table @var +@item shepherd-root-service-type +The @var{guix-shepherd-service} procedure defines how the Shepherd service +is extended. Namely, it returns a @code{<shepherd-service>} object that +defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd-Dienste}). + +@item account-service-type +This extension for this service is computed by @var{guix-accounts}, which +returns a list of @code{user-group} and @code{user-account} objects +representing the build user accounts (@pxref{Aufruf des guix-daemon}). + +@item activation-service-type +Here @var{guix-activation} is a procedure that returns a gexp, which is a +code snippet to run at ``activation time''---e.g., when the service is +booted. +@end table + +A service of this type is instantiated like this: + +@example +(service guix-service-type + (guix-configuration + (build-accounts 5) + (use-substitutes? #f))) +@end example + +The second argument to the @code{service} form is a value representing the +parameters of this specific service instance. +@xref{guix-configuration-type, @code{guix-configuration}}, for information +about the @code{guix-configuration} data type. When the value is omitted, +the default value specified by @code{guix-service-type} is used: + +@example +(service guix-service-type) +@end example + +@var{guix-service-type} is quite simple because it extends other services +but is not extensible itself. + +@c @subsubsubsection Extensible Service Types + +The service type for an @emph{extensible} service looks like this: + +@example +(define udev-service-type + (service-type (name 'udev) + (extensions + (list (service-extension shepherd-root-service-type + udev-shepherd-service))) + + (compose concatenate) ;concatenate the list of rules + (extend (lambda (config rules) + (match config + (($ <udev-configuration> udev initial-rules) + (udev-configuration + (udev udev) ;the udev package to use + (rules (append initial-rules rules))))))))) +@end example + +This is the service type for the +@uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device management +daemon}. Compared to the previous example, in addition to an extension of +@var{shepherd-root-service-type}, we see two new fields: + +@table @code +@item compose +This is the procedure to @dfn{compose} the list of extensions to services of +this type. + +Services can extend the udev service by passing it lists of rules; we +compose those extensions simply by concatenating them. + +@item extend +This procedure defines how the value of the service is @dfn{extended} with +the composition of the extensions. + +Udev extensions are composed into a list of rules, but the udev service +value is itself a @code{<udev-configuration>} record. So here, we extend +that record by appending the list of rules it contains to the list of +contributed rules. + +@item description +This is a string giving an overview of the service type. The string can +contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The +@command{guix system search} command searches these strings and displays +them (@pxref{Aufruf von guix system}). +@end table + +There can be only one instance of an extensible service type such as +@var{udev-service-type}. If there were more, the @code{service-extension} +specifications would be ambiguous. + +Still here? The next section provides a reference of the programming +interface for services. + +@node Service-Referenz +@subsubsection Service-Referenz + +We have seen an overview of service types (@pxref{Diensttypen und Dienste}). This section provides a reference on how to manipulate services +and service types. This interface is provided by the @code{(gnu services)} +module. + +@deffn {Scheme Procedure} service @var{type} [@var{value}] +Return a new service of @var{type}, a @code{<service-type>} object (see +below.) @var{value} can be any object; it represents the parameters of this +particular service instance. + +When @var{value} is omitted, the default value specified by @var{type} is +used; if @var{type} does not specify a default value, an error is raised. + +For instance, this: + +@example +(service openssh-service-type) +@end example + +@noindent +is equivalent to this: + +@example +(service openssh-service-type + (openssh-configuration)) +@end example + +In both cases the result is an instance of @code{openssh-service-type} with +the default configuration. +@end deffn + +@deffn {Scheme Procedure} service? @var{obj} +Return true if @var{obj} is a service. +@end deffn + +@deffn {Scheme Procedure} service-kind @var{service} +Return the type of @var{service}---i.e., a @code{<service-type>} object. +@end deffn + +@deffn {Scheme Procedure} service-value @var{service} +Return the value associated with @var{service}. It represents its +parameters. +@end deffn + +Here is an example of how a service is created and manipulated: + +@example +(define s + (service nginx-service-type + (nginx-configuration + (nginx nginx) + (log-directory log-directory) + (run-directory run-directory) + (file config-file)))) + +(service? s) +@result{} #t + +(eq? (service-kind s) nginx-service-type) +@result{} #t +@end example + +The @code{modify-services} form provides a handy way to change the +parameters of some of the services of a list such as @var{%base-services} +(@pxref{Basisdienste, @code{%base-services}}). It evaluates to a list of +services. Of course, you could always use standard list combinators such as +@code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, +GNU Guile Reference Manual}); @code{modify-services} simply provides a more +concise form for this common pattern. + +@deffn {Scheme Syntax} modify-services @var{services} @ + (@var{type} @var{variable} => @var{body}) @dots{} + +Modify the services listed in @var{services} according to the given +clauses. Each clause has the form: + +@example +(@var{type} @var{variable} => @var{body}) +@end example + +where @var{type} is a service type---e.g., @code{guix-service-type}---and +@var{variable} is an identifier that is bound within the @var{body} to the +service parameters---e.g., a @code{guix-configuration} instance---of the +original service of that @var{type}. + +The @var{body} should evaluate to the new service parameters, which will be +used to configure the new service. This new service will replace the +original in the resulting list. Because a service's service parameters are +created using @code{define-record-type*}, you can write a succinct +@var{body} that evaluates to the new service parameters by using the +@code{inherit} feature that @code{define-record-type*} provides. + +@xref{Das Konfigurationssystems nutzen}, for example usage. + +@end deffn + +Next comes the programming interface for service types. This is something +you want to know when writing new service definitions, but not necessarily +when simply looking for ways to customize your @code{operating-system} +declaration. + +@deftp {Data Type} service-type +@cindex service type +This is the representation of a @dfn{service type} (@pxref{Diensttypen und Dienste}). + +@table @asis +@item @code{name} +This is a symbol, used only to simplify inspection and debugging. + +@item @code{extensions} +A non-empty list of @code{<service-extension>} objects (see below). + +@item @code{compose} (default: @code{#f}) +If this is @code{#f}, then the service type denotes services that cannot be +extended---i.e., services that do not receive ``values'' from other +services. + +Otherwise, it must be a one-argument procedure. The procedure is called by +@code{fold-services} and is passed a list of values collected from +extensions. It may return any single value. + +@item @code{extend} (default: @code{#f}) +If this is @code{#f}, services of this type cannot be extended. + +Otherwise, it must be a two-argument procedure: @code{fold-services} calls +it, passing it the initial value of the service as the first argument and +the result of applying @code{compose} to the extension values as the second +argument. It must return a value that is a valid parameter value for the +service instance. +@end table + +@xref{Diensttypen und Dienste}, for examples. +@end deftp + +@deffn {Scheme Procedure} service-extension @var{target-type} @ + @var{compute} Return a new extension for services of type +@var{target-type}. @var{compute} must be a one-argument procedure: +@code{fold-services} calls it, passing it the value associated with the +service that provides the extension; it must return a valid value for the +target service. +@end deffn + +@deffn {Scheme Procedure} service-extension? @var{obj} +Return true if @var{obj} is a service extension. +@end deffn + +Occasionally, you might want to simply extend an existing service. This +involves creating a new service type and specifying the extension of +interest, which can be verbose; the @code{simple-service} procedure provides +a shorthand for this. + +@deffn {Scheme Procedure} simple-service @var{name} @var{target} @var{value} +Return a service that extends @var{target} with @var{value}. This works by +creating a singleton service type @var{name}, of which the returned service +is an instance. + +For example, this extends mcron (@pxref{Geplante Auftragsausführung}) with an +additional job: + +@example +(simple-service 'my-mcron-job mcron-service-type + #~(job '(next-hour (3)) "guix gc -F 2G")) +@end example +@end deffn + +At the core of the service abstraction lies the @code{fold-services} +procedure, which is responsible for ``compiling'' a list of services down to +a single directory that contains everything needed to boot and run the +system---the directory shown by the @command{guix system build} command +(@pxref{Aufruf von guix system}). In essence, it propagates service +extensions down the service graph, updating each node parameters on the way, +until it reaches the root node. + +@deffn {Scheme Procedure} fold-services @var{services} @ + [#:target-type @var{system-service-type}] Fold @var{services} by propagating +their extensions down to the root of type @var{target-type}; return the root +service adjusted accordingly. +@end deffn + +Lastly, the @code{(gnu services)} module also defines several essential +service types, some of which are listed below. + +@defvr {Scheme Variable} system-service-type +This is the root of the service graph. It produces the system directory as +returned by the @command{guix system build} command. +@end defvr + +@defvr {Scheme Variable} boot-service-type +The type of the ``boot service'', which produces the @dfn{boot script}. The +boot script is what the initial RAM disk runs when booting. +@end defvr + +@defvr {Scheme Variable} etc-service-type +The type of the @file{/etc} service. This service is used to create files +under @file{/etc} and can be extended by passing it name/file tuples such +as: + +@example +(list `("issue" ,(plain-file "issue" "Welcome!\n"))) +@end example + +In this example, the effect would be to add an @file{/etc/issue} file +pointing to the given file. +@end defvr + +@defvr {Scheme Variable} setuid-program-service-type +Type for the ``setuid-program service''. This service collects lists of +executable file names, passed as gexps, and adds them to the set of +setuid-root programs on the system (@pxref{Setuid-Programme}). +@end defvr + +@defvr {Scheme Variable} profile-service-type +Type of the service that populates the @dfn{system profile}---i.e., the +programs under @file{/run/current-system/profile}. Other services can +extend it by passing it lists of packages to add to the system profile. +@end defvr + + +@node Shepherd-Dienste +@subsubsection Shepherd-Dienste + +@cindex shepherd services +@cindex PID 1 +@cindex init system +The @code{(gnu services shepherd)} module provides a way to define services +managed by the GNU@tie{}Shepherd, which is the GuixSD initialization +system---the first process that is started when the system boots, also known +as PID@tie{}1 (@pxref{Einführung,,, shepherd, The GNU Shepherd Manual}). + +Services in the Shepherd can depend on each other. For instance, the SSH +daemon may need to be started after the syslog daemon has been started, +which in turn can only happen once all the file systems have been mounted. +The simple operating system defined earlier (@pxref{Das Konfigurationssystems nutzen}) results in a service graph like this: + +@image{images/shepherd-graph,,5in,Typical shepherd service graph.} + +You can actually generate such a graph for any operating system definition +using the @command{guix system shepherd-graph} command +(@pxref{system-shepherd-graph, @command{guix system shepherd-graph}}). + +The @var{%shepherd-root-service} is a service object representing +PID@tie{}1, of type @var{shepherd-root-service-type}; it can be extended by +passing it lists of @code{<shepherd-service>} objects. + +@deftp {Data Type} shepherd-service +The data type representing a service managed by the Shepherd. + +@table @asis +@item @code{provision} +This is a list of symbols denoting what the service provides. + +These are the names that may be passed to @command{herd start}, +@command{herd status}, and similar commands (@pxref{Invoking herd,,, +shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the +@code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details. + +@item @code{requirements} (default: @code{'()}) +List of symbols denoting the Shepherd services this one depends on. + +@item @code{respawn?} (default: @code{#t}) +Whether to restart the service when it stops, for instance when the +underlying process dies. + +@item @code{start} +@itemx @code{stop} (default: @code{#~(const #f)}) +The @code{start} and @code{stop} fields refer to the Shepherd's facilities +to start and stop processes (@pxref{Service De- and Constructors,,, +shepherd, The GNU Shepherd Manual}). They are given as G-expressions that +get expanded in the Shepherd configuration file (@pxref{G-Ausdrücke}). + +@item @code{actions} (default: @code{'()}) +@cindex actions, of Shepherd services +This is a list of @code{shepherd-action} objects (see below) defining +@dfn{actions} supported by the service, in addition to the standard +@code{start} and @code{stop} actions. Actions listed here become available +as @command{herd} sub-commands: + +@example +herd @var{action} @var{service} [@var{arguments}@dots{}] +@end example + +@item @code{Dokumentation} +A documentation string, as shown when running: + +@example +herd doc @var{service-name} +@end example + +where @var{service-name} is one of the symbols in @var{provision} +(@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). + +@item @code{modules} (default: @var{%default-modules}) +This is the list of modules that must be in scope when @code{start} and +@code{stop} are evaluated. + +@end table +@end deftp + +@deftp {Data Type} shepherd-action +This is the data type that defines additional actions implemented by a +Shepherd service (see above). + +@table @code +@item name +Symbol naming the action. + +@item Dokumentation +This is a documentation string for the action. It can be viewed by running: + +@example +herd doc @var{service} action @var{action} +@end example + +@item procedure +This should be a gexp that evaluates to a procedure of at least one +argument, which is the ``running value'' of the service (@pxref{Slots of +services,,, shepherd, The GNU Shepherd Manual}). +@end table + +The following example defines an action called @code{say-hello} that kindly +greets the user: + +@example +(shepherd-action + (name 'say-hello) + (documentation "Say hi!") + (procedure #~(lambda (running . args) + (format #t "Hello, friend! arguments: ~s\n" + args) + #t))) +@end example + +Assuming this action is added to the @code{example} service, then you can +do: + +@example +# herd say-hello example +Hello, friend! arguments: () +# herd say-hello example a b c +Hello, friend! arguments: ("a" "b" "c") +@end example + +This, as you can see, is a fairly sophisticated way to say hello. +@xref{Service Convenience,,, shepherd, The GNU Shepherd Manual}, for more +info on actions. +@end deftp + +@defvr {Scheme Variable} shepherd-root-service-type +The service type for the Shepherd ``root service''---i.e., PID@tie{}1. + +This is the service type that extensions target when they want to create +shepherd services (@pxref{Diensttypen und Dienste}, for an example). +Each extension must pass a list of @code{<shepherd-service>}. +@end defvr + +@defvr {Scheme Variable} %shepherd-root-service +This service represents PID@tie{}1. +@end defvr + + +@node Dokumentation +@section Dokumentation + +@cindex documentation, searching for +@cindex searching for documentation +@cindex Info, documentation format +@cindex man pages +@cindex manual pages +In most cases packages installed with Guix come with documentation. There +are two main documentation formats: ``Info'', a browseable hypertext format +used for GNU software, and ``manual pages'' (or ``man pages''), the linear +documentation format traditionally found on Unix. Info manuals are accessed +with the @command{info} command or with Emacs, and man pages are accessed +using @command{man}. + +You can look for documentation of software installed on your system by +keyword. For example, the following command searches for information about +``TLS'' in Info manuals: + +@example +$ info -k TLS +"(emacs)Network Security" -- STARTTLS +"(emacs)Network Security" -- TLS +"(gnutls)Core TLS API" -- gnutls_certificate_set_verify_flags +"(gnutls)Core TLS API" -- gnutls_certificate_set_verify_function +@dots{} +@end example + +@noindent +The command below searches for the same keyword in man pages: + +@example +$ man -k TLS +SSL (7) - OpenSSL SSL/TLS library +certtool (1) - GnuTLS certificate tool +@dots {} +@end example + +These searches are purely local to your computer so you have the guarantee +that documentation you find corresponds to what you have actually installed, +you can access it off-line, and your privacy is respected. + +Once you have these results, you can view the relevant documentation by +running, say: + +@example +$ info "(gnutls)Core TLS API" +@end example + +@noindent +or: + +@example +$ man certtool +@end example + +Info manuals contain sections and indices as well as hyperlinks like those +found in Web pages. The @command{info} reader (@pxref{Top, Info reader,, +info-stnd, Stand-alone GNU Info}) and its Emacs counterpart (@pxref{Misc +Help,,, emacs, The GNU Emacs Manual}) provide intuitive key bindings to +navigate manuals. @xref{Getting Started,,, info, Info: An Introduction}, +for an introduction to Info navigation. + +@node Dateien zur Fehlersuche installieren +@section Dateien zur Fehlersuche installieren + +@cindex debugging files +Program binaries, as produced by the GCC compilers for instance, are +typically written in the ELF format, with a section containing +@dfn{debugging information}. Debugging information is what allows the +debugger, GDB, to map binary code to source code; it is required to debug a +compiled program in good conditions. + +The problem with debugging information is that is takes up a fair amount of +disk space. For example, debugging information for the GNU C Library weighs +in at more than 60 MiB. Thus, as a user, keeping all the debugging info of +all the installed programs is usually not an option. Yet, space savings +should not come at the cost of an impediment to debugging---especially in +the GNU system, which should make it easier for users to exert their +computing freedom (@pxref{GNU-Distribution}). + +Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism +that allows users to get the best of both worlds: debugging information can +be stripped from the binaries and stored in separate files. GDB is then +able to load debugging information from those files, when they are available +(@pxref{Separate Debug Files,,, gdb, Debugging with GDB}). + +The GNU distribution takes advantage of this by storing debugging +information in the @code{lib/debug} sub-directory of a separate package +output unimaginatively called @code{debug} (@pxref{Pakete mit mehreren Ausgaben.}). Users can choose to install the @code{debug} output of a package +when they need it. For instance, the following command installs the +debugging information for the GNU C Library and for GNU Guile: + +@example +guix package -i glibc:debug guile:debug +@end example + +GDB must then be told to look for debug files in the user's profile, by +setting the @code{debug-file-directory} variable (consider setting it from +the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with GDB}): + +@example +(gdb) set debug-file-directory ~/.guix-profile/lib/debug +@end example + +From there on, GDB will pick up debugging information from the @code{.debug} +files under @file{~/.guix-profile/lib/debug}. + +In addition, you will most likely want GDB to be able to show the source +code being debugged. To do that, you will have to unpack the source code of +the package of interest (obtained with @code{guix build --source}, +@pxref{Aufruf von guix build}), and to point GDB to that source directory +using the @code{directory} command (@pxref{Source Path, @code{directory},, +gdb, Debugging with GDB}). + +@c XXX: keep me up-to-date +The @code{debug} output mechanism in Guix is implemented by the +@code{gnu-build-system} (@pxref{Erstellungssysteme}). Currently, it is +opt-in---debugging information is available only for the packages with +definitions explicitly declaring a @code{debug} output. This may be changed +to opt-out in the future if our build farm servers can handle the load. To +check whether a package has a @code{debug} output, use @command{guix package +--list-available} (@pxref{Aufruf von guix package}). + + +@node Sicherheitsaktualisierungen +@section Sicherheitsaktualisierungen + +@cindex security updates +@cindex security vulnerabilities +Occasionally, important security vulnerabilities are discovered in software +packages and must be patched. Guix developers try hard to keep track of +known vulnerabilities and to apply fixes as soon as possible in the +@code{master} branch of Guix (we do not yet provide a ``stable'' branch +containing only security updates.) The @command{guix lint} tool helps +developers find out about vulnerable versions of software packages in the +distribution: + +@smallexample +$ guix lint -c cve +gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547 +gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276 +gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924 +@dots{} +@end smallexample + +@xref{Aufruf von guix lint}, for more information. + +@quotation Anmerkung +As of version @value{VERSION}, the feature described below is considered +``beta''. +@end quotation + +Guix follows a functional package management discipline +(@pxref{Einführung}), which implies that, when a package is changed, +@emph{every package that depends on it} must be rebuilt. This can +significantly slow down the deployment of fixes in core packages such as +libc or Bash, since basically the whole distribution would need to be +rebuilt. Using pre-built binaries helps (@pxref{Substitute}), but +deployment may still take more time than desired. + +@cindex grafts +To address this, Guix implements @dfn{grafts}, a mechanism that allows for +fast deployment of critical updates without the costs associated with a +whole-distribution rebuild. The idea is to rebuild only the package that +needs to be patched, and then to ``graft'' it onto packages explicitly +installed by the user and that were previously referring to the original +package. The cost of grafting is typically very low, and order of +magnitudes lower than a full rebuild of the dependency chain. + +@cindex replacements of packages, for grafts +For instance, suppose a security update needs to be applied to Bash. Guix +developers will provide a package definition for the ``fixed'' Bash, say +@var{bash-fixed}, in the usual way (@pxref{Pakete definieren}). Then, the +original package definition is augmented with a @code{replacement} field +pointing to the package containing the bug fix: + +@example +(define bash + (package + (name "bash") + ;; @dots{} + (replacement bash-fixed))) +@end example + +From there on, any package depending directly or indirectly on Bash---as +reported by @command{guix gc --requisites} (@pxref{Aufruf von guix gc})---that +is installed is automatically ``rewritten'' to refer to @var{bash-fixed} +instead of @var{bash}. This grafting process takes time proportional to the +size of the package, usually less than a minute for an ``average'' package +on a recent machine. Grafting is recursive: when an indirect dependency +requires grafting, then grafting ``propagates'' up to the package that the +user is installing. + +Currently, the length of the name and version of the graft and that of the +package it replaces (@var{bash-fixed} and @var{bash} in the example above) +must be equal. This restriction mostly comes from the fact that grafting +works by patching files, including binary files, directly. Other +restrictions may apply: for instance, when adding a graft to a package +providing a shared library, the original shared library and its replacement +must have the same @code{SONAME} and be binary-compatible. + +The @option{--no-grafts} command-line option allows you to forcefully avoid +grafting (@pxref{Gemeinsame Erstellungsoptionen, @option{--no-grafts}}). Thus, the +command: + +@example +guix build bash --no-grafts +@end example + +@noindent +returns the store file name of the original Bash, whereas: + +@example +guix build bash +@end example + +@noindent +returns the store file name of the ``fixed'', replacement Bash. This allows +you to distinguish between the two variants of Bash. + +To verify which Bash your whole profile refers to, you can run +(@pxref{Aufruf von guix gc}): + +@example +guix gc -R `readlink -f ~/.guix-profile` | grep bash +@end example + +@noindent +@dots{} and compare the store file names that you get with those above. +Likewise for a complete GuixSD system generation: + +@example +guix gc -R `guix system build my-config.scm` | grep bash +@end example + +Lastly, to check which Bash running processes are using, you can use the +@command{lsof} command: + +@example +lsof | grep /gnu/store/.*bash +@end example + + +@node Paketmodule +@section Paketmodule + +From a programming viewpoint, the package definitions of the GNU +distribution are provided by Guile modules in the @code{(gnu packages +@dots{})} name space@footnote{Note that packages under the @code{(gnu +packages @dots{})} module name space are not necessarily ``GNU packages''. +This module naming scheme follows the usual Guile module naming convention: +@code{gnu} means that these modules are distributed as part of the GNU +system, and @code{packages} identifies modules that define packages.} +(@pxref{Module, Guile modules,, guile, GNU Guile Reference Manual}). For +instance, the @code{(gnu packages emacs)} module exports a variable named +@code{emacs}, which is bound to a @code{<package>} object (@pxref{Pakete definieren}). + +The @code{(gnu packages @dots{})} module name space is automatically scanned +for packages by the command-line tools. For instance, when running +@code{guix package -i emacs}, all the @code{(gnu packages @dots{})} modules +are scanned until one that exports a package object whose name is +@code{emacs} is found. This package search facility is implemented in the +@code{(gnu packages)} module. + +@cindex Anpassung, von Paketen +@cindex package module search path +Users can store package definitions in modules with different names---e.g., +@code{(my-packages emacs)}@footnote{Note that the file name and module name +must match. For instance, the @code{(my-packages emacs)} module must be +stored in a @file{my-packages/emacs.scm} file relative to the load path +specified with @option{--load-path} or @code{GUIX_PACKAGE_PATH}. +@xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for +details.}. There are two ways to make these package definitions visible to +the user interfaces: + +@enumerate +@item +By adding the directory containing your package modules to the search path +with the @code{-L} flag of @command{guix package} and other commands +(@pxref{Gemeinsame Erstellungsoptionen}), or by setting the @code{GUIX_PACKAGE_PATH} +environment variable described below. + +@item +By defining a @dfn{channel} and configuring @command{guix pull} so that it +pulls from it. A channel is essentially a Git repository containing package +modules. @xref{Channels}, for more information on how to define and use +channels. +@end enumerate + +@code{GUIX_PACKAGE_PATH} works similarly to other search path variables: + +@defvr {Environment Variable} GUIX_PACKAGE_PATH +This is a colon-separated list of directories to search for additional +package modules. Directories listed in this variable take precedence over +the own modules of the distribution. +@end defvr + +The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: each +package is built based solely on other packages in the distribution. The +root of this dependency graph is a small set of @dfn{bootstrap binaries}, +provided by the @code{(gnu packages bootstrap)} module. For more +information on bootstrapping, @pxref{Bootstrapping}. + +@node Paketrichtlinien +@section Paketrichtlinien + +@cindex packages, creating +The GNU distribution is nascent and may well lack some of your favorite +packages. This section describes how you can help make the distribution +grow. @xref{Mitwirken}, for additional information on how you can help. + +Free software packages are usually distributed in the form of @dfn{source +code tarballs}---typically @file{tar.gz} files that contain all the source +files. Adding a package to the distribution means essentially two things: +adding a @dfn{recipe} that describes how to build the package, including a +list of other packages required to build it, and adding @dfn{package +metadata} along with that recipe, such as a description and licensing +information. + +In Guix all this information is embodied in @dfn{package definitions}. +Package definitions provide a high-level view of the package. They are +written using the syntax of the Scheme programming language; in fact, for +each package we define a variable bound to the package definition, and +export that variable from a module (@pxref{Paketmodule}). However, +in-depth Scheme knowledge is @emph{not} a prerequisite for creating +packages. For more information on package definitions, @pxref{Pakete definieren}. + +Once a package definition is in place, stored in a file in the Guix source +tree, it can be tested using the @command{guix build} command +(@pxref{Aufruf von guix build}). For example, assuming the new package is +called @code{gnew}, you may run this command from the Guix build tree +(@pxref{Guix vor der Installation ausführen}): + +@example +./pre-inst-env guix build gnew --keep-failed +@end example + +Using @code{--keep-failed} makes it easier to debug build failures since it +provides access to the failed build tree. Another useful command-line +option when debugging is @code{--log-file}, to access the build log. + +If the package is unknown to the @command{guix} command, it may be that the +source file contains a syntax error, or lacks a @code{define-public} clause +to export the package variable. To figure it out, you may load the module +from Guile to get more information about the actual error: + +@example +./pre-inst-env guile -c '(use-modules (gnu packages gnew))' +@end example + +Once your package builds correctly, please send us a patch +(@pxref{Mitwirken}). Well, if you need help, we will be happy to help +you too. Once the patch is committed in the Guix repository, the new +package automatically gets built on the supported platforms by +@url{http://hydra.gnu.org/jobset/gnu/master, our continuous integration +system}. + +@cindex substituter +Users can obtain the new package definition simply by running @command{guix +pull} (@pxref{Aufruf von guix pull}). When @code{hydra.gnu.org} is done +building the package, installing the package automatically downloads +binaries from there (@pxref{Substitute}). The only place where human +intervention is needed is to review and apply the patch. + + +@menu +* Software-Freiheit:: Was in die Distribution aufgenommen werden + darf. +* Paketbenennung:: Was macht einen Namen aus? +* Versionsnummern:: Wenn der Name noch nicht genug ist. +* Zusammenfassungen und Beschreibungen:: Den Nutzern helfen, das richtige + Paket zu finden. +* Python-Module:: Ein Touch britischer Comedy. +* Perl-Module:: Kleine Perlen. +* Java-Pakete:: Kaffeepause. +* Schriftarten:: Schriften verschriftlicht. +@end menu + +@node Software-Freiheit +@subsection Software-Freiheit + +@c Adapted from http://www.gnu.org/philosophy/philosophy.html. +@cindex free software +The GNU operating system has been developed so that users can have freedom +in their computing. GNU is @dfn{free software}, meaning that users have the +@url{http://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: to +run the program, to study and change the program in source code form, to +redistribute exact copies, and to distribute modified versions. Packages +found in the GNU distribution provide only software that conveys these four +freedoms. + +In addition, the GNU distribution follow the +@url{http://www.gnu.org/distros/free-system-distribution-guidelines.html,free +software distribution guidelines}. Among other things, these guidelines +reject non-free firmware, recommendations of non-free software, and discuss +ways to deal with trademarks and patents. + +Some otherwise free upstream package sources contain a small and optional +subset that violates the above guidelines, for instance because this subset +is itself non-free code. When that happens, the offending items are removed +with appropriate patches or code snippets in the @code{origin} form of the +package (@pxref{Pakete definieren}). This way, @code{guix build --source} +returns the ``freed'' source rather than the unmodified upstream source. + + +@node Paketbenennung +@subsection Paketbenennung + +@cindex package name +A package has actually two names associated with it: First, there is the +name of the @emph{Scheme variable}, the one following @code{define-public}. +By this name, the package can be made known in the Scheme code, for instance +as input to another package. Second, there is the string in the @code{name} +field of a package definition. This name is used by package management +commands such as @command{guix package} and @command{guix build}. + +Both are usually the same and correspond to the lowercase conversion of the +project name chosen upstream, with underscores replaced with hyphens. For +instance, GNUnet is available as @code{gnunet}, and SDL_net as +@code{sdl-net}. + +We do not add @code{lib} prefixes for library packages, unless these are +already part of the official project name. But @pxref{Python-Module} and +@ref{Perl-Module} for special rules concerning modules for the Python and +Perl languages. + +Font package names are handled differently, @pxref{Schriftarten}. + + +@node Versionsnummern +@subsection Versionsnummern + +@cindex package version +We usually package only the latest version of a given free software +project. But sometimes, for instance for incompatible library versions, two +(or more) versions of the same package are needed. These require different +Scheme variable names. We use the name as defined in @ref{Paketbenennung} +for the most recent version; previous versions use the same name, suffixed +by @code{-} and the smallest prefix of the version number that may +distinguish the two versions. + +The name inside the package definition is the same for all versions of a +package and does not contain any version number. + +For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as +follows: + +@example +(define-public gtk+ + (package + (name "gtk+") + (version "3.9.12") + ...)) +(define-public gtk+-2 + (package + (name "gtk+") + (version "2.24.20") + ...)) +@end example +If we also wanted GTK+ 3.8.2, this would be packaged as +@example +(define-public gtk+-3.8 + (package + (name "gtk+") + (version "3.8.2") + ...)) +@end example + +@c See <https://lists.gnu.org/archive/html/guix-devel/2016-01/msg00425.html>, +@c for a discussion of what follows. +@cindex version number, for VCS snapshots +Occasionally, we package snapshots of upstream's version control system +(VCS) instead of formal releases. This should remain exceptional, because +it is up to upstream developers to clarify what the stable release is. Yet, +it is sometimes necessary. So, what should we put in the @code{version} +field? + +Clearly, we need to make the commit identifier of the VCS snapshot visible +in the version string, but we also need to make sure that the version string +is monotonically increasing so that @command{guix package --upgrade} can +determine which version is newer. Since commit identifiers, notably with +Git, are not monotonically increasing, we add a revision number that we +increase each time we upgrade to a newer snapshot. The resulting version +string looks like this: + +@example +2.0.11-3.cabba9e + ^ ^ ^ + | | `-- upstream commit ID + | | + | `--- Guix package revision + | +latest upstream version +@end example + +It is a good idea to strip commit identifiers in the @code{version} field +to, say, 7 digits. It avoids an aesthetic annoyance (assuming aesthetics +have a role to play here) as well as problems related to OS limits such as +the maximum shebang length (127 bytes for the Linux kernel.) It is best to +use the full commit identifiers in @code{origin}s, though, to avoid +ambiguities. A typical package definition may look like this: + +@example +(define my-package + (let ((commit "c3f29bc928d5900971f65965feaae59e1272a3f7") + (revision "1")) ;Guix package revision + (package + (version (git-version "0.9" revision commit)) + (source (origin + (method git-fetch) + (uri (git-reference + (url "git://example.org/my-package.git") + (commit commit))) + (sha256 (base32 "1mbikn@dots{}")) + (file-name (git-file-name name version)))) + ;; @dots{} + ))) +@end example + +@node Zusammenfassungen und Beschreibungen +@subsection Zusammenfassungen und Beschreibungen + +@cindex package description +@cindex package synopsis +As we have seen before, each package in GNU@tie{}Guix includes a synopsis +and a description (@pxref{Pakete definieren}). Synopses and descriptions +are important: They are what @command{guix package --search} searches, and a +crucial piece of information to help users determine whether a given package +suits their needs. Consequently, packagers should pay attention to what +goes into them. + +Synopses must start with a capital letter and must not end with a period. +They must not start with ``a'' or ``the'', which usually does not bring +anything; for instance, prefer ``File-frobbing tool'' over ``A tool that +frobs files''. The synopsis should say what the package is---e.g., ``Core +GNU utilities (file, text, shell)''---or what it is used for---e.g., the +synopsis for GNU@tie{}grep is ``Print lines matching a pattern''. + +Keep in mind that the synopsis must be meaningful for a very wide audience. +For example, ``Manipulate alignments in the SAM format'' might make sense +for a seasoned bioinformatics researcher, but might be fairly unhelpful or +even misleading to a non-specialized audience. It is a good idea to come up +with a synopsis that gives an idea of the application domain of the +package. In this example, this might give something like ``Manipulate +nucleotide sequence alignments'', which hopefully gives the user a better +idea of whether this is what they are looking for. + +Descriptions should take between five and ten lines. Use full sentences, +and avoid using acronyms without first introducing them. Please avoid +marketing phrases such as ``world-leading'', ``industrial-strength'', and +``next-generation'', and avoid superlatives like ``the most +advanced''---they are not helpful to users looking for a package and may +even sound suspicious. Instead, try to be factual, mentioning use cases and +features. + +@cindex Texinfo markup, in package descriptions +Descriptions can include Texinfo markup, which is useful to introduce +ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or hyperlinks +(@pxref{Overview,,, texinfo, GNU Texinfo}). However you should be careful +when using some characters for example @samp{@@} and curly braces which are +the basic special characters in Texinfo (@pxref{Special Characters,,, +texinfo, GNU Texinfo}). User interfaces such as @command{guix package +--show} take care of rendering it appropriately. + +Synopses and descriptions are translated by volunteers +@uref{http://translationproject.org/domain/guix-packages.html, at the +Translation Project} so that as many users as possible can read them in +their native language. User interfaces search them and display them in the +language specified by the current locale. + +To allow @command{xgettext} to extract them as translatable strings, +synopses and descriptions @emph{must be literal strings}. This means that +you cannot use @code{string-append} or @code{format} to construct these +strings: + +@lisp +(package + ;; @dots{} + (synopsis "This is translatable") + (description (string-append "This is " "*not*" " translatable."))) +@end lisp + +Translation is a lot of work so, as a packager, please pay even more +attention to your synopses and descriptions as every change may entail +additional work for translators. In order to help them, it is possible to +make recommendations or instructions visible to them by inserting special +comments like this (@pxref{xgettext Invocation,,, gettext, GNU Gettext}): + +@example +;; TRANSLATORS: "X11 resize-and-rotate" should not be translated. +(description "ARandR is designed to provide a simple visual front end +for the X11 resize-and-rotate (RandR) extension. @dots{}") +@end example + + +@node Python-Module +@subsection Python-Module + +@cindex python +We currently package Python 2 and Python 3, under the Scheme variable names +@code{python-2} and @code{python} as explained in @ref{Versionsnummern}. To +avoid confusion and naming clashes with other programming languages, it +seems desirable that the name of a package for a Python module contains the +word @code{python}. + +Some modules are compatible with only one version of Python, others with +both. If the package Foo compiles only with Python 3, we name it +@code{python-foo}; if it compiles only with Python 2, we name it +@code{python2-foo}. If it is compatible with both versions, we create two +packages with the corresponding names. + +If a project already contains the word @code{python}, we drop this; for +instance, the module python-dateutil is packaged under the names +@code{python-dateutil} and @code{python2-dateutil}. If the project name +starts with @code{py} (e.g. @code{pytz}), we keep it and prefix it as +described above. + +@subsubsection Specifying Dependencies +@cindex inputs, for Python packages + +Dependency information for Python packages is usually available in the +package source tree, with varying degrees of accuracy: in the +@file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}. + +Your mission, when writing a recipe for a Python package, is to map these +dependencies to the appropriate type of ``input'' (@pxref{„package“-Referenz, +inputs}). Although the @code{pypi} importer normally does a good job +(@pxref{Aufruf von guix import}), you may want to check the following check +list to determine which dependency goes where. + +@itemize + +@item +We currently package Python 2 with @code{setuptools} and @code{pip} +installed like Python 3.4 has per default. Thus you don't need to specify +either of these as an input. @command{guix lint} will warn you if you do. + +@item +Python dependencies required at run time go into @code{propagated-inputs}. +They are typically defined with the @code{install_requires} keyword in +@file{setup.py}, or in the @file{requirements.txt} file. + +@item +Python packages required only at build time---e.g., those listed with the +@code{setup_requires} keyword in @file{setup.py}---or only for +testing---e.g., those in @code{tests_require}---go into +@code{native-inputs}. The rationale is that (1) they do not need to be +propagated because they are not needed at run time, and (2) in a +cross-compilation context, it's the ``native'' input that we'd want. + +Examples are the @code{pytest}, @code{mock}, and @code{nose} test +frameworks. Of course if any of these packages is also required at +run-time, it needs to go to @code{propagated-inputs}. + +@item +Anything that does not fall in the previous categories goes to +@code{inputs}, for example programs or C libraries required for building +Python packages containing C extensions. + +@item +If a Python package has optional dependencies (@code{extras_require}), it is +up to you to decide whether to add them or not, based on their +usefulness/overhead ratio (@pxref{Einreichen von Patches, @command{guix size}}). + +@end itemize + + +@node Perl-Module +@subsection Perl-Module + +@cindex perl +Perl programs standing for themselves are named as any other package, using +the lowercase upstream name. For Perl packages containing a single class, +we use the lowercase class name, replace all occurrences of @code{::} by +dashes and prepend the prefix @code{perl-}. So the class @code{XML::Parser} +becomes @code{perl-xml-parser}. Modules containing several classes keep +their lowercase upstream name and are also prepended by @code{perl-}. Such +modules tend to have the word @code{perl} somewhere in their name, which +gets dropped in favor of the prefix. For instance, @code{libwww-perl} +becomes @code{perl-libwww}. + + +@node Java-Pakete +@subsection Java-Pakete + +@cindex java +Java programs standing for themselves are named as any other package, using +the lowercase upstream name. + +To avoid confusion and naming clashes with other programming languages, it +is desirable that the name of a package for a Java package is prefixed with +@code{java-}. If a project already contains the word @code{java}, we drop +this; for instance, the package @code{ngsjava} is packaged under the name +@code{java-ngs}. + +For Java packages containing a single class or a small class hierarchy, we +use the lowercase class name, replace all occurrences of @code{.} by dashes +and prepend the prefix @code{java-}. So the class @code{apache.commons.cli} +becomes package @code{java-apache-commons-cli}. + + +@node Schriftarten +@subsection Schriftarten + +@cindex Schriftarten +For fonts that are in general not installed by a user for typesetting +purposes, or that are distributed as part of a larger software package, we +rely on the general packaging rules for software; for instance, this applies +to the fonts delivered as part of the X.Org system or fonts that are part of +TeX Live. + +To make it easier for a user to search for fonts, names for other packages +containing only fonts are constructed as follows, independently of the +upstream package name. + +The name of a package containing only one font family starts with +@code{font-}; it is followed by the foundry name and a dash @code{-} if the +foundry is known, and the font family name, in which spaces are replaced by +dashes (and as usual, all upper case letters are transformed to lower +case). For example, the Gentium font family by SIL is packaged under the +name @code{font-sil-gentium}. + +For a package containing several font families, the name of the collection +is used in the place of the font family name. For instance, the Liberation +fonts consist of three families, Liberation Sans, Liberation Serif and +Liberation Mono. These could be packaged separately under the names +@code{font-liberation-sans} and so on; but as they are distributed together +under a common name, we prefer to package them together as +@code{font-liberation}. + +In the case where several formats of the same font family or font collection +are packaged separately, a short form of the format, prepended by a dash, is +added to the package name. We use @code{-ttf} for TrueType fonts, +@code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 +fonts. + + + +@node Bootstrapping +@section Bootstrapping + +@c Adapted from the ELS 2013 paper. + +@cindex bootstrapping + +Bootstrapping in our context refers to how the distribution gets built +``from nothing''. Remember that the build environment of a derivation +contains nothing but its declared inputs (@pxref{Einführung}). So there's +an obvious chicken-and-egg problem: how does the first package get built? +How does the first compiler get compiled? Note that this is a question of +interest only to the curious hacker, not to the regular user, so you can +shamelessly skip this section if you consider yourself a ``regular user''. + +@cindex bootstrap binaries +The GNU system is primarily made of C code, with libc at its core. The GNU +build system itself assumes the availability of a Bourne shell and +command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and +`grep'. Furthermore, build programs---programs that run @code{./configure}, +@code{make}, etc.---are written in Guile Scheme (@pxref{Ableitungen}). +Consequently, to be able to build anything at all, from scratch, Guix relies +on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages +mentioned above---the @dfn{bootstrap binaries}. + +These bootstrap binaries are ``taken for granted'', though we can also +re-create them if needed (more on that later). + +@unnumberedsubsec Preparing to Use the Bootstrap Binaries + +@c As of Emacs 24.3, Info-mode displays the image, but since it's a +@c large image, it's hard to scroll. Oh well. +@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap +derivations} + +The figure above shows the very beginning of the dependency graph of the +distribution, corresponding to the package definitions of the @code{(gnu +packages bootstrap)} module. A similar figure can be generated with +@command{guix graph} (@pxref{Aufruf von guix graph}), along the lines of: + +@example +guix graph -t derivation \ + -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \ + | dot -Tps > t.ps +@end example + +At this level of detail, things are slightly complex. First, Guile itself +consists of an ELF executable, along with many source and compiled Scheme +files that are dynamically loaded when it runs. This gets stored in the +@file{guile-2.0.7.tar.xz} tarball shown in this graph. This tarball is part +of Guix's ``source'' distribution, and gets inserted into the store with +@code{add-to-store} (@pxref{Der Store}). + +But how do we write a derivation that unpacks this tarball and adds it to +the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} +derivation---the first one that gets built---uses @code{bash} as its +builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls +@code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, @file{xz}, +and @file{mkdir} are statically-linked binaries, also part of the Guix +source distribution, whose sole purpose is to allow the Guile tarball to be +unpacked. + +Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile +that can be used to run subsequent build programs. Its first task is to +download tarballs containing the other pre-built binaries---this is what the +@code{.tar.xz.drv} derivations do. Guix modules such as +@code{ftp-client.scm} are used for this purpose. The +@code{module-import.drv} derivations import those modules in a directory in +the store, using the original layout. The @code{module-import-compiled.drv} +derivations compile those modules, and write them in an output directory +with the right layout. This corresponds to the @code{#:modules} argument of +@code{build-expression->derivation} (@pxref{Ableitungen}). + +Finally, the various tarballs are unpacked by the derivations +@code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, etc., at which +point we have a working C tool chain. + + +@unnumberedsubsec Building the Build Tools + +Bootstrapping is complete when we have a full tool chain that does not +depend on the pre-built bootstrap tools discussed above. This no-dependency +requirement is verified by checking whether the files of the final tool +chain contain references to the @file{/gnu/store} directories of the +bootstrap inputs. The process that leads to this ``final'' tool chain is +described by the package definitions found in the @code{(gnu packages +commencement)} module. + +The @command{guix graph} command allows us to ``zoom out'' compared to the +graph above, by looking at the level of package objects instead of +individual derivations---remember that a package may translate to several +derivations, typically one derivation to download its source, one to build +the Guile modules it needs, and one to actually build the package from +source. The command: + +@example +guix graph -t bag \ + -e '(@@@@ (gnu packages commencement) + glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps +@end example + +@noindent +produces the dependency graph leading to the ``final'' C +library@footnote{You may notice the @code{glibc-intermediate} label, +suggesting that it is not @emph{quite} final, but as a good approximation, +we will consider it final.}, depicted below. + +@image{images/bootstrap-packages,6in,,Dependency graph of the early +packages} + +@c See <http://lists.gnu.org/archive/html/gnu-system-discuss/2012-10/msg00000.html>. +The first tool that gets built with the bootstrap binaries is +GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite for +all the following packages. From there Findutils and Diffutils get built. + +Then come the first-stage Binutils and GCC, built as pseudo cross +tools---i.e., with @code{--target} equal to @code{--host}. They are used to +build libc. Thanks to this cross-build trick, this libc is guaranteed not +to hold any reference to the initial tool chain. + +From there the final Binutils and GCC (not shown above) are built. GCC uses +@code{ld} from the final Binutils, and links programs against the just-built +libc. This tool chain is used to build the other packages used by Guix and +by the GNU Build System: Guile, Bash, Coreutils, etc. + +And voilà! At this point we have the complete set of build tools that the +GNU Build System expects. These are in the @code{%final-inputs} variable of +the @code{(gnu packages commencement)} module, and are implicitly used by +any package that uses @code{gnu-build-system} (@pxref{Erstellungssysteme, +@code{gnu-build-system}}). + + +@unnumberedsubsec Building the Bootstrap Binaries + +@cindex bootstrap binaries +Because the final tool chain does not depend on the bootstrap binaries, +those rarely need to be updated. Nevertheless, it is useful to have an +automated way to produce them, should an update occur, and this is what the +@code{(gnu packages make-bootstrap)} module provides. + +The following command builds the tarballs containing the bootstrap binaries +(Guile, Binutils, GCC, libc, and a tarball containing a mixture of Coreutils +and other basic command-line tools): + +@example +guix build bootstrap-tarballs +@end example + +The generated tarballs are those that should be referred to in the +@code{(gnu packages bootstrap)} module mentioned at the beginning of this +section. + +Still here? Then perhaps by now you've started to wonder: when do we reach a +fixed point? That is an interesting question! The answer is unknown, but if +you would like to investigate further (and have significant computational +and storage resources to do so), then let us know. + +@unnumberedsubsec Reducing the Set of Bootstrap Binaries + +Our bootstrap binaries currently include GCC, Guile, etc. That's a lot of +binary code! Why is that a problem? It's a problem because these big chunks +of binary code are practically non-auditable, which makes it hard to +establish what source code produced them. Every unauditable binary also +leaves us vulnerable to compiler backdoors as described by Ken Thompson in +the 1984 paper @emph{Reflections on Trusting Trust}. + +This is mitigated by the fact that our bootstrap binaries were generated +from an earlier Guix revision. Nevertheless it lacks the level of +transparency that we get in the rest of the package dependency graph, where +Guix always gives us a source-to-binary mapping. Thus, our goal is to +reduce the set of bootstrap binaries to the bare minimum. + +The @uref{http://bootstrappable.org, Bootstrappable.org web site} lists +on-going projects to do that. One of these is about replacing the bootstrap +GCC with a sequence of assemblers, interpreters, and compilers of increasing +complexity, which could be built from source starting from a simple and +auditable assembler. Your help is welcome! + + +@node Portierung +@section Porting to a New Platform + +As discussed above, the GNU distribution is self-contained, and +self-containment is achieved by relying on pre-built ``bootstrap binaries'' +(@pxref{Bootstrapping}). These binaries are specific to an operating system +kernel, CPU architecture, and application binary interface (ABI). Thus, to +port the distribution to a platform that is not yet supported, one must +build those bootstrap binaries, and update the @code{(gnu packages +bootstrap)} module to use them on that platform. + +Fortunately, Guix can @emph{cross compile} those bootstrap binaries. When +everything goes well, and assuming the GNU tool chain supports the target +platform, this can be as simple as running a command like this one: + +@example +guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs +@end example + +For this to work, the @code{glibc-dynamic-linker} procedure in @code{(gnu +packages bootstrap)} must be augmented to return the right file name for +libc's dynamic linker on that platform; likewise, +@code{system->linux-architecture} in @code{(gnu packages linux)} must be +taught about the new platform. + +Once these are built, the @code{(gnu packages bootstrap)} module needs to be +updated to refer to these binaries on the target platform. That is, the +hashes and URLs of the bootstrap tarballs for the new platform must be added +alongside those of the currently supported platforms. The bootstrap Guile +tarball is treated specially: it is expected to be available locally, and +@file{gnu/local.mk} has rules do download it for the supported +architectures; a rule for the new platform must be added as well. + +In practice, there may be some complications. First, it may be that the +extended GNU triplet that specifies an ABI (like the @code{eabi} suffix +above) is not recognized by all the GNU tools. Typically, glibc recognizes +some of these, whereas GCC uses an extra @code{--with-abi} configure flag +(see @code{gcc.scm} for examples of how to handle this). Second, some of +the required packages could fail to build for that platform. Lastly, the +generated binaries could be broken for some reason. + +@c ********************************************************************* +@include contributing.de.texi + +@c ********************************************************************* +@node Danksagungen +@chapter Danksagungen + +Guix is based on the @uref{http://nixos.org/nix/, Nix package manager}, +which was designed and implemented by Eelco Dolstra, with contributions from +other people (see the @file{nix/AUTHORS} file in Guix.) Nix pioneered +functional package management, and promoted unprecedented features, such as +transactional package upgrades and rollbacks, per-user profiles, and +referentially transparent build processes. Without this work, Guix would +not exist. + +The Nix-based software distributions, Nixpkgs and NixOS, have also been an +inspiration for Guix. + +GNU@tie{}Guix itself is a collective work with contributions from a number +of people. See the @file{AUTHORS} file in Guix for more information on +these fine people. The @file{THANKS} file lists people who have helped by +reporting bugs, taking care of the infrastructure, providing artwork and +themes, making suggestions, and more---thank you! + + +@c ********************************************************************* +@node GNU-Lizenz für freie Dokumentation +@appendix GNU-Lizenz für freie Dokumentation +@cindex license, GNU Free Documentation License +@include fdl-1.3.texi + +@c ********************************************************************* +@node Konzeptverzeichnis +@unnumbered Konzeptverzeichnis +@printindex cp + +@node Programmierverzeichnis +@unnumbered Programmierverzeichnis +@syncodeindex tp fn +@syncodeindex vr fn +@printindex fn + +@bye + +@c Local Variables: +@c ispell-local-dictionary: "american"; +@c End: diff --git a/doc/guix.texi b/doc/guix.texi index b41af61f12..edcff9c844 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -102,8 +102,9 @@ package management tool written for the GNU system. @c how to join your own translation team and how to report issues with the @c translation. This manual is also available in French (@pxref{Top,,, guix.fr, Manuel de -référence de GNU Guix}). If you would like to translate it in your native -language, consider joining the +référence de GNU Guix}) and German (@pxref{Top,,, guix.de, Referenzhandbuch +zu GNU Guix}). If you would like to translate it in your native language, +consider joining the @uref{https://translationproject.org/domain/guix-manual.html, Translation Project}. diff --git a/doc/local.mk b/doc/local.mk index 0b7904329a..adb7b5102d 100644 --- a/doc/local.mk +++ b/doc/local.mk @@ -22,7 +22,8 @@ # along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. info_TEXINFOS = %D%/guix.texi \ - %D%/guix.fr.texi + %D%/guix.fr.texi \ + %D%/guix.de.texi %C%_guix_TEXINFOS = \ %D%/contributing.texi \ @@ -54,7 +55,9 @@ OS_CONFIG_EXAMPLES_TEXI = \ %D%/os-config-lightweight-desktop.texi TRANSLATED_INFO = \ + %D%/guix.de.texi \ %D%/guix.fr.texi \ + %D%/contributing.de.texi \ %D%/contributing.fr.texi # Bundle this file so that makeinfo finds it in out-of-source-tree builds. diff --git a/po/doc/guix-manual.de.po b/po/doc/guix-manual.de.po new file mode 100644 index 0000000000..9e5d4a225f --- /dev/null +++ b/po/doc/guix-manual.de.po @@ -0,0 +1,39797 @@ +# German translation of the Guix user manual. +# Copyright (C) 2018 the authors of Guix (msgids) +# This file is distributed under the same license as the guix package. +# Florian Pelz <pelzflorian@pelzflorian.de>, 2018. +# Mario Blättermann <mario.blaettermann@gmail.com>, 2018. +# +msgid "" +msgstr "" +"Project-Id-Version: guix-manual 0.15.0\n" +"Report-Msgid-Bugs-To: ludo@gnu.org\n" +"POT-Creation-Date: 2018-06-22 14:12+0200\n" +"PO-Revision-Date: 2018-10-27 02:37+0200\n" +"Last-Translator: Mario Blättermann <mario.blaettermann@gmail.com>\n" +"Language-Team: German <translation-team-de@lists.sourceforge.net>\n" +"Language: de\n" +"X-Bugs: Report translation errors to the Language-Team address.\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: chapter +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:1 doc/contributing.texi:2 doc/guix.texi:107 +#: doc/guix.texi:278 +#, no-wrap +msgid "Contributing" +msgstr "Mitwirken" + +#. type: Plain text +#: doc/contributing.texi:9 +msgid "This project is a cooperative effort, and we need your help to make it grow! Please get in touch with us on @email{guix-devel@@gnu.org} and @code{#guix} on the Freenode IRC network. We welcome ideas, bug reports, patches, and anything that may be helpful to the project. We particularly welcome help on packaging (@pxref{Packaging Guidelines})." +msgstr "Dieses Projekt basiert auf Kooperation, daher benötigen wir Ihre Hilfe, um es wachsen zu lassen! Bitte kontaktieren Sie uns auf @email{guix-devel@@gnu.org} und @code{#guix} im Freenode-IRC-Netzwerk. Wir freuen uns auf Ihre Ideen, Fehlerberichte, Patches und alles, was hilfreich für das Projekt ist. Besonders willkommen ist Hilfe bei der Erstellung von Paketen (@pxref{Packaging Guidelines})." + +#. type: cindex +#: doc/contributing.texi:10 +#, no-wrap +msgid "code of conduct, of contributors" +msgstr "Verhaltensregeln, für Mitwirkende" + +#. type: cindex +#: doc/contributing.texi:11 +#, no-wrap +msgid "contributor covenant" +msgstr "Verhaltenskodex für Mitwirkende" + +#. type: Plain text +#: doc/contributing.texi:17 +msgid "We want to provide a warm, friendly, and harassment-free environment, so that anyone can contribute to the best of their abilities. To this end our project uses a ``Contributor Covenant'', which was adapted from @url{http://contributor-covenant.org/}. You can find a local version in the @file{CODE-OF-CONDUCT} file in the source tree." +msgstr "Wir möchten eine angenehme, freundliche und von Belästigungen freie Umgebung bereitstellen, so dass jeder Beiträge nach seinen Fähigkeiten leisten kann. Zu diesem Zweck verwendet unser Projekt einen »Verhaltenskodex für Mitwirkende«, der von @url{http://contributor-covenant.org/} übernommen wurde. Eine übersetzte Fassung finden Sie auf @url{https://www.contributor-covenant.org/de/version/1/4/code-of-conduct} sowie eine mitgelieferte, englische Fassung in der Datei @file{CODE-OF-CONDUCT} im Quellbaum." + +#. type: Plain text +#: doc/contributing.texi:21 +msgid "Contributors are not required to use their legal name in patches and on-line communication; they can use any name or pseudonym of their choice." +msgstr "Von Mitwirkenden wird nicht erwartet, dass sie in Patches oder in der Online-Kommunikation ihre echten Namen preisgeben. Sie können einen beliebigen Namen oder ein Pseudonym ihrer Wahl verwenden." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: section +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:28 doc/contributing.texi:30 doc/contributing.texi:31 +#: doc/guix.texi:284 +#, no-wrap +msgid "Building from Git" +msgstr "Erstellung aus dem Git" + +#. type: menuentry +#: doc/contributing.texi:28 doc/guix.texi:284 +msgid "The latest and greatest." +msgstr "Das Neueste und Beste." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: section +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:28 doc/contributing.texi:102 +#: doc/contributing.texi:103 doc/guix.texi:284 +#, no-wrap +msgid "Running Guix Before It Is Installed" +msgstr "Guix vor der Installation ausführen" + +#. type: menuentry +#: doc/contributing.texi:28 doc/guix.texi:284 +msgid "Hacker tricks." +msgstr "Hacker-Tricks." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: section +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:28 doc/contributing.texi:163 +#: doc/contributing.texi:164 doc/guix.texi:284 +#, no-wrap +msgid "The Perfect Setup" +msgstr "Perfekt eingerichtet" + +#. type: menuentry +#: doc/contributing.texi:28 doc/guix.texi:284 +msgid "The right tools." +msgstr "Die richtigen Werkzeuge." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: section +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:28 doc/contributing.texi:222 +#: doc/contributing.texi:223 doc/guix.texi:284 doc/guix.texi:286 +#, no-wrap +msgid "Coding Style" +msgstr "Code-Stil" + +#. type: menuentry +#: doc/contributing.texi:28 doc/guix.texi:284 +msgid "Hygiene of the contributor." +msgstr "Wie Mitwirkende hygienisch arbeiten." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: section +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:28 doc/contributing.texi:320 +#: doc/contributing.texi:321 doc/guix.texi:284 +#, no-wrap +msgid "Submitting Patches" +msgstr "Einreichen von Patches" + +#. type: menuentry +#: doc/contributing.texi:28 doc/guix.texi:284 +msgid "Share your work." +msgstr "Teilen Sie Ihre Arbeit." + +#. type: Plain text +#: doc/contributing.texi:35 +msgid "If you want to hack Guix itself, it is recommended to use the latest version from the Git repository:" +msgstr "Wenn Sie an Guix selbst hacken wollen, ist es empfehlenswert, dass Sie die neueste Version aus dem Git-Softwarebestand verwenden:" + +#. type: example +#: doc/contributing.texi:38 +#, no-wrap +msgid "git clone https://git.savannah.gnu.org/git/guix.git\n" +msgstr "git clone https://git.savannah.gnu.org/git/guix.git\n" + +#. type: Plain text +#: doc/contributing.texi:43 +msgid "When building Guix from a checkout, the following packages are required in addition to those mentioned in the installation instructions (@pxref{Requirements})." +msgstr "Wenn Sie Guix aus einem Checkout erstellen, sind außer den bereits in den Installationsanweisungen genannten Paketen weitere nötig (@pxref{Requirements})." + +#. type: item +#: doc/contributing.texi:45 +#, no-wrap +msgid "@url{http://gnu.org/software/autoconf/, GNU Autoconf};" +msgstr "@url{http://gnu.org/software/autoconf/, GNU Autoconf};" + +#. type: item +#: doc/contributing.texi:46 +#, no-wrap +msgid "@url{http://gnu.org/software/automake/, GNU Automake};" +msgstr "@url{http://gnu.org/software/automake/, GNU Automake};" + +#. type: item +#: doc/contributing.texi:47 +#, no-wrap +msgid "@url{http://gnu.org/software/gettext/, GNU Gettext};" +msgstr "@url{http://gnu.org/software/gettext/, GNU Gettext};" + +#. type: item +#: doc/contributing.texi:48 +#, no-wrap +msgid "@url{http://gnu.org/software/texinfo/, GNU Texinfo};" +msgstr "@url{http://gnu.org/software/texinfo/, GNU Texinfo};" + +#. type: item +#: doc/contributing.texi:49 +#, no-wrap +msgid "@url{http://www.graphviz.org/, Graphviz};" +msgstr "@url{http://www.graphviz.org/, Graphviz};" + +#. type: item +#: doc/contributing.texi:50 +#, no-wrap +msgid "@url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}." +msgstr "@url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}." + +#. type: Plain text +#: doc/contributing.texi:57 +msgid "The easiest way to set up a development environment for Guix is, of course, by using Guix! The following command starts a new shell where all the dependencies and appropriate environment variables are set up to hack on Guix:" +msgstr "Der einfachste Weg, eine Entwicklungsumgebung für Guix einzurichten, ist natürlich, Guix zu benutzen! Der folgende Befehl startet eine neue Shell, in der alle Abhängigkeiten und Umgebungsvariablen bereits eingerichtet sind, um an Guix zu arbeiten:" + +#. type: example +#: doc/contributing.texi:60 +#, no-wrap +msgid "guix environment guix\n" +msgstr "guix environment guix\n" + +#. type: Plain text +#: doc/contributing.texi:64 +msgid "@xref{Invoking guix environment}, for more information on that command. Extra dependencies can be added with @option{--ad-hoc}:" +msgstr "In @xref{Invoking guix environment} finden Sie weitere Informationen zu diesem Befehl. Zusätzliche Abhängigkeiten können mit @option{--ad-hoc} hinzugefügt werden:" + +#. type: example +#: doc/contributing.texi:67 +#, no-wrap +msgid "guix environment guix --ad-hoc help2man git strace\n" +msgstr "guix environment guix --ad-hoc help2man git strace\n" + +#. type: Plain text +#: doc/contributing.texi:71 +msgid "Run @command{./bootstrap} to generate the build system infrastructure using Autoconf and Automake. If you get an error like this one:" +msgstr "Führen Sie @command{./bootstrap} aus, um die Infrastruktur des Erstellungssystems mit Autoconf und Automake zu erstellen. Möglicherweise erhalten Sie eine Fehlermeldung wie diese:" + +#. type: example +#: doc/contributing.texi:74 +#, no-wrap +msgid "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n" +msgstr "configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES\n" + +#. type: Plain text +#: doc/contributing.texi:83 +msgid "it probably means that Autoconf couldn’t find @file{pkg.m4}, which is provided by pkg-config. Make sure that @file{pkg.m4} is available. The same holds for the @file{guile.m4} set of macros provided by Guile. For instance, if you installed Automake in @file{/usr/local}, it wouldn’t look for @file{.m4} files in @file{/usr/share}. In that case, you have to invoke the following command:" +msgstr "Das bedeutet wahrscheinlich, dass Autoconf @file{pkg.m4} nicht finden konnte, welches von pkg-config bereitgestellt wird. Stellen Sie sicher, dass @file{pkg.m4} verfügbar ist. Gleiches gilt für den von Guile bereitgestellten Makrosatz @file{guile.m4}. Wenn Sie beispielsweise Automake in @file{/usr/local} installiert haben, würde in @file{/usr/share} nicht nach @file{.m4}-Dateien geschaut. In einem solchen Fall müssen Sie folgenden Befehl aufrufen:" + +#. type: example +#: doc/contributing.texi:86 +#, no-wrap +msgid "export ACLOCAL_PATH=/usr/share/aclocal\n" +msgstr "export ACLOCAL_PATH=/usr/share/aclocal\n" + +#. type: Plain text +#: doc/contributing.texi:90 +msgid "@xref{Macro Search Path,,, automake, The GNU Automake Manual}, for more information." +msgstr "In @xref{Macro Search Path,,, automake, The GNU Automake Manual} finden Sie weitere Informationen." + +#. type: Plain text +#: doc/contributing.texi:95 +msgid "Then, run @command{./configure} as usual. Make sure to pass @code{--localstatedir=@var{directory}} where @var{directory} is the @code{localstatedir} value used by your current installation (@pxref{The Store}, for information about this)." +msgstr "Dann führen Sie wie gewohnt @command{./configure} aus. Achten Sie darauf, @code{--localstatedir=@var{Verzeichnis}} zu übergeben, wobei @var{Verzeichnis} der von Ihrer aktuellen Installation verwendete @code{localstatedir}-Wert ist (weitere Informationen auf @pxref{The Store})." + +#. type: Plain text +#: doc/contributing.texi:100 +msgid "Finally, you have to invoke @code{make check} to run tests (@pxref{Running the Test Suite}). If anything fails, take a look at installation instructions (@pxref{Installation}) or send a message to the @email{guix-devel@@gnu.org, mailing list}." +msgstr "Zum Schluss müssen Sie @code{make check} aufrufen, um die Tests auszuführen (@pxref{Running the Test Suite}). Falls etwas fehlschlägt, werfen Sie einen Blick auf die Installationsanweisungen (@pxref{Installation}) oder senden Sie eine E-Mail an @email{guix-devel@@gnu.org, Mailingliste}." + +#. type: Plain text +#: doc/contributing.texi:109 +msgid "In order to keep a sane working environment, you will find it useful to test the changes made in your local source tree checkout without actually installing them. So that you can distinguish between your ``end-user'' hat and your ``motley'' costume." +msgstr "Um eine gesunde Arbeitsumgebung zu behalten, ist es hilfreich, die im lokalen Quellbaum vorgenommenen Änderungen zunächst zu testen, ohne sie tatsächlich zu installieren. So können Sie zwischen Ihrem Endnutzer-»Straßenanzug« und Ihrem »Faschingskostüm« unterscheiden." + +#. type: Plain text +#: doc/contributing.texi:117 +#, fuzzy +#| msgid "To that end, all the command-line tools can be used even if you have not run @code{make install}. To do that, you first need to have an environment with all the dependencies available (@pxref{Building from Git}), and then simply prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the top build tree of Guix), as in@footnote{The @option{-E} flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and the tools it uses can find the Guile modules they need.}:" +msgid "To that end, all the command-line tools can be used even if you have not run @code{make install}. To do that, prefix each command with @command{./pre-inst-env} (the @file{pre-inst-env} script lives in the top build tree of Guix), as in@footnote{The @option{-E} flag to @command{sudo} guarantees that @code{GUILE_LOAD_PATH} is correctly set such that @command{guix-daemon} and the tools it uses can find the Guile modules they need.}:" +msgstr "Zu diesem Zweck können alle Befehlszeilenwerkzeuge auch schon benutzt werden, ohne dass Sie @code{make install} laufen lassen. Dazu müssen Sie sich in einer Umgebung befinden, in der alle Abhängigkeiten von Guix verfügbar sind (@pxref{Building from Git}) und darin einfach vor jeden Befehl @command{./pre-inst-env} schreiben (das Skript @file{pre-inst-env} befindet sich auf oberster Ebene im Verzeichnis, wo Guix erstellt wird), zum Beispiel so@footnote{Die Befehlszeilenoption @option{-E} von @command{sudo} stellt sicher, dass @code{GUILE_LOAD_PATH} richtig gesetzt wird, damit @command{guix-daemon} und die davon benutzten Werkzeuge die von ihnen benötigten Guile-Module finden können.}:" + +#. type: example +#: doc/contributing.texi:121 +#, no-wrap +msgid "" +"$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n" +"$ ./pre-inst-env guix build hello\n" +msgstr "" +"$ sudo -E ./pre-inst-env guix-daemon --build-users-group=guixbuild\n" +"$ ./pre-inst-env guix build hello\n" + +#. type: Plain text +#: doc/contributing.texi:125 +msgid "Similarly, for a Guile session using the Guix modules:" +msgstr "Entsprechend, um eine Guile-Sitzung zu öffnen, die die Guix-Module benutzt:" + +#. type: example +#: doc/contributing.texi:128 +#, no-wrap +msgid "" +"$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n" +"\n" +msgstr "" +"$ ./pre-inst-env guile -c '(use-modules (guix utils)) (pk (%current-system))'\n" +"\n" + +#. type: example +#: doc/contributing.texi:130 +#, no-wrap +msgid ";;; (\"x86_64-linux\")\n" +msgstr ";;; (\"x86_64-linux\")\n" + +#. type: cindex +#: doc/contributing.texi:133 +#, no-wrap +msgid "REPL" +msgstr "REPL" + +#. type: cindex +#: doc/contributing.texi:134 +#, no-wrap +msgid "read-eval-print loop" +msgstr "Lese-Auswerten-Schreiben-Schleife" + +#. type: Plain text +#: doc/contributing.texi:137 +msgid "@dots{} and for a REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):" +msgstr "@dots{} und auf einer REPL (@pxref{Using Guile Interactively,,, guile, Guile Reference Manual}):" + +#. type: example +#: doc/contributing.texi:152 +#, no-wrap +msgid "" +"$ ./pre-inst-env guile\n" +"scheme@@(guile-user)> ,use(guix)\n" +"scheme@@(guile-user)> ,use(gnu)\n" +"scheme@@(guile-user)> (define snakes\n" +" (fold-packages\n" +" (lambda (package lst)\n" +" (if (string-prefix? \"python\"\n" +" (package-name package))\n" +" (cons package lst)\n" +" lst))\n" +" '()))\n" +"scheme@@(guile-user)> (length snakes)\n" +"$1 = 361\n" +msgstr "" +"$ ./pre-inst-env guile\n" +"scheme@@(guile-user)> ,use(guix)\n" +"scheme@@(guile-user)> ,use(gnu)\n" +"scheme@@(guile-user)> (define snakes\n" +" (fold-packages\n" +" (lambda (package lst)\n" +" (if (string-prefix? \"python\"\n" +" (package-name package))\n" +" (cons package lst)\n" +" lst))\n" +" '()))\n" +"scheme@@(guile-user)> (length snakes)\n" +"$1 = 361\n" + +#. type: Plain text +#: doc/contributing.texi:156 +msgid "The @command{pre-inst-env} script sets up all the environment variables necessary to support this, including @env{PATH} and @env{GUILE_LOAD_PATH}." +msgstr "Das @command{pre-inst-env}-Skript richtet alle Umgebungsvariablen ein, die nötig sind, um dies zu ermöglichen, einschließlich @env{PATH} und @env{GUILE_LOAD_PATH}." + +#. type: Plain text +#: doc/contributing.texi:161 +msgid "Note that @command{./pre-inst-env guix pull} does @emph{not} upgrade the local source tree; it simply updates the @file{~/.config/guix/current} symlink (@pxref{Invoking guix pull}). Run @command{git pull} instead if you want to upgrade your local source tree." +msgstr "Beachten Sie, dass @command{./pre-inst-env guix pull} den lokalen Quellbaum @emph{nicht} aktualisiert; es aktualisiert lediglich die symbolische Verknüpfung @file{~/.config/guix/current} (@pxref{Invoking guix pull}). Um Ihren lokalen Quellbaum zu aktualisieren, müssen Sie stattdessen @command{git pull} benutzen." + +#. type: Plain text +#: doc/contributing.texi:171 +msgid "The Perfect Setup to hack on Guix is basically the perfect setup used for Guile hacking (@pxref{Using Guile in Emacs,,, guile, Guile Reference Manual}). First, you need more than an editor, you need @url{http://www.gnu.org/software/emacs, Emacs}, empowered by the wonderful @url{http://nongnu.org/geiser/, Geiser}." +msgstr "Um perfekt für das Hacken an Guix eingerichtet zu sein, brauchen Sie an sich dasselbe wie um perfekt für das Hacken mit Guile (@pxref{Using Guile in Emacs,,, guile, Guile Reference Manual}). Zunächst brauchen Sie mehr als ein Textverarbeitungsprogramm, Sie brauchen @url{http://www.gnu.org/software/emacs, Emacs}, ermächtigt vom wunderbaren @url{http://nongnu.org/geiser/, Geiser}." + +#. type: Plain text +#: doc/contributing.texi:179 +msgid "Geiser allows for interactive and incremental development from within Emacs: code compilation and evaluation from within buffers, access to on-line documentation (docstrings), context-sensitive completion, @kbd{M-.} to jump to an object definition, a REPL to try out your code, and more (@pxref{Introduction,,, geiser, Geiser User Manual}). For convenient Guix development, make sure to augment Guile’s load path so that it finds source files from your checkout:" +msgstr "Geiser ermöglicht interaktive und inkrementelle Entwicklung aus Emacs heraus: Code kann in Puffern kompiliert und ausgewertet werden. Zugang zu Online-Dokumentation (Docstrings) steht ebenso zur Verfügung wie kontextabhängige Vervollständigung, @kbd{M-.} um zu einer Objektdefinition zu springen, eine REPL, um Ihren Code auszuprobieren, und mehr (@pxref{Introduction,,, geiser, Geiser User Manual}). Zur bequemen Guix-Entwicklung sollten Sie Guiles Ladepfad so ergänzen, dass die Quelldateien in Ihrem Checkout gefunden werden." + +#. type: lisp +#: doc/contributing.texi:184 +#, no-wrap +msgid "" +";; @r{Assuming the Guix checkout is in ~/src/guix.}\n" +"(with-eval-after-load 'geiser-guile\n" +" (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n" +msgstr "" +";; @r{Angenommen das Guix-Checkout ist in ~/src/guix.}\n" +"(with-eval-after-load 'geiser-guile\n" +" (add-to-list 'geiser-guile-load-path \"~/src/guix\"))\n" + +#. type: Plain text +#: doc/contributing.texi:192 +msgid "To actually edit the code, Emacs already has a neat Scheme mode. But in addition to that, you must not miss @url{http://www.emacswiki.org/emacs/ParEdit, Paredit}. It provides facilities to directly operate on the syntax tree, such as raising an s-expression or wrapping it, swallowing or rejecting the following s-expression, etc." +msgstr "Um den Code tatsächlich zu bearbeiten, bietet Emacs schon einen netten Scheme-Modus. Aber Sie dürfen auch @url{http://www.emacswiki.org/emacs/ParEdit, Paredit} nicht verpassen. Es bietet Hilfsmittel, um direkt mit dem Syntaxbaum zu arbeiten, und kann so zum Beispiel einen S-Ausdruck hochheben oder ihn umhüllen, ihn verschlucken oder den nachfolgenden S-Ausdruck verwerfen, etc." + +#. type: cindex +#: doc/contributing.texi:193 +#, no-wrap +msgid "code snippets" +msgstr "Code-Schnipsel" + +#. type: cindex +#: doc/contributing.texi:194 +#, no-wrap +msgid "templates" +msgstr "Vorlagen" + +#. type: cindex +#: doc/contributing.texi:195 +#, no-wrap +msgid "reducing boilerplate" +msgstr "Tipparbeit sparen" + +#. type: Plain text +#: doc/contributing.texi:202 +msgid "We also provide templates for common git commit messages and package definitions in the @file{etc/snippets} directory. These templates can be used with @url{http://joaotavora.github.io/yasnippet/, YASnippet} to expand short trigger strings to interactive text snippets. You may want to add the snippets directory to the @var{yas-snippet-dirs} variable in Emacs." +msgstr "Wir bieten auch Vorlagen für häufige Git-Commit-Nachrichten und Paketdefinitionen im Verzeichnis @file{etc/snippets}. Diese Vorlagen können mit @url{http://joaotavora.github.io/yasnippet/, YASnippet} zusammen benutzt werden, um kurze Auslöse-Zeichenketten zu interaktiven Textschnipseln umzuschreiben. Vielleicht möchten Sie das Schnipselverzeichnis zu Ihrer @var{yas-snippet-dirs}-Variablen in Emacs hinzufügen." + +#. type: lisp +#: doc/contributing.texi:207 +#, no-wrap +msgid "" +";; @r{Assuming the Guix checkout is in ~/src/guix.}\n" +"(with-eval-after-load 'yasnippet\n" +" (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n" +msgstr "" +";; @r{Angenommen das Guix-Checkout ist in ~/src/guix.}\n" +"(with-eval-after-load 'yasnippet\n" +" (add-to-list 'yas-snippet-dirs \"~/src/guix/etc/snippets\"))\n" + +#. type: Plain text +#: doc/contributing.texi:214 +#, fuzzy +#| msgid "The commit message snippets depend on @url{https://magit.vc/, Magit} to display staged files. When editing a commit message type @code{add} followed by @kbd{TAB} to insert a commit message template for adding a package; type @code{update} followed by @kbd{TAB} to insert a template for updating a package; type @code{https} followed by @kbd{TAB} to insert a template for changing the home page URI of a package to HTTPS." +msgid "The commit message snippets depend on @url{https://magit.vc/, Magit} to display staged files. When editing a commit message type @code{add} followed by @kbd{TAB} to insert a commit message template for adding a package; type @code{update} followed by @kbd{TAB} to insert a template for updating a package." +msgstr "Die Schnipsel für Commit-Nachrichten setzen @url{https://magit.vc/, Magit} voraus, um zum Commit vorgemerkte Dateien anzuzeigen. Wenn Sie eine Commit-Nachricht bearbeiten, können Sie @code{add} gefolgt von @kbd{TAB} eintippen, um eine Commit-Nachrichten-Vorlage für das Hinzufügen eines Pakets zu erhalten; tippen Sie @code{update} gefolgt von @kbd{TAB} ein, um eine Vorlage zum Aktualisieren eines Pakets zu bekommen; tippen Sie @code{https} gefolgt von @kbd{TAB} ein, um eine Vorlage zum Ändern der Homepage-URI eines Pakets auf HTTPS einzufügen." + +#. type: Plain text +#: doc/contributing.texi:220 +msgid "The main snippet for @code{scheme-mode} is triggered by typing @code{package...} followed by @kbd{TAB}. This snippet also inserts the trigger string @code{origin...}, which can be expanded further. The @code{origin} snippet in turn may insert other trigger strings ending on @code{...}, which also can be expanded further." +msgstr "Das Hauptschnipsel für @code{scheme-mode} wird ausgelöst, indem Sie @code{package...} gefolgt von @kbd{TAB} eintippen. Dieses Snippet fügt auch die Auslöse-Zeichenkette @code{origin...} ein, die danach weiter umgeschrieben werden kann. Das @code{origin}-Schnipsel kann wiederum andere Auslöse-Zeichenketten einfügen, die alle auf @code{...} enden, was selbst wieder weiter umgeschrieben werden kann." + +#. type: Plain text +#: doc/contributing.texi:228 +msgid "In general our code follows the GNU Coding Standards (@pxref{Top,,, standards, GNU Coding Standards}). However, they do not say much about Scheme, so here are some additional rules." +msgstr "Im Allgemeinen folgt unser Code den GNU Coding Standards (@pxref{Top,,, standards, GNU Coding Standards}). Da diese aber nicht viel über Scheme zu sagen haben, folgen hier einige zusätzliche Regeln." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: subsection +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:234 doc/contributing.texi:236 +#: doc/contributing.texi:237 doc/guix.texi:291 +#, no-wrap +msgid "Programming Paradigm" +msgstr "Programmierparadigmen" + +#. type: menuentry +#: doc/contributing.texi:234 doc/guix.texi:291 +msgid "How to compose your elements." +msgstr "Wie Sie Ihre Elemente zusammenstellen." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: subsection +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:234 doc/contributing.texi:243 +#: doc/contributing.texi:244 doc/guix.texi:291 +#, no-wrap +msgid "Modules" +msgstr "Module" + +#. type: menuentry +#: doc/contributing.texi:234 doc/guix.texi:291 +msgid "Where to store your code?" +msgstr "Wo Sie Ihren Code unterbringen." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: subsection +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:234 doc/contributing.texi:254 +#: doc/contributing.texi:255 doc/guix.texi:291 +#, no-wrap +msgid "Data Types and Pattern Matching" +msgstr "Datentypen und Mustervergleich" + +#. type: menuentry +#: doc/contributing.texi:234 doc/guix.texi:291 +msgid "Implementing data structures." +msgstr "Implementierung von Datenstrukturen." + +#. #-#-#-#-# contributing.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: subsection +#. #-#-#-#-# guix.pot (guix 0.14.0.6706-c6386-dirty) #-#-#-#-# +#. type: menuentry +#: doc/contributing.texi:234 doc/contributing.texi:268 +#: doc/contributing.texi:269 doc/guix.texi:291 +#, no-wrap +msgid "Formatting Code" +msgstr "Formatierung von Code" + +#. type: menuentry +#: doc/contributing.texi:234 doc/guix.texi:291 +msgid "Writing conventions." +msgstr "Schreibkonventionen." + +#. type: Plain text +#: doc/contributing.texi:242 +msgid "Scheme code in Guix is written in a purely functional style. One exception is code that involves input/output, and procedures that implement low-level concepts, such as the @code{memoize} procedure." +msgstr "Scheme-Code wird in Guix auf rein funktionale Weise geschrieben. Eine Ausnahme ist Code, der mit Ein- und Ausgabe zu tun hat, und Prozeduren, die grundlegende Konzepte implementieren, wie zum Beispiel die Prozedur @code{memoize}." + +#. type: Plain text +#: doc/contributing.texi:250 +msgid "Guile modules that are meant to be used on the builder side must live in the @code{(guix build @dots{})} name space. They must not refer to other Guix or GNU modules. However, it is OK for a ``host-side'' module to use a build-side module." +msgstr "Guile-Module, die beim Erstellen nutzbar sein sollen, müssen im Namensraum @code{(guix build @dots{})} leben. Sie dürfen auf keine anderen Guix- oder GNU-Modules Bezug nehmen. Jedoch ist es in Ordnung, wenn ein »wirtsseitiges« Modul ein erstellungsseitiges Modul benutzt." + +#. type: Plain text +#: doc/contributing.texi:253 +msgid "Modules that deal with the broader GNU system should be in the @code{(gnu @dots{})} name space rather than @code{(guix @dots{})}." +msgstr "Module, die mit dem weiteren GNU-System zu tun haben, sollten im Namensraum @code{(gnu @dots{})} und nicht in @code{(guix @dots{})} stehen." + +#. type: Plain text +#: doc/contributing.texi:262 +msgid "The tendency in classical Lisp is to use lists to represent everything, and then to browse them ``by hand'' using @code{car}, @code{cdr}, @code{cadr}, and co. There are several problems with that style, notably the fact that it is hard to read, error-prone, and a hindrance to proper type error reports." +msgstr "Im klassischen Lisp gibt es die Tendenz, Listen zur Darstellung von allem zu benutzen, und diese dann »händisch« zu durchlaufen mit @code{car}, @code{cdr}, @code{cadr} und so weiter. Dieser Stil ist aus verschiedenen Gründen problematisch, insbesondere wegen der Tatsache, dass er schwer zu lesen, schnell fehlerbehaftet und ein Hindernis beim Melden von Typfehlern ist." + +#. type: Plain text +#: doc/contributing.texi:267 +msgid "Guix code should define appropriate data types (for instance, using @code{define-record-type*}) rather than abuse lists. In addition, it should use pattern matching, via Guile’s @code{(ice-9 match)} module, especially when matching lists." +msgstr "Guix-Code sollte angemessene Datentypen definieren (zum Beispiel mit @code{define-record-type*}) statt Listen zu missbrauchen. Außerdem sollte er das @code{(ice-9 match)}-Modul von Guile zum Mustervergleich benutzen, besonders mit Listen." + +#. type: cindex +#: doc/contributing.texi:271 +#, no-wrap +msgid "formatting code" +msgstr "Formatierung von Code" + +#. type: cindex +#: doc/contributing.texi:272 +#, no-wrap +msgid "coding style" +msgstr "Code-Stil" + +#. type: Plain text +#: doc/contributing.texi:279 +msgid "When writing Scheme code, we follow common wisdom among Scheme programmers. In general, we follow the @url{http://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp Style Rules}. This document happens to describe the conventions mostly used in Guile’s code too. It is very thoughtful and well written, so please do read it." +msgstr "Beim Schreiben von Scheme-Code halten wir uns an die üblichen Gepflogenheiten unter Scheme-Programmierern. Im Allgemeinen bedeutet das, dass wir uns an @url{http://mumble.net/~campbell/scheme/style.txt, Riastradh's Lisp Style Rules} halten. Es hat sich ergeben, dass dieses Dokument auch die Konventionen beschreibt, die im Code von Guile hauptsächlich verwendet werden. Es ist gut durchdacht und schön geschrieben, also lesen Sie es bitte." + +#. type: Plain text +#: doc/contributing.texi:286 +msgid "Some special forms introduced in Guix, such as the @code{substitute*} macro, have special indentation rules. These are defined in the @file{.dir-locals.el} file, which Emacs automatically uses. Also note that Emacs-Guix provides @code{guix-devel-mode} mode that indents and highlights Guix code properly (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference Manual})." +msgstr "Ein paar in Guix eingeführte Sonderformen, wie zum Beispiel das @code{substitute*}-Makro, haben abweichende Regeln für die Einrückung. Diese sind in der Datei @file{.dir-locals.el} definiert, die Emacs automatisch benutzt. Beachten Sie auch, dass Emacs-Guix einen Modus namens @code{guix-devel-mode} bereitstellt, der Guix-Code richtig einrückt und hervorhebt (@pxref{Development,,, emacs-guix, The Emacs-Guix Reference Manual})." + +#. type: cindex +#: doc/contributing.texi:287 +#, no-wrap +msgid "indentation, of code" +msgstr "Einrückung, Code-" + +#. type: cindex +#: doc/contributing.texi:288 +#, no-wrap +msgid "formatting, of code" +msgstr "Formatierung, Code-" + +#. type: Plain text +#: doc/contributing.texi:291 +msgid "If you do not use Emacs, please make sure to let your editor knows these rules. To automatically indent a package definition, you can also run:" +msgstr "Falls Sie nicht Emacs verwenden, sollten Sie sicherstellen, dass Ihr Editor diese Regeln kennt. Um eine Paketdefinition automatisch einzurücken, können Sie auch Folgendes ausführen:" + +#. type: example +#: doc/contributing.texi:294 +#, no-wrap +msgid "./etc/indent-code.el gnu/packages/@var{file}.scm @var{package}\n" +msgstr "./etc/indent-code.el gnu/packages/@var{Datei}.scm @var{Paket}\n" + +#. type: Plain text +#: doc/contributing.texi:300 +msgid "This automatically indents the definition of @var{package} in @file{gnu/packages/@var{file}.scm} by running Emacs in batch mode. To indent a whole file, omit the second argument:" +msgstr "Dadurch wird die Definition von @var{Paket} in @file{gnu/packages/@var{Datei}.scm} automatisch eingerückt, indem Emacs im Batch-Modus läuft. Um die Einrückung in einer gesamten Datei vorzunehmen, lassen Sie das zweite Argument weg:" + +#. type: example +#: doc/contributing.texi:303 +#, no-wrap +msgid "./etc/indent-code.el gnu/services/@var{file}.scm\n" +msgstr "./etc/indent-code.el gnu/services/@var{Datei}.scm\n" + +#. type: cindex +#: doc/contributing.texi:305 +#, no-wrap +msgid "Vim, Scheme code editing" +msgstr "Vim, zum Editieren von Scheme-Code" + +#. type: Plain text +#: doc/contributing.texi:311 +msgid "If you are editing code with Vim, we recommend that you run @code{:set autoindent} so that your code is automatically indented as you type. Additionally, @uref{https://www.vim.org/scripts/script.php?script_id=3998, @code{paredit.vim}} may help you deal with all these parentheses." +msgstr "Wenn Sie mit Code mit Vim bearbeiten, empfehlen wir, dass Sie @code{:set autoindent} ausführen, damit Ihr Code automatisch eingerückt wird, während Sie ihn schreiben. Außerdem könnte Ihnen @uref{https://www.vim.org/scripts/script.php?script_id=3998, @code{paredit.vim}} dabei helfen, mit all diesen Klammern fertigzuwerden." + +#. type: Plain text +#: doc/contributing.texi:315 +msgid "We require all top-level procedures to carry a docstring. This requirement can be relaxed for simple private procedures in the @code{(guix build @dots{})} name space, though." +msgstr "Wir fordern von allen Prozeduren auf oberster Ebene, dass sie über einen Docstring verfügen. Diese Voraussetzung kann jedoch bei einfachen, privaten Prozeduren im Namensraum @code{(guix build @dots{})} aufgeweicht werden." + +#. type: Plain text +#: doc/contributing.texi:318 +msgid "Procedures should not have more than four positional parameters. Use keyword parameters for procedures that take more than four parameters." +msgstr "Prozeduren sollten nicht mehr als vier positionsbestimmte Parameter haben. Benutzen Sie Schlüsselwort-Parameter für Prozeduren, die mehr als vier Parameter entgegennehmen." + +#. type: Plain text +#: doc/contributing.texi:327 +msgid "Development is done using the Git distributed version control system. Thus, access to the repository is not strictly necessary. We welcome contributions in the form of patches as produced by @code{git format-patch} sent to the @email{guix-patches@@gnu.org} mailing list." +msgstr "Die Entwicklung wird mit Hilfe des verteilten Versionskontrollsystems Git durchgeführt. Daher ist eine ständige Verbindung zum Repository nicht unbedingt erforderlich. Wir begrüßen Beiträge in Form von Patches, die mittels @code{git format-patch} erstellt und an die Mailingliste @email{guix-patches@@gnu.org} geschickt werden." + +#. type: Plain text +#: doc/contributing.texi:334 +msgid "This mailing list is backed by a Debbugs instance accessible at @uref{https://bugs.gnu.org/guix-patches}, which allows us to keep track of submissions. Each message sent to that mailing list gets a new tracking number assigned; people can then follow up on the submission by sending email to @code{@var{NNN}@@debbugs.gnu.org}, where @var{NNN} is the tracking number (@pxref{Sending a Patch Series})." +msgstr "Diese Mailing-Liste setzt auf einer Debbugs-Instanz auf, die zugänglich ist unter @uref{https://bugs.gnu.org/guix-patches}, wodurch wir den Überblick über Eingereichtes behalten können. Jede an diese Mailing-Liste gesendete Nachricht bekommt eine neue Folgenummer zugewiesen, so dass man eine Folge-Email zur Einreichung an @code{@var{NNN}@@debbugs.gnu.org} senden kann, wobei @var{NNN} für die Folgenummer steht (@pxref{Sending a Patch Series})." + +#. type: Plain text +#: doc/contributing.texi:338 +msgid "Please write commit logs in the ChangeLog format (@pxref{Change Logs,,, standards, GNU Coding Standards}); you can check the commit history for examples." +msgstr "Bitte schreiben Sie Commit-Logs im ChangeLog-Format (@pxref{Change Logs,,, standards, GNU Coding Standards}); dazu finden Sie Beispiele unter den bisherigen Commits." + +#. type: Plain text +#: doc/contributing.texi:341 +msgid "Before submitting a patch that adds or modifies a package definition, please run through this check list:" +msgstr "Bevor Sie einen Patch einreichen, der eine Paketdefinition hinzufügt oder verändert, gehen Sie bitte diese Prüfliste:" + +#. type: enumerate +#: doc/contributing.texi:348 +msgid "If the authors of the packaged software provide a cryptographic signature for the release tarball, make an effort to verify the authenticity of the archive. For a detached GPG signature file this would be done with the @code{gpg --verify} command." +msgstr "Wenn die Autoren der verpackten Software eine kryptographische Signatur für den Tarball der Veröffentlichung anbieten, so machen Sie sich bitte die Mühe, die Echtheit des Archivs zu überprüfen. Für eine abgetrennte GPG-Signaturdatei würden Sie das mit dem Befehl @code{gpg --verify} tun." + +#. type: enumerate +#: doc/contributing.texi:352 +msgid "Take some time to provide an adequate synopsis and description for the package. @xref{Synopses and Descriptions}, for some guidelines." +msgstr "Nehmen Sie sich die Zeit, eine passende Zusammenfassung und Beschreibung für das Paket zu verfassen. Unter @xref{Synopses and Descriptions} finden Sie dazu einige Richtlinien." + +#. type: enumerate +#: doc/contributing.texi:357 +msgid "Run @code{guix lint @var{package}}, where @var{package} is the name of the new or modified package, and fix any errors it reports (@pxref{Invoking guix lint})." +msgstr "Verwenden Sie @code{guix lint @var{Paket}}, wobei @var{Paket} das neue oder geänderte Paket bezeichnet, und beheben Sie alle gemeldeten Fehler (@pxref{Invoking guix lint})." + +#. type: enumerate +#: doc/contributing.texi:361 +msgid "Make sure the package builds on your platform, using @code{guix build @var{package}}." +msgstr "Stellen Sie sicher, dass das Paket auf Ihrer Plattform erstellt werden kann, indem Sie @code{guix build @var{Paket}} ausführen." + +#. type: cindex +#: doc/contributing.texi:363 +#, no-wrap +msgid "bundling" +msgstr "gebündelt" + +#. type: enumerate +#: doc/contributing.texi:366 +msgid "Make sure the package does not use bundled copies of software already available as separate packages." +msgstr "Achten Sie darauf, dass im Paket keine Software gebündelt mitgeliefert wird, die bereits in separaten Paketen zur Verfügung steht." + +#. type: enumerate +#: doc/contributing.texi:375 +msgid "Sometimes, packages include copies of the source code of their dependencies as a convenience for users. However, as a distribution, we want to make sure that such packages end up using the copy we already have in the distribution, if there is one. This improves resource usage (the dependency is built and stored only once), and allows the distribution to make transverse changes such as applying security updates for a given software package in a single place and have them affect the whole system---something that bundled copies prevent." +msgstr "Manchmal enthalten Pakete Kopien des Quellcodes ihrer Abhängigkeiten, um Nutzern die Installation zu erleichtern. Als eine Distribution wollen wir jedoch sicherstellen, dass für solche Pakete die schon in der Distribution verfügbare Fassung benutzen, sofern es eine gibt. Dadurch wird sowohl der Ressourcenverbrauch optimiert (die Abhängigkeit wird so nur einmal erstellt und gespeichert) als auch der Distribution die Möglichkeit gegeben, ergänzende Änderungen durchzuführen, um beispielsweise Sicherheitsaktualisierungen für ein bestimmtes Paket an nur einem Ort einzuspielen, die das gesamte System betreffen — gebündelt mitgelieferte Kopien würden dies verhindern." + +#. type: enumerate +#: doc/contributing.texi:382 +msgid "Take a look at the profile reported by @command{guix size} (@pxref{Invoking guix size}). This will allow you to notice references to other packages unwillingly retained. It may also help determine whether to split the package (@pxref{Packages with Multiple Outputs}), and which optional dependencies should be used." +msgstr "Schauen Sie sich das von @command{guix size} ausgegebene Profil an (@pxref{Invoking guix size}). Dadurch können Sie Referenzen auf andere Pakete finden, die ungewollt vorhanden sind. Dies kann auch dabei helfen, zu entscheiden, ob das Paket aufgespalten werden sollte (@pxref{Packages with Multiple Outputs}) und welche optionalen Abhängigkeiten verwendet werden sollten." + +#. type: enumerate +#: doc/contributing.texi:387 +msgid "For important changes, check that dependent package (if applicable) are not affected by the change; @code{guix refresh --list-dependent @var{package}} will help you do that (@pxref{Invoking guix refresh})." +msgstr "Achten Sie bei wichtigen Änderungen darauf, dass abhängige Pakete (falls vorhanden) nicht von der Änderung beeinträchtigt werden; @code{guix refresh --list-dependent @var{Paket}} hilft Ihnen dabei (@pxref{Invoking guix refresh})." + +#. type: cindex +#: doc/contributing.texi:389 +#, no-wrap +msgid "branching strategy" +msgstr "Branching-Strategie" + +#. type: cindex +#: doc/contributing.texi:390 +#, no-wrap +msgid "rebuild scheduling strategy" +msgstr "Neuerstellungs-Zeitplan" + +#. type: enumerate +#: doc/contributing.texi:393 +msgid "Depending on the number of dependent packages and thus the amount of rebuilding induced, commits go to different branches, along these lines:" +msgstr "Je nachdem, wieviele abhängige Pakete es gibt, und entsprechend wieviele Neuerstellungen dadurch nötig würden, finden Commits auf anderen Branches statt, nach ungefähr diesen Regeln:" + +#. type: item +#: doc/contributing.texi:395 +#, no-wrap +msgid "300 dependent packages or less" +msgstr "300 abhängige Pakete oder weniger" + +#. type: table +#: doc/contributing.texi:397 +msgid "@code{master} branch (non-disruptive changes)." +msgstr "@code{master}-Branch (störfreie Änderungen)." + +#. type: item +#: doc/contributing.texi:398 +#, no-wrap +msgid "between 300 and 1,200 dependent packages" +msgstr "zwischen 300 und 1200 abhängige Pakete" + +#. type: table +#: doc/contributing.texi:403 +msgid "@code{staging} branch (non-disruptive changes). This branch is intended to be merged in @code{master} every 3 weeks or so. Topical changes (e.g., an update of the GNOME stack) can instead go to a specific branch (say, @code{gnome-updates})." +msgstr "@code{staging}-Branch (störfreie Änderungen). Dieser Branch wird circa alle 3 Wochen in @code{master} gemerget. Themenbezogene Änderungen (z.B. eine Aktualisierung der GNOME-Plattform) können stattdessen auch auf einem eigenen Branch umgesetzt werden (wie @code{gnome-updates})." + +#. type: item +#: doc/contributing.texi:404 +#, no-wrap +msgid "more than 1,200 dependent packages" +msgstr "mehr als 1200 abhängige Pakete" + +#. type: table +#: doc/contributing.texi:408 +msgid "@code{core-updates} branch (may include major and potentially disruptive changes). This branch is intended to be merged in @code{master} every 2.5 months or so." +msgstr "@code{core-updates}-Branch (kann auch größere und womöglich andere Software beeinträchtigende Änderungen umfassen). Dieser Branch wird planmäßig in @code{master} alle 2,5 Monate oder so gemerget." + +#. type: enumerate +#: doc/contributing.texi:415 +msgid "All these branches are @uref{https://hydra.gnu.org/project/gnu, tracked by our build farm} and merged into @code{master} once everything has been successfully built. This allows us to fix issues before they hit users, and to reduce the window during which pre-built binaries are not available." +msgstr "All diese Branches werden kontinuierlich @uref{https://hydra.gnu.org/project/gnu, auf unserer Build-Farm} erstellt und in @code{master} gemerget, sobald alles erfolgreich erstellt worden ist. Dadurch können wir Probleme beheben, bevor sie bei Nutzern auftreten, und zudem das Zeitfenster, während dessen noch keine vorerstellten Binärdateien verfügbar sind, verkürzen." + +#. type: enumerate +#: doc/contributing.texi:422 +msgid "Generally, branches other than @code{master} are considered @emph{frozen} if there has been a recent evaluation, or there is a corresponding @code{-next} branch. Please ask on the mailing list or IRC if unsure where to place a patch." +msgstr "Im Allgemeinen werden Branches außer @code{master} als @emph{unveränderlich} angesehen, wenn sie kürzlich ausgewertet wurden oder ein entsprechender @code{-next}-Branch existiert. Bitte fragen Sie auf der Mailing-Liste oder IRC, wenn Sie sich nicht sicher sind, wo ein Patch eingespielt werden sollte." + +#. type: cindex +#: doc/contributing.texi:424 +#, no-wrap +msgid "determinism, of build processes" +msgstr "Determinismus, von Erstellungsprozessen" + +#. type: cindex +#: doc/contributing.texi:425 +#, no-wrap +msgid "reproducible builds, checking" +msgstr "Reproduzierbare Erstellungen, Überprüfung" + +#. type: enumerate +#: doc/contributing.texi:429 +msgid "Check whether the package's build process is deterministic. This typically means checking whether an independent build of the package yields the exact same result that you obtained, bit for bit." +msgstr "Überprüfen Sie, ob der Erstellungsprozess deterministisch ist. Dazu prüfen Sie typischerweise, ob eine unabhängige Erstellung des Pakets genau dasselbe Ergebnis wie Ihre Erstellung hat, Bit für Bit." + +#. type: enumerate +#: doc/contributing.texi:432 +msgid "A simple way to do that is by building the same package several times in a row on your machine (@pxref{Invoking guix build}):" +msgstr "Dies können Sie leicht tun, indem Sie dasselbe Paket mehrere Male hintereinander auf Ihrer Maschine erstellen (@pxref{Invoking guix build}):" + +#. type: example +#: doc/contributing.texi:435 +#, no-wrap +msgid "guix build --rounds=2 my-package\n" +msgstr "guix build --rounds=2 mein-paket\n" + +#. type: enumerate +#: doc/contributing.texi:439 +msgid "This is enough to catch a class of common non-determinism issues, such as timestamps or randomly-generated output in the build result." +msgstr "Dies reicht aus, um eine ganze Klasse häufiger Ursachen von Nichtdeterminismus zu finden, wie zum Beispiel Zeitstempel oder zufallsgenerierte Ausgaben im Ergebnis der Erstellung." + +#. type: enumerate +#: doc/contributing.texi:449 +msgid "Another option is to use @command{guix challenge} (@pxref{Invoking guix challenge}). You may run it once the package has been committed and built by @code{hydra.gnu.org} to check whether it obtains the same result as you did. Better yet: Find another machine that can build it and run @command{guix publish}. Since the remote build machine is likely different from yours, this can catch non-determinism issues related to the hardware---e.g., use of different instruction set extensions---or to the operating system kernel---e.g., reliance on @code{uname} or @file{/proc} files." +msgstr "Eine weitere Möglichkeit ist, @command{guix challenge} (@pxref{Invoking guix challenge}) zu benutzen. Sie können es ausführen, sobald ein Paket commitet und von @code{hydra.gnu.org} erstellt wurde, um zu sehen, ob dort dasselbe Ergebnis wie bei Ihnen geliefert wurde. Noch besser: Finden Sie eine andere Maschine, die das Paket erstellen kann, und führen Sie @command{guix publish} aus. Da sich die entfernte Erstellungsmaschine wahrscheinlich von Ihrer unterscheidet, können Sie auf diese Weise Probleme durch Nichtdeterminismus erkennen, die mit der Hardware zu tun haben — zum Beispiel die Nutzung anderer Befehlssatzerweiterungen — oder mit dem Betriebssystem-Kernel — zum Beispiel, indem @code{uname} oder @file{/proc}-Dateien verwendet werden." + +# Hier gehe ich mal davon aus, dass Dokumentation generell zuerst in Englisch geschrieben wird, daher, werden solche Begriffe auch hier nicht übersetzt. +#. type: enumerate +#: doc/contributing.texi:455 +msgid "When writing documentation, please use gender-neutral wording when referring to people, such as @uref{https://en.wikipedia.org/wiki/Singular_they, singular ``they''@comma{} ``their''@comma{} ``them''}, and so forth." +msgstr "Beim Schreiben von Dokumentation achten Sie bitte auf eine geschlechtsneutrale Wortwahl, wenn Sie sich auf Personen beziehen, wie @uref{https://en.wikipedia.org/wiki/Singular_they, »they«@comma{} »their«@comma{} »them« im Singular}, und so weiter." + +#. type: enumerate +#: doc/contributing.texi:459 +msgid "Verify that your patch contains only one set of related changes. Bundling unrelated changes together makes reviewing harder and slower." +msgstr "Stelllen Sie sicher, dass Ihr Patch nur einen Satz zusammengehöriger Änderungen umfasst. Das Zusammenfassen nicht zusammengehöriger Änderungen erschwert und bremst das Durchsehen Ihres Patches." + +#. type: enumerate +#: doc/contributing.texi:462 +msgid "Examples of unrelated changes include the addition of several packages, or a package update along with fixes to that package." +msgstr "Beispiele für nicht zusammengehörige Änderungen sind das Hinzufügen mehrerer Pakete auf einmal, oder das Aktualisieren eines Pakets auf eine neue Version zusammen mit Fehlerbehebungen für das Paket." + +#. type: enumerate +#: doc/contributing.texi:467 +msgid "Please follow our code formatting rules, possibly running the @command{etc/indent-code.el} script to do that automatically for you (@pxref{Formatting Code})." +msgstr "Bitte befolgen Sie unsere Richtlinien für die Code-Formatierung, womöglich wollen Sie dies automatisch tun lassen durch das Skript @command{etc/indent-code.el} (@pxref{Formatting Code})." + +#. type: Plain text +#: doc/contributing.texi:477 +msgid "When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a subject. You may use your email client or the @command{git send-email} command (@pxref{Sending a Patch Series}). We prefer to get patches in plain text messages, either inline or as MIME attachments. You are advised to pay attention if your email client changes anything like line breaks or indentation which could potentially break the patches." +msgstr "Bitte benutzen Sie @samp{[PATCH] @dots{}} als Betreff, wenn Sie einen Patch an die Mailing-Liste schicken. Sie können dazu Ihr E-mail-Programm oder den Befehl @command{git send-email} benutzen (@pxref{Sending a Patch Series}). Wir bevorzugen es, Patches als reine Textnachrichten zu erhalten, entweder eingebettet (inline) oder als MIME-Anhänge. Sie sind dazu angehalten, zu überprüfen, ob Ihr Mail-Programm solche Dinge wie Zeilenumbrüche oder die Einrückung verändert, wodurch die Patches womöglich nicht mehr funktionieren." + +#. type: Plain text +#: doc/contributing.texi:480 +msgid "When a bug is resolved, please close the thread by sending an email to @email{@var{NNN}-done@@debbugs.gnu.org}." +msgstr "Wenn dadurch ein Fehler behoben wurde, schließen Sie bitte den Thread, indem Sie eine E-mail an @email{@var{NNN}-done@@debbugs.gnu.org} senden." + +#. type: anchor{#1} +#: doc/contributing.texi:481 doc/contributing.texi:483 +#, no-wrap +msgid "Sending a Patch Series" +msgstr "Senden einer Patch-Reihe" + +#. type: cindex +#: doc/contributing.texi:483 +#, no-wrap +msgid "patch series" +msgstr "Patch-Reihe" + +#. type: code{#1} +#: doc/contributing.texi:484 +#, no-wrap +msgid "git send-email" +msgstr "git send-email" + +#. type: code{#1} +#: doc/contributing.texi:485 +#, no-wrap +msgid "git-send-email" +msgstr "git-send-email" + +#. type: Plain text +#: doc/contributing.texi:493 +msgid "When sending a patch series (e.g., using @code{git send-email}), please first send one message to @email{guix-patches@@gnu.org}, and then send subsequent patches to @email{@var{NNN}@@debbugs.gnu.org} to make sure they are kept together. See @uref{https://debbugs.gnu.org/Advanced.html, the Debbugs documentation} for more information." +msgstr "Wenn Sie eine Patch-Reihe senden (z.B. mit @code{git send-email}), schicken Sie bitte als Erstes eine Nachricht an @email{guix-patches@@gnu.org} und dann nachfolgende Patches an @email{@var{NNN}@@debbugs.gnu.org}, um sicherzustellen, dass sie zusammen bearbeitet werden. Siehe @uref{https://debbugs.gnu.org/Advanced.html, die Debbugs-Dokumentation} für weitere Informationen." + +#. type: Plain text +#: doc/guix.texi:7 +msgid "@documentencoding UTF-8" +msgstr "" +"@documentencoding UTF-8\n" +"@documentlanguage de\n" +"@frenchspacing on" + +#. type: title +#: doc/guix.texi:7 doc/guix.texi:78 +#, no-wrap +msgid "GNU Guix Reference Manual" +msgstr "Referenzhandbuch zu GNU Guix" + +#. type: include +#: doc/guix.texi:10 +#, no-wrap +msgid "version.texi" +msgstr "version-de.texi" + +#. type: copying +#: doc/guix.texi:52 +#, fuzzy +#| msgid "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017, 2018 Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, 2018 Clément Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, 2018 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 Christopher Allan Webber@* Copyright @copyright{} 2017, 2018 Marius Bakke@* Copyright @copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 Maxim Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright @copyright{} 2018 Gábor Boskovits@*" +msgid "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017 Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, 2018 Clément Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 Christopher Allan Webber@* Copyright @copyright{} 2017, 2018 Marius Bakke@* Copyright @copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 Maxim Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby" +msgstr "Copyright @copyright{} 2012, 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès@* Copyright @copyright{} 2013, 2014, 2016 Andreas Enge@* Copyright @copyright{} 2013 Nikita Karetnikov@* Copyright @copyright{} 2014, 2015, 2016 Alex Kost@* Copyright @copyright{} 2015, 2016 Mathieu Lirzin@* Copyright @copyright{} 2014 Pierre-Antoine Rault@* Copyright @copyright{} 2015 Taylan Ulrich Bayırlı/Kammer@* Copyright @copyright{} 2015, 2016, 2017 Leo Famulari@* Copyright @copyright{} 2015, 2016, 2017, 2018 Ricardo Wurmus@* Copyright @copyright{} 2016 Ben Woodcroft@* Copyright @copyright{} 2016, 2017, 2018 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nils Gillmann@* Copyright @copyright{} 2016, 2017, 2018 Jan Nieuwenhuizen@* Copyright @copyright{} 2016 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2017, 2018 Clément Lassieur@* Copyright @copyright{} 2017 Mathieu Othacehe@* Copyright @copyright{} 2017 Federico Beffa@* Copyright @copyright{} 2017, 2018 Carlo Zancanaro@* Copyright @copyright{} 2017 Thomas Danckaert@* Copyright @copyright{} 2017 humanitiesNerd@* Copyright @copyright{} 2017 Christopher Allan Webber@* Copyright @copyright{} 2017, 2018 Marius Bakke@* Copyright @copyright{} 2017 Hartmut Goebel@* Copyright @copyright{} 2017 Maxim Cournoyer@* Copyright @copyright{} 2017, 2018 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* Copyright @copyright{} 2017, 2018 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018 Oleg Pykhalov@* Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright @copyright{} 2018 Gábor Boskovits@*" + +#. type: copying +#: doc/guix.texi:59 +msgid "Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''." +msgstr "Es ist Ihnen gestattet, dieses Dokument zu vervielfältigen, weiterzugeben und/oder zu verändern, unter den Bedingungen der GNU Free Documentation License, entweder gemäß Version 1.3 der Lizenz oder (nach Ihrer Option) einer späteren Version, die von der Free Software Foundation veröffentlicht wurde, ohne unveränderliche Abschnitte, ohne vorderen Umschlagtext und ohne hinteren Umschlagtext. Eine Kopie der Lizenz finden Sie im Abschnitt mit dem Titel »GNU Free Documentation License«." + +#. type: dircategory +#: doc/guix.texi:61 +#, no-wrap +msgid "System administration" +msgstr "Systemadministration" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Guix: (guix)" +msgstr "Guix: (guix.de)" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Manage installed software and system configuration." +msgstr "Installierte Software und Systemkonfigurationen verwalten." + +#. type: menuentry +#: doc/guix.texi:68 +msgid "guix package: (guix)Invoking guix package" +msgstr "guix package: (guix.de)guix package aufrufen" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Installing, removing, and upgrading packages." +msgstr "Pakete installieren, entfernen und aktualisieren." + +#. type: menuentry +#: doc/guix.texi:68 +msgid "guix gc: (guix)Invoking guix gc" +msgstr "guix gc: (guix.de)guix gc aufrufen" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Reclaiming unused disk space." +msgstr "Unbenutzten Plattenspeicher wieder freigeben." + +#. type: menuentry +#: doc/guix.texi:68 +msgid "guix pull: (guix)Invoking guix pull" +msgstr "guix pull: (guix.de)guix pull aufrufen" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Update the list of available packages." +msgstr "Die Liste verfügbarer Pakete aktualisieren." + +#. type: menuentry +#: doc/guix.texi:68 +msgid "guix system: (guix)Invoking guix system" +msgstr "guix system: (guix.de)guix system aufrufen" + +#. type: menuentry +#: doc/guix.texi:68 +msgid "Manage the operating system configuration." +msgstr "Die Betriebssystemkonfiguration verwalten." + +#. type: dircategory +#: doc/guix.texi:70 +#, no-wrap +msgid "Software development" +msgstr "Softwareentwicklung" + +#. type: menuentry +#: doc/guix.texi:75 +msgid "guix environment: (guix)Invoking guix environment" +msgstr "guix environment: (guix.de)guix environment aufrufen" + +#. type: menuentry +#: doc/guix.texi:75 +msgid "Building development environments with Guix." +msgstr "Umgebungen für Entwickler erstellen" + +#. type: menuentry +#: doc/guix.texi:75 +msgid "guix build: (guix)Invoking guix build" +msgstr "guix build: (guix.de)guix build aufrufen" + +#. type: menuentry +#: doc/guix.texi:75 +msgid "Building packages." +msgstr "Erstellen von Paketen." + +#. type: menuentry +#: doc/guix.texi:75 +msgid "guix pack: (guix)Invoking guix pack" +msgstr "guix pack: (guix.de)guix pack aufrufen" + +#. type: menuentry +#: doc/guix.texi:75 +msgid "Creating binary bundles." +msgstr "Bündel aus Binärdateien erstellen." + +#. type: subtitle +#: doc/guix.texi:79 +#, no-wrap +msgid "Using the GNU Guix Functional Package Manager" +msgstr "Den funktionalen Paketmanager GNU Guix benutzen" + +#. type: author +#: doc/guix.texi:80 +#, no-wrap +msgid "The GNU Guix Developers" +msgstr "Die GNU-Guix-Entwickler" + +#. type: titlepage +#: doc/guix.texi:86 +msgid "Edition @value{EDITION} @* @value{UPDATED} @*" +msgstr "Edition @value{EDITION} @* @value{UPDATED} @*" + +#. type: node +#: doc/guix.texi:93 +#, no-wrap +msgid "Top" +msgstr "Top" + +#. type: top +#: doc/guix.texi:94 +#, no-wrap +msgid "GNU Guix" +msgstr "GNU Guix" + +#. type: Plain text +#: doc/guix.texi:98 +msgid "This document describes GNU Guix version @value{VERSION}, a functional package management tool written for the GNU system." +msgstr "Dieses Dokument beschreibt GNU Guix, Version @value{VERSION}, ein funktionales Paketverwaltungswerkzeug, das für das GNU-System geschrieben wurde." + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:296 doc/guix.texi:297 +#, no-wrap +msgid "Introduction" +msgstr "Einführung" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "What is Guix about?" +msgstr "Was ist Guix überhaupt?" + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:117 doc/guix.texi:369 doc/guix.texi:370 +#, no-wrap +msgid "Installation" +msgstr "Installation" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Installing Guix." +msgstr "Guix installieren." + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:132 doc/guix.texi:1657 doc/guix.texi:1658 +#, no-wrap +msgid "Package Management" +msgstr "Paketverwaltung" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Package installation, upgrade, etc." +msgstr "Pakete installieren, aktualisieren usw." + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:152 doc/guix.texi:3225 doc/guix.texi:3226 +#, no-wrap +msgid "Programming Interface" +msgstr "Programmierschnittstelle" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Using Guix in Scheme." +msgstr "Guix in Scheme verwenden." + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:166 doc/guix.texi:5533 doc/guix.texi:5534 +#, no-wrap +msgid "Utilities" +msgstr "Zubehör" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Package management commands." +msgstr "Befehle zur Paketverwaltung." + +#. type: chapter +#: doc/guix.texi:107 doc/guix.texi:191 doc/guix.texi:8191 doc/guix.texi:8192 +#, no-wrap +msgid "GNU Distribution" +msgstr "GNU-Distribution" + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Software for your friendly GNU system." +msgstr "Software für Ihr freundliches GNU-System." + +#. type: menuentry +#: doc/guix.texi:107 +msgid "Your help needed!" +msgstr "Ihre Hilfe ist nötig!" + +#. type: chapter +#: doc/guix.texi:112 doc/guix.texi:22822 doc/guix.texi:22823 +#, no-wrap +msgid "Acknowledgments" +msgstr "Danksagungen" + +#. type: menuentry +#: doc/guix.texi:112 +msgid "Thanks!" +msgstr "Danke!" + +#. type: appendix +#: doc/guix.texi:112 doc/guix.texi:22844 doc/guix.texi:22845 +#, no-wrap +msgid "GNU Free Documentation License" +msgstr "GNU-Lizenz für freie Dokumentation" + +#. type: menuentry +#: doc/guix.texi:112 +msgid "The license of this manual." +msgstr "Die Lizenz dieses Handbuchs." + +#. type: unnumbered +#: doc/guix.texi:112 doc/guix.texi:22850 doc/guix.texi:22851 +#, no-wrap +msgid "Concept Index" +msgstr "Konzeptverzeichnis" + +#. type: menuentry +#: doc/guix.texi:112 +msgid "Concepts." +msgstr "Konzepte." + +#. type: unnumbered +#: doc/guix.texi:112 doc/guix.texi:22854 doc/guix.texi:22855 +#, no-wrap +msgid "Programming Index" +msgstr "Programmierverzeichnis" + +#. type: menuentry +#: doc/guix.texi:112 +msgid "Data types, functions, and variables." +msgstr "Datentypen, Funktionen und Variable." + +#. type: menuentry +#: doc/guix.texi:115 +msgid "--- The Detailed Node Listing ---" +msgstr "--- Detaillierte Liste der Knoten ---" + +#. type: section +#: doc/guix.texi:124 doc/guix.texi:400 doc/guix.texi:402 doc/guix.texi:403 +#, no-wrap +msgid "Binary Installation" +msgstr "Aus Binärdatei installieren" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Getting Guix running in no time!" +msgstr "Guix installieren, ohne Zeit zu verlieren!" + +#. type: section +#: doc/guix.texi:124 doc/guix.texi:400 doc/guix.texi:598 doc/guix.texi:599 +#, no-wrap +msgid "Requirements" +msgstr "Voraussetzungen" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Software needed to build and run Guix." +msgstr "Zum Erstellen und Benutzen von Guix nötige Software." + +#. type: section +#: doc/guix.texi:124 doc/guix.texi:400 doc/guix.texi:683 doc/guix.texi:684 +#, no-wrap +msgid "Running the Test Suite" +msgstr "Die Testsuite laufen lassen" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Testing Guix." +msgstr "Guix testen." + +#. type: section +#: doc/guix.texi:124 doc/guix.texi:126 doc/guix.texi:400 doc/guix.texi:748 +#: doc/guix.texi:749 +#, no-wrap +msgid "Setting Up the Daemon" +msgstr "Den Daemon einrichten" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Preparing the build daemon's environment." +msgstr "Wie man die Umgebung des Erstellungs-Daemons einrichtet." + +#. type: node +#: doc/guix.texi:124 doc/guix.texi:400 doc/guix.texi:1181 +#, no-wrap +msgid "Invoking guix-daemon" +msgstr "Aufruf des guix-daemon" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Running the build daemon." +msgstr "Den Erstellungs-Daemon laufen lassen." + +#. type: section +#: doc/guix.texi:124 doc/guix.texi:400 doc/guix.texi:1446 doc/guix.texi:1447 +#, no-wrap +msgid "Application Setup" +msgstr "Anwendungen einrichten" + +#. type: menuentry +#: doc/guix.texi:124 doc/guix.texi:400 +msgid "Application-specific setup." +msgstr "Anwendungsspezifische Einstellungen." + +#. type: subsection +#: doc/guix.texi:130 doc/guix.texi:768 doc/guix.texi:770 doc/guix.texi:771 +#, no-wrap +msgid "Build Environment Setup" +msgstr "Einrichten der Erstellungsumgebung" + +#. type: menuentry +#: doc/guix.texi:130 doc/guix.texi:768 +msgid "Preparing the isolated build environment." +msgstr "Die isolierte Umgebung zum Erstellen vorbereiten." + +#. type: node +#: doc/guix.texi:130 doc/guix.texi:768 doc/guix.texi:887 +#, no-wrap +msgid "Daemon Offload Setup" +msgstr "Auslagern des Daemons einrichten" + +#. type: menuentry +#: doc/guix.texi:130 doc/guix.texi:768 +msgid "Offloading builds to remote machines." +msgstr "Erstellungen auf entfernte Maschinen auslagern." + +#. type: subsection +#: doc/guix.texi:130 doc/guix.texi:768 doc/guix.texi:1095 doc/guix.texi:1096 +#, no-wrap +msgid "SELinux Support" +msgstr "SELinux-Unterstützung" + +#. type: menuentry +#: doc/guix.texi:130 doc/guix.texi:768 +msgid "Using an SELinux policy for the daemon." +msgstr "Wie man eine SELinux-Richtlinie für den Daemon einrichtet." + +#. type: section +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:1689 doc/guix.texi:1690 +#, no-wrap +msgid "Features" +msgstr "Funktionalitäten" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "How Guix will make your life brighter." +msgstr "Wie Guix Ihr Leben schöner machen wird." + +#. type: node +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:1766 +#, no-wrap +msgid "Invoking guix package" +msgstr "Aufruf von guix package" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Package installation, removal, etc." +msgstr "Pakete installieren, entfernen usw." + +#. type: section +#: doc/guix.texi:141 doc/guix.texi:143 doc/guix.texi:1687 doc/guix.texi:2250 +#: doc/guix.texi:2251 +#, no-wrap +msgid "Substitutes" +msgstr "Substitute" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Downloading pre-built binaries." +msgstr "Vorerstelle Binärdateien herunterladen." + +#. type: section +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:2483 doc/guix.texi:2484 +#, no-wrap +msgid "Packages with Multiple Outputs" +msgstr "Pakete mit mehreren Ausgaben." + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Single source package, multiple outputs." +msgstr "Ein Quellpaket, mehrere Ausgaben." + +#. type: node +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:2537 +#, no-wrap +msgid "Invoking guix gc" +msgstr "Aufruf von guix gc" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Running the garbage collector." +msgstr "Den Müllsammler laufen lassen." + +#. type: node +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:2725 +#, no-wrap +msgid "Invoking guix pull" +msgstr "Aufruf von guix pull" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Fetching the latest Guix and distribution." +msgstr "Das neueste Guix samt Distribution laden." + +#. type: node +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:2836 +#, no-wrap +msgid "Invoking guix pack" +msgstr "Aufruf von guix pack" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Creating software bundles." +msgstr "Software-Bündel erstellen." + +#. type: node +#: doc/guix.texi:141 doc/guix.texi:1687 doc/guix.texi:3060 +#, no-wrap +msgid "Invoking guix archive" +msgstr "Aufruf von guix archive" + +#. type: menuentry +#: doc/guix.texi:141 doc/guix.texi:1687 +msgid "Exporting and importing store files." +msgstr "Import und Export von Store-Dateien." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2275 doc/guix.texi:2276 +#, no-wrap +msgid "Official Substitute Server" +msgstr "Offizieller Substitut-Server" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "One particular source of substitutes." +msgstr "Eine besondere Quelle von Substituten." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2305 doc/guix.texi:2306 +#, no-wrap +msgid "Substitute Server Authorization" +msgstr "Substitut-Server autorisieren" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "How to enable or disable substitutes." +msgstr "Wie man Substitute an- und abschaltet." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2378 doc/guix.texi:2379 +#, no-wrap +msgid "Substitute Authentication" +msgstr "Substitutauthentifizierung" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "How Guix verifies substitutes." +msgstr "Wie Guix Substitute verifiziert." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2413 doc/guix.texi:2414 +#, no-wrap +msgid "Proxy Settings" +msgstr "Proxy-Einstellungen" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "How to get substitutes via proxy." +msgstr "Wie Sie Substitute über einen Proxy beziehen." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2425 doc/guix.texi:2426 +#, no-wrap +msgid "Substitution Failure" +msgstr "Fehler bei der Substitution" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "What happens when substitution fails." +msgstr "Was passiert, wenn die Substitution fehlschlägt." + +#. type: subsection +#: doc/guix.texi:150 doc/guix.texi:2273 doc/guix.texi:2453 doc/guix.texi:2454 +#, no-wrap +msgid "On Trusting Binaries" +msgstr "Vom Vertrauen gegenüber Binärdateien" + +#. type: menuentry +#: doc/guix.texi:150 doc/guix.texi:2273 +msgid "How can you trust that binary blob?" +msgstr "Wie können Sie diesem binären Blob trauen?" + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:161 doc/guix.texi:3260 doc/guix.texi:3262 +#: doc/guix.texi:3263 +#, no-wrap +msgid "Defining Packages" +msgstr "Pakete definieren" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Defining new packages." +msgstr "Wie Sie neue Pakete definieren." + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:3260 doc/guix.texi:3726 doc/guix.texi:3727 +#, no-wrap +msgid "Build Systems" +msgstr "Erstellungssysteme" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Specifying how packages are built." +msgstr "Angeben, wie Pakete erstellt werden." + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:3260 doc/guix.texi:4321 doc/guix.texi:4322 +#, no-wrap +msgid "The Store" +msgstr "Der Store" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Manipulating the package store." +msgstr "Den Paket-Store verändern." + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:3260 doc/guix.texi:4471 doc/guix.texi:4472 +#, no-wrap +msgid "Derivations" +msgstr "Ableitungen" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Low-level interface to package derivations." +msgstr "Systemnahe Schnittstelle für Paketableitungen." + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:3260 doc/guix.texi:4649 doc/guix.texi:4650 +#, no-wrap +msgid "The Store Monad" +msgstr "Die Store-Monade" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Purely functional interface to the store." +msgstr "Rein funktionale Schnittstelle zum Store." + +#. type: section +#: doc/guix.texi:159 doc/guix.texi:3260 doc/guix.texi:4958 doc/guix.texi:4959 +#, no-wrap +msgid "G-Expressions" +msgstr "G-Ausdrücke" + +#. type: menuentry +#: doc/guix.texi:159 doc/guix.texi:3260 +msgid "Manipulating build expressions." +msgstr "Erstellungsausdrücke verarbeiten." + +#. type: node +#: doc/guix.texi:164 doc/guix.texi:3508 doc/guix.texi:3511 +#, no-wrap +msgid "package Reference" +msgstr "„package“-Referenz" + +#. type: menuentry +#: doc/guix.texi:164 doc/guix.texi:3508 +msgid "The package data type." +msgstr "Der Datentyp für Pakete." + +#. type: node +#: doc/guix.texi:164 doc/guix.texi:3508 doc/guix.texi:3638 +#, no-wrap +msgid "origin Reference" +msgstr "„origin“-Referenz" + +#. type: menuentry +#: doc/guix.texi:164 doc/guix.texi:3508 +msgid "The origin data type." +msgstr "Datentyp für Paketursprünge." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:5559 +#, no-wrap +msgid "Invoking guix build" +msgstr "Aufruf von guix build" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Building packages from the command line." +msgstr "Pakete aus der Befehlszeile heraus erstellen." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6146 +#, no-wrap +msgid "Invoking guix edit" +msgstr "Aufruf von guix edit" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Editing package definitions." +msgstr "Paketdefinitionen bearbeiten." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6172 +#, no-wrap +msgid "Invoking guix download" +msgstr "Aufruf von guix download" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Downloading a file and printing its hash." +msgstr "Herunterladen einer Datei und Ausgabe ihres Hashes." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6225 +#, no-wrap +msgid "Invoking guix hash" +msgstr "Aufruf von guix hash" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Computing the cryptographic hash of a file." +msgstr "Den kryptographischen Hash einer Datei berechnen." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6287 +#, no-wrap +msgid "Invoking guix import" +msgstr "Aufruf von guix import" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Importing package definitions." +msgstr "Paketdefinitionen importieren." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6660 +#, no-wrap +msgid "Invoking guix refresh" +msgstr "Aufruf von guix refresh" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Updating package definitions." +msgstr "Paketdefinitionen aktualisieren." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:6907 +#, no-wrap +msgid "Invoking guix lint" +msgstr "Aufruf von guix lint" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Finding errors in package definitions." +msgstr "Fehler in Paketdefinitionen finden." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7016 +#, no-wrap +msgid "Invoking guix size" +msgstr "Aufruf von guix size" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Profiling disk usage." +msgstr "Plattenverbrauch profilieren." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7140 +#, no-wrap +msgid "Invoking guix graph" +msgstr "Aufruf von guix graph" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Visualizing the graph of packages." +msgstr "Den Paketgraphen visualisieren." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7319 +#, no-wrap +msgid "Invoking guix environment" +msgstr "Aufruf von guix environment" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Setting up development environments." +msgstr "Entwicklungsumgebungen einrichten." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7638 +#, no-wrap +msgid "Invoking guix publish" +msgstr "Aufruf von guix publish" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Sharing substitutes." +msgstr "Substitute teilen." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7855 +#, no-wrap +msgid "Invoking guix challenge" +msgstr "Aufruf von guix challenge" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Challenging substitute servers." +msgstr "Die Substitut-Server anfechten." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:7994 +#, no-wrap +msgid "Invoking guix copy" +msgstr "Aufruf von guix copy" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Copying to and from a remote store." +msgstr "Mit einem entfernten Store Dateien austauschen." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:8057 +#, no-wrap +msgid "Invoking guix container" +msgstr "Aufruf von guix container" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Process isolation." +msgstr "Prozesse isolieren." + +#. type: node +#: doc/guix.texi:182 doc/guix.texi:5557 doc/guix.texi:8111 +#, no-wrap +msgid "Invoking guix weather" +msgstr "Aufruf von guix weather" + +#. type: menuentry +#: doc/guix.texi:182 doc/guix.texi:5557 +msgid "Assessing substitute availability." +msgstr "Die Verfügbarkeit von Substituten einschätzen." + +#. type: section +#: doc/guix.texi:184 doc/guix.texi:5560 +#, no-wrap +msgid "Invoking @command{guix build}" +msgstr "Aufruf von @command{guix build}" + +#. type: subsection +#: doc/guix.texi:189 doc/guix.texi:5611 doc/guix.texi:5613 doc/guix.texi:5614 +#, no-wrap +msgid "Common Build Options" +msgstr "Gemeinsame Erstellungsoptionen" + +#. type: menuentry +#: doc/guix.texi:189 doc/guix.texi:5611 +msgid "Build options for most commands." +msgstr "Erstellungsoptionen für die meisten Befehle." + +#. type: subsection +#: doc/guix.texi:189 doc/guix.texi:5611 doc/guix.texi:5755 doc/guix.texi:5756 +#, no-wrap +msgid "Package Transformation Options" +msgstr "Paketumwandlungsoptionen" + +#. type: menuentry +#: doc/guix.texi:189 doc/guix.texi:5611 +msgid "Creating variants of packages." +msgstr "Varianten von Paketen erzeugen." + +#. type: subsection +#: doc/guix.texi:189 doc/guix.texi:5611 doc/guix.texi:5855 doc/guix.texi:5856 +#, no-wrap +msgid "Additional Build Options" +msgstr "Zusätzliche Erstellungsoptionen" + +#. type: menuentry +#: doc/guix.texi:189 doc/guix.texi:5611 +msgid "Options specific to 'guix build'." +msgstr "Optionen spezifisch für »guix build«." + +#. type: subsection +#: doc/guix.texi:189 doc/guix.texi:5611 doc/guix.texi:6066 doc/guix.texi:6067 +#, no-wrap +msgid "Debugging Build Failures" +msgstr "Fehlschläge beim Erstellen untersuchen" + +#. type: menuentry +#: doc/guix.texi:189 doc/guix.texi:5611 +msgid "Real life packaging experience." +msgstr "Praxiserfahrung bei der Paketerstellung." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:203 doc/guix.texi:8263 doc/guix.texi:8268 +#: doc/guix.texi:8269 +#, no-wrap +msgid "System Installation" +msgstr "Systeminstallation" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Installing the whole operating system." +msgstr "Das ganze Betriebssystem installieren." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:213 doc/guix.texi:8263 doc/guix.texi:8900 +#: doc/guix.texi:8901 +#, no-wrap +msgid "System Configuration" +msgstr "Systemkonfiguration" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Configuring the operating system." +msgstr "Das Betriebssystem konfigurieren." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:21835 +#: doc/guix.texi:21836 +#, no-wrap +msgid "Documentation" +msgstr "Dokumentation" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Browsing software user manuals." +msgstr "Wie man Nutzerhandbücher von Software liest." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:21899 +#: doc/guix.texi:21900 +#, no-wrap +msgid "Installing Debugging Files" +msgstr "Dateien zur Fehlersuche installieren" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Feeding the debugger." +msgstr "Womit man seinen Debugger füttert." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:21965 +#: doc/guix.texi:21966 +#, no-wrap +msgid "Security Updates" +msgstr "Sicherheitsaktualisierungen" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Deploying security fixes quickly." +msgstr "Sicherheits-Patches schnell einspielen." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:22085 +#: doc/guix.texi:22086 +#, no-wrap +msgid "Package Modules" +msgstr "Paketmodule" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Packages from the programmer's viewpoint." +msgstr "Pakete aus Sicht des Programmierers." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:267 doc/guix.texi:8263 doc/guix.texi:22139 +#: doc/guix.texi:22140 +#, no-wrap +msgid "Packaging Guidelines" +msgstr "Paketrichtlinien" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Growing the distribution." +msgstr "Die Distribution wachsen lassen." + +#. type: section +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:22590 +#: doc/guix.texi:22591 +#, no-wrap +msgid "Bootstrapping" +msgstr "Bootstrapping" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "GNU/Linux built from scratch." +msgstr "GNU/Linux von Grund auf selbst erstellen." + +#. type: node +#: doc/guix.texi:201 doc/guix.texi:8263 doc/guix.texi:22774 +#, no-wrap +msgid "Porting" +msgstr "Portierung" + +#. type: menuentry +#: doc/guix.texi:201 doc/guix.texi:8263 +msgid "Targeting another platform or kernel." +msgstr "Guix auf andere Plattformen und Kernels bringen." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:1131 doc/guix.texi:8300 doc/guix.texi:8302 +#: doc/guix.texi:8303 +#, no-wrap +msgid "Limitations" +msgstr "Einschränkungen" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "What you can expect." +msgstr "Was Sie erwarten dürfen." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8346 doc/guix.texi:8347 +#, no-wrap +msgid "Hardware Considerations" +msgstr "Hardware-Überlegungen" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "Supported hardware." +msgstr "Unterstützte Hardware." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8381 doc/guix.texi:8382 +#, no-wrap +msgid "USB Stick and DVD Installation" +msgstr "Installation von USB-Stick oder DVD" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "Preparing the installation medium." +msgstr "Das Installationsmedium vorbereiten." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8479 doc/guix.texi:8480 +#, no-wrap +msgid "Preparing for Installation" +msgstr "Vor der Installation" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "Networking, partitioning, etc." +msgstr "Netzwerkanbindung, Partitionierung etc." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8718 doc/guix.texi:8719 +#, no-wrap +msgid "Proceeding with the Installation" +msgstr "Fortfahren mit der Installation" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "The real thing." +msgstr "Die Hauptsache." + +#. type: node +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8815 +#, no-wrap +msgid "Installing GuixSD in a VM" +msgstr "GuixSD in einer VM installieren" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "GuixSD playground." +msgstr "Ein GuixSD-Spielplatz." + +#. type: subsection +#: doc/guix.texi:211 doc/guix.texi:8300 doc/guix.texi:8869 doc/guix.texi:8870 +#, no-wrap +msgid "Building the Installation Image" +msgstr "Ein Abbild zur Installation erstellen" + +#. type: menuentry +#: doc/guix.texi:211 doc/guix.texi:8300 +msgid "How this comes to be." +msgstr "Wie ein solches entsteht." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:8943 doc/guix.texi:8944 +#, no-wrap +msgid "Using the Configuration System" +msgstr "Das Konfigurationssystems nutzen" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Customizing your GNU system." +msgstr "Ihr GNU-System anpassen" + +#. type: node +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:9159 +#, no-wrap +msgid "operating-system Reference" +msgstr "„operating-system“-Referenz" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Detail of operating-system declarations." +msgstr "Details der Betriebssystem-Deklarationen." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:9313 doc/guix.texi:9314 +#, no-wrap +msgid "File Systems" +msgstr "Dateisysteme" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Configuring file system mounts." +msgstr "Die Dateisystemeinbindungen konfigurieren." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:9478 doc/guix.texi:9479 +#, no-wrap +msgid "Mapped Devices" +msgstr "Abgebildete Geräte" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Block device extra processing." +msgstr "Zusatzverarbeitungsschritte für blockbasierte Geräte." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:9599 doc/guix.texi:9600 +#, no-wrap +msgid "User Accounts" +msgstr "Benutzerkonten" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Specifying user accounts." +msgstr "Benutzerkonten festlegen." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:1454 doc/guix.texi:8941 doc/guix.texi:9734 +#: doc/guix.texi:9735 +#, no-wrap +msgid "Locales" +msgstr "Locales" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Language and cultural convention settings." +msgstr "Sprach- und kulturelle Konventionseinstellungen." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:231 doc/guix.texi:8941 doc/guix.texi:9874 +#: doc/guix.texi:9875 +#, no-wrap +msgid "Services" +msgstr "Dienste" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Specifying system services." +msgstr "Systemdienste festlegen." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:20204 +#: doc/guix.texi:20205 +#, no-wrap +msgid "Setuid Programs" +msgstr "Setuid-Programme" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Programs running with root privileges." +msgstr "Programme mit Administratorrechten ausführen" + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:1599 doc/guix.texi:8941 doc/guix.texi:20250 +#: doc/guix.texi:20251 +#, no-wrap +msgid "X.509 Certificates" +msgstr "X.509-Zertifikate" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Authenticating HTTPS servers." +msgstr "HTTPS-Server authentifizieren." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:1497 doc/guix.texi:8941 doc/guix.texi:20313 +#: doc/guix.texi:20314 +#, no-wrap +msgid "Name Service Switch" +msgstr "Name Service Switch" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Configuring libc's name service switch." +msgstr "Den Name Service Switch von libc konfigurieren." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:20451 +#: doc/guix.texi:20452 +#, no-wrap +msgid "Initial RAM Disk" +msgstr "Initiale RAM-Disk" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Linux-Libre bootstrapping." +msgstr "Linux-libre hochfahren." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:20611 +#: doc/guix.texi:20612 +#, no-wrap +msgid "Bootloader Configuration" +msgstr "Bootloader-Konfiguration" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Configuring the boot loader." +msgstr "Den Bootloader konfigurieren." + +#. type: node +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:20782 +#, no-wrap +msgid "Invoking guix system" +msgstr "Aufruf von guix system" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Instantiating a system configuration." +msgstr "Instanzierung einer Systemkonfiguration" + +#. type: node +#: doc/guix.texi:229 doc/guix.texi:8941 doc/guix.texi:21207 +#, no-wrap +msgid "Running GuixSD in a VM" +msgstr "GuixSD in einer VM starten" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "How to run GuixSD in a virtual machine." +msgstr "Wie man GuixSD in einer virtuellen Maschine startet." + +#. type: subsection +#: doc/guix.texi:229 doc/guix.texi:260 doc/guix.texi:8941 doc/guix.texi:21318 +#: doc/guix.texi:21319 +#, no-wrap +msgid "Defining Services" +msgstr "Dienste definieren" + +#. type: menuentry +#: doc/guix.texi:229 doc/guix.texi:8941 +msgid "Adding new service definitions." +msgstr "Neue Dienstdefinitionen hinzufügen." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:9949 doc/guix.texi:9950 +#, no-wrap +msgid "Base Services" +msgstr "Basisdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Essential system services." +msgstr "Essenzielle Systemdienste" + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:10733 +#: doc/guix.texi:10734 +#, no-wrap +msgid "Scheduled Job Execution" +msgstr "Geplante Auftragsausführung" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "The mcron service." +msgstr "Der mcron-Dienst." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:10828 +#: doc/guix.texi:10829 +#, no-wrap +msgid "Log Rotation" +msgstr "Log-Rotation" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "The rottlog service." +msgstr "Der rottlog-Dienst." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:10930 +#: doc/guix.texi:10931 +#, no-wrap +msgid "Networking Services" +msgstr "Netzwerkdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Network setup, SSH daemon, etc." +msgstr "Netzwerkeinrichtung, SSH-Daemon etc." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:11698 +#: doc/guix.texi:11699 +#, no-wrap +msgid "X Window" +msgstr "X Window" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Graphical display." +msgstr "Graphische Anzeige." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:11982 +#: doc/guix.texi:11983 +#, no-wrap +msgid "Printing Services" +msgstr "Druckdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Local and remote printer support." +msgstr "Unterstützung für lokale und entfernte Drucker." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:12819 +#: doc/guix.texi:12820 +#, no-wrap +msgid "Desktop Services" +msgstr "Desktop-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "D-Bus and desktop services." +msgstr "D-Bus- und Desktop-Dienste." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:13127 +#: doc/guix.texi:13128 +#, no-wrap +msgid "Sound Services" +msgstr "Tondienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "ALSA and Pulseaudio services." +msgstr "Dienste für ALSA und Pulseaudio." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:13169 +#: doc/guix.texi:13170 +#, no-wrap +msgid "Database Services" +msgstr "Datenbankdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "SQL databases, key-value stores, etc." +msgstr "SQL-Datenbanken, Schlüssel-Wert-Speicher etc." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:13293 +#: doc/guix.texi:13294 +#, no-wrap +msgid "Mail Services" +msgstr "Mail-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "IMAP, POP3, SMTP, and all that." +msgstr "IMAP, POP3, SMTP und so weiter." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:14745 +#: doc/guix.texi:14746 +#, no-wrap +msgid "Messaging Services" +msgstr "Kurznachrichtendienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Messaging services." +msgstr "Dienste für Kurznachrichten." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:15216 +#: doc/guix.texi:15217 +#, no-wrap +msgid "Telephony Services" +msgstr "Telefondienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Telephony services." +msgstr "Telefoniedienste." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:15421 +#: doc/guix.texi:15422 +#, no-wrap +msgid "Monitoring Services" +msgstr "Überwachungsdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Monitoring services." +msgstr "Dienste zur Systemüberwachung." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:15574 +#: doc/guix.texi:15575 +#, no-wrap +msgid "Kerberos Services" +msgstr "Kerberos-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Kerberos services." +msgstr "Kerberos-Dienste." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:15700 +#: doc/guix.texi:15701 +#, no-wrap +msgid "Web Services" +msgstr "Web-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Web servers." +msgstr "Web-Server." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:16371 +#: doc/guix.texi:16372 +#, no-wrap +msgid "Certificate Services" +msgstr "Zertifikatsdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "TLS certificates via Let's Encrypt." +msgstr "TLS-Zertifikate via Let’s Encrypt." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:16517 +#: doc/guix.texi:16518 +#, no-wrap +msgid "DNS Services" +msgstr "DNS-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "DNS daemons." +msgstr "DNS-Daemons." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:16978 +#: doc/guix.texi:16979 +#, no-wrap +msgid "VPN Services" +msgstr "VPN-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "VPN daemons." +msgstr "VPN-Daemons." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:17336 +#: doc/guix.texi:17337 +#, no-wrap +msgid "Network File System" +msgstr "Network File System" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "NFS related services." +msgstr "Dienste mit Bezug zum Netzwerkdateisystem." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:17451 +#: doc/guix.texi:17452 +#, no-wrap +msgid "Continuous Integration" +msgstr "Kontinuierliche Integration" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "The Cuirass service." +msgstr "Der Cuirass-Dienst" + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:17547 +#: doc/guix.texi:17548 +#, fuzzy, no-wrap +#| msgid "Power Management Services" +msgid "Power management Services" +msgstr "Dienste zur Stromverbrauchsverwaltung" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +#, fuzzy +#| msgid "The right tools." +msgid "The TLP tool." +msgstr "Die richtigen Werkzeuge." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:18075 +#: doc/guix.texi:18076 +#, no-wrap +msgid "Audio Services" +msgstr "Audio-Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "The MPD." +msgstr "Der MPD." + +#. type: node +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:18125 +#, no-wrap +msgid "Virtualization Services" +msgstr "Virtualisierungsdienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Virtualization services." +msgstr "Dienste für virtuelle Maschinen." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:18918 +#: doc/guix.texi:18919 +#, no-wrap +msgid "Version Control Services" +msgstr "Versionskontrolldienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Providing remote access to Git repositories." +msgstr "Entfernten Zugang zu Git-Repositorys bieten." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:20012 +#: doc/guix.texi:20013 +#, no-wrap +msgid "Game Services" +msgstr "Spieldienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Game servers." +msgstr "Spielserver." + +#. type: subsubsection +#: doc/guix.texi:258 doc/guix.texi:9947 doc/guix.texi:20043 +#: doc/guix.texi:20044 +#, no-wrap +msgid "Miscellaneous Services" +msgstr "Verschiedene Dienste" + +#. type: menuentry +#: doc/guix.texi:258 doc/guix.texi:9947 +msgid "Other services." +msgstr "Andere Dienste." + +#. type: subsubsection +#: doc/guix.texi:265 doc/guix.texi:21330 doc/guix.texi:21332 +#: doc/guix.texi:21333 +#, no-wrap +msgid "Service Composition" +msgstr "Dienstkompositionen" + +#. type: menuentry +#: doc/guix.texi:265 doc/guix.texi:21330 +msgid "The model for composing services." +msgstr "Wie Dienste zusammengestellt werden." + +#. type: subsubsection +#: doc/guix.texi:265 doc/guix.texi:21330 doc/guix.texi:21388 +#: doc/guix.texi:21389 +#, no-wrap +msgid "Service Types and Services" +msgstr "Diensttypen und Dienste" + +#. type: menuentry +#: doc/guix.texi:265 doc/guix.texi:21330 +msgid "Types and services." +msgstr "Typen und Dienste." + +#. type: subsubsection +#: doc/guix.texi:265 doc/guix.texi:21330 doc/guix.texi:21525 +#: doc/guix.texi:21526 +#, no-wrap +msgid "Service Reference" +msgstr "Service-Referenz" + +#. type: menuentry +#: doc/guix.texi:265 doc/guix.texi:21330 +msgid "API reference." +msgstr "Referenz zur Programmierschnittstelle" + +#. type: subsubsection +#: doc/guix.texi:265 doc/guix.texi:21330 doc/guix.texi:21750 +#: doc/guix.texi:21751 +#, no-wrap +msgid "Shepherd Services" +msgstr "Shepherd-Dienste" + +#. type: menuentry +#: doc/guix.texi:265 doc/guix.texi:21330 +msgid "A particular type of service." +msgstr "Eine spezielle Art von Dienst." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22216 +#: doc/guix.texi:22217 +#, no-wrap +msgid "Software Freedom" +msgstr "Software-Freiheit" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "What may go into the distribution." +msgstr "Was in die Distribution aufgenommen werden darf." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22244 +#: doc/guix.texi:22245 +#, no-wrap +msgid "Package Naming" +msgstr "Paketbenennung" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "What's in a name?" +msgstr "Was macht einen Namen aus?" + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22269 +#: doc/guix.texi:22270 +#, no-wrap +msgid "Version Numbers" +msgstr "Versionsnummern" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "When the name is not enough." +msgstr "Wenn der Name noch nicht genug ist." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22360 +#: doc/guix.texi:22361 +#, no-wrap +msgid "Synopses and Descriptions" +msgstr "Zusammenfassungen und Beschreibungen" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "Helping users find the right package." +msgstr "Den Nutzern helfen, das richtige Paket zu finden." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22440 +#: doc/guix.texi:22441 +#, no-wrap +msgid "Python Modules" +msgstr "Python-Module" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "A touch of British comedy." +msgstr "Ein Touch britischer Comedy." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22515 +#: doc/guix.texi:22516 +#, no-wrap +msgid "Perl Modules" +msgstr "Perl-Module" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "Little pearls." +msgstr "Kleine Perlen." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22531 +#: doc/guix.texi:22532 +#, no-wrap +msgid "Java Packages" +msgstr "Java-Pakete" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "Coffee break." +msgstr "Kaffeepause." + +#. type: subsection +#: doc/guix.texi:276 doc/guix.texi:22214 doc/guix.texi:22551 +#: doc/guix.texi:22552 +#, no-wrap +msgid "Fonts" +msgstr "Schriftarten" + +#. type: menuentry +#: doc/guix.texi:276 doc/guix.texi:22214 +msgid "Fond of fonts." +msgstr "Schriften verschriftlicht." + +#. type: cindex +#: doc/guix.texi:299 +#, no-wrap +msgid "purpose" +msgstr "Zweck" + +#. type: Plain text +#: doc/guix.texi:306 +msgid "GNU Guix@footnote{``Guix'' is pronounced like ``geeks'', or ``ɡiːks'' using the international phonetic alphabet (IPA).} is a package management tool for the GNU system. Guix makes it easy for unprivileged users to install, upgrade, or remove packages, to roll back to a previous package set, to build packages from source, and generally assists with the creation and maintenance of software environments." +msgstr "GNU Guix@footnote{»Guix« wird wie »geeks« ausgesprochen, also als »ɡiːks« in der Notation des Internationalen Phonetischen Alphabets (IPA).} ist ein Werkzeug zur Paketverwaltung für das GNU-System. Guix macht es unprivilegierten Nutzern leicht, Pakete zu installieren, zu aktualisieren oder zu entfernen, zu einem vorherigen Satz von Paketen zurückzuwechseln, Pakete aus ihrem Quellcode heraus zu erstellen und hilft allgemein bei der Schöpfung und Wartung von Software-Umgebungen." + +#. type: cindex +#: doc/guix.texi:307 +#, no-wrap +msgid "user interfaces" +msgstr "Benutzeroberflächen" + +#. type: Plain text +#: doc/guix.texi:312 +msgid "Guix provides a command-line package management interface (@pxref{Invoking guix package}), a set of command-line utilities (@pxref{Utilities}), as well as Scheme programming interfaces (@pxref{Programming Interface})." +msgstr "Guix bietet eine kommandozeilenbasierte Paketverwaltungsschnittstelle (@pxref{Invoking guix package}), einen Satz Befehlszeilenwerkzeuge (@pxref{Utilities}) sowie Schnittstellen zur Programmierung in Scheme (@pxref{Programming Interface})." + +#. type: cindex +#: doc/guix.texi:312 +#, no-wrap +msgid "build daemon" +msgstr "Erstellungs-Daemon" + +#. type: Plain text +#: doc/guix.texi:316 +msgid "Its @dfn{build daemon} is responsible for building packages on behalf of users (@pxref{Setting Up the Daemon}) and for downloading pre-built binaries from authorized sources (@pxref{Substitutes})." +msgstr "Der @dfn{Erstellungs-Daemon} ist für das Erstellen von Paketen im Auftrag von Nutzern verantwortlich (@pxref{Setting Up the Daemon}) und für das Herunterladen vorerstellter Binärdateien aus autorisierten Quellen (@pxref{Substitutes})." + +#. type: cindex +#: doc/guix.texi:317 +#, no-wrap +msgid "extensibility of the distribution" +msgstr "Erweiterbarkeit der Distribution" + +#. type: cindex +#: doc/guix.texi:318 doc/guix.texi:22107 +#, no-wrap +msgid "customization, of packages" +msgstr "Anpassung, von Paketen" + +#. type: Plain text +#: doc/guix.texi:327 +msgid "Guix includes package definitions for many GNU and non-GNU packages, all of which @uref{https://www.gnu.org/philosophy/free-sw.html, respect the user's computing freedom}. It is @emph{extensible}: users can write their own package definitions (@pxref{Defining Packages}) and make them available as independent package modules (@pxref{Package Modules}). It is also @emph{customizable}: users can @emph{derive} specialized package definitions from existing ones, including from the command line (@pxref{Package Transformation Options})." +msgstr "Guix enthält Paketdefinitionen für viele Pakete, von GNU und nicht von GNU, die alle @uref{https://www.gnu.org/philosophy/free-sw.html, die Freiheit des Computernutzers respektieren}. Es ist @emph{erweiterbar}: Nutzer können ihre eigenen Paketdefinitionen schreiben (@pxref{Defining Packages}) und sie als unabhängige Paketmodule verfügbar machen (@pxref{Package Modules}). Es ist auch @emph{anpassbar}: Nutzer können spezialisierte Paketdefinitionen aus bestehenden @emph{ableiten}, auch von der Befehlszeile (@pxref{Package Transformation Options})." + +#. type: cindex +#: doc/guix.texi:328 doc/guix.texi:8194 doc/guix.texi:8272 +#, no-wrap +msgid "Guix System Distribution" +msgstr "Guix System Distribution" + +#. type: cindex +#: doc/guix.texi:329 doc/guix.texi:8195 +#, no-wrap +msgid "GuixSD" +msgstr "GuixSD" + +#. type: Plain text +#: doc/guix.texi:338 +msgid "You can install GNU@tie{}Guix on top of an existing GNU/Linux system where it complements the available tools without interference (@pxref{Installation}), or you can use it as part of the standalone @dfn{Guix System Distribution} or GuixSD (@pxref{GNU Distribution}). With GNU@tie{}GuixSD, you @emph{declare} all aspects of the operating system configuration and Guix takes care of instantiating the configuration in a transactional, reproducible, and stateless fashion (@pxref{System Configuration})." +msgstr "Sie können GNU@tie{}Guix auf ein bestehendes GNU/Linux-System aufsetzen, wo es die bereits verfügbaren Werkzeuge ergänzt, ohne zu stören (@pxref{Installation}), oder Sie können es eigenständig als Teil der @dfn{Guix System Distribution}, kurz GuixSD (@pxref{GNU Distribution}), verwenden. Mit GNU@tie{}GuixSD @emph{deklarieren} Sie alle Aspekte der Betriebssystemkonfiguration und Guix kümmert sich darum, die Konfiguration oft transaktionsbasierte, reproduzierbare und zustandslose Weise zu instanzieren (@pxref{System Configuration})." + +#. type: cindex +#: doc/guix.texi:339 +#, no-wrap +msgid "functional package management" +msgstr "funktionale Paketverwaltung" + +#. type: Plain text +#: doc/guix.texi:354 +msgid "Under the hood, Guix implements the @dfn{functional package management} discipline pioneered by Nix (@pxref{Acknowledgments}). In Guix, the package build and installation process is seen as a @emph{function}, in the mathematical sense. That function takes inputs, such as build scripts, a compiler, and libraries, and returns an installed package. As a pure function, its result depends solely on its inputs---for instance, it cannot refer to software or scripts that were not explicitly passed as inputs. A build function always produces the same result when passed a given set of inputs. It cannot alter the environment of the running system in any way; for instance, it cannot create, modify, or delete files outside of its build and installation directories. This is achieved by running build processes in isolated environments (or @dfn{containers}), where only their explicit inputs are visible." +msgstr "Intern implementiert Guix die Disziplin der @dfn{funktionalen Paketverwaltung}, zu der Nix schon die Pionierarbeit geleistet hat (@pxref{Acknowledgments}). In Guix wird der Prozess, ein Paket zu erstellen und zu installieren, als eine @emph{Funktion} im mathematischen Sinn aufgefasst. Diese Funktion hat Eingaben, wie zum Beispiel Erstellungs-Skripts, einen Compiler und Bibliotheken, und liefert ein installiertes Paket. Als eine reine Funktion hängt sein Ergebnis allein von seinen Eingaben ab — zum Beispiel kann er nicht auf Software oder Skripts Bezug nehmen, die nicht ausdrücklich als Eingaben übergeben wurden. Eine Erstellungsfunktion führt immer zum selben Ergebnis, wenn ihr die gleiche Menge an Eingaben übergeben wurde. Sie kann die Umgebung des laufenden Systems auf keine Weise beeinflussen, zum Beispiel kann sie keine Dateien außerhalb ihrer Erstellungs- und Installationsverzeichnisse verändern. Um dies zu erreichen, laufen Erstellungsprozesse in isolieren Umgebungen (sogenannte @dfn{Container}), wo nur ausdrückliche Eingaben sichtbar sind." + +#. type: cindex +#: doc/guix.texi:355 doc/guix.texi:4324 +#, no-wrap +msgid "store" +msgstr "Store" + +#. type: Plain text +#: doc/guix.texi:362 +msgid "The result of package build functions is @dfn{cached} in the file system, in a special directory called @dfn{the store} (@pxref{The Store}). Each package is installed in a directory of its own in the store---by default under @file{/gnu/store}. The directory name contains a hash of all the inputs used to build that package; thus, changing an input yields a different directory name." +msgstr "Das Ergebnis von Paketerstellungsfunktionen wird im Dateisystem @dfn{zwischengespeichert} in einem besonderen Verzeichnis, was als @dfn{der Store} bezeichnet wird (@pxref{The Store}). Jedes Paket wird in sein eigenes Verzeichnis im Store installiert — standardmäßig ist er unter @file{/gnu/store} zu finden. Der Verzeichnisname enthält einen Hash aller Eingaben, anhand derer das Paket erzeugt wurde, somit hat das Ändern einer Eingabe einen völlig anderen Verzeichnisnamen zur Folge." + +#. type: Plain text +#: doc/guix.texi:366 +msgid "This approach is the foundation for the salient features of Guix: support for transactional package upgrade and rollback, per-user installation, and garbage collection of packages (@pxref{Features})." +msgstr "Dieses Vorgehen ist die Grundlage für die Guix auszeichnenden Funktionalitäten: Unterstützung transaktionsbasierter Paketaktualisierungen und -rückstufungen, Installation von Paketen als einfacher Nutzer sowie Garbage Collection für Pakete (@pxref{Features})." + +#. type: cindex +#: doc/guix.texi:372 +#, no-wrap +msgid "installing Guix" +msgstr "Guix installieren" + +#. type: Plain text +#: doc/guix.texi:377 +msgid "GNU Guix is available for download from its website at @url{http://www.gnu.org/software/guix/}. This section describes the software requirements of Guix, as well as how to install it and get ready to use it." +msgstr "GNU Guix kann von seiner Webseite unter @url{http://www.gnu.org/software/guix/} heruntergeladen werden. Dieser Abschnitt beschreibt die Software-Voraussetzungen von Guix und wie man es installiert, so dass man es benutzen kann." + +#. type: Plain text +#: doc/guix.texi:382 +msgid "Note that this section is concerned with the installation of the package manager, which can be done on top of a running GNU/Linux system. If, instead, you want to install the complete GNU operating system, @pxref{System Installation}." +msgstr "Beachten Sie, dass es in diesem Abschnitt um die Installation des Paketverwaltungswerkzeugs geht, welche auf einem laufenden GNU/Linux-System vollzogen werden kann. Falls Sie stattdessen das vollständige GNU-Betriebssystem installieren möchten, werfen Sie einen Blick in den Abschnitt @pxref{System Installation}." + +#. type: cindex +#: doc/guix.texi:383 doc/guix.texi:1449 +#, no-wrap +msgid "foreign distro" +msgstr "Fremddistribution" + +#. type: Plain text +#: doc/guix.texi:389 +msgid "When installed on a running GNU/Linux system---thereafter called a @dfn{foreign distro}---GNU@tie{}Guix complements the available tools without interference. Its data lives exclusively in two directories, usually @file{/gnu/store} and @file{/var/guix}; other files on your system, such as @file{/etc}, are left untouched." +msgstr "Wenn es auf ein bestehendes GNU/Linux-System installiert wird — im Folgenden als @dfn{Fremddistribution} bezeichnet —, ergänzt GNU@tie{}Guix die verfügbaren Werkzeuge, ohne dass sie sich gegenseitig stören. Guix’ Daten befinden sich ausschließlich in zwei Verzeichnissen, üblicherweise @file{/gnu/store} und @file{/var/guix}; andere Dateien auf Ihrem System wie @file{/etc} bleiben unberührt." + +#. type: Plain text +#: doc/guix.texi:392 +msgid "Once installed, Guix can be updated by running @command{guix pull} (@pxref{Invoking guix pull})." +msgstr "Sobald es installiert ist, kann Guix durch Ausführen von @command{guix pull} aktualisiert werden (@pxref{Invoking guix pull})." + +#. type: cindex +#: doc/guix.texi:405 +#, no-wrap +msgid "installing Guix from binaries" +msgstr "Guix aus Binärdateien installieren" + +#. type: Plain text +#: doc/guix.texi:411 +msgid "This section describes how to install Guix on an arbitrary system from a self-contained tarball providing binaries for Guix and for all its dependencies. This is often quicker than installing from source, which is described in the next sections. The only requirement is to have GNU@tie{}tar and Xz." +msgstr "Dieser Abschnitt beschreibt, wie sich Guix auf einem beliebigen System aus einem alle Komponenten umfassenden Tarball installieren lässt, der Binärdateien für Guix und all seine Abhängigkeiten liefert. Dies geht in der Regel schneller, als Guix aus seinen Quelldateien zu installieren, was im nächsten Abschnitt beschrieben wird. Vorausgesetzt wird hier lediglich, dass GNU@tie{}tar und Xz verfügbar sind." + +#. type: Plain text +#: doc/guix.texi:416 +msgid "We provide a @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, shell installer script}, which automates the download, installation, and initial configuration of Guix. It should be run as the root user." +msgstr "Wir bieten ein @uref{https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh, Installations-Skript für die Shell}, welches Guix automatisch herunterlädt, installiert und eine erste Konfiguration von Guix mit sich bringt. Es sollte als der Administratornutzer (als »root«) ausgeführt werden." + +#. type: Plain text +#: doc/guix.texi:418 +msgid "Installing goes along these lines:" +msgstr "Die Installation läuft so ab:" + +#. type: cindex +#: doc/guix.texi:421 +#, no-wrap +msgid "downloading Guix binary" +msgstr "Guix-Binärdatei herunterladen" + +#. type: enumerate +#: doc/guix.texi:426 +#, fuzzy +#| msgid "Download the binary tarball from @indicateurl{https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz}, where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine already running the kernel Linux, and so on." +msgid "Download the binary tarball from @indicateurl{ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz}, where @var{system} is @code{x86_64-linux} for an @code{x86_64} machine already running the kernel Linux, and so on." +msgstr "Laden Sie den binären Tarball von @indicateurl{https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz} herunter, wobei @var{system} für @code{x86_64-linux} steht, falls Sie es auf einer Maschine mit @code{x86_64}-Architektur einrichten, auf der bereits der Linux-Kernel läuft, oder entsprechend für andere Maschinen." + +#. type: enumerate +#: doc/guix.texi:430 +msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the tarball against it, along these lines:" +msgstr "Achten Sie darauf, auch die zugehörige @file{.sig}-Datei herunterzuladen und verifizieren Sie damit die Authentizität des Tarballs, ungefähr so:" + +#. type: example +#: doc/guix.texi:434 +#, fuzzy, no-wrap +#| msgid "" +#| "$ wget https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +#| "$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +msgid "" +"$ wget ftp://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +"$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +msgstr "" +"$ wget https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +"$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" + +#. type: Plain text +#: doc/guix.texi:438 doc/guix.texi:8408 +msgid "If that command fails because you do not have the required public key, then run this command to import it:" +msgstr "Falls dieser Befehl fehlschlägt, weil Sie nicht über den nötigen öffentlichen Schlüssel verfügen, können Sie ihn mit diesem Befehl importieren:" + +#. type: example +#: doc/guix.texi:441 doc/guix.texi:8411 +#, no-wrap +msgid "$ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n" +msgstr "$ gpg --keyserver pgp.mit.edu --recv-keys @value{OPENPGP-SIGNING-KEY-ID}\n" + +#. type: Plain text +#: doc/guix.texi:446 doc/guix.texi:8416 +msgid "and rerun the @code{gpg --verify} command." +msgstr "und den Befehl @code{gpg --verify} erneut ausführen." + +#. type: enumerate +#: doc/guix.texi:450 +msgid "Now, you need to become the @code{root} user. Depending on your distribution, you may have to run @code{su -} or @code{sudo -i}. As @code{root}, run:" +msgstr "Nun müssen Sie zum Administratornutzer @code{root} wechseln. Abhängig von Ihrer Distribution müssen Sie dazu etwa @code{su -} oder @code{sudo -i} ausführen. Danach führen Sie als @code{root}-Nutzer aus:" + +#. type: example +#: doc/guix.texi:456 +#, no-wrap +msgid "" +"# cd /tmp\n" +"# tar --warning=no-timestamp -xf \\\n" +" guix-binary-@value{VERSION}.@var{system}.tar.xz\n" +"# mv var/guix /var/ && mv gnu /\n" +msgstr "" +"# cd /tmp\n" +"# tar --warning=no-timestamp -xf \\\n" +" guix-binary-@value{VERSION}.@var{system}.tar.xz\n" +"# mv var/guix /var/ && mv gnu /\n" + +#. type: enumerate +#: doc/guix.texi:461 +msgid "This creates @file{/gnu/store} (@pxref{The Store}) and @file{/var/guix}. The latter contains a ready-to-use profile for @code{root} (see next step.)" +msgstr "Dadurch wird @file{/gnu/store} (@pxref{The Store}) und @file{/var/guix} erzeugt. Letzteres enthält ein Profil, welches bereit zur Nutzung durch @code{root} ist (wie im nächsten Schritt beschrieben)." + +#. type: enumerate +#: doc/guix.texi:464 +msgid "Do @emph{not} unpack the tarball on a working Guix system since that would overwrite its own essential files." +msgstr "Entpacken Sie den Tarball @emph{nicht} auf einem schon funktionierenden Guix-System, denn es würde seine eigenen essenziellen Dateien überschreiben." + +#. type: enumerate +#: doc/guix.texi:474 +msgid "The @code{--warning=no-timestamp} option makes sure GNU@tie{}tar does not emit warnings about ``implausibly old time stamps'' (such warnings were triggered by GNU@tie{}tar 1.26 and older; recent versions are fine.) They stem from the fact that all the files in the archive have their modification time set to zero (which means January 1st, 1970.) This is done on purpose to make sure the archive content is independent of its creation time, thus making it reproducible." +msgstr "Die Befehlszeilenoption @code{--warning=no-timestamp} stellt sicher, dass GNU@tie{}tar nicht vor »unplausibel alten Zeitstempeln« warnt (solche Warnungen traten bei GNU@tie{}tar 1.26 und älter auf, neue Versionen machen keine Probleme). Sie kommen daher, dass alle Dateien im Archiv als Änderungszeitpunkt null eingetragen bekommen haben (das bezeichnet den 1. Januar 1970). Das ist Absicht, damit der Inhalt des Archivs nicht davon abhängt, wann es erstellt wurde, und es somit reproduzierbar wird." + +#. type: enumerate +#: doc/guix.texi:477 +msgid "Make @code{root}'s profile available under @file{~root/.guix-profile}:" +msgstr "Machen Sie das Profil von @code{root} verfügbar als @file{~root/.guix-profile}:" + +#. type: example +#: doc/guix.texi:481 +#, no-wrap +msgid "" +"# ln -sf /var/guix/profiles/per-user/root/guix-profile \\\n" +" ~root/.guix-profile\n" +msgstr "" +"# ln -sf /var/guix/profiles/per-user/root/guix-profile \\\n" +" ~root/.guix-profile\n" + +#. type: enumerate +#: doc/guix.texi:485 +msgid "Source @file{etc/profile} to augment @code{PATH} and other relevant environment variables:" +msgstr "»Sourcen« Sie @file{etc/profile}, um @code{PATH} und andere relevante Umgebungsvariable zu ergänzen:" + +#. type: example +#: doc/guix.texi:489 +#, no-wrap +msgid "" +"# GUIX_PROFILE=\"`echo ~root`/.guix-profile\" ; \\\n" +" source $GUIX_PROFILE/etc/profile\n" +msgstr "" +"# GUIX_PROFILE=\"`echo ~root`/.guix-profile\" ; \\\n" +" source $GUIX_PROFILE/etc/profile\n" + +#. type: enumerate +#: doc/guix.texi:494 +msgid "Create the group and user accounts for build users as explained below (@pxref{Build Environment Setup})." +msgstr "Erzeugen Sie Nutzergruppe und Nutzerkonten für die Erstellungs-Benutzer wie folgt (@pxref{Build Environment Setup})." + +#. type: enumerate +#: doc/guix.texi:497 +msgid "Run the daemon, and set it to automatically start on boot." +msgstr "Führen Sie den Daemon aus, und lassen Sie ihn automatisch bei jedem Hochfahren starten." + +#. type: enumerate +#: doc/guix.texi:500 +msgid "If your host distro uses the systemd init system, this can be achieved with these commands:" +msgstr "Wenn Ihre Wirts-Distribution systemd als »init«-System verwendet, können Sie das mit folgenden Befehlen veranlassen:" + +#. type: example +#: doc/guix.texi:512 +#, no-wrap +msgid "" +"# cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \\\n" +" /etc/systemd/system/\n" +"# systemctl start guix-daemon && systemctl enable guix-daemon\n" +msgstr "" +"# cp ~root/.guix-profile/lib/systemd/system/guix-daemon.service \\\n" +" /etc/systemd/system/\n" +"# systemctl start guix-daemon && systemctl enable guix-daemon\n" + +#. type: itemize +#: doc/guix.texi:515 doc/guix.texi:7845 +msgid "If your host distro uses the Upstart init system:" +msgstr "Wenn Ihre Wirts-Distribution als »init«-System Upstart verwendet:" + +#. type: example +#: doc/guix.texi:520 +#, no-wrap +msgid "" +"# initctl reload-configuration\n" +"# cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/\n" +"# start guix-daemon\n" +msgstr "" +"# initctl reload-configuration\n" +"# cp ~root/.guix-profile/lib/upstart/system/guix-daemon.conf /etc/init/\n" +"# start guix-daemon\n" + +#. type: enumerate +#: doc/guix.texi:523 +msgid "Otherwise, you can still start the daemon manually with:" +msgstr "Andernfalls können Sie den Daemon immer noch manuell starten, mit:" + +#. type: example +#: doc/guix.texi:526 +#, no-wrap +msgid "# ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild\n" +msgstr "# ~root/.guix-profile/bin/guix-daemon --build-users-group=guixbuild\n" + +#. type: enumerate +#: doc/guix.texi:531 +msgid "Make the @command{guix} command available to other users on the machine, for instance with:" +msgstr "Stellen Sie den @command{guix}-Befehl auch anderen Nutzern Ihrer Maschine zur Verfügung, zum Beispiel so:" + +#. type: example +#: doc/guix.texi:536 +#, no-wrap +msgid "" +"# mkdir -p /usr/local/bin\n" +"# cd /usr/local/bin\n" +"# ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix\n" +msgstr "" +"# mkdir -p /usr/local/bin\n" +"# cd /usr/local/bin\n" +"# ln -s /var/guix/profiles/per-user/root/guix-profile/bin/guix\n" + +#. type: enumerate +#: doc/guix.texi:540 +msgid "It is also a good idea to make the Info version of this manual available there:" +msgstr "Es ist auch eine gute Idee, die Info-Version dieses Handbuchs ebenso verfügbar zu machen:" + +#. type: example +#: doc/guix.texi:546 +#, no-wrap +msgid "" +"# mkdir -p /usr/local/share/info\n" +"# cd /usr/local/share/info\n" +"# for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ;\n" +" do ln -s $i ; done\n" +msgstr "" +"# mkdir -p /usr/local/share/info\n" +"# cd /usr/local/share/info\n" +"# for i in /var/guix/profiles/per-user/root/guix-profile/share/info/* ;\n" +" do ln -s $i ; done\n" + +#. type: enumerate +#: doc/guix.texi:552 +msgid "That way, assuming @file{/usr/local/share/info} is in the search path, running @command{info guix} will open this manual (@pxref{Other Info Directories,,, texinfo, GNU Texinfo}, for more details on changing the Info search path.)" +msgstr "Auf diese Art wird, unter der Annahme, dass bei Ihnen @file{/usr/local/share/info} im Suchpfad eingetragen ist, das Ausführen von @command{info guix} dieses Handbuch öffnen (@pxref{Other Info Directories,,, texinfo, GNU Texinfo} hat weitere Details, wie Sie den Info-Suchpfad ändern können)." + +#. type: cindex +#: doc/guix.texi:554 doc/guix.texi:2309 doc/guix.texi:10423 +#, no-wrap +msgid "substitutes, authorization thereof" +msgstr "Substitute, deren Autorisierung" + +#. type: enumerate +#: doc/guix.texi:557 +msgid "To use substitutes from @code{hydra.gnu.org} or one of its mirrors (@pxref{Substitutes}), authorize them:" +msgstr "Um Substitute von @code{hydra.gnu.org} oder einem Spiegelserver davon zu benutzen (@pxref{Substitutes}), müssen sie erst autorisiert werden:" + +#. type: example +#: doc/guix.texi:560 +#, no-wrap +msgid "# guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub\n" +msgstr "# guix archive --authorize < ~root/.guix-profile/share/guix/hydra.gnu.org.pub\n" + +#. type: enumerate +#: doc/guix.texi:565 +msgid "Each user may need to perform a few additional steps to make their Guix environment ready for use, @pxref{Application Setup}." +msgstr "Alle Nutzer müssen womöglich ein paar zusätzliche Schritte ausführen, damit ihre Guix-Umgebung genutzt werden kann, siehe @pxref{Application Setup}." + +#. type: Plain text +#: doc/guix.texi:568 +msgid "Voilà, the installation is complete!" +msgstr "Voilà, die installation ist fertig!" + +#. type: Plain text +#: doc/guix.texi:571 +msgid "You can confirm that Guix is working by installing a sample package into the root profile:" +msgstr "Sie können nachprüfen, dass Guix funktioniert, indem Sie ein Beispielpaket in das root-Profil installieren:" + +#. type: example +#: doc/guix.texi:574 +#, no-wrap +msgid "# guix package -i hello\n" +msgstr "# guix package -i hello\n" + +#. type: Plain text +#: doc/guix.texi:581 +msgid "The @code{guix} package must remain available in @code{root}'s profile, or it would become subject to garbage collection---in which case you would find yourself badly handicapped by the lack of the @command{guix} command. In other words, do not remove @code{guix} by running @code{guix package -r guix}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:584 +msgid "The binary installation tarball can be (re)produced and verified simply by running the following command in the Guix source tree:" +msgstr "Der Tarball zur Installation aus einer Binärdatei kann einfach durch Ausführung des folgenden Befehls im Guix-Quellbaum (re-)produziert und verifiziert werden:" + +#. type: example +#: doc/guix.texi:587 +#, no-wrap +msgid "make guix-binary.@var{system}.tar.xz\n" +msgstr "make guix-binary.@var{system}.tar.xz\n" + +#. type: Plain text +#: doc/guix.texi:591 +msgid "... which, in turn, runs:" +msgstr "…was wiederum dies ausführt:" + +#. type: example +#: doc/guix.texi:594 +#, no-wrap +msgid "guix pack -s @var{system} --localstatedir guix\n" +msgstr "guix pack -s @var{system} --localstatedir guix\n" + +#. type: Plain text +#: doc/guix.texi:597 +msgid "@xref{Invoking guix pack}, for more info on this handy tool." +msgstr "Siehe @xref{Invoking guix pack} für weitere Informationen zu diesem praktischen Werkzeug." + +#. type: Plain text +#: doc/guix.texi:605 +msgid "This section lists requirements when building Guix from source. The build procedure for Guix is the same as for other GNU software, and is not covered here. Please see the files @file{README} and @file{INSTALL} in the Guix source tree for additional details." +msgstr "Dieser Abschnitt listet Voraussetzungen auf, um Guix aus seinem Quellcode zu erstellen. Der Erstellungsprozess für Guix ist derselbe wie für andere GNU-Software und wird hier nicht beschrieben. Bitte lesen Sie die Dateien @file{README} und @file{INSTALL} im Guix-Quellbaum, um weitere Details zu erfahren." + +#. type: Plain text +#: doc/guix.texi:607 +msgid "GNU Guix depends on the following packages:" +msgstr "GNU Guix hat folgende Pakete als Abhängigkeiten:" + +#. type: item +#: doc/guix.texi:609 +#, no-wrap +msgid "@url{http://gnu.org/software/guile/, GNU Guile}, version 2.0.13 or" +msgstr "@url{http://gnu.org/software/guile/, GNU Guile}, Version 2.0.13 oder" + +#. type: itemize +#: doc/guix.texi:611 +msgid "later, including 2.2.x;" +msgstr "neuer, einschließlich 2.2.x," + +#. type: item +#: doc/guix.texi:611 +#, no-wrap +msgid "@url{http://gnupg.org/, GNU libgcrypt};" +msgstr "@url{http://gnupg.org/, GNU libgcrypt}," + +#. type: itemize +#: doc/guix.texi:616 +msgid "@uref{http://gnutls.org/, GnuTLS}, specifically its Guile bindings (@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile});" +msgstr "@uref{http://gnutls.org/, GnuTLS}, im Speziellen dessen Bindungen für Guile (@pxref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile})," + +#. type: itemize +#: doc/guix.texi:619 +#, fuzzy +#| msgid "@uref{https://notabug.org/civodul/guile-sqlite3, Guile-SQLite3}, version 0.1.0 or later;" +msgid "@uref{https://notabug.org/civodul/guile-sqlite3, Guile-SQLite3};" +msgstr "@uref{https://notabug.org/civodul/guile-sqlite3, Guile-SQLite3}, Version 0.1.0 oder neuer," + +#. type: itemize +#: doc/guix.texi:623 +msgid "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, from August 2017 or later;" +msgstr "@uref{https://gitlab.com/guile-git/guile-git, Guile-Git}, vom August 2017 oder neuer," + +#. type: item +#: doc/guix.texi:623 +#, no-wrap +msgid "@url{http://zlib.net, zlib};" +msgstr "@url{http://zlib.net, zlib}," + +#. type: item +#: doc/guix.texi:624 +#, no-wrap +msgid "@url{http://www.gnu.org/software/make/, GNU Make}." +msgstr "@url{http://www.gnu.org/software/make/, GNU Make}." + +#. type: Plain text +#: doc/guix.texi:628 +msgid "The following dependencies are optional:" +msgstr "Folgende Abhängigkeiten sind optional:" + +#. type: itemize +#: doc/guix.texi:636 +msgid "Installing @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} will allow you to use the @command{guix import pypi} command (@pxref{Invoking guix import}). It is of interest primarily for developers and not for casual users." +msgstr "Wenn Sie @url{http://savannah.nongnu.org/projects/guile-json/, Guile-JSON} installieren, können Sie den Befehl @command{guix import pypi} benutzen (@pxref{Invoking guix import}). Das spielt hauptsächlich für Entwickler und nicht für Gelegenheitsnutzer eine Rolle." + +#. type: itemize +#: doc/guix.texi:643 +msgid "Support for build offloading (@pxref{Daemon Offload Setup}) and @command{guix copy} (@pxref{Invoking guix copy}) depends on @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, version 0.10.2 or later." +msgstr "Unterstützung für das Auslagern von Erstellungen (@pxref{Daemon Offload Setup}) und @command{guix copy} (@pxref{Invoking guix copy}) hängt von @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH}, Version 0.10.2 oder neuer, ab." + +#. type: itemize +#: doc/guix.texi:647 +msgid "When @url{http://www.bzip.org, libbz2} is available, @command{guix-daemon} can use it to compress build logs." +msgstr "Wenn @url{http://www.bzip.org, libbz2} verfügbar ist, kann @command{guix-daemon} damit Erstellungsprotokolle komprimieren." + +#. type: Plain text +#: doc/guix.texi:651 +msgid "Unless @code{--disable-daemon} was passed to @command{configure}, the following packages are also needed:" +msgstr "Sofern nicht @code{--disable-daemon} beim Aufruf von @command{configure} übergeben wurde, benötigen Sie auch folgende Pakete:" + +#. type: item +#: doc/guix.texi:653 +#, no-wrap +msgid "@url{http://sqlite.org, SQLite 3};" +msgstr "@url{http://sqlite.org, SQLite 3}," + +#. type: item +#: doc/guix.texi:654 +#, no-wrap +msgid "@url{http://gcc.gnu.org, GCC's g++}, with support for the" +msgstr "@url{http://gcc.gnu.org, GCC's g++} mit Unterstützung für den" + +#. type: itemize +#: doc/guix.texi:656 +msgid "C++11 standard." +msgstr "C++11-Standard." + +#. type: cindex +#: doc/guix.texi:658 +#, no-wrap +msgid "state directory" +msgstr "Zustandsverzeichnis" + +#. type: Plain text +#: doc/guix.texi:666 +msgid "When configuring Guix on a system that already has a Guix installation, be sure to specify the same state directory as the existing installation using the @code{--localstatedir} option of the @command{configure} script (@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding Standards}). The @command{configure} script protects against unintended misconfiguration of @var{localstatedir} so you do not inadvertently corrupt your store (@pxref{The Store})." +msgstr "Sollten Sie Guix auf einem System konfigurieren, auf dem Guix bereits installiert ist, dann stellen Sie sicher, dasselbe Zustandsverzeichnis wie für die bestehende Installation zu verwenden. Benutzen Sie dazu die Befehlszeilenoption @code{--localstatedir} des @command{configure}-Skripts (@pxref{Directory Variables, @code{localstatedir},, standards, GNU Coding Standards}). Das @command{configure}-Skript schützt vor ungewollter Fehlkonfiguration der @var{localstatedir}, damit sie nicht versehentlich Ihren Store verfälschen (@pxref{The Store})." + +#. type: cindex +#: doc/guix.texi:667 +#, no-wrap +msgid "Nix, compatibility" +msgstr "Nix, Kompatibilität" + +#. type: Plain text +#: doc/guix.texi:672 +msgid "When a working installation of @url{http://nixos.org/nix/, the Nix package manager} is available, you can instead configure Guix with @code{--disable-daemon}. In that case, Nix replaces the three dependencies above." +msgstr "Wenn eine funktionierende Installation of @url{http://nixos.org/nix/, the Nix package manager} verfügbar ist, können Sie Guix stattdessen mit @code{--disable-daemon} konfigurieren. In diesem Fall ersetzt Nix die drei obengenannten Abhängigkeiten." + +#. type: Plain text +#: doc/guix.texi:682 +msgid "Guix is compatible with Nix, so it is possible to share the same store between both. To do so, you must pass @command{configure} not only the same @code{--with-store-dir} value, but also the same @code{--localstatedir} value. The latter is essential because it specifies where the database that stores metadata about the store is located, among other things. The default values for Nix are @code{--with-store-dir=/nix/store} and @code{--localstatedir=/nix/var}. Note that @code{--disable-daemon} is not required if your goal is to share the store with Nix." +msgstr "Guix ist mit Nix kompatibel, daher ist es möglich, denselben Store für beide zu verwenden. Dazu müssen Sie an @command{configure} nicht nur denselben Wert für @code{--with-store-dir} übergeben, sondern auch denselben Wert für @code{--localstatedir}. Letzterer ist deswegen essenziell, weil er unter Anderem angibt, wo die Datenbank liegt, in der sich die Metainformationen über den Store befinden. Für Nix sind die Werte standardmäßig @code{--with-store-dir=/nix/store} und @code{--localstatedir=/nix/var}. Beachten Sie, dass @code{--disable-daemon} nicht erforderlich ist, wenn Sie die Absicht haben, den Store mit Nix zu teilen." + +#. type: cindex +#: doc/guix.texi:686 +#, no-wrap +msgid "test suite" +msgstr "Testkatalog" + +#. type: Plain text +#: doc/guix.texi:692 +msgid "After a successful @command{configure} and @code{make} run, it is a good idea to run the test suite. It can help catch issues with the setup or environment, or bugs in Guix itself---and really, reporting test failures is a good way to help improve the software. To run the test suite, type:" +msgstr "Nachdem @command{configure} und @code{make} erfolgreich durchgelaufen sind, ist es ratsam, den Testkatalog auszuführen. Er kann dabei helfen, Probleme mit der Einrichtung oder Systemumgebung zu finden, oder auch Probleme in Guix selbst — und Testfehler zu melden ist eine wirklich gute Art und Weise, bei der Verbesserung von Guix mitzuhelfen. Um den Testkatalog auszuführen, geben Sie Folgendes ein:" + +#. type: example +#: doc/guix.texi:695 +#, no-wrap +msgid "make check\n" +msgstr "make check\n" + +#. type: Plain text +#: doc/guix.texi:702 +msgid "Test cases can run in parallel: you can use the @code{-j} option of GNU@tie{}make to speed things up. The first run may take a few minutes on a recent machine; subsequent runs will be faster because the store that is created for test purposes will already have various things in cache." +msgstr "Testfälle können parallel ausgeführt werden. Sie können die Befehlszeiltenoption @code{-j} von GNU@tie{}make benutzen, damit es schneller geht. Der erste Durchlauf kann auf neuen Maschinen ein paar Minuten dauern, nachfolgende Ausführungen werden schneller sein, weil der für die Tests erstellte Store schon einige Dinge zwischengespeichert haben wird." + +#. type: Plain text +#: doc/guix.texi:705 +msgid "It is also possible to run a subset of the tests by defining the @code{TESTS} makefile variable as in this example:" +msgstr "Es ist auch möglich, eine Teilmenge der Tests laufen zu lassen, indem Sie die @code{TESTS}-Variable des Makefiles ähnlich wie in diesem Beispiel definieren:" + +#. type: example +#: doc/guix.texi:708 +#, no-wrap +msgid "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n" +msgstr "make check TESTS=\"tests/store.scm tests/cpio.scm\"\n" + +#. type: Plain text +#: doc/guix.texi:713 +msgid "By default, tests results are displayed at a file level. In order to see the details of every individual test cases, it is possible to define the @code{SCM_LOG_DRIVER_FLAGS} makefile variable as in this example:" +msgstr "Standardmäßig werden Testergebnisse pro Datei angezeigt. Um die Details jedes einzelnen Testfalls zu sehen, können Sie wie in diesem Beispiel die @code{SCM_LOG_DRIVER_FLAGS}-Variable des Makefiles definieren:" + +#. type: example +#: doc/guix.texi:716 +#, no-wrap +msgid "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n" +msgstr "make check TESTS=\"tests/base64.scm\" SCM_LOG_DRIVER_FLAGS=\"--brief=no\"\n" + +#. type: Plain text +#: doc/guix.texi:722 +msgid "Upon failure, please email @email{bug-guix@@gnu.org} and attach the @file{test-suite.log} file. Please specify the Guix version being used as well as version numbers of the dependencies (@pxref{Requirements}) in your message." +msgstr "Kommt es zum Fehlschlag, senden Sie bitte eine E-mail an @email{bug-guix@@gnu.org} und fügen Sie die Datei @file{test-suite.log} als Anhang bei. Bitte geben Sie dabei in Ihrer Nachricht die benutze Version von Guix an sowie die Versionsnummern der Abhängigkeiten (@pxref{Requirements})." + +#. type: Plain text +#: doc/guix.texi:726 +msgid "Guix also comes with a whole-system test suite that tests complete GuixSD operating system instances. It can only run on systems where Guix is already installed, using:" +msgstr "Guix wird auch mit einem Testkatalog für das ganze System ausgeliefert, der vollständige Instanzen des GuixSD-Betriebssystems testet. Er kann nur auf Systemen benutzt werden, auf denen Guix bereits installiert ist, mit folgendem Befehl:" + +#. type: example +#: doc/guix.texi:729 +#, no-wrap +msgid "make check-system\n" +msgstr "make check-system\n" + +#. type: Plain text +#: doc/guix.texi:733 +msgid "or, again, by defining @code{TESTS} to select a subset of tests to run:" +msgstr "Oder, auch hier, indem Sie @code{TESTS} definieren, um eine Teilmenge der auszuführenden Tests anzugeben:" + +#. type: example +#: doc/guix.texi:736 +#, no-wrap +msgid "make check-system TESTS=\"basic mcron\"\n" +msgstr "make check-system TESTS=\"basic mcron\"\n" + +#. type: Plain text +#: doc/guix.texi:744 +msgid "These system tests are defined in the @code{(gnu tests @dots{})} modules. They work by running the operating systems under test with lightweight instrumentation in a virtual machine (VM). They can be computationally intensive or rather cheap, depending on whether substitutes are available for their dependencies (@pxref{Substitutes}). Some of them require a lot of storage space to hold VM images." +msgstr "Diese Systemtests sind in den @code{(gnu tests @dots{})}-Modulen definiert. Sie funktionieren, indem Sie das getestete Betriebssystem mitsamt schlichter Instrumentierung in einer virtuellen Maschine (VM) ausführen. Die Tests können aufwendige Berechnungen durchführen oder sie günstig umgehen, je nachdem, ob für ihre Abhängigkeiten Substitute zur Verfügung stehen (@pxref{Substitutes}). Manche von ihnen nehmen viel Speicherplatz in Anspruch, um die VM-Abbilder zu speichern." + +#. type: Plain text +#: doc/guix.texi:747 +msgid "Again in case of test failures, please send @email{bug-guix@@gnu.org} all the details." +msgstr "Auch hier gilt: Falls Testfehler auftreten, senden Sie bitte alle Details an @email{bug-guix@@gnu.org}." + +#. type: cindex +#: doc/guix.texi:751 +#, no-wrap +msgid "daemon" +msgstr "Daemon" + +#. type: Plain text +#: doc/guix.texi:759 +msgid "Operations such as building a package or running the garbage collector are all performed by a specialized process, the @dfn{build daemon}, on behalf of clients. Only the daemon may access the store and its associated database. Thus, any operation that manipulates the store goes through the daemon. For instance, command-line tools such as @command{guix package} and @command{guix build} communicate with the daemon (@i{via} remote procedure calls) to instruct it what to do." +msgstr "Operationen wie das Erstellen eines Pakets oder Laufenlassen des Müllsammlers werden alle durch einen spezialisierten Prozess durchgeführt, den @dfn{Erstellungs-Daemon}, im Auftrag seiner Kunden (Clients). Nur der Daemon darf auf den Store und seine zugehörige Datenbank zugreifen. Daher wird jede den Store verändernde Operation durch den Daemon durchgeführt. Zum Beispiel kommunizieren Befehlszeilenwerkzeuge wie @command{guix package} und @command{guix build} mit dem Daemon (mittels entfernter Prozeduraufrufe), um ihm Anweisungen zu geben, was er tun soll." + +#. type: Plain text +#: doc/guix.texi:763 +msgid "The following sections explain how to prepare the build daemon's environment. See also @ref{Substitutes}, for information on how to allow the daemon to download pre-built binaries." +msgstr "Folgende Abschnitte beschreiben, wie Sie die Umgebung des Erstellungs-Daemons ausstatten sollten. Siehe auch @ref{Substitutes} für Informationen darüber, wie Sie es dem Daemon ermöglichen, vorerstellte Binärdateien herunterzuladen." + +#. type: cindex +#: doc/guix.texi:773 doc/guix.texi:1198 +#, no-wrap +msgid "build environment" +msgstr "Erstellungsumgebung" + +#. type: Plain text +#: doc/guix.texi:781 +msgid "In a standard multi-user setup, Guix and its daemon---the @command{guix-daemon} program---are installed by the system administrator; @file{/gnu/store} is owned by @code{root} and @command{guix-daemon} runs as @code{root}. Unprivileged users may use Guix tools to build packages or otherwise access the store, and the daemon will do it on their behalf, ensuring that the store is kept in a consistent state, and allowing built packages to be shared among users." +msgstr "In einem normalen Mehrbenutzersystem werden Guix und sein Daemon — das Programm @command{guix-daemon} — vom Systemadministrator installiert; @file{/gnu/store} gehört @code{root} und @command{guix-daemon} läuft als @code{root}. Nicht mit erweiterten Rechten ausgestattete Nutzer können Guix-Werkzeuge benutzen, um Pakete zu erstellen oder anderweitig auf den Store zuzugreifen, und der Daemon wird dies für sie erledigen und dabei sicherstellen, dass der Store in einem konsistenten Zustand verbleibt und sich die Nutzer erstellte Pakete teilen." + +#. type: cindex +#: doc/guix.texi:782 +#, no-wrap +msgid "build users" +msgstr "Erstellungsbenutzer" + +#. type: Plain text +#: doc/guix.texi:793 +msgid "When @command{guix-daemon} runs as @code{root}, you may not want package build processes themselves to run as @code{root} too, for obvious security reasons. To avoid that, a special pool of @dfn{build users} should be created for use by build processes started by the daemon. These build users need not have a shell and a home directory: they will just be used when the daemon drops @code{root} privileges in build processes. Having several such users allows the daemon to launch distinct build processes under separate UIDs, which guarantees that they do not interfere with each other---an essential feature since builds are regarded as pure functions (@pxref{Introduction})." +msgstr "Wenn @command{guix-daemon} als Administratornutzer @code{root} läuft, wollen Sie aber vielleicht dennoch nicht, dass Paketerstellungsprozesse auch als @code{root} ablaufen, aus offensichtlichen Sicherheitsgründen. Um dies zu vermeiden, sollte ein besonderer Pool aus @dfn{Erstellungsbenutzern} geschaffen werden, damit vom Daemon gestartete Erstellungsprozesse ihn benutzen. Diese Erstellungsbenutzer müssen weder eine Shell noch einen Persönlichen Ordner zugewiesen bekommen, sie werden lediglich benutzt, wenn der Daemon @code{root}-Rechte in Erstellungsprozessen ablegt. Mehrere solche Benutzer zu haben, ermöglicht es dem Daemon, verschiedene Erstellungsprozessen unter verschiedenen Benutzeridentifikatoren (UIDs) zu starten, was garantiert, dass sie einander nicht stören — eine essenzielle Funktionalität, da Erstellungen als reine Funktionen angesehen werden (@pxref{Introduction})." + +#. type: Plain text +#: doc/guix.texi:796 +msgid "On a GNU/Linux system, a build user pool may be created like this (using Bash syntax and the @code{shadow} commands):" +msgstr "Auf einem GNU/Linux-System kann ein Pool von Erstellungsbenutzern wie folgt erzeugt werden (mit Bash-Syntax und den Befehlen von @code{shadow}):" + +#. type: example +#: doc/guix.texi:808 +#, no-wrap +msgid "" +"# groupadd --system guixbuild\n" +"# for i in `seq -w 1 10`;\n" +" do\n" +" useradd -g guixbuild -G guixbuild \\\n" +" -d /var/empty -s `which nologin` \\\n" +" -c \"Guix build user $i\" --system \\\n" +" guixbuilder$i;\n" +" done\n" +msgstr "" +"# groupadd --system guixbuild\n" +"# for i in `seq -w 1 10`;\n" +" do\n" +" useradd -g guixbuild -G guixbuild \\\n" +" -d /var/empty -s `which nologin` \\\n" +" -c \"Guix-Erstellungsbenutzer $i\" --system \\\n" +" guixbuilder$i;\n" +" done\n" + +#. type: Plain text +#: doc/guix.texi:818 +msgid "The number of build users determines how many build jobs may run in parallel, as specified by the @option{--max-jobs} option (@pxref{Invoking guix-daemon, @option{--max-jobs}}). To use @command{guix system vm} and related commands, you may need to add the build users to the @code{kvm} group so they can access @file{/dev/kvm}, using @code{-G guixbuild,kvm} instead of @code{-G guixbuild} (@pxref{Invoking guix system})." +msgstr "Die Anzahl der Erstellungsbenutzer entscheidet, wieviele Erstellungsaufträge parallel ausgeführt werden können, wie es mit der Befehlszeilenoption @option{--max-jobs} vorgeben werden kann (@pxref{Invoking guix-daemon, @option{--max-jobs}}). Um @command{guix system vm} und ähnliche Befehle nutzen zu können, müssen Sie die Erstellungsbenutzer unter Umständen zur @code{kvm}-Benutzergruppe hinzufügen, damit sie Zugriff auf @file{/dev/kvm} haben, mit @code{-G guixbuild,kvm} statt @code{-G guixbuild} (@pxref{Invoking guix system})." + +#. type: Plain text +#: doc/guix.texi:827 +msgid "The @code{guix-daemon} program may then be run as @code{root} with the following command@footnote{If your machine uses the systemd init system, dropping the @file{@var{prefix}/lib/systemd/system/guix-daemon.service} file in @file{/etc/systemd/system} will ensure that @command{guix-daemon} is automatically started. Similarly, if your machine uses the Upstart init system, drop the @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} file in @file{/etc/init}.}:" +msgstr "Das Programm @code{guix-daemon} kann mit dem folgenden Befehl als @code{root} gestartet werden@footnote{Wenn Ihre Maschine systemd als »init«-System verwendet, genügt es, die Datei @file{@var{prefix}/lib/systemd/system/guix-daemon.service} in @file{/etc/systemd/system} zu platzieren, damit @command{guix-daemon} automatisch gestartet wird. Ebenso können Sie, wenn Ihre Maschine Upstart als »init«-System benutzt, die Datei @file{@var{prefix}/lib/upstart/system/guix-daemon.conf} in @file{/etc/init} platzieren.}:" + +#. type: example +#: doc/guix.texi:830 doc/guix.texi:1191 +#, no-wrap +msgid "# guix-daemon --build-users-group=guixbuild\n" +msgstr "# guix-daemon --build-users-group=guixbuild\n" + +#. type: cindex +#: doc/guix.texi:832 doc/guix.texi:1196 +#, no-wrap +msgid "chroot" +msgstr "chroot" + +#. type: Plain text +#: doc/guix.texi:837 +msgid "This way, the daemon starts build processes in a chroot, under one of the @code{guixbuilder} users. On GNU/Linux, by default, the chroot environment contains nothing but:" +msgstr "Auf diese Weise startet der Daemon Erstellungsprozesse in einem chroot als einer der @code{guixbuilder}-Benutzer. Auf GNU/Linux enthält die chroot-Umgebung standardmäßig nichts außer:" + +#. type: itemize +#: doc/guix.texi:845 +msgid "a minimal @code{/dev} directory, created mostly independently from the host @code{/dev}@footnote{``Mostly'', because while the set of files that appear in the chroot's @code{/dev} is fixed, most of these files can only be created if the host has them.};" +msgstr "einem minimalen @code{/dev}-Verzeichnis, was größtenteils vom @code{/dev} des Wirtssystems unabhängig erstellt wurde@footnote{»Größtenteils«, denn obwohl die Menge an Dateien, die im @code{/dev} des chroots vorkommen, fest ist, können die meisten dieser Dateien nur dann erstellt werden, wenn das Wirtssystem sie auch hat.}," + +#. type: itemize +#: doc/guix.texi:849 +msgid "the @code{/proc} directory; it only shows the processes of the container since a separate PID name space is used;" +msgstr "dem @code{/proc}-Verzeichnis, es zeigt nur die Prozesse des Containers, weil ein separater Namensraum für Prozess-IDs (PIDs) benutzt wird," + +#. type: itemize +#: doc/guix.texi:853 +msgid "@file{/etc/passwd} with an entry for the current user and an entry for user @file{nobody};" +msgstr "@file{/etc/passwd} mit einem Eintrag für den aktuellen Benutzer und einem Eintrag für den Benutzer @file{nobody}," + +#. type: itemize +#: doc/guix.texi:856 +msgid "@file{/etc/group} with an entry for the user's group;" +msgstr "@file{/etc/group} mit einem Eintrag für die Gruppe des Benutzers," + +#. type: itemize +#: doc/guix.texi:860 +msgid "@file{/etc/hosts} with an entry that maps @code{localhost} to @code{127.0.0.1};" +msgstr "@file{/etc/hosts} mit einem Eintrag, der @code{localhost} auf @code{127.0.0.1} abbildet," + +#. type: itemize +#: doc/guix.texi:863 +msgid "a writable @file{/tmp} directory." +msgstr "einem @file{/tmp}-Verzeichnis mit Schreibrechten." + +#. type: Plain text +#: doc/guix.texi:872 +msgid "You can influence the directory where the daemon stores build trees @i{via} the @code{TMPDIR} environment variable. However, the build tree within the chroot is always called @file{/tmp/guix-build-@var{name}.drv-0}, where @var{name} is the derivation name---e.g., @code{coreutils-8.24}. This way, the value of @code{TMPDIR} does not leak inside build environments, which avoids discrepancies in cases where build processes capture the name of their build tree." +msgstr "Sie können beeinflussen, in welchem Verzeichnis der Daemon Erstellungsbäume unterbringt, indem sie den Wert der Umgebungsvariablen @code{TMPDIR} ändern. Allerdings heißt innerhalb des chroots der Erstellungsbaum immer @file{/tmp/guix-build-@var{name}.drv-0}, wobei @var{name} der Ableitungsname ist — z.B. @code{coreutils-8.24}. Dadurch hat der Wert von @code{TMPDIR} keinen Einfluss auf die Erstellungsumgebung, wodurch Unterschiede vermieden werden, falls Erstellungsprozesse den Namen ihres Erstellungsbaumes einfangen." + +#. type: vindex +#: doc/guix.texi:873 doc/guix.texi:2416 +#, no-wrap +msgid "http_proxy" +msgstr "http_proxy" + +#. type: Plain text +#: doc/guix.texi:877 +msgid "The daemon also honors the @code{http_proxy} environment variable for HTTP downloads it performs, be it for fixed-output derivations (@pxref{Derivations}) or for substitutes (@pxref{Substitutes})." +msgstr "Der Daemon befolgt außerdem den Wert der Umgebungsvariablen @code{http_proxy} für von ihm durchgeführte HTTP-Downloads, sei es für Ableitungen mit fester Ausgabe (@pxref{Derivations}) oder für Substitute (@pxref{Substitutes})." + +#. type: Plain text +#: doc/guix.texi:885 +msgid "If you are installing Guix as an unprivileged user, it is still possible to run @command{guix-daemon} provided you pass @code{--disable-chroot}. However, build processes will not be isolated from one another, and not from the rest of the system. Thus, build processes may interfere with each other, and may access programs, libraries, and other files available on the system---making it much harder to view them as @emph{pure} functions." +msgstr "Wenn Sie Guix als ein Benutzer ohne erweiterte Rechte installieren, ist es dennoch möglich, @command{guix-daemon} auszuführen, sofern Sie @code{--disable-chroot} übergeben. Allerdings können Erstellungsprozesse dann nicht voneinander und vom Rest des Systems isoliert werden. Daher können sich Erstellungsprozesse gegenseitig stören und auf Programme, Bibliotheken und andere Dateien zugreifen, die dem restlichen System zur Verfügung stehen — was es deutlich schwerer macht, die als @emph{reine} Funktionen aufzufassen." + +#. type: subsection +#: doc/guix.texi:888 +#, no-wrap +msgid "Using the Offload Facility" +msgstr "Nutzung der Auslagerungsfunktionalität" + +#. type: cindex +#: doc/guix.texi:890 +#, no-wrap +msgid "offloading" +msgstr "auslagern" + +#. type: cindex +#: doc/guix.texi:891 doc/guix.texi:1252 +#, no-wrap +msgid "build hook" +msgstr "Build-Hook" + +#. type: Plain text +#: doc/guix.texi:905 +msgid "When desired, the build daemon can @dfn{offload} derivation builds to other machines running Guix, using the @code{offload} @dfn{build hook}@footnote{This feature is available only when @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH} is present.}. When that feature is enabled, a list of user-specified build machines is read from @file{/etc/guix/machines.scm}; every time a build is requested, for instance via @code{guix build}, the daemon attempts to offload it to one of the machines that satisfy the constraints of the derivation, in particular its system type---e.g., @file{x86_64-linux}. Missing prerequisites for the build are copied over SSH to the target machine, which then proceeds with the build; upon success the output(s) of the build are copied back to the initial machine." +msgstr "Wenn erwünscht kann der Erstellungs-Daemon Ableitungserstellungen @dfn{auslagern} auf andere Maschinen, auf denen Guix läuft, mit Hilfe des @code{offload}-»@dfn{Build-Hooks}«@footnote{Diese Funktionalität ist nur verfügbar, wenn @uref{https://github.com/artyom-poptsov/guile-ssh, Guile-SSH} vorhanden ist.}. Wenn diese Funktionalität aktiviert ist, wird eine nutzerspezifizierte Liste von Erstellungsmaschinen aus @file{/etc/guix/machines.scm} gelesen. Wann immer eine Erstellung angefragt wird, zum Beispiel durch @code{guix build}, versucht der Daemon, sie an eine der Erstellungsmaschinen auszulagern, die die Einschränkungen der Ableitung erfüllen, insbesondere ihren Systemtyp — z.B. @file{x86_64-linux}. Fehlende Voraussetzungen für die Erstellung werden über SSH auf die Zielmaschine kopiert, welche dann mit der Erstellung weitermacht. Hat sie Erfolg damit, so werden die Ausgabe oder Ausgaben der Erstellung zurück auf die ursprüngliche Maschine kopiert." + +#. type: Plain text +#: doc/guix.texi:907 +msgid "The @file{/etc/guix/machines.scm} file typically looks like this:" +msgstr "Die Datei @file{/etc/guix/machines.scm} sieht normalerweise so aus:" + +#. type: example +#: doc/guix.texi:915 +#, no-wrap +msgid "" +"(list (build-machine\n" +" (name \"eightysix.example.org\")\n" +" (system \"x86_64-linux\")\n" +" (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n" +" (user \"bob\")\n" +" (speed 2.)) ;incredibly fast!\n" +"\n" +msgstr "" +"(list (build-machine\n" +" (name \"eightysix.example.org\")\n" +" (system \"x86_64-linux\")\n" +" (host-key \"ssh-ed25519 AAAAC3Nza@dots{}\")\n" +" (user \"bob\")\n" +" (speed 2.)) ;unglaublich schnell!\n" +"\n" + +#. type: example +#: doc/guix.texi:924 +#, no-wrap +msgid "" +" (build-machine\n" +" (name \"meeps.example.org\")\n" +" (system \"mips64el-linux\")\n" +" (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n" +" (user \"alice\")\n" +" (private-key\n" +" (string-append (getenv \"HOME\")\n" +" \"/.ssh/identity-for-guix\"))))\n" +msgstr "" +" (build-machine\n" +" (name \"meeps.example.org\")\n" +" (system \"mips64el-linux\")\n" +" (host-key \"ssh-rsa AAAAB3Nza@dots{}\")\n" +" (user \"alice\")\n" +" (private-key\n" +" (string-append (getenv \"HOME\")\n" +" \"/.ssh/identität-für-guix\"))))\n" + +#. type: Plain text +#: doc/guix.texi:930 +msgid "In the example above we specify a list of two build machines, one for the @code{x86_64} architecture and one for the @code{mips64el} architecture." +msgstr "Im obigen Beispiel geben wir eine Liste mit zwei Erstellungsmaschinen vor, eine für die @code{x86_64}-Architektur und eine für die @code{mips64el}-Architektur." + +#. type: Plain text +#: doc/guix.texi:939 +msgid "In fact, this file is---not surprisingly!---a Scheme file that is evaluated when the @code{offload} hook is started. Its return value must be a list of @code{build-machine} objects. While this example shows a fixed list of build machines, one could imagine, say, using DNS-SD to return a list of potential build machines discovered in the local network (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme Programs}). The @code{build-machine} data type is detailed below." +msgstr "Tatsächlich ist diese Datei — wenig überraschend! — eine Scheme-Datei, die ausgewertet wird, wenn der @code{offload}-Hook gestartet wird. Der Wert, den sie zurückliefert, muss eine Liste von @code{build-machine}-Objekten sein. Obwohl dieses Beispiel eine feste Liste von Erstellungsmaschinen zeigt, könnte man auch auf die Idee kommen, etwa mit DNS-SD eine Liste möglicher im lokalen Netzwerk entdeckter Erstellungsmaschinen zu liefern (@pxref{Introduction, Guile-Avahi,, guile-avahi, Using Avahi in Guile Scheme Programs}). Der Datentyp @code{build-machine} wird im Folgenden weiter ausgeführt." + +#. type: deftp +#: doc/guix.texi:940 +#, no-wrap +msgid "{Data Type} build-machine" +msgstr "{Datentyp} build-machine" + +#. type: deftp +#: doc/guix.texi:943 +msgid "This data type represents build machines to which the daemon may offload builds. The important fields are:" +msgstr "Dieser Datentyp repräsentiert Erstellungsmaschinen, an die der Daemon Erstellungen auslagern darf. Die wichtigen Felder sind:" + +#. type: code{#1} +#: doc/guix.texi:946 doc/guix.texi:3521 doc/guix.texi:9634 doc/guix.texi:9698 +#: doc/guix.texi:9793 doc/guix.texi:11267 doc/guix.texi:15402 +#: doc/guix.texi:15635 doc/guix.texi:15768 doc/guix.texi:16046 +#: doc/guix.texi:16087 doc/guix.texi:20147 doc/guix.texi:20164 +#: doc/guix.texi:20430 doc/guix.texi:21638 +#, no-wrap +msgid "name" +msgstr "name" + +#. type: table +#: doc/guix.texi:948 +msgid "The host name of the remote machine." +msgstr "Der Hostname der entfernten Maschine." + +#. type: item +#: doc/guix.texi:949 +#, no-wrap +msgid "system" +msgstr "system" + +#. type: table +#: doc/guix.texi:951 +msgid "The system type of the remote machine---e.g., @code{\"x86_64-linux\"}." +msgstr "Der Systemtyp der entfernten Maschine — z.B. @code{\"x86_64-linux\"}." + +#. type: code{#1} +#: doc/guix.texi:952 doc/guix.texi:11277 +#, no-wrap +msgid "user" +msgstr "user" + +#. type: table +#: doc/guix.texi:956 +msgid "The user account to use when connecting to the remote machine over SSH. Note that the SSH key pair must @emph{not} be passphrase-protected, to allow non-interactive logins." +msgstr "Das Benutzerkonto, mit dem eine Verbindung zur entfernten Maschine über SSH aufgebaut werden soll. Beachten Sie, dass das SSH-Schlüsselpaart @emph{nicht} durch eine Passphrase geschützt sein darf, damit nicht-interaktive Anmeldungen möglich sind." + +#. type: item +#: doc/guix.texi:957 +#, no-wrap +msgid "host-key" +msgstr "host-key" + +#. type: table +#: doc/guix.texi:961 +msgid "This must be the machine's SSH @dfn{public host key} in OpenSSH format. This is used to authenticate the machine when we connect to it. It is a long string that looks like this:" +msgstr "Dies muss der @dfn{öffentliche SSH-Host-Schlüssel} der Maschine im OpenSSH-Format sein. Er wird benutzt, um die Identität der Maschine zu prüfen, wenn wir uns mit ihr verbinden. Er ist eine lange Zeichenkette, die ungefähr so aussieht:" + +#. type: example +#: doc/guix.texi:964 +#, no-wrap +msgid "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n" +msgstr "ssh-ed25519 AAAAC3NzaC@dots{}mde+UhL hint@@example.org\n" + +#. type: table +#: doc/guix.texi:969 +msgid "If the machine is running the OpenSSH daemon, @command{sshd}, the host key can be found in a file such as @file{/etc/ssh/ssh_host_ed25519_key.pub}." +msgstr "Wenn auf der Maschine der OpenSSH-Daemon, @command{sshd}, läuft, ist der Host-Schlüssel in einer Datei wie @file{/etc/ssh/ssh_host_ed25519_key.pub} zu finden." + +#. type: table +#: doc/guix.texi:974 +msgid "If the machine is running the SSH daemon of GNU@tie{}lsh, @command{lshd}, the host key is in @file{/etc/lsh/host-key.pub} or a similar file. It can be converted to the OpenSSH format using @command{lsh-export-key} (@pxref{Converting keys,,, lsh, LSH Manual}):" +msgstr "Wenn auf der Maschine der SSH-Daemon von GNU@tie{}lsh, nämlich @command{lshd}, läuft, befindet sich der Host-Schlüssel in @file{/etc/lsh/host-key.pub} oder einer ähnlichen Datei. Er kann ins OpenSSH-Format umgewandelt werden durch @command{lsh-export-key} (@pxref{Converting keys,,, lsh, LSH Manual}):" + +#. type: example +#: doc/guix.texi:978 +#, no-wrap +msgid "" +"$ lsh-export-key --openssh < /etc/lsh/host-key.pub \n" +"ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n" +msgstr "" +"$ lsh-export-key --openssh < /etc/lsh/host-key.pub \n" +"ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV@dots{}\n" + +#. type: deftp +#: doc/guix.texi:983 +msgid "A number of optional fields may be specified:" +msgstr "Eine Reihe optionaler Felder kann festgelegt werden:" + +#. type: item +#: doc/guix.texi:986 +#, no-wrap +msgid "@code{port} (default: @code{22})" +msgstr "@code{port} (Vorgabe: @code{22})" + +#. type: table +#: doc/guix.texi:988 +msgid "Port number of SSH server on the machine." +msgstr "Portnummer des SSH-Servers auf der Maschine." + +#. type: item +#: doc/guix.texi:989 +#, no-wrap +msgid "@code{private-key} (default: @file{~root/.ssh/id_rsa})" +msgstr "@code{private-key} (Vorgabe: @file{~root/.ssh/id_rsa})" + +#. type: table +#: doc/guix.texi:992 +#, fuzzy +#| msgid "The SSH private key file to use when connecting to the machine, in OpenSSH format. This key must not be protected with a passphrase." +msgid "The SSH private key file to use when connecting to the machine, in OpenSSH format." +msgstr "Die Datei mit dem privaten SSH-Schlüssel, der beim Verbinden zur Maschine genutzt werden soll, im OpenSSH-Format. Dieser Schlüssel darf nicht mit einer Passphrase geschützt sein." + +#. type: table +#: doc/guix.texi:995 +msgid "Note that the default value is the private key @emph{of the root account}. Make sure it exists if you use the default." +msgstr "Beachten Sie, dass als Vorgabewert der private Schlüssel @emph{des root-Benutzers} genommen wird. Vergewissern Sie sich, dass er existiert, wenn Sie die Standardeinstellung verwenden." + +#. type: item +#: doc/guix.texi:996 +#, no-wrap +msgid "@code{compression} (default: @code{\"zlib@@openssh.com,zlib\"})" +msgstr "@code{compression} (Vorgabe: @code{\"zlib@@openssh.com,zlib\"})" + +#. type: item +#: doc/guix.texi:997 doc/guix.texi:10667 +#, no-wrap +msgid "@code{compression-level} (default: @code{3})" +msgstr "@code{compression-level} (Vorgabe: @code{3})" + +#. type: table +#: doc/guix.texi:999 +msgid "The SSH-level compression methods and compression level requested." +msgstr "Die Kompressionsmethoden auf SSH-Ebene und das angefragte Kompressionsniveau." + +#. type: table +#: doc/guix.texi:1002 +msgid "Note that offloading relies on SSH compression to reduce bandwidth usage when transferring files to and from build machines." +msgstr "Beachten Sie, dass Auslagerungen SSH-Kompression benötigen, um beim Übertragen von Dateien an Erstellungsmaschinen und zurück weniger Bandbreite zu benutzen." + +#. type: item +#: doc/guix.texi:1003 +#, no-wrap +msgid "@code{daemon-socket} (default: @code{\"/var/guix/daemon-socket/socket\"})" +msgstr "@code{daemon-socket} (Vorgabe: @code{\"/var/guix/daemon-socket/socket\"})" + +#. type: table +#: doc/guix.texi:1006 +msgid "File name of the Unix-domain socket @command{guix-daemon} is listening to on that machine." +msgstr "Dateiname des Unix-Sockets, auf dem @command{guix-daemon} auf der Maschine lauscht." + +#. type: item +#: doc/guix.texi:1007 +#, no-wrap +msgid "@code{parallel-builds} (default: @code{1})" +msgstr "@code{parallel-builds} (Vorgabe: @code{1})" + +#. type: table +#: doc/guix.texi:1009 +msgid "The number of builds that may run in parallel on the machine." +msgstr "Die Anzahl der Erstellungen, die auf der Maschine parallel ausgeführt werden können." + +#. type: item +#: doc/guix.texi:1010 +#, no-wrap +msgid "@code{speed} (default: @code{1.0})" +msgstr "@code{speed} (Vorgabe: @code{1.0})" + +#. type: table +#: doc/guix.texi:1013 +msgid "A ``relative speed factor''. The offload scheduler will tend to prefer machines with a higher speed factor." +msgstr "Ein »relativer Geschwindigkeitsfaktor«. Der Auslagerungsplaner gibt tendenziell Maschinen mit höherem Geschwindigkeitsfaktor den Vorrang." + +#. type: item +#: doc/guix.texi:1014 +#, no-wrap +msgid "@code{features} (default: @code{'()})" +msgstr "@code{features} (Vorgabe: @code{'()})" + +#. type: table +#: doc/guix.texi:1019 +msgid "A list of strings denoting specific features supported by the machine. An example is @code{\"kvm\"} for machines that have the KVM Linux modules and corresponding hardware support. Derivations can request features by name, and they will be scheduled on matching build machines." +msgstr "Eine Liste von Zeichenketten, die besondere von der Maschine unterstützte Funktionalitäten bezeichnen. Ein Beispiel ist @code{\"kvm\"} für Maschinen, die über die KVM-Linux-Module zusammen mit entsprechender Hardware-Unterstützung verfügen. Ableitungen können Funktionalitäten dem Namen nach anfragen und werden dann auf passenden Erstellungsmaschinen eingeplant." + +#. type: Plain text +#: doc/guix.texi:1027 +msgid "The @code{guile} command must be in the search path on the build machines. In addition, the Guix modules must be in @code{$GUILE_LOAD_PATH} on the build machine---you can check whether this is the case by running:" +msgstr "Der Befehl @code{guile} muss sich im Suchpfad der Erstellungsmaschinen befinden. Zusätzlich müssen die Guix-Module im @code{$GUILE_LOAD_PATH} auf den Erstellungsmaschinen zu finden sein — um dies nachzuprüfen, können Sie Folgendes ausführen:" + +#. type: example +#: doc/guix.texi:1030 +#, no-wrap +msgid "ssh build-machine guile -c \"'(use-modules (guix config))'\"\n" +msgstr "ssh build-machine guile -c \"'(use-modules (guix config))'\"\n" + +#. type: Plain text +#: doc/guix.texi:1037 +msgid "There is one last thing to do once @file{machines.scm} is in place. As explained above, when offloading, files are transferred back and forth between the machine stores. For this to work, you first need to generate a key pair on each machine to allow the daemon to export signed archives of files from the store (@pxref{Invoking guix archive}):" +msgstr "Es gibt noch eine weitere Sache zu tun, sobald @file{machines.scm} eingerichtet ist. Wie zuvor erklärt, werden beim Auslagern Dateien zwischen den Stores der Maschinen hin- und hergeschickt. Damit das funktioniert, müssen Sie als Erstes ein Schlüsselpaar auf jeder Maschine erzeugen, damit der Daemon signierte Archive mit den Dateien aus dem Store versenden kann (@pxref{Invoking guix archive}):" + +#. type: example +#: doc/guix.texi:1040 +#, no-wrap +msgid "# guix archive --generate-key\n" +msgstr "# guix archive --generate-key\n" + +#. type: Plain text +#: doc/guix.texi:1045 +msgid "Each build machine must authorize the key of the master machine so that it accepts store items it receives from the master:" +msgstr "Jede Erstellungsmaschine muss den Schlüssel der Hauptmaschine autorisieren, damit diese Store-Objekte von der Hauptmaschine empfangen kann:" + +#. type: example +#: doc/guix.texi:1048 +#, no-wrap +msgid "# guix archive --authorize < master-public-key.txt\n" +msgstr "# guix archive --authorize < öffentlicher-schlüssel-hauptmaschine.txt\n" + +#. type: Plain text +#: doc/guix.texi:1052 +msgid "Likewise, the master machine must authorize the key of each build machine." +msgstr "Andersherum muss auch die Hauptmaschine den jeweiligen Schlüssel jeder Erstellungsmaschine autorisieren." + +#. type: Plain text +#: doc/guix.texi:1058 +msgid "All the fuss with keys is here to express pairwise mutual trust relations between the master and the build machines. Concretely, when the master receives files from a build machine (and @i{vice versa}), its build daemon can make sure they are genuine, have not been tampered with, and that they are signed by an authorized key." +msgstr "Der ganze Umstand mit den Schlüsseln soll ausdrücken, dass sich Haupt- und Erstellungsmaschinen paarweise gegenseitig vertrauen. Konkret kann der Erstellungs-Daemon auf der Hauptmaschine die Echtheit von den Erstellungsmaschinen empfangener Dateien gewährleisten (und umgekehrt), und auch dass sie nicht sabotiert wurden und mit einem autorisierten Schlüssel signiert wurden." + +#. type: cindex +#: doc/guix.texi:1059 +#, no-wrap +msgid "offload test" +msgstr "Auslagerung testen" + +#. type: Plain text +#: doc/guix.texi:1062 +msgid "To test whether your setup is operational, run this command on the master node:" +msgstr "Um zu testen, ob Ihr System funktioniert, führen Sie diesen Befehl auf der Hauptmaschine aus:" + +#. type: example +#: doc/guix.texi:1065 +#, no-wrap +msgid "# guix offload test\n" +msgstr "# guix offload test\n" + +#. type: Plain text +#: doc/guix.texi:1071 +msgid "This will attempt to connect to each of the build machines specified in @file{/etc/guix/machines.scm}, make sure Guile and the Guix modules are available on each machine, attempt to export to the machine and import from it, and report any error in the process." +msgstr "Dadurch wird versucht, zu jeder Erstellungsmaschine eine Verbindung herzustellen, die in @file{/etc/guix/machines.scm} angegeben wurde, sichergestellt, dass auf jeder Guile und die Guix-Module nutzbar sind, und jeweils versucht, etwas auf die Erstellungsmaschine zu exportieren und von dort zu imporieren. Dabei auftretende Fehler werden gemeldet." + +#. type: Plain text +#: doc/guix.texi:1074 +msgid "If you want to test a different machine file, just specify it on the command line:" +msgstr "Wenn Sie stattdessen eine andere Maschinendatei verwenden möchten, geben Sie diese einfach auf der Befehlszeile an:" + +#. type: example +#: doc/guix.texi:1077 +#, no-wrap +msgid "# guix offload test machines-qualif.scm\n" +msgstr "# guix offload test maschinen-qualif.scm\n" + +#. type: Plain text +#: doc/guix.texi:1081 +msgid "Last, you can test the subset of the machines whose name matches a regular expression like this:" +msgstr "Letztendlich können Sie hiermit nur die Teilmenge der Maschinen testen, deren Name zu einem regulären Ausdruck passt:" + +#. type: example +#: doc/guix.texi:1084 +#, no-wrap +msgid "# guix offload test machines.scm '\\.gnu\\.org$'\n" +msgstr "# guix offload test maschinen.scm '\\.gnu\\.org$'\n" + +#. type: cindex +#: doc/guix.texi:1086 +#, no-wrap +msgid "offload status" +msgstr "Auslagerungs-Lagebericht" + +#. type: Plain text +#: doc/guix.texi:1089 +msgid "To display the current load of all build hosts, run this command on the main node:" +msgstr "Um die momentane Auslastung aller Erstellungs-Hosts anzuzeigen, führen Sie diesen Befehl auf dem Hauptknoten aus:" + +#. type: example +#: doc/guix.texi:1092 +#, no-wrap +msgid "# guix offload status\n" +msgstr "# guix offload status\n" + +#. type: cindex +#: doc/guix.texi:1098 +#, no-wrap +msgid "SELinux, daemon policy" +msgstr "SELinux, Policy für den Daemon" + +#. type: cindex +#: doc/guix.texi:1099 +#, no-wrap +msgid "mandatory access control, SELinux" +msgstr "Mandatory Access Control, SELinux" + +#. type: cindex +#: doc/guix.texi:1100 +#, no-wrap +msgid "security, guix-daemon" +msgstr "Sicherheit, des guix-daemon" + +#. type: Plain text +#: doc/guix.texi:1106 +msgid "Guix includes an SELinux policy file at @file{etc/guix-daemon.cil} that can be installed on a system where SELinux is enabled, in order to label Guix files and to specify the expected behavior of the daemon. Since GuixSD does not provide an SELinux base policy, the daemon policy cannot be used on GuixSD." +msgstr "" +"Guix enthält eine SELinux-Richtliniendatei (»Policy«) unter\n" +"@file{etc/guix-daemon.cil}, die auf einem System installiert werden\n" +"kann, auf dem SELinux aktiviert ist, damit Guix-Dateien gekennzeichnet\n" +"sind, und um das erwartete Verhalten des Daemons anzugeben. Da GuixSD\n" +"keine Grundrichtlinie (»Base Policy«) für SELinux bietet, kann diese\n" +"Richtlinie für den Daemon auf GuixSD nicht benutzt werden." + +#. type: subsubsection +#: doc/guix.texi:1107 +#, no-wrap +msgid "Installing the SELinux policy" +msgstr "Installieren der SELinux-Policy" + +#. type: cindex +#: doc/guix.texi:1108 +#, no-wrap +msgid "SELinux, policy installation" +msgstr "SELinux, Policy installieren" + +#. type: Plain text +#: doc/guix.texi:1110 +msgid "To install the policy run this command as root:" +msgstr "Um die Richtlinie (Policy) zu installieren, führen Sie folgenden Befehl mit Administratorrechten aus:" + +#. type: example +#: doc/guix.texi:1113 +#, no-wrap +msgid "semodule -i etc/guix-daemon.cil\n" +msgstr "semodule -i etc/guix-daemon.cil\n" + +#. type: Plain text +#: doc/guix.texi:1117 +msgid "Then relabel the file system with @code{restorecon} or by a different mechanism provided by your system." +msgstr "Kennzeichnen Sie dann das Dateisystem neu mit @code{restorecon} oder einem anderen, von Ihrem System angebotenen Mechanismus." + +#. type: Plain text +#: doc/guix.texi:1122 +msgid "Once the policy is installed, the file system has been relabeled, and the daemon has been restarted, it should be running in the @code{guix_daemon_t} context. You can confirm this with the following command:" +msgstr "Sobald die Richtlinie installiert ist, das Dateisystem neu gekennzeichnet wurde und der Daemon neugestartet wurde, sollte er im Kontext @code{guix_daemon_t} laufen. Sie können dies mit dem folgenden Befehl nachprüfen:" + +#. type: example +#: doc/guix.texi:1125 +#, no-wrap +msgid "ps -Zax | grep guix-daemon\n" +msgstr "ps -Zax | grep guix-daemon\n" + +#. type: Plain text +#: doc/guix.texi:1130 +msgid "Monitor the SELinux log files as you run a command like @code{guix build hello} to convince yourself that SELinux permits all necessary operations." +msgstr "Beobachten Sie die Protokolldateien von SELinux, wenn Sie einen Befehl wie @code{guix build hello} ausführen, um sich zu überzeugen, dass SELinux alle notwendigen Operationen gestattet." + +#. type: cindex +#: doc/guix.texi:1132 +#, no-wrap +msgid "SELinux, limitations" +msgstr "SELinux, Einschränkungen" + +#. type: Plain text +#: doc/guix.texi:1137 +msgid "This policy is not perfect. Here is a list of limitations or quirks that should be considered when deploying the provided SELinux policy for the Guix daemon." +msgstr "Diese Richtlinie ist nicht perfekt. Im Folgenden finden Sie eine Liste von Einschränkungen oder merkwürdiger Verhaltensweisen, die bedacht werden sollten, wenn man die mitgelieferte SELinux-Richtlinie für den Guix-Daemon einspielt." + +#. type: enumerate +#: doc/guix.texi:1144 +msgid "@code{guix_daemon_socket_t} isn’t actually used. None of the socket operations involve contexts that have anything to do with @code{guix_daemon_socket_t}. It doesn’t hurt to have this unused label, but it would be preferrable to define socket rules for only this label." +msgstr "@code{guix_daemon_socket_t} wird nicht wirklich benutzt. Keine der Socket-Operationen benutzt Kontexte, die irgendetwas mit @code{guix_daemon_socket_t} zu tun haben. Es schadet nicht, diese ungenutzte Kennzeichnung zu haben, aber es wäre besser, für die Kennzeichnung auch Socket-Regeln festzulegen." + +#. type: enumerate +#: doc/guix.texi:1155 +msgid "@code{guix gc} cannot access arbitrary links to profiles. By design, the file label of the destination of a symlink is independent of the file label of the link itself. Although all profiles under $localstatedir are labelled, the links to these profiles inherit the label of the directory they are in. For links in the user’s home directory this will be @code{user_home_t}. But for links from the root user’s home directory, or @file{/tmp}, or the HTTP server’s working directory, etc, this won’t work. @code{guix gc} would be prevented from reading and following these links." +msgstr "@code{guix gc} kann nicht auf beliebige Verknüpfungen zu Profilen zugreifen. Die Kennzeichnung des Ziels einer symbolischen Verknüpfung ist notwendigerweise unabhängig von der Dateikennzeichnung der Verknüpfung. Obwohl alle Profile unter $localstatedir gekennzeichnet sind, erben die Verknüpfungen auf diese Profile die Kennzeichnung desjenigen Verzeichnisses, in dem sie sich befinden. Für Verknüpfungen im Persönlichen Ordner des Benutzers ist das @code{user_home_t}, aber Verknüpfungen aus dem Persönlichen Ordner des Administratornutzers, oder @file{/tmp}, oder das Arbeitsverzeichnis des HTTP-Servers, etc., funktioniert das nicht. @code{guix gc} würde es nicht gestattet, diese Verknüpfungen auszulesen oder zu verfolgen." + +#. type: enumerate +#: doc/guix.texi:1160 +msgid "The daemon’s feature to listen for TCP connections might no longer work. This might require extra rules, because SELinux treats network sockets differently from files." +msgstr "Die vom Daemon gebotene Funktionalität, auf TCP-Verbindungen zu lauschen, könnte nicht mehr funktionieren. Dies könnte zusätzliche Regeln brauchen, weil SELinux Netzwerk-Sockets anders behandelt als Dateien." + +#. type: enumerate +#: doc/guix.texi:1171 +msgid "Currently all files with a name matching the regular expression @code{/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon} are assigned the label @code{guix_daemon_exec_t}; this means that @emph{any} file with that name in any profile would be permitted to run in the @code{guix_daemon_t} domain. This is not ideal. An attacker could build a package that provides this executable and convince a user to install and run it, which lifts it into the @code{guix_daemon_t} domain. At that point SELinux could not prevent it from accessing files that are allowed for processes in that domain." +msgstr "Derzeit wird allen Dateien mit einem Namen, der zum regulären Ausdruck @code{/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon} passt, die Kennzeichnung @code{guix_daemon_exec_t} zugewiesen, wodurch @emph{jedee beliebigee} Datei mit diesem Namen in irgendeinem Profil gestatttet wäre, in der Domäne @code{guix_daemon_t} ausgeführt zu werden. Das ist nicht ideal. Ein Angreifer könnte ein Paket erstellen, dass solch eine ausführbare Datei enthält, und den Nutzer überzeugen, es zu installieren und auszuführen. Dadurch käme es in die Domäne @code{guix_daemon_t}. Ab diesem Punkt könnte SELinux nicht mehr verhindern, dass es auf Dateien zugreift, auf die Prozesse in dieser Domäne zugreifen dürfen." + +#. type: enumerate +#: doc/guix.texi:1179 +msgid "We could generate a much more restrictive policy at installation time, so that only the @emph{exact} file name of the currently installed @code{guix-daemon} executable would be labelled with @code{guix_daemon_exec_t}, instead of using a broad regular expression. The downside is that root would have to install or upgrade the policy at installation time whenever the Guix package that provides the effectively running @code{guix-daemon} executable is upgraded." +msgstr "Wir könnten zum Zeitpunkt der Installation eine wesentlich restriktivere Richtlinie generieren, für die nur @emph{genau derselbe} Dateiname des gerade installierten @code{guix-daemon}-Programms als @code{guix_daemon_exec_t} gekennzeichnet würde, statt einen vieles umfassenden regulären Ausdruck zu benutzen. Aber dann müsste der Administratornutzer zum Zeitpunkt der Installation jedes Mal die Richtlinie installieren oder aktualisieren müssen, sobald das Guix-Paket aktualisiert wird, dass das tatsächlich in Benutzung befindliche @code{guix-daemon}-Programm enthält." + +#. type: section +#: doc/guix.texi:1182 +#, no-wrap +msgid "Invoking @command{guix-daemon}" +msgstr "Aufruf von @command{guix-daemon}" + +#. type: Plain text +#: doc/guix.texi:1188 +msgid "The @command{guix-daemon} program implements all the functionality to access the store. This includes launching build processes, running the garbage collector, querying the availability of a build result, etc. It is normally run as @code{root} like this:" +msgstr "Das Programm @command{guix-daemon} implementiert alle Funktionalitäten, um auf den Store zuzugreifen. Dazu gehört das Starten von Erstellungsprozessen, das Ausführen des Müllsammlers, das Abfragen, ob ein Erstellungsergebnis verfügbar ist, etc. Normalerweise wird er so als Administratornutzer (@code{root}) gestartet:" + +#. type: Plain text +#: doc/guix.texi:1195 +msgid "For details on how to set it up, @pxref{Setting Up the Daemon}." +msgstr "Details, wie Sie ihn einrichten, finden Sie im Abschnitt @pxref{Setting Up the Daemon}." + +#. type: cindex +#: doc/guix.texi:1197 +#, no-wrap +msgid "container, build environment" +msgstr "Container, Erstellungsumgebung" + +#. type: cindex +#: doc/guix.texi:1199 doc/guix.texi:1737 doc/guix.texi:2397 doc/guix.texi:7858 +#, no-wrap +msgid "reproducible builds" +msgstr "Reproduzierbare Erstellungen" + +#. type: Plain text +#: doc/guix.texi:1211 +msgid "By default, @command{guix-daemon} launches build processes under different UIDs, taken from the build group specified with @code{--build-users-group}. In addition, each build process is run in a chroot environment that only contains the subset of the store that the build process depends on, as specified by its derivation (@pxref{Programming Interface, derivation}), plus a set of specific system directories. By default, the latter contains @file{/dev} and @file{/dev/pts}. Furthermore, on GNU/Linux, the build environment is a @dfn{container}: in addition to having its own file system tree, it has a separate mount name space, its own PID name space, network name space, etc. This helps achieve reproducible builds (@pxref{Features})." +msgstr "Standardmäßig führt @command{guix-daemon} Erstellungsprozesse mit unterschiedlichen UIDs aus, die aus der Erstellungsgruppe stammen, deren Name mit @code{--build-users-group} übergeben wurde. Außerdem läuft jeder Erstellungsprozess in einer chroot-Umgebung, die nur die Teilmenge des Stores enthält, von der der Erstellungsprozess abhängt, entsprechend seiner Ableitung (@pxref{Programming Interface, derivation}), und ein paar bestimmte Systemverzeichnisse, darunter standardmäßig auch @file{/dev} und @file{/dev/pts}. Zudem ist die Erstellungsumgebung auf GNU/Linux ein @dfn{Container}: Nicht nur hat er seinen eigenen Dateisystembaum, er hat auch einen separaten Namensraum zum Einhängen von Dateisystemen, seinen eigenen Namensraum für PIDs, für Netzwerke, etc. Dies hilft dabei, reproduzierbare Erstellungen zu garantieren (@pxref{Features})." + +#. type: Plain text +#: doc/guix.texi:1220 +#, fuzzy +msgid "When the daemon performs a build on behalf of the user, it creates a build directory under @file{/tmp} or under the directory specified by its @code{TMPDIR} environment variable; this directory is shared with the container for the duration of the build. Be aware that using a directory other than @file{/tmp} can affect build results---for example, with a longer directory name, a build process that uses Unix-domain sockets might hit the name length limitation for @code{sun_path}, which it would otherwise not hit." +msgstr "Wenn der Daemon im Auftrag des Nutzers eine Erstellung durchführt, erzeugt er ein Erstellungsverzeichnis, entweder in @file{/tmp} oder im Verzeichnis, das durch die Umgebungsvariable @code{TMPDIR} angegeben wurde; dieses Verzeichnis wird mit dem Container geteilt, solange die Erstellung noch läuft. Beachten Sie, dass die Nutzung eines anderen Verzeichnnnnnnnnnnnnnnn NEIN DAS STIMMT DOCH GAR NICHT MEHR Be aware that using a directory other than @file{/tmp} can affect build results---for example, with a longer directory name, a build process that uses Unix-domain sockets might hit the name length limitation for @code{sun_path}, which it would otherwise not hit." + +#. type: Plain text +#: doc/guix.texi:1224 +msgid "The build directory is automatically deleted upon completion, unless the build failed and the client specified @option{--keep-failed} (@pxref{Invoking guix build, @option{--keep-failed}})." +msgstr "Nach Abschluss der Erstellung wird das Erstellungsverzeichnis automatisch entfernt, außer wenn die Erstellung fehlgeschlagen ist und der Client @option{--keep-failed} angegeben hat (@pxref{Invoking guix build, @option{--keep-failed}})." + +#. type: Plain text +#: doc/guix.texi:1226 +msgid "The following command-line options are supported:" +msgstr "Die folgenden Befehlszeilenoptionen werden unterstützt:" + +#. type: item +#: doc/guix.texi:1228 +#, no-wrap +msgid "--build-users-group=@var{group}" +msgstr "--build-users-group=@var{Gruppe}" + +#. type: table +#: doc/guix.texi:1231 +msgid "Take users from @var{group} to run build processes (@pxref{Setting Up the Daemon, build users})." +msgstr "Verwende die Benutzerkonten aus der @var{Gruppe}, um Erstellungsprozesse auszuführen (@pxref{Setting Up the Daemon, build users})." + +#. type: item +#: doc/guix.texi:1232 doc/guix.texi:5669 +#, no-wrap +msgid "--no-substitutes" +msgstr "--no-substitutes" + +#. type: cindex +#: doc/guix.texi:1233 doc/guix.texi:1749 doc/guix.texi:2253 +#, no-wrap +msgid "substitutes" +msgstr "Substitute" + +#. type: table +#: doc/guix.texi:1237 doc/guix.texi:5673 +msgid "Do not use substitutes for build products. That is, always build things locally instead of allowing downloads of pre-built binaries (@pxref{Substitutes})." +msgstr "Benutze keine Substitute für Erstellungsergebnisse. Das heißt, dass alle Objekte lokal erstellt werden müssen, und kein Herunterladen von vorab erstellten Binärdateien erlaubt ist (@pxref{Substitutes})." + +#. type: table +#: doc/guix.texi:1241 +msgid "When the daemon runs with @code{--no-substitutes}, clients can still explicitly enable substitution @i{via} the @code{set-build-options} remote procedure call (@pxref{The Store})." +msgstr "Wenn der Daemon mit @code{--no-substitutes} ausgeführt wird, können Clients trotzdem Substitute explizit aktivieren über den entfernten Prozeduraufruf @code{set-build-options} (@pxref{The Store})." + +#. type: item +#: doc/guix.texi:1242 doc/guix.texi:5656 doc/guix.texi:7107 doc/guix.texi:7983 +#: doc/guix.texi:8171 +#, no-wrap +msgid "--substitute-urls=@var{urls}" +msgstr "--substitute-urls=@var{URLs}" + +#. type: anchor{#1} +#: doc/guix.texi:1248 +msgid "daemon-substitute-urls" +msgstr "daemon-substitute-urls" + +#. type: table +#: doc/guix.texi:1248 +msgid "Consider @var{urls} the default whitespace-separated list of substitute source URLs. When this option is omitted, @indicateurl{https://mirror.hydra.gnu.org https://hydra.gnu.org} is used (@code{mirror.hydra.gnu.org} is a mirror of @code{hydra.gnu.org})." +msgstr "Benutze @var{URLs} als standardmäßige, leerzeichengetrennte Liste der Quell-URLs für Substitute. Wenn diese Befehlszeilenoption nicht angegeben wird, wird @indicateurl{https://mirror.hydra.gnu.org https://hydra.gnu.org} verwendet (@code{mirror.hydra.gnu.org} ist ein Spiegelserver für @code{hydra.gnu.org})." + +#. type: table +#: doc/guix.texi:1251 +msgid "This means that substitutes may be downloaded from @var{urls}, as long as they are signed by a trusted signature (@pxref{Substitutes})." +msgstr "Das hat zur Folge, dass Substitute von den @var{URLs} heruntergeladen werden können, solange sie mit einer Signatur versehen sind, der vertraut wird (@pxref{Substitutes})." + +#. type: item +#: doc/guix.texi:1253 doc/guix.texi:5694 +#, no-wrap +msgid "--no-build-hook" +msgstr "--no-build-hook" + +#. type: table +#: doc/guix.texi:1255 +msgid "Do not use the @dfn{build hook}." +msgstr "Den »@dfn{Build-Hook}« nicht benutzen." + +#. type: table +#: doc/guix.texi:1259 +msgid "The build hook is a helper program that the daemon can start and to which it submits build requests. This mechanism is used to offload builds to other machines (@pxref{Daemon Offload Setup})." +msgstr "»Build-Hook« ist der Name eines Hilfsprogramms, das der Daemon starten kann und an das er Erstellungsanfragen übermittelt. Durch diesen Mechanismus können Erstellungen an andere Maschinen ausgelagert werden (@pxref{Daemon Offload Setup})." + +#. type: item +#: doc/guix.texi:1260 +#, no-wrap +msgid "--cache-failures" +msgstr "--cache-failures" + +#. type: table +#: doc/guix.texi:1262 +msgid "Cache build failures. By default, only successful builds are cached." +msgstr "Fehler bei der Erstellung zwischenspeichern. Normalerweise werden nur erfolgreiche Erstellungen gespeichert." + +#. type: table +#: doc/guix.texi:1267 +msgid "When this option is used, @command{guix gc --list-failures} can be used to query the set of store items marked as failed; @command{guix gc --clear-failures} removes store items from the set of cached failures. @xref{Invoking guix gc}." +msgstr "Wenn diese Befehlszeilenoption benutzt wird, kann @command{guix gc --list-failures} benutzt werden, um die Menge an Store-Objekten abzufragen, die als Fehlschläge markiert sind; @command{guix gc --clear-failures} entfernt Store-Objekte aus der Menge zwischengespeicherter Fehlschläge. @xref{Invoking guix gc}." + +#. type: item +#: doc/guix.texi:1268 doc/guix.texi:5718 +#, no-wrap +msgid "--cores=@var{n}" +msgstr "--cores=@var{n}" + +#. type: itemx +#: doc/guix.texi:1269 doc/guix.texi:5719 +#, no-wrap +msgid "-c @var{n}" +msgstr "-c @var{n}" + +#. type: table +#: doc/guix.texi:1272 +msgid "Use @var{n} CPU cores to build each derivation; @code{0} means as many as available." +msgstr "@var{n} CPU-Kerne zum Erstellen jeder Ableitung benutzen; @code{0} heißt, so viele wie verfügbar sind." + +#. type: table +#: doc/guix.texi:1276 +msgid "The default value is @code{0}, but it may be overridden by clients, such as the @code{--cores} option of @command{guix build} (@pxref{Invoking guix build})." +msgstr "Der Vorgabewert ist @code{0}, jeder Client kann jedoch eine abweichende Anzahl vorgeben, zum Beispiel mit der Befehlszeilenoption @code{--cores} von @command{guix build} (@pxref{Invoking guix build})." + +#. type: table +#: doc/guix.texi:1280 +msgid "The effect is to define the @code{NIX_BUILD_CORES} environment variable in the build process, which can then use it to exploit internal parallelism---for instance, by running @code{make -j$NIX_BUILD_CORES}." +msgstr "Dadurch wird die Umgebungsvariable @code{NIX_BUILD_CORES} im Erstellungsprozess definiert, welcher sie benutzen kann, um intern parallele Ausführungen zuzulassen — zum Beispiel durch Nutzung von @code{make -j$NIX_BUILD_CORES}." + +#. type: item +#: doc/guix.texi:1281 doc/guix.texi:5723 +#, no-wrap +msgid "--max-jobs=@var{n}" +msgstr "--max-jobs=@var{n}" + +#. type: itemx +#: doc/guix.texi:1282 doc/guix.texi:5724 +#, no-wrap +msgid "-M @var{n}" +msgstr "-M @var{n}" + +#. type: table +#: doc/guix.texi:1287 +msgid "Allow at most @var{n} build jobs in parallel. The default value is @code{1}. Setting it to @code{0} means that no builds will be performed locally; instead, the daemon will offload builds (@pxref{Daemon Offload Setup}), or simply fail." +msgstr "Höchstenss @var{n} Erstellungsaufträge parallel bearbeiten. Der Vorgabewert liegt bei @code{1}. Wird er auf @code{0} gesetzt, werden keine Erstellungen lokal durchgeführt, stattdessen lagert der Daemon sie nur aus (@pxref{Daemon Offload Setup}) oder sie schlagen einfach fehl." + +#. type: item +#: doc/guix.texi:1288 doc/guix.texi:5699 +#, no-wrap +msgid "--max-silent-time=@var{seconds}" +msgstr "--max-silent-time=@var{Sekunden}" + +#. type: table +#: doc/guix.texi:1291 doc/guix.texi:5702 +msgid "When the build or substitution process remains silent for more than @var{seconds}, terminate it and report a build failure." +msgstr "Wenn der Erstellungs- oder Substitutionsprozess länger als @var{Sekunden}-lang keine Ausgabe erzeugt, wird er abgebrochen und ein Fehler beim Erstellen gemeldet." + +#. type: table +#: doc/guix.texi:1293 doc/guix.texi:1302 +msgid "The default value is @code{0}, which disables the timeout." +msgstr "Der Vorgabewert ist @code{0}, was bedeutet, dass es keine Zeitbeschränkung gibt." + +#. type: table +#: doc/guix.texi:1296 +msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @code{--max-silent-time}})." +msgstr "Clients können einen anderen Wert als den hier angegebenen verwenden lassen (@pxref{Common Build Options, @code{--max-silent-time}})." + +#. type: item +#: doc/guix.texi:1297 doc/guix.texi:5706 +#, no-wrap +msgid "--timeout=@var{seconds}" +msgstr "--timeout=@var{Sekunden}" + +#. type: table +#: doc/guix.texi:1300 doc/guix.texi:5709 +msgid "Likewise, when the build or substitution process lasts for more than @var{seconds}, terminate it and report a build failure." +msgstr "Entsprechend wird hier der Erstellungs- oder Substitutionsprozess abgebrochen und als Fehlschlag gemeldet, wenn er mehr als @var{Sekunden}-lang dauert." + +#. type: table +#: doc/guix.texi:1305 +msgid "The value specified here can be overridden by clients (@pxref{Common Build Options, @code{--timeout}})." +msgstr "Clients können einen anderen Wert verwenden lassen (@pxref{Common Build Options, @code{--timeout}})." + +#. type: item +#: doc/guix.texi:1306 +#, no-wrap +msgid "--rounds=@var{N}" +msgstr "--rounds=@var{N}" + +#. type: table +#: doc/guix.texi:1311 +msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical. Note that this setting can be overridden by clients such as @command{guix build} (@pxref{Invoking guix build})." +msgstr "Jede Ableitung @var{n}-mal hintereinander erstellen und einen Fehler melden, wenn nacheinander ausgewertete Erstellungsergebnisse nicht Bit für Bit identisch sind. Beachten Sie, dass Clients wie @command{guix build} einen anderen Wert verwenden lassen können (@pxref{Invoking guix build})." + +#. type: table +#: doc/guix.texi:1315 doc/guix.texi:6008 +msgid "When used in conjunction with @option{--keep-failed}, the differing output is kept in the store, under @file{/gnu/store/@dots{}-check}. This makes it easy to look for differences between the two results." +msgstr "Wenn dies zusammen mit @option{--keep-failed} benutzt wird, bleiben die sich unterscheidenden Ausgaben im Store unter dem Namen @file{/gnu/store/@dots{}-check}. Dadurch können Unterschiede zwischen den beiden Ergebnissen leicht erkannt werden." + +#. type: item +#: doc/guix.texi:1316 +#, no-wrap +msgid "--debug" +msgstr "--debug" + +#. type: table +#: doc/guix.texi:1318 +msgid "Produce debugging output." +msgstr "Informationen zur Fehlersuche ausgeben." + +#. type: table +#: doc/guix.texi:1322 +msgid "This is useful to debug daemon start-up issues, but then it may be overridden by clients, for example the @code{--verbosity} option of @command{guix build} (@pxref{Invoking guix build})." +msgstr "Dies ist nützlich, um Probleme beim Starten des Daemons nachzuvollziehen; Clients könn aber auch ein abweichenden Wert verwenden lassen, zum Beispiel mit der Befehlszeilenoption @code{--verbosity} von @command{guix build} (@pxref{Invoking guix build})." + +#. type: item +#: doc/guix.texi:1323 +#, no-wrap +msgid "--chroot-directory=@var{dir}" +msgstr "--chroot-directory=@var{Verzeichnis}" + +#. type: table +#: doc/guix.texi:1325 +msgid "Add @var{dir} to the build chroot." +msgstr "Füge das @var{Verzeichnis} zum chroot von Erstellungen hinzu." + +#. type: table +#: doc/guix.texi:1331 +msgid "Doing this may change the result of build processes---for instance if they use optional dependencies found in @var{dir} when it is available, and not otherwise. For that reason, it is not recommended to do so. Instead, make sure that each derivation declares all the inputs that it needs." +msgstr "Dadurch kann sich das Ergebnis von Erstellungsprozessen ändern — zum Beispiel, wenn diese optionale Abhängigkeiten aus dem @var{Verzeichnis} verwenden, wenn sie verfügbar sind, und nicht, wenn es fehlt. Deshalb ist es nicht empfohlen, dass Sie diese Befehlszeilenoption besser verwenden, besser sollten Sie dafür sorgen, dass jede Ableitung alle von ihr benötigten Eingabgen deklariert." + +#. type: item +#: doc/guix.texi:1332 +#, no-wrap +msgid "--disable-chroot" +msgstr "--disable-chroot" + +#. type: table +#: doc/guix.texi:1334 +msgid "Disable chroot builds." +msgstr "Erstellungen ohne chroot durchführen." + +#. type: table +#: doc/guix.texi:1339 +msgid "Using this option is not recommended since, again, it would allow build processes to gain access to undeclared dependencies. It is necessary, though, when @command{guix-daemon} is running under an unprivileged user account." +msgstr "Diese Befehlszeilenoption zu benutzen, wird nicht empfohlen, denn auch dadurch bekämen Erstellungsprozesse Zugriff auf nicht deklarierte Abhängigkeiten. Sie ist allerdings unvermeidlich, wenn @command{guix-daemon} auf einem Benutzerkonto ohne ausreichende Berechtigungen ausgeführt wird." + +#. type: item +#: doc/guix.texi:1340 +#, no-wrap +msgid "--log-compression=@var{type}" +msgstr "--log-compression=@var{Typ}" + +#. type: table +#: doc/guix.texi:1343 +msgid "Compress build logs according to @var{type}, one of @code{gzip}, @code{bzip2}, or @code{none}." +msgstr "Erstellungsprotokolle werden entsprechend dem @var{Typ} komprimiert, der entweder @code{gzip}, @code{bzip2} oder @code{none} (für keine Kompression) sein muss." + +#. type: table +#: doc/guix.texi:1347 +msgid "Unless @code{--lose-logs} is used, all the build logs are kept in the @var{localstatedir}. To save space, the daemon automatically compresses them with bzip2 by default." +msgstr "Sofern nicht @code{--lose-logs} angegeben wurde, werden alle Erstellungsprotokolle in der @var{localstatedir} gespeichert. Um Platz zu sparen, komprimiert sie der Daemon standardmäßig automatisch mit bzip2." + +#. type: item +#: doc/guix.texi:1348 +#, no-wrap +msgid "--disable-deduplication" +msgstr "--disable-deduplication" + +#. type: cindex +#: doc/guix.texi:1349 doc/guix.texi:2713 +#, no-wrap +msgid "deduplication" +msgstr "Deduplizieren" + +#. type: table +#: doc/guix.texi:1351 +msgid "Disable automatic file ``deduplication'' in the store." +msgstr "Automatische Dateien-»Deduplizierung« im Store ausschalten." + +#. type: table +#: doc/guix.texi:1358 +msgid "By default, files added to the store are automatically ``deduplicated'': if a newly added file is identical to another one found in the store, the daemon makes the new file a hard link to the other file. This can noticeably reduce disk usage, at the expense of slightly increased input/output load at the end of a build process. This option disables this optimization." +msgstr "Standardmäßig werden zum Store hinzugefügte Objekte automatisch »dedupliziert«: Wenn eine neue Datei mit einer anderen im Store übereinstimmt, wird die neue Datei stattdessen als harte Verknüpfung auf die andere Datei angelegt. Dies reduziert den Speicherverbrauch auf der Platte merklich, jedoch steigt andererseits die Auslastung bei der Ein-/Ausgabe im Erstellungsprozess geringfügig. Durch diese Option wird keine solche Optimierung durchgeführt." + +#. type: item +#: doc/guix.texi:1359 +#, no-wrap +msgid "--gc-keep-outputs[=yes|no]" +msgstr "--gc-keep-outputs[=yes|no]" + +#. type: table +#: doc/guix.texi:1362 +msgid "Tell whether the garbage collector (GC) must keep outputs of live derivations." +msgstr "Gibt an, ob der Müllsammler (Garbage Collector, GC) die Ausgaben lebendiger Ableitungen behalten muss (»yes«) oder nicht (»no«)." + +#. type: cindex +#: doc/guix.texi:1363 doc/guix.texi:2548 +#, no-wrap +msgid "GC roots" +msgstr "GC-Wurzeln" + +#. type: cindex +#: doc/guix.texi:1364 doc/guix.texi:2549 +#, no-wrap +msgid "garbage collector roots" +msgstr "Müllsammlerwurzeln" + +#. type: table +#: doc/guix.texi:1369 +#, fuzzy +#| msgid "When set to ``yes'', the GC will keep the outputs of any live derivation available in the store---the @code{.drv} files. The default is ``no'', meaning that derivation outputs are kept only if they are reachable from a GC root. @xref{Invoking guix gc}, for more on GC roots." +msgid "When set to ``yes'', the GC will keep the outputs of any live derivation available in the store---the @code{.drv} files. The default is ``no'', meaning that derivation outputs are kept only if they are GC roots. @xref{Invoking guix gc}, for more on GC roots." +msgstr "Für »yes« behält der Müllsammler die Ausgaben aller lebendigen Ableitungen im Store — die @code{.drv}-Dateien. Der Vorgabewert ist aber »no«, so dass Ableitungsausgaben nur vorgehalten werden, wenn die von einer Müllsammlerwurzel aus erreichbar sind. Siehe den Abschnitt @xref{Invoking guix gc} für weitere Informationen zu Müllsammlerwurzeln." + +#. type: item +#: doc/guix.texi:1370 +#, no-wrap +msgid "--gc-keep-derivations[=yes|no]" +msgstr "--gc-keep-derivations[=yes|no]" + +#. type: table +#: doc/guix.texi:1373 +msgid "Tell whether the garbage collector (GC) must keep derivations corresponding to live outputs." +msgstr "Gibt an, ob der Müllsammler (GC) Ableitungen behalten muss (»yes«), wenn sie lebendige Ausgaben haben, oder nicht (»no«)." + +#. type: table +#: doc/guix.texi:1378 +msgid "When set to ``yes'', as is the case by default, the GC keeps derivations---i.e., @code{.drv} files---as long as at least one of their outputs is live. This allows users to keep track of the origins of items in their store. Setting it to ``no'' saves a bit of disk space." +msgstr "Für »yes«, den Vorgabewert, behält der Müllsammler Ableitungen — z.B. @code{.drv}-Dateien —, solange zumindest eine ihrer Ausgaben lebendig ist. Dadurch können Nutzer den Ursprung der Dateien in ihrem Store nachvollziehen. Setzt man den Wert auf »no«, wird ein bisschen weniger Speicher auf der Platte verbraucht." + +#. type: table +#: doc/guix.texi:1385 +#, fuzzy +#| msgid "In this way, setting @code{--gc-keep-derivations} to ``yes'' causes liveness to flow from outputs to derivations, and setting @code{--gc-keep-outputs} to ``yes'' causes liveness to flow from derivations to outputs. When both are set to ``yes'', the effect is to keep all the build prerequisites (the sources, compiler, libraries, and other build-time tools) of live objects in the store, regardless of whether these prerequisites are reachable from a GC root. This is convenient for developers since it saves rebuilds or downloads." +msgid "Note that when both @code{--gc-keep-derivations} and @code{--gc-keep-outputs} are used, the effect is to keep all the build prerequisites (the sources, compiler, libraries, and other build-time tools) of live objects in the store, regardless of whether these prerequisites are live. This is convenient for developers since it saves rebuilds or downloads." +msgstr "Auf diese Weise überträge sich, wenn @code{--gc-keep-derivations} auf »yes« steht, die Lebendigkeit von Ausgaben auf Ableitungen übertragen, und wenn @code{--gc-keep-outputs} auf »yes« steht, die Lebendigkeit von Ableitungen auf Ausgaben übertragen. Stehen beide auf »ues«, bleiben so alle Erstellungsvoraussetzungen wie Quelldateien, Compiler, Bibliotheken und andere Erstellungswerkzeuge lebendiger Objekte im Store erhalten, ob sie von einer Müllsammlerwurzel aus erreichbar sind oder nicht. Entwickler können sich so erneute Erstellungen oder erneutes Herunterladen sparen." + +#. type: item +#: doc/guix.texi:1386 +#, no-wrap +msgid "--impersonate-linux-2.6" +msgstr "--impersonate-linux-2.6" + +#. type: table +#: doc/guix.texi:1389 +msgid "On Linux-based systems, impersonate Linux 2.6. This means that the kernel's @code{uname} system call will report 2.6 as the release number." +msgstr "Auf Linux-basierten Systemen wird hiermit vorgetäuscht, dass es sich um Linux 2.6 handeln würde, indem der Kernel für einen @code{uname}-Systemaufruf als Version der Veröffentlichung mit 2.6 antwortet." + +#. type: table +#: doc/guix.texi:1392 +msgid "This might be helpful to build programs that (usually wrongfully) depend on the kernel version number." +msgstr "Dies kann hilfreich sein, um Programme zu erstellen, die (normalerweise zu Unrecht) von der Kernel-Versionsnummer abhängen." + +#. type: item +#: doc/guix.texi:1393 +#, no-wrap +msgid "--lose-logs" +msgstr "--lose-logs" + +#. type: table +#: doc/guix.texi:1396 +msgid "Do not keep build logs. By default they are kept under @code{@var{localstatedir}/guix/log}." +msgstr "Keine Protokolle der Erstellungen vorhalten. Normalerweise würden solche in @code{@var{localstatedir}/guix/log} gespeichert." + +#. type: item +#: doc/guix.texi:1397 doc/guix.texi:3009 doc/guix.texi:5954 doc/guix.texi:7134 +#: doc/guix.texi:7542 doc/guix.texi:8176 doc/guix.texi:20532 +#: doc/guix.texi:21076 +#, no-wrap +msgid "--system=@var{system}" +msgstr "--system=@var{System}" + +#. type: table +#: doc/guix.texi:1401 +msgid "Assume @var{system} as the current system type. By default it is the architecture/kernel pair found at configure time, such as @code{x86_64-linux}." +msgstr "Verwende @var{System} als aktuellen Systemtyp. Standardmäßig ist dies das Paar aus Befehlssatz und Kernel, welches beim Aufruf von @code{configure} erkannt wurde, wie zum Beispiel @code{x86_64-linux}." + +#. type: item +#: doc/guix.texi:1402 +#, no-wrap +msgid "--listen=@var{endpoint}" +msgstr "--listen=@var{Endpunkt}" + +#. type: table +#: doc/guix.texi:1407 +msgid "Listen for connections on @var{endpoint}. @var{endpoint} is interpreted as the file name of a Unix-domain socket if it starts with @code{/} (slash sign). Otherwise, @var{endpoint} is interpreted as a host name or host name and port to listen to. Here are a few examples:" +msgstr "Lausche am @var{Endpunkt} auf Verbindungen. Dabei wird der @var{Endpunkt} als Dateiname eines Unix-Sockets verstanden, wenn er mit einem @code{/} (Schrägstrich) beginnt. Andernfalls wird der @var{Endpunkt} als Hostname oder als Hostname-Port-Paar verstanden, auf dem gelauscht wird. Hier sind ein paar Beispiele:" + +#. type: item +#: doc/guix.texi:1409 +#, no-wrap +msgid "--listen=/gnu/var/daemon" +msgstr "--listen=/gnu/var/daemon" + +#. type: table +#: doc/guix.texi:1412 +msgid "Listen for connections on the @file{/gnu/var/daemon} Unix-domain socket, creating it if needed." +msgstr "Lausche auf Verbindungen am Unix-Socket @file{/gnu/var/daemon}, falls nötig wird er dazu erstellt." + +#. type: item +#: doc/guix.texi:1413 +#, no-wrap +msgid "--listen=localhost" +msgstr "--listen=localhost" + +#. type: cindex +#: doc/guix.texi:1414 doc/guix.texi:4373 +#, no-wrap +msgid "daemon, remote access" +msgstr "Daemon, Fernzugriff" + +#. type: cindex +#: doc/guix.texi:1415 doc/guix.texi:4374 +#, no-wrap +msgid "remote access to the daemon" +msgstr "Fernzugriff auf den Daemon" + +#. type: cindex +#: doc/guix.texi:1416 doc/guix.texi:4375 +#, no-wrap +msgid "daemon, cluster setup" +msgstr "Daemon, Einrichten auf Clustern" + +#. type: cindex +#: doc/guix.texi:1417 doc/guix.texi:4376 +#, no-wrap +msgid "clusters, daemon setup" +msgstr "Cluster, Einrichtung des Daemons" + +#. type: table +#: doc/guix.texi:1420 +msgid "Listen for TCP connections on the network interface corresponding to @code{localhost}, on port 44146." +msgstr "Lausche auf TCP-Verbindungen an der Netzwerkschnittstelle, die @code{localhost} entspricht, auf Port 44146." + +#. type: item +#: doc/guix.texi:1421 +#, no-wrap +msgid "--listen=128.0.0.42:1234" +msgstr "--listen=128.0.0.42:1234" + +#. type: table +#: doc/guix.texi:1424 +msgid "Listen for TCP connections on the network interface corresponding to @code{128.0.0.42}, on port 1234." +msgstr "Lausche auf TCP-Verbindungen an der Netzwerkschnittstelle, die @code{128.0.0.42} entspricht, auf Port 1234." + +#. type: table +#: doc/guix.texi:1431 +msgid "This option can be repeated multiple times, in which case @command{guix-daemon} accepts connections on all the specified endpoints. Users can tell client commands what endpoint to connect to by setting the @code{GUIX_DAEMON_SOCKET} environment variable (@pxref{The Store, @code{GUIX_DAEMON_SOCKET}})." +msgstr "Diese Befehlszeilenoption kann mehrmals wiederholt werden. In diesem Fall akzeptiert @command{guix-daemon} Verbindungen auf allen angegebenen Endpunkten. Benutzer können bei Client-Befehlen angeben, mit welchem Endpunkt sie sich verbinden möchten, indem sie die Umgebungsvariable @code{GUIX_DAEMON_SOCKET} festlegen (@pxref{The Store, @code{GUIX_DAEMON_SOCKET}})." + +#. type: quotation +#: doc/guix.texi:1432 doc/guix.texi:2330 doc/guix.texi:2844 doc/guix.texi:3071 +#: doc/guix.texi:4343 doc/guix.texi:4411 doc/guix.texi:5959 doc/guix.texi:5971 +#: doc/guix.texi:7434 doc/guix.texi:8061 doc/guix.texi:8279 doc/guix.texi:8490 +#: doc/guix.texi:11758 doc/guix.texi:20859 doc/guix.texi:21057 +#: doc/guix.texi:21144 doc/guix.texi:21988 +#, no-wrap +msgid "Note" +msgstr "Anmerkung" + +#. type: quotation +#: doc/guix.texi:1438 +msgid "The daemon protocol is @emph{unauthenticated and unencrypted}. Using @code{--listen=@var{host}} is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon. In other cases where remote access to the daemon is needed, we recommend using Unix-domain sockets along with SSH." +msgstr "Das Daemon-Protokoll ist @emph{weder authentifiziert noch verschlüsselt}. Die Benutzung von @code{--listen=@var{Host}} eignet sich für lokale Netzwerke, wie z.B. in Rechen-Clustern, wo sich nur solche Knoten mit dem Daemon verbinden, denen man vertraut. In Situationen, wo ein Fernzugriff auf den Daemon durchgeführt wird, empfehlen wir, über Unix-Sockets in Verbindung mit SSH zuzugreifen." + +#. type: table +#: doc/guix.texi:1443 +msgid "When @code{--listen} is omitted, @command{guix-daemon} listens for connections on the Unix-domain socket located at @file{@var{localstatedir}/guix/daemon-socket/socket}." +msgstr "Wird @code{--listen} nicht angegeben, lauscht @command{guix-daemon} auf Verbindungen auf dem Unix-Socket, der sich unter @file{@var{localstatedir}/guix/daemon-socket/socket} befindet." + +#. type: Plain text +#: doc/guix.texi:1453 +msgid "When using Guix on top of GNU/Linux distribution other than GuixSD---a so-called @dfn{foreign distro}---a few additional steps are needed to get everything in place. Here are some of them." +msgstr "Läuft Guix aufgesetzt auf einer GNU/Linux-Distribution außer GuixSD — einer sogenannten @dfn{Fremddistribution} —, so sind ein paar zusätzliche Schritte bei der Einrichtung nötig. Hier finden Sie manche davon." + +#. type: anchor{#1} +#: doc/guix.texi:1457 +msgid "locales-and-locpath" +msgstr "locales-and-locpath" + +#. type: cindex +#: doc/guix.texi:1457 +#, no-wrap +msgid "locales, when not on GuixSD" +msgstr "Locales, nicht auf GuixSD" + +#. type: vindex +#: doc/guix.texi:1458 doc/guix.texi:9777 +#, no-wrap +msgid "LOCPATH" +msgstr "LOCPATH" + +#. type: vindex +#: doc/guix.texi:1459 +#, no-wrap +msgid "GUIX_LOCPATH" +msgstr "GUIX_LOCPATH" + +#. type: Plain text +#: doc/guix.texi:1464 +msgid "Packages installed @i{via} Guix will not use the locale data of the host system. Instead, you must first install one of the locale packages available with Guix and then define the @code{GUIX_LOCPATH} environment variable:" +msgstr "Über Guix installierte Pakete benutzen nicht die Daten zu Regions- und Spracheinstellungen (Locales) des Wirtssystems. Stattdessen müssen Sie erst eines der Locale-Pakete installieren, die für Guix verfügbar sind, und dann den Wert Ihrer Umgebungsvariablen @code{GUIX_LOCPATH} passend festlegen:" + +#. type: example +#: doc/guix.texi:1468 +#, no-wrap +msgid "" +"$ guix package -i glibc-locales\n" +"$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n" +msgstr "" +"$ guix package -i glibc-locales\n" +"$ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale\n" + +#. type: Plain text +#: doc/guix.texi:1474 +msgid "Note that the @code{glibc-locales} package contains data for all the locales supported by the GNU@tie{}libc and weighs in at around 110@tie{}MiB. Alternatively, the @code{glibc-utf8-locales} is smaller but limited to a few UTF-8 locales." +msgstr "Beachten Sie, dass das Paket @code{glibc-locales} Daten für alle von GNU@tie{}libc unterstützten Locales enthält und deswegen um die 110@tie{}MiB wiegt. Alternativ gibt es auch @code{glibc-utf8-locales}, was kleiner, aber auf ein paar UTF-8-Locales beschränkt ist." + +#. type: Plain text +#: doc/guix.texi:1478 +msgid "The @code{GUIX_LOCPATH} variable plays a role similar to @code{LOCPATH} (@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C Library Reference Manual}). There are two important differences though:" +msgstr "Die Variable @code{GUIX_LOCPATH} spielt eine ähnliche Rolle wie @code{LOCPATH} (@pxref{Locale Names, @code{LOCPATH},, libc, The GNU C Library Reference Manual}). Es gibt jedoch zwei wichtige Unterschiede:" + +#. type: enumerate +#: doc/guix.texi:1485 +msgid "@code{GUIX_LOCPATH} is honored only by the libc in Guix, and not by the libc provided by foreign distros. Thus, using @code{GUIX_LOCPATH} allows you to make sure the programs of the foreign distro will not end up loading incompatible locale data." +msgstr "@code{GUIX_LOCPATH} wird nur von der libc in Guix beachtet und nicht der von Fremddistributionen bereitgestellten libc. Mit @code{GUIX_LOCPATH} können Sie daher sicherstellen, dass die Programme der Fremddistribution keine inkompatiblen Locale-Daten von Guix laden." + +#. type: enumerate +#: doc/guix.texi:1492 +msgid "libc suffixes each entry of @code{GUIX_LOCPATH} with @code{/X.Y}, where @code{X.Y} is the libc version---e.g., @code{2.22}. This means that, should your Guix profile contain a mixture of programs linked against different libc version, each libc version will only try to load locale data in the right format." +msgstr "libc hängt an jeden @code{GUIX_LOCPATH}-Eintrag @code{/X.Y} an, wobei @code{X.Y} die Version von libc ist — z.B. @code{2.22}. Sollte Ihr Guix-Profil eine Mischung aus Programmen enthalten, die an verschiedene libc-Versionen gebunden sind, wird jede nur die Locale-Daten im richtigen Format zu laden versuchen." + +#. type: Plain text +#: doc/guix.texi:1496 +msgid "This is important because the locale data format used by different libc versions may be incompatible." +msgstr "Das ist wichtig, weil das Locale-Datenformat verschiedener libc-Versionen inkompatibel sein könnte." + +#. type: cindex +#: doc/guix.texi:1499 +#, no-wrap +msgid "name service switch, glibc" +msgstr "Name Service Switch, glibc" + +#. type: cindex +#: doc/guix.texi:1500 +#, no-wrap +msgid "NSS (name service switch), glibc" +msgstr "NSS (Name Service Switch), glibc" + +#. type: cindex +#: doc/guix.texi:1501 +#, no-wrap +msgid "nscd (name service caching daemon)" +msgstr "nscd (Name Service Caching Daemon)" + +#. type: cindex +#: doc/guix.texi:1502 +#, no-wrap +msgid "name service caching daemon (nscd)" +msgstr "Name Service Caching Daemon (nscd)" + +#. type: Plain text +#: doc/guix.texi:1509 +msgid "When using Guix on a foreign distro, we @emph{strongly recommend} that the system run the GNU C library's @dfn{name service cache daemon}, @command{nscd}, which should be listening on the @file{/var/run/nscd/socket} socket. Failing to do that, applications installed with Guix may fail to look up host names or user accounts, or may even crash. The next paragraphs explain why." +msgstr "Wenn Sie Guix auf einer Fremddistribution verwenden, @emph{empfehlen wir stärkstens}, dass Sie den @dfn{Name Service Cache Daemon} der GNU-C-Bibliothek, @command{nscd}, laufen lassen, welcher auf dem Socket @file{/var/run/nscd/socket} lauschen sollte. Wenn Sie das nicht tun, könnten mit Guix installierte Anwendungen Probleme beim Auflösen von Hostnamen oder Benutzerkonten haben, oder sogar abstürzen. Die nächsten Absätze erklären, warum." + +#. type: file{#1} +#: doc/guix.texi:1510 +#, no-wrap +msgid "nsswitch.conf" +msgstr "nsswitch.conf" + +#. type: Plain text +#: doc/guix.texi:1515 +msgid "The GNU C library implements a @dfn{name service switch} (NSS), which is an extensible mechanism for ``name lookups'' in general: host name resolution, user accounts, and more (@pxref{Name Service Switch,,, libc, The GNU C Library Reference Manual})." +msgstr "Die GNU-C-Bibliothek implementiert einen @dfn{Name Service Switch} (NSS), welcher einen erweiterbaren Mechanismus zur allgemeinen »Namensauflösung« darstellt: Hostnamensauflösung, Benutzerkonten und weiteres (@pxref{Name Service Switch,,, libc, The GNU C Library Reference Manual})." + +#. type: cindex +#: doc/guix.texi:1516 +#, no-wrap +msgid "Network information service (NIS)" +msgstr "Network Information Service (NIS)" + +#. type: cindex +#: doc/guix.texi:1517 +#, no-wrap +msgid "NIS (Network information service)" +msgstr "NIS (Network Information Service)" + +#. type: Plain text +#: doc/guix.texi:1526 +msgid "Being extensible, the NSS supports @dfn{plugins}, which provide new name lookup implementations: for example, the @code{nss-mdns} plugin allow resolution of @code{.local} host names, the @code{nis} plugin allows user account lookup using the Network information service (NIS), and so on. These extra ``lookup services'' are configured system-wide in @file{/etc/nsswitch.conf}, and all the programs running on the system honor those settings (@pxref{NSS Configuration File,,, libc, The GNU C Reference Manual})." +msgstr "Für die Erweiterbarkeit unterstützt der NSS @dfn{Plugins}, welche neue Implementierungen zur Namensauflösung bieten: Zum Beispiel ermöglicht das Plugin @code{nss-mdns} die Namensauflösung für @code{.local}-Hostnamen, das Plugin @code{nis} gestattet die Auflösung von Benutzerkonten über den Network Information Service (NIS) und so weiter. Diese zusätzlichen »Auflösungsdienste« werden systemweit konfiguriert in @file{/etc/nsswitch.conf} und alle auf dem System laufenden Programme halten sich an diese Einstellungen (@pxref{NSS Configuration File,,, libc, The GNU C Reference Manual})." + +#. type: Plain text +#: doc/guix.texi:1536 +msgid "When they perform a name lookup---for instance by calling the @code{getaddrinfo} function in C---applications first try to connect to the nscd; on success, nscd performs name lookups on their behalf. If the nscd is not running, then they perform the name lookup by themselves, by loading the name lookup services into their own address space and running it. These name lookup services---the @file{libnss_*.so} files---are @code{dlopen}'d, but they may come from the host system's C library, rather than from the C library the application is linked against (the C library coming from Guix)." +msgstr "Wenn sie eine Namensauflösung durchführen — zum Beispiel, indem sie die @code{getaddrinfo}-Funktion in C aufrufen — versuchen die Anwendungen als Erstes, sich mit dem nscd zu verbinden; ist dies erfolgreich, führt nscd für sie die weiteren Namensauflösungen durch. Falls nscd nicht läuft, führen sie selbst die Namensauflösungen durch, indem sie die Namensauflösungsdienste in ihren eigenen Adressraum laden und ausführen. Diese Namensauflösungsdienste — die @file{libnss_*.so}-Dateien — werden mit @code{dlopen} geladen, aber sie kommen von der C-Bibliothek des Wirtssystems und nicht von der C-Bibliothek, mit der die Anwendung gebunden wurde (also der C-Bibliothek von Guix)." + +#. type: Plain text +#: doc/guix.texi:1541 +msgid "And this is where the problem is: if your application is linked against Guix's C library (say, glibc 2.24) and tries to load NSS plugins from another C library (say, @code{libnss_mdns.so} for glibc 2.22), it will likely crash or have its name lookups fail unexpectedly." +msgstr "Und hier kommt es zum Problem: Wenn die Anwendung mit der C-Bibliothek von Guix (etwa glibc 2.24) gebunden wurde und die NSS-Plugins von einer anderen C-Bibliothek (etwa @code{libnss_mdns.so} für glibc 2.22) zu laden versucht, wird sie vermutlich abstürzen oder die Namensauflösungen werden unerwartet fehlschlagen." + +#. type: Plain text +#: doc/guix.texi:1546 +msgid "Running @command{nscd} on the system, among other advantages, eliminates this binary incompatibility problem because those @code{libnss_*.so} files are loaded in the @command{nscd} process, not in applications themselves." +msgstr "Durch das Ausführen von @command{nscd} auf dem System wird, neben anderen Vorteilen, dieses Problem der binären Inkompatibilität vermieden, weil diese @code{libnss_*.so}-Dateien vom @command{nscd}-Prozess geladen werden, nicht in den Anwendungen selbst." + +#. type: subsection +#: doc/guix.texi:1547 +#, no-wrap +msgid "X11 Fonts" +msgstr "X11-Schriftarten" + +#. type: cindex +#: doc/guix.texi:1549 doc/guix.texi:22554 +#, no-wrap +msgid "fonts" +msgstr "Schriftarten" + +#. type: Plain text +#: doc/guix.texi:1557 +msgid "The majority of graphical applications use Fontconfig to locate and load fonts and perform X11-client-side rendering. The @code{fontconfig} package in Guix looks for fonts in @file{$HOME/.guix-profile} by default. Thus, to allow graphical applications installed with Guix to display fonts, you have to install fonts with Guix as well. Essential font packages include @code{gs-fonts}, @code{font-dejavu}, and @code{font-gnu-freefont-ttf}." +msgstr "Die Mehrheit der graphischen Anwendungen benutzen Fontconfig zum Finden und Laden von Schriftarten und für die Darstellung im X11-Client. Im Paket @code{fontconfig} in Guix werden Schriftarten standardmäßig in @file{$HOME/.guix-profile} gesucht. Um es graphischen Anwendungen, die mit Guix installiert wurden, zu ermöglichen, Schriftarten anzuzeigen, müssen Sie die Schriftarten auch mit Guix installieren. Essenzielle Pakete für Schriftarten sind unter Anderem @code{gs-fonts}, @code{font-dejavu} und @code{font-gnu-freefont-ttf}." + +#. type: Plain text +#: doc/guix.texi:1564 +msgid "To display text written in Chinese languages, Japanese, or Korean in graphical applications, consider installing @code{font-adobe-source-han-sans} or @code{font-wqy-zenhei}. The former has multiple outputs, one per language family (@pxref{Packages with Multiple Outputs}). For instance, the following command installs fonts for Chinese languages:" +msgstr "Um auf Chinesisch, Japanisch oder Koreanisch verfassten Text in graphischen Anwendungen anzeigen zu können, möchten Sie vielleicht @code{font-adobe-source-han-sans} oder @code{font-wqy-zenhei} installieren. Ersteres hat mehrere Ausgaben, für jede Sprachfamilie eine (@pxref{Packages with Multiple Outputs}). Zum Beispiel installiert folgender Befehl Schriftarten für chinesische Sprachen:" + +#. type: example +#: doc/guix.texi:1567 +#, no-wrap +msgid "guix package -i font-adobe-source-han-sans:cn\n" +msgstr "guix package -i font-adobe-source-han-sans:cn\n" + +#. type: code{#1} +#: doc/guix.texi:1569 +#, no-wrap +msgid "xterm" +msgstr "xterm" + +#. type: Plain text +#: doc/guix.texi:1573 +msgid "Older programs such as @command{xterm} do not use Fontconfig and instead rely on server-side font rendering. Such programs require to specify a full name of a font using XLFD (X Logical Font Description), like this:" +msgstr "Ältere Programme wie @command{xterm} benutzen kein Fontconfig, sondern X-Server-seitige Schriftartendarstellung. Solche Programme setzen voraus, dass der volle Name einer Schriftart mit XLFD (X Logical Font Description) angegeben wird, z.B. so:" + +#. type: example +#: doc/guix.texi:1576 +#, no-wrap +msgid "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n" +msgstr "-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1\n" + +#. type: Plain text +#: doc/guix.texi:1580 +msgid "To be able to use such full names for the TrueType fonts installed in your Guix profile, you need to extend the font path of the X server:" +msgstr "Um solche vollen Namen für die in Ihrem Guix-Profil installierten TrueType-Schriftarten zu verwenden, müssen Sie den Pfad für Schriftarten (Font Path) des X-Servers anpassen:" + +#. type: example +#: doc/guix.texi:1585 +#, no-wrap +msgid "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n" +msgstr "xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))\n" + +#. type: code{#1} +#: doc/guix.texi:1587 +#, no-wrap +msgid "xlsfonts" +msgstr "xlsfonts" + +#. type: Plain text +#: doc/guix.texi:1590 +msgid "After that, you can run @code{xlsfonts} (from @code{xlsfonts} package) to make sure your TrueType fonts are listed there." +msgstr "Danach können Sie den Befehl @code{xlsfonts} ausführen (aus dem Paket @code{xlsfonts}), um sicherzustellen, dass dort Ihre TrueType-Schriftarten aufgeführt sind." + +#. type: code{#1} +#: doc/guix.texi:1591 +#, no-wrap +msgid "fc-cache" +msgstr "fc-cache" + +#. type: cindex +#: doc/guix.texi:1592 +#, no-wrap +msgid "font cache" +msgstr "Font-Cache" + +#. type: Plain text +#: doc/guix.texi:1598 +msgid "After installing fonts you may have to refresh the font cache to use them in applications. The same applies when applications installed via Guix do not seem to find fonts. To force rebuilding of the font cache run @code{fc-cache -f}. The @code{fc-cache} command is provided by the @code{fontconfig} package." +msgstr "Nach der Installation der Schriftarten müssen Sie unter Umständen den Schriftarten-Zwischenspeicher (Font-Cache) erneuern, um diese in Anwendungen benutzen zu können. Gleiches gilt, wenn mit Guix installierte Anwendungen anscheinend keine Schriftarten finden können. Um das Erneuern des Font-Caches zu erzwingen, führen Sie @code{fc-cache -f} aus. Der Befehl @code{fc-cache} wird vom Paket @code{fontconfig} angeboten." + +#. type: code{#1} +#: doc/guix.texi:1601 doc/guix.texi:20271 +#, no-wrap +msgid "nss-certs" +msgstr "nss-certs" + +#. type: Plain text +#: doc/guix.texi:1604 +msgid "The @code{nss-certs} package provides X.509 certificates, which allow programs to authenticate Web servers accessed over HTTPS." +msgstr "Das Paket @code{nss-certs} bietet X.509-Zertifikate, womit Programme die Identität von Web-Servern authentifizieren können, auf die über HTTPS zugegriffen wird." + +#. type: Plain text +#: doc/guix.texi:1609 +msgid "When using Guix on a foreign distro, you can install this package and define the relevant environment variables so that packages know where to look for certificates. @xref{X.509 Certificates}, for detailed information." +msgstr "Wenn Sie Guix auf einer Fremddistribution verwenden, können Sie dieses Paket installieren und die relevanten Umgebungsvariablen festlegen, damit Pakete wissen, wo sie Zertifikate finden. In @xref{X.509 Certificates} stehen genaue Informationen." + +#. type: subsection +#: doc/guix.texi:1610 +#, no-wrap +msgid "Emacs Packages" +msgstr "Emacs-Pakete" + +#. type: code{#1} +#: doc/guix.texi:1612 +#, no-wrap +msgid "emacs" +msgstr "emacs" + +#. type: Plain text +#: doc/guix.texi:1623 +msgid "When you install Emacs packages with Guix, the elisp files may be placed either in @file{$HOME/.guix-profile/share/emacs/site-lisp/} or in sub-directories of @file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/}. The latter directory exists because potentially there may exist thousands of Emacs packages and storing all their files in a single directory may not be reliable (because of name conflicts). So we think using a separate directory for each package is a good idea. It is very similar to how the Emacs package system organizes the file structure (@pxref{Package Files,,, emacs, The GNU Emacs Manual})." +msgstr "Wenn Sie mit Guix Pakete für Emacs installieren, werden deren elisp-Dateien entweder in @file{$HOME/.guix-profile/share/emacs/site-lisp/} oder in Unterverzeichnissen von @file{$HOME/.guix-profile/share/emacs/site-lisp/guix.d/} gespeichert. Letzteres Verzeichnis gibt es, weil es Tausende von Emacs-Paketen gibt und sie alle im selben Verzeichnis zu speichern vielleicht nicht verlässlich funktioniert (wegen Namenskonflikten). Daher halten wir es für richtig, für jedes Paket ein anderes Verzeichnis zu benutzen. Das Emacs-Paketsystem organisiert die Dateistruktur ähnlich (@pxref{Package Files,,, emacs, The GNU Emacs Manual})." + +#. type: Plain text +#: doc/guix.texi:1629 +msgid "By default, Emacs (installed with Guix) ``knows'' where these packages are placed, so you do not need to perform any configuration. If, for some reason, you want to avoid auto-loading Emacs packages installed with Guix, you can do so by running Emacs with @code{--no-site-file} option (@pxref{Init File,,, emacs, The GNU Emacs Manual})." +msgstr "Standardmäßig »weiß« Emacs (wenn er mit Guix installiert wurde), wo diese Pakete liegen, sie müssen also nichts selbst konfigurieren. Wenn Sie aber aus irgendeinem Grund mit Guix installierte Pakete nicht automatisch laden lassen möchten, können Sie Emacs mit der Befehlszeilenoption @code{--no-site-file} starten (@pxref{Init File,,, emacs, The GNU Emacs Manual})." + +#. type: subsection +#: doc/guix.texi:1630 +#, no-wrap +msgid "The GCC toolchain" +msgstr "GCC-Toolchain" + +#. type: cindex +#: doc/guix.texi:1632 +#, no-wrap +msgid "GCC" +msgstr "GCC" + +#. type: cindex +#: doc/guix.texi:1633 +#, no-wrap +msgid "ld-wrapper" +msgstr "ld-wrapper" + +#. type: Plain text +#: doc/guix.texi:1642 +msgid "Guix offers individual compiler packages such as @code{gcc} but if you are in need of a complete toolchain for compiling and linking source code what you really want is the @code{gcc-toolchain} package. This package provides a complete GCC toolchain for C/C++ development, including GCC itself, the GNU C Library (headers and binaries, plus debugging symbols in the @code{debug} output), Binutils, and a linker wrapper." +msgstr "Guix bietet individuelle Compiler-Pakete wie etwa @code{gcc}, aber wenn Sie einen vollständigen Satz an Werkzeugen zum Kompilieren und Binden von Quellcode brauchen, werden Sie eigentlich das Paket @code{gcc-toolchain} haben wollen. Das Paket bietet eine vollständige GCC-Toolchain für die Entwicklung mit C/C++, einschließlich GCC selbst, der GNU-C-Bibliothek (Header-Dateien und Binärdateien samt Symbolen zur Fehlersuche/Debugging in der @code{debug}-Ausgabe), Binutils und einen Wrapper für den Binder/Linker." + +#. type: cindex +#: doc/guix.texi:1643 +#, no-wrap +msgid "attempt to use impure library, error message" +msgstr "Versuch, unreine Bibliothek zu benutzen, Fehlermeldung" + +#. type: Plain text +#: doc/guix.texi:1653 +msgid "The wrapper's purpose is to inspect the @code{-L} and @code{-l} switches passed to the linker, add corresponding @code{-rpath} arguments, and invoke the actual linker with this new set of arguments. By default, the linker wrapper refuses to link to libraries outside the store to ensure ``purity''. This can be annoying when using the toolchain to link with local libraries. To allow references to libraries outside the store you need to define the environment variable @code{GUIX_LD_WRAPPER_ALLOW_IMPURITIES}." +msgstr "Der Zweck des Wrappers ist, die an den Binder übergebenen Befehlszeilenoptionen mit @code{-L} und @code{-l} zu überprüfen und jeweils passende Argumente mit @code{-rpath} anzufügen, womit dann der echte Binder aufgerufen wird. Standardmäßig weigert sich der Binder-Wrapper, mit Bibliotheken außerhalb des Stores zu binden, um »Reinheit« zu gewährleisten. Das kann aber stören, wenn man die Toolchain benutzt, um mit lokalen Bibliotheken zu binden. Um Referenzen auf Bibliotheken außerhalb des Stores zu erlauben, müssen Sie die Umgebungsvariable @code{GUIX_LD_WRAPPER_ALLOW_IMPURITIES} setzen." + +#. type: cindex +#: doc/guix.texi:1660 +#, no-wrap +msgid "packages" +msgstr "Pakete" + +#. type: Plain text +#: doc/guix.texi:1665 +msgid "The purpose of GNU Guix is to allow users to easily install, upgrade, and remove software packages, without having to know about their build procedures or dependencies. Guix also goes beyond this obvious set of features." +msgstr "Der Zweck von GNU Guix ist, Benutzern die leichte Installation, Aktualisierung und Entfernung von Software-Paketen zu ermöglichen, ohne dass sie ihre Erstellungsprozeduren oder Abhängigkeiten kennen müssen. Guix kann natürlich noch mehr als diese offensichtlichen Funktionalitäten." + +#. type: Plain text +#: doc/guix.texi:1673 +msgid "This chapter describes the main features of Guix, as well as the package management tools it provides. Along with the command-line interface described below (@pxref{Invoking guix package, @code{guix package}}), you may also use the Emacs-Guix interface (@pxref{Top,,, emacs-guix, The Emacs-Guix Reference Manual}), after installing @code{emacs-guix} package (run @kbd{M-x guix-help} command to start with it):" +msgstr "Dieses Kapitel beschreibt die Hauptfunktionalitäten von Guix, sowie die von Guix angebotenen Paketverwaltungswerkzeuge. Zusätzlich von den im Folgenden beschriebenen Befehlszeilen-Benutzerschnittstellen (@pxref{Invoking guix package, @code{guix package}}) können Sie auch mit der Emacs-Guix-Schnittstelle (@pxref{Top,,, emacs-guix, The Emacs-Guix Reference Manual}) arbeiten, nachdem Sie das Paket @code{emacs-guix} installiert haben (führen Sie zum Einstieg in Emacs-Guix den Emacs-Befehl @kbd{M-x guix-help} aus):" + +#. type: example +#: doc/guix.texi:1676 +#, no-wrap +msgid "guix package -i emacs-guix\n" +msgstr "guix package -i emacs-guix\n" + +#. type: Plain text +#: doc/guix.texi:1695 +msgid "When using Guix, each package ends up in the @dfn{package store}, in its own directory---something that resembles @file{/gnu/store/xxx-package-1.2}, where @code{xxx} is a base32 string." +msgstr "Wenn Sie Guix benutzen, landet jedes Paket schließlich im @dfn{Paket-Store} in seinem eigenen Verzeichnis — der Name ist ähnlich wie @file{/gnu/store/xxx-package-1.2}, wobei @code{xxx} eine Zeichenkette in Base32-Darstellung ist." + +#. type: Plain text +#: doc/guix.texi:1700 +msgid "Instead of referring to these directories, users have their own @dfn{profile}, which points to the packages that they actually want to use. These profiles are stored within each user's home directory, at @code{$HOME/.guix-profile}." +msgstr "Statt diese Verzeichnisse direkt anzugeben, haben Nutzer ihr eigenes @dfn{Profil}, welches auf diejenigen Pakete zeigt, die sie tatsächlich benutzen wollen. Diese Profile sind im Persönlichen Ordner des jeweiligen Nutzers gespeichert als @code{$HOME/.guix-profile}." + +#. type: Plain text +#: doc/guix.texi:1708 +msgid "For example, @code{alice} installs GCC 4.7.2. As a result, @file{/home/alice/.guix-profile/bin/gcc} points to @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Now, on the same machine, @code{bob} had already installed GCC 4.8.0. The profile of @code{bob} simply continues to point to @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc}---i.e., both versions of GCC coexist on the same system without any interference." +msgstr "Zum Beispiel installiert @code{alice} GCC 4.7.2. Dadurch zeigt dann @file{/home/alice/.guix-profile/bin/gcc} auf @file{/gnu/store/@dots{}-gcc-4.7.2/bin/gcc}. Auf demselben Rechner hat @code{bob} bbereits GCC 4.8.0 installiert. Das Profil von @code{bob} zeigt dann einfach weiterhin auf @file{/gnu/store/@dots{}-gcc-4.8.0/bin/gcc} — d.h. beide Versionen von GCC koexistieren auf demselben System, ohne sich zu stören." + +#. type: Plain text +#: doc/guix.texi:1712 +msgid "The @command{guix package} command is the central tool to manage packages (@pxref{Invoking guix package}). It operates on the per-user profiles, and can be used @emph{with normal user privileges}." +msgstr "Der Befehl @command{guix package} ist das zentrale Werkzeug, um Pakete zu verwalten (@pxref{Invoking guix package}). Es arbeitet auf dem eigenen Profil jedes Nutzers und kann @emph{mit normalen Benutzerrechten} ausgeführt werden." + +#. type: cindex +#: doc/guix.texi:1713 doc/guix.texi:1782 +#, no-wrap +msgid "transactions" +msgstr "Transaktionen" + +#. type: Plain text +#: doc/guix.texi:1720 +msgid "The command provides the obvious install, remove, and upgrade operations. Each invocation is actually a @emph{transaction}: either the specified operation succeeds, or nothing happens. Thus, if the @command{guix package} process is terminated during the transaction, or if a power outage occurs during the transaction, then the user's profile remains in its previous state, and remains usable." +msgstr "Der Befehl stellt die offensichtlichen Installations-, Entfernungs- und Aktualisierungsoperationen zur Verfügung. Jeder Aufruf ist tatsächlich eine eigene @emph{Transaktion}: Entweder die angegebene Operation wird erfolgreich durchgeführt, oder gar nichts passiert. Wenn also der Prozess von @command{guix package} während der Transaktion beendet wird, oder es zum Stromausfall während der Transaktion kommt, dann bleibt der alte, nutzbare Zustands des Nutzerprofils erhalten." + +#. type: Plain text +#: doc/guix.texi:1728 +msgid "In addition, any package transaction may be @emph{rolled back}. So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well. Similarly, the global system configuration on GuixSD is subject to transactional upgrades and roll-back (@pxref{Using the Configuration System})." +msgstr "Zudem kann jede Pakettransaktion @emph{zurückgesetzt} werden (Rollback). Wenn also zum Beispiel durch eine Aktualisierung eine neue Version eines Pakets installiert, die einen schwerwiegenden Fehler zur Folge hat, können Nutzer ihr Profil einfach auf die vorherige Profilinstanz zurücksetzen, von der sie wissen, dass sie gut lief. Ebenso unterliegt auf GuixSD auch die globale Systemkonfiguration transaktionellen Aktualisierungen und Rücksetzungen (@pxref{Using the Configuration System})." + +#. type: Plain text +#: doc/guix.texi:1735 +msgid "All packages in the package store may be @emph{garbage-collected}. Guix can determine which packages are still referenced by user profiles, and remove those that are provably no longer referenced (@pxref{Invoking guix gc}). Users may also explicitly remove old generations of their profile so that the packages they refer to can be collected." +msgstr "Alle Pakete im Paket-Store können vom @emph{Müllsammler} (Garbage Collector) gelöscht werden. Guix ist in der Lage, festzustellen, welche Pakete noch durch Benutzerprofile referenziert werden, und entfernt nur diese, die nachweislich nicht mehr referenziert werden (@pxref{Invoking guix gc}). Benutzer können auch ausdrücklich alte Generationen ihres Profils löschen, damit die zugehörigen Pakete vom Müllsammler gelöscht werden können." + +#. type: cindex +#: doc/guix.texi:1736 +#, no-wrap +msgid "reproducibility" +msgstr "Reproduzierbarkeit" + +#. type: Plain text +#: doc/guix.texi:1748 +#, fuzzy +#| msgid "Guix takes a @dfn{purely functional} approach to package management, as described in the introduction (@pxref{Introduction}). Each @file{/gnu/store} package directory name contains a hash of all the inputs that were used to build that package---compiler, libraries, build scripts, etc. This direct correspondence allows users to make sure a given package installation matches the current state of their distribution. It also helps maximize @dfn{build reproducibility}: thanks to the isolated build environments that are used, a given build is likely to yield bit-identical files when performed on different machines (@pxref{Invoking guix-daemon, container})." +msgid "Finally, Guix takes a @dfn{purely functional} approach to package management, as described in the introduction (@pxref{Introduction}). Each @file{/gnu/store} package directory name contains a hash of all the inputs that were used to build that package---compiler, libraries, build scripts, etc. This direct correspondence allows users to make sure a given package installation matches the current state of their distribution. It also helps maximize @dfn{build reproducibility}: thanks to the isolated build environments that are used, a given build is likely to yield bit-identical files when performed on different machines (@pxref{Invoking guix-daemon, container})." +msgstr "Guix verfolgt einen @dfn{rein funktionalen} Ansatz bei der Paketverwaltung, wie er in der Einleitung beschrieben wurde (@pxref{Introduction}). Jedes Paketverzeichnis im @file{/gnu/store} hat einen Hash all seiner bei der Erstellung benutzten Eingaben im Namen — Compiler, Bibliotheken, Erstellungs-Skripts etc. Diese direkte Entsprechung ermöglicht es Benutzern, eine Paketinstallation zu benutzen, die sicher dem aktuellen Stand ihrer Distribution entspricht. Sie maximiert auch die @dfn{Reproduzierbarkeit der Erstellungen} zu maximieren: Dank der isolierten Erstellungsumgebungen, die benutzt werden, resultiert eine Erstellung wahrscheinlich in bitweise identischen Dateien, auch wenn sie auf unterschiedlichen Maschinen durchgeführt wird (@pxref{Invoking guix-daemon, container})." + +#. type: Plain text +#: doc/guix.texi:1759 +msgid "This foundation allows Guix to support @dfn{transparent binary/source deployment}. When a pre-built binary for a @file{/gnu/store} item is available from an external source---a @dfn{substitute}, Guix just downloads it and unpacks it; otherwise, it builds the package from source, locally (@pxref{Substitutes}). Because build results are usually bit-for-bit reproducible, users do not have to trust servers that provide substitutes: they can force a local build and @emph{challenge} providers (@pxref{Invoking guix challenge})." +msgstr "Auf dieser Grundlage kann Guix @dfn{transparent Binär- oder Quelldateien ausliefern}. Wenn eine vorerstellte Binärdatei für ein @file{/gnu/store}-Objekt von einer externen Quelle verfügbar ist — ein @dfn{Substitut} —, lädt Guix sie einfach herunter und entpackt sie, andernfalls erstellt Guix das Paket lokal aus seinem Quellcode (@pxref{Substitutes}). Weil Erstellungsergebnisse normalerweise Bit für Bit reproduzierbar sind, müssen die Nutzer den Servern, die Substitute anbieten, nicht blind vertrauen; sie können eine lokale Erstellung erzwingen und Substitute @emph{anfechten} (@pxref{Invoking guix challenge})." + +#. type: Plain text +#: doc/guix.texi:1765 +msgid "Control over the build environment is a feature that is also useful for developers. The @command{guix environment} command allows developers of a package to quickly set up the right development environment for their package, without having to manually install the dependencies of the package into their profile (@pxref{Invoking guix environment})." +msgstr "Kontrolle über die Erstellungsumgebung ist eine auch für Entwickler nützliche Funktionalität. Der Befehl @command{guix environment} ermöglicht es Entwicklern eines Pakets, schnell die richtige Entwicklungsumgebung für ihr Paket einzurichten, ohne manuell die Abhängigkeiten des Pakets in ihr Profil installieren zu müssen (@pxref{Invoking guix environment})." + +#. type: section +#: doc/guix.texi:1767 +#, no-wrap +msgid "Invoking @command{guix package}" +msgstr "Invoking @command{guix package}" + +#. type: cindex +#: doc/guix.texi:1769 +#, no-wrap +msgid "installing packages" +msgstr "Installieren von Paketen" + +#. type: cindex +#: doc/guix.texi:1770 +#, no-wrap +msgid "removing packages" +msgstr "Entfernen von Paketen" + +#. type: cindex +#: doc/guix.texi:1771 +#, no-wrap +msgid "package installation" +msgstr "Paketinstallation" + +#. type: cindex +#: doc/guix.texi:1772 +#, no-wrap +msgid "package removal" +msgstr "Paketentfernung" + +#. type: Plain text +#: doc/guix.texi:1778 +msgid "The @command{guix package} command is the tool that allows users to install, upgrade, and remove packages, as well as rolling back to previous configurations. It operates only on the user's own profile, and works with normal user privileges (@pxref{Features}). Its syntax is:" +msgstr "Der Befehl @command{guix package} ist ein Werkzeug, womit Nutzer Pakete installieren, aktualisieren, entfernen und auf vorherige Konfigurationen zurücksetzen können. Dabei wird nur das eigene Profil des Nutzers verwendet, und es funktioniert mit normalen Benutzerrechten, ohne Administratorrechte (@pxref{Funktionalitäten}). Die Syntax ist:" + +#. type: example +#: doc/guix.texi:1781 +#, no-wrap +msgid "guix package @var{options}\n" +msgstr "guix package @var{Optionen}\n" + +#. type: Plain text +#: doc/guix.texi:1787 +msgid "Primarily, @var{options} specifies the operations to be performed during the transaction. Upon completion, a new profile is created, but previous @dfn{generations} of the profile remain available, should the user want to roll back." +msgstr "In erster Linie geben die @var{Optionen} an, welche Operationen in der Transaktion durchgeführt werden sollen. Nach Abschluss wird ein neues Profil erzeugt, aber vorherige @dfn{Generationen} des Profils bleiben verfügbar, falls der Benutzer auf sie zurückwechseln will." + +#. type: Plain text +#: doc/guix.texi:1790 +msgid "For example, to remove @code{lua} and install @code{guile} and @code{guile-cairo} in a single transaction:" +msgstr "Um zum Beispiel @code{lua} zu entfernen und @code{guile} und @code{guile-cairo} in einer einzigen Transaktion zu installieren:" + +#. type: example +#: doc/guix.texi:1793 +#, no-wrap +msgid "guix package -r lua -i guile guile-cairo\n" +msgstr "guix package -r lua -i guile guile-cairo\n" + +#. type: Plain text +#: doc/guix.texi:1799 +msgid "@command{guix package} also supports a @dfn{declarative approach} whereby the user specifies the exact set of packages to be available and passes it @i{via} the @option{--manifest} option (@pxref{profile-manifest, @option{--manifest}})." +msgstr "@command{guix package} unterstützt auch ein @dfn{deklaratives Vorgehen}, wobei der Nutzer die genaue Menge an Paketen, die verfügbar sein sollen, festlegt und über die Befehlszeilenoption @option{--manifest} übergibt (@pxref{profile-manifest, @option{--manifest}})." + +#. type: cindex +#: doc/guix.texi:1800 +#, no-wrap +msgid "profile" +msgstr "Profil" + +#. type: Plain text +#: doc/guix.texi:1806 +msgid "For each user, a symlink to the user's default profile is automatically created in @file{$HOME/.guix-profile}. This symlink always points to the current generation of the user's default profile. Thus, users can add @file{$HOME/.guix-profile/bin} to their @code{PATH} environment variable, and so on." +msgstr "Für jeden Benutzer wird automatisch eine symbolische Verknüpfung zu seinem Standardprofil angelegt als @file{$HOME/.guix-profile}. Diese symbolische Verknüpfung zeigt immer auf die aktuelle Generation des Standardprofils des Benutzers. Somit können Nutzer @file{$HOME/.guix-profile/bin} z.B. zu ihrer Umgebungsvariablen @code{PATH} hinzufügen." + +#. type: cindex +#: doc/guix.texi:1806 doc/guix.texi:2003 +#, no-wrap +msgid "search paths" +msgstr "Suchpfade" + +#. type: Plain text +#: doc/guix.texi:1811 +msgid "If you are not using the Guix System Distribution, consider adding the following lines to your @file{~/.bash_profile} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}) so that newly-spawned shells get all the right environment variable definitions:" +msgstr "Wenn Sie nicht die Guix System Distribution benutzen, sollten Sie in Betracht ziehen, folgende Zeilen zu Ihrem @file{~/.bash_profile} hinzuzufügen (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}), damit in neu erzeugten Shells alle Umgebungsvariablen richtig definiert werden:" + +#. type: example +#: doc/guix.texi:1815 +#, no-wrap +msgid "" +"GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n" +"source \"$HOME/.guix-profile/etc/profile\"\n" +msgstr "" +"GUIX_PROFILE=\"$HOME/.guix-profile\" ; \\\n" +"source \"$HOME/.guix-profile/etc/profile\"\n" + +#. type: Plain text +#: doc/guix.texi:1826 +msgid "In a multi-user setup, user profiles are stored in a place registered as a @dfn{garbage-collector root}, which @file{$HOME/.guix-profile} points to (@pxref{Invoking guix gc}). That directory is normally @code{@var{localstatedir}/guix/profiles/per-user/@var{user}}, where @var{localstatedir} is the value passed to @code{configure} as @code{--localstatedir}, and @var{user} is the user name. The @file{per-user} directory is created when @command{guix-daemon} is started, and the @var{user} sub-directory is created by @command{guix package}." +msgstr "Ist Ihr System für mehrere Nutzer eingerichtet, werden Nutzerprofile an einem Ort gespeichert, der als @dfn{Müllsammlerwurzel} registriert ist, auf die @file{$HOME/.guix-profile} zeigt (@pxref{Invoking guix gc}). Dieses Verzeichnis ist normalerweise @code{@var{localstatedir}/guix/profiles/per-user/@var{Benutzer}}, wobei @var{localstatedir} der an @code{configure} als @code{--localstatedir} übergebene Wert ist und @var{Benutzer} für den jeweiligen Benutzernamen steht. Das @file{per-user}-Verzeichnis wird erstellt, wenn @command{guix-daemon} gestartet wird, und das Unterverzeichnis @var{Benutzer} wird durch @command{guix package} erstellt." + +#. type: Plain text +#: doc/guix.texi:1828 +msgid "The @var{options} can be among the following:" +msgstr "Als @var{Optionen} kann vorkommen:" + +#. type: item +#: doc/guix.texi:1831 +#, no-wrap +msgid "--install=@var{package} @dots{}" +msgstr "--install=@var{Paket} @dots{}" + +#. type: itemx +#: doc/guix.texi:1832 +#, no-wrap +msgid "-i @var{package} @dots{}" +msgstr "-i @var{Paket} @dots{}" + +#. type: table +#: doc/guix.texi:1834 +msgid "Install the specified @var{package}s." +msgstr "Die angegebenen @var{Paket}e installieren." + +#. type: table +#: doc/guix.texi:1839 +msgid "Each @var{package} may specify either a simple package name, such as @code{guile}, or a package name followed by an at-sign and version number, such as @code{guile@@1.8.8} or simply @code{guile@@1.8} (in the latter case, the newest version prefixed by @code{1.8} is selected.)" +msgstr "Jedes @var{Paket} kann entweder einfach durch seinen Paketnamen aufgeführt werden, wie @code{guile}, oder als Paketname gefolgt von einem At-Zeichen @@ und einer Versionsnummer, wie @code{guile@@1.8.8} oder auch nur @code{guile@@1.8} (in letzterem Fall wird die neueste Version mit Präfix @code{1.8} ausgewählt.)" + +#. type: table +#: doc/guix.texi:1847 +msgid "If no version number is specified, the newest available version will be selected. In addition, @var{package} may contain a colon, followed by the name of one of the outputs of the package, as in @code{gcc:doc} or @code{binutils@@2.22:lib} (@pxref{Packages with Multiple Outputs}). Packages with a corresponding name (and optionally version) are searched for among the GNU distribution modules (@pxref{Package Modules})." +msgstr "Wird keine Versionsnummer angegeben, wird die neueste verfügbare Version ausgewählt. Zudem kann im @var{Paket} ein Doppelpunkt auftauchen, gefolgt vom Namen einer der Ausgaben des Pakets, wie @code{gcc:doc} oder @code{binutils@@2.22:lib} (@pxref{Packages with Multiple Outputs}). Pakete mit zugehörigem Namen (und optional der Version) werden unter den Modulen der GNU-Distribution gesucht (@pxref{Package Modules})." + +#. type: cindex +#: doc/guix.texi:1848 +#, no-wrap +msgid "propagated inputs" +msgstr "propagierte Eingaben" + +#. type: table +#: doc/guix.texi:1854 +msgid "Sometimes packages have @dfn{propagated inputs}: these are dependencies that automatically get installed along with the required package (@pxref{package-propagated-inputs, @code{propagated-inputs} in @code{package} objects}, for information about propagated inputs in package definitions)." +msgstr "Manchmal haben Pakete @dfn{propagierte Eingaben}: Als solche werden Abhängigkeiten bezeichnet, die automatisch zusammen mit dem angeforderten Paket installiert werden (im Abschnitt @pxref{package-propagated-inputs, @code{propagated-inputs} in @code{package} objects} sind weitere Informationen über propagierte Eingaben in Paketdefinitionen zu finden)." + +#. type: anchor{#1} +#: doc/guix.texi:1861 +msgid "package-cmd-propagated-inputs" +msgstr "package-cmd-propagated-inputs" + +#. type: table +#: doc/guix.texi:1861 +msgid "An example is the GNU MPC library: its C header files refer to those of the GNU MPFR library, which in turn refer to those of the GMP library. Thus, when installing MPC, the MPFR and GMP libraries also get installed in the profile; removing MPC also removes MPFR and GMP---unless they had also been explicitly installed by the user." +msgstr "Ein Beispiel ist die GNU-MPC-Bibliothek: Ihre C-Headerdateien verweisen auf die der GNU-MPFR-Bibliothek, welche wiederum auf die der GMP-Bibliothek verweisen. Wenn also MPC installiert wird, werden auch die MPFR- und GMP-Bibliotheken in das Profil installiert; entfernt man MPC, werden auch MPFR und GMP entfernt — außer sie wurden noch auf andere Art ausdrücklich vom Nutzer installiert." + +#. type: table +#: doc/guix.texi:1866 +msgid "Besides, packages sometimes rely on the definition of environment variables for their search paths (see explanation of @code{--search-paths} below). Any missing or possibly incorrect environment variable definitions are reported here." +msgstr "Abgesehen davon setzen Pakete manchmal die Definition von Umgebungsvariablen für ihre Suchpfade voraus (siehe die Erklärung von @code{--search-paths} weiter unten). Alle fehlenden oder womöglich falschen Definitionen von Umgebungsvariablen werden hierbei gemeldet." + +#. type: item +#: doc/guix.texi:1867 +#, no-wrap +msgid "--install-from-expression=@var{exp}" +msgstr "--install-from-expression=@var{Ausdruck}" + +#. type: itemx +#: doc/guix.texi:1868 +#, no-wrap +msgid "-e @var{exp}" +msgstr "-e @var{Ausdruck}" + +#. type: table +#: doc/guix.texi:1870 +msgid "Install the package @var{exp} evaluates to." +msgstr "Das Paket installieren, zu dem der @var{Ausdruck} ausgewertet wird." + +#. type: table +#: doc/guix.texi:1875 +msgid "@var{exp} must be a Scheme expression that evaluates to a @code{<package>} object. This option is notably useful to disambiguate between same-named variants of a package, with expressions such as @code{(@@ (gnu packages base) guile-final)}." +msgstr "Beim @var{Ausdruck} muss es sich um einen Scheme-Ausdruck handeln, der zu einem @code{<package>}-Objekt ausgewertet wird. Diese Option ist besonders nützlich, um zwischen gleichnamigen Varianten eines Pakets zu unterscheiden, durch Ausdrücke wie @code{(@@ (gnu packages base) guile-final)}." + +#. type: table +#: doc/guix.texi:1879 +msgid "Note that this option installs the first output of the specified package, which may be insufficient when needing a specific output of a multiple-output package." +msgstr "Beachten Sie, dass mit dieser Option die erste Ausgabe des angegebenen Pakets installiert wird, was unzureichend sein kann, wenn eine bestimmte Ausgabe eines Pakets mit mehreren Ausgaben gewünscht ist." + +#. type: item +#: doc/guix.texi:1880 +#, no-wrap +msgid "--install-from-file=@var{file}" +msgstr "--install-from-file=@var{Datei}" + +#. type: itemx +#: doc/guix.texi:1881 doc/guix.texi:5870 +#, no-wrap +msgid "-f @var{file}" +msgstr "-f @var{Datei}" + +#. type: table +#: doc/guix.texi:1883 +msgid "Install the package that the code within @var{file} evaluates to." +msgstr "Das Paket installieren, zu dem der Code in der @var{Datei} ausgewertet wird." + +#. type: table +#: doc/guix.texi:1886 doc/guix.texi:7493 +msgid "As an example, @var{file} might contain a definition like this (@pxref{Defining Packages}):" +msgstr "Zum Beispiel könnte die @var{Datei} eine Definition wie diese enthalten (@pxref{Defining Packages}):" + +#. type: example +#: doc/guix.texi:1889 doc/guix.texi:5880 +#, no-wrap +msgid "@verbatiminclude package-hello.scm\n" +msgstr "@verbatiminclude package-hello.scm\n" + +#. type: table +#: doc/guix.texi:1895 +msgid "Developers may find it useful to include such a @file{guix.scm} file in the root of their project source tree that can be used to test development snapshots and create reproducible development environments (@pxref{Invoking guix environment})." +msgstr "Entwickler könnten es für nützlich erachten, eine solche @file{guix.scm}-Datei im Quellbaum ihres Projekts abzulegen, mit der Zwischenstände der Entwicklung getestet und reproduzierbare Erstellungsumgebungen aufgebaut werden können (@pxref{Invoking guix environment})." + +#. type: item +#: doc/guix.texi:1896 +#, no-wrap +msgid "--remove=@var{package} @dots{}" +msgstr "--remove=@var{Paket} @dots{}" + +#. type: itemx +#: doc/guix.texi:1897 +#, no-wrap +msgid "-r @var{package} @dots{}" +msgstr "-r @var{Paket} @dots{}" + +#. type: table +#: doc/guix.texi:1899 +msgid "Remove the specified @var{package}s." +msgstr "Die angegebenen @var{Paket}e entfernen." + +#. type: table +#: doc/guix.texi:1904 +msgid "As for @code{--install}, each @var{package} may specify a version number and/or output name in addition to the package name. For instance, @code{-r glibc:debug} would remove the @code{debug} output of @code{glibc}." +msgstr "Wie auch bei @code{--install} kann jedes @var{Paket} neben dem Paketnamen auch eine Versionsnummer und/oder eine Ausgabe benennen. Zum Beispiel würde @code{-r glibc:debug} die @code{debug}-Ausgabe von @code{glibc} aus dem Profil entfernen." + +#. type: item +#: doc/guix.texi:1905 +#, no-wrap +msgid "--upgrade[=@var{regexp} @dots{}]" +msgstr "--upgrade[=@var{Regexp} @dots{}]" + +#. type: itemx +#: doc/guix.texi:1906 +#, no-wrap +msgid "-u [@var{regexp} @dots{}]" +msgstr "-u [@var{Regexp} @dots{}]" + +#. type: cindex +#: doc/guix.texi:1907 +#, no-wrap +msgid "upgrading packages" +msgstr "Pakete aktualisieren" + +#. type: table +#: doc/guix.texi:1911 +msgid "Upgrade all the installed packages. If one or more @var{regexp}s are specified, upgrade only installed packages whose name matches a @var{regexp}. Also see the @code{--do-not-upgrade} option below." +msgstr "Alle installierten Pakete aktualisieren. Wenn einer oder mehr reguläre Ausdrücke (Regexps) angegeben wurden, werden nur diejenigen installierten Pakete aktualisiert, deren Name zu einer der @var{Regexp}s passt. Siehe auch weiter unten die Befehlszeilenoption @code{--do-not-upgrade}." + +#. type: table +#: doc/guix.texi:1916 +msgid "Note that this upgrades package to the latest version of packages found in the distribution currently installed. To update your distribution, you should regularly run @command{guix pull} (@pxref{Invoking guix pull})." +msgstr "Beachten Sie, dass das Paket so auf die neueste Version unter den Paketen gebracht wird, die in der aktuell installierten Distribution vorliegen. Um jedoch Ihre Distribution zu aktualisieren, sollten Sie regelmäßig @command{guix pull} ausführen (@pxref{Invoking guix pull})." + +#. type: item +#: doc/guix.texi:1917 +#, no-wrap +msgid "--do-not-upgrade[=@var{regexp} @dots{}]" +msgstr "--do-not-upgrade[=@var{Regexp} @dots{}]" + +#. type: table +#: doc/guix.texi:1922 +msgid "When used together with the @code{--upgrade} option, do @emph{not} upgrade any packages whose name matches a @var{regexp}. For example, to upgrade all packages in the current profile except those containing the substring ``emacs'':" +msgstr "In Verbindung mit der Befehlszeilenoption @code{--upgrade}, führe @emph{keine} Aktualisierung von Paketen durch, deren Name zum regulären Ausdruck @var{Regexp} passt. Um zum Beispiel alle Pakete im aktuellen Profil zu aktualisieren mit Ausnahme derer, die »emacs« im Namen haben:" + +#. type: example +#: doc/guix.texi:1925 +#, no-wrap +msgid "$ guix package --upgrade . --do-not-upgrade emacs\n" +msgstr "$ guix package --upgrade . --do-not-upgrade emacs\n" + +#. type: anchor{#1} +#: doc/guix.texi:1927 +#, no-wrap +msgid "profile-manifest" +msgstr "profile-manifest" + +#. type: item +#: doc/guix.texi:1927 doc/guix.texi:2996 doc/guix.texi:6761 doc/guix.texi:7498 +#: doc/guix.texi:8182 +#, no-wrap +msgid "--manifest=@var{file}" +msgstr "--manifest=@var{Datei}" + +#. type: itemx +#: doc/guix.texi:1928 doc/guix.texi:2997 doc/guix.texi:6762 doc/guix.texi:7499 +#, no-wrap +msgid "-m @var{file}" +msgstr "-m @var{Datei}" + +#. type: cindex +#: doc/guix.texi:1929 +#, no-wrap +msgid "profile declaration" +msgstr "Profildeklaration" + +#. type: cindex +#: doc/guix.texi:1930 +#, no-wrap +msgid "profile manifest" +msgstr "Profilmanifest" + +#. type: table +#: doc/guix.texi:1933 +msgid "Create a new generation of the profile from the manifest object returned by the Scheme code in @var{file}." +msgstr "Erstellt eine neue Generation des Profils aus dem vom Scheme-Code in @var{Datei} gelieferten Manifest-Objekt." + +#. type: table +#: doc/guix.texi:1939 +msgid "This allows you to @emph{declare} the profile's contents rather than constructing it through a sequence of @code{--install} and similar commands. The advantage is that @var{file} can be put under version control, copied to different machines to reproduce the same profile, and so on." +msgstr "Dadurch könnrn Sie den Inhalt des Profils @emph{deklarieren}, statt ihn durch eine Folge von Befehlen wie @code{--install} u.Ä. zu generieren. Der Vorteil ist, dass die @var{Datei} unter Versionskontrolle gestellt werden kann, auf andere Maschinen zum Reproduzieren desselben Profils kopiert werden kann und Ähnliches." + +#. type: table +#: doc/guix.texi:1943 +msgid "@var{file} must return a @dfn{manifest} object, which is roughly a list of packages:" +msgstr "Der Code in der @var{Datei} muss ein @dfn{Manifest}-Objekt liefern, was ungefähr einer Liste von Paketen entspricht:" + +#. type: findex +#: doc/guix.texi:1944 +#, no-wrap +msgid "packages->manifest" +msgstr "packages->manifest" + +#. type: example +#: doc/guix.texi:1947 +#, no-wrap +msgid "" +"(use-package-modules guile emacs)\n" +"\n" +msgstr "" +"(use-package-modules guile emacs)\n" +"\n" + +#. type: example +#: doc/guix.texi:1953 +#, no-wrap +msgid "" +"(packages->manifest\n" +" (list emacs\n" +" guile-2.0\n" +" ;; Use a specific package output.\n" +" (list guile-2.0 \"debug\")))\n" +msgstr "" +"(packages->manifest\n" +" (list emacs\n" +" guile-2.0\n" +" ;; Eine bestimmte Paketausgabe nutzen.\n" +" (list guile-2.0 \"debug\")))\n" + +#. type: findex +#: doc/guix.texi:1955 +#, no-wrap +msgid "specifications->manifest" +msgstr "specifications->manifest" + +#. type: table +#: doc/guix.texi:1962 +msgid "In this example we have to know which modules define the @code{emacs} and @code{guile-2.0} variables to provide the right @code{use-package-modules} line, which can be cumbersome. We can instead provide regular package specifications and let @code{specifications->manifest} look up the corresponding package objects, like this:" +msgstr "In diesem Beispiel müssen wir wissen, welche Module die Variablen @code{emacs} und @code{guile-2.0} definieren, um die richtige Angabe mit @code{use-package-modules} machen zu können, was umständlich sein kann. Wir können auch normale Paketnamen angeben und sie durch @code{specifications->manifest} zu den entsprechenden Paketobjekten auflösen, zum Beispiel so:" + +#. type: example +#: doc/guix.texi:1966 +#, no-wrap +msgid "" +"(specifications->manifest\n" +" '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n" +msgstr "" +"(specifications->manifest\n" +" '(\"emacs\" \"guile@@2.2\" \"guile@@2.2:debug\"))\n" + +#. type: item +#: doc/guix.texi:1968 +#, no-wrap +msgid "--roll-back" +msgstr "--roll-back" + +#. type: cindex +#: doc/guix.texi:1969 doc/guix.texi:20911 +#, no-wrap +msgid "rolling back" +msgstr "rücksetzen" + +#. type: cindex +#: doc/guix.texi:1970 +#, no-wrap +msgid "undoing transactions" +msgstr "Zurücksetzen von Transaktionen" + +#. type: cindex +#: doc/guix.texi:1971 +#, no-wrap +msgid "transactions, undoing" +msgstr "Transaktionen, zurücksetzen" + +#. type: table +#: doc/guix.texi:1974 +msgid "Roll back to the previous @dfn{generation} of the profile---i.e., undo the last transaction." +msgstr "Wechselt zur vorherigen @dfn{Generation} des Profils zurück — d.h. mache die letzte Transaktion rückgängig." + +#. type: table +#: doc/guix.texi:1977 +msgid "When combined with options such as @code{--install}, roll back occurs before any other actions." +msgstr "In Verbindung mit Befehlszeilenoptionen wie @code{--install} wird zuerst zurückgesetzt, bevor andere Aktionen durchgeführt werden." + +#. type: table +#: doc/guix.texi:1981 +msgid "When rolling back from the first generation that actually contains installed packages, the profile is made to point to the @dfn{zeroth generation}, which contains no files apart from its own metadata." +msgstr "Ein Rücksetzen der ersten Generation, die installierte Pakete enthält, wechselt das Profil zur @dfn{nullten Generation}, die keinerlei Dateien enthält, abgesehen von Metadaten über sich selbst." + +#. type: table +#: doc/guix.texi:1985 +msgid "After having rolled back, installing, removing, or upgrading packages overwrites previous future generations. Thus, the history of the generations in a profile is always linear." +msgstr "Nach dem Zurücksetzen überschreibt das Installieren, Entfernen oder Aktualisieren von Paketen vormals zukünftige Generationen, d.h. der Verlauf der Generationen eines Profils ist immer linear." + +#. type: item +#: doc/guix.texi:1986 +#, no-wrap +msgid "--switch-generation=@var{pattern}" +msgstr "--switch-generation=@var{Muster}" + +#. type: itemx +#: doc/guix.texi:1987 +#, no-wrap +msgid "-S @var{pattern}" +msgstr "-S @var{Muster}" + +#. type: cindex +#: doc/guix.texi:1988 doc/guix.texi:2186 doc/guix.texi:20869 +#, no-wrap +msgid "generations" +msgstr "Generationen" + +#. type: table +#: doc/guix.texi:1990 +msgid "Switch to a particular generation defined by @var{pattern}." +msgstr "Wechselt zu der bestimmten Generation, die durch das @var{Muster} bezeichnet wird." + +#. type: table +#: doc/guix.texi:1996 +msgid "@var{pattern} may be either a generation number or a number prefixed with ``+'' or ``-''. The latter means: move forward/backward by a specified number of generations. For example, if you want to return to the latest generation after @code{--roll-back}, use @code{--switch-generation=+1}." +msgstr "Als @var{Muster} kann entweder die Nummer einer Generation oder eine Nummer mit vorangestelltem »+« oder »-« dienen. Letzteres springt die angegebene Anzahl an Generationen vor oder zurück. Zum Beispiel kehrt @code{--switch-generation=+1} nach einem Zurücksetzen wieder zur neueren Generation zurück." + +#. type: table +#: doc/guix.texi:2001 +msgid "The difference between @code{--roll-back} and @code{--switch-generation=-1} is that @code{--switch-generation} will not make a zeroth generation, so if a specified generation does not exist, the current generation will not be changed." +msgstr "Der Unterschied zwischen @code{--roll-back} und @code{--switch-generation=-1} ist, dass @code{--switch-generation} keine nullte Generation erzeugen wird; existiert die angegebene Generation nicht, bleibt schlicht die aktuelle Generation erhalten." + +#. type: item +#: doc/guix.texi:2002 +#, no-wrap +msgid "--search-paths[=@var{kind}]" +msgstr "--search-paths[=@var{Art}]" + +#. type: table +#: doc/guix.texi:2008 +msgid "Report environment variable definitions, in Bash syntax, that may be needed in order to use the set of installed packages. These environment variables are used to specify @dfn{search paths} for files used by some of the installed packages." +msgstr "Führe die Definitionen von Umgebungsvariablen auf, in Bash-Syntax, die nötig sein könnten, um alle installierten Pakete nutzen zu können. Diese Umgebungsvariablen werden benutzt, um die @dfn{Suchpfade} für Dateien festzulegen, die von einigen installierten Paketen benutzt werden." + +#. type: table +#: doc/guix.texi:2016 +msgid "For example, GCC needs the @code{CPATH} and @code{LIBRARY_PATH} environment variables to be defined so it can look for headers and libraries in the user's profile (@pxref{Environment Variables,,, gcc, Using the GNU Compiler Collection (GCC)}). If GCC and, say, the C library are installed in the profile, then @code{--search-paths} will suggest setting these variables to @code{@var{profile}/include} and @code{@var{profile}/lib}, respectively." +msgstr "Zum Beispiel braucht GCC die Umgebungsvariablen @code{CPATH} und @code{LIBRARY_PATH}, um zu wissen, wo sich im Benutzerprofil Header und Bibliotheken befinden (@pxref{Environment Variables,,, gcc, Using the GNU Compiler Collection (GCC)}). Wenn GCC und, sagen wir, die C-Bibliothek im Profil installiert sind, schlägt @code{--search-paths} also vor, diese Variablen jeweils auf @code{@var{profile}/include} und @code{@var{profile}/lib} verweisen zu lassen." + +#. type: table +#: doc/guix.texi:2019 +msgid "The typical use case is to define these environment variables in the shell:" +msgstr "Die typische Nutzung ist, in der Shell diese Variablen zu definieren:" + +#. type: example +#: doc/guix.texi:2022 +#, no-wrap +msgid "$ eval `guix package --search-paths`\n" +msgstr "$ eval `guix package --search-paths`\n" + +#. type: table +#: doc/guix.texi:2028 +msgid "@var{kind} may be one of @code{exact}, @code{prefix}, or @code{suffix}, meaning that the returned environment variable definitions will either be exact settings, or prefixes or suffixes of the current value of these variables. When omitted, @var{kind} defaults to @code{exact}." +msgstr "Als @var{Art} kann entweder @code{exact}, @code{prefix} oder @code{suffix} gewählt werden, wodurch die gelieferten Definitionen der Umgebungsvariablen entweder exakt die Einstellungen für Guix meldet, oder sie als Präfix oder Suffix an den aktuellen Wert dieser Variablen anhängt. Gibt man keine @var{Art} an, wird der Vorgabewert @code{exact} verwendet." + +#. type: table +#: doc/guix.texi:2031 +msgid "This option can also be used to compute the @emph{combined} search paths of several profiles. Consider this example:" +msgstr "Diese Befehlszeilenoption kann auch benutzt werden, um die @emph{kombinierten} Suchpfade mehrerer Profile zu berechnen. Betrachten Sie dieses Beispiel:" + +#. type: example +#: doc/guix.texi:2036 +#, no-wrap +msgid "" +"$ guix package -p foo -i guile\n" +"$ guix package -p bar -i guile-json\n" +"$ guix package -p foo -p bar --search-paths\n" +msgstr "" +"$ guix package -p foo -i guile\n" +"$ guix package -p bar -i guile-json\n" +"$ guix package -p foo -p bar --search-paths\n" + +#. type: table +#: doc/guix.texi:2041 +msgid "The last command above reports about the @code{GUILE_LOAD_PATH} variable, even though, taken individually, neither @file{foo} nor @file{bar} would lead to that recommendation." +msgstr "Der letzte Befehl oben meldet auch die Definition der Umgebungsvariablen @code{GUILE_LOAD_PATH}, obwohl für sich genommen weder @file{foo} noch @file{bar} zu dieser Empfehlung führen würden." + +#. type: item +#: doc/guix.texi:2043 +#, no-wrap +msgid "--profile=@var{profile}" +msgstr "--profile=@var{Profil}" + +#. type: itemx +#: doc/guix.texi:2044 +#, no-wrap +msgid "-p @var{profile}" +msgstr "-p @var{Profil}" + +#. type: table +#: doc/guix.texi:2046 +msgid "Use @var{profile} instead of the user's default profile." +msgstr "Auf @var{Profil} anstelle des Standardprofils des Benutzers arbeiten." + +#. type: cindex +#: doc/guix.texi:2047 +#, no-wrap +msgid "collisions, in a profile" +msgstr "Kollisionen, in einem Profil" + +#. type: cindex +#: doc/guix.texi:2048 +#, no-wrap +msgid "colliding packages in profiles" +msgstr "Paketkollisionen in Profilen" + +#. type: cindex +#: doc/guix.texi:2049 +#, no-wrap +msgid "profile collisions" +msgstr "Profilkollisionen" + +#. type: item +#: doc/guix.texi:2050 +#, no-wrap +msgid "--allow-collisions" +msgstr "--allow-collisions" + +#. type: table +#: doc/guix.texi:2052 +msgid "Allow colliding packages in the new profile. Use at your own risk!" +msgstr "Kollidierende Pakete im neuen Profil zulassen. Benutzung auf eigene Gefahr!" + +#. type: table +#: doc/guix.texi:2056 +msgid "By default, @command{guix package} reports as an error @dfn{collisions} in the profile. Collisions happen when two or more different versions or variants of a given package end up in the profile." +msgstr "Standardmäßig wird @command{guix package} @dfn{Kollisionen} als Fehler auffassen und melden. Zu Kollisionen kommt es, wenn zwei oder mehr verschiedene Versionen oder Varianten desselben Pakets im Profil landen." + +#. type: item +#: doc/guix.texi:2057 doc/guix.texi:2802 doc/guix.texi:7987 +#, no-wrap +msgid "--verbose" +msgstr "--verbose" + +#. type: table +#: doc/guix.texi:2060 +msgid "Produce verbose output. In particular, emit the build log of the environment on the standard error port." +msgstr "Erzeugt ausführliche Textausgaben. Insbesondere wird auch das Erstellungsprotokoll der Umgebung auf dem Standard-Fehler-Port (stderr) ausgegeben." + +#. type: item +#: doc/guix.texi:2061 doc/guix.texi:2828 doc/guix.texi:3050 +#, no-wrap +msgid "--bootstrap" +msgstr "--bootstrap" + +#. type: table +#: doc/guix.texi:2064 +msgid "Use the bootstrap Guile to build the profile. This option is only useful to distribution developers." +msgstr "Erstellt das Profil mit dem Bootstrap-Guile. Diese Option ist nur für Entwickler der Distribution nützlich." + +#. type: Plain text +#: doc/guix.texi:2070 +msgid "In addition to these actions, @command{guix package} supports the following options to query the current state of a profile, or the availability of packages:" +msgstr "Zusätzlich zu diesen Aktionen unterstützt @command{guix package} folgende Befehlszeilenoptionen, um den momentanen Zustand eines Profils oder die Verfügbarkeit von Paketen nachzulesen:" + +#. type: item +#: doc/guix.texi:2073 +#, no-wrap +msgid "--search=@var{regexp}" +msgstr "--search=@var{Regexp}" + +#. type: itemx +#: doc/guix.texi:2074 +#, no-wrap +msgid "-s @var{regexp}" +msgstr "-s @var{Regexp}" + +#. type: cindex +#: doc/guix.texi:2075 +#, no-wrap +msgid "searching for packages" +msgstr "Suche nach Paketen" + +#. type: table +#: doc/guix.texi:2080 +msgid "List the available packages whose name, synopsis, or description matches @var{regexp}, sorted by relevance. Print all the metadata of matching packages in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})." +msgstr "Führt alle verfügbaren Pakete aus, deren Name, Zusammenfassung oder Beschreibung zum regulären Ausdruck @var{Regexp} passt, sortiert nach ihrer Relevanz. Alle Metadaten passender Pakete werden im @code{recutils}-Format geliefert (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})." + +#. type: table +#: doc/guix.texi:2083 +msgid "This allows specific fields to be extracted using the @command{recsel} command, for instance:" +msgstr "So können bestimmte Felder mit dem Befehl @command{recsel} extrahiert werden, zum Beispiel:" + +#. type: example +#: doc/guix.texi:2089 +#, no-wrap +msgid "" +"$ guix package -s malloc | recsel -p name,version,relevance\n" +"name: jemalloc\n" +"version: 4.5.0\n" +"relevance: 6\n" +"\n" +msgstr "" +"$ guix package -s malloc | recsel -p name,version,relevance\n" +"name: jemalloc\n" +"version: 4.5.0\n" +"relevance: 6\n" +"\n" + +#. type: example +#: doc/guix.texi:2093 +#, no-wrap +msgid "" +"name: glibc\n" +"version: 2.25\n" +"relevance: 1\n" +"\n" +msgstr "" +"name: glibc\n" +"version: 2.25\n" +"relevance: 1\n" +"\n" + +#. type: example +#: doc/guix.texi:2097 +#, no-wrap +msgid "" +"name: libgc\n" +"version: 7.6.0\n" +"relevance: 1\n" +msgstr "" +"name: libgc\n" +"version: 7.6.0\n" +"relevance: 1\n" + +#. type: table +#: doc/guix.texi:2101 +msgid "Similarly, to show the name of all the packages available under the terms of the GNU@tie{}LGPL version 3:" +msgstr "Ebenso kann der Name aller zu den Bedingungen der GNU@tie{}LGPL, Version 3, verfügbaren Pakete ermittelt werden:" + +#. type: example +#: doc/guix.texi:2105 +#, no-wrap +msgid "" +"$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n" +"name: elfutils\n" +"\n" +msgstr "" +"$ guix package -s \"\" | recsel -p name -e 'license ~ \"LGPL 3\"'\n" +"name: elfutils\n" +"\n" + +#. type: example +#: doc/guix.texi:2108 +#, no-wrap +msgid "" +"name: gmp\n" +"@dots{}\n" +msgstr "" +"name: gmp\n" +"@dots{}\n" + +#. type: table +#: doc/guix.texi:2113 +msgid "It is also possible to refine search results using several @code{-s} flags. For example, the following command returns a list of board games:" +msgstr "Es ist auch möglich, Suchergebnisse näher einzuschränken, indem Sie @code{-s} mehrmals übergeben. Zum Beispiel liefert folgender Befehl eines Liste von Brettspielen:" + +#. type: example +#: doc/guix.texi:2118 +#, no-wrap +msgid "" +"$ guix package -s '\\<board\\>' -s game | recsel -p name\n" +"name: gnubg\n" +"@dots{}\n" +msgstr "" +"$ guix package -s '\\<board\\>' -s game | recsel -p name\n" +"name: gnubg\n" +"@dots{}\n" + +#. type: table +#: doc/guix.texi:2124 +msgid "If we were to omit @code{-s game}, we would also get software packages that deal with printed circuit boards; removing the angle brackets around @code{board} would further add packages that have to do with keyboards." +msgstr "Würden wir @code{-s game} weglassen, bekämen wir auch Software-Pakete aufgelistet, die mit »printed circuit boards« (elektronischen Leiterplatten) zu tun haben; ohne die spitzen Klammern um @code{board} bekämen wir auch Pakete, die mit »keyboards« (Tastaturen, oder musikalischen Keyboard) zu tun haben." + +#. type: table +#: doc/guix.texi:2128 +msgid "And now for a more elaborate example. The following command searches for cryptographic libraries, filters out Haskell, Perl, Python, and Ruby libraries, and prints the name and synopsis of the matching packages:" +msgstr "Es ist Zeit für ein komplexeres Beispiel. Folgender Befehl sucht kryptographische Bibliotheken, filtert Haskell-, Perl-, Python- und Ruby-Bibliotheken heraus und gibt Namen und Zusammenfassung passender Pakete aus:" + +#. type: example +#: doc/guix.texi:2132 +#, no-wrap +msgid "" +"$ guix package -s crypto -s library | \\\n" +" recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n" +msgstr "" +"$ guix package -s crypto -s library | \\\n" +" recsel -e '! (name ~ \"^(ghc|perl|python|ruby)\")' -p name,synopsis\n" + +#. type: table +#: doc/guix.texi:2137 +msgid "@xref{Selection Expressions,,, recutils, GNU recutils manual}, for more information on @dfn{selection expressions} for @code{recsel -e}." +msgstr "@xref{Selection Expressions,,, recutils, GNU recutils manual} enthält weitere Informationen über @dfn{Auswahlausdrücke} mit @code{recsel -e}." + +#. type: item +#: doc/guix.texi:2138 +#, no-wrap +msgid "--show=@var{package}" +msgstr "--show=@var{Paket}" + +#. type: table +#: doc/guix.texi:2142 +msgid "Show details about @var{package}, taken from the list of available packages, in @code{recutils} format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})." +msgstr "Zeigt Details über das @var{Paket} aus der Liste verfügbarer Pakete, im @code{recutils}-Format (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})." + +#. type: example +#: doc/guix.texi:2147 +#, no-wrap +msgid "" +"$ guix package --show=python | recsel -p name,version\n" +"name: python\n" +"version: 2.7.6\n" +"\n" +msgstr "" +"$ guix package --show=python | recsel -p name,version\n" +"name: python\n" +"version: 2.7.6\n" +"\n" + +#. type: example +#: doc/guix.texi:2150 +#, no-wrap +msgid "" +"name: python\n" +"version: 3.3.5\n" +msgstr "" +"name: python\n" +"version: 3.3.5\n" + +#. type: table +#: doc/guix.texi:2154 +msgid "You may also specify the full name of a package to only get details about a specific version of it:" +msgstr "Sie können auch den vollständigen Namen eines Pakets angeben, um Details nur über diese Version angezeigt zu bekommen:" + +#. type: example +#: doc/guix.texi:2158 +#, no-wrap +msgid "" +"$ guix package --show=python@@3.4 | recsel -p name,version\n" +"name: python\n" +"version: 3.4.3\n" +msgstr "" +"$ guix package --show=python@@3.4 | recsel -p name,version\n" +"name: python\n" +"version: 3.4.3\n" + +#. type: item +#: doc/guix.texi:2162 +#, no-wrap +msgid "--list-installed[=@var{regexp}]" +msgstr "--list-installed[=@var{Regexp}]" + +#. type: itemx +#: doc/guix.texi:2163 +#, no-wrap +msgid "-I [@var{regexp}]" +msgstr "-I [@var{Regexp}]" + +#. type: table +#: doc/guix.texi:2167 +msgid "List the currently installed packages in the specified profile, with the most recently installed packages shown last. When @var{regexp} is specified, list only installed packages whose name matches @var{regexp}." +msgstr "Listet die derzeit installierten Pakete im angegebenen Profil auf, die zuletzt installierten Pakete zuletzt. Wenn ein regulärer Ausdruck @var{Regexp} angegeben wird, werden nur installierte Pakete aufgeführt, deren Name zu @var{Regexp} passt." + +#. type: table +#: doc/guix.texi:2173 +msgid "For each installed package, print the following items, separated by tabs: the package name, its version string, the part of the package that is installed (for instance, @code{out} for the default output, @code{include} for its headers, etc.), and the path of this package in the store." +msgstr "Zu jedem installierten Paket werden folgende Informationen angezeigt, durch Tabulatorzeichen getrennt: der Paketname, die Version als Zeichenkette, welche Teile des Pakets installiert sind (zum Beispiel @code{out}, wenn die Standard-Paketausgabe installiert ist, @code{include}, wenn seine Header installiert sind, usw.) und an welchem Pfad das Paket im Store zu finden ist." + +#. type: item +#: doc/guix.texi:2174 +#, no-wrap +msgid "--list-available[=@var{regexp}]" +msgstr "--list-available[=@var{Regexp}]" + +#. type: itemx +#: doc/guix.texi:2175 +#, no-wrap +msgid "-A [@var{regexp}]" +msgstr "-A [@var{Regexp}]" + +#. type: table +#: doc/guix.texi:2179 +msgid "List packages currently available in the distribution for this system (@pxref{GNU Distribution}). When @var{regexp} is specified, list only installed packages whose name matches @var{regexp}." +msgstr "Listet Pakete auf, die in der aktuell installierten Distribution dieses Systems verfügbar sind (@pxref{GNU Distribution}). Wenn ein regulärer Ausdruck @var{Regexp} angegeben wird, werden nur Pakete aufgeführt, deren Name zum regulären Ausdruck @var{Regexp} passt." + +#. type: table +#: doc/guix.texi:2183 +msgid "For each package, print the following items separated by tabs: its name, its version string, the parts of the package (@pxref{Packages with Multiple Outputs}), and the source location of its definition." +msgstr "Zu jedem Paket werden folgende Informationen getrennt durch Tabulatorzeichen ausgegeben: der Name, die Version als Zeichenkette, die Teile des Programms (@pxref{Packages with Multiple Outputs}) und die Stelle im Quellcode, an der das Paket definiert ist." + +#. type: item +#: doc/guix.texi:2184 doc/guix.texi:2821 +#, no-wrap +msgid "--list-generations[=@var{pattern}]" +msgstr "--list-generations[=@var{Muster}]" + +#. type: itemx +#: doc/guix.texi:2185 doc/guix.texi:2822 +#, no-wrap +msgid "-l [@var{pattern}]" +msgstr "-l [@var{Muster}]" + +#. type: table +#: doc/guix.texi:2191 +msgid "Return a list of generations along with their creation dates; for each generation, show the installed packages, with the most recently installed packages shown last. Note that the zeroth generation is never shown." +msgstr "Liefert eine Liste der Generationen zusammen mit dem Datum, an dem sie erzeugt wurden; zu jeder Generation werden zudem die installierten Pakete angezeigt, zuletzt installierte Pakete zuletzt. Beachten Sie, dass die nullte Generation niemals angezeigt wird." + +#. type: table +#: doc/guix.texi:2196 +msgid "For each installed package, print the following items, separated by tabs: the name of a package, its version string, the part of the package that is installed (@pxref{Packages with Multiple Outputs}), and the location of this package in the store." +msgstr "Zu jedem installierten Paket werden folgende Informationen durch Tabulatorzeichen getrennt angezeigt: der Name des Pakets, die Version als Zeichenkette, welcher Teil des Pakets installiert ist (@pxref{Packages with Multiple Outputs}) und an welcher Stelle sich das Paket im Store befindet." + +#. type: table +#: doc/guix.texi:2199 +msgid "When @var{pattern} is used, the command returns only matching generations. Valid patterns include:" +msgstr "Wenn ein @var{Muster} angegeben wird, liefert der Befehl nur dazu passende Generationen. Gültige Muster sind zum Beispiel:" + +#. type: item +#: doc/guix.texi:2201 +#, no-wrap +msgid "@emph{Integers and comma-separated integers}. Both patterns denote" +msgstr "@emph{Ganze Zahlen und kommagetrennte ganze Zahlen}. Beide Muster bezeichnen" + +#. type: itemize +#: doc/guix.texi:2204 +msgid "generation numbers. For instance, @code{--list-generations=1} returns the first one." +msgstr "Generationsnummern. Zum Beispiel liefert @code{--list-generations=1} die erste Generation." + +#. type: itemize +#: doc/guix.texi:2207 +msgid "And @code{--list-generations=1,8,2} outputs three generations in the specified order. Neither spaces nor trailing commas are allowed." +msgstr "Durch @code{--list-generations=1,8,2} werden drei Generationen in der angegebenen Reihenfolge angezeigt. Weder Leerzeichen noch ein Komma am Schluss der Liste ist erlaubt." + +#. type: item +#: doc/guix.texi:2208 +#, no-wrap +msgid "@emph{Ranges}. @code{--list-generations=2..9} prints the" +msgstr "@emph{Bereiche}. @code{--list-generations=2..9} gibt die" + +#. type: itemize +#: doc/guix.texi:2211 +msgid "specified generations and everything in between. Note that the start of a range must be smaller than its end." +msgstr "angegebenen Generationen und alles dazwischen aus. Beachten Sie, dass der Bereichsanfang eine kleinere Zahl als das Bereichsende sein muss." + +#. type: itemize +#: doc/guix.texi:2215 +msgid "It is also possible to omit the endpoint. For example, @code{--list-generations=2..}, returns all generations starting from the second one." +msgstr "Sie können auch kein Bereichsende angeben, zum Beispiel liefert @code{--list-generations=2..} alle Generationen ab der zweiten." + +#. type: item +#: doc/guix.texi:2216 +#, no-wrap +msgid "@emph{Durations}. You can also get the last @emph{N}@tie{}days, weeks," +msgstr "@emph{Zeitdauern}. Sie können auch die letzten @emph{N}@tie{}Tage, Wochen" + +#. type: itemize +#: doc/guix.texi:2220 +#, fuzzy +msgid "or months by passing an integer along with the first letter of the duration. For example, @code{--list-generations=20d} lists generations that are up to 20 days old." +msgstr "" +"oder Monate angeben, indem Sie eine ganze Zahl gefolgt von jeweils »d«, »w« oder »m« angeben (dem ersten Buchstaben der Maßeinheit der Dauer im Englischen). Zum Beispiel listet @code{--list-generations=20d} die Generationen auf, die höchstens 20 Tage alt sind.\n" +"\n" +"TODO LEIDER WIRD NICHT DER ZEITUNTERSCHIED BIS ZUR AUSFÜHRUNG VON --LIST-GENERATIONS BENUTZT... DIE ZEITANGABEN VON --LIST-GENERATIONS SIND VIELLEICHT AUCH IN UTC!" + +#. type: item +#: doc/guix.texi:2222 +#, no-wrap +msgid "--delete-generations[=@var{pattern}]" +msgstr "--delete-generations[=@var{Muster}]" + +#. type: itemx +#: doc/guix.texi:2223 +#, no-wrap +msgid "-d [@var{pattern}]" +msgstr "-d [@var{Muster}]" + +#. type: table +#: doc/guix.texi:2226 +msgid "When @var{pattern} is omitted, delete all generations except the current one." +msgstr "Wird kein @var{Muster} angegeben, werden alle Generationen außer der aktuellen entfernt." + +#. type: table +#: doc/guix.texi:2232 +msgid "This command accepts the same patterns as @option{--list-generations}. When @var{pattern} is specified, delete the matching generations. When @var{pattern} specifies a duration, generations @emph{older} than the specified duration match. For instance, @code{--delete-generations=1m} deletes generations that are more than one month old." +msgstr "Dieser Befehl akzeptiert dieselben Muster wie @option{--list-generations}. Wenn ein @var{Muster} angegeben wird, werden die passenden Generationen gelöscht. Wenn das @var{Muster} für eine Zeitdauer steht, werden diejenigen Generationen gelöscht, die @emph{älter} als die angegebene Dauer sind. Zum Beispiel löscht @code{--delete-generations=1m} die Generationen, die mehr als einen Monat alt sind." + +#. type: table +#: doc/guix.texi:2235 +msgid "If the current generation matches, it is @emph{not} deleted. Also, the zeroth generation is never deleted." +msgstr "Falls die aktuelle Generation zum Muster passt, wird sie @emph{nicht} gelöscht. Auch die nullte Generation wird niemals gelöscht." + +#. type: table +#: doc/guix.texi:2238 +msgid "Note that deleting generations prevents rolling back to them. Consequently, this command must be used with care." +msgstr "Beachten Sie, dass Sie auf gelöschte Generationen nicht zurückwechseln können. Dieser Befehl sollte also nur mit Vorsicht benutzt werden." + +#. type: Plain text +#: doc/guix.texi:2249 +msgid "Finally, since @command{guix package} may actually start build processes, it supports all the common build options (@pxref{Common Build Options}). It also supports package transformation options, such as @option{--with-source} (@pxref{Package Transformation Options}). However, note that package transformations are lost when upgrading; to preserve transformations across upgrades, you should define your own package variant in a Guile module and add it to @code{GUIX_PACKAGE_PATH} (@pxref{Defining Packages})." +msgstr "Zu guter Letzt können Sie, da @command{guix package} Erstellungsprozesse zu starten vermag, auch alle gemeinsamen Erstellungsoptionen (@pxref{Common Build Options}) verwenden. Auch Paketumwandlungsoptionen wie @option{--with-source} sind möglich (@pxref{Package Transformation Options}). Beachten Sie jedoch, dass die verwendeten Paketumwandlungsoptionen verloren gehen, nachdem Sie die Pakete aktualisiert haben. Damit Paketumwandlungen über Aktualisierungen hinweg erhalten bleiben, sollten Sie Ihre eigene Paketvariante in einem Guile-Modul definieren und zur Umgebungsvariablen @code{GUIX_PACKAGE_PATH} hinzufügen (@pxref{Defining Packages})." + +#. type: cindex +#: doc/guix.texi:2254 +#, no-wrap +msgid "pre-built binaries" +msgstr "vorerstellte Binärdateien" + +#. type: Plain text +#: doc/guix.texi:2260 +msgid "Guix supports transparent source/binary deployment, which means that it can either build things locally, or download pre-built items from a server, or both. We call these pre-built items @dfn{substitutes}---they are substitutes for local build results. In many cases, downloading a substitute is much faster than building things locally." +msgstr "Guix kann transparent Binär- oder Quelldateien ausliefern. Das heißt, Dinge können sowohl lokal erstellt, als auch als vorerstellte Objekte von einem Server heruntergeladen werden, oder beides gemischt. Wir bezeichnen diese vorerstellten Objekte als @dfn{Substitute} — sie substituieren lokale Erstellungsergebnisse. In vielen Fällen geht das Herunterladen eines Substituts wesentlich schneller, als Dinge lokal zu erstellen." + +#. type: Plain text +#: doc/guix.texi:2265 +msgid "Substitutes can be anything resulting from a derivation build (@pxref{Derivations}). Of course, in the common case, they are pre-built package binaries, but source tarballs, for instance, which also result from derivation builds, can be available as substitutes." +msgstr "Substitute können alles sein, was das Ergebnis einer Ableitungserstellung ist (@pxref{Derivations}). Natürlich sind sie üblicherweise vorerstellte Paket-Binärdateien, aber wenn zum Beispiel ein Quell-Tarball das Ergebnis einer Ableitungserstellung ist, kann auch er als Substitut verfügbar sein." + +#. type: cindex +#: doc/guix.texi:2278 +#, no-wrap +msgid "hydra" +msgstr "Hydra" + +#. type: cindex +#: doc/guix.texi:2279 +#, no-wrap +msgid "build farm" +msgstr "Build-Farm" + +#. type: Plain text +#: doc/guix.texi:2289 +msgid "The @code{mirror.hydra.gnu.org} server is a front-end to an official build farm that builds packages from Guix continuously for some architectures, and makes them available as substitutes. This is the default source of substitutes; it can be overridden by passing the @option{--substitute-urls} option either to @command{guix-daemon} (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) or to client tools such as @command{guix package} (@pxref{client-substitute-urls,, client @option{--substitute-urls} option})." +msgstr "Der Server @code{mirror.hydra.gnu.org} ist die Façade für eine offizielle »Build-Farm«, ein Erstellungswerk, das kontinuierlich Guix-Pakete für einige Prozessorarchitekturen erstellt und sie als Substitute zur Verfügung stellt. Dies ist die standardmäßige Quelle von Substituten; durch Übergeben der Befehlszeilenoption @option{--substitute-urls} an entweder den @command{guix-daemon} (@pxref{daemon-substitute-urls,, @code{guix-daemon --substitute-urls}}) oder Client-Werkzeuge wie @command{guix package} (@pxref{client-substitute-urls,, client @option{--substitute-urls} option}) kann eine abweichende Einstellung benutzt werden." + +#. type: Plain text +#: doc/guix.texi:2295 +msgid "Substitute URLs can be either HTTP or HTTPS. HTTPS is recommended because communications are encrypted; conversely, using HTTP makes all communications visible to an eavesdropper, who could use the information gathered to determine, for instance, whether your system has unpatched security vulnerabilities." +msgstr "Substitut-URLs können entweder HTTP oder HTTPS sein. HTTPS wird empfohlen, weil die Kommunikation verschlüsselt ist; umgekehrt kann bei HTTP die Kommunikation belauscht werden, wodurch der Angreifer zum Beispiel erfahren könnte, ob Ihr System über noch nicht behobene Sicherheitsschwachstellen verfügt." + +#. type: Plain text +#: doc/guix.texi:2304 +msgid "Substitutes from the official build farm are enabled by default when using the Guix System Distribution (@pxref{GNU Distribution}). However, they are disabled by default when using Guix on a foreign distribution, unless you have explicitly enabled them via one of the recommended installation steps (@pxref{Installation}). The following paragraphs describe how to enable or disable substitutes for the official build farm; the same procedure can also be used to enable substitutes for any other substitute server." +msgstr "Substitute von der offiziellen Build-Farm sind standardmäßig erlaubt, wenn Sie die Guix System Distribution verwenden (@pxref{GNU Distribution}). Auf Fremddistributionen sind sie allerdings standardmäßig ausgeschaltet, solange Sie sie nicht ausdrücklich in einem der empfohlenen Installationsschritte erlaubt haben (@pxref{Installation}). Die folgenden Absätze beschreiben, wie Sie Substitute für die offizielle Build-Farm an- oder ausschalten; dieselbe Prozedur kann auch benutzt werden, um Substitute für einen beliebigen anderen Substitutsserver zu erlauben." + +#. type: cindex +#: doc/guix.texi:2308 +#, no-wrap +msgid "security" +msgstr "Sicherheit" + +#. type: cindex +#: doc/guix.texi:2310 +#, no-wrap +msgid "access control list (ACL), for substitutes" +msgstr "Access Control List (ACL), für Substitute" + +#. type: cindex +#: doc/guix.texi:2311 +#, no-wrap +msgid "ACL (access control list), for substitutes" +msgstr "ACL (Access Control List), für Substitute" + +#. type: Plain text +#: doc/guix.texi:2318 +msgid "To allow Guix to download substitutes from @code{hydra.gnu.org} or a mirror thereof, you must add its public key to the access control list (ACL) of archive imports, using the @command{guix archive} command (@pxref{Invoking guix archive}). Doing so implies that you trust @code{hydra.gnu.org} to not be compromised and to serve genuine substitutes." +msgstr "Um es Guix zu gestatten, Substitute von @code{hydra.gnu.org} oder einem Spiegelserver davon herunterzuladen, müssen Sie den zugehörigen öffentlichen Schlüssel zur Access Control List (ACL, Zugriffssteuerungsliste) für Archivimporte hinzufügen, mit Hilfe des Befehls @command{guix archive} (@pxref{Invoking guix archive}). Dies impliziert, dass Sie darauf vertrauen, dass @code{hydra.gnu.org} nicht kompromittiert wurde und echte Substitute liefert." + +#. type: Plain text +#: doc/guix.texi:2325 +msgid "The public key for @code{hydra.gnu.org} is installed along with Guix, in @code{@var{prefix}/share/guix/hydra.gnu.org.pub}, where @var{prefix} is the installation prefix of Guix. If you installed Guix from source, make sure you checked the GPG signature of @file{guix-@value{VERSION}.tar.gz}, which contains this public key file. Then, you can run something like this:" +msgstr "Der öffentliche Schlüssel für @code{hydra.gnu.org} wird zusammen mit Guix installiert, in das Verzeichnis @code{@var{prefix}/share/guix/hydra.gnu.org.pub}, wobei @var{prefix} das Installationspräfix von Guix ist. Wenn Sie Guix aus seinem Quellcode heraus installieren, stellen Sie sicher, dass Sie die GPG-Signatur von @file{guix-@value{VERSION}.tar.gz} prüfen, worin sich dieser öffentliche Schlüssel befindet. Dann können Sie so etwas wie hier ausführen:" + +#. type: example +#: doc/guix.texi:2328 +#, no-wrap +msgid "# guix archive --authorize < @var{prefix}/share/guix/hydra.gnu.org.pub\n" +msgstr "# guix archive --authorize < @var{prefix}/share/guix/hydra.gnu.org.pub\n" + +#. type: quotation +#: doc/guix.texi:2334 +msgid "Similarly, the @file{berlin.guixsd.org.pub} file contains the public key for the project's new build farm, reachable at @indicateurl{https://berlin.guixsd.org}." +msgstr "Genauso enthält die Datei @file{berlin.guixsd.org.pub} den öffentlichen Schlüssel für die neue Build-Farm des Guix-Projekts, die unter @indicateurl{https://berlin.guixsd.org} erreichbar ist." + +#. type: quotation +#: doc/guix.texi:2339 +msgid "As of this writing @code{berlin.guixsd.org} is being upgraded so it can better scale up, but you might want to give it a try. It is backed by 20 x86_64/i686 build nodes and may be able to provide substitutes more quickly than @code{mirror.hydra.gnu.org}." +msgstr "Derzeit, als dieser Text geschrieben wurde, wird @code{berlin.guixsd.org} ausgebaut, um besser skalieren zu können, aber Sie könnten es ausprobieren. Dahinter stecken 20 x86_64-/i686-Erstellungsknoten, die Substitute früher anbieten könnten als @code{mirror.hydra.gnu.org}." + +#. type: Plain text +#: doc/guix.texi:2343 +msgid "Once this is in place, the output of a command like @code{guix build} should change from something like:" +msgstr "Sobald es eingerichtet wurde, sollte sich die Ausgabe eines Befehls wie @code{guix build} von so etwas:" + +#. type: example +#: doc/guix.texi:2352 +#, no-wrap +msgid "" +"$ guix build emacs --dry-run\n" +"The following derivations would be built:\n" +" /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n" +" /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n" +" /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n" +" /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n" +"@dots{}\n" +msgstr "" +"$ guix build emacs --dry-run\n" +"The following derivations would be built:\n" +" /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv\n" +" /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv\n" +" /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv\n" +" /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv\n" +"@dots{}\n" + +#. type: Plain text +#: doc/guix.texi:2356 +msgid "to something like:" +msgstr "in so etwas verwandeln:" + +#. type: example +#: doc/guix.texi:2365 +#, no-wrap +msgid "" +"$ guix build emacs --dry-run\n" +"112.3 MB would be downloaded:\n" +" /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n" +" /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n" +" /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n" +" /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n" +"@dots{}\n" +msgstr "" +"$ guix build emacs --dry-run\n" +"112.3 MB would be downloaded:\n" +" /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3\n" +" /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d\n" +" /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16\n" +" /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7\n" +"@dots{}\n" + +#. type: Plain text +#: doc/guix.texi:2370 +msgid "This indicates that substitutes from @code{hydra.gnu.org} are usable and will be downloaded, when possible, for future builds." +msgstr "Das zeigt an, dass Substitute von @code{hydra.gnu.org} nutzbar sind und für zukünftige Erstellungen heruntergeladen, wann immer es möglich ist." + +#. type: cindex +#: doc/guix.texi:2371 +#, no-wrap +msgid "substitutes, how to disable" +msgstr "Substitute, wie man sie ausschaltet" + +#. type: Plain text +#: doc/guix.texi:2377 +msgid "The substitute mechanism can be disabled globally by running @code{guix-daemon} with @code{--no-substitutes} (@pxref{Invoking guix-daemon}). It can also be disabled temporarily by passing the @code{--no-substitutes} option to @command{guix package}, @command{guix build}, and other command-line tools." +msgstr "Der Substitutsmechanismus kann global ausgeschaltet werden, indem Sie dem @code{guix-daemon} beim Starten die Befehlszeilenoption @code{--no-substitutes} übergeben (@pxref{Invoking guix-daemon}). Er kann auch temporär ausgeschaltet werden, indem Sie @code{--no-substitutes} an @command{guix package}, @command{guix build} und andere Befehlszeilenwerkzeuge übergeben." + +#. type: cindex +#: doc/guix.texi:2381 +#, no-wrap +msgid "digital signatures" +msgstr "digitale Signaturen" + +#. type: Plain text +#: doc/guix.texi:2385 +msgid "Guix detects and raises an error when attempting to use a substitute that has been tampered with. Likewise, it ignores substitutes that are not signed, or that are not signed by one of the keys listed in the ACL." +msgstr "Guix erkennt, wenn ein verfälschtes Substitut benutzt würde, und meldet einen Fehler. Ebenso werden Substitute ignoriert, die nich signiert sind, oder nicht mit einem in der ACL aufgelisteten Schlüssel signiert sind." + +#. type: Plain text +#: doc/guix.texi:2391 +msgid "There is one exception though: if an unauthorized server provides substitutes that are @emph{bit-for-bit identical} to those provided by an authorized server, then the unauthorized server becomes eligible for downloads. For example, assume we have chosen two substitute servers with this option:" +msgstr "Es gibt nur eine Ausnahme: Wenn ein unautorisierter Server Substitute anbietet, die @emph{Bit für Bit identisch} mit denen von einem authorisierten Server sind, können sie auch vom unautorisierten Server heruntergeladen werden. Zum Beispiel, angenommen wir haben zwei Substitutserver mit dieser Befehlszeilenoption ausgewählt:" + +#. type: example +#: doc/guix.texi:2394 +#, no-wrap +msgid "--substitute-urls=\"https://a.example.org https://b.example.org\"\n" +msgstr "--substitute-urls=\"https://a.example.org https://b.example.org\"\n" + +#. type: Plain text +#: doc/guix.texi:2405 +msgid "If the ACL contains only the key for @code{b.example.org}, and if @code{a.example.org} happens to serve the @emph{exact same} substitutes, then Guix will download substitutes from @code{a.example.org} because it comes first in the list and can be considered a mirror of @code{b.example.org}. In practice, independent build machines usually produce the same binaries, thanks to bit-reproducible builds (see below)." +msgstr "Wenn in der ACL nur der Schlüssel für @code{b.example.org} aufgeführt wurde, aber @code{a.example.org} @emph{exakt dieselben} Substitute anbietet, wird Guix auch Substitute von @code{a.example.org} herunterladen, weil es in der Liste zuerst kommt und als Spiegelserver für @code{b.example.org} aufgefasst werden kann. In der Praxis haben unabhängige Maschinen bei der Erstellung normalerweise dieselben Binärdateien als Ergebnis, dank bit-reproduzierbarer Erstellungen (siehe unten)." + +#. type: Plain text +#: doc/guix.texi:2412 +msgid "When using HTTPS, the server's X.509 certificate is @emph{not} validated (in other words, the server is not authenticated), contrary to what HTTPS clients such as Web browsers usually do. This is because Guix authenticates substitute information itself, as explained above, which is what we care about (whereas X.509 certificates are about authenticating bindings between domain names and public keys.)" +msgstr "Wenn Sie HTTPS benutzen, wird das X.509-Zertifikat des Servers @emph{nicht} validiert (mit anderen Worten, die Identität des Servers wird nicht authentifiziert), entgegen dem, was HTTPS-Clients wie Web-Browser normalerweise tun. Da Guix Substitutinformationen selbst überprüft, wie oben erklärt, wäre es unnötig (wohingegen mit X.509-Zertifikaten geprüft wird, ob ein Domain-Name zu öffentlichen Schlüsseln passt)." + +#. type: Plain text +#: doc/guix.texi:2424 +msgid "Substitutes are downloaded over HTTP or HTTPS. The @code{http_proxy} environment variable can be set in the environment of @command{guix-daemon} and is honored for downloads of substitutes. Note that the value of @code{http_proxy} in the environment where @command{guix build}, @command{guix package}, and other client commands are run has @emph{absolutely no effect}." +msgstr "Substitute werden über HTTP oder HTTPS heruntergeladen. Die Umgebungsvariable @code{http_proxy} kann in der Umgebung von @command{guix-daemon} definiert werden und wirkt sich dann auf das Herunterladen von Substituten aus. Beachten Sie, dass der Wert von @code{http_proxy} in der Umgebung, in der @command{guix build}, @command{guix package} und andere Client-Befehle ausgeführt werden, @emph{keine Rolle spielt}." + +#. type: Plain text +#: doc/guix.texi:2433 +msgid "Even when a substitute for a derivation is available, sometimes the substitution attempt will fail. This can happen for a variety of reasons: the substitute server might be offline, the substitute may recently have been deleted, the connection might have been interrupted, etc." +msgstr "Selbst wenn ein Substitut für eine Ableitung verfügbar ist, schlägt die versuchte Substitution manchmal fehl. Das kann aus vielen Gründen geschehen: die Substitutsserver könnten offline sein, das Substitut könnte kürzlich gelöscht worden sein, die Netzwerkverbindunge könnte unterbrochen worden sein, usw." + +#. type: Plain text +#: doc/guix.texi:2447 +msgid "When substitutes are enabled and a substitute for a derivation is available, but the substitution attempt fails, Guix will attempt to build the derivation locally depending on whether or not @code{--fallback} was given (@pxref{fallback-option,, common build option @code{--fallback}}). Specifically, if @code{--fallback} was omitted, then no local build will be performed, and the derivation is considered to have failed. However, if @code{--fallback} was given, then Guix will attempt to build the derivation locally, and the success or failure of the derivation depends on the success or failure of the local build. Note that when substitutes are disabled or no substitute is available for the derivation in question, a local build will @emph{always} be performed, regardless of whether or not @code{--fallback} was given." +msgstr "Wenn Substitute aktiviert sind und ein Substitut für eine Ableitung zwar verfügbar ist, aber die versuchte Substitution fehlschlägt, kann Guix versuchen, die Ableitung lokal zu erstellen, je nachdem, ob @code{--fallback} übergeben wurde (@pxref{fallback-option,, common build option @code{--fallback}}). Genauer gesagt, wird keine lokale Erstellung durchgeführt, solange kein @code{--fallback} angegeben wurde, und die Ableitung wird als Fehlschlag angesehen. Wenn @code{--fallback} übergeben wurde, wird Guix versuchen, die Ableitung lokal zu erstellen, und ob die Ableitung erfolgreich ist oder nicht, hängt davon ab, ob die lokale Erstellung erfolgreich ist oder nicht. Beachten Sie, dass, falls Substitute ausgeschaltet oder erst gar kein Substitut verfügbar ist, @emph{immer} eine lokale Erstellung durchgeführt wird, egal ob @code{--fallback} übergeben wurde oder nicht." + +#. type: Plain text +#: doc/guix.texi:2452 +msgid "To get an idea of how many substitutes are available right now, you can try running the @command{guix weather} command (@pxref{Invoking guix weather}). This command provides statistics on the substitutes provided by a server." +msgstr "Um eine Vorstellung zu bekommen, wieviele Substitute gerade verfügbar sind, können Sie den Befehl @command{guix weather} benutzen (@pxref{Invoking guix weather}). Dieser Befehl zeigt Statistiken darüber an, wie es um die von einem Server verfügbaren Substitute steht." + +#. type: cindex +#: doc/guix.texi:2456 +#, no-wrap +msgid "trust, of pre-built binaries" +msgstr "Vertrauen, gegenüber vorerstellten Binärdateien" + +#. type: Plain text +#: doc/guix.texi:2466 +msgid "Today, each individual's control over their own computing is at the mercy of institutions, corporations, and groups with enough power and determination to subvert the computing infrastructure and exploit its weaknesses. While using @code{hydra.gnu.org} substitutes can be convenient, we encourage users to also build on their own, or even run their own build farm, such that @code{hydra.gnu.org} is less of an interesting target. One way to help is by publishing the software you build using @command{guix publish} so that others have one more choice of server to download substitutes from (@pxref{Invoking guix publish})." +msgstr "Derzeit hängt die Kontrolle jedes Individuums über seine Rechner von Institutionen, Unternehmen undsolchen Gruppierungen ab, die über genug Macht und Entschlusskraft verfügen, die Rechnerinfrastruktur zu sabotieren und ihre Schwachstellen auszunutzen. Auch wenn es bequem ist, Substitute von @code{hydra.gnu.org} zu benutzen, ermuntern wir Nutzer, auch selbst Erstellungen durchzuführen oder gar ihre eigene Build-Farm zu betreiben, damit @code{hydra.gnu.org} ein weniger interessantes Ziel wird. Eine Art, uns zu helfen, ist, die von Ihnen erstellte Software mit dem Befehl @command{guix publish} zu veröffentlichen, damit andere eine größere Auswahl haben, von welchem Server sie Substitute beziehen möchten (@pxref{Invoking guix publish})." + +#. type: Plain text +#: doc/guix.texi:2478 +msgid "Guix has the foundations to maximize build reproducibility (@pxref{Features}). In most cases, independent builds of a given package or derivation should yield bit-identical results. Thus, through a diverse set of independent package builds, we can strengthen the integrity of our systems. The @command{guix challenge} command aims to help users assess substitute servers, and to assist developers in finding out about non-deterministic package builds (@pxref{Invoking guix challenge}). Similarly, the @option{--check} option of @command{guix build} allows users to check whether previously-installed substitutes are genuine by rebuilding them locally (@pxref{build-check, @command{guix build --check}})." +msgstr "Guix hat die richtigen Grundlagen, um die Reproduzierbarkeit von Erstellungen zu maximieren (@pxref{Features}). In den meisten Fällen sollten unabhängige Erstellungen eines bestimmten Pakets zu bitweise identischen Ergebnissen führen. Wir können also mit Hilfe einer vielschichtigen Menge an unabhängigen Paketerstellungen die Integrität unseres Systems besser gewährleisten. Der Befehl @command{guix challenge} hat das Ziel, Nutzern zu ermöglichen, Substitutserver zu beurteilen, und Entwicklern zu ermöglichen, nichtdeterministische Paketerstellungen zu finden (@pxref{Invoking guix challenge}). Ebenso ermöglicht es die Befehlszeilenoption @option{--check} von @command{guix build}, dass Nutzer bereits installierte Substitute auf Echtheit zu prüfen, indem sie lokal nachgebaut werden (@pxref{build-check, @command{guix build --check}})." + +#. type: Plain text +#: doc/guix.texi:2482 +msgid "In the future, we want Guix to have support to publish and retrieve binaries to/from other users, in a peer-to-peer fashion. If you would like to discuss this project, join us on @email{guix-devel@@gnu.org}." +msgstr "In Zukunft wollen wir, dass Guix Binärdateien an und von Nutzern in einem Peer-to-Peer veröffentlichen kann. Wenn Sie mit uns dieses Projekt diskuttieren möchten, kommen Sie auf unsere Mailing-Liste @email{guix-devel@@gnu.org}." + +#. type: cindex +#: doc/guix.texi:2486 +#, no-wrap +msgid "multiple-output packages" +msgstr "mehrere Ausgaben, bei Paketen" + +#. type: cindex +#: doc/guix.texi:2487 +#, no-wrap +msgid "package outputs" +msgstr "Paketausgaben" + +#. type: cindex +#: doc/guix.texi:2488 +#, no-wrap +msgid "outputs" +msgstr "Ausgaben" + +#. type: Plain text +#: doc/guix.texi:2498 +msgid "Often, packages defined in Guix have a single @dfn{output}---i.e., the source package leads to exactly one directory in the store. When running @command{guix package -i glibc}, one installs the default output of the GNU libc package; the default output is called @code{out}, but its name can be omitted as shown in this command. In this particular case, the default output of @code{glibc} contains all the C header files, shared libraries, static libraries, Info documentation, and other supporting files." +msgstr "Oft haben in Guix definierte Pakete eine einzige @dfn{Ausgabe} — d.h. aus dem Quellpaket entsteht genau ein Verzeichnis im Store. Wenn Sie @command{guix package -i glibc} ausführen, wird die Standard-Paketausgabe des GNU-libc-Pakets installiert; die Standardausgabe wird @code{out} genannt, aber ihr Name kann weggelassen werden, wie sie an obigem Befehl sehen. In diesem speziellen Fall enthält die Standard-Paketausgabe von @code{glibc} alle C-Headerdateien, gemeinsamen Bibliotheken (»Shared Libraries«), statische Bibliotheken (»Static Libraries«), Dokumentation für Info sowie andere zusätzliche Dateien." + +#. type: Plain text +#: doc/guix.texi:2506 +msgid "Sometimes it is more appropriate to separate the various types of files produced from a single source package into separate outputs. For instance, the GLib C library (used by GTK+ and related packages) installs more than 20 MiB of reference documentation as HTML pages. To save space for users who do not need it, the documentation goes to a separate output, called @code{doc}. To install the main GLib output, which contains everything but the documentation, one would run:" +msgstr "Manchmal ist es besser, die verschiedenen Arten von Dateien, die aus einem einzelnen Quellpaket hervorgehen, in getrennte Ausgaben zu unterteilen. Zum Beispiel installiert die GLib-C-Bibliothek (die von GTK+ und damit zusammenhängenden Paketen benutzt wird) mehr als 20 MiB an HTML-Seiten mit Referenzdokumentation. Um den Nutzern, die das nicht brauchen, Platz zu sparen, wird die Dokumentation in einer separaten Ausgabe abgelegt, genannt @code{doc}. Um also die Hauptausgabe von GLib zu installieren, zu der alles außer der Dokumentation gehört, ist der Befehl:" + +#. type: example +#: doc/guix.texi:2509 +#, no-wrap +msgid "guix package -i glib\n" +msgstr "guix package -i glib\n" + +#. type: code{#1} +#: doc/guix.texi:2511 doc/guix.texi:21805 +#, no-wrap +msgid "documentation" +msgstr "Dokumentation" + +#. type: Plain text +#: doc/guix.texi:2513 +msgid "The command to install its documentation is:" +msgstr "Der Befehl, um die Dokumentation zu installieren, ist:" + +#. type: example +#: doc/guix.texi:2516 +#, no-wrap +msgid "guix package -i glib:doc\n" +msgstr "guix package -i glib:doc\n" + +#. type: Plain text +#: doc/guix.texi:2527 +msgid "Some packages install programs with different ``dependency footprints''. For instance, the WordNet package installs both command-line tools and graphical user interfaces (GUIs). The former depend solely on the C library, whereas the latter depend on Tcl/Tk and the underlying X libraries. In this case, we leave the command-line tools in the default output, whereas the GUIs are in a separate output. This allows users who do not need the GUIs to save space. The @command{guix size} command can help find out about such situations (@pxref{Invoking guix size}). @command{guix graph} can also be helpful (@pxref{Invoking guix graph})." +msgstr "Manche Pakete installieren Programme mit unterschiedlich großem »Abhängigkeiten-Fußabdruck«. Zum Beispiel installiert das Paket WordNet sowohl Befehlszeilenwerkzeuge als auch grafische Benutzerschnittstellen (GUIs). Erstere hängen nur von der C-Bibliothek ab, während Letztere auch von Tcl/Tk und den zu Grunde liegenden X-Bibliotheken abhängen. Jedenfalls belassen wir deshalb die Befehlszeilenwerkzeuge in der Standard-Paketausgabe, während sich die GUIs in einer separaten Ausgabe befinden. So können Benutzer, die die GUIs nicht brauchen, Platz sparen. Der Befehl @command{guix size} kann dabei helfen, solche Situationen zu erkennen (@pxref{Invoking guix size}). @command{guix graph} kann auch helfen (@pxref{Invoking guix graph})." + +#. type: Plain text +#: doc/guix.texi:2535 +msgid "There are several such multiple-output packages in the GNU distribution. Other conventional output names include @code{lib} for libraries and possibly header files, @code{bin} for stand-alone programs, and @code{debug} for debugging information (@pxref{Installing Debugging Files}). The outputs of a packages are listed in the third column of the output of @command{guix package --list-available} (@pxref{Invoking guix package})." +msgstr "In der GNU-Distribution gibt es viele solche Pakete mit mehreren Ausgaben. Andere Konventionen für Ausgabenamen sind zum Beispiel @code{lib} für Bibliotheken und eventuell auch ihre Header-Dateien,, @code{bin} für eigenständige Programme und @code{debug} für Informationen zur Fehlerbehandlung (@pxref{Installing Debugging Files}). Die Ausgaben eines Pakets stehen in der dritten Spalte der Anzeige von @command{guix package --list-available} (@pxref{Invoking guix package})." + +#. type: section +#: doc/guix.texi:2538 +#, no-wrap +msgid "Invoking @command{guix gc}" +msgstr "@command{guix gc} aufrufen" + +#. type: cindex +#: doc/guix.texi:2540 +#, no-wrap +msgid "garbage collector" +msgstr "Müllsammler" + +#. type: cindex +#: doc/guix.texi:2541 +#, no-wrap +msgid "disk space" +msgstr "Plattenspeicher" + +#. type: Plain text +#: doc/guix.texi:2547 +msgid "Packages that are installed, but not used, may be @dfn{garbage-collected}. The @command{guix gc} command allows users to explicitly run the garbage collector to reclaim space from the @file{/gnu/store} directory. It is the @emph{only} way to remove files from @file{/gnu/store}---removing files or directories manually may break it beyond repair!" +msgstr "Pakete, die zwar installiert sind, aber nicht benutzt werden, können vom @dfn{Müllsammler} entfernt werden. Mit dem Befehl @command{guix gc} können Benutzer den Müllsammler ausdrücklich aufrufen, um Speicher im Verzeichnis @file{/gnu/store} freizugeben. Dies ist der @emph{einzige} Weg, Dateien aus @file{/gnu/store} zu entfernen — das manuelle Entfernen von Dateien kann den Store irreparabel beschädigen!" + +#. type: Plain text +#: doc/guix.texi:2558 +msgid "The garbage collector has a set of known @dfn{roots}: any file under @file{/gnu/store} reachable from a root is considered @dfn{live} and cannot be deleted; any other file is considered @dfn{dead} and may be deleted. The set of garbage collector roots (``GC roots'' for short) includes default user profiles; by default, the symlinks under @file{/var/guix/gcroots} represent these GC roots. New GC roots can be added with @command{guix build --root}, for example (@pxref{Invoking guix build})." +msgstr "Der Müllsammler kennt eine Reihe von @dfn{Wurzeln}: Jede Datei in @file{/gnu/store}, die von einer Wurzel aus erreichbar ist, gilt als @dfn{lebendig} und kann nicht entfernt werden; jede andere Datei gilt als @dfn{tot} und ist ein Kandidat, gelöscht zu werden. Die Reihe der Müllsammlerwurzeln (kurz auch »GC-Wurzeln«, von englisch »Garbage Collector«) umfasst Standard-Benutzerprofile; standardmäßig werden diese Müllsammlerwurzeln durch symbolische Verknüpfungen in @file{/var/guix/gcroots} dargestellt. Neue Müllsammlerwurzeln können zum Beispiel mit @command{guix build --root} festgelegt werden (@pxref{Invoking guix build})." + +#. type: Plain text +#: doc/guix.texi:2564 +msgid "Prior to running @code{guix gc --collect-garbage} to make space, it is often useful to remove old generations from user profiles; that way, old package builds referenced by those generations can be reclaimed. This is achieved by running @code{guix package --delete-generations} (@pxref{Invoking guix package})." +msgstr "Bevor Sie mit @code{guix gc --collect-garbage} Speicher freimachen, wollen Sie vielleicht alte Generationen von Benutzerprofilen löschen, damit alte Paketerstellungen von diesen Generationen entfernt werden können. Führen Sie dazu @code{guix package --delete-generations} aus (@pxref{Invoking guix package})." + +#. type: Plain text +#: doc/guix.texi:2568 +msgid "Our recommendation is to run a garbage collection periodically, or when you are short on disk space. For instance, to guarantee that at least 5@tie{}GB are available on your disk, simply run:" +msgstr "Unsere Empfehlung ist, dass Sie den Müllsammler regelmäßig laufen lassen und wenn Sie wenig freien Speicherplatz zur Verfügung haben. Um zum Beispiel sicherzustellen, dass Sie mindestens 5@tie{}GB are auf Ihrer Platte zur Verfügung haben, benutzen Sie einfach:" + +#. type: example +#: doc/guix.texi:2571 +#, no-wrap +msgid "guix gc -F 5G\n" +msgstr "guix gc -F 5G\n" + +#. type: Plain text +#: doc/guix.texi:2580 +msgid "It is perfectly safe to run as a non-interactive periodic job (@pxref{Scheduled Job Execution}, for how to set up such a job on GuixSD). Running @command{guix gc} with no arguments will collect as much garbage as it can, but that is often inconvenient: you may find yourself having to rebuild or re-download software that is ``dead'' from the GC viewpoint but that is necessary to build other pieces of software---e.g., the compiler tool chain." +msgstr "Es ist völlig sicher, dafür eine nicht interaktive, regelmäßige Auftragsausführung vorzugeben (@pxref{Scheduled Job Execution}, für eine Erklärung, wie man das in GuixSD tun kann). @command{guix gc} ohne Befehlszeilenargumente auszuführen, lässt so viel Müll wie möglich sammeln, aber das ist oft nicht, was man will, denn so muss man unter Umständen Software erneut erstellen oder erneut herunterladen, weil der Müllsammler sie als »tot« ansieht, sie aber zur Erstellung anderer Software wiedeer gebraucht wird — das trifft zum Beispiel auf die Compiler-Toolchain zu." + +#. type: Plain text +#: doc/guix.texi:2586 +msgid "The @command{guix gc} command has three modes of operation: it can be used to garbage-collect any dead files (the default), to delete specific files (the @code{--delete} option), to print garbage-collector information, or for more advanced queries. The garbage collection options are as follows:" +msgstr "Der Befehl @command{guix gc} hat drei Arbeitsmodi: Er kann benutzt werden, um als Müllsammler tote Dateien zu entfernen (das Standardverhalten), um ganz bestimmte, angegebene Datein zu löschen (mit der Befehlszeilenoption @code{--delete}), um Müllsammlerinformationen auszugeben oder fortgeschrittenere Anfragen zu verarbeiten. Die Müllsammler-Befehlszeilenoptionen sind wie folgt:" + +#. type: item +#: doc/guix.texi:2588 +#, no-wrap +msgid "--collect-garbage[=@var{min}]" +msgstr "--collect-garbage[=@var{Minimum}]" + +#. type: itemx +#: doc/guix.texi:2589 +#, no-wrap +msgid "-C [@var{min}]" +msgstr "-C [@var{Minimum}]" + +#. type: table +#: doc/guix.texi:2593 +msgid "Collect garbage---i.e., unreachable @file{/gnu/store} files and sub-directories. This is the default operation when no option is specified." +msgstr "Lässt Müll sammeln — z.B. nicht erreichbare Dateien in @file{/gnu/store} und seinen Unterverzeichnissen. Wird keine andere Befehlszeilenoption angegeben, wird standardmäßig diese durchgeführt." + +#. type: table +#: doc/guix.texi:2598 +msgid "When @var{min} is given, stop once @var{min} bytes have been collected. @var{min} may be a number of bytes, or it may include a unit as a suffix, such as @code{MiB} for mebibytes and @code{GB} for gigabytes (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})." +msgstr "Wenn ein @var{Minimum} angegeben wurde, hört der Müllsammler auf, sobald @var{Minimum} Bytes gesammelt wurden. Das @var{Minimum} kann die Anzahl der Bytes bezeichnen oder mit einer Einheit als Suffix versehen sein, wie etwa @code{MiB} für Mebibytes und @code{GB} für Gigabytes (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})." + +#. type: table +#: doc/guix.texi:2600 +msgid "When @var{min} is omitted, collect all the garbage." +msgstr "Wird kein @var{Minimum} angegeben, sammelt der Müllsammler allen Müll." + +#. type: item +#: doc/guix.texi:2601 +#, no-wrap +msgid "--free-space=@var{free}" +msgstr "--free-space=@var{Menge}" + +#. type: itemx +#: doc/guix.texi:2602 +#, no-wrap +msgid "-F @var{free}" +msgstr "-F @var{Menge}" + +#. type: table +#: doc/guix.texi:2606 +msgid "Collect garbage until @var{free} space is available under @file{/gnu/store}, if possible; @var{free} denotes storage space, such as @code{500MiB}, as described above." +msgstr "Sammelt Müll, bis die angegebene @var{Menge} an freiem Speicher in @file{/gnu/store} zur Verfügung steht, falls möglich; die @var{Menge} ist eine Speichergröße wie @code{500MiB}, wie oben beschrieben." + +#. type: table +#: doc/guix.texi:2609 +msgid "When @var{free} or more is already available in @file{/gnu/store}, do nothing and exit immediately." +msgstr "Wenn die angegebene @var{Menge} oder mehr bereits in @file{/gnu/store} frei verfügbar ist, passiert nichts." + +#. type: item +#: doc/guix.texi:2610 +#, no-wrap +msgid "--delete" +msgstr "--delete" + +#. type: itemx +#: doc/guix.texi:2611 doc/guix.texi:6018 doc/guix.texi:21082 +#, no-wrap +msgid "-d" +msgstr "-d" + +#. type: table +#: doc/guix.texi:2615 +msgid "Attempt to delete all the store files and directories specified as arguments. This fails if some of the files are not in the store, or if they are still live." +msgstr "Versucht, alle als Argumente angegebenen Dateien oder Verzeichnisse im Store zu löschen. Dies schlägt fehl, wenn manche der Dateien oder Verzeichnisse nicht im Store oder noch immer lebendig sind." + +#. type: item +#: doc/guix.texi:2616 +#, no-wrap +msgid "--list-failures" +msgstr "--list-failures" + +#. type: table +#: doc/guix.texi:2618 +msgid "List store items corresponding to cached build failures." +msgstr "Store-Objekte auflisten, die zwischengespeicherten Erstellungsfehlern entsprechen." + +#. type: table +#: doc/guix.texi:2622 +msgid "This prints nothing unless the daemon was started with @option{--cache-failures} (@pxref{Invoking guix-daemon, @option{--cache-failures}})." +msgstr "Hierbei wird nichts ausgegeben, sofern der Daemon nicht mit @option{--cache-failures} gestartet wurde (@pxref{Invoking guix-daemon, @option{--cache-failures}})." + +#. type: item +#: doc/guix.texi:2623 +#, no-wrap +msgid "--clear-failures" +msgstr "--clear-failures" + +#. type: table +#: doc/guix.texi:2625 +msgid "Remove the specified store items from the failed-build cache." +msgstr "Die angegebenen Store-Objekte aus dem Zwischenspeicher für fehlgeschlagene Erstellungen entfernen." + +#. type: table +#: doc/guix.texi:2628 +msgid "Again, this option only makes sense when the daemon is started with @option{--cache-failures}. Otherwise, it does nothing." +msgstr "Auch diese Option macht nur Sinn, wenn der Daemon mit @option{--cache-failures} gestartet wurde. Andernfalls passiert nichts." + +#. type: item +#: doc/guix.texi:2629 +#, no-wrap +msgid "--list-dead" +msgstr "--list-dead" + +#. type: table +#: doc/guix.texi:2632 +msgid "Show the list of dead files and directories still present in the store---i.e., files and directories no longer reachable from any root." +msgstr "Zeigt die Liste toter Dateien und Verzeichnisse an, die sich noch im Store befinden — das heißt, Dateien, die von keiner Wurzel mehr erreichbar sind." + +#. type: item +#: doc/guix.texi:2633 +#, no-wrap +msgid "--list-live" +msgstr "--list-live" + +#. type: table +#: doc/guix.texi:2635 +msgid "Show the list of live store files and directories." +msgstr "Zeige die Liste lebendiger Store-Dateien und -Verzeichnisse." + +#. type: Plain text +#: doc/guix.texi:2639 +msgid "In addition, the references among existing store files can be queried:" +msgstr "Außerdem können Referenzen unter bestehenden Store-Dateien gefunden werden:" + +#. type: item +#: doc/guix.texi:2642 +#, no-wrap +msgid "--references" +msgstr "--references" + +#. type: itemx +#: doc/guix.texi:2643 +#, no-wrap +msgid "--referrers" +msgstr "--referrers" + +#. type: cindex +#: doc/guix.texi:2644 doc/guix.texi:7145 +#, no-wrap +msgid "package dependencies" +msgstr "Paketabhängigkeiten" + +#. type: table +#: doc/guix.texi:2647 +msgid "List the references (respectively, the referrers) of store files given as arguments." +msgstr "Listet die referenzierten bzw. sie referenzierenden Objekte der angegebenen Store-Dateien auf." + +#. type: item +#: doc/guix.texi:2648 +#, no-wrap +msgid "--requisites" +msgstr "--requisites" + +#. type: itemx +#: doc/guix.texi:2649 doc/guix.texi:2956 +#, no-wrap +msgid "-R" +msgstr "-R" + +#. type: item +#: doc/guix.texi:2650 doc/guix.texi:7021 doc/guix.texi:7049 doc/guix.texi:7117 +#, no-wrap +msgid "closure" +msgstr "Abschluss" + +#. type: table +#: doc/guix.texi:2655 +msgid "List the requisites of the store files passed as arguments. Requisites include the store files themselves, their references, and the references of these, recursively. In other words, the returned list is the @dfn{transitive closure} of the store files." +msgstr "Listet alle Voraussetzungen der als Argumente übergebenen Store-Dateien auf. Voraussetzungen sind die Store-Dateien selbst, ihre Referenzen sowie die Referenzen davon, rekursiv. Mit anderen Worten, die zurückgelieferte Liste ist der @dfn{transitive Abschluss} dieser Store-Dateien." + +#. type: table +#: doc/guix.texi:2659 +msgid "@xref{Invoking guix size}, for a tool to profile the size of the closure of an element. @xref{Invoking guix graph}, for a tool to visualize the graph of references." +msgstr "Der Abschnitt @xref{Invoking guix size} erklärt ein Werkzeug, um den Speicherbedarf des Abschlusses eines Elements zu ermitteln. Siehe @xref{Invoking guix graph} für ein Werkzeug, um den Referenzgraph zu veranschaulichen." + +#. type: item +#: doc/guix.texi:2660 +#, no-wrap +msgid "--derivers" +msgstr "--derivers" + +#. type: item +#: doc/guix.texi:2661 doc/guix.texi:3241 doc/guix.texi:7230 +#, no-wrap +msgid "derivation" +msgstr "Ableitung" + +#. type: table +#: doc/guix.texi:2664 +msgid "Return the derivation(s) leading to the given store items (@pxref{Derivations})." +msgstr "Liefert die Ableitung(en), die zu den angegebenen Store-Objekten führen (@pxref{Derivations})." + +#. type: table +#: doc/guix.texi:2666 +msgid "For example, this command:" +msgstr "Zum Beispiel liefert dieser Befehl:" + +#. type: example +#: doc/guix.texi:2669 +#, no-wrap +msgid "guix gc --derivers `guix package -I ^emacs$ | cut -f4`\n" +msgstr "guix gc --derivers `guix package -I ^emacs$ | cut -f4`\n" + +#. type: table +#: doc/guix.texi:2674 +msgid "returns the @file{.drv} file(s) leading to the @code{emacs} package installed in your profile." +msgstr "die @file{.drv}-Datei(en), die zum in Ihrem Profil installierten @code{emacs}-Paket führen." + +#. type: table +#: doc/guix.texi:2678 +msgid "Note that there may be zero matching @file{.drv} files, for instance because these files have been garbage-collected. There can also be more than one matching @file{.drv} due to fixed-output derivations." +msgstr "Beachten Sie, dass es auch sein kann, dass keine passenden @file{.drv}-Dateien existieren, zum Beispiel wenn diese Dateien bereits dem Müllsammler zum Opfer gefallen sind. Es kann auch passieren, dass es mehr als eine passende @file{.drv} gibt, bei Ableitungen mit fester Ausgabe." + +#. type: Plain text +#: doc/guix.texi:2682 +msgid "Lastly, the following options allow you to check the integrity of the store and to control disk usage." +msgstr "Zuletzt können Sie mit folgenden Befehlszeilenoptionen die Integrität des Stores prüfen und den Plattenspeicherverbrauch im Zaum halten." + +#. type: item +#: doc/guix.texi:2685 +#, no-wrap +msgid "--verify[=@var{options}]" +msgstr "--verify[=@var{Optionen}]" + +#. type: cindex +#: doc/guix.texi:2686 +#, no-wrap +msgid "integrity, of the store" +msgstr "Integrität, des Stores" + +#. type: cindex +#: doc/guix.texi:2687 +#, no-wrap +msgid "integrity checking" +msgstr "Integritätsprüfung" + +#. type: table +#: doc/guix.texi:2689 +msgid "Verify the integrity of the store." +msgstr "Die Integrität des Stores verifizieren" + +#. type: table +#: doc/guix.texi:2692 +msgid "By default, make sure that all the store items marked as valid in the database of the daemon actually exist in @file{/gnu/store}." +msgstr "Standardmäßig wird sichergestellt, dass alle Store-Objekte, die in der Datenbank des Daemons als gültig markiert wurden, auch tatsächlich in @file{/gnu/store} existieren." + +#. type: table +#: doc/guix.texi:2695 +msgid "When provided, @var{options} must be a comma-separated list containing one or more of @code{contents} and @code{repair}." +msgstr "Wenn angegeben, müssen die @var{Optionen} eine kommagetrennte Liste aus mindestens einem der Worte @code{contents} und @code{repair} sein." + +#. type: table +#: doc/guix.texi:2701 +msgid "When passing @option{--verify=contents}, the daemon computes the content hash of each store item and compares it against its hash in the database. Hash mismatches are reported as data corruptions. Because it traverses @emph{all the files in the store}, this command can take a long time, especially on systems with a slow disk drive." +msgstr "Wenn Sie @option{--verify=contents} übergeben, berechnet der Daemon den Hash des Inhalts jedes Store-Objekts und vergleicht ihn mit dem Hash in der Datenbank. Sind die Hashes ungleich, wird eine Datenbeschädigung gemeldet. Weil dabei @emph{alle Dateien im Store} durchlaufen werden, kann der Befehl viel Zeit brauchen, besonders auf Systemen mit langsamer Platte." + +#. type: cindex +#: doc/guix.texi:2702 +#, no-wrap +msgid "repairing the store" +msgstr "Store, reparieren" + +#. type: cindex +#: doc/guix.texi:2703 doc/guix.texi:6011 +#, no-wrap +msgid "corruption, recovering from" +msgstr "Datenbeschädigung, Behebung" + +#. type: table +#: doc/guix.texi:2711 +msgid "Using @option{--verify=repair} or @option{--verify=contents,repair} causes the daemon to try to repair corrupt store items by fetching substitutes for them (@pxref{Substitutes}). Because repairing is not atomic, and thus potentially dangerous, it is available only to the system administrator. A lightweight alternative, when you know exactly which items in the store are corrupt, is @command{guix build --repair} (@pxref{Invoking guix build})." +msgstr "Mit @option{--verify=repair} oder @option{--verify=contents,repair} versucht der Daemon, beschädigte Store-Objekte zu reparieren, indem er Substitute für selbige herunterlädt (@pxref{Substitutes}). Weil die Reparatur nicht atomar und daher womöglich riskant ist, kann nur der Systemadministrator den Befehl benutzen. Eine weniger aufwendige Alternative, wenn Sie wissen, welches Objekt beschädigt ist, ist, @command{guix build --repair} zu benutzen (@pxref{Invoking guix build})." + +#. type: item +#: doc/guix.texi:2712 +#, no-wrap +msgid "--optimize" +msgstr "--optimize" + +#. type: table +#: doc/guix.texi:2716 +msgid "Optimize the store by hard-linking identical files---this is @dfn{deduplication}." +msgstr "Den Store durch Nutzung harter Verknüpfungen für identische Dateien optimieren — mit anderen Worten wird der Store @dfn{dedupliziert}." + +#. type: table +#: doc/guix.texi:2722 +msgid "The daemon performs deduplication after each successful build or archive import, unless it was started with @code{--disable-deduplication} (@pxref{Invoking guix-daemon, @code{--disable-deduplication}}). Thus, this option is primarily useful when the daemon was running with @code{--disable-deduplication}." +msgstr "Der Daemon führt Deduplizierung automatisch nach jeder erfolgreichen Erstellung und jedem Importieren eines Archivs durch, sofern er nicht mit @code{--disable-deduplication} (@pxref{Invoking guix-daemon, @code{--disable-deduplication}}) gestartet wurde. Diese Befehlszeilenoption brauchen Sie also in erster Linie dann, wenn der Daemon zuvor mit @code{--disable-deduplication} gestartet worden ist." + +#. type: section +#: doc/guix.texi:2726 +#, no-wrap +msgid "Invoking @command{guix pull}" +msgstr "@command{guix pull} aufrufen" + +#. type: cindex +#: doc/guix.texi:2728 +#, no-wrap +msgid "upgrading Guix" +msgstr "Aktualisieren von Guix" + +#. type: cindex +#: doc/guix.texi:2729 +#, no-wrap +msgid "updating Guix" +msgstr "Updaten von Guix" + +#. type: command{#1} +#: doc/guix.texi:2730 +#, no-wrap +msgid "guix pull" +msgstr "guix pull" + +#. type: cindex +#: doc/guix.texi:2731 +#, no-wrap +msgid "pull" +msgstr "pull" + +#. type: Plain text +#: doc/guix.texi:2738 +#, fuzzy +#| msgid "Packages are installed or upgraded to the latest version available in the distribution currently available on your local machine. To update that distribution, along with the Guix tools, you must run @command{guix pull}: the command downloads the latest Guix source code and package descriptions, and deploys it. Source code is downloaded from a @uref{https://git-scm.com, Git} repository, by default the official GNU@tie{}Guix repository, though this can be customized." +msgid "Packages are installed or upgraded to the latest version available in the distribution currently available on your local machine. To update that distribution, along with the Guix tools, you must run @command{guix pull}: the command downloads the latest Guix source code and package descriptions, and deploys it. Source code is downloaded from a @uref{https://git-scm.com, Git} repository." +msgstr "Nach der Installation oder Aktualisierung wird stets die neueste Version von Paketen verwendet, die in der aktuell installierten Distribution verfügbar ist. Um die Distribution und die Guix-Werkzeuge zu aktualisieren, führen Sie @command{guix pull} aus. Der Befehl lädt den neuesten Guix-Quellcode einschließlich Paketbeschreibungen herunter und installiert sie. Quellcode wird aus einem @uref{https://git-scm.com, Git}-Repository geladen, standardmäßig dem offiziellen Repository von GNU@tie{}Guix, was Sie aber auch ändern können." + +#. type: Plain text +#: doc/guix.texi:2744 +msgid "On completion, @command{guix package} will use packages and package versions from this just-retrieved copy of Guix. Not only that, but all the Guix commands and Scheme modules will also be taken from that latest version. New @command{guix} sub-commands added by the update also become available." +msgstr "Danach wird @command{guix package} Pakete und ihre Versionen entsprechend der gerade heruntergeladenen Kopie von Guix benutzen. Nicht nur das, auch alle Guix-Befehle und Scheme-Module werden aus der neuesten Version von Guix kommen. Neue @command{guix}-Unterbefehle, die durch die Aktualisierung hinzugekommen sind, werden also auch verfügbar." + +#. type: Plain text +#: doc/guix.texi:2750 +msgid "Any user can update their Guix copy using @command{guix pull}, and the effect is limited to the user who run @command{guix pull}. For instance, when user @code{root} runs @command{guix pull}, this has no effect on the version of Guix that user @code{alice} sees, and vice versa." +msgstr "Jeder Nutzer kann seine Kopie von Guix mittels @command{guix pull} aktualisieren, wodurch sich nur für den Nutzer etwas verändert, der @command{guix pull} ausgeführt hat. Wenn also zum Beispiel der Administratornutzer @code{root} den Befehl @command{guix pull} ausführt, hat das keine Auswirkungen, auf die für den Benutzer @code{alice} sichtbare Guix-Version, und umgekehrt." + +#. type: Plain text +#: doc/guix.texi:2756 +msgid "The result of running @command{guix pull} is a @dfn{profile} available under @file{~/.config/guix/current} containing the latest Guix. Thus, make sure to add it to the beginning of your search path so that you use the latest version, and similarly for the Info manual (@pxref{Documentation}):" +msgstr "Das Ergebnis von @command{guix pull} ist ein als @file{~/.config/guix/current} verfügbares @dfn{Profil} mit dem neuesten Guix. Stellen Sie sicher, dass es am Anfang Ihres Suchpfades steht, damit Sie auch wirklich das neueste Guix und sein Info-Handbuch sehen (@pxref{Documentation}):" + +#. type: example +#: doc/guix.texi:2760 +#, no-wrap +msgid "" +"export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n" +"export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n" +msgstr "" +"export PATH=\"$HOME/.config/guix/current/bin:$PATH\"\n" +"export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"\n" + +#. type: Plain text +#: doc/guix.texi:2764 +msgid "The @code{--list-generations} or @code{-l} option lists past generations produced by @command{guix pull}, along with details about their provenance:" +msgstr "Die Befehlszeilenoption @code{--list-generations} oder kurz @code{-l} listet ältere von @command{guix pull} erzeugte Generationen auf, zusammen mit Informationen zu deren Provenienz." + +#. type: example +#: doc/guix.texi:2772 +#, no-wrap +msgid "" +"$ guix pull -l\n" +"Generation 1\tJun 10 2018 00:18:18\n" +" guix 65956ad\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n" +"\n" +msgstr "" +"$ guix pull -l\n" +"Generation 1\tJun 10 2018 00:18:18\n" +" guix 65956ad\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n" +"\n" + +#. type: example +#: doc/guix.texi:2778 +#, fuzzy, no-wrap +#| msgid "" +#| "$ guix pull -l\n" +#| "Generation 1\tJun 10 2018 00:18:18\n" +#| " guix 65956ad\n" +#| " repository URL: https://git.savannah.gnu.org/git/guix.git\n" +#| " branch: origin/master\n" +#| " commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n" +#| "\n" +msgid "" +"Generation 2\tJun 11 2018 11:02:49\n" +" guix e0cc7f6\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n" +"\n" +msgstr "" +"$ guix pull -l\n" +"Generation 1\tJun 10 2018 00:18:18\n" +" guix 65956ad\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: 65956ad3526ba09e1f7a40722c96c6ef7c0936fe\n" +"\n" + +#. type: example +#: doc/guix.texi:2784 +#, fuzzy, no-wrap +#| msgid "" +#| "Generation 3\tJun 13 2018 23:31:07\t(current)\n" +#| " guix 844cc1c\n" +#| " repository URL: https://git.savannah.gnu.org/git/guix.git\n" +#| " branch: origin/master\n" +#| " commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n" +#| " 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{}\n" +#| " 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{}\n" +msgid "" +"Generation 3\tJun 13 2018 23:31:07\t(current)\n" +" guix 844cc1c\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n" +msgstr "" +"Generation 3\tJun 13 2018 23:31:07\t(current)\n" +" guix 844cc1c\n" +" repository URL: https://git.savannah.gnu.org/git/guix.git\n" +" branch: origin/master\n" +" commit: 844cc1c8f394f03b404c5bb3aee086922373490c\n" +" 28 new packages: emacs-helm-ls-git, emacs-helm-mu, @dots{}\n" +" 69 packages upgraded: borg@@1.1.6, cheese@@3.28.0, @dots{}\n" + +#. type: Plain text +#: doc/guix.texi:2790 +msgid "This @code{~/.config/guix/current} profile works like any other profile created by @command{guix package} (@pxref{Invoking guix package}). That is, you can list generations, roll back to the previous generation---i.e., the previous Guix---and so on:" +msgstr "Das Profil @code{~/.config/guix/current} verhält sich genau wie jedes andere Profil, das von @command{guix package} erzeugt wurde (@pxref{Invoking guix package}). Das bedeutet, Sie können seine Generationen auflisten und es auf die vorherige Generation — also das vorherige Guix — zurücksetzen und so weiter:" + +#. type: example +#: doc/guix.texi:2796 +#, no-wrap +msgid "" +"$ guix package -p ~/.config/guix/current --roll-back\n" +"switched from generation 3 to 2\n" +"$ guix package -p ~/.config/guix/current --delete-generations=1\n" +"deleting /home/charlie/.config/guix/current-1-link\n" +msgstr "" +"$ guix package -p ~/.config/guix/current --roll-back\n" +"switched from generation 3 to 2\n" +"$ guix package -p ~/.config/guix/current --delete-generations=1\n" +"deleting /home/charlie/.config/guix/current-1-link\n" + +#. type: Plain text +#: doc/guix.texi:2800 +msgid "The @command{guix pull} command is usually invoked with no arguments, but it supports the following options:" +msgstr "Der Befehl @command{guix pull} wird in der Regel ohne Befehlszeilenargumente aufgerufen, aber er versteht auch folgende Befehlszeilenoptionen:" + +#. type: table +#: doc/guix.texi:2804 +msgid "Produce verbose output, writing build logs to the standard error output." +msgstr "Ausführliche Informationen ausgeben und Erstellungsprotokolle auf der Standardfehlerausgabe ausgeben." + +#. type: item +#: doc/guix.texi:2805 +#, no-wrap +msgid "--url=@var{url}" +msgstr "--url=@var{URL}" + +#. type: table +#: doc/guix.texi:2807 +msgid "Download Guix from the Git repository at @var{url}." +msgstr "" + +#. type: vindex +#: doc/guix.texi:2808 +#, no-wrap +msgid "GUIX_PULL_URL" +msgstr "" + +#. type: table +#: doc/guix.texi:2812 +msgid "By default, the source is taken from its canonical Git repository at @code{gnu.org}, for the stable branch of Guix. To use a different source, set the @code{GUIX_PULL_URL} environment variable." +msgstr "" + +#. type: item +#: doc/guix.texi:2813 +#, no-wrap +msgid "--commit=@var{commit}" +msgstr "--commit=@var{Commit}" + +#. type: table +#: doc/guix.texi:2816 +#, fuzzy +#| msgid "Download code from the specified @var{url}, at the given @var{commit} (a valid Git commit ID represented as a hexadecimal string), or @var{branch}." +msgid "Deploy @var{commit}, a valid Git commit ID represented as a hexadecimal string." +msgstr "Code wird von der angegebenen @var{URL} für den angegebenen @var{Commit} (eine gültige Commit-ID, dargestellt als hexadezimale Zeichenkette) oder @var{Branch} heruntergeladen." + +#. type: item +#: doc/guix.texi:2817 +#, no-wrap +msgid "--branch=@var{branch}" +msgstr "--branch=@var{Branch}" + +#. type: table +#: doc/guix.texi:2820 +msgid "Deploy the tip of @var{branch}, the name of a Git branch available on the repository at @var{url}." +msgstr "" + +#. type: table +#: doc/guix.texi:2827 +msgid "List all the generations of @file{~/.config/guix/current} or, if @var{pattern} is provided, the subset of generations that match @var{pattern}. The syntax of @var{pattern} is the same as with @code{guix package --list-generations} (@pxref{Invoking guix package})." +msgstr "" + +#. type: table +#: doc/guix.texi:2831 +msgid "Use the bootstrap Guile to build the latest Guix. This option is only useful to Guix developers." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2835 +msgid "In addition, @command{guix pull} supports all the common build options (@pxref{Common Build Options})." +msgstr "" + +#. type: section +#: doc/guix.texi:2837 +#, no-wrap +msgid "Invoking @command{guix pack}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2843 +msgid "Occasionally you want to pass software to people who are not (yet!) lucky enough to be using Guix. You'd tell them to run @command{guix package -i @var{something}}, but that's not possible in this case. This is where @command{guix pack} comes in." +msgstr "" + +#. type: quotation +#: doc/guix.texi:2848 +msgid "If you are looking for ways to exchange binaries among machines that already run Guix, @pxref{Invoking guix copy}, @ref{Invoking guix publish}, and @ref{Invoking guix archive}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:2850 +#, no-wrap +msgid "pack" +msgstr "" + +#. type: cindex +#: doc/guix.texi:2851 +#, no-wrap +msgid "bundle" +msgstr "" + +#. type: cindex +#: doc/guix.texi:2852 +#, no-wrap +msgid "application bundle" +msgstr "" + +#. type: cindex +#: doc/guix.texi:2853 +#, no-wrap +msgid "software bundle" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2862 +msgid "The @command{guix pack} command creates a shrink-wrapped @dfn{pack} or @dfn{software bundle}: it creates a tarball or some other archive containing the binaries of the software you're interested in, and all its dependencies. The resulting archive can be used on any machine that does not have Guix, and people can run the exact same binaries as those you have with Guix. The pack itself is created in a bit-reproducible fashion, so anyone can verify that it really contains the build results that you pretend to be shipping." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2865 +msgid "For example, to create a bundle containing Guile, Emacs, Geiser, and all their dependencies, you can run:" +msgstr "" + +#. type: example +#: doc/guix.texi:2870 +#, no-wrap +msgid "" +"$ guix pack guile emacs geiser\n" +"@dots{}\n" +"/gnu/store/@dots{}-pack.tar.gz\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2878 +msgid "The result here is a tarball containing a @file{/gnu/store} directory with all the relevant packages. The resulting tarball contains a @dfn{profile} with the three packages of interest; the profile is the same as would be created by @command{guix package -i}. It is this mechanism that is used to create Guix's own standalone binary tarball (@pxref{Binary Installation})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2883 +msgid "Users of this pack would have to run @file{/gnu/store/@dots{}-profile/bin/guile} to run Guile, which you may find inconvenient. To work around it, you can create, say, a @file{/opt/gnu/bin} symlink to the profile:" +msgstr "" + +#. type: example +#: doc/guix.texi:2886 +#, no-wrap +msgid "guix pack -S /opt/gnu/bin=bin guile emacs geiser\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2890 +msgid "That way, users can happily type @file{/opt/gnu/bin/guile} and enjoy." +msgstr "" + +#. type: cindex +#: doc/guix.texi:2891 +#, no-wrap +msgid "relocatable binaries, with @command{guix pack}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2899 +msgid "What if the recipient of your pack does not have root privileges on their machine, and thus cannot unpack it in the root file system? In that case, you will want to use the @code{--relocatable} option (see below). This option produces @dfn{relocatable binaries}, meaning they they can be placed anywhere in the file system hierarchy: in the example above, users can unpack your tarball in their home directory and directly run @file{./opt/gnu/bin/guile}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:2900 +#, no-wrap +msgid "Docker, build an image with guix pack" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2903 +msgid "Alternatively, you can produce a pack in the Docker image format using the following command:" +msgstr "" + +#. type: example +#: doc/guix.texi:2906 +#, no-wrap +msgid "guix pack -f docker guile emacs geiser\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2913 +msgid "The result is a tarball that can be passed to the @command{docker load} command. See the @uref{https://docs.docker.com/engine/reference/commandline/load/, Docker documentation} for more information." +msgstr "" + +#. type: cindex +#: doc/guix.texi:2914 +#, no-wrap +msgid "Singularity, build an image with guix pack" +msgstr "" + +#. type: cindex +#: doc/guix.texi:2915 +#, no-wrap +msgid "SquashFS, build an image with guix pack" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2918 +msgid "Yet another option is to produce a SquashFS image with the following command:" +msgstr "" + +#. type: example +#: doc/guix.texi:2921 +#, no-wrap +msgid "guix pack -f squashfs guile emacs geiser\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2929 +msgid "The result is a SquashFS file system image that can either be mounted or directly be used as a file system container image with the @uref{http://singularity.lbl.gov, Singularity container execution environment}, using commands like @command{singularity shell} or @command{singularity exec}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:2931 +msgid "Several command-line options allow you to customize your pack:" +msgstr "" + +#. type: item +#: doc/guix.texi:2933 +#, no-wrap +msgid "--format=@var{format}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:2934 +#, no-wrap +msgid "-f @var{format}" +msgstr "" + +#. type: table +#: doc/guix.texi:2936 +msgid "Produce a pack in the given @var{format}." +msgstr "" + +#. type: table +#: doc/guix.texi:2938 +msgid "The available formats are:" +msgstr "" + +#. type: item +#: doc/guix.texi:2940 +#, no-wrap +msgid "tarball" +msgstr "" + +#. type: table +#: doc/guix.texi:2943 +msgid "This is the default format. It produces a tarball containing all the specified binaries and symlinks." +msgstr "" + +#. type: item +#: doc/guix.texi:2944 +#, no-wrap +msgid "docker" +msgstr "" + +#. type: table +#: doc/guix.texi:2948 +msgid "This produces a tarball that follows the @uref{https://github.com/docker/docker/blob/master/image/spec/v1.2.md, Docker Image Specification}." +msgstr "" + +#. type: item +#: doc/guix.texi:2949 +#, no-wrap +msgid "squashfs" +msgstr "" + +#. type: table +#: doc/guix.texi:2953 +msgid "This produces a SquashFS image containing all the specified binaries and symlinks, as well as empty mount points for virtual file systems like procfs." +msgstr "" + +#. type: item +#: doc/guix.texi:2955 +#, no-wrap +msgid "--relocatable" +msgstr "" + +#. type: table +#: doc/guix.texi:2960 +msgid "Produce @dfn{relocatable binaries}---i.e., binaries that can be placed anywhere in the file system hierarchy and run from there. For example, if you create a pack containing Bash with:" +msgstr "" + +#. type: example +#: doc/guix.texi:2963 +#, no-wrap +msgid "guix pack -R -S /mybin=bin bash\n" +msgstr "" + +#. type: table +#: doc/guix.texi:2968 +msgid "... you can copy that pack to a machine that lacks Guix, and from your home directory as a normal user, run:" +msgstr "" + +#. type: example +#: doc/guix.texi:2972 +#, no-wrap +msgid "" +"tar xf pack.tar.gz\n" +"./mybin/sh\n" +msgstr "" + +#. type: table +#: doc/guix.texi:2980 +msgid "In that shell, if you type @code{ls /gnu/store}, you'll notice that @file{/gnu/store} shows up and contains all the dependencies of @code{bash}, even though the machine actually lacks @file{/gnu/store} altogether! That is probably the simplest way to deploy Guix-built software on a non-Guix machine." +msgstr "" + +#. type: table +#: doc/guix.texi:2987 +msgid "There's a gotcha though: this technique relies on the @dfn{user namespace} feature of the kernel Linux, which allows unprivileged users to mount or change root. Old versions of Linux did not support it, and some GNU/Linux distributions turn it off; on these systems, programs from the pack @emph{will fail to run}, unless they are unpacked in the root file system." +msgstr "" + +#. type: item +#: doc/guix.texi:2988 doc/guix.texi:5882 doc/guix.texi:6720 doc/guix.texi:7307 +#: doc/guix.texi:7457 doc/guix.texi:21068 +#, no-wrap +msgid "--expression=@var{expr}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:2989 doc/guix.texi:5883 doc/guix.texi:6721 doc/guix.texi:7308 +#: doc/guix.texi:7458 doc/guix.texi:21069 +#, no-wrap +msgid "-e @var{expr}" +msgstr "" + +#. type: table +#: doc/guix.texi:2991 doc/guix.texi:6723 doc/guix.texi:7310 +msgid "Consider the package @var{expr} evaluates to." +msgstr "" + +#. type: table +#: doc/guix.texi:2995 +msgid "This has the same purpose as the same-named option in @command{guix build} (@pxref{Additional Build Options, @code{--expression} in @command{guix build}})." +msgstr "" + +#. type: table +#: doc/guix.texi:3000 +msgid "Use the packages contained in the manifest object returned by the Scheme code in @var{file}." +msgstr "" + +#. type: table +#: doc/guix.texi:3008 +msgid "This has a similar purpose as the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files. It allows you to define a collection of packages once and use it both for creating profiles and for creating archives for use on machines that do not have Guix installed. Note that you can specify @emph{either} a manifest file @emph{or} a list of packages, but not both." +msgstr "" + +#. type: itemx +#: doc/guix.texi:3010 doc/guix.texi:5955 doc/guix.texi:7135 doc/guix.texi:7543 +#: doc/guix.texi:8177 doc/guix.texi:21077 +#, no-wrap +msgid "-s @var{system}" +msgstr "" + +#. type: table +#: doc/guix.texi:3013 doc/guix.texi:5958 +msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}---instead of the system type of the build host." +msgstr "" + +#. type: item +#: doc/guix.texi:3014 doc/guix.texi:5986 +#, no-wrap +msgid "--target=@var{triplet}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3015 doc/guix.texi:3441 doc/guix.texi:5987 +#, no-wrap +msgid "cross-compilation" +msgstr "" + +#. type: table +#: doc/guix.texi:3019 doc/guix.texi:5991 +msgid "Cross-build for @var{triplet}, which must be a valid GNU triplet, such as @code{\"mips64el-linux-gnu\"} (@pxref{Specifying target triplets, GNU configuration triplets,, autoconf, Autoconf})." +msgstr "" + +#. type: item +#: doc/guix.texi:3020 +#, no-wrap +msgid "--compression=@var{tool}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3021 +#, no-wrap +msgid "-C @var{tool}" +msgstr "" + +#. type: table +#: doc/guix.texi:3024 +msgid "Compress the resulting tarball using @var{tool}---one of @code{gzip}, @code{bzip2}, @code{xz}, @code{lzip}, or @code{none} for no compression." +msgstr "" + +#. type: item +#: doc/guix.texi:3025 +#, no-wrap +msgid "--symlink=@var{spec}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3026 +#, no-wrap +msgid "-S @var{spec}" +msgstr "" + +#. type: table +#: doc/guix.texi:3029 +msgid "Add the symlinks specified by @var{spec} to the pack. This option can appear several times." +msgstr "" + +#. type: table +#: doc/guix.texi:3033 +msgid "@var{spec} has the form @code{@var{source}=@var{target}}, where @var{source} is the symlink that will be created and @var{target} is the symlink target." +msgstr "" + +#. type: table +#: doc/guix.texi:3036 +msgid "For instance, @code{-S /opt/gnu/bin=bin} creates a @file{/opt/gnu/bin} symlink pointing to the @file{bin} sub-directory of the profile." +msgstr "" + +#. type: item +#: doc/guix.texi:3037 +#, no-wrap +msgid "--localstatedir" +msgstr "" + +#. type: table +#: doc/guix.texi:3040 +msgid "Include the ``local state directory'', @file{/var/guix}, in the resulting pack." +msgstr "" + +#. type: table +#: doc/guix.texi:3046 +msgid "@file{/var/guix} contains the store database (@pxref{The Store}) as well as garbage-collector roots (@pxref{Invoking guix gc}). Providing it in the pack means that the store is ``complete'' and manageable by Guix; not providing it pack means that the store is ``dead'': items cannot be added to it or removed from it after extraction of the pack." +msgstr "" + +#. type: table +#: doc/guix.texi:3049 +msgid "One use case for this is the Guix self-contained binary tarball (@pxref{Binary Installation})." +msgstr "" + +#. type: table +#: doc/guix.texi:3053 +msgid "Use the bootstrap binaries to build the pack. This option is only useful to Guix developers." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3058 +msgid "In addition, @command{guix pack} supports all the common build options (@pxref{Common Build Options}) and all the package transformation options (@pxref{Package Transformation Options})." +msgstr "" + +#. type: section +#: doc/guix.texi:3061 +#, no-wrap +msgid "Invoking @command{guix archive}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:3063 +#, no-wrap +msgid "guix archive" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3064 +#, no-wrap +msgid "archive" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3070 +msgid "The @command{guix archive} command allows users to @dfn{export} files from the store into a single archive, and to later @dfn{import} them on a machine that runs Guix. In particular, it allows store files to be transferred from one machine to the store on another machine." +msgstr "" + +#. type: quotation +#: doc/guix.texi:3074 +msgid "If you're looking for a way to produce archives in a format suitable for tools other than Guix, @pxref{Invoking guix pack}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3076 +#, no-wrap +msgid "exporting store items" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3078 +msgid "To export store files as an archive to standard output, run:" +msgstr "" + +#. type: example +#: doc/guix.texi:3081 +#, no-wrap +msgid "guix archive --export @var{options} @var{specifications}...\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3088 +msgid "@var{specifications} may be either store file names or package specifications, as for @command{guix package} (@pxref{Invoking guix package}). For instance, the following command creates an archive containing the @code{gui} output of the @code{git} package and the main output of @code{emacs}:" +msgstr "" + +#. type: example +#: doc/guix.texi:3091 +#, no-wrap +msgid "guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3096 +msgid "If the specified packages are not built yet, @command{guix archive} automatically builds them. The build process may be controlled with the common build options (@pxref{Common Build Options})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3099 +msgid "To transfer the @code{emacs} package to a machine connected over SSH, one would run:" +msgstr "" + +#. type: example +#: doc/guix.texi:3102 +#, no-wrap +msgid "guix archive --export -r emacs | ssh the-machine guix archive --import\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3107 +msgid "Similarly, a complete user profile may be transferred from one machine to another like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:3111 +#, no-wrap +msgid "" +"guix archive --export -r $(readlink -f ~/.guix-profile) | \\\n" +" ssh the-machine guix-archive --import\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3121 +msgid "However, note that, in both examples, all of @code{emacs} and the profile as well as all of their dependencies are transferred (due to @code{-r}), regardless of what is already available in the store on the target machine. The @code{--missing} option can help figure out which items are missing from the target store. The @command{guix copy} command simplifies and optimizes this whole process, so this is probably what you should use in this case (@pxref{Invoking guix copy})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3122 +#, no-wrap +msgid "nar, archive format" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3123 +#, no-wrap +msgid "normalized archive (nar)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3133 +msgid "Archives are stored in the ``normalized archive'' or ``nar'' format, which is comparable in spirit to `tar', but with differences that make it more appropriate for our purposes. First, rather than recording all Unix metadata for each file, the nar format only mentions the file type (regular, directory, or symbolic link); Unix permissions and owner/group are dismissed. Second, the order in which directory entries are stored always follows the order of file names according to the C locale collation order. This makes archive production fully deterministic." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3139 +msgid "When exporting, the daemon digitally signs the contents of the archive, and that digital signature is appended. When importing, the daemon verifies the signature and rejects the import in case of an invalid signature or if the signing key is not authorized." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3141 +msgid "The main options are:" +msgstr "" + +#. type: item +#: doc/guix.texi:3143 +#, no-wrap +msgid "--export" +msgstr "" + +#. type: table +#: doc/guix.texi:3146 +msgid "Export the specified store files or packages (see below.) Write the resulting archive to the standard output." +msgstr "" + +#. type: table +#: doc/guix.texi:3149 +msgid "Dependencies are @emph{not} included in the output, unless @code{--recursive} is passed." +msgstr "" + +#. type: itemx +#: doc/guix.texi:3150 doc/guix.texi:6258 doc/guix.texi:6644 +#, no-wrap +msgid "-r" +msgstr "" + +#. type: item +#: doc/guix.texi:3151 doc/guix.texi:6257 doc/guix.texi:6643 +#, no-wrap +msgid "--recursive" +msgstr "" + +#. type: table +#: doc/guix.texi:3156 +msgid "When combined with @code{--export}, this instructs @command{guix archive} to include dependencies of the given items in the archive. Thus, the resulting archive is self-contained: it contains the closure of the exported store items." +msgstr "" + +#. type: item +#: doc/guix.texi:3157 +#, no-wrap +msgid "--import" +msgstr "" + +#. type: table +#: doc/guix.texi:3162 +msgid "Read an archive from the standard input, and import the files listed therein into the store. Abort if the archive has an invalid digital signature, or if it is signed by a public key not among the authorized keys (see @code{--authorize} below.)" +msgstr "" + +#. type: item +#: doc/guix.texi:3163 +#, no-wrap +msgid "--missing" +msgstr "" + +#. type: table +#: doc/guix.texi:3167 +msgid "Read a list of store file names from the standard input, one per line, and write on the standard output the subset of these files missing from the store." +msgstr "" + +#. type: item +#: doc/guix.texi:3168 +#, no-wrap +msgid "--generate-key[=@var{parameters}]" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3169 +#, no-wrap +msgid "signing, archives" +msgstr "" + +#. type: table +#: doc/guix.texi:3174 +msgid "Generate a new key pair for the daemon. This is a prerequisite before archives can be exported with @code{--export}. Note that this operation usually takes time, because it needs to gather enough entropy to generate the key pair." +msgstr "" + +#. type: table +#: doc/guix.texi:3184 +msgid "The generated key pair is typically stored under @file{/etc/guix}, in @file{signing-key.pub} (public key) and @file{signing-key.sec} (private key, which must be kept secret.) When @var{parameters} is omitted, an ECDSA key using the Ed25519 curve is generated, or, for Libgcrypt versions before 1.6.0, it is a 4096-bit RSA key. Alternatively, @var{parameters} can specify @code{genkey} parameters suitable for Libgcrypt (@pxref{General public-key related Functions, @code{gcry_pk_genkey},, gcrypt, The Libgcrypt Reference Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:3185 +#, no-wrap +msgid "--authorize" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3186 +#, no-wrap +msgid "authorizing, archives" +msgstr "" + +#. type: table +#: doc/guix.texi:3190 +msgid "Authorize imports signed by the public key passed on standard input. The public key must be in ``s-expression advanced format''---i.e., the same format as the @file{signing-key.pub} file." +msgstr "" + +#. type: table +#: doc/guix.texi:3197 +msgid "The list of authorized keys is kept in the human-editable file @file{/etc/guix/acl}. The file contains @url{http://people.csail.mit.edu/rivest/Sexp.txt, ``advanced-format s-expressions''} and is structured as an access-control list in the @url{http://theworld.com/~cme/spki.txt, Simple Public-Key Infrastructure (SPKI)}." +msgstr "" + +#. type: item +#: doc/guix.texi:3198 +#, no-wrap +msgid "--extract=@var{directory}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3199 +#, no-wrap +msgid "-x @var{directory}" +msgstr "" + +#. type: table +#: doc/guix.texi:3203 +msgid "Read a single-item archive as served by substitute servers (@pxref{Substitutes}) and extract it to @var{directory}. This is a low-level operation needed in only very narrow use cases; see below." +msgstr "" + +#. type: table +#: doc/guix.texi:3206 +msgid "For example, the following command extracts the substitute for Emacs served by @code{hydra.gnu.org} to @file{/tmp/emacs}:" +msgstr "" + +#. type: example +#: doc/guix.texi:3211 +#, no-wrap +msgid "" +"$ wget -O - \\\n" +" https://hydra.gnu.org/nar/@dots{}-emacs-24.5 \\\n" +" | bunzip2 | guix archive -x /tmp/emacs\n" +msgstr "" + +#. type: table +#: doc/guix.texi:3218 +msgid "Single-item archives are different from multiple-item archives produced by @command{guix archive --export}; they contain a single store item, and they do @emph{not} embed a signature. Thus this operation does @emph{no} signature verification and its output should be considered unsafe." +msgstr "" + +#. type: table +#: doc/guix.texi:3221 +msgid "The primary purpose of this operation is to facilitate inspection of archive contents coming from possibly untrusted substitute servers." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3234 +msgid "GNU Guix provides several Scheme programming interfaces (APIs) to define, build, and query packages. The first interface allows users to write high-level package definitions. These definitions refer to familiar packaging concepts, such as the name and version of a package, its build system, and its dependencies. These definitions can then be turned into concrete build actions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3240 +msgid "Build actions are performed by the Guix daemon, on behalf of users. In a standard setup, the daemon has write access to the store---the @file{/gnu/store} directory---whereas users do not. The recommended setup also has the daemon perform builds in chroots, under a specific build users, to minimize interference with the rest of the system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3249 +msgid "Lower-level APIs are available to interact with the daemon and the store. To instruct the daemon to perform a build action, users actually provide it with a @dfn{derivation}. A derivation is a low-level representation of the build actions to be taken, and the environment in which they should occur---derivations are to package definitions what assembly is to C programs. The term ``derivation'' comes from the fact that build results @emph{derive} from them." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3252 +msgid "This chapter describes all these APIs in turn, starting from high-level package definitions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3269 +msgid "The high-level interface to package definitions is implemented in the @code{(guix packages)} and @code{(guix build-system)} modules. As an example, the package definition, or @dfn{recipe}, for the GNU Hello package looks like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:3277 +#, no-wrap +msgid "" +"(define-module (gnu packages hello)\n" +" #:use-module (guix packages)\n" +" #:use-module (guix download)\n" +" #:use-module (guix build-system gnu)\n" +" #:use-module (guix licenses)\n" +" #:use-module (gnu packages gawk))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:3296 +#, no-wrap +msgid "" +"(define-public hello\n" +" (package\n" +" (name \"hello\")\n" +" (version \"2.10\")\n" +" (source (origin\n" +" (method url-fetch)\n" +" (uri (string-append \"mirror://gnu/hello/hello-\" version\n" +" \".tar.gz\"))\n" +" (sha256\n" +" (base32\n" +" \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"))))\n" +" (build-system gnu-build-system)\n" +" (arguments '(#:configure-flags '(\"--enable-silent-rules\")))\n" +" (inputs `((\"gawk\" ,gawk)))\n" +" (synopsis \"Hello, GNU world: An example GNU package\")\n" +" (description \"Guess what GNU Hello prints!\")\n" +" (home-page \"http://www.gnu.org/software/hello/\")\n" +" (license gpl3+)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3306 +msgid "Without being a Scheme expert, the reader may have guessed the meaning of the various fields here. This expression binds the variable @code{hello} to a @code{<package>} object, which is essentially a record (@pxref{SRFI-9, Scheme records,, guile, GNU Guile Reference Manual}). This package object can be inspected using procedures found in the @code{(guix packages)} module; for instance, @code{(package-name hello)} returns---surprise!---@code{\"hello\"}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3310 +msgid "With luck, you may be able to import part or all of the definition of the package you are interested in from another repository, using the @code{guix import} command (@pxref{Invoking guix import})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3316 +msgid "In the example above, @var{hello} is defined in a module of its own, @code{(gnu packages hello)}. Technically, this is not strictly necessary, but it is convenient to do so: all the packages defined in modules under @code{(gnu packages @dots{})} are automatically known to the command-line tools (@pxref{Package Modules})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3318 +msgid "There are a few points worth noting in the above package definition:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:3325 +msgid "The @code{source} field of the package is an @code{<origin>} object (@pxref{origin Reference}, for the complete reference). Here, the @code{url-fetch} method from @code{(guix download)} is used, meaning that the source is a file to be downloaded over FTP or HTTP." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3328 +msgid "The @code{mirror://gnu} prefix instructs @code{url-fetch} to use one of the GNU mirrors defined in @code{(guix download)}." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3335 +msgid "The @code{sha256} field specifies the expected SHA256 hash of the file being downloaded. It is mandatory, and allows Guix to check the integrity of the file. The @code{(base32 @dots{})} form introduces the base32 representation of the hash. You can obtain this information with @code{guix download} (@pxref{Invoking guix download}) and @code{guix hash} (@pxref{Invoking guix hash})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3336 +#, no-wrap +msgid "patches" +msgstr "" + +#. type: itemize +#: doc/guix.texi:3340 +msgid "When needed, the @code{origin} form can also have a @code{patches} field listing patches to be applied, and a @code{snippet} field giving a Scheme expression to modify the source code." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3342 +#, no-wrap +msgid "GNU Build System" +msgstr "GNU-Erstellungssystem" + +#. type: itemize +#: doc/guix.texi:3348 +msgid "The @code{build-system} field specifies the procedure to build the package (@pxref{Build Systems}). Here, @var{gnu-build-system} represents the familiar GNU Build System, where packages may be configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3354 +msgid "The @code{arguments} field specifies options for the build system (@pxref{Build Systems}). Here it is interpreted by @var{gnu-build-system} as a request run @file{configure} with the @code{--enable-silent-rules} flag." +msgstr "" + +#. type: findex +#: doc/guix.texi:3355 doc/guix.texi:3358 +#, no-wrap +msgid "quote" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3356 +#, no-wrap +msgid "quoting" +msgstr "" + +#. type: findex +#: doc/guix.texi:3357 +#, no-wrap +msgid "'" +msgstr "" + +#. type: itemize +#: doc/guix.texi:3366 +msgid "What about these quote (@code{'}) characters? They are Scheme syntax to introduce a literal list; @code{'} is synonymous with @code{quote}. @xref{Expression Syntax, quoting,, guile, GNU Guile Reference Manual}, for details. Here the value of the @code{arguments} field is a list of arguments passed to the build system down the road, as with @code{apply} (@pxref{Fly Evaluation, @code{apply},, guile, GNU Guile Reference Manual})." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3372 +msgid "The hash-colon (@code{#:}) sequence defines a Scheme @dfn{keyword} (@pxref{Keywords,,, guile, GNU Guile Reference Manual}), and @code{#:configure-flags} is a keyword used to pass a keyword argument to the build system (@pxref{Coding With Keywords,,, guile, GNU Guile Reference Manual})." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3378 +msgid "The @code{inputs} field specifies inputs to the build process---i.e., build-time or run-time dependencies of the package. Here, we define an input called @code{\"gawk\"} whose value is that of the @var{gawk} variable; @var{gawk} is itself bound to a @code{<package>} object." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3379 +#, no-wrap +msgid "backquote (quasiquote)" +msgstr "" + +#. type: findex +#: doc/guix.texi:3380 +#, no-wrap +msgid "`" +msgstr "" + +#. type: findex +#: doc/guix.texi:3381 +#, no-wrap +msgid "quasiquote" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3382 +#, no-wrap +msgid "comma (unquote)" +msgstr "" + +#. type: findex +#: doc/guix.texi:3383 +#, no-wrap +msgid "," +msgstr "" + +#. type: findex +#: doc/guix.texi:3384 +#, no-wrap +msgid "unquote" +msgstr "" + +#. type: findex +#: doc/guix.texi:3385 +#, no-wrap +msgid ",@@" +msgstr "" + +#. type: findex +#: doc/guix.texi:3386 +#, no-wrap +msgid "unquote-splicing" +msgstr "" + +#. type: itemize +#: doc/guix.texi:3392 +msgid "Again, @code{`} (a backquote, synonymous with @code{quasiquote}) allows us to introduce a literal list in the @code{inputs} field, while @code{,} (a comma, synonymous with @code{unquote}) allows us to insert a value in that list (@pxref{Expression Syntax, unquote,, guile, GNU Guile Reference Manual})." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3396 +msgid "Note that GCC, Coreutils, Bash, and other essential tools do not need to be specified as inputs here. Instead, @var{gnu-build-system} takes care of ensuring that they are present (@pxref{Build Systems})." +msgstr "" + +#. type: itemize +#: doc/guix.texi:3400 +msgid "However, any other dependencies need to be specified in the @code{inputs} field. Any dependency not specified here will simply be unavailable to the build process, possibly leading to a build failure." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3403 +msgid "@xref{package Reference}, for a full description of possible fields." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3414 +msgid "Once a package definition is in place, the package may actually be built using the @code{guix build} command-line tool (@pxref{Invoking guix build}), troubleshooting any build failures you encounter (@pxref{Debugging Build Failures}). You can easily jump back to the package definition using the @command{guix edit} command (@pxref{Invoking guix edit}). @xref{Packaging Guidelines}, for more information on how to test package definitions, and @ref{Invoking guix lint}, for information on how to check a definition for style conformance." +msgstr "" + +#. type: vindex +#: doc/guix.texi:3414 +#, no-wrap +msgid "GUIX_PACKAGE_PATH" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3418 +msgid "Lastly, @pxref{Package Modules}, for information on how to extend the distribution by adding your own package definitions to @code{GUIX_PACKAGE_PATH}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3422 +msgid "Finally, updating the package definition to a new upstream version can be partly automated by the @command{guix refresh} command (@pxref{Invoking guix refresh})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3428 +msgid "Behind the scenes, a derivation corresponding to the @code{<package>} object is first computed by the @code{package-derivation} procedure. That derivation is stored in a @code{.drv} file under @file{/gnu/store}. The build actions it prescribes may then be realized by using the @code{build-derivations} procedure (@pxref{The Store})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:3429 +#, no-wrap +msgid "{Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3432 +msgid "Return the @code{<derivation>} object of @var{package} for @var{system} (@pxref{Derivations})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:3438 +msgid "@var{package} must be a valid @code{<package>} object, and @var{system} must be a string denoting the target system type---e.g., @code{\"x86_64-linux\"} for an x86_64 Linux-based GNU system. @var{store} must be a connection to the daemon, which operates on the store (@pxref{The Store})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3444 +msgid "Similarly, it is possible to compute a derivation that cross-builds a package for some other system:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3445 +#, no-wrap +msgid "{Scheme Procedure} package-cross-derivation @var{store} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3449 +msgid "@var{package} @var{target} [@var{system}] Return the @code{<derivation>} object of @var{package} cross-built from @var{system} to @var{target}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:3454 +msgid "@var{target} must be a valid GNU triplet denoting the target hardware and operating system, such as @code{\"mips64el-linux-gnu\"} (@pxref{Configuration Names, GNU configuration triplets,, configure, GNU Configure and Build System})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3456 +#, no-wrap +msgid "package transformations" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3457 +#, no-wrap +msgid "input rewriting" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3458 +#, no-wrap +msgid "dependency tree rewriting" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3462 +msgid "Packages can be manipulated in arbitrary ways. An example of a useful transformation is @dfn{input rewriting}, whereby the dependency tree of a package is rewritten by replacing specific inputs by others:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3463 +#, no-wrap +msgid "{Scheme Procedure} package-input-rewriting @var{replacements} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3470 +msgid "[@var{rewrite-name}] Return a procedure that, when passed a package, replaces its direct and indirect dependencies (but not its implicit inputs) according to @var{replacements}. @var{replacements} is a list of package pairs; the first element of each pair is the package to replace, and the second one is the replacement." +msgstr "" + +#. type: deffn +#: doc/guix.texi:3473 +msgid "Optionally, @var{rewrite-name} is a one-argument procedure that takes the name of a package and returns its new name after rewrite." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3477 +msgid "Consider this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:3483 +#, no-wrap +msgid "" +"(define libressl-instead-of-openssl\n" +" ;; This is a procedure to replace OPENSSL by LIBRESSL,\n" +" ;; recursively.\n" +" (package-input-rewriting `((,openssl . ,libressl))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:3486 +#, no-wrap +msgid "" +"(define git-with-libressl\n" +" (libressl-instead-of-openssl git))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3494 +msgid "Here we first define a rewriting procedure that replaces @var{openssl} with @var{libressl}. Then we use it to define a @dfn{variant} of the @var{git} package that uses @var{libressl} instead of @var{openssl}. This is exactly what the @option{--with-input} command-line option does (@pxref{Package Transformation Options, @option{--with-input}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3498 +msgid "A more generic procedure to rewrite a package dependency graph is @code{package-mapping}: it supports arbitrary changes to nodes in the graph." +msgstr "" + +#. type: deffn +#: doc/guix.texi:3499 +#, no-wrap +msgid "{Scheme Procedure} package-mapping @var{proc} [@var{cut?}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:3503 +msgid "Return a procedure that, given a package, applies @var{proc} to all the packages depended on and returns the resulting package. The procedure stops recursion when @var{cut?} returns true for a given package." +msgstr "" + +#. type: subsection +#: doc/guix.texi:3512 +#, no-wrap +msgid "@code{package} Reference" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3516 +msgid "This section summarizes all the options available in @code{package} declarations (@pxref{Defining Packages})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:3517 +#, no-wrap +msgid "{Data Type} package" +msgstr "" + +#. type: deftp +#: doc/guix.texi:3519 +msgid "This is the data type representing a package recipe." +msgstr "" + +#. type: table +#: doc/guix.texi:3523 +msgid "The name of the package, as a string." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3524 +#, no-wrap +msgid "version" +msgstr "" + +#. type: table +#: doc/guix.texi:3526 +msgid "The version of the package, as a string." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3527 doc/guix.texi:6927 doc/guix.texi:9509 doc/guix.texi:9797 +#, no-wrap +msgid "source" +msgstr "" + +#. type: table +#: doc/guix.texi:3534 +msgid "An object telling how the source code for the package should be acquired. Most of the time, this is an @code{origin} object, which denotes a file fetched from the Internet (@pxref{origin Reference}). It can also be any other ``file-like'' object such as a @code{local-file}, which denotes a file from the local file system (@pxref{G-Expressions, @code{local-file}})." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3535 +#, no-wrap +msgid "build-system" +msgstr "" + +#. type: table +#: doc/guix.texi:3538 +msgid "The build system that should be used to build the package (@pxref{Build Systems})." +msgstr "" + +#. type: item +#: doc/guix.texi:3539 doc/guix.texi:11285 +#, no-wrap +msgid "@code{arguments} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:3542 +msgid "The arguments that should be passed to the build system. This is a list, typically containing sequential keyword-value pairs." +msgstr "" + +#. type: item +#: doc/guix.texi:3543 +#, no-wrap +msgid "@code{inputs} (default: @code{'()})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3544 +#, no-wrap +msgid "@code{native-inputs} (default: @code{'()})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3545 +#, no-wrap +msgid "@code{propagated-inputs} (default: @code{'()})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3546 +#, no-wrap +msgid "inputs, of packages" +msgstr "" + +#. type: table +#: doc/guix.texi:3554 +msgid "These fields list dependencies of the package. Each one is a list of tuples, where each tuple has a label for the input (a string) as its first element, a package, origin, or derivation as its second element, and optionally the name of the output thereof that should be used, which defaults to @code{\"out\"} (@pxref{Packages with Multiple Outputs}, for more on package outputs). For example, the list below specifies three inputs:" +msgstr "" + +#. type: example +#: doc/guix.texi:3559 +#, no-wrap +msgid "" +"`((\"libffi\" ,libffi)\n" +" (\"libunistring\" ,libunistring)\n" +" (\"glib:bin\" ,glib \"bin\")) ;the \"bin\" output of Glib\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3561 +#, no-wrap +msgid "cross compilation, package dependencies" +msgstr "" + +#. type: table +#: doc/guix.texi:3567 +msgid "The distinction between @code{native-inputs} and @code{inputs} is necessary when considering cross-compilation. When cross-compiling, dependencies listed in @code{inputs} are built for the @emph{target} architecture; conversely, dependencies listed in @code{native-inputs} are built for the architecture of the @emph{build} machine." +msgstr "" + +#. type: table +#: doc/guix.texi:3572 +msgid "@code{native-inputs} is typically used to list tools needed at build time, but not at run time, such as Autoconf, Automake, pkg-config, Gettext, or Bison. @command{guix lint} can report likely mistakes in this area (@pxref{Invoking guix lint})." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:3579 +msgid "package-propagated-inputs" +msgstr "" + +#. type: table +#: doc/guix.texi:3579 +msgid "Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the specified packages will be automatically installed alongside the package they belong to (@pxref{package-cmd-propagated-inputs, @command{guix package}}, for information on how @command{guix package} deals with propagated inputs.)" +msgstr "" + +#. type: table +#: doc/guix.texi:3583 +msgid "For example this is necessary when a C/C++ library needs headers of another library to compile, or when a pkg-config file refers to another one @i{via} its @code{Requires} field." +msgstr "" + +#. type: table +#: doc/guix.texi:3590 +msgid "Another example where @code{propagated-inputs} is useful is for languages that lack a facility to record the run-time search path akin to the @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and more. To ensure that libraries written in those languages can find library code they depend on at run time, run-time dependencies must be listed in @code{propagated-inputs} rather than @code{inputs}." +msgstr "" + +#. type: item +#: doc/guix.texi:3591 +#, no-wrap +msgid "@code{self-native-input?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3594 +msgid "This is a Boolean field telling whether the package should use itself as a native input when cross-compiling." +msgstr "" + +#. type: item +#: doc/guix.texi:3595 +#, no-wrap +msgid "@code{outputs} (default: @code{'(\"out\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:3598 +msgid "The list of output names of the package. @xref{Packages with Multiple Outputs}, for typical uses of additional outputs." +msgstr "" + +#. type: item +#: doc/guix.texi:3599 +#, no-wrap +msgid "@code{native-search-paths} (default: @code{'()})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:3600 +#, no-wrap +msgid "@code{search-paths} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:3603 +msgid "A list of @code{search-path-specification} objects describing search-path environment variables honored by the package." +msgstr "" + +#. type: item +#: doc/guix.texi:3604 +#, no-wrap +msgid "@code{replacement} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3608 +msgid "This must be either @code{#f} or a package object that will be used as a @dfn{replacement} for this package. @xref{Security Updates, grafts}, for details." +msgstr "" + +#. type: item +#: doc/guix.texi:3609 doc/guix.texi:6919 +#, no-wrap +msgid "synopsis" +msgstr "synopsis" + +#. type: table +#: doc/guix.texi:3611 +msgid "A one-line description of the package." +msgstr "Eine einzeilige Beschreibung des Pakets." + +#. type: item +#: doc/guix.texi:3612 doc/guix.texi:6920 doc/guix.texi:21511 +#, no-wrap +msgid "description" +msgstr "description" + +#. type: table +#: doc/guix.texi:3614 +msgid "A more elaborate description of the package." +msgstr "Eine ausführlichere Beschreibung des Pakets." + +#. type: code{#1} +#: doc/guix.texi:3615 +#, no-wrap +msgid "license" +msgstr "license" + +#. type: cindex +#: doc/guix.texi:3616 +#, no-wrap +msgid "license, of packages" +msgstr "" + +#. type: table +#: doc/guix.texi:3619 +msgid "The license of the package; a value from @code{(guix licenses)}, or a list of such values." +msgstr "" + +#. type: itemx +#: doc/guix.texi:3620 doc/guix.texi:6928 +#, no-wrap +msgid "home-page" +msgstr "" + +#. type: table +#: doc/guix.texi:3622 +msgid "The URL to the home-page of the package, as a string." +msgstr "" + +#. type: item +#: doc/guix.texi:3623 +#, no-wrap +msgid "@code{supported-systems} (default: @var{%supported-systems})" +msgstr "" + +#. type: table +#: doc/guix.texi:3626 +msgid "The list of systems supported by the package, as strings of the form @code{architecture-kernel}, for example @code{\"x86_64-linux\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:3627 +#, no-wrap +msgid "@code{maintainers} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:3629 +msgid "The list of maintainers of the package, as @code{maintainer} objects." +msgstr "" + +#. type: item +#: doc/guix.texi:3630 +#, no-wrap +msgid "@code{location} (default: source location of the @code{package} form)" +msgstr "" + +#. type: table +#: doc/guix.texi:3634 +msgid "The source location of the package. It is useful to override this when inheriting from another package, in which case this field is not automatically corrected." +msgstr "" + +#. type: subsection +#: doc/guix.texi:3639 +#, no-wrap +msgid "@code{origin} Reference" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3643 +msgid "This section summarizes all the options available in @code{origin} declarations (@pxref{Defining Packages})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:3644 +#, no-wrap +msgid "{Data Type} origin" +msgstr "" + +#. type: deftp +#: doc/guix.texi:3646 +msgid "This is the data type representing a source code origin." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3648 doc/guix.texi:16065 +#, no-wrap +msgid "uri" +msgstr "" + +#. type: table +#: doc/guix.texi:3653 +msgid "An object containing the URI of the source. The object type depends on the @code{method} (see below). For example, when using the @var{url-fetch} method of @code{(guix download)}, the valid @code{uri} values are: a URL represented as a string, or a list thereof." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3654 +#, no-wrap +msgid "method" +msgstr "" + +#. type: table +#: doc/guix.texi:3656 +msgid "A procedure that handles the URI." +msgstr "" + +#. type: table +#: doc/guix.texi:3658 +msgid "Examples include:" +msgstr "" + +#. type: item +#: doc/guix.texi:3660 +#, no-wrap +msgid "@var{url-fetch} from @code{(guix download)}" +msgstr "" + +#. type: table +#: doc/guix.texi:3663 +msgid "download a file from the HTTP, HTTPS, or FTP URL specified in the @code{uri} field;" +msgstr "" + +#. type: vindex +#: doc/guix.texi:3664 doc/guix.texi:6275 +#, no-wrap +msgid "git-fetch" +msgstr "git-fetch" + +#. type: item +#: doc/guix.texi:3665 +#, no-wrap +msgid "@var{git-fetch} from @code{(guix git-download)}" +msgstr "" + +#. type: table +#: doc/guix.texi:3669 +msgid "clone the Git version control repository, and check out the revision specified in the @code{uri} field as a @code{git-reference} object; a @code{git-reference} looks like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:3674 +#, no-wrap +msgid "" +"(git-reference\n" +" (url \"git://git.debian.org/git/pkg-shadow/shadow\")\n" +" (commit \"v4.1.5.1\"))\n" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:3677 +#, no-wrap +msgid "sha256" +msgstr "sha256" + +#. type: table +#: doc/guix.texi:3681 +msgid "A bytevector containing the SHA-256 hash of the source. Typically the @code{base32} form is used here to generate the bytevector from a base-32 string." +msgstr "" + +#. type: table +#: doc/guix.texi:3685 +msgid "You can obtain this information using @code{guix download} (@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking guix hash})." +msgstr "" + +#. type: item +#: doc/guix.texi:3686 +#, no-wrap +msgid "@code{file-name} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3692 +msgid "The file name under which the source code should be saved. When this is @code{#f}, a sensible default value will be used in most cases. In case the source is fetched from a URL, the file name from the URL will be used. For version control checkouts, it is recommended to provide the file name explicitly because the default is not very descriptive." +msgstr "" + +#. type: item +#: doc/guix.texi:3693 +#, no-wrap +msgid "@code{patches} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:3696 +msgid "A list of file names, origins, or file-like objects (@pxref{G-Expressions, file-like objects}) pointing to patches to be applied to the source." +msgstr "" + +#. type: table +#: doc/guix.texi:3700 +msgid "This list of patches must be unconditional. In particular, it cannot depend on the value of @code{%current-system} or @code{%current-target-system}." +msgstr "" + +#. type: item +#: doc/guix.texi:3701 +#, no-wrap +msgid "@code{snippet} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3705 +msgid "A G-expression (@pxref{G-Expressions}) or S-expression that will be run in the source directory. This is a convenient way to modify the source, sometimes more convenient than a patch." +msgstr "" + +#. type: item +#: doc/guix.texi:3706 +#, no-wrap +msgid "@code{patch-flags} (default: @code{'(\"-p1\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:3709 +msgid "A list of command-line flags that should be passed to the @code{patch} command." +msgstr "" + +#. type: item +#: doc/guix.texi:3710 +#, no-wrap +msgid "@code{patch-inputs} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3714 +msgid "Input packages or derivations to the patching process. When this is @code{#f}, the usual set of inputs necessary for patching are provided, such as GNU@tie{}Patch." +msgstr "" + +#. type: item +#: doc/guix.texi:3715 +#, no-wrap +msgid "@code{modules} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:3718 +msgid "A list of Guile modules that should be loaded during the patching process and while running the code in the @code{snippet} field." +msgstr "" + +#. type: item +#: doc/guix.texi:3719 +#, no-wrap +msgid "@code{patch-guile} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:3722 +msgid "The Guile package that should be used in the patching process. When this is @code{#f}, a sensible default is used." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3729 +#, no-wrap +msgid "build system" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3734 +msgid "Each package definition specifies a @dfn{build system} and arguments for that build system (@pxref{Defining Packages}). This @code{build-system} field represents the build procedure of the package, as well as implicit dependencies of that build procedure." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3738 +msgid "Build systems are @code{<build-system>} objects. The interface to create and manipulate them is provided by the @code{(guix build-system)} module, and actual build systems are exported by specific modules." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3739 +#, no-wrap +msgid "bag (low-level package representation)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3746 +msgid "Under the hood, build systems first compile package objects to @dfn{bags}. A @dfn{bag} is like a package, but with less ornamentation---in other words, a bag is a lower-level representation of a package, which includes all the inputs of that package, including some that were implicitly added by the build system. This intermediate representation is then compiled to a derivation (@pxref{Derivations})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3754 +msgid "Build systems accept an optional list of @dfn{arguments}. In package definitions, these are passed @i{via} the @code{arguments} field (@pxref{Defining Packages}). They are typically keyword arguments (@pxref{Optional Arguments, keyword arguments in Guile,, guile, GNU Guile Reference Manual}). The value of these arguments is usually evaluated in the @dfn{build stratum}---i.e., by a Guile process launched by the daemon (@pxref{Derivations})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3758 +msgid "The main build system is @var{gnu-build-system}, which implements the standard build procedure for GNU and many other packages. It is provided by the @code{(guix build-system gnu)} module." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3759 +#, no-wrap +msgid "{Scheme Variable} gnu-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3763 +msgid "@var{gnu-build-system} represents the GNU Build System, and variants thereof (@pxref{Configuration, configuration and makefile conventions,, standards, GNU Coding Standards})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:3764 +#, no-wrap +msgid "build phases" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3771 +msgid "In a nutshell, packages using it are configured, built, and installed with the usual @code{./configure && make && make check && make install} command sequence. In practice, a few additional steps are often needed. All these steps are split up in separate @dfn{phases}, notably@footnote{Please see the @code{(guix build gnu-build-system)} modules for more details about the build phases.}:" +msgstr "" + +#. type: item +#: doc/guix.texi:3773 +#, no-wrap +msgid "unpack" +msgstr "" + +#. type: table +#: doc/guix.texi:3777 +msgid "Unpack the source tarball, and change the current directory to the extracted source tree. If the source is actually a directory, copy it to the build tree, and enter that directory." +msgstr "" + +#. type: item +#: doc/guix.texi:3778 +#, no-wrap +msgid "patch-source-shebangs" +msgstr "" + +#. type: table +#: doc/guix.texi:3782 +msgid "Patch shebangs encountered in source files so they refer to the right store file names. For instance, this changes @code{#!/bin/sh} to @code{#!/gnu/store/@dots{}-bash-4.3/bin/sh}." +msgstr "" + +#. type: item +#: doc/guix.texi:3783 doc/guix.texi:4268 +#, no-wrap +msgid "configure" +msgstr "" + +#. type: table +#: doc/guix.texi:3787 +msgid "Run the @file{configure} script with a number of default options, such as @code{--prefix=/gnu/store/@dots{}}, as well as the options specified by the @code{#:configure-flags} argument." +msgstr "" + +#. type: item +#: doc/guix.texi:3788 doc/guix.texi:4273 doc/guix.texi:20921 +#, no-wrap +msgid "build" +msgstr "" + +#. type: table +#: doc/guix.texi:3792 +msgid "Run @code{make} with the list of flags specified with @code{#:make-flags}. If the @code{#:parallel-build?} argument is true (the default), build with @code{make -j}." +msgstr "" + +#. type: item +#: doc/guix.texi:3793 doc/guix.texi:4277 +#, no-wrap +msgid "check" +msgstr "" + +#. type: table +#: doc/guix.texi:3798 +msgid "Run @code{make check}, or some other target specified with @code{#:test-target}, unless @code{#:tests? #f} is passed. If the @code{#:parallel-tests?} argument is true (the default), run @code{make check -j}." +msgstr "" + +#. type: item +#: doc/guix.texi:3799 doc/guix.texi:4281 +#, no-wrap +msgid "install" +msgstr "" + +#. type: table +#: doc/guix.texi:3801 +msgid "Run @code{make install} with the flags listed in @code{#:make-flags}." +msgstr "" + +#. type: item +#: doc/guix.texi:3802 +#, no-wrap +msgid "patch-shebangs" +msgstr "" + +#. type: table +#: doc/guix.texi:3804 +msgid "Patch shebangs on the installed executable files." +msgstr "" + +#. type: item +#: doc/guix.texi:3805 +#, no-wrap +msgid "strip" +msgstr "" + +#. type: table +#: doc/guix.texi:3809 +msgid "Strip debugging symbols from ELF files (unless @code{#:strip-binaries?} is false), copying them to the @code{debug} output when available (@pxref{Installing Debugging Files})." +msgstr "" + +#. type: vindex +#: doc/guix.texi:3811 +#, no-wrap +msgid "%standard-phases" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3816 +msgid "The build-side module @code{(guix build gnu-build-system)} defines @var{%standard-phases} as the default list of build phases. @var{%standard-phases} is a list of symbol/procedure pairs, where the procedure implements the actual phase." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3819 +msgid "The list of phases used for a particular package can be changed with the @code{#:phases} parameter. For instance, passing:" +msgstr "" + +#. type: example +#: doc/guix.texi:3822 +#, no-wrap +msgid "#:phases (modify-phases %standard-phases (delete 'configure))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3826 +msgid "means that all the phases described above will be used, except the @code{configure} phase." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3833 +msgid "In addition, this build system ensures that the ``standard'' environment for GNU packages is available. This includes tools such as GCC, libc, Coreutils, Bash, Make, Diffutils, grep, and sed (see the @code{(guix build-system gnu)} module for a complete list). We call these the @dfn{implicit inputs} of a package, because package definitions do not have to mention them." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:3840 +msgid "Other @code{<build-system>} objects are defined to support other conventions and tools used by free software packages. They inherit most of @var{gnu-build-system}, and differ mainly in the set of inputs implicitly added to the build process, and in the list of phases executed. Some of these build systems are listed below." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3841 +#, no-wrap +msgid "{Scheme Variable} ant-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3845 +msgid "This variable is exported by @code{(guix build-system ant)}. It implements the build procedure for Java packages that can be built with @url{http://ant.apache.org/, Ant build tool}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3850 +msgid "It adds both @code{ant} and the @dfn{Java Development Kit} (JDK) as provided by the @code{icedtea} package to the set of inputs. Different packages can be specified with the @code{#:ant} and @code{#:jdk} parameters, respectively." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3856 +msgid "When the original package does not provide a suitable Ant build file, the parameter @code{#:jar-name} can be used to generate a minimal Ant build file @file{build.xml} with tasks to build the specified jar archive. In this case the parameter @code{#:source-dir} can be used to specify the source sub-directory, defaulting to ``src''." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3864 +msgid "The @code{#:main-class} parameter can be used with the minimal ant buildfile to specify the main class of the resulting jar. This makes the jar file executable. The @code{#:test-include} parameter can be used to specify the list of junit tests to run. It defaults to @code{(list \"**/*Test.java\")}. The @code{#:test-exclude} can be used to disable some tests. It defaults to @code{(list \"**/Abstract*.java\")}, because abstract classes cannot be run as tests." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3868 +msgid "The parameter @code{#:build-target} can be used to specify the Ant task that should be run during the @code{build} phase. By default the ``jar'' task will be run." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3871 +#, no-wrap +msgid "{Scheme Variable} android-ndk-build-system" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3872 +#, no-wrap +msgid "Android distribution" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3873 +#, no-wrap +msgid "Android NDK build system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3877 +msgid "This variable is exported by @code{(guix build-system android-ndk)}. It implements a build procedure for Android NDK (native development kit) packages using a Guix-specific build process." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3881 +msgid "The build system assumes that packages install their public interface (header) files to the subdirectory \"include\" of the \"out\" output and their libraries to the subdirectory \"lib\" of the \"out\" output." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3884 +msgid "It's also assumed that the union of all the dependencies of a package has no conflicting files." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3887 +msgid "For the time being, cross-compilation is not supported - so right now the libraries and header files are assumed to be host tools." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3890 +#, no-wrap +msgid "{Scheme Variable} asdf-build-system/source" +msgstr "" + +#. type: defvrx +#: doc/guix.texi:3891 +#, no-wrap +msgid "{Scheme Variable} asdf-build-system/sbcl" +msgstr "" + +#. type: defvrx +#: doc/guix.texi:3892 +#, no-wrap +msgid "{Scheme Variable} asdf-build-system/ecl" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3898 +msgid "These variables, exported by @code{(guix build-system asdf)}, implement build procedures for Common Lisp packages using @url{https://common-lisp.net/project/asdf/, ``ASDF''}. ASDF is a system definition facility for Common Lisp programs and libraries." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3905 +msgid "The @code{asdf-build-system/source} system installs the packages in source form, and can be loaded using any common lisp implementation, via ASDF. The others, such as @code{asdf-build-system/sbcl}, install binary systems in the format which a particular implementation understands. These build systems can also be used to produce executable programs, or lisp images which contain a set of packages pre-loaded." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3909 +msgid "The build system uses naming conventions. For binary packages, the package name should be prefixed with the lisp implementation, such as @code{sbcl-} for @code{asdf-build-system/sbcl}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3913 +msgid "Additionally, the corresponding source package should be labeled using the same convention as python packages (see @ref{Python Modules}), using the @code{cl-} prefix." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3918 +msgid "For binary packages, each system should be defined as a Guix package. If one package @code{origin} contains several systems, package variants can be created in order to build all the systems. Source packages, which use @code{asdf-build-system/source}, may contain several systems." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3925 +msgid "In order to create executable programs and images, the build-side procedures @code{build-program} and @code{build-image} can be used. They should be called in a build phase after the @code{create-symlinks} phase, so that the system which was just built can be used within the resulting image. @code{build-program} requires a list of Common Lisp expressions to be passed as the @code{#:entry-program} argument." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3934 +msgid "If the system is not defined within its own @code{.asd} file of the same name, then the @code{#:asd-file} parameter should be used to specify which file the system is defined in. Furthermore, if the package defines a system for its tests in a separate file, it will be loaded before the tests are run if it is specified by the @code{#:test-asd-file} parameter. If it is not set, the files @code{<system>-tests.asd}, @code{<system>-test.asd}, @code{tests.asd}, and @code{test.asd} will be tried if they exist." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3938 +msgid "If for some reason the package must be named in a different way than the naming conventions suggest, the @code{#:asd-system-name} parameter can be used to specify the name of the system." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3941 +#, no-wrap +msgid "{Scheme Variable} cargo-build-system" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3942 +#, no-wrap +msgid "Rust programming language" +msgstr "" + +#. type: cindex +#: doc/guix.texi:3943 +#, no-wrap +msgid "Cargo (Rust build system)" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3947 +msgid "This variable is exported by @code{(guix build-system cargo)}. It supports builds of packages using Cargo, the build tool of the @uref{https://www.rust-lang.org, Rust programming language}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3952 +msgid "In its @code{configure} phase, this build system replaces dependencies specified in the @file{Carto.toml} file with inputs to the Guix package. The @code{install} phase installs the binaries, and it also installs the source code and @file{Cargo.toml} file." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3954 +#, no-wrap +msgid "{Scheme Variable} cmake-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3958 +msgid "This variable is exported by @code{(guix build-system cmake)}. It implements the build procedure for packages using the @url{http://www.cmake.org, CMake build tool}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3962 +msgid "It automatically adds the @code{cmake} package to the set of inputs. Which package is used can be specified with the @code{#:cmake} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3969 +msgid "The @code{#:configure-flags} parameter is taken as a list of flags passed to the @command{cmake} command. The @code{#:build-type} parameter specifies in abstract terms the flags passed to the compiler; it defaults to @code{\"RelWithDebInfo\"} (short for ``release mode with debugging information''), which roughly means that code is compiled with @code{-O2 -g}, as is the case for Autoconf-based packages by default." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3971 +#, no-wrap +msgid "{Scheme Variable} go-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3976 +msgid "This variable is exported by @code{(guix build-system go)}. It implements a build procedure for Go packages using the standard @url{https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies, Go build mechanisms}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3987 +msgid "The user is expected to provide a value for the key @code{#:import-path} and, in some cases, @code{#:unpack-path}. The @url{https://golang.org/doc/code.html#ImportPaths, import path} corresponds to the file system path expected by the package's build scripts and any referring packages, and provides a unique way to refer to a Go package. It is typically based on a combination of the package source code's remote URI and file system hierarchy structure. In some cases, you will need to unpack the package's source code to a different directory structure than the one indicated by the import path, and @code{#:unpack-path} should be used in such cases." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3992 +msgid "Packages that provide Go libraries should be installed along with their source code. The key @code{#:install-source?}, which defaults to @code{#t}, controls whether or not the source code is installed. It can be set to @code{#f} for packages that only provide executable files." +msgstr "" + +#. type: defvr +#: doc/guix.texi:3994 +#, no-wrap +msgid "{Scheme Variable} glib-or-gtk-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:3997 +msgid "This variable is exported by @code{(guix build-system glib-or-gtk)}. It is intended for use with packages making use of GLib or GTK+." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4000 +msgid "This build system adds the following two phases to the ones defined by @var{gnu-build-system}:" +msgstr "" + +#. type: item +#: doc/guix.texi:4002 doc/guix.texi:4297 +#, no-wrap +msgid "glib-or-gtk-wrap" +msgstr "" + +#. type: table +#: doc/guix.texi:4009 +msgid "The phase @code{glib-or-gtk-wrap} ensures that programs in @file{bin/} are able to find GLib ``schemas'' and @uref{https://developer.gnome.org/gtk3/stable/gtk-running.html, GTK+ modules}. This is achieved by wrapping the programs in launch scripts that appropriately set the @code{XDG_DATA_DIRS} and @code{GTK_PATH} environment variables." +msgstr "" + +#. type: table +#: doc/guix.texi:4016 +msgid "It is possible to exclude specific package outputs from that wrapping process by listing their names in the @code{#:glib-or-gtk-wrap-excluded-outputs} parameter. This is useful when an output is known not to contain any GLib or GTK+ binaries, and where wrapping would gratuitously add a dependency of that output on GLib and GTK+." +msgstr "" + +#. type: item +#: doc/guix.texi:4017 doc/guix.texi:4301 +#, no-wrap +msgid "glib-or-gtk-compile-schemas" +msgstr "" + +#. type: table +#: doc/guix.texi:4025 +msgid "The phase @code{glib-or-gtk-compile-schemas} makes sure that all @uref{https://developer.gnome.org/gio/stable/glib-compile-schemas.html, GSettings schemas} of GLib are compiled. Compilation is performed by the @command{glib-compile-schemas} program. It is provided by the package @code{glib:bin} which is automatically imported by the build system. The @code{glib} package providing @command{glib-compile-schemas} can be specified with the @code{#:glib} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4028 +msgid "Both phases are executed after the @code{install} phase." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4030 +#, no-wrap +msgid "{Scheme Variable} minify-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4033 +msgid "This variable is exported by @code{(guix build-system minify)}. It implements a minification procedure for simple JavaScript packages." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4039 +msgid "It adds @code{uglify-js} to the set of inputs and uses it to compress all JavaScript files in the @file{src} directory. A different minifier package can be specified with the @code{#:uglify-js} parameter, but it is expected that the package writes the minified code to the standard output." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4043 +msgid "When the input JavaScript files are not all located in the @file{src} directory, the parameter @code{#:javascript-files} can be used to specify a list of file names to feed to the minifier." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4045 +#, no-wrap +msgid "{Scheme Variable} ocaml-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4051 +msgid "This variable is exported by @code{(guix build-system ocaml)}. It implements a build procedure for @uref{https://ocaml.org, OCaml} packages, which consists of choosing the correct set of commands to run for each package. OCaml packages can expect many different commands to be run. This build system will try some of them." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4061 +msgid "When the package has a @file{setup.ml} file present at the top-level, it will run @code{ocaml setup.ml -configure}, @code{ocaml setup.ml -build} and @code{ocaml setup.ml -install}. The build system will assume that this file was generated by @uref{http://oasis.forge.ocamlcore.org/, OASIS} and will take care of setting the prefix and enabling tests if they are not disabled. You can pass configure and build flags with the @code{#:configure-flags} and @code{#:build-flags}. The @code{#:test-flags} key can be passed to change the set of flags used to enable tests. The @code{#:use-make?} key can be used to bypass this system in the build and install phases." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4066 +msgid "When the package has a @file{configure} file, it is assumed that it is a hand-made configure script that requires a different argument format than in the @code{gnu-build-system}. You can add more flags with the @code{#:configure-flags} key." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4070 +msgid "When the package has a @file{Makefile} file (or @code{#:use-make?} is @code{#t}), it will be used and more flags can be passed to the build and install phases with the @code{#:make-flags} key." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4078 +msgid "Finally, some packages do not have these files and use a somewhat standard location for its build system. In that case, the build system will run @code{ocaml pkg/pkg.ml} or @code{ocaml pkg/build.ml} and take care of providing the path to the required findlib module. Additional flags can be passed via the @code{#:build-flags} key. Install is taken care of by @command{opam-installer}. In this case, the @code{opam} package must be added to the @code{native-inputs} field of the package definition." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4086 +msgid "Note that most OCaml packages assume they will be installed in the same directory as OCaml, which is not what we want in guix. In particular, they will install @file{.so} files in their module's directory, which is usually fine because it is in the OCaml compiler directory. In guix though, these libraries cannot be found and we use @code{CAML_LD_LIBRARY_PATH}. This variable points to @file{lib/ocaml/site-lib/stubslibs} and this is where @file{.so} libraries should be installed." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4088 +#, no-wrap +msgid "{Scheme Variable} python-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4093 +msgid "This variable is exported by @code{(guix build-system python)}. It implements the more or less standard build procedure used by Python packages, which consists in running @code{python setup.py build} and then @code{python setup.py install --prefix=/gnu/store/@dots{}}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4097 +msgid "For packages that install stand-alone Python programs under @code{bin/}, it takes care of wrapping these programs so that their @code{PYTHONPATH} environment variable points to all the Python libraries they depend on." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4103 +msgid "Which Python package is used to perform the build can be specified with the @code{#:python} parameter. This is a useful way to force a package to be built for a specific version of the Python interpreter, which might be necessary if the package is only compatible with a single interpreter version." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4108 +msgid "By default guix calls @code{setup.py} under control of @code{setuptools}, much like @command{pip} does. Some packages are not compatible with setuptools (and pip), thus you can disable this by setting the @code{#:use-setuptools} parameter to @code{#f}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4110 +#, no-wrap +msgid "{Scheme Variable} perl-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4122 +msgid "This variable is exported by @code{(guix build-system perl)}. It implements the standard build procedure for Perl packages, which either consists in running @code{perl Build.PL --prefix=/gnu/store/@dots{}}, followed by @code{Build} and @code{Build install}; or in running @code{perl Makefile.PL PREFIX=/gnu/store/@dots{}}, followed by @code{make} and @code{make install}, depending on which of @code{Build.PL} or @code{Makefile.PL} is present in the package distribution. Preference is given to the former if both @code{Build.PL} and @code{Makefile.PL} exist in the package distribution. This preference can be reversed by specifying @code{#t} for the @code{#:make-maker?} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4126 +msgid "The initial @code{perl Makefile.PL} or @code{perl Build.PL} invocation passes flags specified by the @code{#:make-maker-flags} or @code{#:module-build-flags} parameter, respectively." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4128 +msgid "Which Perl package is used can be specified with @code{#:perl}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4130 +#, no-wrap +msgid "{Scheme Variable} r-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4138 +msgid "This variable is exported by @code{(guix build-system r)}. It implements the build procedure used by @uref{http://r-project.org, R} packages, which essentially is little more than running @code{R CMD INSTALL --library=/gnu/store/@dots{}} in an environment where @code{R_LIBS_SITE} contains the paths to all R package inputs. Tests are run after installation using the R function @code{tools::testInstalledPackage}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4140 +#, no-wrap +msgid "{Scheme Variable} texlive-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4145 +msgid "This variable is exported by @code{(guix build-system texlive)}. It is used to build TeX packages in batch mode with a specified engine. The build system sets the @code{TEXINPUTS} variable to find all TeX source files in the inputs." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4154 +msgid "By default it runs @code{luatex} on all files ending on @code{ins}. A different engine and format can be specified with the @code{#:tex-format} argument. Different build targets can be specified with the @code{#:build-targets} argument, which expects a list of file names. The build system adds only @code{texlive-bin} and @code{texlive-latex-base} (both from @code{(gnu packages tex}) to the inputs. Both can be overridden with the arguments @code{#:texlive-bin} and @code{#:texlive-latex-base}, respectively." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4157 +msgid "The @code{#:tex-directory} parameter tells the build system where to install the built files under the texmf tree." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4159 +#, no-wrap +msgid "{Scheme Variable} ruby-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4163 +msgid "This variable is exported by @code{(guix build-system ruby)}. It implements the RubyGems build procedure used by Ruby packages, which involves running @code{gem build} followed by @code{gem install}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4171 +msgid "The @code{source} field of a package that uses this build system typically references a gem archive, since this is the format that Ruby developers use when releasing their software. The build system unpacks the gem archive, potentially patches the source, runs the test suite, repackages the gem, and installs it. Additionally, directories and tarballs may be referenced to allow building unreleased gems from Git or a traditional source release tarball." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4175 +msgid "Which Ruby package is used can be specified with the @code{#:ruby} parameter. A list of additional flags to be passed to the @command{gem} command can be specified with the @code{#:gem-flags} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4177 +#, no-wrap +msgid "{Scheme Variable} waf-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4183 +msgid "This variable is exported by @code{(guix build-system waf)}. It implements a build procedure around the @code{waf} script. The common phases---@code{configure}, @code{build}, and @code{install}---are implemented by passing their names as arguments to the @code{waf} script." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4187 +msgid "The @code{waf} script is executed by the Python interpreter. Which Python package is used to run the script can be specified with the @code{#:python} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4189 +#, no-wrap +msgid "{Scheme Variable} scons-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4195 +msgid "This variable is exported by @code{(guix build-system scons)}. It implements the build procedure used by the SCons software construction tool. This build system runs @code{scons} to build the package, @code{scons test} to run tests, and then @code{scons install} to install the package." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4200 +msgid "Additional flags to be passed to @code{scons} can be specified with the @code{#:scons-flags} parameter. The version of Python used to run SCons can be specified by selecting the appropriate SCons package with the @code{#:scons} parameter." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4202 +#, no-wrap +msgid "{Scheme Variable} haskell-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4216 +msgid "This variable is exported by @code{(guix build-system haskell)}. It implements the Cabal build procedure used by Haskell packages, which involves running @code{runhaskell Setup.hs configure --prefix=/gnu/store/@dots{}} and @code{runhaskell Setup.hs build}. Instead of installing the package by running @code{runhaskell Setup.hs install}, to avoid trying to register libraries in the read-only compiler store directory, the build system uses @code{runhaskell Setup.hs copy}, followed by @code{runhaskell Setup.hs register}. In addition, the build system generates the package documentation by running @code{runhaskell Setup.hs haddock}, unless @code{#:haddock? #f} is passed. Optional Haddock parameters can be passed with the help of the @code{#:haddock-flags} parameter. If the file @code{Setup.hs} is not found, the build system looks for @code{Setup.lhs} instead." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4219 +msgid "Which Haskell compiler is used can be specified with the @code{#:haskell} parameter which defaults to @code{ghc}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4221 +#, no-wrap +msgid "{Scheme Variable} dub-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4226 +msgid "This variable is exported by @code{(guix build-system dub)}. It implements the Dub build procedure used by D packages, which involves running @code{dub build} and @code{dub run}. Installation is done by copying the files manually." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4229 +msgid "Which D compiler is used can be specified with the @code{#:ldc} parameter which defaults to @code{ldc}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4231 +#, no-wrap +msgid "{Scheme Variable} emacs-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4235 +msgid "This variable is exported by @code{(guix build-system emacs)}. It implements an installation procedure similar to the packaging system of Emacs itself (@pxref{Packages,,, emacs, The GNU Emacs Manual})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4242 +msgid "It first creates the @code{@var{package}-autoloads.el} file, then it byte compiles all Emacs Lisp files. Differently from the Emacs packaging system, the Info documentation files are moved to the standard documentation directory and the @file{dir} file is deleted. Each package is installed in its own directory under @file{share/emacs/site-lisp/guix.d}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4244 +#, no-wrap +msgid "{Scheme Variable} font-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4250 +msgid "This variable is exported by @code{(guix build-system font)}. It implements an installation procedure for font packages where upstream provides pre-compiled TrueType, OpenType, etc. font files that merely need to be copied into place. It copies font files to standard locations in the output directory." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4252 +#, no-wrap +msgid "{Scheme Variable} meson-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4256 +msgid "This variable is exported by @code{(guix build-system meson)}. It implements the build procedure for packages that use @url{http://mesonbuild.com, Meson} as their build system." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4262 +msgid "It adds both Meson and @uref{https://ninja-build.org/, Ninja} to the set of inputs, and they can be changed with the parameters @code{#:meson} and @code{#:ninja} if needed. The default Meson is @code{meson-for-build}, which is special because it doesn't clear the @code{RUNPATH} of binaries and libraries when they are installed." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4265 +msgid "This build system is an extension of @var{gnu-build-system}, but with the following phases changed to some specific for Meson:" +msgstr "" + +#. type: table +#: doc/guix.texi:4272 +msgid "The phase runs @code{meson} with the flags specified in @code{#:configure-flags}. The flag @code{--build-type} is always set to @code{plain} unless something else is specified in @code{#:build-type}." +msgstr "" + +#. type: table +#: doc/guix.texi:4276 +msgid "The phase runs @code{ninja} to build the package in parallel by default, but this can be changed with @code{#:parallel-build?}." +msgstr "" + +#. type: table +#: doc/guix.texi:4280 +msgid "The phase runs @code{ninja} with the target specified in @code{#:test-target}, which is @code{\"test\"} by default." +msgstr "" + +#. type: table +#: doc/guix.texi:4283 +msgid "The phase runs @code{ninja install} and can not be changed." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4286 +msgid "Apart from that, the build system also adds the following phases:" +msgstr "" + +#. type: item +#: doc/guix.texi:4289 +#, no-wrap +msgid "fix-runpath" +msgstr "" + +#. type: table +#: doc/guix.texi:4296 +msgid "This phase ensures that all binaries can find the libraries they need. It searches for required libraries in subdirectories of the package being built, and adds those to @code{RUNPATH} where needed. It also removes references to libraries left over from the build phase by @code{meson-for-build}, such as test dependencies, that aren't actually required for the program to run." +msgstr "" + +#. type: table +#: doc/guix.texi:4300 doc/guix.texi:4304 +msgid "This phase is the phase provided by @code{glib-or-gtk-build-system}, and it is not enabled by default. It can be enabled with @code{#:glib-or-gtk?}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4311 +msgid "Lastly, for packages that do not need anything as sophisticated, a ``trivial'' build system is provided. It is trivial in the sense that it provides basically no support: it does not pull any implicit inputs, and does not have a notion of build phases." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4312 +#, no-wrap +msgid "{Scheme Variable} trivial-build-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4314 +msgid "This variable is exported by @code{(guix build-system trivial)}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4319 +msgid "This build system requires a @code{#:builder} argument. This argument must be a Scheme expression that builds the package output(s)---as with @code{build-expression->derivation} (@pxref{Derivations, @code{build-expression->derivation}})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4325 +#, no-wrap +msgid "store items" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4326 +#, no-wrap +msgid "store paths" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4337 +msgid "Conceptually, the @dfn{store} is the place where derivations that have been built successfully are stored---by default, @file{/gnu/store}. Sub-directories in the store are referred to as @dfn{store items} or sometimes @dfn{store paths}. The store has an associated database that contains information such as the store paths referred to by each store path, and the list of @emph{valid} store items---results of successful builds. This database resides in @file{@var{localstatedir}/guix/db}, where @var{localstatedir} is the state directory specified @i{via} @option{--localstatedir} at configure time, usually @file{/var}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4342 +msgid "The store is @emph{always} accessed by the daemon on behalf of its clients (@pxref{Invoking guix-daemon}). To manipulate the store, clients connect to the daemon over a Unix-domain socket, send requests to it, and read the result---these are remote procedure calls, or RPCs." +msgstr "" + +#. type: quotation +#: doc/guix.texi:4347 +msgid "Users must @emph{never} modify files under @file{/gnu/store} directly. This would lead to inconsistencies and break the immutability assumptions of Guix's functional model (@pxref{Introduction})." +msgstr "" + +#. type: quotation +#: doc/guix.texi:4351 +msgid "@xref{Invoking guix gc, @command{guix gc --verify}}, for information on how to check the integrity of the store and attempt recovery from accidental modifications." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4358 +msgid "The @code{(guix store)} module provides procedures to connect to the daemon, and to perform RPCs. These are described below. By default, @code{open-connection}, and thus all the @command{guix} commands, connect to the local daemon or to the URI specified by the @code{GUIX_DAEMON_SOCKET} environment variable." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4359 +#, no-wrap +msgid "{Environment Variable} GUIX_DAEMON_SOCKET" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4364 +msgid "When set, the value of this variable should be a file name or a URI designating the daemon endpoint. When it is a file name, it denotes a Unix-domain socket to connect to. In addition to file names, the supported URI schemes are:" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:4366 doc/guix.texi:15771 +#, no-wrap +msgid "file" +msgstr "" + +#. type: itemx +#: doc/guix.texi:4367 +#, no-wrap +msgid "unix" +msgstr "" + +#. type: table +#: doc/guix.texi:4371 +msgid "These are for Unix-domain sockets. @code{file:///var/guix/daemon-socket/socket} is equivalent to @file{/var/guix/daemon-socket/socket}." +msgstr "" + +#. type: item +#: doc/guix.texi:4372 +#, no-wrap +msgid "guix" +msgstr "" + +#. type: table +#: doc/guix.texi:4380 +msgid "These URIs denote connections over TCP/IP, without encryption nor authentication of the remote host. The URI must specify the host name and optionally a port number (by default port 44146 is used):" +msgstr "" + +#. type: example +#: doc/guix.texi:4383 +#, no-wrap +msgid "guix://master.guix.example.org:1234\n" +msgstr "" + +#. type: table +#: doc/guix.texi:4388 +msgid "This setup is suitable on local networks, such as clusters, where only trusted nodes may connect to the build daemon at @code{master.guix.example.org}." +msgstr "" + +#. type: table +#: doc/guix.texi:4392 +msgid "The @code{--listen} option of @command{guix-daemon} can be used to instruct it to listen for TCP connections (@pxref{Invoking guix-daemon, @code{--listen}})." +msgstr "" + +#. type: item +#: doc/guix.texi:4393 +#, no-wrap +msgid "ssh" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4394 +#, no-wrap +msgid "SSH access to build daemons" +msgstr "" + +#. type: table +#: doc/guix.texi:4398 +msgid "These URIs allow you to connect to a remote daemon over SSH@footnote{This feature requires Guile-SSH (@pxref{Requirements}).}. A typical URL might look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:4401 +#, no-wrap +msgid "ssh://charlie@@guix.example.org:22\n" +msgstr "" + +#. type: table +#: doc/guix.texi:4405 +msgid "As for @command{guix copy}, the usual OpenSSH client configuration files are honored (@pxref{Invoking guix copy})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4408 +msgid "Additional URI schemes may be supported in the future." +msgstr "" + +#. type: quotation +#: doc/guix.texi:4415 +msgid "The ability to connect to remote build daemons is considered experimental as of @value{VERSION}. Please get in touch with us to share any problems or suggestions you may have (@pxref{Contributing})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4418 +#, no-wrap +msgid "{Scheme Procedure} open-connection [@var{uri}] [#:reserve-space? #t]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4423 +msgid "Connect to the daemon over the Unix-domain socket at @var{uri} (a string). When @var{reserve-space?} is true, instruct it to reserve a little bit of extra space on the file system so that the garbage collector can still operate should the disk become full. Return a server object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4426 +msgid "@var{file} defaults to @var{%default-socket-path}, which is the normal location given the options that were passed to @command{configure}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4428 +#, no-wrap +msgid "{Scheme Procedure} close-connection @var{server}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4430 +msgid "Close the connection to @var{server}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4432 +#, no-wrap +msgid "{Scheme Variable} current-build-output-port" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4435 +msgid "This variable is bound to a SRFI-39 parameter, which refers to the port where build and error logs sent by the daemon should be written." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4439 +msgid "Procedures that make RPCs all take a server object as their first argument." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4440 +#, no-wrap +msgid "{Scheme Procedure} valid-path? @var{server} @var{path}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4441 +#, no-wrap +msgid "invalid store items" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4446 +msgid "Return @code{#t} when @var{path} designates a valid store item and @code{#f} otherwise (an invalid item may exist on disk but still be invalid, for instance because it is the result of an aborted or failed build.)" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4449 +msgid "A @code{&nix-protocol-error} condition is raised if @var{path} is not prefixed by the store directory (@file{/gnu/store})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4451 +#, no-wrap +msgid "{Scheme Procedure} add-text-to-store @var{server} @var{name} @var{text} [@var{references}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4455 +msgid "Add @var{text} under file @var{name} in the store, and return its store path. @var{references} is the list of store paths referred to by the resulting store path." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4457 +#, no-wrap +msgid "{Scheme Procedure} build-derivations @var{server} @var{derivations}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4461 +msgid "Build @var{derivations} (a list of @code{<derivation>} objects or derivation paths), and return when the worker is done building them. Return @code{#t} on success." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4467 +msgid "Note that the @code{(guix monads)} module provides a monad as well as monadic versions of the above procedures, with the goal of making it more convenient to work with code that accesses the store (@pxref{The Store Monad})." +msgstr "" + +#. type: i{#1} +#: doc/guix.texi:4470 +msgid "This section is currently incomplete." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4474 +#, no-wrap +msgid "derivations" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4478 +msgid "Low-level build actions and the environment in which they are performed are represented by @dfn{derivations}. A derivation contains the following pieces of information:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:4483 +msgid "The outputs of the derivation---derivations produce at least one file or directory in the store, but may produce more." +msgstr "" + +#. type: itemize +#: doc/guix.texi:4487 +msgid "The inputs of the derivations, which may be other derivations or plain files in the store (patches, build scripts, etc.)" +msgstr "" + +#. type: itemize +#: doc/guix.texi:4490 +msgid "The system type targeted by the derivation---e.g., @code{x86_64-linux}." +msgstr "" + +#. type: itemize +#: doc/guix.texi:4494 +msgid "The file name of a build script in the store, along with the arguments to be passed." +msgstr "" + +#. type: itemize +#: doc/guix.texi:4497 +msgid "A list of environment variables to be defined." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4500 +#, no-wrap +msgid "derivation path" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4508 +msgid "Derivations allow clients of the daemon to communicate build actions to the store. They exist in two forms: as an in-memory representation, both on the client- and daemon-side, and as files in the store whose name end in @code{.drv}---these files are referred to as @dfn{derivation paths}. Derivations paths can be passed to the @code{build-derivations} procedure to perform the build actions they prescribe (@pxref{The Store})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4509 +#, no-wrap +msgid "fixed-output derivations" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4516 +msgid "Operations such as file downloads and version-control checkouts for which the expected content hash is known in advance are modeled as @dfn{fixed-output derivations}. Unlike regular derivations, the outputs of a fixed-output derivation are independent of its inputs---e.g., a source code download produces the same result regardless of the download method and tools being used." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4521 +msgid "The @code{(guix derivations)} module provides a representation of derivations as Scheme objects, along with procedures to create and otherwise manipulate derivations. The lowest-level primitive to create a derivation is the @code{derivation} procedure:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4522 +#, no-wrap +msgid "{Scheme Procedure} derivation @var{store} @var{name} @var{builder} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4531 +msgid "@var{args} [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:inputs '()] [#:env-vars '()] @ [#:system (%current-system)] [#:references-graphs #f] @ [#:allowed-references #f] [#:disallowed-references #f] @ [#:leaked-env-vars #f] [#:local-build? #f] @ [#:substitutable? #t] Build a derivation with the given arguments, and return the resulting @code{<derivation>} object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4538 +msgid "When @var{hash} and @var{hash-algo} are given, a @dfn{fixed-output derivation} is created---i.e., one whose result is known in advance, such as a file download. If, in addition, @var{recursive?} is true, then that fixed output may be an executable file or a directory and @var{hash} must be the hash of an archive containing this output." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4543 +msgid "When @var{references-graphs} is true, it must be a list of file name/store path pairs. In that case, the reference graph of each store path is exported in the build environment in the corresponding file, in a simple text format." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4548 +msgid "When @var{allowed-references} is true, it must be a list of store items or outputs that the derivation's output may refer to. Likewise, @var{disallowed-references}, if true, must be a list of things the outputs may @emph{not} refer to." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4555 +msgid "When @var{leaked-env-vars} is true, it must be a list of strings denoting environment variables that are allowed to ``leak'' from the daemon's environment to the build environment. This is only applicable to fixed-output derivations---i.e., when @var{hash} is true. The main use is to allow variables such as @code{http_proxy} to be passed to derivations that download files." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4560 +msgid "When @var{local-build?} is true, declare that the derivation is not a good candidate for offloading and should rather be built locally (@pxref{Daemon Offload Setup}). This is the case for small derivations where the costs of data transfers would outweigh the benefits." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4565 +msgid "When @var{substitutable?} is false, declare that substitutes of the derivation's output should not be used (@pxref{Substitutes}). This is useful, for instance, when building packages that capture details of the host CPU instruction set." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4571 +msgid "Here's an example with a shell script as its builder, assuming @var{store} is an open connection to the daemon, and @var{bash} points to a Bash executable in the store:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:4576 +#, no-wrap +msgid "" +"(use-modules (guix utils)\n" +" (guix store)\n" +" (guix derivations))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:4585 +#, no-wrap +msgid "" +"(let ((builder ; add the Bash script to the store\n" +" (add-text-to-store store \"my-builder.sh\"\n" +" \"echo hello world > $out\\n\" '())))\n" +" (derivation store \"foo\"\n" +" bash `(\"-e\" ,builder)\n" +" #:inputs `((,bash) (,builder))\n" +" #:env-vars '((\"HOME\" . \"/homeless\"))))\n" +"@result{} #<derivation /gnu/store/@dots{}-foo.drv => /gnu/store/@dots{}-foo>\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4592 +msgid "As can be guessed, this primitive is cumbersome to use directly. A better approach is to write build scripts in Scheme, of course! The best course of action for that is to write the build code as a ``G-expression'', and to pass it to @code{gexp->derivation}. For more information, @pxref{G-Expressions}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4597 +msgid "Once upon a time, @code{gexp->derivation} did not exist and constructing derivations with build code written in Scheme was achieved with @code{build-expression->derivation}, documented below. This procedure is now deprecated in favor of the much nicer @code{gexp->derivation}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4598 +#, no-wrap +msgid "{Scheme Procedure} build-expression->derivation @var{store} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4614 +msgid "@var{name} @var{exp} @ [#:system (%current-system)] [#:inputs '()] @ [#:outputs '(\"out\")] [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] Return a derivation that executes Scheme expression @var{exp} as a builder for derivation @var{name}. @var{inputs} must be a list of @code{(name drv-path sub-drv)} tuples; when @var{sub-drv} is omitted, @code{\"out\"} is assumed. @var{modules} is a list of names of Guile modules from the current search path to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4622 +msgid "@var{exp} is evaluated in an environment where @code{%outputs} is bound to a list of output/path pairs, and where @code{%build-inputs} is bound to a list of string/output-path pairs made from @var{inputs}. Optionally, @var{env-vars} is a list of string pairs specifying the name and value of environment variables visible to the builder. The builder terminates by passing the result of @var{exp} to @code{exit}; thus, when @var{exp} returns @code{#f}, the build is considered to have failed." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4626 +msgid "@var{exp} is built using @var{guile-for-build} (a derivation). When @var{guile-for-build} is omitted or is @code{#f}, the value of the @code{%guile-for-build} fluid is used instead." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4631 +msgid "See the @code{derivation} procedure for the meaning of @var{references-graphs}, @var{allowed-references}, @var{disallowed-references}, @var{local-build?}, and @var{substitutable?}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4636 +msgid "Here's an example of a single-output derivation that creates a directory containing one file:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:4644 +#, no-wrap +msgid "" +"(let ((builder '(let ((out (assoc-ref %outputs \"out\")))\n" +" (mkdir out) ; create /gnu/store/@dots{}-goo\n" +" (call-with-output-file (string-append out \"/test\")\n" +" (lambda (p)\n" +" (display '(hello guix) p))))))\n" +" (build-expression->derivation store \"goo\" builder))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:4646 +#, no-wrap +msgid "@result{} #<derivation /gnu/store/@dots{}-goo.drv => @dots{}>\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4652 +#, no-wrap +msgid "monad" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4658 +msgid "The procedures that operate on the store described in the previous sections all take an open connection to the build daemon as their first argument. Although the underlying model is functional, they either have side effects or depend on the current state of the store." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4664 +msgid "The former is inconvenient: the connection to the build daemon has to be carried around in all those functions, making it impossible to compose functions that do not take that parameter with functions that do. The latter can be problematic: since store operations have side effects and/or depend on external state, they have to be properly sequenced." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4665 +#, no-wrap +msgid "monadic values" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4666 +#, no-wrap +msgid "monadic functions" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4676 +msgid "This is where the @code{(guix monads)} module comes in. This module provides a framework for working with @dfn{monads}, and a particularly useful monad for our uses, the @dfn{store monad}. Monads are a construct that allows two things: associating ``context'' with values (in our case, the context is the store), and building sequences of computations (here computations include accesses to the store). Values in a monad---values that carry this additional context---are called @dfn{monadic values}; procedures that return such values are called @dfn{monadic procedures}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4678 +msgid "Consider this ``normal'' procedure:" +msgstr "" + +#. type: example +#: doc/guix.texi:4687 +#, no-wrap +msgid "" +"(define (sh-symlink store)\n" +" ;; Return a derivation that symlinks the 'bash' executable.\n" +" (let* ((drv (package-derivation store bash))\n" +" (out (derivation->output-path drv))\n" +" (sh (string-append out \"/bin/bash\")))\n" +" (build-expression->derivation store \"sh\"\n" +" `(symlink ,sh %output))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4691 +msgid "Using @code{(guix monads)} and @code{(guix gexp)}, it may be rewritten as a monadic function:" +msgstr "" + +#. type: example +#: doc/guix.texi:4699 +#, no-wrap +msgid "" +"(define (sh-symlink)\n" +" ;; Same, but return a monadic value.\n" +" (mlet %store-monad ((drv (package->derivation bash)))\n" +" (gexp->derivation \"sh\"\n" +" #~(symlink (string-append #$drv \"/bin/bash\")\n" +" #$output))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4706 +msgid "There are several things to note in the second version: the @code{store} parameter is now implicit and is ``threaded'' in the calls to the @code{package->derivation} and @code{gexp->derivation} monadic procedures, and the monadic value returned by @code{package->derivation} is @dfn{bound} using @code{mlet} instead of plain @code{let}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4710 +msgid "As it turns out, the call to @code{package->derivation} can even be omitted since it will take place implicitly, as we will see later (@pxref{G-Expressions}):" +msgstr "" + +#. type: example +#: doc/guix.texi:4716 +#, no-wrap +msgid "" +"(define (sh-symlink)\n" +" (gexp->derivation \"sh\"\n" +" #~(symlink (string-append #$bash \"/bin/bash\")\n" +" #$output)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4725 +msgid "Calling the monadic @code{sh-symlink} has no effect. As someone once said, ``you exit a monad like you exit a building on fire: by running''. So, to exit the monad and get the desired effect, one must use @code{run-with-store}:" +msgstr "" + +#. type: example +#: doc/guix.texi:4729 +#, no-wrap +msgid "" +"(run-with-store (open-connection) (sh-symlink))\n" +"@result{} /gnu/store/...-sh-symlink\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4735 +msgid "Note that the @code{(guix monad-repl)} module extends the Guile REPL with new ``meta-commands'' to make it easier to deal with monadic procedures: @code{run-in-store}, and @code{enter-store-monad}. The former is used to ``run'' a single monadic value through the store:" +msgstr "" + +#. type: example +#: doc/guix.texi:4739 +#, no-wrap +msgid "" +"scheme@@(guile-user)> ,run-in-store (package->derivation hello)\n" +"$1 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4743 +msgid "The latter enters a recursive REPL, where all the return values are automatically run through the store:" +msgstr "" + +#. type: example +#: doc/guix.texi:4752 +#, no-wrap +msgid "" +"scheme@@(guile-user)> ,enter-store-monad\n" +"store-monad@@(guile-user) [1]> (package->derivation hello)\n" +"$2 = #<derivation /gnu/store/@dots{}-hello-2.9.drv => @dots{}>\n" +"store-monad@@(guile-user) [1]> (text-file \"foo\" \"Hello!\")\n" +"$3 = \"/gnu/store/@dots{}-foo\"\n" +"store-monad@@(guile-user) [1]> ,q\n" +"scheme@@(guile-user)>\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4757 +msgid "Note that non-monadic values cannot be returned in the @code{store-monad} REPL." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4760 +msgid "The main syntactic forms to deal with monads in general are provided by the @code{(guix monads)} module and are described below." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4761 +#, no-wrap +msgid "{Scheme Syntax} with-monad @var{monad} @var{body} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4764 +msgid "Evaluate any @code{>>=} or @code{return} forms in @var{body} as being in @var{monad}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4766 +#, no-wrap +msgid "{Scheme Syntax} return @var{val}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4768 +msgid "Return a monadic value that encapsulates @var{val}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4770 +#, no-wrap +msgid "{Scheme Syntax} >>= @var{mval} @var{mproc} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4777 +msgid "@dfn{Bind} monadic value @var{mval}, passing its ``contents'' to monadic procedures @var{mproc}@dots{}@footnote{This operation is commonly referred to as ``bind'', but that name denotes an unrelated procedure in Guile. Thus we use this somewhat cryptic symbol inherited from the Haskell language.}. There can be one @var{mproc} or several of them, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:4785 +#, no-wrap +msgid "" +"(run-with-state\n" +" (with-monad %state-monad\n" +" (>>= (return 1)\n" +" (lambda (x) (return (+ 1 x)))\n" +" (lambda (x) (return (* 2 x)))))\n" +" 'some-state)\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:4788 +#, no-wrap +msgid "" +"@result{} 4\n" +"@result{} some-state\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4791 +#, no-wrap +msgid "{Scheme Syntax} mlet @var{monad} ((@var{var} @var{mval}) ...) @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4793 +msgid "@var{body} ..." +msgstr "" + +#. type: deffnx +#: doc/guix.texi:4793 +#, no-wrap +msgid "{Scheme Syntax} mlet* @var{monad} ((@var{var} @var{mval}) ...) @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4805 +msgid "@var{body} ... Bind the variables @var{var} to the monadic values @var{mval} in @var{body}, which is a sequence of expressions. As with the bind operator, this can be thought of as ``unpacking'' the raw, non-monadic value ``contained'' in @var{mval} and making @var{var} refer to that raw, non-monadic value within the scope of the @var{body}. The form (@var{var} -> @var{val}) binds @var{var} to the ``normal'' value @var{val}, as per @code{let}. The binding operations occur in sequence from left to right. The last expression of @var{body} must be a monadic expression, and its result will become the result of the @code{mlet} or @code{mlet*} when run in the @var{monad}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4808 +msgid "@code{mlet*} is to @code{mlet} what @code{let*} is to @code{let} (@pxref{Local Bindings,,, guile, GNU Guile Reference Manual})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4810 +#, no-wrap +msgid "{Scheme System} mbegin @var{monad} @var{mexp} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4814 +msgid "Bind @var{mexp} and the following monadic expressions in sequence, returning the result of the last expression. Every expression in the sequence must be a monadic expression." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4818 +msgid "This is akin to @code{mlet}, except that the return values of the monadic expressions are ignored. In that sense, it is analogous to @code{begin}, but applied to monadic expressions." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4820 +#, no-wrap +msgid "{Scheme System} mwhen @var{condition} @var{mexp0} @var{mexp*} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4825 +msgid "When @var{condition} is true, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is false, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4827 +#, no-wrap +msgid "{Scheme System} munless @var{condition} @var{mexp0} @var{mexp*} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4832 +msgid "When @var{condition} is false, evaluate the sequence of monadic expressions @var{mexp0}..@var{mexp*} as in an @code{mbegin}. When @var{condition} is true, return @code{*unspecified*} in the current monad. Every expression in the sequence must be a monadic expression." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4834 +#, no-wrap +msgid "state monad" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4838 +msgid "The @code{(guix monads)} module provides the @dfn{state monad}, which allows an additional value---the state---to be @emph{threaded} through monadic procedure calls." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4839 +#, no-wrap +msgid "{Scheme Variable} %state-monad" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4842 +msgid "The state monad. Procedures in the state monad can access and change the state that is threaded." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4846 +msgid "Consider the example below. The @code{square} procedure returns a value in the state monad. It returns the square of its argument, but also increments the current state value:" +msgstr "" + +#. type: example +#: doc/guix.texi:4853 +#, no-wrap +msgid "" +"(define (square x)\n" +" (mlet %state-monad ((count (current-state)))\n" +" (mbegin %state-monad\n" +" (set-current-state (+ 1 count))\n" +" (return (* x x)))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:4857 +#, no-wrap +msgid "" +"(run-with-state (sequence %state-monad (map square (iota 3))) 0)\n" +"@result{} (0 1 4)\n" +"@result{} 3\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4861 +msgid "When ``run'' through @var{%state-monad}, we obtain that additional state value, which is the number of @code{square} calls." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4863 +#, no-wrap +msgid "{Monadic Procedure} current-state" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4865 +msgid "Return the current state as a monadic value." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4867 +#, no-wrap +msgid "{Monadic Procedure} set-current-state @var{value}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4870 +msgid "Set the current state to @var{value} and return the previous state as a monadic value." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4872 +#, no-wrap +msgid "{Monadic Procedure} state-push @var{value}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4875 +msgid "Push @var{value} to the current state, which is assumed to be a list, and return the previous state as a monadic value." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4877 +#, no-wrap +msgid "{Monadic Procedure} state-pop" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4880 +msgid "Pop a value from the current state and return it as a monadic value. The state is assumed to be a list." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4882 +#, no-wrap +msgid "{Scheme Procedure} run-with-state @var{mval} [@var{state}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4885 +msgid "Run monadic value @var{mval} starting with @var{state} as the initial state. Return two values: the resulting value, and the resulting state." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4889 +msgid "The main interface to the store monad, provided by the @code{(guix store)} module, is as follows." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4890 +#, no-wrap +msgid "{Scheme Variable} %store-monad" +msgstr "" + +#. type: defvr +#: doc/guix.texi:4892 +msgid "The store monad---an alias for @var{%state-monad}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:4896 +msgid "Values in the store monad encapsulate accesses to the store. When its effect is needed, a value of the store monad must be ``evaluated'' by passing it to the @code{run-with-store} procedure (see below.)" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4898 +#, no-wrap +msgid "{Scheme Procedure} run-with-store @var{store} @var{mval} [#:guile-for-build] [#:system (%current-system)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4901 +msgid "Run @var{mval}, a monadic value in the store monad, in @var{store}, an open store connection." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4903 +#, no-wrap +msgid "{Monadic Procedure} text-file @var{name} @var{text} [@var{references}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4907 +msgid "Return as a monadic value the absolute file name in the store of the file containing @var{text}, a string. @var{references} is a list of store items that the resulting text file refers to; it defaults to the empty list." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4909 +#, no-wrap +msgid "{Monadic Procedure} interned-file @var{file} [@var{name}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4914 +msgid "[#:recursive? #t] [#:select? (const #t)] Return the name of @var{file} once interned in the store. Use @var{name} as its store name, or the basename of @var{file} if @var{name} is omitted." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4918 doc/guix.texi:5330 +msgid "When @var{recursive?} is true, the contents of @var{file} are added recursively; if @var{file} designates a flat file and @var{recursive?} is true, its contents are added, and its permission bits are kept." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4923 doc/guix.texi:5335 +msgid "When @var{recursive?} is true, call @code{(@var{select?} @var{file} @var{stat})} for each directory entry, where @var{file} is the entry's absolute file name and @var{stat} is the result of @code{lstat}; exclude entries for which @var{select?} does not return true." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4925 +msgid "The example below adds a file to the store, under two different names:" +msgstr "" + +#. type: example +#: doc/guix.texi:4931 +#, no-wrap +msgid "" +"(run-with-store (open-connection)\n" +" (mlet %store-monad ((a (interned-file \"README\"))\n" +" (b (interned-file \"README\" \"LEGU-MIN\")))\n" +" (return (list a b))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:4933 +#, no-wrap +msgid "@result{} (\"/gnu/store/rwm@dots{}-README\" \"/gnu/store/44i@dots{}-LEGU-MIN\")\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4939 +msgid "The @code{(guix packages)} module exports the following package-related monadic procedures:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4940 +#, no-wrap +msgid "{Monadic Procedure} package-file @var{package} [@var{file}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4948 +msgid "[#:system (%current-system)] [#:target #f] @ [#:output \"out\"] Return as a monadic value in the absolute file name of @var{file} within the @var{output} directory of @var{package}. When @var{file} is omitted, return the name of the @var{output} directory of @var{package}. When @var{target} is true, use it as a cross-compilation target triplet." +msgstr "" + +#. type: deffn +#: doc/guix.texi:4950 +#, no-wrap +msgid "{Monadic Procedure} package->derivation @var{package} [@var{system}]" +msgstr "" + +#. type: deffnx +#: doc/guix.texi:4951 +#, no-wrap +msgid "{Monadic Procedure} package->cross-derivation @var{package} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:4955 +msgid "@var{target} [@var{system}] Monadic version of @code{package-derivation} and @code{package-cross-derivation} (@pxref{Defining Packages})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4961 +#, no-wrap +msgid "G-expression" +msgstr "" + +#. type: cindex +#: doc/guix.texi:4962 +#, no-wrap +msgid "build code quoting" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4968 +msgid "So we have ``derivations'', which represent a sequence of build actions to be performed to produce an item in the store (@pxref{Derivations}). These build actions are performed when asking the daemon to actually build the derivations; they are run by the daemon in a container (@pxref{Invoking guix-daemon})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:4969 +#, no-wrap +msgid "strata of code" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4981 +msgid "It should come as no surprise that we like to write these build actions in Scheme. When we do that, we end up with two @dfn{strata} of Scheme code@footnote{The term @dfn{stratum} in this context was coined by Manuel Serrano et al.@: in the context of their work on Hop. Oleg Kiselyov, who has written insightful @url{http://okmij.org/ftp/meta-programming/#meta-scheme, essays and code on this topic}, refers to this kind of code generation as @dfn{staging}.}: the ``host code''---code that defines packages, talks to the daemon, etc.---and the ``build code''---code that actually performs build actions, such as making directories, invoking @command{make}, etc." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4988 +msgid "To describe a derivation and its build actions, one typically needs to embed build code inside host code. It boils down to manipulating build code as data, and the homoiconicity of Scheme---code has a direct representation as data---comes in handy for that. But we need more than the normal @code{quasiquote} mechanism in Scheme to construct build expressions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:4997 +msgid "The @code{(guix gexp)} module implements @dfn{G-expressions}, a form of S-expressions adapted to build expressions. G-expressions, or @dfn{gexps}, consist essentially of three syntactic forms: @code{gexp}, @code{ungexp}, and @code{ungexp-splicing} (or simply: @code{#~}, @code{#$}, and @code{#$@@}), which are comparable to @code{quasiquote}, @code{unquote}, and @code{unquote-splicing}, respectively (@pxref{Expression Syntax, @code{quasiquote},, guile, GNU Guile Reference Manual}). However, there are major differences:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:5002 +msgid "Gexps are meant to be written to a file and run or manipulated by other processes." +msgstr "" + +#. type: itemize +#: doc/guix.texi:5007 +msgid "When a high-level object such as a package or derivation is unquoted inside a gexp, the result is as if its output file name had been introduced." +msgstr "" + +#. type: itemize +#: doc/guix.texi:5012 +msgid "Gexps carry information about the packages or derivations they refer to, and these dependencies are automatically added as inputs to the build processes that use them." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5014 doc/guix.texi:5517 +#, no-wrap +msgid "lowering, of high-level objects in gexps" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5024 +msgid "This mechanism is not limited to package and derivation objects: @dfn{compilers} able to ``lower'' other high-level objects to derivations or files in the store can be defined, such that these objects can also be inserted into gexps. For example, a useful type of high-level objects that can be inserted in a gexp is ``file-like objects'', which make it easy to add files to the store and to refer to them in derivations and such (see @code{local-file} and @code{plain-file} below.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5026 +msgid "To illustrate the idea, here is an example of a gexp:" +msgstr "" + +#. type: example +#: doc/guix.texi:5034 +#, no-wrap +msgid "" +"(define build-exp\n" +" #~(begin\n" +" (mkdir #$output)\n" +" (chdir #$output)\n" +" (symlink (string-append #$coreutils \"/bin/ls\")\n" +" \"list-files\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5039 +msgid "This gexp can be passed to @code{gexp->derivation}; we obtain a derivation that builds a directory containing exactly one symlink to @file{/gnu/store/@dots{}-coreutils-8.22/bin/ls}:" +msgstr "" + +#. type: example +#: doc/guix.texi:5042 +#, no-wrap +msgid "(gexp->derivation \"the-thing\" build-exp)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5050 +msgid "As one would expect, the @code{\"/gnu/store/@dots{}-coreutils-8.22\"} string is substituted to the reference to the @var{coreutils} package in the actual build code, and @var{coreutils} is automatically made an input to the derivation. Likewise, @code{#$output} (equivalent to @code{(ungexp output)}) is replaced by a string containing the directory name of the output of the derivation." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5051 +#, no-wrap +msgid "cross compilation" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5057 +msgid "In a cross-compilation context, it is useful to distinguish between references to the @emph{native} build of a package---that can run on the host---versus references to cross builds of a package. To that end, the @code{#+} plays the same role as @code{#$}, but is a reference to a native package build:" +msgstr "" + +#. type: example +#: doc/guix.texi:5067 +#, no-wrap +msgid "" +"(gexp->derivation \"vi\"\n" +" #~(begin\n" +" (mkdir #$output)\n" +" (system* (string-append #+coreutils \"/bin/ln\")\n" +" \"-s\"\n" +" (string-append #$emacs \"/bin/emacs\")\n" +" (string-append #$output \"/bin/vi\")))\n" +" #:target \"mips64el-linux-gnu\")\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5073 +msgid "In the example above, the native build of @var{coreutils} is used, so that @command{ln} can actually run on the host; but then the cross-compiled build of @var{emacs} is referenced." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5074 +#, no-wrap +msgid "imported modules, for gexps" +msgstr "" + +#. type: findex +#: doc/guix.texi:5075 +#, no-wrap +msgid "with-imported-modules" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5080 +msgid "Another gexp feature is @dfn{imported modules}: sometimes you want to be able to use certain Guile modules from the ``host environment'' in the gexp, so those modules should be imported in the ``build environment''. The @code{with-imported-modules} form allows you to express that:" +msgstr "" + +#. type: example +#: doc/guix.texi:5091 +#, no-wrap +msgid "" +"(let ((build (with-imported-modules '((guix build utils))\n" +" #~(begin\n" +" (use-modules (guix build utils))\n" +" (mkdir-p (string-append #$output \"/bin\"))))))\n" +" (gexp->derivation \"empty-dir\"\n" +" #~(begin\n" +" #$build\n" +" (display \"success!\\n\")\n" +" #t)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5097 +msgid "In this example, the @code{(guix build utils)} module is automatically pulled into the isolated build environment of our gexp, such that @code{(use-modules (guix build utils))} works as expected." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5098 +#, no-wrap +msgid "module closure" +msgstr "" + +#. type: findex +#: doc/guix.texi:5099 +#, no-wrap +msgid "source-module-closure" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5106 +msgid "Usually you want the @emph{closure} of the module to be imported---i.e., the module itself and all the modules it depends on---rather than just the module; failing to do that, attempts to use the module will fail because of missing dependent modules. The @code{source-module-closure} procedure computes the closure of a module by looking at its source file headers, which comes in handy in this case:" +msgstr "" + +#. type: example +#: doc/guix.texi:5109 +#, no-wrap +msgid "" +"(use-modules (guix modules)) ;for 'source-module-closure'\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:5118 +#, no-wrap +msgid "" +"(with-imported-modules (source-module-closure\n" +" '((guix build utils)\n" +" (gnu build vm)))\n" +" (gexp->derivation \"something-with-vms\"\n" +" #~(begin\n" +" (use-modules (guix build utils)\n" +" (gnu build vm))\n" +" @dots{})))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:5120 +#, no-wrap +msgid "extensions, for gexps" +msgstr "" + +#. type: findex +#: doc/guix.texi:5121 +#, no-wrap +msgid "with-extensions" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5126 +msgid "In the same vein, sometimes you want to import not just pure-Scheme modules, but also ``extensions'' such as Guile bindings to C libraries or other ``full-blown'' packages. Say you need the @code{guile-json} package available on the build side, here's how you would do it:" +msgstr "" + +#. type: example +#: doc/guix.texi:5129 +#, no-wrap +msgid "" +"(use-modules (gnu packages guile)) ;for 'guile-json'\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:5135 +#, no-wrap +msgid "" +"(with-extensions (list guile-json)\n" +" (gexp->derivation \"something-with-json\"\n" +" #~(begin\n" +" (use-modules (json))\n" +" @dots{})))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5138 +msgid "The syntactic form to construct gexps is summarized below." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5139 +#, no-wrap +msgid "{Scheme Syntax} #~@var{exp}" +msgstr "" + +#. type: deffnx +#: doc/guix.texi:5140 +#, no-wrap +msgid "{Scheme Syntax} (gexp @var{exp})" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5143 +msgid "Return a G-expression containing @var{exp}. @var{exp} may contain one or more of the following forms:" +msgstr "" + +#. type: item +#: doc/guix.texi:5145 +#, no-wrap +msgid "#$@var{obj}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5146 +#, no-wrap +msgid "(ungexp @var{obj})" +msgstr "" + +#. type: table +#: doc/guix.texi:5151 +msgid "Introduce a reference to @var{obj}. @var{obj} may have one of the supported types, for example a package or a derivation, in which case the @code{ungexp} form is replaced by its output file name---e.g., @code{\"/gnu/store/@dots{}-coreutils-8.22}." +msgstr "" + +#. type: table +#: doc/guix.texi:5154 +msgid "If @var{obj} is a list, it is traversed and references to supported objects are substituted similarly." +msgstr "" + +#. type: table +#: doc/guix.texi:5157 +msgid "If @var{obj} is another gexp, its contents are inserted and its dependencies are added to those of the containing gexp." +msgstr "" + +#. type: table +#: doc/guix.texi:5159 +msgid "If @var{obj} is another kind of object, it is inserted as is." +msgstr "" + +#. type: item +#: doc/guix.texi:5160 +#, no-wrap +msgid "#$@var{obj}:@var{output}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5161 +#, no-wrap +msgid "(ungexp @var{obj} @var{output})" +msgstr "" + +#. type: table +#: doc/guix.texi:5165 +msgid "This is like the form above, but referring explicitly to the @var{output} of @var{obj}---this is useful when @var{obj} produces multiple outputs (@pxref{Packages with Multiple Outputs})." +msgstr "" + +#. type: item +#: doc/guix.texi:5166 +#, no-wrap +msgid "#+@var{obj}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5167 +#, no-wrap +msgid "#+@var{obj}:output" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5168 +#, no-wrap +msgid "(ungexp-native @var{obj})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5169 +#, no-wrap +msgid "(ungexp-native @var{obj} @var{output})" +msgstr "" + +#. type: table +#: doc/guix.texi:5172 +msgid "Same as @code{ungexp}, but produces a reference to the @emph{native} build of @var{obj} when used in a cross compilation context." +msgstr "" + +#. type: item +#: doc/guix.texi:5173 +#, no-wrap +msgid "#$output[:@var{output}]" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5174 +#, no-wrap +msgid "(ungexp output [@var{output}])" +msgstr "" + +#. type: table +#: doc/guix.texi:5177 +msgid "Insert a reference to derivation output @var{output}, or to the main output when @var{output} is omitted." +msgstr "" + +#. type: table +#: doc/guix.texi:5179 +msgid "This only makes sense for gexps passed to @code{gexp->derivation}." +msgstr "" + +#. type: item +#: doc/guix.texi:5180 +#, no-wrap +msgid "#$@@@var{lst}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5181 +#, no-wrap +msgid "(ungexp-splicing @var{lst})" +msgstr "" + +#. type: table +#: doc/guix.texi:5184 +msgid "Like the above, but splices the contents of @var{lst} inside the containing list." +msgstr "" + +#. type: item +#: doc/guix.texi:5185 +#, no-wrap +msgid "#+@@@var{lst}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5186 +#, no-wrap +msgid "(ungexp-native-splicing @var{lst})" +msgstr "" + +#. type: table +#: doc/guix.texi:5189 +msgid "Like the above, but refers to native builds of the objects listed in @var{lst}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5194 +msgid "G-expressions created by @code{gexp} or @code{#~} are run-time objects of the @code{gexp?} type (see below.)" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5196 +#, no-wrap +msgid "{Scheme Syntax} with-imported-modules @var{modules} @var{body}@dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5199 +msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{modules} in their execution environment." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5203 +msgid "Each item in @var{modules} can be the name of a module, such as @code{(guix build utils)}, or it can be a module name, followed by an arrow, followed by a file-like object:" +msgstr "" + +#. type: example +#: doc/guix.texi:5209 +#, no-wrap +msgid "" +"`((guix build utils)\n" +" (guix gcrypt)\n" +" ((guix config) => ,(scheme-file \"config.scm\"\n" +" #~(define-module @dots{}))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5214 +msgid "In the example above, the first two modules are taken from the search path, and the last one is created from the given file-like object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5218 +msgid "This form has @emph{lexical} scope: it has an effect on the gexps directly defined in @var{body}@dots{}, but not on those defined, say, in procedures called from @var{body}@dots{}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5220 +#, no-wrap +msgid "{Scheme Syntax} with-extensions @var{extensions} @var{body}@dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5225 +msgid "Mark the gexps defined in @var{body}@dots{} as requiring @var{extensions} in their build and execution environment. @var{extensions} is typically a list of package objects such as those defined in the @code{(gnu packages guile)} module." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5230 +msgid "Concretely, the packages listed in @var{extensions} are added to the load path while compiling imported modules in @var{body}@dots{}; they are also added to the load path of the gexp returned by @var{body}@dots{}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5232 +#, no-wrap +msgid "{Scheme Procedure} gexp? @var{obj}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5234 +msgid "Return @code{#t} if @var{obj} is a G-expression." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5240 +msgid "G-expressions are meant to be written to disk, either as code building some derivation, or as plain files in the store. The monadic procedures below allow you to do that (@pxref{The Store Monad}, for more information about monads.)" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5241 +#, no-wrap +msgid "{Monadic Procedure} gexp->derivation @var{name} @var{exp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5258 +msgid "[#:system (%current-system)] [#:target #f] [#:graft? #t] @ [#:hash #f] [#:hash-algo #f] @ [#:recursive? #f] [#:env-vars '()] [#:modules '()] @ [#:module-path @var{%load-path}] @ [#:effective-version \"2.2\"] @ [#:references-graphs #f] [#:allowed-references #f] @ [#:disallowed-references #f] @ [#:leaked-env-vars #f] @ [#:script-name (string-append @var{name} \"-builder\")] @ [#:deprecation-warnings #f] @ [#:local-build? #f] [#:substitutable? #t] [#:guile-for-build #f] Return a derivation @var{name} that runs @var{exp} (a gexp) with @var{guile-for-build} (a derivation) on @var{system}; @var{exp} is stored in a file called @var{script-name}. When @var{target} is true, it is used as the cross-compilation target triplet for packages referred to by @var{exp}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5266 +msgid "@var{modules} is deprecated in favor of @code{with-imported-modules}. Its meaning is to make @var{modules} available in the evaluation context of @var{exp}; @var{modules} is a list of names of Guile modules searched in @var{module-path} to be copied in the store, compiled, and made available in the load path during the execution of @var{exp}---e.g., @code{((guix build utils) (guix build gnu-build-system))}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5269 +msgid "@var{effective-version} determines the string to use when adding extensions of @var{exp} (see @code{with-extensions}) to the search path---e.g., @code{\"2.2\"}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5272 +msgid "@var{graft?} determines whether packages referred to by @var{exp} should be grafted when applicable." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5275 +msgid "When @var{references-graphs} is true, it must be a list of tuples of one of the following forms:" +msgstr "" + +#. type: example +#: doc/guix.texi:5282 +#, no-wrap +msgid "" +"(@var{file-name} @var{package})\n" +"(@var{file-name} @var{package} @var{output})\n" +"(@var{file-name} @var{derivation})\n" +"(@var{file-name} @var{derivation} @var{output})\n" +"(@var{file-name} @var{store-item})\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5288 +msgid "The right-hand-side of each element of @var{references-graphs} is automatically made an input of the build process of @var{exp}. In the build environment, each @var{file-name} contains the reference graph of the corresponding item, in a simple text format." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5294 +msgid "@var{allowed-references} must be either @code{#f} or a list of output names and packages. In the latter case, the list denotes store items that the result is allowed to refer to. Any reference to another store item will lead to a build error. Similarly for @var{disallowed-references}, which can list items that must not be referenced by the outputs." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5297 +msgid "@var{deprecation-warnings} determines whether to show deprecation warnings while compiling modules. It can be @code{#f}, @code{#t}, or @code{'detailed}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5299 +msgid "The other arguments are as for @code{derivation} (@pxref{Derivations})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5301 +#, no-wrap +msgid "file-like objects" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5306 +msgid "The @code{local-file}, @code{plain-file}, @code{computed-file}, @code{program-file}, and @code{scheme-file} procedures below return @dfn{file-like objects}. That is, when unquoted in a G-expression, these objects lead to a file in the store. Consider this G-expression:" +msgstr "" + +#. type: example +#: doc/guix.texi:5310 +#, no-wrap +msgid "" +"#~(system* #$(file-append glibc \"/sbin/nscd\") \"-f\"\n" +" #$(local-file \"/tmp/my-nscd.conf\"))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5319 +msgid "The effect here is to ``intern'' @file{/tmp/my-nscd.conf} by copying it to the store. Once expanded, for instance @i{via} @code{gexp->derivation}, the G-expression refers to that copy under @file{/gnu/store}; thus, modifying or removing the file in @file{/tmp} does not have any effect on what the G-expression does. @code{plain-file} can be used similarly; it differs in that the file content is directly passed as a string." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5320 +#, no-wrap +msgid "{Scheme Procedure} local-file @var{file} [@var{name}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5326 +msgid "[#:recursive? #f] [#:select? (const #t)] Return an object representing local file @var{file} to add to the store; this object can be used in a gexp. If @var{file} is a relative file name, it is looked up relative to the source file where this form appears. @var{file} will be added to the store under @var{name}--by default the base name of @var{file}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5338 +msgid "This is the declarative counterpart of the @code{interned-file} monadic procedure (@pxref{The Store Monad, @code{interned-file}})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5340 +#, no-wrap +msgid "{Scheme Procedure} plain-file @var{name} @var{content}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5343 +msgid "Return an object representing a text file called @var{name} with the given @var{content} (a string) to be added to the store." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5345 +msgid "This is the declarative counterpart of @code{text-file}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5347 +#, no-wrap +msgid "{Scheme Procedure} computed-file @var{name} @var{gexp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5352 +msgid "[#:options '(#:local-build? #t)] Return an object representing the store item @var{name}, a file or directory computed by @var{gexp}. @var{options} is a list of additional arguments to pass to @code{gexp->derivation}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5354 +msgid "This is the declarative counterpart of @code{gexp->derivation}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5356 +#, no-wrap +msgid "{Monadic Procedure} gexp->script @var{name} @var{exp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5361 +msgid "[#:guile (default-guile)] [#:module-path %load-path] Return an executable script @var{name} that runs @var{exp} using @var{guile}, with @var{exp}'s imported modules in its search path. Look up @var{exp}'s modules in @var{module-path}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5364 +msgid "The example below builds a script that simply invokes the @command{ls} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:5367 +#, no-wrap +msgid "" +"(use-modules (guix gexp) (gnu packages base))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:5371 +#, no-wrap +msgid "" +"(gexp->script \"list-files\"\n" +" #~(execl #$(file-append coreutils \"/bin/ls\")\n" +" \"ls\"))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5376 +msgid "When ``running'' it through the store (@pxref{The Store Monad, @code{run-with-store}}), we obtain a derivation that produces an executable file @file{/gnu/store/@dots{}-list-files} along these lines:" +msgstr "" + +#. type: example +#: doc/guix.texi:5381 +#, no-wrap +msgid "" +"#!/gnu/store/@dots{}-guile-2.0.11/bin/guile -ds\n" +"!#\n" +"(execl \"/gnu/store/@dots{}-coreutils-8.22\"/bin/ls\" \"ls\")\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5384 +#, no-wrap +msgid "{Scheme Procedure} program-file @var{name} @var{exp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5389 +msgid "[#:guile #f] [#:module-path %load-path] Return an object representing the executable store item @var{name} that runs @var{gexp}. @var{guile} is the Guile package used to execute that script. Imported modules of @var{gexp} are looked up in @var{module-path}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5391 +msgid "This is the declarative counterpart of @code{gexp->script}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5393 +#, no-wrap +msgid "{Monadic Procedure} gexp->file @var{name} @var{exp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5400 +msgid "[#:set-load-path? #t] [#:module-path %load-path] @ [#:splice? #f] @ [#:guile (default-guile)] Return a derivation that builds a file @var{name} containing @var{exp}. When @var{splice?} is true, @var{exp} is considered to be a list of expressions that will be spliced in the resulting file." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5405 +msgid "When @var{set-load-path?} is true, emit code in the resulting file to set @code{%load-path} and @code{%load-compiled-path} to honor @var{exp}'s imported modules. Look up @var{exp}'s modules in @var{module-path}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5408 +msgid "The resulting file holds references to all the dependencies of @var{exp} or a subset thereof." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5410 +#, no-wrap +msgid "{Scheme Procedure} scheme-file @var{name} @var{exp} [#:splice? #f]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5413 +msgid "Return an object representing the Scheme file @var{name} that contains @var{exp}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5415 +msgid "This is the declarative counterpart of @code{gexp->file}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5417 +#, no-wrap +msgid "{Monadic Procedure} text-file* @var{name} @var{text} @dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5423 +msgid "Return as a monadic value a derivation that builds a text file containing all of @var{text}. @var{text} may list, in addition to strings, objects of any type that can be used in a gexp: packages, derivations, local file objects, etc. The resulting store file holds references to all these." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5428 +msgid "This variant should be preferred over @code{text-file} anytime the file to create will reference items from the store. This is typically the case when building a configuration file that embeds store file names, like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:5436 +#, no-wrap +msgid "" +"(define (profile.sh)\n" +" ;; Return the name of a shell script in the store that\n" +" ;; initializes the 'PATH' environment variable.\n" +" (text-file* \"profile.sh\"\n" +" \"export PATH=\" coreutils \"/bin:\"\n" +" grep \"/bin:\" sed \"/bin\\n\"))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5441 +msgid "In this example, the resulting @file{/gnu/store/@dots{}-profile.sh} file will reference @var{coreutils}, @var{grep}, and @var{sed}, thereby preventing them from being garbage-collected during its lifetime." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5443 +#, no-wrap +msgid "{Scheme Procedure} mixed-text-file @var{name} @var{text} @dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5447 +msgid "Return an object representing store file @var{name} containing @var{text}. @var{text} is a sequence of strings and file-like objects, as in:" +msgstr "" + +#. type: example +#: doc/guix.texi:5451 +#, no-wrap +msgid "" +"(mixed-text-file \"profile\"\n" +" \"export PATH=\" coreutils \"/bin:\" grep \"/bin\")\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5454 +msgid "This is the declarative counterpart of @code{text-file*}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5456 +#, no-wrap +msgid "{Scheme Procedure} file-union @var{name} @var{files}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5461 +msgid "Return a @code{<computed-file>} that builds a directory containing all of @var{files}. Each item in @var{files} must be a two-element list where the first element is the file name to use in the new directory, and the second element is a gexp denoting the target file. Here's an example:" +msgstr "" + +#. type: example +#: doc/guix.texi:5468 +#, no-wrap +msgid "" +"(file-union \"etc\"\n" +" `((\"hosts\" ,(plain-file \"hosts\"\n" +" \"127.0.0.1 localhost\"))\n" +" (\"bashrc\" ,(plain-file \"bashrc\"\n" +" \"alias ls='ls --color'\"))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5471 +msgid "This yields an @code{etc} directory containing these two files." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5473 +#, no-wrap +msgid "{Scheme Procedure} directory-union @var{name} @var{things}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5476 +msgid "Return a directory that is the union of @var{things}, where @var{things} is a list of file-like objects denoting directories. For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:5479 +#, no-wrap +msgid "(directory-union \"guile+emacs\" (list guile emacs))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5482 +msgid "yields a directory that is the union of the @code{guile} and @code{emacs} packages." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5484 +#, no-wrap +msgid "{Scheme Procedure} file-append @var{obj} @var{suffix} @dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5488 +msgid "Return a file-like object that expands to the concatenation of @var{obj} and @var{suffix}, where @var{obj} is a lowerable object and each @var{suffix} is a string." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5490 +msgid "As an example, consider this gexp:" +msgstr "" + +#. type: example +#: doc/guix.texi:5495 +#, no-wrap +msgid "" +"(gexp->script \"run-uname\"\n" +" #~(system* #$(file-append coreutils\n" +" \"/bin/uname\")))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5498 +msgid "The same effect could be achieved with:" +msgstr "" + +#. type: example +#: doc/guix.texi:5503 +#, no-wrap +msgid "" +"(gexp->script \"run-uname\"\n" +" #~(system* (string-append #$coreutils\n" +" \"/bin/uname\")))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5509 +msgid "There is one difference though: in the @code{file-append} case, the resulting script contains the absolute file name as a string, whereas in the second case, the resulting script contains a @code{(string-append @dots{})} expression to construct the file name @emph{at run time}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5516 +msgid "Of course, in addition to gexps embedded in ``host'' code, there are also modules containing build tools. To make it clear that they are meant to be used in the build stratum, these modules are kept in the @code{(guix build @dots{})} name space." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5522 +msgid "Internally, high-level objects are @dfn{lowered}, using their compiler, to either derivations or store items. For instance, lowering a package yields a derivation, and lowering a @code{plain-file} yields a store item. This is achieved using the @code{lower-object} monadic procedure." +msgstr "" + +#. type: deffn +#: doc/guix.texi:5523 +#, no-wrap +msgid "{Monadic Procedure} lower-object @var{obj} [@var{system}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:5529 +msgid "[#:target #f] Return as a value in @var{%store-monad} the derivation or store item corresponding to @var{obj} for @var{system}, cross-compiling for @var{target} if @var{target} is true. @var{obj} must be an object that has an associated gexp compiler, such as a @code{<package>}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5540 +msgid "This section describes Guix command-line utilities. Some of them are primarily targeted at developers and users who write new package definitions, while others are more generally useful. They complement the Scheme programming interface of Guix in a convenient way." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5562 +#, no-wrap +msgid "package building" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:5563 +#, no-wrap +msgid "guix build" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5569 +msgid "The @command{guix build} command builds packages or derivations and their dependencies, and prints the resulting store paths. Note that it does not modify the user's profile---this is the job of the @command{guix package} command (@pxref{Invoking guix package}). Thus, it is mainly useful for distribution developers." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5571 doc/guix.texi:6235 doc/guix.texi:6302 doc/guix.texi:6995 +#: doc/guix.texi:7333 doc/guix.texi:7663 doc/guix.texi:7968 doc/guix.texi:8034 +#: doc/guix.texi:8073 +msgid "The general syntax is:" +msgstr "" + +#. type: example +#: doc/guix.texi:5574 +#, no-wrap +msgid "guix build @var{options} @var{package-or-derivation}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5579 +msgid "As an example, the following command builds the latest versions of Emacs and of Guile, displays their build logs, and finally displays the resulting directories:" +msgstr "" + +#. type: example +#: doc/guix.texi:5582 +#, no-wrap +msgid "guix build emacs guile\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5585 +msgid "Similarly, the following command builds all the available packages:" +msgstr "" + +#. type: example +#: doc/guix.texi:5589 +#, no-wrap +msgid "" +"guix build --quiet --keep-going \\\n" +" `guix package -A | cut -f1,2 --output-delimiter=@@`\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5597 +msgid "@var{package-or-derivation} may be either the name of a package found in the software distribution such as @code{coreutils} or @code{coreutils@@8.20}, or a derivation such as @file{/gnu/store/@dots{}-coreutils-8.19.drv}. In the former case, a package with the corresponding name (and optionally version) is searched for among the GNU distribution modules (@pxref{Package Modules})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5602 +msgid "Alternatively, the @code{--expression} option may be used to specify a Scheme expression that evaluates to a package; this is useful when disambiguating among several same-named packages or package variants is needed." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5605 +msgid "There may be zero or more @var{options}. The available options are described in the subsections below." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5620 +msgid "A number of options that control the build process are common to @command{guix build} and other commands that can spawn builds, such as @command{guix package} or @command{guix archive}. These are the following:" +msgstr "" + +#. type: item +#: doc/guix.texi:5623 +#, no-wrap +msgid "--load-path=@var{directory}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5624 +#, no-wrap +msgid "-L @var{directory}" +msgstr "" + +#. type: table +#: doc/guix.texi:5627 +msgid "Add @var{directory} to the front of the package module search path (@pxref{Package Modules})." +msgstr "" + +#. type: table +#: doc/guix.texi:5630 +msgid "This allows users to define their own packages and make them visible to the command-line tools." +msgstr "" + +#. type: item +#: doc/guix.texi:5631 +#, no-wrap +msgid "--keep-failed" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5632 +#, no-wrap +msgid "-K" +msgstr "" + +#. type: table +#: doc/guix.texi:5638 +msgid "Keep the build tree of failed builds. Thus, if a build fails, its build tree is kept under @file{/tmp}, in a directory whose name is shown at the end of the build log. This is useful when debugging build issues. @xref{Debugging Build Failures}, for tips and tricks on how to debug build issues." +msgstr "" + +#. type: item +#: doc/guix.texi:5639 +#, no-wrap +msgid "--keep-going" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5640 +#, no-wrap +msgid "-k" +msgstr "" + +#. type: table +#: doc/guix.texi:5643 +msgid "Keep going when some of the derivations fail to build; return only once all the builds have either completed or failed." +msgstr "" + +#. type: table +#: doc/guix.texi:5646 +msgid "The default behavior is to stop as soon as one of the specified derivations has failed." +msgstr "" + +#. type: item +#: doc/guix.texi:5647 +#, no-wrap +msgid "--dry-run" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5648 +#, no-wrap +msgid "-n" +msgstr "" + +#. type: table +#: doc/guix.texi:5650 +msgid "Do not build the derivations." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:5652 +msgid "fallback-option" +msgstr "" + +#. type: item +#: doc/guix.texi:5652 +#, no-wrap +msgid "--fallback" +msgstr "" + +#. type: table +#: doc/guix.texi:5655 +msgid "When substituting a pre-built binary fails, fall back to building packages locally (@pxref{Substitution Failure})." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:5661 +msgid "client-substitute-urls" +msgstr "" + +#. type: table +#: doc/guix.texi:5661 +msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs, overriding the default list of URLs of @command{guix-daemon} (@pxref{daemon-substitute-urls,, @command{guix-daemon} URLs})." +msgstr "" + +#. type: table +#: doc/guix.texi:5665 +msgid "This means that substitutes may be downloaded from @var{urls}, provided they are signed by a key authorized by the system administrator (@pxref{Substitutes})." +msgstr "" + +#. type: table +#: doc/guix.texi:5668 +msgid "When @var{urls} is the empty string, substitutes are effectively disabled." +msgstr "" + +#. type: item +#: doc/guix.texi:5674 +#, no-wrap +msgid "--no-grafts" +msgstr "" + +#. type: table +#: doc/guix.texi:5678 +msgid "Do not ``graft'' packages. In practice, this means that package updates available as grafts are not applied. @xref{Security Updates}, for more information on grafts." +msgstr "" + +#. type: item +#: doc/guix.texi:5679 +#, no-wrap +msgid "--rounds=@var{n}" +msgstr "" + +#. type: table +#: doc/guix.texi:5682 +msgid "Build each derivation @var{n} times in a row, and raise an error if consecutive build results are not bit-for-bit identical." +msgstr "" + +#. type: table +#: doc/guix.texi:5687 +msgid "This is a useful way to detect non-deterministic builds processes. Non-deterministic build processes are a problem because they make it practically impossible for users to @emph{verify} whether third-party binaries are genuine. @xref{Invoking guix challenge}, for more." +msgstr "" + +#. type: table +#: doc/guix.texi:5693 +msgid "Note that, currently, the differing build results are not kept around, so you will have to manually investigate in case of an error---e.g., by stashing one of the build results with @code{guix archive --export} (@pxref{Invoking guix archive}), then rebuilding, and finally comparing the two results." +msgstr "" + +#. type: table +#: doc/guix.texi:5698 +msgid "Do not attempt to offload builds @i{via} the ``build hook'' of the daemon (@pxref{Daemon Offload Setup}). That is, always build things locally instead of offloading builds to remote machines." +msgstr "Nicht versuchen, Erstellungen über den »Build-Hook« des Daemons auszulagern (@pxref{Daemon Offload Setup}). Somit wird lokal erstellt, statt Erstellungen auf entfernte Maschinen auszulagern." + +#. type: table +#: doc/guix.texi:5705 +msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @code{--max-silent-time}})." +msgstr "" + +#. type: table +#: doc/guix.texi:5712 +msgid "By default, the daemon's setting is honored (@pxref{Invoking guix-daemon, @code{--timeout}})." +msgstr "" + +#. type: item +#: doc/guix.texi:5713 +#, no-wrap +msgid "--verbosity=@var{level}" +msgstr "" + +#. type: table +#: doc/guix.texi:5717 +msgid "Use the given verbosity level. @var{level} must be an integer between 0 and 5; higher means more verbose output. Setting a level of 4 or more may be helpful when debugging setup issues with the build daemon." +msgstr "" + +#. type: table +#: doc/guix.texi:5722 +msgid "Allow the use of up to @var{n} CPU cores for the build. The special value @code{0} means to use as many CPU cores as available." +msgstr "" + +#. type: table +#: doc/guix.texi:5728 +msgid "Allow at most @var{n} build jobs in parallel. @xref{Invoking guix-daemon, @code{--max-jobs}}, for details about this option and the equivalent @command{guix-daemon} option." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5735 +msgid "Behind the scenes, @command{guix build} is essentially an interface to the @code{package-derivation} procedure of the @code{(guix packages)} module, and to the @code{build-derivations} procedure of the @code{(guix derivations)} module." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5739 +msgid "In addition to options explicitly passed on the command line, @command{guix build} and other @command{guix} commands that support building honor the @code{GUIX_BUILD_OPTIONS} environment variable." +msgstr "" + +#. type: defvr +#: doc/guix.texi:5740 +#, no-wrap +msgid "{Environment Variable} GUIX_BUILD_OPTIONS" +msgstr "" + +#. type: defvr +#: doc/guix.texi:5745 +msgid "Users can define this variable to a list of command line options that will automatically be used by @command{guix build} and other @command{guix} commands that can perform builds, as in the example below:" +msgstr "" + +#. type: example +#: doc/guix.texi:5748 +#, no-wrap +msgid "$ export GUIX_BUILD_OPTIONS=\"--no-substitutes -c 2 -L /foo/bar\"\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:5752 +msgid "These options are parsed independently, and the result is appended to the parsed command-line options." +msgstr "" + +#. type: cindex +#: doc/guix.texi:5758 +#, no-wrap +msgid "package variants" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5766 +msgid "Another set of command-line options supported by @command{guix build} and also @command{guix package} are @dfn{package transformation options}. These are options that make it possible to define @dfn{package variants}---for instance, packages built from different source code. This is a convenient way to create customized packages on the fly without having to type in the definitions of package variants (@pxref{Defining Packages})." +msgstr "" + +#. type: item +#: doc/guix.texi:5769 +#, no-wrap +msgid "--with-source=@var{source}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5770 +#, no-wrap +msgid "--with-source=@var{package}=@var{source}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5771 +#, no-wrap +msgid "--with-source=@var{package}@@@var{version}=@var{source}" +msgstr "" + +#. type: table +#: doc/guix.texi:5776 +msgid "Use @var{source} as the source of @var{package}, and @var{version} as its version number. @var{source} must be a file name or a URL, as for @command{guix download} (@pxref{Invoking guix download})." +msgstr "" + +#. type: table +#: doc/guix.texi:5782 +msgid "When @var{package} is omitted, it is taken to be the package name specified on the command line that matches the base of @var{source}---e.g., if @var{source} is @code{/src/guile-2.0.10.tar.gz}, the corresponding package is @code{guile}." +msgstr "" + +#. type: table +#: doc/guix.texi:5785 +msgid "Likewise, when @var{version} is omitted, the version string is inferred from @var{source}; in the previous example, it is @code{2.0.10}." +msgstr "" + +#. type: table +#: doc/guix.texi:5790 +msgid "This option allows users to try out versions of packages other than the one provided by the distribution. The example below downloads @file{ed-1.7.tar.gz} from a GNU mirror and uses that as the source for the @code{ed} package:" +msgstr "" + +#. type: example +#: doc/guix.texi:5793 +#, no-wrap +msgid "guix build ed --with-source=mirror://gnu/ed/ed-1.7.tar.gz\n" +msgstr "" + +#. type: table +#: doc/guix.texi:5797 +msgid "As a developer, @code{--with-source} makes it easy to test release candidates:" +msgstr "" + +#. type: example +#: doc/guix.texi:5800 +#, no-wrap +msgid "guix build guile --with-source=../guile-2.0.9.219-e1bb7.tar.xz\n" +msgstr "" + +#. type: table +#: doc/guix.texi:5803 +msgid "@dots{} or to build from a checkout in a pristine environment:" +msgstr "" + +#. type: example +#: doc/guix.texi:5807 +#, no-wrap +msgid "" +"$ git clone git://git.sv.gnu.org/guix.git\n" +"$ guix build guix --with-source=guix@@1.0=./guix\n" +msgstr "" + +#. type: item +#: doc/guix.texi:5809 +#, no-wrap +msgid "--with-input=@var{package}=@var{replacement}" +msgstr "" + +#. type: table +#: doc/guix.texi:5814 +msgid "Replace dependency on @var{package} by a dependency on @var{replacement}. @var{package} must be a package name, and @var{replacement} must be a package specification such as @code{guile} or @code{guile@@1.8}." +msgstr "" + +#. type: table +#: doc/guix.texi:5818 +msgid "For instance, the following command builds Guix, but replaces its dependency on the current stable version of Guile with a dependency on the legacy version of Guile, @code{guile@@2.0}:" +msgstr "" + +#. type: example +#: doc/guix.texi:5821 +#, no-wrap +msgid "guix build --with-input=guile=guile@@2.0 guix\n" +msgstr "" + +#. type: table +#: doc/guix.texi:5826 +msgid "This is a recursive, deep replacement. So in this example, both @code{guix} and its dependency @code{guile-json} (which also depends on @code{guile}) get rebuilt against @code{guile@@2.0}." +msgstr "" + +#. type: table +#: doc/guix.texi:5829 +msgid "This is implemented using the @code{package-input-rewriting} Scheme procedure (@pxref{Defining Packages, @code{package-input-rewriting}})." +msgstr "" + +#. type: item +#: doc/guix.texi:5830 +#, no-wrap +msgid "--with-graft=@var{package}=@var{replacement}" +msgstr "" + +#. type: table +#: doc/guix.texi:5836 +msgid "This is similar to @code{--with-input} but with an important difference: instead of rebuilding the whole dependency chain, @var{replacement} is built and then @dfn{grafted} onto the binaries that were initially referring to @var{package}. @xref{Security Updates}, for more information on grafts." +msgstr "" + +#. type: table +#: doc/guix.texi:5840 +msgid "For example, the command below grafts version 3.5.4 of GnuTLS onto Wget and all its dependencies, replacing references to the version of GnuTLS they currently refer to:" +msgstr "" + +#. type: example +#: doc/guix.texi:5843 +#, no-wrap +msgid "guix build --with-graft=gnutls=gnutls@@3.5.4 wget\n" +msgstr "" + +#. type: table +#: doc/guix.texi:5852 +msgid "This has the advantage of being much faster than rebuilding everything. But there is a caveat: it works if and only if @var{package} and @var{replacement} are strictly compatible---for example, if they provide a library, the application binary interface (ABI) of those libraries must be compatible. If @var{replacement} is somehow incompatible with @var{package}, then the resulting package may be unusable. Use with care!" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:5860 +msgid "The command-line options presented below are specific to @command{guix build}." +msgstr "" + +#. type: item +#: doc/guix.texi:5863 +#, no-wrap +msgid "--quiet" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5864 +#, no-wrap +msgid "-q" +msgstr "" + +#. type: table +#: doc/guix.texi:5868 +msgid "Build quietly, without displaying the build log. Upon completion, the build log is kept in @file{/var} (or similar) and can always be retrieved using the @option{--log-file} option." +msgstr "" + +#. type: item +#: doc/guix.texi:5869 +#, no-wrap +msgid "--file=@var{file}" +msgstr "" + +#. type: table +#: doc/guix.texi:5874 +msgid "Build the package or derivation that the code within @var{file} evaluates to." +msgstr "" + +#. type: table +#: doc/guix.texi:5877 +msgid "As an example, @var{file} might contain a package definition like this (@pxref{Defining Packages}):" +msgstr "" + +#. type: table +#: doc/guix.texi:5885 +msgid "Build the package or derivation @var{expr} evaluates to." +msgstr "" + +#. type: table +#: doc/guix.texi:5889 +msgid "For example, @var{expr} may be @code{(@@ (gnu packages guile) guile-1.8)}, which unambiguously designates this specific variant of version 1.8 of Guile." +msgstr "" + +#. type: table +#: doc/guix.texi:5893 +msgid "Alternatively, @var{expr} may be a G-expression, in which case it is used as a build program passed to @code{gexp->derivation} (@pxref{G-Expressions})." +msgstr "" + +#. type: table +#: doc/guix.texi:5897 +msgid "Lastly, @var{expr} may refer to a zero-argument monadic procedure (@pxref{The Store Monad}). The procedure must return a derivation as a monadic value, which is then passed through @code{run-with-store}." +msgstr "" + +#. type: item +#: doc/guix.texi:5898 +#, no-wrap +msgid "--source" +msgstr "" + +#. type: itemx +#: doc/guix.texi:5899 +#, no-wrap +msgid "-S" +msgstr "" + +#. type: table +#: doc/guix.texi:5902 +msgid "Build the source derivations of the packages, rather than the packages themselves." +msgstr "" + +#. type: table +#: doc/guix.texi:5906 +msgid "For instance, @code{guix build -S gcc} returns something like @file{/gnu/store/@dots{}-gcc-4.7.2.tar.bz2}, which is the GCC source tarball." +msgstr "" + +#. type: table +#: doc/guix.texi:5910 +msgid "The returned source tarball is the result of applying any patches and code snippets specified in the package @code{origin} (@pxref{Defining Packages})." +msgstr "" + +#. type: item +#: doc/guix.texi:5911 +#, no-wrap +msgid "--sources" +msgstr "" + +#. type: table +#: doc/guix.texi:5918 +msgid "Fetch and return the source of @var{package-or-derivation} and all their dependencies, recursively. This is a handy way to obtain a local copy of all the source code needed to build @var{packages}, allowing you to eventually build them even without network access. It is an extension of the @code{--source} option and can accept one of the following optional argument values:" +msgstr "" + +#. type: item +#: doc/guix.texi:5920 doc/guix.texi:7184 +#, no-wrap +msgid "package" +msgstr "" + +#. type: table +#: doc/guix.texi:5923 +msgid "This value causes the @code{--sources} option to behave in the same way as the @code{--source} option." +msgstr "" + +#. type: item +#: doc/guix.texi:5924 doc/guix.texi:12103 +#, no-wrap +msgid "all" +msgstr "" + +#. type: table +#: doc/guix.texi:5927 +msgid "Build the source derivations of all packages, including any source that might be listed as @code{inputs}. This is the default value." +msgstr "" + +#. type: example +#: doc/guix.texi:5933 +#, no-wrap +msgid "" +"$ guix build --sources tzdata\n" +"The following derivations will be built:\n" +" /gnu/store/@dots{}-tzdata2015b.tar.gz.drv\n" +" /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n" +msgstr "" + +#. type: item +#: doc/guix.texi:5935 +#, no-wrap +msgid "transitive" +msgstr "" + +#. type: table +#: doc/guix.texi:5939 +msgid "Build the source derivations of all packages, as well of all transitive inputs to the packages. This can be used e.g. to prefetch package source for later offline building." +msgstr "" + +#. type: example +#: doc/guix.texi:5950 +#, no-wrap +msgid "" +"$ guix build --sources=transitive tzdata\n" +"The following derivations will be built:\n" +" /gnu/store/@dots{}-tzcode2015b.tar.gz.drv\n" +" /gnu/store/@dots{}-findutils-4.4.2.tar.xz.drv\n" +" /gnu/store/@dots{}-grep-2.21.tar.xz.drv\n" +" /gnu/store/@dots{}-coreutils-8.23.tar.xz.drv\n" +" /gnu/store/@dots{}-make-4.1.tar.xz.drv\n" +" /gnu/store/@dots{}-bash-4.3.tar.xz.drv\n" +"@dots{}\n" +msgstr "" + +#. type: quotation +#: doc/guix.texi:5963 +msgid "The @code{--system} flag is for @emph{native} compilation and must not be confused with cross-compilation. See @code{--target} below for information on cross-compilation." +msgstr "" + +#. type: table +#: doc/guix.texi:5970 +msgid "An example use of this is on Linux-based systems, which can emulate different personalities. For instance, passing @code{--system=i686-linux} on an @code{x86_64-linux} system or @code{--system=armhf-linux} on an @code{aarch64-linux} system allows you to build packages in a complete 32-bit environment." +msgstr "" + +#. type: quotation +#: doc/guix.texi:5975 +msgid "Building for an @code{armhf-linux} system is unconditionally enabled on @code{aarch64-linux} machines, although certain aarch64 chipsets do not allow for this functionality, notably the ThunderX." +msgstr "" + +#. type: table +#: doc/guix.texi:5981 +msgid "Similarly, when transparent emulation with QEMU and @code{binfmt_misc} is enabled (@pxref{Virtualization Services, @code{qemu-binfmt-service-type}}), you can build for any system for which a QEMU @code{binfmt_misc} handler is installed." +msgstr "" + +#. type: table +#: doc/guix.texi:5985 +msgid "Builds for a system other than that of the machine you are using can also be offloaded to a remote machine of the right architecture. @xref{Daemon Offload Setup}, for more information on offloading." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:5993 +msgid "build-check" +msgstr "" + +#. type: item +#: doc/guix.texi:5993 +#, no-wrap +msgid "--check" +msgstr "" + +#. type: cindex +#: doc/guix.texi:5994 +#, no-wrap +msgid "determinism, checking" +msgstr "" + +#. type: cindex +#: doc/guix.texi:5995 +#, no-wrap +msgid "reproducibility, checking" +msgstr "" + +#. type: table +#: doc/guix.texi:5999 +msgid "Rebuild @var{package-or-derivation}, which are already available in the store, and raise an error if the build results are not bit-for-bit identical." +msgstr "" + +#. type: table +#: doc/guix.texi:6004 +msgid "This mechanism allows you to check whether previously installed substitutes are genuine (@pxref{Substitutes}), or whether the build result of a package is deterministic. @xref{Invoking guix challenge}, for more background information and tools." +msgstr "" + +#. type: item +#: doc/guix.texi:6009 +#, no-wrap +msgid "--repair" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6010 +#, no-wrap +msgid "repairing store items" +msgstr "" + +#. type: table +#: doc/guix.texi:6014 +msgid "Attempt to repair the specified store items, if they are corrupt, by re-downloading or rebuilding them." +msgstr "" + +#. type: table +#: doc/guix.texi:6016 +msgid "This operation is not atomic and thus restricted to @code{root}." +msgstr "" + +#. type: item +#: doc/guix.texi:6017 +#, no-wrap +msgid "--derivations" +msgstr "" + +#. type: table +#: doc/guix.texi:6021 +msgid "Return the derivation paths, not the output paths, of the given packages." +msgstr "" + +#. type: item +#: doc/guix.texi:6022 doc/guix.texi:7441 doc/guix.texi:21109 +#, no-wrap +msgid "--root=@var{file}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6023 doc/guix.texi:7442 doc/guix.texi:21110 +#, no-wrap +msgid "-r @var{file}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6024 +#, no-wrap +msgid "GC roots, adding" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6025 +#, no-wrap +msgid "garbage collector roots, adding" +msgstr "" + +#. type: table +#: doc/guix.texi:6028 doc/guix.texi:21113 +msgid "Make @var{file} a symlink to the result, and register it as a garbage collector root." +msgstr "" + +#. type: table +#: doc/guix.texi:6034 +msgid "Consequently, the results of this @command{guix build} invocation are protected from garbage collection until @var{file} is removed. When that option is omitted, build results are eligible for garbage collection as soon as the build completes. @xref{Invoking guix gc}, for more on GC roots." +msgstr "" + +#. type: item +#: doc/guix.texi:6035 +#, no-wrap +msgid "--log-file" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6036 +#, no-wrap +msgid "build logs, access" +msgstr "" + +#. type: table +#: doc/guix.texi:6040 +msgid "Return the build log file names or URLs for the given @var{package-or-derivation}, or raise an error if build logs are missing." +msgstr "" + +#. type: table +#: doc/guix.texi:6043 +msgid "This works regardless of how packages or derivations are specified. For instance, the following invocations are equivalent:" +msgstr "" + +#. type: example +#: doc/guix.texi:6049 +#, no-wrap +msgid "" +"guix build --log-file `guix build -d guile`\n" +"guix build --log-file `guix build guile`\n" +"guix build --log-file guile\n" +"guix build --log-file -e '(@@ (gnu packages guile) guile-2.0)'\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6054 +msgid "If a log is unavailable locally, and unless @code{--no-substitutes} is passed, the command looks for a corresponding log on one of the substitute servers (as specified with @code{--substitute-urls}.)" +msgstr "" + +#. type: table +#: doc/guix.texi:6057 +msgid "So for instance, imagine you want to see the build log of GDB on MIPS, but you are actually on an @code{x86_64} machine:" +msgstr "" + +#. type: example +#: doc/guix.texi:6061 +#, no-wrap +msgid "" +"$ guix build --log-file gdb -s mips64el-linux\n" +"https://hydra.gnu.org/log/@dots{}-gdb-7.10\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6064 +msgid "You can freely access a huge library of build logs!" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6069 +#, no-wrap +msgid "build failures, debugging" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6075 +msgid "When defining a new package (@pxref{Defining Packages}), you will probably find yourself spending some time debugging and tweaking the build until it succeeds. To do that, you need to operate the build commands yourself in an environment as close as possible to the one the build daemon uses." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6080 +msgid "To that end, the first thing to do is to use the @option{--keep-failed} or @option{-K} option of @command{guix build}, which will keep the failed build tree in @file{/tmp} or whatever directory you specified as @code{TMPDIR} (@pxref{Invoking guix build, @code{--keep-failed}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6086 +msgid "From there on, you can @command{cd} to the failed build tree and source the @file{environment-variables} file, which contains all the environment variable definitions that were in place when the build failed. So let's say you're debugging a build failure in package @code{foo}; a typical session would look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:6093 +#, no-wrap +msgid "" +"$ guix build foo -K\n" +"@dots{} @i{build fails}\n" +"$ cd /tmp/guix-build-foo.drv-0\n" +"$ source ./environment-variables\n" +"$ cd foo-1.2\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6097 +msgid "Now, you can invoke commands as if you were the daemon (almost) and troubleshoot your build process." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6103 +msgid "Sometimes it happens that, for example, a package's tests pass when you run them manually but they fail when the daemon runs them. This can happen because the daemon runs builds in containers where, unlike in our environment above, network access is missing, @file{/bin/sh} does not exist, etc. (@pxref{Build Environment Setup})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6106 +msgid "In such cases, you may need to run inspect the build process from within a container similar to the one the build daemon creates:" +msgstr "" + +#. type: example +#: doc/guix.texi:6114 +#, no-wrap +msgid "" +"$ guix build -K foo\n" +"@dots{}\n" +"$ cd /tmp/guix-build-foo.drv-0\n" +"$ guix environment --no-grafts -C foo --ad-hoc strace gdb\n" +"[env]# source ./environment-variables\n" +"[env]# cd foo-1.2\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6123 +msgid "Here, @command{guix environment -C} creates a container and spawns a new shell in it (@pxref{Invoking guix environment}). The @command{--ad-hoc strace gdb} part adds the @command{strace} and @command{gdb} commands to the container, which would may find handy while debugging. The @option{--no-grafts} option makes sure we get the exact same environment, with ungrafted packages (@pxref{Security Updates}, for more info on grafts)." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6126 +msgid "To get closer to a container like that used by the build daemon, we can remove @file{/bin/sh}:" +msgstr "" + +#. type: example +#: doc/guix.texi:6129 +#, no-wrap +msgid "[env]# rm /bin/sh\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6133 +msgid "(Don't worry, this is harmless: this is all happening in the throw-away container created by @command{guix environment}.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6136 +msgid "The @command{strace} command is probably not in the search path, but we can run:" +msgstr "" + +#. type: example +#: doc/guix.texi:6139 +#, no-wrap +msgid "[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6144 +msgid "In this way, not only you will have reproduced the environment variables the daemon uses, you will also be running the build process in a container similar to the one the daemon uses." +msgstr "" + +#. type: section +#: doc/guix.texi:6147 +#, no-wrap +msgid "Invoking @command{guix edit}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:6149 +#, no-wrap +msgid "guix edit" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6150 +#, no-wrap +msgid "package definition, editing" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6155 +msgid "So many packages, so many source files! The @command{guix edit} command facilitates the life of users and packagers by pointing their editor at the source file containing the definition of the specified packages. For instance:" +msgstr "" + +#. type: example +#: doc/guix.texi:6158 +#, no-wrap +msgid "guix edit gcc@@4.9 vim\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6164 +msgid "launches the program specified in the @code{VISUAL} or in the @code{EDITOR} environment variable to view the recipe of GCC@tie{}4.9.3 and that of Vim." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6170 +msgid "If you are using a Guix Git checkout (@pxref{Building from Git}), or have created your own packages on @code{GUIX_PACKAGE_PATH} (@pxref{Defining Packages}), you will be able to edit the package recipes. Otherwise, you will be able to examine the read-only recipes for packages currently in the store." +msgstr "" + +#. type: section +#: doc/guix.texi:6173 +#, no-wrap +msgid "Invoking @command{guix download}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:6175 +#, no-wrap +msgid "guix download" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6176 +#, no-wrap +msgid "downloading package sources" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6183 +msgid "When writing a package definition, developers typically need to download a source tarball, compute its SHA256 hash, and write that hash in the package definition (@pxref{Defining Packages}). The @command{guix download} tool helps with this task: it downloads a file from the given URI, adds it to the store, and prints both its file name in the store and its SHA256 hash." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6190 +msgid "The fact that the downloaded file is added to the store saves bandwidth: when the developer eventually tries to build the newly defined package with @command{guix build}, the source tarball will not have to be downloaded again because it is already in the store. It is also a convenient way to temporarily stash files, which may be deleted eventually (@pxref{Invoking guix gc})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6198 +msgid "The @command{guix download} command supports the same URIs as used in package definitions. In particular, it supports @code{mirror://} URIs. @code{https} URIs (HTTP over TLS) are supported @emph{provided} the Guile bindings for GnuTLS are available in the user's environment; when they are not available, an error is raised. @xref{Guile Preparations, how to install the GnuTLS bindings for Guile,, gnutls-guile, GnuTLS-Guile}, for more information." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6203 +msgid "@command{guix download} verifies HTTPS server certificates by loading the certificates of X.509 authorities from the directory pointed to by the @code{SSL_CERT_DIR} environment variable (@pxref{X.509 Certificates}), unless @option{--no-check-certificate} is used." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6205 doc/guix.texi:7721 +msgid "The following options are available:" +msgstr "" + +#. type: item +#: doc/guix.texi:6207 doc/guix.texi:6246 +#, no-wrap +msgid "--format=@var{fmt}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6208 doc/guix.texi:6247 +#, no-wrap +msgid "-f @var{fmt}" +msgstr "" + +#. type: table +#: doc/guix.texi:6211 +msgid "Write the hash in the format specified by @var{fmt}. For more information on the valid values for @var{fmt}, @pxref{Invoking guix hash}." +msgstr "" + +#. type: item +#: doc/guix.texi:6212 +#, no-wrap +msgid "--no-check-certificate" +msgstr "" + +#. type: table +#: doc/guix.texi:6214 +msgid "Do not validate the X.509 certificates of HTTPS servers." +msgstr "" + +#. type: table +#: doc/guix.texi:6218 +msgid "When using this option, you have @emph{absolutely no guarantee} that you are communicating with the authentic server responsible for the given URL, which makes you vulnerable to ``man-in-the-middle'' attacks." +msgstr "" + +#. type: item +#: doc/guix.texi:6219 +#, no-wrap +msgid "--output=@var{file}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6220 +#, no-wrap +msgid "-o @var{file}" +msgstr "" + +#. type: table +#: doc/guix.texi:6223 +msgid "Save the downloaded file to @var{file} instead of adding it to the store." +msgstr "" + +#. type: section +#: doc/guix.texi:6226 +#, no-wrap +msgid "Invoking @command{guix hash}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:6228 +#, no-wrap +msgid "guix hash" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6233 +msgid "The @command{guix hash} command computes the SHA256 hash of a file. It is primarily a convenience tool for anyone contributing to the distribution: it computes the cryptographic hash of a file, which can be used in the definition of a package (@pxref{Defining Packages})." +msgstr "" + +#. type: example +#: doc/guix.texi:6238 +#, no-wrap +msgid "guix hash @var{option} @var{file}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6243 +msgid "When @var{file} is @code{-} (a hyphen), @command{guix hash} computes the hash of data read from standard input. @command{guix hash} has the following options:" +msgstr "" + +#. type: table +#: doc/guix.texi:6249 +msgid "Write the hash in the format specified by @var{fmt}." +msgstr "" + +#. type: table +#: doc/guix.texi:6252 +msgid "Supported formats: @code{nix-base32}, @code{base32}, @code{base16} (@code{hex} and @code{hexadecimal} can be used as well)." +msgstr "" + +#. type: table +#: doc/guix.texi:6256 +msgid "If the @option{--format} option is not specified, @command{guix hash} will output the hash in @code{nix-base32}. This representation is used in the definitions of packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6260 +msgid "Compute the hash on @var{file} recursively." +msgstr "" + +#. type: table +#: doc/guix.texi:6269 +msgid "In this case, the hash is computed on an archive containing @var{file}, including its children if it is a directory. Some of the metadata of @var{file} is part of the archive; for instance, when @var{file} is a regular file, the hash is different depending on whether @var{file} is executable or not. Metadata such as time stamps has no impact on the hash (@pxref{Invoking guix archive})." +msgstr "" + +#. type: item +#: doc/guix.texi:6270 +#, no-wrap +msgid "--exclude-vcs" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6271 +#, no-wrap +msgid "-x" +msgstr "" + +#. type: table +#: doc/guix.texi:6274 +msgid "When combined with @option{--recursive}, exclude version control system directories (@file{.bzr}, @file{.git}, @file{.hg}, etc.)" +msgstr "" + +#. type: table +#: doc/guix.texi:6279 +msgid "As an example, here is how you would compute the hash of a Git checkout, which is useful when using the @code{git-fetch} method (@pxref{origin Reference}):" +msgstr "" + +#. type: example +#: doc/guix.texi:6284 +#, no-wrap +msgid "" +"$ git clone http://example.org/foo.git\n" +"$ cd foo\n" +"$ guix hash -rx .\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6288 doc/guix.texi:6293 +#, no-wrap +msgid "Invoking @command{guix import}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6290 +#, no-wrap +msgid "importing packages" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6291 +#, no-wrap +msgid "package import" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6292 +#, no-wrap +msgid "package conversion" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6300 +msgid "The @command{guix import} command is useful for people who would like to add a package to the distribution with as little work as possible---a legitimate demand. The command knows of a few repositories from which it can ``import'' package metadata. The result is a package definition, or a template thereof, in the format we know (@pxref{Defining Packages})." +msgstr "" + +#. type: example +#: doc/guix.texi:6305 +#, no-wrap +msgid "guix import @var{importer} @var{options}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6311 +msgid "@var{importer} specifies the source from which to import package metadata, and @var{options} specifies a package identifier and other options specific to @var{importer}. Currently, the available ``importers'' are:" +msgstr "" + +#. type: item +#: doc/guix.texi:6313 doc/guix.texi:6772 +#, no-wrap +msgid "gnu" +msgstr "" + +#. type: table +#: doc/guix.texi:6317 +msgid "Import metadata for the given GNU package. This provides a template for the latest version of that GNU package, including the hash of its source tarball, and its canonical synopsis and description." +msgstr "" + +#. type: table +#: doc/guix.texi:6320 +msgid "Additional information such as the package dependencies and its license needs to be figured out manually." +msgstr "" + +#. type: table +#: doc/guix.texi:6323 +msgid "For example, the following command returns a package definition for GNU@tie{}Hello:" +msgstr "" + +#. type: example +#: doc/guix.texi:6326 +#, no-wrap +msgid "guix import gnu hello\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6329 doc/guix.texi:6547 doc/guix.texi:6592 doc/guix.texi:6616 +msgid "Specific command-line options are:" +msgstr "" + +#. type: item +#: doc/guix.texi:6331 doc/guix.texi:6873 +#, no-wrap +msgid "--key-download=@var{policy}" +msgstr "" + +#. type: table +#: doc/guix.texi:6335 +msgid "As for @code{guix refresh}, specify the policy to handle missing OpenPGP keys when verifying the package signature. @xref{Invoking guix refresh, @code{--key-download}}." +msgstr "" + +#. type: item +#: doc/guix.texi:6337 doc/guix.texi:6338 doc/guix.texi:6790 +#, no-wrap +msgid "pypi" +msgstr "" + +#. type: table +#: doc/guix.texi:6346 +msgid "Import metadata from the @uref{https://pypi.python.org/, Python Package Index}@footnote{This functionality requires Guile-JSON to be installed. @xref{Requirements}.}. Information is taken from the JSON-formatted description available at @code{pypi.python.org} and usually includes all the relevant information, including package dependencies. For maximum efficiency, it is recommended to install the @command{unzip} utility, so that the importer can unzip Python wheels and gather data from them." +msgstr "" + +#. type: table +#: doc/guix.texi:6349 +msgid "The command below imports metadata for the @code{itsdangerous} Python package:" +msgstr "" + +#. type: example +#: doc/guix.texi:6352 +#, no-wrap +msgid "guix import pypi itsdangerous\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6354 doc/guix.texi:6355 doc/guix.texi:6792 +#, no-wrap +msgid "gem" +msgstr "" + +#. type: table +#: doc/guix.texi:6366 +msgid "Import metadata from @uref{https://rubygems.org/, RubyGems}@footnote{This functionality requires Guile-JSON to be installed. @xref{Requirements}.}. Information is taken from the JSON-formatted description available at @code{rubygems.org} and includes most relevant information, including runtime dependencies. There are some caveats, however. The metadata doesn't distinguish between synopses and descriptions, so the same string is used for both fields. Additionally, the details of non-Ruby dependencies required to build native extensions is unavailable and left as an exercise to the packager." +msgstr "" + +#. type: table +#: doc/guix.texi:6368 +msgid "The command below imports metadata for the @code{rails} Ruby package:" +msgstr "" + +#. type: example +#: doc/guix.texi:6371 +#, no-wrap +msgid "guix import gem rails\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6373 doc/guix.texi:6788 +#, no-wrap +msgid "cpan" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6374 +#, no-wrap +msgid "CPAN" +msgstr "" + +#. type: table +#: doc/guix.texi:6384 +msgid "Import metadata from @uref{https://www.metacpan.org/, MetaCPAN}@footnote{This functionality requires Guile-JSON to be installed. @xref{Requirements}.}. Information is taken from the JSON-formatted metadata provided through @uref{https://fastapi.metacpan.org/, MetaCPAN's API} and includes most relevant information, such as module dependencies. License information should be checked closely. If Perl is available in the store, then the @code{corelist} utility will be used to filter core modules out of the list of dependencies." +msgstr "" + +#. type: table +#: doc/guix.texi:6387 +msgid "The command command below imports metadata for the @code{Acme::Boolean} Perl module:" +msgstr "" + +#. type: example +#: doc/guix.texi:6390 +#, no-wrap +msgid "guix import cpan Acme::Boolean\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6392 doc/guix.texi:6784 +#, no-wrap +msgid "cran" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6393 +#, no-wrap +msgid "CRAN" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6394 +#, no-wrap +msgid "Bioconductor" +msgstr "" + +#. type: table +#: doc/guix.texi:6398 +msgid "Import metadata from @uref{https://cran.r-project.org/, CRAN}, the central repository for the @uref{http://r-project.org, GNU@tie{}R statistical and graphical environment}." +msgstr "" + +#. type: table +#: doc/guix.texi:6400 +msgid "Information is extracted from the @code{DESCRIPTION} file of the package." +msgstr "" + +#. type: table +#: doc/guix.texi:6403 +msgid "The command command below imports metadata for the @code{Cairo} R package:" +msgstr "" + +#. type: example +#: doc/guix.texi:6406 +#, no-wrap +msgid "guix import cran Cairo\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6411 +msgid "When @code{--recursive} is added, the importer will traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix." +msgstr "" + +#. type: table +#: doc/guix.texi:6416 +msgid "When @code{--archive=bioconductor} is added, metadata is imported from @uref{https://www.bioconductor.org/, Bioconductor}, a repository of R packages for for the analysis and comprehension of high-throughput genomic data in bioinformatics." +msgstr "" + +#. type: table +#: doc/guix.texi:6419 +msgid "Information is extracted from the @code{DESCRIPTION} file of a package published on the web interface of the Bioconductor SVN repository." +msgstr "" + +#. type: table +#: doc/guix.texi:6422 +msgid "The command below imports metadata for the @code{GenomicRanges} R package:" +msgstr "" + +#. type: example +#: doc/guix.texi:6425 +#, no-wrap +msgid "guix import cran --archive=bioconductor GenomicRanges\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6427 +#, no-wrap +msgid "texlive" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6428 +#, no-wrap +msgid "TeX Live" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6429 +#, no-wrap +msgid "CTAN" +msgstr "" + +#. type: table +#: doc/guix.texi:6433 +msgid "Import metadata from @uref{http://www.ctan.org/, CTAN}, the comprehensive TeX archive network for TeX packages that are part of the @uref{https://www.tug.org/texlive/, TeX Live distribution}." +msgstr "" + +#. type: table +#: doc/guix.texi:6438 +msgid "Information about the package is obtained through the XML API provided by CTAN, while the source code is downloaded from the SVN repository of the Tex Live project. This is done because the CTAN does not keep versioned archives." +msgstr "" + +#. type: table +#: doc/guix.texi:6441 +msgid "The command command below imports metadata for the @code{fontspec} TeX package:" +msgstr "" + +#. type: example +#: doc/guix.texi:6444 +#, no-wrap +msgid "guix import texlive fontspec\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6450 +msgid "When @code{--archive=DIRECTORY} is added, the source code is downloaded not from the @file{latex} sub-directory of the @file{texmf-dist/source} tree in the TeX Live SVN repository, but from the specified sibling directory under the same root." +msgstr "" + +#. type: table +#: doc/guix.texi:6454 +msgid "The command below imports metadata for the @code{ifxetex} package from CTAN while fetching the sources from the directory @file{texmf/source/generic}:" +msgstr "" + +#. type: example +#: doc/guix.texi:6457 +#, no-wrap +msgid "guix import texlive --archive=generic ifxetex\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6459 +#, no-wrap +msgid "json" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6460 +#, no-wrap +msgid "JSON, import" +msgstr "" + +#. type: table +#: doc/guix.texi:6465 +msgid "Import package metadata from a local JSON file@footnote{This functionality requires Guile-JSON to be installed. @xref{Requirements}.}. Consider the following example package definition in JSON format:" +msgstr "" + +#. type: example +#: doc/guix.texi:6478 +#, no-wrap +msgid "" +"@{\n" +" \"name\": \"hello\",\n" +" \"version\": \"2.10\",\n" +" \"source\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n" +" \"build-system\": \"gnu\",\n" +" \"home-page\": \"https://www.gnu.org/software/hello/\",\n" +" \"synopsis\": \"Hello, GNU world: An example GNU package\",\n" +" \"description\": \"GNU Hello prints a greeting.\",\n" +" \"license\": \"GPL-3.0+\",\n" +" \"native-inputs\": [\"gcc@@6\"]\n" +"@}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6484 +msgid "The field names are the same as for the @code{<package>} record (@xref{Defining Packages}). References to other packages are provided as JSON lists of quoted package specification strings such as @code{guile} or @code{guile@@2.0}." +msgstr "" + +#. type: table +#: doc/guix.texi:6487 +msgid "The importer also supports a more explicit source definition using the common fields for @code{<origin>} records:" +msgstr "" + +#. type: example +#: doc/guix.texi:6500 +#, no-wrap +msgid "" +"@{\n" +" @dots{}\n" +" \"source\": @{\n" +" \"method\": \"url-fetch\",\n" +" \"uri\": \"mirror://gnu/hello/hello-2.10.tar.gz\",\n" +" \"sha256\": @{\n" +" \"base32\": \"0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i\"\n" +" @}\n" +" @}\n" +" @dots{}\n" +"@}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6504 +msgid "The command below reads metadata from the JSON file @code{hello.json} and outputs a package expression:" +msgstr "" + +#. type: example +#: doc/guix.texi:6507 +#, no-wrap +msgid "guix import json hello.json\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6509 +#, no-wrap +msgid "nix" +msgstr "" + +#. type: table +#: doc/guix.texi:6518 +msgid "Import metadata from a local copy of the source of the @uref{http://nixos.org/nixpkgs/, Nixpkgs distribution}@footnote{This relies on the @command{nix-instantiate} command of @uref{http://nixos.org/nix/, Nix}.}. Package definitions in Nixpkgs are typically written in a mixture of Nix-language and Bash code. This command only imports the high-level package structure that is written in the Nix language. It normally includes all the basic fields of a package definition." +msgstr "" + +#. type: table +#: doc/guix.texi:6521 +msgid "When importing a GNU package, the synopsis and descriptions are replaced by their canonical upstream variant." +msgstr "" + +#. type: table +#: doc/guix.texi:6523 +msgid "Usually, you will first need to do:" +msgstr "" + +#. type: example +#: doc/guix.texi:6526 +#, no-wrap +msgid "export NIX_REMOTE=daemon\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6530 +msgid "so that @command{nix-instantiate} does not try to open the Nix database." +msgstr "" + +#. type: table +#: doc/guix.texi:6534 +msgid "As an example, the command below imports the package definition of LibreOffice (more precisely, it imports the definition of the package bound to the @code{libreoffice} top-level attribute):" +msgstr "" + +#. type: example +#: doc/guix.texi:6537 +#, no-wrap +msgid "guix import nix ~/path/to/nixpkgs libreoffice\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6539 doc/guix.texi:6540 doc/guix.texi:6796 +#, no-wrap +msgid "hackage" +msgstr "" + +#. type: table +#: doc/guix.texi:6545 +msgid "Import metadata from the Haskell community's central package archive @uref{https://hackage.haskell.org/, Hackage}. Information is taken from Cabal files and includes all the relevant information, including package dependencies." +msgstr "" + +#. type: item +#: doc/guix.texi:6549 +#, no-wrap +msgid "--stdin" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6550 +#, no-wrap +msgid "-s" +msgstr "" + +#. type: table +#: doc/guix.texi:6552 +msgid "Read a Cabal file from standard input." +msgstr "" + +#. type: item +#: doc/guix.texi:6552 doc/guix.texi:6594 +#, no-wrap +msgid "--no-test-dependencies" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6553 doc/guix.texi:6595 +#, no-wrap +msgid "-t" +msgstr "" + +#. type: table +#: doc/guix.texi:6555 doc/guix.texi:6597 +msgid "Do not include dependencies required only by the test suites." +msgstr "" + +#. type: item +#: doc/guix.texi:6555 +#, no-wrap +msgid "--cabal-environment=@var{alist}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6556 +#, no-wrap +msgid "-e @var{alist}" +msgstr "" + +#. type: table +#: doc/guix.texi:6565 +msgid "@var{alist} is a Scheme alist defining the environment in which the Cabal conditionals are evaluated. The accepted keys are: @code{os}, @code{arch}, @code{impl} and a string representing the name of a flag. The value associated with a flag has to be either the symbol @code{true} or @code{false}. The value associated with other keys has to conform to the Cabal file format definition. The default value associated with the keys @code{os}, @code{arch} and @code{impl} is @samp{linux}, @samp{x86_64} and @samp{ghc}, respectively." +msgstr "" + +#. type: table +#: doc/guix.texi:6570 +msgid "The command below imports metadata for the latest version of the @code{HTTP} Haskell package without including test dependencies and specifying the value of the flag @samp{network-uri} as @code{false}:" +msgstr "" + +#. type: example +#: doc/guix.texi:6573 +#, no-wrap +msgid "guix import hackage -t -e \"'((\\\"network-uri\\\" . false))\" HTTP\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6577 +msgid "A specific package version may optionally be specified by following the package name by an at-sign and a version number as in the following example:" +msgstr "" + +#. type: example +#: doc/guix.texi:6580 +#, no-wrap +msgid "guix import hackage mtl@@2.1.3.1\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6582 doc/guix.texi:6583 doc/guix.texi:6798 +#, no-wrap +msgid "stackage" +msgstr "" + +#. type: table +#: doc/guix.texi:6590 +msgid "The @code{stackage} importer is a wrapper around the @code{hackage} one. It takes a package name, looks up the package version included in a long-term support (LTS) @uref{https://www.stackage.org, Stackage} release and uses the @code{hackage} importer to retrieve its metadata. Note that it is up to you to select an LTS release compatible with the GHC compiler used by Guix." +msgstr "" + +#. type: item +#: doc/guix.texi:6597 +#, no-wrap +msgid "--lts-version=@var{version}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6598 +#, fuzzy, no-wrap +#| msgid "-c @var{n}" +msgid "-r @var{version}" +msgstr "-c @var{n}" + +#. type: table +#: doc/guix.texi:6601 +msgid "@var{version} is the desired LTS release version. If omitted the latest release is used." +msgstr "" + +#. type: table +#: doc/guix.texi:6605 +msgid "The command below imports metadata for the @code{HTTP} Haskell package included in the LTS Stackage release version 7.18:" +msgstr "" + +#. type: example +#: doc/guix.texi:6608 +#, no-wrap +msgid "guix import stackage --lts-version=7.18 HTTP\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6610 doc/guix.texi:6611 doc/guix.texi:6782 +#, no-wrap +msgid "elpa" +msgstr "" + +#. type: table +#: doc/guix.texi:6614 +msgid "Import metadata from an Emacs Lisp Package Archive (ELPA) package repository (@pxref{Packages,,, emacs, The GNU Emacs Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:6618 +#, no-wrap +msgid "--archive=@var{repo}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6619 +#, no-wrap +msgid "-a @var{repo}" +msgstr "" + +#. type: table +#: doc/guix.texi:6623 +msgid "@var{repo} identifies the archive repository from which to retrieve the information. Currently the supported repositories and their identifiers are:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:6627 +msgid "@uref{http://elpa.gnu.org/packages, GNU}, selected by the @code{gnu} identifier. This is the default." +msgstr "" + +#. type: itemize +#: doc/guix.texi:6633 +msgid "Packages from @code{elpa.gnu.org} are signed with one of the keys contained in the GnuPG keyring at @file{share/emacs/25.1/etc/package-keyring.gpg} (or similar) in the @code{emacs} package (@pxref{Package Installation, ELPA package signatures,, emacs, The GNU Emacs Manual})." +msgstr "" + +#. type: itemize +#: doc/guix.texi:6637 +msgid "@uref{http://stable.melpa.org/packages, MELPA-Stable}, selected by the @code{melpa-stable} identifier." +msgstr "" + +#. type: itemize +#: doc/guix.texi:6641 +msgid "@uref{http://melpa.org/packages, MELPA}, selected by the @code{melpa} identifier." +msgstr "" + +#. type: table +#: doc/guix.texi:6648 +msgid "Traverse the dependency graph of the given upstream package recursively and generate package expressions for all those packages that are not yet in Guix." +msgstr "" + +#. type: item +#: doc/guix.texi:6650 doc/guix.texi:6651 doc/guix.texi:6800 +#, no-wrap +msgid "crate" +msgstr "" + +#. type: table +#: doc/guix.texi:6654 +msgid "Import metadata from the crates.io Rust package repository @uref{https://crates.io, crates.io}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6659 +msgid "The structure of the @command{guix import} code is modular. It would be useful to have more importers for other package formats, and your help is welcome here (@pxref{Contributing})." +msgstr "" + +#. type: section +#: doc/guix.texi:6661 +#, no-wrap +msgid "Invoking @command{guix refresh}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:6663 +#, no-wrap +msgid "guix refresh" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6668 +msgid "The primary audience of the @command{guix refresh} command is developers of the GNU software distribution. By default, it reports any packages provided by the distribution that are outdated compared to the latest upstream version, like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:6673 +#, no-wrap +msgid "" +"$ guix refresh\n" +"gnu/packages/gettext.scm:29:13: gettext would be upgraded from 0.18.1.1 to 0.18.2.1\n" +"gnu/packages/glib.scm:77:12: glib would be upgraded from 2.34.3 to 2.37.0\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6677 +msgid "Alternately, one can specify packages to consider, in which case a warning is emitted for packages that lack an updater:" +msgstr "" + +#. type: example +#: doc/guix.texi:6682 +#, no-wrap +msgid "" +"$ guix refresh coreutils guile guile-ssh\n" +"gnu/packages/ssh.scm:205:2: warning: no updater for guile-ssh\n" +"gnu/packages/guile.scm:136:12: guile would be upgraded from 2.0.12 to 2.0.13\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6691 +msgid "@command{guix refresh} browses the upstream repository of each package and determines the highest version number of the releases therein. The command knows how to update specific types of packages: GNU packages, ELPA packages, etc.---see the documentation for @option{--type} below. There are many packages, though, for which it lacks a method to determine whether a new upstream release is available. However, the mechanism is extensible, so feel free to get in touch with us to add a new method!" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6696 +msgid "Sometimes the upstream name differs from the package name used in Guix, and @command{guix refresh} needs a little help. Most updaters honor the @code{upstream-name} property in package definitions, which can be used to that effect:" +msgstr "" + +#. type: example +#: doc/guix.texi:6703 +#, no-wrap +msgid "" +"(define-public network-manager\n" +" (package\n" +" (name \"network-manager\")\n" +" ;; @dots{}\n" +" (properties '((upstream-name . \"NetworkManager\")))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6715 +msgid "When passed @code{--update}, it modifies distribution source files to update the version numbers and source tarball hashes of those package recipes (@pxref{Defining Packages}). This is achieved by downloading each package's latest source tarball and its associated OpenPGP signature, authenticating the downloaded tarball against its signature using @command{gpg}, and finally computing its hash. When the public key used to sign the tarball is missing from the user's keyring, an attempt is made to automatically retrieve it from a public key server; when this is successful, the key is added to the user's keyring; otherwise, @command{guix refresh} reports an error." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6717 +msgid "The following options are supported:" +msgstr "" + +#. type: table +#: doc/guix.texi:6725 doc/guix.texi:7312 +msgid "This is useful to precisely refer to a package, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:6728 +#, no-wrap +msgid "guix refresh -l -e '(@@@@ (gnu packages commencement) glibc-final)'\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6732 +msgid "This command lists the dependents of the ``final'' libc (essentially all the packages.)" +msgstr "" + +#. type: item +#: doc/guix.texi:6733 +#, no-wrap +msgid "--update" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6734 +#, no-wrap +msgid "-u" +msgstr "" + +#. type: table +#: doc/guix.texi:6738 +msgid "Update distribution source files (package recipes) in place. This is usually run from a checkout of the Guix source tree (@pxref{Running Guix Before It Is Installed}):" +msgstr "" + +#. type: example +#: doc/guix.texi:6741 +#, no-wrap +msgid "$ ./pre-inst-env guix refresh -s non-core -u\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6744 +msgid "@xref{Defining Packages}, for more information on package definitions." +msgstr "" + +#. type: item +#: doc/guix.texi:6745 +#, no-wrap +msgid "--select=[@var{subset}]" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6746 +#, no-wrap +msgid "-s @var{subset}" +msgstr "" + +#. type: table +#: doc/guix.texi:6749 +msgid "Select all the packages in @var{subset}, one of @code{core} or @code{non-core}." +msgstr "" + +#. type: table +#: doc/guix.texi:6756 +msgid "The @code{core} subset refers to all the packages at the core of the distribution---i.e., packages that are used to build ``everything else''. This includes GCC, libc, Binutils, Bash, etc. Usually, changing one of these packages in the distribution entails a rebuild of all the others. Thus, such updates are an inconvenience to users in terms of build time or bandwidth used to achieve the upgrade." +msgstr "" + +#. type: table +#: doc/guix.texi:6760 +msgid "The @code{non-core} subset refers to the remaining packages. It is typically useful in cases where an update of the core packages would be inconvenient." +msgstr "" + +#. type: table +#: doc/guix.texi:6765 +msgid "Select all the packages from the manifest in @var{file}. This is useful to check if any packages of the user manifest can be updated." +msgstr "" + +#. type: item +#: doc/guix.texi:6766 +#, no-wrap +msgid "--type=@var{updater}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6767 +#, no-wrap +msgid "-t @var{updater}" +msgstr "" + +#. type: table +#: doc/guix.texi:6770 +msgid "Select only packages handled by @var{updater} (may be a comma-separated list of updaters). Currently, @var{updater} may be one of:" +msgstr "" + +#. type: table +#: doc/guix.texi:6774 +msgid "the updater for GNU packages;" +msgstr "" + +#. type: item +#: doc/guix.texi:6774 +#, no-wrap +msgid "gnome" +msgstr "" + +#. type: table +#: doc/guix.texi:6776 +msgid "the updater for GNOME packages;" +msgstr "" + +#. type: item +#: doc/guix.texi:6776 +#, no-wrap +msgid "kde" +msgstr "" + +#. type: table +#: doc/guix.texi:6778 +msgid "the updater for KDE packages;" +msgstr "" + +#. type: item +#: doc/guix.texi:6778 +#, no-wrap +msgid "xorg" +msgstr "" + +#. type: table +#: doc/guix.texi:6780 +msgid "the updater for X.org packages;" +msgstr "" + +#. type: item +#: doc/guix.texi:6780 +#, no-wrap +msgid "kernel.org" +msgstr "" + +#. type: table +#: doc/guix.texi:6782 +msgid "the updater for packages hosted on kernel.org;" +msgstr "" + +#. type: table +#: doc/guix.texi:6784 +msgid "the updater for @uref{http://elpa.gnu.org/, ELPA} packages;" +msgstr "" + +#. type: table +#: doc/guix.texi:6786 +msgid "the updater for @uref{https://cran.r-project.org/, CRAN} packages;" +msgstr "" + +#. type: item +#: doc/guix.texi:6786 +#, no-wrap +msgid "bioconductor" +msgstr "" + +#. type: table +#: doc/guix.texi:6788 +msgid "the updater for @uref{https://www.bioconductor.org/, Bioconductor} R packages;" +msgstr "" + +#. type: table +#: doc/guix.texi:6790 +msgid "the updater for @uref{http://www.cpan.org/, CPAN} packages;" +msgstr "" + +#. type: table +#: doc/guix.texi:6792 +msgid "the updater for @uref{https://pypi.python.org, PyPI} packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6794 +msgid "the updater for @uref{https://rubygems.org, RubyGems} packages." +msgstr "" + +#. type: item +#: doc/guix.texi:6794 +#, no-wrap +msgid "github" +msgstr "" + +#. type: table +#: doc/guix.texi:6796 +msgid "the updater for @uref{https://github.com, GitHub} packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6798 +msgid "the updater for @uref{https://hackage.haskell.org, Hackage} packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6800 +msgid "the updater for @uref{https://www.stackage.org, Stackage} packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6802 +msgid "the updater for @uref{https://crates.io, Crates} packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6806 +msgid "For instance, the following command only checks for updates of Emacs packages hosted at @code{elpa.gnu.org} and for updates of CRAN packages:" +msgstr "" + +#. type: example +#: doc/guix.texi:6811 +#, no-wrap +msgid "" +"$ guix refresh --type=elpa,cran\n" +"gnu/packages/statistics.scm:819:13: r-testthat would be upgraded from 0.10.0 to 0.11.0\n" +"gnu/packages/emacs.scm:856:13: emacs-auctex would be upgraded from 11.88.6 to 11.88.9\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6817 +msgid "In addition, @command{guix refresh} can be passed one or more package names, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:6820 +#, no-wrap +msgid "$ ./pre-inst-env guix refresh -u emacs idutils gcc@@4.8\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6826 +msgid "The command above specifically updates the @code{emacs} and @code{idutils} packages. The @code{--select} option would have no effect in this case." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6831 +msgid "When considering whether to upgrade a package, it is sometimes convenient to know which packages would be affected by the upgrade and should be checked for compatibility. For this the following option may be used when passing @command{guix refresh} one or more package names:" +msgstr "" + +#. type: item +#: doc/guix.texi:6834 +#, no-wrap +msgid "--list-updaters" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6835 +#, no-wrap +msgid "-L" +msgstr "" + +#. type: table +#: doc/guix.texi:6837 +msgid "List available updaters and exit (see @option{--type} above.)" +msgstr "" + +#. type: table +#: doc/guix.texi:6840 +msgid "For each updater, display the fraction of packages it covers; at the end, display the fraction of packages covered by all these updaters." +msgstr "" + +#. type: item +#: doc/guix.texi:6841 +#, no-wrap +msgid "--list-dependent" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6842 doc/guix.texi:7005 +#, no-wrap +msgid "-l" +msgstr "" + +#. type: table +#: doc/guix.texi:6845 +msgid "List top-level dependent packages that would need to be rebuilt as a result of upgrading one or more packages." +msgstr "" + +#. type: table +#: doc/guix.texi:6849 +msgid "@xref{Invoking guix graph, the @code{reverse-package} type of @command{guix graph}}, for information on how to visualize the list of dependents of a package." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6855 +msgid "Be aware that the @code{--list-dependent} option only @emph{approximates} the rebuilds that would be required as a result of an upgrade. More rebuilds might be required under some circumstances." +msgstr "" + +#. type: example +#: doc/guix.texi:6860 +#, no-wrap +msgid "" +"$ guix refresh --list-dependent flex\n" +"Building the following 120 packages would ensure 213 dependent packages are rebuilt:\n" +"hop@@2.4.0 geiser@@0.4 notmuch@@0.18 mu@@0.9.9.5 cflow@@1.4 idutils@@4.6 @dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6864 +msgid "The command above lists a set of packages that could be built to check for compatibility with an upgraded @code{flex} package." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6866 +msgid "The following options can be used to customize GnuPG operation:" +msgstr "" + +#. type: item +#: doc/guix.texi:6869 +#, no-wrap +msgid "--gpg=@var{command}" +msgstr "" + +#. type: table +#: doc/guix.texi:6872 +msgid "Use @var{command} as the GnuPG 2.x command. @var{command} is searched for in @code{$PATH}." +msgstr "" + +#. type: table +#: doc/guix.texi:6876 +msgid "Handle missing OpenPGP keys according to @var{policy}, which may be one of:" +msgstr "" + +#. type: item +#: doc/guix.texi:6878 doc/guix.texi:14077 +#, no-wrap +msgid "always" +msgstr "" + +#. type: table +#: doc/guix.texi:6881 +msgid "Always download missing OpenPGP keys from the key server, and add them to the user's GnuPG keyring." +msgstr "" + +#. type: item +#: doc/guix.texi:6882 doc/guix.texi:14079 +#, no-wrap +msgid "never" +msgstr "" + +#. type: table +#: doc/guix.texi:6884 +msgid "Never try to download missing OpenPGP keys. Instead just bail out." +msgstr "" + +#. type: item +#: doc/guix.texi:6885 +#, no-wrap +msgid "interactive" +msgstr "" + +#. type: table +#: doc/guix.texi:6888 +msgid "When a package signed with an unknown OpenPGP key is encountered, ask the user whether to download it or not. This is the default behavior." +msgstr "" + +#. type: item +#: doc/guix.texi:6890 +#, no-wrap +msgid "--key-server=@var{host}" +msgstr "" + +#. type: table +#: doc/guix.texi:6892 +msgid "Use @var{host} as the OpenPGP key server when importing a public key." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6905 +msgid "The @code{github} updater uses the @uref{https://developer.github.com/v3/, GitHub API} to query for new releases. When used repeatedly e.g. when refreshing all packages, GitHub will eventually refuse to answer any further API requests. By default 60 API requests per hour are allowed, and a full refresh on all GitHub packages in Guix requires more than this. Authentication with GitHub through the use of an API token alleviates these limits. To use an API token, set the environment variable @code{GUIX_GITHUB_TOKEN} to a token procured from @uref{https://github.com/settings/tokens} or otherwise." +msgstr "" + +#. type: section +#: doc/guix.texi:6908 +#, no-wrap +msgid "Invoking @command{guix lint}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:6910 +#, no-wrap +msgid "guix lint" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6911 +#, no-wrap +msgid "package, checking for errors" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:6917 +msgid "The @command{guix lint} command is meant to help package developers avoid common errors and use a consistent style. It runs a number of checks on a given set of packages in order to find common mistakes in their definitions. Available @dfn{checkers} include (see @code{--list-checkers} for a complete list):" +msgstr "" + +#. type: table +#: doc/guix.texi:6923 +msgid "Validate certain typographical and stylistic rules about package descriptions and synopses." +msgstr "" + +#. type: item +#: doc/guix.texi:6924 +#, no-wrap +msgid "inputs-should-be-native" +msgstr "" + +#. type: table +#: doc/guix.texi:6926 +msgid "Identify inputs that should most likely be native inputs." +msgstr "" + +#. type: itemx +#: doc/guix.texi:6929 +#, no-wrap +msgid "mirror-url" +msgstr "" + +#. type: itemx +#: doc/guix.texi:6930 +#, no-wrap +msgid "source-file-name" +msgstr "" + +#. type: table +#: doc/guix.texi:6936 +msgid "Probe @code{home-page} and @code{source} URLs and report those that are invalid. Suggest a @code{mirror://} URL when applicable. Check that the source file name is meaningful, e.g. is not just a version number or ``git-checkout'', without a declared @code{file-name} (@pxref{origin Reference})." +msgstr "" + +#. type: item +#: doc/guix.texi:6937 +#, no-wrap +msgid "cve" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6938 doc/guix.texi:21969 +#, no-wrap +msgid "security vulnerabilities" +msgstr "" + +#. type: cindex +#: doc/guix.texi:6939 +#, no-wrap +msgid "CVE, Common Vulnerabilities and Exposures" +msgstr "" + +#. type: table +#: doc/guix.texi:6944 +msgid "Report known vulnerabilities found in the Common Vulnerabilities and Exposures (CVE) databases of the current and past year @uref{https://nvd.nist.gov/download.cfm#CVE_FEED, published by the US NIST}." +msgstr "" + +#. type: table +#: doc/guix.texi:6946 +msgid "To view information about a particular vulnerability, visit pages such as:" +msgstr "" + +#. type: indicateurl{#1} +#: doc/guix.texi:6950 +msgid "https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-YYYY-ABCD" +msgstr "" + +#. type: indicateurl{#1} +#: doc/guix.texi:6952 +msgid "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-YYYY-ABCD" +msgstr "" + +#. type: table +#: doc/guix.texi:6957 +msgid "where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g., @code{CVE-2015-7554}." +msgstr "" + +#. type: table +#: doc/guix.texi:6962 +msgid "Package developers can specify in package recipes the @uref{https://nvd.nist.gov/cpe.cfm,Common Platform Enumeration (CPE)} name and version of the package when they differ from the name or version that Guix uses, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:6970 +#, no-wrap +msgid "" +"(package\n" +" (name \"grub\")\n" +" ;; @dots{}\n" +" ;; CPE calls this package \"grub2\".\n" +" (properties '((cpe-name . \"grub2\")\n" +" (cpe-version . \"2.3\")))\n" +msgstr "" + +#. type: table +#: doc/guix.texi:6977 +msgid "Some entries in the CVE database do not specify which version of a package they apply to, and would thus ``stick around'' forever. Package developers who found CVE alerts and verified they can be ignored can declare them as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:6987 +#, no-wrap +msgid "" +"(package\n" +" (name \"t1lib\")\n" +" ;; @dots{}\n" +" ;; These CVEs no longer apply and can be safely ignored.\n" +" (properties `((lint-hidden-cve . (\"CVE-2011-0433\"\n" +" \"CVE-2011-1553\"\n" +" \"CVE-2011-1554\"\n" +" \"CVE-2011-5244\")))))\n" +msgstr "" + +#. type: item +#: doc/guix.texi:6989 +#, no-wrap +msgid "formatting" +msgstr "" + +#. type: table +#: doc/guix.texi:6992 +msgid "Warn about obvious source code formatting issues: trailing white space, use of tabulations, etc." +msgstr "" + +#. type: example +#: doc/guix.texi:6998 +#, no-wrap +msgid "guix lint @var{options} @var{package}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7002 +msgid "If no package is given on the command line, then all packages are checked. The @var{options} may be zero or more of the following:" +msgstr "" + +#. type: item +#: doc/guix.texi:7004 +#, no-wrap +msgid "--list-checkers" +msgstr "" + +#. type: table +#: doc/guix.texi:7008 +msgid "List and describe all the available checkers that will be run on packages and exit." +msgstr "" + +#. type: item +#: doc/guix.texi:7009 +#, no-wrap +msgid "--checkers" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7010 +#, no-wrap +msgid "-c" +msgstr "" + +#. type: table +#: doc/guix.texi:7013 +msgid "Only enable the checkers specified in a comma-separated list using the names returned by @code{--list-checkers}." +msgstr "" + +#. type: section +#: doc/guix.texi:7017 +#, no-wrap +msgid "Invoking @command{guix size}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7019 +#, no-wrap +msgid "size" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7020 +#, no-wrap +msgid "package size" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:7022 +#, no-wrap +msgid "guix size" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7029 +msgid "The @command{guix size} command helps package developers profile the disk usage of packages. It is easy to overlook the impact of an additional dependency added to a package, or the impact of using a single output for a package that could easily be split (@pxref{Packages with Multiple Outputs}). Such are the typical issues that @command{guix size} can highlight." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7034 +msgid "The command can be passed one or more package specifications such as @code{gcc@@4.8} or @code{guile:debug}, or a file name in the store. Consider this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:7047 +#, no-wrap +msgid "" +"$ guix size coreutils\n" +"store item total self\n" +"/gnu/store/@dots{}-gcc-5.5.0-lib 60.4 30.1 38.1%\n" +"/gnu/store/@dots{}-glibc-2.27 30.3 28.8 36.6%\n" +"/gnu/store/@dots{}-coreutils-8.28 78.9 15.0 19.0%\n" +"/gnu/store/@dots{}-gmp-6.1.2 63.1 2.7 3.4%\n" +"/gnu/store/@dots{}-bash-static-4.4.12 1.5 1.5 1.9%\n" +"/gnu/store/@dots{}-acl-2.2.52 61.1 0.4 0.5%\n" +"/gnu/store/@dots{}-attr-2.4.47 60.6 0.2 0.3%\n" +"/gnu/store/@dots{}-libcap-2.25 60.5 0.2 0.2%\n" +"total: 78.9 MiB\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7053 +msgid "The store items listed here constitute the @dfn{transitive closure} of Coreutils---i.e., Coreutils and all its dependencies, recursively---as would be returned by:" +msgstr "" + +#. type: example +#: doc/guix.texi:7056 +#, no-wrap +msgid "$ guix gc -R /gnu/store/@dots{}-coreutils-8.23\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7064 +msgid "Here the output shows three columns next to store items. The first column, labeled ``total'', shows the size in mebibytes (MiB) of the closure of the store item---that is, its own size plus the size of all its dependencies. The next column, labeled ``self'', shows the size of the item itself. The last column shows the ratio of the size of the item itself to the space occupied by all the items listed here." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7070 +msgid "In this example, we see that the closure of Coreutils weighs in at 79@tie{}MiB, most of which is taken by libc and GCC's run-time support libraries. (That libc and GCC's libraries represent a large fraction of the closure is not a problem @i{per se} because they are always available on the system anyway.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7079 +msgid "When the package(s) passed to @command{guix size} are available in the store@footnote{More precisely, @command{guix size} looks for the @emph{ungrafted} variant of the given package(s), as returned by @code{guix build @var{package} --no-grafts}. @xref{Security Updates}, for information on grafts.}, @command{guix size} queries the daemon to determine its dependencies, and measures its size in the store, similar to @command{du -ms --apparent-size} (@pxref{du invocation,,, coreutils, GNU Coreutils})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7084 +msgid "When the given packages are @emph{not} in the store, @command{guix size} reports information based on the available substitutes (@pxref{Substitutes}). This makes it possible it to profile disk usage of store items that are not even on disk, only available remotely." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7086 +msgid "You can also specify several package names:" +msgstr "" + +#. type: example +#: doc/guix.texi:7096 +#, no-wrap +msgid "" +"$ guix size coreutils grep sed bash\n" +"store item total self\n" +"/gnu/store/@dots{}-coreutils-8.24 77.8 13.8 13.4%\n" +"/gnu/store/@dots{}-grep-2.22 73.1 0.8 0.8%\n" +"/gnu/store/@dots{}-bash-4.3.42 72.3 4.7 4.6%\n" +"/gnu/store/@dots{}-readline-6.3 67.6 1.2 1.2%\n" +"@dots{}\n" +"total: 102.3 MiB\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7102 +msgid "In this example we see that the combination of the four packages takes 102.3@tie{}MiB in total, which is much less than the sum of each closure since they have a lot of dependencies in common." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7104 +msgid "The available options are:" +msgstr "" + +#. type: table +#: doc/guix.texi:7110 +msgid "Use substitute information from @var{urls}. @xref{client-substitute-urls, the same option for @code{guix build}}." +msgstr "" + +#. type: item +#: doc/guix.texi:7111 +#, no-wrap +msgid "--sort=@var{key}" +msgstr "" + +#. type: table +#: doc/guix.texi:7113 +msgid "Sort lines according to @var{key}, one of the following options:" +msgstr "" + +#. type: item +#: doc/guix.texi:7115 +#, no-wrap +msgid "self" +msgstr "" + +#. type: table +#: doc/guix.texi:7117 +msgid "the size of each item (the default);" +msgstr "" + +#. type: table +#: doc/guix.texi:7119 +msgid "the total size of the item's closure." +msgstr "" + +#. type: item +#: doc/guix.texi:7121 +#, no-wrap +msgid "--map-file=@var{file}" +msgstr "" + +#. type: table +#: doc/guix.texi:7123 +msgid "Write a graphical map of disk usage in PNG format to @var{file}." +msgstr "" + +#. type: table +#: doc/guix.texi:7125 +msgid "For the example above, the map looks like this:" +msgstr "" + +#. type: table +#: doc/guix.texi:7128 +msgid "@image{images/coreutils-size-map,5in,, map of Coreutils disk usage produced by @command{guix size}}" +msgstr "" + +#. type: table +#: doc/guix.texi:7133 +msgid "This option requires that @uref{http://wingolog.org/software/guile-charting/, Guile-Charting} be installed and visible in Guile's module search path. When that is not the case, @command{guix size} fails as it tries to load it." +msgstr "" + +#. type: table +#: doc/guix.texi:7137 +msgid "Consider packages for @var{system}---e.g., @code{x86_64-linux}." +msgstr "" + +#. type: section +#: doc/guix.texi:7141 +#, no-wrap +msgid "Invoking @command{guix graph}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7143 +#, no-wrap +msgid "DAG" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:7144 +#, no-wrap +msgid "guix graph" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7158 +msgid "Packages and their dependencies form a @dfn{graph}, specifically a directed acyclic graph (DAG). It can quickly become difficult to have a mental model of the package DAG, so the @command{guix graph} command provides a visual representation of the DAG. By default, @command{guix graph} emits a DAG representation in the input format of @uref{http://www.graphviz.org/, Graphviz}, so its output can be passed directly to the @command{dot} command of Graphviz. It can also emit an HTML page with embedded JavaScript code to display a ``chord diagram'' in a Web browser, using the @uref{https://d3js.org/, d3.js} library, or emit Cypher queries to construct a graph in a graph database supporting the @uref{http://www.opencypher.org/, openCypher} query language. The general syntax is:" +msgstr "" + +#. type: example +#: doc/guix.texi:7161 +#, no-wrap +msgid "guix graph @var{options} @var{package}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7166 +msgid "For example, the following command generates a PDF file representing the package DAG for the GNU@tie{}Core Utilities, showing its build-time dependencies:" +msgstr "" + +#. type: example +#: doc/guix.texi:7169 +#, no-wrap +msgid "guix graph coreutils | dot -Tpdf > dag.pdf\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7172 +msgid "The output looks like this:" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7174 +msgid "@image{images/coreutils-graph,2in,,Dependency graph of the GNU Coreutils}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7176 +msgid "Nice little graph, no?" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7182 +msgid "But there is more than one graph! The one above is concise: it is the graph of package objects, omitting implicit inputs such as GCC, libc, grep, etc. It is often useful to have such a concise graph, but sometimes one may want to see more details. @command{guix graph} supports several types of graphs, allowing you to choose the level of detail:" +msgstr "" + +#. type: table +#: doc/guix.texi:7188 +msgid "This is the default type used in the example above. It shows the DAG of package objects, excluding implicit dependencies. It is concise, but filters out many details." +msgstr "" + +#. type: item +#: doc/guix.texi:7189 +#, no-wrap +msgid "reverse-package" +msgstr "" + +#. type: table +#: doc/guix.texi:7191 +msgid "This shows the @emph{reverse} DAG of packages. For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:7194 +#, no-wrap +msgid "guix graph --type=reverse-package ocaml\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7197 +msgid "... yields the graph of packages that depend on OCaml." +msgstr "" + +#. type: table +#: doc/guix.texi:7202 +msgid "Note that for core packages this can yield huge graphs. If all you want is to know the number of packages that depend on a given package, use @command{guix refresh --list-dependent} (@pxref{Invoking guix refresh, @option{--list-dependent}})." +msgstr "" + +#. type: item +#: doc/guix.texi:7203 +#, no-wrap +msgid "bag-emerged" +msgstr "" + +#. type: table +#: doc/guix.texi:7205 +msgid "This is the package DAG, @emph{including} implicit inputs." +msgstr "" + +#. type: table +#: doc/guix.texi:7207 +msgid "For instance, the following command:" +msgstr "" + +#. type: example +#: doc/guix.texi:7210 +#, no-wrap +msgid "guix graph --type=bag-emerged coreutils | dot -Tpdf > dag.pdf\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7213 +msgid "... yields this bigger graph:" +msgstr "" + +#. type: table +#: doc/guix.texi:7215 +msgid "@image{images/coreutils-bag-graph,,5in,Detailed dependency graph of the GNU Coreutils}" +msgstr "" + +#. type: table +#: doc/guix.texi:7218 +msgid "At the bottom of the graph, we see all the implicit inputs of @var{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})." +msgstr "" + +#. type: table +#: doc/guix.texi:7222 +msgid "Now, note that the dependencies of these implicit inputs---that is, the @dfn{bootstrap dependencies} (@pxref{Bootstrapping})---are not shown here, for conciseness." +msgstr "" + +#. type: item +#: doc/guix.texi:7223 +#, no-wrap +msgid "bag" +msgstr "" + +#. type: table +#: doc/guix.texi:7226 +msgid "Similar to @code{bag-emerged}, but this time including all the bootstrap dependencies." +msgstr "" + +#. type: item +#: doc/guix.texi:7227 +#, no-wrap +msgid "bag-with-origins" +msgstr "" + +#. type: table +#: doc/guix.texi:7229 +msgid "Similar to @code{bag}, but also showing origins and their dependencies." +msgstr "" + +#. type: table +#: doc/guix.texi:7235 +msgid "This is the most detailed representation: It shows the DAG of derivations (@pxref{Derivations}) and plain store items. Compared to the above representation, many additional nodes are visible, including build scripts, patches, Guile modules, etc." +msgstr "" + +#. type: table +#: doc/guix.texi:7238 +msgid "For this type of graph, it is also possible to pass a @file{.drv} file name instead of a package name, as in:" +msgstr "" + +#. type: example +#: doc/guix.texi:7241 +#, no-wrap +msgid "guix graph -t derivation `guix system build -d my-config.scm`\n" +msgstr "" + +#. type: item +#: doc/guix.texi:7243 +#, no-wrap +msgid "module" +msgstr "" + +#. type: table +#: doc/guix.texi:7247 +msgid "This is the graph of @dfn{package modules} (@pxref{Package Modules}). For example, the following command shows the graph for the package module that defines the @code{guile} package:" +msgstr "" + +#. type: example +#: doc/guix.texi:7250 +#, no-wrap +msgid "guix graph -t module guile | dot -Tpdf > module-graph.pdf\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7255 +msgid "All the types above correspond to @emph{build-time dependencies}. The following graph type represents the @emph{run-time dependencies}:" +msgstr "" + +#. type: item +#: doc/guix.texi:7257 +#, no-wrap +msgid "references" +msgstr "" + +#. type: table +#: doc/guix.texi:7260 +msgid "This is the graph of @dfn{references} of a package output, as returned by @command{guix gc --references} (@pxref{Invoking guix gc})." +msgstr "" + +#. type: table +#: doc/guix.texi:7263 +msgid "If the given package output is not available in the store, @command{guix graph} attempts to obtain dependency information from substitutes." +msgstr "" + +#. type: table +#: doc/guix.texi:7267 +msgid "Here you can also pass a store file name instead of a package name. For example, the command below produces the reference graph of your profile (which can be big!):" +msgstr "" + +#. type: example +#: doc/guix.texi:7270 +#, no-wrap +msgid "guix graph -t references `readlink -f ~/.guix-profile`\n" +msgstr "" + +#. type: item +#: doc/guix.texi:7272 +#, no-wrap +msgid "referrers" +msgstr "" + +#. type: table +#: doc/guix.texi:7275 +msgid "This is the graph of the @dfn{referrers} of a store item, as returned by @command{guix gc --referrers} (@pxref{Invoking guix gc})." +msgstr "" + +#. type: table +#: doc/guix.texi:7281 +msgid "This relies exclusively on local information from your store. For instance, let us suppose that the current Inkscape is available in 10 profiles on your machine; @command{guix graph -t referrers inkscape} will show a graph rooted at Inkscape and with those 10 profiles linked to it." +msgstr "" + +#. type: table +#: doc/guix.texi:7284 +msgid "It can help determine what is preventing a store item from being garbage collected." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7288 +msgid "The available options are the following:" +msgstr "" + +#. type: item +#: doc/guix.texi:7290 +#, no-wrap +msgid "--type=@var{type}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7291 doc/guix.texi:21087 +#, no-wrap +msgid "-t @var{type}" +msgstr "" + +#. type: table +#: doc/guix.texi:7294 +msgid "Produce a graph output of @var{type}, where @var{type} must be one of the values listed above." +msgstr "" + +#. type: item +#: doc/guix.texi:7295 +#, no-wrap +msgid "--list-types" +msgstr "" + +#. type: table +#: doc/guix.texi:7297 +msgid "List the supported graph types." +msgstr "" + +#. type: item +#: doc/guix.texi:7298 +#, no-wrap +msgid "--backend=@var{backend}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7299 +#, no-wrap +msgid "-b @var{backend}" +msgstr "" + +#. type: table +#: doc/guix.texi:7301 +msgid "Produce a graph using the selected @var{backend}." +msgstr "" + +#. type: item +#: doc/guix.texi:7302 +#, no-wrap +msgid "--list-backends" +msgstr "" + +#. type: table +#: doc/guix.texi:7304 +msgid "List the supported graph backends." +msgstr "" + +#. type: table +#: doc/guix.texi:7306 +msgid "Currently, the available backends are Graphviz and d3.js." +msgstr "" + +#. type: example +#: doc/guix.texi:7315 +#, no-wrap +msgid "guix graph -e '(@@@@ (gnu packages commencement) gnu-make-final)'\n" +msgstr "" + +#. type: section +#: doc/guix.texi:7320 +#, no-wrap +msgid "Invoking @command{guix environment}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7322 +#, no-wrap +msgid "reproducible build environments" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7323 +#, no-wrap +msgid "development environments" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:7324 +#, no-wrap +msgid "guix environment" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7325 +#, no-wrap +msgid "environment, package build environment" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7331 +msgid "The purpose of @command{guix environment} is to assist hackers in creating reproducible development environments without polluting their package profile. The @command{guix environment} tool takes one or more packages, builds all of their inputs, and creates a shell environment to use them." +msgstr "" + +#. type: example +#: doc/guix.texi:7336 +#, no-wrap +msgid "guix environment @var{options} @var{package}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7340 +msgid "The following example spawns a new shell set up for the development of GNU@tie{}Guile:" +msgstr "" + +#. type: example +#: doc/guix.texi:7343 +#, no-wrap +msgid "guix environment guile\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7360 +msgid "If the needed dependencies are not built yet, @command{guix environment} automatically builds them. The environment of the new shell is an augmented version of the environment that @command{guix environment} was run in. It contains the necessary search paths for building the given package added to the existing environment variables. To create a ``pure'' environment, in which the original environment variables have been unset, use the @code{--pure} option@footnote{Users sometimes wrongfully augment environment variables such as @code{PATH} in their @file{~/.bashrc} file. As a consequence, when @code{guix environment} launches it, Bash may read @file{~/.bashrc}, thereby introducing ``impurities'' in these environment variables. It is an error to define such environment variables in @file{.bashrc}; instead, they should be defined in @file{.bash_profile}, which is sourced only by log-in shells. @xref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}, for details on Bash start-up files.}." +msgstr "" + +#. type: vindex +#: doc/guix.texi:7361 +#, no-wrap +msgid "GUIX_ENVIRONMENT" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7367 +msgid "@command{guix environment} defines the @code{GUIX_ENVIRONMENT} variable in the shell it spawns; its value is the file name of the profile of this environment. This allows users to, say, define a specific prompt for development environments in their @file{.bashrc} (@pxref{Bash Startup Files,,, bash, The GNU Bash Reference Manual}):" +msgstr "" + +#. type: example +#: doc/guix.texi:7373 +#, no-wrap +msgid "" +"if [ -n \"$GUIX_ENVIRONMENT\" ]\n" +"then\n" +" export PS1=\"\\u@@\\h \\w [dev]\\$ \"\n" +"fi\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7377 +msgid "... or to browse the profile:" +msgstr "" + +#. type: example +#: doc/guix.texi:7380 +#, no-wrap +msgid "$ ls \"$GUIX_ENVIRONMENT/bin\"\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7386 +msgid "Additionally, more than one package may be specified, in which case the union of the inputs for the given packages are used. For example, the command below spawns a shell where all of the dependencies of both Guile and Emacs are available:" +msgstr "" + +#. type: example +#: doc/guix.texi:7389 +#, no-wrap +msgid "guix environment guile emacs\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7394 +msgid "Sometimes an interactive shell session is not desired. An arbitrary command may be invoked by placing the @code{--} token to separate the command from the rest of the arguments:" +msgstr "" + +#. type: example +#: doc/guix.texi:7397 +#, no-wrap +msgid "guix environment guile -- make -j4\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7403 +msgid "In other situations, it is more convenient to specify the list of packages needed in the environment. For example, the following command runs @command{python} from an environment containing Python@tie{}2.7 and NumPy:" +msgstr "" + +#. type: example +#: doc/guix.texi:7406 +#, no-wrap +msgid "guix environment --ad-hoc python2-numpy python-2.7 -- python\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7417 +msgid "Furthermore, one might want the dependencies of a package and also some additional packages that are not build-time or runtime dependencies, but are useful when developing nonetheless. Because of this, the @code{--ad-hoc} flag is positional. Packages appearing before @code{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment. Packages appearing after are interpreted as packages that will be added to the environment directly. For example, the following command creates a Guix development environment that additionally includes Git and strace:" +msgstr "" + +#. type: example +#: doc/guix.texi:7420 +#, no-wrap +msgid "guix environment guix --ad-hoc git strace\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7429 +msgid "Sometimes it is desirable to isolate the environment as much as possible, for maximal purity and reproducibility. In particular, when using Guix on a host distro that is not GuixSD, it is desirable to prevent access to @file{/usr/bin} and other system-wide resources from the development environment. For example, the following command spawns a Guile REPL in a ``container'' where only the store and the current working directory are mounted:" +msgstr "" + +#. type: example +#: doc/guix.texi:7432 +#, no-wrap +msgid "guix environment --ad-hoc --container guile -- guile\n" +msgstr "" + +#. type: quotation +#: doc/guix.texi:7436 +msgid "The @code{--container} option requires Linux-libre 3.19 or newer." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7439 +msgid "The available options are summarized below." +msgstr "" + +#. type: cindex +#: doc/guix.texi:7443 +#, no-wrap +msgid "persistent environment" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7444 +#, no-wrap +msgid "garbage collector root, for environments" +msgstr "" + +#. type: table +#: doc/guix.texi:7447 +msgid "Make @var{file} a symlink to the profile for this environment, and register it as a garbage collector root." +msgstr "" + +#. type: table +#: doc/guix.texi:7450 +msgid "This is useful if you want to protect your environment from garbage collection, to make it ``persistent''." +msgstr "" + +#. type: table +#: doc/guix.texi:7456 +msgid "When this option is omitted, the environment is protected from garbage collection only for the duration of the @command{guix environment} session. This means that next time you recreate the same environment, you could have to rebuild or re-download packages. @xref{Invoking guix gc}, for more on GC roots." +msgstr "" + +#. type: table +#: doc/guix.texi:7461 +msgid "Create an environment for the package or list of packages that @var{expr} evaluates to." +msgstr "" + +#. type: table +#: doc/guix.texi:7463 +msgid "For example, running:" +msgstr "" + +#. type: example +#: doc/guix.texi:7466 +#, no-wrap +msgid "guix environment -e '(@@ (gnu packages maths) petsc-openmpi)'\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7470 +msgid "starts a shell with the environment for this specific variant of the PETSc package." +msgstr "" + +#. type: table +#: doc/guix.texi:7472 +msgid "Running:" +msgstr "" + +#. type: example +#: doc/guix.texi:7475 +#, no-wrap +msgid "guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7478 +msgid "starts a shell with all the GuixSD base packages available." +msgstr "" + +#. type: table +#: doc/guix.texi:7481 +msgid "The above commands only use the default output of the given packages. To select other outputs, two element tuples can be specified:" +msgstr "" + +#. type: example +#: doc/guix.texi:7484 +#, no-wrap +msgid "guix environment --ad-hoc -e '(list (@@ (gnu packages bash) bash) \"include\")'\n" +msgstr "" + +#. type: item +#: doc/guix.texi:7486 +#, no-wrap +msgid "--load=@var{file}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7487 +#, no-wrap +msgid "-l @var{file}" +msgstr "" + +#. type: table +#: doc/guix.texi:7490 +msgid "Create an environment for the package or list of packages that the code within @var{file} evaluates to." +msgstr "" + +#. type: example +#: doc/guix.texi:7496 +#, no-wrap +msgid "@verbatiminclude environment-gdb.scm\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7502 +msgid "Create an environment for the packages contained in the manifest object returned by the Scheme code in @var{file}." +msgstr "" + +#. type: table +#: doc/guix.texi:7506 +msgid "This is similar to the same-named option in @command{guix package} (@pxref{profile-manifest, @option{--manifest}}) and uses the same manifest files." +msgstr "" + +#. type: item +#: doc/guix.texi:7507 +#, no-wrap +msgid "--ad-hoc" +msgstr "" + +#. type: table +#: doc/guix.texi:7512 +msgid "Include all specified packages in the resulting environment, as if an @i{ad hoc} package were defined with them as inputs. This option is useful for quickly creating an environment without having to write a package expression to contain the desired inputs." +msgstr "" + +#. type: table +#: doc/guix.texi:7514 +msgid "For instance, the command:" +msgstr "" + +#. type: example +#: doc/guix.texi:7517 +#, no-wrap +msgid "guix environment --ad-hoc guile guile-sdl -- guile\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7521 +msgid "runs @command{guile} in an environment where Guile and Guile-SDL are available." +msgstr "" + +#. type: table +#: doc/guix.texi:7526 +msgid "Note that this example implicitly asks for the default output of @code{guile} and @code{guile-sdl}, but it is possible to ask for a specific output---e.g., @code{glib:bin} asks for the @code{bin} output of @code{glib} (@pxref{Packages with Multiple Outputs})." +msgstr "" + +#. type: table +#: doc/guix.texi:7532 +msgid "This option may be composed with the default behavior of @command{guix environment}. Packages appearing before @code{--ad-hoc} are interpreted as packages whose dependencies will be added to the environment, the default behavior. Packages appearing after are interpreted as packages that will be added to the environment directly." +msgstr "" + +#. type: item +#: doc/guix.texi:7533 +#, no-wrap +msgid "--pure" +msgstr "" + +#. type: table +#: doc/guix.texi:7537 +msgid "Unset existing environment variables when building the new environment. This has the effect of creating an environment in which search paths only contain package inputs." +msgstr "" + +#. type: item +#: doc/guix.texi:7538 +#, no-wrap +msgid "--search-paths" +msgstr "" + +#. type: table +#: doc/guix.texi:7541 +msgid "Display the environment variable definitions that make up the environment." +msgstr "" + +#. type: table +#: doc/guix.texi:7545 +msgid "Attempt to build for @var{system}---e.g., @code{i686-linux}." +msgstr "" + +#. type: item +#: doc/guix.texi:7546 +#, no-wrap +msgid "--container" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7547 +#, no-wrap +msgid "-C" +msgstr "" + +#. type: item +#: doc/guix.texi:7548 doc/guix.texi:8059 doc/guix.texi:21036 +#, no-wrap +msgid "container" +msgstr "" + +#. type: table +#: doc/guix.texi:7556 +msgid "Run @var{command} within an isolated container. The current working directory outside the container is mapped inside the container. Additionally, unless overridden with @code{--user}, a dummy home directory is created that matches the current user's home directory, and @file{/etc/passwd} is configured accordingly. The spawned process runs as the current user outside the container, but has root privileges in the context of the container." +msgstr "" + +#. type: item +#: doc/guix.texi:7557 +#, no-wrap +msgid "--network" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7558 +#, no-wrap +msgid "-N" +msgstr "" + +#. type: table +#: doc/guix.texi:7562 +msgid "For containers, share the network namespace with the host system. Containers created without this flag only have access to the loopback device." +msgstr "" + +#. type: item +#: doc/guix.texi:7563 +#, no-wrap +msgid "--link-profile" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7564 +#, no-wrap +msgid "-P" +msgstr "" + +#. type: table +#: doc/guix.texi:7571 +msgid "For containers, link the environment profile to @file{~/.guix-profile} within the container. This is equivalent to running the command @command{ln -s $GUIX_ENVIRONMENT ~/.guix-profile} within the container. Linking will fail and abort the environment if the directory already exists, which will certainly be the case if @command{guix environment} was invoked in the user's home directory." +msgstr "" + +#. type: table +#: doc/guix.texi:7578 +msgid "Certain packages are configured to look in @code{~/.guix-profile} for configuration files and data;@footnote{For example, the @code{fontconfig} package inspects @file{~/.guix-profile/share/fonts} for additional fonts.} @code{--link-profile} allows these programs to behave as expected within the environment." +msgstr "" + +#. type: item +#: doc/guix.texi:7579 doc/guix.texi:7731 +#, no-wrap +msgid "--user=@var{user}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7580 doc/guix.texi:7732 +#, no-wrap +msgid "-u @var{user}" +msgstr "" + +#. type: table +#: doc/guix.texi:7586 +msgid "For containers, use the username @var{user} in place of the current user. The generated @file{/etc/passwd} entry within the container will contain the name @var{user}; the home directory will be @file{/home/USER}; and no user GECOS data will be copied. @var{user} need not exist on the system." +msgstr "" + +#. type: table +#: doc/guix.texi:7591 +msgid "Additionally, any shared or exposed path (see @code{--share} and @code{--expose} respectively) whose target is within the current user's home directory will be remapped relative to @file{/home/USER}; this includes the automatic mapping of the current working directory." +msgstr "" + +#. type: example +#: doc/guix.texi:7598 +#, no-wrap +msgid "" +"# will expose paths as /home/foo/wd, /home/foo/test, and /home/foo/target\n" +"cd $HOME/wd\n" +"guix environment --container --user=foo \\\n" +" --expose=$HOME/test \\\n" +" --expose=/tmp/target=$HOME/target\n" +msgstr "" + +#. type: table +#: doc/guix.texi:7603 +msgid "While this will limit the leaking of user identity through home paths and each of the user fields, this is only one useful component of a broader privacy/anonymity solution---not one in and of itself." +msgstr "" + +#. type: item +#: doc/guix.texi:7604 +#, no-wrap +msgid "--expose=@var{source}[=@var{target}]" +msgstr "" + +#. type: table +#: doc/guix.texi:7609 +msgid "For containers, expose the file system @var{source} from the host system as the read-only file system @var{target} within the container. If @var{target} is not specified, @var{source} is used as the target mount point in the container." +msgstr "" + +#. type: table +#: doc/guix.texi:7613 +msgid "The example below spawns a Guile REPL in a container in which the user's home directory is accessible read-only via the @file{/exchange} directory:" +msgstr "" + +#. type: example +#: doc/guix.texi:7616 +#, no-wrap +msgid "guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile\n" +msgstr "" + +#. type: item +#: doc/guix.texi:7618 +#, no-wrap +msgid "--share=@var{source}[=@var{target}]" +msgstr "" + +#. type: table +#: doc/guix.texi:7623 +msgid "For containers, share the file system @var{source} from the host system as the writable file system @var{target} within the container. If @var{target} is not specified, @var{source} is used as the target mount point in the container." +msgstr "" + +#. type: table +#: doc/guix.texi:7627 +msgid "The example below spawns a Guile REPL in a container in which the user's home directory is accessible for both reading and writing via the @file{/exchange} directory:" +msgstr "" + +#. type: example +#: doc/guix.texi:7630 +#, no-wrap +msgid "guix environment --container --share=$HOME=/exchange --ad-hoc guile -- guile\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7636 +msgid "@command{guix environment} also supports all of the common build options that @command{guix build} supports (@pxref{Common Build Options})." +msgstr "" + +#. type: section +#: doc/guix.texi:7639 +#, no-wrap +msgid "Invoking @command{guix publish}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:7641 +#, no-wrap +msgid "guix publish" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7645 +msgid "The purpose of @command{guix publish} is to enable users to easily share their store with others, who can then use it as a substitute server (@pxref{Substitutes})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7651 +msgid "When @command{guix publish} runs, it spawns an HTTP server which allows anyone with network access to obtain substitutes from it. This means that any machine running Guix can also act as if it were a build farm, since the HTTP interface is compatible with Hydra, the software behind the @code{hydra.gnu.org} build farm." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7657 +msgid "For security, each substitute is signed, allowing recipients to check their authenticity and integrity (@pxref{Substitutes}). Because @command{guix publish} uses the signing key of the system, which is only readable by the system administrator, it must be started as root; the @code{--user} option makes it drop root privileges early on." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7661 +msgid "The signing key pair must be generated before @command{guix publish} is launched, using @command{guix archive --generate-key} (@pxref{Invoking guix archive})." +msgstr "" + +#. type: example +#: doc/guix.texi:7666 +#, no-wrap +msgid "guix publish @var{options}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7670 +msgid "Running @command{guix publish} without any additional arguments will spawn an HTTP server on port 8080:" +msgstr "" + +#. type: example +#: doc/guix.texi:7673 +#, no-wrap +msgid "guix publish\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7677 +msgid "Once a publishing server has been authorized (@pxref{Invoking guix archive}), the daemon may download substitutes from it:" +msgstr "" + +#. type: example +#: doc/guix.texi:7680 +#, no-wrap +msgid "guix-daemon --substitute-urls=http://example.org:8080\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7689 +msgid "By default, @command{guix publish} compresses archives on the fly as it serves them. This ``on-the-fly'' mode is convenient in that it requires no setup and is immediately available. However, when serving lots of clients, we recommend using the @option{--cache} option, which enables caching of the archives before they are sent to clients---see below for details. The @command{guix weather} command provides a handy way to check what a server provides (@pxref{Invoking guix weather})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7696 +msgid "As a bonus, @command{guix publish} also serves as a content-addressed mirror for source files referenced in @code{origin} records (@pxref{origin Reference}). For instance, assuming @command{guix publish} is running on @code{example.org}, the following URL returns the raw @file{hello-2.10.tar.gz} file with the given SHA256 hash (represented in @code{nix-base32} format, @pxref{Invoking guix hash}):" +msgstr "" + +#. type: example +#: doc/guix.texi:7699 +#, no-wrap +msgid "http://example.org/file/hello-2.10.tar.gz/sha256/0ssi1@dots{}ndq1i\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7703 +msgid "Obviously, these URLs only work for files that are in the store; in other cases, they return 404 (``Not Found'')." +msgstr "" + +#. type: cindex +#: doc/guix.texi:7704 +#, no-wrap +msgid "build logs, publication" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7706 +msgid "Build logs are available from @code{/log} URLs like:" +msgstr "" + +#. type: example +#: doc/guix.texi:7709 +#, no-wrap +msgid "http://example.org/log/gwspk@dots{}-guile-2.2.3\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7719 +msgid "When @command{guix-daemon} is configured to save compressed build logs, as is the case by default (@pxref{Invoking guix-daemon}), @code{/log} URLs return the compressed log as-is, with an appropriate @code{Content-Type} and/or @code{Content-Encoding} header. We recommend running @command{guix-daemon} with @code{--log-compression=gzip} since Web browsers can automatically decompress it, which is not the case with bzip2 compression." +msgstr "" + +#. type: item +#: doc/guix.texi:7723 +#, no-wrap +msgid "--port=@var{port}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7724 +#, no-wrap +msgid "-p @var{port}" +msgstr "" + +#. type: table +#: doc/guix.texi:7726 +msgid "Listen for HTTP requests on @var{port}." +msgstr "" + +#. type: item +#: doc/guix.texi:7727 doc/guix.texi:17516 +#, no-wrap +msgid "--listen=@var{host}" +msgstr "" + +#. type: table +#: doc/guix.texi:7730 +msgid "Listen on the network interface for @var{host}. The default is to accept connections from any interface." +msgstr "" + +#. type: table +#: doc/guix.texi:7735 +msgid "Change privileges to @var{user} as soon as possible---i.e., once the server socket is open and the signing key has been read." +msgstr "" + +#. type: item +#: doc/guix.texi:7736 +#, no-wrap +msgid "--compression[=@var{level}]" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7737 +#, no-wrap +msgid "-C [@var{level}]" +msgstr "" + +#. type: table +#: doc/guix.texi:7742 +msgid "Compress data using the given @var{level}. When @var{level} is zero, disable compression. The range 1 to 9 corresponds to different gzip compression levels: 1 is the fastest, and 9 is the best (CPU-intensive). The default is 3." +msgstr "" + +#. type: table +#: doc/guix.texi:7751 +msgid "Unless @option{--cache} is used, compression occurs on the fly and the compressed streams are not cached. Thus, to reduce load on the machine that runs @command{guix publish}, it may be a good idea to choose a low compression level, to run @command{guix publish} behind a caching proxy, or to use @option{--cache}. Using @option{--cache} has the advantage that it allows @command{guix publish} to add @code{Content-Length} HTTP header to its responses." +msgstr "" + +#. type: item +#: doc/guix.texi:7752 +#, no-wrap +msgid "--cache=@var{directory}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7753 +#, no-wrap +msgid "-c @var{directory}" +msgstr "" + +#. type: table +#: doc/guix.texi:7756 +msgid "Cache archives and meta-data (@code{.narinfo} URLs) to @var{directory} and only serve archives that are in cache." +msgstr "" + +#. type: table +#: doc/guix.texi:7764 +msgid "When this option is omitted, archives and meta-data are created on-the-fly. This can reduce the available bandwidth, especially when compression is enabled, since this may become CPU-bound. Another drawback of the default mode is that the length of archives is not known in advance, so @command{guix publish} does not add a @code{Content-Length} HTTP header to its responses, which in turn prevents clients from knowing the amount of data being downloaded." +msgstr "" + +#. type: table +#: doc/guix.texi:7772 +msgid "Conversely, when @option{--cache} is used, the first request for a store item (@i{via} a @code{.narinfo} URL) returns 404 and triggers a background process to @dfn{bake} the archive---computing its @code{.narinfo} and compressing the archive, if needed. Once the archive is cached in @var{directory}, subsequent requests succeed and are served directly from the cache, which guarantees that clients get the best possible bandwidth." +msgstr "" + +#. type: table +#: doc/guix.texi:7776 +msgid "The ``baking'' process is performed by worker threads. By default, one thread per CPU core is created, but this can be customized. See @option{--workers} below." +msgstr "" + +#. type: table +#: doc/guix.texi:7779 +msgid "When @option{--ttl} is used, cached entries are automatically deleted when they have expired." +msgstr "" + +#. type: item +#: doc/guix.texi:7780 +#, no-wrap +msgid "--workers=@var{N}" +msgstr "" + +#. type: table +#: doc/guix.texi:7783 +msgid "When @option{--cache} is used, request the allocation of @var{N} worker threads to ``bake'' archives." +msgstr "" + +#. type: item +#: doc/guix.texi:7784 +#, no-wrap +msgid "--ttl=@var{ttl}" +msgstr "" + +#. type: table +#: doc/guix.texi:7788 +msgid "Produce @code{Cache-Control} HTTP headers that advertise a time-to-live (TTL) of @var{ttl}. @var{ttl} must denote a duration: @code{5d} means 5 days, @code{1m} means 1 month, and so on." +msgstr "" + +#. type: table +#: doc/guix.texi:7793 +msgid "This allows the user's Guix to keep substitute information in cache for @var{ttl}. However, note that @code{guix publish} does not itself guarantee that the store items it provides will indeed remain available for as long as @var{ttl}." +msgstr "" + +#. type: table +#: doc/guix.texi:7797 +msgid "Additionally, when @option{--cache} is used, cached entries that have not been accessed for @var{ttl} and that no longer have a corresponding item in the store, may be deleted." +msgstr "" + +#. type: item +#: doc/guix.texi:7798 +#, no-wrap +msgid "--nar-path=@var{path}" +msgstr "" + +#. type: table +#: doc/guix.texi:7801 +msgid "Use @var{path} as the prefix for the URLs of ``nar'' files (@pxref{Invoking guix archive, normalized archives})." +msgstr "" + +#. type: table +#: doc/guix.texi:7805 +msgid "By default, nars are served at a URL such as @code{/nar/gzip/@dots{}-coreutils-8.25}. This option allows you to change the @code{/nar} part to @var{path}." +msgstr "" + +#. type: item +#: doc/guix.texi:7806 +#, no-wrap +msgid "--public-key=@var{file}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7807 +#, no-wrap +msgid "--private-key=@var{file}" +msgstr "" + +#. type: table +#: doc/guix.texi:7810 +msgid "Use the specific @var{file}s as the public/private key pair used to sign the store items being published." +msgstr "" + +#. type: table +#: doc/guix.texi:7817 +msgid "The files must correspond to the same key pair (the private key is used for signing and the public key is merely advertised in the signature metadata). They must contain keys in the canonical s-expression format as produced by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). By default, @file{/etc/guix/signing-key.pub} and @file{/etc/guix/signing-key.sec} are used." +msgstr "" + +#. type: item +#: doc/guix.texi:7818 +#, no-wrap +msgid "--repl[=@var{port}]" +msgstr "" + +#. type: itemx +#: doc/guix.texi:7819 +#, no-wrap +msgid "-r [@var{port}]" +msgstr "" + +#. type: table +#: doc/guix.texi:7823 +msgid "Spawn a Guile REPL server (@pxref{REPL Servers,,, guile, GNU Guile Reference Manual}) on @var{port} (37146 by default). This is used primarily for debugging a running @command{guix publish} server." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7829 +msgid "Enabling @command{guix publish} on a GuixSD system is a one-liner: just instantiate a @code{guix-publish-service-type} service in the @code{services} field of the @code{operating-system} declaration (@pxref{guix-publish-service-type, @code{guix-publish-service-type}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7832 +msgid "If you are instead running Guix on a ``foreign distro'', follow these instructions:”" +msgstr "" + +#. type: itemize +#: doc/guix.texi:7836 +msgid "If your host distro uses the systemd init system:" +msgstr "" + +#. type: example +#: doc/guix.texi:7841 +#, no-wrap +msgid "" +"# ln -s ~root/.guix-profile/lib/systemd/system/guix-publish.service \\\n" +" /etc/systemd/system/\n" +"# systemctl start guix-publish && systemctl enable guix-publish\n" +msgstr "" + +#. type: example +#: doc/guix.texi:7849 +#, no-wrap +msgid "" +"# ln -s ~root/.guix-profile/lib/upstart/system/guix-publish.conf /etc/init/\n" +"# start guix-publish\n" +msgstr "" + +#. type: itemize +#: doc/guix.texi:7853 +msgid "Otherwise, proceed similarly with your distro's init system." +msgstr "" + +#. type: section +#: doc/guix.texi:7856 +#, no-wrap +msgid "Invoking @command{guix challenge}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7859 +#, no-wrap +msgid "verifiable builds" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:7860 +#, no-wrap +msgid "guix challenge" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7861 +#, no-wrap +msgid "challenge" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7866 +msgid "Do the binaries provided by this server really correspond to the source code it claims to build? Is a package build process deterministic? These are the questions the @command{guix challenge} command attempts to answer." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7874 +msgid "The former is obviously an important question: Before using a substitute server (@pxref{Substitutes}), one had better @emph{verify} that it provides the right binaries, and thus @emph{challenge} it. The latter is what enables the former: If package builds are deterministic, then independent builds of the package should yield the exact same result, bit for bit; if a server provides a binary different from the one obtained locally, it may be either corrupt or malicious." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7883 +msgid "We know that the hash that shows up in @file{/gnu/store} file names is the hash of all the inputs of the process that built the file or directory---compilers, libraries, build scripts, etc. (@pxref{Introduction}). Assuming deterministic build processes, one store file name should map to exactly one build output. @command{guix challenge} checks whether there is, indeed, a single mapping by comparing the build outputs of several independent builds of any given store item." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7885 +msgid "The command output looks like this:" +msgstr "" + +#. type: smallexample +#: doc/guix.texi:7902 +#, no-wrap +msgid "" +"$ guix challenge --substitute-urls=\"https://hydra.gnu.org https://guix.example.org\"\n" +"updating list of substitutes from 'https://hydra.gnu.org'... 100.0%\n" +"updating list of substitutes from 'https://guix.example.org'... 100.0%\n" +"/gnu/store/@dots{}-openssl-1.0.2d contents differ:\n" +" local hash: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n" +" https://hydra.gnu.org/nar/@dots{}-openssl-1.0.2d: 0725l22r5jnzazaacncwsvp9kgf42266ayyp814v7djxs7nk963q\n" +" https://guix.example.org/nar/@dots{}-openssl-1.0.2d: 1zy4fmaaqcnjrzzajkdn3f5gmjk754b43qkq47llbyak9z0qjyim\n" +"/gnu/store/@dots{}-git-2.5.0 contents differ:\n" +" local hash: 00p3bmryhjxrhpn2gxs2fy0a15lnip05l97205pgbk5ra395hyha\n" +" https://hydra.gnu.org/nar/@dots{}-git-2.5.0: 069nb85bv4d4a6slrwjdy8v1cn4cwspm3kdbmyb81d6zckj3nq9f\n" +" https://guix.example.org/nar/@dots{}-git-2.5.0: 0mdqa9w1p6cmli6976v4wi0sw9r4p5prkj7lzfd1877wk11c9c73\n" +"/gnu/store/@dots{}-pius-2.1.1 contents differ:\n" +" local hash: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n" +" https://hydra.gnu.org/nar/@dots{}-pius-2.1.1: 0k4v3m9z1zp8xzzizb7d8kjj72f9172xv078sq4wl73vnq9ig3ax\n" +" https://guix.example.org/nar/@dots{}-pius-2.1.1: 1cy25x1a4fzq5rk0pmvc8xhwyffnqz95h2bpvqsz2mpvlbccy0gs\n" +"\n" +msgstr "" + +#. type: smallexample +#: doc/guix.texi:7904 +#, no-wrap +msgid "" +"@dots{}\n" +"\n" +msgstr "" + +#. type: smallexample +#: doc/guix.texi:7909 +#, no-wrap +msgid "" +"6,406 store items were analyzed:\n" +" - 4,749 (74.1%) were identical\n" +" - 525 (8.2%) differed\n" +" - 1,132 (17.7%) were inconclusive\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7917 +msgid "In this example, @command{guix challenge} first scans the store to determine the set of locally-built derivations---as opposed to store items that were downloaded from a substitute server---and then queries all the substitute servers. It then reports those store items for which the servers obtained a result different from the local build." +msgstr "" + +#. type: cindex +#: doc/guix.texi:7918 +#, no-wrap +msgid "non-determinism, in package builds" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7929 +msgid "As an example, @code{guix.example.org} always gets a different answer. Conversely, @code{hydra.gnu.org} agrees with local builds, except in the case of Git. This might indicate that the build process of Git is non-deterministic, meaning that its output varies as a function of various things that Guix does not fully control, in spite of building packages in isolated environments (@pxref{Features}). Most common sources of non-determinism include the addition of timestamps in build results, the inclusion of random numbers, and directory listings sorted by inode number. See @uref{https://reproducible-builds.org/docs/}, for more information." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7932 +msgid "To find out what is wrong with this Git binary, we can do something along these lines (@pxref{Invoking guix archive}):" +msgstr "" + +#. type: example +#: doc/guix.texi:7937 +#, no-wrap +msgid "" +"$ wget -q -O - https://hydra.gnu.org/nar/@dots{}-git-2.5.0 \\\n" +" | guix archive -x /tmp/git\n" +"$ diff -ur --no-dereference /gnu/store/@dots{}-git.2.5.0 /tmp/git\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7946 +msgid "This command shows the difference between the files resulting from the local build, and the files resulting from the build on @code{hydra.gnu.org} (@pxref{Overview, Comparing and Merging Files,, diffutils, Comparing and Merging Files}). The @command{diff} command works great for text files. When binary files differ, a better option is @uref{https://diffoscope.org/, Diffoscope}, a tool that helps visualize differences for all kinds of files." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7954 +msgid "Once you have done that work, you can tell whether the differences are due to a non-deterministic build process or to a malicious server. We try hard to remove sources of non-determinism in packages to make it easier to verify substitutes, but of course, this is a process that involves not just Guix, but a large part of the free software community. In the meantime, @command{guix challenge} is one tool to help address the problem." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7958 +msgid "If you are writing packages for Guix, you are encouraged to check whether @code{hydra.gnu.org} and other substitute servers obtain the same build result as you did with:" +msgstr "" + +#. type: example +#: doc/guix.texi:7961 +#, no-wrap +msgid "$ guix challenge @var{package}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7966 +msgid "where @var{package} is a package specification such as @code{guile@@2.0} or @code{glibc:debug}." +msgstr "" + +#. type: example +#: doc/guix.texi:7971 +#, no-wrap +msgid "guix challenge @var{options} [@var{packages}@dots{}]\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7978 +msgid "When a difference is found between the hash of a locally-built item and that of a server-provided substitute, or among substitutes provided by different servers, the command displays it as in the example above and its exit code is 2 (other non-zero exit codes denote other kinds of errors.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:7980 +msgid "The one option that matters is:" +msgstr "" + +#. type: table +#: doc/guix.texi:7986 +msgid "Consider @var{urls} the whitespace-separated list of substitute source URLs to compare to." +msgstr "" + +#. type: itemx +#: doc/guix.texi:7988 +#, no-wrap +msgid "-v" +msgstr "" + +#. type: table +#: doc/guix.texi:7991 +msgid "Show details about matches (identical contents) in addition to information about mismatches." +msgstr "" + +#. type: section +#: doc/guix.texi:7995 +#, no-wrap +msgid "Invoking @command{guix copy}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7997 +#, no-wrap +msgid "copy, of store items, over SSH" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7998 +#, no-wrap +msgid "SSH, copy of store items" +msgstr "" + +#. type: cindex +#: doc/guix.texi:7999 +#, no-wrap +msgid "sharing store items across machines" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8000 +#, no-wrap +msgid "transferring store items across machines" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8007 +msgid "The @command{guix copy} command copies items from the store of one machine to that of another machine over a secure shell (SSH) connection@footnote{This command is available only when Guile-SSH was found. @xref{Requirements}, for details.}. For example, the following command copies the @code{coreutils} package, the user's profile, and all their dependencies over to @var{host}, logged in as @var{user}:" +msgstr "" + +#. type: example +#: doc/guix.texi:8011 +#, no-wrap +msgid "" +"guix copy --to=@var{user}@@@var{host} \\\n" +" coreutils `readlink -f ~/.guix-profile`\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8015 +msgid "If some of the items to be copied are already present on @var{host}, they are not actually sent." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8018 +msgid "The command below retrieves @code{libreoffice} and @code{gimp} from @var{host}, assuming they are available there:" +msgstr "" + +#. type: example +#: doc/guix.texi:8021 +#, no-wrap +msgid "guix copy --from=@var{host} libreoffice gimp\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8026 +msgid "The SSH connection is established using the Guile-SSH client, which is compatible with OpenSSH: it honors @file{~/.ssh/known_hosts} and @file{~/.ssh/config}, and uses the SSH agent for authentication." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8032 +msgid "The key used to sign items that are sent must be accepted by the remote machine. Likewise, the key used by the remote machine to sign items you are retrieving must be in @file{/etc/guix/acl} so it is accepted by your own daemon. @xref{Invoking guix archive}, for more information about store item authentication." +msgstr "" + +#. type: example +#: doc/guix.texi:8037 +#, no-wrap +msgid "guix copy [--to=@var{spec}|--from=@var{spec}] @var{items}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8040 +msgid "You must always specify one of the following options:" +msgstr "" + +#. type: item +#: doc/guix.texi:8042 +#, no-wrap +msgid "--to=@var{spec}" +msgstr "" + +#. type: itemx +#: doc/guix.texi:8043 +#, no-wrap +msgid "--from=@var{spec}" +msgstr "" + +#. type: table +#: doc/guix.texi:8047 +msgid "Specify the host to send to or receive from. @var{spec} must be an SSH spec such as @code{example.org}, @code{charlie@@example.org}, or @code{charlie@@example.org:2222}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8051 +msgid "The @var{items} can be either package names, such as @code{gimp}, or store items, such as @file{/gnu/store/@dots{}-idutils-4.6}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8055 +msgid "When specifying the name of a package to send, it is first built if needed, unless @option{--dry-run} was specified. Common build options are supported (@pxref{Common Build Options})." +msgstr "" + +#. type: section +#: doc/guix.texi:8058 +#, no-wrap +msgid "Invoking @command{guix container}" +msgstr "" + +#. type: command{#1} +#: doc/guix.texi:8060 +#, no-wrap +msgid "guix container" +msgstr "" + +#. type: quotation +#: doc/guix.texi:8064 +msgid "As of version @value{VERSION}, this tool is experimental. The interface is subject to radical change in the future." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8071 +msgid "The purpose of @command{guix container} is to manipulate processes running within an isolated environment, commonly known as a ``container'', typically created by the @command{guix environment} (@pxref{Invoking guix environment}) and @command{guix system container} (@pxref{Invoking guix system}) commands." +msgstr "" + +#. type: example +#: doc/guix.texi:8076 +#, no-wrap +msgid "guix container @var{action} @var{options}@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8080 +msgid "@var{action} specifies the operation to perform with a container, and @var{options} specifies the context-specific arguments for the action." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8082 +msgid "The following actions are available:" +msgstr "" + +#. type: item +#: doc/guix.texi:8084 +#, no-wrap +msgid "exec" +msgstr "" + +#. type: table +#: doc/guix.texi:8086 +msgid "Execute a command within the context of a running container." +msgstr "" + +#. type: table +#: doc/guix.texi:8088 +msgid "The syntax is:" +msgstr "" + +#. type: example +#: doc/guix.texi:8091 +#, no-wrap +msgid "guix container exec @var{pid} @var{program} @var{arguments}@dots{}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:8097 +msgid "@var{pid} specifies the process ID of the running container. @var{program} specifies an executable file name within the root file system of the container. @var{arguments} are the additional options that will be passed to @var{program}." +msgstr "" + +#. type: table +#: doc/guix.texi:8101 +msgid "The following command launches an interactive login shell inside a GuixSD container, started by @command{guix system container}, and whose process ID is 9001:" +msgstr "" + +#. type: example +#: doc/guix.texi:8104 +#, no-wrap +msgid "guix container exec 9001 /run/current-system/profile/bin/bash --login\n" +msgstr "" + +#. type: table +#: doc/guix.texi:8108 +msgid "Note that the @var{pid} cannot be the parent process of a container. It must be PID 1 of the container or one of its child processes." +msgstr "" + +#. type: section +#: doc/guix.texi:8112 +#, no-wrap +msgid "Invoking @command{guix weather}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8121 +msgid "Occasionally you're grumpy because substitutes are lacking and you end up building packages by yourself (@pxref{Substitutes}). The @command{guix weather} command reports on substitute availability on the specified servers so you can have an idea of whether you'll be grumpy today. It can sometimes be useful info as a user, but it is primarily useful to people running @command{guix publish} (@pxref{Invoking guix publish})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8122 +#, no-wrap +msgid "statistics, for substitutes" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8123 +#, no-wrap +msgid "availability of substitutes" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8124 +#, no-wrap +msgid "substitute availability" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8125 +#, no-wrap +msgid "weather, substitute availability" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8127 +msgid "Here's a sample run:" +msgstr "" + +#. type: example +#: doc/guix.texi:8139 +#, no-wrap +msgid "" +"$ guix weather --substitute-urls=https://guix.example.org\n" +"computing 5,872 package derivations for x86_64-linux...\n" +"looking for 6,128 store items on https://guix.example.org..\n" +"updating list of substitutes from 'https://guix.example.org'... 100.0%\n" +"https://guix.example.org\n" +" 43.4% substitutes available (2,658 out of 6,128)\n" +" 7,032.5 MiB of nars (compressed)\n" +" 19,824.2 MiB on disk (uncompressed)\n" +" 0.030 seconds per request (182.9 seconds in total)\n" +" 33.5 requests per second\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:8149 +#, no-wrap +msgid "" +" 9.8% (342 out of 3,470) of the missing items are queued\n" +" 867 queued builds\n" +" x86_64-linux: 518 (59.7%)\n" +" i686-linux: 221 (25.5%)\n" +" aarch64-linux: 128 (14.8%)\n" +" build rate: 23.41 builds per hour\n" +" x86_64-linux: 11.16 builds per hour\n" +" i686-linux: 6.03 builds per hour\n" +" aarch64-linux: 6.41 builds per hour\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8151 +#, no-wrap +msgid "continuous integration, statistics" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8160 +msgid "As you can see, it reports the fraction of all the packages for which substitutes are available on the server---regardless of whether substitutes are enabled, and regardless of whether this server's signing key is authorized. It also reports the size of the compressed archives (``nars'') provided by the server, the size the corresponding store items occupy in the store (assuming deduplication is turned off), and the server's throughput. The second part gives continuous integration (CI) statistics, if the server supports it." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8166 +msgid "To achieve that, @command{guix weather} queries over HTTP(S) meta-data (@dfn{narinfos}) for all the relevant store items. Like @command{guix challenge}, it ignores signatures on those substitutes, which is innocuous since the command only gathers statistics and cannot install those substitutes." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8169 +msgid "Among other things, it is possible to query specific system types and specific package sets. The available options are listed below." +msgstr "" + +#. type: table +#: doc/guix.texi:8175 +msgid "@var{urls} is the space-separated list of substitute server URLs to query. When this option is omitted, the default set of substitute servers is queried." +msgstr "" + +#. type: table +#: doc/guix.texi:8181 +msgid "Query substitutes for @var{system}---e.g., @code{aarch64-linux}. This option can be repeated, in which case @command{guix weather} will query substitutes for several system types." +msgstr "" + +#. type: table +#: doc/guix.texi:8187 +msgid "Instead of querying substitutes for all the packages, only ask for those specified in @var{file}. @var{file} must contain a @dfn{manifest}, as with the @code{-m} option of @command{guix package} (@pxref{Invoking guix package})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8205 +msgid "Guix comes with a distribution of the GNU system consisting entirely of free software@footnote{The term ``free'' here refers to the @url{http://www.gnu.org/philosophy/free-sw.html,freedom provided to users of that software}.}. The distribution can be installed on its own (@pxref{System Installation}), but it is also possible to install Guix as a package manager on top of an installed GNU/Linux system (@pxref{Installation}). To distinguish between the two, we refer to the standalone distribution as the Guix System Distribution, or GuixSD." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8211 +msgid "The distribution provides core GNU packages such as GNU libc, GCC, and Binutils, as well as many GNU and non-GNU applications. The complete list of available packages can be browsed @url{http://www.gnu.org/software/guix/packages,on-line} or by running @command{guix package} (@pxref{Invoking guix package}):" +msgstr "" + +#. type: example +#: doc/guix.texi:8214 +#, no-wrap +msgid "guix package --list-available\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8220 +msgid "Our goal is to provide a practical 100% free software distribution of Linux-based and other variants of GNU, with a focus on the promotion and tight integration of GNU components, and an emphasis on programs and tools that help users exert that freedom." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8222 +msgid "Packages are currently available on the following platforms:" +msgstr "" + +#. type: item +#: doc/guix.texi:8225 doc/guix.texi:8390 +#, no-wrap +msgid "x86_64-linux" +msgstr "" + +#. type: table +#: doc/guix.texi:8227 +msgid "Intel/AMD @code{x86_64} architecture, Linux-Libre kernel;" +msgstr "" + +#. type: item +#: doc/guix.texi:8228 doc/guix.texi:8393 +#, no-wrap +msgid "i686-linux" +msgstr "" + +#. type: table +#: doc/guix.texi:8230 +msgid "Intel 32-bit architecture (IA32), Linux-Libre kernel;" +msgstr "" + +#. type: item +#: doc/guix.texi:8231 +#, no-wrap +msgid "armhf-linux" +msgstr "" + +#. type: table +#: doc/guix.texi:8235 +msgid "ARMv7-A architecture with hard float, Thumb-2 and NEON, using the EABI hard-float application binary interface (ABI), and Linux-Libre kernel." +msgstr "" + +#. type: item +#: doc/guix.texi:8236 +#, no-wrap +msgid "aarch64-linux" +msgstr "" + +#. type: table +#: doc/guix.texi:8240 +msgid "little-endian 64-bit ARMv8-A processors, Linux-Libre kernel. This is currently in an experimental stage, with limited support. @xref{Contributing}, for how to help!" +msgstr "" + +#. type: item +#: doc/guix.texi:8241 +#, no-wrap +msgid "mips64el-linux" +msgstr "" + +#. type: table +#: doc/guix.texi:8244 +msgid "little-endian 64-bit MIPS processors, specifically the Loongson series, n32 ABI, and Linux-Libre kernel." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8248 +msgid "GuixSD itself is currently only available on @code{i686} and @code{x86_64}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8252 +msgid "For information on porting to other architectures or kernels, @pxref{Porting}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8267 +msgid "Building this distribution is a cooperative effort, and you are invited to join! @xref{Contributing}, for information about how you can help." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8271 +#, no-wrap +msgid "installing GuixSD" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8277 +msgid "This section explains how to install the Guix System Distribution (GuixSD) on a machine. The Guix package manager can also be installed on top of a running GNU/Linux system, @pxref{Installation}." +msgstr "" + +#. type: quotation +#: doc/guix.texi:8286 +msgid "You are reading this documentation with an Info reader. For details on how to use it, hit the @key{RET} key (``return'' or ``enter'') on the link that follows: @pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}. Hit @kbd{l} afterwards to come back here." +msgstr "" + +#. type: quotation +#: doc/guix.texi:8289 +msgid "Alternately, run @command{info info} in another tty to keep the manual available." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8314 +msgid "As of version @value{VERSION}, the Guix System Distribution (GuixSD) is not production-ready. It may contain bugs and lack important features. Thus, if you are looking for a stable production system that respects your freedom as a computer user, a good solution at this point is to consider @url{http://www.gnu.org/distros/free-distros.html, one of the more established GNU/Linux distributions}. We hope you can soon switch to the GuixSD without fear, of course. In the meantime, you can also keep using your distribution and try out the package manager on top of it (@pxref{Installation})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8317 +msgid "Before you proceed with the installation, be aware of the following noteworthy limitations applicable to version @value{VERSION}:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:8323 +msgid "The installation process does not include a graphical user interface and requires familiarity with GNU/Linux (see the following subsections to get a feel of what that means.)" +msgstr "" + +#. type: itemize +#: doc/guix.texi:8326 +msgid "Support for the Logical Volume Manager (LVM) is missing." +msgstr "" + +#. type: itemize +#: doc/guix.texi:8330 +msgid "More and more system services are provided (@pxref{Services}), but some may be missing." +msgstr "" + +#. type: itemize +#: doc/guix.texi:8334 +msgid "More than 6,500 packages are available, but you might occasionally find that a useful package is missing." +msgstr "" + +#. type: itemize +#: doc/guix.texi:8339 +msgid "GNOME, Xfce, LXDE, and Enlightenment are available (@pxref{Desktop Services}), as well as a number of X11 window managers. However, some graphical applications may be missing, as well as KDE." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8344 +msgid "You have been warned! But more than a disclaimer, this is an invitation to report issues (and success stories!), and to join us in improving it. @xref{Contributing}, for more info." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8349 +#, no-wrap +msgid "hardware support on GuixSD" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8358 +msgid "GNU@tie{}GuixSD focuses on respecting the user's computing freedom. It builds around the kernel Linux-libre, which means that only hardware for which free software drivers and firmware exist is supported. Nowadays, a wide range of off-the-shelf hardware is supported on GNU/Linux-libre---from keyboards to graphics cards to scanners and Ethernet controllers. Unfortunately, there are still areas where hardware vendors deny users control over their own computing, and such hardware is not supported on GuixSD." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8359 +#, no-wrap +msgid "WiFi, hardware support" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8368 +msgid "One of the main areas where free drivers or firmware are lacking is WiFi devices. WiFi devices known to work include those using Atheros chips (AR9271 and AR7010), which corresponds to the @code{ath9k} Linux-libre driver, and those using Broadcom/AirForce chips (BCM43xx with Wireless-Core Revision 5), which corresponds to the @code{b43-open} Linux-libre driver. Free firmware exists for both and is available out-of-the-box on GuixSD, as part of @var{%base-firmware} (@pxref{operating-system Reference, @code{firmware}})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8369 +#, no-wrap +msgid "RYF, Respects Your Freedom" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8375 +msgid "The @uref{https://www.fsf.org/, Free Software Foundation} runs @uref{https://www.fsf.org/ryf, @dfn{Respects Your Freedom}} (RYF), a certification program for hardware products that respect your freedom and your privacy and ensure that you have control over your device. We encourage you to check the list of RYF-certified devices." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8379 +msgid "Another useful resource is the @uref{https://www.h-node.org/, H-Node} web site. It contains a catalog of hardware devices with information about their support in GNU/Linux." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8388 +msgid "An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from @indicateurl{ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.iso.xz}, where @var{system} is one of:" +msgstr "" + +#. type: table +#: doc/guix.texi:8392 +msgid "for a GNU/Linux system on Intel/AMD-compatible 64-bit CPUs;" +msgstr "" + +#. type: table +#: doc/guix.texi:8395 +msgid "for a 32-bit GNU/Linux system on Intel-compatible CPUs." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8400 +msgid "Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines:" +msgstr "" + +#. type: example +#: doc/guix.texi:8404 +#, fuzzy, no-wrap +#| msgid "" +#| "$ wget https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +#| "$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +msgid "" +"$ wget ftp://alpha.gnu.org/gnu/guix/guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig\n" +"$ gpg --verify guixsd-install-@value{VERSION}.@var{system}.iso.xz.sig\n" +msgstr "" +"$ wget https://alpha.gnu.org/gnu/guix/guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" +"$ gpg --verify guix-binary-@value{VERSION}.@var{system}.tar.xz.sig\n" + +#. type: Plain text +#: doc/guix.texi:8419 +msgid "This image contains the tools necessary for an installation. It is meant to be copied @emph{as is} to a large-enough USB stick or DVD." +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:8420 +#, no-wrap +msgid "Copying to a USB Stick" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8423 +msgid "To copy the image to a USB stick, follow these steps:" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8427 doc/guix.texi:8452 +msgid "Decompress the image using the @command{xz} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:8430 doc/guix.texi:8455 +#, no-wrap +msgid "xz -d guixsd-install-@value{VERSION}.@var{system}.iso.xz\n" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8436 +msgid "Insert a USB stick of 1@tie{}GiB or more into your machine, and determine its device name. Assuming that the USB stick is known as @file{/dev/sdX}, copy the image with:" +msgstr "" + +#. type: example +#: doc/guix.texi:8440 +#, no-wrap +msgid "" +"dd if=guixsd-install-@value{VERSION}.x86_64-linux.iso of=/dev/sdX\n" +"sync\n" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8443 +msgid "Access to @file{/dev/sdX} usually requires root privileges." +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:8445 +#, no-wrap +msgid "Burning on a DVD" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8448 +msgid "To copy the image to a DVD, follow these steps:" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8461 +msgid "Insert a blank DVD into your machine, and determine its device name. Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with:" +msgstr "" + +#. type: example +#: doc/guix.texi:8464 +#, no-wrap +msgid "growisofs -dvd-compat -Z /dev/srX=guixsd-install-@value{VERSION}.x86_64.iso\n" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8467 +msgid "Access to @file{/dev/srX} usually requires root privileges." +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:8469 +#, no-wrap +msgid "Booting" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8474 +msgid "Once this is done, you should be able to reboot the system and boot from the USB stick or DVD. The latter usually requires you to get in the BIOS or UEFI boot menu, where you can choose to boot from the USB stick." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8477 +msgid "@xref{Installing GuixSD in a VM}, if, instead, you would like to install GuixSD in a virtual machine (VM)." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8489 +msgid "Once you have successfully booted your computer using the installation medium, you should end up with a root prompt. Several console TTYs are configured and can be used to run commands as root. TTY2 shows this documentation, browsable using the Info reader commands (@pxref{Top,,, info-stnd, Stand-alone GNU Info}). The installation system runs the GPM mouse daemon, which allows you to select text with the left mouse button and to paste it with the middle button." +msgstr "" + +#. type: quotation +#: doc/guix.texi:8494 +msgid "Installation requires access to the Internet so that any missing dependencies of your system configuration can be downloaded. See the ``Networking'' section below." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8500 +msgid "The installation system includes many common tools needed for this task. But it is also a full-blown GuixSD system, which means that you can install additional packages, should you need it, using @command{guix package} (@pxref{Invoking guix package})." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:8501 +#, no-wrap +msgid "Keyboard Layout" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8503 doc/guix.texi:10593 doc/guix.texi:11931 +#, no-wrap +msgid "keyboard layout" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8507 +msgid "The installation image uses the US qwerty keyboard layout. If you want to change it, you can use the @command{loadkeys} command. For example, the following command selects the Dvorak keyboard layout:" +msgstr "" + +#. type: example +#: doc/guix.texi:8510 +#, no-wrap +msgid "loadkeys dvorak\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8515 +msgid "See the files under @file{/run/current-system/profile/share/keymaps} for a list of available keyboard layouts. Run @command{man loadkeys} for more information." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:8516 +#, no-wrap +msgid "Networking" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8519 +msgid "Run the following command see what your network interfaces are called:" +msgstr "" + +#. type: example +#: doc/guix.texi:8522 +#, no-wrap +msgid "ifconfig -a\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8526 +msgid "@dots{} or, using the GNU/Linux-specific @command{ip} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:8529 +#, no-wrap +msgid "ip a\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8536 +msgid "Wired interfaces have a name starting with @samp{e}; for example, the interface corresponding to the first on-board Ethernet controller is called @samp{eno1}. Wireless interfaces have a name starting with @samp{w}, like @samp{w1p2s0}." +msgstr "" + +#. type: item +#: doc/guix.texi:8538 +#, no-wrap +msgid "Wired connection" +msgstr "" + +#. type: table +#: doc/guix.texi:8541 +msgid "To configure a wired network run the following command, substituting @var{interface} with the name of the wired interface you want to use." +msgstr "" + +#. type: example +#: doc/guix.texi:8544 +#, no-wrap +msgid "ifconfig @var{interface} up\n" +msgstr "" + +#. type: item +#: doc/guix.texi:8546 +#, no-wrap +msgid "Wireless connection" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8547 doc/guix.texi:11008 +#, no-wrap +msgid "wireless" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8548 doc/guix.texi:11009 +#, no-wrap +msgid "WiFi" +msgstr "" + +#. type: table +#: doc/guix.texi:8553 +msgid "To configure wireless networking, you can create a configuration file for the @command{wpa_supplicant} configuration tool (its location is not important) using one of the available text editors such as @command{nano}:" +msgstr "" + +#. type: example +#: doc/guix.texi:8556 +#, no-wrap +msgid "nano wpa_supplicant.conf\n" +msgstr "" + +#. type: table +#: doc/guix.texi:8561 +msgid "As an example, the following stanza can go to this file and will work for many wireless networks, provided you give the actual SSID and passphrase for the network you are connecting to:" +msgstr "" + +#. type: example +#: doc/guix.texi:8568 +#, no-wrap +msgid "" +"network=@{\n" +" ssid=\"@var{my-ssid}\"\n" +" key_mgmt=WPA-PSK\n" +" psk=\"the network's secret passphrase\"\n" +"@}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:8573 +msgid "Start the wireless service and run it in the background with the following command (substitute @var{interface} with the name of the network interface you want to use):" +msgstr "" + +#. type: example +#: doc/guix.texi:8576 +#, no-wrap +msgid "wpa_supplicant -c wpa_supplicant.conf -i @var{interface} -B\n" +msgstr "" + +#. type: table +#: doc/guix.texi:8579 +msgid "Run @command{man wpa_supplicant} for more information." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8581 +#, no-wrap +msgid "DHCP" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8584 +msgid "At this point, you need to acquire an IP address. On a network where IP addresses are automatically assigned @i{via} DHCP, you can run:" +msgstr "" + +#. type: example +#: doc/guix.texi:8587 +#, no-wrap +msgid "dhclient -v @var{interface}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8590 +msgid "Try to ping a server to see if networking is up and running:" +msgstr "" + +#. type: example +#: doc/guix.texi:8593 +#, no-wrap +msgid "ping -c 3 gnu.org\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8597 +msgid "Setting up network access is almost always a requirement because the image does not contain all the software and tools that may be needed." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8598 +#, no-wrap +msgid "installing over SSH" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8601 +msgid "If you want to, you can continue the installation remotely by starting an SSH server:" +msgstr "" + +#. type: example +#: doc/guix.texi:8604 +#, no-wrap +msgid "herd start ssh-daemon\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8608 +msgid "Make sure to either set a password with @command{passwd}, or configure OpenSSH public key authentication before logging in." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:8609 +#, no-wrap +msgid "Disk Partitioning" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8613 +msgid "Unless this has already been done, the next step is to partition, and then format the target partition(s)." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8618 +msgid "The installation image includes several partitioning tools, including Parted (@pxref{Overview,,, parted, GNU Parted User Manual}), @command{fdisk}, and @command{cfdisk}. Run it and set up your disk with the partition layout you want:" +msgstr "" + +#. type: example +#: doc/guix.texi:8621 +#, no-wrap +msgid "cfdisk\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8627 +msgid "If your disk uses the GUID Partition Table (GPT) format and you plan to install BIOS-based GRUB (which is the default), make sure a BIOS Boot Partition is available (@pxref{BIOS installation,,, grub, GNU GRUB manual})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8628 +#, no-wrap +msgid "EFI, installation" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8629 +#, no-wrap +msgid "UEFI, installation" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8630 +#, no-wrap +msgid "ESP, EFI system partition" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8634 +msgid "If you instead wish to use EFI-based GRUB, a FAT32 @dfn{EFI System Partition} (ESP) is required. This partition should be mounted at @file{/boot/efi} and must have the @code{esp} flag set. E.g., for @command{parted}:" +msgstr "" + +#. type: example +#: doc/guix.texi:8637 +#, no-wrap +msgid "parted /dev/sda set 1 esp on\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8645 +msgid "Once you are done partitioning the target hard disk drive, you have to create a file system on the relevant partition(s)@footnote{Currently GuixSD only supports ext4 and btrfs file systems. In particular, code that reads file system UUIDs and labels only works for these file system types.}. For the ESP, if you have one and assuming it is @file{/dev/sda2}, run:" +msgstr "" + +#. type: example +#: doc/guix.texi:8648 +#, no-wrap +msgid "mkfs.fat -F32 /dev/sda2\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8656 +msgid "Preferably, assign file systems a label so that you can easily and reliably refer to them in @code{file-system} declarations (@pxref{File Systems}). This is typically done using the @code{-L} option of @command{mkfs.ext4} and related commands. So, assuming the target root partition lives at @file{/dev/sda1}, a file system with the label @code{my-root} can be created with:" +msgstr "" + +#. type: example +#: doc/guix.texi:8659 +#, no-wrap +msgid "mkfs.ext4 -L my-root /dev/sda1\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8661 doc/guix.texi:9066 +#, no-wrap +msgid "encrypted disk" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8668 +msgid "If you are instead planning to encrypt the root partition, you can use the Cryptsetup/LUKS utilities to do that (see @inlinefmtifelse{html, @uref{https://linux.die.net/man/8/cryptsetup, @code{man cryptsetup}}, @code{man cryptsetup}} for more information.) Assuming you want to store the root partition on @file{/dev/sda1}, the command sequence would be along these lines:" +msgstr "" + +#. type: example +#: doc/guix.texi:8673 +#, no-wrap +msgid "" +"cryptsetup luksFormat /dev/sda1\n" +"cryptsetup open --type luks /dev/sda1 my-partition\n" +"mkfs.ext4 -L my-root /dev/mapper/my-partition\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8678 +msgid "Once that is done, mount the target file system under @file{/mnt} with a command like (again, assuming @code{my-root} is the label of the root file system):" +msgstr "" + +#. type: example +#: doc/guix.texi:8681 +#, no-wrap +msgid "mount LABEL=my-root /mnt\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8687 +msgid "Also mount any other file systems you would like to use on the target system relative to this path. If you have @file{/boot} on a separate partition for example, mount it at @file{/mnt/boot} now so it is found by @code{guix system init} afterwards." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8692 +msgid "Finally, if you plan to use one or more swap partitions (@pxref{Memory Concepts, swap space,, libc, The GNU C Library Reference Manual}), make sure to initialize them with @command{mkswap}. Assuming you have one swap partition on @file{/dev/sda2}, you would run:" +msgstr "" + +#. type: example +#: doc/guix.texi:8696 +#, no-wrap +msgid "" +"mkswap /dev/sda2\n" +"swapon /dev/sda2\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8704 +msgid "Alternatively, you may use a swap file. For example, assuming that in the new system you want to use the file @file{/swapfile} as a swap file, you would run@footnote{This example will work for many types of file systems (e.g., ext4). However, for copy-on-write file systems (e.g., btrfs), the required steps may be different. For details, see the manual pages for @command{mkswap} and @command{swapon}.}:" +msgstr "" + +#. type: example +#: doc/guix.texi:8712 +#, no-wrap +msgid "" +"# This is 10 GiB of swap space. Adjust \"count\" to change the size.\n" +"dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240\n" +"# For security, make the file readable and writable only by root.\n" +"chmod 600 /mnt/swapfile\n" +"mkswap /mnt/swapfile\n" +"swapon /mnt/swapfile\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8717 +msgid "Note that if you have encrypted the root partition and created a swap file in its file system as described above, then the encryption also protects the swap file, just like any other file in that file system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8723 +msgid "With the target partitions ready and the target root mounted on @file{/mnt}, we're ready to go. First, run:" +msgstr "" + +#. type: example +#: doc/guix.texi:8726 +#, no-wrap +msgid "herd start cow-store /mnt\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8733 +msgid "This makes @file{/gnu/store} copy-on-write, such that packages added to it during the installation phase are written to the target disk on @file{/mnt} rather than kept in memory. This is necessary because the first phase of the @command{guix system init} command (see below) entails downloads or builds to @file{/gnu/store} which, initially, is an in-memory file system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8744 +msgid "Next, you have to edit a file and provide the declaration of the operating system to be installed. To that end, the installation system comes with three text editors. We recommend GNU nano (@pxref{Top,,, nano, GNU nano Manual}), which supports syntax highlighting and parentheses matching; other editors include GNU Zile (an Emacs clone), and nvi (a clone of the original BSD @command{vi} editor). We strongly recommend storing that file on the target root file system, say, as @file{/mnt/etc/config.scm}. Failing to do that, you will have lost your configuration file once you have rebooted into the newly-installed system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8751 +msgid "@xref{Using the Configuration System}, for an overview of the configuration file. The example configurations discussed in that section are available under @file{/etc/configuration} in the installation image. Thus, to get started with a system configuration providing a graphical display server (a ``desktop'' system), you can run something along these lines:" +msgstr "" + +#. type: example +#: doc/guix.texi:8756 +#, no-wrap +msgid "" +"# mkdir /mnt/etc\n" +"# cp /etc/configuration/desktop.scm /mnt/etc/config.scm\n" +"# nano /mnt/etc/config.scm\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8760 +msgid "You should pay attention to what your configuration file contains, and in particular:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:8770 +msgid "Make sure the @code{bootloader-configuration} form refers to the target you want to install GRUB on. It should mention @code{grub-bootloader} if you are installing GRUB in the legacy way, or @code{grub-efi-bootloader} for newer UEFI systems. For legacy systems, the @code{target} field names a device, like @code{/dev/sda}; for UEFI systems it names a path to a mounted EFI partition, like @code{/boot/efi}, and do make sure the path is actually mounted." +msgstr "" + +#. type: itemize +#: doc/guix.texi:8776 +msgid "Be sure that your file system labels match the value of their respective @code{device} fields in your @code{file-system} configuration, assuming your @code{file-system} configuration sets the value of @code{title} to @code{'label}." +msgstr "" + +#. type: itemize +#: doc/guix.texi:8780 +msgid "If there are encrypted or RAID partitions, make sure to add a @code{mapped-devices} field to describe them (@pxref{Mapped Devices})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8785 +msgid "Once you are done preparing the configuration file, the new system must be initialized (remember that the target root file system is mounted under @file{/mnt}):" +msgstr "" + +#. type: example +#: doc/guix.texi:8788 +#, no-wrap +msgid "guix system init /mnt/etc/config.scm /mnt\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8795 +msgid "This copies all the necessary files and installs GRUB on @file{/dev/sdX}, unless you pass the @option{--no-bootloader} option. For more information, @pxref{Invoking guix system}. This command may trigger downloads or builds of missing packages, which can take some time." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8802 +msgid "Once that command has completed---and hopefully succeeded!---you can run @command{reboot} and boot into the new system. The @code{root} password in the new system is initially empty; other users' passwords need to be initialized by running the @command{passwd} command as @code{root}, unless your configuration specifies otherwise (@pxref{user-account-password, user account passwords})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8803 +#, no-wrap +msgid "upgrading GuixSD" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8810 +msgid "From then on, you can update GuixSD whenever you want by running @command{guix pull} as @code{root} (@pxref{Invoking guix pull}), and then running @command{guix system reconfigure} to build a new system generation with the latest packages and services (@pxref{Invoking guix system}). We recommend doing that regularly so that your system includes the latest security updates (@pxref{Security Updates})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8814 +msgid "Join us on @code{#guix} on the Freenode IRC network or on @file{guix-devel@@gnu.org} to share your experience---good or not so good." +msgstr "" + +#. type: subsection +#: doc/guix.texi:8816 +#, no-wrap +msgid "Installing GuixSD in a Virtual Machine" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8818 +#, no-wrap +msgid "virtual machine, GuixSD installation" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8819 +#, no-wrap +msgid "virtual private server (VPS)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:8820 +#, no-wrap +msgid "VPS (virtual private server)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8824 +msgid "If you'd like to install GuixSD in a virtual machine (VM) or on a virtual private server (VPS) rather than on your beloved machine, this section is for you." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8827 +msgid "To boot a @uref{http://qemu.org/,QEMU} VM for installing GuixSD in a disk image, follow these steps:" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8832 +msgid "First, retrieve and decompress the GuixSD installation image as described previously (@pxref{USB Stick and DVD Installation})." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8836 +msgid "Create a disk image that will hold the installed system. To make a qcow2-formatted disk image, use the @command{qemu-img} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:8839 +#, no-wrap +msgid "qemu-img create -f qcow2 guixsd.img 50G\n" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8843 +msgid "The resulting file will be much smaller than 50 GB (typically less than 1 MB), but it will grow as the virtualized storage device is filled up." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8846 +msgid "Boot the USB installation image in an VM:" +msgstr "" + +#. type: example +#: doc/guix.texi:8852 +#, no-wrap +msgid "" +"qemu-system-x86_64 -m 1024 -smp 1 \\\n" +" -net user -net nic,model=virtio -boot menu=on \\\n" +" -drive file=guixsd-install-@value{VERSION}.@var{system}.iso \\\n" +" -drive file=guixsd.img\n" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8855 +msgid "The ordering of the drives matters." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8859 +msgid "In the VM console, quickly press the @kbd{F12} key to enter the boot menu. Then press the @kbd{2} key and the @kbd{RET} key to validate your selection." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:8863 +msgid "You're now root in the VM, proceed with the installation process. @xref{Preparing for Installation}, and follow the instructions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8868 +msgid "Once installation is complete, you can boot the system that's on your @file{guixsd.img} image. @xref{Running GuixSD in a VM}, for how to do that." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8872 +#, no-wrap +msgid "installation image" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8875 +msgid "The installation image described above was built using the @command{guix system} command, specifically:" +msgstr "" + +#. type: example +#: doc/guix.texi:8878 +#, no-wrap +msgid "guix system disk-image gnu/system/install.scm\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8883 +msgid "Have a look at @file{gnu/system/install.scm} in the source tree, and see also @ref{Invoking guix system} for more information about the installation image." +msgstr "" + +#. type: subsection +#: doc/guix.texi:8884 +#, no-wrap +msgid "Building the Installation Image for ARM Boards" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8888 +msgid "Many ARM boards require a specific variant of the @uref{http://www.denx.de/wiki/U-Boot/, U-Boot} bootloader." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8892 +msgid "If you build a disk image and the bootloader is not available otherwise (on another boot drive etc), it's advisable to build an image that includes the bootloader, specifically:" +msgstr "" + +#. type: example +#: doc/guix.texi:8895 +#, no-wrap +msgid "guix system disk-image --system=armhf-linux -e '((@@ (gnu system install) os-with-u-boot) (@@ (gnu system install) installation-os) \"A20-OLinuXino-Lime2\")'\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8899 +msgid "@code{A20-OLinuXino-Lime2} is the name of the board. If you specify an invalid board, a list of possible boards will be printed." +msgstr "" + +#. type: cindex +#: doc/guix.texi:8903 +#, no-wrap +msgid "system configuration" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8909 +msgid "The Guix System Distribution supports a consistent whole-system configuration mechanism. By that we mean that all aspects of the global system configuration---such as the available system services, timezone and locale settings, user accounts---are declared in a single place. Such a @dfn{system configuration} can be @dfn{instantiated}---i.e., effected." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8919 +msgid "One of the advantages of putting all the system configuration under the control of Guix is that it supports transactional system upgrades, and makes it possible to roll back to a previous system instantiation, should something go wrong with the new one (@pxref{Features}). Another advantage is that it makes it easy to replicate the exact same configuration across different machines, or at different points in time, without having to resort to additional administration tools layered on top of the own tools of the system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8924 +msgid "This section describes this mechanism. First we focus on the system administrator's viewpoint---explaining how the system is configured and instantiated. Then we show how this mechanism can be extended, for instance to support new system services." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8951 +msgid "The operating system is configured by providing an @code{operating-system} declaration in a file that can then be passed to the @command{guix system} command (@pxref{Invoking guix system}). A simple setup, with the default system services, the default Linux-Libre kernel, initial RAM disk, and boot loader looks like this:" +msgstr "" + +#. type: findex +#: doc/guix.texi:8952 +#, no-wrap +msgid "operating-system" +msgstr "" + +#. type: include +#: doc/guix.texi:8954 +#, no-wrap +msgid "os-config-bare-bones.texi" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8961 +msgid "This example should be self-describing. Some of the fields defined above, such as @code{host-name} and @code{bootloader}, are mandatory. Others, such as @code{packages} and @code{services}, can be omitted, in which case they get a default value." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8966 +msgid "Below we discuss the effect of some of the most important fields (@pxref{operating-system Reference}, for details about all the available fields), and how to @dfn{instantiate} the operating system using @command{guix system}." +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:8967 +#, no-wrap +msgid "Globally-Visible Packages" +msgstr "" + +#. type: vindex +#: doc/guix.texi:8969 +#, no-wrap +msgid "%base-packages" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:8982 +msgid "The @code{packages} field lists packages that will be globally visible on the system, for all user accounts---i.e., in every user's @code{PATH} environment variable---in addition to the per-user profiles (@pxref{Invoking guix package}). The @var{%base-packages} variable provides all the tools one would expect for basic user and administrator tasks---including the GNU Core Utilities, the GNU Networking Utilities, the GNU Zile lightweight text editor, @command{find}, @command{grep}, etc. The example above adds GNU@tie{}Screen and OpenSSH to those, taken from the @code{(gnu packages screen)} and @code{(gnu packages ssh)} modules (@pxref{Package Modules}). The @code{(list package output)} syntax can be used to add a specific output of a package:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:8986 +#, no-wrap +msgid "" +"(use-modules (gnu packages))\n" +"(use-modules (gnu packages dns))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:8991 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; ...\n" +" (packages (cons (list bind \"utils\")\n" +" %base-packages)))\n" +msgstr "" + +#. type: findex +#: doc/guix.texi:8993 +#, no-wrap +msgid "specification->package" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9002 +msgid "Referring to packages by variable name, like @code{bind} above, has the advantage of being unambiguous; it also allows typos and such to be diagnosed right away as ``unbound variables''. The downside is that one needs to know which module defines which package, and to augment the @code{use-package-modules} line accordingly. To avoid that, one can use the @code{specification->package} procedure of the @code{(gnu packages)} module, which returns the best package for a given name or name and version:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:9005 +#, no-wrap +msgid "" +"(use-modules (gnu packages))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:9011 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; ...\n" +" (packages (append (map specification->package\n" +" '(\"tcpdump\" \"htop\" \"gnupg@@2.0\"))\n" +" %base-packages)))\n" +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:9013 +#, no-wrap +msgid "System Services" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9015 doc/guix.texi:20417 doc/guix.texi:21335 +#, no-wrap +msgid "services" +msgstr "" + +#. type: vindex +#: doc/guix.texi:9016 +#, no-wrap +msgid "%base-services" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9026 +msgid "The @code{services} field lists @dfn{system services} to be made available when the system starts (@pxref{Services}). The @code{operating-system} declaration above specifies that, in addition to the basic services, we want the @command{lshd} secure shell daemon listening on port 2222 (@pxref{Networking Services, @code{lsh-service}}). Under the hood, @code{lsh-service} arranges so that @code{lshd} is started with the right command-line options, possibly with supporting configuration files generated as needed (@pxref{Defining Services})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9027 +#, no-wrap +msgid "customization, of services" +msgstr "" + +#. type: findex +#: doc/guix.texi:9028 +#, no-wrap +msgid "modify-services" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9032 +msgid "Occasionally, instead of using the base services as is, you will want to customize them. To do this, use @code{modify-services} (@pxref{Service Reference, @code{modify-services}}) to modify the list." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9037 +msgid "For example, suppose you want to modify @code{guix-daemon} and Mingetty (the console log-in) in the @var{%base-services} list (@pxref{Base Services, @code{%base-services}}). To do that, you can write the following in your operating system declaration:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:9050 +#, no-wrap +msgid "" +"(define %my-services\n" +" ;; My very own list of services.\n" +" (modify-services %base-services\n" +" (guix-service-type config =>\n" +" (guix-configuration\n" +" (inherit config)\n" +" (use-substitutes? #f)\n" +" (extra-options '(\"--gc-keep-derivations\"))))\n" +" (mingetty-service-type config =>\n" +" (mingetty-configuration\n" +" (inherit config)))))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:9054 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (services %my-services))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9065 +msgid "This changes the configuration---i.e., the service parameters---of the @code{guix-service-type} instance, and that of all the @code{mingetty-service-type} instances in the @var{%base-services} list. Observe how this is accomplished: first, we arrange for the original configuration to be bound to the identifier @code{config} in the @var{body}, and then we write the @var{body} so that it evaluates to the desired configuration. In particular, notice how we use @code{inherit} to create a new configuration which has the same values as the old configuration, but with a few modifications." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9072 +msgid "The configuration for a typical ``desktop'' usage, with an encrypted root partition, the X11 display server, GNOME and Xfce (users can choose which of these desktop environments to use at the log-in screen by pressing @kbd{F1}), network management, power management, and more, would look like this:" +msgstr "" + +#. type: include +#: doc/guix.texi:9074 +#, no-wrap +msgid "os-config-desktop.texi" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9077 +#, no-wrap +msgid "UEFI" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9080 +msgid "A graphical UEFI system with a choice of lightweight window managers instead of full-blown desktop environments would look like this:" +msgstr "" + +#. type: include +#: doc/guix.texi:9082 +#, no-wrap +msgid "os-config-lightweight-desktop.texi" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9088 +msgid "This example refers to the @file{/boot/efi} file system by its UUID, @code{1234-ABCD}. Replace this UUID with the right UUID on your system, as returned by the @command{blkid} command." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9092 +msgid "@xref{Desktop Services}, for the exact list of services provided by @var{%desktop-services}. @xref{X.509 Certificates}, for background information about the @code{nss-certs} package that is used here." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9099 +msgid "Again, @var{%desktop-services} is just a list of service objects. If you want to remove services from there, you can do so using the procedures for list filtering (@pxref{SRFI-1 Filtering and Partitioning,,, guile, GNU Guile Reference Manual}). For instance, the following expression returns a list that contains all the services in @var{%desktop-services} minus the Avahi service:" +msgstr "" + +#. type: example +#: doc/guix.texi:9104 +#, no-wrap +msgid "" +"(remove (lambda (service)\n" +" (eq? (service-kind service) avahi-service-type))\n" +" %desktop-services)\n" +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:9106 +#, no-wrap +msgid "Instantiating the System" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9113 +msgid "Assuming the @code{operating-system} declaration is stored in the @file{my-system-config.scm} file, the @command{guix system reconfigure my-system-config.scm} command instantiates that configuration, and makes it the default GRUB boot entry (@pxref{Invoking guix system})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9121 +msgid "The normal way to change the system configuration is by updating this file and re-running @command{guix system reconfigure}. One should never have to touch files in @file{/etc} or to run commands that modify the system state such as @command{useradd} or @command{grub-install}. In fact, you must avoid that since that would not only void your warranty but also prevent you from rolling back to previous versions of your system, should you ever need to." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9122 +#, no-wrap +msgid "roll-back, of the operating system" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9132 +msgid "Speaking of roll-back, each time you run @command{guix system reconfigure}, a new @dfn{generation} of the system is created---without modifying or deleting previous generations. Old system generations get an entry in the bootloader boot menu, allowing you to boot them in case something went wrong with the latest generation. Reassuring, no? The @command{guix system list-generations} command lists the system generations available on disk. It is also possible to roll back the system via the commands @command{guix system roll-back} and @command{guix system switch-generation}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9138 +msgid "Although the command @command{guix system reconfigure} will not modify previous generations, must take care when the current generation is not the latest (e.g., after invoking @command{guix system roll-back}), since the operation might overwrite a later generation (@pxref{Invoking guix system})." +msgstr "" + +#. type: unnumberedsubsubsec +#: doc/guix.texi:9139 +#, no-wrap +msgid "The Programming Interface" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9144 +msgid "At the Scheme level, the bulk of an @code{operating-system} declaration is instantiated with the following monadic procedure (@pxref{The Store Monad}):" +msgstr "" + +#. type: deffn +#: doc/guix.texi:9145 +#, no-wrap +msgid "{Monadic Procedure} operating-system-derivation os" +msgstr "" + +#. type: deffn +#: doc/guix.texi:9148 +msgid "Return a derivation that builds @var{os}, an @code{operating-system} object (@pxref{Derivations})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:9152 +msgid "The output of the derivation is a single directory that refers to all the packages, configuration files, and other supporting files needed to instantiate @var{os}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9157 +msgid "This procedure is provided by the @code{(gnu system)} module. Along with @code{(gnu services)} (@pxref{Services}), this module contains the guts of GuixSD. Make sure to visit it!" +msgstr "" + +#. type: subsection +#: doc/guix.texi:9160 +#, no-wrap +msgid "@code{operating-system} Reference" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9165 +msgid "This section summarizes all the options available in @code{operating-system} declarations (@pxref{Using the Configuration System})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:9166 +#, no-wrap +msgid "{Data Type} operating-system" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9170 +msgid "This is the data type representing an operating system configuration. By that, we mean all the global system configuration, not per-user configuration (@pxref{Using the Configuration System})." +msgstr "" + +#. type: item +#: doc/guix.texi:9172 +#, no-wrap +msgid "@code{kernel} (default: @var{linux-libre})" +msgstr "" + +#. type: table +#: doc/guix.texi:9176 +msgid "The package object of the operating system kernel to use@footnote{Currently only the Linux-libre kernel is supported. In the future, it will be possible to use the GNU@tie{}Hurd.}." +msgstr "" + +#. type: item +#: doc/guix.texi:9177 +#, no-wrap +msgid "@code{kernel-arguments} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:9180 +msgid "List of strings or gexps representing additional arguments to pass on the command-line of the kernel---e.g., @code{(\"console=ttyS0\")}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9181 doc/guix.texi:20614 doc/guix.texi:20633 +#, no-wrap +msgid "bootloader" +msgstr "" + +#. type: table +#: doc/guix.texi:9183 +msgid "The system bootloader configuration object. @xref{Bootloader Configuration}." +msgstr "" + +#. type: item +#: doc/guix.texi:9184 +#, no-wrap +msgid "@code{initrd-modules} (default: @code{%base-initrd-modules})" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9185 doc/guix.texi:20454 doc/guix.texi:20557 +#: doc/guix.texi:20752 +#, no-wrap +msgid "initrd" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9186 doc/guix.texi:20455 doc/guix.texi:20558 +#, no-wrap +msgid "initial RAM disk" +msgstr "" + +#. type: table +#: doc/guix.texi:9189 +msgid "The list of Linux kernel modules that need to be available in the initial RAM disk. @xref{Initial RAM Disk}." +msgstr "" + +#. type: item +#: doc/guix.texi:9190 +#, no-wrap +msgid "@code{initrd} (default: @code{base-initrd})" +msgstr "" + +#. type: table +#: doc/guix.texi:9194 +msgid "A monadic procedure that returns an initial RAM disk for the Linux kernel. This field is provided to support low-level customization and should rarely be needed for casual use. @xref{Initial RAM Disk}." +msgstr "" + +#. type: item +#: doc/guix.texi:9195 +#, no-wrap +msgid "@code{firmware} (default: @var{%base-firmware})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9196 +#, no-wrap +msgid "firmware" +msgstr "" + +#. type: table +#: doc/guix.texi:9198 +msgid "List of firmware packages loadable by the operating system kernel." +msgstr "" + +#. type: table +#: doc/guix.texi:9203 +msgid "The default includes firmware needed for Atheros- and Broadcom-based WiFi devices (Linux-libre modules @code{ath9k} and @code{b43-open}, respectively). @xref{Hardware Considerations}, for more info on supported hardware." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9204 +#, no-wrap +msgid "host-name" +msgstr "" + +#. type: table +#: doc/guix.texi:9206 +msgid "The host name." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9207 +#, no-wrap +msgid "hosts-file" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9208 +#, no-wrap +msgid "hosts file" +msgstr "" + +#. type: table +#: doc/guix.texi:9213 +msgid "A file-like object (@pxref{G-Expressions, file-like objects}) for use as @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). The default is a file with entries for @code{localhost} and @var{host-name}." +msgstr "" + +#. type: item +#: doc/guix.texi:9214 +#, no-wrap +msgid "@code{mapped-devices} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:9216 +msgid "A list of mapped devices. @xref{Mapped Devices}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9217 +#, no-wrap +msgid "file-systems" +msgstr "" + +#. type: table +#: doc/guix.texi:9219 +msgid "A list of file systems. @xref{File Systems}." +msgstr "" + +#. type: item +#: doc/guix.texi:9220 +#, no-wrap +msgid "@code{swap-devices} (default: @code{'()})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9221 +#, no-wrap +msgid "swap devices" +msgstr "" + +#. type: table +#: doc/guix.texi:9228 +msgid "A list of strings identifying devices or files to be used for ``swap space'' (@pxref{Memory Concepts,,, libc, The GNU C Library Reference Manual}). For example, @code{'(\"/dev/sda3\")} or @code{'(\"/swapfile\")}. It is possible to specify a swap file in a file system on a mapped device, provided that the necessary device mapping and file system are also specified. @xref{Mapped Devices} and @ref{File Systems}." +msgstr "" + +#. type: item +#: doc/guix.texi:9229 +#, no-wrap +msgid "@code{users} (default: @code{%base-user-accounts})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:9230 +#, no-wrap +msgid "@code{groups} (default: @var{%base-groups})" +msgstr "" + +#. type: table +#: doc/guix.texi:9232 +msgid "List of user accounts and groups. @xref{User Accounts}." +msgstr "" + +#. type: table +#: doc/guix.texi:9235 +msgid "If the @code{users} list lacks a user account with UID@tie{}0, a ``root'' account with UID@tie{}0 is automatically added." +msgstr "" + +#. type: item +#: doc/guix.texi:9236 +#, no-wrap +msgid "@code{skeletons} (default: @code{(default-skeletons)})" +msgstr "" + +#. type: table +#: doc/guix.texi:9240 +msgid "A list target file name/file-like object tuples (@pxref{G-Expressions, file-like objects}). These are the skeleton files that will be added to the home directory of newly-created user accounts." +msgstr "" + +#. type: table +#: doc/guix.texi:9242 +msgid "For instance, a valid value may look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:9248 +#, no-wrap +msgid "" +"`((\".bashrc\" ,(plain-file \"bashrc\" \"echo Hello\\n\"))\n" +" (\".guile\" ,(plain-file \"guile\"\n" +" \"(use-modules (ice-9 readline))\n" +" (activate-readline)\")))\n" +msgstr "" + +#. type: item +#: doc/guix.texi:9250 +#, no-wrap +msgid "@code{issue} (default: @var{%default-issue})" +msgstr "" + +#. type: table +#: doc/guix.texi:9253 +msgid "A string denoting the contents of the @file{/etc/issue} file, which is displayed when users log in on a text console." +msgstr "" + +#. type: item +#: doc/guix.texi:9254 +#, no-wrap +msgid "@code{packages} (default: @var{%base-packages})" +msgstr "" + +#. type: table +#: doc/guix.texi:9257 +msgid "The set of packages installed in the global profile, which is accessible at @file{/run/current-system/profile}." +msgstr "" + +#. type: table +#: doc/guix.texi:9261 +msgid "The default set includes core utilities and it is good practice to install non-core utilities in user profiles (@pxref{Invoking guix package})." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9262 +#, no-wrap +msgid "timezone" +msgstr "" + +#. type: table +#: doc/guix.texi:9264 +msgid "A timezone identifying string---e.g., @code{\"Europe/Paris\"}." +msgstr "" + +#. type: table +#: doc/guix.texi:9268 +msgid "You can run the @command{tzselect} command to find out which timezone string corresponds to your region. Choosing an invalid timezone name causes @command{guix system} to fail." +msgstr "" + +#. type: item +#: doc/guix.texi:9269 +#, no-wrap +msgid "@code{locale} (default: @code{\"en_US.utf8\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:9272 +msgid "The name of the default locale (@pxref{Locale Names,,, libc, The GNU C Library Reference Manual}). @xref{Locales}, for more information." +msgstr "" + +#. type: item +#: doc/guix.texi:9273 +#, no-wrap +msgid "@code{locale-definitions} (default: @var{%default-locale-definitions})" +msgstr "" + +#. type: table +#: doc/guix.texi:9276 +msgid "The list of locale definitions to be compiled and that may be used at run time. @xref{Locales}." +msgstr "" + +#. type: item +#: doc/guix.texi:9277 +#, no-wrap +msgid "@code{locale-libcs} (default: @code{(list @var{glibc})})" +msgstr "" + +#. type: table +#: doc/guix.texi:9281 +msgid "The list of GNU@tie{}libc packages whose locale data and tools are used to build the locale definitions. @xref{Locales}, for compatibility considerations that justify this option." +msgstr "" + +#. type: item +#: doc/guix.texi:9282 +#, no-wrap +msgid "@code{name-service-switch} (default: @var{%default-nss})" +msgstr "" + +#. type: table +#: doc/guix.texi:9286 +msgid "Configuration of the libc name service switch (NSS)---a @code{<name-service-switch>} object. @xref{Name Service Switch}, for details." +msgstr "" + +#. type: item +#: doc/guix.texi:9287 +#, no-wrap +msgid "@code{services} (default: @var{%base-services})" +msgstr "" + +#. type: table +#: doc/guix.texi:9289 +msgid "A list of service objects denoting system services. @xref{Services}." +msgstr "" + +#. type: item +#: doc/guix.texi:9290 +#, no-wrap +msgid "@code{pam-services} (default: @code{(base-pam-services)})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9291 +#, no-wrap +msgid "PAM" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9292 +#, no-wrap +msgid "pluggable authentication modules" +msgstr "" + +#. type: table +#: doc/guix.texi:9295 +msgid "Linux @dfn{pluggable authentication module} (PAM) services." +msgstr "" + +#. type: item +#: doc/guix.texi:9296 +#, no-wrap +msgid "@code{setuid-programs} (default: @var{%setuid-programs})" +msgstr "" + +#. type: table +#: doc/guix.texi:9299 +msgid "List of string-valued G-expressions denoting setuid programs. @xref{Setuid Programs}." +msgstr "" + +#. type: item +#: doc/guix.texi:9300 +#, no-wrap +msgid "@code{sudoers-file} (default: @var{%sudoers-specification})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9301 +#, no-wrap +msgid "sudoers file" +msgstr "" + +#. type: table +#: doc/guix.texi:9304 +msgid "The contents of the @file{/etc/sudoers} file as a file-like object (@pxref{G-Expressions, @code{local-file} and @code{plain-file}})." +msgstr "" + +#. type: table +#: doc/guix.texi:9309 +msgid "This file specifies which users can use the @command{sudo} command, what they are allowed to do, and what privileges they may gain. The default is that only @code{root} and members of the @code{wheel} group may use @code{sudo}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9320 +msgid "The list of file systems to be mounted is specified in the @code{file-systems} field of the operating system declaration (@pxref{Using the Configuration System}). Each file system is declared using the @code{file-system} form, like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:9326 +#, no-wrap +msgid "" +"(file-system\n" +" (mount-point \"/home\")\n" +" (device \"/dev/sda3\")\n" +" (type \"ext4\"))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9330 +msgid "As usual, some of the fields are mandatory---those shown in the example above---while others can be omitted. These are described below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:9331 +#, no-wrap +msgid "{Data Type} file-system" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9334 +msgid "Objects of this type represent file systems to be mounted. They contain the following members:" +msgstr "" + +#. type: item +#: doc/guix.texi:9336 doc/guix.texi:9522 +#, no-wrap +msgid "type" +msgstr "" + +#. type: table +#: doc/guix.texi:9339 +msgid "This is a string specifying the type of the file system---e.g., @code{\"ext4\"}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9340 +#, no-wrap +msgid "mount-point" +msgstr "" + +#. type: table +#: doc/guix.texi:9342 +msgid "This designates the place where the file system is to be mounted." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9343 +#, no-wrap +msgid "device" +msgstr "" + +#. type: table +#: doc/guix.texi:9353 +msgid "This names the ``source'' of the file system. It can be one of three things: a file system label, a file system UUID, or the name of a @file{/dev} node. Labels and UUIDs offer a way to refer to file systems without having to hard-code their actual device name@footnote{Note that, while it is tempting to use @file{/dev/disk/by-uuid} and similar device names to achieve the same result, this is not recommended: These special device nodes are created by the udev daemon and may be unavailable at the time the device is mounted.}." +msgstr "" + +#. type: findex +#: doc/guix.texi:9354 +#, no-wrap +msgid "file-system-label" +msgstr "" + +#. type: table +#: doc/guix.texi:9359 +msgid "File system labels are created using the @code{file-system-label} procedure, UUIDs are created using @code{uuid}, and @file{/dev} node are plain strings. Here's an example of a file system referred to by its label, as shown by the @command{e2label} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:9365 +#, no-wrap +msgid "" +"(file-system\n" +" (mount-point \"/home\")\n" +" (type \"ext4\")\n" +" (device (file-system-label \"my-home\")))\n" +msgstr "" + +#. type: findex +#: doc/guix.texi:9367 +#, no-wrap +msgid "uuid" +msgstr "" + +#. type: table +#: doc/guix.texi:9375 +msgid "UUIDs are converted from their string representation (as shown by the @command{tune2fs -l} command) using the @code{uuid} form@footnote{The @code{uuid} form expects 16-byte UUIDs as defined in @uref{https://tools.ietf.org/html/rfc4122, RFC@tie{}4122}. This is the form of UUID used by the ext2 family of file systems and others, but it is different from ``UUIDs'' found in FAT file systems, for instance.}, like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:9381 +#, no-wrap +msgid "" +"(file-system\n" +" (mount-point \"/home\")\n" +" (type \"ext4\")\n" +" (device (uuid \"4dab5feb-d176-45de-b287-9b0a6e4c01cb\")))\n" +msgstr "" + +#. type: table +#: doc/guix.texi:9389 +msgid "When the source of a file system is a mapped device (@pxref{Mapped Devices}), its @code{device} field @emph{must} refer to the mapped device name---e.g., @file{\"/dev/mapper/root-partition\"}. This is required so that the system knows that mounting the file system depends on having the corresponding device mapping established." +msgstr "" + +#. type: item +#: doc/guix.texi:9390 +#, no-wrap +msgid "@code{flags} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:9395 +msgid "This is a list of symbols denoting mount flags. Recognized flags include @code{read-only}, @code{bind-mount}, @code{no-dev} (disallow access to special files), @code{no-suid} (ignore setuid and setgid bits), and @code{no-exec} (disallow program execution.)" +msgstr "" + +#. type: item +#: doc/guix.texi:9396 +#, no-wrap +msgid "@code{options} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9398 +msgid "This is either @code{#f}, or a string denoting mount options." +msgstr "" + +#. type: item +#: doc/guix.texi:9399 +#, no-wrap +msgid "@code{mount?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:9404 +msgid "This value indicates whether to automatically mount the file system when the system is brought up. When set to @code{#f}, the file system gets an entry in @file{/etc/fstab} (read by the @command{mount} command) but is not automatically mounted." +msgstr "" + +#. type: item +#: doc/guix.texi:9405 +#, no-wrap +msgid "@code{needed-for-boot?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9410 +msgid "This Boolean value indicates whether the file system is needed when booting. If that is true, then the file system is mounted when the initial RAM disk (initrd) is loaded. This is always the case, for instance, for the root file system." +msgstr "" + +#. type: item +#: doc/guix.texi:9411 +#, no-wrap +msgid "@code{check?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:9414 +msgid "This Boolean indicates whether the file system needs to be checked for errors before being mounted." +msgstr "" + +#. type: item +#: doc/guix.texi:9415 +#, no-wrap +msgid "@code{create-mount-point?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9417 +msgid "When true, the mount point is created if it does not exist yet." +msgstr "" + +#. type: item +#: doc/guix.texi:9418 +#, no-wrap +msgid "@code{dependencies} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:9422 +msgid "This is a list of @code{<file-system>} or @code{<mapped-device>} objects representing file systems that must be mounted or mapped devices that must be opened before (and unmounted or closed after) this one." +msgstr "" + +#. type: table +#: doc/guix.texi:9426 +msgid "As an example, consider a hierarchy of mounts: @file{/sys/fs/cgroup} is a dependency of @file{/sys/fs/cgroup/cpu} and @file{/sys/fs/cgroup/memory}." +msgstr "" + +#. type: table +#: doc/guix.texi:9429 +msgid "Another example is a file system that depends on a mapped device, for example for an encrypted partition (@pxref{Mapped Devices})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9434 +msgid "The @code{(gnu system file-systems)} exports the following useful variables." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9435 +#, no-wrap +msgid "{Scheme Variable} %base-file-systems" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9440 +msgid "These are essential file systems that are required on normal systems, such as @var{%pseudo-terminal-file-system} and @var{%immutable-store} (see below.) Operating system declarations should always contain at least these." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9442 +#, no-wrap +msgid "{Scheme Variable} %pseudo-terminal-file-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9448 +msgid "This is the file system to be mounted as @file{/dev/pts}. It supports @dfn{pseudo-terminals} created @i{via} @code{openpty} and similar functions (@pxref{Pseudo-Terminals,,, libc, The GNU C Library Reference Manual}). Pseudo-terminals are used by terminal emulators such as @command{xterm}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9450 +#, no-wrap +msgid "{Scheme Variable} %shared-memory-file-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9454 +msgid "This file system is mounted as @file{/dev/shm} and is used to support memory sharing across processes (@pxref{Memory-mapped I/O, @code{shm_open},, libc, The GNU C Library Reference Manual})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9456 +#, no-wrap +msgid "{Scheme Variable} %immutable-store" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9461 +msgid "This file system performs a read-only ``bind mount'' of @file{/gnu/store}, making it read-only for all the users including @code{root}. This prevents against accidental modification by software running as @code{root} or by system administrators." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9464 +msgid "The daemon itself is still able to write to the store: it remounts it read-write in its own ``name space.''" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9466 +#, no-wrap +msgid "{Scheme Variable} %binary-format-file-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9470 +msgid "The @code{binfmt_misc} file system, which allows handling of arbitrary executable file types to be delegated to user space. This requires the @code{binfmt.ko} kernel module to be loaded." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9472 +#, no-wrap +msgid "{Scheme Variable} %fuse-control-file-system" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9476 +msgid "The @code{fusectl} file system, which allows unprivileged users to mount and unmount user-space FUSE file systems. This requires the @code{fuse.ko} kernel module to be loaded." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9481 +#, no-wrap +msgid "device mapping" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9482 +#, no-wrap +msgid "mapped devices" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9500 +msgid "The Linux kernel has a notion of @dfn{device mapping}: a block device, such as a hard disk partition, can be @dfn{mapped} into another device, usually in @code{/dev/mapper/}, with additional processing over the data that flows through it@footnote{Note that the GNU@tie{}Hurd makes no difference between the concept of a ``mapped device'' and that of a file system: both boil down to @emph{translating} input/output operations made on a file to operations on its backing store. Thus, the Hurd implements mapped devices, like file systems, using the generic @dfn{translator} mechanism (@pxref{Translators,,, hurd, The GNU Hurd Reference Manual}).}. A typical example is encryption device mapping: all writes to the mapped device are encrypted, and all reads are deciphered, transparently. Guix extends this notion by considering any device or set of devices that are @dfn{transformed} in some way to create a new device; for instance, RAID devices are obtained by @dfn{assembling} several other devices, such as hard disks or partitions, into a new one that behaves as one partition. Other examples, not yet implemented, are LVM logical volumes." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9503 +msgid "Mapped devices are declared using the @code{mapped-device} form, defined as follows; for examples, see below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:9504 +#, no-wrap +msgid "{Data Type} mapped-device" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9507 +msgid "Objects of this type represent device mappings that will be made when the system boots up." +msgstr "" + +#. type: table +#: doc/guix.texi:9513 +msgid "This is either a string specifying the name of the block device to be mapped, such as @code{\"/dev/sda3\"}, or a list of such strings when several devices need to be assembled for creating a new one." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9514 doc/guix.texi:20646 +#, no-wrap +msgid "target" +msgstr "" + +#. type: table +#: doc/guix.texi:9521 +msgid "This string specifies the name of the resulting mapped device. For kernel mappers such as encrypted devices of type @code{luks-device-mapping}, specifying @code{\"my-partition\"} leads to the creation of the @code{\"/dev/mapper/my-partition\"} device. For RAID devices of type @code{raid-device-mapping}, the full device name such as @code{\"/dev/md0\"} needs to be given." +msgstr "" + +#. type: table +#: doc/guix.texi:9525 +msgid "This must be a @code{mapped-device-kind} object, which specifies how @var{source} is mapped to @var{target}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9528 +#, no-wrap +msgid "{Scheme Variable} luks-device-mapping" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9532 +msgid "This defines LUKS block device encryption using the @command{cryptsetup} command from the package with the same name. It relies on the @code{dm-crypt} Linux kernel module." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9534 +#, no-wrap +msgid "{Scheme Variable} raid-device-mapping" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9539 +msgid "This defines a RAID device, which is assembled using the @code{mdadm} command from the package with the same name. It requires a Linux kernel module for the appropriate RAID level to be loaded, such as @code{raid456} for RAID-4, RAID-5 or RAID-6, or @code{raid10} for RAID-10." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9541 +#, no-wrap +msgid "disk encryption" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9542 +#, no-wrap +msgid "LUKS" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9550 +msgid "The following example specifies a mapping from @file{/dev/sda3} to @file{/dev/mapper/home} using LUKS---the @url{https://gitlab.com/cryptsetup/cryptsetup,Linux Unified Key Setup}, a standard mechanism for disk encryption. The @file{/dev/mapper/home} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems})." +msgstr "" + +#. type: example +#: doc/guix.texi:9556 +#, no-wrap +msgid "" +"(mapped-device\n" +" (source \"/dev/sda3\")\n" +" (target \"home\")\n" +" (type luks-device-mapping))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9561 +msgid "Alternatively, to become independent of device numbering, one may obtain the LUKS UUID (@dfn{unique identifier}) of the source device by a command like:" +msgstr "" + +#. type: example +#: doc/guix.texi:9564 +#, no-wrap +msgid "cryptsetup luksUUID /dev/sda3\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9567 +msgid "and use it as follows:" +msgstr "" + +#. type: example +#: doc/guix.texi:9573 +#, no-wrap +msgid "" +"(mapped-device\n" +" (source (uuid \"cb67fc72-0d54-4c88-9d4b-b225f30b0f44\"))\n" +" (target \"home\")\n" +" (type luks-device-mapping))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9575 +#, no-wrap +msgid "swap encryption" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9581 +msgid "It is also desirable to encrypt swap space, since swap space may contain sensitive data. One way to accomplish that is to use a swap file in a file system on a device mapped via LUKS encryption. In this way, the swap file is encrypted because the entire device is encrypted. @xref{Preparing for Installation,,Disk Partitioning}, for an example." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9584 +msgid "A RAID device formed of the partitions @file{/dev/sda1} and @file{/dev/sdb1} may be declared as follows:" +msgstr "" + +#. type: example +#: doc/guix.texi:9590 +#, no-wrap +msgid "" +"(mapped-device\n" +" (source (list \"/dev/sda1\" \"/dev/sdb1\"))\n" +" (target \"/dev/md0\")\n" +" (type raid-device-mapping))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9597 +msgid "The @file{/dev/md0} device can then be used as the @code{device} of a @code{file-system} declaration (@pxref{File Systems}). Note that the RAID level need not be given; it is chosen during the initial creation and formatting of the RAID device and is determined automatically later." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9602 +#, no-wrap +msgid "users" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9603 +#, no-wrap +msgid "accounts" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9604 +#, no-wrap +msgid "user accounts" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9608 +msgid "User accounts and groups are entirely managed through the @code{operating-system} declaration. They are specified with the @code{user-account} and @code{user-group} forms:" +msgstr "" + +#. type: example +#: doc/guix.texi:9619 +#, no-wrap +msgid "" +"(user-account\n" +" (name \"alice\")\n" +" (group \"users\")\n" +" (supplementary-groups '(\"wheel\" ;allow use of sudo, etc.\n" +" \"audio\" ;sound card\n" +" \"video\" ;video devices such as webcams\n" +" \"cdrom\")) ;the good ol' CD-ROM\n" +" (comment \"Bob's sister\")\n" +" (home-directory \"/home/alice\"))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9628 +msgid "When booting or upon completion of @command{guix system reconfigure}, the system ensures that only the user accounts and groups specified in the @code{operating-system} declaration exist, and with the specified properties. Thus, account or group creations or modifications made by directly invoking commands such as @command{useradd} are lost upon reconfiguration or reboot. This ensures that the system remains exactly as declared." +msgstr "" + +#. type: deftp +#: doc/guix.texi:9629 +#, no-wrap +msgid "{Data Type} user-account" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9632 +msgid "Objects of this type represent user accounts. The following members may be specified:" +msgstr "" + +#. type: table +#: doc/guix.texi:9636 +msgid "The name of the user account." +msgstr "" + +#. type: itemx +#: doc/guix.texi:9637 doc/guix.texi:20408 +#, no-wrap +msgid "group" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9638 doc/guix.texi:9687 +#, no-wrap +msgid "groups" +msgstr "" + +#. type: table +#: doc/guix.texi:9641 +msgid "This is the name (a string) or identifier (a number) of the user group this account belongs to." +msgstr "" + +#. type: item +#: doc/guix.texi:9642 +#, no-wrap +msgid "@code{supplementary-groups} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:9645 +msgid "Optionally, this can be defined as a list of group names that this account belongs to." +msgstr "" + +#. type: item +#: doc/guix.texi:9646 +#, no-wrap +msgid "@code{uid} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9650 +msgid "This is the user ID for this account (a number), or @code{#f}. In the latter case, a number is automatically chosen by the system when the account is created." +msgstr "" + +#. type: item +#: doc/guix.texi:9651 +#, no-wrap +msgid "@code{comment} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:9653 +msgid "A comment about the account, such as the account owner's full name." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:9654 +#, no-wrap +msgid "home-directory" +msgstr "" + +#. type: table +#: doc/guix.texi:9656 +msgid "This is the name of the home directory for the account." +msgstr "" + +#. type: item +#: doc/guix.texi:9657 +#, no-wrap +msgid "@code{create-home-directory?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:9660 +msgid "Indicates whether the home directory of this account should be created if it does not exist yet." +msgstr "" + +#. type: item +#: doc/guix.texi:9661 +#, no-wrap +msgid "@code{shell} (default: Bash)" +msgstr "" + +#. type: table +#: doc/guix.texi:9664 +msgid "This is a G-expression denoting the file name of a program to be used as the shell (@pxref{G-Expressions})." +msgstr "" + +#. type: item +#: doc/guix.texi:9665 doc/guix.texi:9705 +#, no-wrap +msgid "@code{system?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9669 +msgid "This Boolean value indicates whether the account is a ``system'' account. System accounts are sometimes treated specially; for instance, graphical login managers do not list them." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:9671 +msgid "user-account-password" +msgstr "" + +#. type: item +#: doc/guix.texi:9671 doc/guix.texi:9709 +#, no-wrap +msgid "@code{password} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9677 +msgid "You would normally leave this field to @code{#f}, initialize user passwords as @code{root} with the @command{passwd} command, and then let users change it with @command{passwd}. Passwords set with @command{passwd} are of course preserved across reboot and reconfiguration." +msgstr "" + +#. type: table +#: doc/guix.texi:9683 +msgid "If you @emph{do} want to have a preset password for an account, then this field must contain the encrypted password, as a string. @xref{crypt,,, libc, The GNU C Library Reference Manual}, for more information on password encryption, and @ref{Encryption,,, guile, GNU Guile Reference Manual}, for information on Guile's @code{crypt} procedure." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9689 +msgid "User group declarations are even simpler:" +msgstr "" + +#. type: example +#: doc/guix.texi:9692 +#, no-wrap +msgid "(user-group (name \"students\"))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9694 +#, no-wrap +msgid "{Data Type} user-group" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9696 +msgid "This type is for, well, user groups. There are just a few fields:" +msgstr "" + +#. type: table +#: doc/guix.texi:9700 +msgid "The name of the group." +msgstr "" + +#. type: item +#: doc/guix.texi:9701 +#, no-wrap +msgid "@code{id} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:9704 +msgid "The group identifier (a number). If @code{#f}, a new number is automatically allocated when the group is created." +msgstr "" + +#. type: table +#: doc/guix.texi:9708 +msgid "This Boolean value indicates whether the group is a ``system'' group. System groups have low numerical IDs." +msgstr "" + +#. type: table +#: doc/guix.texi:9712 +msgid "What, user groups can have a password? Well, apparently yes. Unless @code{#f}, this field specifies the password of the group." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9718 +msgid "For convenience, a variable lists all the basic user groups one may expect:" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9719 +#, no-wrap +msgid "{Scheme Variable} %base-groups" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9724 +msgid "This is the list of basic user groups that users and/or packages expect to be present on the system. This includes groups such as ``root'', ``wheel'', and ``users'', as well as groups used to control access to specific devices such as ``audio'', ``disk'', and ``cdrom''." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9726 +#, no-wrap +msgid "{Scheme Variable} %base-user-accounts" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9729 +msgid "This is the list of basic system accounts that programs may expect to find on a GNU/Linux system, such as the ``nobody'' account." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9732 +msgid "Note that the ``root'' account is not included here. It is a special-case and is automatically added whether or not it is specified." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9737 +#, no-wrap +msgid "locale" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9744 +msgid "A @dfn{locale} defines cultural conventions for a particular language and region of the world (@pxref{Locales,,, libc, The GNU C Library Reference Manual}). Each locale has a name that typically has the form @code{@var{language}_@var{territory}.@var{codeset}}---e.g., @code{fr_LU.utf8} designates the locale for the French language, with cultural conventions from Luxembourg, and using the UTF-8 encoding." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9745 +#, no-wrap +msgid "locale definition" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9749 +msgid "Usually, you will want to specify the default locale for the machine using the @code{locale} field of the @code{operating-system} declaration (@pxref{operating-system Reference, @code{locale}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9758 +msgid "The selected locale is automatically added to the @dfn{locale definitions} known to the system if needed, with its codeset inferred from its name---e.g., @code{bo_CN.utf8} will be assumed to use the @code{UTF-8} codeset. Additional locale definitions can be specified in the @code{locale-definitions} slot of @code{operating-system}---this is useful, for instance, if the codeset could not be inferred from the locale name. The default set of locale definitions includes some widely used locales, but not all the available locales, in order to save space." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9761 +msgid "For instance, to add the North Frisian locale for Germany, the value of that field may be:" +msgstr "" + +#. type: example +#: doc/guix.texi:9766 +#, no-wrap +msgid "" +"(cons (locale-definition\n" +" (name \"fy_DE.utf8\") (source \"fy_DE\"))\n" +" %default-locale-definitions)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9770 +msgid "Likewise, to save space, one might want @code{locale-definitions} to list only the locales that are actually used, as in:" +msgstr "" + +#. type: example +#: doc/guix.texi:9775 +#, no-wrap +msgid "" +"(list (locale-definition\n" +" (name \"ja_JP.eucjp\") (source \"ja_JP\")\n" +" (charset \"EUC-JP\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9784 +msgid "The compiled locale definitions are available at @file{/run/current-system/locale/X.Y}, where @code{X.Y} is the libc version, which is the default location where the GNU@tie{}libc provided by Guix looks for locale data. This can be overridden using the @code{LOCPATH} environment variable (@pxref{locales-and-locpath, @code{LOCPATH} and locale packages})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9787 +msgid "The @code{locale-definition} form is provided by the @code{(gnu system locale)} module. Details are given below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:9788 +#, no-wrap +msgid "{Data Type} locale-definition" +msgstr "" + +#. type: deftp +#: doc/guix.texi:9790 +msgid "This is the data type of a locale definition." +msgstr "" + +#. type: table +#: doc/guix.texi:9796 +msgid "The name of the locale. @xref{Locale Names,,, libc, The GNU C Library Reference Manual}, for more information on locale names." +msgstr "" + +#. type: table +#: doc/guix.texi:9800 +msgid "The name of the source for that locale. This is typically the @code{@var{language}_@var{territory}} part of the locale name." +msgstr "" + +#. type: item +#: doc/guix.texi:9801 +#, no-wrap +msgid "@code{charset} (default: @code{\"UTF-8\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:9805 +msgid "The ``character set'' or ``code set'' for that locale, @uref{http://www.iana.org/assignments/character-sets, as defined by IANA}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9809 +#, no-wrap +msgid "{Scheme Variable} %default-locale-definitions" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9813 +msgid "A list of commonly used UTF-8 locales, used as the default value of the @code{locale-definitions} field of @code{operating-system} declarations." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9814 +#, no-wrap +msgid "locale name" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9815 +#, no-wrap +msgid "normalized codeset in locale names" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9821 +msgid "These locale definitions use the @dfn{normalized codeset} for the part that follows the dot in the name (@pxref{Using gettextized software, normalized codeset,, libc, The GNU C Library Reference Manual}). So for instance it has @code{uk_UA.utf8} but @emph{not}, say, @code{uk_UA.UTF-8}." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:9823 +#, no-wrap +msgid "Locale Data Compatibility Considerations" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9825 +#, no-wrap +msgid "incompatibility, of locale data" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9832 +msgid "@code{operating-system} declarations provide a @code{locale-libcs} field to specify the GNU@tie{}libc packages that are used to compile locale declarations (@pxref{operating-system Reference}). ``Why would I care?'', you may ask. Well, it turns out that the binary format of locale data is occasionally incompatible from one libc version to another." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9844 +msgid "For instance, a program linked against libc version 2.21 is unable to read locale data produced with libc 2.22; worse, that program @emph{aborts} instead of simply ignoring the incompatible locale data@footnote{Versions 2.23 and later of GNU@tie{}libc will simply skip the incompatible locale data, which is already an improvement.}. Similarly, a program linked against libc 2.22 can read most, but not all, of the locale data from libc 2.21 (specifically, @code{LC_COLLATE} data is incompatible); thus calls to @code{setlocale} may fail, but programs will not abort." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9849 +msgid "The ``problem'' in GuixSD is that users have a lot of freedom: They can choose whether and when to upgrade software in their profiles, and might be using a libc version different from the one the system administrator used to build the system-wide locale data." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9853 +msgid "Fortunately, unprivileged users can also install their own locale data and define @var{GUIX_LOCPATH} accordingly (@pxref{locales-and-locpath, @code{GUIX_LOCPATH} and locale packages})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9860 +msgid "Still, it is best if the system-wide locale data at @file{/run/current-system/locale} is built for all the libc versions actually in use on the system, so that all the programs can access it---this is especially crucial on a multi-user system. To do that, the administrator can specify several libc packages in the @code{locale-libcs} field of @code{operating-system}:" +msgstr "" + +#. type: example +#: doc/guix.texi:9863 +#, no-wrap +msgid "" +"(use-package-modules base)\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:9867 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (locale-libcs (list glibc-2.21 (canonical-package glibc))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9872 +msgid "This example would lead to a system containing locale definitions for both libc 2.21 and the current version of libc in @file{/run/current-system/locale}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:9877 +#, no-wrap +msgid "system services" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9883 +msgid "An important part of preparing an @code{operating-system} declaration is listing @dfn{system services} and their configuration (@pxref{Using the Configuration System}). System services are typically daemons launched when the system boots, or other actions needed at that time---e.g., configuring network access." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9890 +msgid "GuixSD has a broad definition of ``service'' (@pxref{Service Composition}), but many services are managed by the GNU@tie{}Shepherd (@pxref{Shepherd Services}). On a running system, the @command{herd} command allows you to list the available services, show their status, start and stop them, or do other specific operations (@pxref{Jump Start,,, shepherd, The GNU Shepherd Manual}). For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:9893 +#, no-wrap +msgid "# herd status\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9898 +msgid "The above command, run as @code{root}, lists the currently defined services. The @command{herd doc} command shows a synopsis of the given service:" +msgstr "" + +#. type: example +#: doc/guix.texi:9902 +#, no-wrap +msgid "" +"# herd doc nscd\n" +"Run libc's name service cache daemon (nscd).\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9907 +msgid "The @command{start}, @command{stop}, and @command{restart} sub-commands have the effect you would expect. For instance, the commands below stop the nscd service and restart the Xorg display server:" +msgstr "" + +#. type: example +#: doc/guix.texi:9914 +#, no-wrap +msgid "" +"# herd stop nscd\n" +"Service nscd has been stopped.\n" +"# herd restart xorg-server\n" +"Service xorg-server has been stopped.\n" +"Service xorg-server has been started.\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9919 +msgid "The following sections document the available services, starting with the core services, that may be used in an @code{operating-system} declaration." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:9955 +msgid "The @code{(gnu services base)} module provides definitions for the basic services that one expects from the system. The services exported by this module are listed below." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9956 +#, no-wrap +msgid "{Scheme Variable} %base-services" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9962 +msgid "This variable contains a list of basic services (@pxref{Service Types and Services}, for more information on service objects) one would expect from the system: a login service (mingetty) on each tty, syslogd, the libc name service cache daemon (nscd), the udev device manager, and more." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9967 +msgid "This is the default value of the @code{services} field of @code{operating-system} declarations. Usually, when customizing a system, you will want to append services to @var{%base-services}, like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:9970 +#, no-wrap +msgid "(cons* (avahi-service) (lsh-service) %base-services)\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9973 +#, no-wrap +msgid "{Scheme Variable} special-files-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9976 +msgid "This is the service that sets up ``special files'' such as @file{/bin/sh}; an instance of it is part of @code{%base-services}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:9980 +msgid "The value associated with @code{special-files-service-type} services must be a list of tuples where the first element is the ``special file'' and the second element is its target. By default it is:" +msgstr "" + +#. type: file{#1} +#: doc/guix.texi:9981 +#, no-wrap +msgid "/bin/sh" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9982 +#, no-wrap +msgid "@file{sh}, in @file{/bin}" +msgstr "" + +#. type: example +#: doc/guix.texi:9985 +#, no-wrap +msgid "`((\"/bin/sh\" ,(file-append @var{bash} \"/bin/sh\")))\n" +msgstr "" + +#. type: file{#1} +#: doc/guix.texi:9987 +#, no-wrap +msgid "/usr/bin/env" +msgstr "" + +#. type: cindex +#: doc/guix.texi:9988 +#, no-wrap +msgid "@file{env}, in @file{/usr/bin}" +msgstr "" + +#. type: defvr +#: doc/guix.texi:9991 +msgid "If you want to add, say, @code{/usr/bin/env} to your system, you can change it to:" +msgstr "" + +#. type: example +#: doc/guix.texi:9995 +#, no-wrap +msgid "" +"`((\"/bin/sh\" ,(file-append @var{bash} \"/bin/sh\"))\n" +" (\"/usr/bin/env\" ,(file-append @var{coreutils} \"/bin/env\")))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10002 +msgid "Since this is part of @code{%base-services}, you can use @code{modify-services} to customize the set of special files (@pxref{Service Reference, @code{modify-services}}). But the simple way to add a special file is @i{via} the @code{extra-special-file} procedure (see below.)" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10004 +#, no-wrap +msgid "{Scheme Procedure} extra-special-file @var{file} @var{target}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10006 +msgid "Use @var{target} as the ``special file'' @var{file}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10010 +msgid "For example, adding the following lines to the @code{services} field of your operating system declaration leads to a @file{/usr/bin/env} symlink:" +msgstr "" + +#. type: example +#: doc/guix.texi:10014 +#, no-wrap +msgid "" +"(extra-special-file \"/usr/bin/env\"\n" +" (file-append coreutils \"/bin/env\"))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10017 +#, no-wrap +msgid "{Scheme Procedure} host-name-service @var{name}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10019 +msgid "Return a service that sets the host name to @var{name}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10021 +#, no-wrap +msgid "{Scheme Procedure} login-service @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10025 +msgid "Return a service to run login according to @var{config}, a @code{<login-configuration>} object, which specifies the message of the day, among other things." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10027 +#, no-wrap +msgid "{Data Type} login-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10029 +msgid "This is the data type representing the configuration of login." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10032 +#, no-wrap +msgid "motd" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10033 +#, no-wrap +msgid "message of the day" +msgstr "" + +#. type: table +#: doc/guix.texi:10035 +msgid "A file-like object containing the ``message of the day''." +msgstr "" + +#. type: item +#: doc/guix.texi:10036 doc/guix.texi:11736 +#, no-wrap +msgid "@code{allow-empty-passwords?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10039 +msgid "Allow empty passwords by default so that first-time users can log in when the 'root' account has just been created." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10043 +#, no-wrap +msgid "{Scheme Procedure} mingetty-service @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10047 +msgid "Return a service to run mingetty according to @var{config}, a @code{<mingetty-configuration>} object, which specifies the tty to run, among other things." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10049 +#, no-wrap +msgid "{Data Type} mingetty-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10052 +msgid "This is the data type representing the configuration of Mingetty, which provides the default implementation of virtual console log-in." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10055 doc/guix.texi:10091 +#, no-wrap +msgid "tty" +msgstr "" + +#. type: table +#: doc/guix.texi:10057 +msgid "The name of the console this Mingetty runs on---e.g., @code{\"tty1\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:10058 doc/guix.texi:10120 +#, no-wrap +msgid "@code{auto-login} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10062 +msgid "When true, this field must be a string denoting the user name under which the system automatically logs in. When it is @code{#f}, a user name and password must be entered to log in." +msgstr "" + +#. type: item +#: doc/guix.texi:10063 +#, no-wrap +msgid "@code{login-program} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10067 +msgid "This must be either @code{#f}, in which case the default log-in program is used (@command{login} from the Shadow tool suite), or a gexp denoting the name of the log-in program." +msgstr "" + +#. type: item +#: doc/guix.texi:10068 +#, no-wrap +msgid "@code{login-pause?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10071 +msgid "When set to @code{#t} in conjunction with @var{auto-login}, the user will have to press a key before the log-in shell is launched." +msgstr "" + +#. type: item +#: doc/guix.texi:10072 +#, no-wrap +msgid "@code{mingetty} (default: @var{mingetty})" +msgstr "" + +#. type: table +#: doc/guix.texi:10074 +msgid "The Mingetty package to use." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10078 +#, no-wrap +msgid "{Scheme Procedure} agetty-service @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10082 +msgid "Return a service to run agetty according to @var{config}, an @code{<agetty-configuration>} object, which specifies the tty to run, among other things." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10084 +#, no-wrap +msgid "{Data Type} agetty-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10088 +msgid "This is the data type representing the configuration of agetty, which implements virtual and serial console log-in. See the @code{agetty(8)} man page for more information." +msgstr "" + +#. type: table +#: doc/guix.texi:10095 +msgid "The name of the console this agetty runs on, as a string---e.g., @code{\"ttyS0\"}. This argument is optional, it will default to a reasonable default serial port used by the kernel Linux." +msgstr "" + +#. type: table +#: doc/guix.texi:10099 +msgid "For this, if there is a value for an option @code{agetty.tty} in the kernel command line, agetty will extract the device name of the serial port from it and use that." +msgstr "" + +#. type: table +#: doc/guix.texi:10103 +msgid "If not and if there is a value for an option @code{console} with a tty in the Linux command line, agetty will extract the device name of the serial port from it and use that." +msgstr "" + +#. type: table +#: doc/guix.texi:10107 +msgid "In both cases, agetty will leave the other serial device settings (baud rate etc.) alone---in the hope that Linux pinned them to the correct values." +msgstr "" + +#. type: item +#: doc/guix.texi:10108 +#, no-wrap +msgid "@code{baud-rate} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10111 +msgid "A string containing a comma-separated list of one or more baud rates, in descending order." +msgstr "" + +#. type: item +#: doc/guix.texi:10112 +#, no-wrap +msgid "@code{term} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10115 +msgid "A string containing the value used for the @code{TERM} environment variable." +msgstr "" + +#. type: item +#: doc/guix.texi:10116 +#, no-wrap +msgid "@code{eight-bits?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10119 +msgid "When @code{#t}, the tty is assumed to be 8-bit clean, and parity detection is disabled." +msgstr "" + +#. type: table +#: doc/guix.texi:10123 +msgid "When passed a login name, as a string, the specified user will be logged in automatically without prompting for their login name or password." +msgstr "" + +#. type: item +#: doc/guix.texi:10124 +#, no-wrap +msgid "@code{no-reset?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10126 +msgid "When @code{#t}, don't reset terminal cflags (control modes)." +msgstr "" + +#. type: item +#: doc/guix.texi:10127 +#, no-wrap +msgid "@code{host} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10130 +msgid "This accepts a string containing the \"login_host\", which will be written into the @file{/var/run/utmpx} file." +msgstr "" + +#. type: item +#: doc/guix.texi:10131 +#, no-wrap +msgid "@code{remote?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10135 +msgid "When set to @code{#t} in conjunction with @var{host}, this will add an @code{-r} fakehost option to the command line of the login program specified in @var{login-program}." +msgstr "" + +#. type: item +#: doc/guix.texi:10136 +#, no-wrap +msgid "@code{flow-control?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10138 +msgid "When set to @code{#t}, enable hardware (RTS/CTS) flow control." +msgstr "" + +#. type: item +#: doc/guix.texi:10139 +#, no-wrap +msgid "@code{no-issue?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10142 +msgid "When set to @code{#t}, the contents of the @file{/etc/issue} file will not be displayed before presenting the login prompt." +msgstr "" + +#. type: item +#: doc/guix.texi:10143 +#, no-wrap +msgid "@code{init-string} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10146 +msgid "This accepts a string that will be sent to the tty or modem before sending anything else. It can be used to initialize a modem." +msgstr "" + +#. type: item +#: doc/guix.texi:10147 +#, no-wrap +msgid "@code{no-clear?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10150 +msgid "When set to @code{#t}, agetty will not clear the screen before showing the login prompt." +msgstr "" + +#. type: item +#: doc/guix.texi:10151 +#, no-wrap +msgid "@code{login-program} (default: (file-append shadow \"/bin/login\"))" +msgstr "" + +#. type: table +#: doc/guix.texi:10155 +msgid "This must be either a gexp denoting the name of a log-in program, or unset, in which case the default value is the @command{login} from the Shadow tool suite." +msgstr "" + +#. type: item +#: doc/guix.texi:10156 +#, no-wrap +msgid "@code{local-line} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10160 +msgid "Control the CLOCAL line flag. This accepts one of three symbols as arguments, @code{'auto}, @code{'always}, or @code{'never}. If @code{#f}, the default value chosen by agetty is @code{'auto}." +msgstr "" + +#. type: item +#: doc/guix.texi:10161 +#, no-wrap +msgid "@code{extract-baud?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10164 +msgid "When set to @code{#t}, instruct agetty to try to extract the baud rate from the status messages produced by certain types of modems." +msgstr "" + +#. type: item +#: doc/guix.texi:10165 +#, no-wrap +msgid "@code{skip-login?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10169 +msgid "When set to @code{#t}, do not prompt the user for a login name. This can be used with @var{login-program} field to use non-standard login systems." +msgstr "" + +#. type: item +#: doc/guix.texi:10170 +#, no-wrap +msgid "@code{no-newline?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10173 +msgid "When set to @code{#t}, do not print a newline before printing the @file{/etc/issue} file." +msgstr "" + +#. type: item +#: doc/guix.texi:10175 +#, no-wrap +msgid "@code{login-options} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10180 +msgid "This option accepts a string containing options that are passed to the login program. When used with the @var{login-program}, be aware that a malicious user could try to enter a login name containing embedded options that could be parsed by the login program." +msgstr "" + +#. type: item +#: doc/guix.texi:10181 +#, no-wrap +msgid "@code{login-pause} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10185 +msgid "When set to @code{#t}, wait for any key before showing the login prompt. This can be used in conjunction with @var{auto-login} to save memory by lazily spawning shells." +msgstr "" + +#. type: item +#: doc/guix.texi:10186 +#, no-wrap +msgid "@code{chroot} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10189 +msgid "Change root to the specified directory. This option accepts a directory path as a string." +msgstr "" + +#. type: item +#: doc/guix.texi:10190 +#, no-wrap +msgid "@code{hangup?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10193 +msgid "Use the Linux system call @code{vhangup} to do a virtual hangup of the specified terminal." +msgstr "" + +#. type: item +#: doc/guix.texi:10194 +#, no-wrap +msgid "@code{keep-baud?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10198 +msgid "When set to @code{#t}, try to keep the existing baud rate. The baud rates from @var{baud-rate} are used when agetty receives a @key{BREAK} character." +msgstr "" + +#. type: item +#: doc/guix.texi:10199 +#, no-wrap +msgid "@code{timeout} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10202 +msgid "When set to an integer value, terminate if no user name could be read within @var{timeout} seconds." +msgstr "" + +#. type: item +#: doc/guix.texi:10203 +#, no-wrap +msgid "@code{detect-case?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10209 +msgid "When set to @code{#t}, turn on support for detecting an uppercase-only terminal. This setting will detect a login name containing only uppercase letters as indicating an uppercase-only terminal and turn on some upper-to-lower case conversions. Note that this will not support Unicode characters." +msgstr "" + +#. type: item +#: doc/guix.texi:10210 +#, no-wrap +msgid "@code{wait-cr?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10215 +msgid "When set to @code{#t}, wait for the user or modem to send a carriage-return or linefeed character before displaying @file{/etc/issue} or login prompt. This is typically used with the @var{init-string} option." +msgstr "" + +#. type: item +#: doc/guix.texi:10216 +#, no-wrap +msgid "@code{no-hints?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10219 +msgid "When set to @code{#t}, do not print hints about Num, Caps, and Scroll locks." +msgstr "" + +#. type: item +#: doc/guix.texi:10220 +#, no-wrap +msgid "@code{no-hostname?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10223 +msgid "By default, the hostname is printed. When this option is set to @code{#t}, no hostname will be shown at all." +msgstr "" + +#. type: item +#: doc/guix.texi:10224 +#, no-wrap +msgid "@code{long-hostname?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10228 +msgid "By default, the hostname is only printed until the first dot. When this option is set to @code{#t}, the fully qualified hostname by @code{gethostname} or @code{getaddrinfo} is shown." +msgstr "" + +#. type: item +#: doc/guix.texi:10229 +#, no-wrap +msgid "@code{erase-characters} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10232 +msgid "This option accepts a string of additional characters that should be interpreted as backspace when the user types their login name." +msgstr "" + +#. type: item +#: doc/guix.texi:10233 +#, no-wrap +msgid "@code{kill-characters} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10237 +msgid "This option accepts a string that should be interpreted to mean \"ignore all previous characters\" (also called a \"kill\" character) when the types their login name." +msgstr "" + +#. type: item +#: doc/guix.texi:10238 +#, no-wrap +msgid "@code{chdir} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10241 +msgid "This option accepts, as a string, a directory path that will be changed to before login." +msgstr "" + +#. type: item +#: doc/guix.texi:10242 +#, no-wrap +msgid "@code{delay} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10245 +msgid "This options accepts, as an integer, the number of seconds to sleep before opening the tty and displaying the login prompt." +msgstr "" + +#. type: item +#: doc/guix.texi:10246 +#, no-wrap +msgid "@code{nice} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10249 +msgid "This option accepts, as an integer, the nice value with which to run the @command{login} program." +msgstr "" + +#. type: item +#: doc/guix.texi:10250 doc/guix.texi:10450 +#, no-wrap +msgid "@code{extra-options} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:10253 +msgid "This option provides an \"escape hatch\" for the user to provide arbitrary command-line arguments to @command{agetty} as a list of strings." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10257 +#, no-wrap +msgid "{Scheme Procedure} kmscon-service-type @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10261 +msgid "Return a service to run @uref{https://www.freedesktop.org/wiki/Software/kmscon,kmscon} according to @var{config}, a @code{<kmscon-configuration>} object, which specifies the tty to run, among other things." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10263 +#, no-wrap +msgid "{Data Type} kmscon-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10266 +msgid "This is the data type representing the configuration of Kmscon, which implements virtual console log-in." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10269 +#, no-wrap +msgid "virtual-terminal" +msgstr "" + +#. type: table +#: doc/guix.texi:10271 +msgid "The name of the console this Kmscon runs on---e.g., @code{\"tty1\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:10272 +#, no-wrap +msgid "@code{login-program} (default: @code{#~(string-append #$shadow \"/bin/login\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:10275 +msgid "A gexp denoting the name of the log-in program. The default log-in program is @command{login} from the Shadow tool suite." +msgstr "" + +#. type: item +#: doc/guix.texi:10276 +#, no-wrap +msgid "@code{login-arguments} (default: @code{'(\"-p\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:10278 +msgid "A list of arguments to pass to @command{login}." +msgstr "" + +#. type: item +#: doc/guix.texi:10279 +#, no-wrap +msgid "@code{hardware-acceleration?} (default: #f)" +msgstr "" + +#. type: table +#: doc/guix.texi:10281 +msgid "Whether to use hardware acceleration." +msgstr "" + +#. type: item +#: doc/guix.texi:10282 +#, no-wrap +msgid "@code{kmscon} (default: @var{kmscon})" +msgstr "" + +#. type: table +#: doc/guix.texi:10284 +msgid "The Kmscon package to use." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10288 +#, no-wrap +msgid "name service cache daemon" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10289 +#, no-wrap +msgid "nscd" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10290 +#, no-wrap +msgid "{Scheme Procedure} nscd-service [@var{config}] [#:glibc glibc] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10295 +msgid "[#:name-services '()] Return a service that runs the libc name service cache daemon (nscd) with the given @var{config}---an @code{<nscd-configuration>} object. @xref{Name Service Switch}, for an example." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10297 +#, no-wrap +msgid "{Scheme Variable} %nscd-default-configuration" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10301 +msgid "This is the default @code{<nscd-configuration>} value (see below) used by @code{nscd-service}. It uses the caches defined by @var{%nscd-default-caches}; see below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10303 +#, no-wrap +msgid "{Data Type} nscd-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10306 +msgid "This is the data type representing the name service cache daemon (nscd) configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:10309 +#, no-wrap +msgid "@code{name-services} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:10312 +msgid "List of packages denoting @dfn{name services} that must be visible to the nscd---e.g., @code{(list @var{nss-mdns})}." +msgstr "" + +#. type: item +#: doc/guix.texi:10313 +#, no-wrap +msgid "@code{glibc} (default: @var{glibc})" +msgstr "" + +#. type: table +#: doc/guix.texi:10316 +msgid "Package object denoting the GNU C Library providing the @command{nscd} command." +msgstr "" + +#. type: item +#: doc/guix.texi:10317 +#, no-wrap +msgid "@code{log-file} (default: @code{\"/var/log/nscd.log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10320 +msgid "Name of the nscd log file. This is where debugging output goes when @code{debug-level} is strictly positive." +msgstr "" + +#. type: item +#: doc/guix.texi:10321 +#, no-wrap +msgid "@code{debug-level} (default: @code{0})" +msgstr "" + +#. type: table +#: doc/guix.texi:10324 +msgid "Integer denoting the debugging levels. Higher numbers mean that more debugging output is logged." +msgstr "" + +#. type: item +#: doc/guix.texi:10325 +#, no-wrap +msgid "@code{caches} (default: @var{%nscd-default-caches})" +msgstr "" + +#. type: table +#: doc/guix.texi:10328 +msgid "List of @code{<nscd-cache>} objects denoting things to be cached; see below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10332 +#, no-wrap +msgid "{Data Type} nscd-cache" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10334 +msgid "Data type representing a cache database of nscd and its parameters." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10337 doc/guix.texi:13172 +#, no-wrap +msgid "database" +msgstr "" + +#. type: table +#: doc/guix.texi:10342 +msgid "This is a symbol representing the name of the database to be cached. Valid values are @code{passwd}, @code{group}, @code{hosts}, and @code{services}, which designate the corresponding NSS database (@pxref{NSS Basics,,, libc, The GNU C Library Reference Manual})." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10343 +#, no-wrap +msgid "positive-time-to-live" +msgstr "" + +#. type: itemx +#: doc/guix.texi:10344 +#, no-wrap +msgid "@code{negative-time-to-live} (default: @code{20})" +msgstr "" + +#. type: table +#: doc/guix.texi:10347 +msgid "A number representing the number of seconds during which a positive or negative lookup result remains in cache." +msgstr "" + +#. type: item +#: doc/guix.texi:10348 +#, no-wrap +msgid "@code{check-files?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10351 +msgid "Whether to check for updates of the files corresponding to @var{database}." +msgstr "" + +#. type: table +#: doc/guix.texi:10355 +msgid "For instance, when @var{database} is @code{hosts}, setting this flag instructs nscd to check for updates in @file{/etc/hosts} and to take them into account." +msgstr "" + +#. type: item +#: doc/guix.texi:10356 +#, no-wrap +msgid "@code{persistent?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10358 +msgid "Whether the cache should be stored persistently on disk." +msgstr "" + +#. type: item +#: doc/guix.texi:10359 +#, no-wrap +msgid "@code{shared?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10361 +msgid "Whether the cache should be shared among users." +msgstr "" + +#. type: item +#: doc/guix.texi:10362 +#, no-wrap +msgid "@code{max-database-size} (default: 32@tie{}MiB)" +msgstr "" + +#. type: table +#: doc/guix.texi:10364 +msgid "Maximum size in bytes of the database cache." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10371 +#, no-wrap +msgid "{Scheme Variable} %nscd-default-caches" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10374 +msgid "List of @code{<nscd-cache>} objects used by default by @code{nscd-configuration} (see above)." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10380 +msgid "It enables persistent and aggressive caching of service and host name lookups. The latter provides better host name lookup performance, resilience in the face of unreliable name servers, and also better privacy---often the result of host name lookups is in local cache, so external name servers do not even need to be queried." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10383 +msgid "syslog-configuration-type" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10383 doc/guix.texi:10399 +#, no-wrap +msgid "syslog" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10384 doc/guix.texi:10833 +#, no-wrap +msgid "logging" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10385 +#, no-wrap +msgid "{Data Type} syslog-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10387 +msgid "This data type represents the configuration of the syslog daemon." +msgstr "" + +#. type: item +#: doc/guix.texi:10389 +#, no-wrap +msgid "@code{syslogd} (default: @code{#~(string-append #$inetutils \"/libexec/syslogd\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:10391 +msgid "The syslog daemon to use." +msgstr "" + +#. type: item +#: doc/guix.texi:10392 +#, no-wrap +msgid "@code{config-file} (default: @code{%default-syslog.conf})" +msgstr "" + +#. type: table +#: doc/guix.texi:10394 +msgid "The syslog configuration file to use." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10399 +msgid "syslog-service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10400 +#, no-wrap +msgid "{Scheme Procedure} syslog-service @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10402 +msgid "Return a service that runs a syslog daemon according to @var{config}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10405 +msgid "@xref{syslogd invocation,,, inetutils, GNU Inetutils}, for more information on the configuration file syntax." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10408 +msgid "guix-configuration-type" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10408 +#, no-wrap +msgid "{Data Type} guix-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10411 +msgid "This data type represents the configuration of the Guix build daemon. @xref{Invoking guix-daemon}, for more information." +msgstr "" + +#. type: item +#: doc/guix.texi:10413 +#, no-wrap +msgid "@code{guix} (default: @var{guix})" +msgstr "" + +#. type: table +#: doc/guix.texi:10415 doc/guix.texi:10659 +msgid "The Guix package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:10416 +#, no-wrap +msgid "@code{build-group} (default: @code{\"guixbuild\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10418 +msgid "Name of the group for build user accounts." +msgstr "" + +#. type: item +#: doc/guix.texi:10419 +#, no-wrap +msgid "@code{build-accounts} (default: @code{10})" +msgstr "" + +#. type: table +#: doc/guix.texi:10421 +msgid "Number of build user accounts to create." +msgstr "" + +#. type: item +#: doc/guix.texi:10422 +#, no-wrap +msgid "@code{authorize-key?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10427 +msgid "Whether to authorize the substitute keys listed in @code{authorized-keys}---by default that of @code{hydra.gnu.org} (@pxref{Substitutes})." +msgstr "" + +#. type: vindex +#: doc/guix.texi:10428 +#, no-wrap +msgid "%default-authorized-guix-keys" +msgstr "" + +#. type: item +#: doc/guix.texi:10429 +#, no-wrap +msgid "@code{authorized-keys} (default: @var{%default-authorized-guix-keys})" +msgstr "" + +#. type: table +#: doc/guix.texi:10433 +msgid "The list of authorized key files for archive imports, as a list of string-valued gexps (@pxref{Invoking guix archive}). By default, it contains that of @code{hydra.gnu.org} (@pxref{Substitutes})." +msgstr "" + +#. type: item +#: doc/guix.texi:10434 +#, no-wrap +msgid "@code{use-substitutes?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:10436 +msgid "Whether to use substitutes." +msgstr "" + +#. type: item +#: doc/guix.texi:10437 +#, no-wrap +msgid "@code{substitute-urls} (default: @var{%default-substitute-urls})" +msgstr "" + +#. type: table +#: doc/guix.texi:10439 +msgid "The list of URLs where to look for substitutes by default." +msgstr "" + +#. type: item +#: doc/guix.texi:10440 +#, no-wrap +msgid "@code{max-silent-time} (default: @code{0})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:10441 +#, no-wrap +msgid "@code{timeout} (default: @code{0})" +msgstr "" + +#. type: table +#: doc/guix.texi:10445 +msgid "The number of seconds of silence and the number of seconds of activity, respectively, after which a build process times out. A value of zero disables the timeout." +msgstr "" + +#. type: item +#: doc/guix.texi:10446 +#, no-wrap +msgid "@code{log-compression} (default: @code{'bzip2})" +msgstr "" + +#. type: table +#: doc/guix.texi:10449 +msgid "The type of compression used for build logs---one of @code{gzip}, @code{bzip2}, or @code{none}." +msgstr "" + +#. type: table +#: doc/guix.texi:10452 +msgid "List of extra command-line options for @command{guix-daemon}." +msgstr "" + +#. type: item +#: doc/guix.texi:10453 +#, no-wrap +msgid "@code{log-file} (default: @code{\"/var/log/guix-daemon.log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10456 +msgid "File where @command{guix-daemon}'s standard output and standard error are written." +msgstr "" + +#. type: item +#: doc/guix.texi:10457 +#, no-wrap +msgid "@code{http-proxy} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10460 +msgid "The HTTP proxy used for downloading fixed-output derivations and substitutes." +msgstr "" + +#. type: item +#: doc/guix.texi:10461 +#, no-wrap +msgid "@code{tmpdir} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10463 +msgid "A directory path where the @command{guix-daemon} will perform builds." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10467 +#, no-wrap +msgid "{Scheme Procedure} guix-service @var{config}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10470 +msgid "Return a service that runs the Guix build daemon according to @var{config}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10472 +#, no-wrap +msgid "{Scheme Procedure} udev-service [#:udev @var{eudev} #:rules @code{'()}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10477 +msgid "Run @var{udev}, which populates the @file{/dev} directory dynamically. udev rules can be provided as a list of files through the @var{rules} variable. The procedures @var{udev-rule} and @var{file->udev-rule} from @code{(gnu services base)} simplify the creation of such rule files." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10478 +#, no-wrap +msgid "{Scheme Procedure} udev-rule [@var{file-name} @var{contents}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10481 +msgid "Return a udev-rule file named @var{file-name} containing the rules defined by the @var{contents} literal." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10485 +msgid "In the following example, a rule for a USB device is defined to be stored in the file @file{90-usb-thing.rules}. The rule runs a script upon detecting a USB device with a given product identifier." +msgstr "" + +#. type: example +#: doc/guix.texi:10493 +#, no-wrap +msgid "" +"(define %example-udev-rule\n" +" (udev-rule\n" +" \"90-usb-thing.rules\"\n" +" (string-append \"ACTION==\\\"add\\\", SUBSYSTEM==\\\"usb\\\", \"\n" +" \"ATTR@{product@}==\\\"Example\\\", \"\n" +" \"RUN+=\\\"/path/to/script\\\"\")))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10497 +msgid "Here we show how the default @var{udev-service} can be extended with it." +msgstr "" + +#. type: example +#: doc/guix.texi:10507 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (services\n" +" (modify-services %desktop-services\n" +" (udev-service-type config =>\n" +" (udev-configuration (inherit config)\n" +" (rules (append (udev-configuration-rules config)\n" +" (list %example-udev-rule))))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10509 +#, no-wrap +msgid "{Scheme Procedure} file->udev-rule [@var{file-name} @var{file}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10512 +msgid "Return a udev file named @var{file-name} containing the rules defined within @var{file}, a file-like object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10514 +msgid "The following example showcases how we can use an existing rule file." +msgstr "" + +#. type: example +#: doc/guix.texi:10519 +#, no-wrap +msgid "" +"(use-modules (guix download) ;for url-fetch\n" +" (guix packages) ;for origin\n" +" ;; @dots{})\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:10530 +#, no-wrap +msgid "" +"(define %android-udev-rules\n" +" (file->udev-rule\n" +" \"51-android-udev.rules\"\n" +" (let ((version \"20170910\"))\n" +" (origin\n" +" (method url-fetch)\n" +" (uri (string-append \"https://raw.githubusercontent.com/M0Rf30/\"\n" +" \"android-udev-rules/\" version \"/51-android.rules\"))\n" +" (sha256\n" +" (base32 \"0lmmagpyb6xsq6zcr2w1cyx9qmjqmajkvrdbhjx32gqf1d9is003\"))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10539 +msgid "Additionally, Guix package definitions can be included in @var{rules} in order to extend the udev rules with the definitions found under their @file{lib/udev/rules.d} sub-directory. In lieu of the previous @var{file->udev-rule} example, we could have used the @var{android-udev-rules} package which exists in Guix in the @code{(gnu packages android)} module." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10548 +msgid "The following example shows how to use the @var{android-udev-rules} package so that the Android tool @command{adb} can detect devices without root privileges. It also details how to create the @code{adbusers} group, which is required for the proper functioning of the rules defined within the @var{android-udev-rules} package. To create such a group, we must define it both as part of the @var{supplementary-groups} of our @var{user-account} declaration, as well as in the @var{groups} field of the @var{operating-system} record." +msgstr "" + +#. type: example +#: doc/guix.texi:10553 +#, no-wrap +msgid "" +"(use-modules (gnu packages android) ;for android-udev-rules\n" +" (gnu system shadow) ;for user-group\n" +" ;; @dots{})\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:10562 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (users (cons (user-acount\n" +" ;; @dots{}\n" +" (supplementary-groups\n" +" '(\"adbusers\" ;for adb\n" +" \"wheel\" \"netdev\" \"audio\" \"video\"))\n" +" ;; @dots{})))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:10565 +#, no-wrap +msgid "" +" (groups (cons (user-group (system? #t) (name \"adbusers\"))\n" +" %base-groups))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:10567 +#, no-wrap +msgid "" +" ;; @dots{}\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:10574 +#, no-wrap +msgid "" +" (services\n" +" (modify-services %desktop-services\n" +" (udev-service-type config =>\n" +" (udev-configuration (inherit config)\n" +" (rules (cons* android-udev-rules\n" +" (udev-configuration-rules config))))))))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10577 +#, no-wrap +msgid "{Scheme Variable} urandom-seed-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10582 +msgid "Save some entropy in @var{%random-seed-file} to seed @file{/dev/urandom} when rebooting. It also tries to seed @file{/dev/urandom} from @file{/dev/hwrng} while booting, if @file{/dev/hwrng} exists and is readable." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10584 +#, no-wrap +msgid "{Scheme Variable} %random-seed-file" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10588 +msgid "This is the name of the file where some random bytes are saved by @var{urandom-seed-service} to seed @file{/dev/urandom} when rebooting. It defaults to @file{/var/lib/random-seed}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10590 doc/guix.texi:11930 +#, no-wrap +msgid "keymap" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10591 +#, no-wrap +msgid "keyboard" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10592 +#, no-wrap +msgid "{Scheme Procedure} console-keymap-service @var{files} ..." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10597 +msgid "Return a service to load console keymaps from @var{files} using @command{loadkeys} command. Most likely, you want to load some default keymap, which can be done like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:10600 +#, no-wrap +msgid "(console-keymap-service \"dvorak\")\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10604 +msgid "Or, for example, for a Swedish keyboard, you may need to combine the following keymaps:" +msgstr "" + +#. type: example +#: doc/guix.texi:10606 +#, no-wrap +msgid "(console-keymap-service \"se-lat6\" \"se-fi-lat6\")\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10610 +msgid "Also you can specify a full file name (or file names) of your keymap(s). See @code{man loadkeys} for details." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10613 +#, no-wrap +msgid "mouse" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10614 +#, no-wrap +msgid "gpm" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10615 +#, no-wrap +msgid "{Scheme Variable} gpm-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10620 +msgid "This is the type of the service that runs GPM, the @dfn{general-purpose mouse daemon}, which provides mouse support to the Linux console. GPM allows users to use the mouse in the console, notably to select, copy, and paste text." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10623 +msgid "The value for services of this type must be a @code{gpm-configuration} (see below). This service is not part of @var{%base-services}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10625 +#, no-wrap +msgid "{Data Type} gpm-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10627 +msgid "Data type representing the configuration of GPM." +msgstr "" + +#. type: item +#: doc/guix.texi:10629 +#, no-wrap +msgid "@code{options} (default: @code{%default-gpm-options})" +msgstr "" + +#. type: table +#: doc/guix.texi:10634 +msgid "Command-line options passed to @command{gpm}. The default set of options instruct @command{gpm} to listen to mouse events on @file{/dev/input/mice}. @xref{Command Line,,, gpm, gpm manual}, for more information." +msgstr "" + +#. type: item +#: doc/guix.texi:10635 +#, no-wrap +msgid "@code{gpm} (default: @code{gpm})" +msgstr "" + +#. type: table +#: doc/guix.texi:10637 +msgid "The GPM package to use." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10642 +msgid "guix-publish-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10642 +#, no-wrap +msgid "{Scheme Variable} guix-publish-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10646 +msgid "This is the service type for @command{guix publish} (@pxref{Invoking guix publish}). Its value must be a @code{guix-configuration} object, as described below." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10650 +msgid "This assumes that @file{/etc/guix} already contains a signing key pair as created by @command{guix archive --generate-key} (@pxref{Invoking guix archive}). If that is not the case, the service will fail to start." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10652 +#, no-wrap +msgid "{Data Type} guix-publish-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10655 +msgid "Data type representing the configuration of the @code{guix publish} service." +msgstr "" + +#. type: item +#: doc/guix.texi:10657 +#, no-wrap +msgid "@code{guix} (default: @code{guix})" +msgstr "" + +#. type: item +#: doc/guix.texi:10660 +#, no-wrap +msgid "@code{port} (default: @code{80})" +msgstr "" + +#. type: table +#: doc/guix.texi:10662 +msgid "The TCP port to listen for connections." +msgstr "" + +#. type: item +#: doc/guix.texi:10663 +#, no-wrap +msgid "@code{host} (default: @code{\"localhost\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10666 +msgid "The host (and thus, network interface) to listen to. Use @code{\"0.0.0.0\"} to listen on all the network interfaces." +msgstr "" + +#. type: table +#: doc/guix.texi:10671 +msgid "The gzip compression level at which substitutes are compressed. Use @code{0} to disable compression altogether, and @code{9} to get the best compression ratio at the expense of increased CPU usage." +msgstr "" + +#. type: item +#: doc/guix.texi:10672 +#, no-wrap +msgid "@code{nar-path} (default: @code{\"nar\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10675 +msgid "The URL path at which ``nars'' can be fetched. @xref{Invoking guix publish, @code{--nar-path}}, for details." +msgstr "" + +#. type: item +#: doc/guix.texi:10676 +#, no-wrap +msgid "@code{cache} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10682 +msgid "When it is @code{#f}, disable caching and instead generate archives on demand. Otherwise, this should be the name of a directory---e.g., @code{\"/var/cache/guix/publish\"}---where @command{guix publish} caches archives and meta-data ready to be sent. @xref{Invoking guix publish, @option{--cache}}, for more information on the tradeoffs involved." +msgstr "" + +#. type: item +#: doc/guix.texi:10683 +#, no-wrap +msgid "@code{workers} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10687 +msgid "When it is an integer, this is the number of worker threads used for caching; when @code{#f}, the number of processors is used. @xref{Invoking guix publish, @option{--workers}}, for more information." +msgstr "" + +#. type: item +#: doc/guix.texi:10688 +#, no-wrap +msgid "@code{ttl} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10692 +msgid "When it is an integer, this denotes the @dfn{time-to-live} in seconds of the published archives. @xref{Invoking guix publish, @option{--ttl}}, for more information." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10696 +msgid "rngd-service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10696 +#, no-wrap +msgid "{Scheme Procedure} rngd-service [#:rng-tools @var{rng-tools}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10701 +msgid "[#:device \"/dev/hwrng\"] Return a service that runs the @command{rngd} program from @var{rng-tools} to add @var{device} to the kernel's entropy pool. The service will fail if @var{device} does not exist." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:10704 +msgid "pam-limits-service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10704 +#, no-wrap +msgid "session limits" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10705 +#, no-wrap +msgid "ulimit" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10706 +#, no-wrap +msgid "priority" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10707 +#, no-wrap +msgid "realtime" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10708 +#, no-wrap +msgid "jackd" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10709 +#, no-wrap +msgid "{Scheme Procedure} pam-limits-service [#:limits @code{'()}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10716 +msgid "Return a service that installs a configuration file for the @uref{http://linux-pam.org/Linux-PAM-html/sag-pam_limits.html, @code{pam_limits} module}. The procedure optionally takes a list of @code{pam-limits-entry} values, which can be used to specify @code{ulimit} limits and nice priority limits to user sessions." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10719 +msgid "The following limits definition sets two hard and soft limits for all login sessions of users in the @code{realtime} group:" +msgstr "" + +#. type: example +#: doc/guix.texi:10725 +#, no-wrap +msgid "" +"(pam-limits-service\n" +" (list\n" +" (pam-limits-entry \"@@realtime\" 'both 'rtprio 99)\n" +" (pam-limits-entry \"@@realtime\" 'both 'memlock 'unlimited)))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10731 +msgid "The first entry increases the maximum realtime priority for non-privileged processes; the second entry lifts any restriction of the maximum address space that can be locked in memory. These settings are commonly used for real-time audio systems." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10736 +#, no-wrap +msgid "cron" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10737 +#, no-wrap +msgid "mcron" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10738 +#, no-wrap +msgid "scheduling jobs" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10745 +msgid "The @code{(gnu services mcron)} module provides an interface to GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, mcron, GNU@tie{}mcron}). GNU@tie{}mcron is similar to the traditional Unix @command{cron} daemon; the main difference is that it is implemented in Guile Scheme, which provides a lot of flexibility when specifying the scheduling of jobs and their actions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10753 +msgid "The example below defines an operating system that runs the @command{updatedb} (@pxref{Invoking updatedb,,, find, Finding Files}) and the @command{guix gc} commands (@pxref{Invoking guix gc}) daily, as well as the @command{mkid} command on behalf of an unprivileged user (@pxref{mkid invocation,,, idutils, ID Database Utilities}). It uses gexps to introduce job definitions that are passed to mcron (@pxref{G-Expressions})." +msgstr "" + +#. type: lisp +#: doc/guix.texi:10757 +#, no-wrap +msgid "" +"(use-modules (guix) (gnu) (gnu services mcron))\n" +"(use-package-modules base idutils)\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:10766 +#, no-wrap +msgid "" +"(define updatedb-job\n" +" ;; Run 'updatedb' at 3AM every day. Here we write the\n" +" ;; job's action as a Scheme procedure.\n" +" #~(job '(next-hour '(3))\n" +" (lambda ()\n" +" (execl (string-append #$findutils \"/bin/updatedb\")\n" +" \"updatedb\"\n" +" \"--prunepaths=/tmp /var/tmp /gnu/store\"))))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:10772 +#, no-wrap +msgid "" +"(define garbage-collector-job\n" +" ;; Collect garbage 5 minutes after midnight every day.\n" +" ;; The job's action is a shell command.\n" +" #~(job \"5 0 * * *\" ;Vixie cron syntax\n" +" \"guix gc -F 1G\"))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:10779 +#, no-wrap +msgid "" +"(define idutils-job\n" +" ;; Update the index database as user \"charlie\" at 12:15PM\n" +" ;; and 19:15PM. This runs from the user's home directory.\n" +" #~(job '(next-minute-from (next-hour '(12 19)) '(15))\n" +" (string-append #$idutils \"/bin/mkid src\")\n" +" #:user \"charlie\"))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:10786 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (services (cons (mcron-service (list garbage-collector-job\n" +" updatedb-job\n" +" idutils-job))\n" +" %base-services)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10791 +msgid "@xref{Guile Syntax, mcron job specifications,, mcron, GNU@tie{}mcron}, for more information on mcron job specifications. Below is the reference of the mcron service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10792 +#, no-wrap +msgid "{Scheme Procedure} mcron-service @var{jobs} [#:mcron @var{mcron}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10795 +msgid "Return an mcron service running @var{mcron} that schedules @var{jobs}, a list of gexps denoting mcron job specifications." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10797 +msgid "This is a shorthand for:" +msgstr "" + +#. type: example +#: doc/guix.texi:10800 +#, no-wrap +msgid "" +"(service mcron-service-type\n" +" (mcron-configuration (mcron mcron) (jobs jobs)))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10803 +#, no-wrap +msgid "{Scheme Variable} mcron-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10806 +msgid "This is the type of the @code{mcron} service, whose value is an @code{mcron-configuration} object." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10811 +msgid "This service type can be the target of a service extension that provides it additional job specifications (@pxref{Service Composition}). In other words, it is possible to define services that provide additional mcron jobs to run." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10813 +#, no-wrap +msgid "{Data Type} mcron-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10815 +msgid "Data type representing the configuration of mcron." +msgstr "" + +#. type: item +#: doc/guix.texi:10817 +#, no-wrap +msgid "@code{mcron} (default: @var{mcron})" +msgstr "" + +#. type: table +#: doc/guix.texi:10819 +msgid "The mcron package to use." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10820 doc/guix.texi:10879 +#, no-wrap +msgid "jobs" +msgstr "" + +#. type: table +#: doc/guix.texi:10824 +msgid "This is a list of gexps (@pxref{G-Expressions}), where each gexp corresponds to an mcron job specification (@pxref{Syntax, mcron job specifications,, mcron, GNU@tie{}mcron})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10831 +#, no-wrap +msgid "rottlog" +msgstr "" + +#. type: cindex +#: doc/guix.texi:10832 +#, no-wrap +msgid "log rotation" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10839 +msgid "Log files such as those found in @file{/var/log} tend to grow endlessly, so it's a good idea to @dfn{rotate} them once in a while---i.e., archive their contents in separate files, possibly compressed. The @code{(gnu services admin)} module provides an interface to GNU@tie{}Rot[t]log, a log rotation tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10842 +msgid "The example below defines an operating system that provides log rotation with the default settings, for commonly encountered log files." +msgstr "" + +#. type: lisp +#: doc/guix.texi:10847 +#, no-wrap +msgid "" +"(use-modules (guix) (gnu))\n" +"(use-service-modules admin mcron)\n" +"(use-package-modules base idutils)\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:10852 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (services (cons (service rottlog-service-type)\n" +" %base-services)))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10854 +#, no-wrap +msgid "{Scheme Variable} rottlog-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10857 +msgid "This is the type of the Rottlog service, whose value is a @code{rottlog-configuration} object." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10860 +msgid "Other services can extend this one with new @code{log-rotation} objects (see below), thereby augmenting the set of files to be rotated." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10863 +msgid "This service type can define mcron jobs (@pxref{Scheduled Job Execution}) to run the rottlog service." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10865 +#, no-wrap +msgid "{Data Type} rottlog-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10867 +msgid "Data type representing the configuration of rottlog." +msgstr "" + +#. type: item +#: doc/guix.texi:10869 +#, no-wrap +msgid "@code{rottlog} (default: @code{rottlog})" +msgstr "" + +#. type: table +#: doc/guix.texi:10871 +msgid "The Rottlog package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:10872 +#, no-wrap +msgid "@code{rc-file} (default: @code{(file-append rottlog \"/etc/rc\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:10875 +msgid "The Rottlog configuration file to use (@pxref{Mandatory RC Variables,,, rottlog, GNU Rot[t]log Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:10876 +#, no-wrap +msgid "@code{rotations} (default: @code{%default-rotations})" +msgstr "" + +#. type: table +#: doc/guix.texi:10878 +msgid "A list of @code{log-rotation} objects as defined below." +msgstr "" + +#. type: table +#: doc/guix.texi:10882 +msgid "This is a list of gexps where each gexp corresponds to an mcron job specification (@pxref{Scheduled Job Execution})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10885 +#, no-wrap +msgid "{Data Type} log-rotation" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10887 +msgid "Data type representing the rotation of a group of log files." +msgstr "" + +#. type: deftp +#: doc/guix.texi:10891 +msgid "Taking an example from the Rottlog manual (@pxref{Period Related File Examples,,, rottlog, GNU Rot[t]log Manual}), a log rotation might be defined like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:10900 +#, no-wrap +msgid "" +"(log-rotation\n" +" (frequency 'daily)\n" +" (files '(\"/var/log/apache/*\"))\n" +" (options '(\"storedir apache-archives\"\n" +" \"rotate 6\"\n" +" \"notifempty\"\n" +" \"nocompress\")))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10903 +msgid "The list of fields is as follows:" +msgstr "" + +#. type: item +#: doc/guix.texi:10905 +#, no-wrap +msgid "@code{frequency} (default: @code{'weekly})" +msgstr "" + +#. type: table +#: doc/guix.texi:10907 +msgid "The log rotation frequency, a symbol." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:10908 +#, no-wrap +msgid "files" +msgstr "" + +#. type: table +#: doc/guix.texi:10910 +msgid "The list of files or file glob patterns to rotate." +msgstr "" + +#. type: item +#: doc/guix.texi:10911 +#, no-wrap +msgid "@code{options} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:10914 +msgid "The list of rottlog options for this rotation (@pxref{Configuration parameters,,, rottlog, GNU Rot[t]lg Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:10915 +#, no-wrap +msgid "@code{post-rotate} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10917 +msgid "Either @code{#f} or a gexp to execute once the rotation has completed." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10920 +#, no-wrap +msgid "{Scheme Variable} %default-rotations" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10923 +msgid "Specifies weekly rotation of @var{%rotated-files} and a couple of other files." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10925 +#, no-wrap +msgid "{Scheme Variable} %rotated-files" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10928 +msgid "The list of syslog-controlled files to be rotated. By default it is: @code{'(\"/var/log/messages\" \"/var/log/secure\")}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:10935 +msgid "The @code{(gnu services networking)} module provides services to configure the network interface." +msgstr "" + +#. type: cindex +#: doc/guix.texi:10936 +#, no-wrap +msgid "DHCP, networking service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10937 +#, no-wrap +msgid "{Scheme Procedure} dhcp-client-service [#:dhcp @var{isc-dhcp}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10940 +msgid "Return a service that runs @var{dhcp}, a Dynamic Host Configuration Protocol (DHCP) client, on all the non-loopback network interfaces." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10942 +#, no-wrap +msgid "{Scheme Procedure} dhcpd-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:10946 +msgid "This type defines a service that runs a DHCP daemon. To create a service of this type, you must supply a @code{<dhcpd-configuration>}. For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:10952 +#, no-wrap +msgid "" +"(service dhcpd-service-type\n" +" (dhcpd-configuration\n" +" (config-file (local-file \"my-dhcpd.conf\"))\n" +" (interfaces '(\"enp0s25\"))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:10955 +#, no-wrap +msgid "{Data Type} dhcpd-configuration" +msgstr "" + +#. type: item +#: doc/guix.texi:10957 +#, no-wrap +msgid "@code{package} (default: @code{isc-dhcp})" +msgstr "" + +#. type: table +#: doc/guix.texi:10962 +msgid "The package that provides the DHCP daemon. This package is expected to provide the daemon at @file{sbin/dhcpd} relative to its output directory. The default package is the @uref{http://www.isc.org/products/DHCP, ISC's DHCP server}." +msgstr "" + +#. type: item +#: doc/guix.texi:10962 doc/guix.texi:14707 +#, no-wrap +msgid "@code{config-file} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:10967 +msgid "The configuration file to use. This is required. It will be passed to @code{dhcpd} via its @code{-cf} option. This may be any ``file-like'' object (@pxref{G-Expressions, file-like objects}). See @code{man dhcpd.conf} for details on the configuration file syntax." +msgstr "" + +#. type: item +#: doc/guix.texi:10967 +#, no-wrap +msgid "@code{version} (default: @code{\"4\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10972 +msgid "The DHCP version to use. The ISC DHCP server supports the values ``4'', ``6'', and ``4o6''. These correspond to the @code{dhcpd} program options @code{-4}, @code{-6}, and @code{-4o6}. See @code{man dhcpd} for details." +msgstr "" + +#. type: item +#: doc/guix.texi:10972 +#, no-wrap +msgid "@code{run-directory} (default: @code{\"/run/dhcpd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10975 +msgid "The run directory to use. At service activation time, this directory will be created if it does not exist." +msgstr "" + +#. type: item +#: doc/guix.texi:10975 +#, no-wrap +msgid "@code{pid-file} (default: @code{\"/run/dhcpd/dhcpd.pid\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:10978 +msgid "The PID file to use. This corresponds to the @code{-pf} option of @code{dhcpd}. See @code{man dhcpd} for details." +msgstr "" + +#. type: item +#: doc/guix.texi:10978 +#, no-wrap +msgid "@code{interfaces} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:10984 +msgid "The names of the network interfaces on which dhcpd should listen for broadcasts. If this list is not empty, then its elements (which must be strings) will be appended to the @code{dhcpd} invocation when starting the daemon. It may not be necessary to explicitly specify any interfaces here; see @code{man dhcpd} for details." +msgstr "" + +#. type: defvr +#: doc/guix.texi:10987 +#, no-wrap +msgid "{Scheme Variable} static-networking-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:10990 +msgid "This is the type for statically-configured network interfaces." +msgstr "" + +#. type: deffn +#: doc/guix.texi:10992 +#, no-wrap +msgid "{Scheme Procedure} static-networking-service @var{interface} @var{ip} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11000 +msgid "[#:netmask #f] [#:gateway #f] [#:name-servers @code{'()}] [#:requirement @code{'(udev)}] Return a service that starts @var{interface} with address @var{ip}. If @var{netmask} is true, use it as the network mask. If @var{gateway} is true, it must be a string specifying the default network gateway. @var{requirement} can be used to declare a dependency on another service before configuring the interface." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11005 +msgid "This procedure can be called several times, one for each network interface of interest. Behind the scenes what it does is extend @code{static-networking-service-type} with additional network interfaces to handle." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11007 +#, no-wrap +msgid "wicd" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11010 +#, no-wrap +msgid "network management" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11011 +#, no-wrap +msgid "{Scheme Procedure} wicd-service [#:wicd @var{wicd}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11014 +msgid "Return a service that runs @url{https://launchpad.net/wicd,Wicd}, a network management daemon that aims to simplify wired and wireless networking." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11019 +msgid "This service adds the @var{wicd} package to the global profile, providing several commands to interact with the daemon and configure networking: @command{wicd-client}, a graphical user interface, and the @command{wicd-cli} and @command{wicd-curses} user interfaces." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11021 +#, no-wrap +msgid "ModemManager" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11023 +#, no-wrap +msgid "{Scheme Variable} modem-manager-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11028 +msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/ModemManager, ModemManager} service. The value for this service type is a @code{modem-manager-configuration} record." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11031 doc/guix.texi:11053 +msgid "This service is part of @code{%desktop-services} (@pxref{Desktop Services})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11033 +#, no-wrap +msgid "{Data Type} modem-manager-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11035 +msgid "Data type representing the configuration of ModemManager." +msgstr "" + +#. type: item +#: doc/guix.texi:11037 +#, no-wrap +msgid "@code{modem-manager} (default: @code{modem-manager})" +msgstr "" + +#. type: table +#: doc/guix.texi:11039 +msgid "The ModemManager package to use." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11043 +#, no-wrap +msgid "NetworkManager" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11045 +#, no-wrap +msgid "{Scheme Variable} network-manager-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11050 +msgid "This is the service type for the @uref{https://wiki.gnome.org/Projects/NetworkManager, NetworkManager} service. The value for this service type is a @code{network-manager-configuration} record." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11055 +#, no-wrap +msgid "{Data Type} network-manager-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11057 +msgid "Data type representing the configuration of NetworkManager." +msgstr "" + +#. type: item +#: doc/guix.texi:11059 +#, no-wrap +msgid "@code{network-manager} (default: @code{network-manager})" +msgstr "" + +#. type: table +#: doc/guix.texi:11061 +msgid "The NetworkManager package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11062 +#, no-wrap +msgid "@code{dns} (default: @code{\"default\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11065 +msgid "Processing mode for DNS, which affects how NetworkManager uses the @code{resolv.conf} configuration file." +msgstr "" + +#. type: item +#: doc/guix.texi:11067 +#, no-wrap +msgid "default" +msgstr "" + +#. type: table +#: doc/guix.texi:11070 +msgid "NetworkManager will update @code{resolv.conf} to reflect the nameservers provided by currently active connections." +msgstr "" + +#. type: item +#: doc/guix.texi:11071 +#, no-wrap +msgid "dnsmasq" +msgstr "" + +#. type: table +#: doc/guix.texi:11075 +msgid "NetworkManager will run @code{dnsmasq} as a local caching nameserver, using a \"split DNS\" configuration if you are connected to a VPN, and then update @code{resolv.conf} to point to the local nameserver." +msgstr "" + +#. type: item +#: doc/guix.texi:11076 doc/guix.texi:12100 +#, no-wrap +msgid "none" +msgstr "" + +#. type: table +#: doc/guix.texi:11078 +msgid "NetworkManager will not modify @code{resolv.conf}." +msgstr "" + +#. type: item +#: doc/guix.texi:11080 +#, no-wrap +msgid "@code{vpn-plugins} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11084 +msgid "This is the list of available plugins for virtual private networks (VPNs). An example of this is the @code{network-manager-openvpn} package, which allows NetworkManager to manage VPNs @i{via} OpenVPN." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11088 +#, no-wrap +msgid "Connman" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11089 +#, no-wrap +msgid "{Scheme Variable} connman-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11092 +msgid "This is the service type to run @url{https://01.org/connman,Connman}, a network connection manager." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11095 +msgid "Its value must be an @code{connman-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:11100 +#, no-wrap +msgid "" +"(service connman-service-type\n" +" (connman-configuration\n" +" (disable-vpn? #t)))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11103 +msgid "See below for details about @code{connman-configuration}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11105 +#, no-wrap +msgid "{Data Type} connman-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11107 +msgid "Data Type representing the configuration of connman." +msgstr "" + +#. type: item +#: doc/guix.texi:11109 +#, no-wrap +msgid "@code{connman} (default: @var{connman})" +msgstr "" + +#. type: table +#: doc/guix.texi:11111 +msgid "The connman package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11112 +#, no-wrap +msgid "@code{disable-vpn?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11114 +msgid "When true, enable connman's vpn plugin." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11117 +#, no-wrap +msgid "WPA Supplicant" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11118 +#, no-wrap +msgid "{Scheme Variable} wpa-supplicant-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11123 +msgid "This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA supplicant}, an authentication daemon required to authenticate against encrypted WiFi or ethernet networks. It is configured to listen for requests on D-Bus." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11126 +msgid "The value of this service is the @code{wpa-supplicant} package to use. Thus, it can be instantiated like this:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:11129 +#, no-wrap +msgid "" +"(use-modules (gnu services networking))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:11131 +#, no-wrap +msgid "(service wpa-supplicant-service-type)\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11134 +#, no-wrap +msgid "NTP" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11135 +#, no-wrap +msgid "real time clock" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11136 +#, no-wrap +msgid "{Scheme Procedure} ntp-service [#:ntp @var{ntp}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11144 +msgid "[#:servers @var{%ntp-servers}] @ [#:allow-large-adjustment? #f] Return a service that runs the daemon from @var{ntp}, the @uref{http://www.ntp.org, Network Time Protocol package}. The daemon will keep the system clock synchronized with that of @var{servers}. @var{allow-large-adjustment?} determines whether @command{ntpd} is allowed to make an initial adjustment of more than 1,000 seconds." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11146 +#, no-wrap +msgid "{Scheme Variable} %ntp-servers" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11148 +msgid "List of host names used as the default NTP servers." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11150 +#, no-wrap +msgid "OpenNTPD" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11151 +#, no-wrap +msgid "{Scheme Procedure} openntpd-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11155 +msgid "Run the @command{ntpd}, the Network Time Protocol (NTP) daemon, as implemented by @uref{http://www.openntpd.org, OpenNTPD}. The daemon will keep the system clock synchronized with that of the given servers." +msgstr "" + +#. type: example +#: doc/guix.texi:11165 +#, no-wrap +msgid "" +"(service\n" +" openntpd-service-type\n" +" (openntpd-configuration\n" +" (listen-on '(\"127.0.0.1\" \"::1\"))\n" +" (sensor '(\"udcf0 correction 70000\"))\n" +" (constraint-from '(\"www.gnu.org\"))\n" +" (constraints-from '(\"https://www.google.com/\"))\n" +" (allow-large-adjustment? #t)))\n" +"\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11169 +#, no-wrap +msgid "{Data Type} openntpd-configuration" +msgstr "" + +#. type: item +#: doc/guix.texi:11171 +#, no-wrap +msgid "@code{openntpd} (default: @code{(file-append openntpd \"/sbin/ntpd\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11173 +msgid "The openntpd executable to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11173 +#, no-wrap +msgid "@code{listen-on} (default: @code{'(\"127.0.0.1\" \"::1\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11175 +msgid "A list of local IP addresses or hostnames the ntpd daemon should listen on." +msgstr "" + +#. type: item +#: doc/guix.texi:11175 +#, no-wrap +msgid "@code{query-from} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11177 +msgid "A list of local IP address the ntpd daemon should use for outgoing queries." +msgstr "" + +#. type: item +#: doc/guix.texi:11177 +#, no-wrap +msgid "@code{sensor} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11182 +msgid "Specify a list of timedelta sensor devices ntpd should use. @code{ntpd} will listen to each sensor that acutally exists and ignore non-existant ones. See @uref{https://man.openbsd.org/ntpd.conf, upstream documentation} for more information." +msgstr "" + +#. type: item +#: doc/guix.texi:11182 +#, no-wrap +msgid "@code{server} (default: @var{%ntp-servers})" +msgstr "" + +#. type: table +#: doc/guix.texi:11184 +msgid "Specify a list of IP addresses or hostnames of NTP servers to synchronize to." +msgstr "" + +#. type: item +#: doc/guix.texi:11184 doc/guix.texi:16965 +#, no-wrap +msgid "@code{servers} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11186 +msgid "Specify a list of IP addresses or hostnames of NTP pools to synchronize to." +msgstr "" + +#. type: item +#: doc/guix.texi:11186 +#, no-wrap +msgid "@code{constraint-from} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11193 +msgid "@code{ntpd} can be configured to query the ‘Date’ from trusted HTTPS servers via TLS. This time information is not used for precision but acts as an authenticated constraint, thereby reducing the impact of unauthenticated NTP man-in-the-middle attacks. Specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint." +msgstr "" + +#. type: item +#: doc/guix.texi:11193 +#, no-wrap +msgid "@code{constraints-from} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11197 +msgid "As with constraint from, specify a list of URLs, IP addresses or hostnames of HTTPS servers to provide a constraint. Should the hostname resolve to multiple IP addresses, @code{ntpd} will calculate a median constraint from all of them." +msgstr "" + +#. type: item +#: doc/guix.texi:11197 +#, no-wrap +msgid "@code{allow-large-adjustment?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11200 +msgid "Determines if @code{ntpd} is allowed to make an initial adjustment of more than 180 seconds." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11203 +#, no-wrap +msgid "inetd" +msgstr "inetd" + +#. type: deffn +#: doc/guix.texi:11204 +#, no-wrap +msgid "{Scheme variable} inetd-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11209 +msgid "This service runs the @command{inetd} (@pxref{inetd invocation,,, inetutils, GNU Inetutils}) daemon. @command{inetd} listens for connections on internet sockets, and lazily starts the specified server program when a connection is made on one of these sockets." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11215 +msgid "The value of this service is an @code{inetd-configuration} object. The following example configures the @command{inetd} daemon to provide the built-in @command{echo} service, as well as an smtp service which forwards smtp traffic over ssh to a server @code{smtp-server} behind a gateway @code{hostname}:" +msgstr "" + +#. type: example +#: doc/guix.texi:11238 +#, no-wrap +msgid "" +"(service\n" +" inetd-service-type\n" +" (inetd-configuration\n" +" (entries (list\n" +" (inetd-entry\n" +" (name \"echo\")\n" +" (socket-type 'stream)\n" +" (protocol \"tcp\")\n" +" (wait? #f)\n" +" (user \"root\"))\n" +" (inetd-entry\n" +" (node \"127.0.0.1\")\n" +" (name \"smtp\")\n" +" (socket-type 'stream)\n" +" (protocol \"tcp\")\n" +" (wait? #f)\n" +" (user \"root\")\n" +" (program (file-append openssh \"/bin/ssh\"))\n" +" (arguments\n" +" '(\"ssh\" \"-qT\" \"-i\" \"/path/to/ssh_key\"\n" +" \"-W\" \"smtp-server:25\" \"user@@hostname\")))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11241 +msgid "See below for more details about @code{inetd-configuration}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11243 +#, no-wrap +msgid "{Data Type} inetd-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11245 +msgid "Data type representing the configuration of @command{inetd}." +msgstr "" + +#. type: item +#: doc/guix.texi:11247 +#, no-wrap +msgid "@code{program} (default: @code{(file-append inetutils \"/libexec/inetd\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11249 +msgid "The @command{inetd} executable to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11250 doc/guix.texi:16671 +#, no-wrap +msgid "@code{entries} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11253 +msgid "A list of @command{inetd} service entries. Each entry should be created by the @code{inetd-entry} constructor." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11256 +#, no-wrap +msgid "{Data Type} inetd-entry" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11260 +msgid "Data type representing an entry in the @command{inetd} configuration. Each entry corresponds to a socket where @command{inetd} will listen for requests." +msgstr "" + +#. type: item +#: doc/guix.texi:11262 +#, no-wrap +msgid "@code{node} (default: @code{#f})" +msgstr "@code{node} (Vorgabe: @code{#f})" + +#. type: table +#: doc/guix.texi:11267 +msgid "Optional string, a comma-separated list of local addresses @command{inetd} should use when listening for this service. @xref{Configuration file,,, inetutils, GNU Inetutils} for a complete description of all options." +msgstr "" + +#. type: table +#: doc/guix.texi:11269 +msgid "A string, the name must correspond to an entry in @code{/etc/services}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:11269 +#, no-wrap +msgid "socket-type" +msgstr "socket-type" + +#. type: table +#: doc/guix.texi:11272 +msgid "One of @code{'stream}, @code{'dgram}, @code{'raw}, @code{'rdm} or @code{'seqpacket}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:11272 +#, no-wrap +msgid "protocol" +msgstr "protocol" + +#. type: table +#: doc/guix.texi:11274 +msgid "A string, must correspond to an entry in @code{/etc/protocols}." +msgstr "" + +#. type: item +#: doc/guix.texi:11274 +#, no-wrap +msgid "@code{wait?} (default: @code{#t})" +msgstr "@code{wait?} (Vorgabe: @code{#t})" + +#. type: table +#: doc/guix.texi:11277 +msgid "Whether @command{inetd} should wait for the server to exit before listening to new service requests." +msgstr "" + +#. type: table +#: doc/guix.texi:11282 +msgid "A string containing the user (and, optionally, group) name of the user as whom the server should run. The group name can be specified in a suffix, separated by a colon or period, i.e. @code{\"user\"}, @code{\"user:group\"} or @code{\"user.group\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:11282 +#, no-wrap +msgid "@code{program} (default: @code{\"internal\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11285 +msgid "The server program which will serve the requests, or @code{\"internal\"} if @command{inetd} should use a built-in service." +msgstr "" + +#. type: table +#: doc/guix.texi:11290 +msgid "A list strings or file-like objects, which are the server program's arguments, starting with the zeroth argument, i.e. the name of the program itself. For @command{inetd}'s internal services, this entry must be @code{'()} or @code{'(\"internal\")}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11294 +msgid "@xref{Configuration file,,, inetutils, GNU Inetutils} for a more detailed discussion of each configuration field." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11296 +#, no-wrap +msgid "Tor" +msgstr "Tor" + +#. type: deffn +#: doc/guix.texi:11297 +#, no-wrap +msgid "{Scheme Procedure} tor-service [@var{config-file}] [#:tor @var{tor}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11300 +msgid "Return a service to run the @uref{https://torproject.org, Tor} anonymous networking daemon." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11305 +msgid "The daemon runs as the @code{tor} unprivileged user. It is passed @var{config-file}, a file-like object, with an additional @code{User tor} line and lines for hidden services added via @code{tor-hidden-service}. Run @command{man tor} for information about the configuration file." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11307 +#, no-wrap +msgid "hidden service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11308 +#, no-wrap +msgid "{Scheme Procedure} tor-hidden-service @var{name} @var{mapping}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11311 +msgid "Define a new Tor @dfn{hidden service} called @var{name} and implementing @var{mapping}. @var{mapping} is a list of port/host tuples, such as:" +msgstr "" + +#. type: example +#: doc/guix.texi:11315 +#, no-wrap +msgid "" +" '((22 \"127.0.0.1:22\")\n" +" (80 \"127.0.0.1:8080\"))\n" +msgstr "" +" '((22 \"127.0.0.1:22\")\n" +" (80 \"127.0.0.1:8080\"))\n" + +#. type: deffn +#: doc/guix.texi:11319 +msgid "In this example, port 22 of the hidden service is mapped to local port 22, and port 80 is mapped to local port 8080." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11323 +msgid "This creates a @file{/var/lib/tor/hidden-services/@var{name}} directory, where the @file{hostname} file contains the @code{.onion} host name for the hidden service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11326 +msgid "See @uref{https://www.torproject.org/docs/tor-hidden-service.html.en, the Tor project's documentation} for more information." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11329 +msgid "The @code{(gnu services rsync)} module provides the following services:" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11333 +msgid "You might want an rsync daemon if you have files that you want available so anyone (or just yourself) can download existing files or upload new files." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11334 +#, no-wrap +msgid "{Scheme Variable} rsync-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11337 +msgid "This is the type for the @uref{https://rsync.samba.org, rsync} rsync daemon, @command{rsync-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:11340 +#, no-wrap +msgid "(service rsync-service-type)\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11343 +msgid "See below for details about @code{rsync-configuration}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11345 +#, no-wrap +msgid "{Data Type} rsync-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11347 +msgid "Data type representing the configuration for @code{rsync-service}." +msgstr "" + +#. type: item +#: doc/guix.texi:11349 +#, no-wrap +msgid "@code{package} (default: @var{rsync})" +msgstr "" + +#. type: table +#: doc/guix.texi:11351 +msgid "@code{rsync} package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11352 +#, no-wrap +msgid "@code{port-number} (default: @code{873})" +msgstr "" + +#. type: table +#: doc/guix.texi:11356 +msgid "TCP port on which @command{rsync} listens for incoming connections. If port is less than @code{1024} @command{rsync} needs to be started as the @code{root} user and group." +msgstr "" + +#. type: item +#: doc/guix.texi:11357 +#, no-wrap +msgid "@code{pid-file} (default: @code{\"/var/run/rsyncd/rsyncd.pid\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11359 +msgid "Name of the file where @command{rsync} writes its PID." +msgstr "" + +#. type: item +#: doc/guix.texi:11360 +#, no-wrap +msgid "@code{lock-file} (default: @code{\"/var/run/rsyncd/rsyncd.lock\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11362 +msgid "Name of the file where @command{rsync} writes its lock file." +msgstr "" + +#. type: item +#: doc/guix.texi:11363 +#, no-wrap +msgid "@code{log-file} (default: @code{\"/var/log/rsyncd.log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11365 +msgid "Name of the file where @command{rsync} writes its log file." +msgstr "" + +#. type: item +#: doc/guix.texi:11366 +#, no-wrap +msgid "@code{use-chroot?} (default: @var{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11368 +msgid "Whether to use chroot for @command{rsync} shared directory." +msgstr "" + +#. type: item +#: doc/guix.texi:11369 +#, no-wrap +msgid "@code{share-path} (default: @file{/srv/rsync})" +msgstr "" + +#. type: table +#: doc/guix.texi:11371 +msgid "Location of the @command{rsync} shared directory." +msgstr "" + +#. type: item +#: doc/guix.texi:11372 +#, no-wrap +msgid "@code{share-comment} (default: @code{\"Rsync share\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11374 +msgid "Comment of the @command{rsync} shared directory." +msgstr "" + +#. type: item +#: doc/guix.texi:11375 +#, no-wrap +msgid "@code{read-only?} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11377 +msgid "Read-write permissions to shared directory." +msgstr "" + +#. type: item +#: doc/guix.texi:11378 +#, no-wrap +msgid "@code{timeout} (default: @code{300})" +msgstr "" + +#. type: table +#: doc/guix.texi:11380 +msgid "I/O timeout in seconds." +msgstr "" + +#. type: item +#: doc/guix.texi:11381 +#, no-wrap +msgid "@code{user} (default: @var{\"root\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11383 +msgid "Owner of the @code{rsync} process." +msgstr "" + +#. type: item +#: doc/guix.texi:11384 +#, no-wrap +msgid "@code{group} (default: @var{\"root\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11386 +msgid "Group of the @code{rsync} process." +msgstr "" + +#. type: item +#: doc/guix.texi:11387 +#, no-wrap +msgid "@code{uid} (default: @var{\"rsyncd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11390 +msgid "User name or user ID that file transfers to and from that module should take place as when the daemon was run as @code{root}." +msgstr "" + +#. type: item +#: doc/guix.texi:11391 +#, no-wrap +msgid "@code{gid} (default: @var{\"rsyncd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11393 +msgid "Group name or group ID that will be used when accessing the module." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11398 +msgid "Furthermore, @code{(gnu services ssh)} provides the following services." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11398 doc/guix.texi:11437 doc/guix.texi:21275 +#, no-wrap +msgid "SSH" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11399 doc/guix.texi:11438 doc/guix.texi:21276 +#, no-wrap +msgid "SSH server" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11401 +#, no-wrap +msgid "{Scheme Procedure} lsh-service [#:host-key \"/etc/lsh/host-key\"] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11410 +msgid "[#:daemonic? #t] [#:interfaces '()] [#:port-number 22] @ [#:allow-empty-passwords? #f] [#:root-login? #f] @ [#:syslog-output? #t] [#:x11-forwarding? #t] @ [#:tcp/ip-forwarding? #t] [#:password-authentication? #t] @ [#:public-key-authentication? #t] [#:initialize? #t] Run the @command{lshd} program from @var{lsh} to listen on port @var{port-number}. @var{host-key} must designate a file containing the host key, and readable only by root." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11416 +msgid "When @var{daemonic?} is true, @command{lshd} will detach from the controlling terminal and log its output to syslogd, unless one sets @var{syslog-output?} to false. Obviously, it also makes lsh-service depend on existence of syslogd service. When @var{pid-file?} is true, @command{lshd} writes its PID to the file called @var{pid-file}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11420 +msgid "When @var{initialize?} is true, automatically create the seed and host key upon service activation if they do not exist yet. This may take long and require interaction." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11425 +msgid "When @var{initialize?} is false, it is up to the user to initialize the randomness generator (@pxref{lsh-make-seed,,, lsh, LSH Manual}), and to create a key pair with the private key stored in file @var{host-key} (@pxref{lshd basics,,, lsh, LSH Manual})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11429 +msgid "When @var{interfaces} is empty, lshd listens for connections on all the network interfaces; otherwise, @var{interfaces} must be a list of host names or addresses." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11433 +msgid "@var{allow-empty-passwords?} specifies whether to accept log-ins with empty passwords, and @var{root-login?} specifies whether to accept log-ins as root." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11435 +msgid "The other options should be self-descriptive." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11439 +#, no-wrap +msgid "{Scheme Variable} openssh-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11443 +msgid "This is the type for the @uref{http://www.openssh.org, OpenSSH} secure shell daemon, @command{sshd}. Its value must be an @code{openssh-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:11452 +#, no-wrap +msgid "" +"(service openssh-service-type\n" +" (openssh-configuration\n" +" (x11-forwarding? #t)\n" +" (permit-root-login 'without-password)\n" +" (authorized-keys\n" +" `((\"alice\" ,(local-file \"alice.pub\"))\n" +" (\"bob\" ,(local-file \"bob.pub\"))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11455 +msgid "See below for details about @code{openssh-configuration}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11458 +msgid "This service can be extended with extra authorized keys, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:11463 +#, no-wrap +msgid "" +"(service-extension openssh-service-type\n" +" (const `((\"charlie\"\n" +" ,(local-file \"charlie.pub\")))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11466 +#, no-wrap +msgid "{Data Type} openssh-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11468 +msgid "This is the configuration record for OpenSSH's @command{sshd}." +msgstr "" + +#. type: item +#: doc/guix.texi:11470 +#, no-wrap +msgid "@code{pid-file} (default: @code{\"/var/run/sshd.pid\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11472 +msgid "Name of the file where @command{sshd} writes its PID." +msgstr "" + +#. type: item +#: doc/guix.texi:11473 +#, no-wrap +msgid "@code{port-number} (default: @code{22})" +msgstr "" + +#. type: table +#: doc/guix.texi:11475 +msgid "TCP port on which @command{sshd} listens for incoming connections." +msgstr "" + +#. type: item +#: doc/guix.texi:11476 +#, no-wrap +msgid "@code{permit-root-login} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11481 +msgid "This field determines whether and when to allow logins as root. If @code{#f}, root logins are disallowed; if @code{#t}, they are allowed. If it's the symbol @code{'without-password}, then root logins are permitted but not with password-based authentication." +msgstr "" + +#. type: item +#: doc/guix.texi:11482 doc/guix.texi:11615 +#, no-wrap +msgid "@code{allow-empty-passwords?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11485 +msgid "When true, users with empty passwords may log in. When false, they may not." +msgstr "" + +#. type: item +#: doc/guix.texi:11486 doc/guix.texi:11618 +#, no-wrap +msgid "@code{password-authentication?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11489 +msgid "When true, users may log in with their password. When false, they have other authentication methods." +msgstr "" + +#. type: item +#: doc/guix.texi:11490 +#, no-wrap +msgid "@code{public-key-authentication?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11493 +msgid "When true, users may log in using public key authentication. When false, users have to use other authentication method." +msgstr "" + +#. type: table +#: doc/guix.texi:11496 +msgid "Authorized public keys are stored in @file{~/.ssh/authorized_keys}. This is used only by protocol version 2." +msgstr "" + +#. type: item +#: doc/guix.texi:11497 +#, no-wrap +msgid "@code{x11-forwarding?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11501 +msgid "When true, forwarding of X11 graphical client connections is enabled---in other words, @command{ssh} options @option{-X} and @option{-Y} will work." +msgstr "" + +#. type: item +#: doc/guix.texi:11502 +#, no-wrap +msgid "@code{challenge-response-authentication?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11505 +msgid "Specifies whether challenge response authentication is allowed (e.g. via PAM)." +msgstr "" + +#. type: item +#: doc/guix.texi:11506 +#, no-wrap +msgid "@code{use-pam?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11512 +msgid "Enables the Pluggable Authentication Module interface. If set to @code{#t}, this will enable PAM authentication using @code{challenge-response-authentication?} and @code{password-authentication?}, in addition to PAM account and session module processing for all authentication types." +msgstr "" + +#. type: table +#: doc/guix.texi:11517 +msgid "Because PAM challenge response authentication usually serves an equivalent role to password authentication, you should disable either @code{challenge-response-authentication?} or @code{password-authentication?}." +msgstr "" + +#. type: item +#: doc/guix.texi:11518 +#, no-wrap +msgid "@code{print-last-log?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11521 +msgid "Specifies whether @command{sshd} should print the date and time of the last user login when a user logs in interactively." +msgstr "" + +#. type: item +#: doc/guix.texi:11522 +#, no-wrap +msgid "@code{subsystems} (default: @code{'((\"sftp\" \"internal-sftp\"))})" +msgstr "" + +#. type: table +#: doc/guix.texi:11524 +msgid "Configures external subsystems (e.g. file transfer daemon)." +msgstr "" + +#. type: table +#: doc/guix.texi:11528 +msgid "This is a list of two-element lists, each of which containing the subsystem name and a command (with optional arguments) to execute upon subsystem request." +msgstr "" + +#. type: table +#: doc/guix.texi:11531 +msgid "The command @command{internal-sftp} implements an in-process SFTP server. Alternately, one can specify the @command{sftp-server} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:11536 +#, no-wrap +msgid "" +"(service openssh-service-type\n" +" (openssh-configuration\n" +" (subsystems\n" +" `((\"sftp\" ,(file-append openssh \"/libexec/sftp-server\"))))))\n" +msgstr "" + +#. type: item +#: doc/guix.texi:11538 +#, no-wrap +msgid "@code{accepted-environment} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:11540 +msgid "List of strings describing which environment variables may be exported." +msgstr "" + +#. type: table +#: doc/guix.texi:11543 +msgid "Each string gets on its own line. See the @code{AcceptEnv} option in @code{man sshd_config}." +msgstr "" + +#. type: table +#: doc/guix.texi:11548 +msgid "This example allows ssh-clients to export the @code{COLORTERM} variable. It is set by terminal emulators, which support colors. You can use it in your shell's ressource file to enable colors for the prompt and commands if this variable is set." +msgstr "" + +#. type: example +#: doc/guix.texi:11553 +#, no-wrap +msgid "" +"(service openssh-service-type\n" +" (openssh-configuration\n" +" (accepted-environment '(\"COLORTERM\"))))\n" +msgstr "" + +#. type: item +#: doc/guix.texi:11555 +#, no-wrap +msgid "@code{authorized-keys} (default: @code{'()})" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11556 +#, no-wrap +msgid "authorized keys, SSH" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11557 +#, no-wrap +msgid "SSH authorized keys" +msgstr "" + +#. type: table +#: doc/guix.texi:11561 +msgid "This is the list of authorized keys. Each element of the list is a user name followed by one or more file-like objects that represent SSH public keys. For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:11568 +#, no-wrap +msgid "" +"(openssh-configuration\n" +" (authorized-keys\n" +" `((\"rekado\" ,(local-file \"rekado.pub\"))\n" +" (\"chris\" ,(local-file \"chris.pub\"))\n" +" (\"root\" ,(local-file \"rekado.pub\") ,(local-file \"chris.pub\")))))\n" +msgstr "" + +#. type: table +#: doc/guix.texi:11573 +msgid "registers the specified public keys for user accounts @code{rekado}, @code{chris}, and @code{root}." +msgstr "" + +#. type: table +#: doc/guix.texi:11576 +msgid "Additional authorized keys can be specified @i{via} @code{service-extension}." +msgstr "" + +#. type: table +#: doc/guix.texi:11579 +msgid "Note that this does @emph{not} interfere with the use of @file{~/.ssh/authorized_keys}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11582 +#, no-wrap +msgid "{Scheme Procedure} dropbear-service [@var{config}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11586 +msgid "Run the @uref{https://matt.ucc.asn.au/dropbear/dropbear.html,Dropbear SSH daemon} with the given @var{config}, a @code{<dropbear-configuration>} object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11589 +msgid "For example, to specify a Dropbear service listening on port 1234, add this call to the operating system's @code{services} field:" +msgstr "" + +#. type: example +#: doc/guix.texi:11593 +#, no-wrap +msgid "" +"(dropbear-service (dropbear-configuration\n" +" (port-number 1234)))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11596 +#, no-wrap +msgid "{Data Type} dropbear-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11598 +msgid "This data type represents the configuration of a Dropbear SSH daemon." +msgstr "" + +#. type: item +#: doc/guix.texi:11600 +#, no-wrap +msgid "@code{dropbear} (default: @var{dropbear})" +msgstr "" + +#. type: table +#: doc/guix.texi:11602 +msgid "The Dropbear package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11603 +#, no-wrap +msgid "@code{port-number} (default: 22)" +msgstr "" + +#. type: table +#: doc/guix.texi:11605 +msgid "The TCP port where the daemon waits for incoming connections." +msgstr "" + +#. type: item +#: doc/guix.texi:11606 +#, no-wrap +msgid "@code{syslog-output?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:11608 +msgid "Whether to enable syslog output." +msgstr "" + +#. type: item +#: doc/guix.texi:11609 +#, no-wrap +msgid "@code{pid-file} (default: @code{\"/var/run/dropbear.pid\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11611 +msgid "File name of the daemon's PID file." +msgstr "" + +#. type: item +#: doc/guix.texi:11612 +#, no-wrap +msgid "@code{root-login?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11614 +msgid "Whether to allow @code{root} logins." +msgstr "" + +#. type: table +#: doc/guix.texi:11617 +msgid "Whether to allow empty passwords." +msgstr "" + +#. type: table +#: doc/guix.texi:11620 +msgid "Whether to enable password-based authentication." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11623 +#, no-wrap +msgid "{Scheme Variable} %facebook-host-aliases" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11629 +msgid "This variable contains a string for use in @file{/etc/hosts} (@pxref{Host Names,,, libc, The GNU C Library Reference Manual}). Each line contains a entry that maps a known server name of the Facebook on-line service---e.g., @code{www.facebook.com}---to the local host---@code{127.0.0.1} or its IPv6 equivalent, @code{::1}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11633 +msgid "This variable is typically used in the @code{hosts-file} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @file{/etc/hosts}}):" +msgstr "" + +#. type: example +#: doc/guix.texi:11636 +#, no-wrap +msgid "" +"(use-modules (gnu) (guix))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:11646 +#, no-wrap +msgid "" +"(operating-system\n" +" (host-name \"mymachine\")\n" +" ;; ...\n" +" (hosts-file\n" +" ;; Create a /etc/hosts file with aliases for \"localhost\"\n" +" ;; and \"mymachine\", as well as for Facebook servers.\n" +" (plain-file \"hosts\"\n" +" (string-append (local-host-aliases host-name)\n" +" %facebook-host-aliases))))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11650 +msgid "This mechanism can prevent programs running locally, such as Web browsers, from accessing Facebook." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11653 +msgid "The @code{(gnu services avahi)} provides the following definition." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11654 +#, no-wrap +msgid "{Scheme Procedure} avahi-service [#:avahi @var{avahi}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11666 +msgid "[#:host-name #f] [#:publish? #t] [#:ipv4? #t] @ [#:ipv6? #t] [#:wide-area? #f] @ [#:domains-to-browse '()] [#:debug? #f] Return a service that runs @command{avahi-daemon}, a system-wide mDNS/DNS-SD responder that allows for service discovery and \"zero-configuration\" host name lookups (see @uref{http://avahi.org/}), and extends the name service cache daemon (nscd) so that it can resolve @code{.local} host names using @uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. Additionally, add the @var{avahi} package to the system profile so that commands such as @command{avahi-browse} are directly usable." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11669 +msgid "If @var{host-name} is different from @code{#f}, use that as the host name to publish for this machine; otherwise, use the machine's actual host name." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11673 +msgid "When @var{publish?} is true, publishing of host names and services is allowed; in particular, avahi-daemon will publish the machine's host name and IP address via mDNS on the local network." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11675 +msgid "When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11678 +msgid "Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6 sockets." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11680 +#, no-wrap +msgid "{Scheme Variable} openvswitch-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11684 +msgid "This is the type of the @uref{http://www.openvswitch.org, Open vSwitch} service, whose value should be an @code{openvswitch-configuration} object." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11686 +#, no-wrap +msgid "{Data Type} openvswitch-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11690 +msgid "Data type representing the configuration of Open vSwitch, a multilayer virtual switch which is designed to enable massive network automation through programmatic extension." +msgstr "" + +#. type: item +#: doc/guix.texi:11692 +#, no-wrap +msgid "@code{package} (default: @var{openvswitch})" +msgstr "" + +#. type: table +#: doc/guix.texi:11694 +msgid "Package object of the Open vSwitch." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11701 +#, no-wrap +msgid "X11" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11702 +#, no-wrap +msgid "X Window System" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11703 doc/guix.texi:11880 +#, no-wrap +msgid "login manager" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11708 +msgid "Support for the X Window graphical display system---specifically Xorg---is provided by the @code{(gnu services xorg)} module. Note that there is no @code{xorg-service} procedure. Instead, the X server is started by the @dfn{login manager}, by default SLiM." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11709 +#, no-wrap +msgid "window manager" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11714 +msgid "To use X11, you must install at least one @dfn{window manager}---for example the @code{windowmaker} or @code{openbox} packages---preferably by adding it to the @code{packages} field of your operating system definition (@pxref{operating-system Reference, system-wide packages})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11715 +#, no-wrap +msgid "{Scheme Variable} slim-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11717 +msgid "This is the type for the SLiM graphical login manager for X11." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11718 +#, no-wrap +msgid "session types (X11)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:11719 +#, no-wrap +msgid "X11 session types" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11726 +msgid "SLiM looks for @dfn{session types} described by the @file{.desktop} files in @file{/run/current-system/profile/share/xsessions} and allows users to choose a session from the log-in screen using @kbd{F1}. Packages such as @code{xfce}, @code{sawfish}, and @code{ratpoison} provide @file{.desktop} files; adding them to the system-wide set of packages automatically makes them available at the log-in screen." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11730 +msgid "In addition, @file{~/.xsession} files are honored. When available, @file{~/.xsession} must be an executable that starts a window manager and/or other X clients." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11732 +#, no-wrap +msgid "{Data Type} slim-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11734 +msgid "Data type representing the configuration of @code{slim-service-type}." +msgstr "" + +#. type: table +#: doc/guix.texi:11738 +msgid "Whether to allow logins with empty passwords." +msgstr "" + +#. type: item +#: doc/guix.texi:11739 +#, no-wrap +msgid "@code{auto-login?} (default: @code{#f})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:11740 +#, no-wrap +msgid "@code{default-user} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:11742 +msgid "When @code{auto-login?} is false, SLiM presents a log-in screen." +msgstr "" + +#. type: table +#: doc/guix.texi:11745 +msgid "When @code{auto-login?} is true, SLiM logs in directly as @code{default-user}." +msgstr "" + +#. type: item +#: doc/guix.texi:11746 +#, no-wrap +msgid "@code{theme} (default: @code{%default-slim-theme})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:11747 +#, no-wrap +msgid "@code{theme-name} (default: @code{%default-slim-theme-name})" +msgstr "" + +#. type: table +#: doc/guix.texi:11749 +msgid "The graphical theme to use and its name." +msgstr "" + +#. type: item +#: doc/guix.texi:11750 +#, no-wrap +msgid "@code{auto-login-session} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:11753 +msgid "If true, this must be the name of the executable to start as the default session---e.g., @code{(file-append windowmaker \"/bin/windowmaker\")}." +msgstr "" + +#. type: table +#: doc/guix.texi:11757 +msgid "If false, a session described by one of the available @file{.desktop} files in @code{/run/current-system/profile} and @code{~/.guix-profile} will be used." +msgstr "" + +#. type: quotation +#: doc/guix.texi:11762 +msgid "You must install at least one window manager in the system profile or in your user profile. Failing to do that, if @code{auto-login-session} is false, you will be unable to log in." +msgstr "" + +#. type: item +#: doc/guix.texi:11764 +#, no-wrap +msgid "@code{startx} (default: @code{(xorg-start-command)})" +msgstr "" + +#. type: table +#: doc/guix.texi:11766 +msgid "The command used to start the X11 graphical server." +msgstr "" + +#. type: item +#: doc/guix.texi:11767 +#, no-wrap +msgid "@code{xauth} (default: @code{xauth})" +msgstr "" + +#. type: table +#: doc/guix.texi:11769 +msgid "The XAuth package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11770 +#, no-wrap +msgid "@code{shepherd} (default: @code{shepherd})" +msgstr "" + +#. type: table +#: doc/guix.texi:11773 +msgid "The Shepherd package used when invoking @command{halt} and @command{reboot}." +msgstr "" + +#. type: item +#: doc/guix.texi:11774 +#, no-wrap +msgid "@code{sessreg} (default: @code{sessreg})" +msgstr "" + +#. type: table +#: doc/guix.texi:11776 +msgid "The sessreg package used in order to register the session." +msgstr "" + +#. type: item +#: doc/guix.texi:11777 +#, no-wrap +msgid "@code{slim} (default: @code{slim})" +msgstr "" + +#. type: table +#: doc/guix.texi:11779 +msgid "The SLiM package to use." +msgstr "" + +#. type: defvr +#: doc/guix.texi:11782 doc/guix.texi:20772 +#, no-wrap +msgid "{Scheme Variable} %default-theme" +msgstr "" + +#. type: defvrx +#: doc/guix.texi:11783 +#, no-wrap +msgid "{Scheme Variable} %default-theme-name" +msgstr "" + +#. type: defvr +#: doc/guix.texi:11785 +msgid "The default SLiM theme and its name." +msgstr "" + +#. type: deftp +#: doc/guix.texi:11788 +#, no-wrap +msgid "{Data Type} sddm-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:11790 +msgid "This is the data type representing the sddm service configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:11792 +#, no-wrap +msgid "@code{display-server} (default: \"x11\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11795 +msgid "Select display server to use for the greeter. Valid values are \"x11\" or \"wayland\"." +msgstr "" + +#. type: item +#: doc/guix.texi:11796 +#, no-wrap +msgid "@code{numlock} (default: \"on\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11798 +msgid "Valid values are \"on\", \"off\" or \"none\"." +msgstr "" + +#. type: item +#: doc/guix.texi:11799 +#, no-wrap +msgid "@code{halt-command} (default @code{#~(string-apppend #$shepherd \"/sbin/halt\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11801 +msgid "Command to run when halting." +msgstr "" + +#. type: item +#: doc/guix.texi:11802 +#, no-wrap +msgid "@code{reboot-command} (default @code{#~(string-append #$shepherd \"/sbin/reboot\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11804 +msgid "Command to run when rebooting." +msgstr "" + +#. type: item +#: doc/guix.texi:11805 +#, no-wrap +msgid "@code{theme} (default \"maldives\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11807 +msgid "Theme to use. Default themes provided by SDDM are \"elarun\" or \"maldives\"." +msgstr "" + +#. type: item +#: doc/guix.texi:11808 +#, no-wrap +msgid "@code{themes-directory} (default \"/run/current-system/profile/share/sddm/themes\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11810 +msgid "Directory to look for themes." +msgstr "" + +#. type: item +#: doc/guix.texi:11811 +#, no-wrap +msgid "@code{faces-directory} (default \"/run/current-system/profile/share/sddm/faces\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11813 +msgid "Directory to look for faces." +msgstr "" + +#. type: item +#: doc/guix.texi:11814 +#, no-wrap +msgid "@code{default-path} (default \"/run/current-system/profile/bin\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11816 +msgid "Default PATH to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11817 +#, no-wrap +msgid "@code{minimum-uid} (default 1000)" +msgstr "" + +#. type: table +#: doc/guix.texi:11819 +msgid "Minimum UID to display in SDDM." +msgstr "" + +#. type: item +#: doc/guix.texi:11820 +#, no-wrap +msgid "@code{maximum-uid} (default 2000)" +msgstr "" + +#. type: table +#: doc/guix.texi:11822 +msgid "Maximum UID to display in SDDM" +msgstr "" + +#. type: item +#: doc/guix.texi:11823 +#, no-wrap +msgid "@code{remember-last-user?} (default #t)" +msgstr "" + +#. type: table +#: doc/guix.texi:11825 +msgid "Remember last user." +msgstr "" + +#. type: item +#: doc/guix.texi:11826 +#, no-wrap +msgid "@code{remember-last-session?} (default #t)" +msgstr "" + +#. type: table +#: doc/guix.texi:11828 +msgid "Remember last session." +msgstr "" + +#. type: item +#: doc/guix.texi:11829 +#, no-wrap +msgid "@code{hide-users} (default \"\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11831 +msgid "Usernames to hide from SDDM greeter." +msgstr "" + +#. type: item +#: doc/guix.texi:11832 +#, no-wrap +msgid "@code{hide-shells} (default @code{#~(string-append #$shadow \"/sbin/nologin\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11834 +msgid "Users with shells listed will be hidden from the SDDM greeter." +msgstr "" + +#. type: item +#: doc/guix.texi:11835 +#, no-wrap +msgid "@code{session-command} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/wayland-session\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11837 +msgid "Script to run before starting a wayland session." +msgstr "" + +#. type: item +#: doc/guix.texi:11838 +#, no-wrap +msgid "@code{sessions-directory} (default \"/run/current-system/profile/share/wayland-sessions\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11840 +msgid "Directory to look for desktop files starting wayland sessions." +msgstr "" + +#. type: item +#: doc/guix.texi:11841 +#, no-wrap +msgid "@code{xorg-server-path} (default @code{xorg-start-command})" +msgstr "" + +#. type: table +#: doc/guix.texi:11843 +msgid "Path to xorg-server." +msgstr "" + +#. type: item +#: doc/guix.texi:11844 +#, no-wrap +msgid "@code{xauth-path} (default @code{#~(string-append #$xauth \"/bin/xauth\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11846 +msgid "Path to xauth." +msgstr "" + +#. type: item +#: doc/guix.texi:11847 +#, no-wrap +msgid "@code{xephyr-path} (default @code{#~(string-append #$xorg-server \"/bin/Xephyr\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11849 +msgid "Path to Xephyr." +msgstr "" + +#. type: item +#: doc/guix.texi:11850 +#, no-wrap +msgid "@code{xdisplay-start} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xsetup\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11852 +msgid "Script to run after starting xorg-server." +msgstr "" + +#. type: item +#: doc/guix.texi:11853 +#, no-wrap +msgid "@code{xdisplay-stop} (default @code{#~(string-append #$sddm \"/share/sddm/scripts/Xstop\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:11855 +msgid "Script to run before stopping xorg-server." +msgstr "" + +#. type: item +#: doc/guix.texi:11856 +#, no-wrap +msgid "@code{xsession-command} (default: @code{xinitrc})" +msgstr "" + +#. type: table +#: doc/guix.texi:11858 +msgid "Script to run before starting a X session." +msgstr "" + +#. type: item +#: doc/guix.texi:11859 +#, no-wrap +msgid "@code{xsessions-directory} (default: \"/run/current-system/profile/share/xsessions\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11861 +msgid "Directory to look for desktop files starting X sessions." +msgstr "" + +#. type: item +#: doc/guix.texi:11862 +#, no-wrap +msgid "@code{minimum-vt} (default: 7)" +msgstr "" + +#. type: table +#: doc/guix.texi:11864 +msgid "Minimum VT to use." +msgstr "" + +#. type: item +#: doc/guix.texi:11865 +#, no-wrap +msgid "@code{xserver-arguments} (default \"-nolisten tcp\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11867 +msgid "Arguments to pass to xorg-server." +msgstr "" + +#. type: item +#: doc/guix.texi:11868 +#, no-wrap +msgid "@code{auto-login-user} (default \"\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11870 +msgid "User to use for auto-login." +msgstr "" + +#. type: item +#: doc/guix.texi:11871 +#, no-wrap +msgid "@code{auto-login-session} (default \"\")" +msgstr "" + +#. type: table +#: doc/guix.texi:11873 +msgid "Desktop file to use for auto-login." +msgstr "" + +#. type: item +#: doc/guix.texi:11874 +#, no-wrap +msgid "@code{relogin?} (default #f)" +msgstr "" + +#. type: table +#: doc/guix.texi:11876 +msgid "Relogin after logout." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11881 +#, no-wrap +msgid "X11 login" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11882 +#, no-wrap +msgid "{Scheme Procedure} sddm-service config" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11885 +msgid "Return a service that spawns the SDDM graphical login manager for config of type @code{<sddm-configuration>}." +msgstr "" + +#. type: example +#: doc/guix.texi:11890 +#, no-wrap +msgid "" +" (sddm-service (sddm-configuration\n" +" (auto-login-user \"Alice\")\n" +" (auto-login-session \"xfce.desktop\")))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11893 +#, no-wrap +msgid "{Scheme Procedure} xorg-start-command [#:guile] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11902 +msgid "[#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ [#:configuration-file (xorg-configuration-file @dots{})] @ [#:xorg-server @var{xorg-server}] Return a @code{startx} script in which @var{modules}, a list of X module packages, and @var{fonts}, a list of X font directories, are available. See @code{xorg-wrapper} for more details on the arguments. The result should be used in place of @code{startx}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11904 +msgid "Usually the X server is started by a login manager." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11906 +#, no-wrap +msgid "{Scheme Procedure} xorg-configuration-file @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11912 +msgid "[#:modules %default-xorg-modules] @ [#:fonts %default-xorg-fonts] @ [#:drivers '()] [#:resolutions '()] [#:extra-config '()] Return a configuration file for the Xorg server containing search paths for all the common drivers." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11917 +msgid "@var{modules} must be a list of @dfn{module packages} loaded by the Xorg server---e.g., @code{xf86-video-vesa}, @code{xf86-input-keyboard}, and so on. @var{fonts} must be a list of font directories to add to the server's @dfn{font path}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11921 +msgid "@var{drivers} must be either the empty list, in which case Xorg chooses a graphics driver automatically, or a list of driver names that will be tried in this order---e.g., @code{(\"modesetting\" \"vesa\")}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11925 +msgid "Likewise, when @var{resolutions} is the empty list, Xorg chooses an appropriate screen resolution; otherwise, it must be a list of resolutions---e.g., @code{((1024 768) (640 480))}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11929 +msgid "Last, @var{extra-config} is a list of strings or objects appended to the configuration file. It is used to pass extra text to be added verbatim to the configuration file." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11935 +msgid "This procedure is especially useful to configure a different keyboard layout than the default US keymap. For instance, to use the ``bépo'' keymap by default on the display manager:" +msgstr "" + +#. type: example +#: doc/guix.texi:11945 +#, no-wrap +msgid "" +"(define bepo-evdev\n" +" \"Section \\\"InputClass\\\"\n" +" Identifier \\\"evdev keyboard catchall\\\"\n" +" Driver \\\"evdev\\\"\n" +" MatchIsKeyboard \\\"on\\\"\n" +" Option \\\"xkb_layout\\\" \\\"fr\\\"\n" +" Option \\\"xkb_variant\\\" \\\"bepo\\\"\n" +"EndSection\")\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:11958 +#, no-wrap +msgid "" +"(operating-system\n" +" ...\n" +" (services\n" +" (modify-services %desktop-services\n" +" (slim-service-type config =>\n" +" (slim-configuration\n" +" (inherit config)\n" +" (startx (xorg-start-command\n" +" #:configuration-file\n" +" (xorg-configuration-file\n" +" #:extra-config\n" +" (list bepo-evdev)))))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11967 +msgid "The @code{MatchIsKeyboard} line specifies that we only apply the configuration to keyboards. Without this line, other devices such as touchpad may not work correctly because they will be attached to the wrong driver. In this example, the user typically used @code{setxkbmap fr bepo} to set their favorite keymap once logged in. The first argument corresponds to the layout, while the second argument corresponds to the variant. The @code{xkb_variant} line can be omitted to select the default variant." +msgstr "" + +#. type: deffn +#: doc/guix.texi:11969 +#, no-wrap +msgid "{Scheme Procedure} screen-locker-service @var{package} [@var{program}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11973 +msgid "Add @var{package}, a package for a screen locker or screen saver whose command is @var{program}, to the set of setuid programs and add a PAM entry for it. For example:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:11976 +#, no-wrap +msgid "(screen-locker-service xlockmore \"xlock\")\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11979 +msgid "makes the good ol' XlockMore usable." +msgstr "" + +#. type: cindex +#: doc/guix.texi:11985 +#, no-wrap +msgid "printer support with CUPS" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:11989 +msgid "The @code{(gnu services cups)} module provides a Guix service definition for the CUPS printing service. To add printer support to a GuixSD system, add a @code{cups-service} to the operating system definition:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11990 +#, no-wrap +msgid "{Scheme Variable} cups-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:11994 +msgid "The service type for the CUPS print server. Its value should be a valid CUPS configuration (see below). To use the default settings, simply write:" +msgstr "" + +#. type: example +#: doc/guix.texi:11996 +#, no-wrap +msgid "(service cups-service-type)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12006 +msgid "The CUPS configuration controls the basic things about your CUPS installation: what interfaces it listens on, what to do if a print job fails, how much logging to do, and so on. To actually add a printer, you have to visit the @url{http://localhost:631} URL, or use a tool such as GNOME's printer configuration services. By default, configuring a CUPS service will generate a self-signed certificate if needed, for secure connections to the print server." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12011 +msgid "Suppose you want to enable the Web interface of CUPS and also add support for Epson printers @i{via} the @code{escpr} package and for HP printers @i{via} the @code{hplip} package. You can do that directly, like this (you need to use the @code{(gnu packages cups)} module):" +msgstr "" + +#. type: example +#: doc/guix.texi:12018 +#, no-wrap +msgid "" +"(service cups-service-type\n" +" (cups-configuration\n" +" (web-interface? #t)\n" +" (extensions\n" +" (list cups-filters escpr hplip))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12026 +msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{cupsd.conf} file that you want to port over from some other system; see the end for more details." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12037 +msgid "Available @code{cups-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12038 +#, no-wrap +msgid "{@code{cups-configuration} parameter} package cups" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12040 doc/guix.texi:12797 +msgid "The CUPS package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12042 +#, no-wrap +msgid "{@code{cups-configuration} parameter} package-list extensions" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12044 +msgid "Drivers and other extensions to the CUPS package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12046 +#, no-wrap +msgid "{@code{cups-configuration} parameter} files-configuration files-configuration" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12049 +msgid "Configuration of where to write logs, what directories to use for print spools, and related privileged configuration parameters." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12051 +msgid "Available @code{files-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12052 +#, no-wrap +msgid "{@code{files-configuration} parameter} log-location access-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12060 +msgid "Defines the access log filename. Specifying a blank filename disables access log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-access_log}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12062 +msgid "Defaults to @samp{\"/var/log/cups/access_log\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12064 +#, no-wrap +msgid "{@code{files-configuration} parameter} file-name cache-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12066 +msgid "Where CUPS should cache data." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12068 +msgid "Defaults to @samp{\"/var/cache/cups\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12070 +#, no-wrap +msgid "{@code{files-configuration} parameter} string config-file-perm" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12073 +msgid "Specifies the permissions for all configuration files that the scheduler writes." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12079 +msgid "Note that the permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12081 +msgid "Defaults to @samp{\"0640\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12083 +#, no-wrap +msgid "{@code{files-configuration} parameter} log-location error-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12091 +msgid "Defines the error log filename. Specifying a blank filename disables access log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-error_log}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12093 +msgid "Defaults to @samp{\"/var/log/cups/error_log\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12095 +#, no-wrap +msgid "{@code{files-configuration} parameter} string fatal-errors" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12098 +msgid "Specifies which errors are fatal, causing the scheduler to exit. The kind strings are:" +msgstr "" + +#. type: table +#: doc/guix.texi:12102 +msgid "No errors are fatal." +msgstr "" + +#. type: table +#: doc/guix.texi:12105 +msgid "All of the errors below are fatal." +msgstr "" + +#. type: item +#: doc/guix.texi:12106 +#, no-wrap +msgid "browse" +msgstr "" + +#. type: table +#: doc/guix.texi:12109 +msgid "Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon." +msgstr "" + +#. type: item +#: doc/guix.texi:12110 +#, no-wrap +msgid "config" +msgstr "" + +#. type: table +#: doc/guix.texi:12112 +msgid "Configuration file syntax errors are fatal." +msgstr "" + +#. type: item +#: doc/guix.texi:12113 +#, no-wrap +msgid "listen" +msgstr "" + +#. type: table +#: doc/guix.texi:12116 +msgid "Listen or Port errors are fatal, except for IPv6 failures on the loopback or @code{any} addresses." +msgstr "" + +#. type: item +#: doc/guix.texi:12117 +#, no-wrap +msgid "log" +msgstr "" + +#. type: table +#: doc/guix.texi:12119 +msgid "Log file creation or write errors are fatal." +msgstr "" + +#. type: item +#: doc/guix.texi:12120 +#, no-wrap +msgid "permissions" +msgstr "" + +#. type: table +#: doc/guix.texi:12123 +msgid "Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12126 +msgid "Defaults to @samp{\"all -browse\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12128 +#, no-wrap +msgid "{@code{files-configuration} parameter} boolean file-device?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12131 +msgid "Specifies whether the file pseudo-device can be used for new printer queues. The URI @uref{file:///dev/null} is always allowed." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12133 doc/guix.texi:12203 doc/guix.texi:12239 +#: doc/guix.texi:12251 doc/guix.texi:12257 doc/guix.texi:12273 +#: doc/guix.texi:12361 doc/guix.texi:12455 doc/guix.texi:12771 +#: doc/guix.texi:12784 doc/guix.texi:17090 doc/guix.texi:17104 +#: doc/guix.texi:17226 doc/guix.texi:17247 doc/guix.texi:17268 +#: doc/guix.texi:17275 doc/guix.texi:17320 doc/guix.texi:17327 +#: doc/guix.texi:17730 doc/guix.texi:17744 doc/guix.texi:17916 +#: doc/guix.texi:17961 doc/guix.texi:18048 doc/guix.texi:18177 +#: doc/guix.texi:18210 doc/guix.texi:18350 doc/guix.texi:18361 +#: doc/guix.texi:18611 doc/guix.texi:19253 doc/guix.texi:19262 +#: doc/guix.texi:19270 doc/guix.texi:19278 doc/guix.texi:19294 +#: doc/guix.texi:19310 doc/guix.texi:19318 doc/guix.texi:19326 +#: doc/guix.texi:19335 doc/guix.texi:19344 doc/guix.texi:19360 +#: doc/guix.texi:19424 doc/guix.texi:19530 doc/guix.texi:19538 +#: doc/guix.texi:19546 doc/guix.texi:19571 doc/guix.texi:19625 +#: doc/guix.texi:19673 doc/guix.texi:19826 doc/guix.texi:19834 +#: doc/guix.texi:19842 doc/guix.texi:19850 doc/guix.texi:19858 +#: doc/guix.texi:19866 doc/guix.texi:19874 doc/guix.texi:19881 +msgid "Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12135 +#, no-wrap +msgid "{@code{files-configuration} parameter} string group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12138 +msgid "Specifies the group name or ID that will be used when executing external programs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12140 doc/guix.texi:12220 +msgid "Defaults to @samp{\"lp\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12142 +#, no-wrap +msgid "{@code{files-configuration} parameter} string log-file-perm" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12144 +msgid "Specifies the permissions for all log files that the scheduler writes." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12146 +msgid "Defaults to @samp{\"0644\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12148 +#, no-wrap +msgid "{@code{files-configuration} parameter} log-location page-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12156 +msgid "Defines the page log filename. Specifying a blank filename disables access log generation. The value @code{stderr} causes log entries to be sent to the standard error file when the scheduler is running in the foreground, or to the system log daemon when run in the background. The value @code{syslog} causes log entries to be sent to the system log daemon. The server name may be included in filenames using the string @code{%s}, as in @code{/var/log/cups/%s-page_log}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12158 +msgid "Defaults to @samp{\"/var/log/cups/page_log\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12160 +#, no-wrap +msgid "{@code{files-configuration} parameter} string remote-root" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12163 +msgid "Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user. The default is @code{remroot}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12165 +msgid "Defaults to @samp{\"remroot\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12167 +#, no-wrap +msgid "{@code{files-configuration} parameter} file-name request-root" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12170 +msgid "Specifies the directory that contains print jobs and other HTTP request data." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12172 +msgid "Defaults to @samp{\"/var/spool/cups\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12174 +#, no-wrap +msgid "{@code{files-configuration} parameter} sandboxing sandboxing" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12179 +msgid "Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler; either @code{relaxed} or @code{strict}. This directive is currently only used/supported on macOS." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12181 +msgid "Defaults to @samp{strict}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12183 +#, no-wrap +msgid "{@code{files-configuration} parameter} file-name server-keychain" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12188 +msgid "Specifies the location of TLS certificates and private keys. CUPS will look for public and private keys in this directory: a @code{.crt} files for PEM-encoded certificates and corresponding @code{.key} files for PEM-encoded private keys." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12190 +msgid "Defaults to @samp{\"/etc/cups/ssl\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12192 +#, no-wrap +msgid "{@code{files-configuration} parameter} file-name server-root" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12194 +msgid "Specifies the directory containing the server configuration files." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12196 +msgid "Defaults to @samp{\"/etc/cups\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12198 +#, no-wrap +msgid "{@code{files-configuration} parameter} boolean sync-on-close?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12201 +msgid "Specifies whether the scheduler calls fsync(2) after writing configuration or state files." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12205 +#, no-wrap +msgid "{@code{files-configuration} parameter} space-separated-string-list system-group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12207 +msgid "Specifies the group(s) to use for @code{@@SYSTEM} group authentication." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12209 +#, no-wrap +msgid "{@code{files-configuration} parameter} file-name temp-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12211 +msgid "Specifies the directory where temporary files are stored." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12213 +msgid "Defaults to @samp{\"/var/spool/cups/tmp\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12215 +#, no-wrap +msgid "{@code{files-configuration} parameter} string user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12218 +msgid "Specifies the user name or ID that is used when running external programs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12223 +#, no-wrap +msgid "{@code{cups-configuration} parameter} access-log-level access-log-level" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12230 +msgid "Specifies the logging level for the AccessLog file. The @code{config} level logs when printers and classes are added, deleted, or modified and when configuration files are accessed or updated. The @code{actions} level logs when print jobs are submitted, held, released, modified, or canceled, and any of the conditions for @code{config}. The @code{all} level logs all requests." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12232 +msgid "Defaults to @samp{actions}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12234 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean auto-purge-jobs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12237 +msgid "Specifies whether to purge job history data automatically when it is no longer required for quotas." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12241 +#, no-wrap +msgid "{@code{cups-configuration} parameter} browse-local-protocols browse-local-protocols" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12243 +msgid "Specifies which protocols to use for local printer sharing." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12245 +msgid "Defaults to @samp{dnssd}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12247 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean browse-web-if?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12249 +msgid "Specifies whether the CUPS web interface is advertised." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12253 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean browsing?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12255 +msgid "Specifies whether shared printers are advertised." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12259 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string classification" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12264 +msgid "Specifies the security classification of the server. Any valid banner name can be used, including \"classified\", \"confidential\", \"secret\", \"topsecret\", and \"unclassified\", or the banner can be omitted to disable secure printing functions." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12266 doc/guix.texi:12603 doc/guix.texi:14019 +#: doc/guix.texi:14031 doc/guix.texi:18316 doc/guix.texi:18324 +#: doc/guix.texi:18332 doc/guix.texi:18340 doc/guix.texi:18618 +#: doc/guix.texi:19096 doc/guix.texi:19104 doc/guix.texi:19112 +#: doc/guix.texi:19220 doc/guix.texi:19245 doc/guix.texi:19376 +#: doc/guix.texi:19384 doc/guix.texi:19392 doc/guix.texi:19400 +#: doc/guix.texi:19408 doc/guix.texi:19416 doc/guix.texi:19439 +#: doc/guix.texi:19447 doc/guix.texi:19499 doc/guix.texi:19515 +#: doc/guix.texi:19523 doc/guix.texi:19562 doc/guix.texi:19585 +#: doc/guix.texi:19607 doc/guix.texi:19614 doc/guix.texi:19649 +#: doc/guix.texi:19657 doc/guix.texi:19681 doc/guix.texi:19713 +#: doc/guix.texi:19742 doc/guix.texi:19749 doc/guix.texi:19756 +#: doc/guix.texi:19764 doc/guix.texi:19778 doc/guix.texi:19787 +#: doc/guix.texi:19797 doc/guix.texi:19804 doc/guix.texi:19811 +#: doc/guix.texi:19818 doc/guix.texi:19889 doc/guix.texi:19896 +#: doc/guix.texi:19903 doc/guix.texi:19912 doc/guix.texi:19928 +#: doc/guix.texi:19935 doc/guix.texi:19942 doc/guix.texi:19949 +#: doc/guix.texi:19957 doc/guix.texi:19965 +msgid "Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12268 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean classify-override?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12271 +msgid "Specifies whether users may override the classification (cover page) of individual print jobs using the @code{job-sheets} option." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12275 +#, no-wrap +msgid "{@code{cups-configuration} parameter} default-auth-type default-auth-type" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12277 +msgid "Specifies the default type of authentication to use." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12279 +msgid "Defaults to @samp{Basic}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12281 +#, no-wrap +msgid "{@code{cups-configuration} parameter} default-encryption default-encryption" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12283 +msgid "Specifies whether encryption will be used for authenticated requests." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12285 +msgid "Defaults to @samp{Required}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12287 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string default-language" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12289 +msgid "Specifies the default language to use for text and web content." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12291 +msgid "Defaults to @samp{\"en\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12293 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string default-paper-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12298 +msgid "Specifies the default paper size for new print queues. @samp{\"Auto\"} uses a locale-specific default, while @samp{\"None\"} specifies there is no default paper size. Specific size names are typically @samp{\"Letter\"} or @samp{\"A4\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12300 +msgid "Defaults to @samp{\"Auto\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12302 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string default-policy" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12304 +msgid "Specifies the default access policy to use." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12306 +msgid "Defaults to @samp{\"default\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12308 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean default-shared?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12310 +msgid "Specifies whether local printers are shared by default." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12312 doc/guix.texi:12392 doc/guix.texi:12688 +#: doc/guix.texi:17060 doc/guix.texi:17067 doc/guix.texi:17075 +#: doc/guix.texi:17097 doc/guix.texi:17111 doc/guix.texi:17196 +#: doc/guix.texi:17203 doc/guix.texi:17211 doc/guix.texi:17597 +#: doc/guix.texi:17737 doc/guix.texi:17923 doc/guix.texi:17930 +#: doc/guix.texi:17952 doc/guix.texi:17991 doc/guix.texi:18011 +#: doc/guix.texi:18025 doc/guix.texi:18165 doc/guix.texi:19198 +#: doc/guix.texi:19286 doc/guix.texi:19302 doc/guix.texi:19352 +msgid "Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12314 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer dirty-clean-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12318 +msgid "Specifies the delay for updating of configuration and state files, in seconds. A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12320 doc/guix.texi:12368 doc/guix.texi:12377 +#: doc/guix.texi:12398 doc/guix.texi:12695 +msgid "Defaults to @samp{30}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12322 +#, no-wrap +msgid "{@code{cups-configuration} parameter} error-policy error-policy" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12328 +msgid "Specifies what to do when an error occurs. Possible values are @code{abort-job}, which will discard the failed print job; @code{retry-job}, which will retry the job at a later time; @code{retry-this-job}, which retries the failed job immediately; and @code{stop-printer}, which stops the printer." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12330 +msgid "Defaults to @samp{stop-printer}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12332 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer filter-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12340 +msgid "Specifies the maximum cost of filters that are run concurrently, which can be used to minimize disk, memory, and CPU resource problems. A limit of 0 disables filter limiting. An average print to a non-PostScript printer needs a filter limit of about 200. A PostScript printer needs about half that (100). Setting the limit below these thresholds will effectively limit the scheduler to printing a single job at any time." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12342 doc/guix.texi:12350 doc/guix.texi:12405 +#: doc/guix.texi:12521 doc/guix.texi:12535 doc/guix.texi:12542 +#: doc/guix.texi:14123 doc/guix.texi:14135 doc/guix.texi:17613 +#: doc/guix.texi:17938 doc/guix.texi:19191 doc/guix.texi:19491 +#: doc/guix.texi:19665 +msgid "Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12344 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer filter-nice" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12348 +msgid "Specifies the scheduling priority of filters that are run to print a job. The nice value ranges from 0, the highest priority, to 19, the lowest priority." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12352 +#, no-wrap +msgid "{@code{cups-configuration} parameter} host-name-lookups host-name-lookups" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12359 +msgid "Specifies whether to do reverse lookups on connecting clients. The @code{double} setting causes @code{cupsd} to verify that the hostname resolved from the address matches one of the addresses returned for that hostname. Double lookups also prevent clients with unregistered addresses from connecting to your server. Only set this option to @code{#t} or @code{double} if absolutely required." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12363 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer job-kill-delay" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12366 +msgid "Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12370 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12375 +msgid "Specifies the interval between retries of jobs in seconds. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12379 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer job-retry-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12384 +msgid "Specifies the number of retries that are done for jobs. This is typically used for fax queues but can also be used with normal print queues whose error policy is @code{retry-job} or @code{retry-current-job}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12386 doc/guix.texi:18417 doc/guix.texi:18437 +#: doc/guix.texi:18453 doc/guix.texi:18467 doc/guix.texi:18474 +#: doc/guix.texi:18481 doc/guix.texi:18488 doc/guix.texi:18647 +#: doc/guix.texi:18663 doc/guix.texi:18670 doc/guix.texi:18677 +#: doc/guix.texi:18688 doc/guix.texi:19143 doc/guix.texi:19151 +#: doc/guix.texi:19159 doc/guix.texi:19183 +msgid "Defaults to @samp{5}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12388 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean keep-alive?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12390 +msgid "Specifies whether to support HTTP keep-alive connections." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12394 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer keep-alive-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12396 +msgid "Specifies how long an idle client connection remains open, in seconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12400 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer limit-request-body" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12403 +msgid "Specifies the maximum size of print files, IPP requests, and HTML form data. A limit of 0 disables the limit check." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12407 +#, no-wrap +msgid "{@code{cups-configuration} parameter} multiline-string-list listen" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12414 +msgid "Listens on the specified interfaces for connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses. Values can also be file names of local UNIX domain sockets. The Listen directive is similar to the Port directive but allows you to restrict access to specific interfaces or networks." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12416 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer listen-back-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12423 +msgid "Specifies the number of pending connections that will be allowed. This normally only affects very busy servers that have reached the MaxClients limit, but can also be triggered by large numbers of simultaneous connections. When the limit is reached, the operating system will refuse additional connections until the scheduler can accept the pending ones." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12425 +msgid "Defaults to @samp{128}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12427 +#, no-wrap +msgid "{@code{cups-configuration} parameter} location-access-control-list location-access-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12429 +msgid "Specifies a set of additional access controls." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12431 +msgid "Available @code{location-access-controls} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12432 +#, no-wrap +msgid "{@code{location-access-controls} parameter} file-name path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12434 +msgid "Specifies the URI path to which the access control applies." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12436 +#, no-wrap +msgid "{@code{location-access-controls} parameter} access-control-list access-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12439 +msgid "Access controls for all access to this path, in the same format as the @code{access-controls} of @code{operation-access-control}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12441 doc/guix.texi:12447 doc/guix.texi:12461 +#: doc/guix.texi:12468 doc/guix.texi:12610 doc/guix.texi:12669 +#: doc/guix.texi:12753 doc/guix.texi:12764 doc/guix.texi:14609 +#: doc/guix.texi:17118 doc/guix.texi:17306 doc/guix.texi:18308 +#: doc/guix.texi:18368 doc/guix.texi:18376 doc/guix.texi:19206 +#: doc/guix.texi:19213 doc/guix.texi:19555 doc/guix.texi:19633 +#: doc/guix.texi:19727 doc/guix.texi:19735 doc/guix.texi:19771 +#: doc/guix.texi:19921 doc/guix.texi:19972 doc/guix.texi:19981 +msgid "Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12443 +#, no-wrap +msgid "{@code{location-access-controls} parameter} method-access-control-list method-access-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12445 +msgid "Access controls for method-specific access to this path." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12449 +msgid "Available @code{method-access-controls} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12450 +#, no-wrap +msgid "{@code{method-access-controls} parameter} boolean reverse?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12453 +msgid "If @code{#t}, apply access controls to all methods except the listed methods. Otherwise apply to only the listed methods." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12457 +#, no-wrap +msgid "{@code{method-access-controls} parameter} method-list methods" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12459 +msgid "Methods to which this access control applies." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12463 +#, no-wrap +msgid "{@code{method-access-controls} parameter} access-control-list access-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12466 +msgid "Access control directives, as a list of strings. Each string should be one directive, such as \"Order allow,deny\"." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12472 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer log-debug-history" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12476 +msgid "Specifies the number of debugging messages that are retained for logging if an error occurs in a print job. Debug messages are logged regardless of the LogLevel setting." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12478 doc/guix.texi:12499 doc/guix.texi:12506 +#: doc/guix.texi:14369 doc/guix.texi:17291 +msgid "Defaults to @samp{100}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12480 +#, no-wrap +msgid "{@code{cups-configuration} parameter} log-level log-level" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12483 +msgid "Specifies the level of logging for the ErrorLog file. The value @code{none} stops all logging while @code{debug2} logs everything." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12485 +msgid "Defaults to @samp{info}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12487 +#, no-wrap +msgid "{@code{cups-configuration} parameter} log-time-format log-time-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12490 +msgid "Specifies the format of the date and time in the log files. The value @code{standard} logs whole seconds while @code{usecs} logs microseconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12492 +msgid "Defaults to @samp{standard}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12494 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12497 +msgid "Specifies the maximum number of simultaneous clients that are allowed by the scheduler." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12501 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-clients-per-host" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12504 +msgid "Specifies the maximum number of simultaneous clients that are allowed from a single address." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12508 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-copies" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12511 +msgid "Specifies the maximum number of copies that a user can print of each job." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12513 +msgid "Defaults to @samp{9999}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12515 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-hold-time" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12519 +msgid "Specifies the maximum time a job may remain in the @code{indefinite} hold state before it is canceled. A value of 0 disables cancellation of held jobs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12523 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12526 +msgid "Specifies the maximum number of simultaneous jobs that are allowed. Set to 0 to allow an unlimited number of jobs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12528 +msgid "Defaults to @samp{500}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12530 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-printer" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12533 +msgid "Specifies the maximum number of simultaneous jobs that are allowed per printer. A value of 0 allows up to MaxJobs jobs per printer." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12537 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-jobs-per-user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12540 +msgid "Specifies the maximum number of simultaneous jobs that are allowed per user. A value of 0 allows up to MaxJobs jobs per user." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12544 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-job-time" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12547 +msgid "Specifies the maximum time a job may take to print before it is canceled, in seconds. Set to 0 to disable cancellation of \"stuck\" jobs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12549 +msgid "Defaults to @samp{10800}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12551 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer max-log-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12554 +msgid "Specifies the maximum size of the log files before they are rotated, in bytes. The value 0 disables log rotation." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12556 +msgid "Defaults to @samp{1048576}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12558 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer multiple-operation-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12561 +msgid "Specifies the maximum amount of time to allow between files in a multiple file print job, in seconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12563 doc/guix.texi:12777 +msgid "Defaults to @samp{300}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12565 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string page-log-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12570 +msgid "Specifies the format of PageLog lines. Sequences beginning with percent (@samp{%}) characters are replaced with the corresponding information, while all other characters are copied literally. The following percent sequences are recognized:" +msgstr "" + +#. type: item +#: doc/guix.texi:12572 +#, no-wrap +msgid "%%" +msgstr "" + +#. type: table +#: doc/guix.texi:12574 +msgid "insert a single percent character" +msgstr "" + +#. type: item +#: doc/guix.texi:12575 +#, no-wrap +msgid "%@{name@}" +msgstr "" + +#. type: table +#: doc/guix.texi:12577 +msgid "insert the value of the specified IPP attribute" +msgstr "" + +#. type: item +#: doc/guix.texi:12578 +#, no-wrap +msgid "%C" +msgstr "" + +#. type: table +#: doc/guix.texi:12580 +msgid "insert the number of copies for the current page" +msgstr "" + +#. type: item +#: doc/guix.texi:12581 +#, no-wrap +msgid "%P" +msgstr "" + +#. type: table +#: doc/guix.texi:12583 +msgid "insert the current page number" +msgstr "" + +#. type: item +#: doc/guix.texi:12584 +#, no-wrap +msgid "%T" +msgstr "" + +#. type: table +#: doc/guix.texi:12586 +msgid "insert the current date and time in common log format" +msgstr "" + +#. type: item +#: doc/guix.texi:12587 +#, no-wrap +msgid "%j" +msgstr "" + +#. type: table +#: doc/guix.texi:12589 +msgid "insert the job ID" +msgstr "" + +#. type: item +#: doc/guix.texi:12590 doc/guix.texi:13979 +#, no-wrap +msgid "%p" +msgstr "" + +#. type: table +#: doc/guix.texi:12592 +msgid "insert the printer name" +msgstr "" + +#. type: item +#: doc/guix.texi:12593 doc/guix.texi:14002 +#, no-wrap +msgid "%u" +msgstr "" + +#. type: table +#: doc/guix.texi:12595 +msgid "insert the username" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12601 +msgid "A value of the empty string disables page logging. The string @code{%p %u %j %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@} %@{media@} %@{sides@}} creates a page log with the standard items." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12605 +#, no-wrap +msgid "{@code{cups-configuration} parameter} environment-variables environment-variables" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12608 +msgid "Passes the specified environment variable(s) to child processes; a list of strings." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12612 +#, no-wrap +msgid "{@code{cups-configuration} parameter} policy-configuration-list policies" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12614 +msgid "Specifies named access control policies." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12616 +msgid "Available @code{policy-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12617 +#, no-wrap +msgid "{@code{policy-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12619 +msgid "Name of the policy." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12621 +#, no-wrap +msgid "{@code{policy-configuration} parameter} string job-private-access" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12631 +msgid "Specifies an access list for a job's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-config} configuration, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12633 doc/guix.texi:12655 +msgid "Defaults to @samp{\"@@OWNER @@SYSTEM\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12635 +#, no-wrap +msgid "{@code{policy-configuration} parameter} string job-private-values" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12638 doc/guix.texi:12660 +msgid "Specifies the list of job values to make private, or @code{all}, @code{default}, or @code{none}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12641 +msgid "Defaults to @samp{\"job-name job-originating-host-name job-originating-user-name phone\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12643 +#, no-wrap +msgid "{@code{policy-configuration} parameter} string subscription-private-access" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12653 +msgid "Specifies an access list for a subscription's private values. @code{@@ACL} maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of the @code{files-config} configuration, which is reified into the @code{cups-files.conf(5)} file. Other possible elements of the access list include specific user names, and @code{@@@var{group}} to indicate members of a specific group. The access list may also be simply @code{all} or @code{default}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12657 +#, no-wrap +msgid "{@code{policy-configuration} parameter} string subscription-private-values" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12663 +msgid "Defaults to @samp{\"notify-events notify-pull-method notify-recipient-uri notify-subscriber-user-name notify-user-data\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12665 +#, no-wrap +msgid "{@code{policy-configuration} parameter} operation-access-control-list access-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12667 +msgid "Access control by IPP operation." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12672 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-files" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12677 +msgid "Specifies whether job files (documents) are preserved after a job is printed. If a numeric value is specified, job files are preserved for the indicated number of seconds after printing. Otherwise a boolean value applies indefinitely." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12679 +msgid "Defaults to @samp{86400}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12681 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean-or-non-negative-integer preserve-job-history" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12686 +msgid "Specifies whether the job history is preserved after a job is printed. If a numeric value is specified, the job history is preserved for the indicated number of seconds after printing. If @code{#t}, the job history is preserved until the MaxJobs limit is reached." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12690 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer reload-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12693 +msgid "Specifies the amount of time to wait for job completion before restarting the scheduler." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12697 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string rip-cache" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12700 +msgid "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12702 +msgid "Defaults to @samp{\"128m\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12704 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string server-admin" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12706 +msgid "Specifies the email address of the server administrator." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12708 +msgid "Defaults to @samp{\"root@@localhost.localdomain\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12710 +#, no-wrap +msgid "{@code{cups-configuration} parameter} host-name-list-or-* server-alias" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12718 +msgid "The ServerAlias directive is used for HTTP Host header validation when clients connect to the scheduler from external interfaces. Using the special name @code{*} can expose your system to known browser-based DNS rebinding attacks, even when accessing sites through a firewall. If the auto-discovery of alternate names does not work, we recommend listing each alternate name with a ServerAlias directive instead of using @code{*}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12720 +msgid "Defaults to @samp{*}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12722 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string server-name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12724 +msgid "Specifies the fully-qualified host name of the server." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12726 +msgid "Defaults to @samp{\"localhost\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12728 +#, no-wrap +msgid "{@code{cups-configuration} parameter} server-tokens server-tokens" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12736 +msgid "Specifies what information is included in the Server header of HTTP responses. @code{None} disables the Server header. @code{ProductOnly} reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor} reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS} reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname}) IPP/2.0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12738 +msgid "Defaults to @samp{Minimal}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12740 +#, no-wrap +msgid "{@code{cups-configuration} parameter} string set-env" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12742 +msgid "Set the specified environment variable to be passed to child processes." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12744 +msgid "Defaults to @samp{\"variable value\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12746 +#, no-wrap +msgid "{@code{cups-configuration} parameter} multiline-string-list ssl-listen" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12751 +msgid "Listens on the specified interfaces for encrypted connections. Valid values are of the form @var{address}:@var{port}, where @var{address} is either an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all addresses." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12755 +#, no-wrap +msgid "{@code{cups-configuration} parameter} ssl-options ssl-options" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12762 +msgid "Sets encryption options. By default, CUPS only supports encryption using TLS v1.0 or higher using known secure cipher suites. The @code{AllowRC4} option enables the 128-bit RC4 cipher suites, which are required for some older clients that do not implement newer ones. The @code{AllowSSL3} option enables SSL v3.0, which is required for some older clients that do not support TLS v1.0." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12766 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean strict-conformance?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12769 +msgid "Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12773 +#, no-wrap +msgid "{@code{cups-configuration} parameter} non-negative-integer timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12775 +msgid "Specifies the HTTP request timeout, in seconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12780 +#, no-wrap +msgid "{@code{cups-configuration} parameter} boolean web-interface?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12782 +msgid "Specifies whether the web interface is enabled." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12792 +msgid "At this point you're probably thinking ``oh dear, Guix manual, I like you but you can stop already with the configuration options''. Indeed. However, one more point: it could be that you have an existing @code{cupsd.conf} that you want to use. In that case, you can pass an @code{opaque-cups-configuration} as the configuration of a @code{cups-service-type}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12794 +msgid "Available @code{opaque-cups-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12795 +#, no-wrap +msgid "{@code{opaque-cups-configuration} parameter} package cups" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12799 +#, no-wrap +msgid "{@code{opaque-cups-configuration} parameter} string cupsd.conf" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12801 +msgid "The contents of the @code{cupsd.conf}, as a string." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12803 +#, no-wrap +msgid "{@code{opaque-cups-configuration} parameter} string cups-files.conf" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:12805 +msgid "The contents of the @code{cups-files.conf} file, as a string." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12810 +msgid "For example, if your @code{cupsd.conf} and @code{cups-files.conf} are in strings of the same name, you could instantiate a CUPS service like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:12816 +#, no-wrap +msgid "" +"(service cups-service-type\n" +" (opaque-cups-configuration\n" +" (cupsd.conf cupsd.conf)\n" +" (cups-files.conf cups-files.conf)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12827 +msgid "The @code{(gnu services desktop)} module provides services that are usually useful in the context of a ``desktop'' setup---that is, on a machine running a graphical display server, possibly with graphical user interfaces, etc. It also defines services that provide specific desktop environments like GNOME, XFCE or MATE." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12831 +msgid "To simplify things, the module defines a variable containing the set of services that users typically expect on a machine with a graphical environment and networking:" +msgstr "" + +#. type: defvr +#: doc/guix.texi:12832 +#, no-wrap +msgid "{Scheme Variable} %desktop-services" +msgstr "" + +#. type: defvr +#: doc/guix.texi:12835 +msgid "This is a list of services that builds upon @var{%base-services} and adds or adjusts services for a typical ``desktop'' setup." +msgstr "" + +#. type: defvr +#: doc/guix.texi:12845 +msgid "In particular, it adds a graphical login manager (@pxref{X Window, @code{slim-service}}), screen lockers, a network management tool (@pxref{Networking Services, @code{network-manager-service-type}}), energy and color management services, the @code{elogind} login and seat manager, the Polkit privilege service, the GeoClue location service, the AccountsService daemon that allows authorized users change system passwords, an NTP client (@pxref{Networking Services}), the Avahi daemon, and has the name service switch service configured to be able to use @code{nss-mdns} (@pxref{Name Service Switch, mDNS})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12850 +msgid "The @var{%desktop-services} variable can be used as the @code{services} field of an @code{operating-system} declaration (@pxref{operating-system Reference, @code{services}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12873 +msgid "Additionally, the @code{gnome-desktop-service}, @code{xfce-desktop-service}, @code{mate-desktop-service} and @code{enlightenment-desktop-service-type} procedures can add GNOME, XFCE, MATE and/or Enlightenment to a system. To ``add GNOME'' means that system-level services like the backlight adjustment helpers and the power management utilities are added to the system, extending @code{polkit} and @code{dbus} appropriately, allowing GNOME to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service made by @code{gnome-desktop-service} adds the GNOME metapackage to the system profile. Likewise, adding the XFCE service not only adds the @code{xfce} metapackage to the system profile, but it also gives the Thunar file manager the ability to open a ``root-mode'' file management window, if the user authenticates using the administrator's password via the standard polkit graphical interface. To ``add MATE'' means that @code{polkit} and @code{dbus} are extended appropriately, allowing MATE to operate with elevated privileges on a limited number of special-purpose system interfaces. Additionally, adding a service made by @code{mate-desktop-service} adds the MATE metapackage to the system profile. ``Adding ENLIGHTENMENT'' means that @code{dbus} is extended appropriately, and several of Enlightenment's binaries are set as setuid, allowing Enlightenment's screen locker and other functionality to work as expetected." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12882 +msgid "The desktop environments in Guix use the Xorg display server by default. If you'd like to use the newer display server protocol called Wayland, you need to use the @code{sddm-service} instead of the @code{slim-service} for the graphical login manager. You should then select the ``GNOME (Wayland)'' session in SDDM. Alternatively you can also try starting GNOME on Wayland manually from a TTY with the command ``XDG_SESSION_TYPE=wayland exec dbus-run-session gnome-session``. Currently only GNOME has support for Wayland." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12883 +#, no-wrap +msgid "{Scheme Procedure} gnome-desktop-service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12887 +msgid "Return a service that adds the @code{gnome} package to the system profile, and extends polkit with the actions from @code{gnome-settings-daemon}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12889 +#, no-wrap +msgid "{Scheme Procedure} xfce-desktop-service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12894 +msgid "Return a service that adds the @code{xfce} package to the system profile, and extends polkit with the ability for @code{thunar} to manipulate the file system as root from within a user session, after the user has authenticated with the administrator's password." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12896 +#, no-wrap +msgid "{Scheme Procedure} mate-desktop-service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12900 +msgid "Return a service that adds the @code{mate} package to the system profile, and extends polkit with the actions from @code{mate-settings-daemon}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12902 +#, no-wrap +msgid "{Scheme Procedure} enlightenment-desktop-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12905 +msgid "Return a service that adds the @code{enlightenment} package to the system profile, and extends dbus with actions from @code{efl}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:12907 +#, no-wrap +msgid "{Data Type} enlightenment-desktop-service-configuration" +msgstr "" + +#. type: item +#: doc/guix.texi:12909 +#, no-wrap +msgid "@code{enlightenment} (default @code{enlightenment})" +msgstr "" + +#. type: table +#: doc/guix.texi:12911 +msgid "The enlightenment package to use." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12919 +msgid "Because the GNOME, XFCE and MATE desktop services pull in so many packages, the default @code{%desktop-services} variable doesn't include any of them by default. To add GNOME, XFCE or MATE, just @code{cons} them onto @code{%desktop-services} in the @code{services} field of your @code{operating-system}:" +msgstr "" + +#. type: example +#: doc/guix.texi:12930 +#, no-wrap +msgid "" +"(use-modules (gnu))\n" +"(use-service-modules desktop)\n" +"(operating-system\n" +" ...\n" +" ;; cons* adds items to the list given as its last argument.\n" +" (services (cons* (gnome-desktop-service)\n" +" (xfce-desktop-service)\n" +" %desktop-services))\n" +" ...)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12934 +msgid "These desktop environments will then be available as options in the graphical login window." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:12938 +msgid "The actual service definitions included in @code{%desktop-services} and provided by @code{(gnu services dbus)} and @code{(gnu services desktop)} are described below." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12939 +#, no-wrap +msgid "{Scheme Procedure} dbus-service [#:dbus @var{dbus}] [#:services '()]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12942 +msgid "Return a service that runs the ``system bus'', using @var{dbus}, with support for @var{services}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12946 +msgid "@uref{http://dbus.freedesktop.org/, D-Bus} is an inter-process communication facility. Its system bus is used to allow system services to communicate and to be notified of system-wide events." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12951 +msgid "@var{services} must be a list of packages that provide an @file{etc/dbus-1/system.d} directory containing additional D-Bus configuration and policy files. For example, to allow avahi-daemon to use the system bus, @var{services} must be equal to @code{(list avahi)}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12953 +#, no-wrap +msgid "{Scheme Procedure} elogind-service [#:config @var{config}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:12959 +msgid "Return a service that runs the @code{elogind} login and seat management daemon. @uref{https://github.com/elogind/elogind, Elogind} exposes a D-Bus interface that can be used to know which users are logged in, know what kind of sessions they have open, suspend the system, inhibit system suspend, reboot the system, and other tasks." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12963 +msgid "Elogind handles most system-level power events for a computer, for example suspending the system when a lid is closed, or shutting it down when the power button is pressed." +msgstr "" + +#. type: deffn +#: doc/guix.texi:12968 +msgid "The @var{config} keyword argument specifies the configuration for elogind, and should be the result of an @code{(elogind-configuration (@var{parameter} @var{value})...)} invocation. Available parameters and their default values are:" +msgstr "" + +#. type: item +#: doc/guix.texi:12970 +#, no-wrap +msgid "kill-user-processes?" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12972 doc/guix.texi:12990 doc/guix.texi:12992 +#: doc/guix.texi:12994 doc/guix.texi:13006 +msgid "#f" +msgstr "" + +#. type: item +#: doc/guix.texi:12972 +#, no-wrap +msgid "kill-only-users" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12974 doc/guix.texi:13012 +msgid "()" +msgstr "" + +#. type: item +#: doc/guix.texi:12974 +#, no-wrap +msgid "kill-exclude-users" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12976 +msgid "(\"root\")" +msgstr "" + +#. type: item +#: doc/guix.texi:12976 +#, no-wrap +msgid "inhibit-delay-max-seconds" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12978 +msgid "5" +msgstr "" + +#. type: item +#: doc/guix.texi:12978 +#, no-wrap +msgid "handle-power-key" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12980 +msgid "poweroff" +msgstr "" + +#. type: item +#: doc/guix.texi:12980 +#, no-wrap +msgid "handle-suspend-key" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12982 doc/guix.texi:12986 +msgid "suspend" +msgstr "" + +#. type: item +#: doc/guix.texi:12982 +#, no-wrap +msgid "handle-hibernate-key" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12984 +msgid "hibernate" +msgstr "" + +#. type: item +#: doc/guix.texi:12984 +#, no-wrap +msgid "handle-lid-switch" +msgstr "" + +#. type: item +#: doc/guix.texi:12986 +#, no-wrap +msgid "handle-lid-switch-docked" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12988 doc/guix.texi:13000 +msgid "ignore" +msgstr "" + +#. type: item +#: doc/guix.texi:12988 +#, no-wrap +msgid "power-key-ignore-inhibited?" +msgstr "" + +#. type: item +#: doc/guix.texi:12990 +#, no-wrap +msgid "suspend-key-ignore-inhibited?" +msgstr "" + +#. type: item +#: doc/guix.texi:12992 +#, no-wrap +msgid "hibernate-key-ignore-inhibited?" +msgstr "" + +#. type: item +#: doc/guix.texi:12994 +#, no-wrap +msgid "lid-switch-ignore-inhibited?" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12996 doc/guix.texi:13008 +msgid "#t" +msgstr "" + +#. type: item +#: doc/guix.texi:12996 +#, no-wrap +msgid "holdoff-timeout-seconds" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:12998 +msgid "30" +msgstr "" + +#. type: item +#: doc/guix.texi:12998 +#, no-wrap +msgid "idle-action" +msgstr "" + +#. type: item +#: doc/guix.texi:13000 +#, no-wrap +msgid "idle-action-seconds" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13002 +msgid "(* 30 60)" +msgstr "" + +#. type: item +#: doc/guix.texi:13002 +#, no-wrap +msgid "runtime-directory-size-percent" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13004 +msgid "10" +msgstr "" + +#. type: item +#: doc/guix.texi:13004 +#, no-wrap +msgid "runtime-directory-size" +msgstr "" + +#. type: item +#: doc/guix.texi:13006 +#, no-wrap +msgid "remove-ipc?" +msgstr "" + +#. type: item +#: doc/guix.texi:13008 +#, no-wrap +msgid "suspend-state" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13010 +msgid "(\"mem\" \"standby\" \"freeze\")" +msgstr "" + +#. type: item +#: doc/guix.texi:13010 +#, no-wrap +msgid "suspend-mode" +msgstr "" + +#. type: item +#: doc/guix.texi:13012 +#, no-wrap +msgid "hibernate-state" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13014 doc/guix.texi:13018 +msgid "(\"disk\")" +msgstr "" + +#. type: item +#: doc/guix.texi:13014 +#, no-wrap +msgid "hibernate-mode" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13016 +msgid "(\"platform\" \"shutdown\")" +msgstr "" + +#. type: item +#: doc/guix.texi:13016 +#, no-wrap +msgid "hybrid-sleep-state" +msgstr "" + +#. type: item +#: doc/guix.texi:13018 +#, no-wrap +msgid "hybrid-sleep-mode" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13020 +msgid "(\"suspend\" \"platform\" \"shutdown\")" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13023 +#, no-wrap +msgid "{Scheme Procedure} accountsservice-service @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13031 +msgid "[#:accountsservice @var{accountsservice}] Return a service that runs AccountsService, a system service that can list available accounts, change their passwords, and so on. AccountsService integrates with PolicyKit to enable unprivileged users to acquire the capability to modify their system configuration. @uref{https://www.freedesktop.org/wiki/Software/AccountsService/, the accountsservice web site} for more information." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13034 +msgid "The @var{accountsservice} keyword argument is the @code{accountsservice} package to expose as a service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13036 +#, no-wrap +msgid "{Scheme Procedure} polkit-service @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13045 +msgid "[#:polkit @var{polkit}] Return a service that runs the @uref{http://www.freedesktop.org/wiki/Software/polkit/, Polkit privilege management service}, which allows system administrators to grant access to privileged operations in a structured way. By querying the Polkit service, a privileged system component can know when it should grant additional capabilities to ordinary users. For example, an ordinary user can be granted the capability to suspend the system if the user is logged in locally." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13047 +#, no-wrap +msgid "{Scheme Procedure} upower-service [#:upower @var{upower}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13064 +msgid "[#:watts-up-pro? #f] @ [#:poll-batteries? #t] @ [#:ignore-lid? #f] @ [#:use-percentage-for-policy? #f] @ [#:percentage-low 10] @ [#:percentage-critical 3] @ [#:percentage-action 2] @ [#:time-low 1200] @ [#:time-critical 300] @ [#:time-action 120] @ [#:critical-power-action 'hybrid-sleep] Return a service that runs @uref{http://upower.freedesktop.org/, @command{upowerd}}, a system-wide monitor for power consumption and battery levels, with the given configuration settings. It implements the @code{org.freedesktop.UPower} D-Bus interface, and is notably used by GNOME." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13066 +#, no-wrap +msgid "{Scheme Procedure} udisks-service [#:udisks @var{udisks}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13071 +msgid "Return a service for @uref{http://udisks.freedesktop.org/docs/latest/, UDisks}, a @dfn{disk management} daemon that provides user interfaces with notifications and ways to mount/unmount disks. Programs that talk to UDisks include the @command{udisksctl} command, part of UDisks, and GNOME Disks." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13073 +#, no-wrap +msgid "{Scheme Procedure} colord-service [#:colord @var{colord}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13079 +msgid "Return a service that runs @command{colord}, a system service with a D-Bus interface to manage the color profiles of input and output devices such as screens and scanners. It is notably used by the GNOME Color Manager graphical tool. See @uref{http://www.freedesktop.org/software/colord/, the colord web site} for more information." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13081 +#, no-wrap +msgid "{Scheme Procedure} geoclue-application name [#:allowed? #t] [#:system? #f] [#:users '()]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13090 +msgid "Return a configuration allowing an application to access GeoClue location data. @var{name} is the Desktop ID of the application, without the @code{.desktop} part. If @var{allowed?} is true, the application will have access to location information by default. The boolean @var{system?} value indicates whether an application is a system component or not. Finally @var{users} is a list of UIDs of all users for which this application is allowed location info access. An empty users list means that all users are allowed." +msgstr "" + +#. type: defvr +#: doc/guix.texi:13092 +#, no-wrap +msgid "{Scheme Variable} %standard-geoclue-applications" +msgstr "" + +#. type: defvr +#: doc/guix.texi:13099 +msgid "The standard list of well-known GeoClue application configurations, granting authority to the GNOME date-and-time utility to ask for the current location in order to set the time zone, and allowing the IceCat and Epiphany web browsers to request location information. IceCat and Epiphany both query the user before allowing a web page to know the user's location." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13101 +#, no-wrap +msgid "{Scheme Procedure} geoclue-service [#:colord @var{colord}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13114 +msgid "[#:whitelist '()] @ [#:wifi-geolocation-url \"https://location.services.mozilla.com/v1/geolocate?key=geoclue\"] @ [#:submit-data? #f] [#:wifi-submission-url \"https://location.services.mozilla.com/v1/submit?key=geoclue\"] @ [#:submission-nick \"geoclue\"] @ [#:applications %standard-geoclue-applications] Return a service that runs the GeoClue location service. This service provides a D-Bus interface to allow applications to request access to a user's physical location, and optionally to add information to online location databases. See @uref{https://wiki.freedesktop.org/www/Software/GeoClue/, the GeoClue web site} for more information." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13116 +#, no-wrap +msgid "{Scheme Procedure} bluetooth-service [#:bluez @var{bluez}] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13123 +msgid "[@w{#:auto-enable? #f}] Return a service that runs the @command{bluetoothd} daemon, which manages all the Bluetooth devices and provides a number of D-Bus interfaces. When AUTO-ENABLE? is true, the bluetooth controller is powered automatically at boot, which can be useful when using a bluetooth keyboard or mouse." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13125 +msgid "Users need to be in the @code{lp} group to access the D-Bus service." +msgstr "" + +#. type: cindex +#: doc/guix.texi:13130 +#, no-wrap +msgid "sound support" +msgstr "" + +#. type: cindex +#: doc/guix.texi:13131 +#, no-wrap +msgid "ALSA" +msgstr "" + +#. type: cindex +#: doc/guix.texi:13132 +#, no-wrap +msgid "PulseAudio, sound support" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13139 +msgid "The @code{(gnu services sound)} module provides an @code{alsa-service-type} service to generate an ALSA @file{/etc/asound.conf} configuration file. This configuration file is what allows applications that produce sound using ALSA to be correctly handled." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13140 +#, no-wrap +msgid "{Scheme Variable} alsa-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13143 +msgid "This is the type for the @uref{https://alsa-project.org/, ALSA}, @command{alsa-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:13146 +#, no-wrap +msgid "(service alsa-service-type)\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13149 +msgid "See below for details about @code{alsa-configuration}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:13151 +#, no-wrap +msgid "{Data Type} alsa-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13153 +msgid "Data type representing the configuration for @code{alsa-service}." +msgstr "" + +#. type: item +#: doc/guix.texi:13155 +#, no-wrap +msgid "@code{pulseaudio?} (default: @var{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:13158 +msgid "Whether ALSA applications should transparently be made to use the @uref{http://www.pulseaudio.org/, PulseAudio} sound server." +msgstr "" + +#. type: table +#: doc/guix.texi:13162 +msgid "Using PulseAudio allows you to run several sound-producing applications at the same time and to individual control them @i{via} @command{pavucontrol}, among other things." +msgstr "" + +#. type: item +#: doc/guix.texi:13163 +#, no-wrap +msgid "@code{extra-options} (default: @var{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:13165 +msgid "String to append to the @file{asound.conf} file." +msgstr "" + +#. type: cindex +#: doc/guix.texi:13173 +#, no-wrap +msgid "SQL" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13175 +msgid "The @code{(gnu services databases)} module provides the following services." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13176 +#, no-wrap +msgid "{Scheme Procedure} postgresql-service [#:postgresql postgresql] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13181 +msgid "[#:config-file] [#:data-directory ``/var/lib/postgresql/data''] @ [#:port 5432] [#:locale ``en_US.utf8''] Return a service that runs @var{postgresql}, the PostgreSQL database server." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13185 +msgid "The PostgreSQL daemon loads its runtime configuration from @var{config-file}, creates a database cluster with @var{locale} as the default locale, stored in @var{data-directory}. It then listens on @var{port}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13187 +#, no-wrap +msgid "{Scheme Procedure} mysql-service [#:config (mysql-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13190 +msgid "Return a service that runs @command{mysqld}, the MySQL or MariaDB database server." +msgstr "" + +#. type: deffn +#: doc/guix.texi:13193 +msgid "The optional @var{config} argument specifies the configuration for @command{mysqld}, which should be a @code{<mysql-configuration>} object." +msgstr "" + +#. type: deftp +#: doc/guix.texi:13195 +#, no-wrap +msgid "{Data Type} mysql-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13197 +msgid "Data type representing the configuration of @var{mysql-service}." +msgstr "" + +#. type: item +#: doc/guix.texi:13199 +#, no-wrap +msgid "@code{mysql} (default: @var{mariadb})" +msgstr "" + +#. type: table +#: doc/guix.texi:13202 +msgid "Package object of the MySQL database server, can be either @var{mariadb} or @var{mysql}." +msgstr "" + +#. type: table +#: doc/guix.texi:13205 +msgid "For MySQL, a temporary root password will be displayed at activation time. For MariaDB, the root password is empty." +msgstr "" + +#. type: item +#: doc/guix.texi:13206 +#, no-wrap +msgid "@code{port} (default: @code{3306})" +msgstr "" + +#. type: table +#: doc/guix.texi:13208 +msgid "TCP port on which the database server listens for incoming connections." +msgstr "" + +#. type: defvr +#: doc/guix.texi:13211 +#, no-wrap +msgid "{Scheme Variable} memcached-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:13215 +msgid "This is the service type for the @uref{https://memcached.org/, Memcached} service, which provides a distributed in memory cache. The value for the service type is a @code{memcached-configuration} object." +msgstr "" + +#. type: example +#: doc/guix.texi:13219 +#, no-wrap +msgid "(service memcached-service-type)\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13221 +#, no-wrap +msgid "{Data Type} memcached-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13223 +msgid "Data type representing the configuration of memcached." +msgstr "" + +#. type: item +#: doc/guix.texi:13225 +#, no-wrap +msgid "@code{memcached} (default: @code{memcached})" +msgstr "" + +#. type: table +#: doc/guix.texi:13227 +msgid "The Memcached package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:13228 +#, no-wrap +msgid "@code{interfaces} (default: @code{'(\"0.0.0.0\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:13230 +msgid "Network interfaces on which to listen." +msgstr "" + +#. type: item +#: doc/guix.texi:13231 +#, no-wrap +msgid "@code{tcp-port} (default: @code{11211})" +msgstr "" + +#. type: table +#: doc/guix.texi:13233 +msgid "Port on which to accept connections on," +msgstr "" + +#. type: item +#: doc/guix.texi:13234 +#, no-wrap +msgid "@code{udp-port} (default: @code{11211})" +msgstr "" + +#. type: table +#: doc/guix.texi:13237 +msgid "Port on which to accept UDP connections on, a value of 0 will disable listening on a UDP socket." +msgstr "" + +#. type: item +#: doc/guix.texi:13238 +#, no-wrap +msgid "@code{additional-options} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:13240 +msgid "Additional command line options to pass to @code{memcached}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:13243 +#, no-wrap +msgid "{Scheme Variable} mongodb-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:13246 +msgid "This is the service type for @uref{https://www.mongodb.com/, MongoDB}. The value for the service type is a @code{mongodb-configuration} object." +msgstr "" + +#. type: example +#: doc/guix.texi:13250 +#, no-wrap +msgid "(service mongodb-service-type)\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13252 +#, no-wrap +msgid "{Data Type} mongodb-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13254 +msgid "Data type representing the configuration of mongodb." +msgstr "" + +#. type: item +#: doc/guix.texi:13256 +#, no-wrap +msgid "@code{mongodb} (default: @code{mongodb})" +msgstr "" + +#. type: table +#: doc/guix.texi:13258 +msgid "The MongoDB package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:13259 +#, no-wrap +msgid "@code{config-file} (default: @code{%default-mongodb-configuration-file})" +msgstr "" + +#. type: table +#: doc/guix.texi:13261 +msgid "The configuration file for MongoDB." +msgstr "" + +#. type: item +#: doc/guix.texi:13262 +#, no-wrap +msgid "@code{data-directory} (default: @code{\"/var/lib/mongodb\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:13266 +msgid "This value is used to create the directory, so that it exists and is owned by the mongodb user. It should match the data-directory which MongoDB is configured to use through the configuration file." +msgstr "" + +#. type: defvr +#: doc/guix.texi:13269 +#, no-wrap +msgid "{Scheme Variable} redis-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:13272 +msgid "This is the service type for the @uref{https://redis.io/, Redis} key/value store, whose value is a @code{redis-configuration} object." +msgstr "" + +#. type: deftp +#: doc/guix.texi:13274 +#, no-wrap +msgid "{Data Type} redis-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:13276 +msgid "Data type representing the configuration of redis." +msgstr "" + +#. type: item +#: doc/guix.texi:13278 +#, no-wrap +msgid "@code{redis} (default: @code{redis})" +msgstr "" + +#. type: table +#: doc/guix.texi:13280 +msgid "The Redis package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:13281 +#, no-wrap +msgid "@code{bind} (default: @code{\"127.0.0.1\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:13283 +msgid "Network interface on which to listen." +msgstr "" + +#. type: item +#: doc/guix.texi:13284 +#, no-wrap +msgid "@code{port} (default: @code{6379})" +msgstr "" + +#. type: table +#: doc/guix.texi:13287 +msgid "Port on which to accept connections on, a value of 0 will disable listening on a TCP socket." +msgstr "" + +#. type: item +#: doc/guix.texi:13288 +#, no-wrap +msgid "@code{working-directory} (default: @code{\"/var/lib/redis\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:13290 +msgid "Directory in which to store the database and related files." +msgstr "" + +#. type: cindex +#: doc/guix.texi:13296 +#, no-wrap +msgid "mail" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:13297 doc/guix.texi:16457 +#, no-wrap +msgid "email" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13302 +msgid "The @code{(gnu services mail)} module provides Guix service definitions for email services: IMAP, POP3, and LMTP servers, as well as mail transport agents (MTAs). Lots of acronyms! These services are detailed in the subsections below." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:13303 +#, no-wrap +msgid "Dovecot Service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13305 +#, no-wrap +msgid "{Scheme Procedure} dovecot-service [#:config (dovecot-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:13307 +msgid "Return a service that runs the Dovecot IMAP/POP3/LMTP mail server." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13317 +msgid "By default, Dovecot does not need much configuration; the default configuration object created by @code{(dovecot-configuration)} will suffice if your mail is delivered to @code{~/Maildir}. A self-signed certificate will be generated for TLS-protected connections, though Dovecot will also listen on cleartext ports by default. There are a number of options, though, which mail administrators might need to change, and as is the case with other services, Guix allows the system administrator to specify these parameters via a uniform Scheme interface." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13320 +msgid "For example, to specify that mail is located at @code{maildir~/.mail}, one would instantiate the Dovecot service like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:13325 +#, no-wrap +msgid "" +"(dovecot-service #:config\n" +" (dovecot-configuration\n" +" (mail-location \"maildir:~/.mail\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13333 +msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. There is also a way to specify the configuration as a string, if you have an old @code{dovecot.conf} file that you want to port over from some other system; see the end for more details." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:13343 +msgid "Available @code{dovecot-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13344 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} package dovecot" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13346 doc/guix.texi:14633 +msgid "The dovecot package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13348 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} comma-separated-string-list listen" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13354 +msgid "A list of IPs or hosts where to listen for connections. @samp{*} listens on all IPv4 interfaces, @samp{::} listens on all IPv6 interfaces. If you want to specify non-default ports or anything more complex, customize the address and port fields of the @samp{inet-listener} of the specific services you are interested in." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13356 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} protocol-configuration-list protocols" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13359 +msgid "List of protocols we want to serve. Available protocols include @samp{imap}, @samp{pop3}, and @samp{lmtp}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13361 +msgid "Available @code{protocol-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13362 +#, no-wrap +msgid "{@code{protocol-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13364 +msgid "The name of the protocol." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13366 +#, no-wrap +msgid "{@code{protocol-configuration} parameter} string auth-socket-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13370 +msgid "UNIX socket path to the master authentication server to find users. This is used by imap (for shared users) and lda. It defaults to @samp{\"/var/run/dovecot/auth-userdb\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13372 +#, no-wrap +msgid "{@code{protocol-configuration} parameter} space-separated-string-list mail-plugins" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13374 +msgid "Space separated list of plugins to load." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13376 +#, no-wrap +msgid "{@code{protocol-configuration} parameter} non-negative-integer mail-max-userip-connections" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13380 +msgid "Maximum number of IMAP connections allowed for a user from each IP address. NOTE: The username is compared case-sensitively. Defaults to @samp{10}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13384 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} service-configuration-list services" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13388 +msgid "List of services to enable. Available services include @samp{imap}, @samp{imap-login}, @samp{pop3}, @samp{pop3-login}, @samp{auth}, and @samp{lmtp}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13390 +msgid "Available @code{service-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13391 +#, no-wrap +msgid "{@code{service-configuration} parameter} string kind" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13396 +msgid "The service kind. Valid values include @code{director}, @code{imap-login}, @code{pop3-login}, @code{lmtp}, @code{imap}, @code{pop3}, @code{auth}, @code{auth-worker}, @code{dict}, @code{tcpwrap}, @code{quota-warning}, or anything else." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13398 +#, no-wrap +msgid "{@code{service-configuration} parameter} listener-configuration-list listeners" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13403 +msgid "Listeners for the service. A listener is either a @code{unix-listener-configuration}, a @code{fifo-listener-configuration}, or an @code{inet-listener-configuration}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13405 +msgid "Available @code{unix-listener-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13406 +#, no-wrap +msgid "{@code{unix-listener-configuration} parameter} string path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13409 doc/guix.texi:13432 +msgid "Path to the file, relative to @code{base-dir} field. This is also used as the section name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13411 +#, no-wrap +msgid "{@code{unix-listener-configuration} parameter} string mode" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13414 doc/guix.texi:13437 +msgid "The access mode for the socket. Defaults to @samp{\"0600\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13416 +#, no-wrap +msgid "{@code{unix-listener-configuration} parameter} string user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13419 doc/guix.texi:13442 +msgid "The user to own the socket. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13421 +#, no-wrap +msgid "{@code{unix-listener-configuration} parameter} string group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13424 doc/guix.texi:13447 +msgid "The group to own the socket. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13428 +msgid "Available @code{fifo-listener-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13429 +#, no-wrap +msgid "{@code{fifo-listener-configuration} parameter} string path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13434 +#, no-wrap +msgid "{@code{fifo-listener-configuration} parameter} string mode" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13439 +#, no-wrap +msgid "{@code{fifo-listener-configuration} parameter} string user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13444 +#, no-wrap +msgid "{@code{fifo-listener-configuration} parameter} string group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13451 +msgid "Available @code{inet-listener-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13452 +#, no-wrap +msgid "{@code{inet-listener-configuration} parameter} string protocol" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13454 +msgid "The protocol to listen for." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13456 +#, no-wrap +msgid "{@code{inet-listener-configuration} parameter} string address" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13459 +msgid "The address on which to listen, or empty for all addresses. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13461 +#, no-wrap +msgid "{@code{inet-listener-configuration} parameter} non-negative-integer port" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13463 +msgid "The port on which to listen." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13465 +#, no-wrap +msgid "{@code{inet-listener-configuration} parameter} boolean ssl?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13469 +msgid "Whether to use SSL for this service; @samp{yes}, @samp{no}, or @samp{required}. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13473 +#, no-wrap +msgid "{@code{service-configuration} parameter} non-negative-integer service-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13478 +msgid "Number of connections to handle before starting a new process. Typically the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 is faster. <doc/wiki/LoginProcess.txt>. Defaults to @samp{1}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13480 +#, no-wrap +msgid "{@code{service-configuration} parameter} non-negative-integer process-min-avail" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13483 +msgid "Number of processes to always keep waiting for more connections. Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13485 +#, no-wrap +msgid "{@code{service-configuration} parameter} non-negative-integer vsz-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13489 +msgid "If you set @samp{service-count 0}, you probably need to grow this. Defaults to @samp{256000000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13493 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} dict-configuration dict" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13496 +msgid "Dict configuration, as created by the @code{dict-configuration} constructor." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13498 +msgid "Available @code{dict-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13499 +#, no-wrap +msgid "{@code{dict-configuration} parameter} free-form-fields entries" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13502 +msgid "A list of key-value pairs that this dict should hold. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13506 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} passdb-configuration-list passdbs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13509 +msgid "A list of passdb configurations, each one created by the @code{passdb-configuration} constructor." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13511 +msgid "Available @code{passdb-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13512 +#, no-wrap +msgid "{@code{passdb-configuration} parameter} string driver" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13517 +msgid "The driver that the passdb should use. Valid values include @samp{pam}, @samp{passwd}, @samp{shadow}, @samp{bsdauth}, and @samp{static}. Defaults to @samp{\"pam\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13519 +#, no-wrap +msgid "{@code{passdb-configuration} parameter} space-separated-string-list args" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13522 +msgid "Space separated list of arguments to the passdb driver. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13526 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} userdb-configuration-list userdbs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13529 +msgid "List of userdb configurations, each one created by the @code{userdb-configuration} constructor." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13531 +msgid "Available @code{userdb-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13532 +#, no-wrap +msgid "{@code{userdb-configuration} parameter} string driver" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13536 +msgid "The driver that the userdb should use. Valid values include @samp{passwd} and @samp{static}. Defaults to @samp{\"passwd\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13538 +#, no-wrap +msgid "{@code{userdb-configuration} parameter} space-separated-string-list args" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13541 +msgid "Space separated list of arguments to the userdb driver. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13543 +#, no-wrap +msgid "{@code{userdb-configuration} parameter} free-form-args override-fields" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13546 +msgid "Override fields from passwd. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13550 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} plugin-configuration plugin-configuration" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13553 +msgid "Plug-in configuration, created by the @code{plugin-configuration} constructor." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13555 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} list-of-namespace-configuration namespaces" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13558 +msgid "List of namespaces. Each item in the list is created by the @code{namespace-configuration} constructor." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13560 +msgid "Available @code{namespace-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13561 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13563 +msgid "Name for this namespace." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13565 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} string type" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13568 +msgid "Namespace type: @samp{private}, @samp{shared} or @samp{public}. Defaults to @samp{\"private\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13570 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} string separator" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13576 +msgid "Hierarchy separator to use. You should use the same separator for all namespaces or some clients get confused. @samp{/} is usually a good one. The default however depends on the underlying mail storage format. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13578 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} string prefix" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13582 +msgid "Prefix required to access this namespace. This needs to be different for all namespaces. For example @samp{Public/}. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13584 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} string location" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13588 +msgid "Physical location of the mailbox. This is in the same format as mail_location, which is also the default for it. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13590 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} boolean inbox?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13594 +msgid "There can be only one INBOX, and this setting defines which namespace has it. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13596 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} boolean hidden?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13604 +msgid "If namespace is hidden, it's not advertised to clients via NAMESPACE extension. You'll most likely also want to set @samp{list? #f}. This is mostly useful when converting from another server with different namespaces which you want to deprecate but still keep working. For example you can create hidden namespaces with prefixes @samp{~/mail/}, @samp{~%u/mail/} and @samp{mail/}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13606 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} boolean list?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13612 +msgid "Show the mailboxes under this namespace with the LIST command. This makes the namespace visible for clients that do not support the NAMESPACE extension. The special @code{children} value lists child mailboxes, but hides the namespace prefix. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13614 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} boolean subscriptions?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13619 +msgid "Namespace handles its own subscriptions. If set to @code{#f}, the parent namespace handles them. The empty prefix should always have this as @code{#t}). Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13621 +#, no-wrap +msgid "{@code{namespace-configuration} parameter} mailbox-configuration-list mailboxes" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13624 +msgid "List of predefined mailboxes in this namespace. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13626 +msgid "Available @code{mailbox-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13627 +#, no-wrap +msgid "{@code{mailbox-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13629 +msgid "Name for this mailbox." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13631 +#, no-wrap +msgid "{@code{mailbox-configuration} parameter} string auto" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13635 +msgid "@samp{create} will automatically create this mailbox. @samp{subscribe} will both create and subscribe to the mailbox. Defaults to @samp{\"no\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13637 +#, no-wrap +msgid "{@code{mailbox-configuration} parameter} space-separated-string-list special-use" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13642 +msgid "List of IMAP @code{SPECIAL-USE} attributes as specified by RFC 6154. Valid values are @code{\\All}, @code{\\Archive}, @code{\\Drafts}, @code{\\Flagged}, @code{\\Junk}, @code{\\Sent}, and @code{\\Trash}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13648 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name base-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13651 +msgid "Base directory where to store runtime data. Defaults to @samp{\"/var/run/dovecot/\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13653 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string login-greeting" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13656 +msgid "Greeting message for clients. Defaults to @samp{\"Dovecot ready.\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13658 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-trusted-networks" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13665 +msgid "List of trusted network ranges. Connections from these IPs are allowed to override their IP addresses and ports (for logging and for authentication checks). @samp{disable-plaintext-auth} is also ignored for these networks. Typically you would specify your IMAP proxy servers here. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13667 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-access-sockets" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13670 +msgid "List of login access check sockets (e.g. tcpwrap). Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13672 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean verbose-proctitle?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13678 +msgid "Show more verbose process titles (in ps). Currently shows user name and IP address. Useful for seeing who is actually using the IMAP processes (e.g. shared mailboxes or if the same uid is used for multiple accounts). Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13680 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean shutdown-clients?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13686 +msgid "Should all processes be killed when Dovecot master process shuts down. Setting this to @code{#f} means that Dovecot can be upgraded without forcing existing client connections to close (although that could also be a problem if the upgrade is e.g. due to a security fix). Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13688 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer doveadm-worker-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13692 +msgid "If non-zero, run mail commands via this many connections to doveadm server, instead of running them directly in the same process. Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13694 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string doveadm-socket-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13697 +msgid "UNIX socket or host:port used for connecting to doveadm server. Defaults to @samp{\"doveadm-server\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13699 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list import-environment" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13703 +msgid "List of environment variables that are preserved on Dovecot startup and passed down to all of its child processes. You can also give key=value pairs to always set specific settings." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13705 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean disable-plaintext-auth?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13712 +msgid "Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP matches the local IP (i.e. you're connecting from the same computer), the connection is considered secure and plaintext authentication is allowed. See also ssl=required setting. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13714 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-cache-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13719 +msgid "Authentication cache size (e.g. @samp{#e10e6}). 0 means it's disabled. Note that bsdauth, PAM and vpopmail require @samp{cache-key} to be set for caching to be used. Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13721 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-cache-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13729 +msgid "Time to live for cached data. After TTL expires the cached record is no longer used, *except* if the main database lookup returns internal failure. We also try to handle password changes automatically: If user's previous authentication was successful, but this one wasn't, the cache isn't used. For now this works only with plaintext authentication. Defaults to @samp{\"1 hour\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13731 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-cache-negative-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13735 +msgid "TTL for negative hits (user not found, password mismatch). 0 disables caching them completely. Defaults to @samp{\"1 hour\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13737 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-realms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13743 +msgid "List of realms for SASL authentication mechanisms that need them. You can leave it empty if you don't want to support multiple realms. Many clients simply use the first one listed here, so keep the default realm first. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13745 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-default-realm" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13750 +msgid "Default realm/domain to use if none was specified. This is used for both SASL realms and appending @@domain to username in plaintext logins. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13752 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-username-chars" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13759 +msgid "List of allowed characters in username. If the user-given username contains a character not listed in here, the login automatically fails. This is just an extra check to make sure user can't exploit any potential quote escaping vulnerabilities with SQL/LDAP databases. If you want to allow all characters, set this value to empty. Defaults to @samp{\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@@\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13761 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-username-translation" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13767 +msgid "Username character translations before it's looked up from databases. The value contains series of from -> to characters. For example @samp{#@@/@@} means that @samp{#} and @samp{/} characters are translated to @samp{@@}. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13769 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-username-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13776 +msgid "Username formatting before it's looked up from databases. You can use the standard variables here, e.g. %Lu would lowercase the username, %n would drop away the domain if it was given, or @samp{%n-AT-%d} would change the @samp{@@} into @samp{-AT-}. This translation is done after @samp{auth-username-translation} changes. Defaults to @samp{\"%Lu\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13778 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-master-user-separator" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13786 +msgid "If you want to allow master users to log in by specifying the master username within the normal username string (i.e. not using SASL mechanism's support for it), you can specify the separator character here. The format is then <username><separator><master username>. UW-IMAP uses @samp{*} as the separator, so that could be a good choice. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13788 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-anonymous-username" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13792 +msgid "Username to use for users logging in with ANONYMOUS SASL mechanism. Defaults to @samp{\"anonymous\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13794 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer auth-worker-max-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13799 +msgid "Maximum number of dovecot-auth worker processes. They're used to execute blocking passdb and userdb queries (e.g. MySQL and PAM). They're automatically created and destroyed as needed. Defaults to @samp{30}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13801 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-gssapi-hostname" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13806 +msgid "Host name to use in GSSAPI principal names. The default is to use the name returned by gethostname(). Use @samp{$ALL} (with quotes) to allow all keytab entries. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13808 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-krb5-keytab" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13814 +msgid "Kerberos keytab to use for the GSSAPI mechanism. Will use the system default (usually @file{/etc/krb5.keytab}) if not specified. You may need to change the auth service to run as root to be able to read this file. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13816 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-use-winbind?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13821 +msgid "Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and @samp{ntlm-auth} helper. <doc/wiki/Authentication/Mechanisms/Winbind.txt>. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13823 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name auth-winbind-helper-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13826 +msgid "Path for Samba's @samp{ntlm-auth} helper binary. Defaults to @samp{\"/usr/bin/ntlm_auth\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13828 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string auth-failure-delay" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13831 +msgid "Time to delay before replying to failed authentications. Defaults to @samp{\"2 secs\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13833 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-require-client-cert?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13837 +msgid "Require a valid SSL client certificate or the authentication fails. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13839 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-ssl-username-from-cert?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13844 +msgid "Take the username from client's SSL certificate, using @code{X509_NAME_get_text_by_NID()} which returns the subject's DN's CommonName. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13846 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list auth-mechanisms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13852 +msgid "List of wanted authentication mechanisms. Supported mechanisms are: @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, @samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also @samp{disable-plaintext-auth} setting." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13854 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-servers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13859 +msgid "List of IPs or hostnames to all director servers, including ourself. Ports can be specified as ip:port. The default port is the same as what director service's @samp{inet-listener} is using. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13861 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list director-mail-servers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13865 +msgid "List of IPs or hostnames to all backend mail servers. Ranges are allowed too, like 10.0.0.10-10.0.0.30. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13867 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string director-user-expire" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13871 +msgid "How long to redirect users to a specific server after it no longer has any connections. Defaults to @samp{\"15 min\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13873 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string director-username-hash" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13878 +msgid "How the username is translated before being hashed. Useful values include %Ln if user can log in with or without @@domain, %Ld if mailboxes are shared within domain. Defaults to @samp{\"%Lu\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13880 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string log-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13884 +msgid "Log file to use for error messages. @samp{syslog} logs to syslog, @samp{/dev/stderr} logs to stderr. Defaults to @samp{\"syslog\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13886 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string info-log-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13890 +msgid "Log file to use for informational messages. Defaults to @samp{log-path}. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13892 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string debug-log-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13896 +msgid "Log file to use for debug messages. Defaults to @samp{info-log-path}. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13898 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string syslog-facility" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13903 +msgid "Syslog facility to use if you're logging to syslog. Usually if you don't want to use @samp{mail}, you'll use local0..local7. Also other standard facilities are supported. Defaults to @samp{\"mail\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13905 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13909 +msgid "Log unsuccessful authentication attempts and the reasons why they failed. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13911 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-verbose-passwords?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13918 +msgid "In case of password mismatches, log the attempted password. Valid values are no, plain and sha1. sha1 can be useful for detecting brute force password attempts vs. user simply trying the same password over and over again. You can also truncate the value to n chars by appending \":n\" (e.g. sha1:6). Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13920 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-debug?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13924 +msgid "Even more verbose logging for debugging purposes. Shows for example SQL queries. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13926 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean auth-debug-passwords?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13931 +msgid "In case of password mismatches, log the passwords and used scheme so the problem can be debugged. Enabling this also enables @samp{auth-debug}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13933 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mail-debug?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13937 +msgid "Enable mail process debugging. This can help you figure out why Dovecot isn't finding your mails. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13939 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean verbose-ssl?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13942 +msgid "Show protocol level SSL errors. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13944 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string log-timestamp" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13948 +msgid "Prefix for each line written to log file. % codes are in strftime(3) format. Defaults to @samp{\"\\\"%b %d %H:%M:%S \\\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13950 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list login-log-format-elements" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13954 +msgid "List of elements we want to log. The elements which have a non-empty variable value are joined together to form a comma-separated string." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13956 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string login-log-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13960 +msgid "Login log format. %s contains @samp{login-log-format-elements} string, %$ contains the data we want to log. Defaults to @samp{\"%$: %s\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13962 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-log-prefix" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13966 +msgid "Log prefix for mail processes. See doc/wiki/Variables.txt for list of possible variables you can use. Defaults to @samp{\"\\\"%s(%u)<%@{pid@}><%@{session@}>: \\\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13968 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string deliver-log-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13970 +msgid "Format to use for logging mail deliveries. You can use variables:" +msgstr "" + +#. type: item +#: doc/guix.texi:13971 +#, no-wrap +msgid "%$" +msgstr "" + +#. type: table +#: doc/guix.texi:13973 +msgid "Delivery status message (e.g. @samp{saved to INBOX})" +msgstr "" + +#. type: item +#: doc/guix.texi:13973 +#, no-wrap +msgid "%m" +msgstr "" + +#. type: table +#: doc/guix.texi:13975 +msgid "Message-ID" +msgstr "" + +#. type: item +#: doc/guix.texi:13975 doc/guix.texi:14507 +#, no-wrap +msgid "%s" +msgstr "" + +#. type: table +#: doc/guix.texi:13977 +msgid "Subject" +msgstr "" + +#. type: item +#: doc/guix.texi:13977 +#, no-wrap +msgid "%f" +msgstr "" + +#. type: table +#: doc/guix.texi:13979 +msgid "From address" +msgstr "" + +#. type: table +#: doc/guix.texi:13981 +msgid "Physical size" +msgstr "" + +#. type: item +#: doc/guix.texi:13981 +#, no-wrap +msgid "%w" +msgstr "" + +#. type: table +#: doc/guix.texi:13983 +msgid "Virtual size." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13985 +msgid "Defaults to @samp{\"msgid=%m: %$\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13987 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-location" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13992 +msgid "Location for users' mailboxes. The default is empty, which means that Dovecot tries to find the mailboxes automatically. This won't work if the user doesn't yet have any mail, so you should explicitly tell Dovecot the full location." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:13998 +msgid "If you're using mbox, giving a path to the INBOX file (e.g. /var/mail/%u) isn't enough. You'll also need to tell Dovecot where the other mailboxes are kept. This is called the \"root mail directory\", and it must be the first path given in the @samp{mail-location} setting." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14000 +msgid "There are a few special variables you can use, eg.:" +msgstr "" + +#. type: table +#: doc/guix.texi:14004 +msgid "username" +msgstr "" + +#. type: item +#: doc/guix.texi:14004 doc/guix.texi:14503 +#, no-wrap +msgid "%n" +msgstr "" + +#. type: table +#: doc/guix.texi:14006 +msgid "user part in user@@domain, same as %u if there's no domain" +msgstr "" + +#. type: item +#: doc/guix.texi:14006 +#, no-wrap +msgid "%d" +msgstr "" + +#. type: table +#: doc/guix.texi:14008 +msgid "domain part in user@@domain, empty if there's no domain" +msgstr "" + +#. type: item +#: doc/guix.texi:14008 +#, no-wrap +msgid "%h" +msgstr "" + +#. type: table +#: doc/guix.texi:14010 +msgid "home director" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14013 +msgid "See doc/wiki/Variables.txt for full list. Some examples:" +msgstr "" + +#. type: item +#: doc/guix.texi:14014 +#, no-wrap +msgid "maildir:~/Maildir" +msgstr "" + +#. type: item +#: doc/guix.texi:14015 +#, no-wrap +msgid "mbox:~/mail:INBOX=/var/mail/%u" +msgstr "" + +#. type: item +#: doc/guix.texi:14016 +#, no-wrap +msgid "mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14021 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-uid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14026 +msgid "System user and group used to access mails. If you use multiple, userdb can override these by returning uid or gid fields. You can use either numbers or names. <doc/wiki/UserIds.txt>. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14028 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-gid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14033 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-privileged-group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14039 +msgid "Group to enable temporarily for privileged operations. Currently this is used only with INBOX when either its initial creation or dotlocking fails. Typically this is set to \"mail\" to give access to /var/mail. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14041 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-access-groups" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14049 +msgid "Grant access to these supplementary groups for mail processes. Typically these are used to set up access to shared mailboxes. Note that it may be dangerous to set these if users can create symlinks (e.g. if \"mail\" group is set here, ln -s /var/mail ~/mail/var could allow a user to delete others' mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it). Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14051 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mail-full-filesystem-access?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14057 +msgid "Allow full file system access to clients. There's no access checks other than what the operating system does for the active UID/GID. It works with both maildir and mboxes, allowing you to prefix mailboxes names with e.g. /path/ or ~user/. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14059 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mmap-disable?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14063 +msgid "Don't use mmap() at all. This is required if you store indexes to shared file systems (NFS or clustered file system). Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14065 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean dotlock-use-excl?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14070 +msgid "Rely on @samp{O_EXCL} to work when creating dotlock files. NFS supports @samp{O_EXCL} since version 3, so this should be safe to use nowadays by default. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14072 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-fsync" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14074 +msgid "When to use fsync() or fdatasync() calls:" +msgstr "" + +#. type: item +#: doc/guix.texi:14075 +#, no-wrap +msgid "optimized" +msgstr "" + +#. type: table +#: doc/guix.texi:14077 +msgid "Whenever necessary to avoid losing important data" +msgstr "" + +#. type: table +#: doc/guix.texi:14079 +msgid "Useful with e.g. NFS when write()s are delayed" +msgstr "" + +#. type: table +#: doc/guix.texi:14081 +msgid "Never use it (best performance, but crashes can lose data)." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14083 +msgid "Defaults to @samp{\"optimized\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14085 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-storage?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14090 +msgid "Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS caches whenever needed. If you're using only a single mail server this isn't needed. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14092 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mail-nfs-index?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14096 +msgid "Mail index files also exist in NFS. Setting this to yes requires @samp{mmap-disable? #t} and @samp{fsync-disable? #f}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14098 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string lock-method" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14104 +msgid "Locking method for index files. Alternatives are fcntl, flock and dotlock. Dotlocking uses some tricks which may create more disk I/O than other locking methods. NFS users: flock doesn't work, remember to change @samp{mmap-disable}. Defaults to @samp{\"fcntl\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14106 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name mail-temp-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14110 +msgid "Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. Defaults to @samp{\"/tmp\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14112 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-uid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14118 +msgid "Valid UID range for users. This is mostly to make sure that users can't log in as daemons or other system users. Note that denying root logins is hardcoded to dovecot binary and can't be done even if @samp{first-valid-uid} is set to 0. Defaults to @samp{500}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14120 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-uid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14125 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer first-valid-gid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14130 +msgid "Valid GID range for users. Users having non-valid GID as primary group ID aren't allowed to log in. If user belongs to supplementary groups with non-valid GIDs, those groups are not set. Defaults to @samp{1}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14132 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer last-valid-gid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14137 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-max-keyword-length" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14141 +msgid "Maximum allowed length for mail keyword name. It's only forced when trying to create new keywords. Defaults to @samp{50}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14143 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} colon-separated-file-name-list valid-chroot-dirs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14153 +msgid "List of directories under which chrooting is allowed for mail processes (i.e. /var/mail will allow chrooting to /var/mail/foo/bar too). This setting doesn't affect @samp{login-chroot} @samp{mail-chroot} or auth chroot settings. If this setting is empty, \"/./\" in home dirs are ignored. WARNING: Never add directories here which local users can modify, that may lead to root exploit. Usually this should be done only if you don't allow shell access for users. <doc/wiki/Chrooting.txt>. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14155 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-chroot" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14164 +msgid "Default chroot directory for mail processes. This can be overridden for specific users in user database by giving /./ in user's home directory (e.g. /home/./user chroots into /home). Note that usually there is no real need to do chrooting, Dovecot doesn't allow users to access files outside their mail directory anyway. If your home directories are prefixed with the chroot directory, append \"/.\" to @samp{mail-chroot}. <doc/wiki/Chrooting.txt>. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14166 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name auth-socket-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14170 +msgid "UNIX socket path to master authentication server to find users. This is used by imap (for shared users) and lda. Defaults to @samp{\"/var/run/dovecot/auth-userdb\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14172 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name mail-plugin-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14175 +msgid "Directory where to look up mail plugins. Defaults to @samp{\"/usr/lib/dovecot\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14177 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mail-plugins" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14181 +msgid "List of plugins to load for all services. Plugins specific to IMAP, LDA, etc. are added to this list in their own .conf files. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14183 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-cache-min-mail-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14188 +msgid "The minimum number of mails in a mailbox before updates are done to cache file. This allows optimizing Dovecot's behavior to do less disk writes at the cost of more disk reads. Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14190 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mailbox-idle-check-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14197 +msgid "When IDLE command is running, mailbox is checked once in a while to see if there are any new mails or other changes. This setting defines the minimum time to wait between those checks. Dovecot can also use dnotify, inotify and kqueue to find out immediately when changes occur. Defaults to @samp{\"30 secs\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14199 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mail-save-crlf?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14206 +msgid "Save mails with CR+LF instead of plain LF. This makes sending those mails take less CPU, especially with sendfile() syscall with Linux and FreeBSD. But it also creates a bit more disk I/O which may just make it slower. Also note that if other software reads the mboxes/maildirs, they may handle the extra CRs wrong and cause problems. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14208 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean maildir-stat-dirs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14216 +msgid "By default LIST command returns all entries in maildir beginning with a dot. Enabling this option makes Dovecot return only entries which are directories. This is done by stat()ing each entry, so it causes more disk I/O. (For systems setting struct @samp{dirent->d_type} this check is free and it's done always regardless of this setting). Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14218 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean maildir-copy-with-hardlinks?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14223 +msgid "When copying a message, do it with hard links whenever possible. This makes the performance much better, and it's unlikely to have any side effects. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14225 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean maildir-very-dirty-syncs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14230 +msgid "Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only when its mtime changes unexpectedly or when we can't find the mail otherwise. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14232 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-read-locks" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14235 +msgid "Which locking methods to use for locking mbox. There are four available:" +msgstr "" + +#. type: item +#: doc/guix.texi:14237 +#, no-wrap +msgid "dotlock" +msgstr "" + +#. type: table +#: doc/guix.texi:14241 +msgid "Create <mailbox>.lock file. This is the oldest and most NFS-safe solution. If you want to use /var/mail/ like directory, the users will need write access to that directory." +msgstr "" + +#. type: item +#: doc/guix.texi:14241 +#, no-wrap +msgid "dotlock-try" +msgstr "" + +#. type: table +#: doc/guix.texi:14244 +msgid "Same as dotlock, but if it fails because of permissions or because there isn't enough disk space, just skip it." +msgstr "" + +#. type: item +#: doc/guix.texi:14244 +#, no-wrap +msgid "fcntl" +msgstr "" + +#. type: table +#: doc/guix.texi:14246 +msgid "Use this if possible. Works with NFS too if lockd is used." +msgstr "" + +#. type: item +#: doc/guix.texi:14246 +#, no-wrap +msgid "flock" +msgstr "" + +#. type: table +#: doc/guix.texi:14248 doc/guix.texi:14250 +msgid "May not exist in all systems. Doesn't work with NFS." +msgstr "" + +#. type: item +#: doc/guix.texi:14248 +#, no-wrap +msgid "lockf" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14256 +msgid "You can use multiple locking methods; if you do the order they're declared in is important to avoid deadlocks if other MTAs/MUAs are using multiple locking methods as well. Some operating systems don't allow using some of them simultaneously." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14258 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list mbox-write-locks" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14262 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mbox-lock-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14265 +msgid "Maximum time to wait for lock (all of them) before aborting. Defaults to @samp{\"5 mins\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14267 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mbox-dotlock-change-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14271 +msgid "If dotlock exists but the mailbox isn't modified in any way, override the lock file after this much time. Defaults to @samp{\"2 mins\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14273 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mbox-dirty-syncs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14284 +msgid "When mbox changes unexpectedly we have to fully read it to find out what changed. If the mbox is large this can take a long time. Since the change is usually just a newly appended mail, it'd be faster to simply read the new mails. If this setting is enabled, Dovecot does this but still safely fallbacks to re-reading the whole mbox file whenever something in mbox isn't how it's expected to be. The only real downside to this setting is that if some other MUA changes message flags, Dovecot doesn't notice it immediately. Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK commands. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14286 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mbox-very-dirty-syncs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14291 +msgid "Like @samp{mbox-dirty-syncs}, but don't do full syncs even with SELECT, EXAMINE, EXPUNGE or CHECK commands. If this is set, @samp{mbox-dirty-syncs} is ignored. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14293 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mbox-lazy-writes?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14299 +msgid "Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK commands and when closing the mailbox). This is especially useful for POP3 where clients often delete all mails. The downside is that our changes aren't immediately visible to other MUAs. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14301 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer mbox-min-index-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14306 +msgid "If mbox size is smaller than this (e.g. 100k), don't write index files. If an index file already exists it's still read, just not updated. Defaults to @samp{0}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14308 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer mdbox-rotate-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14311 +msgid "Maximum dbox file size until it's rotated. Defaults to @samp{10000000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14313 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mdbox-rotate-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14318 +msgid "Maximum dbox file age until it's rotated. Typically in days. Day begins from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. Defaults to @samp{\"1d\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14320 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean mdbox-preallocate-space?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14325 +msgid "When creating new mdbox files, immediately preallocate their size to @samp{mdbox-rotate-size}. This setting currently works only in Linux with some file systems (ext4, xfs). Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14327 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-attachment-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14331 +msgid "sdbox and mdbox support saving mail attachments to external files, which also allows single instance storage for them. Other backends don't support this for now." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14333 +msgid "WARNING: This feature hasn't been tested much yet. Use at your own risk." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14336 +msgid "Directory root where to store mail attachments. Disabled, if empty. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14338 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer mail-attachment-min-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14343 +msgid "Attachments smaller than this aren't saved externally. It's also possible to write a plugin to disable saving specific attachments externally. Defaults to @samp{128000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14345 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-attachment-fs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14347 +msgid "File system backend to use for saving attachments:" +msgstr "" + +#. type: item +#: doc/guix.texi:14348 +#, no-wrap +msgid "posix" +msgstr "" + +#. type: table +#: doc/guix.texi:14350 +msgid "No SiS done by Dovecot (but this might help FS's own deduplication)" +msgstr "" + +#. type: item +#: doc/guix.texi:14350 +#, no-wrap +msgid "sis posix" +msgstr "" + +#. type: table +#: doc/guix.texi:14352 +msgid "SiS with immediate byte-by-byte comparison during saving" +msgstr "" + +#. type: item +#: doc/guix.texi:14352 +#, no-wrap +msgid "sis-queue posix" +msgstr "" + +#. type: table +#: doc/guix.texi:14354 +msgid "SiS with delayed comparison and deduplication." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14356 +msgid "Defaults to @samp{\"sis posix\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14358 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string mail-attachment-hash" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14364 +msgid "Hash format to use in attachment filenames. You can add any text and variables: @code{%@{md4@}}, @code{%@{md5@}}, @code{%@{sha1@}}, @code{%@{sha256@}}, @code{%@{sha512@}}, @code{%@{size@}}. Variables can be truncated, e.g. @code{%@{sha256:80@}} returns only first 80 bits. Defaults to @samp{\"%@{sha1@}\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14366 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-process-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14371 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-client-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14374 doc/guix.texi:18402 +msgid "Defaults to @samp{1000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14376 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer default-vsz-limit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14381 +msgid "Default VSZ (virtual memory size) limit for service processes. This is mainly intended to catch and kill processes that leak memory before they eat up everything. Defaults to @samp{256000000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14383 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string default-login-user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14388 +msgid "Login user is internally used by login processes. This is the most untrusted user in Dovecot system. It shouldn't have access to anything at all. Defaults to @samp{\"dovenull\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14390 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string default-internal-user" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14395 +msgid "Internal user is used by unprivileged processes. It should be separate from login user, so that login processes can't disturb other processes. Defaults to @samp{\"dovecot\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14397 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14400 +msgid "SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>. Defaults to @samp{\"required\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14402 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-cert" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14405 +msgid "PEM encoded X.509 SSL/TLS certificate (public key). Defaults to @samp{\"</etc/dovecot/default.pem\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14407 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-key" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14412 +msgid "PEM encoded SSL/TLS private key. The key is opened before dropping root privileges, so keep the key file unreadable by anyone but root. Defaults to @samp{\"</etc/dovecot/private/default.pem\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14414 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-key-password" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14420 +msgid "If key file is password protected, give the password here. Alternatively give it when starting dovecot with -p parameter. Since this file is often world-readable, you may want to place this setting instead to a different. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14422 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-ca" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14428 +msgid "PEM encoded trusted certificate authority. Set this only if you intend to use @samp{ssl-verify-client-cert? #t}. The file should contain the CA certificate(s) followed by the matching CRL(s). (e.g. @samp{ssl-ca </etc/ssl/certs/ca.pem}). Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14430 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean ssl-require-crl?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14433 +msgid "Require that CRL check succeeds for client certificates. Defaults to @samp{#t}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14435 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean ssl-verify-client-cert?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14439 +msgid "Request client to send a certificate. If you also want to require it, set @samp{auth-ssl-require-client-cert? #t} in auth section. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14441 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-cert-username-field" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14446 +msgid "Which field from certificate to use for username. commonName and x500UniqueIdentifier are the usual choices. You'll also need to set @samp{auth-ssl-username-from-cert? #t}. Defaults to @samp{\"commonName\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14448 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-min-protocol" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14451 +msgid "Minimum SSL protocol version to accept. Defaults to @samp{\"TLSv1\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14453 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-cipher-list" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14456 +msgid "SSL ciphers to use. Defaults to @samp{\"ALL:!kRSA:!SRP:!kDHd:!DSS:!aNULL:!eNULL:!EXPORT:!DES:!3DES:!MD5:!PSK:!RC4:!ADH:!LOW@@STRENGTH\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14458 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string ssl-crypto-device" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14461 +msgid "SSL crypto device to use, for valid values run \"openssl engine\". Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14463 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string postmaster-address" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14467 +msgid "Address to use when sending rejection mails. %d expands to recipient domain. Defaults to @samp{\"postmaster@@%d\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14469 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string hostname" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14473 +msgid "Hostname to use in various parts of sent mails (e.g. in Message-Id) and in LMTP replies. Default is the system's real hostname@@domain. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14475 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean quota-full-tempfail?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14479 +msgid "If user is over quota, return with temporary failure instead of bouncing the mail. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14481 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} file-name sendmail-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14484 +msgid "Binary to use for sending mails. Defaults to @samp{\"/usr/sbin/sendmail\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14486 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string submission-host" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14490 +msgid "If non-empty, send mails via this SMTP host[:port] instead of sendmail. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14492 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string rejection-subject" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14496 +msgid "Subject: header to use for rejection mails. You can use the same variables as for @samp{rejection-reason} below. Defaults to @samp{\"Rejected: %s\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14498 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string rejection-reason" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14501 +msgid "Human readable error message for rejection mails. You can use variables:" +msgstr "" + +#. type: table +#: doc/guix.texi:14505 +msgid "CRLF" +msgstr "" + +#. type: item +#: doc/guix.texi:14505 +#, no-wrap +msgid "%r" +msgstr "" + +#. type: table +#: doc/guix.texi:14507 +msgid "reason" +msgstr "" + +#. type: table +#: doc/guix.texi:14509 +msgid "original subject" +msgstr "" + +#. type: item +#: doc/guix.texi:14509 +#, no-wrap +msgid "%t" +msgstr "" + +#. type: table +#: doc/guix.texi:14511 +msgid "recipient" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14513 +msgid "Defaults to @samp{\"Your message to <%t> was automatically rejected:%n%r\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14515 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string recipient-delimiter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14519 +msgid "Delimiter character between local-part and detail in email address. Defaults to @samp{\"+\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14521 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string lda-original-recipient-header" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14527 +msgid "Header where the original recipient address (SMTP's RCPT TO: address) is taken from if not available elsewhere. With dovecot-lda -a parameter overrides this. A commonly used header for this is X-Original-To. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14529 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autocreate?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14533 +msgid "Should saving a mail to a nonexistent mailbox automatically create it?. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14535 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} boolean lda-mailbox-autosubscribe?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14539 +msgid "Should automatically created mailboxes be also automatically subscribed?. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14541 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} non-negative-integer imap-max-line-length" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14547 +msgid "Maximum IMAP command line length. Some clients generate very long command lines with huge mailboxes, so you may need to raise this if you get \"Too long argument\" or \"IMAP command line too large\" errors often. Defaults to @samp{64000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14549 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-logout-format" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14551 +msgid "IMAP logout format string:" +msgstr "" + +#. type: item +#: doc/guix.texi:14552 +#, no-wrap +msgid "%i" +msgstr "" + +#. type: table +#: doc/guix.texi:14554 +msgid "total number of bytes read from client" +msgstr "" + +#. type: item +#: doc/guix.texi:14554 +#, no-wrap +msgid "%o" +msgstr "" + +#. type: table +#: doc/guix.texi:14556 +msgid "total number of bytes sent to client." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14559 +msgid "See @file{doc/wiki/Variables.txt} for a list of all the variables you can use. Defaults to @samp{\"in=%i out=%o deleted=%@{deleted@} expunged=%@{expunged@} trashed=%@{trashed@} hdr_count=%@{fetch_hdr_count@} hdr_bytes=%@{fetch_hdr_bytes@} body_count=%@{fetch_body_count@} body_bytes=%@{fetch_body_bytes@}\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14561 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-capability" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14565 +msgid "Override the IMAP CAPABILITY response. If the value begins with '+', add the given capabilities on top of the defaults (e.g. +XFOO XBAR). Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14567 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-idle-notify-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14571 +msgid "How long to wait between \"OK Still here\" notifications when client is IDLEing. Defaults to @samp{\"2 mins\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14573 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-id-send" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14579 +msgid "ID field names and values to send to clients. Using * as the value makes Dovecot use the default value. The following fields have default values currently: name, version, os, os-version, support-url, support-email. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14581 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-id-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14584 +msgid "ID fields sent by client to log. * means everything. Defaults to @samp{\"\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14586 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} space-separated-string-list imap-client-workarounds" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14588 +msgid "Workarounds for various client bugs:" +msgstr "" + +#. type: item +#: doc/guix.texi:14590 +#, no-wrap +msgid "delay-newmail" +msgstr "" + +#. type: table +#: doc/guix.texi:14597 +msgid "Send EXISTS/RECENT new mail notifications only when replying to NOOP and CHECK commands. Some clients ignore them otherwise, for example OSX Mail (<v2.1). Outlook Express breaks more badly though, without this it may show user \"Message no longer in server\" errors. Note that OE6 still breaks even with this workaround if synchronization is set to \"Headers Only\"." +msgstr "" + +#. type: item +#: doc/guix.texi:14598 +#, no-wrap +msgid "tb-extra-mailbox-sep" +msgstr "" + +#. type: table +#: doc/guix.texi:14602 +msgid "Thunderbird gets somehow confused with LAYOUT=fs (mbox and dbox) and adds extra @samp{/} suffixes to mailbox names. This option causes Dovecot to ignore the extra @samp{/} instead of treating it as invalid mailbox name." +msgstr "" + +#. type: item +#: doc/guix.texi:14603 +#, no-wrap +msgid "tb-lsub-flags" +msgstr "" + +#. type: table +#: doc/guix.texi:14607 +msgid "Show \\Noselect flags for LSUB replies with LAYOUT=fs (e.g. mbox). This makes Thunderbird realize they aren't selectable and show them greyed out, instead of only later giving \"not selectable\" popup error." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14611 +#, no-wrap +msgid "{@code{dovecot-configuration} parameter} string imap-urlauth-host" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14614 +msgid "Host allowed in URLAUTH URLs sent by client. \"*\" allows all. Defaults to @samp{\"\"}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14622 +msgid "Whew! Lots of configuration options. The nice thing about it though is that GuixSD has a complete interface to Dovecot's configuration language. This allows not only a nice way to declare configurations, but also offers reflective capabilities as well: users can write code to inspect and transform configurations from within Scheme." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14628 +msgid "However, it could be that you just want to get a @code{dovecot.conf} up and running. In that case, you can pass an @code{opaque-dovecot-configuration} as the @code{#:config} parameter to @code{dovecot-service}. As its name indicates, an opaque configuration does not have easy reflective capabilities." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14630 +msgid "Available @code{opaque-dovecot-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14631 +#, no-wrap +msgid "{@code{opaque-dovecot-configuration} parameter} package dovecot" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14635 +#, no-wrap +msgid "{@code{opaque-dovecot-configuration} parameter} string string" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14637 +msgid "The contents of the @code{dovecot.conf}, as a string." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14641 +msgid "For example, if your @code{dovecot.conf} is just the empty string, you could instantiate a dovecot service like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:14646 +#, no-wrap +msgid "" +"(dovecot-service #:config\n" +" (opaque-dovecot-configuration\n" +" (string \"\")))\n" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:14648 +#, no-wrap +msgid "OpenSMTPD Service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14650 +#, no-wrap +msgid "{Scheme Variable} opensmtpd-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14654 +msgid "This is the type of the @uref{https://www.opensmtpd.org, OpenSMTPD} service, whose value should be an @code{opensmtpd-configuration} object as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:14659 +#, no-wrap +msgid "" +"(service opensmtpd-service-type\n" +" (opensmtpd-configuration\n" +" (config-file (local-file \"./my-smtpd.conf\"))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:14662 +#, no-wrap +msgid "{Data Type} opensmtpd-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:14664 +msgid "Data type representing the configuration of opensmtpd." +msgstr "" + +#. type: item +#: doc/guix.texi:14666 +#, no-wrap +msgid "@code{package} (default: @var{opensmtpd})" +msgstr "" + +#. type: table +#: doc/guix.texi:14668 +msgid "Package object of the OpenSMTPD SMTP server." +msgstr "" + +#. type: item +#: doc/guix.texi:14669 +#, no-wrap +msgid "@code{config-file} (default: @var{%default-opensmtpd-file})" +msgstr "" + +#. type: table +#: doc/guix.texi:14674 +msgid "File-like object of the OpenSMTPD configuration file to use. By default it listens on the loopback network interface, and allows for mail from users and daemons on the local machine, as well as permitting email to remote servers. Run @command{man smtpd.conf} for more information." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:14678 +#, no-wrap +msgid "Exim Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14680 +#, no-wrap +msgid "mail transfer agent (MTA)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14681 +#, no-wrap +msgid "MTA (mail transfer agent)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14682 +#, no-wrap +msgid "SMTP" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14684 +#, no-wrap +msgid "{Scheme Variable} exim-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14688 +msgid "This is the type of the @uref{https://exim.org, Exim} mail transfer agent (MTA), whose value should be an @code{exim-configuration} object as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:14693 +#, no-wrap +msgid "" +"(service exim-service-type\n" +" (exim-configuration\n" +" (config-file (local-file \"./my-exim.conf\"))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14699 +msgid "In order to use an @code{exim-service-type} service you must also have a @code{mail-aliases-service-type} service present in your @code{operating-system} (even if it has no aliases)." +msgstr "" + +#. type: deftp +#: doc/guix.texi:14700 +#, no-wrap +msgid "{Data Type} exim-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:14702 +msgid "Data type representing the configuration of exim." +msgstr "" + +#. type: item +#: doc/guix.texi:14704 +#, no-wrap +msgid "@code{package} (default: @var{exim})" +msgstr "" + +#. type: table +#: doc/guix.texi:14706 +msgid "Package object of the Exim server." +msgstr "" + +#. type: table +#: doc/guix.texi:14713 +msgid "File-like object of the Exim configuration file to use. If its value is @code{#f} then use the default configuration file from the package provided in @code{package}. The resulting configuration file is loaded after setting the @code{exim_user} and @code{exim_group} configuration variables." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:14717 +#, no-wrap +msgid "Mail Aliases Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14719 +#, no-wrap +msgid "email aliases" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14720 +#, no-wrap +msgid "aliases, for email addresses" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14722 +#, no-wrap +msgid "{Scheme Variable} mail-aliases-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14725 +msgid "This is the type of the service which provides @code{/etc/aliases}, specifying how to deliver mail to users on this system." +msgstr "" + +#. type: example +#: doc/guix.texi:14730 +#, no-wrap +msgid "" +"(service mail-aliases-service-type\n" +" '((\"postmaster\" \"bob\")\n" +" (\"bob\" \"bob@@example.com\" \"bob@@example2.com\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14738 +msgid "The configuration for a @code{mail-aliases-service-type} service is an association list denoting how to deliver mail that comes to this system. Each entry is of the form @code{(alias addresses ...)}, with @code{alias} specifying the local alias and @code{addresses} specifying where to deliver this user's mail." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14744 +msgid "The aliases aren't required to exist as users on the local system. In the above example, there doesn't need to be a @code{postmaster} entry in the @code{operating-system}'s @code{user-accounts} in order to deliver the @code{postmaster} mail to @code{bob} (which subsequently would deliver mail to @code{bob@@example.com} and @code{bob@@example2.com})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:14748 +#, no-wrap +msgid "messaging" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14749 +#, no-wrap +msgid "jabber" +msgstr "" + +#. type: cindex +#: doc/guix.texi:14750 +#, no-wrap +msgid "XMPP" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14753 +msgid "The @code{(gnu services messaging)} module provides Guix service definitions for messaging services: currently only Prosody is supported." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:14754 +#, no-wrap +msgid "Prosody Service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14756 +#, no-wrap +msgid "{Scheme Variable} prosody-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14760 +msgid "This is the type for the @uref{https://prosody.im, Prosody XMPP communication server}. Its value must be a @code{prosody-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:14775 +#, no-wrap +msgid "" +"(service prosody-service-type\n" +" (prosody-configuration\n" +" (modules-enabled (cons \"groups\" \"mam\" %default-modules-enabled))\n" +" (int-components\n" +" (list\n" +" (int-component-configuration\n" +" (hostname \"conference.example.net\")\n" +" (plugin \"muc\")\n" +" (mod-muc (mod-muc-configuration)))))\n" +" (virtualhosts\n" +" (list\n" +" (virtualhost-configuration\n" +" (domain \"example.net\"))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:14778 +msgid "See below for details about @code{prosody-configuration}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14784 +msgid "By default, Prosody does not need much configuration. Only one @code{virtualhosts} field is needed: it specifies the domain you wish Prosody to serve." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14787 +msgid "You can perform various sanity checks on the generated configuration with the @code{prosodyctl check} command." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14791 +msgid "Prosodyctl will also help you to import certificates from the @code{letsencrypt} directory so that the @code{prosody} user can access them. See @url{https://prosody.im/doc/letsencrypt}." +msgstr "" + +#. type: example +#: doc/guix.texi:14794 +#, no-wrap +msgid "prosodyctl --root cert import /etc/letsencrypt/live\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14801 +msgid "The available configuration parameters follow. Each parameter definition is preceded by its type; for example, @samp{string-list foo} indicates that the @code{foo} parameter should be specified as a list of strings. Types starting with @code{maybe-} denote parameters that won't show up in @code{prosody.cfg.lua} when their value is @code{'disabled}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14805 +msgid "There is also a way to specify the configuration as a string, if you have an old @code{prosody.cfg.lua} file that you want to port over from some other system; see the end for more details." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14808 +msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a file name." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:14818 +msgid "Available @code{prosody-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14819 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} package prosody" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14821 +msgid "The Prosody package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14823 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} file-name data-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14827 +msgid "Location of the Prosody data storage directory. See @url{https://prosody.im/doc/configure}. Defaults to @samp{\"/var/lib/prosody\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14829 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} file-object-list plugin-paths" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14833 +msgid "Additional plugin directories. They are searched in all the specified paths in order. See @url{https://prosody.im/doc/plugins_directory}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14835 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} file-name certificates" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14840 +msgid "Every virtual host and component needs a certificate so that clients and servers can securely verify its identity. Prosody will automatically load certificates/keys from the directory specified here. Defaults to @samp{\"/etc/prosody/certs\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14842 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string-list admins" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14848 +msgid "This is a list of accounts that are admins for the server. Note that you must create the accounts separately. See @url{https://prosody.im/doc/admins} and @url{https://prosody.im/doc/creating_accounts}. Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))} Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14850 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} boolean use-libevent?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14854 +msgid "Enable use of libevent for better performance under high load. See @url{https://prosody.im/doc/libevent}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14856 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} module-list modules-enabled" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14862 +msgid "This is the list of modules Prosody will load on startup. It looks for @code{mod_modulename.lua} in the plugins folder, so make sure that exists too. Documentation on modules can be found at: @url{https://prosody.im/doc/modules}. Defaults to @samp{(\"roster\" \"saslauth\" \"tls\" \"dialback\" \"disco\" \"carbons\" \"private\" \"blocklist\" \"vcard\" \"version\" \"uptime\" \"time\" \"ping\" \"pep\" \"register\" \"admin_adhoc\")}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14864 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string-list modules-disabled" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14868 +msgid "@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but should you want to disable them then add them to this list. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14870 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} file-object groups-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14875 +msgid "Path to a text file where the shared groups are defined. If this path is empty then @samp{mod_groups} does nothing. See @url{https://prosody.im/doc/modules/mod_groups}. Defaults to @samp{\"/var/lib/prosody/sharedgroups.txt\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14877 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} boolean allow-registration?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14881 +msgid "Disable account creation by default, for security. See @url{https://prosody.im/doc/creating_accounts}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14883 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} maybe-ssl-configuration ssl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14888 +msgid "These are the SSL/TLS-related settings. Most of them are disabled so to use Prosody's defaults. If you do not completely understand these options, do not add them to your config, it is easy to lower the security of your server using them. See @url{https://prosody.im/doc/advanced_ssl_config}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14890 +msgid "Available @code{ssl-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14891 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string protocol" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14893 +msgid "This determines what handshake to use." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14895 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-file-name key" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14897 +msgid "Path to your private key file." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14899 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-file-name certificate" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14901 +msgid "Path to your certificate file." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14903 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} file-object capath" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14907 +msgid "Path to directory containing root certificates that you wish Prosody to trust when verifying the certificates of remote servers. Defaults to @samp{\"/etc/ssl/certs\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14909 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-file-object cafile" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14912 +msgid "Path to a file containing root certificates that you wish Prosody to trust. Similar to @code{capath} but with all certificates concatenated together." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14914 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string-list verify" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14917 +msgid "A list of verification options (these mostly map to OpenSSL's @code{set_verify()} flags)." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14919 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string-list options" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14923 +msgid "A list of general options relating to SSL/TLS. These map to OpenSSL's @code{set_options()}. For a full list of options available in LuaSec, see the LuaSec source." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14925 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-non-negative-integer depth" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14928 +msgid "How long a chain of certificate authorities to check when looking for a trusted root certificate." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14930 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string ciphers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14933 +msgid "An OpenSSL cipher string. This selects what ciphers Prosody will offer to clients, and in what order." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14935 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-file-name dhparam" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14939 +msgid "A path to a file containing parameters for Diffie-Hellman key exchange. You can create such a file with: @code{openssl dhparam -out /etc/prosody/certs/dh-2048.pem 2048}" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14941 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string curve" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14944 +msgid "Curve for Elliptic curve Diffie-Hellman. Prosody's default is @samp{\"secp384r1\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14946 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string-list verifyext" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14948 +msgid "A list of \"extra\" verification options." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14950 +#, no-wrap +msgid "{@code{ssl-configuration} parameter} maybe-string password" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14952 +msgid "Password for encrypted private keys." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14956 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} boolean c2s-require-encryption?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14960 +msgid "Whether to force all client-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14962 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string-list disable-sasl-mechanisms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14966 +msgid "Set of mechanisms that will never be offered. See @url{https://prosody.im/doc/modules/mod_saslauth}. Defaults to @samp{(\"DIGEST-MD5\")}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14968 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} boolean s2s-require-encryption?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14972 +msgid "Whether to force all server-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14974 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} boolean s2s-secure-auth?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14980 +msgid "Whether to require encryption and certificate authentication. This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14982 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string-list s2s-insecure-domains" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14988 +msgid "Many servers don't support encryption or have invalid or self-signed certificates. You can list domains here that will not be required to authenticate using certificates. They will be authenticated using DNS. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14990 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string-list s2s-secure-domains" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14995 +msgid "Even if you leave @code{s2s-secure-auth?} disabled, you can still require valid certificates for some domains by specifying a list here. See @url{https://prosody.im/doc/s2s#security}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:14997 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string authentication" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15005 +msgid "Select the authentication backend to use. The default provider stores passwords in plaintext and uses Prosody's configured data storage to store the authentication data. If you do not trust your server please see @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information about using the hashed backend. See also @url{https://prosody.im/doc/authentication} Defaults to @samp{\"internal_plain\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15007 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} maybe-string log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15011 +msgid "Set logging options. Advanced logging configuration is not yet supported by the GuixSD Prosody Service. See @url{https://prosody.im/doc/logging}. Defaults to @samp{\"*syslog\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15013 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} file-name pidfile" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15016 +msgid "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}. Defaults to @samp{\"/var/run/prosody/prosody.pid\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15018 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} maybe-non-negative-integer http-max-content-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15020 +msgid "Maximum allowed size of the HTTP body (in bytes)." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15022 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} maybe-string http-external-url" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15027 +msgid "Some modules expose their own URL in various ways. This URL is built from the protocol, host and port used. If Prosody sits behind a proxy, the public URL will be @code{http-external-url} instead. See @url{https://prosody.im/doc/http#external_url}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15029 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} virtualhost-configuration-list virtualhosts" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15034 +msgid "A host in Prosody is a domain on which user accounts can be created. For example if you want your users to have addresses like @samp{\"john.smith@@example.com\"} then you need to add a host @samp{\"example.com\"}. All options in this list will apply only to this host." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15040 +msgid "Note: the name \"virtual\" host is used in configuration to avoid confusion with the actual physical host that Prosody is installed on. A single Prosody instance can serve many domains, each one defined as a VirtualHost entry in Prosody's configuration. Conversely a server that hosts a single domain would have just one VirtualHost entry." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15042 +msgid "See @url{https://prosody.im/doc/configure#virtual_host_settings}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15044 +msgid "Available @code{virtualhost-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15046 doc/guix.texi:15068 doc/guix.texi:15121 +msgid "all these @code{prosody-configuration} fields: @code{admins}, @code{use-libevent?}, @code{modules-enabled}, @code{modules-disabled}, @code{groups-file}, @code{allow-registration?}, @code{ssl}, @code{c2s-require-encryption?}, @code{disable-sasl-mechanisms}, @code{s2s-require-encryption?}, @code{s2s-secure-auth?}, @code{s2s-insecure-domains}, @code{s2s-secure-domains}, @code{authentication}, @code{log}, @code{http-max-content-size}, @code{http-external-url}, @code{raw-content}, plus:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15046 +#, no-wrap +msgid "{@code{virtualhost-configuration} parameter} string domain" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15048 +msgid "Domain you wish Prosody to serve." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15052 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} int-component-configuration-list int-components" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15057 +msgid "Components are extra services on a server which are available to clients, usually on a subdomain of the main server (such as @samp{\"mycomponent.example.com\"}). Example components might be chatroom servers, user directories, or gateways to other protocols." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15061 +msgid "Internal components are implemented with Prosody-specific plugins. To add an internal component, you simply fill the hostname field, and the plugin you wish to use for the component." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15064 +msgid "See @url{https://prosody.im/doc/components}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15066 +msgid "Available @code{int-component-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15068 +#, no-wrap +msgid "{@code{int-component-configuration} parameter} string hostname" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15070 doc/guix.texi:15127 +msgid "Hostname of the component." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15072 +#, no-wrap +msgid "{@code{int-component-configuration} parameter} string plugin" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15074 +msgid "Plugin you wish to use for the component." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15076 +#, no-wrap +msgid "{@code{int-component-configuration} parameter} maybe-mod-muc-configuration mod-muc" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15079 +msgid "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15083 +msgid "General information on setting up and using multi-user chatrooms can be found in the \"Chatrooms\" documentation (@url{https://prosody.im/doc/chatrooms}), which you should read if you are new to XMPP chatrooms." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15085 +msgid "See also @url{https://prosody.im/doc/modules/mod_muc}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15087 +msgid "Available @code{mod-muc-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15088 +#, no-wrap +msgid "{@code{mod-muc-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15091 +msgid "The name to return in service discovery responses. Defaults to @samp{\"Prosody Chatrooms\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15093 +#, no-wrap +msgid "{@code{mod-muc-configuration} parameter} string-or-boolean restrict-room-creation" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15100 +msgid "If @samp{#t}, this will only allow admins to create new chatrooms. Otherwise anyone can create a room. The value @samp{\"local\"} restricts room creation to users on the service's parent domain. E.g. @samp{user@@example.com} can create rooms on @samp{rooms.example.com}. The value @samp{\"admin\"} restricts to service administrators only. Defaults to @samp{#f}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15102 +#, no-wrap +msgid "{@code{mod-muc-configuration} parameter} non-negative-integer max-history-messages" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15106 +msgid "Maximum number of history messages that will be sent to the member that has just joined the room. Defaults to @samp{20}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15112 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} ext-component-configuration-list ext-components" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15117 +msgid "External components use XEP-0114, which most standalone components support. To add an external component, you simply fill the hostname field. See @url{https://prosody.im/doc/components}. Defaults to @samp{()}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15119 +msgid "Available @code{ext-component-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15121 +#, no-wrap +msgid "{@code{ext-component-configuration} parameter} string component-secret" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15123 +msgid "Password which the component will use to log in." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15125 +#, no-wrap +msgid "{@code{ext-component-configuration} parameter} string hostname" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15131 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} non-negative-integer-list component-ports" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15134 +msgid "Port(s) Prosody listens on for component connections. Defaults to @samp{(5347)}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15136 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} string component-interface" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15139 +msgid "Interface Prosody listens on for component connections. Defaults to @samp{\"127.0.0.1\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15141 +#, no-wrap +msgid "{@code{prosody-configuration} parameter} maybe-raw-content raw-content" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15143 +msgid "Raw content that will be added to the configuration file." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15151 +msgid "It could be that you just want to get a @code{prosody.cfg.lua} up and running. In that case, you can pass an @code{opaque-prosody-configuration} record as the value of @code{prosody-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities. Available @code{opaque-prosody-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15152 +#, no-wrap +msgid "{@code{opaque-prosody-configuration} parameter} package prosody" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15154 +msgid "The prosody package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15156 +#, no-wrap +msgid "{@code{opaque-prosody-configuration} parameter} string prosody.cfg.lua" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:15158 +msgid "The contents of the @code{prosody.cfg.lua} to use." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15162 +msgid "For example, if your @code{prosody.cfg.lua} is just the empty string, you could instantiate a prosody service like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:15167 +#, no-wrap +msgid "" +"(service prosody-service-type\n" +" (opaque-prosody-configuration\n" +" (prosody.cfg.lua \"\")))\n" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15171 +#, no-wrap +msgid "BitlBee Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15173 +#, no-wrap +msgid "IRC (Internet Relay Chat)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15174 +#, no-wrap +msgid "IRC gateway" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15177 +msgid "@url{http://bitlbee.org,BitlBee} is a gateway that provides an IRC interface to a variety of messaging protocols such as XMPP." +msgstr "" + +#. type: defvr +#: doc/guix.texi:15178 +#, no-wrap +msgid "{Scheme Variable} bitlbee-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:15182 +msgid "This is the service type for the @url{http://bitlbee.org,BitlBee} IRC gateway daemon. Its value is a @code{bitlbee-configuration} (see below)." +msgstr "" + +#. type: defvr +#: doc/guix.texi:15185 +msgid "To have BitlBee listen on port 6667 on localhost, add this line to your services:" +msgstr "" + +#. type: example +#: doc/guix.texi:15188 +#, no-wrap +msgid "(service bitlbee-service-type)\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15191 +#, no-wrap +msgid "{Data Type} bitlbee-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15193 +msgid "This is the configuration for BitlBee, with the following fields:" +msgstr "" + +#. type: item +#: doc/guix.texi:15195 +#, no-wrap +msgid "@code{interface} (default: @code{\"127.0.0.1\"})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:15196 +#, no-wrap +msgid "@code{port} (default: @code{6667})" +msgstr "" + +#. type: table +#: doc/guix.texi:15199 +msgid "Listen on the network interface corresponding to the IP address specified in @var{interface}, on @var{port}." +msgstr "" + +#. type: table +#: doc/guix.texi:15203 +msgid "When @var{interface} is @code{127.0.0.1}, only local clients can connect; when it is @code{0.0.0.0}, connections can come from any networking interface." +msgstr "" + +#. type: item +#: doc/guix.texi:15204 +#, no-wrap +msgid "@code{package} (default: @code{bitlbee})" +msgstr "" + +#. type: table +#: doc/guix.texi:15206 +msgid "The BitlBee package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:15207 +#, no-wrap +msgid "@code{plugins} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:15209 +msgid "List of plugin packages to use---e.g., @code{bitlbee-discord}." +msgstr "" + +#. type: item +#: doc/guix.texi:15210 +#, no-wrap +msgid "@code{extra-settings} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15212 +msgid "Configuration snippet added as-is to the BitlBee configuration file." +msgstr "" + +#. type: cindex +#: doc/guix.texi:15219 +#, no-wrap +msgid "Murmur (VoIP server)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15220 +#, no-wrap +msgid "VoIP server" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15224 +msgid "This section describes how to set up and run a Murmur server. Murmur is the server of the @uref{https://mumble.info, Mumble} voice-over-IP (VoIP) suite." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15225 +#, no-wrap +msgid "{Data Type} murmur-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15228 +msgid "The service type for the Murmur server. An example configuration can look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:15237 +#, no-wrap +msgid "" +"(service murmur-service-type\n" +" (murmur-configuration\n" +" (welcome-text\n" +" \"Welcome to this Mumble server running on GuixSD!\")\n" +" (cert-required? #t) ;disallow text password logins\n" +" (ssl-cert \"/etc/letsencrypt/live/mumble.example.com/fullchain.pem\")\n" +" (ssl-key \"/etc/letsencrypt/live/mumble.example.com/privkey.pem\")))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15241 +msgid "After reconfiguring your system, you can manually set the murmur @code{SuperUser} password with the command that is printed during the activation phase." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15250 +msgid "It is recommended to register a normal Mumble user account and grant it admin or moderator rights. You can use the @code{mumble} client to login as new normal user, register yourself, and log out. For the next step login with the name @code{SuperUser} use the @code{SuperUser} password that you set previously, and grant your newly registered mumble user administrator or moderator rights and create some channels." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15252 +msgid "Available @code{murmur-configuration} fields are:" +msgstr "" + +#. type: item +#: doc/guix.texi:15254 +#, no-wrap +msgid "@code{package} (default: @code{mumble})" +msgstr "" + +#. type: table +#: doc/guix.texi:15256 +msgid "Package that contains @code{bin/murmurd}." +msgstr "" + +#. type: item +#: doc/guix.texi:15257 +#, no-wrap +msgid "@code{user} (default: @code{\"murmur\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15259 +msgid "User who will run the Murmur server." +msgstr "" + +#. type: item +#: doc/guix.texi:15260 +#, no-wrap +msgid "@code{group} (default: @code{\"murmur\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15262 +msgid "Group of the user who will run the murmur server." +msgstr "" + +#. type: item +#: doc/guix.texi:15263 +#, no-wrap +msgid "@code{port} (default: @code{64738})" +msgstr "" + +#. type: table +#: doc/guix.texi:15265 +msgid "Port on which the server will listen." +msgstr "" + +#. type: item +#: doc/guix.texi:15266 +#, no-wrap +msgid "@code{welcome-text} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15268 +msgid "Welcome text sent to clients when they connect." +msgstr "" + +#. type: item +#: doc/guix.texi:15269 +#, no-wrap +msgid "@code{server-password} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15271 +msgid "Password the clients have to enter in order to connect." +msgstr "" + +#. type: item +#: doc/guix.texi:15272 +#, no-wrap +msgid "@code{max-users} (default: @code{100})" +msgstr "" + +#. type: table +#: doc/guix.texi:15274 +msgid "Maximum of users that can be connected to the server at once." +msgstr "" + +#. type: item +#: doc/guix.texi:15275 +#, no-wrap +msgid "@code{max-user-bandwidth} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15277 +msgid "Maximum voice traffic a user can send per second." +msgstr "" + +#. type: item +#: doc/guix.texi:15278 +#, no-wrap +msgid "@code{database-file} (default: @code{\"/var/lib/murmur/db.sqlite\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15281 +msgid "File name of the sqlite database. The service's user will become the owner of the directory." +msgstr "" + +#. type: item +#: doc/guix.texi:15282 +#, no-wrap +msgid "@code{log-file} (default: @code{\"/var/log/murmur/murmur.log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15285 +msgid "File name of the log file. The service's user will become the owner of the directory." +msgstr "" + +#. type: item +#: doc/guix.texi:15286 +#, no-wrap +msgid "@code{autoban-attempts} (default: @code{10})" +msgstr "" + +#. type: table +#: doc/guix.texi:15289 +msgid "Maximum number of logins a user can make in @code{autoban-timeframe} without getting auto banned for @code{autoban-time}." +msgstr "" + +#. type: item +#: doc/guix.texi:15290 +#, no-wrap +msgid "@code{autoban-timeframe} (default: @code{120})" +msgstr "" + +#. type: table +#: doc/guix.texi:15292 +msgid "Timeframe for autoban in seconds." +msgstr "" + +#. type: item +#: doc/guix.texi:15293 +#, no-wrap +msgid "@code{autoban-time} (default: @code{300})" +msgstr "" + +#. type: table +#: doc/guix.texi:15296 +msgid "Amount of time in seconds for which a client gets banned when violating the autoban limits." +msgstr "" + +#. type: item +#: doc/guix.texi:15297 +#, no-wrap +msgid "@code{opus-threshold} (default: @code{100})" +msgstr "" + +#. type: table +#: doc/guix.texi:15300 +msgid "Percentage of clients that need to support opus before switching over to opus audio codec." +msgstr "" + +#. type: item +#: doc/guix.texi:15301 +#, no-wrap +msgid "@code{channel-nesting-limit} (default: @code{10})" +msgstr "" + +#. type: table +#: doc/guix.texi:15303 +msgid "How deep channels can be nested at maximum." +msgstr "" + +#. type: item +#: doc/guix.texi:15304 +#, no-wrap +msgid "@code{channelname-regex} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15306 +msgid "A string in from of a Qt regular expression that channel names must conform to." +msgstr "" + +#. type: item +#: doc/guix.texi:15307 +#, no-wrap +msgid "@code{username-regex} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15309 +msgid "A string in from of a Qt regular expression that user names must conform to." +msgstr "" + +#. type: item +#: doc/guix.texi:15310 +#, no-wrap +msgid "@code{text-message-length} (default: @code{5000})" +msgstr "" + +#. type: table +#: doc/guix.texi:15312 +msgid "Maximum size in bytes that a user can send in one text chat message." +msgstr "" + +#. type: item +#: doc/guix.texi:15313 +#, no-wrap +msgid "@code{image-message-length} (default: @code{(* 128 1024)})" +msgstr "" + +#. type: table +#: doc/guix.texi:15315 +msgid "Maximum size in bytes that a user can send in one image message." +msgstr "" + +#. type: item +#: doc/guix.texi:15316 +#, no-wrap +msgid "@code{cert-required?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15319 +msgid "If it is set to @code{#t} clients that use weak password authentification will not be accepted. Users must have completed the certificate wizard to join." +msgstr "" + +#. type: item +#: doc/guix.texi:15320 +#, no-wrap +msgid "@code{remember-channel?} (defualt @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15323 +msgid "Should murmur remember the last channel each user was in when they disconnected and put them into the remembered channel when they rejoin." +msgstr "" + +#. type: item +#: doc/guix.texi:15324 +#, no-wrap +msgid "@code{allow-html?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15326 +msgid "Should html be allowed in text messages, user comments, and channel descriptions." +msgstr "" + +#. type: item +#: doc/guix.texi:15327 +#, no-wrap +msgid "@code{allow-ping?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15331 +msgid "Setting to true exposes the current user count, the maximum user count, and the server's maximum bandwidth per client to unauthenticated users. In the Mumble client, this information is shown in the Connect dialog." +msgstr "" + +#. type: table +#: doc/guix.texi:15333 +msgid "Disabling this setting will prevent public listing of the server." +msgstr "" + +#. type: item +#: doc/guix.texi:15334 +#, no-wrap +msgid "@code{bonjour?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15336 +msgid "Should the server advertise itself in the local network through the bonjour protocol." +msgstr "" + +#. type: item +#: doc/guix.texi:15337 +#, no-wrap +msgid "@code{send-version?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15339 +msgid "Should the murmur server version be exposed in ping requests." +msgstr "" + +#. type: item +#: doc/guix.texi:15340 +#, no-wrap +msgid "@code{log-days} (default: @code{31})" +msgstr "" + +#. type: table +#: doc/guix.texi:15344 +msgid "Murmur also stores logs in the database, which are accessible via RPC. The default is 31 days of months, but you can set this setting to 0 to keep logs forever, or -1 to disable logging to the database." +msgstr "" + +#. type: item +#: doc/guix.texi:15345 +#, no-wrap +msgid "@code{obfuscate-ips?} (default @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:15347 +msgid "Should logged ips be obfuscated to protect the privacy of users." +msgstr "" + +#. type: item +#: doc/guix.texi:15348 +#, no-wrap +msgid "@code{ssl-cert} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15350 +msgid "File name of the SSL/TLS certificate used for encrypted connections." +msgstr "" + +#. type: example +#: doc/guix.texi:15353 +#, no-wrap +msgid "(ssl-cert \"/etc/letsencrypt/live/example.com/fullchain.pem\")\n" +msgstr "" + +#. type: item +#: doc/guix.texi:15354 +#, no-wrap +msgid "@code{ssl-key} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15356 +msgid "Filepath to the ssl private key used for encrypted connections." +msgstr "" + +#. type: example +#: doc/guix.texi:15358 +#, no-wrap +msgid "(ssl-key \"/etc/letsencrypt/live/example.com/privkey.pem\")\n" +msgstr "" + +#. type: item +#: doc/guix.texi:15360 +#, no-wrap +msgid "@code{ssl-dh-params} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15365 +msgid "File name of a PEM-encoded file with Diffie-Hellman parameters for the SSL/TLS encryption. Alternatively you set it to @code{\"@@ffdhe2048\"}, @code{\"@@ffdhe3072\"}, @code{\"@@ffdhe4096\"}, @code{\"@@ffdhe6144\"} or @code{\"@@ffdhe8192\"} to use bundled parameters from RFC 7919." +msgstr "" + +#. type: item +#: doc/guix.texi:15366 +#, no-wrap +msgid "@code{ssl-ciphers} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15369 +msgid "The @code{ssl-ciphers} option chooses the cipher suites to make available for use in SSL/TLS." +msgstr "" + +#. type: table +#: doc/guix.texi:15373 +msgid "This option is specified using @uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}." +msgstr "" + +#. type: table +#: doc/guix.texi:15378 +msgid "It is recommended that you try your cipher string using 'openssl ciphers <string>' before setting it here, to get a feel for which cipher suites you will get. After setting this option, it is recommend that you inspect your Murmur log to ensure that Murmur is using the cipher suites that you expected it to." +msgstr "" + +#. type: table +#: doc/guix.texi:15382 +msgid "Note: Changing this option may impact the backwards compatibility of your Murmur server, and can remove the ability for older Mumble clients to be able to connect to it." +msgstr "" + +#. type: item +#: doc/guix.texi:15383 +#, no-wrap +msgid "@code{public-registration} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15385 +msgid "Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}." +msgstr "" + +#. type: table +#: doc/guix.texi:15390 +msgid "You can optionally register your server in the public server list that the @code{mumble} client shows on startup. You cannot register your server if you have set a @code{server-password}, or set @code{allow-ping} to @code{#f}." +msgstr "" + +#. type: table +#: doc/guix.texi:15392 +msgid "It might take a few hours until it shows up in the public list." +msgstr "" + +#. type: item +#: doc/guix.texi:15393 doc/guix.texi:15964 +#, no-wrap +msgid "@code{file} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15395 +msgid "Optional alternative override for this configuration." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15398 +#, no-wrap +msgid "{Data Type} murmur-public-registration-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15400 +msgid "Configuration for public registration of a murmur service." +msgstr "" + +#. type: table +#: doc/guix.texi:15404 +msgid "This is a display name for your server. Not to be confused with the hostname." +msgstr "" + +#. type: itemx +#: doc/guix.texi:15405 doc/guix.texi:20414 +#, no-wrap +msgid "password" +msgstr "" + +#. type: table +#: doc/guix.texi:15408 +msgid "A password to identify your registration. Subsequent updates will need the same password. Don't lose your password." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15409 +#, no-wrap +msgid "url" +msgstr "" + +#. type: table +#: doc/guix.texi:15412 +msgid "This should be a @code{http://} or @code{https://} link to your web site." +msgstr "" + +#. type: item +#: doc/guix.texi:15413 +#, no-wrap +msgid "@code{hostname} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15416 +msgid "By default your server will be listed by its IP address. If it is set your server will be linked by this host name instead." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15424 +#, no-wrap +msgid "Tailon Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15428 +msgid "@uref{https://tailon.readthedocs.io/, Tailon} is a web application for viewing and searching log files." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15431 +msgid "The following example will configure the service with default values. By default, Tailon can be accessed on port 8080 (@code{http://localhost:8080})." +msgstr "" + +#. type: example +#: doc/guix.texi:15434 +#, no-wrap +msgid "(service tailon-service-type)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15438 +msgid "The following example customises more of the Tailon configuration, adding @command{sed} to the list of allowed commands." +msgstr "" + +#. type: example +#: doc/guix.texi:15445 +#, no-wrap +msgid "" +"(service tailon-service-type\n" +" (tailon-configuration\n" +" (config-file\n" +" (tailon-configuration-file\n" +" (allowed-commands '(\"tail\" \"grep\" \"awk\" \"sed\"))))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15448 +#, no-wrap +msgid "{Data Type} tailon-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15451 +msgid "Data type representing the configuration of Tailon. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:15453 +#, no-wrap +msgid "@code{config-file} (default: @code{(tailon-configuration-file)})" +msgstr "" + +#. type: table +#: doc/guix.texi:15457 +msgid "The configuration file to use for Tailon. This can be set to a @dfn{tailon-configuration-file} record value, or any gexp (@pxref{G-Expressions})." +msgstr "" + +#. type: table +#: doc/guix.texi:15460 +msgid "For example, to instead use a local file, the @code{local-file} function can be used:" +msgstr "" + +#. type: example +#: doc/guix.texi:15465 +#, no-wrap +msgid "" +"(service tailon-service-type\n" +" (tailon-configuration\n" +" (config-file (local-file \"./my-tailon.conf\"))))\n" +msgstr "" + +#. type: item +#: doc/guix.texi:15467 +#, no-wrap +msgid "@code{package} (default: @code{tailon})" +msgstr "" + +#. type: table +#: doc/guix.texi:15469 +msgid "The tailon package to use." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15473 +#, no-wrap +msgid "{Data Type} tailon-configuration-file" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15476 +msgid "Data type representing the configuration options for Tailon. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:15478 +#, no-wrap +msgid "@code{files} (default: @code{(list \"/var/log\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:15483 +msgid "List of files to display. The list can include strings for a single file or directory, or a list, where the first item is the name of a subsection, and the remaining items are the files or directories in that subsection." +msgstr "" + +#. type: item +#: doc/guix.texi:15484 +#, no-wrap +msgid "@code{bind} (default: @code{\"localhost:8080\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15486 +msgid "Address and port to which Tailon should bind on." +msgstr "" + +#. type: item +#: doc/guix.texi:15487 +#, no-wrap +msgid "@code{relative-root} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15489 +msgid "URL path to use for Tailon, set to @code{#f} to not use a path." +msgstr "" + +#. type: item +#: doc/guix.texi:15490 +#, no-wrap +msgid "@code{allow-transfers?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:15492 +msgid "Allow downloading the log files in the web interface." +msgstr "" + +#. type: item +#: doc/guix.texi:15493 +#, no-wrap +msgid "@code{follow-names?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:15495 +msgid "Allow tailing of not-yet existent files." +msgstr "" + +#. type: item +#: doc/guix.texi:15496 +#, no-wrap +msgid "@code{tail-lines} (default: @code{200})" +msgstr "" + +#. type: table +#: doc/guix.texi:15498 +msgid "Number of lines to read initially from each file." +msgstr "" + +#. type: item +#: doc/guix.texi:15499 +#, no-wrap +msgid "@code{allowed-commands} (default: @code{(list \"tail\" \"grep\" \"awk\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:15501 +msgid "Commands to allow running. By default, @code{sed} is disabled." +msgstr "" + +#. type: item +#: doc/guix.texi:15502 +#, no-wrap +msgid "@code{debug?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15504 +msgid "Set @code{debug?} to @code{#t} to show debug messages." +msgstr "" + +#. type: item +#: doc/guix.texi:15505 +#, no-wrap +msgid "@code{wrap-lines} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:15509 +msgid "Initial line wrapping state in the web interface. Set to @code{#t} to initially wrap lines (the default), or to @code{#f} to initially not wrap lines." +msgstr "" + +#. type: item +#: doc/guix.texi:15510 +#, no-wrap +msgid "@code{http-auth} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15514 +msgid "HTTP authentication type to use. Set to @code{#f} to disable authentication (the default). Supported values are @code{\"digest\"} or @code{\"basic\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:15515 +#, no-wrap +msgid "@code{users} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15520 +msgid "If HTTP authentication is enabled (see @code{http-auth}), access will be restricted to the credentials provided here. To configure users, use a list of pairs, where the first element of the pair is the username, and the 2nd element of the pair is the password." +msgstr "" + +#. type: example +#: doc/guix.texi:15526 +#, no-wrap +msgid "" +"(tailon-configuration-file\n" +" (http-auth \"basic\")\n" +" (users '((\"user1\" . \"password1\")\n" +" (\"user2\" . \"password2\"))))\n" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15532 +#, no-wrap +msgid "Darkstat Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15533 +#, no-wrap +msgid "darkstat" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15536 +msgid "Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP." +msgstr "" + +#. type: defvar +#: doc/guix.texi:15537 +#, no-wrap +msgid "{Scheme Variable} darkstat-service-type" +msgstr "" + +#. type: defvar +#: doc/guix.texi:15542 +msgid "This is the service type for the @uref{https://unix4lyfe.org/darkstat/, darkstat} service, its value must be a @code{darkstat-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:15547 +#, no-wrap +msgid "" +"(service darkstat-service-type\n" +" (darkstat-configuration\n" +" (interface \"eno1\")))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15550 +#, no-wrap +msgid "{Data Type} darkstat-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15552 +msgid "Data type representing the configuration of @command{darkstat}." +msgstr "" + +#. type: item +#: doc/guix.texi:15554 +#, no-wrap +msgid "@code{package} (default: @code{darkstat})" +msgstr "" + +#. type: table +#: doc/guix.texi:15556 +msgid "The darkstat package to use." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15557 +#, no-wrap +msgid "interface" +msgstr "" + +#. type: table +#: doc/guix.texi:15559 +msgid "Capture traffic on the specified network interface." +msgstr "" + +#. type: item +#: doc/guix.texi:15560 +#, no-wrap +msgid "@code{port} (default: @code{\"667\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15562 +msgid "Bind the web interface to the specified port." +msgstr "" + +#. type: item +#: doc/guix.texi:15563 +#, no-wrap +msgid "@code{bind-address} (default: @code{\"127.0.0.1\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15565 +msgid "Bind the web interface to the specified address." +msgstr "" + +#. type: item +#: doc/guix.texi:15566 +#, no-wrap +msgid "@code{base} (default: @code{\"/\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15569 +msgid "Specify the path of the base URL. This can be useful if @command{darkstat} is accessed via a reverse proxy." +msgstr "" + +#. type: cindex +#: doc/guix.texi:15576 +#, no-wrap +msgid "Kerberos" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15580 +msgid "The @code{(gnu services kerberos)} module provides services relating to the authentication protocol @dfn{Kerberos}." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15581 +#, no-wrap +msgid "Krb5 Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15588 +msgid "Programs using a Kerberos client library normally expect a configuration file in @file{/etc/krb5.conf}. This service generates such a file from a definition provided in the operating system declaration. It does not cause any daemon to be started." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15592 +msgid "No ``keytab'' files are provided by this service---you must explicitly create them. This service is known to work with the MIT client library, @code{mit-krb5}. Other implementations have not been tested." +msgstr "" + +#. type: defvr +#: doc/guix.texi:15593 +#, no-wrap +msgid "{Scheme Variable} krb5-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:15595 +msgid "A service type for Kerberos 5 clients." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15599 +msgid "Here is an example of its use:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:15613 +#, no-wrap +msgid "" +"(service krb5-service-type\n" +" (krb5-configuration\n" +" (default-realm \"EXAMPLE.COM\")\n" +" (allow-weak-crypto? #t)\n" +" (realms (list\n" +" (krb5-realm\n" +" (name \"EXAMPLE.COM\")\n" +" (admin-server \"groucho.example.com\")\n" +" (kdc \"karl.example.com\"))\n" +" (krb5-realm\n" +" (name \"ARGRX.EDU\")\n" +" (admin-server \"kerb-admin.argrx.edu\")\n" +" (kdc \"keys.argrx.edu\"))))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15617 +msgid "This example provides a Kerberos@tie{}5 client configuration which:" +msgstr "" + +#. type: item +#: doc/guix.texi:15618 +#, no-wrap +msgid "Recognizes two realms, @i{viz:} ``EXAMPLE.COM'' and ``ARGRX.EDU'', both" +msgstr "" + +#. type: itemize +#: doc/guix.texi:15620 +msgid "of which have distinct administration servers and key distribution centers;" +msgstr "" + +#. type: item +#: doc/guix.texi:15620 +#, no-wrap +msgid "Will default to the realm ``EXAMPLE.COM'' if the realm is not explicitly" +msgstr "" + +#. type: itemize +#: doc/guix.texi:15622 +msgid "specified by clients;" +msgstr "" + +#. type: item +#: doc/guix.texi:15622 +#, no-wrap +msgid "Accepts services which only support encryption types known to be weak." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15630 +msgid "The @code{krb5-realm} and @code{krb5-configuration} types have many fields. Only the most commonly used ones are described here. For a full list, and more detailed explanation of each, see the MIT @uref{http://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html,,krb5.conf} documentation." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15632 +#, no-wrap +msgid "{Data Type} krb5-realm" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15633 +#, no-wrap +msgid "realm, kerberos" +msgstr "" + +#. type: table +#: doc/guix.texi:15639 +msgid "This field is a string identifying the name of the realm. A common convention is to use the fully qualified DNS name of your organization, converted to upper case." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15640 +#, no-wrap +msgid "admin-server" +msgstr "" + +#. type: table +#: doc/guix.texi:15643 +msgid "This field is a string identifying the host where the administration server is running." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15644 +#, no-wrap +msgid "kdc" +msgstr "" + +#. type: table +#: doc/guix.texi:15647 +msgid "This field is a string identifying the key distribution center for the realm." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15650 +#, no-wrap +msgid "{Data Type} krb5-configuration" +msgstr "" + +#. type: item +#: doc/guix.texi:15653 +#, no-wrap +msgid "@code{allow-weak-crypto?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15656 +msgid "If this flag is @code{#t} then services which only offer encryption algorithms known to be weak will be accepted." +msgstr "" + +#. type: item +#: doc/guix.texi:15657 +#, no-wrap +msgid "@code{default-realm} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15664 +msgid "This field should be a string identifying the default Kerberos realm for the client. You should set this field to the name of your Kerberos realm. If this value is @code{#f} then a realm must be specified with every Kerberos principal when invoking programs such as @command{kinit}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15665 +#, no-wrap +msgid "realms" +msgstr "" + +#. type: table +#: doc/guix.texi:15670 +msgid "This should be a non-empty list of @code{krb5-realm} objects, which clients may access. Normally, one of them will have a @code{name} field matching the @code{default-realm} field." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15674 +#, no-wrap +msgid "PAM krb5 Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15675 +#, no-wrap +msgid "pam-krb5" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15681 +msgid "The @code{pam-krb5} service allows for login authentication and password management via Kerberos. You will need this service if you want PAM enabled applications to authenticate users using Kerberos." +msgstr "" + +#. type: defvr +#: doc/guix.texi:15682 +#, no-wrap +msgid "{Scheme Variable} pam-krb5-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:15684 +msgid "A service type for the Kerberos 5 PAM module." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15686 +#, no-wrap +msgid "{Data Type} pam-krb5-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15689 +msgid "Data type representing the configuration of the Kerberos 5 PAM module This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:15690 +#, no-wrap +msgid "@code{pam-krb5} (default: @code{pam-krb5})" +msgstr "" + +#. type: table +#: doc/guix.texi:15692 +msgid "The pam-krb5 package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:15693 +#, no-wrap +msgid "@code{minimum-uid} (default: @code{1000})" +msgstr "" + +#. type: table +#: doc/guix.texi:15696 +msgid "The smallest user ID for which Kerberos authentications should be attempted. Local accounts with lower values will silently fail to authenticate." +msgstr "" + +#. type: cindex +#: doc/guix.texi:15703 +#, no-wrap +msgid "web" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15704 +#, no-wrap +msgid "www" +msgstr "" + +#. type: cindex +#: doc/guix.texi:15705 +#, no-wrap +msgid "HTTP" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15708 +msgid "The @code{(gnu services web)} module provides the Apache HTTP Server, the nginx web server, and also a fastcgi wrapper daemon." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15709 +#, no-wrap +msgid "Apache HTTP Server" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15711 +#, no-wrap +msgid "{Scheme Variable} httpd-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15715 +msgid "Service type for the @uref{https://httpd.apache.org/,Apache HTTP} server (@dfn{httpd}). The value for this service type is a @code{https-configuration} record." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15717 doc/guix.texi:15868 +msgid "A simple example configuration is given below." +msgstr "" + +#. type: example +#: doc/guix.texi:15725 +#, no-wrap +msgid "" +"(service httpd-service-type\n" +" (httpd-configuration\n" +" (config\n" +" (httpd-config-file\n" +" (server-name \"www.example.com\")\n" +" (document-root \"/srv/http/www.example.com\")))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15729 +msgid "Other services can also extend the @code{httpd-service-type} to add to the configuration." +msgstr "" + +#. type: example +#: doc/guix.texi:15738 doc/guix.texi:15848 +#, no-wrap +msgid "" +"(simple-service 'my-extra-server httpd-service-type\n" +" (list\n" +" (httpd-virtualhost\n" +" \"*:80\"\n" +" (list (string-append\n" +" \"ServerName \"www.example.com\n" +" DocumentRoot \\\"/srv/http/www.example.com\\\"\")))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15744 +msgid "The details for the @code{httpd-configuration}, @code{httpd-module}, @code{httpd-config-file} and @code{httpd-virtualhost} record types are given below." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15745 +#, no-wrap +msgid "{Data Type} httpd-configuration" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15747 +msgid "This data type represents the configuration for the httpd service." +msgstr "" + +#. type: item +#: doc/guix.texi:15749 +#, no-wrap +msgid "@code{package} (default: @code{httpd})" +msgstr "" + +#. type: table +#: doc/guix.texi:15751 +msgid "The httpd package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:15752 doc/guix.texi:15811 +#, no-wrap +msgid "@code{pid-file} (default: @code{\"/var/run/httpd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15754 +msgid "The pid file used by the shepherd-service." +msgstr "" + +#. type: item +#: doc/guix.texi:15755 +#, no-wrap +msgid "@code{config} (default: @code{(httpd-config-file)})" +msgstr "" + +#. type: table +#: doc/guix.texi:15760 +msgid "The configuration file to use with the httpd service. The default value is a @code{httpd-config-file} record, but this can also be a different G-expression that generates a file, for example a @code{plain-file}. A file outside of the store can also be specified through a string." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15764 +#, no-wrap +msgid "{Data Type} httpd-module" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15766 +msgid "This data type represents a module for the httpd service." +msgstr "" + +#. type: table +#: doc/guix.texi:15770 +msgid "The name of the module." +msgstr "" + +#. type: table +#: doc/guix.texi:15776 +msgid "The file for the module. This can be relative to the httpd package being used, the absolute location of a file, or a G-expression for a file within the store, for example @code{(file-append mod-wsgi \"/modules/mod_wsgi.so\")}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15780 +#, no-wrap +msgid "{Data Type} httpd-config-file" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15782 +msgid "This data type represents a configuration file for the httpd service." +msgstr "" + +#. type: item +#: doc/guix.texi:15784 +#, no-wrap +msgid "@code{modules} (default: @code{%default-httpd-modules})" +msgstr "" + +#. type: table +#: doc/guix.texi:15787 +msgid "The modules to load. Additional modules can be added here, or loaded by additional configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:15788 +#, no-wrap +msgid "@code{server-root} (default: @code{httpd})" +msgstr "" + +#. type: table +#: doc/guix.texi:15792 +msgid "The @code{ServerRoot} in the configuration file, defaults to the httpd package. Directives including @code{Include} and @code{LoadModule} are taken as relative to the server root." +msgstr "" + +#. type: item +#: doc/guix.texi:15793 +#, no-wrap +msgid "@code{server-name} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15797 +msgid "The @code{ServerName} in the configuration file, used to specify the request scheme, hostname and port that the server uses to identify itself." +msgstr "" + +#. type: table +#: doc/guix.texi:15801 +msgid "This doesn't need to be set in the server config, and can be specifyed in virtual hosts. The default is @code{#f} to not specify a @code{ServerName}." +msgstr "" + +#. type: item +#: doc/guix.texi:15802 +#, no-wrap +msgid "@code{document-root} (default: @code{\"/srv/http\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15804 +msgid "The @code{DocumentRoot} from which files will be served." +msgstr "" + +#. type: item +#: doc/guix.texi:15805 +#, no-wrap +msgid "@code{listen} (default: @code{'(\"80\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:15810 +msgid "The list of values for the @code{Listen} directives in the config file. The value should be a list of strings, when each string can specify the port number to listen on, and optionally the IP address and protocol to use." +msgstr "" + +#. type: table +#: doc/guix.texi:15815 +msgid "The @code{PidFile} to use. This should match the @code{pid-file} set in the @code{httpd-configuration} so that the Shepherd service is configured correctly." +msgstr "" + +#. type: item +#: doc/guix.texi:15816 +#, no-wrap +msgid "@code{error-log} (default: @code{\"/var/log/httpd/error_log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15818 +msgid "The @code{ErrorLog} to which the server will log errors." +msgstr "" + +#. type: item +#: doc/guix.texi:15819 +#, no-wrap +msgid "@code{user} (default: @code{\"httpd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15821 +msgid "The @code{User} which the server will answer requests as." +msgstr "" + +#. type: item +#: doc/guix.texi:15822 +#, no-wrap +msgid "@code{group} (default: @code{\"httpd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15824 +msgid "The @code{Group} which the server will answer requests as." +msgstr "" + +#. type: item +#: doc/guix.texi:15825 +#, no-wrap +msgid "@code{extra-config} (default: @code{(list \"TypesConfig etc/httpd/mime.types\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:15828 +msgid "A flat list of strings and G-expressions which will be added to the end of the configuration file." +msgstr "" + +#. type: table +#: doc/guix.texi:15831 +msgid "Any values which the service is extended with will be appended to this list." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15835 +#, no-wrap +msgid "{Data Type} httpd-virtualhost" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15837 +msgid "This data type represents a virtualhost configuration block for the httpd service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15839 +msgid "These should be added to the extra-config for the httpd-service." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15851 +#, no-wrap +msgid "addresses-and-ports" +msgstr "" + +#. type: table +#: doc/guix.texi:15853 +msgid "The addresses and ports for the @code{VirtualHost} directive." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:15854 +#, no-wrap +msgid "contents" +msgstr "" + +#. type: table +#: doc/guix.texi:15857 +msgid "The contents of the @code{VirtualHost} directive, this should be a list of strings and G-expressions." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:15861 +#, no-wrap +msgid "NGINX" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15863 +#, no-wrap +msgid "{Scheme Variable} nginx-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15866 +msgid "Service type for the @uref{https://nginx.org/,NGinx} web server. The value for this service type is a @code{<nginx-configuration>} record." +msgstr "" + +#. type: example +#: doc/guix.texi:15876 doc/guix.texi:15930 +#, no-wrap +msgid "" +"(service nginx-service-type\n" +" (nginx-configuration\n" +" (server-blocks\n" +" (list (nginx-server-configuration\n" +" (server-name '(\"www.example.com\"))\n" +" (root \"/srv/http/www.example.com\"))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15881 +msgid "In addition to adding server blocks to the service configuration directly, this service can be extended by other services to add server blocks, as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:15887 +#, no-wrap +msgid "" +"(simple-service 'my-extra-server nginx-service-type\n" +" (list (nginx-server-configuration\n" +" (root \"/srv/http/extra-website\")\n" +" (try-files (list \"$uri\" \"$uri/index.html\")))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:15898 +msgid "At startup, @command{nginx} has not yet read its configuration file, so it uses a default file to log error messages. If it fails to load its configuration file, that is where error messages are logged. After the configuration file is loaded, the default error log file changes as per configuration. In our case, startup error messages can be found in @file{/var/run/nginx/logs/error.log}, and after configuration in @file{/var/log/nginx/error.log}. The second location can be changed with the @var{log-directory} configuration option." +msgstr "" + +#. type: deffn +#: doc/guix.texi:15899 +#, no-wrap +msgid "{Data Type} nginx-configuration" +msgstr "" + +#. type: deffn +#: doc/guix.texi:15903 +msgid "This data type represents the configuration for NGinx. Some configuration can be done through this and the other provided record types, or alternatively, a config file can be provided." +msgstr "" + +#. type: item +#: doc/guix.texi:15905 +#, no-wrap +msgid "@code{nginx} (default: @code{nginx})" +msgstr "" + +#. type: table +#: doc/guix.texi:15907 +msgid "The nginx package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:15908 +#, no-wrap +msgid "@code{log-directory} (default: @code{\"/var/log/nginx\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15910 +msgid "The directory to which NGinx will write log files." +msgstr "" + +#. type: item +#: doc/guix.texi:15911 +#, no-wrap +msgid "@code{run-directory} (default: @code{\"/var/run/nginx\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15914 +msgid "The directory in which NGinx will create a pid file, and write temporary files." +msgstr "" + +#. type: item +#: doc/guix.texi:15915 +#, no-wrap +msgid "@code{server-blocks} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:15919 +msgid "A list of @dfn{server blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-server-configuration>}." +msgstr "" + +#. type: table +#: doc/guix.texi:15923 +msgid "The following example would setup NGinx to serve @code{www.example.com} from the @code{/srv/http/www.example.com} directory, without using HTTPS." +msgstr "" + +#. type: item +#: doc/guix.texi:15932 +#, no-wrap +msgid "@code{upstream-blocks} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:15936 +msgid "A list of @dfn{upstream blocks} to create in the generated configuration file, the elements should be of type @code{<nginx-upstream-configuration>}." +msgstr "" + +#. type: table +#: doc/guix.texi:15943 +msgid "Configuring upstreams through the @code{upstream-blocks} can be useful when combined with @code{locations} in the @code{<nginx-server-configuration>} records. The following example creates a server configuration with one location configuration, that will proxy requests to a upstream configuration, which will handle requests with two servers." +msgstr "" + +#. type: example +#: doc/guix.texi:15962 +#, no-wrap +msgid "" +"(service\n" +" nginx-service-type\n" +" (nginx-configuration\n" +" (server-blocks\n" +" (list (nginx-server-configuration\n" +" (server-name '(\"www.example.com\"))\n" +" (root \"/srv/http/www.example.com\")\n" +" (locations\n" +" (list\n" +" (nginx-location-configuration\n" +" (uri \"/path1\")\n" +" (body '(\"proxy_pass http://server-proxy;\"))))))))\n" +" (upstream-blocks\n" +" (list (nginx-upstream-configuration\n" +" (name \"server-proxy\")\n" +" (servers (list \"server1.example.com\"\n" +" \"server2.example.com\")))))))\n" +msgstr "" + +#. type: table +#: doc/guix.texi:15970 +msgid "If a configuration @var{file} is provided, this will be used, rather than generating a configuration file from the provided @code{log-directory}, @code{run-directory}, @code{server-blocks} and @code{upstream-blocks}. For proper operation, these arguments should match what is in @var{file} to ensure that the directories are created when the service is activated." +msgstr "" + +#. type: table +#: doc/guix.texi:15974 +msgid "This can be useful if you have an existing configuration file, or it's not possible to do what is required through the other parts of the nginx-configuration record." +msgstr "" + +#. type: item +#: doc/guix.texi:15975 +#, no-wrap +msgid "@code{server-names-hash-bucket-size} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15978 +msgid "Bucket size for the server names hash tables, defaults to @code{#f} to use the size of the processors cache line." +msgstr "" + +#. type: item +#: doc/guix.texi:15979 +#, no-wrap +msgid "@code{server-names-hash-bucket-max-size} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:15981 +msgid "Maximum bucket size for the server names hash tables." +msgstr "" + +#. type: item +#: doc/guix.texi:15982 +#, no-wrap +msgid "@code{extra-content} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:15985 +msgid "Extra content for the @code{http} block. Should be string or a string valued G-expression." +msgstr "" + +#. type: deftp +#: doc/guix.texi:15989 +#, no-wrap +msgid "{Data Type} nginx-server-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:15992 +msgid "Data type representing the configuration of an nginx server block. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:15994 +#, no-wrap +msgid "@code{listen} (default: @code{'(\"80\" \"443 ssl\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:15999 +msgid "Each @code{listen} directive sets the address and port for IP, or the path for a UNIX-domain socket on which the server will accept requests. Both address and port, or only address or only port can be specified. An address may also be a hostname, for example:" +msgstr "" + +#. type: example +#: doc/guix.texi:16002 +#, no-wrap +msgid "'(\"127.0.0.1:8000\" \"127.0.0.1\" \"8000\" \"*:8000\" \"localhost:8000\")\n" +msgstr "" + +#. type: item +#: doc/guix.texi:16004 +#, no-wrap +msgid "@code{server-name} (default: @code{(list 'default)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16007 +msgid "A list of server names this server represents. @code{'default} represents the default server for connections matching no other server." +msgstr "" + +#. type: item +#: doc/guix.texi:16008 +#, no-wrap +msgid "@code{root} (default: @code{\"/srv/http\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16010 +msgid "Root of the website nginx will serve." +msgstr "" + +#. type: item +#: doc/guix.texi:16011 +#, no-wrap +msgid "@code{locations} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16015 +msgid "A list of @dfn{nginx-location-configuration} or @dfn{nginx-named-location-configuration} records to use within this server block." +msgstr "" + +#. type: item +#: doc/guix.texi:16016 +#, no-wrap +msgid "@code{index} (default: @code{(list \"index.html\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:16019 +msgid "Index files to look for when clients ask for a directory. If it cannot be found, Nginx will send the list of files in the directory." +msgstr "" + +#. type: item +#: doc/guix.texi:16020 +#, no-wrap +msgid "@code{try-files} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16023 +msgid "A list of files whose existence is checked in the specified order. @code{nginx} will use the first file it finds to process the request." +msgstr "" + +#. type: item +#: doc/guix.texi:16024 +#, no-wrap +msgid "@code{ssl-certificate} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16027 +msgid "Where to find the certificate for secure connections. Set it to @code{#f} if you don't have a certificate or you don't want to use HTTPS." +msgstr "" + +#. type: item +#: doc/guix.texi:16028 +#, no-wrap +msgid "@code{ssl-certificate-key} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16031 +msgid "Where to find the private key for secure connections. Set it to @code{#f} if you don't have a key or you don't want to use HTTPS." +msgstr "" + +#. type: item +#: doc/guix.texi:16032 +#, no-wrap +msgid "@code{server-tokens?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16034 +msgid "Whether the server should add its configuration to response." +msgstr "" + +#. type: item +#: doc/guix.texi:16035 +#, no-wrap +msgid "@code{raw-content} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16037 +msgid "A list of raw lines added to the server block." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16041 +#, no-wrap +msgid "{Data Type} nginx-upstream-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16044 +msgid "Data type representing the configuration of an nginx @code{upstream} block. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16048 +msgid "Name for this group of servers." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16049 +#, no-wrap +msgid "servers" +msgstr "" + +#. type: table +#: doc/guix.texi:16056 +msgid "Specify the addresses of the servers in the group. The address can be specified as a IP address (e.g. @samp{127.0.0.1}), domain name (e.g. @samp{backend1.example.com}) or a path to a UNIX socket using the prefix @samp{unix:}. For addresses using an IP address or domain name, the default port is 80, and a different port can be specified explicitly." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16060 +#, no-wrap +msgid "{Data Type} nginx-location-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16063 +msgid "Data type representing the configuration of an nginx @code{location} block. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16067 +msgid "URI which this location block matches." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:16069 +msgid "nginx-location-configuration body" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16069 doc/guix.texi:16090 +#, no-wrap +msgid "body" +msgstr "" + +#. type: table +#: doc/guix.texi:16076 +msgid "Body of the location block, specified as a list of strings. This can contain many configuration directives. For example, to pass requests to a upstream server group defined using an @code{nginx-upstream-configuration} block, the following directive would be specified in the body @samp{(list \"proxy_pass http://upstream-name;\")}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16080 +#, no-wrap +msgid "{Data Type} nginx-named-location-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16085 +msgid "Data type representing the configuration of an nginx named location block. Named location blocks are used for request redirection, and not used for regular request processing. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16089 +msgid "Name to identify this location block." +msgstr "" + +#. type: table +#: doc/guix.texi:16095 +msgid "@xref{nginx-location-configuration body}, as the body for named location blocks can be used in a similar way to the @code{nginx-location-configuration body}. One restriction is that the body of a named location block cannot contain location blocks." +msgstr "" + +#. type: cindex +#: doc/guix.texi:16099 +#, no-wrap +msgid "fastcgi" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16100 +#, no-wrap +msgid "fcgiwrap" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16107 +msgid "FastCGI is an interface between the front-end and the back-end of a web service. It is a somewhat legacy facility; new web services should generally just talk HTTP between the front-end and the back-end. However there are a number of back-end services such as PHP or the optimized HTTP Git repository access that use FastCGI, so we have support for it in Guix." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16114 +msgid "To use FastCGI, you configure the front-end web server (e.g., nginx) to dispatch some subset of its requests to the fastcgi backend, which listens on a local TCP or UNIX socket. There is an intermediary @code{fcgiwrap} program that sits between the actual backend process and the web server. The front-end indicates which backend program to run, passing that information to the @code{fcgiwrap} process." +msgstr "" + +#. type: defvr +#: doc/guix.texi:16115 +#, no-wrap +msgid "{Scheme Variable} fcgiwrap-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:16117 +msgid "A service type for the @code{fcgiwrap} FastCGI proxy." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16119 +#, no-wrap +msgid "{Data Type} fcgiwrap-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16122 +msgid "Data type representing the configuration of the @code{fcgiwrap} serice. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16123 +#, no-wrap +msgid "@code{package} (default: @code{fcgiwrap})" +msgstr "" + +#. type: table +#: doc/guix.texi:16125 +msgid "The fcgiwrap package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:16126 +#, no-wrap +msgid "@code{socket} (default: @code{tcp:127.0.0.1:9000})" +msgstr "" + +#. type: table +#: doc/guix.texi:16132 +msgid "The socket on which the @code{fcgiwrap} process should listen, as a string. Valid @var{socket} values include @code{unix:@var{/path/to/unix/socket}}, @code{tcp:@var{dot.ted.qu.ad}:@var{port}} and @code{tcp6:[@var{ipv6_addr}]:port}." +msgstr "" + +#. type: item +#: doc/guix.texi:16133 +#, no-wrap +msgid "@code{user} (default: @code{fcgiwrap})" +msgstr "" + +#. type: itemx +#: doc/guix.texi:16134 +#, no-wrap +msgid "@code{group} (default: @code{fcgiwrap})" +msgstr "" + +#. type: table +#: doc/guix.texi:16139 +msgid "The user and group names, as strings, under which to run the @code{fcgiwrap} process. The @code{fastcgi} service will ensure that if the user asks for the specific user or group names @code{fcgiwrap} that the corresponding user and/or group is present on the system." +msgstr "" + +#. type: table +#: doc/guix.texi:16146 +msgid "It is possible to configure a FastCGI-backed web service to pass HTTP authentication information from the front-end to the back-end, and to allow @code{fcgiwrap} to run the back-end process as a corresponding local user. To enable this capability on the back-end., run @code{fcgiwrap} as the @code{root} user and group. Note that this capability also has to be configured on the front-end as well." +msgstr "" + +#. type: cindex +#: doc/guix.texi:16149 +#, no-wrap +msgid "php-fpm" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16152 +msgid "PHP-FPM (FastCGI Process Manager) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16154 +msgid "These features include:" +msgstr "" + +#. type: item +#: doc/guix.texi:16155 +#, no-wrap +msgid "Adaptive process spawning" +msgstr "" + +#. type: item +#: doc/guix.texi:16156 +#, no-wrap +msgid "Basic statistics (similar to Apache's mod_status)" +msgstr "" + +#. type: item +#: doc/guix.texi:16157 +#, no-wrap +msgid "Advanced process management with graceful stop/start" +msgstr "" + +#. type: item +#: doc/guix.texi:16158 +#, no-wrap +msgid "Ability to start workers with different uid/gid/chroot/environment" +msgstr "" + +#. type: itemize +#: doc/guix.texi:16160 +msgid "and different php.ini (replaces safe_mode)" +msgstr "" + +#. type: item +#: doc/guix.texi:16160 +#, no-wrap +msgid "Stdout & stderr logging" +msgstr "" + +#. type: item +#: doc/guix.texi:16161 +#, no-wrap +msgid "Emergency restart in case of accidental opcode cache destruction" +msgstr "" + +#. type: item +#: doc/guix.texi:16162 +#, no-wrap +msgid "Accelerated upload support" +msgstr "" + +#. type: item +#: doc/guix.texi:16163 +#, no-wrap +msgid "Support for a \"slowlog\"" +msgstr "" + +#. type: item +#: doc/guix.texi:16164 +#, no-wrap +msgid "Enhancements to FastCGI, such as fastcgi_finish_request() -" +msgstr "" + +#. type: itemize +#: doc/guix.texi:16167 +msgid "a special function to finish request & flush all data while continuing to do something time-consuming (video converting, stats processing, etc.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16169 +msgid "... and much more." +msgstr "" + +#. type: defvr +#: doc/guix.texi:16170 +#, no-wrap +msgid "{Scheme Variable} php-fpm-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:16172 +msgid "A Service type for @code{php-fpm}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16174 +#, no-wrap +msgid "{Data Type} php-fpm-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16176 +msgid "Data Type for php-fpm service configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:16177 +#, no-wrap +msgid "@code{php} (default: @code{php})" +msgstr "" + +#. type: table +#: doc/guix.texi:16179 +msgid "The php package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:16179 +#, no-wrap +msgid "@code{socket} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.sock\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:16181 +msgid "The address on which to accept FastCGI requests. Valid syntaxes are:" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16182 +#, no-wrap +msgid "\"ip.add.re.ss:port\"" +msgstr "" + +#. type: table +#: doc/guix.texi:16184 +msgid "Listen on a TCP socket to a specific address on a specific port." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16184 +#, no-wrap +msgid "\"port\"" +msgstr "" + +#. type: table +#: doc/guix.texi:16186 +msgid "Listen on a TCP socket to all addresses on a specific port." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16186 +#, no-wrap +msgid "\"/path/to/unix/socket\"" +msgstr "" + +#. type: table +#: doc/guix.texi:16188 +msgid "Listen on a unix socket." +msgstr "" + +#. type: item +#: doc/guix.texi:16190 +#, no-wrap +msgid "@code{user} (default: @code{php-fpm})" +msgstr "" + +#. type: table +#: doc/guix.texi:16192 +msgid "User who will own the php worker processes." +msgstr "" + +#. type: item +#: doc/guix.texi:16192 +#, no-wrap +msgid "@code{group} (default: @code{php-fpm})" +msgstr "" + +#. type: table +#: doc/guix.texi:16194 +msgid "Group of the worker processes." +msgstr "" + +#. type: item +#: doc/guix.texi:16194 +#, no-wrap +msgid "@code{socket-user} (default: @code{php-fpm})" +msgstr "" + +#. type: table +#: doc/guix.texi:16196 +msgid "User who can speak to the php-fpm socket." +msgstr "" + +#. type: item +#: doc/guix.texi:16196 +#, no-wrap +msgid "@code{socket-group} (default: @code{php-fpm})" +msgstr "" + +#. type: table +#: doc/guix.texi:16198 +msgid "Group that can speak to the php-fpm socket." +msgstr "" + +#. type: item +#: doc/guix.texi:16198 +#, no-wrap +msgid "@code{pid-file} (default: @code{(string-append \"/var/run/php\" (version-major (package-version php)) \"-fpm.pid\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:16201 +msgid "The process id of the php-fpm process is written to this file once the service has started." +msgstr "" + +#. type: item +#: doc/guix.texi:16201 +#, no-wrap +msgid "@code{log-file} (default: @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.log\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:16203 +msgid "Log for the php-fpm master process." +msgstr "" + +#. type: item +#: doc/guix.texi:16203 +#, no-wrap +msgid "@code{process-manager} (default: @code{(php-fpm-dynamic-process-manager-configuration)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16206 +msgid "Detailed settings for the php-fpm process manager. Must be either:" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16207 +#, no-wrap +msgid "<php-fpm-dynamic-process-manager-configuration>" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16208 +#, no-wrap +msgid "<php-fpm-static-process-manager-configuration>" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16209 +#, no-wrap +msgid "<php-fpm-on-demand-process-manager-configuration>" +msgstr "" + +#. type: item +#: doc/guix.texi:16211 +#, no-wrap +msgid "@code{display-errors} (default @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16216 +msgid "Determines whether php errors and warning should be sent to clients and displayed in their browsers. This is useful for local php development, but a security risk for public sites, as error messages can reveal passwords and personal data." +msgstr "" + +#. type: item +#: doc/guix.texi:16216 +#, no-wrap +msgid "@code{workers-logfile} (default @code{(string-append \"/var/log/php\" (version-major (package-version php)) \"-fpm.www.log\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:16219 +msgid "This file will log the @code{stderr} outputs of php worker processes. Can be set to @code{#f} to disable logging." +msgstr "" + +#. type: item +#: doc/guix.texi:16219 +#, no-wrap +msgid "@code{file} (default @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16222 +msgid "An optional override of the whole configuration. You can use the @code{mixed-text-file} function or an absolute filepath for it." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16225 +#, no-wrap +msgid "{Data type} php-fpm-dynamic-process-manager-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16229 +msgid "Data Type for the @code{dynamic} php-fpm process manager. With the @code{dynamic} process manager, spare worker processes are kept around based on it's configured limits." +msgstr "" + +#. type: item +#: doc/guix.texi:16230 doc/guix.texi:16246 doc/guix.texi:16256 +#, no-wrap +msgid "@code{max-children} (default: @code{5})" +msgstr "" + +#. type: table +#: doc/guix.texi:16232 doc/guix.texi:16248 doc/guix.texi:16258 +msgid "Maximum of worker processes." +msgstr "" + +#. type: item +#: doc/guix.texi:16232 +#, no-wrap +msgid "@code{start-servers} (default: @code{2})" +msgstr "" + +#. type: table +#: doc/guix.texi:16234 +msgid "How many worker processes should be started on start-up." +msgstr "" + +#. type: item +#: doc/guix.texi:16234 +#, no-wrap +msgid "@code{min-spare-servers} (default: @code{1})" +msgstr "" + +#. type: table +#: doc/guix.texi:16236 +msgid "How many spare worker processes should be kept around at minimum." +msgstr "" + +#. type: item +#: doc/guix.texi:16236 +#, no-wrap +msgid "@code{max-spare-servers} (default: @code{3})" +msgstr "" + +#. type: table +#: doc/guix.texi:16238 +msgid "How many spare worker processes should be kept around at maximum." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16241 +#, no-wrap +msgid "{Data type} php-fpm-static-process-manager-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16245 +msgid "Data Type for the @code{static} php-fpm process manager. With the @code{static} process manager, an unchanging number of worker processes are created." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16251 +#, no-wrap +msgid "{Data type} php-fpm-on-demand-process-manager-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16255 +msgid "Data Type for the @code{on-demand} php-fpm process manager. With the @code{on-demand} process manager, worker processes are only created as requests arrive." +msgstr "" + +#. type: item +#: doc/guix.texi:16258 +#, no-wrap +msgid "@code{process-idle-timeout} (default: @code{10})" +msgstr "" + +#. type: table +#: doc/guix.texi:16260 +msgid "The time in seconds after which a process with no requests is killed." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16264 +#, no-wrap +msgid "{Scheme Procedure} nginx-php-fpm-location @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16270 +msgid "[#:nginx-package nginx] @ [socket (string-append \"/var/run/php\" @ (version-major (package-version php)) @ \"-fpm.sock\")] A helper function to quickly add php to an @code{nginx-server-configuration}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16273 +msgid "A simple services setup for nginx with php can look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:16286 +#, no-wrap +msgid "" +"(services (cons* (dhcp-client-service)\n" +" (service php-fpm-service-type)\n" +" (service nginx-service-type\n" +" (nginx-server-configuration\n" +" (server-name '(\"example.com\"))\n" +" (root \"/srv/http/\")\n" +" (locations\n" +" (list (nginx-php-location)))\n" +" (https-port #f)\n" +" (ssl-certificate #f)\n" +" (ssl-certificate-key #f)))\n" +" %base-services))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16288 +#, no-wrap +msgid "cat-avatar-generator" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16292 +msgid "The cat avatar generator is a simple service to demonstrate the use of php-fpm in @code{Nginx}. It is used to generate cat avatar from a seed, for instance the hash of a user's email address." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16293 +#, no-wrap +msgid "{Scheme Procedure} cat-avatar-generator-serice @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16301 +msgid "[#:cache-dir \"/var/cache/cat-avatar-generator\"] @ [#:package cat-avatar-generator] @ [#:configuration (nginx-server-configuration)] Returns an nginx-server-configuration that inherits @code{configuration}. It extends the nginx configuration to add a server block that serves @code{package}, a version of cat-avatar-generator. During execution, cat-avatar-generator will be able to use @code{cache-dir} as its cache directory." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16304 +msgid "A simple setup for cat-avatar-generator can look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:16311 +#, no-wrap +msgid "" +"(services (cons* (cat-avatar-generator-service\n" +" #:configuration\n" +" (nginx-server-configuration\n" +" (server-name '(\"example.com\"))))\n" +" ...\n" +" %base-services))\n" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:16313 +#, no-wrap +msgid "Hpcguix-web" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16315 +#, no-wrap +msgid "hpcguix-web" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16320 +msgid "The @uref{hpcguix-web, https://github.com/UMCUGenetics/hpcguix-web/} program is a customizable web interface to browse Guix packages, initially designed for users of high-performance computing (HPC) clusters." +msgstr "" + +#. type: defvr +#: doc/guix.texi:16321 +#, no-wrap +msgid "{Scheme Variable} hpcguix-web-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:16323 +msgid "The service type for @code{hpcguix-web}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16325 +#, no-wrap +msgid "{Data Type} hpcguix-web-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16327 +msgid "Data type for the hpcguix-web service configuration." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:16329 +#, no-wrap +msgid "specs" +msgstr "" + +#. type: table +#: doc/guix.texi:16332 +msgid "A gexp (@pxref{G-Expressions}) specifying the hpcguix-web service configuration. The main items available in this spec are:" +msgstr "" + +#. type: item +#: doc/guix.texi:16334 +#, no-wrap +msgid "@code{title-prefix} (default: @code{\"hpcguix | \"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16336 +msgid "The page title prefix." +msgstr "" + +#. type: item +#: doc/guix.texi:16337 +#, no-wrap +msgid "@code{guix-command} (default: @code{\"guix\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16339 +msgid "The @command{guix} command." +msgstr "" + +#. type: item +#: doc/guix.texi:16340 +#, no-wrap +msgid "@code{package-filter-proc} (default: @code{(const #t)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16342 +msgid "A procedure specifying how to filter packages that are displayed." +msgstr "" + +#. type: item +#: doc/guix.texi:16343 +#, no-wrap +msgid "@code{package-page-extension-proc} (default: @code{(const '())})" +msgstr "" + +#. type: table +#: doc/guix.texi:16345 +msgid "Extension package for @code{hpcguix-web}." +msgstr "" + +#. type: item +#: doc/guix.texi:16346 +#, no-wrap +msgid "@code{menu} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16348 +msgid "Additional entry in page @code{menu}." +msgstr "" + +#. type: table +#: doc/guix.texi:16353 +msgid "See the hpcguix-web repository for a @uref{https://github.com/UMCUGenetics/hpcguix-web/blob/master/hpcweb-configuration.scm, complete example}." +msgstr "" + +#. type: item +#: doc/guix.texi:16354 +#, no-wrap +msgid "@code{package} (default: @code{hpcguix-web})" +msgstr "" + +#. type: table +#: doc/guix.texi:16356 +msgid "The hpcguix-web package to use." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16360 +msgid "A typical hpcguix-web service declaration looks like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:16369 +#, no-wrap +msgid "" +"(service hpcguix-web-service-type\n" +" (hpcguix-web-configuration\n" +" (specs\n" +" #~(define site-config\n" +" (hpcweb-configuration\n" +" (title-prefix \"Guix-HPC - \")\n" +" (menu '((\"/about\" \"ABOUT\"))))))))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16374 +#, no-wrap +msgid "Web" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16375 +#, no-wrap +msgid "HTTP, HTTPS" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16376 +#, no-wrap +msgid "Let's Encrypt" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16377 +#, no-wrap +msgid "TLS certificates" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16384 +msgid "The @code{(gnu services certbot)} module provides a service to automatically obtain a valid TLS certificate from the Let's Encrypt certificate authority. These certificates can then be used to serve content securely over HTTPS or other TLS-based protocols, with the knowledge that the client will be able to verify the server's authenticity." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16396 +msgid "@url{https://letsencrypt.org/, Let's Encrypt} provides the @code{certbot} tool to automate the certification process. This tool first securely generates a key on the server. It then makes a request to the Let's Encrypt certificate authority (CA) to sign the key. The CA checks that the request originates from the host in question by using a challenge-response protocol, requiring the server to provide its response over HTTP. If that protocol completes successfully, the CA signs the key, resulting in a certificate. That certificate is valid for a limited period of time, and therefore to continue to provide TLS services, the server needs to periodically ask the CA to renew its signature." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16403 +msgid "The certbot service automates this process: the initial key generation, the initial certification request to the Let's Encrypt service, the web server challenge/response integration, writing the certificate to disk, the automated periodic renewals, and the deployment tasks associated with the renewal (e.g. reloading services, copying keys with different permissions)." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16409 +msgid "Certbot is run twice a day, at a random minute within the hour. It won't do anything until your certificates are due for renewal or revoked, but running it regularly would give your service a chance of staying online in case a Let's Encrypt-initiated revocation happened for some reason." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16413 +msgid "By using this service, you agree to the ACME Subscriber Agreement, which can be found there: @url{https://acme-v01.api.letsencrypt.org/directory}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:16414 +#, no-wrap +msgid "{Scheme Variable} certbot-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:16417 +msgid "A service type for the @code{certbot} Let's Encrypt client. Its value must be a @code{certbot-configuration} record as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:16424 +#, no-wrap +msgid "" +"(define %nginx-deploy-hook\n" +" (program-file\n" +" \"nginx-deploy-hook\"\n" +" #~(let ((pid (call-with-input-file \"/var/run/nginx/pid\" read)))\n" +" (kill pid SIGHUP))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:16435 +#, no-wrap +msgid "" +"(service certbot-service-type\n" +" (certbot-configuration\n" +" (email \"foo@@example.net\")\n" +" (certificates\n" +" (list\n" +" (certificate-configuration\n" +" (domains '(\"example.net\" \"www.example.net\"))\n" +" (deploy-hook %nginx-deploy-hook))\n" +" (certificate-configuration\n" +" (domains '(\"bar.example.net\")))))))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:16438 +msgid "See below for details about @code{certbot-configuration}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16440 +#, no-wrap +msgid "{Data Type} certbot-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16443 +msgid "Data type representing the configuration of the @code{certbot} service. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16445 +#, no-wrap +msgid "@code{package} (default: @code{certbot})" +msgstr "" + +#. type: table +#: doc/guix.texi:16447 +msgid "The certbot package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:16448 +#, no-wrap +msgid "@code{webroot} (default: @code{/var/www})" +msgstr "" + +#. type: table +#: doc/guix.texi:16451 +msgid "The directory from which to serve the Let's Encrypt challenge/response files." +msgstr "" + +#. type: item +#: doc/guix.texi:16452 +#, no-wrap +msgid "@code{certificates} (default: @code{()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16456 +msgid "A list of @code{certificates-configuration}s for which to generate certificates and request signatures. Each certificate has a @code{name} and several @code{domains}." +msgstr "" + +#. type: table +#: doc/guix.texi:16460 +msgid "Mandatory email used for registration, recovery contact, and important account notifications." +msgstr "" + +#. type: item +#: doc/guix.texi:16461 +#, no-wrap +msgid "@code{rsa-key-size} (default: @code{2048})" +msgstr "" + +#. type: table +#: doc/guix.texi:16463 +msgid "Size of the RSA key." +msgstr "" + +#. type: item +#: doc/guix.texi:16464 +#, no-wrap +msgid "@code{default-location} (default: @i{see below})" +msgstr "" + +#. type: table +#: doc/guix.texi:16473 +msgid "The default @code{nginx-location-configuration}. Because @code{certbot} needs to be able to serve challenges and responses, it needs to be able to run a web server. It does so by extending the @code{nginx} web service with an @code{nginx-server-configuration} listening on the @var{domains} on port 80, and which has a @code{nginx-location-configuration} for the @code{/.well-known/} URI path subspace used by Let's Encrypt. @xref{Web Services}, for more on these nginx configuration data types." +msgstr "" + +#. type: table +#: doc/guix.texi:16477 +msgid "Requests to other URL paths will be matched by the @code{default-location}, which if present is added to all @code{nginx-server-configuration}s." +msgstr "" + +#. type: table +#: doc/guix.texi:16481 +msgid "By default, the @code{default-location} will issue a redirect from @code{http://@var{domain}/...} to @code{https://@var{domain}/...}, leaving you to define what to serve on your site via @code{https}." +msgstr "" + +#. type: table +#: doc/guix.texi:16483 +msgid "Pass @code{#f} to not issue a default location." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16486 +#, no-wrap +msgid "{Data Type} certificate-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16489 +msgid "Data type representing the configuration of a certificate. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16491 +#, no-wrap +msgid "@code{name} (default: @i{see below})" +msgstr "" + +#. type: table +#: doc/guix.texi:16495 +msgid "This name is used by Certbot for housekeeping and in file paths; it doesn't affect the content of the certificate itself. To see certificate names, run @code{certbot certificates}." +msgstr "" + +#. type: table +#: doc/guix.texi:16497 +msgid "Its default is the first provided domain." +msgstr "" + +#. type: item +#: doc/guix.texi:16498 +#, no-wrap +msgid "@code{domains} (default: @code{()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16501 +msgid "The first domain provided will be the subject CN of the certificate, and all domains will be Subject Alternative Names on the certificate." +msgstr "" + +#. type: item +#: doc/guix.texi:16502 +#, no-wrap +msgid "@code{deploy-hook} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16510 +msgid "Command to be run in a shell once for each successfully issued certificate. For this command, the shell variable @code{$RENEWED_LINEAGE} will point to the config live subdirectory (for example, @samp{\"/etc/letsencrypt/live/example.com\"}) containing the new certificates and keys; the shell variable @code{$RENEWED_DOMAINS} will contain a space-delimited list of renewed certificate domains (for example, @samp{\"example.com www.example.com\"}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16517 +msgid "For each @code{certificate-configuration}, the certificate is saved to @code{/etc/letsencrypt/live/@var{name}/fullchain.pem} and the key is saved to @code{/etc/letsencrypt/live/@var{name}/privkey.pem}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:16519 +#, no-wrap +msgid "DNS (domain name system)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16520 +#, no-wrap +msgid "domain name system (DNS)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16528 +msgid "The @code{(gnu services dns)} module provides services related to the @dfn{domain name system} (DNS). It provides a server service for hosting an @emph{authoritative} DNS server for multiple zones, slave or master. This service uses @uref{https://www.knot-dns.cz/, Knot DNS}. And also a caching and forwarding DNS server for the LAN, which uses @uref{http://www.thekelleys.org.uk/dnsmasq/doc.html, dnsmasq}." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:16529 +#, no-wrap +msgid "Knot Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16533 +msgid "An example configuration of an authoritative server for two zones, one master and one slave, is:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:16540 +#, no-wrap +msgid "" +"(define-zone-entries example.org.zone\n" +";; Name TTL Class Type Data\n" +" (\"@@\" \"\" \"IN\" \"A\" \"127.0.0.1\")\n" +" (\"@@\" \"\" \"IN\" \"NS\" \"ns\")\n" +" (\"ns\" \"\" \"IN\" \"A\" \"127.0.0.1\"))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:16547 +#, no-wrap +msgid "" +"(define master-zone\n" +" (knot-zone-configuration\n" +" (domain \"example.org\")\n" +" (zone (zone-file\n" +" (origin \"example.org\")\n" +" (entries example.org.zone)))))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:16553 +#, no-wrap +msgid "" +"(define slave-zone\n" +" (knot-zone-configuration\n" +" (domain \"plop.org\")\n" +" (dnssec-policy \"default\")\n" +" (master (list \"plop-master\"))))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:16558 +#, no-wrap +msgid "" +"(define plop-master\n" +" (knot-remote-configuration\n" +" (id \"plop-master\")\n" +" (address (list \"208.76.58.171\"))))\n" +"\n" +msgstr "" + +#. type: lisp +#: doc/guix.texi:16567 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; ...\n" +" (services (cons* (service knot-service-type\n" +" (knot-configuration\n" +" (remotes (list plop-master))\n" +" (zones (list master-zone slave-zone))))\n" +" ;; ...\n" +" %base-services)))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16569 +#, no-wrap +msgid "{Scheme Variable} knot-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16571 +msgid "This is the type for the Knot DNS server." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16579 +msgid "Knot DNS is an authoritative DNS server, meaning that it can serve multiple zones, that is to say domain names you would buy from a registrar. This server is not a resolver, meaning that it can only resolve names for which it is authoritative. This server can be configured to serve zones as a master server or a slave server as a per-zone basis. Slave zones will get their data from masters, and will serve it as an authoritative server. From the point of view of a resolver, there is no difference between master and slave." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16581 +msgid "The following data types are used to configure the Knot DNS server:" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16583 +#, no-wrap +msgid "{Data Type} knot-key-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16586 +msgid "Data type representing a key. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16588 doc/guix.texi:16608 doc/guix.texi:16723 +#: doc/guix.texi:16749 doc/guix.texi:16784 +#, no-wrap +msgid "@code{id} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16591 +msgid "An identifier for other configuration fields to refer to this key. IDs must be unique and must not be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16592 +#, no-wrap +msgid "@code{algorithm} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16596 +msgid "The algorithm to use. Choose between @code{#f}, @code{'hmac-md5}, @code{'hmac-sha1}, @code{'hmac-sha224}, @code{'hmac-sha256}, @code{'hmac-sha384} and @code{'hmac-sha512}." +msgstr "" + +#. type: item +#: doc/guix.texi:16597 +#, no-wrap +msgid "@code{secret} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16599 +msgid "The secret key itself." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16603 +#, no-wrap +msgid "{Data Type} knot-acl-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16606 +msgid "Data type representing an Access Control List (ACL) configuration. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16611 +msgid "An identifier for ether configuration fields to refer to this key. IDs must be unique and must not be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16612 doc/guix.texi:16727 +#, no-wrap +msgid "@code{address} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16616 +msgid "An ordered list of IP addresses, network subnets, or network ranges represented with strings. The query must match one of them. Empty value means that address match is not required." +msgstr "" + +#. type: item +#: doc/guix.texi:16617 +#, no-wrap +msgid "@code{key} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16621 +msgid "An ordered list of references to keys represented with strings. The string must match a key ID defined in a @code{knot-key-configuration}. No key means that a key is not require to match that ACL." +msgstr "" + +#. type: item +#: doc/guix.texi:16622 +#, no-wrap +msgid "@code{action} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16626 +msgid "An ordered list of actions that are permitted or forbidden by this ACL. Possible values are lists of zero or more elements from @code{'transfer}, @code{'notify} and @code{'update}." +msgstr "" + +#. type: item +#: doc/guix.texi:16627 +#, no-wrap +msgid "@code{deny?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16630 +msgid "When true, the ACL defines restrictions. Listed actions are forbidden. When false, listed actions are allowed." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16634 +#, no-wrap +msgid "{Data Type} zone-entry" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16637 +msgid "Data type represnting a record entry in a zone file. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16639 +#, no-wrap +msgid "@code{name} (default: @code{\"@@\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16645 +msgid "The name of the record. @code{\"@@\"} refers to the origin of the zone. Names are relative to the origin of the zone. For example, in the @code{example.org} zone, @code{\"ns.example.org\"} actually refers to @code{ns.example.org.example.org}. Names ending with a dot are absolute, which means that @code{\"ns.example.org.\"} refers to @code{ns.example.org}." +msgstr "" + +#. type: item +#: doc/guix.texi:16646 +#, no-wrap +msgid "@code{ttl} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16648 +msgid "The Time-To-Live (TTL) of this record. If not set, the default TTL is used." +msgstr "" + +#. type: item +#: doc/guix.texi:16649 +#, no-wrap +msgid "@code{class} (default: @code{\"IN\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16652 +msgid "The class of the record. Knot currently supports only @code{\"IN\"} and partially @code{\"CH\"}." +msgstr "" + +#. type: item +#: doc/guix.texi:16653 +#, no-wrap +msgid "@code{type} (default: @code{\"A\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16657 +msgid "The type of the record. Common types include A (IPv4 address), AAAA (IPv6 address), NS (Name Server) and MX (Mail eXchange). Many other types are defined." +msgstr "" + +#. type: item +#: doc/guix.texi:16658 +#, no-wrap +msgid "@code{data} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16662 +msgid "The data contained in the record. For instance an IP address associated with an A record, or a domain name associated with an NS record. Remember that domain names are relative to the origin unless they end with a dot." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16666 +#, no-wrap +msgid "{Data Type} zone-file" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16669 +msgid "Data type representing the content of a zone file. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16678 +msgid "The list of entries. The SOA record is taken care of, so you don't need to put it in the list of entries. This list should probably contain an entry for your primary authoritative DNS server. Other than using a list of entries directly, you can use @code{define-zone-entries} to define a object containing the list of entries more easily, that you can later pass to the @code{entries} field of the @code{zone-file}." +msgstr "" + +#. type: item +#: doc/guix.texi:16679 +#, no-wrap +msgid "@code{origin} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16681 +msgid "The name of your zone. This parameter cannot be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16682 +#, no-wrap +msgid "@code{ns} (default: @code{\"ns\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16687 +msgid "The domain of your primary authoritative DNS server. The name is relative to the origin, unless it ends with a dot. It is mandatory that this primary DNS server corresponds to an NS record in the zone and that it is associated to an IP address in the list of entries." +msgstr "" + +#. type: item +#: doc/guix.texi:16688 +#, no-wrap +msgid "@code{mail} (default: @code{\"hostmaster\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16691 +msgid "An email address people can contact you at, as the owner of the zone. This is translated as @code{<mail>@@<origin>}." +msgstr "" + +#. type: item +#: doc/guix.texi:16692 +#, no-wrap +msgid "@code{serial} (default: @code{1})" +msgstr "" + +#. type: table +#: doc/guix.texi:16696 +msgid "The serial number of the zone. As this is used to keep track of changes by both slaves and resolvers, it is mandatory that it @emph{never} decreases. Always increment it when you make a change in your zone." +msgstr "" + +#. type: item +#: doc/guix.texi:16697 +#, no-wrap +msgid "@code{refresh} (default: @code{(* 2 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16701 +msgid "The frequency at which slaves will do a zone transfer. This value is a number of seconds. It can be computed by multiplications or with @code{(string->duration)}." +msgstr "" + +#. type: item +#: doc/guix.texi:16702 +#, no-wrap +msgid "@code{retry} (default: @code{(* 15 60)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16705 +msgid "The period after which a slave will retry to contact its master when it fails to do so a first time." +msgstr "" + +#. type: item +#: doc/guix.texi:16706 +#, no-wrap +msgid "@code{expiry} (default: @code{(* 14 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16710 +msgid "Default TTL of records. Existing records are considered correct for at most this amount of time. After this period, resolvers will invalidate their cache and check again that it still exists." +msgstr "" + +#. type: item +#: doc/guix.texi:16711 +#, no-wrap +msgid "@code{nx} (default: @code{3600})" +msgstr "" + +#. type: table +#: doc/guix.texi:16714 +msgid "Default TTL of inexistant records. This delay is usually short because you want your new domains to reach everyone quickly." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16718 +#, no-wrap +msgid "{Data Type} knot-remote-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16721 +msgid "Data type representing a remote configuration. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16726 +msgid "An identifier for other configuration fields to refer to this remote. IDs must be unique and must not be empty." +msgstr "" + +#. type: table +#: doc/guix.texi:16731 +msgid "An ordered list of destination IP addresses. Addresses are tried in sequence. An optional port can be given with the @@ separator. For instance: @code{(list \"1.2.3.4\" \"2.3.4.5@@53\")}. Default port is 53." +msgstr "" + +#. type: item +#: doc/guix.texi:16732 +#, no-wrap +msgid "@code{via} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16736 +msgid "An ordered list of source IP addresses. An empty list will have Knot choose an appropriate source IP. An optional port can be given with the @@ separator. The default is to choose at random." +msgstr "" + +#. type: item +#: doc/guix.texi:16737 +#, no-wrap +msgid "@code{key} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16740 +msgid "A reference to a key, that is a string containing the identifier of a key defined in a @code{knot-key-configuration} field." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16744 +#, no-wrap +msgid "{Data Type} knot-keystore-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16747 +msgid "Data type representing a keystore to hold dnssec keys. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16751 +msgid "The id of the keystore. It must not be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16752 +#, no-wrap +msgid "@code{backend} (default: @code{'pem})" +msgstr "" + +#. type: table +#: doc/guix.texi:16754 +msgid "The backend to store the keys in. Can be @code{'pem} or @code{'pkcs11}." +msgstr "" + +#. type: item +#: doc/guix.texi:16755 +#, no-wrap +msgid "@code{config} (default: @code{\"/var/lib/knot/keys/keys\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16759 +msgid "The configuration string of the backend. An example for the PKCS#11 is: @code{\"pkcs11:token=knot;pin-value=1234 /gnu/store/.../lib/pkcs11/libsofthsm2.so\"}. For the pem backend, the string reprensents a path in the file system." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16763 +#, no-wrap +msgid "{Data Type} knot-policy-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16767 +msgid "Data type representing a dnssec policy. Knot DNS is able to automatically sign your zones. It can either generate and manage your keys automatically or use keys that you generate." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16774 +msgid "Dnssec is usually implemented using two keys: a Key Signing Key (KSK) that is used to sign the second, and a Zone Signing Key (ZSK) that is used to sign the zone. In order to be trusted, the KSK needs to be present in the parent zone (usually a top-level domain). If your registrar supports dnssec, you will have to send them your KSK's hash so they can add a DS record in their zone. This is not automated and need to be done each time you change your KSK." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16780 +msgid "The policy also defines the lifetime of keys. Usually, ZSK can be changed easily and use weaker cryptographic functions (they use lower parameters) in order to sign records quickly, so they are changed often. The KSK however requires manual interaction with the registrar, so they are changed less often and use stronger parameters because they sign only one record." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16782 +msgid "This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:16786 +msgid "The id of the policy. It must not be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16787 +#, no-wrap +msgid "@code{keystore} (default: @code{\"default\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16792 +msgid "A reference to a keystore, that is a string containing the identifier of a keystore defined in a @code{knot-keystore-configuration} field. The @code{\"default\"} identifier means the default keystore (a kasp database that was setup by this service)." +msgstr "" + +#. type: item +#: doc/guix.texi:16793 +#, no-wrap +msgid "@code{manual?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16795 +msgid "Whether the key management is manual or automatic." +msgstr "" + +#. type: item +#: doc/guix.texi:16796 +#, no-wrap +msgid "@code{single-type-signing?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16798 +msgid "When @code{#t}, use the Single-Type Signing Scheme." +msgstr "" + +#. type: item +#: doc/guix.texi:16799 +#, no-wrap +msgid "@code{algorithm} (default: @code{\"ecdsap256sha256\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16801 +msgid "An algorithm of signing keys and issued signatures." +msgstr "" + +#. type: item +#: doc/guix.texi:16802 +#, no-wrap +msgid "@code{ksk-size} (default: @code{256})" +msgstr "" + +#. type: table +#: doc/guix.texi:16805 +msgid "The length of the KSK. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms." +msgstr "" + +#. type: item +#: doc/guix.texi:16806 +#, no-wrap +msgid "@code{zsk-size} (default: @code{256})" +msgstr "" + +#. type: table +#: doc/guix.texi:16809 +msgid "The length of the ZSK. Note that this value is correct for the default algorithm, but would be unsecure for other algorithms." +msgstr "" + +#. type: item +#: doc/guix.texi:16810 +#, no-wrap +msgid "@code{dnskey-ttl} (default: @code{'default})" +msgstr "" + +#. type: table +#: doc/guix.texi:16813 +msgid "The TTL value for DNSKEY records added into zone apex. The special @code{'default} value means same as the zone SOA TTL." +msgstr "" + +#. type: item +#: doc/guix.texi:16814 +#, no-wrap +msgid "@code{zsk-lifetime} (default: @code{(* 30 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16816 +msgid "The period between ZSK publication and the next rollover initiation." +msgstr "" + +#. type: item +#: doc/guix.texi:16817 +#, no-wrap +msgid "@code{propagation-delay} (default: @code{(* 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16820 +msgid "An extra delay added for each key rollover step. This value should be high enough to cover propagation of data from the master server to all slaves." +msgstr "" + +#. type: item +#: doc/guix.texi:16821 +#, no-wrap +msgid "@code{rrsig-lifetime} (default: @code{(* 14 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16823 +msgid "A validity period of newly issued signatures." +msgstr "" + +#. type: item +#: doc/guix.texi:16824 +#, no-wrap +msgid "@code{rrsig-refresh} (default: @code{(* 7 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16826 +msgid "A period how long before a signature expiration the signature will be refreshed." +msgstr "" + +#. type: item +#: doc/guix.texi:16827 +#, no-wrap +msgid "@code{nsec3?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16829 +msgid "When @code{#t}, NSEC3 will be used instead of NSEC." +msgstr "" + +#. type: item +#: doc/guix.texi:16830 +#, no-wrap +msgid "@code{nsec3-iterations} (default: @code{5})" +msgstr "" + +#. type: table +#: doc/guix.texi:16832 +msgid "The number of additional times the hashing is performed." +msgstr "" + +#. type: item +#: doc/guix.texi:16833 +#, no-wrap +msgid "@code{nsec3-salt-length} (default: @code{8})" +msgstr "" + +#. type: table +#: doc/guix.texi:16836 +msgid "The length of a salt field in octets, which is appended to the original owner name before hashing." +msgstr "" + +#. type: item +#: doc/guix.texi:16837 +#, no-wrap +msgid "@code{nsec3-salt-lifetime} (default: @code{(* 30 24 3600)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16839 +msgid "The validity period of newly issued salt field." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16843 +#, no-wrap +msgid "{Data Type} knot-zone-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16846 +msgid "Data type representing a zone served by Knot. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16848 +#, no-wrap +msgid "@code{domain} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16850 +msgid "The domain served by this configuration. It must not be empty." +msgstr "" + +#. type: item +#: doc/guix.texi:16851 +#, no-wrap +msgid "@code{file} (default: @code{\"\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16854 +msgid "The file where this zone is saved. This parameter is ignored by master zones. Empty means default location that depends on the domain name." +msgstr "" + +#. type: item +#: doc/guix.texi:16855 +#, no-wrap +msgid "@code{zone} (default: @code{(zone-file)})" +msgstr "" + +#. type: table +#: doc/guix.texi:16858 +msgid "The content of the zone file. This parameter is ignored by slave zones. It must contain a zone-file record." +msgstr "" + +#. type: item +#: doc/guix.texi:16859 +#, no-wrap +msgid "@code{master} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16862 +msgid "A list of master remotes. When empty, this zone is a master. When set, this zone is a slave. This is a list of remotes identifiers." +msgstr "" + +#. type: item +#: doc/guix.texi:16863 +#, no-wrap +msgid "@code{ddns-master} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16866 +msgid "The main master. When empty, it defaults to the first master in the list of masters." +msgstr "" + +#. type: item +#: doc/guix.texi:16867 +#, no-wrap +msgid "@code{notify} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16869 +msgid "A list of slave remote identifiers." +msgstr "" + +#. type: item +#: doc/guix.texi:16870 +#, no-wrap +msgid "@code{acl} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16872 +msgid "A list of acl identifiers." +msgstr "" + +#. type: item +#: doc/guix.texi:16873 +#, no-wrap +msgid "@code{semantic-checks?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16875 +msgid "When set, this adds more semantic checks to the zone." +msgstr "" + +#. type: item +#: doc/guix.texi:16876 +#, no-wrap +msgid "@code{disable-any?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16878 +msgid "When set, this forbids queries of the ANY type." +msgstr "" + +#. type: item +#: doc/guix.texi:16879 +#, no-wrap +msgid "@code{zonefile-sync} (default: @code{0})" +msgstr "" + +#. type: table +#: doc/guix.texi:16882 +msgid "The delay between a modification in memory and on disk. 0 means immediate synchronization." +msgstr "" + +#. type: item +#: doc/guix.texi:16883 +#, no-wrap +msgid "@code{serial-policy} (default: @code{'increment})" +msgstr "" + +#. type: table +#: doc/guix.texi:16885 +msgid "A policy between @code{'increment} and @code{'unixtime}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:16889 +#, no-wrap +msgid "{Data Type} knot-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16892 +msgid "Data type representing the Knot configuration. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:16894 +#, no-wrap +msgid "@code{knot} (default: @code{knot})" +msgstr "" + +#. type: table +#: doc/guix.texi:16896 +msgid "The Knot package." +msgstr "" + +#. type: item +#: doc/guix.texi:16897 +#, no-wrap +msgid "@code{run-directory} (default: @code{\"/var/run/knot\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16899 +msgid "The run directory. This directory will be used for pid file and sockets." +msgstr "" + +#. type: item +#: doc/guix.texi:16900 +#, no-wrap +msgid "@code{listen-v4} (default: @code{\"0.0.0.0\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16902 doc/guix.texi:16905 +msgid "An ip address on which to listen." +msgstr "" + +#. type: item +#: doc/guix.texi:16903 +#, no-wrap +msgid "@code{listen-v6} (default: @code{\"::\"})" +msgstr "" + +#. type: item +#: doc/guix.texi:16906 +#, no-wrap +msgid "@code{listen-port} (default: @code{53})" +msgstr "" + +#. type: table +#: doc/guix.texi:16908 +msgid "A port on which to listen." +msgstr "" + +#. type: item +#: doc/guix.texi:16909 +#, no-wrap +msgid "@code{keys} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16911 +msgid "The list of knot-key-configuration used by this configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:16912 +#, no-wrap +msgid "@code{acls} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16914 +msgid "The list of knot-acl-configuration used by this configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:16915 +#, no-wrap +msgid "@code{remotes} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16917 +msgid "The list of knot-remote-configuration used by this configuration." +msgstr "" + +#. type: item +#: doc/guix.texi:16918 +#, no-wrap +msgid "@code{zones} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16920 +msgid "The list of knot-zone-configuration used by this configuration." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:16924 +#, no-wrap +msgid "Dnsmasq Service" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16926 +#, no-wrap +msgid "{Scheme Variable} dnsmasq-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16929 +msgid "This is the type of the dnsmasq service, whose value should be an @code{dnsmasq-configuration} object as in this example:" +msgstr "" + +#. type: example +#: doc/guix.texi:16935 +#, no-wrap +msgid "" +"(service dnsmasq-service-type\n" +" (dnsmasq-configuration\n" +" (no-resolv? #t)\n" +" (servers '(\"192.168.1.1\"))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16938 +#, no-wrap +msgid "{Data Type} dnsmasq-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:16940 +msgid "Data type representing the configuration of dnsmasq." +msgstr "" + +#. type: item +#: doc/guix.texi:16942 +#, no-wrap +msgid "@code{package} (default: @var{dnsmasq})" +msgstr "" + +#. type: table +#: doc/guix.texi:16944 +msgid "Package object of the dnsmasq server." +msgstr "" + +#. type: item +#: doc/guix.texi:16945 +#, no-wrap +msgid "@code{no-hosts?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16947 +msgid "When true, don't read the hostnames in /etc/hosts." +msgstr "" + +#. type: item +#: doc/guix.texi:16948 +#, no-wrap +msgid "@code{port} (default: @code{53})" +msgstr "" + +#. type: table +#: doc/guix.texi:16951 +msgid "The port to listen on. Setting this to zero completely disables DNS funtion, leaving only DHCP and/or TFTP." +msgstr "" + +#. type: item +#: doc/guix.texi:16952 +#, no-wrap +msgid "@code{local-service?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:16955 +msgid "Accept DNS queries only from hosts whose address is on a local subnet, ie a subnet for which an interface exists on the server." +msgstr "" + +#. type: item +#: doc/guix.texi:16956 +#, no-wrap +msgid "@code{listen-addresses} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:16958 +msgid "Listen on the given IP addresses." +msgstr "" + +#. type: item +#: doc/guix.texi:16959 +#, no-wrap +msgid "@code{resolv-file} (default: @code{\"/etc/resolv.conf\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:16961 +msgid "The file to read the IP address of the upstream nameservers from." +msgstr "" + +#. type: item +#: doc/guix.texi:16962 +#, no-wrap +msgid "@code{no-resolv?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:16964 +msgid "When true, don't read @var{resolv-file}." +msgstr "" + +#. type: table +#: doc/guix.texi:16967 +msgid "Specify IP address of upstream servers directly." +msgstr "" + +#. type: item +#: doc/guix.texi:16968 +#, no-wrap +msgid "@code{cache-size} (default: @code{150})" +msgstr "" + +#. type: table +#: doc/guix.texi:16971 +msgid "Set the size of dnsmasq's cache. Setting the cache size to zero disables caching." +msgstr "" + +#. type: item +#: doc/guix.texi:16972 +#, no-wrap +msgid "@code{negative-cache?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:16974 +msgid "When false, disable negative caching." +msgstr "" + +#. type: cindex +#: doc/guix.texi:16980 +#, no-wrap +msgid "VPN (virtual private network)" +msgstr "" + +#. type: cindex +#: doc/guix.texi:16981 +#, no-wrap +msgid "virtual private network (VPN)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:16987 +msgid "The @code{(gnu services vpn)} module provides services related to @dfn{virtual private networks} (VPNs). It provides a @emph{client} service for your machine to connect to a VPN, and a @emph{servire} service for your machine to host a VPN. Both services use @uref{https://openvpn.net/, OpenVPN}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16988 +#, no-wrap +msgid "{Scheme Procedure} openvpn-client-service @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16990 +msgid "[#:config (openvpn-client-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16992 +msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a client." +msgstr "" + +#. type: deffn +#: doc/guix.texi:16994 +#, no-wrap +msgid "{Scheme Procedure} openvpn-server-service @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16996 +msgid "[#:config (openvpn-server-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:16998 +msgid "Return a service that runs @command{openvpn}, a VPN daemon, as a server." +msgstr "" + +#. type: deffn +#: doc/guix.texi:17000 +msgid "Both can be run simultaneously." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17005 +msgid "Available @code{openvpn-client-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17006 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} package openvpn" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17008 doc/guix.texi:17144 +msgid "The OpenVPN package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17011 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} string pid-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17013 doc/guix.texi:17149 +msgid "The OpenVPN pid file." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17015 doc/guix.texi:17151 +msgid "Defaults to @samp{\"/var/run/openvpn/openvpn.pid\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17018 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} proto proto" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17021 doc/guix.texi:17157 +msgid "The protocol (UDP or TCP) used to open a channel between clients and servers." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17023 doc/guix.texi:17159 +msgid "Defaults to @samp{udp}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17026 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} dev dev" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17028 doc/guix.texi:17164 +msgid "The device type used to represent the VPN connection." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17030 doc/guix.texi:17166 +msgid "Defaults to @samp{tun}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17033 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} string ca" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17035 doc/guix.texi:17171 +msgid "The certificate authority to check connections against." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17037 doc/guix.texi:17173 +msgid "Defaults to @samp{\"/etc/openvpn/ca.crt\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17040 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} string cert" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17043 doc/guix.texi:17179 +msgid "The certificate of the machine the daemon is running on. It should be signed by the authority given in @code{ca}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17045 doc/guix.texi:17181 +msgid "Defaults to @samp{\"/etc/openvpn/client.crt\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17048 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} string key" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17051 doc/guix.texi:17187 +msgid "The key of the machine the daemon is running on. It must be the key whose certificate is @code{cert}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17053 doc/guix.texi:17189 +msgid "Defaults to @samp{\"/etc/openvpn/client.key\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17056 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} boolean comp-lzo?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17058 doc/guix.texi:17194 +msgid "Whether to use the lzo compression algorithm." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17063 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} boolean persist-key?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17065 doc/guix.texi:17201 +msgid "Don't re-read key files across SIGUSR1 or --ping-restart." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17070 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} boolean persist-tun?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17073 doc/guix.texi:17209 +msgid "Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17078 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} number verbosity" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17080 doc/guix.texi:17216 +msgid "Verbosity level." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17082 doc/guix.texi:17218 doc/guix.texi:18495 +#: doc/guix.texi:18718 +msgid "Defaults to @samp{3}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17085 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} tls-auth-client tls-auth" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17088 doc/guix.texi:17224 +msgid "Add an additional layer of HMAC authentication on top of the TLS control channel to protect against DoS attacks." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17093 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} key-usage verify-key-usage?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17095 +msgid "Whether to check the server certificate has server usage extension." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17100 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} bind bind?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17102 +msgid "Bind to a specific local port number." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17107 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} resolv-retry resolv-retry?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17109 +msgid "Retry resolving server address." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17114 +#, no-wrap +msgid "{@code{openvpn-client-configuration} parameter} openvpn-remote-list remote" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17116 +msgid "A list of remote servers to connect to." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17120 +msgid "Available @code{openvpn-remote-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17121 +#, no-wrap +msgid "{@code{openvpn-remote-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17123 +msgid "Server name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17125 +msgid "Defaults to @samp{\"my-server\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17128 +#, no-wrap +msgid "{@code{openvpn-remote-configuration} parameter} number port" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17130 +msgid "Port number the server listens to." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17132 doc/guix.texi:17233 +msgid "Defaults to @samp{1194}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17141 +msgid "Available @code{openvpn-server-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17142 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} package openvpn" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17147 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string pid-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17154 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} proto proto" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17162 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} dev dev" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17169 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string ca" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17176 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string cert" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17184 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string key" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17192 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} boolean comp-lzo?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17199 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} boolean persist-key?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17206 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} boolean persist-tun?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17214 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} number verbosity" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17221 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} tls-auth-server tls-auth" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17229 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} number port" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17231 +msgid "Specifies the port number on which the server listens." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17236 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} ip-mask server" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17238 +msgid "An ip and mask specifying the subnet inside the virtual network." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17240 +msgid "Defaults to @samp{\"10.8.0.0 255.255.255.0\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17243 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} cidr6 server-ipv6" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17245 +msgid "A CIDR notation specifying the IPv6 subnet inside the virtual network." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17250 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string dh" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17252 +msgid "The Diffie-Hellman parameters file." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17254 +msgid "Defaults to @samp{\"/etc/openvpn/dh2048.pem\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17257 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string ifconfig-pool-persist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17259 +msgid "The file that records client IPs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17261 +msgid "Defaults to @samp{\"/etc/openvpn/ipp.txt\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17264 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} gateway redirect-gateway?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17266 +msgid "When true, the server will act as a gateway for its clients." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17271 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} boolean client-to-client?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17273 +msgid "When true, clients are allowed to talk to each other inside the VPN." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17278 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} keepalive keepalive" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17284 +msgid "Causes ping-like messages to be sent back and forth over the link so that each side knows when the other side has gone down. @code{keepalive} requires a pair. The first element is the period of the ping sending, and the second element is the timeout before considering the other side down." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17287 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} number max-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17289 +msgid "The maximum number of clients." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17294 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} string status" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17297 +msgid "The status file. This file shows a small report on current connection. It is truncated and rewritten every minute." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17299 +msgid "Defaults to @samp{\"/var/run/openvpn/status\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17302 +#, no-wrap +msgid "{@code{openvpn-server-configuration} parameter} openvpn-ccd-list client-config-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17304 +msgid "The list of configuration for some clients." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17308 +msgid "Available @code{openvpn-ccd-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17309 +#, no-wrap +msgid "{@code{openvpn-ccd-configuration} parameter} string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17311 +msgid "Client name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17313 +msgid "Defaults to @samp{\"client\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17316 +#, no-wrap +msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask iroute" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17318 +msgid "Client own network" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17323 +#, no-wrap +msgid "{@code{openvpn-ccd-configuration} parameter} ip-mask ifconfig-push" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17325 +msgid "Client VPN IP." +msgstr "" + +#. type: cindex +#: doc/guix.texi:17338 +#, no-wrap +msgid "NFS" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17343 +msgid "The @code{(gnu services nfs)} module provides the following services, which are most commonly used in relation to mounting or exporting directory trees as @dfn{network file systems} (NFS)." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:17344 +#, no-wrap +msgid "RPC Bind Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17345 +#, no-wrap +msgid "rpcbind" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17351 +msgid "The RPC Bind service provides a facility to map program numbers into universal addresses. Many NFS related services use this facility. Hence it is automatically started when a dependent service starts." +msgstr "" + +#. type: defvr +#: doc/guix.texi:17352 +#, no-wrap +msgid "{Scheme Variable} rpcbind-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:17354 +msgid "A service type for the RPC portmapper daemon." +msgstr "" + +#. type: deftp +#: doc/guix.texi:17357 +#, no-wrap +msgid "{Data Type} rpcbind-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:17360 +msgid "Data type representing the configuration of the RPC Bind Service. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:17361 +#, no-wrap +msgid "@code{rpcbind} (default: @code{rpcbind})" +msgstr "" + +#. type: table +#: doc/guix.texi:17363 +msgid "The rpcbind package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:17364 +#, no-wrap +msgid "@code{warm-start?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:17368 +msgid "If this parameter is @code{#t}, then the daemon will read a state file on startup thus reloading state information saved by a previous instance." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:17372 +#, no-wrap +msgid "Pipefs Pseudo File System" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17373 +#, no-wrap +msgid "pipefs" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17374 +#, no-wrap +msgid "rpc_pipefs" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17378 +msgid "The pipefs file system is used to transfer NFS related data between the kernel and user space programs." +msgstr "" + +#. type: defvr +#: doc/guix.texi:17379 +#, no-wrap +msgid "{Scheme Variable} pipefs-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:17381 +msgid "A service type for the pipefs pseudo file system." +msgstr "" + +#. type: deftp +#: doc/guix.texi:17383 +#, no-wrap +msgid "{Data Type} pipefs-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:17386 +msgid "Data type representing the configuration of the pipefs pseudo file system service. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:17387 +#, no-wrap +msgid "@code{mount-point} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17389 +msgid "The directory to which the file system is to be attached." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:17393 +#, no-wrap +msgid "GSS Daemon Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17394 +#, no-wrap +msgid "GSSD" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17395 +#, no-wrap +msgid "GSS" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17396 +#, no-wrap +msgid "global security system" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17403 +msgid "The @dfn{global security system} (GSS) daemon provides strong security for RPC based protocols. Before exchanging RPC requests an RPC client must establish a security context. Typically this is done using the Kerberos command @command{kinit} or automatically at login time using PAM services (@pxref{Kerberos Services})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:17404 +#, no-wrap +msgid "{Scheme Variable} gss-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:17406 +msgid "A service type for the Global Security System (GSS) daemon." +msgstr "" + +#. type: deftp +#: doc/guix.texi:17408 +#, no-wrap +msgid "{Data Type} gss-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:17411 +msgid "Data type representing the configuration of the GSS daemon service. This type has the following parameters:" +msgstr "" + +#. type: item +#: doc/guix.texi:17412 doc/guix.texi:17437 +#, no-wrap +msgid "@code{nfs-utils} (default: @code{nfs-utils})" +msgstr "" + +#. type: table +#: doc/guix.texi:17414 +msgid "The package in which the @command{rpc.gssd} command is to be found." +msgstr "" + +#. type: item +#: doc/guix.texi:17415 doc/guix.texi:17440 +#, no-wrap +msgid "@code{pipefs-directory} (default: @code{\"/var/lib/nfs/rpc_pipefs\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17417 doc/guix.texi:17442 +msgid "The directory where the pipefs file system is mounted." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:17422 +#, no-wrap +msgid "IDMAP Daemon Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17423 +#, no-wrap +msgid "idmapd" +msgstr "" + +#. type: cindex +#: doc/guix.texi:17424 +#, no-wrap +msgid "name mapper" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17428 +msgid "The idmap daemon service provides mapping between user IDs and user names. Typically it is required in order to access file systems mounted via NFSv4." +msgstr "" + +#. type: defvr +#: doc/guix.texi:17429 +#, no-wrap +msgid "{Scheme Variable} idmap-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:17431 +msgid "A service type for the Identity Mapper (IDMAP) daemon." +msgstr "" + +#. type: deftp +#: doc/guix.texi:17433 +#, no-wrap +msgid "{Data Type} idmap-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:17436 +msgid "Data type representing the configuration of the IDMAP daemon service. This type has the following parameters:" +msgstr "" + +#. type: table +#: doc/guix.texi:17439 +msgid "The package in which the @command{rpc.idmapd} command is to be found." +msgstr "" + +#. type: item +#: doc/guix.texi:17443 +#, no-wrap +msgid "@code{domain} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:17447 +msgid "The local NFSv4 domain name. This must be a string or @code{#f}. If it is @code{#f} then the daemon will use the host's fully qualified domain name." +msgstr "" + +#. type: cindex +#: doc/guix.texi:17454 +#, no-wrap +msgid "continuous integration" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17458 +msgid "@uref{https://notabug.org/mthl/cuirass, Cuirass} is a continuous integration tool for Guix. It can be used both for development and for providing substitutes to others (@pxref{Substitutes})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17460 +msgid "The @code{(gnu services cuirass)} module provides the following service." +msgstr "" + +#. type: defvr +#: doc/guix.texi:17461 +#, no-wrap +msgid "{Scheme Procedure} cuirass-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:17464 +msgid "The type of the Cuirass service. Its value must be a @code{cuirass-configuration} object, as described below." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17471 +msgid "To add build jobs, you have to set the @code{specifications} field of the configuration. Here is an example of a service defining a build job based on a specification that can be found in Cuirass source tree. This service polls the Guix repository and builds a subset of the Guix packages, as prescribed in the @file{gnu-system.scm} example spec:" +msgstr "" + +#. type: example +#: doc/guix.texi:17483 +#, no-wrap +msgid "" +"(let ((spec #~((#:name . \"guix\")\n" +" (#:url . \"git://git.savannah.gnu.org/guix.git\")\n" +" (#:load-path . \".\")\n" +" (#:file . \"build-aux/cuirass/gnu-system.scm\")\n" +" (#:proc . cuirass-jobs)\n" +" (#:arguments (subset . \"hello\"))\n" +" (#:branch . \"master\"))))\n" +" (service cuirass-service-type\n" +" (cuirass-configuration\n" +" (specifications #~(list '#$spec)))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17488 +msgid "While information related to build jobs is located directly in the specifications, global settings for the @command{cuirass} process are accessible in other @code{cuirass-configuration} fields." +msgstr "" + +#. type: deftp +#: doc/guix.texi:17489 +#, no-wrap +msgid "{Data Type} cuirass-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:17491 +msgid "Data type representing the configuration of Cuirass." +msgstr "" + +#. type: item +#: doc/guix.texi:17493 +#, no-wrap +msgid "@code{log-file} (default: @code{\"/var/log/cuirass.log\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17495 +msgid "Location of the log file." +msgstr "" + +#. type: item +#: doc/guix.texi:17496 +#, no-wrap +msgid "@code{cache-directory} (default: @code{\"/var/cache/cuirass\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17498 +msgid "Location of the repository cache." +msgstr "" + +#. type: item +#: doc/guix.texi:17499 +#, no-wrap +msgid "@code{user} (default: @code{\"cuirass\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17501 +msgid "Owner of the @code{cuirass} process." +msgstr "" + +#. type: item +#: doc/guix.texi:17502 +#, no-wrap +msgid "@code{group} (default: @code{\"cuirass\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:17504 +msgid "Owner's group of the @code{cuirass} process." +msgstr "" + +#. type: item +#: doc/guix.texi:17505 +#, no-wrap +msgid "@code{interval} (default: @code{60})" +msgstr "" + +#. type: table +#: doc/guix.texi:17508 +msgid "Number of seconds between the poll of the repositories followed by the Cuirass jobs." +msgstr "" + +#. type: item +#: doc/guix.texi:17509 +#, fuzzy, no-wrap +#| msgid "@code{package} (default: @code{varnish})" +msgid "@code{database} (default: @code{\"/var/run/cuirass/cuirass.db\"})" +msgstr "@code{package} (Vorgabe: @code{varnish})" + +#. type: table +#: doc/guix.texi:17512 +msgid "Location of sqlite database which contains the build results and previously added specifications." +msgstr "" + +#. type: item +#: doc/guix.texi:17513 +#, no-wrap +msgid "@code{port} (default: @code{8081})" +msgstr "" + +#. type: table +#: doc/guix.texi:17515 +msgid "Port number used by the HTTP server." +msgstr "" + +#. type: table +#: doc/guix.texi:17519 +msgid "Listen on the network interface for @var{host}. The default is to accept connections from localhost." +msgstr "" + +#. type: item +#: doc/guix.texi:17520 +#, no-wrap +msgid "@code{specifications} (default: @code{#~'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:17526 +msgid "A gexp (@pxref{G-Expressions}) that evaluates to a list of specifications, where a specification is an association list (@pxref{Associations Lists,,, guile, GNU Guile Reference Manual}) whose keys are keywords (@code{#:keyword-example}) as shown in the example above." +msgstr "" + +#. type: item +#: doc/guix.texi:17527 +#, no-wrap +msgid "@code{use-substitutes?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:17530 +msgid "This allows using substitutes to avoid building every dependencies of a job from source." +msgstr "" + +#. type: item +#: doc/guix.texi:17531 +#, no-wrap +msgid "@code{one-shot?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:17533 +msgid "Only evaluate specifications and build derivations once." +msgstr "" + +#. type: item +#: doc/guix.texi:17534 +#, no-wrap +msgid "@code{fallback?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:17537 +msgid "When substituting a pre-built binary fails, fall back to building packages locally." +msgstr "" + +#. type: item +#: doc/guix.texi:17538 +#, fuzzy, no-wrap +#| msgid "@code{actions} (default: @code{'()})" +msgid "@code{load-path} (default: @code{'()})" +msgstr "@code{actions} (Vorgabe: @code{'()})" + +#. type: table +#: doc/guix.texi:17541 +msgid "This allows users to define their own packages and make them visible to cuirass as in @command{guix build} command." +msgstr "" + +#. type: item +#: doc/guix.texi:17542 +#, no-wrap +msgid "@code{cuirass} (default: @code{cuirass})" +msgstr "" + +#. type: table +#: doc/guix.texi:17544 +msgid "The Cuirass package to use." +msgstr "" + +#. type: cindex +#: doc/guix.texi:17550 +#, no-wrap +msgid "power management with TLP" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17553 +msgid "The @code{(gnu services pm)} module provides a Guix service definition for the Linux power management tool TLP." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17559 +msgid "TLP enables various powersaving modes in userspace and kernel. Contrary to @code{upower-service}, it is not a passive, monitoring tool, as it will apply custom settings each time a new power source is detected. More information can be found at @uref{http://linrunner.de/en/tlp/tlp.html, TLP home page}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:17560 +#, no-wrap +msgid "{Scheme Variable} tlp-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:17564 +msgid "The service type for the TLP tool. Its value should be a valid TLP configuration (see below). To use the default settings, simply write:" +msgstr "" + +#. type: example +#: doc/guix.texi:17566 +#, no-wrap +msgid "(service tlp-service-type)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17571 +msgid "By default TLP does not need much configuration but most TLP parameters can be tweaked using @code{tlp-configuration}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17577 +msgid "Each parameter definition is preceded by its type; for example, @samp{boolean foo} indicates that the @code{foo} parameter should be specified as a boolean. Types starting with @code{maybe-} denote parameters that won't show up in TLP config file when their value is @code{'disabled}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:17587 +msgid "Available @code{tlp-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17588 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} package tlp" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17590 +msgid "The TLP package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17593 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean tlp-enable?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17595 +msgid "Set to true if you wish to enable TLP." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17600 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string tlp-default-mode" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17603 +msgid "Default mode when no power supply can be detected. Alternatives are AC and BAT." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17605 +msgid "Defaults to @samp{\"AC\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17608 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17611 +msgid "Number of seconds Linux kernel has to wait after the disk goes idle, before syncing on AC." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17616 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer disk-idle-secs-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17618 +msgid "Same as @code{disk-idle-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17620 +msgid "Defaults to @samp{2}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17623 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17625 +msgid "Dirty pages flushing periodicity, expressed in seconds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17627 doc/guix.texi:17850 doc/guix.texi:19167 +#: doc/guix.texi:19175 +msgid "Defaults to @samp{15}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17630 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer max-lost-work-secs-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17632 +msgid "Same as @code{max-lost-work-secs-on-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17634 +msgid "Defaults to @samp{60}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17637 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17641 +msgid "CPU frequency scaling governor on AC mode. With intel_pstate driver, alternatives are powersave and performance. With acpi-cpufreq driver, alternatives are ondemand, powersave, performance and conservative." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17643 doc/guix.texi:17650 doc/guix.texi:17657 +#: doc/guix.texi:17664 doc/guix.texi:17671 doc/guix.texi:17678 +#: doc/guix.texi:17686 doc/guix.texi:17694 doc/guix.texi:17701 +#: doc/guix.texi:17708 doc/guix.texi:17715 doc/guix.texi:17722 +#: doc/guix.texi:17752 doc/guix.texi:17790 doc/guix.texi:17797 +#: doc/guix.texi:17806 doc/guix.texi:17828 doc/guix.texi:17836 +#: doc/guix.texi:17843 doc/guix.texi:17998 doc/guix.texi:18018 +#: doc/guix.texi:18033 doc/guix.texi:18040 +msgid "Defaults to @samp{disabled}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17646 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list cpu-scaling-governor-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17648 +msgid "Same as @code{cpu-scaling-governor-on-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17653 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17655 +msgid "Set the min available frequency for the scaling governor on AC." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17660 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17662 +msgid "Set the max available frequency for the scaling governor on AC." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17667 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-min-freq-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17669 +msgid "Set the min available frequency for the scaling governor on BAT." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17674 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-scaling-max-freq-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17676 +msgid "Set the max available frequency for the scaling governor on BAT." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17681 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17684 +msgid "Limit the min P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17689 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17692 +msgid "Limit the max P-state to control the power dissipation of the CPU, in AC mode. Values are stated as a percentage of the available performance." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17697 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-min-perf-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17699 +msgid "Same as @code{cpu-min-perf-on-ac} on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17704 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-non-negative-integer cpu-max-perf-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17706 +msgid "Same as @code{cpu-max-perf-on-ac} on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17711 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-ac?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17713 +msgid "Enable CPU turbo boost feature on AC mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17718 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-boolean cpu-boost-on-bat?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17720 +msgid "Same as @code{cpu-boost-on-ac?} on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17725 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-ac?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17728 +msgid "Allow Linux kernel to minimize the number of CPU cores/hyper-threads used under light load conditions." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17733 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean sched-powersave-on-bat?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17735 +msgid "Same as @code{sched-powersave-on-ac?} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17740 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean nmi-watchdog?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17742 +msgid "Enable Linux kernel NMI watchdog." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17747 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-string phc-controls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17750 +msgid "For Linux kernels with PHC patch applied, change CPU voltages. An example value would be @samp{\"F:V F:V F:V F:V\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17755 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17758 +msgid "Set CPU performance versus energy saving policy on AC. Alternatives are performance, normal, powersave." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17760 doc/guix.texi:17858 doc/guix.texi:17888 +msgid "Defaults to @samp{\"performance\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17763 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string energy-perf-policy-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17765 +msgid "Same as @code{energy-perf-policy-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17767 doc/guix.texi:17865 +msgid "Defaults to @samp{\"powersave\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17770 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} space-separated-string-list disks-devices" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17772 +msgid "Hard disk devices." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17775 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17777 +msgid "Hard disk advanced power management level." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17780 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} space-separated-string-list disk-apm-level-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17782 +msgid "Same as @code{disk-apm-bat} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17785 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17788 +msgid "Hard disk spin down timeout. One value has to be specified for each declared hard disk." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17793 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-spindown-timeout-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17795 +msgid "Same as @code{disk-spindown-timeout-on-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17800 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list disk-iosched" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17804 +msgid "Select IO scheduler for disk devices. One value has to be specified for each declared hard disk. Example alternatives are cfq, deadline and noop." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17809 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17812 +msgid "SATA aggressive link power management (ALPM) level. Alternatives are min_power, medium_power, max_performance." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17814 +msgid "Defaults to @samp{\"max_performance\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17817 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string sata-linkpwr-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17819 +msgid "Same as @code{sata-linkpwr-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17821 +msgid "Defaults to @samp{\"min_power\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17824 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-string sata-linkpwr-blacklist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17826 +msgid "Exclude specified SATA host devices for link power management." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17831 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-ac?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17834 +msgid "Enable Runtime Power Management for AHCI controller and disks on AC mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17839 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-on-off-boolean ahci-runtime-pm-on-bat?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17841 +msgid "Same as @code{ahci-runtime-pm-on-ac} on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17846 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer ahci-runtime-pm-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17848 +msgid "Seconds of inactivity before disk is suspended." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17853 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17856 +msgid "PCI Express Active State Power Management level. Alternatives are default, performance, powersave." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17861 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string pcie-aspm-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17863 +msgid "Same as @code{pcie-aspm-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17868 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17871 +msgid "Radeon graphics clock speed level. Alternatives are low, mid, high, auto, default." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17873 +msgid "Defaults to @samp{\"high\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17876 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-power-profile-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17878 +msgid "Same as @code{radeon-power-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17880 +msgid "Defaults to @samp{\"low\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17883 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17886 +msgid "Radeon dynamic power management method (DPM). Alternatives are battery, performance." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17891 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-dpm-state-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17893 +msgid "Same as @code{radeon-dpm-state-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17895 +msgid "Defaults to @samp{\"battery\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17898 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17900 +msgid "Radeon DPM performance level. Alternatives are auto, low, high." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17902 doc/guix.texi:17909 doc/guix.texi:17983 +msgid "Defaults to @samp{\"auto\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17905 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string radeon-dpm-perf-level-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17907 +msgid "Same as @code{radeon-dpm-perf-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17912 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-ac?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17914 +msgid "Wifi power saving mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17919 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} on-off-boolean wifi-pwr-on-bat?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17921 +msgid "Same as @code{wifi-power-ac?} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17926 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} y-n-boolean wol-disable?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17928 +msgid "Disable wake on LAN." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17933 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17936 +msgid "Timeout duration in seconds before activating audio power saving on Intel HDA and AC97 devices. A value of 0 disables power saving." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17941 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} non-negative-integer sound-power-save-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17943 +msgid "Same as @code{sound-powersave-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17945 doc/guix.texi:18460 doc/guix.texi:18604 +msgid "Defaults to @samp{1}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17948 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} y-n-boolean sound-power-save-controller?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17950 +msgid "Disable controller in powersaving mode on Intel HDA devices." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17955 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean bay-poweroff-on-bat?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17959 +msgid "Enable optical drive in UltraBay/MediaBay on BAT mode. Drive can be powered on again by releasing (and reinserting) the eject lever or by pressing the disc eject button on newer models." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17964 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string bay-device" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17966 +msgid "Name of the optical drive device to power off." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17968 +msgid "Defaults to @samp{\"sr0\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17971 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-ac" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17974 +msgid "Runtime Power Management for PCI(e) bus devices. Alternatives are on and auto." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17976 +msgid "Defaults to @samp{\"on\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17979 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} string runtime-pm-on-bat" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17981 +msgid "Same as @code{runtime-pm-ac} but on BAT mode." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17986 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean runtime-pm-all?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17989 +msgid "Runtime Power Management for all PCI(e) bus devices, except blacklisted ones." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17994 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-space-separated-string-list runtime-pm-blacklist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:17996 +msgid "Exclude specified PCI(e) device addresses from Runtime Power Management." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18001 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} space-separated-string-list runtime-pm-driver-blacklist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18004 +msgid "Exclude PCI(e) devices assigned to the specified drivers from Runtime Power Management." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18007 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean usb-autosuspend?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18009 +msgid "Enable USB autosuspend feature." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18014 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-string usb-blacklist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18016 +msgid "Exclude specified devices from USB autosuspend." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18021 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean usb-blacklist-wwan?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18023 +msgid "Exclude WWAN devices from USB autosuspend." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18028 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-string usb-whitelist" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18031 +msgid "Include specified devices into USB autosuspend, even if they are already excluded by the driver or via @code{usb-blacklist-wwan?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18036 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} maybe-boolean usb-autosuspend-disable-on-shutdown?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18038 +msgid "Enable USB autosuspend before shutdown." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18043 +#, no-wrap +msgid "{@code{tlp-configuration} parameter} boolean restore-device-state-on-startup?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18046 +msgid "Restore radio device state (bluetooth, wifi, wwan) from previous shutdown on system startup." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18054 +msgid "The @code{(gnu services pm)} module provides an interface to thermald, a CPU frequency scaling service which helps prevent overheating." +msgstr "" + +#. type: defvr +#: doc/guix.texi:18055 +#, no-wrap +msgid "{Scheme Variable} thermald-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:18060 +msgid "This is the service type for @uref{https://01.org/linux-thermal-daemon/, thermald}, the Linux Thermal Daemon, which is responsible for controlling the thermal state of processors and preventing overheating." +msgstr "" + +#. type: deftp +#: doc/guix.texi:18062 +#, no-wrap +msgid "{Data Type} thermald-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:18064 +msgid "Data type representing the configuration of @code{thermald-service-type}." +msgstr "" + +#. type: item +#: doc/guix.texi:18066 +#, no-wrap +msgid "@code{ignore-cpuid-check?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:18068 +msgid "Ignore cpuid check for supported CPU models." +msgstr "" + +#. type: item +#: doc/guix.texi:18069 +#, no-wrap +msgid "@code{thermald} (default: @var{thermald})" +msgstr "" + +#. type: table +#: doc/guix.texi:18071 +msgid "Package object of thermald." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18080 +msgid "The @code{(gnu services audio)} module provides a service to start MPD (the Music Player Daemon)." +msgstr "" + +#. type: cindex +#: doc/guix.texi:18081 +#, no-wrap +msgid "mpd" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:18082 +#, no-wrap +msgid "Music Player Daemon" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18087 +msgid "The Music Player Daemon (MPD) is a service that can play music while being controlled from the local machine or over the network by a variety of clients." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18090 +msgid "The following example shows how one might run @code{mpd} as user @code{\"bob\"} on port @code{6666}. It uses pulseaudio for output." +msgstr "" + +#. type: example +#: doc/guix.texi:18096 +#, no-wrap +msgid "" +"(service mpd-service-type\n" +" (mpd-configuration\n" +" (user \"bob\")\n" +" (port \"6666\")))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:18098 +#, no-wrap +msgid "{Scheme Variable} mpd-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:18100 +msgid "The service type for @command{mpd}" +msgstr "" + +#. type: deftp +#: doc/guix.texi:18102 +#, no-wrap +msgid "{Data Type} mpd-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:18104 +msgid "Data type representing the configuration of @command{mpd}." +msgstr "" + +#. type: item +#: doc/guix.texi:18106 +#, no-wrap +msgid "@code{user} (default: @code{\"mpd\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:18108 +msgid "The user to run mpd as." +msgstr "" + +#. type: item +#: doc/guix.texi:18109 +#, no-wrap +msgid "@code{music-dir} (default: @code{\"~/Music\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:18111 +msgid "The directory to scan for music files." +msgstr "" + +#. type: item +#: doc/guix.texi:18112 +#, no-wrap +msgid "@code{playlist-dir} (default: @code{\"~/.mpd/playlists\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:18114 +msgid "The directory to store playlists." +msgstr "" + +#. type: item +#: doc/guix.texi:18115 +#, no-wrap +msgid "@code{port} (default: @code{\"6600\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:18117 +msgid "The port to run mpd on." +msgstr "" + +#. type: item +#: doc/guix.texi:18118 +#, no-wrap +msgid "@code{address} (default: @code{\"any\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:18121 +msgid "The address that mpd will bind to. To use a Unix domain socket, an absolute path can be specified here." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:18126 +#, no-wrap +msgid "Virtualization services" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18131 +msgid "The @code{(gnu services virtualization)} module provides services for the libvirt and virtlog daemons, as well as other virtualization-related services." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:18132 +#, no-wrap +msgid "Libvirt daemon" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18136 +msgid "@code{libvirtd} is the server side daemon component of the libvirt virtualization management system. This daemon runs on host servers and performs required management tasks for virtualized guests." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18137 +#, no-wrap +msgid "{Scheme Variable} libvirt-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18140 +msgid "This is the type of the @uref{https://libvirt.org, libvirt daemon}. Its value must be a @code{libvirt-configuration}." +msgstr "" + +#. type: example +#: doc/guix.texi:18146 +#, no-wrap +msgid "" +"(service libvirt-service-type\n" +" (libvirt-configuration\n" +" (unix-sock-group \"libvirt\")\n" +" (tls-port \"16555\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18151 +msgid "Available @code{libvirt-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18152 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} package libvirt" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18154 +msgid "Libvirt package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18157 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean listen-tls?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18160 +msgid "Flag listening for secure TLS connections on the public TCP/IP port. must set @code{listen} for this to have any effect." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18163 +msgid "It is necessary to setup a CA and issue server certificates before using this capability." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18168 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean listen-tcp?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18171 +msgid "Listen for unencrypted TCP connections on the public TCP/IP port. must set @code{listen} for this to have any effect." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18175 +msgid "Using the TCP socket requires SASL authentication by default. Only SASL mechanisms which support data encryption are allowed. This is DIGEST_MD5 and GSSAPI (Kerberos5)" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18180 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string tls-port" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18183 +msgid "Port for accepting secure TLS connections This can be a port number, or service name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18185 +msgid "Defaults to @samp{\"16514\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18188 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string tcp-port" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18191 +msgid "Port for accepting insecure TCP connections This can be a port number, or service name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18193 +msgid "Defaults to @samp{\"16509\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18196 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string listen-addr" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18198 +msgid "IP address or hostname used for client connections." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18200 +msgid "Defaults to @samp{\"0.0.0.0\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18203 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean mdns-adv?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18205 +msgid "Flag toggling mDNS advertisement of the libvirt service." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18208 +msgid "Alternatively can disable for all services on a host by stopping the Avahi daemon." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18213 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string mdns-name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18216 +msgid "Default mDNS advertisement name. This must be unique on the immediate broadcast network." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18218 +msgid "Defaults to @samp{\"Virtualization Host <hostname>\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18221 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string unix-sock-group" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18225 +msgid "UNIX domain socket group ownership. This can be used to allow a 'trusted' set of users access to management capabilities without becoming root." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18227 +msgid "Defaults to @samp{\"root\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18230 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string unix-sock-ro-perms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18233 +msgid "UNIX socket permissions for the R/O socket. This is used for monitoring VM status only." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18235 doc/guix.texi:18253 +msgid "Defaults to @samp{\"0777\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18238 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string unix-sock-rw-perms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18242 +msgid "UNIX socket permissions for the R/W socket. Default allows only root. If PolicyKit is enabled on the socket, the default will change to allow everyone (eg, 0777)" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18244 +msgid "Defaults to @samp{\"0770\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18247 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string unix-sock-admin-perms" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18251 +msgid "UNIX socket permissions for the admin socket. Default allows only owner (root), do not change it unless you are sure to whom you are exposing the access to." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18256 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string unix-sock-dir" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18258 +msgid "The directory in which sockets will be found/created." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18260 +msgid "Defaults to @samp{\"/var/run/libvirt\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18263 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string auth-unix-ro" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18266 +msgid "Authentication scheme for UNIX read-only sockets. By default socket permissions allow anyone to connect" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18268 doc/guix.texi:18277 +msgid "Defaults to @samp{\"polkit\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18271 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string auth-unix-rw" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18275 +msgid "Authentication scheme for UNIX read-write sockets. By default socket permissions only allow root. If PolicyKit support was compiled into libvirt, the default will be to use 'polkit' auth." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18280 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string auth-tcp" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18284 +msgid "Authentication scheme for TCP sockets. If you don't enable SASL, then all TCP traffic is cleartext. Don't do this outside of a dev/test scenario." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18286 +msgid "Defaults to @samp{\"sasl\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18289 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string auth-tls" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18293 +msgid "Authentication scheme for TLS sockets. TLS sockets already have encryption provided by the TLS layer, and limited authentication is done by certificates." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18296 +msgid "It is possible to make use of any SASL authentication mechanism as well, by using 'sasl' for this option" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18298 +msgid "Defaults to @samp{\"none\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18301 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} optional-list access-drivers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18303 +msgid "API access control scheme." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18306 +msgid "By default an authenticated user is allowed access to all APIs. Access drivers can place restrictions on this." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18311 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string key-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18314 +msgid "Server key file path. If set to an empty string, then no private key is loaded." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18319 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string cert-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18322 +msgid "Server key file path. If set to an empty string, then no certificate is loaded." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18327 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string ca-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18330 +msgid "Server key file path. If set to an empty string, then no CA certificate is loaded." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18335 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string crl-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18338 +msgid "Certificate revocation list path. If set to an empty string, then no CRL is loaded." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18343 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean tls-no-sanity-cert" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18345 +msgid "Disable verification of our own server certificates." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18348 +msgid "When libvirtd starts it performs some sanity checks against its own certificates." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18353 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean tls-no-verify-cert" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18355 +msgid "Disable verification of client certificates." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18359 +msgid "Client certificate verification is the primary authentication mechanism. Any client which does not present a certificate signed by the CA will be rejected." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18364 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} optional-list tls-allowed-dn-list" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18366 +msgid "Whitelist of allowed x509 Distinguished Name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18371 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} optional-list sasl-allowed-usernames" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18374 +msgid "Whitelist of allowed SASL usernames. The format for username depends on the SASL authentication mechanism." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18379 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string tls-priority" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18383 +msgid "Override the compile time default TLS priority string. The default is usually \"NORMAL\" unless overridden at build time. Only set this is it is desired for libvirt to deviate from the global default settings." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18385 +msgid "Defaults to @samp{\"NORMAL\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18388 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18391 doc/guix.texi:18814 +msgid "Maximum number of concurrent client connections to allow over all sockets combined." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18393 +msgid "Defaults to @samp{5000}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18396 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-queued-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18400 +msgid "Maximum length of queue of connections waiting to be accepted by the daemon. Note, that some protocols supporting retransmission may obey this so that a later reattempt at connection succeeds." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18405 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-anonymous-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18408 +msgid "Maximum length of queue of accepted but not yet authenticated clients. Set this to zero to turn this feature off" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18410 doc/guix.texi:18428 doc/guix.texi:18444 +msgid "Defaults to @samp{20}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18413 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer min-workers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18415 +msgid "Number of workers to start up initially." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18420 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-workers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18422 +msgid "Maximum number of worker threads." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18426 +msgid "If the number of active clients exceeds @code{min-workers}, then more threads are spawned, up to max_workers limit. Typically you'd want max_workers to equal maximum number of clients allowed." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18431 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer prio-workers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18435 +msgid "Number of priority workers. If all workers from above pool are stuck, some calls marked as high priority (notably domainDestroy) can be executed in this pool." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18440 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-requests" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18442 +msgid "Total global limit on concurrent RPC calls." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18447 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer max-client-requests" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18451 +msgid "Limit on concurrent requests from a single client connection. To avoid one client monopolizing the server this should be a small fraction of the global max_requests and max_workers parameter." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18456 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-min-workers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18458 +msgid "Same as @code{min-workers} but for the admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18463 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-max-workers" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18465 +msgid "Same as @code{max-workers} but for the admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18470 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-max-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18472 +msgid "Same as @code{max-clients} but for the admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18477 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-max-queued-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18479 +msgid "Same as @code{max-queued-clients} but for the admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18484 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-max-client-requests" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18486 +msgid "Same as @code{max-client-requests} but for the admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18491 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer log-level" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18493 doc/guix.texi:18716 +msgid "Logging level. 4 errors, 3 warnings, 2 information, 1 debug." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18498 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string log-filters" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18500 doc/guix.texi:18723 +msgid "Logging filters." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18503 doc/guix.texi:18726 +msgid "A filter allows to select a different logging level for a given category of logs The format for a filter is one of:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18507 doc/guix.texi:18730 +msgid "x:name" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18510 doc/guix.texi:18733 +msgid "x:+name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18520 doc/guix.texi:18743 +msgid "where @code{name} is a string which is matched against the category given in the @code{VIR_LOG_INIT()} at the top of each libvirt source file, e.g., \"remote\", \"qemu\", or \"util.json\" (the name in the filter can be a substring of the full category name, in order to match multiple similar categories), the optional \"+\" prefix tells libvirt to log stack trace for each message matching name, and @code{x} is the minimal level where matching messages should be logged:" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18524 doc/guix.texi:18569 doc/guix.texi:18747 +#: doc/guix.texi:18792 +msgid "1: DEBUG" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18527 doc/guix.texi:18572 doc/guix.texi:18750 +#: doc/guix.texi:18795 +msgid "2: INFO" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18530 doc/guix.texi:18575 doc/guix.texi:18753 +#: doc/guix.texi:18798 +msgid "3: WARNING" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18533 doc/guix.texi:18578 doc/guix.texi:18756 +#: doc/guix.texi:18801 +msgid "4: ERROR" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18538 doc/guix.texi:18761 +msgid "Multiple filters can be defined in a single filters statement, they just need to be separated by spaces." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18540 doc/guix.texi:18763 +msgid "Defaults to @samp{\"3:remote 4:event\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18543 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string log-outputs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18545 doc/guix.texi:18768 +msgid "Logging outputs." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18548 doc/guix.texi:18771 +msgid "An output is one of the places to save logging information The format for an output can be:" +msgstr "" + +#. type: item +#: doc/guix.texi:18550 doc/guix.texi:18773 +#, no-wrap +msgid "x:stderr" +msgstr "" + +#. type: table +#: doc/guix.texi:18552 doc/guix.texi:18775 +msgid "output goes to stderr" +msgstr "" + +#. type: item +#: doc/guix.texi:18553 doc/guix.texi:18776 +#, no-wrap +msgid "x:syslog:name" +msgstr "" + +#. type: table +#: doc/guix.texi:18555 doc/guix.texi:18778 +msgid "use syslog for the output and use the given name as the ident" +msgstr "" + +#. type: item +#: doc/guix.texi:18556 doc/guix.texi:18779 +#, no-wrap +msgid "x:file:file_path" +msgstr "" + +#. type: table +#: doc/guix.texi:18558 doc/guix.texi:18781 +msgid "output to a file, with the given filepath" +msgstr "" + +#. type: item +#: doc/guix.texi:18559 doc/guix.texi:18782 +#, no-wrap +msgid "x:journald" +msgstr "" + +#. type: table +#: doc/guix.texi:18561 doc/guix.texi:18784 +msgid "output to journald logging system" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18565 doc/guix.texi:18788 +msgid "In all case the x prefix is the minimal level, acting as a filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18583 doc/guix.texi:18806 +msgid "Multiple outputs can be defined, they just need to be separated by spaces." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18585 doc/guix.texi:18808 +msgid "Defaults to @samp{\"3:stderr\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18588 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer audit-level" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18590 +msgid "Allows usage of the auditing subsystem to be altered" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18594 +msgid "0: disable all auditing" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18597 +msgid "1: enable auditing, only if enabled on host" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18600 +msgid "2: enable auditing, and exit if disabled on host." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18607 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} boolean audit-logging" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18609 +msgid "Send audit messages via libvirt logging infrastructure." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18614 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} optional-string host-uuid" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18616 +msgid "Host UUID. UUID must not have all digits be the same." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18621 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} string host-uuid-source" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18623 +msgid "Source to read host UUID." +msgstr "" + +#. type: itemize +#: doc/guix.texi:18627 +msgid "@code{smbios}: fetch the UUID from @code{dmidecode -s system-uuid}" +msgstr "" + +#. type: itemize +#: doc/guix.texi:18630 +msgid "@code{machine-id}: fetch the UUID from @code{/etc/machine-id}" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18635 +msgid "If @code{dmidecode} does not provide a valid UUID a temporary UUID will be generated." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18637 +msgid "Defaults to @samp{\"smbios\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18640 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer keepalive-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18645 +msgid "A keepalive message is sent to a client after @code{keepalive_interval} seconds of inactivity to check if the client is still responding. If set to -1, libvirtd will never send keepalive requests; however clients can still send them and the daemon will send responses." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18650 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer keepalive-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18654 +msgid "Maximum number of keepalive messages that are allowed to be sent to the client without getting any response before the connection is considered broken." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18661 +msgid "In other words, the connection is automatically closed approximately after @code{keepalive_interval * (keepalive_count + 1)} seconds since the last message received from the client. When @code{keepalive-count} is set to 0, connections will be automatically closed after @code{keepalive-interval} seconds of inactivity without sending any keepalive messages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18666 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-interval" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18668 doc/guix.texi:18675 +msgid "Same as above but for admin interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18673 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer admin-keepalive-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18680 +#, no-wrap +msgid "{@code{libvirt-configuration} parameter} integer ovs-timeout" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18682 +msgid "Timeout for Open vSwitch calls." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18686 +msgid "The @code{ovs-vsctl} utility is used for the configuration and its timeout option is set by default to 5 seconds to avoid potential infinite waits blocking libvirt." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:18693 +#, no-wrap +msgid "Virtlog daemon" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18696 +msgid "The virtlogd service is a server side daemon component of libvirt that is used to manage logs from virtual machine consoles." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18702 +msgid "This daemon is not used directly by libvirt client applications, rather it is called on their behalf by @code{libvirtd}. By maintaining the logs in a standalone daemon, the main @code{libvirtd} daemon can be restarted without risk of losing logs. The @code{virtlogd} daemon has the ability to re-exec() itself upon receiving @code{SIGUSR1}, to allow live upgrades without downtime." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18703 +#, no-wrap +msgid "{Scheme Variable} virtlog-service-type" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18706 +msgid "This is the type of the virtlog daemon. Its value must be a @code{virtlog-configuration}." +msgstr "" + +#. type: example +#: doc/guix.texi:18711 +#, no-wrap +msgid "" +"(service virtlog-service-type\n" +" (virtlog-configuration\n" +" (max-clients 1000)))\n" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18714 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} integer log-level" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18721 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} string log-filters" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18766 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} string log-outputs" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18811 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} integer max-clients" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18816 +msgid "Defaults to @samp{1024}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18819 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} integer max-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18821 +msgid "Maximum file size before rolling over." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18823 +msgid "Defaults to @samp{2MB}" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18826 +#, no-wrap +msgid "{@code{virtlog-configuration} parameter} integer max-backups" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18828 +msgid "Maximum number of backup files to keep." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:18830 +msgid "Defaults to @samp{3}" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:18833 +#, no-wrap +msgid "Transparent Emulation with QEMU" +msgstr "" + +#. type: cindex +#: doc/guix.texi:18835 +#, no-wrap +msgid "emulation" +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:18836 +#, no-wrap +msgid "binfmt_misc" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18842 +msgid "@code{qemu-binfmt-service-type} provides support for transparent emulation of program binaries built for different architectures---e.g., it allows you to transparently execute an ARMv7 program on an x86_64 machine. It achieves this by combining the @uref{https://www.qemu.org, QEMU} emulator and the @code{binfmt_misc} feature of the kernel Linux." +msgstr "" + +#. type: defvr +#: doc/guix.texi:18843 +#, no-wrap +msgid "{Scheme Variable} qemu-binfmt-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:18848 +msgid "This is the type of the QEMU/binfmt service for transparent emulation. Its value must be a @code{qemu-binfmt-configuration} object, which specifies the QEMU package to use as well as the architecture we want to emulated:" +msgstr "" + +#. type: example +#: doc/guix.texi:18853 +#, no-wrap +msgid "" +"(service qemu-binfmt-service-type\n" +" (qemu-binfmt-configuration\n" +" (platforms (lookup-qemu-platforms \"arm\" \"aarch64\" \"ppc\"))))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:18859 +msgid "In this example, we enable transparent emulation for the ARM and aarch64 platforms. Running @code{herd stop qemu-binfmt} turns it off, and running @code{herd start qemu-binfmt} turns it back on (@pxref{Invoking herd, the @command{herd} command,, shepherd, The GNU Shepherd Manual})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:18861 +#, no-wrap +msgid "{Data Type} qemu-binfmt-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:18863 +msgid "This is the configuration for the @code{qemu-binfmt} service." +msgstr "" + +#. type: item +#: doc/guix.texi:18865 +#, no-wrap +msgid "@code{platforms} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:18868 +msgid "The list of emulated QEMU platforms. Each item must be a @dfn{platform object} as returned by @code{lookup-qemu-platforms} (see below)." +msgstr "" + +#. type: item +#: doc/guix.texi:18869 +#, no-wrap +msgid "@code{guix-support?} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:18875 +msgid "When it is true, QEMU and all its dependencies are added to the build environment of @command{guix-daemon} (@pxref{Invoking guix-daemon, @code{--chroot-directory} option}). This allows the @code{binfmt_misc} handlers to be used within the build environment, which in turn means that you can transparently build programs for another architecture." +msgstr "" + +#. type: table +#: doc/guix.texi:18878 +msgid "For example, let's suppose you're on an x86_64 machine and you have this service:" +msgstr "" + +#. type: example +#: doc/guix.texi:18884 +#, no-wrap +msgid "" +"(service qemu-binfmt-service-type\n" +" (qemu-binfmt-configuration\n" +" (platforms (lookup-qemu-platforms \"arm\"))\n" +" (guix-support? #t)))\n" +msgstr "" + +#. type: table +#: doc/guix.texi:18887 +msgid "You can run:" +msgstr "" + +#. type: example +#: doc/guix.texi:18890 +#, no-wrap +msgid "guix build -s armhf-linux inkscape\n" +msgstr "" + +#. type: table +#: doc/guix.texi:18897 +msgid "and it will build Inkscape for ARMv7 @emph{as if it were a native build}, transparently using QEMU to emulate the ARMv7 CPU. Pretty handy if you'd like to test a package build for an architecture you don't have access to!" +msgstr "" + +#. type: item +#: doc/guix.texi:18898 +#, no-wrap +msgid "@code{qemu} (default: @code{qemu})" +msgstr "" + +#. type: table +#: doc/guix.texi:18900 +msgid "The QEMU package to use." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18903 +#, no-wrap +msgid "{Scheme Procedure} lookup-qemu-platforms @var{platforms}@dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18908 +msgid "Return the list of QEMU platform objects corresponding to @var{platforms}@dots{}. @var{platforms} must be a list of strings corresponding to platform names, such as @code{\"arm\"}, @code{\"sparc\"}, @code{\"mips64el\"}, and so on." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18910 +#, no-wrap +msgid "{Scheme Procedure} qemu-platform? @var{obj}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18912 +msgid "Return true if @var{obj} is a platform object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18914 +#, no-wrap +msgid "{Scheme Procedure} qemu-platform-name @var{platform}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18916 +msgid "Return the name of @var{platform}---a string such as @code{\"arm\"}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18928 +msgid "The @code{(gnu services version-control)} module provides a service to allow remote access to local Git repositories. There are three options: the @code{git-daemon-service}, which provides access to repositories via the @code{git://} unsecured TCP-based protocol, extending the @code{nginx} web server to proxy some requests to @code{git-http-backend}, or providing a web interface with @code{cgit-service-type}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18929 +#, no-wrap +msgid "{Scheme Procedure} git-daemon-service [#:config (git-daemon-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:18933 +msgid "Return a service that runs @command{git daemon}, a simple TCP server to expose repositories over the Git protocol for anonymous access." +msgstr "" + +#. type: deffn +#: doc/guix.texi:18939 +msgid "The optional @var{config} argument should be a @code{<git-daemon-configuration>} object, by default it allows read-only access to exported@footnote{By creating the magic file \"git-daemon-export-ok\" in the repository directory.} repositories under @file{/srv/git}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:18942 +#, no-wrap +msgid "{Data Type} git-daemon-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:18944 +msgid "Data type representing the configuration for @code{git-daemon-service}." +msgstr "" + +#. type: item +#: doc/guix.texi:18946 doc/guix.texi:19002 +#, no-wrap +msgid "@code{package} (default: @var{git})" +msgstr "" + +#. type: table +#: doc/guix.texi:18948 doc/guix.texi:19004 +msgid "Package object of the Git distributed version control system." +msgstr "" + +#. type: item +#: doc/guix.texi:18949 doc/guix.texi:19008 +#, no-wrap +msgid "@code{export-all?} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:18952 +msgid "Whether to allow access for all Git repositories, even if they do not have the @file{git-daemon-export-ok} file." +msgstr "" + +#. type: item +#: doc/guix.texi:18953 +#, no-wrap +msgid "@code{base-path} (default: @file{/srv/git})" +msgstr "" + +#. type: table +#: doc/guix.texi:18958 +msgid "Whether to remap all the path requests as relative to the given path. If you run git daemon with @var{(base-path \"/srv/git\")} on example.com, then if you later try to pull @code{git://example.com/hello.git}, git daemon will interpret the path as @code{/srv/git/hello.git}." +msgstr "" + +#. type: item +#: doc/guix.texi:18959 +#, no-wrap +msgid "@code{user-path} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:18966 +msgid "Whether to allow @code{~user} notation to be used in requests. When specified with empty string, requests to @code{git://host/~alice/foo} is taken as a request to access @code{foo} repository in the home directory of user @code{alice}. If @var{(user-path \"path\")} is specified, the same request is taken as a request to access @code{path/foo} repository in the home directory of user @code{alice}." +msgstr "" + +#. type: item +#: doc/guix.texi:18967 +#, no-wrap +msgid "@code{listen} (default: @var{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:18970 +msgid "Whether to listen on specific IP addresses or hostnames, defaults to all." +msgstr "" + +#. type: item +#: doc/guix.texi:18971 +#, no-wrap +msgid "@code{port} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:18973 +msgid "Whether to listen on an alternative port, which defaults to 9418." +msgstr "" + +#. type: item +#: doc/guix.texi:18974 +#, no-wrap +msgid "@code{whitelist} (default: @var{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:18976 +msgid "If not empty, only allow access to this list of directories." +msgstr "" + +#. type: item +#: doc/guix.texi:18977 +#, no-wrap +msgid "@code{extra-options} (default: @var{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:18980 +msgid "Extra options will be passed to @code{git daemon}, please run @command{man git-daemon} for more information." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18994 +msgid "The @code{git://} protocol lacks authentication. When you pull from a repository fetched via @code{git://}, you don't know that the data you receive was modified is really coming from the specified host, and you have your connection is subject to eavesdropping. It's better to use an authenticated and encrypted transport, such as @code{https}. Although Git allows you to serve repositories using unsophisticated file-based web servers, there is a faster protocol implemented by the @code{git-http-backend} program. This program is the back-end of a proper Git web service. It is designed to sit behind a FastCGI proxy. @xref{Web Services}, for more on running the necessary @code{fcgiwrap} daemon." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:18997 +msgid "Guix has a separate configuration data type for serving Git repositories over HTTP." +msgstr "" + +#. type: deftp +#: doc/guix.texi:18998 +#, no-wrap +msgid "{Data Type} git-http-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:19000 +msgid "Data type representing the configuration for @code{git-http-service}." +msgstr "" + +#. type: item +#: doc/guix.texi:19005 +#, no-wrap +msgid "@code{git-root} (default: @file{/srv/git})" +msgstr "" + +#. type: table +#: doc/guix.texi:19007 +msgid "Directory containing the Git repositories to expose to the world." +msgstr "" + +#. type: table +#: doc/guix.texi:19011 +msgid "Whether to expose access for all Git repositories in @var{git-root}, even if they do not have the @file{git-daemon-export-ok} file." +msgstr "" + +#. type: item +#: doc/guix.texi:19012 +#, no-wrap +msgid "@code{uri-path} (default: @file{/git/})" +msgstr "" + +#. type: table +#: doc/guix.texi:19017 +msgid "Path prefix for Git access. With the default @code{/git/} prefix, this will map @code{http://@var{server}/git/@var{repo}.git} to @code{/srv/git/@var{repo}.git}. Requests whose URI paths do not begin with this prefix are not passed on to this Git instance." +msgstr "" + +#. type: item +#: doc/guix.texi:19018 +#, no-wrap +msgid "@code{fcgiwrap-socket} (default: @code{127.0.0.1:9000})" +msgstr "" + +#. type: table +#: doc/guix.texi:19021 +msgid "The socket on which the @code{fcgiwrap} daemon is listening. @xref{Web Services}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19028 +msgid "There is no @code{git-http-service-type}, currently; instead you can create an @code{nginx-location-configuration} from a @code{git-http-configuration} and then add that location to a web server." +msgstr "" + +#. type: deffn +#: doc/guix.texi:19029 +#, no-wrap +msgid "{Scheme Procedure} git-http-nginx-location-configuration @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:19034 +msgid "[config=(git-http-configuration)] Compute an @code{nginx-location-configuration} that corresponds to the given Git http configuration. An example nginx service definition to serve the default @file{/srv/git} over HTTPS might be:" +msgstr "" + +#. type: example +#: doc/guix.texi:19051 +#, no-wrap +msgid "" +"(service nginx-service-type\n" +" (nginx-configuration\n" +" (server-blocks\n" +" (list\n" +" (nginx-server-configuration\n" +" (listen '(\"443 ssl\"))\n" +" (server-name \"git.my-host.org\")\n" +" (ssl-certificate\n" +" \"/etc/letsencrypt/live/git.my-host.org/fullchain.pem\")\n" +" (ssl-certificate-key\n" +" \"/etc/letsencrypt/live/git.my-host.org/privkey.pem\")\n" +" (locations\n" +" (list\n" +" (git-http-nginx-location-configuration\n" +" (git-http-configuration (uri-path \"/\"))))))))))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:19058 +msgid "This example assumes that you are using Let's Encrypt to get your TLS certificate. @xref{Certificate Services}. The default @code{certbot} service will redirect all HTTP traffic on @code{git.my-host.org} to HTTPS. You will also need to add an @code{fcgiwrap} proxy to your system services. @xref{Web Services}." +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:19060 +#, no-wrap +msgid "Cgit Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:19062 +#, no-wrap +msgid "Cgit service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:19063 +#, no-wrap +msgid "Git, web interface" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19066 +msgid "@uref{https://git.zx2c4.com/cgit/, Cgit} is a web frontend for Git repositories written in C." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19069 +msgid "The following example will configure the service with default values. By default, Cgit can be accessed on port 80 (@code{http://localhost:80})." +msgstr "" + +#. type: example +#: doc/guix.texi:19072 +#, no-wrap +msgid "(service cgit-service-type)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19076 +msgid "The @code{file-object} type designates either a file-like object (@pxref{G-Expressions, file-like objects}) or a string." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19080 +msgid "Available @code{cgit-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19081 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} package package" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19083 +msgid "The CGIT package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19086 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} nginx-server-configuration-list nginx" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19088 +msgid "NGINX configuration." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19091 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object about-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19094 +msgid "Specifies a command which will be invoked to format the content of about pages (both top-level and for each repository)." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19099 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string agefile" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19102 +msgid "Specifies a path, relative to each repository path, which can be used to specify the date and time of the youngest commit in the repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19107 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object auth-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19110 +msgid "Specifies a command that will be invoked for authenticating repository access." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19115 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string branch-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19118 +msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set @samp{name} enables ordering by branch name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19120 +msgid "Defaults to @samp{\"name\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19123 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string cache-root" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19125 +msgid "Path used to store the cgit cache entries." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19127 +msgid "Defaults to @samp{\"/var/cache/cgit\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19130 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-static-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19133 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19135 doc/guix.texi:19578 +msgid "Defaults to @samp{-1}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19138 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-dynamic-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19141 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19146 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-repo-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19149 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19154 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-root-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19157 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19162 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-scanrc-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19165 +msgid "Number which specifies the time-to-live, in minutes, for the result of scanning a path for Git repositories." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19170 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-about-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19173 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of the repository about page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19178 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-snapshot-ttl" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19181 +msgid "Number which specifies the time-to-live, in minutes, for the cached version of snapshots." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19186 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer cache-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19189 +msgid "The maximum number of entries in the cgit cache. When set to @samp{0}, caching is disabled." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19194 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean case-sensitive-sort?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19196 +msgid "Sort items in the repo list case sensitively." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19201 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} list clone-prefix" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19204 +msgid "List of common prefixes which, when combined with a repository URL, generates valid clone URLs for the repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19209 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} list clone-url" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19211 +msgid "List of @code{clone-url} templates." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19216 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object commit-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19218 +msgid "Command which will be invoked to format commit messages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19223 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string commit-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19227 doc/guix.texi:19785 +msgid "Flag which, when set to @samp{date}, enables strict date ordering in the commit log, and when set to @samp{topo} enables strict topological ordering." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19229 +msgid "Defaults to @samp{\"git log\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19232 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object css" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19234 +msgid "URL which specifies the css document to include in all cgit pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19236 +msgid "Defaults to @samp{\"/share/cgit/cgit.css\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19239 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object email-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19243 +msgid "Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19248 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean embedded?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19251 +msgid "Flag which, when set to @samp{#t}, will make cgit generate a HTML fragment suitable for embedding in other HTML pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19256 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-commit-graph?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19260 +msgid "Flag which, when set to @samp{#t}, will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19265 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-filter-overrides?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19268 +msgid "Flag which, when set to @samp{#t}, allows all filter settings to be overridden in repository-specific cgitrc files." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19273 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-follow-links?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19276 +msgid "Flag which, when set to @samp{#t}, allows users to follow a file in the log view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19281 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-http-clone?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19284 +msgid "If set to @samp{#t}, cgit will act as an dumb HTTP endpoint for Git clones." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19289 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-index-links?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19292 +msgid "Flag which, when set to @samp{#t}, will make cgit generate extra links \"summary\", \"commit\", \"tree\" for each repo in the repository index." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19297 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-index-owner?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19300 +msgid "Flag which, when set to @samp{#t}, will make cgit display the owner of each repo in the repository index." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19305 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-log-filecount?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19308 +msgid "Flag which, when set to @samp{#t}, will make cgit print the number of modified files for each commit on the repository log page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19313 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-log-linecount?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19316 +msgid "Flag which, when set to @samp{#t}, will make cgit print the number of added and removed lines for each commit on the repository log page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19321 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-remote-branches?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19324 doc/guix.texi:19848 +msgid "Flag which, when set to @code{#t}, will make cgit display remote branches in the summary and refs views." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19329 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-subject-links?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19333 +msgid "Flag which, when set to @code{1}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19338 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-html-serving?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19342 +msgid "Flag which, when set to @samp{#t}, will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19347 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-tree-linenumbers?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19350 +msgid "Flag which, when set to @samp{#t}, will make cgit generate linenumber links for plaintext blobs printed in the tree view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19355 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean enable-git-config?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19358 +msgid "Flag which, when set to @samp{#f}, will allow cgit to use Git config to set any repo specific settings." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19363 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object favicon" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19365 +msgid "URL used as link to a shortcut icon for cgit." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19367 +msgid "Defaults to @samp{\"/favicon.ico\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19370 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string footer" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19374 +msgid "The content of the file specified with this option will be included verbatim at the bottom of all pages (i.e. it replaces the standard \"generated by...\" message)." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19379 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string head-include" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19382 +msgid "The content of the file specified with this option will be included verbatim in the HTML HEAD section on all pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19387 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string header" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19390 +msgid "The content of the file specified with this option will be included verbatim at the top of all pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19395 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object include" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19398 +msgid "Name of a configfile to include before the rest of the current config- file is parsed." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19403 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string index-header" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19406 +msgid "The content of the file specified with this option will be included verbatim above the repository index." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19411 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string index-info" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19414 +msgid "The content of the file specified with this option will be included verbatim below the heading on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19419 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean local-time?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19422 +msgid "Flag which, if set to @samp{#t}, makes cgit print commit and tag times in the servers timezone." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19427 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object logo" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19430 +msgid "URL which specifies the source of an image which will be used as a logo on all cgit pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19432 +msgid "Defaults to @samp{\"/share/cgit/cgit.png\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19435 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string logo-link" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19437 doc/guix.texi:19894 +msgid "URL loaded when clicking on the cgit logo image." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19442 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object owner-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19445 +msgid "Command which will be invoked to format the Owner column of the main page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19450 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-atom-items" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19452 +msgid "Number of items to display in atom feeds view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19454 doc/guix.texi:19689 doc/guix.texi:19697 +#: doc/guix.texi:19705 +msgid "Defaults to @samp{10}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19457 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-commit-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19459 +msgid "Number of entries to list per page in \"log\" view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19461 doc/guix.texi:19476 +msgid "Defaults to @samp{50}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19464 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-message-length" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19466 +msgid "Number of commit message characters to display in \"log\" view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19468 doc/guix.texi:19484 +msgid "Defaults to @samp{80}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19471 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-repo-count" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19474 +msgid "Specifies the number of entries to list per page on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19479 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-repodesc-length" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19482 +msgid "Specifies the maximum number of repo description characters to display on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19487 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer max-blob-size" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19489 +msgid "Specifies the maximum size of a blob to display HTML for in KBytes." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19494 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string max-stats" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19497 +msgid "Maximum statistics period. Valid values are @samp{week},@samp{month}, @samp{quarter} and @samp{year}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19502 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} mimetype-alist mimetype" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19504 +msgid "Mimetype for the specified filename extension." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19508 +msgid "Defaults to @samp{((gif \"image/gif\") (html \"text/html\") (jpg \"image/jpeg\") (jpeg \"image/jpeg\") (pdf \"application/pdf\") (png \"image/png\") (svg \"image/svg+xml\"))}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19511 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object mimetype-file" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19513 +msgid "Specifies the file to use for automatic mimetype lookup." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19518 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string module-link" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19521 +msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19526 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean nocache?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19528 +msgid "If set to the value @samp{#t} caching will be disabled." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19533 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean noplainemail?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19536 +msgid "If set to @samp{#t} showing full author email addresses will be disabled." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19541 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean noheader?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19544 +msgid "Flag which, when set to @samp{#t}, will make cgit omit the standard header on all pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19549 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} project-list project-list" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19553 +msgid "A list of subdirectories inside of @code{repository-directory}, relative to it, that should loaded as Git repositories. An empty list means that all subdirectories will be loaded." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19558 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object readme" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19560 +msgid "Text which will be used as default value for @code{cgit-repo-readme}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19565 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean remove-suffix?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19569 +msgid "If set to @code{#t} and @code{repository-directory} is enabled, if any repositories are found with a suffix of @code{.git}, this suffix will be removed for the URL and name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19574 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer renamelimit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19576 +msgid "Maximum number of files to consider when detecting renames." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19581 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string repository-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19583 +msgid "The way in which repositories in each section are sorted." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19588 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} robots-list robots" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19590 +msgid "Text used as content for the @code{robots} meta-tag." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19592 +msgid "Defaults to @samp{(\"noindex\" \"nofollow\")}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19595 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string root-desc" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19597 +msgid "Text printed below the heading on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19599 +msgid "Defaults to @samp{\"a fast webinterface for the git dscm\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19602 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string root-readme" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19605 +msgid "The content of the file specified with this option will be included verbatim below thef \"about\" link on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19610 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string root-title" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19612 +msgid "Text printed as heading on the repository index page." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19617 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean scan-hidden-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19623 +msgid "If set to @samp{#t} and repository-directory is enabled, repository-directory will recurse into directories whose name starts with a period. Otherwise, repository-directory will stay away from such directories, considered as \"hidden\". Note that this does not apply to the \".git\" directory in non-bare repos." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19628 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} list snapshots" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19631 +msgid "Text which specifies the default set of snapshot formats that cgit generates links for." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19636 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} repository-directory repository-directory" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19639 +msgid "Name of the directory to scan for repositories (represents @code{scan-path})." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19641 +msgid "Defaults to @samp{\"/srv/git\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19644 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string section" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19647 doc/guix.texi:19963 +msgid "The name of the current repository section - all repositories defined after this option will inherit the current section name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19652 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string section-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19655 +msgid "Flag which, when set to @samp{1}, will sort the sections on the repository listing by name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19660 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer section-from-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19663 +msgid "A number which, if defined prior to repository-directory, specifies how many path elements from each repo path to use as a default section name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19668 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} boolean side-by-side-diffs?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19671 +msgid "If set to @samp{#t} shows side-by-side diffs instead of unidiffs per default." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19676 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} file-object source-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19679 +msgid "Specifies a command which will be invoked to format plaintext blobs in the tree view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19684 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer summary-branches" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19687 +msgid "Specifies the number of branches to display in the repository \"summary\" view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19692 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer summary-log" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19695 +msgid "Specifies the number of log entries to display in the repository \"summary\" view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19700 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} integer summary-tags" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19703 +msgid "Specifies the number of tags to display in the repository \"summary\" view." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19708 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string strict-export" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19711 +msgid "Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19716 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} string virtual-root" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19718 +msgid "URL which, if specified, will be used as root for all cgit links." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19720 +msgid "Defaults to @samp{\"/\"}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19723 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} repository-cgit-configuration-list repositories" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19725 +msgid "A list of @dfn{cgit-repo} records to use with config." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19729 +msgid "Available @code{repository-cgit-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19730 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-list snapshots" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19733 +msgid "A mask of snapshot formats for this repo that cgit generates links for, restricted by the global @code{snapshots} setting." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19738 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object source-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19740 +msgid "Override the default @code{source-filter}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19745 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string url" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19747 +msgid "The relative URL used to access the repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19752 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object about-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19754 +msgid "Override the default @code{about-filter}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19759 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string branch-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19762 +msgid "Flag which, when set to @samp{age}, enables date ordering in the branch ref list, and when set to @samp{name} enables ordering by branch name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19767 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-list clone-url" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19769 +msgid "A list of URLs which can be used to clone repo." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19774 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object commit-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19776 +msgid "Override the default @code{commit-filter}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19781 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string commit-sort" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19790 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string defbranch" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19795 +msgid "The name of the default branch for this repository. If no such branch exists in the repository, the first branch name (when sorted) is used as default instead. By default branch pointed to by HEAD, or \"master\" if there is no suitable HEAD." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19800 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string desc" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19802 +msgid "The value to show as repository description." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19807 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string homepage" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19809 +msgid "The value to show as repository homepage." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19814 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object email-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19816 +msgid "Override the default @code{email-filter}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19821 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-commit-graph?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19824 +msgid "A flag which can be used to disable the global setting @code{enable-commit-graph?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19829 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-log-filecount?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19832 +msgid "A flag which can be used to disable the global setting @code{enable-log-filecount?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19837 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-log-linecount?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19840 +msgid "A flag which can be used to disable the global setting @code{enable-log-linecount?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19845 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-remote-branches?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19853 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-subject-links?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19856 +msgid "A flag which can be used to override the global setting @code{enable-subject-links?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19861 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean enable-html-serving?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19864 +msgid "A flag which can be used to override the global setting @code{enable-html-serving?}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19869 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean hide?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19872 +msgid "Flag which, when set to @code{#t}, hides the repository from the repository index." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19877 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-boolean ignore?" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19879 +msgid "Flag which, when set to @samp{#t}, ignores the repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19884 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object logo" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19887 +msgid "URL which specifies the source of an image which will be used as a logo on this repo’s pages." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19892 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string logo-link" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19899 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-file-object owner-filter" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19901 +msgid "Override the default @code{owner-filter}." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19906 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string module-link" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19910 +msgid "Text which will be used as the formatstring for a hyperlink when a submodule is printed in a directory listing. The arguments for the formatstring are the path and SHA1 of the submodule commit." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19915 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} module-link-path module-link-path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19919 +msgid "Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory listing." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19924 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string max-stats" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19926 +msgid "Override the default maximum statistics period." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19931 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string name" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19933 +msgid "The value to show as repository name." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19938 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string owner" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19940 +msgid "A value used to identify the owner of the repository." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19945 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string path" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19947 +msgid "An absolute path to the repository directory." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19952 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string readme" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19955 +msgid "A path (relative to repo) which specifies a file to include verbatim as the \"About\" page for this repo." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19960 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-string section" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19968 +#, no-wrap +msgid "{@code{repository-cgit-configuration} parameter} repo-list extra-options" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19970 doc/guix.texi:19979 +msgid "Extra options will be appended to cgitrc file." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19977 +#, no-wrap +msgid "{@code{cgit-configuration} parameter} list extra-options" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19991 +msgid "However, it could be that you just want to get a @code{cgitrc} up and running. In that case, you can pass an @code{opaque-cgit-configuration} as a record to @code{cgit-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:19993 +msgid "Available @code{opaque-cgit-configuration} fields are:" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19994 +#, no-wrap +msgid "{@code{opaque-cgit-configuration} parameter} package cgit" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19996 +msgid "The cgit package." +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:19998 +#, no-wrap +msgid "{@code{opaque-cgit-configuration} parameter} string string" +msgstr "" + +#. type: deftypevr +#: doc/guix.texi:20000 +msgid "The contents of the @code{cgitrc}, as a string." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20004 +msgid "For example, if your @code{cgitrc} is just the empty string, you could instantiate a cgit service like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:20009 +#, no-wrap +msgid "" +"(service cgit-service-type\n" +" (opaque-cgit-configuration\n" +" (cgitrc \"\")))\n" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:20015 +#, no-wrap +msgid "The Battle for Wesnoth Service" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20016 +#, no-wrap +msgid "wesnothd" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20020 +msgid "@uref{https://wesnoth.org, The Battle for Wesnoth} is a fantasy, turn based tactical strategy game, with several single player campaigns, and multiplayer games (both networked and local)." +msgstr "" + +#. type: defvar +#: doc/guix.texi:20021 +#, no-wrap +msgid "{Scheme Variable} wesnothd-service-type" +msgstr "" + +#. type: defvar +#: doc/guix.texi:20025 +msgid "Service type for the wesnothd service. Its value must be a @code{wesnothd-configuration} object. To run wesnothd in the default configuration, instantiate it as:" +msgstr "" + +#. type: example +#: doc/guix.texi:20028 +#, no-wrap +msgid "(service wesnothd-service-type)\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20031 +#, no-wrap +msgid "{Data Type} wesnothd-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20033 +msgid "Data type representing the configuration of @command{wesnothd}." +msgstr "" + +#. type: item +#: doc/guix.texi:20035 +#, no-wrap +msgid "@code{package} (default: @code{wesnoth-server})" +msgstr "" + +#. type: table +#: doc/guix.texi:20037 +msgid "The wesnoth server package to use." +msgstr "" + +#. type: item +#: doc/guix.texi:20038 +#, no-wrap +msgid "@code{port} (default: @code{15000})" +msgstr "" + +#. type: table +#: doc/guix.texi:20040 +msgid "The port to bind the server to." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20046 +#, no-wrap +msgid "sysctl" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:20047 +#, no-wrap +msgid "System Control Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20051 +msgid "The @code{(gnu services sysctl)} provides a service to configure kernel parameters at boot." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20052 +#, no-wrap +msgid "{Scheme Variable} sysctl-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20056 +msgid "The service type for @command{sysctl}, which modifies kernel parameters under @file{/proc/sys/}. To enable IPv4 forwarding, it can be instantiated as:" +msgstr "" + +#. type: example +#: doc/guix.texi:20061 +#, no-wrap +msgid "" +"(service sysctl-service-type\n" +" (sysctl-configuration\n" +" (settings '((\"net.ipv4.ip_forward\" . \"1\")))))\n" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20064 +#, no-wrap +msgid "{Data Type} sysctl-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20066 +msgid "The data type representing the configuration of @command{sysctl}." +msgstr "" + +#. type: item +#: doc/guix.texi:20068 +#, no-wrap +msgid "@code{sysctl} (default: @code{(file-append procps \"/sbin/sysctl\"})" +msgstr "" + +#. type: table +#: doc/guix.texi:20070 +msgid "The @command{sysctl} executable to use." +msgstr "" + +#. type: item +#: doc/guix.texi:20071 +#, no-wrap +msgid "@code{settings} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:20073 +msgid "An association list specifies kernel parameters and their values." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20076 +#, no-wrap +msgid "lirc" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:20077 +#, no-wrap +msgid "Lirc Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20080 +msgid "The @code{(gnu services lirc)} module provides the following service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20081 +#, no-wrap +msgid "{Scheme Procedure} lirc-service [#:lirc lirc] @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20086 +msgid "[#:device #f] [#:driver #f] [#:config-file #f] @ [#:extra-options '()] Return a service that runs @url{http://www.lirc.org,LIRC}, a daemon that decodes infrared signals from remote controls." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20090 +msgid "Optionally, @var{device}, @var{driver} and @var{config-file} (configuration file name) may be specified. See @command{lircd} manual for details." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20093 +msgid "Finally, @var{extra-options} is a list of additional command-line options passed to @command{lircd}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20095 +#, no-wrap +msgid "spice" +msgstr "" + +#. type: subsubheading +#: doc/guix.texi:20096 +#, no-wrap +msgid "Spice Service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20099 +msgid "The @code{(gnu services spice)} module provides the following service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20100 +#, no-wrap +msgid "{Scheme Procedure} spice-vdagent-service [#:spice-vdagent]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20104 +msgid "Returns a service that runs @url{http://www.spice-space.org,VDAGENT}, a daemon that enables sharing the clipboard with a vm and setting the guest display resolution when the graphical console window resizes." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:20106 +#, no-wrap +msgid "Dictionary Services" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20107 +#, no-wrap +msgid "dictionary" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20109 +msgid "The @code{(gnu services dict)} module provides the following service:" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20110 +#, no-wrap +msgid "{Scheme Procedure} dicod-service [#:config (dicod-configuration)]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20113 +msgid "Return a service that runs the @command{dicod} daemon, an implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual})." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20117 +msgid "The optional @var{config} argument specifies the configuration for @command{dicod}, which should be a @code{<dicod-configuration>} object, by default it serves the GNU Collaborative International Dictonary of English." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20121 +msgid "You can add @command{open localhost} to your @file{~/.dico} file to make @code{localhost} the default server for @command{dico} client (@pxref{Initialization File,,, dico, GNU Dico Manual})." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20123 +#, no-wrap +msgid "{Data Type} dicod-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20125 +msgid "Data type representing the configuration of dicod." +msgstr "" + +#. type: item +#: doc/guix.texi:20127 +#, no-wrap +msgid "@code{dico} (default: @var{dico})" +msgstr "" + +#. type: table +#: doc/guix.texi:20129 +msgid "Package object of the GNU Dico dictionary server." +msgstr "" + +#. type: item +#: doc/guix.texi:20130 +#, no-wrap +msgid "@code{interfaces} (default: @var{'(\"localhost\")})" +msgstr "" + +#. type: table +#: doc/guix.texi:20134 +msgid "This is the list of IP addresses and ports and possibly socket file names to listen to (@pxref{Server Settings, @code{listen} directive,, dico, GNU Dico Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20135 +#, no-wrap +msgid "@code{handlers} (default: @var{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:20137 +msgid "List of @code{<dicod-handler>} objects denoting handlers (module instances)." +msgstr "" + +#. type: item +#: doc/guix.texi:20138 +#, no-wrap +msgid "@code{databases} (default: @var{(list %dicod-database:gcide)})" +msgstr "" + +#. type: table +#: doc/guix.texi:20140 +msgid "List of @code{<dicod-database>} objects denoting dictionaries to be served." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20143 +#, no-wrap +msgid "{Data Type} dicod-handler" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20145 +msgid "Data type representing a dictionary handler (module instance)." +msgstr "" + +#. type: table +#: doc/guix.texi:20149 +msgid "Name of the handler (module instance)." +msgstr "" + +#. type: item +#: doc/guix.texi:20150 +#, no-wrap +msgid "@code{module} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20154 +msgid "Name of the dicod module of the handler (instance). If it is @code{#f}, the module has the same name as the handler. (@pxref{Modules,,, dico, GNU Dico Manual})." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:20155 doc/guix.texi:20175 +#, no-wrap +msgid "options" +msgstr "" + +#. type: table +#: doc/guix.texi:20157 +msgid "List of strings or gexps representing the arguments for the module handler" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20160 +#, no-wrap +msgid "{Data Type} dicod-database" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20162 +msgid "Data type representing a dictionary database." +msgstr "" + +#. type: table +#: doc/guix.texi:20166 +msgid "Name of the database, will be used in DICT commands." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:20167 +#, no-wrap +msgid "handler" +msgstr "" + +#. type: table +#: doc/guix.texi:20170 +msgid "Name of the dicod handler (module instance) used by this database (@pxref{Handlers,,, dico, GNU Dico Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20171 +#, no-wrap +msgid "@code{complex?} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20174 +msgid "Whether the database configuration complex. The complex configuration will need a corresponding @code{<dicod-handler>} object, otherwise not." +msgstr "" + +#. type: table +#: doc/guix.texi:20178 +msgid "List of strings or gexps representing the arguments for the database (@pxref{Databases,,, dico, GNU Dico Manual})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20181 +#, no-wrap +msgid "{Scheme Variable} %dicod-database:gcide" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20184 +msgid "A @code{<dicod-database>} object serving the GNU Collaborative International Dictionary of English using the @code{gcide} package." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20187 +msgid "The following is an example @code{dicod-service} configuration." +msgstr "" + +#. type: example +#: doc/guix.texi:20202 +#, no-wrap +msgid "" +"(dicod-service #:config\n" +" (dicod-configuration\n" +" (handlers (list (dicod-handler\n" +" (name \"wordnet\")\n" +" (module \"dictorg\")\n" +" (options\n" +" (list #~(string-append \"dbdir=\" #$wordnet))))))\n" +" (databases (list (dicod-database\n" +" (name \"wordnet\")\n" +" (complex? #t)\n" +" (handler \"wordnet\")\n" +" (options '(\"database=wn\")))\n" +" %dicod-database:gcide))))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20207 +#, no-wrap +msgid "setuid programs" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20217 +msgid "Some programs need to run with ``root'' privileges, even when they are launched by unprivileged users. A notorious example is the @command{passwd} program, which users can run to change their password, and which needs to access the @file{/etc/passwd} and @file{/etc/shadow} files---something normally restricted to root, for obvious security reasons. To address that, these executables are @dfn{setuid-root}, meaning that they always run with root privileges (@pxref{How Change Persona,,, libc, The GNU C Library Reference Manual}, for more info about the setuid mechanism.)" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20224 +msgid "The store itself @emph{cannot} contain setuid programs: that would be a security issue since any user on the system can write derivations that populate the store (@pxref{The Store}). Thus, a different mechanism is used: instead of changing the setuid bit directly on files that are in the store, we let the system administrator @emph{declare} which programs should be setuid root." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20230 +msgid "The @code{setuid-programs} field of an @code{operating-system} declaration contains a list of G-expressions denoting the names of programs to be setuid-root (@pxref{Using the Configuration System}). For instance, the @command{passwd} program, which is part of the Shadow package, can be designated by this G-expression (@pxref{G-Expressions}):" +msgstr "" + +#. type: example +#: doc/guix.texi:20233 +#, no-wrap +msgid "#~(string-append #$shadow \"/bin/passwd\")\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20237 +msgid "A default set of setuid programs is defined by the @code{%setuid-programs} variable of the @code{(gnu system)} module." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20238 +#, no-wrap +msgid "{Scheme Variable} %setuid-programs" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20240 +msgid "A list of G-expressions denoting common programs that are setuid-root." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20243 +msgid "The list includes commands such as @command{passwd}, @command{ping}, @command{su}, and @command{sudo}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20249 +msgid "Under the hood, the actual setuid programs are created in the @file{/run/setuid-programs} directory at system activation time. The files in this directory refer to the ``real'' binaries, which are in the store." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20253 +#, no-wrap +msgid "HTTPS, certificates" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20254 +#, no-wrap +msgid "X.509 certificates" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20255 +#, no-wrap +msgid "TLS" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20262 +msgid "Web servers available over HTTPS (that is, HTTP over the transport-layer security mechanism, TLS) send client programs an @dfn{X.509 certificate} that the client can then use to @emph{authenticate} the server. To do that, clients verify that the server's certificate is signed by a so-called @dfn{certificate authority} (CA). But to verify the CA's signature, clients must have first acquired the CA's certificate." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20266 +msgid "Web browsers such as GNU@tie{}IceCat include their own set of CA certificates, such that they are able to verify CA signatures out-of-the-box." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20270 +msgid "However, most other programs that can talk HTTPS---@command{wget}, @command{git}, @command{w3m}, etc.---need to be told where CA certificates can be found." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20277 +msgid "In GuixSD, this is done by adding a package that provides certificates to the @code{packages} field of the @code{operating-system} declaration (@pxref{operating-system Reference}). GuixSD includes one such package, @code{nss-certs}, which is a set of CA certificates provided as part of Mozilla's Network Security Services." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20282 +msgid "Note that it is @emph{not} part of @var{%base-packages}, so you need to explicitly add it. The @file{/etc/ssl/certs} directory, which is where most applications and libraries look for certificates by default, points to the certificates installed globally." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20292 +msgid "Unprivileged users, including users of Guix on a foreign distro, can also install their own certificate package in their profile. A number of environment variables need to be defined so that applications and libraries know where to find them. Namely, the OpenSSL library honors the @code{SSL_CERT_DIR} and @code{SSL_CERT_FILE} variables. Some applications add their own environment variables; for instance, the Git version control system honors the certificate bundle pointed to by the @code{GIT_SSL_CAINFO} environment variable. Thus, you would typically run something like:" +msgstr "" + +#. type: example +#: doc/guix.texi:20298 +#, no-wrap +msgid "" +"$ guix package -i nss-certs\n" +"$ export SSL_CERT_DIR=\"$HOME/.guix-profile/etc/ssl/certs\"\n" +"$ export SSL_CERT_FILE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n" +"$ export GIT_SSL_CAINFO=\"$SSL_CERT_FILE\"\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20303 +msgid "As another example, R requires the @code{CURL_CA_BUNDLE} environment variable to point to a certificate bundle, so you would have to run something like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:20307 +#, no-wrap +msgid "" +"$ guix package -i nss-certs\n" +"$ export CURL_CA_BUNDLE=\"$HOME/.guix-profile/etc/ssl/certs/ca-certificates.crt\"\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20311 +msgid "For other applications you may want to look up the required environment variable in the relevant documentation." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20316 +#, no-wrap +msgid "name service switch" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20317 +#, no-wrap +msgid "NSS" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20326 +msgid "The @code{(gnu system nss)} module provides bindings to the configuration file of the libc @dfn{name service switch} or @dfn{NSS} (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). In a nutshell, the NSS is a mechanism that allows libc to be extended with new ``name'' lookup methods for system databases, which includes host names, service names, user accounts, and more (@pxref{Name Service Switch, System Databases and Name Service Switch,, libc, The GNU C Library Reference Manual})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20333 +msgid "The NSS configuration specifies, for each system database, which lookup method is to be used, and how the various methods are chained together---for instance, under which circumstances NSS should try the next method in the list. The NSS configuration is given in the @code{name-service-switch} field of @code{operating-system} declarations (@pxref{operating-system Reference, @code{name-service-switch}})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20334 +#, no-wrap +msgid "nss-mdns" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20335 +#, no-wrap +msgid ".local, host name lookup" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20340 +msgid "As an example, the declaration below configures the NSS to use the @uref{http://0pointer.de/lennart/projects/nss-mdns/, @code{nss-mdns} back-end}, which supports host name lookups over multicast DNS (mDNS) for host names ending in @code{.local}:" +msgstr "" + +#. type: example +#: doc/guix.texi:20344 +#, no-wrap +msgid "" +"(name-service-switch\n" +" (hosts (list %files ;first, check /etc/hosts\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20349 +#, no-wrap +msgid "" +" ;; If the above did not succeed, try\n" +" ;; with 'mdns_minimal'.\n" +" (name-service\n" +" (name \"mdns_minimal\")\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20355 +#, no-wrap +msgid "" +" ;; 'mdns_minimal' is authoritative for\n" +" ;; '.local'. When it returns \"not found\",\n" +" ;; no need to try the next methods.\n" +" (reaction (lookup-specification\n" +" (not-found => return))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20359 +#, no-wrap +msgid "" +" ;; Then fall back to DNS.\n" +" (name-service\n" +" (name \"dns\"))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20363 +#, no-wrap +msgid "" +" ;; Finally, try with the \"full\" 'mdns'.\n" +" (name-service\n" +" (name \"mdns\")))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20368 +msgid "Do not worry: the @code{%mdns-host-lookup-nss} variable (see below) contains this configuration, so you will not have to type it if all you want is to have @code{.local} host lookup working." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20376 +msgid "Note that, in this case, in addition to setting the @code{name-service-switch} of the @code{operating-system} declaration, you also need to use @code{avahi-service} (@pxref{Networking Services, @code{avahi-service}}), or @var{%desktop-services}, which includes it (@pxref{Desktop Services}). Doing this makes @code{nss-mdns} accessible to the name service cache daemon (@pxref{Base Services, @code{nscd-service}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20379 +msgid "For convenience, the following variables provide typical NSS configurations." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20380 +#, no-wrap +msgid "{Scheme Variable} %default-nss" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20383 +msgid "This is the default name service switch configuration, a @code{name-service-switch} object." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20385 +#, no-wrap +msgid "{Scheme Variable} %mdns-host-lookup-nss" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20388 +msgid "This is the name service switch configuration with support for host name lookup over multicast DNS (mDNS) for host names ending in @code{.local}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20398 +msgid "The reference for name service switch configuration is given below. It is a direct mapping of the configuration file format of the C library , so please refer to the C library manual for more information (@pxref{NSS Configuration File,,, libc, The GNU C Library Reference Manual}). Compared to the configuration file format of libc NSS, it has the advantage not only of adding this warm parenthetic feel that we like, but also static checks: you will know about syntax errors and typos as soon as you run @command{guix system}." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20399 +#, no-wrap +msgid "{Data Type} name-service-switch" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20404 +msgid "This is the data type representation the configuration of libc's name service switch (NSS). Each field below represents one of the supported system databases." +msgstr "" + +#. type: item +#: doc/guix.texi:20406 +#, no-wrap +msgid "aliases" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20407 +#, no-wrap +msgid "ethers" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20409 +#, no-wrap +msgid "gshadow" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20410 +#, no-wrap +msgid "hosts" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20411 +#, no-wrap +msgid "initgroups" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20412 +#, no-wrap +msgid "netgroup" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20413 +#, no-wrap +msgid "networks" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20415 +#, no-wrap +msgid "public-key" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20416 +#, no-wrap +msgid "rpc" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20418 +#, no-wrap +msgid "shadow" +msgstr "" + +#. type: table +#: doc/guix.texi:20421 +msgid "The system databases handled by the NSS. Each of these fields must be a list of @code{<name-service>} objects (see below)." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20424 +#, no-wrap +msgid "{Data Type} name-service" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20428 +msgid "This is the data type representing an actual name service and the associated lookup action." +msgstr "" + +#. type: table +#: doc/guix.texi:20433 +msgid "A string denoting the name service (@pxref{Services in the NSS configuration,,, libc, The GNU C Library Reference Manual})." +msgstr "" + +#. type: table +#: doc/guix.texi:20438 +msgid "Note that name services listed here must be visible to nscd. This is achieved by passing the @code{#:name-services} argument to @code{nscd-service} the list of packages providing the needed name services (@pxref{Base Services, @code{nscd-service}})." +msgstr "" + +#. type: item +#: doc/guix.texi:20439 +#, no-wrap +msgid "reaction" +msgstr "" + +#. type: table +#: doc/guix.texi:20443 +msgid "An action specified using the @code{lookup-specification} macro (@pxref{Actions in the NSS configuration,,, libc, The GNU C Library Reference Manual}). For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:20447 +#, no-wrap +msgid "" +"(lookup-specification (unavailable => continue)\n" +" (success => return))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20461 +msgid "For bootstrapping purposes, the Linux-Libre kernel is passed an @dfn{initial RAM disk}, or @dfn{initrd}. An initrd contains a temporary root file system as well as an initialization script. The latter is responsible for mounting the real root file system, and for loading any kernel modules that may be needed to achieve that." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20470 +msgid "The @code{initrd-modules} field of an @code{operating-system} declaration allows you to specify Linux-libre kernel modules that must be available in the initrd. In particular, this is where you would list modules needed to actually drive the hard disk where your root partition is---although the default value of @code{initrd-modules} should cover most use cases. For example, assuming you need the @code{megaraid_sas} module in addition to the default modules to be able to access your root file system, you would write:" +msgstr "" + +#. type: example +#: doc/guix.texi:20475 +#, no-wrap +msgid "" +"(operating-system\n" +" ;; @dots{}\n" +" (initrd-modules (cons \"megaraid_sas\" %base-initrd-modules)))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20477 +#, no-wrap +msgid "{Scheme Variable} %base-initrd-modules" +msgstr "" + +#. type: defvr +#: doc/guix.texi:20479 +msgid "This is the list of kernel modules included in the initrd by default." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20487 +msgid "Furthermore, if you need lower-level customization, the @code{initrd} field of an @code{operating-system} declaration allows you to specify which initrd you would like to use. The @code{(gnu system linux-initrd)} module provides three ways to build an initrd: the high-level @code{base-initrd} procedure and the low-level @code{raw-initrd} and @code{expression->initrd} procedures." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20492 +msgid "The @code{base-initrd} procedure is intended to cover most common uses. For example, if you want to add a bunch of kernel modules to be loaded at boot time, you can define the @code{initrd} field of the operating system declaration like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:20500 +#, no-wrap +msgid "" +"(initrd (lambda (file-systems . rest)\n" +" ;; Create a standard initrd but set up networking\n" +" ;; with the parameters QEMU expects by default.\n" +" (apply base-initrd file-systems\n" +" #:qemu-networking? #t\n" +" rest)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20505 +msgid "The @code{base-initrd} procedure also handles common use cases that involves using the system as a QEMU guest, or as a ``live'' system with volatile root file system." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20512 +msgid "The @code{base-initrd} procedure is built from @code{raw-initrd} procedure. Unlike @code{base-initrd}, @code{raw-initrd} doesn't do anything high-level, such as trying to guess which kernel modules and packages should be included to the initrd. An example use of @code{raw-initrd} is when a user has a custom Linux kernel configuration and default kernel modules included by @code{base-initrd} are not available." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20517 +msgid "The initial RAM disk produced by @code{base-initrd} or @code{raw-initrd} honors several options passed on the Linux kernel command line (that is, arguments passed @i{via} the @code{linux} command of GRUB, or the @code{-append} option of QEMU), notably:" +msgstr "" + +#. type: item +#: doc/guix.texi:20519 +#, no-wrap +msgid "--load=@var{boot}" +msgstr "" + +#. type: table +#: doc/guix.texi:20522 +msgid "Tell the initial RAM disk to load @var{boot}, a file containing a Scheme program, once it has mounted the root file system." +msgstr "" + +#. type: table +#: doc/guix.texi:20526 +msgid "GuixSD uses this option to yield control to a boot program that runs the service activation programs and then spawns the GNU@tie{}Shepherd, the initialization system." +msgstr "" + +#. type: item +#: doc/guix.texi:20527 +#, no-wrap +msgid "--root=@var{root}" +msgstr "" + +#. type: table +#: doc/guix.texi:20531 +msgid "Mount @var{root} as the root file system. @var{root} can be a device name like @code{/dev/sda1}, a file system label, or a file system UUID." +msgstr "" + +#. type: table +#: doc/guix.texi:20535 +msgid "Have @file{/run/booted-system} and @file{/run/current-system} point to @var{system}." +msgstr "" + +#. type: item +#: doc/guix.texi:20536 +#, no-wrap +msgid "modprobe.blacklist=@var{modules}@dots{}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20537 +#, no-wrap +msgid "module, black-listing" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20538 +#, no-wrap +msgid "black list, of kernel modules" +msgstr "" + +#. type: table +#: doc/guix.texi:20543 +msgid "Instruct the initial RAM disk as well as the @command{modprobe} command (from the kmod package) to refuse to load @var{modules}. @var{modules} must be a comma-separated list of module names---e.g., @code{usbkbd,9pnet}." +msgstr "" + +#. type: item +#: doc/guix.texi:20544 +#, no-wrap +msgid "--repl" +msgstr "" + +#. type: table +#: doc/guix.texi:20550 +msgid "Start a read-eval-print loop (REPL) from the initial RAM disk before it tries to load kernel modules and to mount the root file system. Our marketing team calls it @dfn{boot-to-Guile}. The Schemer in you will love it. @xref{Using Guile Interactively,,, guile, GNU Guile Reference Manual}, for more information on Guile's REPL." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20556 +msgid "Now that you know all the features that initial RAM disks produced by @code{base-initrd} and @code{raw-initrd} provide, here is how to use it and customize it further." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20559 +#, no-wrap +msgid "{Monadic Procedure} raw-initrd @var{file-systems} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20571 +msgid "[#:linux-modules '()] [#:mapped-devices '()] @ [#:helper-packages '()] [#:qemu-networking? #f] [#:volatile-root? #f] Return a monadic derivation that builds a raw initrd. @var{file-systems} is a list of file systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @code{--root}. @var{linux-modules} is a list of kernel modules to be loaded at boot time. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted (@pxref{Mapped Devices}). @var{helper-packages} is a list of packages to be copied in the initrd. It may include @code{e2fsck/static} or other packages needed by the initrd to check the root file system." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20575 +msgid "When @var{qemu-networking?} is true, set up networking with the standard QEMU parameters. When @var{virtio?} is true, load additional modules so that the initrd can be used as a QEMU guest with para-virtualized I/O drivers." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20578 +msgid "When @var{volatile-root?} is true, the root file system is writable but any changes to it are lost." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20580 +#, no-wrap +msgid "{Monadic Procedure} base-initrd @var{file-systems} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20588 +msgid "[#:mapped-devices '()] [#:qemu-networking? #f] [#:volatile-root? #f]@ [#:linux-modules '()] Return a monadic derivation that builds a generic initrd, with kernel modules taken from @var{linux}. @var{file-systems} is a list of file-systems to be mounted by the initrd, possibly in addition to the root file system specified on the kernel command line via @code{--root}. @var{mapped-devices} is a list of device mappings to realize before @var{file-systems} are mounted." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20590 +msgid "@var{qemu-networking?} and @var{volatile-root?} behaves as in @code{raw-initrd}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20595 +msgid "The initrd is automatically populated with all the kernel modules necessary for @var{file-systems} and for the given options. Additional kernel modules can be listed in @var{linux-modules}. They will be added to the initrd, and loaded at boot time in the order in which they appear." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20602 +msgid "Needless to say, the initrds we produce and use embed a statically-linked Guile, and the initialization program is a Guile program. That gives a lot of flexibility. The @code{expression->initrd} procedure builds such an initrd, given the program to run in that initrd." +msgstr "" + +#. type: deffn +#: doc/guix.texi:20603 +#, no-wrap +msgid "{Monadic Procedure} expression->initrd @var{exp} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:20609 +msgid "[#:guile %guile-static-stripped] [#:name \"guile-initrd\"] Return a derivation that builds a Linux initrd (a gzipped cpio archive) containing @var{guile} and that evaluates @var{exp}, a G-expression, upon booting. All the derivations referenced by @var{exp} are automatically copied to the initrd." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20615 +#, no-wrap +msgid "boot loader" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20622 +msgid "The operating system supports multiple bootloaders. The bootloader is configured using @code{bootloader-configuration} declaration. All the fields of this structure are bootloader agnostic except for one field, @code{bootloader} that indicates the bootloader to be configured and installed." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20627 +msgid "Some of the bootloaders do not honor every field of @code{bootloader-configuration}. For instance, the extlinux bootloader does not support themes and thus ignores the @code{theme} field." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20628 +#, no-wrap +msgid "{Data Type} bootloader-configuration" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20630 +msgid "The type of a bootloader configuration declaration." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20634 +#, no-wrap +msgid "EFI, bootloader" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20635 +#, no-wrap +msgid "UEFI, bootloader" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20636 +#, no-wrap +msgid "BIOS, bootloader" +msgstr "" + +#. type: table +#: doc/guix.texi:20642 +msgid "The bootloader to use, as a @code{bootloader} object. For now @code{grub-bootloader}, @code{grub-efi-bootloader}, @code{extlinux-bootloader} and @code{u-boot-bootloader} are supported. @code{grub-efi-bootloader} allows to boot on modern systems using the @dfn{Unified Extensible Firmware Interface} (UEFI)." +msgstr "" + +#. type: table +#: doc/guix.texi:20645 +msgid "Available bootloaders are described in @code{(gnu bootloader @dots{})} modules." +msgstr "" + +#. type: table +#: doc/guix.texi:20655 +msgid "This is a string denoting the target onto which to install the bootloader. The exact interpretation depends on the bootloader in question; for @code{grub-bootloader}, for example, it should be a device name understood by the bootloader @command{installer} command, such as @code{/dev/sda} or @code{(hd0)} (for GRUB, @pxref{Invoking grub-install,,, grub, GNU GRUB Manual}). For @code{grub-efi-bootloader}, it should be the path to a mounted EFI file system." +msgstr "" + +#. type: item +#: doc/guix.texi:20656 +#, no-wrap +msgid "@code{menu-entries} (default: @code{()})" +msgstr "" + +#. type: table +#: doc/guix.texi:20660 +msgid "A possibly empty list of @code{menu-entry} objects (see below), denoting entries to appear in the bootloader menu, in addition to the current system entry and the entry pointing to previous system generations." +msgstr "" + +#. type: item +#: doc/guix.texi:20661 +#, no-wrap +msgid "@code{default-entry} (default: @code{0})" +msgstr "" + +#. type: table +#: doc/guix.texi:20664 +msgid "The index of the default boot menu entry. Index 0 is for the entry of the current system." +msgstr "" + +#. type: item +#: doc/guix.texi:20665 +#, no-wrap +msgid "@code{timeout} (default: @code{5})" +msgstr "" + +#. type: table +#: doc/guix.texi:20668 +msgid "The number of seconds to wait for keyboard input before booting. Set to 0 to boot immediately, and to -1 to wait indefinitely." +msgstr "" + +#. type: item +#: doc/guix.texi:20669 +#, no-wrap +msgid "@code{theme} (default: @var{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20673 +msgid "The bootloader theme object describing the theme to use. If no theme is provided, some bootloaders might use a default theme, that's true for GRUB." +msgstr "" + +#. type: item +#: doc/guix.texi:20674 +#, no-wrap +msgid "@code{terminal-outputs} (default: @code{'gfxterm})" +msgstr "" + +#. type: table +#: doc/guix.texi:20681 +msgid "The output terminals used for the bootloader boot menu, as a list of symbols. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{gfxterm}, @code{vga_text}, @code{mda_text}, @code{morse}, and @code{pkmodem}. This field corresponds to the GRUB variable GRUB_TERMINAL_OUTPUT (@pxref{Simple configuration,,, grub,GNU GRUB manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20682 +#, no-wrap +msgid "@code{terminal-inputs} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:20690 +msgid "The input terminals used for the bootloader boot menu, as a list of symbols. For GRUB, the default is the native platform terminal as determined at run-time. GRUB accepts the values: @code{console}, @code{serial}, @code{serial_@{0-3@}}, @code{at_keyboard}, and @code{usb_keyboard}. This field corresponds to the GRUB variable GRUB_TERMINAL_INPUT (@pxref{Simple configuration,,, grub,GNU GRUB manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20691 +#, no-wrap +msgid "@code{serial-unit} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20695 +msgid "The serial unit used by the bootloader, as an integer from 0 to 3. For GRUB, it is chosen at run-time; currently GRUB chooses 0, which corresponds to COM1 (@pxref{Serial terminal,,, grub,GNU GRUB manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20696 +#, no-wrap +msgid "@code{serial-speed} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20700 +msgid "The speed of the serial interface, as an integer. For GRUB, the default value is chosen at run-time; currently GRUB chooses 9600@tie{}bps (@pxref{Serial terminal,,, grub,GNU GRUB manual})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20704 +#, no-wrap +msgid "dual boot" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20705 +#, no-wrap +msgid "boot menu" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20711 +msgid "Should you want to list additional boot menu entries @i{via} the @code{menu-entries} field above, you will need to create them with the @code{menu-entry} form. For example, imagine you want to be able to boot another distro (hard to imagine!), you can define a menu entry along these lines:" +msgstr "" + +#. type: example +#: doc/guix.texi:20718 +#, no-wrap +msgid "" +"(menu-entry\n" +" (label \"The Other Distro\")\n" +" (linux \"/boot/old/vmlinux-2.6.32\")\n" +" (linux-arguments '(\"root=/dev/sda2\"))\n" +" (initrd \"/boot/old/initrd\"))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20721 +msgid "Details below." +msgstr "" + +#. type: deftp +#: doc/guix.texi:20722 +#, no-wrap +msgid "{Data Type} menu-entry" +msgstr "" + +#. type: deftp +#: doc/guix.texi:20724 +msgid "The type of an entry in the bootloader menu." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:20727 +#, no-wrap +msgid "label" +msgstr "" + +#. type: table +#: doc/guix.texi:20729 +msgid "The label to show in the menu---e.g., @code{\"GNU\"}." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:20730 +#, no-wrap +msgid "linux" +msgstr "" + +#. type: table +#: doc/guix.texi:20732 +msgid "The Linux kernel image to boot, for example:" +msgstr "" + +#. type: example +#: doc/guix.texi:20735 +#, no-wrap +msgid "(file-append linux-libre \"/bzImage\")\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20740 +msgid "For GRUB, it is also possible to specify a device explicitly in the file path using GRUB's device naming convention (@pxref{Naming convention,,, grub, GNU GRUB manual}), for example:" +msgstr "" + +#. type: example +#: doc/guix.texi:20743 +#, no-wrap +msgid "\"(hd0,msdos1)/boot/vmlinuz\"\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20747 +msgid "If the device is specified explicitly as above, then the @code{device} field is ignored entirely." +msgstr "" + +#. type: item +#: doc/guix.texi:20748 +#, no-wrap +msgid "@code{linux-arguments} (default: @code{()})" +msgstr "" + +#. type: table +#: doc/guix.texi:20751 +msgid "The list of extra Linux kernel command-line arguments---e.g., @code{(\"console=ttyS0\")}." +msgstr "" + +#. type: table +#: doc/guix.texi:20755 +msgid "A G-Expression or string denoting the file name of the initial RAM disk to use (@pxref{G-Expressions})." +msgstr "" + +#. type: item +#: doc/guix.texi:20755 +#, no-wrap +msgid "@code{device} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:20758 +msgid "The device where the kernel and initrd are to be found---i.e., for GRUB, @dfn{root} for this menu entry (@pxref{root,,, grub, GNU GRUB manual})." +msgstr "" + +#. type: table +#: doc/guix.texi:20764 +msgid "This may be a file system label (a string), a file system UUID (a bytevector, @pxref{File Systems}), or @code{#f}, in which case the bootloader will search the device containing the file specified by the @code{linux} field (@pxref{search,,, grub, GNU GRUB manual}). It must @emph{not} be an OS device name such as @file{/dev/sda1}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20771 +msgid "Fow now only GRUB has theme support. GRUB themes are created using the @code{grub-theme} form, which is not documented yet." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20776 +msgid "This is the default GRUB theme used by the operating system if no @code{theme} field is specified in @code{bootloader-configuration} record." +msgstr "" + +#. type: defvr +#: doc/guix.texi:20779 +msgid "It comes with a fancy background image displaying the GNU and Guix logos." +msgstr "" + +#. type: subsection +#: doc/guix.texi:20783 +#, no-wrap +msgid "Invoking @code{guix system}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20788 +msgid "Once you have written an operating system declaration as seen in the previous section, it can be @dfn{instantiated} using the @command{guix system} command. The synopsis is:" +msgstr "" + +#. type: example +#: doc/guix.texi:20791 +#, no-wrap +msgid "guix system @var{options}@dots{} @var{action} @var{file}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:20797 +msgid "@var{file} must be the name of a file containing an @code{operating-system} declaration. @var{action} specifies how the operating system is instantiated. Currently the following values are supported:" +msgstr "" + +#. type: item +#: doc/guix.texi:20799 +#, no-wrap +msgid "search" +msgstr "" + +#. type: table +#: doc/guix.texi:20802 +msgid "Display available service type definitions that match the given regular expressions, sorted by relevance:" +msgstr "" + +#. type: example +#: doc/guix.texi:20814 +#, no-wrap +msgid "" +"$ guix system search console font\n" +"name: console-fonts\n" +"location: gnu/services/base.scm:729:2\n" +"extends: shepherd-root\n" +"description: Install the given fonts on the specified ttys (fonts are\n" +"+ per virtual console on GNU/Linux). The value of this service is a list\n" +"+ of tty/font pairs like:\n" +"+ \n" +"+ '((\"tty1\" . \"LatGrkCyr-8x16\"))\n" +"relevance: 20\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20820 +#, no-wrap +msgid "" +"name: mingetty\n" +"location: gnu/services/base.scm:1048:2\n" +"extends: shepherd-root\n" +"description: Provide console login using the `mingetty' program.\n" +"relevance: 2\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20827 +#, no-wrap +msgid "" +"name: login\n" +"location: gnu/services/base.scm:775:2\n" +"extends: pam\n" +"description: Provide a console log-in service as specified by its\n" +"+ configuration value, a `login-configuration' object.\n" +"relevance: 2\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:20829 +#, no-wrap +msgid "@dots{}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20834 +msgid "As for @command{guix package --search}, the result is written in @code{recutils} format, which makes it easy to filter the output (@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:20835 +#, no-wrap +msgid "reconfigure" +msgstr "" + +#. type: table +#: doc/guix.texi:20840 +msgid "Build the operating system described in @var{file}, activate it, and switch to it@footnote{This action (and the related actions @code{switch-generation} and @code{roll-back}) are usable only on systems already running GuixSD.}." +msgstr "" + +#. type: table +#: doc/guix.texi:20847 +msgid "This effects all the configuration specified in @var{file}: user accounts, system services, global package list, setuid programs, etc. The command starts system services specified in @var{file} that are not currently running; if a service is currently running, it does not attempt to upgrade it since this would not be possible without stopping it first." +msgstr "" + +#. type: table +#: doc/guix.texi:20853 +msgid "This command creates a new generation whose number is one greater than the current generation (as reported by @command{guix system list-generations}). If that generation already exists, it will be overwritten. This behavior mirrors that of @command{guix package} (@pxref{Invoking guix package})." +msgstr "" + +#. type: table +#: doc/guix.texi:20858 +msgid "It also adds a bootloader menu entry for the new OS configuration, ---unless @option{--no-bootloader} is passed. For GRUB, it moves entries for older configurations to a submenu, allowing you to choose an older system generation at boot time should you need it." +msgstr "" + +#. type: quotation +#: doc/guix.texi:20866 +msgid "It is highly recommended to run @command{guix pull} once before you run @command{guix system reconfigure} for the first time (@pxref{Invoking guix pull}). Failing to do that you would see an older version of Guix once @command{reconfigure} has completed." +msgstr "" + +#. type: item +#: doc/guix.texi:20868 +#, no-wrap +msgid "switch-generation" +msgstr "" + +#. type: table +#: doc/guix.texi:20877 +msgid "Switch to an existing system generation. This action atomically switches the system profile to the specified system generation. It also rearranges the system's existing bootloader menu entries. It makes the menu entry for the specified system generation the default, and it moves the entries for the other generatiors to a submenu, if supported by the bootloader being used. The next time the system boots, it will use the specified system generation." +msgstr "" + +#. type: table +#: doc/guix.texi:20881 +msgid "The bootloader itself is not being reinstalled when using this command. Thus, the installed bootloader is used with an updated configuration file." +msgstr "" + +#. type: table +#: doc/guix.texi:20885 +msgid "The target generation can be specified explicitly by its generation number. For example, the following invocation would switch to system generation 7:" +msgstr "" + +#. type: example +#: doc/guix.texi:20888 +#, no-wrap +msgid "guix system switch-generation 7\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20896 +msgid "The target generation can also be specified relative to the current generation with the form @code{+N} or @code{-N}, where @code{+3} means ``3 generations ahead of the current generation,'' and @code{-1} means ``1 generation prior to the current generation.'' When specifying a negative value such as @code{-1}, you must precede it with @code{--} to prevent it from being parsed as an option. For example:" +msgstr "" + +#. type: example +#: doc/guix.texi:20899 +#, no-wrap +msgid "guix system switch-generation -- -1\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20907 +msgid "Currently, the effect of invoking this action is @emph{only} to switch the system profile to an existing generation and rearrange the bootloader menu entries. To actually start using the target system generation, you must reboot after running this action. In the future, it will be updated to do the same things as @command{reconfigure}, like activating and deactivating services." +msgstr "" + +#. type: table +#: doc/guix.texi:20909 +msgid "This action will fail if the specified generation does not exist." +msgstr "" + +#. type: item +#: doc/guix.texi:20910 +#, no-wrap +msgid "roll-back" +msgstr "" + +#. type: table +#: doc/guix.texi:20916 +msgid "Switch to the preceding system generation. The next time the system boots, it will use the preceding system generation. This is the inverse of @command{reconfigure}, and it is exactly the same as invoking @command{switch-generation} with an argument of @code{-1}." +msgstr "" + +#. type: table +#: doc/guix.texi:20920 +msgid "Currently, as with @command{switch-generation}, you must reboot after running this action to actually start using the preceding system generation." +msgstr "" + +#. type: table +#: doc/guix.texi:20925 +msgid "Build the derivation of the operating system, which includes all the configuration files and programs needed to boot and run the system. This action does not actually install anything." +msgstr "" + +#. type: item +#: doc/guix.texi:20926 +#, no-wrap +msgid "init" +msgstr "" + +#. type: table +#: doc/guix.texi:20930 +msgid "Populate the given directory with all the files necessary to run the operating system specified in @var{file}. This is useful for first-time installations of GuixSD. For instance:" +msgstr "" + +#. type: example +#: doc/guix.texi:20933 +#, no-wrap +msgid "guix system init my-os-config.scm /mnt\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20940 +msgid "copies to @file{/mnt} all the store items required by the configuration specified in @file{my-os-config.scm}. This includes configuration files, packages, and so on. It also creates other essential files needed for the system to operate correctly---e.g., the @file{/etc}, @file{/var}, and @file{/run} directories, and the @file{/bin/sh} file." +msgstr "" + +#. type: table +#: doc/guix.texi:20944 +msgid "This command also installs bootloader on the target specified in @file{my-os-config}, unless the @option{--no-bootloader} option was passed." +msgstr "" + +#. type: item +#: doc/guix.texi:20945 +#, no-wrap +msgid "vm" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20946 doc/guix.texi:21210 +#, no-wrap +msgid "virtual machine" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20947 +#, no-wrap +msgid "VM" +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:20954 +msgid "guix system vm" +msgstr "" + +#. type: table +#: doc/guix.texi:20954 +msgid "Build a virtual machine that contains the operating system declared in @var{file}, and return a script to run that virtual machine (VM). Arguments given to the script are passed to QEMU as in the example below, which enables networking and requests 1@tie{}GiB of RAM for the emulated machine:" +msgstr "" + +#. type: example +#: doc/guix.texi:20957 +#, no-wrap +msgid "$ /gnu/store/@dots{}-run-vm.sh -m 1024 -net user\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20960 +msgid "The VM shares its store with the host system." +msgstr "" + +#. type: table +#: doc/guix.texi:20965 +msgid "Additional file systems can be shared between the host and the VM using the @code{--share} and @code{--expose} command-line options: the former specifies a directory to be shared with write access, while the latter provides read-only access to the shared directory." +msgstr "" + +#. type: table +#: doc/guix.texi:20969 +msgid "The example below creates a VM in which the user's home directory is accessible read-only, and where the @file{/exchange} directory is a read-write mapping of @file{$HOME/tmp} on the host:" +msgstr "" + +#. type: example +#: doc/guix.texi:20973 +#, no-wrap +msgid "" +"guix system vm my-config.scm \\\n" +" --expose=$HOME --share=$HOME/tmp=/exchange\n" +msgstr "" + +#. type: table +#: doc/guix.texi:20978 +msgid "On GNU/Linux, the default is to boot directly to the kernel; this has the advantage of requiring only a very tiny root disk image since the store of the host can then be mounted." +msgstr "" + +#. type: table +#: doc/guix.texi:20984 +msgid "The @code{--full-boot} option forces a complete boot sequence, starting with the bootloader. This requires more disk space since a root image containing at least the kernel, initrd, and bootloader data files must be created. The @code{--image-size} option can be used to specify the size of the image." +msgstr "" + +#. type: cindex +#: doc/guix.texi:20985 +#, no-wrap +msgid "System images, creation in various formats" +msgstr "" + +#. type: cindex +#: doc/guix.texi:20986 +#, no-wrap +msgid "Creating system images in various formats" +msgstr "" + +#. type: item +#: doc/guix.texi:20987 +#, no-wrap +msgid "vm-image" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20988 +#, no-wrap +msgid "disk-image" +msgstr "" + +#. type: itemx +#: doc/guix.texi:20989 +#, no-wrap +msgid "docker-image" +msgstr "" + +#. type: table +#: doc/guix.texi:20997 +msgid "Return a virtual machine, disk image, or Docker image of the operating system declared in @var{file} that stands alone. By default, @command{guix system} estimates the size of the image needed to store the system, but you can use the @option{--image-size} option to specify a value. Docker images are built to contain exactly what they need, so the @option{--image-size} option is ignored in the case of @code{docker-image}." +msgstr "" + +#. type: table +#: doc/guix.texi:21000 +msgid "You can specify the root file system type by using the @option{--file-system-type} option. It defaults to @code{ext4}." +msgstr "" + +#. type: table +#: doc/guix.texi:21004 +msgid "When using @code{vm-image}, the returned image is in qcow2 format, which the QEMU emulator can efficiently use. @xref{Running GuixSD in a VM}, for more information on how to run the image in a virtual machine." +msgstr "" + +#. type: table +#: doc/guix.texi:21009 +msgid "When using @code{disk-image}, a raw disk image is produced; it can be copied as is to a USB stick, for instance. Assuming @code{/dev/sdc} is the device corresponding to a USB stick, one can copy the image to it using the following command:" +msgstr "" + +#. type: example +#: doc/guix.texi:21012 +#, no-wrap +msgid "# dd if=$(guix system disk-image my-os.scm) of=/dev/sdc\n" +msgstr "" + +#. type: table +#: doc/guix.texi:21019 +msgid "When using @code{docker-image}, a Docker image is produced. Guix builds the image from scratch, not from a pre-existing Docker base image. As a result, it contains @emph{exactly} what you define in the operating system configuration file. You can then load the image and launch a Docker container using commands like the following:" +msgstr "" + +#. type: example +#: doc/guix.texi:21025 +#, no-wrap +msgid "" +"image_id=\"$(docker load < guixsd-docker-image.tar.gz)\"\n" +"docker run -e GUIX_NEW_SYSTEM=/var/guix/profiles/system \\\\\n" +" --entrypoint /var/guix/profiles/system/profile/bin/guile \\\\\n" +" $image_id /var/guix/profiles/system/boot\n" +msgstr "" + +#. type: table +#: doc/guix.texi:21035 +msgid "This command starts a new Docker container from the specified image. It will boot the GuixSD system in the usual manner, which means it will start any services you have defined in the operating system configuration. Depending on what you run in the Docker container, it may be necessary to give the container additional permissions. For example, if you intend to build software using Guix inside of the Docker container, you may need to pass the @option{--privileged} option to @code{docker run}." +msgstr "" + +#. type: table +#: doc/guix.texi:21043 +msgid "Return a script to run the operating system declared in @var{file} within a container. Containers are a set of lightweight isolation mechanisms provided by the kernel Linux-libre. Containers are substantially less resource-demanding than full virtual machines since the kernel, shared objects, and other resources can be shared with the host system; this also means they provide thinner isolation." +msgstr "" + +#. type: table +#: doc/guix.texi:21047 +msgid "Currently, the script must be run as root in order to support more than a single user and group. The container shares its store with the host system." +msgstr "" + +#. type: table +#: doc/guix.texi:21051 +msgid "As with the @code{vm} action (@pxref{guix system vm}), additional file systems to be shared between the host and container can be specified using the @option{--share} and @option{--expose} options:" +msgstr "" + +#. type: example +#: doc/guix.texi:21055 +#, no-wrap +msgid "" +"guix system container my-config.scm \\\n" +" --expose=$HOME --share=$HOME/tmp=/exchange\n" +msgstr "" + +#. type: quotation +#: doc/guix.texi:21059 +msgid "This option requires Linux-libre 3.19 or newer." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21066 +msgid "@var{options} can contain any of the common build options (@pxref{Common Build Options}). In addition, @var{options} can contain one of the following:" +msgstr "" + +#. type: table +#: doc/guix.texi:21075 +msgid "Consider the operating-system @var{expr} evaluates to. This is an alternative to specifying a file which evaluates to an operating system. This is used to generate the GuixSD installer @pxref{Building the Installation Image})." +msgstr "" + +#. type: table +#: doc/guix.texi:21080 +msgid "Attempt to build for @var{system} instead of the host system type. This works as per @command{guix build} (@pxref{Invoking guix build})." +msgstr "" + +#. type: item +#: doc/guix.texi:21081 +#, no-wrap +msgid "--derivation" +msgstr "" + +#. type: table +#: doc/guix.texi:21085 +msgid "Return the derivation file name of the given operating system without building anything." +msgstr "" + +#. type: item +#: doc/guix.texi:21086 +#, no-wrap +msgid "--file-system-type=@var{type}" +msgstr "" + +#. type: table +#: doc/guix.texi:21090 +msgid "For the @code{disk-image} action, create a file system of the given @var{type} on the image." +msgstr "" + +#. type: table +#: doc/guix.texi:21092 +msgid "When this option is omitted, @command{guix system} uses @code{ext4}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21093 +#, no-wrap +msgid "ISO-9660 format" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21094 +#, no-wrap +msgid "CD image format" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21095 +#, no-wrap +msgid "DVD image format" +msgstr "" + +#. type: table +#: doc/guix.texi:21098 +msgid "@code{--file-system-type=iso9660} produces an ISO-9660 image, suitable for burning on CDs and DVDs." +msgstr "" + +#. type: item +#: doc/guix.texi:21099 +#, no-wrap +msgid "--image-size=@var{size}" +msgstr "" + +#. type: table +#: doc/guix.texi:21104 +msgid "For the @code{vm-image} and @code{disk-image} actions, create an image of the given @var{size}. @var{size} may be a number of bytes, or it may include a unit as a suffix (@pxref{Block size, size specifications,, coreutils, GNU Coreutils})." +msgstr "" + +#. type: table +#: doc/guix.texi:21108 +msgid "When this option is omitted, @command{guix system} computes an estimate of the image size as a function of the size of the system declared in @var{file}." +msgstr "" + +#. type: item +#: doc/guix.texi:21114 +#, no-wrap +msgid "--skip-checks" +msgstr "" + +#. type: table +#: doc/guix.texi:21116 +msgid "Skip pre-installation safety checks." +msgstr "" + +#. type: table +#: doc/guix.texi:21123 +msgid "By default, @command{guix system init} and @command{guix system reconfigure} perform safety checks: they make sure the file systems that appear in the @code{operating-system} declaration actually exist (@pxref{File Systems}), and that any Linux kernel modules that may be needed at boot time are listed in @code{initrd-modules} (@pxref{Initial RAM Disk}). Passing this option skips these tests altogether." +msgstr "" + +#. type: item +#: doc/guix.texi:21124 +#, no-wrap +msgid "--on-error=@var{strategy}" +msgstr "" + +#. type: table +#: doc/guix.texi:21127 +msgid "Apply @var{strategy} when an error occurs when reading @var{file}. @var{strategy} may be one of the following:" +msgstr "" + +#. type: item +#: doc/guix.texi:21129 +#, no-wrap +msgid "nothing-special" +msgstr "" + +#. type: table +#: doc/guix.texi:21131 +msgid "Report the error concisely and exit. This is the default strategy." +msgstr "" + +#. type: item +#: doc/guix.texi:21132 +#, no-wrap +msgid "backtrace" +msgstr "" + +#. type: table +#: doc/guix.texi:21134 +msgid "Likewise, but also display a backtrace." +msgstr "" + +#. type: item +#: doc/guix.texi:21135 +#, no-wrap +msgid "debug" +msgstr "" + +#. type: table +#: doc/guix.texi:21141 +msgid "Report the error and enter Guile's debugger. From there, you can run commands such as @code{,bt} to get a backtrace, @code{,locals} to display local variable values, and more generally inspect the state of the program. @xref{Debug Commands,,, guile, GNU Guile Reference Manual}, for a list of available debugging commands." +msgstr "" + +#. type: quotation +#: doc/guix.texi:21151 +msgid "All the actions above, except @code{build} and @code{init}, can use KVM support in the Linux-libre kernel. Specifically, if the machine has hardware virtualization support, the corresponding KVM kernel module should be loaded, and the @file{/dev/kvm} device node must exist and be readable and writable by the user and by the build users of the daemon (@pxref{Build Environment Setup})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21157 +msgid "Once you have built, configured, re-configured, and re-re-configured your GuixSD installation, you may find it useful to list the operating system generations available on disk---and that you can choose from the bootloader boot menu:" +msgstr "" + +#. type: item +#: doc/guix.texi:21160 +#, no-wrap +msgid "list-generations" +msgstr "" + +#. type: table +#: doc/guix.texi:21165 +msgid "List a summary of each generation of the operating system available on disk, in a human-readable way. This is similar to the @option{--list-generations} option of @command{guix package} (@pxref{Invoking guix package})." +msgstr "" + +#. type: table +#: doc/guix.texi:21170 +msgid "Optionally, one can specify a pattern, with the same syntax that is used in @command{guix package --list-generations}, to restrict the list of generations displayed. For instance, the following command displays generations that are up to 10 days old:" +msgstr "" + +#. type: example +#: doc/guix.texi:21173 +#, no-wrap +msgid "$ guix system list-generations 10d\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21180 +msgid "The @command{guix system} command has even more to offer! The following sub-commands allow you to visualize how your system services relate to each other:" +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:21182 +msgid "system-extension-graph" +msgstr "" + +#. type: item +#: doc/guix.texi:21184 +#, no-wrap +msgid "extension-graph" +msgstr "" + +#. type: table +#: doc/guix.texi:21189 +msgid "Emit in Dot/Graphviz format to standard output the @dfn{service extension graph} of the operating system defined in @var{file} (@pxref{Service Composition}, for more information on service extensions.)" +msgstr "" + +#. type: table +#: doc/guix.texi:21191 +msgid "The command:" +msgstr "" + +#. type: example +#: doc/guix.texi:21194 +#, no-wrap +msgid "$ guix system extension-graph @var{file} | dot -Tpdf > services.pdf\n" +msgstr "" + +#. type: table +#: doc/guix.texi:21197 +msgid "produces a PDF file showing the extension relations among services." +msgstr "" + +#. type: anchor{#1} +#: doc/guix.texi:21199 +msgid "system-shepherd-graph" +msgstr "" + +#. type: item +#: doc/guix.texi:21199 +#, no-wrap +msgid "shepherd-graph" +msgstr "" + +#. type: table +#: doc/guix.texi:21204 +msgid "Emit in Dot/Graphviz format to standard output the @dfn{dependency graph} of shepherd services of the operating system defined in @var{file}. @xref{Shepherd Services}, for more information and for an example graph." +msgstr "" + +#. type: subsection +#: doc/guix.texi:21208 +#, no-wrap +msgid "Running GuixSD in a Virtual Machine" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21218 +msgid "To run GuixSD in a virtual machine (VM), one can either use the pre-built GuixSD VM image distributed at @indicateurl{ftp://alpha.gnu.org/guix/guixsd-vm-image-@value{VERSION}.@var{system}.tar.xz} , or build their own virtual machine image using @command{guix system vm-image} (@pxref{Invoking guix system}). The returned image is in qcow2 format, which the @uref{http://qemu.org/, QEMU emulator} can efficiently use." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21219 +#, no-wrap +msgid "QEMU" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21226 +msgid "If you built your own image, you must copy it out of the store (@pxref{The Store}) and give yourself permission to write to the copy before you can use it. When invoking QEMU, you must choose a system emulator that is suitable for your hardware platform. Here is a minimal QEMU invocation that will boot the result of @command{guix system vm-image} on x86_64 hardware:" +msgstr "" + +#. type: example +#: doc/guix.texi:21231 +#, no-wrap +msgid "" +"$ qemu-system-x86_64 \\\n" +" -net user -net nic,model=virtio \\\n" +" -enable-kvm -m 256 /tmp/qemu-image\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21234 +msgid "Here is what each of these options means:" +msgstr "" + +#. type: item +#: doc/guix.texi:21236 +#, no-wrap +msgid "qemu-system-x86_64" +msgstr "" + +#. type: table +#: doc/guix.texi:21239 +msgid "This specifies the hardware platform to emulate. This should match the host." +msgstr "" + +#. type: item +#: doc/guix.texi:21240 +#, no-wrap +msgid "-net user" +msgstr "" + +#. type: table +#: doc/guix.texi:21244 +msgid "Enable the unprivileged user-mode network stack. The guest OS can access the host but not vice versa. This is the simplest way to get the guest OS online." +msgstr "" + +#. type: item +#: doc/guix.texi:21245 +#, no-wrap +msgid "-net nic,model=virtio" +msgstr "" + +#. type: table +#: doc/guix.texi:21250 +msgid "You must create a network interface of a given model. If you do not create a NIC, the boot will fail. Assuming your hardware platform is x86_64, you can get a list of available NIC models by running @command{qemu-system-x86_64 -net nic,model=help}." +msgstr "" + +#. type: item +#: doc/guix.texi:21251 +#, no-wrap +msgid "-enable-kvm" +msgstr "" + +#. type: table +#: doc/guix.texi:21255 +msgid "If your system has hardware virtualization extensions, enabling the virtual machine support (KVM) of the Linux kernel will make things run faster." +msgstr "" + +#. type: item +#: doc/guix.texi:21256 +#, no-wrap +msgid "-m 256" +msgstr "" + +#. type: table +#: doc/guix.texi:21259 +msgid "RAM available to the guest OS, in mebibytes. Defaults to 128@tie{}MiB, which may be insufficient for some operations." +msgstr "" + +#. type: item +#: doc/guix.texi:21260 +#, no-wrap +msgid "/tmp/qemu-image" +msgstr "" + +#. type: table +#: doc/guix.texi:21262 +msgid "The file name of the qcow2 image." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21272 +msgid "The default @command{run-vm.sh} script that is returned by an invocation of @command{guix system vm} does not add a @command{-net user} flag by default. To get network access from within the vm add the @code{(dhcp-client-service)} to your system definition and start the VM using @command{`guix system vm config.scm` -net user}. An important caveat of using @command{-net user} for networking is that @command{ping} will not work, because it uses the ICMP protocol. You'll have to use a different command to check for network connectivity, for example @command{guix download}." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:21273 +#, no-wrap +msgid "Connecting Through SSH" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21282 +msgid "To enable SSH inside a VM you need to add a SSH server like @code{(dropbear-service)} or @code{(lsh-service)} to your VM. The @code{(lsh-service}) doesn't currently boot unsupervised. It requires you to type some characters to initialize the randomness generator. In addition you need to forward the SSH port, 22 by default, to the host. You can do this with" +msgstr "" + +#. type: example +#: doc/guix.texi:21285 +#, no-wrap +msgid "`guix system vm config.scm` -net user,hostfwd=tcp::10022-:22\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21288 +msgid "To connect to the VM you can run" +msgstr "" + +#. type: example +#: doc/guix.texi:21291 +#, no-wrap +msgid "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 10022\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21298 +msgid "The @command{-p} tells @command{ssh} the port you want to connect to. @command{-o UserKnownHostsFile=/dev/null} prevents @command{ssh} from complaining every time you modify your @command{config.scm} file and the @command{-o StrictHostKeyChecking=no} prevents you from having to allow a connection to an unknown host every time you connect." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:21299 +#, no-wrap +msgid "Using @command{virt-viewer} with Spice" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21305 +msgid "As an alternative to the default @command{qemu} graphical client you can use the @command{remote-viewer} from the @command{virt-viewer} package. To connect pass the @command{-spice port=5930,disable-ticketing} flag to @command{qemu}. See previous section for further information on how to do this." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21308 +msgid "Spice also allows you to do some nice stuff like share your clipboard with your VM. To enable that you'll also have to pass the following flags to @command{qemu}:" +msgstr "" + +#. type: example +#: doc/guix.texi:21314 +#, no-wrap +msgid "" +"-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5\n" +"-chardev spicevmc,name=vdagent,id=vdagent\n" +"-device virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,\n" +"name=com.redhat.spice.0\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21317 +msgid "You'll also need to add the @pxref{Miscellaneous Services, Spice service}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21324 +msgid "The previous sections show the available services and how one can combine them in an @code{operating-system} declaration. But how do we define them in the first place? And what is a service anyway?" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21336 +#, no-wrap +msgid "daemons" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21349 +msgid "Here we define a @dfn{service} as, broadly, something that extends the functionality of the operating system. Often a service is a process---a @dfn{daemon}---started when the system boots: a secure shell server, a Web server, the Guix build daemon, etc. Sometimes a service is a daemon whose execution can be triggered by another daemon---e.g., an FTP server started by @command{inetd} or a D-Bus service activated by @command{dbus-daemon}. Occasionally, a service does not map to a daemon. For instance, the ``account'' service collects user accounts and makes sure they exist when the system runs; the ``udev'' service collects device management rules and makes them available to the eudev daemon; the @file{/etc} service populates the @file{/etc} directory of the system." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21350 +#, no-wrap +msgid "service extensions" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21362 +msgid "GuixSD services are connected by @dfn{extensions}. For instance, the secure shell service @emph{extends} the Shepherd---the GuixSD initialization system, running as PID@tie{}1---by giving it the command lines to start and stop the secure shell daemon (@pxref{Networking Services, @code{lsh-service}}); the UPower service extends the D-Bus service by passing it its @file{.service} specification, and extends the udev service by passing it device management rules (@pxref{Desktop Services, @code{upower-service}}); the Guix daemon service extends the Shepherd by passing it the command lines to start and stop the daemon, and extends the account service by passing it a list of required build user accounts (@pxref{Base Services})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21366 +msgid "All in all, services and their ``extends'' relations form a directed acyclic graph (DAG). If we represent services as boxes and extensions as arrows, a typical system might provide something like this:" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21368 +msgid "@image{images/service-graph,,5in,Typical service extension graph.}" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21369 +#, no-wrap +msgid "system service" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21377 +msgid "At the bottom, we see the @dfn{system service}, which produces the directory containing everything to run and boot the system, as returned by the @command{guix system build} command. @xref{Service Reference}, to learn about the other service types shown here. @xref{system-extension-graph, the @command{guix system extension-graph} command}, for information on how to generate this representation for a particular operating system definition." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21378 +#, no-wrap +msgid "service types" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21384 +msgid "Technically, developers can define @dfn{service types} to express these relations. There can be any number of services of a given type on the system---for instance, a system running two instances of the GNU secure shell server (lsh) has two instances of @var{lsh-service-type}, with different parameters." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21387 +msgid "The following section describes the programming interface for service types and services." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21394 +msgid "A @dfn{service type} is a node in the DAG described above. Let us start with a simple example, the service type for the Guix build daemon (@pxref{Invoking guix-daemon}):" +msgstr "" + +#. type: example +#: doc/guix.texi:21404 +#, no-wrap +msgid "" +"(define guix-service-type\n" +" (service-type\n" +" (name 'guix)\n" +" (extensions\n" +" (list (service-extension shepherd-root-service-type guix-shepherd-service)\n" +" (service-extension account-service-type guix-accounts)\n" +" (service-extension activation-service-type guix-activation)))\n" +" (default-value (guix-configuration))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21408 +msgid "It defines three things:" +msgstr "" + +#. type: enumerate +#: doc/guix.texi:21412 +msgid "A name, whose sole purpose is to make inspection and debugging easier." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:21417 +msgid "A list of @dfn{service extensions}, where each extension designates the target service type and a procedure that, given the parameters of the service, returns a list of objects to extend the service of that type." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:21420 +msgid "Every service type has at least one service extension. The only exception is the @dfn{boot service type}, which is the ultimate service." +msgstr "" + +#. type: enumerate +#: doc/guix.texi:21423 +msgid "Optionally, a default value for instances of this type." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21426 +msgid "In this example, @var{guix-service-type} extends three services:" +msgstr "" + +#. type: item +#: doc/guix.texi:21428 +#, no-wrap +msgid "shepherd-root-service-type" +msgstr "" + +#. type: table +#: doc/guix.texi:21433 +msgid "The @var{guix-shepherd-service} procedure defines how the Shepherd service is extended. Namely, it returns a @code{<shepherd-service>} object that defines how @command{guix-daemon} is started and stopped (@pxref{Shepherd Services})." +msgstr "" + +#. type: item +#: doc/guix.texi:21434 +#, no-wrap +msgid "account-service-type" +msgstr "" + +#. type: table +#: doc/guix.texi:21439 +msgid "This extension for this service is computed by @var{guix-accounts}, which returns a list of @code{user-group} and @code{user-account} objects representing the build user accounts (@pxref{Invoking guix-daemon})." +msgstr "" + +#. type: item +#: doc/guix.texi:21440 +#, no-wrap +msgid "activation-service-type" +msgstr "" + +#. type: table +#: doc/guix.texi:21444 +msgid "Here @var{guix-activation} is a procedure that returns a gexp, which is a code snippet to run at ``activation time''---e.g., when the service is booted." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21447 +msgid "A service of this type is instantiated like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:21453 +#, no-wrap +msgid "" +"(service guix-service-type\n" +" (guix-configuration\n" +" (build-accounts 5)\n" +" (use-substitutes? #f)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21461 +msgid "The second argument to the @code{service} form is a value representing the parameters of this specific service instance. @xref{guix-configuration-type, @code{guix-configuration}}, for information about the @code{guix-configuration} data type. When the value is omitted, the default value specified by @code{guix-service-type} is used:" +msgstr "" + +#. type: example +#: doc/guix.texi:21464 +#, no-wrap +msgid "(service guix-service-type)\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21468 +msgid "@var{guix-service-type} is quite simple because it extends other services but is not extensible itself." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21472 +msgid "The service type for an @emph{extensible} service looks like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:21479 +#, no-wrap +msgid "" +"(define udev-service-type\n" +" (service-type (name 'udev)\n" +" (extensions\n" +" (list (service-extension shepherd-root-service-type\n" +" udev-shepherd-service)))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:21487 +#, no-wrap +msgid "" +" (compose concatenate) ;concatenate the list of rules\n" +" (extend (lambda (config rules)\n" +" (match config\n" +" (($ <udev-configuration> udev initial-rules)\n" +" (udev-configuration\n" +" (udev udev) ;the udev package to use\n" +" (rules (append initial-rules rules)))))))))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21493 +msgid "This is the service type for the @uref{https://wiki.gentoo.org/wiki/Project:Eudev, eudev device management daemon}. Compared to the previous example, in addition to an extension of @var{shepherd-root-service-type}, we see two new fields:" +msgstr "" + +#. type: item +#: doc/guix.texi:21495 +#, no-wrap +msgid "compose" +msgstr "" + +#. type: table +#: doc/guix.texi:21498 +msgid "This is the procedure to @dfn{compose} the list of extensions to services of this type." +msgstr "" + +#. type: table +#: doc/guix.texi:21501 +msgid "Services can extend the udev service by passing it lists of rules; we compose those extensions simply by concatenating them." +msgstr "" + +#. type: item +#: doc/guix.texi:21502 +#, no-wrap +msgid "extend" +msgstr "" + +#. type: table +#: doc/guix.texi:21505 +msgid "This procedure defines how the value of the service is @dfn{extended} with the composition of the extensions." +msgstr "" + +#. type: table +#: doc/guix.texi:21510 +msgid "Udev extensions are composed into a list of rules, but the udev service value is itself a @code{<udev-configuration>} record. So here, we extend that record by appending the list of rules it contains to the list of contributed rules." +msgstr "" + +#. type: table +#: doc/guix.texi:21516 +msgid "This is a string giving an overview of the service type. The string can contain Texinfo markup (@pxref{Overview,,, texinfo, GNU Texinfo}). The @command{guix system search} command searches these strings and displays them (@pxref{Invoking guix system})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21521 +msgid "There can be only one instance of an extensible service type such as @var{udev-service-type}. If there were more, the @code{service-extension} specifications would be ambiguous." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21524 +msgid "Still here? The next section provides a reference of the programming interface for services." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21532 +msgid "We have seen an overview of service types (@pxref{Service Types and Services}). This section provides a reference on how to manipulate services and service types. This interface is provided by the @code{(gnu services)} module." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21533 +#, no-wrap +msgid "{Scheme Procedure} service @var{type} [@var{value}]" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21537 +msgid "Return a new service of @var{type}, a @code{<service-type>} object (see below.) @var{value} can be any object; it represents the parameters of this particular service instance." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21541 +msgid "When @var{value} is omitted, the default value specified by @var{type} is used; if @var{type} does not specify a default value, an error is raised." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21543 +msgid "For instance, this:" +msgstr "" + +#. type: example +#: doc/guix.texi:21546 +#, no-wrap +msgid "(service openssh-service-type)\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21550 +msgid "is equivalent to this:" +msgstr "" + +#. type: example +#: doc/guix.texi:21554 +#, no-wrap +msgid "" +"(service openssh-service-type\n" +" (openssh-configuration))\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21558 +msgid "In both cases the result is an instance of @code{openssh-service-type} with the default configuration." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21560 +#, no-wrap +msgid "{Scheme Procedure} service? @var{obj}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21562 +msgid "Return true if @var{obj} is a service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21564 +#, no-wrap +msgid "{Scheme Procedure} service-kind @var{service}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21566 +msgid "Return the type of @var{service}---i.e., a @code{<service-type>} object." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21568 +#, no-wrap +msgid "{Scheme Procedure} service-value @var{service}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21571 +msgid "Return the value associated with @var{service}. It represents its parameters." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21574 +msgid "Here is an example of how a service is created and manipulated:" +msgstr "" + +#. type: example +#: doc/guix.texi:21583 +#, no-wrap +msgid "" +"(define s\n" +" (service nginx-service-type\n" +" (nginx-configuration\n" +" (nginx nginx)\n" +" (log-directory log-directory)\n" +" (run-directory run-directory)\n" +" (file config-file))))\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:21586 +#, no-wrap +msgid "" +"(service? s)\n" +"@result{} #t\n" +"\n" +msgstr "" + +#. type: example +#: doc/guix.texi:21589 +#, no-wrap +msgid "" +"(eq? (service-kind s) nginx-service-type)\n" +"@result{} #t\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21599 +msgid "The @code{modify-services} form provides a handy way to change the parameters of some of the services of a list such as @var{%base-services} (@pxref{Base Services, @code{%base-services}}). It evaluates to a list of services. Of course, you could always use standard list combinators such as @code{map} and @code{fold} to do that (@pxref{SRFI-1, List Library,, guile, GNU Guile Reference Manual}); @code{modify-services} simply provides a more concise form for this common pattern." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21600 +#, no-wrap +msgid "{Scheme Syntax} modify-services @var{services} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21602 +msgid "(@var{type} @var{variable} => @var{body}) @dots{}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21605 +msgid "Modify the services listed in @var{services} according to the given clauses. Each clause has the form:" +msgstr "" + +#. type: example +#: doc/guix.texi:21608 +#, no-wrap +msgid "(@var{type} @var{variable} => @var{body})\n" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21615 +msgid "where @var{type} is a service type---e.g., @code{guix-service-type}---and @var{variable} is an identifier that is bound within the @var{body} to the service parameters---e.g., a @code{guix-configuration} instance---of the original service of that @var{type}." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21622 +msgid "The @var{body} should evaluate to the new service parameters, which will be used to configure the new service. This new service will replace the original in the resulting list. Because a service's service parameters are created using @code{define-record-type*}, you can write a succinct @var{body} that evaluates to the new service parameters by using the @code{inherit} feature that @code{define-record-type*} provides." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21624 +msgid "@xref{Using the Configuration System}, for example usage." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21631 +msgid "Next comes the programming interface for service types. This is something you want to know when writing new service definitions, but not necessarily when simply looking for ways to customize your @code{operating-system} declaration." +msgstr "" + +#. type: deftp +#: doc/guix.texi:21632 +#, no-wrap +msgid "{Data Type} service-type" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21633 +#, no-wrap +msgid "service type" +msgstr "" + +#. type: deftp +#: doc/guix.texi:21636 +msgid "This is the representation of a @dfn{service type} (@pxref{Service Types and Services})." +msgstr "" + +#. type: table +#: doc/guix.texi:21640 +msgid "This is a symbol, used only to simplify inspection and debugging." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:21641 +#, no-wrap +msgid "extensions" +msgstr "" + +#. type: table +#: doc/guix.texi:21643 +msgid "A non-empty list of @code{<service-extension>} objects (see below)." +msgstr "" + +#. type: item +#: doc/guix.texi:21644 +#, no-wrap +msgid "@code{compose} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:21648 +msgid "If this is @code{#f}, then the service type denotes services that cannot be extended---i.e., services that do not receive ``values'' from other services." +msgstr "" + +#. type: table +#: doc/guix.texi:21652 +msgid "Otherwise, it must be a one-argument procedure. The procedure is called by @code{fold-services} and is passed a list of values collected from extensions. It may return any single value." +msgstr "" + +#. type: item +#: doc/guix.texi:21653 +#, no-wrap +msgid "@code{extend} (default: @code{#f})" +msgstr "" + +#. type: table +#: doc/guix.texi:21655 +msgid "If this is @code{#f}, services of this type cannot be extended." +msgstr "" + +#. type: table +#: doc/guix.texi:21661 +msgid "Otherwise, it must be a two-argument procedure: @code{fold-services} calls it, passing it the initial value of the service as the first argument and the result of applying @code{compose} to the extension values as the second argument. It must return a value that is a valid parameter value for the service instance." +msgstr "" + +#. type: deftp +#: doc/guix.texi:21664 +msgid "@xref{Service Types and Services}, for examples." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21666 +#, no-wrap +msgid "{Scheme Procedure} service-extension @var{target-type} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21672 +msgid "@var{compute} Return a new extension for services of type @var{target-type}. @var{compute} must be a one-argument procedure: @code{fold-services} calls it, passing it the value associated with the service that provides the extension; it must return a valid value for the target service." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21674 +#, no-wrap +msgid "{Scheme Procedure} service-extension? @var{obj}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21676 +msgid "Return true if @var{obj} is a service extension." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21682 +msgid "Occasionally, you might want to simply extend an existing service. This involves creating a new service type and specifying the extension of interest, which can be verbose; the @code{simple-service} procedure provides a shorthand for this." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21683 +#, no-wrap +msgid "{Scheme Procedure} simple-service @var{name} @var{target} @var{value}" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21687 +msgid "Return a service that extends @var{target} with @var{value}. This works by creating a singleton service type @var{name}, of which the returned service is an instance." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21690 +msgid "For example, this extends mcron (@pxref{Scheduled Job Execution}) with an additional job:" +msgstr "" + +#. type: example +#: doc/guix.texi:21694 +#, no-wrap +msgid "" +"(simple-service 'my-mcron-job mcron-service-type\n" +" #~(job '(next-hour (3)) \"guix gc -F 2G\"))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21704 +msgid "At the core of the service abstraction lies the @code{fold-services} procedure, which is responsible for ``compiling'' a list of services down to a single directory that contains everything needed to boot and run the system---the directory shown by the @command{guix system build} command (@pxref{Invoking guix system}). In essence, it propagates service extensions down the service graph, updating each node parameters on the way, until it reaches the root node." +msgstr "" + +#. type: deffn +#: doc/guix.texi:21705 +#, no-wrap +msgid "{Scheme Procedure} fold-services @var{services} @" +msgstr "" + +#. type: deffn +#: doc/guix.texi:21709 +msgid "[#:target-type @var{system-service-type}] Fold @var{services} by propagating their extensions down to the root of type @var{target-type}; return the root service adjusted accordingly." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21713 +msgid "Lastly, the @code{(gnu services)} module also defines several essential service types, some of which are listed below." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21714 +#, no-wrap +msgid "{Scheme Variable} system-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21717 +msgid "This is the root of the service graph. It produces the system directory as returned by the @command{guix system build} command." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21719 +#, no-wrap +msgid "{Scheme Variable} boot-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21722 +msgid "The type of the ``boot service'', which produces the @dfn{boot script}. The boot script is what the initial RAM disk runs when booting." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21724 +#, no-wrap +msgid "{Scheme Variable} etc-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21728 +msgid "The type of the @file{/etc} service. This service is used to create files under @file{/etc} and can be extended by passing it name/file tuples such as:" +msgstr "" + +#. type: example +#: doc/guix.texi:21731 +#, no-wrap +msgid "(list `(\"issue\" ,(plain-file \"issue\" \"Welcome!\\n\")))\n" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21735 +msgid "In this example, the effect would be to add an @file{/etc/issue} file pointing to the given file." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21737 +#, no-wrap +msgid "{Scheme Variable} setuid-program-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21741 +msgid "Type for the ``setuid-program service''. This service collects lists of executable file names, passed as gexps, and adds them to the set of setuid-root programs on the system (@pxref{Setuid Programs})." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21743 +#, no-wrap +msgid "{Scheme Variable} profile-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21747 +msgid "Type of the service that populates the @dfn{system profile}---i.e., the programs under @file{/run/current-system/profile}. Other services can extend it by passing it lists of packages to add to the system profile." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21753 +#, no-wrap +msgid "shepherd services" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21754 +#, no-wrap +msgid "PID 1" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21755 +#, no-wrap +msgid "init system" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21761 +msgid "The @code{(gnu services shepherd)} module provides a way to define services managed by the GNU@tie{}Shepherd, which is the GuixSD initialization system---the first process that is started when the system boots, also known as PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd Manual})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21767 +msgid "Services in the Shepherd can depend on each other. For instance, the SSH daemon may need to be started after the syslog daemon has been started, which in turn can only happen once all the file systems have been mounted. The simple operating system defined earlier (@pxref{Using the Configuration System}) results in a service graph like this:" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21769 +msgid "@image{images/shepherd-graph,,5in,Typical shepherd service graph.}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21773 +msgid "You can actually generate such a graph for any operating system definition using the @command{guix system shepherd-graph} command (@pxref{system-shepherd-graph, @command{guix system shepherd-graph}})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21777 +msgid "The @var{%shepherd-root-service} is a service object representing PID@tie{}1, of type @var{shepherd-root-service-type}; it can be extended by passing it lists of @code{<shepherd-service>} objects." +msgstr "" + +#. type: deftp +#: doc/guix.texi:21778 +#, no-wrap +msgid "{Data Type} shepherd-service" +msgstr "" + +#. type: deftp +#: doc/guix.texi:21780 +msgid "The data type representing a service managed by the Shepherd." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:21782 +#, no-wrap +msgid "provision" +msgstr "" + +#. type: table +#: doc/guix.texi:21784 +msgid "This is a list of symbols denoting what the service provides." +msgstr "" + +#. type: table +#: doc/guix.texi:21789 +msgid "These are the names that may be passed to @command{herd start}, @command{herd status}, and similar commands (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual}). @xref{Slots of services, the @code{provides} slot,, shepherd, The GNU Shepherd Manual}, for details." +msgstr "" + +#. type: item +#: doc/guix.texi:21790 +#, no-wrap +msgid "@code{requirements} (default: @code{'()})" +msgstr "" + +#. type: table +#: doc/guix.texi:21792 +msgid "List of symbols denoting the Shepherd services this one depends on." +msgstr "" + +#. type: item +#: doc/guix.texi:21793 +#, no-wrap +msgid "@code{respawn?} (default: @code{#t})" +msgstr "" + +#. type: table +#: doc/guix.texi:21796 +msgid "Whether to restart the service when it stops, for instance when the underlying process dies." +msgstr "" + +#. type: code{#1} +#: doc/guix.texi:21797 +#, no-wrap +msgid "start" +msgstr "" + +#. type: itemx +#: doc/guix.texi:21798 +#, no-wrap +msgid "@code{stop} (default: @code{#~(const #f)})" +msgstr "" + +#. type: table +#: doc/guix.texi:21804 +msgid "The @code{start} and @code{stop} fields refer to the Shepherd's facilities to start and stop processes (@pxref{Service De- and Constructors,,, shepherd, The GNU Shepherd Manual}). They are given as G-expressions that get expanded in the Shepherd configuration file (@pxref{G-Expressions})." +msgstr "" + +#. type: table +#: doc/guix.texi:21807 +msgid "A documentation string, as shown when running:" +msgstr "" + +#. type: example +#: doc/guix.texi:21810 +#, no-wrap +msgid "herd doc @var{service-name}\n" +msgstr "" + +#. type: table +#: doc/guix.texi:21814 +msgid "where @var{service-name} is one of the symbols in @var{provision} (@pxref{Invoking herd,,, shepherd, The GNU Shepherd Manual})." +msgstr "" + +#. type: item +#: doc/guix.texi:21815 +#, no-wrap +msgid "@code{modules} (default: @var{%default-modules})" +msgstr "" + +#. type: table +#: doc/guix.texi:21818 +msgid "This is the list of modules that must be in scope when @code{start} and @code{stop} are evaluated." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21822 +#, no-wrap +msgid "{Scheme Variable} shepherd-root-service-type" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21824 +msgid "The service type for the Shepherd ``root service''---i.e., PID@tie{}1." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21828 +msgid "This is the service type that extensions target when they want to create shepherd services (@pxref{Service Types and Services}, for an example). Each extension must pass a list of @code{<shepherd-service>}." +msgstr "" + +#. type: defvr +#: doc/guix.texi:21830 +#, no-wrap +msgid "{Scheme Variable} %shepherd-root-service" +msgstr "" + +#. type: defvr +#: doc/guix.texi:21832 +msgid "This service represents PID@tie{}1." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21838 +#, no-wrap +msgid "documentation, searching for" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21839 +#, no-wrap +msgid "searching for documentation" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21840 +#, no-wrap +msgid "Info, documentation format" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21841 +#, no-wrap +msgid "man pages" +msgstr "" + +#. type: cindex +#: doc/guix.texi:21842 +#, no-wrap +msgid "manual pages" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21849 +msgid "In most cases packages installed with Guix come with documentation. There are two main documentation formats: ``Info'', a browseable hypertext format used for GNU software, and ``manual pages'' (or ``man pages''), the linear documentation format traditionally found on Unix. Info manuals are accessed with the @command{info} command or with Emacs, and man pages are accessed using @command{man}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21853 +msgid "You can look for documentation of software installed on your system by keyword. For example, the following command searches for information about ``TLS'' in Info manuals:" +msgstr "" + +#. type: example +#: doc/guix.texi:21861 +#, no-wrap +msgid "" +"$ info -k TLS\n" +"\"(emacs)Network Security\" -- STARTTLS\n" +"\"(emacs)Network Security\" -- TLS\n" +"\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_flags\n" +"\"(gnutls)Core TLS API\" -- gnutls_certificate_set_verify_function\n" +"@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21865 +msgid "The command below searches for the same keyword in man pages:" +msgstr "" + +#. type: example +#: doc/guix.texi:21871 +#, no-wrap +msgid "" +"$ man -k TLS\n" +"SSL (7) - OpenSSL SSL/TLS library\n" +"certtool (1) - GnuTLS certificate tool\n" +"@dots {}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21877 +msgid "These searches are purely local to your computer so you have the guarantee that documentation you find corresponds to what you have actually installed, you can access it off-line, and your privacy is respected." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21880 +msgid "Once you have these results, you can view the relevant documentation by running, say:" +msgstr "" + +#. type: example +#: doc/guix.texi:21883 +#, no-wrap +msgid "$ info \"(gnutls)Core TLS API\"\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21887 +msgid "or:" +msgstr "" + +#. type: example +#: doc/guix.texi:21890 +#, no-wrap +msgid "$ man certtool\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21898 +msgid "Info manuals contain sections and indices as well as hyperlinks like those found in Web pages. The @command{info} reader (@pxref{Top, Info reader,, info-stnd, Stand-alone GNU Info}) and its Emacs counterpart (@pxref{Misc Help,,, emacs, The GNU Emacs Manual}) provide intuitive key bindings to navigate manuals. @xref{Getting Started,,, info, Info: An Introduction}, for an introduction to Info navigation." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21902 +#, no-wrap +msgid "debugging files" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21908 +msgid "Program binaries, as produced by the GCC compilers for instance, are typically written in the ELF format, with a section containing @dfn{debugging information}. Debugging information is what allows the debugger, GDB, to map binary code to source code; it is required to debug a compiled program in good conditions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21916 +msgid "The problem with debugging information is that is takes up a fair amount of disk space. For example, debugging information for the GNU C Library weighs in at more than 60 MiB. Thus, as a user, keeping all the debugging info of all the installed programs is usually not an option. Yet, space savings should not come at the cost of an impediment to debugging---especially in the GNU system, which should make it easier for users to exert their computing freedom (@pxref{GNU Distribution})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21923 +msgid "Thankfully, the GNU Binary Utilities (Binutils) and GDB provide a mechanism that allows users to get the best of both worlds: debugging information can be stripped from the binaries and stored in separate files. GDB is then able to load debugging information from those files, when they are available (@pxref{Separate Debug Files,,, gdb, Debugging with GDB})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21931 +msgid "The GNU distribution takes advantage of this by storing debugging information in the @code{lib/debug} sub-directory of a separate package output unimaginatively called @code{debug} (@pxref{Packages with Multiple Outputs}). Users can choose to install the @code{debug} output of a package when they need it. For instance, the following command installs the debugging information for the GNU C Library and for GNU Guile:" +msgstr "" + +#. type: example +#: doc/guix.texi:21934 +#, no-wrap +msgid "guix package -i glibc:debug guile:debug\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21940 +msgid "GDB must then be told to look for debug files in the user's profile, by setting the @code{debug-file-directory} variable (consider setting it from the @file{~/.gdbinit} file, @pxref{Startup,,, gdb, Debugging with GDB}):" +msgstr "" + +#. type: example +#: doc/guix.texi:21943 +#, no-wrap +msgid "(gdb) set debug-file-directory ~/.guix-profile/lib/debug\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21947 +msgid "From there on, GDB will pick up debugging information from the @code{.debug} files under @file{~/.guix-profile/lib/debug}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21954 +msgid "In addition, you will most likely want GDB to be able to show the source code being debugged. To do that, you will have to unpack the source code of the package of interest (obtained with @code{guix build --source}, @pxref{Invoking guix build}), and to point GDB to that source directory using the @code{directory} command (@pxref{Source Path, @code{directory},, gdb, Debugging with GDB})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21963 +msgid "The @code{debug} output mechanism in Guix is implemented by the @code{gnu-build-system} (@pxref{Build Systems}). Currently, it is opt-in---debugging information is available only for the packages with definitions explicitly declaring a @code{debug} output. This may be changed to opt-out in the future if our build farm servers can handle the load. To check whether a package has a @code{debug} output, use @command{guix package --list-available} (@pxref{Invoking guix package})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:21968 +#, no-wrap +msgid "security updates" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21977 +msgid "Occasionally, important security vulnerabilities are discovered in software packages and must be patched. Guix developers try hard to keep track of known vulnerabilities and to apply fixes as soon as possible in the @code{master} branch of Guix (we do not yet provide a ``stable'' branch containing only security updates.) The @command{guix lint} tool helps developers find out about vulnerable versions of software packages in the distribution:" +msgstr "" + +#. type: smallexample +#: doc/guix.texi:21984 +#, no-wrap +msgid "" +"$ guix lint -c cve\n" +"gnu/packages/base.scm:652:2: glibc@@2.21: probably vulnerable to CVE-2015-1781, CVE-2015-7547\n" +"gnu/packages/gcc.scm:334:2: gcc@@4.9.3: probably vulnerable to CVE-2015-5276\n" +"gnu/packages/image.scm:312:2: openjpeg@@2.1.0: probably vulnerable to CVE-2016-1923, CVE-2016-1924\n" +"@dots{}\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:21987 +msgid "@xref{Invoking guix lint}, for more information." +msgstr "" + +#. type: quotation +#: doc/guix.texi:21991 +msgid "As of version @value{VERSION}, the feature described below is considered ``beta''." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22001 +msgid "Guix follows a functional package management discipline (@pxref{Introduction}), which implies that, when a package is changed, @emph{every package that depends on it} must be rebuilt. This can significantly slow down the deployment of fixes in core packages such as libc or Bash, since basically the whole distribution would need to be rebuilt. Using pre-built binaries helps (@pxref{Substitutes}), but deployment may still take more time than desired." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22002 +#, no-wrap +msgid "grafts" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22010 +msgid "To address this, Guix implements @dfn{grafts}, a mechanism that allows for fast deployment of critical updates without the costs associated with a whole-distribution rebuild. The idea is to rebuild only the package that needs to be patched, and then to ``graft'' it onto packages explicitly installed by the user and that were previously referring to the original package. The cost of grafting is typically very low, and order of magnitudes lower than a full rebuild of the dependency chain." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22011 +#, no-wrap +msgid "replacements of packages, for grafts" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22017 +msgid "For instance, suppose a security update needs to be applied to Bash. Guix developers will provide a package definition for the ``fixed'' Bash, say @var{bash-fixed}, in the usual way (@pxref{Defining Packages}). Then, the original package definition is augmented with a @code{replacement} field pointing to the package containing the bug fix:" +msgstr "" + +#. type: example +#: doc/guix.texi:22024 +#, no-wrap +msgid "" +"(define bash\n" +" (package\n" +" (name \"bash\")\n" +" ;; @dots{}\n" +" (replacement bash-fixed)))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22034 +msgid "From there on, any package depending directly or indirectly on Bash---as reported by @command{guix gc --requisites} (@pxref{Invoking guix gc})---that is installed is automatically ``rewritten'' to refer to @var{bash-fixed} instead of @var{bash}. This grafting process takes time proportional to the size of the package, usually less than a minute for an ``average'' package on a recent machine. Grafting is recursive: when an indirect dependency requires grafting, then grafting ``propagates'' up to the package that the user is installing." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22042 +msgid "Currently, the length of the name and version of the graft and that of the package it replaces (@var{bash-fixed} and @var{bash} in the example above) must be equal. This restriction mostly comes from the fact that grafting works by patching files, including binary files, directly. Other restrictions may apply: for instance, when adding a graft to a package providing a shared library, the original shared library and its replacement must have the same @code{SONAME} and be binary-compatible." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22046 +msgid "The @option{--no-grafts} command-line option allows you to forcefully avoid grafting (@pxref{Common Build Options, @option{--no-grafts}}). Thus, the command:" +msgstr "" + +#. type: example +#: doc/guix.texi:22049 +#, no-wrap +msgid "guix build bash --no-grafts\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22053 +msgid "returns the store file name of the original Bash, whereas:" +msgstr "" + +#. type: example +#: doc/guix.texi:22056 +#, no-wrap +msgid "guix build bash\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22061 +msgid "returns the store file name of the ``fixed'', replacement Bash. This allows you to distinguish between the two variants of Bash." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22064 +msgid "To verify which Bash your whole profile refers to, you can run (@pxref{Invoking guix gc}):" +msgstr "" + +#. type: example +#: doc/guix.texi:22067 +#, no-wrap +msgid "guix gc -R `readlink -f ~/.guix-profile` | grep bash\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22072 +msgid "@dots{} and compare the store file names that you get with those above. Likewise for a complete GuixSD system generation:" +msgstr "" + +#. type: example +#: doc/guix.texi:22075 +#, no-wrap +msgid "guix gc -R `guix system build my-config.scm` | grep bash\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22079 +msgid "Lastly, to check which Bash running processes are using, you can use the @command{lsof} command:" +msgstr "" + +#. type: example +#: doc/guix.texi:22082 +#, no-wrap +msgid "lsof | grep /gnu/store/.*bash\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22099 +msgid "From a programming viewpoint, the package definitions of the GNU distribution are provided by Guile modules in the @code{(gnu packages @dots{})} name space@footnote{Note that packages under the @code{(gnu packages @dots{})} module name space are not necessarily ``GNU packages''. This module naming scheme follows the usual Guile module naming convention: @code{gnu} means that these modules are distributed as part of the GNU system, and @code{packages} identifies modules that define packages.} (@pxref{Modules, Guile modules,, guile, GNU Guile Reference Manual}). For instance, the @code{(gnu packages emacs)} module exports a variable named @code{emacs}, which is bound to a @code{<package>} object (@pxref{Defining Packages})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22106 +msgid "The @code{(gnu packages @dots{})} module name space is automatically scanned for packages by the command-line tools. For instance, when running @code{guix package -i emacs}, all the @code{(gnu packages @dots{})} modules are scanned until one that exports a package object whose name is @code{emacs} is found. This package search facility is implemented in the @code{(gnu packages)} module." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22108 +#, no-wrap +msgid "package module search path" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22125 +msgid "Users can store package definitions in modules with different names---e.g., @code{(my-packages emacs)}@footnote{Note that the file name and module name must match. For instance, the @code{(my-packages emacs)} module must be stored in a @file{my-packages/emacs.scm} file relative to the load path specified with @option{--load-path} or @code{GUIX_PACKAGE_PATH}. @xref{Modules and the File System,,, guile, GNU Guile Reference Manual}, for details.}. These package definitions will not be visible by default. Users can invoke commands such as @command{guix package} and @command{guix build} with the @code{-e} option so that they know where to find the package. Better yet, they can use the @code{-L} option of these commands to make those modules visible (@pxref{Invoking guix build, @code{--load-path}}), or define the @code{GUIX_PACKAGE_PATH} environment variable. This environment variable makes it easy to extend or customize the distribution and is honored by all the user interfaces." +msgstr "" + +#. type: defvr +#: doc/guix.texi:22126 +#, no-wrap +msgid "{Environment Variable} GUIX_PACKAGE_PATH" +msgstr "" + +#. type: defvr +#: doc/guix.texi:22130 +msgid "This is a colon-separated list of directories to search for additional package modules. Directories listed in this variable take precedence over the own modules of the distribution." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22138 +msgid "The distribution is fully @dfn{bootstrapped} and @dfn{self-contained}: each package is built based solely on other packages in the distribution. The root of this dependency graph is a small set of @dfn{bootstrap binaries}, provided by the @code{(gnu packages bootstrap)} module. For more information on bootstrapping, @pxref{Bootstrapping}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22142 +#, no-wrap +msgid "packages, creating" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22147 +msgid "The GNU distribution is nascent and may well lack some of your favorite packages. This section describes how you can help make the distribution grow. @xref{Contributing}, for additional information on how you can help." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22155 +msgid "Free software packages are usually distributed in the form of @dfn{source code tarballs}---typically @file{tar.gz} files that contain all the source files. Adding a package to the distribution means essentially two things: adding a @dfn{recipe} that describes how to build the package, including a list of other packages required to build it, and adding @dfn{package metadata} along with that recipe, such as a description and licensing information." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22164 +msgid "In Guix all this information is embodied in @dfn{package definitions}. Package definitions provide a high-level view of the package. They are written using the syntax of the Scheme programming language; in fact, for each package we define a variable bound to the package definition, and export that variable from a module (@pxref{Package Modules}). However, in-depth Scheme knowledge is @emph{not} a prerequisite for creating packages. For more information on package definitions, @pxref{Defining Packages}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22170 +msgid "Once a package definition is in place, stored in a file in the Guix source tree, it can be tested using the @command{guix build} command (@pxref{Invoking guix build}). For example, assuming the new package is called @code{gnew}, you may run this command from the Guix build tree (@pxref{Running Guix Before It Is Installed}):" +msgstr "" + +#. type: example +#: doc/guix.texi:22173 +#, no-wrap +msgid "./pre-inst-env guix build gnew --keep-failed\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22179 +msgid "Using @code{--keep-failed} makes it easier to debug build failures since it provides access to the failed build tree. Another useful command-line option when debugging is @code{--log-file}, to access the build log." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22184 +msgid "If the package is unknown to the @command{guix} command, it may be that the source file contains a syntax error, or lacks a @code{define-public} clause to export the package variable. To figure it out, you may load the module from Guile to get more information about the actual error:" +msgstr "" + +#. type: example +#: doc/guix.texi:22187 +#, no-wrap +msgid "./pre-inst-env guile -c '(use-modules (gnu packages gnew))'\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22195 +msgid "Once your package builds correctly, please send us a patch (@pxref{Contributing}). Well, if you need help, we will be happy to help you too. Once the patch is committed in the Guix repository, the new package automatically gets built on the supported platforms by @url{http://hydra.gnu.org/jobset/gnu/master, our continuous integration system}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22196 +#, no-wrap +msgid "substituter" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22203 +msgid "Users can obtain the new package definition simply by running @command{guix pull} (@pxref{Invoking guix pull}). When @code{hydra.gnu.org} is done building the package, installing the package automatically downloads binaries from there (@pxref{Substitutes}). The only place where human intervention is needed is to review and apply the patch." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22220 +#, no-wrap +msgid "free software" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22228 +msgid "The GNU operating system has been developed so that users can have freedom in their computing. GNU is @dfn{free software}, meaning that users have the @url{http://www.gnu.org/philosophy/free-sw.html,four essential freedoms}: to run the program, to study and change the program in source code form, to redistribute exact copies, and to distribute modified versions. Packages found in the GNU distribution provide only software that conveys these four freedoms." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22234 +msgid "In addition, the GNU distribution follow the @url{http://www.gnu.org/distros/free-system-distribution-guidelines.html,free software distribution guidelines}. Among other things, these guidelines reject non-free firmware, recommendations of non-free software, and discuss ways to deal with trademarks and patents." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22242 +msgid "Some otherwise free upstream package sources contain a small and optional subset that violates the above guidelines, for instance because this subset is itself non-free code. When that happens, the offending items are removed with appropriate patches or code snippets in the @code{origin} form of the package (@pxref{Defining Packages}). This way, @code{guix build --source} returns the ``freed'' source rather than the unmodified upstream source." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22247 +#, no-wrap +msgid "package name" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22255 +msgid "A package has actually two names associated with it: First, there is the name of the @emph{Scheme variable}, the one following @code{define-public}. By this name, the package can be made known in the Scheme code, for instance as input to another package. Second, there is the string in the @code{name} field of a package definition. This name is used by package management commands such as @command{guix package} and @command{guix build}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22260 +msgid "Both are usually the same and correspond to the lowercase conversion of the project name chosen upstream, with underscores replaced with hyphens. For instance, GNUnet is available as @code{gnunet}, and SDL_net as @code{sdl-net}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22265 +msgid "We do not add @code{lib} prefixes for library packages, unless these are already part of the official project name. But @pxref{Python Modules} and @ref{Perl Modules} for special rules concerning modules for the Python and Perl languages." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22267 +msgid "Font package names are handled differently, @pxref{Fonts}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22272 +#, no-wrap +msgid "package version" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22281 +msgid "We usually package only the latest version of a given free software project. But sometimes, for instance for incompatible library versions, two (or more) versions of the same package are needed. These require different Scheme variable names. We use the name as defined in @ref{Package Naming} for the most recent version; previous versions use the same name, suffixed by @code{-} and the smallest prefix of the version number that may distinguish the two versions." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22284 +msgid "The name inside the package definition is the same for all versions of a package and does not contain any version number." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22286 +msgid "For instance, the versions 2.24.20 and 3.9.12 of GTK+ may be packaged as follows:" +msgstr "" + +#. type: example +#: doc/guix.texi:22298 +#, no-wrap +msgid "" +"(define-public gtk+\n" +" (package\n" +" (name \"gtk+\")\n" +" (version \"3.9.12\")\n" +" ...))\n" +"(define-public gtk+-2\n" +" (package\n" +" (name \"gtk+\")\n" +" (version \"2.24.20\")\n" +" ...))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22300 +msgid "If we also wanted GTK+ 3.8.2, this would be packaged as" +msgstr "" + +#. type: example +#: doc/guix.texi:22306 +#, no-wrap +msgid "" +"(define-public gtk+-3.8\n" +" (package\n" +" (name \"gtk+\")\n" +" (version \"3.8.2\")\n" +" ...))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22310 +#, no-wrap +msgid "version number, for VCS snapshots" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22316 +msgid "Occasionally, we package snapshots of upstream's version control system (VCS) instead of formal releases. This should remain exceptional, because it is up to upstream developers to clarify what the stable release is. Yet, it is sometimes necessary. So, what should we put in the @code{version} field?" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22324 +msgid "Clearly, we need to make the commit identifier of the VCS snapshot visible in the version string, but we also need to make sure that the version string is monotonically increasing so that @command{guix package --upgrade} can determine which version is newer. Since commit identifiers, notably with Git, are not monotonically increasing, we add a revision number that we increase each time we upgrade to a newer snapshot. The resulting version string looks like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:22333 +#, no-wrap +msgid "" +"2.0.11-3.cabba9e\n" +" ^ ^ ^\n" +" | | `-- upstream commit ID\n" +" | |\n" +" | `--- Guix package revision\n" +" |\n" +"latest upstream version\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22342 +msgid "It is a good idea to strip commit identifiers in the @code{version} field to, say, 7 digits. It avoids an aesthetic annoyance (assuming aesthetics have a role to play here) as well as problems related to OS limits such as the maximum shebang length (127 bytes for the Linux kernel.) It is best to use the full commit identifiers in @code{origin}s, though, to avoid ambiguities. A typical package definition may look like this:" +msgstr "" + +#. type: example +#: doc/guix.texi:22358 +#, no-wrap +msgid "" +"(define my-package\n" +" (let ((commit \"c3f29bc928d5900971f65965feaae59e1272a3f7\")\n" +" (revision \"1\")) ;Guix package revision\n" +" (package\n" +" (version (git-version \"0.9\" revision commit))\n" +" (source (origin\n" +" (method git-fetch)\n" +" (uri (git-reference\n" +" (url \"git://example.org/my-package.git\")\n" +" (commit commit)))\n" +" (sha256 (base32 \"1mbikn@dots{}\"))\n" +" (file-name (git-file-name name version))))\n" +" ;; @dots{}\n" +" )))\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22363 +#, no-wrap +msgid "package description" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22364 +#, no-wrap +msgid "package synopsis" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22371 +msgid "As we have seen before, each package in GNU@tie{}Guix includes a synopsis and a description (@pxref{Defining Packages}). Synopses and descriptions are important: They are what @command{guix package --search} searches, and a crucial piece of information to help users determine whether a given package suits their needs. Consequently, packagers should pay attention to what goes into them." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22379 +msgid "Synopses must start with a capital letter and must not end with a period. They must not start with ``a'' or ``the'', which usually does not bring anything; for instance, prefer ``File-frobbing tool'' over ``A tool that frobs files''. The synopsis should say what the package is---e.g., ``Core GNU utilities (file, text, shell)''---or what it is used for---e.g., the synopsis for GNU@tie{}grep is ``Print lines matching a pattern''." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22389 +msgid "Keep in mind that the synopsis must be meaningful for a very wide audience. For example, ``Manipulate alignments in the SAM format'' might make sense for a seasoned bioinformatics researcher, but might be fairly unhelpful or even misleading to a non-specialized audience. It is a good idea to come up with a synopsis that gives an idea of the application domain of the package. In this example, this might give something like ``Manipulate nucleotide sequence alignments'', which hopefully gives the user a better idea of whether this is what they are looking for." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22397 +msgid "Descriptions should take between five and ten lines. Use full sentences, and avoid using acronyms without first introducing them. Please avoid marketing phrases such as ``world-leading'', ``industrial-strength'', and ``next-generation'', and avoid superlatives like ``the most advanced''---they are not helpful to users looking for a package and may even sound suspicious. Instead, try to be factual, mentioning use cases and features." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22398 +#, no-wrap +msgid "Texinfo markup, in package descriptions" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22407 +msgid "Descriptions can include Texinfo markup, which is useful to introduce ornaments such as @code{@@code} or @code{@@dfn}, bullet lists, or hyperlinks (@pxref{Overview,,, texinfo, GNU Texinfo}). However you should be careful when using some characters for example @samp{@@} and curly braces which are the basic special characters in Texinfo (@pxref{Special Characters,,, texinfo, GNU Texinfo}). User interfaces such as @command{guix package --show} take care of rendering it appropriately." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22413 +msgid "Synopses and descriptions are translated by volunteers @uref{http://translationproject.org/domain/guix-packages.html, at the Translation Project} so that as many users as possible can read them in their native language. User interfaces search them and display them in the language specified by the current locale." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22418 +msgid "To allow @command{xgettext} to extract them as translatable strings, synopses and descriptions @emph{must be literal strings}. This means that you cannot use @code{string-append} or @code{format} to construct these strings:" +msgstr "" + +#. type: lisp +#: doc/guix.texi:22424 +#, no-wrap +msgid "" +"(package\n" +" ;; @dots{}\n" +" (synopsis \"This is translatable\")\n" +" (description (string-append \"This is \" \"*not*\" \" translatable.\")))\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22432 +msgid "Translation is a lot of work so, as a packager, please pay even more attention to your synopses and descriptions as every change may entail additional work for translators. In order to help them, it is possible to make recommendations or instructions visible to them by inserting special comments like this (@pxref{xgettext Invocation,,, gettext, GNU Gettext}):" +msgstr "" + +#. type: example +#: doc/guix.texi:22437 +#, no-wrap +msgid "" +";; TRANSLATORS: \"X11 resize-and-rotate\" should not be translated.\n" +"(description \"ARandR is designed to provide a simple visual front end\n" +"for the X11 resize-and-rotate (RandR) extension. @dots{}\")\n" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22443 +#, no-wrap +msgid "python" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22449 +msgid "We currently package Python 2 and Python 3, under the Scheme variable names @code{python-2} and @code{python} as explained in @ref{Version Numbers}. To avoid confusion and naming clashes with other programming languages, it seems desirable that the name of a package for a Python module contains the word @code{python}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22455 +msgid "Some modules are compatible with only one version of Python, others with both. If the package Foo compiles only with Python 3, we name it @code{python-foo}; if it compiles only with Python 2, we name it @code{python2-foo}. If it is compatible with both versions, we create two packages with the corresponding names." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22461 +msgid "If a project already contains the word @code{python}, we drop this; for instance, the module python-dateutil is packaged under the names @code{python-dateutil} and @code{python2-dateutil}. If the project name starts with @code{py} (e.g. @code{pytz}), we keep it and prefix it as described above." +msgstr "" + +#. type: subsubsection +#: doc/guix.texi:22462 +#, no-wrap +msgid "Specifying Dependencies" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22463 +#, no-wrap +msgid "inputs, for Python packages" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22468 +msgid "Dependency information for Python packages is usually available in the package source tree, with varying degrees of accuracy: in the @file{setup.py} file, in @file{requirements.txt}, or in @file{tox.ini}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22474 +msgid "Your mission, when writing a recipe for a Python package, is to map these dependencies to the appropriate type of ``input'' (@pxref{package Reference, inputs}). Although the @code{pypi} importer normally does a good job (@pxref{Invoking guix import}), you may want to check the following check list to determine which dependency goes where." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22482 +msgid "We currently package Python 2 with @code{setuptools} and @code{pip} installed like Python 3.4 has per default. Thus you don't need to specify either of these as an input. @command{guix lint} will warn you if you do." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22488 +msgid "Python dependencies required at run time go into @code{propagated-inputs}. They are typically defined with the @code{install_requires} keyword in @file{setup.py}, or in the @file{requirements.txt} file." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22496 +msgid "Python packages required only at build time---e.g., those listed with the @code{setup_requires} keyword in @file{setup.py}---or only for testing---e.g., those in @code{tests_require}---go into @code{native-inputs}. The rationale is that (1) they do not need to be propagated because they are not needed at run time, and (2) in a cross-compilation context, it's the ``native'' input that we'd want." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22500 +msgid "Examples are the @code{pytest}, @code{mock}, and @code{nose} test frameworks. Of course if any of these packages is also required at run-time, it needs to go to @code{propagated-inputs}." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22505 +msgid "Anything that does not fall in the previous categories goes to @code{inputs}, for example programs or C libraries required for building Python packages containing C extensions." +msgstr "" + +#. type: itemize +#: doc/guix.texi:22511 +msgid "If a Python package has optional dependencies (@code{extras_require}), it is up to you to decide whether to add them or not, based on their usefulness/overhead ratio (@pxref{Submitting Patches, @command{guix size}})." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22518 +#, no-wrap +msgid "perl" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22529 +msgid "Perl programs standing for themselves are named as any other package, using the lowercase upstream name. For Perl packages containing a single class, we use the lowercase class name, replace all occurrences of @code{::} by dashes and prepend the prefix @code{perl-}. So the class @code{XML::Parser} becomes @code{perl-xml-parser}. Modules containing several classes keep their lowercase upstream name and are also prepended by @code{perl-}. Such modules tend to have the word @code{perl} somewhere in their name, which gets dropped in favor of the prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22534 +#, no-wrap +msgid "java" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22537 +msgid "Java programs standing for themselves are named as any other package, using the lowercase upstream name." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22543 +msgid "To avoid confusion and naming clashes with other programming languages, it is desirable that the name of a package for a Java package is prefixed with @code{java-}. If a project already contains the word @code{java}, we drop this; for instance, the package @code{ngsjava} is packaged under the name @code{java-ngs}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22549 +msgid "For Java packages containing a single class or a small class hierarchy, we use the lowercase class name, replace all occurrences of @code{.} by dashes and prepend the prefix @code{java-}. So the class @code{apache.commons.cli} becomes package @code{java-apache-commons-cli}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22560 +msgid "For fonts that are in general not installed by a user for typesetting purposes, or that are distributed as part of a larger software package, we rely on the general packaging rules for software; for instance, this applies to the fonts delivered as part of the X.Org system or fonts that are part of TeX Live." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22564 +msgid "To make it easier for a user to search for fonts, names for other packages containing only fonts are constructed as follows, independently of the upstream package name." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22572 +msgid "The name of a package containing only one font family starts with @code{font-}; it is followed by the foundry name and a dash @code{-} if the foundry is known, and the font family name, in which spaces are replaced by dashes (and as usual, all upper case letters are transformed to lower case). For example, the Gentium font family by SIL is packaged under the name @code{font-sil-gentium}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22581 +msgid "For a package containing several font families, the name of the collection is used in the place of the font family name. For instance, the Liberation fonts consist of three families, Liberation Sans, Liberation Serif and Liberation Mono. These could be packaged separately under the names @code{font-liberation-sans} and so on; but as they are distributed together under a common name, we prefer to package them together as @code{font-liberation}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22587 +msgid "In the case where several formats of the same font family or font collection are packaged separately, a short form of the format, prepended by a dash, is added to the package name. We use @code{-ttf} for TrueType fonts, @code{-otf} for OpenType fonts and @code{-type1} for PostScript Type 1 fonts." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22595 +#, no-wrap +msgid "bootstrapping" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22605 +msgid "Bootstrapping in our context refers to how the distribution gets built ``from nothing''. Remember that the build environment of a derivation contains nothing but its declared inputs (@pxref{Introduction}). So there's an obvious chicken-and-egg problem: how does the first package get built? How does the first compiler get compiled? Note that this is a question of interest only to the curious hacker, not to the regular user, so you can shamelessly skip this section if you consider yourself a ``regular user''." +msgstr "" + +#. type: cindex +#: doc/guix.texi:22606 doc/guix.texi:22728 +#, no-wrap +msgid "bootstrap binaries" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22616 +msgid "The GNU system is primarily made of C code, with libc at its core. The GNU build system itself assumes the availability of a Bourne shell and command-line tools provided by GNU Coreutils, Awk, Findutils, `sed', and `grep'. Furthermore, build programs---programs that run @code{./configure}, @code{make}, etc.---are written in Guile Scheme (@pxref{Derivations}). Consequently, to be able to build anything at all, from scratch, Guix relies on pre-built binaries of Guile, GCC, Binutils, libc, and the other packages mentioned above---the @dfn{bootstrap binaries}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22619 +msgid "These bootstrap binaries are ``taken for granted'', though we can also re-create them if needed (more on that later)." +msgstr "" + +#. type: unnumberedsubsec +#: doc/guix.texi:22620 +#, no-wrap +msgid "Preparing to Use the Bootstrap Binaries" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22625 +msgid "@image{images/bootstrap-graph,6in,,Dependency graph of the early bootstrap derivations}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22630 +msgid "The figure above shows the very beginning of the dependency graph of the distribution, corresponding to the package definitions of the @code{(gnu packages bootstrap)} module. A similar figure can be generated with @command{guix graph} (@pxref{Invoking guix graph}), along the lines of:" +msgstr "" + +#. type: example +#: doc/guix.texi:22635 +#, no-wrap +msgid "" +"guix graph -t derivation \\\n" +" -e '(@@@@ (gnu packages bootstrap) %bootstrap-gcc)' \\\n" +" | dot -Tps > t.ps\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22644 +msgid "At this level of detail, things are slightly complex. First, Guile itself consists of an ELF executable, along with many source and compiled Scheme files that are dynamically loaded when it runs. This gets stored in the @file{guile-2.0.7.tar.xz} tarball shown in this graph. This tarball is part of Guix's ``source'' distribution, and gets inserted into the store with @code{add-to-store} (@pxref{The Store})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22653 +msgid "But how do we write a derivation that unpacks this tarball and adds it to the store? To solve this problem, the @code{guile-bootstrap-2.0.drv} derivation---the first one that gets built---uses @code{bash} as its builder, which runs @code{build-bootstrap-guile.sh}, which in turn calls @code{tar} to unpack the tarball. Thus, @file{bash}, @file{tar}, @file{xz}, and @file{mkdir} are statically-linked binaries, also part of the Guix source distribution, whose sole purpose is to allow the Guile tarball to be unpacked." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22665 +msgid "Once @code{guile-bootstrap-2.0.drv} is built, we have a functioning Guile that can be used to run subsequent build programs. Its first task is to download tarballs containing the other pre-built binaries---this is what the @code{.tar.xz.drv} derivations do. Guix modules such as @code{ftp-client.scm} are used for this purpose. The @code{module-import.drv} derivations import those modules in a directory in the store, using the original layout. The @code{module-import-compiled.drv} derivations compile those modules, and write them in an output directory with the right layout. This corresponds to the @code{#:modules} argument of @code{build-expression->derivation} (@pxref{Derivations})." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22669 +msgid "Finally, the various tarballs are unpacked by the derivations @code{gcc-bootstrap-0.drv}, @code{glibc-bootstrap-0.drv}, etc., at which point we have a working C tool chain." +msgstr "" + +#. type: unnumberedsubsec +#: doc/guix.texi:22671 +#, no-wrap +msgid "Building the Build Tools" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22680 +msgid "Bootstrapping is complete when we have a full tool chain that does not depend on the pre-built bootstrap tools discussed above. This no-dependency requirement is verified by checking whether the files of the final tool chain contain references to the @file{/gnu/store} directories of the bootstrap inputs. The process that leads to this ``final'' tool chain is described by the package definitions found in the @code{(gnu packages commencement)} module." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22687 +msgid "The @command{guix graph} command allows us to ``zoom out'' compared to the graph above, by looking at the level of package objects instead of individual derivations---remember that a package may translate to several derivations, typically one derivation to download its source, one to build the Guile modules it needs, and one to actually build the package from source. The command:" +msgstr "" + +#. type: example +#: doc/guix.texi:22692 +#, no-wrap +msgid "" +"guix graph -t bag \\\n" +" -e '(@@@@ (gnu packages commencement)\n" +" glibc-final-with-bootstrap-bash)' | dot -Tps > t.ps\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22699 +msgid "produces the dependency graph leading to the ``final'' C library@footnote{You may notice the @code{glibc-intermediate} label, suggesting that it is not @emph{quite} final, but as a good approximation, we will consider it final.}, depicted below." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22701 +msgid "@image{images/bootstrap-packages,6in,,Dependency graph of the early packages}" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22707 +msgid "The first tool that gets built with the bootstrap binaries is GNU@tie{}Make---noted @code{make-boot0} above---which is a prerequisite for all the following packages. From there Findutils and Diffutils get built." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22712 +msgid "Then come the first-stage Binutils and GCC, built as pseudo cross tools---i.e., with @code{--target} equal to @code{--host}. They are used to build libc. Thanks to this cross-build trick, this libc is guaranteed not to hold any reference to the initial tool chain." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22718 +msgid "From there the final Binutils and GCC (not shown above) are built. GCC uses @code{ld} from the final Binutils, and links programs against the just-built libc. This tool chain is used to build the other packages used by Guix and by the GNU Build System: Guile, Bash, Coreutils, etc." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22724 +msgid "And voilà! At this point we have the complete set of build tools that the GNU Build System expects. These are in the @code{%final-inputs} variable of the @code{(gnu packages commencement)} module, and are implicitly used by any package that uses @code{gnu-build-system} (@pxref{Build Systems, @code{gnu-build-system}})." +msgstr "" + +#. type: unnumberedsubsec +#: doc/guix.texi:22726 +#, no-wrap +msgid "Building the Bootstrap Binaries" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22733 +msgid "Because the final tool chain does not depend on the bootstrap binaries, those rarely need to be updated. Nevertheless, it is useful to have an automated way to produce them, should an update occur, and this is what the @code{(gnu packages make-bootstrap)} module provides." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22737 +msgid "The following command builds the tarballs containing the bootstrap binaries (Guile, Binutils, GCC, libc, and a tarball containing a mixture of Coreutils and other basic command-line tools):" +msgstr "" + +#. type: example +#: doc/guix.texi:22740 +#, no-wrap +msgid "guix build bootstrap-tarballs\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22745 +msgid "The generated tarballs are those that should be referred to in the @code{(gnu packages bootstrap)} module mentioned at the beginning of this section." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22751 +msgid "Still here? Then perhaps by now you've started to wonder: when do we reach a fixed point? That is an interesting question! The answer is unknown, but if you would like to investigate further (and have significant computational and storage resources to do so), then let us know." +msgstr "" + +#. type: unnumberedsubsec +#: doc/guix.texi:22752 +#, no-wrap +msgid "Reducing the Set of Bootstrap Binaries" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22760 +msgid "Our bootstrap binaries currently include GCC, Guile, etc. That's a lot of binary code! Why is that a problem? It's a problem because these big chunks of binary code are practically non-auditable, which makes it hard to establish what source code produced them. Every unauditable binary also leaves us vulnerable to compiler backdoors as described by Ken Thompson in the 1984 paper @emph{Reflections on Trusting Trust}." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22766 +msgid "This is mitigated by the fact that our bootstrap binaries were generated from an earlier Guix revision. Nevertheless it lacks the level of transparency that we get in the rest of the package dependency graph, where Guix always gives us a source-to-binary mapping. Thus, our goal is to reduce the set of bootstrap binaries to the bare minimum." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22772 +msgid "The @uref{http://bootstrappable.org, Bootstrappable.org web site} lists on-going projects to do that. One of these is about replacing the bootstrap GCC with a sequence of assemblers, interpreters, and compilers of increasing complexity, which could be built from source starting from a simple and auditable assembler. Your help is welcome!" +msgstr "" + +#. type: section +#: doc/guix.texi:22775 +#, no-wrap +msgid "Porting to a New Platform" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22784 +msgid "As discussed above, the GNU distribution is self-contained, and self-containment is achieved by relying on pre-built ``bootstrap binaries'' (@pxref{Bootstrapping}). These binaries are specific to an operating system kernel, CPU architecture, and application binary interface (ABI). Thus, to port the distribution to a platform that is not yet supported, one must build those bootstrap binaries, and update the @code{(gnu packages bootstrap)} module to use them on that platform." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22789 +msgid "Fortunately, Guix can @emph{cross compile} those bootstrap binaries. When everything goes well, and assuming the GNU tool chain supports the target platform, this can be as simple as running a command like this one:" +msgstr "" + +#. type: example +#: doc/guix.texi:22792 +#, no-wrap +msgid "guix build --target=armv5tel-linux-gnueabi bootstrap-tarballs\n" +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22799 +msgid "For this to work, the @code{glibc-dynamic-linker} procedure in @code{(gnu packages bootstrap)} must be augmented to return the right file name for libc's dynamic linker on that platform; likewise, @code{system->linux-architecture} in @code{(gnu packages linux)} must be taught about the new platform." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22808 +msgid "Once these are built, the @code{(gnu packages bootstrap)} module needs to be updated to refer to these binaries on the target platform. That is, the hashes and URLs of the bootstrap tarballs for the new platform must be added alongside those of the currently supported platforms. The bootstrap Guile tarball is treated specially: it is expected to be available locally, and @file{gnu/local.mk} has rules do download it for the supported architectures; a rule for the new platform must be added as well." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22817 +msgid "In practice, there may be some complications. First, it may be that the extended GNU triplet that specifies an ABI (like the @code{eabi} suffix above) is not recognized by all the GNU tools. Typically, glibc recognizes some of these, whereas GCC uses an extra @code{--with-abi} configure flag (see @code{gcc.scm} for examples of how to handle this). Second, some of the required packages could fail to build for that platform. Lastly, the generated binaries could be broken for some reason." +msgstr "" + +#. type: include +#: doc/guix.texi:22819 +#, no-wrap +msgid "contributing.texi" +msgstr "contributing.de.texi" + +#. type: Plain text +#: doc/guix.texi:22832 +msgid "Guix is based on the @uref{http://nixos.org/nix/, Nix package manager}, which was designed and implemented by Eelco Dolstra, with contributions from other people (see the @file{nix/AUTHORS} file in Guix.) Nix pioneered functional package management, and promoted unprecedented features, such as transactional package upgrades and rollbacks, per-user profiles, and referentially transparent build processes. Without this work, Guix would not exist." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22835 +msgid "The Nix-based software distributions, Nixpkgs and NixOS, have also been an inspiration for Guix." +msgstr "" + +#. type: Plain text +#: doc/guix.texi:22841 +msgid "GNU@tie{}Guix itself is a collective work with contributions from a number of people. See the @file{AUTHORS} file in Guix for more information on these fine people. The @file{THANKS} file lists people who have helped by reporting bugs, taking care of the infrastructure, providing artwork and themes, making suggestions, and more---thank you!" +msgstr "" + +#. type: cindex +#: doc/guix.texi:22846 +#, no-wrap +msgid "license, GNU Free Documentation License" +msgstr "" + +#. type: include +#: doc/guix.texi:22847 +#, no-wrap +msgid "fdl-1.3.texi" +msgstr "fdl-1.3.texi" + +#~ msgid "This manual is also available in French (@pxref{Top,,, guix.fr, Manuel de référence de GNU Guix}). If you would like to translate it in your native language, consider joining the @uref{https://translationproject.org/domain/guix-manual.html, Translation Project}." +#~ msgstr "Dieses Handbuch ist auch auf Französisch verfügbar (@pxref{Top,,, guix.fr, Manuel de référence de GNU Guix}). Wenn Sie es in Ihre eigene Sprache übersetzen möchten, dann sind Sie beim @uref{https://translationproject.org/domain/guix-manual.html, Translation Project} herzlich willkommen." + +#~ msgid "Channels" +#~ msgstr "Kanäle" + +#~ msgid "Customizing the package collection." +#~ msgstr "Die Paketsammlung anpassen." + +#~ msgid "Inferiors" +#~ msgstr "Untergeordnete" + +#~ msgid "Interacting with another revision of Guix." +#~ msgstr "Mit einer anderen Version von Guix interagieren." + +#~ msgid "Invoking guix describe" +#~ msgstr "Aufruf von guix describe" + +#~ msgid "Display information about your Guix revision." +#~ msgstr "Informationen über Ihre Guix-Fassung anzeigen." + +#~ msgid "Invoking guix repl" +#~ msgstr "Aufruf von guix repl" + +#~ msgid "Fiddling with Guix interactively." +#~ msgstr "Interaktiv an Guix herumbasteln." + +#~ msgid "Extending battery life." +#~ msgstr "Den Akku schonen." + +#~ msgid "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, version" +#~ msgstr "@url{https://notabug.org/cwebber/guile-gcrypt, Guile-Gcrypt}, Version" + +#~ msgid "0.1.0 or later;" +#~ msgstr "0.1.0 oder neuer," + +#~ msgid "replication, of software environments" +#~ msgstr "Nachbildung, von Software-Umgebungen" + +#~ msgid "provenance tracking, of software artifacts" +#~ msgstr "Provenienzverfolgung, von Software-Artefakten" + +#~ msgid "All of Guix and its package definitions is version-controlled, and @command{guix pull} allows you to ``travel in time'' on the history of Guix itself (@pxref{Invoking guix pull}). This makes it possible to replicate a Guix instance on a different machine or at a later point in time, which in turn allows you to @emph{replicate complete software environments}, while retaining precise @dfn{provenance tracking} of the software." +#~ msgstr "Ganz Guix und all seine Paketdefinitionen stehen unter Versionskontrolle und @command{guix pull} macht es möglich, auf dem Verlauf der Entwicklung von Guix selbst »in der Zeit zu reisen« (@pxref{Invoking guix pull}). Dadurch kann eine Instanz von Guix auf einer anderen Maschine oder zu einem späteren Zeitpunkt genau nachgebildet werden, wodurch auch @emph{vollständige Software-Umgebungen gänzlich nachgebildet} werden können, mit genauer @dfn{Provenienzverfolgung}, wo diese Software herkommt." + +#~ msgid "" +#~ "Generation 2\tJun 11 2018 11:02:49\n" +#~ " guix e0cc7f6\n" +#~ " repository URL: https://git.savannah.gnu.org/git/guix.git\n" +#~ " branch: origin/master\n" +#~ " commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n" +#~ " 2 new packages: keepalived, libnfnetlink\n" +#~ " 6 packages upgraded: emacs-nix-mode@@2.0.4,\n" +#~ " guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac,\n" +#~ " heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4\n" +#~ "\n" +#~ msgstr "" +#~ "Generation 2\tJun 11 2018 11:02:49\n" +#~ " guix e0cc7f6\n" +#~ " repository URL: https://git.savannah.gnu.org/git/guix.git\n" +#~ " branch: origin/master\n" +#~ " commit: e0cc7f669bec22c37481dd03a7941c7d11a64f1d\n" +#~ " 2 new packages: keepalived, libnfnetlink\n" +#~ " 6 packages upgraded: emacs-nix-mode@@2.0.4,\n" +#~ " guile2.0-guix@@0.14.0-12.77a1aac, guix@@0.14.0-12.77a1aac,\n" +#~ " heimdal@@7.5.0, milkytracker@@1.02.00, nix@@2.0.4\n" +#~ "\n" + +#~ msgid "@ref{Invoking guix describe, @command{guix describe}}, for other ways to describe the current status of Guix." +#~ msgstr "Im Abschnitt @ref{Invoking guix describe, @command{guix describe}} werden andere Möglichkeiten erklärt, sich den momentanen Zustand von Guix beschreiben zu lassen." + +#~ msgid "Replicating Guix" +#~ msgstr "Guix nachbilden" + +#~ msgid "replicating Guix" +#~ msgstr "Nachbilden von Guix" + +#~ msgid "inferior packages" +#~ msgstr "untergeordnete Pakete" + +#~ msgid "The data type representing the configuration of iptables." +#~ msgstr "Repräsentiert die iptables-Konfiguration." + +#~ msgid "@code{iptables} (default: @code{iptables})" +#~ msgstr "@code{iptables} (Vorgabe: @code{iptables})" + +#~ msgid "@code{ipv4-rules} (default: @code{%iptables-accept-all-rules})" +#~ msgstr "@code{ipv4-rules} (Vorgabe: @code{%iptables-accept-all-rules})" + +#~ msgid "@code{ipv6-rules} (default: @code{%iptables-accept-all-rules})" +#~ msgstr "@code{ipv6-rules} (Vorgabe: @code{%iptables-accept-all-rules})" + +#~ msgid "@code{tor} (default: @code{tor})" +#~ msgstr "@code{tor} (Vorgabe: @code{tor})" + +#~ msgid "@code{config-file} (default: @code{(plain-file \"empty\" \"\")})" +#~ msgstr "@code{config-file} (Vorgabe: @code{(plain-file \"empty\" \"\")})" + +#~ msgid "@code{hidden-services} (default: @code{'()})" +#~ msgstr "@code{hidden-services} (Vorgabe: @code{'()})" + +#~ msgid "@code{socks-socket-type} (default: @code{'tcp})" +#~ msgstr "@code{socks-socket-type} (Vorgabe: @code{'tcp})" + +#~ msgid "@code{allow-agent-forwarding?} (default: @code{#t})" +#~ msgstr "@code{allow-agent-forwarding?} (Vorgabe: @code{#t})" + +#~ msgid "@code{allow-tcp-forwarding?} (default: @code{#t})" +#~ msgstr "@code{allow-tcp-forwarding?} (Vorgabe: @code{#t})" + +#~ msgid "@code{gateway-ports?} (default: @code{#f})" +#~ msgstr "@code{gateway-ports?} (Vorgabe: @code{#f})" + +#~ msgid "@code{log-level} (default: @code{'info})" +#~ msgstr "@code{log-level} (Vorgabe: @code{'info})" + +#~ msgid "@code{web-listen-address} (default: @code{\":9100\"})" +#~ msgstr "@code{web-listen-address} (Vorgabe: @code{\":9100\"})" + +#~ msgid "The Varnish package to use." +#~ msgstr "Das Varnish-Paket, was benutzt werden soll." + +#~ msgid "@code{name} (default: @code{\"default\"})" +#~ msgstr "@code{name} (Vorgabe: @code{\"default\"})" + +#~ msgid "@code{backend} (default: @code{\"localhost:8080\"})" +#~ msgstr "@code{backend} (Vorgabe: @code{\"localhost:8080\"})" + +#~ msgid "@code{vcl} (default: #f)" +#~ msgstr "@code{vcl} (Vorgabe: #f)" + +#~ msgid "@code{listen} (default: @code{'(\"localhost:80\")})" +#~ msgstr "@code{listen} (Vorgabe: @code{'(\"localhost:80\")})" + +#~ msgid "@code{storage} (default: @code{'(\"malloc,128m\")})" +#~ msgstr "@code{storage} (Vorgabe: @code{'(\"malloc,128m\")})" + +#~ msgid "@code{parameters} (default: @code{'()})" +#~ msgstr "@code{parameters} (Vorgabe: @code{'()})" + +#~ msgid "@code{channels} (default: @code{%default-channels})" +#~ msgstr "@code{channels} (Vorgabe: @code{%default-channels})" + +#~ msgid "@code{package-list-expiration} (default: @code{(* 12 3600)})" +#~ msgstr "@code{package-list-expiration} (Vorgabe: @code{(* 12 3600)})" + +#~ msgid "The ddclient package." +#~ msgstr "Das ddclient-Paket." + +#~ msgid "Gitolite Service" +#~ msgstr "Gitolite-Dienst" + +#~ msgid "Gitolite service" +#~ msgstr "Gitolite-Dienst" + +#~ msgid "@code{package} (default: @var{gitolite})" +#~ msgstr "@code{package} (Vorgabe: @var{gitolite})" + +#~ msgid "Gitolite package to use." +#~ msgstr "Welches Gitolite-Paket benutzt werden soll." + +#~ msgid "@code{user} (default: @var{git})" +#~ msgstr "@code{user} (Vorgabe: @var{git})" + +#~ msgid "@code{group} (default: @var{git})" +#~ msgstr "@code{group} (Vorgabe: @var{git})" + +#~ msgid "@code{home-directory} (default: @var{\"/var/lib/gitolite\"})" +#~ msgstr "@code{home-directory} (Vorgabe: @var{\"/var/lib/gitolite\"})" + +#~ msgid "@code{rc-file} (default: @var{(gitolite-rc-file)})" +#~ msgstr "@code{rc-file} (Vorgabe: @var{(gitolite-rc-file)})" + +#~ msgid "@code{admin-pubkey} (default: @var{#f})" +#~ msgstr "@code{admin-pubkey} (Vorgabe: @var{#f})" + +#~ msgid "@code{umask} (default: @code{#o0077})" +#~ msgstr "@code{umask} (Vorgabe: @code{#o0077})" + +#~ msgid "@code{git-config-keys} (default: @code{\"\"})" +#~ msgstr "@code{git-config-keys} (Vorgabe: @code{\"\"})" + +#~ msgid "@code{roles} (default: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})" +#~ msgstr "@code{roles} (Vorgabe: @code{'((\"READERS\" . 1) (\"WRITERS\" . ))})" + +#~ msgid "@code{pcsc-lite} (default: @code{pcsc-lite})" +#~ msgstr "@code{pcsc-lite} (Vorgabe: @code{pcsc-lite})" + +#~ msgid "@code{usb-drivers} (default: @code{(list ccid)})" +#~ msgstr "@code{usb-drivers} (Vorgabe: @code{(list ccid)})" + +#~ msgid "Symbol naming the action." +#~ msgstr "Die Aktion bezeichnendes Symbol." diff --git a/po/doc/local.mk b/po/doc/local.mk index ca588ea916..3d3b4f67b1 100644 --- a/po/doc/local.mk +++ b/po/doc/local.mk @@ -18,6 +18,7 @@ EXTRA_DIST = \ %D%/guix-manual.pot \ + %D%/guix-manual.de.po \ %D%/guix-manual.fr.po POT_OPTIONS = --package-name "guix" --package-version "$(VERSION)" \ |